crypto: add support for chacha20-poly1305 for AEAD #24081

chux0519 · 2018-11-04T15:47:33Z

Openssl support AEAD_CHACHA20_POLY1305(rfc7539) since 1.1.

Fixes: #24080
Refs: https://tools.ietf.org/html/rfc7539

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

targos · 2018-11-04T15:49:49Z

@nodejs/crypto

doc/api/crypto.md

src/node_crypto.cc

refack · 2018-11-05T00:50:27Z

Hello @chux0519 welcome, and thank you for your contribution 🥇
If you are not familiar with our review and landing process, it's covered in CONTRIBUTING.md

P.S. If you have any question you can also feel free to contact me directly.

chux0519 · 2018-11-05T00:56:00Z

Hello @chux0519 welcome, and thank you for your contribution 🥇
If you are not familiar with our review and landing process, it's covered in CONTRIBUTING.md

P.S. If you have any question you can also feel free to contact me directly.

thx, I will change my code to follow that guide

chux0519 · 2018-11-05T02:27:20Z

It seems make lint-md can not check the 80 characters limit.

ryzokuken · 2018-11-05T03:49:09Z

@chux0519 lint-md lints the markdown in the codebase. It is geared towards doc-only contributions.

chux0519 · 2018-11-05T04:19:58Z

@chux0519 lint-md lints the markdown in the codebase. It is geared towards doc-only contributions.

thx, i see

Trott · 2018-11-05T04:20:57Z

It seems make lint-md can not check the 80 characters limit.

@chux0519 It does not currently check that line lengths are 80 characters or less, although I've just opened a PR to implement that. #24094

chux0519 · 2018-11-05T04:33:33Z

#24094

It would be great to have that, And will avoid many comments in reviews causing by doc lint like this one above.

doc/api/crypto.md

src/node_crypto.cc

refack · 2018-11-06T14:40:33Z

After rebasing to current master, Travis should not fail anymore for lint in commit message - #23739

sam-github

LGTM, thanks.

sam-github · 2018-11-06T18:55:27Z

src/node_crypto.cc

