Node.js v24.0.0 文档

生成密钥#

可以使用 <SubtleCrypto> 类生成对称（秘密）密钥或非对称密钥对（公钥和私钥）。

const { subtle } = globalThis.crypto;

async function generateAesKey(length = 256) {
  const key = await subtle.generateKey({
    name: 'AES-CBC',
    length,
  }, true, ['encrypt', 'decrypt']);

  return key;
} copy

const { subtle } = globalThis.crypto;

async function generateEcKey(namedCurve = 'P-521') {
  const {
    publicKey,
    privateKey,
  } = await subtle.generateKey({
    name: 'ECDSA',
    namedCurve,
  }, true, ['sign', 'verify']);

  return { publicKey, privateKey };
} copy

const { subtle } = globalThis.crypto;

async function generateEd25519Key() {
  return subtle.generateKey({
    name: 'Ed25519',
  }, true, ['sign', 'verify']);
}

async function generateX25519Key() {
  return subtle.generateKey({
    name: 'X25519',
  }, true, ['deriveKey']);
} copy

const { subtle } = globalThis.crypto;

async function generateHmacKey(hash = 'SHA-256') {
  const key = await subtle.generateKey({
    name: 'HMAC',
    hash,
  }, true, ['sign', 'verify']);

  return key;
} copy

const { subtle } = globalThis.crypto;
const publicExponent = new Uint8Array([1, 0, 1]);

async function generateRsaKey(modulusLength = 2048, hash = 'SHA-256') {
  const {
    publicKey,
    privateKey,
  } = await subtle.generateKey({
    name: 'RSASSA-PKCS1-v1_5',
    modulusLength,
    publicExponent,
    hash,
  }, true, ['sign', 'verify']);

  return { publicKey, privateKey };
} copy

加密和解密#

const crypto = globalThis.crypto;

async function aesEncrypt(plaintext) {
  const ec = new TextEncoder();
  const key = await generateAesKey();
  const iv = crypto.getRandomValues(new Uint8Array(16));

  const ciphertext = await crypto.subtle.encrypt({
    name: 'AES-CBC',
    iv,
  }, key, ec.encode(plaintext));

  return {
    key,
    iv,
    ciphertext,
  };
}

async function aesDecrypt(ciphertext, key, iv) {
  const dec = new TextDecoder();
  const plaintext = await crypto.subtle.decrypt({
    name: 'AES-CBC',
    iv,
  }, key, ciphertext);

  return dec.decode(plaintext);
} copy

导出和导入密钥#

const { subtle } = globalThis.crypto;

async function generateAndExportHmacKey(format = 'jwk', hash = 'SHA-512') {
  const key = await subtle.generateKey({
    name: 'HMAC',
    hash,
  }, true, ['sign', 'verify']);

  return subtle.exportKey(format, key);
}

async function importHmacKey(keyData, format = 'jwk', hash = 'SHA-512') {
  const key = await subtle.importKey(format, keyData, {
    name: 'HMAC',
    hash,
  }, true, ['sign', 'verify']);

  return key;
} copy

包装和解包密钥#

const { subtle } = globalThis.crypto;

async function generateAndWrapHmacKey(format = 'jwk', hash = 'SHA-512') {
  const [
    key,
    wrappingKey,
  ] = await Promise.all([
    subtle.generateKey({
      name: 'HMAC', hash,
    }, true, ['sign', 'verify']),
    subtle.generateKey({
      name: 'AES-KW',
      length: 256,
    }, true, ['wrapKey', 'unwrapKey']),
  ]);

  const wrappedKey = await subtle.wrapKey(format, key, wrappingKey, 'AES-KW');

  return { wrappedKey, wrappingKey };
}

async function unwrapHmacKey(
  wrappedKey,
  wrappingKey,
  format = 'jwk',
  hash = 'SHA-512') {

  const key = await subtle.unwrapKey(
    format,
    wrappedKey,
    wrappingKey,
    'AES-KW',
    { name: 'HMAC', hash },
    true,
    ['sign', 'verify']);

  return key;
} copy

签名和验证#

const { subtle } = globalThis.crypto;

