# @ampproject/toolbox-script-csp 中文文档

规范地址：https://npmcn.com/package/%40ampproject/toolbox-script-csp/

版本：2\.10\.1
npm 元数据更新时间：2024-06-14T00:33:56.118Z
中文译文更新时间：2026-11-06T01:25:52.985Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40ampproject/toolbox-script-csp
原文对照：https://npmcn.com/package/%40ampproject/toolbox-script-csp/?lang=original
项目主页：https://github.com/ampproject/amp-toolbox/tree/main/packages/script-csp
源码仓库：https://github.com/ampproject/amp-toolbox

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

- 包体积（解压后）：5.4 kB，4 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2019-08-29T20:28:30.666Z
- 最新版本发布：2024-06-14T00:33:55.589Z
- 近 30 天下载量：158608（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 0 个）

## 中文简介

一个计算 ap-script 的 CSP 散列库

## 安装

```sh
npm install @ampproject/toolbox-script-csp
```

也可以使用：`pnpm add @ampproject/toolbox-script-csp`、`yarn add @ampproject/toolbox-script-csp`、`bun add @ampproject/toolbox-script-csp`

## README

# AMP- Toolbox 脚本 CSP

[![npm version](https://badge.fury.io/js/%40ampproject%2Ftoolbox-script-csp.svg)](https://badge.fury.io/js/%40ampproject%2Ftoolbox-script-csp)

计算 [内容安全政策](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP) 用于给定脚本的散列,格式为预期 [`amp-script`](https://amp.dev/documentation/components/amp-script/)。 。 。 .

使用时需要CSP `amp-script` 带有内线或跨源脚本.

## 使用量

通过 :

```
$ npm install @ampproject/toolbox-script-csp
```

### 使用模块

该模块暴露了单一功能, `calculateHash(src, options?)`。 。 。 .

`src` 可以是字符串(在这种情况下假设UTF8编码)或 [`DataView`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView) 例如 [`Buffer`](https://nodejs.org/api/buffer.html)。 。 。 .

`options` 用于覆盖默认选项.

#### 选项

-   `algorithm` 覆盖要使用的散列算法。 现在,唯一的 支持的算法 `amp-script` 实值 `sha384` 默认值.

### 示例

以下是如何使用 `calculateHash` 函数生成一个 `amp-script` CSP头条.

注意在计算 hash 并必须完全匹配内入脚本中使用的白空格.

```javascript
const {calculateHash} = require('@ampproject/toolbox-script-csp');

const script = `
    const subject = 'world';
    console.log('Hello, ' + subject);
    `;

const hash = calculateHash(script);

console.log(hash);  // sha384-xRxb5sv13at6tVgZET4JLmf89TSZP10HjCGXVqO9bKWVXB0asV2jLrsDN8v4zX6j
```

生成的散列可用于 `<meta>` 标记此方式 :

```html
<!doctype html>
<html ⚡>
<head>
  ...

  <meta name="amp-script-src" content="sha384-xRxb5sv13at6tVgZET4JLmf89TSZP10HjCGXVqO9bKWVXB0asV2jLrsDN8v4zX6j">
</head>
  <body>
    ...

    <amp-script layout="container" script="example"></amp-script>

    <script id="example" type="text/plain" target="amp-script">
    const subject = 'world';
    console.log('Hello, ' + subject);
    </script>
  </body>
</html>
```

## 常见问题

### @ampproject/toolbox-script-csp 是什么？

一个计算 ap-script 的 CSP 散列库

### 如何安装 @ampproject/toolbox-script-csp？

在项目目录运行 npm install @ampproject/toolbox-script-csp，或使用 pnpm add / yarn add / bun add。

### @ampproject/toolbox-script-csp 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/ampproject\_\_toolbox-script-csp 是否存在。

### @ampproject/toolbox-script-csp 支持 ESM 还是 CommonJS？

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

### @ampproject/toolbox-script-csp 可以商用吗？

@ampproject/toolbox-script-csp 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @ampproject/toolbox-script-csp 的下载量有多少？

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

### @ampproject/toolbox-script-csp 还在维护吗？

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

