safely* install packages with npm/yarn by auditing them as part of your install process
Media coverage about npq:
- As mentioned on Thomas Gentilhomme's French book of Become a Node.js Developer
- Tao Bojlén's A web of trust for npm
- Zander's favorite list of command line tools
- Ran Bar Zik's npq review to install safe modules
- ostechnix's How To Safely Install Packages Using Npm Or Yarn On Linux
- debricked's How to evaluate the security of your NPM Package dependencies
- JavaScript January advent calendar's post on Open Source From Heaven, Modules From Hell
- Liran Tal's Malicious Modules — what you need to know when installing npm packages
About
Once npq is installed, you can safely* install packages:
npq install expressnpq will perform the following steps to sanity check that the package is safe by employing syntactic heuristics and querying a CVE database:
- Consult the snyk.io database of publicly disclosed vulnerabilities to check if a security vulnerability exists for this package and its version.
- Package age on npm
- Package download count as a popularity metric
- Package has a README file
- Package has a LICENSE file
- Package has pre/post install scripts
If npq is prompted to continue with the install, it simply hands over the actual package install job to the package manager (npm by default).
safely* - there's no guaranteed safety; a malicious or vulnerable package could still exist that has no security vulnerabilities publicly disclosed and passes npq's checks.
Install
npm install -g npqNote: we recommend installing with npm rather than yarn. That way, npq can automatically install shell aliases for you.
Usage
Install packages with npq:
npq install expressEmbed in your day to day
Since npq is a pre-step to ensure that the npm package you're installing is safe, you can safely embed it in your day-to-day npm usage so there's no need to remember to run npq explicitly.
alias npm='npq-hero'Offload to package managers
If you're using yarn, or generally want to explicitly tell npq which package manager to use you can specify an environment variable: NPQ_PKG_MGR=yarn
Example: create an alias with yarn as the package manager:
alias yarn="NPQ_PKG_MGR=yarn npq-hero"Note: npq by default will offload all commands and their arguments to the npm package manager after it finished its due-diligence for the respective packages.
Marshalls
| Marshall Name | Description | Notes |
|---|---|---|
| age | Will show a warning for a package if its age on npm is less than 22 days | Checks a package creation date, not a specific version |
| author | Will show a warning if a package has been found without an author field | Checks the latest version for an author |
| downloads | Will show a warning for a package if its download count in the last month is less than 20 | |
| readme | Will show a warning if a package has no README or it has been detected as a security placeholder package by npm staff | |
| repo | Will show a warning if a package has been found without a valid and working repository URL | Checks the latest version for a repository URL |
| scripts | Will show a warning if a package has a pre/post install script which could potentially be malicious | |
| snyk | Will show a warning if a package has been found with vulnerabilities in Snyk's database | For Snyk to work you need to either have the snyk npm package installed with a valid api token, or make the token available in the SNYK_TOKEN environment variable, and npq will use it |
| license | Will show a warning if a package has been found without a license field | Checks the latest version for a license |
| expired domains | Will show a warning if a package has been found with one of its maintainers having an email address that includes an expired domain | Checks a dependency version for a maintainer with an expired domain |
Disabling Marshalls
To disable a marshall altogether, set an environment variable using with the marshall's shortname.
Example, to disable the Snyk vulnerability marshall:
MARSHALL_DISABLE_SNYK=1 npq install express
Run checks on package without installing it:
npq install express --dry-runUsing with TravisCI
An example of using lockfile-lint with a .travis.yml configuration as part of your build:
language: node_js
before_script:
- npx lockfile-lint --path package-lock.json --validate-https --allowed-hosts npm
install:
- yarn install
script:
- yarn run test
FAQ
- Can I use NPQ without having npm or yarn?
- NPQ will audit a package for possible security issues, but it isn't a replacement for npm or yarn. When you choose to continue installing the package, it will offload the installation process to your choice of either npm or yarn.
- How is NPQ different from npm audit?
npm installwill install a module even if it has vulnerabilities; NPQ will display the issues detected, and prompt the user for confirmation on whether to proceed installing it.- NPQ will run synthetic checks, called marshalls, on the characteristics of a module, such as whether the module you are going to install has a
pre-installscript which can be potentially harmful for your system and prompt you whether to install it. Whereasnpm auditwill not perform any such checks, and only consults a vulnerability database for known security issues. npm auditis closer in functionality to what Snyk does, rather than what NPQ does.
- Do I require a Snyk API key in order to use NPQ?
- It's not required. If NPQ is unable to detect a Snyk API key for the user running NPQ, then it will skip the database vulnerabilities check. We do, however, greatly encourage you to use Snyk, and connect it with NPQ for broader security.
Contributing
Please consult the CONTRIBUTING for guidelines on contributing to this project
Author
Liran Tal [email protected]