async function sign(key, data) {
  const ec = new TextEncoder();
  const signature =
    await subtle.sign('RSASSA-PKCS1-v1_5', key, ec.encode(data));
  return signature;
}

async function verify(key, signature, data) {
  const ec = new TextEncoder();
  const verified =
    await subtle.verify(
      'RSASSA-PKCS1-v1_5',
      key,
      signature,
      ec.encode(data));
  return verified;
} copy

派生位和密钥#

const { subtle } = globalThis.crypto;

async function pbkdf2(pass, salt, iterations = 1000, length = 256) {
  const ec = new TextEncoder();
  const key = await subtle.importKey(
    'raw',
    ec.encode(pass),
    'PBKDF2',
    false,
    ['deriveBits']);
  const bits = await subtle.deriveBits({
    name: 'PBKDF2',
    hash: 'SHA-512',
    salt: ec.encode(salt),
    iterations,
  }, key, length);
  return bits;
}

async function pbkdf2Key(pass, salt, iterations = 1000, length = 256) {
  const ec = new TextEncoder();
  const keyMaterial = await subtle.importKey(
    'raw',
    ec.encode(pass),
    'PBKDF2',
    false,
    ['deriveKey']);
  const key = await subtle.deriveKey({
    name: 'PBKDF2',
    hash: 'SHA-512',
    salt: ec.encode(salt),
    iterations,
  }, keyMaterial, {
    name: 'AES-GCM',
    length,
  }, true, ['encrypt', 'decrypt']);
  return key;
} copy

摘要#

const { subtle } = globalThis.crypto;

async function digest(data, algorithm = 'SHA-512') {
  const ec = new TextEncoder();
  const digest = await subtle.digest(algorithm, ec.encode(data));
  return digest;
} copy

crypto.subtle#

• 类型：<SubtleCrypto>

提供对 SubtleCrypto API 的访问。

crypto.getRandomValues(typedArray)#

• typedArray <Buffer> | <TypedArray>
• 返回：<Buffer> | <TypedArray>

生成密码学上强大的随机值。 给定的 typedArray 填充了随机值，并返回对 typedArray 的引用。

给定的 typedArray 必须是 <TypedArray> 的基于整数的实例，即不接受 Float32Array 和 Float64Array 。

如果给定的 typedArray 大于 65,536 字节，将抛出一个错误。

crypto.randomUUID()#

• 返回：<string>

生成一个随机的 RFC 4122 版本 4 UUID。 UUID 是使用密码学伪随机数生成器生成的。

cryptoKey.algorithm#

• 类型: <AesKeyGenParams> | <RsaHashedKeyGenParams> | <EcKeyGenParams> | <HmacKeyGenParams>

一个对象，详细说明了密钥可用于的算法以及其他特定于算法的参数。

只读。

cryptoKey.extractable#

• 类型: <boolean>

当 true 时，可以使用 subtleCrypto.exportKey() 或 subtleCrypto.wrapKey() 提取 <CryptoKey>。

只读。

cryptoKey.type#

• 类型: <string> 'secret'、'private' 或 'public' 之一。

一个字符串，用于标识密钥是对称密钥（'secret'）还是非对称密钥（'private' 或 'public'）。

cryptoKey.usages#

• 类型: <string[]>

一个字符串数组，用于标识密钥可以使用的操作。

可能的用法是

• 'encrypt' - 密钥可用于加密数据。
• 'decrypt' - 密钥可用于解密数据。
• 'sign' - 密钥可用于生成数字签名。
• 'verify' - 密钥可用于验证数字签名。
• 'deriveKey' - 密钥可用于派生新密钥。
• 'deriveBits' - 密钥可用于派生位。
• 'wrapKey' - 密钥可用于包装另一个密钥。
• 'unwrapKey' - 密钥可用于解包另一个密钥。

有效的密钥用法取决于密钥算法（由 cryptokey.algorithm.name 标识）。

cryptoKeyPair.privateKey#

• 类型: <CryptoKey> 其 type 将为 'private' 的 <CryptoKey>。

cryptoKeyPair.publicKey#

• 类型: <CryptoKey> 其 type 将为 'public' 的 <CryptoKey>。

subtle.decrypt(algorithm, key, data)#

• algorithm: <RsaOaepParams> | <AesCtrParams> | <AesCbcParams> | <AesGcmParams>
• key: <CryptoKey>
• data: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer>
• 返回值: <Promise> 成功时返回一个 <ArrayBuffer>。

使用 algorithm 中指定的方法和参数以及 key 提供的密钥材料，subtle.decrypt() 尝试解密提供的 data。如果成功，则返回的 promise 将解析为一个包含纯文本结果的 <ArrayBuffer>。

目前支持的算法包括

• 'RSA-OAEP'
• 'AES-CTR'
• 'AES-CBC'
• 'AES-GCM'

subtle.deriveBits(algorithm, baseKey[, length])#

• algorithm: <EcdhKeyDeriveParams> | <HkdfParams> | <Pbkdf2Params>
• baseKey: <CryptoKey>
• length: <number> | <null> 默认: null
• 返回值: <Promise> 成功时返回一个 <ArrayBuffer>。

使用 algorithm 中指定的方法和参数以及 baseKey 提供的密钥材料，subtle.deriveBits() 尝试生成 length 位。

当不提供 length 或 length 为 null 时，会生成给定算法的最大位数。这对于 'ECDH'、'X25519' 和 'X448' 算法是允许的，对于其他算法，length 必须是一个数字。

如果成功，则返回的 promise 将解析为一个包含生成的数据的 <ArrayBuffer>。

目前支持的算法包括

• 'ECDH'
• 'X25519'
• 'X448' ¹
• 'HKDF'
• 'PBKDF2'

subtle.deriveKey(algorithm, baseKey, derivedKeyAlgorithm, extractable, keyUsages)#

• algorithm: <EcdhKeyDeriveParams> | <HkdfParams> | <Pbkdf2Params>
• baseKey: <CryptoKey>
• derivedKeyAlgorithm: <string> | <AlgorithmIdentifier> | <HmacImportParams> | <AesDerivedKeyParams>
• extractable: <boolean>
• keyUsages: <string[]> 参见 密钥用法。
• 返回值: <Promise> 成功时返回一个 <CryptoKey>。

使用 algorithm 中指定的方法和参数，以及 baseKey 提供的密钥材料，subtle.deriveKey() 尝试基于 derivedKeyAlgorithm 中的方法和参数生成一个新的 <CryptoKey>。

调用 subtle.deriveKey() 等同于调用 subtle.deriveBits() 来生成原始密钥材料，然后使用 deriveKeyAlgorithm、extractable 和 keyUsages 参数作为输入，将结果传递到 subtle.importKey() 方法中。

目前支持的算法包括

• 'ECDH'
• 'X25519'
• 'X448' ¹
• 'HKDF'
• 'PBKDF2'

subtle.digest(algorithm, data)#

• algorithm: <string> | <AlgorithmIdentifier>
• data: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer>
• 返回值: <Promise> 成功时返回一个 <ArrayBuffer>。

使用 algorithm 标识的方法，subtle.digest() 尝试生成 data 的摘要。 如果成功，则返回的 promise 将解析为一个包含计算出的摘要的 <ArrayBuffer>。

如果 algorithm 作为 <string> 提供，则它必须是以下之一

• 'SHA-1'
• 'SHA-256'
• 'SHA-384'
• 'SHA-512'

如果 algorithm 作为 <Object> 提供，则它必须具有一个 name 属性，其值是上述之一。

subtle.encrypt(algorithm, key, data)#

• algorithm: <RsaOaepParams> | <AesCtrParams> | <AesCbcParams> | <AesGcmParams>
• key: <CryptoKey>
• data: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer>
• 返回值: <Promise> 成功时返回一个 <ArrayBuffer>。

使用 algorithm 指定的方法和参数以及 key 提供的密钥材料，subtle.encrypt() 尝试加密 data。如果成功，则返回的 promise 将解析为一个包含加密结果的 <ArrayBuffer>。

目前支持的算法包括

• 'RSA-OAEP'
• 'AES-CTR'
• 'AES-CBC'
• 'AES-GCM'

