# @fastify/csrf 中文文档

规范地址：https://npmcn.com/package/%40fastify/csrf/

版本：8\.1\.1
npm 元数据更新时间：2026-10-18T12:30:29.217Z
中文译文更新时间：2026-11-14T11:18:17.642Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：47.9 kB，25 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2021-05-12T16:29:42.756Z
- 最新版本发布：2026-10-09T08:37:06.520Z
- 近 30 天下载量：758251（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 2 个）

## 中文简介

csrf 符号背后的主逻辑

## 安装

```sh
npm install @fastify/csrf
```

也可以使用：`pnpm add @fastify/csrf`、`yarn add @fastify/csrf`、`bun add @fastify/csrf`

## README

# 中国证监会

[![CI](https://github.com/fastify/csrf/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/fastify/csrf/actions/workflows/ci.yml) [![NPM version](https://img.shields.io/npm/v/@fastify/csrf.svg?style=flat)](https://www.npmjs.com/package/@fastify/csrf) [![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard)

CSRF标志创建与验证背后的逻辑.

读取 [谅解 -- -- 中国证监会](https://github.com/pillarjs/understanding-csrf) 欲了解更多有关企业社会责任基金的信息。 使用此模块创建自定义的 CSRF 中间软件 .

寻找您最喜欢的框架的 CSRF 框架 模块?

-   快捷/连接 : [库尔多夫](https://www.npmjs.com/package/csurf) 或者说 [备选案文xsrf](https://www.npmjs.com/package/alt-xsrf)
-   科亚: [科阿语csrf](https://www.npmjs.com/package/koa-csrf) 或者说 [科阿原子会议](https://www.npmjs.com/package/koa-atomic-session)

此模块为 [https://github.com/pillerjs/csrf 页面存档备份,存于互联网档案馆](https://github.com/pillarjs/csrf) 在f0d66c91ea4be6d30a03bd311ed9518951d9c3e4时.

### 安装

```sh
$ npm i @fastify/csrf
```

### 类型脚本

本单元包括: [类型脚本](https://www.typescriptlang.org/) 允许自动完成兼容编辑器和类型的声明文件 typeScript 项目的信息.

## API 密码

```js
const Tokens = require('@fastify/csrf')
```

### 新托肯( \[选项\])

创建新的代号/核查实例 。 这个 `options` 参数是 可选,如果缺少,则只使用所有默认值.

#### 选项

Tokens 在选项对象中接受这些属性 .

##### 算法

散列算法生成符. 默认为 `sha256`。 。 。 .

##### 盐质

内用盐的长度,以字符表示. 内部的盐 是一个基础 62 字符串。 默认为 `8` 字符键.

##### 密钥 Length

要生成的秘密的长度, 以字节表示 。 注意,这个秘密是 环绕64个基数编码,这个长度指底数 字节,而不是基-64字符串的长度. 默认为 `18` 字节.

##### 用户信息

要求在 `tokens.create()` 财务报告和审定财务报表 `tokens.verify()`。 。 。 .

##### 密钥

设定时 `hmacKey` 用于生成加密 HMAC 散列,而不是默认散列函数.

##### 有效性

要生成的符号的最大有效性, 以毫秒计 。 注意,时代是 绕了36号基地的密码 默认为 `0` 毫秒 (残疾).

#### coords.create (secret \[, userInfo\] ) (密语)

创建一个新的CSRF 令牌, 附加在给定的上 `secret`编辑 `secret` 是一个 字符串,通常从 `tokens.secret()` 或者说 `tokens.secretSync()` 方法。 。 。 此符号是您应该添加到 HTML 中的内容 `<form>` 块和 期望用户的浏览器提供回馈.

```js
const secret = tokens.secretSync()
const token = tokens.create(secret)
```

这个 `userInfo` 参数可用于防止饼干抛出 在不可信的情况下部署应用程序时的攻击(和类似) 子域. 它将编码其中某些用户特定信息 符号 。 只有在 `userInfo: true` 传递到 建筑师.

#### 符号. secret(召回)

同步创建新 `secret`,这是一个字符串。 秘诀是 保存在服务器上,通常保存在服务器侧会话中 用户。 秘密应至少是每个用户.

```js
tokens.secret(function (err, secret) {
  if (err) throw err
  // Do something with the secret
})
```

#### 符号. secret ()

同步创建新 `secret` 返回一个 `Promise`请参看 `tokens.secret(callback)` 详细文件.

**说明**:在Node.js中使用承诺 _在0.12年之前_承诺必须 “填充”使用 `global.Promise = require('bluebird')`。 。 。 .

```js
tokens.secret().then(function (secret) {
  // Do something with the secret
})
```

#### 符号. secretSync ()

同步版本的 `tokens.secret(callback)`请参看 `tokens.secret(callback)` 详细文件.

```js
const secret = tokens.secretSync()
```

#### coorders.verify (机密, coord \[, userInfo\]) (密文, coords \[, userInfo\] ) (英文)

检查 CSRF 令牌对给定是否有效 `secret`返回时 a 布尔.

```js
if (!tokens.verify(secret, token)) {
  throw new Error('invalid token!')
}
```

这个 `userInfo` 如果 `userInfo: true` 已配置 初始化期间。 用户特定信息必须匹配 通过了 `tokens.create()`。 。 。 .

## 许可证

许可证根据 [麻省理工学院](https://npmcn.com/package/%40fastify/csrf/LICENSE)。 。 。 .

## 常见问题

### @fastify/csrf 是什么？

csrf 符号背后的主逻辑

### 如何安装 @fastify/csrf？

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

### @fastify/csrf 支持 TypeScript 吗？

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

### @fastify/csrf 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @fastify/csrf 可以商用吗？

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

### @fastify/csrf 的下载量有多少？

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

### @fastify/csrf 还在维护吗？

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