OSSForks/node
1
0
Fork 0
mirror of https://github.com/zebrajr/node.git synced 2026-01-15 12:15:26 +00:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

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

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/39474
Refs: https://github.com/nodejs/node/issues/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>
This commit is contained in:
Tobias Nießen
2021-07-20 21:15:50 +02:00
committed by James M Snell
parent fc6de093e2
commit 1229d49e39
3 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/api/crypto.md
View File

@@ -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}.

2
lib/internal/crypto/hkdf.js
View File

@@ -91,7 +91,7 @@ function prepareKey(key) {
if (!isArrayBufferView(key)) {
throw new ERR_INVALID_ARG_TYPE(
'key',
'ikm',
[
'string',
'SecretKeyObject',

4
test/parallel/test-crypto-hkdf.js
View File

@@ -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 /
});
});