feat: add KMS Discovery Keyring #324
Merged
Conversation
This file contains hidden or 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
lucasmcdonald3
previously approved these changes
Jul 24, 2024
There was a problem hiding this comment.
LGTM!
I don't think I fully understand the "why" of the implementation but it seems reasonable. If you want to explain the "why", I'd suggest adding comments where I nit'ted, but since all the "why" is around internal implementation details, not required for merge.
| } | ||
| } | ||
|
|
||
| // We are validating the encryption context to match S3EC V2 behavior |
There was a problem hiding this comment.
nit: Consider linking to said behavior
There was a problem hiding this comment.
the code is in another repo,
i will mention the class in question at least
| decryptDataKeyStrategies.put(_kmsContextDiscoveryStrategy.keyProviderInfo(), _kmsContextDiscoveryStrategy); | ||
| } | ||
|
|
||
| private final DecryptDataKeyStrategy _kmsDiscoveryStrategy = new DecryptDataKeyStrategy() { |
There was a problem hiding this comment.
nit: Consider adding some words explaining each strategy; how are they different? Why is this one legacy?
There was a problem hiding this comment.
sure,
it maps to kms v1 and kms+context (v2/v3)
lucasmcdonald3
approved these changes
Jul 26, 2024
josecorella
pushed a commit
that referenced
this pull request
Aug 20, 2024
## [3.2.0](v3.1.3...v3.2.0) (2024-08-20) ### Features * add KMS Discovery Keyring ([#324](#324)) ([8d3c06a](8d3c06a)) * allow S3EncryptionClient and S3AsyncEncryption Client to be configured ([#328](#328)) ([11f25f6](11f25f6)) ### Maintenance * **deps-dev:** bump org.bouncycastle:bcprov-jdk18on ([#260](#260)) ([cd58967](cd58967)) * **deps:** bump software.amazon.awssdk.crt:aws-crt ([#303](#303)) ([cfe325e](cfe325e)) * update build scripts ([#341](#341)) ([8fa4266](8fa4266)) * Update Release CFN ([#343](#343)) ([81606b6](81606b6)), closes [#382](#382)
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.
Issue #, if available: n/a
Description of changes: For many customers, it is not feasible to know the KMS Key ID associated with all of the objects the client instance should decrypt on GetObject. For example, the data may come from an external customer with more than one key encrypting many objects in a single bucket. This change adds a new keyring, KmsDiscoveryKeyring, which does not require the specification of a KMS Key ID during instantiation. The keyring will decrypt materials for whichever KMS key the ciphertext was encrypted with. This has slightly weaker security properties than the ordinary KMS keyring, but may be the only option for certain workloads.
Note that this keyring is very similar to the AWS KMS Discovery Keyring in the AWS Encryption SDK. However, the S3EC version DOES NOT support a DiscoveryFilter, as the KMS key ID is NOT persisted to the object metadata in v2/v3 KMS ciphertexts.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Check any applicable: