@autotelic/ietf-hmac-signatures

中文文档
0.1.0-next.2发布于 2021/05/27MITTypeScriptCommonJS近 30 天下载 1860

根据IETF标准草案构建和核实HMAC签名的方法

中文使用文档
文档目录3 节
  1. 示例
  2. API 密码
  3. 许可证

ietf-hmac 签名

JavaScript Style Guide CI

根据《京都议定书》第十二条第(一)款构建和核实高频谱签名的方法 IETF 标准草案。 。 。 .

示例

const createSignedRequest = require('@autotelic/ietf-hmac-signatures')

// Content to be covered by the HMAC signature
const signatureFields = [
  '(request-target)',
  '(created)',
  '(expires)',
  'Host',
  'Digest',
  'Content-Type'
]

const opts = {
  secret: 'topSecret',
  keyId: 'test-key-a',
  signatureFields
}

// Construct the request signer
const signRequest = createSignedRequest(opts)

// Use
const request = {
  url: 'http://localhost:3000/foo',
  method: 'POST',
  body: JSON.stringify({ hello: 'world' }),
  headers: {
    Date: 1602872645,
    'Content-Type': 'application/json'
  }
}

const signed = signRequest(request)
/**
 * Output:
 *
 * {
 *   url: 'http://localhost:3000/foo',
 *   method: 'POST',
 *   body: JSON.stringify({ hello: 'world' }),
 *   headers: {
 *     Date: 1602872645,
 *     'Content-Type': 'application/json',
 *     Digest: 'sha-512=+PtokCNHosgo04ww4cNhd4yJxhMjLzWjDAKtKwQZDT4Ef9v/PrS/+BQLX4IX5dZkUMK/tQo7Uyc68RkhNyCZVg==',
 *     Signature: 'keyId="test-key-a", algorithm="hs2019", headers="(request-target) (created) (expires) host digest content-type", signature="HFIn7RU3zvfFHeyOjsRlMzUQ18prW+KE61ikKKKoyAlcxGUdlBF/sruA+VznOhQNlWh3J4y3tZc8aDa0TxRBEg==", created="1602872645", expires="1602872945"'
 *   }
 * }
 */

API 密码

/TODO(jkirkpatrick24):生成文档.

许可证

麻省理工学院

版本与发布记录

@autotelic/ietf-hmac-signatures 共发布 4 个版本,首次发布于 2020/11/04;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.1.0-next.2latest2021/05/275 年前
0.1.0-next.12021/05/275 年前
0.1.0-next.02021/03/035 年前
0.1.1-development2020/11/046 年前

关于 @autotelic/ietf-hmac-signatures 的常见问题

@autotelic/ietf-hmac-signatures 是什么?

根据IETF标准草案构建和核实HMAC签名的方法

如何安装 @autotelic/ietf-hmac-signatures?

在项目目录运行 npm install @autotelic/ietf-hmac-signatures,或使用 pnpm add / yarn add / bun add。

@autotelic/ietf-hmac-signatures 支持 TypeScript 吗?

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

@autotelic/ietf-hmac-signatures 支持 ESM 还是 CommonJS?

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

@autotelic/ietf-hmac-signatures 需要什么版本的 Node.js?

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

@autotelic/ietf-hmac-signatures 可以商用吗?

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

@autotelic/ietf-hmac-signatures 的下载量有多少?

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

@autotelic/ietf-hmac-signatures 还在维护吗?

最新版本 0.1.0-next.2 发布于 2021/05/27(5 年前);至今共发布 4 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/11/04。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。