tls: deprecate undocumented tlsSocket.ssl property, add docs by jasnell · Pull Request #23915 · nodejs/node

jasnell · 2018-10-26T22:47:47Z

Updated take on #10846

Checklist

documentation is changed or added
commit message follows commit guidelines

nodejs-github-bot · 2018-10-26T22:47:48Z

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

jasnell · 2018-10-30T15:45:50Z

@addaleax @sam-github @bnoordhuis @nodejs/tsc ... please take another look over. This has changed significantly and is now a semver-major deprecation.

sam-github · 2018-10-30T15:53:41Z

Are the things people were using .ssl for possible via public APIs?

jasnell · 2018-10-30T16:02:49Z

I've added verifyError() as a function on TLSSocket.prototype but I'm really not sure what else folks have been using beyond that. We can address those cases as needed.

jasnell · 2018-11-01T14:35:16Z

Ping @nodejs/tsc

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#10846Fixes: nodejs#10555

Trott · 2018-11-02T07:43:58Z

 smaller fragments add extra TLS framing bytes and CPU overhead, which may
 decrease overall server throughput.

+### tlsSocket.verifyError()


Sorry if these questions are naïve or otherwise ill-informed: Is this the best name for this? I know it's what we used previously, but it wasn't exposed publicly, was it? Might `validatePeerCertificate() or something like that be a better name?

I'm fine with whatever name folks would like to see.

Co-Authored-By: jasnell <jasnell@gmail.com>

jasnell · 2018-11-19T07:09:36Z

Ping @nodejs/tsc

rvagg · 2018-11-19T11:37:16Z

there's an outstanding question from @Trott inline

lgtm I think, although the commit description doesn't hint at the addition of features. So it might be best to split out verifyError() to a separate commit.

nodejs-github-bot added doc Issues and PRs related to the documentations. tls Issues and PRs related to the tls subsystem. labels Oct 26, 2018

jasnell commented Oct 26, 2018
View reviewed changes

Comment threaddoc/api/tls.md Outdated

jasnell commented Oct 26, 2018
View reviewed changes

Comment threaddoc/api/tls.md Outdated

vsemozhetbyt reviewed Oct 27, 2018
View reviewed changes

Comment threaddoc/api/tls.md Outdated

vsemozhetbyt reviewed Oct 27, 2018
View reviewed changes

Comment threaddoc/api/tls.md Outdated

vsemozhetbyt reviewed Oct 27, 2018
View reviewed changes

Comment threaddoc/api/tls.md Outdated

addaleax reviewed Oct 27, 2018
View reviewed changes

Comment threaddoc/api/tls.md Outdated
Comment threaddoc/api/tls.md Outdated

vsemozhetbyt reviewed Oct 27, 2018
View reviewed changes

Comment threaddoc/api/tls.md Outdated

vsemozhetbyt reviewed Oct 27, 2018
View reviewed changes

Comment threaddoc/api/tls.md Outdated

jasnell commented Oct 29, 2018
View reviewed changes

Comment threaddoc/api/tls.md Outdated

jasnell commented Oct 29, 2018
View reviewed changes

Comment threaddoc/api/tls.md Outdated

jasnell commented Oct 29, 2018
View reviewed changes

Comment threaddoc/api/tls.md Outdated

sam-github approved these changes Oct 29, 2018
View reviewed changes

jasnell force-pushed the tls-socket-take2 branch 2 times, most recently from 02e937e to 66849e7Compare October 30, 2018 15:44

jasnell changed the title ~~doc: tls API for direct TLS socket use~~tls: deprecate undocumented tlsSocket.ssl property, add docsOct 30, 2018

jasnell added semver-major PRs that contain breaking changes and should be released in the next major version. deprecations Issues and PRs related to deprecations. labels Oct 30, 2018

vsemozhetbyt reviewed Oct 30, 2018
View reviewed changes

Comment threaddoc/api/deprecations.md Outdated

vsemozhetbyt reviewed Oct 30, 2018
View reviewed changes

Comment threaddoc/api/tls.md Outdated

jasnell requested a review from addaleax November 1, 2018 14:35

addaleax approved these changes Nov 1, 2018
View reviewed changes

Comment threadlib/_tls_wrap.js Outdated

jasnell added 2 commits November 1, 2018 08:37

tls: deprecate undocumented .ssl property, add docs
4ca0e4c
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#10846Fixes: nodejs#10555

[Squash] use kHandle
c82010d

jasnell force-pushed the tls-socket-take2 branch from 0a479a4 to c82010dCompare November 1, 2018 19:19

Trott reviewed Nov 2, 2018
View reviewed changes

Comment threaddoc/api/deprecations.md Outdated

Trott reviewed Nov 2, 2018
View reviewed changes

[Squash] suggestion
5116f58
Co-Authored-By: jasnell <jasnell@gmail.com>

jasnell closed this Jan 28, 2019

armanbilge mentioned this pull request Jul 26, 2022
How to use new tls.TLSSocket(...) to establish a secure connection? #43994
Open

Uh oh!

Uh oh!

Conversation

jasnell commented Oct 26, 2018

Checklist

Uh oh!

nodejs-github-bot commented Oct 26, 2018

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jasnell commented Oct 30, 2018

Uh oh!

sam-github commented Oct 30, 2018

Uh oh!

jasnell commented Oct 30, 2018

Uh oh!

Uh oh!

Uh oh!

jasnell commented Nov 1, 2018

Uh oh!

Uh oh!

Uh oh!

TrottNov 2, 2018

Choose a reason for hiding this comment

Uh oh!

jasnellNov 19, 2018

Choose a reason for hiding this comment

Uh oh!

jasnell commented Nov 19, 2018

Uh oh!

rvagg commented Nov 19, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants