chore: Clarify StrictAwsKmsMasterKeyProvider docs #316
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
|
Note from June that saying something like "configured ARN" could be confusing for customers, as they could then think that a "Configured ARN" is a thing they need to understand. Instead, consider rewording to make it explicitly "the ARN you configured the MKP with". |
farleyb-amazon
previously approved these changes
Jan 25, 2021
| should be used for encryption and decryption. On encryption, the plaintext will be encrypted with all configured | ||
| master keys. On decryption, it only attempts to decrypt ciphertexts that have been wrapped with a CMK that | ||
| matches one of the configured CMK ARNs. If the ciphertext is encrypted with a master key that was not | ||
| explicitly configured, decryption will fail. To create a Strict Aws Kms Master Key Provider you must provide |
There was a problem hiding this comment.
Minor: looks like we're referring to the symbol here, so I would say StrictAwsKmsMasterKeyProvider, rather than with spaces.
farleyb-amazon
approved these changes
Jan 27, 2021
robin-aws
pushed a commit
to robin-aws/aws-encryption-sdk-python
that referenced
this pull request
Apr 27, 2021
robin-aws
pushed a commit
that referenced
this pull request
Apr 28, 2021
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: We've seen some confusion over the point that you must only use key ARNs when decrypting with the Strict KMS MK Provider. Attempting to clarify that in the code and docs.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Check any applicable: