a Node.js CLI to deeply analyze the dependency tree of a given NPM package or Node.js local app
- Run a static scan on every JavaScript files and sort out warnings (unsafe-regex, unsafe-import etc) and the complete list of required expr and statements (files, node.js module, etc.).
- Return complete composition for each packages (extensions, files, tarball size, etc).
- Packages metadata from the npm registry API (number of releases, last publish date, maintainers etc).
- Search for licenses files in the tarball and return the SPDX expression conformance of each detected licenses.
- Link vulnerabilities from the multiple sources like GitHub Advisory, Sonatype or Snyk using Vulnera.
- Add flags (emojis) to each packages versions to identify well known patterns and potential security threats easily.
- First-class support of open source security initiatives like OpenSSF Scorecard.
- Generate security report (PDF).
- Node.js v18 or higher
$ npm install @nodesecure/cli -gor
$ git clone https://github.com/NodeSecure/cli.git
$ cd cli
$ npm install
# bundle/compile front-end assets
$ npm run build
$ npm linkThen the nsecure binary will be available in your terminal. Give a try with the popular express package. This will automatically open the webpage in your default system browser.
$ nsecure auto expressTip
Setup an npm token to avoid hiting the maximum request limit of the npm registry API.
# Run a scan on the current working dir
# Note: must have a package.json or node_modules directory
$ nsecure cwd
# Run a scan on a remote 'npm' package
$ nsecure from mochaThen a nsecure-result.json will be writted at the current CLI location. To open it on a web page just run
$ nsecure openThe CLI includes built-in documentation accessible with the --help option:
$ nsecure --help
$ nsecure <command> --helpFor complete details on each command, refer to the following documents:
Each link provides access to the full documentation for the command, including additional details, options, and usage examples.
NodeSecure allow you to fetch stats on private npm packages by setting up a NODE_SECURE_TOKEN env variable (which must contains an npm token).
Tip
If you npm link the package by yourself you can create a .env file at the root of the project too.
NodeSecure is capable to work behind a custom private npm registry too by searching the default registry URL in your local npm configuration.
$ npm config get registry
$ npm config set "http://your-registry/"Our back-end scanner package is available here.
Flags and emojis legends are documented here.
Since version 0.6.0, the UI includes a brand new search bar that allows you to search anything within the tree (graph) using multiple criteria (filters). The currently available filters are:
- package (the default filter if there is none).
- version (take a semver range as an argument).
- flag (list of available flags in the current payload/tree).
- license (list of available licenses in the current payload/tree).
- author (author name/email/url).
- ext (list of available file extensions in the current payload/tree).
- builtin (available Node.js core module name).
- size (see here).
Exemple of query:
version: >=1.2 | 2, ext: .js, builtin: fs
Nodes are highlighted in red when the project/package is flagged with 🔬 hasMinifiedCode or hasWarnings. You can deactivate specific warnings in the options if desired.
The back-end scanner will analyze the complete size of the npm tarball without any filters or specific optimizations. In contrast, Bundlephobia will bundle the package and remove most of the unnecessary files from the tarball, such as documentation and other non-essential items.
Note
We run a weekly Scorecard scan of the 1 million most critical open source projects judged by their direct dependencies and publish the results in a BigQuery public dataset.
If you are a developer looking to contribute to the project, you must first read the CONTRIBUTING guide.
If you have already cloned and installed the project locally with npm, you still need to build and bundle front-end assets using the npm build script:
$ npm run buildImportant
Restart this command when modifying files in the public root folder
Once you have finished your development, check that the tests (and linter) are still good by running the following script:
$ npm testCaution
If you add a feature, try adding tests for it along.
The package is published on NPM with provenance, ensuring that this project is compliant with SLSA Level 3 standards. The build and publication process is managed through the GitHub npm-provenance.yml workflow, which is automatically triggered upon the creation of a new release.
To create a local version of the package using npm and Git, follow these commands:
$ npm version [patch | minor | major]
$ git commit -am "chore: x.x.x"
$ git push origin master --tagsThese commands will increment the package version, commit the changes, and push them along with the tags to the repository
Click on one of the links to access the documentation of the workspace:
| name | package and link |
|---|---|
| documentation-ui | @nodesecure/documentation-ui |
| vis-network | @nodesecure/vis-network |
| size-satisfies | @nodesecure/size-satisfies |
These packages are available in the Node Package Repository and can be easily installed with npm or yarn.
$ npm i @nodesecure/documentation-ui
# or
$ yarn add @nodesecure/documentation-ui
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
MIT