audit-filter takes the output of npm audit --json and an
nsp rc config file without
comments and filters out advisories
according to the nsp offline exceptions format (see usage for an
example).
This provides a migration path from nsp check to npm audit and
lets projects to use npm audit in CI pipelines without masking all
advisories (e.g. with npm audit || true).
Install
Requirements
node 8.x or 10.x
npm@6 (for --json support and newer package-lock.json format)
Local NPM package
Run npm install --save-dev audit-filter to add it as a dev dependency
Require an npm version with npm audit support in package.json e.g.
$ audit-filter -haudit-filter filters the output of "npm audit --json"Usage: audit-filter [--json] [--audit=<->] [--nsp-config=<.nsprc>] audit-filter (-h | --help | --version)Options: -h --help Show this screen. --version Show version. --json Output subset of JSON for the unfiltered advisories as an array. --audit=<audit> NPM Audit JSON file [default: -]. --nsp-config=<config> Default filter config [default: .nsprc].$ cd audit-filter/example/$ cat package.json{ "dependencies": { "moment": "2.19.2", "restify": "7.0.0" }, "devDependencies": { "audit-filter": "0.3.0", "lodash": "^4.0.0" }, "engines": { "node": ">=8", "npm": ">=6.4.1" }, "scripts": { "lint:deps": "npm audit --json | audit-filter --nsp-config=.nsprc --audit=-"
Fixing comments in .nsprc files
$ cat tests/fixtures/screenshots-0191b17d3bac5de51efa7acbaa0d52bb26c91573-nsprc-comment.json{ // See https://github.com/mozilla-services/screenshots/issues/4397 "exceptions": [ "https://nodesecurity.io/advisories/566", "https://nodesecurity.io/advisories/577", "https://nodesecurity.io/advisories/598", "https://nodesecurity.io/advisories/663", "https://nodesecurity.io/advisories/664" ]}$ audit-filter --nsp-config tests/fixtures/screenshots-0191b17d3bac5de51efa7acbaa0d52bb26c91573-nsprc-comment.json --audit tests/fixtures/screenshots-0191b17d3bac5de51efa7acbaa0d52bb26c91573-npm-6.4.1-audit.jsonError parsing nsp config JSON: key must be a string at line 2 column 3$ echo $?2$ cat tests/fixtures/screenshots-0191b17d3bac5de51efa7acbaa0d52bb26c91573-nsprc-comment.json | sed "s|// .*||g" | python -m json.tool{ "exceptions": [ "https://nodesecurity.io/advisories/566", "https://nodesecurity.io/advisories/577", "https://nodesecurity.io/advisories/598", "https://nodesecurity.io/advisories/663",
Exit Codes
0 - No advisories or all advisories acked from filters
1 - New failures one or more unacked advisory. Rerun npm audit to see the errors.
2 - Error finding or parsing config files or audit JSON.
Other errors
NB: error messages will differ for audit-filter installed with NPM
Enumerated here for completeness. These all exit with code 2.
Error opening audit file
$ audit-filter --nsp-config tests/fixtures/screenshots-0191b17d3bac5de51efa7acbaa0d52bb26c91573-nsprc.json --audit no-fileError opening audit JSON no-file: No such file or directory (os error 2)
Error parsing audit from stdin
$ echo "this is not JSON" | audit-filter --nsp-config tests/fixtures/screenshots-0191b17d3bac5de51efa7acbaa0d52bb26c91573-nsprc.json --audit -Error parsing audit JSON from stdin: expected ident at line 1 column 2
Error parsing audit from file
$ echo "this is not JSON" > not_json.txt$ audit-filter --nsp-config tests/fixtures/screenshots-0191b17d3bac5de51efa7acbaa0d52bb26c91573-nsprc.json --audit not_json.txtError parsing audit JSON: expected ident at line 1 column 2
Error opening nsp config file
$ audit-filter --nsp-config no-file --audit tests/fixtures/screenshots-0191b17d3bac5de51efa7acbaa0d52bb26c91573-npm-6.4.1-audit.jsonError opening nsp config JSON no-file: No such file or directory (os error 2)
Error parsing nsp config from stdin
$ echo "this is not JSON" | audit-filter --nsp-config - --audit tests/fixtures/screenshots-0191b17d3bac5de51efa7acbaa0d52bb26c91573-npm-6.4.1-audit.jsonError parsing nsp config JSON from stdin: expected ident at line 1 column 2
Error parsing nsp config from file
$ echo "this is not JSON" > not_json.txt$ audit-filter --nsp-config not_json.txt --audit tests/fixtures/screenshots-0191b17d3bac5de51efa7acbaa0d52bb26c91573-npm-6.4.1-audit.jsonError parsing nsp config JSON: expected ident at line 1 column 2
Building
To build a static executable:
$ rustup target add x86_64-unknown-linux-musl...$ cargo build --release --target x86_64-unknown-linux-musl...$ ls -lh ./target/x86_64-unknown-linux-musl/release/audit-filter-rwxrwxr-x 2 gguthe gguthe 7.0M Sep 20 13:09 ./target/x86_64-unknown-linux-musl/release/audit-filter$ ldd ./target/x86_64-unknown-linux-musl/release/audit-filter not a dynamic executable
"overview": "Affected versions of `minimatch` are vulnerable to regular expression denial of service attacks when user input is passed into the `pattern` argument of `minimatch(path, pattern)`.\n\n\n## Proof of Concept\n```\nvar minimatch = require(“minimatch”);\n\n// utility function for generating long strings\nvar genstr = function (len, chr) {\n var result = “”;\n for (i=0; i<=len; i++) {\n result = result + chr;\n }\n return result;\n}\n\nvar exploit = “[!” + genstr(1000000, “\\\\”) + “A”;\n\n// minimatch exploit.\nconsole.log(“starting minimatch”);\nminimatch(“foo”, exploit);\nconsole.log(“finishing minimatch”);\n```",
"recommendation": "Update to version 3.0.2 or later.",
"severity": "high",
"url": "https://nodesecurity.io/advisories/118"
},
{
"findings": [
{
"version": "2.2.0",
"paths": [
"istanbul-middleware>body-parser>debug"
],
"dev": true,
"optional": false,
"bundled": false
}
],
"id": 534,
"title": "Regular Expression Denial of Service",
"module_name": "debug",
"overview": "Affected versions of `debug` are vulnerable to regular expression denial of service when untrusted user input is passed into the `o` formatter. \n\nAs it takes 50,000 characters to block the event loop for 2 seconds, this issue is a low severity issue.",
"recommendation": "Version 2.x.x: Update to version 2.6.9 or later.\nVersion 3.x.x: Update to version 3.1.0 or later.\n",
"severity": "low",
"url": "https://nodesecurity.io/advisories/534"
},
{
"findings": [
{
"version": "0.4.7",
"paths": [
"jpm>firefox-profile>adm-zip",
"web-ext>firefox-profile>adm-zip"
],
"dev": false,
"optional": false,
"bundled": false
}
],
"id": 681,
"title": "Arbitrary File Write via Archive Extraction",
"module_name": "adm-zip",
"overview": "Versions of `adm-zip` before 0.4.9 are vulnerable to arbitrary file write when used to extract a specifically crafted archive that contains path traversal filenames (`../../file.txt` for example).",
"recommendation": "Update to version 0.4.9 or later.",
"severity": "high",
"url": "https://nodesecurity.io/advisories/681"
}
]
"https://nodesecurity.io/advisories/664"
]
}
$ # alternatively convert comments into valid JSON e.g.
{
"comment": "See https://github.com/mozilla-services/screenshots/issues/4397",