crypto: modernize DH/ECDH/ECDH-ES #31178

tniessen · 2020-01-03T15:27:45Z

This adds support for DH/ECDH/ECDH-ES via the KeyObject API, and should fix #26626. I also added DH support to generateKeyPair, which is a partial solution to #28404. There are still lots of things I need to figure out, but I would like to see if people are okay with this approach.

(Note that the current API does not support "raw" DH keys, only SPKI/PKCS#8 keys are supported as of now. That will likely change via the previously discussed .params / .fields APIs.)

cc @nodejs/crypto @nodejs/security

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

doc/api/crypto.md

sam-github

LGTM in principle, some comments on the WIP.

doc/api/crypto.md

lib/internal/crypto/diffiehellman.js

src/node_crypto.cc

src/node_crypto_groups.h

panva · 2020-01-03T17:54:46Z

I can confirm the missing ECDH-ES JWA algorithm support for x25519 and x448 keys is solved with this (closes #26626).

@tniessen would it be possible to split the change to

add the diffieHellman method only (accepting only current 'ec', 'x25519' and 'x448' key objects)
add the dh KeyObject support in a follow up PR?

Reason I ask is i'd like to see 1) backported to lts/erbium and in order to do that It would likely be easier if the change was as simple as possible.

sam-github · 2020-01-03T18:48:47Z

@panva Since either the whole PR, or a subset, are semver-minor, there isn't anything blocking backporting to LTS.

panva · 2020-01-03T18:49:25Z

Great.

bnoordhuis

Overall direction seems okay to me.

src/node_crypto.cc

tniessen · 2020-01-04T14:54:30Z

Thank you for the initial round of reviews, I'll try to finish up within the next few days.

Overall direction seems okay to me.

I would happily accept alternative directions! This is the best I came up with so far :)

doc/api/crypto.md

src/node_crypto.cc

lundibundi

Few nits regarding error handling.

lib/internal/crypto/keygen.js

tniessen · 2020-01-11T20:23:45Z

@nodejs/crypto PTAL.

BridgeAR

The JS code is LGTM

lib/internal/crypto/keygen.js

test/parallel/test-crypto-dh-stateless.js

Refs: #31178 Refs: #31445 PR-URL: #31873 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

The new key type 'dh' corresponds to EVP_PKEY_DH. PR-URL: nodejs#31178 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>

PR-URL: nodejs#31178 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>

This allows using the generateKeyPair API for DH instead of the old stateful DH APIs. PR-URL: nodejs#31178 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>

Currently, Node.js has separate (stateful) APIs for DH/ECDH, and no support for ECDH-ES. This commit adds a single stateless function to compute the DH/ECDH/ECDH-ES secret based on two KeyObjects. PR-URL: nodejs#31178 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>

test-crypto-keygen and test-crypto-dh-stateless are currently flaky on ARM CI systems due to their slow CPUs. PR-URL: nodejs#31178 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>

The new key type 'dh' corresponds to EVP_PKEY_DH. PR-URL: #31178 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>

PR-URL: #31178 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>

This allows using the generateKeyPair API for DH instead of the old stateful DH APIs. PR-URL: #31178 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>

Currently, Node.js has separate (stateful) APIs for DH/ECDH, and no support for ECDH-ES. This commit adds a single stateless function to compute the DH/ECDH/ECDH-ES secret based on two KeyObjects. PR-URL: #31178 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>

test-crypto-keygen and test-crypto-dh-stateless are currently flaky on ARM CI systems due to their slow CPUs. PR-URL: #31178 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>

mhdawson · 2022-03-17T13:53:11Z

@tniessen I noticed some test excludes in the parallel tests:

[$arch==arm || $arch==arm64]
# https://github.com/nodejs/node/pull/31178
test-crypto-dh-stateless: SKIP
test-crypto-keygen: SKIP

Since this PR is closed I'm wondering if they are still needed and/or there is an open issue that should be listed instead of this one as to why they are excluded?

tniessen · 2022-03-17T15:30:38Z

@mhdawson These tests were disabled because they kept timing out. I "temporarily disabled" them more than two years ago, see #31178 (comment) 😄

tniessen added wip Issues and PRs that are still a work in progress. crypto Issues and PRs related to the crypto subsystem. semver-minor PRs that contain new features and should be released in the next minor version. labels Jan 3, 2020

nodejs-github-bot added the lib / src Issues and PRs related to general changes in the lib or src directory. label Jan 3, 2020

BridgeAR reviewed Jan 3, 2020

View reviewed changes

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

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

tniessen force-pushed the crypto-modernize-dh branch from e394dd5 to 6261781 Compare January 3, 2020 15:46

sam-github reviewed Jan 3, 2020

View reviewed changes

bnoordhuis reviewed Jan 4, 2020

View reviewed changes

src/node_crypto.cc Show resolved Hide resolved

src/node_crypto.cc Outdated Show resolved Hide resolved

src/node_crypto.cc Show resolved Hide resolved

tniessen force-pushed the crypto-modernize-dh branch from 6261781 to 0dfa9c5 Compare January 4, 2020 14:41

addaleax reviewed Jan 4, 2020

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 Show resolved Hide resolved

tniessen force-pushed the crypto-modernize-dh branch 4 times, most recently from 27d73df to 78043cc Compare January 5, 2020 01:35

lundibundi reviewed Jan 5, 2020

View reviewed changes

lib/internal/crypto/keygen.js Show resolved Hide resolved

lib/internal/crypto/keygen.js Show resolved Hide resolved

lib/internal/crypto/keygen.js Outdated Show resolved Hide resolved

tniessen force-pushed the crypto-modernize-dh branch from 78043cc to eb347a5 Compare January 5, 2020 17:36

tniessen mentioned this pull request Jan 8, 2020

Supported asymmetric key types #26996

Open

16 tasks

tniessen force-pushed the crypto-modernize-dh branch from eb347a5 to bc309fb Compare January 8, 2020 14:22

tniessen marked this pull request as ready for review January 8, 2020 14:27

BridgeAR removed the wip Issues and PRs that are still a work in progress. label Jan 9, 2020

tniessen force-pushed the crypto-modernize-dh branch from e98c950 to 4378c9d Compare January 11, 2020 20:19

tniessen force-pushed the crypto-modernize-dh branch from 4378c9d to 70dc715 Compare January 11, 2020 20:33

BridgeAR reviewed Jan 12, 2020

View reviewed changes

lib/internal/crypto/keygen.js Show resolved Hide resolved

test/parallel/test-crypto-dh-stateless.js Outdated Show resolved Hide resolved

tniessen force-pushed the crypto-modernize-dh branch 2 times, most recently from 62197f1 to a962a3d Compare January 15, 2020 21:36

BethGriggs added the backport-requested-v10.x label Feb 27, 2020

rhenwood-arm mentioned this pull request Mar 12, 2020

re-enable crypto dh keygen testing on Arm #32233

Open

codebytere mentioned this pull request Mar 16, 2020

test: add secp224k1 check in crypto-dh-stateless #31715

Closed

2 tasks

targos removed the lts-watch-v12.x label Apr 25, 2020

targos pushed a commit to targos/node that referenced this pull request Apr 25, 2020

crypto: add key type 'dh'

0f4946e

The new key type 'dh' corresponds to EVP_PKEY_DH. PR-URL: nodejs#31178 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>

targos pushed a commit to targos/node that referenced this pull request Apr 25, 2020

crypto: simplify DH groups

fd6bdfb

PR-URL: nodejs#31178 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>

targos pushed a commit to targos/node that referenced this pull request Apr 25, 2020

crypto: add DH support to generateKeyPair

5380c33

This allows using the generateKeyPair API for DH instead of the old stateful DH APIs. PR-URL: nodejs#31178 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>

targos pushed a commit that referenced this pull request Apr 28, 2020

crypto: add key type 'dh'

9f85585

The new key type 'dh' corresponds to EVP_PKEY_DH. PR-URL: #31178 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>

targos pushed a commit that referenced this pull request Apr 28, 2020

crypto: simplify DH groups

5dab489

PR-URL: #31178 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>

targos pushed a commit that referenced this pull request Apr 28, 2020

crypto: add DH support to generateKeyPair

1977136

This allows using the generateKeyPair API for DH instead of the old stateful DH APIs. PR-URL: #31178 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>

targos pushed a commit that referenced this pull request Apr 28, 2020

test: skip keygen tests on arm systems

733002b

test-crypto-keygen and test-crypto-dh-stateless are currently flaky on ARM CI systems due to their slow CPUs. PR-URL: #31178 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>

targos mentioned this pull request May 2, 2020

v12.17.0 release proposal #33197

Merged

vishalsevani mentioned this pull request Oct 6, 2020

Issue for large number of ssh connections with DH key exchange on CentOS 8.2 mscdex/ssh2#934

Closed

tniessen mentioned this pull request Jan 24, 2021

generateKeyPair('ec') should not support NODE-ED* and NODE-X* #37055

Closed

panva mentioned this pull request Feb 3, 2021

crypto: introduce crypto/promises #37218

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

crypto: modernize DH/ECDH/ECDH-ES #31178

crypto: modernize DH/ECDH/ECDH-ES #31178

tniessen commented Jan 3, 2020 •

edited

sam-github left a comment

panva commented Jan 3, 2020

sam-github commented Jan 3, 2020

panva commented Jan 3, 2020

bnoordhuis left a comment

tniessen commented Jan 4, 2020

lundibundi left a comment

tniessen commented Jan 11, 2020

BridgeAR left a comment

mhdawson commented Mar 17, 2022

tniessen commented Mar 17, 2022

crypto: modernize DH/ECDH/ECDH-ES #31178

crypto: modernize DH/ECDH/ECDH-ES #31178

Conversation

tniessen commented Jan 3, 2020 • edited

Checklist

sam-github left a comment

Choose a reason for hiding this comment

panva commented Jan 3, 2020

sam-github commented Jan 3, 2020

panva commented Jan 3, 2020

bnoordhuis left a comment

Choose a reason for hiding this comment

tniessen commented Jan 4, 2020

lundibundi left a comment

Choose a reason for hiding this comment

tniessen commented Jan 11, 2020

BridgeAR left a comment

Choose a reason for hiding this comment

mhdawson commented Mar 17, 2022

tniessen commented Mar 17, 2022

tniessen commented Jan 3, 2020 •

edited