-
Notifications
You must be signed in to change notification settings - Fork 38.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #48574 from sakshamsharma/kms-transformer
Automatic merge from submit-queue Add Google cloud KMS service for envelope encryption transformer This adds the required pieces which will allow addition of KMS based encryption providers (envelope transformer). For now, we will be implementing it using Google Cloud KMS, but the code should make it easy to add support for any other such provider which can expose Decrypt and Encrypt calls. Writing tests for Google Cloud KMS Service may cause a significant overhead to the testing framework. It has been tested locally and on GKE though. Upcoming after this PR: * Complete implementation of the envelope transformer, which uses LRU cache to maintain decrypted DEKs in memory. * Track key version to assist in data re-encryption after a KEK rotation. Development branch containing the changes described above: sakshamsharma#4 Envelope transformer used by this PR was merged in #49350 Concerns #48522 Planned configuration: ``` kind: EncryptionConfig apiVersion: v1 resources: - resources: - secrets providers: - kms: cachesize: 100 configfile: gcp-cloudkms.conf name: gcp-cloudkms - identity: {} ``` gcp-cloudkms.conf: ``` [GoogleCloudKMS] kms-location: global kms-keyring: google-container-engine kms-cryptokey: example-key ```
- Loading branch information
Showing
9 changed files
with
214 additions
and
123 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,167 @@ | ||
| /* | ||
| Copyright 2017 The Kubernetes Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package gce | ||
|
|
||
| import ( | ||
| "encoding/base64" | ||
| "fmt" | ||
| "io" | ||
|
|
||
| "github.com/golang/glog" | ||
| cloudkms "google.golang.org/api/cloudkms/v1" | ||
| "google.golang.org/api/googleapi" | ||
| gcfg "gopkg.in/gcfg.v1" | ||
| "k8s.io/apiserver/pkg/storage/value/encrypt/envelope" | ||
| ) | ||
|
|
||
| const ( | ||
| // KMSServiceName is the name of the cloudkms provider registered by this cloud. | ||
| KMSServiceName = "gcp-cloudkms" | ||
|
|
||
| defaultGKMSKeyRing = "google-container-engine" | ||
| defaultGKMSKeyRingLocation = "global" | ||
| ) | ||
|
|
||
| // gkmsConfig contains the GCE specific KMS configuration for setting up a KMS connection. | ||
| type gkmsConfig struct { | ||
| Global struct { | ||
| // location is the KMS location of the KeyRing to be used for encryption. | ||
| // It can be found by checking the available KeyRings in the IAM UI. | ||
| // This is not the same as the GCP location of the project. | ||
| // +optional | ||
| Location string `gcfg:"kms-location"` | ||
| // keyRing is the keyRing of the hosted key to be used. The default value is "google-kubernetes". | ||
| // +optional | ||
| KeyRing string `gcfg:"kms-keyring"` | ||
| // cryptoKey is the name of the key to be used for encryption of Data-Encryption-Keys. | ||
| CryptoKey string `gcfg:"kms-cryptokey"` | ||
| } | ||
| } | ||
|
|
||
| // readGCPCloudKMSConfig parses and returns the configuration parameters for Google Cloud KMS. | ||
| func readGCPCloudKMSConfig(reader io.Reader) (*gkmsConfig, error) { | ||
| cfg := &gkmsConfig{} | ||
| if err := gcfg.FatalOnly(gcfg.ReadInto(cfg, reader)); err != nil { | ||
| glog.Errorf("Couldn't read Google Cloud KMS config: %v", err) | ||
| return nil, err | ||
| } | ||
| return cfg, nil | ||
| } | ||
|
|
||
| // gkmsService provides Encrypt and Decrypt methods which allow cryptographic operations | ||
| // using Google Cloud KMS service. | ||
| type gkmsService struct { | ||
| parentName string | ||
| cloudkmsService *cloudkms.Service | ||
| } | ||
|
|
||
| // getGCPCloudKMSService provides a Google Cloud KMS based implementation of envelope.Service. | ||
| func (gce *GCECloud) getGCPCloudKMSService(config io.Reader) (envelope.Service, error) { | ||
| kmsConfig, err := readGCPCloudKMSConfig(config) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| // Hosting on GCE/GKE with Google KMS encryption provider | ||
| cloudkmsService := gce.GetKMSService() | ||
|
|
||
| // Set defaults for location and keyRing. | ||
| location := kmsConfig.Global.Location | ||
| if len(location) == 0 { | ||
| location = defaultGKMSKeyRingLocation | ||
| } | ||
| keyRing := kmsConfig.Global.KeyRing | ||
| if len(keyRing) == 0 { | ||
| keyRing = defaultGKMSKeyRing | ||
| } | ||
|
|
||
| cryptoKey := kmsConfig.Global.CryptoKey | ||
| if len(cryptoKey) == 0 { | ||
| return nil, fmt.Errorf("missing cryptoKey for cloudprovided KMS: " + KMSServiceName) | ||
| } | ||
|
|
||
| parentName := fmt.Sprintf("projects/%s/locations/%s", gce.projectID, location) | ||
|
|
||
| // Create the keyRing if it does not exist yet | ||
| _, err = cloudkmsService.Projects.Locations.KeyRings.Create(parentName, | ||
| &cloudkms.KeyRing{}).KeyRingId(keyRing).Do() | ||
| if err != nil && unrecoverableCreationError(err) { | ||
| return nil, err | ||
| } | ||
| parentName = parentName + "/keyRings/" + keyRing | ||
|
|
||
| // Create the cryptoKey if it does not exist yet | ||
| _, err = cloudkmsService.Projects.Locations.KeyRings.CryptoKeys.Create(parentName, | ||
| &cloudkms.CryptoKey{ | ||
| Purpose: "ENCRYPT_DECRYPT", | ||
| }).CryptoKeyId(cryptoKey).Do() | ||
| if err != nil && unrecoverableCreationError(err) { | ||
| return nil, err | ||
| } | ||
| parentName = parentName + "/cryptoKeys/" + cryptoKey | ||
|
|
||
| service := &gkmsService{ | ||
| parentName: parentName, | ||
| cloudkmsService: cloudkmsService, | ||
| } | ||
|
|
||
| // Sanity check before startup. For non-GCP clusters, the user's account may not have permissions to create | ||
| // the key. We need to verify the existence of the key before apiserver startup. | ||
| _, err = service.Encrypt([]byte("test")) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to encrypt data using Google cloudkms, using key %s. Ensure that the keyRing and cryptoKey exist. Got error: %v", parentName, err) | ||
| } | ||
|
|
||
| return service, nil | ||
| } | ||
|
|
||
| // Decrypt decrypts a base64 representation of encrypted bytes. | ||
| func (t *gkmsService) Decrypt(data string) ([]byte, error) { | ||
| resp, err := t.cloudkmsService.Projects.Locations.KeyRings.CryptoKeys. | ||
| Decrypt(t.parentName, &cloudkms.DecryptRequest{ | ||
| Ciphertext: data, | ||
| }).Do() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return base64.StdEncoding.DecodeString(resp.Plaintext) | ||
| } | ||
|
|
||
| // Encrypt encrypts bytes, and returns base64 representation of the ciphertext. | ||
| func (t *gkmsService) Encrypt(data []byte) (string, error) { | ||
| resp, err := t.cloudkmsService.Projects.Locations.KeyRings.CryptoKeys. | ||
| Encrypt(t.parentName, &cloudkms.EncryptRequest{ | ||
| Plaintext: base64.StdEncoding.EncodeToString(data), | ||
| }).Do() | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| return resp.Ciphertext, nil | ||
| } | ||
|
|
||
| // unrecoverableCreationError decides if Kubernetes should ignore the encountered Google KMS | ||
| // error. Only to be used for errors seen while creating a KeyRing or CryptoKey. | ||
| func unrecoverableCreationError(err error) bool { | ||
| apiError, isAPIError := err.(*googleapi.Error) | ||
| // 409 means the object exists. | ||
| // 403 means we do not have permission to create the object, the user must do it. | ||
| // Else, it is an unrecoverable error. | ||
| if !isAPIError || (apiError.Code != 409 && apiError.Code != 403) { | ||
| return true | ||
| } | ||
| return false | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.