Skip to content

NOTE

Bun 实现了 [`node:crypto`](https://nodejs.org/api/crypto.html) 中的 `createHash` 和 `createHmac` 函数, 此外还有下面记录的 Bun 原生 API。

Bun.password

Bun.password 是一组用于使用各种加密安全算法进行哈希和密码验证的实用函数集合。

ts
const password = "super-secure-pa$$word";

const hash = await Bun.password.hash(password);
// => $argon2id$v=19$m=65536,t=2,p=1$tFq+9AVr1bfPxQdh6E8DQRhEXg/M/SqYCNu6gVdRRNs$GzJ8PuBi+K+BVojzPfS5mjnC8OpLGtv8KJqF99eP6a4

const isMatch = await Bun.password.verify(password, hash);
// => true

Bun.password.hash 的第二个参数接受一个参数对象,让你可以选择和配置哈希算法。

ts
const password = "super-secure-pa$$word";

// 使用 argon2(默认)
const argonHash = await Bun.password.hash(password, {
  algorithm: "argon2id", // "argon2id" | "argon2i" | "argon2d"
  memoryCost: 4, // 内存使用量(kibibytes)
  timeCost: 3, // 迭代次数
});

// 使用 bcrypt
const bcryptHash = await Bun.password.hash(password, {
  algorithm: "bcrypt",
  cost: 4, // 4-31 之间的数字
});

用于创建哈希的算法存储在哈希本身中。使用 bcrypt 时,返回的哈希以 Modular Crypt Format 编码,以与大多数现有 bcrypt 实现兼容;使用 argon2 时,结果以较新的 PHC format 编码。

verify 函数根据输入哈希自动检测算法并使用正确的验证方法。它可以正确地从 PHC 或 MCF 编码的哈希中推断算法。

ts
const password = "super-secure-pa$$word";

const hash = await Bun.password.hash(password, {
  /* 配置 */
});

const isMatch = await Bun.password.verify(password, hash);
// => true

所有函数的同步版本也可用。请记住,这些函数计算成本很高,因此使用阻塞 API 可能会降低应用程序性能。

ts
const password = "super-secure-pa$$word";

const hash = Bun.password.hashSync(password, {
  /* 配置 */
});

const isMatch = Bun.password.verifySync(password, hash);
// => true

当你使用 Bun.password.hash 时,会自动生成一个盐并包含在哈希中。

bcrypt - Modular Crypt Format

在以下 Modular Crypt Format 哈希(bcrypt 使用)中:

输入:

ts
await Bun.password.hash("hello", {
  algorithm: "bcrypt",
});

输出:

sh
$2b$10$Lyj9kHYZtiyfxh2G60TEfeqs7xkkGiEFFDi3iJGc50ZG/XJ1sxIFi;

格式由以下部分组成:

  • bcrypt: $2b
  • rounds: $10 - 轮数(实际轮数的 log10)
  • salt: $Lyj9kHYZtiyfxh2G60TEfeqs7xkkGiEFFDi3iJGc50ZG/XJ1sxIFi
  • hash: $GzJ8PuBi+K+BVojzPfS5mjnC8OpLGtv8KJqF99eP6a4

默认情况下,bcrypt 库会截断超过 72 字节的密码。在 Bun 中,如果你传递给 Bun.password.hash 的密码超过 72 字节并使用 bcrypt 算法,密码将在传递给 bcrypt 之前通过 SHA-512 进行哈希。

ts
await Bun.password.hash("hello".repeat(100), {
  algorithm: "bcrypt",
});

因此,Bun 不会静默地将 500 字节的密码截断为 72 字节传递给 bcrypt,而是使用 SHA-512 对密码进行哈希并将哈希后的密码发送给 bcrypt(仅当超过 72 字节时)。这是更安全的默认行为。

argon2 - PHC 格式

在以下 PHC format 哈希(argon2 使用)中:

输入:

ts
await Bun.password.hash("hello", {
  algorithm: "argon2id",
});

输出:

sh
$argon2id$v=19$m=65536,t=2,p=1$xXnlSvPh4ym5KYmxKAuuHVlDvy2QGHBNuI6bJJrRDOs$2YY6M48XmHn+s5NoBaL+ficzXajq2Yj8wut3r0vnrwI

格式由以下部分组成:

  • algorithm: $argon2id
  • version: $v=19
  • memory cost: 65536
  • iterations: t=2
  • parallelism: p=1
  • salt: $xXnlSvPh4ym5KYmxKAuuHVlDvy2QGHBNuI6bJJrRDOs
  • hash: $2YY6M48XmHn+s5NoBaL+ficzXajq2Yj8wut3r0vnrwI

Bun.hash

Bun.hash 是一组用于 非加密 哈希的实用工具。非加密哈希算法针对计算速度进行了优化,而不是抗碰撞性或安全性。

标准 Bun.hash 函数使用 Wyhash 从任意大小的输入生成 64 位哈希。

ts
Bun.hash("some data here");
// 11562320457524636935n

输入可以是字符串、TypedArrayDataViewArrayBufferSharedArrayBuffer

ts
const arr = new Uint8Array([1, 2, 3, 4]);

Bun.hash("some data here");
Bun.hash(arr);
Bun.hash(arr.buffer);
Bun.hash(new DataView(arr.buffer));

可选地,可以将整数种子作为第二个参数指定。对于 64 位哈希,大于 Number.MAX_SAFE_INTEGER 的种子应作为 BigInt 提供,以避免精度损失。

ts
Bun.hash("some data here", 1234);
// 15724820720172937558n

Bun.hash 的属性上提供了其他哈希算法。每个 API 都相同,只是将 32 位哈希的返回类型从 number 更改为 64 位哈希的 bigint。

ts
Bun.hash.wyhash("data", 1234); // 等同于 Bun.hash()
Bun.hash.crc32("data", 1234);
Bun.hash.adler32("data", 1234);
Bun.hash.cityHash32("data", 1234);
Bun.hash.cityHash64("data", 1234);
Bun.hash.xxHash32("data", 1234);
Bun.hash.xxHash64("data", 1234);
Bun.hash.xxHash3("data", 1234);
Bun.hash.murmur32v3("data", 1234);
Bun.hash.murmur32v2("data", 1234);
Bun.hash.murmur64v2("data", 1234);
Bun.hash.rapidhash("data", 1234);

Bun.CryptoHasher

Bun.CryptoHasher 是一个通用实用类,让你可以使用一系列加密哈希算法增量计算字符串或二进制数据的哈希。支持以下算法:

  • "blake2b256"
  • "blake2b512"
  • "md4"
  • "md5"
  • "ripemd160"
  • "sha1"
  • "sha224"
  • "sha256"
  • "sha384"
  • "sha512"
  • "sha512-224"
  • "sha512-256"
  • "sha3-224"
  • "sha3-256"
  • "sha3-384"
  • "sha3-512"
  • "shake128"
  • "shake256"
ts
const hasher = new Bun.CryptoHasher("sha256");
hasher.update("hello world");
hasher.digest();
// Uint8Array(32) [ <byte>, <byte>, ... ]

初始化后,可以使用 .update() 增量将数据馈送到哈希器。此方法接受 stringTypedArrayArrayBuffer

ts
const hasher = new Bun.CryptoHasher("sha256");

hasher.update("hello world");
hasher.update(new Uint8Array([1, 2, 3]));
hasher.update(new ArrayBuffer(10));

如果传递 string,可以使用可选的第二个参数指定编码(默认 'utf-8')。支持以下编码:

类别编码
二进制编码"base64" "base64url" "hex" "binary"
字符编码"utf8" "utf-8" "utf16le" "latin1"
传统字符编码"ascii" "binary" "ucs2" "ucs-2"
ts
hasher.update("hello world"); // 默认为 utf8
hasher.update("hello world", "hex");
hasher.update("hello world", "base64");
hasher.update("hello world", "latin1");

数据馈送到哈希器后,可以使用 .digest() 计算最终哈希。默认情况下,此方法返回包含哈希的 Uint8Array

ts
const hasher = new Bun.CryptoHasher("sha256");
hasher.update("hello world");

hasher.digest();
// => Uint8Array(32) [ 185, 77, 39, 185, 147, ... ]

.digest() 方法可选地将哈希作为字符串返回。为此,请指定编码:

ts
hasher.digest("base64");
// => "uU0nuZNNPgilLlLX2n2r+sSE7+N6U4DukIj3rOLvzek="

hasher.digest("hex");
// => "b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9"

或者,该方法可以将哈希写入预先存在的 TypedArray 实例。这可能在某些性能敏感应用中需要。

ts
const arr = new Uint8Array(32);

hasher.digest(arr);

console.log(arr);
// => Uint8Array(32) [ 185, 77, 39, 185, 147, ... ]

Bun.CryptoHasher 中的 HMAC

Bun.CryptoHasher 可用于计算 HMAC 摘要。为此,请将密钥传递给构造函数。

ts
const hasher = new Bun.CryptoHasher("sha256", "secret-key");
hasher.update("hello world");
console.log(hasher.digest("hex"));
// => "095d5a21fe6d0646db223fdf3de6436bb8dfb2fab0b51677ecf6441fcf5f2a67"

使用 HMAC 时,支持的算法集更有限:

  • "blake2b512"
  • "md5"
  • "sha1"
  • "sha224"
  • "sha256"
  • "sha384"
  • "sha512-224"
  • "sha512-256"
  • "sha512"

与非 HMAC Bun.CryptoHasher 不同,HMAC Bun.CryptoHasher 实例在调用 .digest() 后不会重置,尝试再次使用同一实例将抛出错误。

支持其他方法如 .copy().update()(只要在 .digest() 之前),但不支持像 .digest() 这样最终确定哈希器的方法。

ts
const hasher = new Bun.CryptoHasher("sha256", "secret-key");
hasher.update("hello world");

const copy = hasher.copy();
copy.update("!");
console.log(copy.digest("hex"));
// => "3840176c3d8923f59ac402b7550404b28ab11cb0ef1fa199130a5c37864b5497"

console.log(hasher.digest("hex"));
// => "095d5a21fe6d0646db223fdf3de6436bb8dfb2fab0b51677ecf6441fcf5f2a67"

Bun学习网由www.bunjs.com.cn整理维护