Gathering detailed insights and metrics for csrf
Gathering detailed insights and metrics for csrf
Installations
npm install csrfDeveloper Guide
BETA
Typescript
No
Module System
N/A
Min. Node Version
>= 0.8
Node Version
8.15.1
NPM Version
6.4.1
Score
99
Supply Chain
99.5
Quality
77.4
Maintenance
100
Vulnerability
100
License
Releases
16
Languages
1
JavaScript
JavaScript (100%)
Developer
pillarjs
Download Statistics
Total Downloads
205,643,591
Last Day
121,108
Last Week
759,154
Last Month
3,387,616
Last Year
37,607,051
GitHub Statistics
MIT License
310 Stars
293 Commits
32 Forks
18 Watchers
1 Branches
27 Contributors
Updated on Apr 24, 2025
Bundle Size
3.52 kB
Minified
1.30 kB
Minified + Gzipped
Maintainers
2
Package Meta Information
Latest Version
3.1.0
Package Id
csrf@3.1.0
Size
4.69 kB
NPM Version
6.4.1
Node Version
8.15.1
Published on
Apr 10, 2019
Total Downloads
Cumulative downloads
Total Downloads
205,643,591
CSRF
Logic behind CSRF token creation and verification.
Read Understanding-CSRF for more information on CSRF. Use this module to create custom CSRF middleware.
Looking for a CSRF framework for your favorite framework that uses this module?
- Express/connect: csurf or alt-xsrf
- Koa: koa-csrf or koa-atomic-session
Install
1$ npm install csrf
TypeScript
This module includes a TypeScript declaration file to enable auto complete in compatible editors and type information for TypeScript projects.
API
1var Tokens = require('csrf')
new Tokens([options])
Create a new token generation/verification instance. The options argument is
optional and will just use all defaults if missing.
Options
Tokens accepts these properties in the options object.
saltLength
The length of the internal salt to use, in characters. Internally, the salt
is a base 62 string. Defaults to 8 characters.
secretLength
The length of the secret to generate, in bytes. Note that the secret is
passed around base-64 encoded and that this length refers to the underlying
bytes, not the length of the base-64 string. Defaults to 18 bytes.
tokens.create(secret)
Create a new CSRF token attached to the given secret. The secret is a
string, typically generated from the tokens.secret() or tokens.secretSync()
methods. This token is what you should add into HTML <form> blocks and
expect the user's browser to provide back.
1var secret = tokens.secretSync() 2var token = tokens.create(secret)
tokens.secret(callback)
Asynchronously create a new secret, which is a string. The secret is to
be kept on the server, typically stored in a server-side session for the
user. The secret should be at least per user.
1tokens.secret(function (err, secret) { 2 if (err) throw err 3 // do something with the secret 4})
tokens.secret()
Asynchronously create a new secret and return a Promise. Please see
tokens.secret(callback) documentation for full details.
Note: To use promises in Node.js prior to 0.12, promises must be
"polyfilled" using global.Promise = require('bluebird').
1tokens.secret().then(function (secret) { 2 // do something with the secret 3})
tokens.secretSync()
A synchronous version of tokens.secret(callback). Please see
tokens.secret(callback) documentation for full details.
1var secret = tokens.secretSync()
tokens.verify(secret, token)
Check whether a CSRF token is valid for the given secret, returning
a Boolean.
1if (!tokens.verify(secret, token)) { 2 throw new Error('invalid token!') 3}
License
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
11 different organizations found -- score normalized to 10
Details
- Info: contributors work for ExpressGateway,crypto-utils,expressjs,houzz,jshttp,koajs,mysqljs,nodejs,pillarjs,repo-utils,stream-utils
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: License file found in expected location: LICENSE:1
- Info: FSF or OSI recognized license: LICENSE:1
Reason
security policy file detected
Details
- Info: security policy file detected: github.com/pillarjs/.github/SECURITY.md:1
- Info: Found linked content: github.com/pillarjs/.github/SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/pillarjs/.github/SECURITY.md:1
- Info: Found text in security policy: github.com/pillarjs/.github/SECURITY.md:1
Reason
no vulnerabilities detected
Reason
dependency not pinned by hash detected -- score normalized to 2
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:124: update your workflow using https://app.stepsecurity.io/secureworkflow/pillarjs/csrf/ci.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:187: update your workflow using https://app.stepsecurity.io/secureworkflow/pillarjs/csrf/ci.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:199: update your workflow using https://app.stepsecurity.io/secureworkflow/pillarjs/csrf/ci.yml/master?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:147
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:163
- Info: 3 out of 4 GitHub-owned GitHubAction dependencies pinned
- Info: 1 out of 3 third-party GitHubAction dependencies pinned
- Info: 0 out of 2 npmCommand dependencies pinned
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
0 out of 1 merged PRs checked by a CI test -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
found 29 unreviewed changesets out of 30 -- score normalized to 0
Reason
no update tool detected
Details
- Warn: tool 'RenovateBot' is not used: Follow the instructions from https://docs.renovatebot.com/configuration-options/. (Low effort)
- Warn: tool 'Dependabot' is not used: Follow the instructions from https://docs.github.com/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates. (Low effort)
- Warn: tool 'PyUp' is not used: Follow the instructions from https://docs.pyup.io/docs. (Low effort)
- Warn: tool 'Sonatype Lift' is not used: Follow the instructions from https://help.sonatype.com/lift/getting-started. (Low effort)
Reason
project is not fuzzed
Details
- Warn: no OSSFuzz integration found: Follow the steps in https://github.com/google/oss-fuzz to integrate fuzzing for your project. Over time, try to add fuzzing for more functionalities of your project. (High effort)
- Warn: no OneFuzz integration found: Follow the steps in https://github.com/microsoft/onefuzz to start fuzzing for your project. Over time, try to add fuzzing for more functionalities of your project. (High effort)
- Warn: no GoBuiltInFuzzer integration found: Follow the steps in https://go.dev/doc/fuzz/ to enable fuzzing on your project. Over time, try to add fuzzing for more functionalities of your project. (Medium effort)
- Warn: no PythonAtherisFuzzer integration found: Follow the steps in https://github.com/google/atheris to enable fuzzing on your project. Over time, try to add fuzzing for more functionalities of your project. (Medium effort)
- Warn: no CLibFuzzer integration found: Follow the steps in https://llvm.org/docs/LibFuzzer.html to enable fuzzing on your project. Over time, try to add fuzzing for more functionalities of your project. (Medium effort)
- Warn: no CppLibFuzzer integration found: Follow the steps in https://llvm.org/docs/LibFuzzer.html to enable fuzzing on your project. Over time, try to add fuzzing for more functionalities of your project. (Medium effort)
- Warn: no SwiftLibFuzzer integration found: Follow the steps in https://google.github.io/oss-fuzz/getting-started/new-project-guide/swift-lang/ to enable fuzzing on your project. Over time, try to add fuzzing for more functionalities of your project. (Medium effort)
- Warn: no RustCargoFuzzer integration found: Follow the steps in https://rust-fuzz.github.io/book/cargo-fuzz.html to enable fuzzing on your project. Over time, try to add fuzzing for more functionalities of your project. (Medium effort)
- Warn: no JavaJazzerFuzzer integration found: Follow the steps in https://github.com/CodeIntelligenceTesting/jazzer to enable fuzzing on your project. Over time, try to add fuzzing for more functionalities of your project. (Medium effort)
- Warn: no ClusterFuzzLite integration found: Follow the steps in https://github.com/google/clusterfuzzlite to integrate fuzzing as part of CI. Over time, try to add fuzzing for more functionalities of your project. (High effort)
- Warn: no HaskellPropertyBasedTesting integration found: Use one of the following frameworks to fuzz your project: QuickCheck: https://hackage.haskell.org/package/QuickCheck hedgehog: https://hedgehog.qa/ validity: https://github.com/NorfairKing/validity smallcheck: https://hackage.haskell.org/package/smallcheck hspec: https://hspec.github.io/ tasty: https://hackage.haskell.org/package/tasty (High effort)
- Warn: no TypeScriptPropertyBasedTesting integration found: Use fast-check: https://github.com/dubzzz/fast-check (High effort)
- Warn: no JavaScriptPropertyBasedTesting integration found: Use fast-check: https://github.com/dubzzz/fast-check (High effort)
Reason
0 commit(s) out of 30 and 0 issue activity out of 8 found in the last 90 days -- score normalized to 0
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 1 are checked with a SAST tool
- Warn: CodeQL tool not detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1: Visit https://app.stepsecurity.io/secureworkflow/pillarjs/csrf/ci.yml/master?enable=permissions Tick the 'Restrict permissions for GITHUB_TOKEN' Untick other options NOTE: If you want to resolve multiple issues at once, you can visit https://app.stepsecurity.io/securerepo instead. (Low effort)
- Info: topLevel permissions set to 'read-all': .github/workflows/scorecard.yml:19
- Info: no jobLevel write permissions found
Score
3.9
/10
Last Scanned on 2025-04-21T21:27:34Z
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