doc,lib,test: rename HKDF 'key' argument

PR-URL: #39474 Refs: #39471 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Zeyu Yang <himself65@outlook.com> Reviewed-By: Filip Skokan <panva.ip@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
nodejs · Jul 26, 2021 · 1229d49 · 1229d49
1 parent fc6de09
commit 1229d49
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 11 deletions.
diff --git a/doc/api/crypto.md b/doc/api/crypto.md
@@ -3839,14 +3839,14 @@ const {
 console.log(getHashes()); // ['DSA', 'DSA-SHA', 'DSA-SHA1', ...]
 ```
 
-### `crypto.hkdf(digest, key, salt, info, keylen, callback)`
+### `crypto.hkdf(digest, ikm, salt, info, keylen, callback)`
 <!-- YAML
 added: v15.0.0
 -->
 
 * `digest` {string} The digest algorithm to use.
-* `key` {string|ArrayBuffer|Buffer|TypedArray|DataView|KeyObject} The secret
-  key. It must be at least one byte in length.
+* `ikm` {string|ArrayBuffer|Buffer|TypedArray|DataView|KeyObject} The input
+  keying material. It must be at least one byte in length.
 * `salt` {string|ArrayBuffer|Buffer|TypedArray|DataView} The salt value. Must
   be provided but can be zero-length.
 * `info` {string|ArrayBuffer|Buffer|TypedArray|DataView} Additional info value.
@@ -3859,7 +3859,7 @@ added: v15.0.0
   * `err` {Error}
   * `derivedKey` {Buffer}
 
-HKDF is a simple key derivation function defined in RFC 5869. The given `key`,
+HKDF is a simple key derivation function defined in RFC 5869. The given `ikm`,
 `salt` and `info` are used with the `digest` to derive a key of `keylen` bytes.
 
 The supplied `callback` function is called with two arguments: `err` and
@@ -3892,14 +3892,14 @@ hkdf('sha512', 'key', 'salt', 'info', 64, (err, derivedKey) => {
 });
 ```
 
-### `crypto.hkdfSync(digest, key, salt, info, keylen)`
+### `crypto.hkdfSync(digest, ikm, salt, info, keylen)`
 <!-- YAML
 added: v15.0.0
 -->
 
 * `digest` {string} The digest algorithm to use.
-* `key` {string|ArrayBuffer|Buffer|TypedArray|DataView|KeyObject} The secret
-  key. It must be at least one byte in length.
+* `ikm` {string|ArrayBuffer|Buffer|TypedArray|DataView|KeyObject} The input
+  keying material. It must be at least one byte in length.
 * `salt` {string|ArrayBuffer|Buffer|TypedArray|DataView} The salt value. Must
   be provided but can be zero-length.
 * `info` {string|ArrayBuffer|Buffer|TypedArray|DataView} Additional info value.
@@ -3911,7 +3911,7 @@ added: v15.0.0
 * Returns: {ArrayBuffer}
 
 Provides a synchronous HKDF key derivation function as defined in RFC 5869. The
-given `key`, `salt` and `info` are used with the `digest` to derive a key of
+given `ikm`, `salt` and `info` are used with the `digest` to derive a key of
 `keylen` bytes.
 
 The successfully generated `derivedKey` will be returned as an {ArrayBuffer}.

diff --git a/lib/internal/crypto/hkdf.js b/lib/internal/crypto/hkdf.js
@@ -91,7 +91,7 @@ function prepareKey(key) {
 
   if (!isArrayBufferView(key)) {
     throw new ERR_INVALID_ARG_TYPE(
-      'key',
+      'ikm',
       [
         'string',
         'SecretKeyObject',

diff --git a/test/parallel/test-crypto-hkdf.js b/test/parallel/test-crypto-hkdf.js
@@ -29,11 +29,11 @@ const {
   [1, {}, [], false, Infinity].forEach((i) => {
     assert.throws(() => hkdf('sha256', i), {
       code: 'ERR_INVALID_ARG_TYPE',
-      message: /^The "key" argument must be /
+      message: /^The "ikm" argument must be /
     });
     assert.throws(() => hkdfSync('sha256', i), {
       code: 'ERR_INVALID_ARG_TYPE',
-      message: /^The "key" argument must be /
+      message: /^The "ikm" argument must be /
     });
   });