@@ -2855,8 +2855,7 @@ bool CipherBase::CheckCCMMessageLength(int message_len) {
 bool CipherBase::IsAuthenticatedMode() const {
  // Check if this cipher operates in an AEAD mode that we support.
  CHECK(ctx_);
-  const int mode = EVP_CIPHER_CTX_mode(ctx_.get());
-  return IsSupportedAuthenticatedMode(mode);
+  return IsSupportedAuthenticatedMode(EVP_CIPHER_CTX_cipher(ctx_.get()));


Would overloading IsSupportedAuthenticatedMode() to also accept the EVP_CIPHER_CTX type make sense? It would shorten these 3 repeated calls.

thank you, It's a good idea, I will add one more IsSupportedAuthenticatedMode to take the EVP_CIPHER_CTX as param

sam-github · 2018-11-06T18:56:58Z

src/node_crypto.cc

-  return mode == EVP_CIPH_CCM_MODE ||
+static bool IsSupportedAuthenticatedMode(const EVP_CIPHER* cipher) {
+  const int mode = EVP_CIPHER_mode(cipher);
+  return EVP_CIPHER_nid(cipher) == NID_chacha20_poly1305 ||


Maybe a comment here to state that chacha20-poly1305 is an AEAD cipher, but that its mode of 0 doesn't indicate that?

I will add a comment to indicate it

sam-github · 2018-11-06T18:58:16Z

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

bnoordhuis

Thanks, LGTM with a request and a suggestion.

bnoordhuis · 2018-11-06T18:53:18Z

src/node_crypto.cc

+      auth_tag_len_ = auth_tag_len;
+    }
+  } else {
+    // CCM / OCB / AEAD-chacha20-poly1305


Can you add a CHECK here that verifies the cipher is one of these?

@bnoordhuis maybe the comment can just be removed? The function is protected by a CHECK(IsAuthenticatedMode()); already, so we know this is an AEAD cipher, and what's happening here is that GCM has some special requirements on tag length that aren't shared by any other AEAD ciphers.

Thank you for comment, will remove it

bnoordhuis · 2018-11-06T18:54:53Z

src/node_crypto.cc

-  if (kind_ == kDecipher && IsSupportedAuthenticatedMode(mode)) {
-    MaybePassAuthTagToOpenSSL();
+  if (
+    kind_ == kDecipher &&


Style: should go on the previous line; i.e., no line break after the paren. The next line should have 4 spaces of indent.

If it gets too unwieldy / doesn't fit in 80 columns, assign the cipher to a variable first:

const EVP_CIPHER* cipher = EVP_CIPHER_CTX_cipher(ctx_.get()); if (kind_ == kDecipher && IsSupportedAuthenticatedMode(cipher)) { // ... }

(Arguably a good idea in any case; easier to read, IMO.)

Thank you, I will fix this

test/fixtures/aead-vectors.js

refack · 2018-11-07T00:32:47Z

Resume: https://ci.nodejs.org/job/node-test-commit/22946/

P.S. I'm self-assigned this so I'll get notifications from Github, and so that I will not lose track of it and help steward it to completion.

tniessen

LGTM, but it would be best to explicitely mention this change in the changes section of createCipheriv and createDecipheriv (in doc/api/crypto.md) like this:

  - version: REPLACEME
    pr-url: https://github.com/nodejs/node/pull/24081
    description: The cipher `chacha20-poly1305` is now supported.

Could you add this to the top of the respective changes: metadata sections in doc/api/crypto.md? (Probably right above OCB support.)

chux0519 · 2018-11-07T08:30:47Z

@tniessen Of course, I have added them

targos · 2018-11-07T08:43:35Z

doc/api/crypto.md

@@ -1382,6 +1382,9 @@ Adversaries][] for details.
 <!-- YAML
 added: v0.1.94
 changes:
+  - version: v12.0.0


Suggested change

- version: v12.0.0

- version: REPLACEME

targos · 2018-11-07T08:43:52Z

doc/api/crypto.md

@@ -1468,6 +1471,9 @@ to create the `Decipher` object.
 <!-- YAML
 added: v0.1.94
 changes:
+  - version: v12.0.0


Suggested change

- version: v12.0.0

- version: REPLACEME

v10.14.0 right ? Sorry, I just used the ./out/Release/node -v

We do not know yet in which actual release this will land, so instead we write REPLACEME and the value is changed when the release that includes this change is done.

ah, I misunderstood the REPLACEMENT

Thank you for being so patient.

I think you are the one being patient! Thanks.

targos · 2018-11-07T08:44:38Z

I assume this is semver-minor?

tniessen · 2018-11-07T14:44:35Z

@targos I don't think we have been consistent about that in the past, I'd be okay with marking it semver-minor.

tniessen · 2018-11-07T16:19:40Z

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

openSSL supports AEAD_CHACHA20_POLY1305(rfc7539) since 1.1. PR-URL: nodejs#24081 Fixes: nodejs#24080 Refs: https://tools.ietf.org/html/rfc7539 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>

refack · 2018-11-07T23:48:09Z

Landed in 5c59622
Congratulations @chux0519 for GitHub promoting you from

to

openSSL supports AEAD_CHACHA20_POLY1305(rfc7539) since 1.1. PR-URL: #24081 Fixes: #24080 Refs: https://tools.ietf.org/html/rfc7539 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>

openSSL supports AEAD_CHACHA20_POLY1305(rfc7539) since 1.1. PR-URL: nodejs#24081 Fixes: nodejs#24080 Refs: https://tools.ietf.org/html/rfc7539 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>

rvagg · 2018-11-18T04:04:27Z

Hey @chux0519, thanks for contributing this! I wasn't even aware we didn't support it but it'll help us get closer to solid TLS1.3 support (eventually). You'll note that it's in 11.2.0 now btw.

chux0519 · 2018-11-18T04:31:33Z

Hey @chux0519, thanks for contributing this! I wasn't even aware we didn't support it but it'll help us get closer to solid TLS1.3 support (eventually). You'll note that it's in 11.2.0 now btw.

I'm happy to make this little contrubution to nodejs, thank your all guys' help during the PR process

openSSL supports AEAD_CHACHA20_POLY1305(rfc7539) since 1.1. PR-URL: #24081 Fixes: #24080 Refs: https://tools.ietf.org/html/rfc7539 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>

Notable changes: * crypto: * add support for chacha20-poly1305 for AEAD (chux0519) #24081 * increase maxmem range from 32 to 53 bits (Tobias Nießen) #28799 * deps: * update npm to 6.11.3 (claudiahdz) #29430 * upgrade openssl sources to 1.1.1d (Sam Roberts) #29921 * dns: * remove dns.promises experimental warning (cjihrig) #26592 * fs: * remove experimental warning for fs.promises (Anna Henningsen) #26581 * http: * makes response.writeHead return the response (Mark S. Everitt) #25974 * http2: * makes response.writeHead return the response (Mark S. Everitt) #25974 * n-api: * make func argument of napi\_create\_threadsafe\_function optional (legendecas) #27791 * mark version 5 N-APIs as stable (Gabriel Schulhof) #29401 * implement date object (Jarrod Connolly) #25917 * process: * add --unhandled-rejections flag (Ruben Bridgewater) #26599 * stream: * implement Readable.from async iterator utility (Guy Bedford) #27660 * make Symbol.asyncIterator support stable (Matteo Collina) #26989 PR-URL: #29875

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. crypto Issues and PRs related to the crypto subsystem. labels Nov 4, 2018

chux0519 force-pushed the chacha branch from 5065682 to c0c9a05 Compare November 4, 2018 15:56

tniessen reviewed Nov 4, 2018

View reviewed changes

doc/api/crypto.md Outdated Show resolved Hide resolved

src/node_crypto.cc Outdated Show resolved Hide resolved

src/node_crypto.cc Outdated Show resolved Hide resolved

src/node_crypto.cc Outdated Show resolved Hide resolved

chux0519 force-pushed the chacha branch from c0c9a05 to b26fbb1 Compare November 5, 2018 02:20

sam-github reviewed Nov 5, 2018

View reviewed changes

doc/api/crypto.md Outdated Show resolved Hide resolved

src/node_crypto.cc Outdated Show resolved Hide resolved

chux0519 force-pushed the chacha branch from 2056732 to ab420ae Compare November 6, 2018 11:45

sam-github approved these changes Nov 6, 2018

View reviewed changes

bnoordhuis approved these changes Nov 6, 2018

View reviewed changes

tniessen reviewed Nov 6, 2018

View reviewed changes

test/fixtures/aead-vectors.js Show resolved Hide resolved

refack added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Nov 7, 2018

refack self-assigned this Nov 7, 2018

refack removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Nov 7, 2018

tniessen approved these changes Nov 7, 2018

View reviewed changes

targos reviewed Nov 7, 2018

View reviewed changes

targos added the semver-minor PRs that contain new features and should be released in the next minor version. label Nov 7, 2018

refack force-pushed the chacha branch from 7ca89c6 to 5c59622 Compare November 7, 2018 23:44

refack merged commit 5c59622 into nodejs:master Nov 7, 2018

BridgeAR mentioned this pull request Nov 14, 2018

Release proposal: v11.2 #24350

Merged

refack removed their assignment Mar 11, 2019

reklatsmasters mentioned this pull request Apr 21, 2019

crypto: getCiphers() returns unsupported cipher #27335

Closed

mscdex added the lts-watch-v10.x label Apr 21, 2019

imcotton mentioned this pull request May 3, 2019

v10.16.0 proposal #27514

Merged

BethGriggs added backport-requested-v10.x and removed lts-watch-v10.x labels May 10, 2019

tniessen mentioned this pull request Oct 21, 2019

v10.17.0 proposal #29875

Merged

crypto: add support for chacha20-poly1305 for AEAD #24081

crypto: add support for chacha20-poly1305 for AEAD #24081

Conversation

chux0519 commented Nov 4, 2018 • edited Loading

Checklist

targos commented Nov 4, 2018

refack commented Nov 5, 2018

chux0519 commented Nov 5, 2018

chux0519 commented Nov 5, 2018

ryzokuken commented Nov 5, 2018

chux0519 commented Nov 5, 2018

Trott commented Nov 5, 2018

chux0519 commented Nov 5, 2018

refack commented Nov 6, 2018 • edited Loading

sam-github left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sam-github commented Nov 6, 2018

bnoordhuis left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

refack commented Nov 7, 2018 • edited Loading

tniessen left a comment

Choose a reason for hiding this comment

chux0519 commented Nov 7, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

targos commented Nov 7, 2018

tniessen commented Nov 7, 2018

tniessen commented Nov 7, 2018

refack commented Nov 7, 2018

rvagg commented Nov 18, 2018

chux0519 commented Nov 18, 2018

chux0519 commented Nov 4, 2018 •

edited

Loading

refack commented Nov 6, 2018 •

edited

Loading

refack commented Nov 7, 2018 •

edited

Loading