NAME¶

npm-audit

Synopsis¶

<!-- AUTOGENERATED USAGE DESCRIPTIONS -->

Description¶

The audit command submits a description of the dependencies configured in your project to your default registry and asks for a report of known vulnerabilities.
If any vulnerabilities are found, then the impact and appropriate remediation will be calculated.
If the fix argument is provided, then remediations will be applied to the package tree.

The command will exit with a 0 exit code if no vulnerabilities were found.

Note that some vulnerabilities cannot be fixed automatically and will require manual intervention or review.
Also note that since npm audit fix runs a full-fledged npm install under the hood, all configs that apply to the installer will also apply to npm install -- so things like npm audit fix --package-lock-only will work as expected.

By default, the audit command will exit with a non-zero code if any vulnerability is found.
It may be useful in CI environments to include the --audit-level parameter to specify the minimum vulnerability level that will cause the command to fail.
This option does not filter the report output, it simply changes the command's failure threshold.

Package lock¶

By default npm requires a package-lock or shrinkwrap in order to run the audit.
You can bypass the package lock with --no-package-lock but be aware the results may be different with every run, since npm will re-build the dependency tree each time.

Audit Signatures¶

To ensure the integrity of packages you download from the public npm registry, or any registry that supports signatures, you can verify the registry signatures of downloaded packages using the npm CLI.

Registry signatures can be verified using the following audit command:

$ npm audit signatures

The audit signatures command will also verify the provenance attestations of downloaded packages.
Because provenance attestations are such a new feature, security features may be added to (or changed in) the attestation format over time.
To ensure that you're always able to verify attestation signatures check that you're running the latest version of the npm CLI. Please note this often means updating npm beyond the version that ships with Node.js.

To include the full sigstore attestation bundles in JSON output, use:

$ npm audit signatures --json --include-attestations

This adds a verified array to the JSON output containing the attestation
bundles (DSSE envelopes, verification material, and transparency log entries)
for each verified package.

The npm CLI supports registry signatures and signing keys provided by any registry if the following conventions are followed:

"dist":{


  "..omitted..": "..omitted..",


  "signatures": [{


    "keyid": "SHA256:{{SHA256_PUBLIC_KEY}}",


    "sig": "a312b9c3cb4a1b693e8ebac5ee1ca9cc01f2661c14391917dcb111517f72370809..."


  }]
}

See this example of a signed package from the public npm registry.

The sig is generated using the following template: ${package.name}@${package.version}:${package.dist.integrity} and the keyid has to match one of the public signing keys below.

{


  "keys": [{


    "expires": null,


    "keyid": "SHA256:{{SHA256_PUBLIC_KEY}}",


    "keytype": "ecdsa-sha2-nistp256",


    "scheme": "ecdsa-sha2-nistp256",


    "key": "{{B64_PUBLIC_KEY}}"


  }]
}

Keys response:

See this example key's response from the public npm registry.

Audit Endpoints¶

There are two audit endpoints that npm may use to fetch vulnerability information: the Bulk Advisory endpoint and the Quick Audit endpoint.

Exit Code¶

The npm audit command will exit with a 0 exit code if no vulnerabilities were found.
The npm audit fix command will exit with 0 exit code if no vulnerabilities are found or if the remediation is able to successfully fix all vulnerabilities.

If vulnerabilities were found the exit code will depend on the audit-level config.

Examples¶

Scan your project for vulnerabilities and automatically install any compatible updates to vulnerable dependencies:

$ npm audit fix

Run audit fix without modifying node_modules, but still updating the pkglock:

$ npm audit fix --package-lock-only

Skip updating devDependencies:

$ npm audit fix --only=prod

Have audit fix install SemVer-major updates to toplevel dependencies, not just SemVer-compatible ones:

$ npm audit fix --force

Do a dry run to get an idea of what audit fix will do, and also output install information in JSON format:

$ npm audit fix --dry-run --json

Scan your project for vulnerabilities and just show the details, without fixing anything:

$ npm audit

Get the detailed audit report in JSON format:

$ npm audit --json

Fail an audit only if the results include a vulnerability with a level of moderate or higher:

$ npm audit --audit-level=moderate

Configuration¶

<!-- AUTOGENERATED CONFIG DESCRIPTIONS -->

See Also¶