# @csrf-armor/core 中文文档

规范地址：https://npmcn.com/package/%40csrf-armor/core/

版本：1\.3\.1
npm 元数据更新时间：2026-10-05T22:40:01.620Z
中文译文更新时间：2026-11-11T03:17:01.113Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40csrf-armor/core
原文对照：https://npmcn.com/package/%40csrf-armor/core/?lang=original
项目主页：https://github.com/muneebs/csrf-armor#readme
源码仓库：https://github.com/muneebs/csrf-armor

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

- 包体积（解压后）：138 kB，27 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：0 个
- 首次发布：2025-06-02T21:03:40.159Z
- 最新版本发布：2026-10-05T22:40:01.174Z
- 近 30 天下载量：21454（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 6 个）

## 中文简介

框架不可识别的CSRF保护核心功能

## 安装

```sh
npm install @csrf-armor/core
```

也可以使用：`pnpm add @csrf-armor/core`、`yarn add @csrf-armor/core`、`bun add @csrf-armor/core`

## README

# @ csrf- armor/ 核心

![CSRF Armor](https://cdn.nebz.dev/csrf-armor/logo-light.webp)

[![CodeQL](https://github.com/muneebs/csrf-armor/workflows/CodeQL%20Security%20Analysis/badge.svg)](https://github.com/muneebs/csrf-armor/actions/workflows/codeql-analysis.yml) [![CI](https://github.com/muneebs/csrf-armor/workflows/CI/badge.svg)](https://github.com/muneebs/csrf-armor/actions/workflows/ci.yml) [![npm version](https://img.shields.io/npm/v/@csrf-armor/core.svg)](https://www.npmjs.com/package/@csrf-armor/core) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

CSRF Armor背后的框架-不可知引擎. 它没有依赖性,只使用Web API,因此在Node.js和边缘跑道运行.

**使用Next.js,快递还是Nuxt?** 安装适配器; 包含此软件包 : [`@csrf-armor/nextjs`](https://www.npmjs.com/package/@csrf-armor/nextjs) • 妇女 [`@csrf-armor/express`](https://www.npmjs.com/package/@csrf-armor/express) • 妇女 [`@csrf-armor/nuxt`](https://www.npmjs.com/package/@csrf-armor/nuxt)

直接使用核心支持另一个框架,或为低等符号帮助者.

## 安装

```bash
npm install @csrf-armor/core
```

## 使用量

执行 `CsrfAdapter` 您的框架,然后创建一个保护者:

```typescript
import { createCsrfProtection } from '@csrf-armor/core';

const csrf = createCsrfProtection(new MyFrameworkAdapter(), {
  secret: process.env.CSRF_SECRET,
});

const result = await csrf.protect(request, response);

if (!result.success) {
  // Respond with 403. result.reason says why.
}
// Otherwise continue with result.response, which carries the token cookie and header.
```

这个 [适配器指南](https://github.com/muneebs/csrf-armor/blob/main/docs/custom-adapters.md) 覆盖接口并包含一个完整的快感适配器.

## 调用助手

```typescript
import { generateNonce, generateSignedToken, parseSignedToken } from '@csrf-armor/core';

const token = await generateSignedToken(secret, 3600);   // "{expiry}.{nonce}.{signature}"
const { exp } = await parseSignedToken(token, secret);   // throws TokenExpiredError / TokenInvalidError
const nonce = generateNonce(32);                         // 64 hex characters
```

这只处理密码工作 它们不绑定饼干或会话的代币;使用 `createCsrfProtection` 请求保护.

## 文档

-   [战略](https://github.com/muneebs/csrf-armor/blob/main/docs/strategies.md)
-   [配置](https://github.com/muneebs/csrf-armor/blob/main/docs/configuration.md)
-   [安保指南](https://github.com/muneebs/csrf-armor/blob/main/docs/security.md)
-   [写入适配器](https://github.com/muneebs/csrf-armor/blob/main/docs/custom-adapters.md)
-   [API 参考](https://github.com/muneebs/csrf-armor/blob/main/docs/api.md)
-   [移徙](https://github.com/muneebs/csrf-armor/blob/main/docs/migration.md)

## 许可证

麻省理工学院 [萨缪尔斯](https://github.com/muneebs)

## 常见问题

### @csrf-armor/core 是什么？

框架不可识别的CSRF保护核心功能

### 如何安装 @csrf-armor/core？

在项目目录运行 npm install @csrf-armor/core，或使用 pnpm add / yarn add / bun add。

### @csrf-armor/core 支持 TypeScript 吗？

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

### @csrf-armor/core 支持 ESM 还是 CommonJS？

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

### @csrf-armor/core 需要什么版本的 Node\.js？

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

### @csrf-armor/core 可以商用吗？

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

### @csrf-armor/core 的下载量有多少？

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

### @csrf-armor/core 还在维护吗？

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