cipher: clarify the EncryptingKey docs #488
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
Previously the `aws_lc_rs::cipher::EncryptingKey` type's `encrypt()` and `less_safe_encrypt()` functions were documented as returning a reference to the encrypted data. However, the implementation uses an `in_out: &mut [u8]` argument for the encrypted data and **returns** a `DecryptionContext`, not a ref. to ciphertext. Similarly, it feels important to call out that the `DecryptionContext` when using `encrypt()` contains a randomly generated IV. This makes usage clearer and also provides good counter-point to the disclaimer on `less_safe_encrypt()` about the provenance (and safety) of the IV being unknown.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #488 +/- ##
==========================================
- Coverage 95.80% 92.69% -3.11%
==========================================
Files 61 63 +2
Lines 8143 8456 +313
Branches 0 8456 +8456
==========================================
+ Hits 7801 7838 +37
- Misses 342 361 +19
- Partials 0 257 +257 ☔ View full report in Codecov by Sentry. |
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.
Issues:
N/A
Description of changes:
While working with the
aws_lc_rs::ciphermodule downstream in rustls/rustls#2066 we noticed the documentation here could use a small touch-up.Previously the
aws_lc_rs::cipher::EncryptingKeytype'sencrypt()andless_safe_encrypt()functions were documented as returning a reference to the encrypted data. However, the implementation uses anin_out: &mut [u8]argument for the encrypted data and returns aDecryptionContext, not a ref. to ciphertext.Similarly, it feels important to call out that the
DecryptionContextwhen usingencrypt()contains a randomly generated IV. This makes usage clearer and also provides good counter-point to the disclaimer onless_safe_encrypt()about the provenance (and safety) of the IV being unknown.Call-outs:
None that I can think of :-)
Testing:
N/A - docs only update.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and the ISC license.