crypto: upgrade pbkdf2 without digest to an error by jasnell · Pull Request #11305 · nodejs/node

jasnell · 2017-02-10T22:52:06Z

Commit a116358 added a deprecation warning when pbkdf2 was called without an explicit digest argument. This was because the default digest is sha1, which is not-recommended from a security point of view. This upgrades it to a runtime error when digest is undefined per the plan discussed in the original issue.

Ref: a116358

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

Affected core subsystem(s)

crypto

jasnell · 2017-02-10T22:52:26Z

cc @nodejs/crypto @bnoordhuis

bnoordhuis

LGTM with style nits and a suggestion.

bnoordhuis · 2017-02-11T06:13:41Z

lib/crypto.js

Can you indent by two additional spaces here?

It checks if digest is a function and throws error saying must not be undefined. I think this could do stricter validations.

bnoordhuis · 2017-02-11T06:16:55Z

lib/crypto.js

Ditto. Out of curiosity, is there a reason you can't move the check to the pbkdf2 function below? That would avoid the duplication.

and null is allowed? Or will another layer throw for that case? basically, looks like the check should be against == undefined to me, but there is clearly another layer doing a check for digests like 'the-happy-digest', and other invalid input (numbers, etc.), so maybe its covered there.

sam-github · 2017-02-11T19:53:21Z

doc/api/deprecations.md

drop the "the"

sam-github · 2017-02-11T19:54:07Z

doc/api/deprecations.md

what if its null? Maybe, "with an unspecified digest" or "with a non-string digest"?

sam-github · 2017-02-11T19:57:04Z

lib/crypto.js

and null is allowed? Or will another layer throw for that case? basically, looks like the check should be against == undefined to me, but there is clearly another layer doing a check for digests like 'the-happy-digest', and other invalid input (numbers, etc.), so maybe its covered there.

jasnell · 2017-02-11T22:16:41Z

to be honest, not sure what we should do with null. the current code only prints the deprecation notice if it's undefined so this only throws if it's undefined. The assumption, I believe, is that passing null is more explicit and is therefore ok.

indutny

LGTM

jasnell · 2017-02-12T20:44:53Z

Updated to address feedback. New CI: https://ci.nodejs.org/job/node-test-pull-request/6365/

Commit a116358 added a deprecation warning when pbkdf2 was called without an explicit `digest` argument. This was because the default digest is `sha1`, which is not-recommended from a security point of view. This upgrades it to a runtime error when `digest` is undefined per the plan discussed in the original issue. Ref: nodejs@a116358

jasnell · 2017-02-13T16:08:09Z

@nodejs/ctc ... any further thoughts?

thefourtheye · 2017-02-13T16:41:16Z

lib/crypto.js

@@ -562,15 +556,17 @@ exports.pbkdf2 = function(password,


 exports.pbkdf2Sync = function(password, salt, iterations, keylen, digest) {


Let's simply do exports.pbkdf2Sync = pbkdf2

That would change the signature of pbkdf2Sync (it would accept the callback argument and change the value of pbkdf2Sync.length).

Fishrock123

Concept and API (error) change LGTM, no comment on the code

Commit a116358 added a deprecation warning when pbkdf2 was called without an explicit `digest` argument. This was because the default digest is `sha1`, which is not-recommended from a security point of view. This upgrades it to a runtime error when `digest` is undefined per the plan discussed in the original issue. Ref: a116358 PR-URL: #11305 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>

jasnell · 2017-02-13T19:09:00Z

Landed in 9f74184

Calling `crypto.pbkdf2()` without a digest has been deprecated in Node and is scheduled to be broken in Node 8. Fix this by actually passing a digest. ref: nodejs/node#11305

addaleax · 2017-02-15T19:34:42Z

@jasnell This breaks CITGM because it was used in the express tests in the deprecated way… it’s “just” in an example script, but we really should have run that on this :/

I opened expressjs/express#3207 but there might be another problem with express + Node master… I’m looking into it

jasnell · 2017-02-15T19:38:59Z

Argh... Ok.

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

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

bnoordhuis approved these changes Feb 11, 2017

View reviewed changes

sam-github reviewed Feb 11, 2017

View reviewed changes

doc/api/deprecations.md Outdated

Copy link

Contributor

sam-github Feb 11, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

drop the "the"

sam-github reviewed Feb 11, 2017

View reviewed changes

indutny approved these changes Feb 11, 2017

View reviewed changes

jasnell force-pushed the crypto-error-pbkdf2-without-digest branch from 62568ab to 6c58166 Compare February 12, 2017 20:48

thefourtheye reviewed Feb 13, 2017

View reviewed changes

Fishrock123 approved these changes Feb 13, 2017

View reviewed changes

jasnell closed this Feb 13, 2017

yosuke-furukawa mentioned this pull request Feb 15, 2017

test: improve crypto coverage #11280

Closed

3 tasks

addaleax mentioned this pull request Feb 15, 2017

examples: fix pbkdf2 invocation expressjs/express#3207

Closed

jasnell mentioned this pull request Apr 4, 2017

8.0.0 Release Proposal #12220

Closed

sam-github mentioned this pull request Apr 7, 2017

crypto.pbkdf2Sync return different result that previous node versions #7464

Closed

vkoechli mentioned this pull request Sep 1, 2017

No more default digest in node.js 8 jcoglan/restore#44

Open

airicyu mentioned this pull request Sep 9, 2017

Nodejs version8 Compatible fix for crypto.pbkdf2Sync method 73rhodes/node-opentoken#3

Merged

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

panva mentioned this pull request Sep 20, 2022

doc,crypto: cleanup removed pbkdf2 behaviours #44733

Merged

		@@ -562,15 +556,17 @@ exports.pbkdf2 = function(password,


		exports.pbkdf2Sync = function(password, salt, iterations, keylen, digest) {

Uh oh!

Conversation

jasnell commented Feb 10, 2017

Checklist

Affected core subsystem(s)

Uh oh!

jasnell commented Feb 10, 2017

Uh oh!

bnoordhuis left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jasnell commented Feb 11, 2017

Uh oh!

indutny left a comment

Choose a reason for hiding this comment

Uh oh!

jasnell commented Feb 12, 2017

Uh oh!

jasnell commented Feb 13, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Fishrock123 left a comment

Choose a reason for hiding this comment

Uh oh!

jasnell commented Feb 13, 2017

Uh oh!

addaleax commented Feb 15, 2017

Uh oh!

jasnell commented Feb 15, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants