Gathering detailed insights and metrics for verify-github-webhook-secret
Gathering detailed insights and metrics for verify-github-webhook-secret
🔐 Verifies the secret that is sent in GitHub Webhooks
Installations
npm install verify-github-webhook-secretDeveloper Guide
BETA
Typescript
No
Module System
ESM
Min. Node Version
>= 16.0.0
Node Version
18.16.1
NPM Version
9.5.1
Releases
14
Languages
2
TypeScript
JavaScript
TypeScript (92.81%)
JavaScript (7.19%)
Developer
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
3 Stars
1,648 Commits
2 Watchers
5 Branches
3 Contributors
Updated on Jul 13, 2025
Maintainers
1
Package Meta Information
Latest Version
3.0.2
Package Id
verify-github-webhook-secret@3.0.2
Unpacked Size
7.03 kB
Size
3.23 kB
File Count
9
NPM Version
9.5.1
Node Version
18.16.1
Published on
Jul 18, 2023
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
verify-github-webhook-secret
Verifies the secret that is sent in GitHub Webhooks. The secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.
Installation 🏗
1$ npm install --save verify-github-webhook-secret
or if you use Yarn 🐈
1$ yarn add verify-github-webhook-secret
Usage 🔨
The exported function needs a http.IncomingMessage and your personal secret string. It returns a Promise that fulfills with a boolean if the received secret is valid or not.
You can use it for example with micro as follows:
1import micro from "micro"; 2import { verifySecret } from "verify-github-webhook-secret"; 3 4const server = micro(async (req) => { 5 const valid = await verifySecret(req, "my-secret"); 6 return valid ? "Allowed" : "Not allowed"; 7});
Another way to call the function is directly with the HTTP body and the x-hub-signature HTTP header. This is useful in an scenario where you don't have an IncomingMessage like in some serverless environments.
1import { verifySecret } from "verify-github-webhook-secret"; 2 3async function myFunc() { 4 const valid = await verifySecret('{"foo":"bar"}', "my-secret", "sha1=30a233839fe2ddd9233c49fd593e8f1aec68f553"); 5 return valid ? "Allowed" : "Not allowed"; 6}
No vulnerabilities found.
Reason
30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
0 existing vulnerabilities detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1
- Info: no jobLevel write permissions found
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/screendriver/verify-github-webhook-secret/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/screendriver/verify-github-webhook-secret/ci.yml/main?enable=pin
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
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
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 9 are checked with a SAST tool
Score
4.4
/10
Last Scanned on 2025-07-07
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 More