doc,test: clarify ChaCha20-Poly1305 usage#42323
Merged
Uh oh!
There was an error while loading. Please reload this page.
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
tniessen added crypto 
github-actionsbot removed the request-ci 
Collaborator
nodejs-github-bot commented Mar 13, 2022
Contributor
mscdex commented Mar 13, 2022
Perhaps we should also note that this particular chacha20-poly1305 implementation conforms to RFC 7539 (IIRC)? |
MemberAuthor
tniessen commented Mar 13, 2022
Ideally, yes, but I haven't figured out where to best put that information without duplicating it across all relevant functions. Suggestions welcome, otherwise, I think we'll have to gradually improve the documentation over time. |
28 tasks
Collaborator
nodejs-github-bot commented Mar 14, 2022
jasnell approved these changes Mar 14, 2022
tniessen added the author ready This was referenced Mar 15, 2022
MemberAuthor
@mscdex#42370 adds it to the existing mentions of |
38 tasks
tniessenforce-pushed the mention-chacha20poly1305-in-crypto-doc branch from d1bbf33 to 0307193CompareMemberAuthor
tniessen commented Mar 20, 2022
Rebased without changes. |
github-actionsbot removed the request-ci This comment was marked as outdated.
This comment was marked as outdated.
Collaborator
nodejs-github-bot commented Mar 20, 2022
37 tasks
jasnell approved these changes Mar 21, 2022
tniessen added the commit-queue 
nodejs-github-bot removed the commit-queue Collaborator
nodejs-github-bot commented Mar 21, 2022
Landed in 6559261 |
MemberAuthor
tniessen commented Mar 21, 2022
Thanks for reviewing! |
This was referenced Mar 22, 2022
This was referenced Mar 29, 2022
juanarbol pushed a commit that referenced this pull request Apr 4, 2022
PR-URL: #42323 Reviewed-By: James M Snell <[email protected]>
juanarbol pushed a commit to juanarbol/node that referenced this pull request Apr 5, 2022
PR-URL: nodejs#42323 Reviewed-By: James M Snell <[email protected]>
juanarbol pushed a commit that referenced this pull request Apr 6, 2022
PR-URL: #42323 Reviewed-By: James M Snell <[email protected]>
xtx1130 pushed a commit to xtx1130/node that referenced this pull request Apr 25, 2022
PR-URL: nodejs#42323 Reviewed-By: James M Snell <[email protected]>
juanarbol pushed a commit that referenced this pull request May 31, 2022
PR-URL: #42323 Reviewed-By: James M Snell <[email protected]>
danielleadams pushed a commit that referenced this pull request Jun 27, 2022
PR-URL: #42323 Reviewed-By: James M Snell <[email protected]>
targos pushed a commit that referenced this pull request Jul 11, 2022
PR-URL: #42323 Reviewed-By: James M Snell <[email protected]>
targos pushed a commit that referenced this pull request Jul 31, 2022
PR-URL: #42323 Reviewed-By: James M Snell <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
PR-URL: nodejs/node#42323 Reviewed-By: James M Snell <[email protected]>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment
4 participants
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.
The crypto documentation does not list
chacha20-poly1305as a supported AEAD algorithm and omits that the algorithm requires passing theauthTagLengthoption.This patch changes that and also adds a test to assert that the documented behavior is correct.
Arguably,
chacha20-poly1305should not require theauthTagLengthoption. I'll probably open a separate semver-minor PR to address that and update the documentation accordingly.