tls: Add PSK support #23188

lundibundi · 2018-09-30T22:14:13Z

~~Basically #14978.~~
~~Wanted to push to that branch but started with a rebase which resulted in github closing the PR and disallowing me to push there.~~

Add the pskCallback client/server option, which resolves an identity
or identity hint to a pre-shared key.

Add the pskIdentityHint server option to set the identity hint for the
ServerKeyExchange message.

Co-authored-by: Chris Osborn chris.osborn@sitelier.com
Co-authored-by: stephank gh@stephank.nl
Co-authored-by: Taylor Zane Glaeser tzglaeser@gmail.com

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

Additional changes:

removed ifdef check for openssl < 1.0.0 as we don't support that
hardened args/return value checks in client/server psk callbacks
small style refactorings in _tsl_common.js
updated docs according to new styles/linting

~~Edit: note for all reviewers, thanks for reviewing, though this is currently waiting on @taylorzane, I'm not sure if he will have time to finish this.~~
* If he does have time then we will either float those comments and changes to #14978 or I'll just give him push access to this branch.
* If he doesn't have time for this then I'll pick it up and address comments/review more thoroughly.

~~Initially, I've only just rebased this on master and did simple cleanups without changing much.~~
~~Adding 'In Progress' to be verbose.~~

~~I'll proceed with this now.~~

Addressed review comments and updated PR description.

nodejs-github-bot · 2018-09-30T22:14:15Z

@lundibundi build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/1080/pipeline

tniessen · 2018-09-30T22:50:08Z

cc @nodejs/crypto

Why is the PSK passed as a hexadecimal string instead of a buffer?

doc/api/tls.md

src/node_crypto.cc

doc/api/tls.md

lib/_tls_common.js

src/node_crypto.cc

test/parallel/test-tls-psk-circuit.js

test/parallel/test-tls-psk-client.js

lundibundi · 2018-10-02T13:06:47Z

Updated initial post on the status of this PR.

lundibundi · 2018-10-28T14:44:40Z

It's been 25 days already 😮, sorry for the delay, wanted to get back to this in a week or two.
I'll proceed with this now.

lundibundi · 2018-10-29T09:52:32Z

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

lundibundi · 2018-10-29T10:12:48Z

@tniessen I assume that's due to https://tools.ietf.org/html/rfc4279#section-5.4

5.4. Requirements for Management Interfaces
In the absence of an application profile specification specifying
otherwise, a management interface for entering the PSK and/or PSK
identity MUST support the following:
...

Entering PSKs up to 64 octets in length as ASCII strings and in
hexadecimal encoding.

Though perhaps this should be changed to use Buffer (as strings are utf8)?

sam-github

Its a good feature to have, thank you.

I feel that there is some lack of clarity in the types. Some things that are null terminated strings are Buffer in the API, some things that are arbitrary binary data are hex strings, etc. But perhaps I misunderstand, please see my comments, and review the API.

doc/api/tls.md

lib/_tls_wrap.js

src/tls_wrap.cc

test/parallel/test-tls-psk-circuit.js

lundibundi · 2018-10-31T22:37:39Z

Currently, we cannot connect to a server using PSK without rejectUnauthorized: false as I assume due to

node/src/node_crypto.cc

Lines 2150 to 2154 in e35f671

    
           // XXX(bnoordhuis) The UNABLE_TO_GET_ISSUER_CERT error when there is no 
        
           // peer certificate is questionable but it's compatible with what was 
        
           // here before. 
        
           long x509_verify_error =  // NOLINT(runtime/int) 
        
               X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT;

and if we remove that then, later on, we will get

node/lib/tls.js

Lines 236 to 238 in e35f671

    
           } else { 
        
             reason = 'Cert is empty'; 
        
           }

