@freedomofpress/sigsum

中文文档
0.6.0发布于 2026/10/31MITTypeScriptES Module构建来源已验证近 30 天下载 1977

浏览器的 Sigsum 验证器 .

中文使用文档
文档目录3 节
  1. 名义密码类型
  2. 使用量
  3. 实验政策汇编和评价

缩略语

注:该图书馆未经审计,因此其安全性未经独立核实.

sigsum-ts 是一个小型的 TypeScript 库,用于在浏览器中校验 Sigsum 证明 。 它旨在与Sigsum政策格式合作,并根据法定人数规则核实包含证明、签名树头和签名。 执行严格是为了核查目的,任何密码或格式出错都会造成例外,确保故障总是明确的,必须被呼叫者抓住. 它唯一的运行时间依赖是 密码浏览器,使用 网络加密 API; 应用程序针对没有Ed25519呼叫的引擎 installEd25519Fallback() 从 @freedomofpress/crypto-browser/noble 一次开始。 库从"Sigsum"寄存器中映射出原"Go"执行的逻辑,旨在行为和结构上尽可能相近.

sigsum-ts 有完整的测试覆盖。 其主要用途是: 韦贝克,用于网络应用程序的透明度和完整性层,其中客户端需要验证加密证明.

关于Sigsum的更多信息,请访问 sigsum.org (英语) 或 数据库。 。 。 .

名义密码类型

为防止意外地滥用密码材料, sigsum-ts 定义每个加密类型的明确面值包装类。 虽然他们中许多人在内部包裹 Uint8Array 或一个 string,它们不能互换,而 TypeScript 会拒绝通过一个 Hash 其中a Signature 预期.

使用量

要校验 Sigsum 证明, 请用信件、 原始提交者公钥、 策略和证明文本调用 yessage () 函数 .

import { verifyMessage } from "sigsum-ts";

const isValid = await verify(
  messageBytes, // Uint8Array
  submitterRawPublicKey, // Uint8Array as RawPublicKey (32 bytes, Ed25519)
  policyText, // string (Sigsum policy format)
  proofText, // string (Sigsum proof format)
);

有时,特别是在远程获取更新时,验证尚未获得的文件散列的证据可能是有用的. verifyHash 采用同样的论点: verifyMessage,但第一个应该是 已经散去.

import { verifyMessage } from "sigsum-ts";

const isValid = await verifyMessage(
  messageHash, // Uint8Array
  submitterRawPublicKey, // Uint8Array as RawPublicKey (32 bytes, Ed25519)
  policyText, // string (Sigsum policy format)
  proofText, // string (Sigsum proof format)
);

实验政策汇编和评价

这个项目包括一个政策汇编器和一个基于字节编码的评价员,根据《公约》第19条加以修改 锡格苏姆 C 参考执行。 目标是使政策验证紧凑而高效,适合内存和二进制尺寸要求有限的受制约环境(如嵌入式设备).

汇编的格式和评价逻辑都具有实验性和不稳定性,因为随着西格苏姆生态系统的发展,它们可能在不事先通知的情况下发生变化.

参考文献:

版本与发布记录

@freedomofpress/sigsum 共发布 7 个版本,首次发布于 2025/11/27;过去 12 个月发布了 7 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.6.0latest2026/10/3115 天前
0.5.02026/10/3116 天前
0.4.02026/09/301 个月前
0.3.92026/09/152 个月前
0.3.82025/12/1011 个月前
0.3.72025/12/0311 个月前

关于 @freedomofpress/sigsum 的常见问题

@freedomofpress/sigsum 是什么?

浏览器的 Sigsum 验证器 .

如何安装 @freedomofpress/sigsum?

在项目目录运行 npm install @freedomofpress/sigsum,或使用 pnpm add / yarn add / bun add。

@freedomofpress/sigsum 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@freedomofpress/sigsum 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@freedomofpress/sigsum 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@freedomofpress/sigsum 可以商用吗?

@freedomofpress/sigsum 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@freedomofpress/sigsum 的下载量有多少?

根据 npm 官方下载统计,@freedomofpress/sigsum 在 2026/10/16 – 2026/11/14 这 30 天内被下载 1,977 次,日均约 66 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@freedomofpress/sigsum 还在维护吗?

最新版本 0.6.0 发布于 2026/10/31(15 天前);至今共发布 7 个版本,其中过去 12 个月发布了 7 个;首次发布于 2025/11/27。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。