subtle.exportKey(format, key)#

• format: <string> 必须是 'raw'、'pkcs8'、'spki' 或 'jwk' 之一。
• key: <CryptoKey>
• 返回值: <Promise> 成功时返回一个 <ArrayBuffer> | <Object>。

将给定的密钥导出为指定的格式（如果支持）。

如果 <CryptoKey> 不可提取，则返回的 promise 将被拒绝。

当 format 是 'pkcs8' 或 'spki' 并且导出成功时，返回的 promise 将解析为一个包含导出的密钥数据的 <ArrayBuffer>。

当 format 是 'jwk' 并且导出成功时，返回的 promise 将解析为一个符合 JSON Web Key 规范的 JavaScript 对象。

subtle.generateKey(algorithm, extractable, keyUsages)#

• algorithm: <string> | <AlgorithmIdentifier> | <RsaHashedKeyGenParams> | <EcKeyGenParams> | <HmacKeyGenParams> | <AesKeyGenParams>

• extractable: <boolean>
• keyUsages: <string[]> 参见 密钥用法。
• 返回值: <Promise> 成功时，使用 <CryptoKey> | <CryptoKeyPair> 兑现。

subtle.generateKey() 尝试使用 algorithm 中提供的方法和参数来生成新的密钥材料。根据使用的方法，该方法可以生成单个 <CryptoKey> 或 <CryptoKeyPair>。

支持生成 <CryptoKeyPair>（公钥和私钥）的算法包括

• 'RSASSA-PKCS1-v1_5'
• 'RSA-PSS'
• 'RSA-OAEP'
• 'ECDSA'
• 'Ed25519'
• 'Ed448' ¹
• 'ECDH'
• 'X25519'
• 'X448' ¹

支持生成 <CryptoKey>（密钥）的算法包括

• 'HMAC'
• 'AES-CTR'
• 'AES-CBC'
• 'AES-GCM'
• 'AES-KW'

subtle.importKey(format, keyData, algorithm, extractable, keyUsages)#

• format: <string> 必须是 'raw'、'pkcs8'、'spki' 或 'jwk' 之一。
• keyData: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer> | <Object>

• algorithm: <string> | <AlgorithmIdentifier> | <RsaHashedImportParams> | <EcKeyImportParams> | <HmacImportParams>

• extractable: <boolean>
• keyUsages: <string[]> 参见 密钥用法。
• 返回值: <Promise> 成功时返回一个 <CryptoKey>。

subtle.importKey() 方法尝试将提供的 keyData 解释为给定的 format，以使用提供的 algorithm、extractable 和 keyUsages 参数创建 <CryptoKey> 实例。如果导入成功，返回的 promise 将使用创建的 <CryptoKey> 来解决。

如果导入 'PBKDF2' 密钥，则 extractable 必须为 false。

目前支持的算法包括

subtle.sign(algorithm, key, data)#

• algorithm: <string> | <AlgorithmIdentifier> | <RsaPssParams> | <EcdsaParams> | <Ed448Params>
• key: <CryptoKey>
• data: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer>
• 返回值: <Promise> 成功时返回一个 <ArrayBuffer>。

subtle.sign() 使用 algorithm 给出的方法和参数以及 key 提供的密钥材料，尝试生成 data 的加密签名。如果成功，返回的 promise 将使用包含生成的签名的 <ArrayBuffer> 来解决。

目前支持的算法包括

• 'RSASSA-PKCS1-v1_5'
• 'RSA-PSS'
• 'ECDSA'
• 'Ed25519'
• 'Ed448' ¹
• 'HMAC'

subtle.unwrapKey(format, wrappedKey, unwrappingKey, unwrapAlgo, unwrappedKeyAlgo, extractable, keyUsages)#

• format: <string> 必须是 'raw'、'pkcs8'、'spki' 或 'jwk' 之一。
• wrappedKey: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer>
• unwrappingKey: <CryptoKey>

