大网数据广告活动
Web 标准与前端开发

SubtleCrypto:digest() 方法

· 52CE 我爱测

SubtleCrypto 接口的 **`digest()`** 方法使用指定的hash function生成给定数据的*摘要*。摘要是从一些可变长的输入生成的短且具有固定长度的值。密码学摘要应表现出抗冲突性,这意味着很难构造出具有相同摘要值的两个不同的输入。

Web Crypto API

SubtleCrypto 接口的 digest() 方法使用指定的hash function生成给定数据的摘要。摘要是从一些可变长的输入生成的短且具有固定长度的值。密码学摘要应表现出抗冲突性,这意味着很难构造出具有相同摘要值的两个不同的输入。

它以使用的摘要算法的标识符和计算摘要的数据为参数。并返回一个 Promise,会兑现数据的摘要值。

请注意此 API 不支持流式输入:你必须先将整个输入读入内存,然后再将其传递给摘要函数。

语法

digest(algorithm, data)

参数

  • algorithm
    • : 可以是一个字符串或一个仅有 name 字符串属性的对象。该字符串为使用的散列函数的名称。支持的值有:
      • "SHA-1"(但是请不要在加密应用程序中使用它)
      • "SHA-256"
      • "SHA-384"
      • "SHA-512"
  • data
    • : 一个包含将计算摘要的数据的 ArrayBuffer、TypedArray 或 DataView 对象。

返回值

一个 Promise,会兑现一个包含摘要值的 ArrayBuffer。

支持的算法

摘要算法(也称为hash function)将任意长度的数据块转换为固定长度的输出(通常比输入短得多)。其在密码学中有多种应用。

<table class="standard-table"> <tbody> <tr> <th scope="col">算法</th> <th scope="col">输出长度(比特)</th> <th scope="col">块大小(比特)</th> <th scope="col">规范</th> </tr> <tr> <th scope="row">SHA-1</th> <td>160</td> <td>512</td> <td> <a href="https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf" >FIPS 180-4</a > 第 6.1 节 </td> </tr> <tr> <th scope="row">SHA-256</th> <td>256</td> <td>512</td> <td> <a href="https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf" >FIPS 180-4</a > 第 6.2 节 </td> </tr> <tr> <th scope="row">SHA-384</th> <td>384</td> <td>1024</td> <td> <a href="https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf" >FIPS 180-4</a > 第 6.5 节 </td> </tr> <tr> <th scope="row">SHA-512</th> <td>512</td> <td>1024</td> <td> <a href="https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf" >FIPS 180-4</a > 第 6.4 节 </td> </tr> </tbody> </table>

[!WARNING] 现在,SHA-1 被认为是易受攻击的,不应将其用于加密应用程序。

[!NOTE] 如果你在寻找如何创建密钥散列消息认证码(HMAC),则需要改用 SubtleCrypto.sign() 方法。

示例

有关使用 digest() API 的更多示例,请参阅 SubtleCrypto 的非加密用途。

基本示例

此示例对消息进行编码,然后计算其 SHA-256 摘要,并打印摘要长度:

const text =
  "An obscure body in the S-K System, your majesty. The inhabitants refer to it as the planet Earth.";

async function digestMessage(message) {
  const encoder = new TextEncoder();
  const data = encoder.encode(message);
  const hash = await window.crypto.subtle.digest("SHA-256", data);
  return hash;
}

digestMessage(text).then((digestBuffer) =>
  console.log(digestBuffer.byteLength),
);

将摘要转换为十六进制字符串

摘要以 ArrayBuffer 的形式返回,但为了进行比较和显示,通常会使用十六进制(hex)字符串的形式表示。此示例计算摘要,然后将 ArrayBuffer 转换为十六进制字符串:

const text =
  "An obscure body in the S-K System, your majesty. The inhabitants refer to it as the planet Earth.";

async function digestMessage(message) {
  const msgUint8 = new TextEncoder().encode(message); // 编码为(utf-8)Uint8Array
  const hashBuffer = await window.crypto.subtle.digest("SHA-256", msgUint8); // 计算消息的散列值
  const hashArray = Array.from(new Uint8Array(hashBuffer)); // 将缓冲区转换为字节数组
  const hashHex = hashArray
    .map((b) => b.toString(16).padStart(2, "0"))
    .join(""); // 将字节数组转换为十六进制字符串
  return hashHex;
}

digestMessage(text).then((digestHex) => console.log(digestHex));

规范

浏览器兼容性

参见

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。