哈希 - API | Bun 文档

Bun 除了下面记录的 Bun 本地 API 之外，还实现了 node:crypto 中的 createHash 和 createHmac 函数。

`Bun.password`

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

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 的第二个参数接受一个 params 对象，该对象允许您选择和配置哈希算法。

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

// use argon2 (default)
const argonHash = await Bun.password.hash(password, {
  algorithm: "argon2id", // "argon2id" | "argon2i" | "argon2d"
  memoryCost: 4, // memory usage in kibibytes
  timeCost: 3, // the number of iterations
});

// use bcrypt
const bcryptHash = await Bun.password.hash(password, {
  algorithm: "bcrypt",
  cost: 4, // number between 4-31
});

用于创建哈希的算法存储在哈希本身中。使用 bcrypt 时，返回的哈希以模块化加密格式编码，以兼容大多数现有的 bcrypt 实现；使用 argon2 时，结果以较新的 PHC 格式编码。

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

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

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

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

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

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

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

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

`Bun.hash`

Bun.hash 是一个用于非加密哈希的实用程序集合。非加密哈希算法针对计算速度进行了优化，而不是抗碰撞或安全性。

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

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

输入可以是字符串、TypedArray、DataView、ArrayBuffer 或 SharedArrayBuffer。

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 给出，以避免精度损失。

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

其他哈希算法作为 Bun.hash 上的属性提供。每个算法的 API 相同，仅将 32 位哈希的返回类型从数字更改为 64 位哈希的 bigint。

Bun.hash.wyhash("data", 1234); // equivalent to Bun.hash()
Bun.hash.crc32("data", 1234);
Bun.hash.adler32("data", 1234);
Bun.hash.cityHash32("data", 1234);
Bun.hash.cityHash64("data", 1234);
Bun.hash.murmur32v3("data", 1234);
Bun.hash.murmur32v2("data", 1234);
Bun.hash.murmur64v2("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"

const hasher = new Bun.CryptoHasher("sha256");
hasher.update("hello world");
hasher.digest();
// Uint8Array(32) [ <byte>, <byte>, ... ]

初始化后，可以使用 .update() 将数据增量提供给哈希器。此方法接受 string、TypedArray 和 ArrayBuffer。

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"`

hasher.update("hello world"); // defaults to utf8
hasher.update("hello world", "hex");
hasher.update("hello world", "base64");
hasher.update("hello world", "latin1");

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

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

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

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

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

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

或者，该方法可以将哈希写入预先存在的 TypedArray 实例。在某些对性能敏感的应用程序中，这可能是理想的。

const arr = new Uint8Array(32);

hasher.digest(arr);

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