Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc,test: clarify ChaCha20-Poly1305 usage #42323

Conversation

tniessen
Copy link
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 nodejs-github-bot added the needs-ci PRs that need a full CI run. label Mar 13, 2022
@tniessen 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 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
Copy link
Collaborator

@mscdex
Copy link
Contributor

mscdex commented Mar 13, 2022

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

@tniessen
Copy link
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.

@nodejs-github-bot
Copy link
Collaborator

@tniessen tniessen added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 14, 2022
@tniessen
Copy link
Member Author

tniessen commented Mar 16, 2022

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.

@tniessen tniessen force-pushed the mention-chacha20poly1305-in-crypto-doc branch from d1bbf33 to 0307193 Compare March 20, 2022 18:31
@tniessen
Copy link
Member Author

Rebased without changes.

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

This comment was marked as outdated.

@nodejs-github-bot
Copy link
Collaborator

@tniessen tniessen added the commit-queue Add this label to land a pull request using GitHub Actions. label Mar 21, 2022
@nodejs-github-bot 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 nodejs-github-bot merged commit 6559261 into nodejs:master Mar 21, 2022
@nodejs-github-bot
Copy link
Collaborator

Landed in 6559261

@tniessen
Copy link
Member Author

Thanks for reviewing!

juanarbol pushed a commit that referenced this pull request Apr 4, 2022
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
PR-URL: nodejs#42323
Reviewed-By: James M Snell <jasnell@gmail.com>
This was referenced Apr 5, 2022
juanarbol pushed a commit that referenced this pull request Apr 6, 2022
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
PR-URL: nodejs#42323
Reviewed-By: James M Snell <jasnell@gmail.com>
juanarbol pushed a commit that referenced this pull request May 31, 2022
PR-URL: #42323
Reviewed-By: James M Snell <jasnell@gmail.com>
danielleadams pushed a commit that referenced this pull request Jun 27, 2022
PR-URL: #42323
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request Jul 11, 2022
PR-URL: #42323
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request Jul 31, 2022
PR-URL: #42323
Reviewed-By: James M Snell <jasnell@gmail.com>
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 <jasnell@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, 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
Development

Successfully merging this pull request may close these issues.

4 participants