crypto.pbkdf2(password, salt, iterations, keylen, digest, callback)

版本历史

版本	变更
v18.0.0	Passing an invalid callback to the `callback` argument now throws `ERR_INVALID_ARG_TYPE` instead of `ERR_INVALID_CALLBACK`.
v15.0.0	The password and salt arguments can also be ArrayBuffer instances.
v14.0.0	The `iterations` parameter is now restricted to positive values. Earlier releases treated other values as one.
v8.0.0	The `digest` parameter is always required now.
v6.0.0	Calling this function without passing the `digest` parameter is deprecated now and will emit a warning.
v6.0.0	The default encoding for `password` if it is a string changed from `binary` to `utf8`.
v0.5.5	新增于: v0.5.5

password <string> | <ArrayBuffer> | <Buffer> | <TypedArray> | <DataView>
salt <string> | <ArrayBuffer> | <Buffer> | <TypedArray> | <DataView>
iterations <number>
keylen <number>
digest <string>
callback <Function>
- err <Error>
- derivedKey <Buffer>

提供一个异步的基于密码的密钥派生函数 2（PBKDF2）实现。通过 digest 指定的 HMAC 摘要算法，用于从 password、salt 和 iterations 派生请求字节长度（keylen）的密钥。

🌐 Provides an asynchronous Password-Based Key Derivation Function 2 (PBKDF2) implementation. A selected HMAC digest algorithm specified by digest is applied to derive a key of the requested byte length (keylen) from the password, salt and iterations.

提供的 callback 函数会接收两个参数：err 和 derivedKey。如果在生成密钥时发生错误，err 将被设置；否则 err 将为 null。默认情况下，成功生成的 derivedKey 会作为 Buffer 传递给回调。如果任何输入参数指定了无效的值或类型，将会抛出错误。

🌐 The supplied callback function is called with two arguments: err and derivedKey. If an error occurs while deriving the key, err will be set; 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.

iterations 参数必须是尽可能高的数字。迭代次数越多，派生的密钥就越安全，但完成所需的时间也会更长。

🌐 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.

salt 应尽可能唯一。建议盐值是随机的，并且至少为 16 字节长。详情请参阅 NIST SP 800-132。

🌐 The salt should be as unique as possible. It is recommended that a salt is random and at least 16 bytes long. See NIST SP 800-132 for details.

在传递 password 或 salt 字符串时，请考虑将字符串用作加密 API 输入时的注意事项。

🌐 When passing strings for password or salt, please consider caveats when using strings as inputs to cryptographic APIs.

const {
  pbkdf2,
} = await import('node:crypto');

pbkdf2('secret', 'salt', 100000, 64, 'sha512', (err, derivedKey) => {
  if (err) throw err;
  console.log(derivedKey.toString('hex'));  // '3745e48...08d59ae'
});const {
  pbkdf2,
} = require('node:crypto');

pbkdf2('secret', 'salt', 100000, 64, 'sha512', (err, derivedKey) => {
  if (err) throw err;
  console.log(derivedKey.toString('hex'));  // '3745e48...08d59ae'
});

可用的摘要算法取决于 OpenSSL 的版本和配置。PBKDF2 内部使用 HMAC。crypto.getHashes() 列出了哈希 API 可用的算法，但并非每个列出的算法都一定适合用于 HMAC 或 PBKDF2。

🌐 The available digest algorithms depend on the version and configuration of OpenSSL. PBKDF2 uses HMAC internally. crypto.getHashes() lists algorithms available to the hashing APIs, but not every listed algorithm is necessarily suitable for HMAC or PBKDF2.

该 API 使用 libuv 的线程池，这可能对某些应用产生意想不到的负面性能影响；更多信息请参阅 UV_THREADPOOL_SIZE 文档。

🌐 This API uses libuv's threadpool, which can have surprising and negative performance implications for some applications; see the UV_THREADPOOL_SIZE documentation for more information.