A JavaScript library for creating and verifying HTTP Signature headers
Table of Contents
Background
HTTP Signatures IETF draft
Install
To install locally (for development):
git clone https://github.com/digitalbazaar/http-signature-header.git
cd http-signature-header
npm install
Usage
import {
createAuthzHeader, createSignatureString
} from '@digitalbazaar/http-signature-header';
const requestOptions = {
url,
method: 'POST',
headers
}
const includeHeaders = ['expires', 'host', '(request-target)'];
const plaintext = createSignatureString({includeHeaders, requestOptions});
const data = new TextEncoder().encode(plaintext);
const signature = base64url.encode(await signer.sign({data}));
const Authorization = createAuthzHeader({
includeHeaders,
keyId: signer.id,
signature
});
Contribute
Please follow the existing code style.
PRs accepted.
If editing the Readme, please conform to the
standard-readme specification.
Commercial Support
Commercial support for this library is available upon request from
Digital Bazaar: [email protected]
License
BSD-3-Clause © Digital Bazaar
关于 @digitalbazaar/http-signature-header 的常见问题
@digitalbazaar/http-signature-header 是什么？
[](https://github.com/digitalbaza
如何安装 @digitalbazaar/http-signature-header？
在项目目录运行 npm install @digitalbazaar/http-signature-header，或使用 pnpm add / yarn add / bun add。
@digitalbazaar/http-signature-header 支持 TypeScript 吗？
该包的 package.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/digitalbazaar__http-signature-header 是否存在。
@digitalbazaar/http-signature-header 支持 ESM 还是 CommonJS？
以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module，更早的版本需要改用动态 import()。
@digitalbazaar/http-signature-header 需要什么版本的 Node.js？
package.json 的 engines 字段要求 Node.js >=14。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。
@digitalbazaar/http-signature-header 可以商用吗？
@digitalbazaar/http-signature-header 使用 BSD-3-Clause 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括，不构成法律意见，请以许可原文为准。
@digitalbazaar/http-signature-header 的下载量有多少？
根据 npm 官方下载统计，@digitalbazaar/http-signature-header 在 2026/10/12 – 2026/11/10 这 30 天内被下载 11,103 次，日均约 370 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@digitalbazaar/http-signature-header 还在维护吗？
最新版本 5.0.1 发布于 2024/08/09（2 年前）；至今共发布 5 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/01/12。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。