node-secure

ver license build status Test coverage dep size download All Contributors

Node.js security Command Line Interface. The goal of the project is to a design a CLI/API that will fetch and deeply analyze the dependency tree of a given npm package (Or a local project with a package.json) and output a .json file that will contains all metadata and flags about each packages.

The CLI allow to load the JSON into a Webpage with the open command. The page will draw a Network of all dependencies with vis.js (example in the screenshot below).

Features

Requirements

Getting Started

$ npm install nsecure -g

or

$ git clone https://github.com/ES-Community/nsecure.git
$ cd nsecure
$ npm ci
$ npm run build
$ npm link

Then 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 express

⚠️ Setup an npm token to avoid hiting the maximum request limit of the npm registry API.

Usage example

To show the complete list of commands

$ nsecure --help

# Run an analysis on the current working dir (must have a package.json file).
$ nsecure cwd

# Run an analysis for a given 'npm' package (must be in the npm registry).
$ nsecure from @sindresorhus/is

Then a nsecure-result.json will be writted at the current CLI location. To open it on a web page just run

$ nsecure open

The auto command can be used to chain cwd/from and open commands automatically.

$ nsecure auto jest

# if no package is given to the auto command then it will run the cwd command instead of from.
$ nsecure auto

πŸ‘€ By default with the auto command the .json file is deleted when the http server is closed. It’s possible to disable this behavior by using the CLI option --keep, -k.


Some options are available on both cwd, from and auto commands. The output option is not available for the auto command.

name shortcut default value description
–depth -d 4 the maximum depth we must walk (when we fetch the whole tree).
–output -o nsecure-result the name that the outputted .json file will have
$ nsecure from express -d 10 -o express-security-report

Private packages / registry

Nsecure allow you to fetch stats on private npm packages by setting up a NODE_SECURE_TOKEN env variable (which must contains an npm token).

πŸ’¬ If you link the package by yourself with npm you can create a .env file at the root of the project too.

Nsecure 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/"

API

Use nsecure as an API package to fetch and work with the generated JSON. The following example demonstrates how to retrieve the Payload for mocha, cacache and is-wsl packages. It’s possible to use the cwd method if you want to achieve similar work on a local project.

const { from } = require("nsecure");
const { writeFile } = require("fs").promises;

async function main() {
    const toFetch = ["mocha", "cacache", "is-wsl"];
    const options = { verbose: false }; // disable verbose to not show the spinners

    const payloads = await Promise.all(
        toFetch.map((name) => from(name, options))
    );

    const toWritePromise = [];
    for (let i = 0; i < toFetch.length; i++) {
        const data = JSON.stringify(payloads[i], null, 2);
        toWritePromise.push(writeFile(`${toFetch[i]}.json`, data));
    }
    await Promise.allSettled(toWritePromise);
}
main().catch(console.error);

The SlimIO Security project use nsecure with the API to analyze packages and repositories of a given github organization (or user).

Flags legends

Flags and emojis legends are documented here.

Searchbar filters

Since version 0.6.0 of Node-secure the UI include a brand new searchbar that allow to search anything on the tree (graph) by multiple criteria (filters). The current available filters are:

Exemple of query:

version: >=1.2 | 2, ext: .js, builtin: fs

FAQ

Why some nodes are red in the UI ?

Nodes are red when the project/package has been flagged with πŸ”¬ hasMinifiedCode or ⚠️ hasWarnings.

Why the node-secure package size is so different from Bundlephobia ?

Node-secure will analyze the complete size of the npm tarball with no filters or particular optimization. Bundlephobia on the other side will bundle and remove most of the useless files from the tarball (Like the documentation, etc.).

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Haze

πŸ’» 🎨

fraxken

πŸ’» πŸ› πŸ“ ⚠️ πŸ“– 🎨

Xavier Stouder

πŸ’» 🎨 πŸ“–

This project follows the all-contributors specification. Contributions of any kind welcome!

Roadmap

We have created a trello so that we can plan long-term tasks. Do not hesitate to come participate and exchange your ideas!

License

MIT