crypto.argon2Sync(algorithm, parameters)


稳定性: 1.2 - 发布候选版

  • 'algorithm' <string> Argon2 的变体,是 '“argon2d”, ''argon2i' 或 '“argon2id”' 之一。
  • parameters <Object>
    • message <string> | <ArrayBuffer> | <Buffer> | <TypedArray> | <DataView> 必填,这是用于 Argon2 密码哈希应用的密码。
    • nonce <string> | <ArrayBuffer> | <Buffer> | <TypedArray> | <DataView> 必填,长度至少为 8 字节。这是 Argon2 密码哈希应用的盐值。
    • parallelism <number> 是必需的,并行度决定可以运行多少计算链(通道)。必须大于1且小于 2**24-1
    • tagLength <number> 必填,要生成的密钥长度。必须大于 4 且小于 2**32-1
    • memory <number> 必填,内存消耗以 1KiB 块为单位。必须大于 8 * parallelism 并且小于 2**32-1。实际的块数会向下取整到最接近的 4 * parallelism 倍数。
    • passes <number> 必需,传递次数(迭代次数)。必须大于 1 且小于 2**32-1
    • secret <string> | <ArrayBuffer> | <Buffer> | <TypedArray> | <DataView> | <undefined> 可选,随机额外输入,类似于盐,不应与派生密钥一起存储。在密码哈希应用中称为 pepper。如果使用,长度不得超过 2**32-1 字节。
    • associatedData <string> | <ArrayBuffer> | <Buffer> | <TypedArray> | <DataView> | <undefined> 可选,附加数据,将添加到哈希中,功能上等同于盐值或密钥,但用于非随机数据。如果使用,长度不得超过 2**32-1 字节。
  • 返回:<Buffer>

提供同步的 氩气2 实现。Argon2 是一种基于密码的密钥派生函数,设计上在计算和内存方面都很昂贵,以使暴力破解攻击不划算。

🌐 Provides a synchronous Argon2 implementation. Argon2 is a password-based key derivation function that is designed to be expensive computationally and memory-wise in order to make brute-force attacks unrewarding.

nonce 应尽可能唯一。建议 nonce 是随机的,并且至少 16 字节长。详情请参见 NIST SP 800-132

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

在为 messagenoncesecretassociatedData 传递字符串时,请考虑 将字符串用作加密 API 输入时的注意事项

🌐 When passing strings for message, nonce, secret or associatedData, please consider caveats when using strings as inputs to cryptographic APIs.

当密钥派生失败时,会抛出异常,否则派生的密钥将作为 Buffer 返回。

🌐 An exception is thrown when key derivation fails, otherwise the derived key is returned as a Buffer.

当任何输入参数指定无效的值或类型时,会抛出异常。

🌐 An exception is thrown when any of the input arguments specify invalid values or types.

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

const parameters = {
  message: 'password',
  nonce: randomBytes(16),
  parallelism: 4,
  tagLength: 64,
  memory: 65536,
  passes: 3,
};

const derivedKey = argon2Sync('argon2id', parameters);
console.log(derivedKey.toString('hex'));  // 'af91dad...9520f15'const { argon2Sync, randomBytes } = require('node:crypto');

const parameters = {
  message: 'password',
  nonce: randomBytes(16),
  parallelism: 4,
  tagLength: 64,
  memory: 65536,
  passes: 3,
};

const derivedKey = argon2Sync('argon2id', parameters);
console.log(derivedKey.toString('hex'));  // 'af91dad...9520f15'