doc: tls API for direct TLS socket use #10846
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sam-github
added
doc
addaleax
previously approved these changes
Jan 17, 2017
sam-github
force-pushed
the
tls-conn-tests
branch
from
9cd0633
to
9249391
Compare
sam-github
added
land-on-v4.x
semver-minor
sam-github
force-pushed
the
tls-conn-tests
branch
from
9249391
to
7213e0f
Compare
|
PTAL @nodejs/crypto |
sam-github
force-pushed
the
tls-conn-tests
branch
from
7213e0f
to
ea5385b
Compare
sam-github
force-pushed
the
tls-conn-tests
branch
from
ea5385b
to
bd3e202
Compare
|
PTAL @bnoordhuis @indutny @shigeki |
|
@nodejs/crypto hasn't been reviewed yet, so I pushed docs for the APIs called by https://github.com/mattcg/starttls and other users, I'm sure. That last commit fixes #10555 |
Direct use of tls.TLSSocket to start a TLS session over an existing TCP connection was documented. However, to use this connection securely it is necessary to validate and authenticate the peer's certificate, and the documented events and properties are implemented only for TLSSockets returned by tls.connect(). In order to create secure connections, additional undocumented APIs must be used, and these APIs are being called right now by npm modules. Fix: nodejs#10555 Fix: nodejs#11467
sam-github
force-pushed
the
tls-conn-tests
branch
from
0661c26
to
67e40ec
Compare
|
Updates on this one? |
|
There hasn't been any activity here. I'm closing this. Feel free to reopen if closed in error. |
2 tasks
jasnell
added a commit
to jasnell/node
that referenced
this pull request
Nov 1, 2018
deprecate the legacy undocumented `.ssl` alias for the `TLSSocket._handle` and document alternatives. Document how to properly use the `TLSSocket` constructor directly. Updated take on nodejs#10846 Fixes: nodejs#10555
jasnell
added a commit
to jasnell/node
that referenced
this pull request
Dec 31, 2020
Fixes: nodejs#10555 Refs: nodejs#10846 The `new tls.TLSSocket()` constructor does not set up all of the necessary lifecycle management or event handlers necessary for proper use. The `tls.connect()` method really should be the way that all `tls.TLSSocket()` instances are created. This commit begins the eventual phasing out of the `new tls.TLSSocket()` constructor with a doc-only deprecation. Signed-off-by: James M Snell <jasnell@gmail.com>
3 tasks
jasnell
added a commit
to jasnell/node
that referenced
this pull request
Apr 28, 2021
Fixes: nodejs#10555 Signed-off-by: James M Snell <jasnell@gmail.com> Refs: nodejs#10846
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Direct use of tls.TLSSocket to start a TLS session over an existing TCP connection was documented.
However, to use this connection securely it is necessary to validate and
authenticate the peer's certificate, and the documented events and
properties are implemented only for TLSSockets returned by
tls.connect(). In order to create secure connections, additional
undocumented APIs must be used, and these APIs are being called right
now by npm modules.
Fix: #10555
Fix: #11467
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)
tls,test,doc