tls: runtime deprecate _tls_legacy by jasnell · Pull Request #11349 · nodejs/node · GitHub

~~The CryptoStream.prototype.readyState property was marked as being docs-only deprecated about 4 years ago in af80e7b

This upgrades it to a runtime deprecation.~~

Runtime deprecate tls.createSecurePair() (_tls_legacy.js)

/cc @indutny @ChALkeR

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

tls (legacy)

@nodejs/crypto

IMO, this is an insufficient deprecation message.

Yep, not too happy with it either. Any suggestions for improvements?

The CryptoStream.prototype.readyState property was marked as being docs-only deprecated about 4 years ago in af80e7b

Unless I'm missing something, that commit does not appear to deprecate readyState.

Looking at this further, CryptoStream is only used within SecurePair which is docs-only deprecated. What we should likely do at this point is runtime deprecate tls.createSecurePair() in order to cover the whole _tls_legacy module

I like the idea of just deprecating the whole thing, rather than bits and pieces.

Ok, changed this to runtime deprecate the tls.createSecurePair() API.
@nodejs/ctc PTAL

Thought I had a déjà vu… #8783 😄

LGTM but you might as well copy the test case from #8783 ;)

Ha! I'd completely forgotten about that one. I'll pull over the test

…

On Thu, Feb 16, 2017 at 2:36 PM Anna Henningsen ***@***.***> wrote: ***@***.**** approved this pull request. LGTM but you might as well copy the test case from #8783 <#8783> ;) — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#11349 (review)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAa2eaYzqRCneeYusqRZIqN8sEkiS3Deks5rdM9jgaJpZM4L_qGB> .

LGTM with a suggestion. I do wonder though how much tls.createSecurePair() is used in the wild. I've seen it used in a few libraries.

I'd drop 'Docs-only', it's a little jargon-y.

LGTM

Shouldn't this be done on _tls_legacy file? I can still access this function, with out the deprecation warning, by directly requiring _tls_legacy.

Yeah i was considering that. Perhaps it's worthwhile checking how common it is to require that file directly

@thefourtheye @addaleax @bnoordhuis ... updated to address your feedback! PTAL

Rubber-stamp LGTM (given a CITGM pass).

As of 2017-02-23, I located that in 66 modules, the top 14 downloaded are:

