Installations
npm install http-signature-headerDeveloper Guide
Typescript
No
Module System
CommonJS, UMD
Min. Node Version
>=8.6.0
Node Version
14.18.2
NPM Version
6.14.15
Score
72.1
Supply Chain
90.5
Quality
80.4
Maintenance
100
Vulnerability
100
License
Releases
Unable to fetch releases
Contributors
Unable to fetch Contributors
Languages
JavaScript (99.66%)
Shell (0.34%)
Developer
digitalbazaar
Download Statistics
Total Downloads
60,924
Last Day
20
Last Week
57
Last Month
188
Last Year
3,711
GitHub Statistics
8 Stars
269 Commits
2 Forks
12 Watching
7 Branches
14 Contributors
Bundle Size
6.66 kB
Minified
2.52 kB
Minified + Gzipped
Maintainers
Package Meta Information
Latest Version
3.0.0
Package Id
http-signature-header@3.0.0
Unpacked Size
26.22 kB
Size
8.58 kB
File Count
7
NPM Version
6.14.15
Node Version
14.18.2
Total Downloads
Cumulative downloads
Total Downloads
60,924
Last day
150%
20
Compared to previous day
Last week
0%
57
Compared to previous week
Last month
13.3%
188
Compared to previous month
Last year
-20.4%
3,711
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
HTTP Signature Header (http-signature-header)
A JavaScript library for creating and verifying HTTP Signature headers
Table of Contents
Background
Install
To install locally (for development):
git clone https://github.com/digitalbazaar/http-signature-header.git
cd http-signature-header
npm install
Usage
1const {createAuthzHeader, createSignatureString} = require('http-signature-header'); 2 3const requestOptions = { 4 url, 5 method: 'POST', 6 headers 7} 8const includeHeaders = ['expires', 'host', '(request-target)']; 9const plaintext = createSignatureString({includeHeaders, requestOptions}); 10 11const data = new TextEncoder().encode(plaintext); 12const signature = base64url.encode(await signer.sign({data})); 13 14const Authorization = createAuthzHeader({ 15 includeHeaders, 16 keyId: signer.id, 17 signature 18});
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: support@digitalbazaar.com
License
BSD-3-Clause © Digital Bazaar
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE.md:0
- Info: FSF or OSI recognized license: BSD 3-Clause "New" or "Revised" License: LICENSE.md:0
Reason
Found 2/17 approved changesets -- score normalized to 1
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/main.yaml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yaml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/digitalbazaar/http-signature-header/main.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/digitalbazaar/http-signature-header/main.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yaml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/digitalbazaar/http-signature-header/main.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yaml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/digitalbazaar/http-signature-header/main.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yaml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/digitalbazaar/http-signature-header/main.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yaml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/digitalbazaar/http-signature-header/main.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yaml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/digitalbazaar/http-signature-header/main.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yaml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/digitalbazaar/http-signature-header/main.yaml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yaml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/digitalbazaar/http-signature-header/main.yaml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/main.yaml:64
- Warn: npmCommand not pinned by hash: .github/workflows/main.yaml:18
- Warn: npmCommand not pinned by hash: .github/workflows/main.yaml:33
- Warn: npmCommand not pinned by hash: .github/workflows/main.yaml:48
- Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
- Info: 0 out of 4 npmCommand dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 17 are checked with a SAST tool
Score
3.9
/10
Last Scanned on 2025-01-27
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn MoreOther packages similar to http-signature-header
@digitalbazaar/http-signature-header
[](https://npm.im/http-signature-header) [](https://github.com/digitalbaza
http-signature-header-signing
http signature header signing
authorization-signature
Create HTTP Authorization header values for [HTTP Message Signatures](https://oauth.net/http-signatures/).
header-forwarder
Package with utilities to extract HTTP headers with X-* signature