chore: spec for S3EC Keyring/KmsKeyring #306
Open
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
Open
1 task
josecorella
reviewed
Aug 20, 2025
| The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" | ||
| in this document are to be interpreted as described in [RFC2119](https://tools.ietf.org/html/rfc2119). | ||
|
|
||
| ## Interface |
There was a problem hiding this comment.
maybe too much for this review, but similarly to the mpl keyring interface,
https://github.com/awslabs/aws-encryption-sdk-specification/blob/master/framework/keyring-interface.md#interface
you may want to include more generic information on how the encrypt and decrypt operations should do
|
|
||
| ## Interface | ||
|
|
||
| The KmsKeyring MUST implement the [Keyring interface](keyring-interface.md#interface) and include the behavior described in the [S3 Keyring](s3-keyring.md). |
There was a problem hiding this comment.
i think you mean,
Suggested change
| The KmsKeyring MUST implement the [Keyring interface](keyring-interface.md#interface) and include the behavior described in the [S3 Keyring](s3-keyring.md). | |
| The KmsKeyring MUST implement the [Keyring interface](keyrings.md#interface) and include the behavior described in the [S3 Keyring](s3-keyring.md). |
?
| The KmsKeyring MAY validate that the AWS KMS key identifier is not null or empty. | ||
| If the KmsKeyring validates that the AWS KMS key identifier is not null or empty, then it MUST throw an exception. | ||
| The KmsKeyring MAY validate that the AWS KMS key identifier is [a valid AWS KMS Key identifier](../../framework/aws-kms/aws-kms-key-arn.md#a-valid-aws-kms-identifier). | ||
| If the KmsKeyring validates that the AWS KMS key identifier is not a valid AWS KMS Key identifier, then it MUST throw an exception. |
There was a problem hiding this comment.
nit: perhaps a good start to specify the type of exception that gets thrown or at least the error message?
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:
Spec for S3EC Keyring/S3 Keyring/KmsKeyring.
Java annotations: aws/amazon-s3-encryption-client-java#483
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Check any applicable: