fix: Encrypt name to result #211
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
Javascript stimulates named parameters with objects. The previous version used `ciphertext` to denote the usable result from a call to `encrypt`. However, this caused some cogitative load. Ciphertext is used to denote encrypted data, however the result of a call to `encrypt` in not _only_ encrypted data. The AWS Encryption SDK uses envelop encryption, so the result of a call to `encrypt` include not only the encrypted data, but also, the encrypted data keys, metadata, and the encryption context. By returning both the `messageHeader` *and* the `ciphertext` users are confused about what exactly was *in* `ciphertext`. This is compounded by returning `messageHeader` which is just a parsed version of the header that is already returned by the result of `encrypt` The named parameter is now call `result`. This makes it clear that this is the important return value from `encrypt` that is the only value needed for `decrypt`.
mattsb42-aws
approved these changes
Sep 16, 2019
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.
Javascript stimulates named parameters with objects.
The previous version used
ciphertextto denotethe usable result from a call to
encrypt.However, this caused some cogitative load.
Ciphertext is used to denote encrypted data,
however the result of a call to
encryptin not only encrypted data.The AWS Encryption SDK uses envelop encryption,
so the result of a call to
encryptinclude not only the encrypted data,but also, the encrypted data keys, metadata, and the encryption context.
By returning both the
messageHeaderand theciphertextusers are confused about what exactly was in
ciphertext.This is compounded by returning
messageHeaderwhich is just a parsed version of the header
that is already returned by the result of
encryptThe named parameter is now call
result.This makes it clear that this is the important return value from
encryptthat is the only value needed for
decrypt.This change is only merged without a major version bumb
because the project is still in bets.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Check any applicable: