# @aws-sdk/cloudfront-signer 中文文档

规范地址：https://npmcn.com/package/%40aws-sdk/cloudfront-signer/

版本：3\.1161\.0
npm 元数据更新时间：2026-10-30T18:47:09.439Z
中文译文更新时间：2026-11-07T10:06:14.836Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40aws-sdk/cloudfront-signer
原文对照：https://npmcn.com/package/%40aws-sdk/cloudfront-signer/?lang=original
项目主页：https://github.com/aws/aws-sdk-js-v3/tree/main/packages/cloudfront-signer
源码仓库：https://github.com/aws/aws-sdk-js-v3

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

- 包体积（解压后）：44.8 kB，10 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：2 个
- 首次发布：2022-05-12T18:45:18.402Z
- 最新版本发布：2026-10-30T18:47:09.273Z
- 近 30 天下载量：6550129（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：169（近 12 个月 61 个）

## 中文简介

这个软件包提供了生成签名的urls和cookie的功能,用于基于CloudFront信任的密钥组对访问CloudFront上的私人内容.

## 安装

```sh
npm install @aws-sdk/cloudfront-signer
```

也可以使用：`pnpm add @aws-sdk/cloudfront-signer`、`yarn add @aws-sdk/cloudfront-signer`、`bun add @aws-sdk/cloudfront-signer`

## README

# @aws- sdk/ 云头签名器

这个软件包提供了生成签名的urls和cookie的功能,用于基于CloudFront信任的密钥组对访问CloudFront上的私人内容.

> 请注意,用 Cloudfront 创建已签名的 URL 的过程与 S3 的过程有很大不同 。 详情请查阅文件 [使用已签名的 URL 和已签名的 cookie 限制 CloudFront 内容](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html)。 。 。 .

### 签名 URL

Java 脚本示例 :

```javascript
import { getSignedUrl } from "@aws-sdk/cloudfront-signer"; // ESM
// const { getSignedUrl } = require("@aws-sdk/cloudfront-signer"); // CJS

const cloudfrontDistributionDomain = "https://d111111abcdef8.cloudfront.net";
const s3ObjectKey = "private-content/private.jpeg";
const url = `${cloudfrontDistributionDomain}/${s3ObjectKey}`;
const privateKey = "CONTENTS-OF-PRIVATE-KEY";
const keyPairId = "PUBLIC-KEY-ID-OF-CLOUDFRONT-KEY-PAIR";
const dateLessThan = "2022-01-01"; // any Date constructor compatible

const signedUrl = getSignedUrl({
  url,
  keyPairId,
  dateLessThan,
  privateKey,
});
```

### 用策略签名 URL

```javascript
import { getSignedUrl } from "@aws-sdk/cloudfront-signer"; // ESM
// const { getSignedUrl } = require("@aws-sdk/cloudfront-signer"); // CJS

const cloudfrontDistributionDomain = "https://d111111abcdef8.cloudfront.net";
const s3ObjectKey = "private-content/private.jpeg";
const url = `${cloudfrontDistributionDomain}/${s3ObjectKey}`;
const privateKey = "CONTENTS-OF-PRIVATE-KEY";
const keyPairId = "PUBLIC-KEY-ID-OF-CLOUDFRONT-KEY-PAIR";
const dateLessThan = "2022-01-01";

const policy = {
  Statement: [
    {
      Resource: url,
      Condition: {
        DateLessThan: {
          "AWS:EpochTime": new Date(dateLessThan).getTime() / 1000, // time in seconds
        },
      },
    },
  ],
};

const policyString = JSON.stringify(policy);

const signedUrl = getSignedUrl({
  keyPairId,
  privateKey,
  policy: policyString,
  // url is automatically extracted from the policy, however you could still overwrite it if needed
});
```

### 为资源获取签名的 cookie

```javascript
import { getSignedCookies } from "@aws-sdk/cloudfront-signer"; // ESM
// const { getSignedCookies } = require("@aws-sdk/cloudfront-signer"); // CJS

const cloudfrontDistributionDomain = "https://d111111abcdef8.cloudfront.net";
const s3ObjectKey = "private-content/private.jpeg";
const url = `${cloudfrontDistributionDomain}/${s3ObjectKey}`;
const privateKey = "CONTENTS-OF-PRIVATE-KEY";
const keyPairId = "PUBLIC-KEY-ID-OF-CLOUDFRONT-KEY-PAIR";
const dateLessThan = "2022-01-01";

const cookies = getSignedCookies({
  url,
  keyPairId,
  dateLessThan,
  privateKey,
});
```

### 获得带有策略的签名 cookie

```javascript
import { getSignedCookies } from "@aws-sdk/cloudfront-signer"; // ESM
// const { getSignedCookies } = require("@aws-sdk/cloudfront-signer"); // CJS

const cloudfrontDistributionDomain = "https://d111111abcdef8.cloudfront.net";
const s3ObjectKey = "private-content/private.jpeg";
const url = `${cloudfrontDistributionDomain}/${s3ObjectKey}`;
const privateKey = "CONTENTS-OF-PRIVATE-KEY";
const keyPairId = "PUBLIC-KEY-ID-OF-CLOUDFRONT-KEY-PAIR";
const dateLessThan = "2022-01-01";

const policy = {
  Statement: [
    {
      Resource: url,
      Condition: {
        DateLessThan: {
          "AWS:EpochTime": new Date(dateLessThan).getTime() / 1000, // time in seconds
        },
      },
    },
  ],
};

const policyString = JSON.stringify(policy);

const cookies = getSignedCookies({
  keyPairId,
  privateKey,
  policy: policyString,
});
```

## 常见问题

### @aws-sdk/cloudfront-signer 是什么？

这个软件包提供了生成签名的urls和cookie的功能,用于基于CloudFront信任的密钥组对访问CloudFront上的私人内容\.

### 如何安装 @aws-sdk/cloudfront-signer？

在项目目录运行 npm install @aws-sdk/cloudfront-signer，或使用 pnpm add / yarn add / bun add。

### @aws-sdk/cloudfront-signer 支持 TypeScript 吗？

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

### @aws-sdk/cloudfront-signer 支持 ESM 还是 CommonJS？

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

### @aws-sdk/cloudfront-signer 需要什么版本的 Node\.js？

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

### @aws-sdk/cloudfront-signer 可以商用吗？

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

### @aws-sdk/cloudfront-signer 的下载量有多少？

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

### @aws-sdk/cloudfront-signer 还在维护吗？

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