# @civic/auth-verify 中文文档

规范地址：https://npmcn.com/package/%40civic/auth-verify/

版本：0\.0\.5
npm 元数据更新时间：2026-10-30T07:49:16.163Z
中文译文更新时间：2026-11-09T22:28:46.032Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40civic/auth-verify
原文对照：https://npmcn.com/package/%40civic/auth-verify/?lang=original

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

- 包体积（解压后）：43.2 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：1 个
- 首次发布：2025-06-02T12:38:56.197Z
- 最新版本发布：2026-07-14T11:41:46.525Z
- 近 30 天下载量：4778（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 2 个）

## 中文简介

JWT 公民 Auth 核查库

## 安装

```sh
npm install @civic/auth-verify
```

也可以使用：`pnpm add @civic/auth-verify`、`yarn add @civic/auth-verify`、`bun add @civic/auth-verify`

## README

# @ civic/ auth- 验证

JWT 用于使用 JWKS 端点发现的 Civil Auth 证书的验证库 .

## 特征

-   使用 JWKS 端点发现进行 JWT 符号验证
-   OIDC配置发现(. 熟知/开通配置)
-   使用基于发行器的密钥为 JWKS 数据构建缓存
-   支持多个缓存执行( InMemory and Bundled)
-   具有完整类型安全的脚本支持

## 安装

```bash
pnpm add @civic/auth-verify
```

## 使用量

### 基本用途

```typescript
import { verify } from '@civic/auth-verify';

// Verify a token with default settings (uses Civic Auth issuer)
const payload = await verify(token);
console.log(payload);
```

### 使用自定义缓存

默认情况下,库对JWKS数据使用内存缓存. 如有需要,您可以自行提供缓存执行 .

在内存缓存中,密钥被存储在内存中,并在进程重启时丢失. 库使用所有共享的默认实例 `verify` 除非你自己提供.

如果您想要控制缓存的生命周期,请提供以下内容:

```typescript
import { verify, InMemoryJWKSCache } from '@civic/auth-verify';

// Create a custom cache instance
const cache = new InMemoryJWKSCache();

// Use the cache for verification
const payload = await verify(token, {
  jwksCache: cache
});
```

### 使用 “ Bundled 缓存 ” (预装 Civil Auth JWKS)

Bundled缓存是预存有Civil Auth JWKS密钥的密钥缓存,可用于离线验证或降低延迟.

-   **预装密钥**: 包含在构建时捆绑的最新公民 Auth JWKS
-   **离线支持**: 能够验证公民 没有网络请求的认证符
-   **业绩**: 取消 JWKS 为 Civil Auth 令牌获取的初始版本
-   **更新**: 捆绑的JWKS在包建/发布时被更新
-   **广泛**: 仍然可以为其他发行人动态获取并缓存 JWKS

**说明**:被捆绑的JWKS是Civil Auth键所特有的. 如果使用另一个发行器,您仍可使用 `InMemoryJWKSCache` 或执行自己的缓存.

```typescript
import { verify, BundledJWKSCache } from '@civic/auth-verify';

// Use bundled cache with pre-downloaded Civic Auth JWKS
const cache = new BundledJWKSCache();

const payload = await verify(token, {
  jwksCache: cache
});
```

## API 密码

### `verify(token: string, options?: VerifyOptions): Promise<JWTPayload>`

验证一个JWT标志,并返回其有效载荷.

#### 参数

-   `token` - JWT证明书
-   `options` - 可选核查选项
    -   `issuer` - 符号发行器 URL( 默认为 Civil Auth)
    -   `wellKnownConfigurationUrl` - 自定义 OpenID 配置 URL
    -   `jwksCache` - 自定义 JWKS 缓存执行
    -   `aud` - 标志的预期受众值(可选)
    -   `clientId` - 对象的预期客户端ID值(可选). 如果提供,JWT必须在以下两种中的任何一种中包含这一数值: `client_id` 或者说 `tid` 字段
    -   `issuerValidator` - 可选上游 `(issuer: string) => boolean` 为了接受这个标志 `iss` 索赔。 提供时,Jose的精确匹配的发行人检查被跳过,而代号是 `iss` 3⁄4 ̄ ̧漯B 用它来接受多个发行商,例如动态客户注册的租户范围发行商(英语:`https://auth.civic.com/oauth/<tid>/`JWKS的发现仍然使用 `issuer` (或默认),所以每个被接受的发行者必须共享JWKS.

#### 回返

一个能解决JWT有效载荷的承诺.

### 接受多个发行人(例如,租户范围/DCR令牌)

```typescript
import { verify } from '@civic/auth-verify';

// Accept the base Civic issuer and any tenant-scoped issuer beneath it
const payload = await verify(token, {
  issuerValidator: (iss) => iss.startsWith('https://auth.civic.com/oauth/'),
});
```

## 发展

```bash
# Install dependencies
pnpm install

# Run tests
pnpm test

# Build
pnpm build

# Lint
pnpm lint
```

## 常见问题

### @civic/auth-verify 是什么？

JWT 公民 Auth 核查库

### 如何安装 @civic/auth-verify？

在项目目录运行 npm install @civic/auth-verify，或使用 pnpm add / yarn add / bun add。

### @civic/auth-verify 支持 TypeScript 吗？

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

### @civic/auth-verify 支持 ESM 还是 CommonJS？

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

### @civic/auth-verify 需要什么版本的 Node\.js？

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

### @civic/auth-verify 可以商用吗？

@civic/auth-verify 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @civic/auth-verify 的下载量有多少？

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

### @civic/auth-verify 还在维护吗？

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