FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc,test: clarify ChaCha20-Poly1305 usage by tniessen · Pull Request #42323 · nodejs/node · GitHub

/ node Public

doc,test: clarify ChaCha20-Poly1305 usage - #42323

Merged
nodejs-github-bot merged 1 commit into
nodejs:masterfrom
tniessen:mention-chacha20poly1305-in-crypto-doc
Mar 21, 2022
ConversationCommits (1)ChecksFiles changed
Merged

doc,test: clarify ChaCha20-Poly1305 usage#42323
nodejs-github-bot merged 1 commit into
nodejs:masterfrom
tniessen:mention-chacha20poly1305-in-crypto-doc

Conversation

tniessen commented Mar 13, 2022

Copy link
Copy Markdown
Member

The crypto documentation does not list chacha20-poly1305 as a supported AEAD algorithm and omits that the algorithm requires passing the authTagLength option.

This patch changes that and also adds a test to assert that the documented behavior is correct.

Arguably, chacha20-poly1305 should not require the authTagLength option. I'll probably open a separate semver-minor PR to address that and update the documentation accordingly.

nodejs-github-bot added the needs-ci PRs that need a full CI run. label Mar 13, 2022
tniessen added crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. test Issues and PRs related to the tests. request-ci Add this label to start a Jenkins CI on a PR. labels Mar 13, 2022
github-actions Bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Mar 13, 2022

nodejs-github-bot commented Mar 13, 2022

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/42992/

mscdex commented Mar 13, 2022

Copy link
Copy Markdown
Contributor

Perhaps we should also note that this particular chacha20-poly1305 implementation conforms to RFC 7539 (IIRC)?

tniessen commented Mar 13, 2022

Copy link
Copy Markdown
Member Author

Perhaps we should also note that this particular chacha20-poly1305 implementation conforms to RFC 7539 (IIRC)?

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.

github-actions Bot mentioned this pull request Mar 14, 2022
Open
28 tasks

nodejs-github-bot commented Mar 14, 2022

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/43005/

tniessen added the author ready PRs that have at least one approval, no outstanding review comments, and a CI started. label Mar 14, 2022
This was referenced Mar 15, 2022
Open
Open
tniessen mentioned this pull request Mar 16, 2022
Merged

tniessen commented Mar 16, 2022 •
edited
Loading

Copy link
Copy Markdown
Member Author

Perhaps we should also note that this particular chacha20-poly1305 implementation conforms to RFC 7539 (IIRC)?

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.

@mscdex #42370 adds it to the existing mentions of chacha20-poly1305.

github-actions Bot mentioned this pull request Mar 17, 2022
Open
38 tasks
tniessen force-pushed the mention-chacha20poly1305-in-crypto-doc branch from d1bbf33 to 0307193 Compare March 20, 2022 18:31

tniessen commented Mar 20, 2022

Copy link
Copy Markdown
Member Author

Rebased without changes.

tniessen added the request-ci Add this label to start a Jenkins CI on a PR. label Mar 20, 2022
github-actions Bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Mar 20, 2022

This comment was marked as outdated.

Sign in to view

nodejs-github-bot commented Mar 20, 2022

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/43137/

github-actions Bot mentioned this pull request Mar 21, 2022
Open
37 tasks
tniessen added the commit-queue Add this label to land a pull request using GitHub Actions. label Mar 21, 2022
nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Mar 21, 2022
nodejs-github-bot merged commit 6559261 into nodejs:master Mar 21, 2022

nodejs-github-bot commented Mar 21, 2022

Copy link
Copy Markdown
Collaborator

Landed in 6559261

tniessen commented Mar 21, 2022

Copy link
Copy Markdown
Member Author

Thanks for reviewing!

This was referenced Mar 22, 2022
Open
Open
Open
Open
Open
Open
Open
This was referenced Mar 29, 2022
Open
Open
juanarbol pushed a commit that referenced this pull request Apr 4, 2022
doc,test: clarify ChaCha20-Poly1305 usage
eb319bf 
PR-URL: #42323
Reviewed-By: James M Snell <jasnell@gmail.com>
juanarbol pushed a commit to juanarbol/node that referenced this pull request Apr 5, 2022
doc,test: clarify ChaCha20-Poly1305 usage
5602c08 
PR-URL: nodejs#42323
Reviewed-By: James M Snell <jasnell@gmail.com>
This was referenced Apr 5, 2022
Closed
Merged
juanarbol pushed a commit that referenced this pull request Apr 6, 2022
doc,test: clarify ChaCha20-Poly1305 usage
5589a44 
PR-URL: #42323
Reviewed-By: James M Snell <jasnell@gmail.com>
xtx1130 pushed a commit to xtx1130/node that referenced this pull request Apr 25, 2022
doc,test: clarify ChaCha20-Poly1305 usage
be05fef 
PR-URL: nodejs#42323
Reviewed-By: James M Snell <jasnell@gmail.com>
juanarbol pushed a commit that referenced this pull request May 31, 2022
doc,test: clarify ChaCha20-Poly1305 usage
2b80754 
PR-URL: #42323
Reviewed-By: James M Snell <jasnell@gmail.com>
juanarbol mentioned this pull request May 31, 2022
Closed
danielleadams pushed a commit that referenced this pull request Jun 27, 2022
doc,test: clarify ChaCha20-Poly1305 usage
dff6d82 
PR-URL: #42323
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request Jul 11, 2022
doc,test: clarify ChaCha20-Poly1305 usage
805a3e5 
PR-URL: #42323
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request Jul 31, 2022
doc,test: clarify ChaCha20-Poly1305 usage
6c00369 
PR-URL: #42323
Reviewed-By: James M Snell <jasnell@gmail.com>
targos mentioned this pull request Aug 3, 2022
Merged
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
doc,test: clarify ChaCha20-Poly1305 usage
35d9dca 
PR-URL: nodejs/node#42323
Reviewed-By: James M Snell <jasnell@gmail.com>
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

jasnell jasnell approved these changes

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no outstanding review comments, and a CI started. crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. needs-ci PRs that need a full CI run. test Issues and PRs related to the tests.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

Back | FazBrowse Home | New Git URL