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: nodejs#22858 Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
AdamMajer · Sep 18, 2018 · ba0b4e4 · ba0b4e4
1 parent 8989c76
commit ba0b4e4
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git 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
@@ -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,15 +43,15 @@ 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();
   if (encoding === 'buffer') return keybuf;
   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);