chore(java): demo hv-2 does not send prefixed EC in examples #1529
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
rishav-karanjit
commented
May 20, 2025
...ples/java/src/main/java/software/amazon/cryptography/example/hierarchy/CreateKeyExample.java
Outdated
Show resolved
Hide resolved
texastony
requested changes
May 20, 2025
Comment on lines
104
to
134
| // HV2 sends the encryption context without any transformation. | ||
| // We have a kms key `Fixtures.KMS_KEY_FOR_HV2_ONLY`, that requires EC to be exactly {"Robbie": "Is a Dog."} in its key policy. | ||
| // For demostration, we will create a key with a different EC then the one that is expected and see it fail. | ||
| final Map<String, String> encryptionContextFailingCase = | ||
| Collections.singletonMap("I", "am not a Dog."); | ||
| boolean exceptionThrown = false; | ||
| try { | ||
| _admin | ||
| .CreateKey( | ||
| CreateKeyInput | ||
| .builder() | ||
| // This is the KMS ARN that will be used to protect the Branch Key. | ||
| // It is a required argument. | ||
| .KmsArn(KmsSymmetricKeyArn.builder().KmsKeyArn(kmsKeyArn).build()) | ||
| // If you need to specify the Identifier for a Branch Key, you may. | ||
| // This is an optional argument. | ||
| .Identifier(branchKeyId) | ||
| // If a branch key Identifier is provided, | ||
| // custom encryption context MUST be provided as well. | ||
| .EncryptionContext(encryptionContextFailingCase) | ||
| // The Branch Key Store Admin can create HV-1 or HV-2 Branch Keys | ||
| .HierarchyVersion(_hierarchyVersion) | ||
| // But the Strategy MUST support the Hierarchy Version | ||
| .Strategy(strategy) | ||
| .build() | ||
| ) | ||
| .Identifier(); | ||
| } catch (KmsException e) { | ||
| exceptionThrown = true; | ||
| } | ||
| assert exceptionThrown; |
There was a problem hiding this comment.
Blocking: Just move all of this to a Test.
Do not keep it in line with the examples, that confuses customers, and complicates this CreateKey method that we use through out the Example Testing.
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:
Description of changes:
Squash/merge commit message, if applicable:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.