(because, obviously, there is no certificate).
@bnoordhuis could you maybe help (as that was your comment initially).
I'm not sure how to procceed with this one.
(refs #23188 (comment))

lundibundi · 2018-11-10T11:52:22Z

ping @bnoordhuis PTAL #23188 (comment) and #23188 (comment)).
ping @sam-github @addaleax @vsemozhetbyt.

sam-github · 2018-11-13T18:23:12Z

@lundibundi its quite a bit of work to verify whether you have addressed all comments. You didn't address https://github.com/nodejs/node/pull/23188/files#r229014173 or https://github.com/nodejs/node/pull/23188/files#r228850947. It doesn't look like the identity hint was constrained to utf-8, it still accepts Buffer/arbitrary binary data (which will get truncated to the first NUL byte by ossl). I don't have the time today to go through every comment and re-read the diff to check what you did to address the comments.

You can make re-review easier by following up on all comments with a thumbs up icon, or a statement saying you agree and will address, or some other indication of what happened.

Trott · 2018-11-28T03:31:24Z

What's the status of this one? In progress? Stalled? Ready for reviews? @lundibundi @sam-github

lundibundi · 2018-11-28T09:52:30Z

@Trott @sam-github, sorry for the delay, was swamped at work.
At first, I wanted to wait for the feedback on 'make hint Unicode' and 'certificate checking', but I've gone ahead and changed those now.

Could someone from @nodejs/crypto take a look at https://github.com/nodejs/node/pull/23188/files#diff-801e3948990f4965a8ea4aca4a423864R2264 as I'm not sure if those changes are ok.

This is ready for review.

lundibundi · 2018-12-09T15:22:26Z

Rebased on master just in case.

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

ping @sam-github @addaleax @bnoordhuis @vsemozhetbyt.

sam-github

There are some nits, and we have to sort out the oddity with the hex-encoded args.

#23188 (comment) is also blocking - we can't release this telling people to provide rejectUnauthorized as an argument, that would make client auth completely insecure. Better to figure out another way, or to disallow mixing PSK and requestCert or PSK and any non-PSK ciphers.

doc/api/tls.md

lib/_tls_wrap.js

doc/api/tls.md

sam-github · 2018-12-13T21:01:32Z

doc/api/tls.md

+    with "decrypt_error" before it will be finished completely.
+    Note that PSK ciphers are disabled by default, and using TLS-PSK thus
+    requires explicitly specifying a cipher suite with the `ciphers` option.
+    Additionally, it may be necessary to disable `rejectUnauthorized` if a


This is a bug. If openssl allows a client to have both a PSK cipher suite configured, and a non-PSK certificate-based authentication configured so the server can choose which one to use, then the connection should be secure. disabling rejectUnauthorized means the cert-based auth won't happen, and the connection will be insecure. I don't see how we can release this feature with a security hole like this.

If this is fundamentally a problem (bug?) with openssl, we can raise with them, and then perhaps work harder in this PR to make it not possible for a server to both request a client certificate, and enable PSK ciphers.

It is also possible that this is something that could be fixed in our code, where we are validating a cert when we should not be when PSK was used.

You said to @addaleax that you would investigate this further. Have you? If you can't figure out what's going on, I could take a shot at looking at this.

Sorry, I forgot to remove this from here. Refer to #23188 (comment) and
https://github.com/nodejs/node/pull/23188/files#diff-f6e3a86962eaf0897ab59e88b418e64fR986

It will be necessary to provide a custom [`tls.checkServerIdentity()`][] for the connection as the default one will try to check hostname/IP of the server against the certificate but that's not applicable for PSK because there won't be a certificate present.

lib/_tls_wrap.js

sam-github · 2018-12-14T18:20:06Z

https://wiki.openssl.org/index.php/TLS1.3#PSKs

I'm reviewing what we'll need for TLSv1.3 support, and came across the above.

I haven't looked really closely, yet, but my initial impression is that while some more work might be necessary to support PSKs with TLS1.3, that it wouldn't cause the API here to break, though some aspects might become optional (identity hints).

It would be unfortunate to add a new API and shortly after have to change it, so even though TLS1.3 isn't in Node.js yet, lets make sure we know the impact.

lundibundi · 2018-12-17T16:10:02Z

@sam-github

#23188 (comment) is also blocking - we can't release this telling people to provide rejectUnauthorized as an argument, that would make client auth completely insecure. Better to figure out another way, or to disallow mixing PSK and requestCert or PSK and any non-PSK ciphers.

This is resolved with
https://github.com/nodejs/node/blob/ab82ec5af640a6bf8000711951756d0aaf43e66c/src/node_crypto.cc#L2273-L2278
and the need to provide custom (or empty) checkServerIdentity but I want someone more experienced with security and TLS to take a look.

As for the TLS1.3, this should work as is. Based on the docs of the methods we use here (in openssl) they have kept the current methods as backups if the new methods are not implemented.

lundibundi · 2018-12-18T15:23:12Z

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

Add the `pskCallback` client/server option, which resolves an identity or identity hint to a pre-shared key. Add the `pskIdentityHint` server option to set the identity hint for the ServerKeyExchange message. Co-authored-by: Chris Osborn <chris.osborn@sitelier.com> Co-authored-by: stephank <gh@stephank.nl> Co-authored-by: Taylor Zane Glaeser <tzglaeser@gmail.com>

lundibundi · 2019-12-21T12:18:09Z

So I changed the server pskCallback to make it possible to associate the socket with the identity if needed. Docs changed accordingly.

Also, this could use a few more reviews, ping @nodejs/crypto, maybe @addaleax @vsemozhetbyt.

/cc @sam-github

nodejs-github-bot · 2019-12-21T12:19:32Z

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

doc/api/tls.md

src/env.h

src/tls_wrap.cc

nodejs-github-bot · 2019-12-22T22:12:35Z

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

nodejs-github-bot · 2019-12-23T14:38:19Z

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

Add the `pskCallback` client/server option, which resolves an identity or identity hint to a pre-shared key. Add the `pskIdentityHint` server option to set the identity hint for the ServerKeyExchange message. Co-authored-by: Chris Osborn <chris.osborn@sitelier.com> Co-authored-by: stephank <gh@stephank.nl> Co-authored-by: Taylor Zane Glaeser <tzglaeser@gmail.com> PR-URL: nodejs#23188 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

BridgeAR · 2019-12-25T11:44:28Z

Woohoo! This finally landed in f8d7e22 after more than one year! 🎉

@lundibundi awesome work

Add the `pskCallback` client/server option, which resolves an identity or identity hint to a pre-shared key. Add the `pskIdentityHint` server option to set the identity hint for the ServerKeyExchange message. Co-authored-by: Chris Osborn <chris.osborn@sitelier.com> Co-authored-by: stephank <gh@stephank.nl> Co-authored-by: Taylor Zane Glaeser <tzglaeser@gmail.com> PR-URL: #23188 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

Notable changes: * assert: * Implement `assert.match()` and `assert.doesNotMatch()` (Ruben Bridgewater) #30929 * events: * Add `EventEmitter.on` to async iterate over events (Matteo Collina) #27994 * Allow monitoring error events (Gerhard Stoebich) #30932 * fs: * Allow overriding `fs` for streams (Robert Nagy) #29083 * perf_hooks: * Move `perf_hooks` out of experimental (legendecas) #31101 * repl: * Implement ZSH-like reverse-i-search (Ruben Bridgewater) #31006 * tls: * Add PSK (pre-shared key) support (Denys Otrishko) #23188 PR-URL: #31238

Add the `pskCallback` client/server option, which resolves an identity or identity hint to a pre-shared key. Add the `pskIdentityHint` server option to set the identity hint for the ServerKeyExchange message. Co-authored-by: Chris Osborn <chris.osborn@sitelier.com> Co-authored-by: stephank <gh@stephank.nl> Co-authored-by: Taylor Zane Glaeser <tzglaeser@gmail.com> PR-URL: #23188 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

nodejs/node#23188 We don't support much of TLS owing to schisms between BoringSSL and OpenSSL.

* chore: bump node in DEPS to v12.16.0 * Fixup asar support setup patch nodejs/node#30862 * Fixup InternalCallbackScope patch nodejs/node#30236 * Fixup GN buildfiles patch nodejs/node#30755 * Fixup low-level hooks patch nodejs/node#30466 * Fixup globals require patch nodejs/node#31643 * Fixup process stream patch nodejs/node#30862 * Fixup js2c modification patch nodejs/node#30755 * Fixup internal fs override patch nodejs/node#30610 * Fixup context-aware warn patch nodejs/node#30336 * Fixup Node.js with ltcg config nodejs/node#29388 * Fixup oaepLabel patch nodejs/node#30917 * Remove redundant ESM test patch nodejs/node#30997 * Remove redundant cli flag patch nodejs/node#30466 * Update filenames.json * Remove macro generation in GN build files nodejs/node#30755 * Fix some compilation errors upstream * Add uvwasi to deps nodejs/node#30258 * Fix BoringSSL incompatibilities * Fixup linked module patch nodejs/node#30274 * Add missing sources to GN uv build libuv/libuv#2347 * Patch some uvwasi incompatibilities * chore: bump Node.js to v12.6.1 * Remove mark_arraybuffer_as_untransferable.patch nodejs/node#30549 * Fix uvwasi build failure on win * Fixup --perf-prof cli option error * Fixup early cjs module loading * fix: initialize diagnostics properly nodejs/node#30025 * Disable new esm syntax specs nodejs/node#30219 * Fixup v8 weakref hook spec nodejs/node#29874 * Fix async context timer issue * Disable monkey-patch-main spec It relies on nodejs/node#29777, and we don't override prepareStackTrace. * Disable new tls specs nodejs/node#23188 We don't support much of TLS owing to schisms between BoringSSL and OpenSSL. Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory. labels Sep 30, 2018

addaleax reviewed Sep 30, 2018

View reviewed changes

addaleax mentioned this pull request Sep 30, 2018

tls: Add PSK support (v9.0.0-pre) #14978

Closed

4 tasks

vsemozhetbyt reviewed Oct 1, 2018

View reviewed changes

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

bnoordhuis reviewed Oct 2, 2018

View reviewed changes

lundibundi added the wip Issues and PRs that are still a work in progress. label Oct 2, 2018

lundibundi force-pushed the pr-14978 branch from 3bb2498 to 6ff755f Compare October 29, 2018 09:51

lundibundi removed the wip Issues and PRs that are still a work in progress. label Oct 29, 2018

sam-github suggested changes Oct 29, 2018

View reviewed changes

lundibundi force-pushed the pr-14978 branch from cca4f8b to 2a4f20d Compare November 25, 2018 22:59

lundibundi force-pushed the pr-14978 branch from 2a4f20d to ab82ec5 Compare December 9, 2018 15:20

sam-github suggested changes Dec 13, 2018

View reviewed changes

lundibundi force-pushed the pr-14978 branch 2 times, most recently from 70557ee to 6a52fad Compare December 17, 2018 20:45

lundibundi and others added 2 commits December 20, 2019 22:43

fixup! pass socket to server's pskCallback

596296f

lundibundi force-pushed the pr-14978 branch from 72f39d8 to 596296f Compare December 21, 2019 12:13

addaleax approved these changes Dec 21, 2019

View reviewed changes

fixup! address comments, use node_errors, add pskIdentityHint error test

61c8f50

lundibundi added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 24, 2019

BridgeAR closed this Dec 25, 2019

BridgeAR added the semver-minor PRs that contain new features and should be released in the next minor version. label Jan 7, 2020

BridgeAR mentioned this pull request Jan 7, 2020

v13.6.0 proposal #31238

Merged

targos mentioned this pull request Jan 15, 2020

v12.15.0 release proposal #31368

Closed

MylesBorins mentioned this pull request Feb 8, 2020

v12.16.0 proposal #31691

Merged

codebytere added a commit to electron/electron that referenced this pull request Feb 24, 2020

Disable new tls specs

1cee8ba

nodejs/node#23188 We don't support much of TLS owing to schisms between BoringSSL and OpenSSL.

codebytere added a commit to electron/electron that referenced this pull request Feb 24, 2020

Disable new tls specs

43e4324

nodejs/node#23188 We don't support much of TLS owing to schisms between BoringSSL and OpenSSL.

mootari mentioned this pull request Apr 10, 2024

Typo in error code ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED #52448

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

tls: Add PSK support #23188

tls: Add PSK support #23188

lundibundi commented Sep 30, 2018 •

edited

nodejs-github-bot commented Sep 30, 2018

tniessen commented Sep 30, 2018

lundibundi commented Oct 2, 2018

lundibundi commented Oct 28, 2018

lundibundi commented Oct 29, 2018

lundibundi commented Oct 29, 2018 •

edited

sam-github left a comment

lundibundi commented Oct 31, 2018

lundibundi commented Nov 10, 2018

sam-github commented Nov 13, 2018

Trott commented Nov 28, 2018

lundibundi commented Nov 28, 2018

lundibundi commented Dec 9, 2018

sam-github left a comment

sam-github Dec 13, 2018

lundibundi Dec 17, 2018

sam-github commented Dec 14, 2018

lundibundi commented Dec 17, 2018 •

edited

lundibundi commented Dec 18, 2018

lundibundi commented Dec 21, 2019

nodejs-github-bot commented Dec 21, 2019

nodejs-github-bot commented Dec 22, 2019

nodejs-github-bot commented Dec 23, 2019

BridgeAR commented Dec 25, 2019

tls: Add PSK support #23188

tls: Add PSK support #23188

Conversation

lundibundi commented Sep 30, 2018 • edited

Checklist

nodejs-github-bot commented Sep 30, 2018

tniessen commented Sep 30, 2018

lundibundi commented Oct 2, 2018

lundibundi commented Oct 28, 2018

lundibundi commented Oct 29, 2018

lundibundi commented Oct 29, 2018 • edited

sam-github left a comment

Choose a reason for hiding this comment

lundibundi commented Oct 31, 2018

lundibundi commented Nov 10, 2018

sam-github commented Nov 13, 2018

Trott commented Nov 28, 2018

lundibundi commented Nov 28, 2018

lundibundi commented Dec 9, 2018

sam-github left a comment

Choose a reason for hiding this comment

sam-github Dec 13, 2018

Choose a reason for hiding this comment

lundibundi Dec 17, 2018

Choose a reason for hiding this comment

sam-github commented Dec 14, 2018

lundibundi commented Dec 17, 2018 • edited

lundibundi commented Dec 18, 2018

lundibundi commented Dec 21, 2019

nodejs-github-bot commented Dec 21, 2019

nodejs-github-bot commented Dec 22, 2019

nodejs-github-bot commented Dec 23, 2019

BridgeAR commented Dec 25, 2019

lundibundi commented Sep 30, 2018 •

edited

lundibundi commented Oct 29, 2018 •

edited

lundibundi commented Dec 17, 2018 •

edited