doc,test: clarify ChaCha20-Poly1305 usage#42323
doc,test: clarify ChaCha20-Poly1305 usage#42323nodejs-github-bot merged 1 commit intonodejs:masterfrom
Conversation
|
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 |
d1bbf33 to
0307193
Compare
|
Rebased without changes. |
This comment was marked as outdated.
This comment was marked as outdated.
|
Landed in 6559261 |
|
Thanks for reviewing! |
PR-URL: #42323 Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: nodejs#42323 Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: #42323 Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: nodejs#42323 Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: #42323 Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: #42323 Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: #42323 Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: #42323 Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: nodejs/node#42323 Reviewed-By: James M Snell <jasnell@gmail.com>
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.