summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMaleDong <maledong_github@outlook.com>2018-09-14 16:13:14 +0800
committerTobias Nießen <tniessen@tnie.de>2018-09-18 16:06:32 +0200
commitba0b4e43e442926bfb9389a42aa7393f91e6748a (patch)
tree44bdbc63fa5ee5501796dace17fc6fd23b484a4a
parent8989c76c6eff653a3abb19f4cfb3097da58b5dce (diff)
downloadnode-new-ba0b4e43e442926bfb9389a42aa7393f91e6748a.tar.gz
lib,doc: remove unused parameter, improve docs
1) Remove 'callback' in 'check' function, because we don't check or use that directly. 2) Make 'digest' clearer in the documentation. PR-URL: https://github.com/nodejs/node/pull/22858 Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
-rw-r--r--doc/api/crypto.md6
-rw-r--r--lib/internal/crypto/pbkdf2.js6
2 files changed, 9 insertions, 3 deletions
diff --git a/doc/api/crypto.md b/doc/api/crypto.md
index e9e2d203d4..06d9281ba4 100644
--- a/doc/api/crypto.md
+++ b/doc/api/crypto.md
@@ -1786,6 +1786,9 @@ otherwise `err` will be `null`. By default, the successfully generated
`derivedKey` will be passed to the callback as a [`Buffer`][]. An error will be
thrown if any of the input arguments specify invalid values or types.
+If `digest` is `null`, `'sha1'` will be used. This behavior will be deprecated
+in a future version of Node.js.
+
The `iterations` argument must be a number set as high as possible. The
higher the number of iterations, the more secure the derived key will be,
but will take a longer amount of time to complete.
@@ -1849,6 +1852,9 @@ applied to derive a key of the requested byte length (`keylen`) from the
If an error occurs an `Error` will be thrown, otherwise the derived key will be
returned as a [`Buffer`][].
+If `digest` is `null`, `'sha1'` will be used. This behavior will be deprecated
+in a future version of Node.js.
+
The `iterations` argument must be a number set as high as possible. The
higher the number of iterations, the more secure the derived key will be,
but will take a longer amount of time to complete.
diff --git a/lib/internal/crypto/pbkdf2.js b/lib/internal/crypto/pbkdf2.js
index 140aa2a05a..3567a91e08 100644
--- a/lib/internal/crypto/pbkdf2.js
+++ b/lib/internal/crypto/pbkdf2.js
@@ -23,7 +23,7 @@ function pbkdf2(password, salt, iterations, keylen, digest, callback) {
}
({ password, salt, iterations, keylen, digest } =
- check(password, salt, iterations, keylen, digest, callback));
+ check(password, salt, iterations, keylen, digest));
if (typeof callback !== 'function')
throw new ERR_INVALID_CALLBACK();
@@ -43,7 +43,7 @@ function pbkdf2(password, salt, iterations, keylen, digest, callback) {
function pbkdf2Sync(password, salt, iterations, keylen, digest) {
({ password, salt, iterations, keylen, digest } =
- check(password, salt, iterations, keylen, digest, pbkdf2Sync));
+ check(password, salt, iterations, keylen, digest));
const keybuf = Buffer.alloc(keylen);
handleError(keybuf, password, salt, iterations, digest);
const encoding = getDefaultEncoding();
@@ -51,7 +51,7 @@ function pbkdf2Sync(password, salt, iterations, keylen, digest) {
return keybuf.toString(encoding);
}
-function check(password, salt, iterations, keylen, digest, callback) {
+function check(password, salt, iterations, keylen, digest) {
if (typeof digest !== 'string') {
if (digest !== null)
throw new ERR_INVALID_ARG_TYPE('digest', ['string', 'null'], digest);