crypto: hide native handles from JS modules #22747

tniessen · 2018-09-07T13:27:41Z

Another attempt to reduce the undocumented API surface. I am defensively marking this as semver-major, but as far as I can tell, no popular packages are using these properties. It would be kind of pointless anyway since there is no advantage in using _handle here. (This is not true for other parts of our API, but it seems to be valid for the affected crypto APIs.)

Checklist

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

nodejs-github-bot · 2018-09-07T13:27:42Z

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

jasnell · 2018-09-07T14:54:20Z

It's likely safer to turn _handle into a deprecated getter/alias for [kHandle], at least through one major release cycle.

tniessen · 2018-09-07T14:58:35Z

Definitely safer, yes, but I wonder whether people are using it at all. (I can't think of a single legitimate use case.)

BridgeAR · 2018-09-07T16:19:26Z

lib/internal/crypto/cipher.js

@@ -73,11 +75,11 @@ function getUIntOption(options, key) {
 function createCipherBase(cipher, credential, options, decipher, iv) {
  const authTagLength = getUIntOption(options, 'authTagLength');

-  this._handle = new CipherBase(decipher);
+  this[kHandle] = new CipherBase(decipher);
  if (iv === undefined) {


Since the purpose of this is to hide the actual implementation details, I would prefer to use a non-enumerable symbol. Otherwise it will still show up in the repl and when inspecting the value (including console calls).

I had the idea to do this after reviewing #22684. If we want to use non-enumerable symbols, maybe we should add that to the guidelines?

Trott · 2018-09-07T20:31:20Z

@nodejs/security-wg

jasnell · 2018-09-07T20:39:52Z

Definitely safer, yes, but I wonder whether people are using it at all. (I can't think of a single legitimate use case.)

They likely aren't, but that doesn't make it any less the right thing to do... at least just for a single major cycle. Node.js 11 would not be a LTS branch so the deprecated aliases wouldn't be around for long.

lirantal · 2018-09-08T08:07:59Z

Does it make sense to add a test that will assert on this new expectation that _handle isn't accessible as an enumerable on the returned object?

tniessen · 2018-09-09T09:38:24Z

I changed the PR to deprecate the _handle property. PTAL.

tniessen · 2018-09-11T10:44:49Z

CI: https://ci.nodejs.org/job/node-test-pull-request/17114/
Resumed in https://ci.nodejs.org/job/node-test-pull-request/17118/
Resumed in https://ci.nodejs.org/job/node-test-pull-request/17128/

tniessen · 2018-09-12T14:06:34Z

CI was stopped, resuming a previous build again... https://ci.nodejs.org/job/node-test-pull-request/17140/

PR-URL: nodejs#22747 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

tniessen · 2018-09-12T20:21:44Z

Landed in 0ade10d.

vsemozhetbyt · 2018-09-12T20:41:18Z

DEP00XX seems forgotten to replace)

Refs: nodejs#22747

PR-URL: #22827 Refs: #22747 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Creating deprecated accessors each time an object is created is very time consuming. Refs: nodejs#22747 Fixes: nodejs#24266

Creating deprecated accessors each time an object is created is very time consuming. Refs: #22747 Fixes: #24266 PR-URL: #24269 Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

Creating deprecated accessors each time an object is created is very time consuming. Refs: nodejs#22747 Fixes: nodejs#24266 PR-URL: nodejs#24269 Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

nodejs-github-bot added the crypto Issues and PRs related to the crypto subsystem. label Sep 7, 2018

tniessen added the semver-major PRs that contain breaking changes and should be released in the next major version. label Sep 7, 2018

BridgeAR reviewed Sep 7, 2018

View reviewed changes

tniessen mentioned this pull request Sep 7, 2018

doc: added symbols guidelines #22684

Closed

3 tasks

tniessen force-pushed the crypto-hide-native-handles branch from 8098199 to ae70d12 Compare September 9, 2018 09:32

crypto: hide native handles from JS modules

4427dc2

tniessen force-pushed the crypto-hide-native-handles branch from ae70d12 to 4427dc2 Compare September 9, 2018 09:37

lpinca approved these changes Sep 9, 2018

View reviewed changes

cjihrig approved these changes Sep 10, 2018

View reviewed changes

jasnell approved these changes Sep 10, 2018

View reviewed changes

vdeturckheim approved these changes Sep 10, 2018

View reviewed changes

tniessen added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. deprecations Issues and PRs related to deprecations. labels Sep 11, 2018

trivikr approved these changes Sep 11, 2018

View reviewed changes

joyeecheung approved these changes Sep 12, 2018

View reviewed changes

tniessen force-pushed the crypto-hide-native-handles branch from 16783a9 to a5c9b02 Compare September 12, 2018 19:50

Add metadata for the added deprecation

2e3353b

tniessen force-pushed the crypto-hide-native-handles branch from a5c9b02 to 2e3353b Compare September 12, 2018 19:52

tniessen closed this Sep 12, 2018

tniessen removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Sep 12, 2018

tniessen added a commit to tniessen/node that referenced this pull request Sep 12, 2018

crypto: assign missing deprecation code

3459213

Refs: nodejs#22747

tniessen mentioned this pull request Sep 12, 2018

crypto: assign missing deprecation code #22827

Closed

3 tasks

tniessen added a commit that referenced this pull request Sep 12, 2018

crypto: assign missing deprecation code

360465d

PR-URL: #22827 Refs: #22747 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

targos added a commit to targos/node that referenced this pull request Nov 9, 2018

crypto: put legacy _handle accessors on prototypes

e5006d3

Creating deprecated accessors each time an object is created is very time consuming. Refs: nodejs#22747 Fixes: nodejs#24266

targos mentioned this pull request Nov 9, 2018

crypto: put legacy _handle accessors on prototypes #24269

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

crypto: hide native handles from JS modules #22747

crypto: hide native handles from JS modules #22747

tniessen commented Sep 7, 2018

nodejs-github-bot commented Sep 7, 2018

jasnell commented Sep 7, 2018

tniessen commented Sep 7, 2018

BridgeAR Sep 7, 2018

tniessen Sep 7, 2018

Trott commented Sep 7, 2018

jasnell commented Sep 7, 2018

lirantal commented Sep 8, 2018

tniessen commented Sep 9, 2018

tniessen commented Sep 11, 2018 •

edited

Loading

tniessen commented Sep 12, 2018

tniessen commented Sep 12, 2018

vsemozhetbyt commented Sep 12, 2018

crypto: hide native handles from JS modules #22747

crypto: hide native handles from JS modules #22747

Conversation

tniessen commented Sep 7, 2018

Checklist

nodejs-github-bot commented Sep 7, 2018

jasnell commented Sep 7, 2018

tniessen commented Sep 7, 2018

BridgeAR Sep 7, 2018

Choose a reason for hiding this comment

tniessen Sep 7, 2018

Choose a reason for hiding this comment

Trott commented Sep 7, 2018

jasnell commented Sep 7, 2018

lirantal commented Sep 8, 2018

tniessen commented Sep 9, 2018

tniessen commented Sep 11, 2018 • edited Loading

tniessen commented Sep 12, 2018

tniessen commented Sep 12, 2018

vsemozhetbyt commented Sep 12, 2018

tniessen commented Sep 11, 2018 •

edited

Loading