crypto: deprecate aliases for randomBytes

nodejs · Aug 27, 2018 · 86b7efd · 86b7efd
1 parent dd03706
commit 86b7efd
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 3 deletions.
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md
@@ -1039,6 +1039,17 @@ Type: Runtime
 The `crypto._toBuf()` function was not designed to be used by modules outside
 of Node.js core and will be removed in the future.
 
+<a id="DEP00XX"></a>
+### DEP00XX: crypto.prng(), crypto.pseudoRandomBytes(), crypto.rng()
+
+Type: Runtime
+
+In recent versions of Node.js, there is no difference between
+[`crypto.randomBytes()`][] and `crypto.pseudoRandomBytes()`. The latter has been
+deprecated along with the undocumented aliases `crypto.prng()` and
+`crypto.rng()` in favor of [`crypto.randomBytes()`][] and will be removed in a
+future release.
+
 [`--pending-deprecation`]: cli.html#cli_pending_deprecation
 [`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_class_method_buffer_allocunsafeslow_size
 [`Buffer.from(array)`]: buffer.html#buffer_class_method_buffer_from_array
@@ -1065,6 +1076,7 @@ of Node.js core and will be removed in the future.
 [`crypto.DEFAULT_ENCODING`]: crypto.html#crypto_crypto_default_encoding
 [`crypto.fips`]: crypto.html#crypto_crypto_fips
 [`crypto.pbkdf2()`]: crypto.html#crypto_crypto_pbkdf2_password_salt_iterations_keylen_digest_callback
+[`crypto.randomBytes()`]: crypto.html#crypto_crypto_randombytes_size_callback
 [`crypto.scrypt()`]: crypto.html#crypto_crypto_scrypt_password_salt_keylen_options_callback
 [`decipher.final()`]: crypto.html#crypto_decipher_final_outputencoding
 [`decipher.setAuthTag()`]: crypto.html#crypto_decipher_setauthtag_buffer

diff --git a/lib/crypto.js b/lib/crypto.js
@@ -155,14 +155,11 @@ module.exports = exports = {
   pbkdf2Sync,
   privateDecrypt,
   privateEncrypt,
-  prng: randomBytes,
-  pseudoRandomBytes: randomBytes,
   publicDecrypt,
   publicEncrypt,
   randomBytes,
   randomFill,
   randomFillSync,
-  rng: randomBytes,
   scrypt,
   scryptSync,
   setEngine,
@@ -234,5 +231,22 @@ Object.defineProperties(exports, {
     configurable: false,
     enumerable: true,
     value: constants
+  },
+
+  // Aliases for randomBytes are deprecated.
+  // The ecosystem needs those to exist for backwards compatibility with
+  // ancient Node.js runtimes (0.10, 0.12).
+  prng: {
+    enumerable: false,
+    value: deprecate(randomBytes, 'crypto.prng is deprecated.', 'DEP00XX')
+  },
+  pseudoRandomBytes: {
+    enumerable: false,
+    value: deprecate(randomBytes,
+                     'crypto.pseudoRandomBytes is deprecated.', 'DEP00XX')
+  },
+  rng: {
+    enumerable: false,
+    value: deprecate(randomBytes, 'crypto.rng is deprecated.', 'DEP00XX')
   }
 });
diff --git a/test/parallel/test-crypto-random.js b/test/parallel/test-crypto-random.js
@@ -35,6 +35,9 @@ const kMaxPossibleLength = Math.min(kMaxLength, kMaxUint32);
 // bump, we register a lot of exit listeners
 process.setMaxListeners(256);
 
+common.expectWarning('DeprecationWarning',
+                     'crypto.pseudoRandomBytes is deprecated.', 'DEP00XX');
+
 {
   [crypto.randomBytes, crypto.pseudoRandomBytes].forEach((f) => {
     [undefined, null, false, true, {}, []].forEach((value) => {