gcpkms: update SDK to latest, add tests, tidy #1072
Merged
Conversation
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
hiddeco
commented
Jun 7, 2022
ajvb
reviewed
Jun 28, 2022
This updates the GCP KMS client to latest, adds more extensive test coverage, and general tidying of bits of code. The improvements are based on a fork of the key source in the Flux project's kustomize-controller, built due to SOPS' limitation around credential management without relying on runtime environment variables. - Updates the deprecated `google.golang.org/api/cloudkms/v1` to `cloud.google.com/go/kms/apiv1`. - It introduces a `CredentialJSON` type which holds a Service Account credential file, and can be applied to the `MasterKey`. When applied, the provided credentials are used in the GCP KMS service client configuration, instead of relying on `GOOGLE_CREDENTIALS`, or the default client environment variables. This is most useful when working with SOPS as an SDK, in combination with e.g. a local key service server implementation. - Test coverage. The forked version of this has compatability (and integration) tests to ensure it works with current SOPS: - https://github.com/fluxcd/kustomize-controller/blob/cbb0fc9df5da12a54cf998392dbd80d28522def5/internal/sops/gcpkms/keysource_integration_test.go#L39 - https://github.com/fluxcd/kustomize-controller/blob/cbb0fc9df5da12a54cf998392dbd80d28522def5/internal/sops/gcpkms/keysource_integration_test.go#L59 Co-authored-by: Somtochi Onyekwere <[email protected]> Signed-off-by: Hidde Beydals <[email protected]>
Closed
ajvb
approved these changes
Jul 12, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the GCP KMS client to latest, adds more extensive test
coverage, and general tidying of bits of code.
The improvements are based on a fork of the key source in the Flux
project's kustomize-controller, built due to SOPS' limitation around
credential management without relying on runtime environment variables.
google.golang.org/api/cloudkms/v1tocloud.google.com/go/kms/apiv1.CredentialJSONtype which holds a Service Accountcredential file, and can be applied to the
MasterKey.When applied, the provided credentials are used in the GCP KMS
service client configuration, instead of relying on
GOOGLE_CREDENTIALS, or the default client environment variables.This is most useful when working with SOPS as an SDK, in combination
with e.g. a local key service server implementation.
The forked version of this has compatability (and integration) tests to
ensure it works with current SOPS: