# @gldywn/crlset\.js 中文文档

规范地址：https://npmcn.com/package/%40gldywn/crlset.js/

版本：1\.2\.0
npm 元数据更新时间：2025-08-08T10:27:37.108Z
中文译文更新时间：2026-11-16T15:45:59.620Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40gldywn/crlset.js
原文对照：https://npmcn.com/package/%40gldywn/crlset.js/?lang=original
项目主页：https://github.com/Gldywn/crlset.js#readme
源码仓库：https://github.com/Gldywn/crlset.js

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：131 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 首次发布：2025-08-01T09:10:58.586Z
- 最新版本发布：2025-08-08T10:27:36.955Z
- 近 30 天下载量：4088（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 0 个）

## 中文简介

获取和剖析内存中最新的 Chrome CRLSet, 支持检查证书或其签发者是否已被吊销 .

## 安装

```sh
npm install @gldywn/crlset.js
```

也可以使用：`pnpm add @gldywn/crlset.js`、`yarn add @gldywn/crlset.js`、`bun add @gldywn/crlset.js`

## README

![crlset.js](https://npmcn.com/package/%40gldywn/crlset.js/assets/header.png)

# CRLSet.js (英语)

CRLSet.js是TypeScript中用于Node.js的轻量级CRLSet解析器和验证器. 它获取并解析存储器中最新的 Chrome CRLSet, 支持检查证书或其签发者是否已被吊销 .

[![Build Status](https://github.com/Gldywn/crlset.js/actions/workflows/build.yml/badge.svg)](https://github.com/Gldywn/crlset.js/actions/workflows/build.yml) [![Coverage Status (codecov.io)](https://codecov.io/gh/Gldywn/crlset.js/branch/main/graph/badge.svg)](https://codecov.io/gh/Gldywn/crlset.js) [![npm](https://img.shields.io/npm/v/@gldywn/crlset.js.svg)](https://www.npmjs.com/package/@gldywn/crlset.js) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A 类 [CRLSet 软件](https://www.chromium.org/Home/chromium-security/crlsets/) 是谷歌汇总的证书吊销信息的集合,被克罗姆用来快速识别并屏蔽被吊销的证书. 与传统的证书撤销列表(CRLs)或在线证书状态协议(OCSP)不同,CRLSets提供了快速有效的机制来检查证书的撤销状态.

这个库处理从Google的"Omaha"代理中取取最新CRLSet的过程,验证其签名以确保其完整性,解析,并可供撤销检查使用. 它被设计为易于嵌入到HTTPS代理或TLS验证流中. 虽然它为大多数使用案例提供了一个简单的一行函数,但它也输出其核心组件用于更先进的自定义执行.

## 安装

```sh
npm install @gldywn/crlset.js
```

## 基本用途

此库的主要功能是确定一个给定的证书是否根据最新的 CRLSet 被吊销. 这是通过对照CRLSet中的块列表来检查证书的发证人和序列号来实现的.

> 完整、可操作的例子见 [实例/核实.ts](https://npmcn.com/package/%40gldywn/crlset.js/examples/verify.ts)。 。 。 .

```typescript
console.log('Loading the latest CRLSet...');
/*
 * By default, `loadLatestCRLSet` verifies the CRX signature, checks for a newer version,
 * and downloads it if available. The latest version is cached to avoid redundant downloads.
 * For customization:
 *  - `verifySignature: false`: Disables CRX signature verification (not recommended).
 *  - `updateStrategy: 'on-expiry'`: Updates only when the cached version hard-expires (not recommended).
 * e.g. `await loadLatestCRLSet({ verifySignature: false, updateStrategy: 'on-expiry' })`
 */
const crlSet = await loadLatestCRLSet();
console.log(
  `Successfully loaded CRLSet ${crlSet.sequence} (${crlSet.getBlockedSpkiCount()} blocked SPKIs, ${crlSet.getRevocationCount()} revocations).`,
);

const revokedBySerialInfo = {
  spkiHash: '03b4392598a10a3ff5695cf02a5775586b170f564a808a4d41568578a184e329',
  serialNumber: '179cc56dc82dbded5573c7999997f646',
};

console.log(
  `\nChecking certificate with issuer SPKI hash: ${revokedBySerialInfo.spkiHash} and serial number: ${revokedBySerialInfo.serialNumber}...`,
);
const status = crlSet.check(revokedBySerialInfo.spkiHash, revokedBySerialInfo.serialNumber);
console.log(`Certificate revocation status: ${RevocationStatus[status]}`); // REVOKED_BY_SERIAL

// [...]
crlSet.check(revokedBySpkiInfo.spkiHash, notRevokedInfo.serialNumber); // REVOKED_BY_SPKI
crlSet.check(notRevokedInfo.spkiHash, notRevokedInfo.serialNumber); // OK
```

## 高级使用

对于更具体的用例,您可以使用 `CRLSet` 类和其他直接导出函数。 这使得您可以构建一个 `CRLSet` 实例来自自定义数据或利用库的内部力学为您自己的逻辑。 这样一来 `crlset.js` 用于处理CRLSets的多功能"瑞士陆军刀".

### 外观检查

虽然 `check` 如果需要区分不同的撤销理由,您也可以直接调用基本方法:

```typescript
const isRevokedBySpki = crlSet.isRevokedBySPKI(certificateInfo.spkiHash);
console.log(`Is certificate revoked by SPKI?: ${isRevokedBySpki}`);

const isRevokedBySerial = crlSet.isRevokedBySerial(certificateInfo.spkiHash, certificateInfo.serialNumber);
console.log(`Is certificate revoked by serial?: ${isRevokedBySerial}`);
```

### 直接 `CRLSet` 证据

您可以创建 `CRLSet` 实例,如果您有标题和撤销数据.

```typescript
import { CRLSet, RevocationStatus } from '@gldywn/crlset.js';
import type { CRLSetHeader } from '@gldywn/crlset.js';

// Define the header and revocation data
const header: CRLSetHeader = {
  Sequence: 1,
  NumParents: 1,
  BlockedSPKIs: [],
  NotAfter: Math.floor(Date.now() / 1000) + 3600, // Expires in 1 hour
  ContentType: 'CRLSet',
  DeltaFrom: 0,
};

const revocations = new Map<string, Set<string>>();
const spkiHash = 'a_spki_hash_in_hex';
const serials = new Set(['a_serial_number_in_hex']);
revocations.set(spkiHash, serials);

// Create a new CRLSet instance
const crlSet = new CRLSet(header, revocations);

// Use it as usual
const status = crlSet.check(spkiHash, 'a_serial_number_in_hex');
console.log(RevocationStatus[status]); // REVOKED_BY_SERIAL
```

### 导出的工具函数

库输出其大部分内部功能, 允许您构建自定义逻辑 :

-   **`fetchCrxUrl()`**:从Google的Omaha代理服务器获取最新CRLSet CRX文件的下载URL.
-   **`downloadLatestCRLSetCrx()`**:下载完整的 CRLSet CRX 文件,并作为缓冲器返回.
-   **`fetchRemoteHeader()`**: 执行部分下载,只取最新 CRLSet 的页眉,用于快速版本检查.
-   **`unpackCrx(crxBuffer)`**: 解析出一个原始的 CRX 文件缓冲器,将Protobuf头与主要ZIP内容相分离.
-   **`processCrx(crxBuffer, verifySignature)`**:一个高级函数,可以解开一个 CRX 文件,可选地验证其签名,并解析包含的 CRLSet 数据.
-   **`parseCRLSet(crlSetBuffer)`**: 解析二进制 CRLSet 数据( `crl-set` 从 ZIP 中生成一个结构化标题和一个撤销地图.
-   **`parseCRLSetHeader(crlSetBuffer)`**:一个轻量级解析器,只读取从CRLSet数据得到的JSON头.
-   **`verifyCrxSignature(crxHeader, zipBuffer)`**:验证CRX文件在标题中针对公钥的签名.

## 测试

该项目包括一个综合测试套件,以确保正确性和稳定性.

### 运行测试

要运行完整的测试套件 :

```sh
npm test
```

## 许可证

CRLSet.js根据麻省理工学院的许可证进行发售.

## 常见问题

### @gldywn/crlset\.js 是什么？

获取和剖析内存中最新的 Chrome CRLSet, 支持检查证书或其签发者是否已被吊销 \.

### 如何安装 @gldywn/crlset\.js？

在项目目录运行 npm install @gldywn/crlset\.js，或使用 pnpm add / yarn add / bun add。

### @gldywn/crlset\.js 支持 TypeScript 吗？

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

### @gldywn/crlset\.js 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @gldywn/crlset\.js 可以商用吗？

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

### @gldywn/crlset\.js 的下载量有多少？

根据 npm 官方下载统计，@gldywn/crlset\.js 在 2026/10/17 – 2026/11/15 这 30 天内被下载 4,088 次，日均约 136 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @gldywn/crlset\.js 还在维护吗？

最新版本 1\.2\.0 发布于 2025/08/08（1\.3 年前）；至今共发布 6 个版本，其中过去 12 个月发布了 0 个；首次发布于 2025/08/01。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

