@freedomofpress/sigsum

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

A Sigsum proof verifier for the browser.

原始使用文档
文档目录3 节
  1. Nominal crypto types
  2. Usage
  3. Experimental policy compilation & evaluation

sigsum-ts

Note: this library has not been audited, thus its security has not been independently verified.

sigsum-ts is a small TypeScript library for verifying Sigsum proofs in the browser. It is designed to work with the Sigsum policy format and verify inclusion proofs, Signed Tree Heads, and cosignatures according to quorum rules. The implementation is strictly for verification purposes, and any cryptographic or format error will throw an exception, ensuring that failures are always explicit and must be caught by the caller. Its only runtime dependency is crypto-browser, which uses the Web Crypto API; applications targeting engines without Ed25519 call installEd25519Fallback() from @freedomofpress/crypto-browser/noble once at startup. The library mirrors the logic of the original Go implementation from the Sigsum repository, and aims to be as close in behavior and structure as possible.

sigsum-ts has complete test coverage. Its primary use case is as part of WEBCAT, a transparency and integrity layer for web-based applications, where client-side verification of cryptographic proofs is required.

For more information on Sigsum visit the sigsum.org or the development repository.

Nominal crypto types

To prevent accidental misuse of cryptographic material, sigsum-ts defines explicit nominal wrapper classes for each crypto type. Although many of them internally wrap a Uint8Array or a string, they are not interchangeable, and TypeScript will refuse to pass a Hash where a Signature is expected.

Usage

To verify a Sigsum proof, call the verifyMessage() function with the message, the raw submitter public key, a Sigsum policy, and the proof text.

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)
);

Sometimes, especially when fetching updates remotely, it could be useful to verify a proof for a hash of a file that has not been obtained yet. verifyHash takes the same arguments of verifyMessage, except that the first one is expected to be already an hash.

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)
);

Experimental policy compilation & evaluation

This project includes a policy compiler and bytecode-based evaluator adapted from the Sigsum C reference implementation. The goal is to make policy verification compact and efficient, suitable for constrained environments with limited memory and binary size requirements (e.g., embedded devices).

Both the compiled format and the evaluation logic are experimental and unstable as they may change without notice as the Sigsum ecosystem evolves.

References:

版本与发布记录

@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 是什么?

A Sigsum proof verifier for the browser.

如何安装 @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 和提交记录判断。