937438	nssocket-0.6.0.tgz/lib/common.js:43:        pair = tls.createSecurePair(sslcontext, false),
729894	mysql-2.13.0.tgz/lib/Connection.js:353:    var securePair         = tls.createSecurePair(credentials, false, true, rejectUnauthorized);
138343	rai-0.1.12.tgz/lib/mockup.js:75:                pair = tlslib.createSecurePair(sslcontext, false);
138343	rai-0.1.12.tgz/lib/starttls.js:40:    pair = require('tls').createSecurePair(sslcontext, true);
109233	tedious-1.14.0.tgz/lib/message-io.js:117:      this.securePair = tls.createSecurePair(credentials);
51533	mysql2-1.2.0.tgz/lib/connection.js:349:    var securePair = Tls.createSecurePair(credentials, false, true, rejectUnauthorized);
46631	emailjs-1.0.8.tgz/smtp/smtp.js:286:              pair: tls.createSecurePair(
43978	starttls-1.0.1.tgz/lib/starttls.js:49:		securePair = tls.createSecurePair(credentials, false);
38778	poplib-0.1.7.tgz/main.js:144:		var pair = tls.createSecurePair(sslcontext, false);
27311	tls-connect-0.2.2.tgz/_tls_wrap-0.11.10.js:671:  var pair = tls_legacy.createSecurePair(credentials,
27311	tls-connect-0.2.2.tgz/_tls_wrap-patch.js:671:  var pair = tls_legacy.createSecurePair(credentials,
27311	tls-connect-0.2.2.tgz/starttls.js:197:  var pair = tls.createSecurePair(credentials,
10661	ftpd-0.2.15.tgz/lib/starttls.js:51:  pair = tls.createSecurePair(sslcontext, isServer);
5854	node-xmpp-tls-connect-1.0.1.tgz/starttls.js:199:  var pair = tls.createSecurePair(credentials,
3874	vertica-0.5.5.tgz/lib/starttls.js:7:  pair = require('tls').createSecurePair(sslcontext, false);
3874	vertica-0.5.5.tgz/src/starttls.coffee:4:  pair       = require('tls').createSecurePair(sslcontext, false)
2904	inbox-1.1.59.tgz/lib/starttls.js:39:    pair = require('tls').createSecurePair(sslcontext, false);
1128	cf-autoconfig-0.1.0.tgz/tests/test_modules/mongodb/lib/mongodb/connection/connection.js:64:    var pair = this.pair = tls.createSecurePair(false);

The remaining 52 are below 1000 downloads/month.

Note that e.g. mysql2 (and mysql) is a false positive, as it uses feature detection since sidorares/node-mysql2#367 — the tls.createSecurePair line doesn't get called on current versions of Node.js.

rai itself seems to be deprecated.

Now the commit title says "runtime deprecate _tls_legacy", which is not actually what we are doing.

Upgrade the deprecation for _tls_legacy (`tls.createSecurePair()`) to a runtime deprecation.

Upgrade the deprecation for _tls_legacy (`tls.createSecurePair()`) to a runtime deprecation. PR-URL: #11349 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>

Landed in a2ae089

* **Async Hooks** * The `async_hooks` module has landed in core [[`4a7233c178`](nodejs@4a7233c178)] [nodejs#12892](nodejs#12892). * **Buffer** * Using the `--pending-deprecation` flag will cause Node.js to emit a deprecation warning when using `new Buffer(num)` or `Buffer(num)`. [[`d2d32ea5a2`](nodejs@d2d32ea5a2)] [nodejs#11968](nodejs#11968). * `new Buffer(num)` and `Buffer(num)` will zero-fill new `Buffer` instances [[`7eb1b4658e`](nodejs@7eb1b4658e)] [nodejs#12141](nodejs#12141). * Many `Buffer` methods now accept `Uint8Array` as input [[`beca3244e2`](nodejs@beca3244e2)] [nodejs#10236](nodejs#10236). * **Child Process** * Argument and kill signal validations have been improved [[`97a77288ce`](nodejs@97a77288ce)] [nodejs#12348](nodejs#12348), [[`d75fdd96aa`](nodejs@d75fdd96aa)] [nodejs#10423](nodejs#10423). * Child Process methods accept `Uint8Array` as input [[`627ecee9ed`](nodejs@627ecee9ed)] [nodejs#10653](nodejs#10653). * **Console** * Error events emitted when using `console` methods are now supressed. [[`f18e08d820`](nodejs@f18e08d820)] [nodejs#9744](nodejs#9744). * **Dependencies** * The npm client has been updated to 5.0.0 [[`3c3b36af0f`](nodejs@3c3b36af0f)] [nodejs#12936](nodejs#12936). * V8 has been updated to 5.8 with forward ABI stability to 6.0 [[`60d1aac8d2`](nodejs@60d1aac8d2)] [nodejs#12784](nodejs#12784). * **Domains** * Native `Promise` instances are now `Domain` aware [[`84dabe8373`](nodejs@84dabe8373)] [nodejs#12489](nodejs#12489). * **Errors** * We have started assigning static error codes to errors generated by Node.js. This has been done through multiple commits and is still a work in progress. * **File System** * The utility class `fs.SyncWriteStream` has been deprecated [[`7a55e34ef4`](nodejs@7a55e34ef4)] [nodejs#10467](nodejs#10467). * The deprecated `fs.read()` string interface has been removed [[`3c2a9361ff`](nodejs@3c2a9361ff)] [nodejs#9683](nodejs#9683). * **HTTP** * Improved support for userland implemented Agents [[`90403dd1d0`](nodejs@90403dd1d0)] [nodejs#11567](nodejs#11567). * Outgoing Cookie headers are concatenated into a single string [[`d3480776c7`](nodejs@d3480776c7)] [nodejs#11259](nodejs#11259). * The `httpResponse.writeHeader()` method has been deprecated [[`fb71ba4921`](nodejs@fb71ba4921)] [nodejs#11355](nodejs#11355). * New methods for accessing HTTP headers have been added to `OutgoingMessage` [[`3e6f1032a4`](nodejs@3e6f1032a4)] [nodejs#10805](nodejs#10805). * **Lib** * All deprecation messages have been assigned static identifiers [[`5de3cf099c`](nodejs@5de3cf099c)] [nodejs#10116](nodejs#10116). * The legacy `linkedlist` module has been removed [[`84a23391f6`](nodejs@84a23391f6)] [nodejs#12113](nodejs#12113). * **N-API** * Experimental support for the new N-API API has been added [[`56e881d0b0`](nodejs@56e881d0b0)] [nodejs#11975](nodejs#11975). * **Process** * Process warning output can be redirected to a file using the `--redirect-warnings` command-line argument [[`03e89b3ff2`](nodejs@03e89b3ff2)] [nodejs#10116](nodejs#10116). * Process warnings may now include additional detail [[`dd20e68b0f`](nodejs@dd20e68b0f)] [nodejs#12725](nodejs#12725). * **REPL** * REPL magic mode has been deprecated [[`3f27f02da0`](nodejs@3f27f02da0)] [nodejs#11599](nodejs#11599). * **Src** * `NODE_MODULE_VERSION` has been updated to 57 (nodejs@ec7cbaf266)] [nodejs#12995](nodejs#12995). * Add `--pending-deprecation` command-line argument and `NODE_PENDING_DEPRECATION` environment variable [[`a16b570f8c`](nodejs@a16b570f8c)] [nodejs#11968](nodejs#11968). * The `--debug` command-line argument has been deprecated. Note that using `--debug` will enable the *new* Inspector-based debug protocol as the legacy Debugger protocol previously used by Node.js has been removed. [[`010f864426`](nodejs@010f864426)] [nodejs#12949](nodejs#12949). * Throw when the `-c` and `-e` command-line arguments are used at the same time [[`a5f91ab230`](nodejs@a5f91ab230)] [nodejs#11689](nodejs#11689). * Throw when the `--use-bundled-ca` and `--use-openssl-ca` command-line arguments are used at the same time. [[`8a7db9d4b5`](nodejs@8a7db9d4b5)] [nodejs#12087](nodejs#12087). * **Stream** * `Stream` now supports `destroy()` and `_destroy()` APIs [[`b6e1d22fa6`](nodejs@b6e1d22fa6)] [nodejs#12925](nodejs#12925). * `Stream` now supports the `_final()` API [[`07c7f198db`](nodejs@07c7f198db)] [nodejs#12828](nodejs#12828). * **TLS** * The `rejectUnauthorized` option now defaults to `true` [[`348cc80a3c`](nodejs@348cc80a3c)] [nodejs#5923](nodejs#5923). * The `tls.createSecurePair()` API now emits a runtime deprecation [[`a2ae08999b`](nodejs@a2ae08999b)] [nodejs#11349](nodejs#11349). * A runtime deprecation will now be emitted when `dhparam` is less than 2048 bits [[`d523eb9c40`](nodejs@d523eb9c40)] [nodejs#11447](nodejs#11447). * **URL** * The WHATWG URL implementation is now a fully-supported Node.js API [[`d080ead0f9`](nodejs@d080ead0f9)] [nodejs#12710](nodejs#12710). * **Util** * `Symbol` keys are now displayed by default when using `util.inspect()` [[`5bfd13b81e`](nodejs@5bfd13b81e)] [nodejs#9726](nodejs#9726). * `toJSON` errors will be thrown when formatting `%j` [[`455e6f1dd8`](nodejs@455e6f1dd8)] [nodejs#11708](nodejs#11708). * Convert `inspect.styles` and `inspect.colors` to prototype-less objects [[`aab0d202f8`](nodejs@aab0d202f8)] [nodejs#11624](nodejs#11624). * The new `util.promisify()` API has been added [[`99da8e8e02`](nodejs@99da8e8e02)] [nodejs#12442](nodejs#12442). * **Zlib** * Support `Uint8Array` in Zlib convenience methods [[`91383e47fd`](nodejs@91383e47fd)] [nodejs#12001](nodejs#12001). * Zlib errors now use `RangeError` and `TypeError` consistently [[`b514bd231e`](nodejs@b514bd231e)] [nodejs#11391](nodejs#11391).

* **Async Hooks** * The `async_hooks` module has landed in core [[`4a7233c178`](4a7233c178)] [#12892](#12892). * **Buffer** * Using the `--pending-deprecation` flag will cause Node.js to emit a deprecation warning when using `new Buffer(num)` or `Buffer(num)`. [[`d2d32ea5a2`](d2d32ea5a2)] [#11968](#11968). * `new Buffer(num)` and `Buffer(num)` will zero-fill new `Buffer` instances [[`7eb1b4658e`](7eb1b4658e)] [#12141](#12141). * Many `Buffer` methods now accept `Uint8Array` as input [[`beca3244e2`](beca3244e2)] [#10236](#10236). * **Child Process** * Argument and kill signal validations have been improved [[`97a77288ce`](97a77288ce)] [#12348](#12348), [[`d75fdd96aa`](d75fdd96aa)] [#10423](#10423). * Child Process methods accept `Uint8Array` as input [[`627ecee9ed`](627ecee9ed)] [#10653](#10653). * **Console** * Error events emitted when using `console` methods are now supressed. [[`f18e08d820`](f18e08d820)] [#9744](#9744). * **Dependencies** * The npm client has been updated to 5.0.0 [[`3c3b36af0f`](3c3b36af0f)] [#12936](#12936). * V8 has been updated to 5.8 with forward ABI stability to 6.0 [[`60d1aac8d2`](60d1aac8d2)] [#12784](#12784). * **Domains** * Native `Promise` instances are now `Domain` aware [[`84dabe8373`](84dabe8373)] [#12489](#12489). * **Errors** * We have started assigning static error codes to errors generated by Node.js. This has been done through multiple commits and is still a work in progress. * **File System** * The utility class `fs.SyncWriteStream` has been deprecated [[`7a55e34ef4`](7a55e34ef4)] [#10467](#10467). * The deprecated `fs.read()` string interface has been removed [[`3c2a9361ff`](3c2a9361ff)] [#9683](#9683). * **HTTP** * Improved support for userland implemented Agents [[`90403dd1d0`](90403dd1d0)] [#11567](#11567). * Outgoing Cookie headers are concatenated into a single string [[`d3480776c7`](d3480776c7)] [#11259](#11259). * The `httpResponse.writeHeader()` method has been deprecated [[`fb71ba4921`](fb71ba4921)] [#11355](#11355). * New methods for accessing HTTP headers have been added to `OutgoingMessage` [[`3e6f1032a4`](3e6f1032a4)] [#10805](#10805). * **Lib** * All deprecation messages have been assigned static identifiers [[`5de3cf099c`](5de3cf099c)] [#10116](#10116). * The legacy `linkedlist` module has been removed [[`84a23391f6`](84a23391f6)] [#12113](#12113). * **N-API** * Experimental support for the new N-API API has been added [[`56e881d0b0`](56e881d0b0)] [#11975](#11975). * **Process** * Process warning output can be redirected to a file using the `--redirect-warnings` command-line argument [[`03e89b3ff2`](03e89b3ff2)] [#10116](#10116). * Process warnings may now include additional detail [[`dd20e68b0f`](dd20e68b0f)] [#12725](#12725). * **REPL** * REPL magic mode has been deprecated [[`3f27f02da0`](3f27f02da0)] [#11599](#11599). * **Src** * `NODE_MODULE_VERSION` has been updated to 57 (ec7cbaf266)] [#12995](#12995). * Add `--pending-deprecation` command-line argument and `NODE_PENDING_DEPRECATION` environment variable [[`a16b570f8c`](a16b570f8c)] [#11968](#11968). * The `--debug` command-line argument has been deprecated. Note that using `--debug` will enable the *new* Inspector-based debug protocol as the legacy Debugger protocol previously used by Node.js has been removed. [[`010f864426`](010f864426)] [#12949](#12949). * Throw when the `-c` and `-e` command-line arguments are used at the same time [[`a5f91ab230`](a5f91ab230)] [#11689](#11689). * Throw when the `--use-bundled-ca` and `--use-openssl-ca` command-line arguments are used at the same time. [[`8a7db9d4b5`](8a7db9d4b5)] [#12087](#12087). * **Stream** * `Stream` now supports `destroy()` and `_destroy()` APIs [[`b6e1d22fa6`](b6e1d22fa6)] [#12925](#12925). * `Stream` now supports the `_final()` API [[`07c7f198db`](07c7f198db)] [#12828](#12828). * **TLS** * The `rejectUnauthorized` option now defaults to `true` [[`348cc80a3c`](348cc80a3c)] [#5923](#5923). * The `tls.createSecurePair()` API now emits a runtime deprecation [[`a2ae08999b`](a2ae08999b)] [#11349](#11349). * A runtime deprecation will now be emitted when `dhparam` is less than 2048 bits [[`d523eb9c40`](d523eb9c40)] [#11447](#11447). * **URL** * The WHATWG URL implementation is now a fully-supported Node.js API [[`d080ead0f9`](d080ead0f9)] [#12710](#12710). * **Util** * `Symbol` keys are now displayed by default when using `util.inspect()` [[`5bfd13b81e`](5bfd13b81e)] [#9726](#9726). * `toJSON` errors will be thrown when formatting `%j` [[`455e6f1dd8`](455e6f1dd8)] [#11708](#11708). * Convert `inspect.styles` and `inspect.colors` to prototype-less objects [[`aab0d202f8`](aab0d202f8)] [#11624](#11624). * The new `util.promisify()` API has been added [[`99da8e8e02`](99da8e8e02)] [#12442](#12442). * **Zlib** * Support `Uint8Array` in Zlib convenience methods [[`91383e47fd`](91383e47fd)] [#12001](#12001). * Zlib errors now use `RangeError` and `TypeError` consistently [[`b514bd231e`](b514bd231e)] [#11391](#11391).

jasnell added the semver-major PRs that contain breaking changes and should be released in the next major version. label Feb 13, 2017

nodejs-github-bot added the tls Issues and PRs related to the tls subsystem. label Feb 13, 2017

sam-github approved these changes Feb 13, 2017

View reviewed changes

Trott reviewed Feb 14, 2017

View reviewed changes

jasnell force-pushed the fixup-deprecations branch from 6da48f5 to 25b87e9 Compare February 16, 2017 22:31

jasnell changed the title tls: upgrade CryptoStream.prototype.readyState deprecation tls: runtime deprecate _tls_legacy Feb 16, 2017

addaleax approved these changes Feb 16, 2017

View reviewed changes

jasnell added the ctc-review label Feb 22, 2017

jasnell mentioned this pull request Feb 22, 2017

Node.js Foundation Core Technical Committee (CTC) Meeting 2017-02-22 nodejs/CTC#71

Closed

bnoordhuis approved these changes Feb 22, 2017

View reviewed changes

indutny approved these changes Feb 22, 2017

View reviewed changes

mhdawson approved these changes Feb 22, 2017

View reviewed changes

thefourtheye reviewed Feb 22, 2017

View reviewed changes

ChALkeR self-requested a review February 22, 2017 21:19

jasnell force-pushed the fixup-deprecations branch from 25b87e9 to 5aae812 Compare February 24, 2017 16:16

ChALkeR approved these changes Feb 26, 2017

View reviewed changes

Trott mentioned this pull request Feb 27, 2017

Node.js Foundation Core Technical Committee (CTC) Meeting 2017-03-01 nodejs/CTC#74

Closed

jasnell mentioned this pull request Mar 1, 2017

tls: remove tls_legacy, createSecurePair #5924

Closed

4 tasks

Trott mentioned this pull request Mar 6, 2017

Node.js Foundation Core Technical Committee (CTC) Meeting 2017-03-08 nodejs/CTC#77

Closed

jasnell force-pushed the fixup-deprecations branch from 8f543a3 to 9c2ef27 Compare March 6, 2017 22:19

tls: runtime deprecation for tls.createSecurePair()

402016c

Upgrade the deprecation for _tls_legacy (`tls.createSecurePair()`) to a runtime deprecation.

jasnell force-pushed the fixup-deprecations branch from 9c2ef27 to 402016c Compare March 6, 2017 22:22

jasnell closed this Mar 6, 2017

jasnell removed the ctc-review label Mar 6, 2017

jasnell mentioned this pull request Apr 4, 2017

8.0.0 Release Proposal #12220

Closed

tniessen added the deprecations Issues and PRs related to deprecations. label Sep 7, 2018

tls: runtime deprecate _tls_legacy by jasnell · Pull Request #11349 · nodejs/node · GitHub

Uh oh!

Uh oh!

tls: runtime deprecate _tls_legacy - #11349

tls: runtime deprecate _tls_legacy#11349jasnell wants to merge 1 commit intonodejs:masternodejs/node:masterfrom jasnell:fixup-deprecationsjasnell/node:fixup-deprecationsCopy head branch name to clipboard

Conversation

jasnell commented Feb 13, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Affected core subsystem(s)

Uh oh!

jasnell commented Feb 13, 2017

Uh oh!

Trott Feb 14, 2017

Choose a reason for hiding this comment

Uh oh!

jasnell Feb 14, 2017

Choose a reason for hiding this comment

Uh oh!

Trott commented Feb 14, 2017

Uh oh!

jasnell commented Feb 14, 2017

Uh oh!

sam-github commented Feb 15, 2017

Uh oh!

jasnell commented Feb 16, 2017

Uh oh!

addaleax commented Feb 16, 2017

Uh oh!

addaleax left a comment

Choose a reason for hiding this comment

Uh oh!

jasnell commented Feb 16, 2017 via email

Uh oh!

bnoordhuis left a comment

Choose a reason for hiding this comment

Uh oh!

bnoordhuis Feb 22, 2017

Choose a reason for hiding this comment

Uh oh!

indutny left a comment

Choose a reason for hiding this comment

Uh oh!

mhdawson left a comment

Choose a reason for hiding this comment

Uh oh!

thefourtheye Feb 22, 2017

Choose a reason for hiding this comment

Uh oh!

jasnell Feb 22, 2017

Choose a reason for hiding this comment

Uh oh!

jasnell commented Feb 24, 2017

Uh oh!

ChALkeR left a comment

Choose a reason for hiding this comment

Uh oh!

ChALkeR commented Feb 26, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

thefourtheye commented Feb 26, 2017

Uh oh!

jasnell commented Mar 6, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

tls: runtime deprecate _tls_legacy#11349
jasnell wants to merge 1 commit into
nodejs:masterfrom
jasnell:fixup-deprecations

jasnell commented Feb 13, 2017 •
edited
Loading

ChALkeR commented Feb 26, 2017 •
edited
Loading