• unwrapAlgo: <string> | <AlgorithmIdentifier> | <RsaOaepParams> | <AesCtrParams> | <AesCbcParams> | <AesGcmParams>
• unwrappedKeyAlgo: <string> | <AlgorithmIdentifier> | <RsaHashedImportParams> | <EcKeyImportParams> | <HmacImportParams>

• extractable: <boolean>
• keyUsages: <string[]> 参见 密钥用法。
• 返回值: <Promise> 成功时返回一个 <CryptoKey>。

在密码学中，“包装密钥”是指导出然后加密密钥材料。subtle.unwrapKey() 方法尝试解密包装的密钥并创建 <CryptoKey> 实例。它等效于首先对加密的密钥数据调用 subtle.decrypt()（使用 wrappedKey、unwrapAlgo 和 unwrappingKey 参数作为输入），然后使用 unwrappedKeyAlgo、extractable 和 keyUsages 参数作为输入，将结果传递给 subtle.importKey() 方法。如果成功，返回的 promise 将使用 <CryptoKey> 对象来解决。

当前支持的包装算法包括

• 'RSA-OAEP'
• 'AES-CTR'
• 'AES-CBC'
• 'AES-GCM'
• 'AES-KW'

支持的解包密钥算法包括

• 'RSASSA-PKCS1-v1_5'
• 'RSA-PSS'
• 'RSA-OAEP'
• 'ECDSA'
• 'Ed25519'
• 'Ed448' ¹
• 'ECDH'
• 'X25519'
• 'X448' ¹
• 'HMAC'
• 'AES-CTR'
• 'AES-CBC'
• 'AES-GCM'
• 'AES-KW'

subtle.verify(algorithm, key, signature, data)#

• algorithm: <string> | <AlgorithmIdentifier> | <RsaPssParams> | <EcdsaParams> | <Ed448Params>
• key: <CryptoKey>
• signature: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer>
• data: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer>
• 返回值: <Promise> 成功时，使用 <boolean> 兑现。

subtle.verify() 使用 algorithm 中给出的方法和参数以及 key 提供的密钥材料，尝试验证 signature 是否为 data 的有效加密签名。返回的 promise 将使用 true 或 false 来解决。

目前支持的算法包括

• 'RSASSA-PKCS1-v1_5'
• 'RSA-PSS'
• 'ECDSA'
• 'Ed25519'
• 'Ed448' ¹
• 'HMAC'

subtle.wrapKey(format, key, wrappingKey, wrapAlgo)#

• format: <string> 必须是 'raw'、'pkcs8'、'spki' 或 'jwk' 之一。
• key: <CryptoKey>
• wrappingKey: <CryptoKey>
• wrapAlgo: <string> | <AlgorithmIdentifier> | <RsaOaepParams> | <AesCtrParams> | <AesCbcParams> | <AesGcmParams>
• 返回值: <Promise> 成功时返回一个 <ArrayBuffer>。

在密码学中，“包装密钥”是指导出然后加密密钥材料。subtle.wrapKey() 方法将密钥材料导出为 format 标识的格式，然后使用 wrapAlgo 指定的方法和参数以及 wrappingKey 提供的密钥材料对其进行加密。它等效于使用 format 和 key 作为参数调用 subtle.exportKey()，然后使用 wrappingKey 和 wrapAlgo 作为输入将结果传递给 subtle.encrypt() 方法。如果成功，返回的 promise 将使用包含加密的密钥数据的 <ArrayBuffer> 来解决。

当前支持的包装算法包括

• 'RSA-OAEP'
• 'AES-CTR'
• 'AES-CBC'
• 'AES-GCM'
• 'AES-KW'

类: AlgorithmIdentifier#

类: AesDerivedKeyParams#

类: AesCbcParams#

类：AesCtrParams#

类：AesGcmParams#

类：AesKeyGenParams#

类：EcdhKeyDeriveParams#

类：EcdsaParams#

类：EcKeyGenParams#

类：EcKeyImportParams#

类：Ed448Params#

类：HkdfParams#

类：HmacImportParams#

类：HmacKeyGenParams#

类: Pbkdf2Params#

类: RsaHashedImportParams#

类: RsaHashedKeyGenParams#

类: RsaOaepParams#

类: RsaPssParams#