audit: env selection for report#125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
larsgw wants to merge 2 commits into from
Closed

audit: env selection for report #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7810b9
audit: env selection for report
larsgw Dec 17, 2018
ca35059
doc: add docs for audit level and env selection
larsgw Jan 17, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion doc/cli/npm-audit.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,21 @@ npm-audit(1) -- Run a security audit

## SYNOPSIS

npm audit [--json|--parseable]
npm audit [--json|--parseable|--production|--only=dev]
npm audit fix [--force|--package-lock-only|--dry-run|--production|--only=dev]

## EXAMPLES

List vulnerabilities with a level of `high` or higher:
```
$ npm audit --audit-level high
```

List vulnerabilities in `devDependencies`:
```
$ npm audit --only=dev
```

Scan your project for vulnerabilities and automatically install any compatible
updates to vulnerable dependencies:
```
Expand Down
18 changes: 10 additions & 8 deletions doc/misc/npm-config.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -153,7 +153,8 @@ even for `GET` requests.
* Type: String

When "dev" or "development" and running local `npm shrinkwrap`,
`npm outdated`, or `npm update`, is an alias for `--dev`.
`npm outdated`, or `npm update`, or `npm audit`, is an alias for
`--dev`.

### audit

Expand DownExpand Up@@ -329,7 +330,7 @@ Show the description in `npm search`
* Default: false
* Type: Boolean

Install `dev-dependencies` along with packages.
Install or audit `devDependencies` along with packages.

### dry-run

Expand DownExpand Up@@ -723,15 +724,15 @@ usage.
When "dev" or "development" and running local `npm install` without any
arguments, only devDependencies (and their dependencies) are installed.

When "dev" or "development" and running local `npm ls`, `npm outdated`, or
`npm update`, is an alias for `--dev`.
When "dev" or "development" and running local `npm ls`, `npm outdated`,
`npm update`, or `npm audit`, is an alias for `--dev`.

When "prod" or "production" and running local `npm install` without any
arguments, only non-devDependencies (and their dependencies) are
installed.

When "prod" or "production" and running local `npm ls`, `npm outdated`, or
`npm update`, is an alias for `--production`.
When "prod" or "production" and running local `npm ls`, `npm outdated`,
`npm update`, or `npm audit`, is an alias for `--production`.

### optional

Expand DownExpand Up@@ -822,8 +823,9 @@ semver. Like the `rc` in `1.2.0-rc.8`.
Set to true to run in "production" mode.

1. devDependencies are not installed at the topmost level when running
local `npm install` without any arguments.
2. Set the NODE_ENV="production" for lifecycle scripts.
local `npm install` without any arguments or `npm audit fix`.
2. devDependencies are excluded from the npm audit report
3. Set the NODE_ENV="production" for lifecycle scripts.

### progress

Expand Down
26 changes: 18 additions & 8 deletions lib/audit.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -130,15 +130,18 @@ function maybeReadFile (name) {
})
}

function filterEnv (action, opts) {
function getEnvFilter (opts) {
const includeDev = opts.dev ||
(!/^prod(uction)?$/.test(opts.only) && !opts.production) ||
/^dev(elopment)?$/.test(opts.only) ||
/^dev(elopment)?$/.test(opts.also)
const includeProd = !/^dev(elopment)?$/.test(opts.only)
const resolves = action.resolves.filter(({dev}) => {
return (dev && includeDev) || (!dev && includeProd)
})

return ({dev}) => (dev && includeDev) || (!dev && includeProd)
}

function filterEnv (action, envFilter) {
const resolves = action.resolves.filter(envFilter)
if (resolves.length) {
return Object.assign({}, action, {resolves})
}
Expand DownExpand Up@@ -197,9 +200,10 @@ function auditCmd (args, cb) {
}
throw err
}).then((auditResult) => {
const envFilter = getEnvFilter(opts)
if (args[0] === 'fix') {
const actions = (auditResult.actions || []).reduce((acc, action) => {
action = filterEnv(action, opts)
action = filterEnv(action, envFilter)
if (!action) { return acc }
if (action.isMajor) {
acc.major.add(`${action.module}@${action.target}`)
Expand DownExpand Up@@ -280,9 +284,15 @@ function auditCmd (args, cb) {
} else {
const levels = ['low', 'moderate', 'high', 'critical']
const minLevel = levels.indexOf(opts['audit-level'])
const vulns = levels.reduce((count, level, i) => {
return i < minLevel ? count : count + (auditResult.metadata.vulnerabilities[level] || 0)
}, 0)
let vulns = 0

for (const id in auditResult.advisories) {
const advisory = auditResult.advisories[id]
if (levels.indexOf(advisory.severity) >= minLevel) {
vulns += advisory.findings.filter(envFilter).length
}
}

if (vulns > 0) process.exitCode = 1
if (opts.parseable) {
return audit.printParseableReport(auditResult)
Expand Down
102 changes: 101 additions & 1 deletion test/tap/audit.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,12 @@ test('exits with zero exit code for vulnerabilities below the `audit-level` flag
target: '1.2.3',
resolves: [{path: 'baddep'}]
}],
advisories: {
'1': {
severity: 'low',
findings: [{dev: false}]
}
},
metadata: {
vulnerabilities: {
low: 1
Expand DownExpand Up@@ -169,6 +175,12 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
target: '1.2.3',
resolves: [{path: 'baddep'}]
}],
advisories: {
'1': {
severity: 'high',
findings: [{dev: false}]
}
},
metadata: {
vulnerabilities: {
high: 1
Expand All@@ -188,7 +200,7 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
})
})

test('exits with non-zero exit code for vulnerabilities at the `audit-level` flag', t => {
test('exits with non-zero exit code for vulnerabilities above the `audit-level` flag', t => {
const fixture = new Tacks(new Dir({
'package.json': new File({
name: 'foo',
Expand DownExpand Up@@ -244,6 +256,12 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
target: '1.2.3',
resolves: [{path: 'baddep'}]
}],
advisories: {
'1': {
severity: 'high',
findings: [{dev: false}]
}
},
metadata: {
vulnerabilities: {
high: 1
Expand All@@ -263,6 +281,88 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
})
})

test('exits with zero exit code for vulnerabilities not included with --only, --also and --production flags', t => {
const fixture = new Tacks(new Dir({
'package.json': new File({
name: 'foo',
version: '1.0.0',
dependencies: {
baddep: '1.0.0'
}
})
}))
fixture.create(testDir)
return tmock(t).then(srv => {
srv.filteringRequestBody(req => 'ok')
srv.post('/-/npm/v1/security/audits/quick', 'ok').reply(200, 'yeah')
srv.get('/baddep').twice().reply(200, {
name: 'baddep',
'dist-tags': {
'latest': '1.2.3'
},
versions: {
'1.0.0': {
name: 'baddep',
version: '1.0.0',
_hasShrinkwrap: false,
dist: {
shasum: 'deadbeef',
tarball: common.registry + '/idk/-/idk-1.0.0.tgz'
}
},
'1.2.3': {
name: 'baddep',
version: '1.2.3',
_hasShrinkwrap: false,
dist: {
shasum: 'deadbeef',
tarball: common.registry + '/idk/-/idk-1.2.3.tgz'
}
}
}
})
return common.npm([
'install',
'--audit',
'--json',
'--package-lock-only',
'--registry', common.registry,
'--cache', path.join(testDir, 'npm-cache')
], EXEC_OPTS).then(([code, stdout, stderr]) => {
srv.filteringRequestBody(req => 'ok')
srv.post('/-/npm/v1/security/audits', 'ok').reply(200, {
actions: [{
action: 'update',
module: 'baddep',
target: '1.2.3',
resolves: [{path: 'baddep'}]
}],
advisories: {
'1': {
severity: 'high',
findings: [{dev: false}]
}
},
metadata: {
vulnerabilities: {
high: 1
}
}
})
return common.npm([
'audit',
'--audit-level', 'moderate',
'--only', 'development',
'--json',
'--registry', common.registry,
'--cache', path.join(testDir, 'npm-cache')
], EXEC_OPTS).then(([code, stdout, stderr]) => {
t.equal(code, 0, 'exited OK')
})
})
})
})

test('cleanup', t => {
return rimraf(testDir)
})
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
audit: env selection for report#125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

larsgw
wants to merge
2
commits into

from

 Closed


audit: env selection for report
#125
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
a7810b9

audit: env selection for report


larsgw Dec 17, 2018
ca35059

doc: add docs for audit level and env selection


larsgw Jan 17, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


12 changes: 11 additions & 1 deletion
doc/cli/npm-audit.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,21 @@ npm-audit(1) -- Run a security audit

## SYNOPSIS

 npm audit [--json|--parseable]
 npm audit [--json|--parseable|--production|--only=dev]
 npm audit fix [--force|--package-lock-only|--dry-run|--production|--only=dev]

## EXAMPLES

List vulnerabilities with a level of `high` or higher:
```
$ npm audit --audit-level high
```

List vulnerabilities in `devDependencies`:
```
$ npm audit --only=dev
```

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

18 changes: 10 additions & 8 deletions
doc/misc/npm-config.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -153,7 +153,8 @@ even for `GET` requests.
* Type: String

When "dev" or "development" and running local `npm shrinkwrap`,
`npm outdated`, or `npm update`, is an alias for `--dev`.
`npm outdated`, or `npm update`, or `npm audit`, is an alias for
`--dev`.

### audit

Expand DownExpand Up@@ -329,7 +330,7 @@ Show the description in `npm search`
* Default: false
* Type: Boolean

Install `dev-dependencies` along with packages.
Install or audit `devDependencies` along with packages.

### dry-run

Expand DownExpand Up@@ -723,15 +724,15 @@ usage.
When "dev" or "development" and running local `npm install` without any
arguments, only devDependencies (and their dependencies) are installed.

When "dev" or "development" and running local `npm ls`, `npm outdated`, or
`npm update`, is an alias for `--dev`.
When "dev" or "development" and running local `npm ls`, `npm outdated`,
`npm update`, or `npm audit`, is an alias for `--dev`.

When "prod" or "production" and running local `npm install` without any
arguments, only non-devDependencies (and their dependencies) are
installed.

When "prod" or "production" and running local `npm ls`, `npm outdated`, or
`npm update`, is an alias for `--production`.
When "prod" or "production" and running local `npm ls`, `npm outdated`,
`npm update`, or `npm audit`, is an alias for `--production`.

### optional

Expand DownExpand Up@@ -822,8 +823,9 @@ semver. Like the `rc` in `1.2.0-rc.8`.
Set to true to run in "production" mode.

1. devDependencies are not installed at the topmost level when running
 local `npm install` without any arguments.
2. Set the NODE_ENV="production" for lifecycle scripts.
 local `npm install` without any arguments or `npm audit fix`.
2. devDependencies are excluded from the npm audit report
3. Set the NODE_ENV="production" for lifecycle scripts.

### progress

Expand Down

26 changes: 18 additions & 8 deletions
lib/audit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,15 +130,18 @@ function maybeReadFile (name) {
 })
}

function filterEnv (action, opts) {
function getEnvFilter (opts) {
 const includeDev = opts.dev ||
 (!/^prod(uction)?$/.test(opts.only) && !opts.production) ||
 /^dev(elopment)?$/.test(opts.only) ||
 /^dev(elopment)?$/.test(opts.also)
 const includeProd = !/^dev(elopment)?$/.test(opts.only)
 const resolves = action.resolves.filter(({dev}) => {
 return (dev && includeDev) || (!dev && includeProd)
 })

 return ({dev}) => (dev && includeDev) || (!dev && includeProd)
}

function filterEnv (action, envFilter) {
 const resolves = action.resolves.filter(envFilter)
 if (resolves.length) {
 return Object.assign({}, action, {resolves})
 }
Expand DownExpand Up@@ -197,9 +200,10 @@ function auditCmd (args, cb) {
 }
 throw err
 }).then((auditResult) => {
 const envFilter = getEnvFilter(opts)
 if (args[0] === 'fix') {
 const actions = (auditResult.actions || []).reduce((acc, action) => {
 action = filterEnv(action, opts)
 action = filterEnv(action, envFilter)
 if (!action) { return acc }
 if (action.isMajor) {
 acc.major.add(`${action.module}@${action.target}`)
Expand DownExpand Up@@ -280,9 +284,15 @@ function auditCmd (args, cb) {
 } else {
 const levels = ['low', 'moderate', 'high', 'critical']
 const minLevel = levels.indexOf(opts['audit-level'])
 const vulns = levels.reduce((count, level, i) => {
 return i < minLevel ? count : count + (auditResult.metadata.vulnerabilities[level] || 0)
 }, 0)
 let vulns = 0

 for (const id in auditResult.advisories) {
 const advisory = auditResult.advisories[id]
 if (levels.indexOf(advisory.severity) >= minLevel) {
 vulns += advisory.findings.filter(envFilter).length
 }
 }

 if (vulns > 0) process.exitCode = 1
 if (opts.parseable) {
 return audit.printParseableReport(auditResult)
Expand Down

102 changes: 101 additions & 1 deletion
test/tap/audit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,12 @@ test('exits with zero exit code for vulnerabilities below the `audit-level` flag
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'low',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 low: 1
Expand DownExpand Up@@ -169,6 +175,12 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'high',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 high: 1
Expand All@@ -188,7 +200,7 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 })
})

test('exits with non-zero exit code for vulnerabilities at the `audit-level` flag', t => {
test('exits with non-zero exit code for vulnerabilities above the `audit-level` flag', t => {
 const fixture = new Tacks(new Dir({
 'package.json': new File({
 name: 'foo',
Expand DownExpand Up@@ -244,6 +256,12 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'high',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 high: 1
Expand All@@ -263,6 +281,88 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 })
})

test('exits with zero exit code for vulnerabilities not included with --only, --also and --production flags', t => {
 const fixture = new Tacks(new Dir({
 'package.json': new File({
 name: 'foo',
 version: '1.0.0',
 dependencies: {
 baddep: '1.0.0'
 }
 })
 }))
 fixture.create(testDir)
 return tmock(t).then(srv => {
 srv.filteringRequestBody(req => 'ok')
 srv.post('/-/npm/v1/security/audits/quick', 'ok').reply(200, 'yeah')
 srv.get('/baddep').twice().reply(200, {
 name: 'baddep',
 'dist-tags': {
 'latest': '1.2.3'
 },
 versions: {
 '1.0.0': {
 name: 'baddep',
 version: '1.0.0',
 _hasShrinkwrap: false,
 dist: {
 shasum: 'deadbeef',
 tarball: common.registry + '/idk/-/idk-1.0.0.tgz'
 }
 },
 '1.2.3': {
 name: 'baddep',
 version: '1.2.3',
 _hasShrinkwrap: false,
 dist: {
 shasum: 'deadbeef',
 tarball: common.registry + '/idk/-/idk-1.2.3.tgz'
 }
 }
 }
 })
 return common.npm([
 'install',
 '--audit',
 '--json',
 '--package-lock-only',
 '--registry', common.registry,
 '--cache', path.join(testDir, 'npm-cache')
 ], EXEC_OPTS).then(([code, stdout, stderr]) => {
 srv.filteringRequestBody(req => 'ok')
 srv.post('/-/npm/v1/security/audits', 'ok').reply(200, {
 actions: [{
 action: 'update',
 module: 'baddep',
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'high',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 high: 1
 }
 }
 })
 return common.npm([
 'audit',
 '--audit-level', 'moderate',
 '--only', 'development',
 '--json',
 '--registry', common.registry,
 '--cache', path.join(testDir, 'npm-cache')
 ], EXEC_OPTS).then(([code, stdout, stderr]) => {
 t.equal(code, 0, 'exited OK')
 })
 })
 })
})

test('cleanup', t => {
 return rimraf(testDir)
})

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
audit: env selection for report#125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

larsgw
wants to merge
2
commits into

from

 Closed


audit: env selection for report
#125
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
a7810b9

audit: env selection for report


larsgw Dec 17, 2018
ca35059

doc: add docs for audit level and env selection


larsgw Jan 17, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


12 changes: 11 additions & 1 deletion
doc/cli/npm-audit.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,21 @@ npm-audit(1) -- Run a security audit

## SYNOPSIS

 npm audit [--json|--parseable]
 npm audit [--json|--parseable|--production|--only=dev]
 npm audit fix [--force|--package-lock-only|--dry-run|--production|--only=dev]

## EXAMPLES

List vulnerabilities with a level of `high` or higher:
```
$ npm audit --audit-level high
```

List vulnerabilities in `devDependencies`:
```
$ npm audit --only=dev
```

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

18 changes: 10 additions & 8 deletions
doc/misc/npm-config.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -153,7 +153,8 @@ even for `GET` requests.
* Type: String

When "dev" or "development" and running local `npm shrinkwrap`,
`npm outdated`, or `npm update`, is an alias for `--dev`.
`npm outdated`, or `npm update`, or `npm audit`, is an alias for
`--dev`.

### audit

Expand DownExpand Up@@ -329,7 +330,7 @@ Show the description in `npm search`
* Default: false
* Type: Boolean

Install `dev-dependencies` along with packages.
Install or audit `devDependencies` along with packages.

### dry-run

Expand DownExpand Up@@ -723,15 +724,15 @@ usage.
When "dev" or "development" and running local `npm install` without any
arguments, only devDependencies (and their dependencies) are installed.

When "dev" or "development" and running local `npm ls`, `npm outdated`, or
`npm update`, is an alias for `--dev`.
When "dev" or "development" and running local `npm ls`, `npm outdated`,
`npm update`, or `npm audit`, is an alias for `--dev`.

When "prod" or "production" and running local `npm install` without any
arguments, only non-devDependencies (and their dependencies) are
installed.

When "prod" or "production" and running local `npm ls`, `npm outdated`, or
`npm update`, is an alias for `--production`.
When "prod" or "production" and running local `npm ls`, `npm outdated`,
`npm update`, or `npm audit`, is an alias for `--production`.

### optional

Expand DownExpand Up@@ -822,8 +823,9 @@ semver. Like the `rc` in `1.2.0-rc.8`.
Set to true to run in "production" mode.

1. devDependencies are not installed at the topmost level when running
 local `npm install` without any arguments.
2. Set the NODE_ENV="production" for lifecycle scripts.
 local `npm install` without any arguments or `npm audit fix`.
2. devDependencies are excluded from the npm audit report
3. Set the NODE_ENV="production" for lifecycle scripts.

### progress

Expand Down

26 changes: 18 additions & 8 deletions
lib/audit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,15 +130,18 @@ function maybeReadFile (name) {
 })
}

function filterEnv (action, opts) {
function getEnvFilter (opts) {
 const includeDev = opts.dev ||
 (!/^prod(uction)?$/.test(opts.only) && !opts.production) ||
 /^dev(elopment)?$/.test(opts.only) ||
 /^dev(elopment)?$/.test(opts.also)
 const includeProd = !/^dev(elopment)?$/.test(opts.only)
 const resolves = action.resolves.filter(({dev}) => {
 return (dev && includeDev) || (!dev && includeProd)
 })

 return ({dev}) => (dev && includeDev) || (!dev && includeProd)
}

function filterEnv (action, envFilter) {
 const resolves = action.resolves.filter(envFilter)
 if (resolves.length) {
 return Object.assign({}, action, {resolves})
 }
Expand DownExpand Up@@ -197,9 +200,10 @@ function auditCmd (args, cb) {
 }
 throw err
 }).then((auditResult) => {
 const envFilter = getEnvFilter(opts)
 if (args[0] === 'fix') {
 const actions = (auditResult.actions || []).reduce((acc, action) => {
 action = filterEnv(action, opts)
 action = filterEnv(action, envFilter)
 if (!action) { return acc }
 if (action.isMajor) {
 acc.major.add(`${action.module}@${action.target}`)
Expand DownExpand Up@@ -280,9 +284,15 @@ function auditCmd (args, cb) {
 } else {
 const levels = ['low', 'moderate', 'high', 'critical']
 const minLevel = levels.indexOf(opts['audit-level'])
 const vulns = levels.reduce((count, level, i) => {
 return i < minLevel ? count : count + (auditResult.metadata.vulnerabilities[level] || 0)
 }, 0)
 let vulns = 0

 for (const id in auditResult.advisories) {
 const advisory = auditResult.advisories[id]
 if (levels.indexOf(advisory.severity) >= minLevel) {
 vulns += advisory.findings.filter(envFilter).length
 }
 }

 if (vulns > 0) process.exitCode = 1
 if (opts.parseable) {
 return audit.printParseableReport(auditResult)
Expand Down

102 changes: 101 additions & 1 deletion
test/tap/audit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,12 @@ test('exits with zero exit code for vulnerabilities below the `audit-level` flag
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'low',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 low: 1
Expand DownExpand Up@@ -169,6 +175,12 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'high',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 high: 1
Expand All@@ -188,7 +200,7 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 })
})

test('exits with non-zero exit code for vulnerabilities at the `audit-level` flag', t => {
test('exits with non-zero exit code for vulnerabilities above the `audit-level` flag', t => {
 const fixture = new Tacks(new Dir({
 'package.json': new File({
 name: 'foo',
Expand DownExpand Up@@ -244,6 +256,12 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'high',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 high: 1
Expand All@@ -263,6 +281,88 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 })
})

test('exits with zero exit code for vulnerabilities not included with --only, --also and --production flags', t => {
 const fixture = new Tacks(new Dir({
 'package.json': new File({
 name: 'foo',
 version: '1.0.0',
 dependencies: {
 baddep: '1.0.0'
 }
 })
 }))
 fixture.create(testDir)
 return tmock(t).then(srv => {
 srv.filteringRequestBody(req => 'ok')
 srv.post('/-/npm/v1/security/audits/quick', 'ok').reply(200, 'yeah')
 srv.get('/baddep').twice().reply(200, {
 name: 'baddep',
 'dist-tags': {
 'latest': '1.2.3'
 },
 versions: {
 '1.0.0': {
 name: 'baddep',
 version: '1.0.0',
 _hasShrinkwrap: false,
 dist: {
 shasum: 'deadbeef',
 tarball: common.registry + '/idk/-/idk-1.0.0.tgz'
 }
 },
 '1.2.3': {
 name: 'baddep',
 version: '1.2.3',
 _hasShrinkwrap: false,
 dist: {
 shasum: 'deadbeef',
 tarball: common.registry + '/idk/-/idk-1.2.3.tgz'
 }
 }
 }
 })
 return common.npm([
 'install',
 '--audit',
 '--json',
 '--package-lock-only',
 '--registry', common.registry,
 '--cache', path.join(testDir, 'npm-cache')
 ], EXEC_OPTS).then(([code, stdout, stderr]) => {
 srv.filteringRequestBody(req => 'ok')
 srv.post('/-/npm/v1/security/audits', 'ok').reply(200, {
 actions: [{
 action: 'update',
 module: 'baddep',
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'high',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 high: 1
 }
 }
 })
 return common.npm([
 'audit',
 '--audit-level', 'moderate',
 '--only', 'development',
 '--json',
 '--registry', common.registry,
 '--cache', path.join(testDir, 'npm-cache')
 ], EXEC_OPTS).then(([code, stdout, stderr]) => {
 t.equal(code, 0, 'exited OK')
 })
 })
 })
})

test('cleanup', t => {
 return rimraf(testDir)
})

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
audit: env selection for report#125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

larsgw
wants to merge
2
commits into

from

 Closed


audit: env selection for report
#125
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
a7810b9

audit: env selection for report


larsgw Dec 17, 2018
ca35059

doc: add docs for audit level and env selection


larsgw Jan 17, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


12 changes: 11 additions & 1 deletion
doc/cli/npm-audit.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,21 @@ npm-audit(1) -- Run a security audit

## SYNOPSIS

 npm audit [--json|--parseable]
 npm audit [--json|--parseable|--production|--only=dev]
 npm audit fix [--force|--package-lock-only|--dry-run|--production|--only=dev]

## EXAMPLES

List vulnerabilities with a level of `high` or higher:
```
$ npm audit --audit-level high
```

List vulnerabilities in `devDependencies`:
```
$ npm audit --only=dev
```

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

18 changes: 10 additions & 8 deletions
doc/misc/npm-config.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -153,7 +153,8 @@ even for `GET` requests.
* Type: String

When "dev" or "development" and running local `npm shrinkwrap`,
`npm outdated`, or `npm update`, is an alias for `--dev`.
`npm outdated`, or `npm update`, or `npm audit`, is an alias for
`--dev`.

### audit

Expand DownExpand Up@@ -329,7 +330,7 @@ Show the description in `npm search`
* Default: false
* Type: Boolean

Install `dev-dependencies` along with packages.
Install or audit `devDependencies` along with packages.

### dry-run

Expand DownExpand Up@@ -723,15 +724,15 @@ usage.
When "dev" or "development" and running local `npm install` without any
arguments, only devDependencies (and their dependencies) are installed.

When "dev" or "development" and running local `npm ls`, `npm outdated`, or
`npm update`, is an alias for `--dev`.
When "dev" or "development" and running local `npm ls`, `npm outdated`,
`npm update`, or `npm audit`, is an alias for `--dev`.

When "prod" or "production" and running local `npm install` without any
arguments, only non-devDependencies (and their dependencies) are
installed.

When "prod" or "production" and running local `npm ls`, `npm outdated`, or
`npm update`, is an alias for `--production`.
When "prod" or "production" and running local `npm ls`, `npm outdated`,
`npm update`, or `npm audit`, is an alias for `--production`.

### optional

Expand DownExpand Up@@ -822,8 +823,9 @@ semver. Like the `rc` in `1.2.0-rc.8`.
Set to true to run in "production" mode.

1. devDependencies are not installed at the topmost level when running
 local `npm install` without any arguments.
2. Set the NODE_ENV="production" for lifecycle scripts.
 local `npm install` without any arguments or `npm audit fix`.
2. devDependencies are excluded from the npm audit report
3. Set the NODE_ENV="production" for lifecycle scripts.

### progress

Expand Down

26 changes: 18 additions & 8 deletions
lib/audit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,15 +130,18 @@ function maybeReadFile (name) {
 })
}

function filterEnv (action, opts) {
function getEnvFilter (opts) {
 const includeDev = opts.dev ||
 (!/^prod(uction)?$/.test(opts.only) && !opts.production) ||
 /^dev(elopment)?$/.test(opts.only) ||
 /^dev(elopment)?$/.test(opts.also)
 const includeProd = !/^dev(elopment)?$/.test(opts.only)
 const resolves = action.resolves.filter(({dev}) => {
 return (dev && includeDev) || (!dev && includeProd)
 })

 return ({dev}) => (dev && includeDev) || (!dev && includeProd)
}

function filterEnv (action, envFilter) {
 const resolves = action.resolves.filter(envFilter)
 if (resolves.length) {
 return Object.assign({}, action, {resolves})
 }
Expand DownExpand Up@@ -197,9 +200,10 @@ function auditCmd (args, cb) {
 }
 throw err
 }).then((auditResult) => {
 const envFilter = getEnvFilter(opts)
 if (args[0] === 'fix') {
 const actions = (auditResult.actions || []).reduce((acc, action) => {
 action = filterEnv(action, opts)
 action = filterEnv(action, envFilter)
 if (!action) { return acc }
 if (action.isMajor) {
 acc.major.add(`${action.module}@${action.target}`)
Expand DownExpand Up@@ -280,9 +284,15 @@ function auditCmd (args, cb) {
 } else {
 const levels = ['low', 'moderate', 'high', 'critical']
 const minLevel = levels.indexOf(opts['audit-level'])
 const vulns = levels.reduce((count, level, i) => {
 return i < minLevel ? count : count + (auditResult.metadata.vulnerabilities[level] || 0)
 }, 0)
 let vulns = 0

 for (const id in auditResult.advisories) {
 const advisory = auditResult.advisories[id]
 if (levels.indexOf(advisory.severity) >= minLevel) {
 vulns += advisory.findings.filter(envFilter).length
 }
 }

 if (vulns > 0) process.exitCode = 1
 if (opts.parseable) {
 return audit.printParseableReport(auditResult)
Expand Down

102 changes: 101 additions & 1 deletion
test/tap/audit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,12 @@ test('exits with zero exit code for vulnerabilities below the `audit-level` flag
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'low',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 low: 1
Expand DownExpand Up@@ -169,6 +175,12 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'high',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 high: 1
Expand All@@ -188,7 +200,7 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 })
})

test('exits with non-zero exit code for vulnerabilities at the `audit-level` flag', t => {
test('exits with non-zero exit code for vulnerabilities above the `audit-level` flag', t => {
 const fixture = new Tacks(new Dir({
 'package.json': new File({
 name: 'foo',
Expand DownExpand Up@@ -244,6 +256,12 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'high',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 high: 1
Expand All@@ -263,6 +281,88 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 })
})

test('exits with zero exit code for vulnerabilities not included with --only, --also and --production flags', t => {
 const fixture = new Tacks(new Dir({
 'package.json': new File({
 name: 'foo',
 version: '1.0.0',
 dependencies: {
 baddep: '1.0.0'
 }
 })
 }))
 fixture.create(testDir)
 return tmock(t).then(srv => {
 srv.filteringRequestBody(req => 'ok')
 srv.post('/-/npm/v1/security/audits/quick', 'ok').reply(200, 'yeah')
 srv.get('/baddep').twice().reply(200, {
 name: 'baddep',
 'dist-tags': {
 'latest': '1.2.3'
 },
 versions: {
 '1.0.0': {
 name: 'baddep',
 version: '1.0.0',
 _hasShrinkwrap: false,
 dist: {
 shasum: 'deadbeef',
 tarball: common.registry + '/idk/-/idk-1.0.0.tgz'
 }
 },
 '1.2.3': {
 name: 'baddep',
 version: '1.2.3',
 _hasShrinkwrap: false,
 dist: {
 shasum: 'deadbeef',
 tarball: common.registry + '/idk/-/idk-1.2.3.tgz'
 }
 }
 }
 })
 return common.npm([
 'install',
 '--audit',
 '--json',
 '--package-lock-only',
 '--registry', common.registry,
 '--cache', path.join(testDir, 'npm-cache')
 ], EXEC_OPTS).then(([code, stdout, stderr]) => {
 srv.filteringRequestBody(req => 'ok')
 srv.post('/-/npm/v1/security/audits', 'ok').reply(200, {
 actions: [{
 action: 'update',
 module: 'baddep',
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'high',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 high: 1
 }
 }
 })
 return common.npm([
 'audit',
 '--audit-level', 'moderate',
 '--only', 'development',
 '--json',
 '--registry', common.registry,
 '--cache', path.join(testDir, 'npm-cache')
 ], EXEC_OPTS).then(([code, stdout, stderr]) => {
 t.equal(code, 0, 'exited OK')
 })
 })
 })
})

test('cleanup', t => {
 return rimraf(testDir)
})

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
audit: env selection for report#125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

larsgw
wants to merge
2
commits into

from

 Closed


audit: env selection for report
#125
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
a7810b9

audit: env selection for report


larsgw Dec 17, 2018
ca35059

doc: add docs for audit level and env selection


larsgw Jan 17, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


12 changes: 11 additions & 1 deletion
doc/cli/npm-audit.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,21 @@ npm-audit(1) -- Run a security audit

## SYNOPSIS

 npm audit [--json|--parseable]
 npm audit [--json|--parseable|--production|--only=dev]
 npm audit fix [--force|--package-lock-only|--dry-run|--production|--only=dev]

## EXAMPLES

List vulnerabilities with a level of `high` or higher:
```
$ npm audit --audit-level high
```

List vulnerabilities in `devDependencies`:
```
$ npm audit --only=dev
```

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

18 changes: 10 additions & 8 deletions
doc/misc/npm-config.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -153,7 +153,8 @@ even for `GET` requests.
* Type: String

When "dev" or "development" and running local `npm shrinkwrap`,
`npm outdated`, or `npm update`, is an alias for `--dev`.
`npm outdated`, or `npm update`, or `npm audit`, is an alias for
`--dev`.

### audit

Expand DownExpand Up@@ -329,7 +330,7 @@ Show the description in `npm search`
* Default: false
* Type: Boolean

Install `dev-dependencies` along with packages.
Install or audit `devDependencies` along with packages.

### dry-run

Expand DownExpand Up@@ -723,15 +724,15 @@ usage.
When "dev" or "development" and running local `npm install` without any
arguments, only devDependencies (and their dependencies) are installed.

When "dev" or "development" and running local `npm ls`, `npm outdated`, or
`npm update`, is an alias for `--dev`.
When "dev" or "development" and running local `npm ls`, `npm outdated`,
`npm update`, or `npm audit`, is an alias for `--dev`.

When "prod" or "production" and running local `npm install` without any
arguments, only non-devDependencies (and their dependencies) are
installed.

When "prod" or "production" and running local `npm ls`, `npm outdated`, or
`npm update`, is an alias for `--production`.
When "prod" or "production" and running local `npm ls`, `npm outdated`,
`npm update`, or `npm audit`, is an alias for `--production`.

### optional

Expand DownExpand Up@@ -822,8 +823,9 @@ semver. Like the `rc` in `1.2.0-rc.8`.
Set to true to run in "production" mode.

1. devDependencies are not installed at the topmost level when running
 local `npm install` without any arguments.
2. Set the NODE_ENV="production" for lifecycle scripts.
 local `npm install` without any arguments or `npm audit fix`.
2. devDependencies are excluded from the npm audit report
3. Set the NODE_ENV="production" for lifecycle scripts.

### progress

Expand Down

26 changes: 18 additions & 8 deletions
lib/audit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,15 +130,18 @@ function maybeReadFile (name) {
 })
}

function filterEnv (action, opts) {
function getEnvFilter (opts) {
 const includeDev = opts.dev ||
 (!/^prod(uction)?$/.test(opts.only) && !opts.production) ||
 /^dev(elopment)?$/.test(opts.only) ||
 /^dev(elopment)?$/.test(opts.also)
 const includeProd = !/^dev(elopment)?$/.test(opts.only)
 const resolves = action.resolves.filter(({dev}) => {
 return (dev && includeDev) || (!dev && includeProd)
 })

 return ({dev}) => (dev && includeDev) || (!dev && includeProd)
}

function filterEnv (action, envFilter) {
 const resolves = action.resolves.filter(envFilter)
 if (resolves.length) {
 return Object.assign({}, action, {resolves})
 }
Expand DownExpand Up@@ -197,9 +200,10 @@ function auditCmd (args, cb) {
 }
 throw err
 }).then((auditResult) => {
 const envFilter = getEnvFilter(opts)
 if (args[0] === 'fix') {
 const actions = (auditResult.actions || []).reduce((acc, action) => {
 action = filterEnv(action, opts)
 action = filterEnv(action, envFilter)
 if (!action) { return acc }
 if (action.isMajor) {
 acc.major.add(`${action.module}@${action.target}`)
Expand DownExpand Up@@ -280,9 +284,15 @@ function auditCmd (args, cb) {
 } else {
 const levels = ['low', 'moderate', 'high', 'critical']
 const minLevel = levels.indexOf(opts['audit-level'])
 const vulns = levels.reduce((count, level, i) => {
 return i < minLevel ? count : count + (auditResult.metadata.vulnerabilities[level] || 0)
 }, 0)
 let vulns = 0

 for (const id in auditResult.advisories) {
 const advisory = auditResult.advisories[id]
 if (levels.indexOf(advisory.severity) >= minLevel) {
 vulns += advisory.findings.filter(envFilter).length
 }
 }

 if (vulns > 0) process.exitCode = 1
 if (opts.parseable) {
 return audit.printParseableReport(auditResult)
Expand Down

102 changes: 101 additions & 1 deletion
test/tap/audit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,12 @@ test('exits with zero exit code for vulnerabilities below the `audit-level` flag
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'low',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 low: 1
Expand DownExpand Up@@ -169,6 +175,12 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'high',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 high: 1
Expand All@@ -188,7 +200,7 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 })
})

test('exits with non-zero exit code for vulnerabilities at the `audit-level` flag', t => {
test('exits with non-zero exit code for vulnerabilities above the `audit-level` flag', t => {
 const fixture = new Tacks(new Dir({
 'package.json': new File({
 name: 'foo',
Expand DownExpand Up@@ -244,6 +256,12 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'high',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 high: 1
Expand All@@ -263,6 +281,88 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 })
})

test('exits with zero exit code for vulnerabilities not included with --only, --also and --production flags', t => {
 const fixture = new Tacks(new Dir({
 'package.json': new File({
 name: 'foo',
 version: '1.0.0',
 dependencies: {
 baddep: '1.0.0'
 }
 })
 }))
 fixture.create(testDir)
 return tmock(t).then(srv => {
 srv.filteringRequestBody(req => 'ok')
 srv.post('/-/npm/v1/security/audits/quick', 'ok').reply(200, 'yeah')
 srv.get('/baddep').twice().reply(200, {
 name: 'baddep',
 'dist-tags': {
 'latest': '1.2.3'
 },
 versions: {
 '1.0.0': {
 name: 'baddep',
 version: '1.0.0',
 _hasShrinkwrap: false,
 dist: {
 shasum: 'deadbeef',
 tarball: common.registry + '/idk/-/idk-1.0.0.tgz'
 }
 },
 '1.2.3': {
 name: 'baddep',
 version: '1.2.3',
 _hasShrinkwrap: false,
 dist: {
 shasum: 'deadbeef',
 tarball: common.registry + '/idk/-/idk-1.2.3.tgz'
 }
 }
 }
 })
 return common.npm([
 'install',
 '--audit',
 '--json',
 '--package-lock-only',
 '--registry', common.registry,
 '--cache', path.join(testDir, 'npm-cache')
 ], EXEC_OPTS).then(([code, stdout, stderr]) => {
 srv.filteringRequestBody(req => 'ok')
 srv.post('/-/npm/v1/security/audits', 'ok').reply(200, {
 actions: [{
 action: 'update',
 module: 'baddep',
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'high',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 high: 1
 }
 }
 })
 return common.npm([
 'audit',
 '--audit-level', 'moderate',
 '--only', 'development',
 '--json',
 '--registry', common.registry,
 '--cache', path.join(testDir, 'npm-cache')
 ], EXEC_OPTS).then(([code, stdout, stderr]) => {
 t.equal(code, 0, 'exited OK')
 })
 })
 })
})

test('cleanup', t => {
 return rimraf(testDir)
})

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
audit: env selection for report#125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

larsgw
wants to merge
2
commits into

from

 Closed


audit: env selection for report
#125
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
a7810b9

audit: env selection for report


larsgw Dec 17, 2018
ca35059

doc: add docs for audit level and env selection


larsgw Jan 17, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


12 changes: 11 additions & 1 deletion
doc/cli/npm-audit.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,21 @@ npm-audit(1) -- Run a security audit

## SYNOPSIS

 npm audit [--json|--parseable]
 npm audit [--json|--parseable|--production|--only=dev]
 npm audit fix [--force|--package-lock-only|--dry-run|--production|--only=dev]

## EXAMPLES

List vulnerabilities with a level of `high` or higher:
```
$ npm audit --audit-level high
```

List vulnerabilities in `devDependencies`:
```
$ npm audit --only=dev
```

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

18 changes: 10 additions & 8 deletions
doc/misc/npm-config.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -153,7 +153,8 @@ even for `GET` requests.
* Type: String

When "dev" or "development" and running local `npm shrinkwrap`,
`npm outdated`, or `npm update`, is an alias for `--dev`.
`npm outdated`, or `npm update`, or `npm audit`, is an alias for
`--dev`.

### audit

Expand DownExpand Up@@ -329,7 +330,7 @@ Show the description in `npm search`
* Default: false
* Type: Boolean

Install `dev-dependencies` along with packages.
Install or audit `devDependencies` along with packages.

### dry-run

Expand DownExpand Up@@ -723,15 +724,15 @@ usage.
When "dev" or "development" and running local `npm install` without any
arguments, only devDependencies (and their dependencies) are installed.

When "dev" or "development" and running local `npm ls`, `npm outdated`, or
`npm update`, is an alias for `--dev`.
When "dev" or "development" and running local `npm ls`, `npm outdated`,
`npm update`, or `npm audit`, is an alias for `--dev`.

When "prod" or "production" and running local `npm install` without any
arguments, only non-devDependencies (and their dependencies) are
installed.

When "prod" or "production" and running local `npm ls`, `npm outdated`, or
`npm update`, is an alias for `--production`.
When "prod" or "production" and running local `npm ls`, `npm outdated`,
`npm update`, or `npm audit`, is an alias for `--production`.

### optional

Expand DownExpand Up@@ -822,8 +823,9 @@ semver. Like the `rc` in `1.2.0-rc.8`.
Set to true to run in "production" mode.

1. devDependencies are not installed at the topmost level when running
 local `npm install` without any arguments.
2. Set the NODE_ENV="production" for lifecycle scripts.
 local `npm install` without any arguments or `npm audit fix`.
2. devDependencies are excluded from the npm audit report
3. Set the NODE_ENV="production" for lifecycle scripts.

### progress

Expand Down

26 changes: 18 additions & 8 deletions
lib/audit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,15 +130,18 @@ function maybeReadFile (name) {
 })
}

function filterEnv (action, opts) {
function getEnvFilter (opts) {
 const includeDev = opts.dev ||
 (!/^prod(uction)?$/.test(opts.only) && !opts.production) ||
 /^dev(elopment)?$/.test(opts.only) ||
 /^dev(elopment)?$/.test(opts.also)
 const includeProd = !/^dev(elopment)?$/.test(opts.only)
 const resolves = action.resolves.filter(({dev}) => {
 return (dev && includeDev) || (!dev && includeProd)
 })

 return ({dev}) => (dev && includeDev) || (!dev && includeProd)
}

function filterEnv (action, envFilter) {
 const resolves = action.resolves.filter(envFilter)
 if (resolves.length) {
 return Object.assign({}, action, {resolves})
 }
Expand DownExpand Up@@ -197,9 +200,10 @@ function auditCmd (args, cb) {
 }
 throw err
 }).then((auditResult) => {
 const envFilter = getEnvFilter(opts)
 if (args[0] === 'fix') {
 const actions = (auditResult.actions || []).reduce((acc, action) => {
 action = filterEnv(action, opts)
 action = filterEnv(action, envFilter)
 if (!action) { return acc }
 if (action.isMajor) {
 acc.major.add(`${action.module}@${action.target}`)
Expand DownExpand Up@@ -280,9 +284,15 @@ function auditCmd (args, cb) {
 } else {
 const levels = ['low', 'moderate', 'high', 'critical']
 const minLevel = levels.indexOf(opts['audit-level'])
 const vulns = levels.reduce((count, level, i) => {
 return i < minLevel ? count : count + (auditResult.metadata.vulnerabilities[level] || 0)
 }, 0)
 let vulns = 0

 for (const id in auditResult.advisories) {
 const advisory = auditResult.advisories[id]
 if (levels.indexOf(advisory.severity) >= minLevel) {
 vulns += advisory.findings.filter(envFilter).length
 }
 }

 if (vulns > 0) process.exitCode = 1
 if (opts.parseable) {
 return audit.printParseableReport(auditResult)
Expand Down

102 changes: 101 additions & 1 deletion
test/tap/audit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,12 @@ test('exits with zero exit code for vulnerabilities below the `audit-level` flag
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'low',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 low: 1
Expand DownExpand Up@@ -169,6 +175,12 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'high',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 high: 1
Expand All@@ -188,7 +200,7 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 })
})

test('exits with non-zero exit code for vulnerabilities at the `audit-level` flag', t => {
test('exits with non-zero exit code for vulnerabilities above the `audit-level` flag', t => {
 const fixture = new Tacks(new Dir({
 'package.json': new File({
 name: 'foo',
Expand DownExpand Up@@ -244,6 +256,12 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'high',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 high: 1
Expand All@@ -263,6 +281,88 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 })
})

test('exits with zero exit code for vulnerabilities not included with --only, --also and --production flags', t => {
 const fixture = new Tacks(new Dir({
 'package.json': new File({
 name: 'foo',
 version: '1.0.0',
 dependencies: {
 baddep: '1.0.0'
 }
 })
 }))
 fixture.create(testDir)
 return tmock(t).then(srv => {
 srv.filteringRequestBody(req => 'ok')
 srv.post('/-/npm/v1/security/audits/quick', 'ok').reply(200, 'yeah')
 srv.get('/baddep').twice().reply(200, {
 name: 'baddep',
 'dist-tags': {
 'latest': '1.2.3'
 },
 versions: {
 '1.0.0': {
 name: 'baddep',
 version: '1.0.0',
 _hasShrinkwrap: false,
 dist: {
 shasum: 'deadbeef',
 tarball: common.registry + '/idk/-/idk-1.0.0.tgz'
 }
 },
 '1.2.3': {
 name: 'baddep',
 version: '1.2.3',
 _hasShrinkwrap: false,
 dist: {
 shasum: 'deadbeef',
 tarball: common.registry + '/idk/-/idk-1.2.3.tgz'
 }
 }
 }
 })
 return common.npm([
 'install',
 '--audit',
 '--json',
 '--package-lock-only',
 '--registry', common.registry,
 '--cache', path.join(testDir, 'npm-cache')
 ], EXEC_OPTS).then(([code, stdout, stderr]) => {
 srv.filteringRequestBody(req => 'ok')
 srv.post('/-/npm/v1/security/audits', 'ok').reply(200, {
 actions: [{
 action: 'update',
 module: 'baddep',
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'high',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 high: 1
 }
 }
 })
 return common.npm([
 'audit',
 '--audit-level', 'moderate',
 '--only', 'development',
 '--json',
 '--registry', common.registry,
 '--cache', path.join(testDir, 'npm-cache')
 ], EXEC_OPTS).then(([code, stdout, stderr]) => {
 t.equal(code, 0, 'exited OK')
 })
 })
 })
})

test('cleanup', t => {
 return rimraf(testDir)
})

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
audit: env selection for report#125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

larsgw
wants to merge
2
commits into

from

 Closed


audit: env selection for report
#125
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
a7810b9

audit: env selection for report


larsgw Dec 17, 2018
ca35059

doc: add docs for audit level and env selection


larsgw Jan 17, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


12 changes: 11 additions & 1 deletion
doc/cli/npm-audit.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,21 @@ npm-audit(1) -- Run a security audit

## SYNOPSIS

 npm audit [--json|--parseable]
 npm audit [--json|--parseable|--production|--only=dev]
 npm audit fix [--force|--package-lock-only|--dry-run|--production|--only=dev]

## EXAMPLES

List vulnerabilities with a level of `high` or higher:
```
$ npm audit --audit-level high
```

List vulnerabilities in `devDependencies`:
```
$ npm audit --only=dev
```

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

18 changes: 10 additions & 8 deletions
doc/misc/npm-config.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -153,7 +153,8 @@ even for `GET` requests.
* Type: String

When "dev" or "development" and running local `npm shrinkwrap`,
`npm outdated`, or `npm update`, is an alias for `--dev`.
`npm outdated`, or `npm update`, or `npm audit`, is an alias for
`--dev`.

### audit

Expand DownExpand Up@@ -329,7 +330,7 @@ Show the description in `npm search`
* Default: false
* Type: Boolean

Install `dev-dependencies` along with packages.
Install or audit `devDependencies` along with packages.

### dry-run

Expand DownExpand Up@@ -723,15 +724,15 @@ usage.
When "dev" or "development" and running local `npm install` without any
arguments, only devDependencies (and their dependencies) are installed.

When "dev" or "development" and running local `npm ls`, `npm outdated`, or
`npm update`, is an alias for `--dev`.
When "dev" or "development" and running local `npm ls`, `npm outdated`,
`npm update`, or `npm audit`, is an alias for `--dev`.

When "prod" or "production" and running local `npm install` without any
arguments, only non-devDependencies (and their dependencies) are
installed.

When "prod" or "production" and running local `npm ls`, `npm outdated`, or
`npm update`, is an alias for `--production`.
When "prod" or "production" and running local `npm ls`, `npm outdated`,
`npm update`, or `npm audit`, is an alias for `--production`.

### optional

Expand DownExpand Up@@ -822,8 +823,9 @@ semver. Like the `rc` in `1.2.0-rc.8`.
Set to true to run in "production" mode.

1. devDependencies are not installed at the topmost level when running
 local `npm install` without any arguments.
2. Set the NODE_ENV="production" for lifecycle scripts.
 local `npm install` without any arguments or `npm audit fix`.
2. devDependencies are excluded from the npm audit report
3. Set the NODE_ENV="production" for lifecycle scripts.

### progress

Expand Down

26 changes: 18 additions & 8 deletions
lib/audit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,15 +130,18 @@ function maybeReadFile (name) {
 })
}

function filterEnv (action, opts) {
function getEnvFilter (opts) {
 const includeDev = opts.dev ||
 (!/^prod(uction)?$/.test(opts.only) && !opts.production) ||
 /^dev(elopment)?$/.test(opts.only) ||
 /^dev(elopment)?$/.test(opts.also)
 const includeProd = !/^dev(elopment)?$/.test(opts.only)
 const resolves = action.resolves.filter(({dev}) => {
 return (dev && includeDev) || (!dev && includeProd)
 })

 return ({dev}) => (dev && includeDev) || (!dev && includeProd)
}

function filterEnv (action, envFilter) {
 const resolves = action.resolves.filter(envFilter)
 if (resolves.length) {
 return Object.assign({}, action, {resolves})
 }
Expand DownExpand Up@@ -197,9 +200,10 @@ function auditCmd (args, cb) {
 }
 throw err
 }).then((auditResult) => {
 const envFilter = getEnvFilter(opts)
 if (args[0] === 'fix') {
 const actions = (auditResult.actions || []).reduce((acc, action) => {
 action = filterEnv(action, opts)
 action = filterEnv(action, envFilter)
 if (!action) { return acc }
 if (action.isMajor) {
 acc.major.add(`${action.module}@${action.target}`)
Expand DownExpand Up@@ -280,9 +284,15 @@ function auditCmd (args, cb) {
 } else {
 const levels = ['low', 'moderate', 'high', 'critical']
 const minLevel = levels.indexOf(opts['audit-level'])
 const vulns = levels.reduce((count, level, i) => {
 return i < minLevel ? count : count + (auditResult.metadata.vulnerabilities[level] || 0)
 }, 0)
 let vulns = 0

 for (const id in auditResult.advisories) {
 const advisory = auditResult.advisories[id]
 if (levels.indexOf(advisory.severity) >= minLevel) {
 vulns += advisory.findings.filter(envFilter).length
 }
 }

 if (vulns > 0) process.exitCode = 1
 if (opts.parseable) {
 return audit.printParseableReport(auditResult)
Expand Down

102 changes: 101 additions & 1 deletion
test/tap/audit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,12 @@ test('exits with zero exit code for vulnerabilities below the `audit-level` flag
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'low',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 low: 1
Expand DownExpand Up@@ -169,6 +175,12 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'high',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 high: 1
Expand All@@ -188,7 +200,7 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 })
})

test('exits with non-zero exit code for vulnerabilities at the `audit-level` flag', t => {
test('exits with non-zero exit code for vulnerabilities above the `audit-level` flag', t => {
 const fixture = new Tacks(new Dir({
 'package.json': new File({
 name: 'foo',
Expand DownExpand Up@@ -244,6 +256,12 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'high',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 high: 1
Expand All@@ -263,6 +281,88 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 })
})

test('exits with zero exit code for vulnerabilities not included with --only, --also and --production flags', t => {
 const fixture = new Tacks(new Dir({
 'package.json': new File({
 name: 'foo',
 version: '1.0.0',
 dependencies: {
 baddep: '1.0.0'
 }
 })
 }))
 fixture.create(testDir)
 return tmock(t).then(srv => {
 srv.filteringRequestBody(req => 'ok')
 srv.post('/-/npm/v1/security/audits/quick', 'ok').reply(200, 'yeah')
 srv.get('/baddep').twice().reply(200, {
 name: 'baddep',
 'dist-tags': {
 'latest': '1.2.3'
 },
 versions: {
 '1.0.0': {
 name: 'baddep',
 version: '1.0.0',
 _hasShrinkwrap: false,
 dist: {
 shasum: 'deadbeef',
 tarball: common.registry + '/idk/-/idk-1.0.0.tgz'
 }
 },
 '1.2.3': {
 name: 'baddep',
 version: '1.2.3',
 _hasShrinkwrap: false,
 dist: {
 shasum: 'deadbeef',
 tarball: common.registry + '/idk/-/idk-1.2.3.tgz'
 }
 }
 }
 })
 return common.npm([
 'install',
 '--audit',
 '--json',
 '--package-lock-only',
 '--registry', common.registry,
 '--cache', path.join(testDir, 'npm-cache')
 ], EXEC_OPTS).then(([code, stdout, stderr]) => {
 srv.filteringRequestBody(req => 'ok')
 srv.post('/-/npm/v1/security/audits', 'ok').reply(200, {
 actions: [{
 action: 'update',
 module: 'baddep',
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'high',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 high: 1
 }
 }
 })
 return common.npm([
 'audit',
 '--audit-level', 'moderate',
 '--only', 'development',
 '--json',
 '--registry', common.registry,
 '--cache', path.join(testDir, 'npm-cache')
 ], EXEC_OPTS).then(([code, stdout, stderr]) => {
 t.equal(code, 0, 'exited OK')
 })
 })
 })
})

test('cleanup', t => {
 return rimraf(testDir)
})

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
audit: env selection for report#125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

larsgw
wants to merge
2
commits into

from

 Closed


audit: env selection for report
#125
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
a7810b9

audit: env selection for report


larsgw Dec 17, 2018
ca35059

doc: add docs for audit level and env selection


larsgw Jan 17, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


12 changes: 11 additions & 1 deletion
doc/cli/npm-audit.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,21 @@ npm-audit(1) -- Run a security audit

## SYNOPSIS

 npm audit [--json|--parseable]
 npm audit [--json|--parseable|--production|--only=dev]
 npm audit fix [--force|--package-lock-only|--dry-run|--production|--only=dev]

## EXAMPLES

List vulnerabilities with a level of `high` or higher:
```
$ npm audit --audit-level high
```

List vulnerabilities in `devDependencies`:
```
$ npm audit --only=dev
```

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

18 changes: 10 additions & 8 deletions
doc/misc/npm-config.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -153,7 +153,8 @@ even for `GET` requests.
* Type: String

When "dev" or "development" and running local `npm shrinkwrap`,
`npm outdated`, or `npm update`, is an alias for `--dev`.
`npm outdated`, or `npm update`, or `npm audit`, is an alias for
`--dev`.

### audit

Expand DownExpand Up@@ -329,7 +330,7 @@ Show the description in `npm search`
* Default: false
* Type: Boolean

Install `dev-dependencies` along with packages.
Install or audit `devDependencies` along with packages.

### dry-run

Expand DownExpand Up@@ -723,15 +724,15 @@ usage.
When "dev" or "development" and running local `npm install` without any
arguments, only devDependencies (and their dependencies) are installed.

When "dev" or "development" and running local `npm ls`, `npm outdated`, or
`npm update`, is an alias for `--dev`.
When "dev" or "development" and running local `npm ls`, `npm outdated`,
`npm update`, or `npm audit`, is an alias for `--dev`.

When "prod" or "production" and running local `npm install` without any
arguments, only non-devDependencies (and their dependencies) are
installed.

When "prod" or "production" and running local `npm ls`, `npm outdated`, or
`npm update`, is an alias for `--production`.
When "prod" or "production" and running local `npm ls`, `npm outdated`,
`npm update`, or `npm audit`, is an alias for `--production`.

### optional

Expand DownExpand Up@@ -822,8 +823,9 @@ semver. Like the `rc` in `1.2.0-rc.8`.
Set to true to run in "production" mode.

1. devDependencies are not installed at the topmost level when running
 local `npm install` without any arguments.
2. Set the NODE_ENV="production" for lifecycle scripts.
 local `npm install` without any arguments or `npm audit fix`.
2. devDependencies are excluded from the npm audit report
3. Set the NODE_ENV="production" for lifecycle scripts.

### progress

Expand Down

26 changes: 18 additions & 8 deletions
lib/audit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,15 +130,18 @@ function maybeReadFile (name) {
 })
}

function filterEnv (action, opts) {
function getEnvFilter (opts) {
 const includeDev = opts.dev ||
 (!/^prod(uction)?$/.test(opts.only) && !opts.production) ||
 /^dev(elopment)?$/.test(opts.only) ||
 /^dev(elopment)?$/.test(opts.also)
 const includeProd = !/^dev(elopment)?$/.test(opts.only)
 const resolves = action.resolves.filter(({dev}) => {
 return (dev && includeDev) || (!dev && includeProd)
 })

 return ({dev}) => (dev && includeDev) || (!dev && includeProd)
}

function filterEnv (action, envFilter) {
 const resolves = action.resolves.filter(envFilter)
 if (resolves.length) {
 return Object.assign({}, action, {resolves})
 }
Expand DownExpand Up@@ -197,9 +200,10 @@ function auditCmd (args, cb) {
 }
 throw err
 }).then((auditResult) => {
 const envFilter = getEnvFilter(opts)
 if (args[0] === 'fix') {
 const actions = (auditResult.actions || []).reduce((acc, action) => {
 action = filterEnv(action, opts)
 action = filterEnv(action, envFilter)
 if (!action) { return acc }
 if (action.isMajor) {
 acc.major.add(`${action.module}@${action.target}`)
Expand DownExpand Up@@ -280,9 +284,15 @@ function auditCmd (args, cb) {
 } else {
 const levels = ['low', 'moderate', 'high', 'critical']
 const minLevel = levels.indexOf(opts['audit-level'])
 const vulns = levels.reduce((count, level, i) => {
 return i < minLevel ? count : count + (auditResult.metadata.vulnerabilities[level] || 0)
 }, 0)
 let vulns = 0

 for (const id in auditResult.advisories) {
 const advisory = auditResult.advisories[id]
 if (levels.indexOf(advisory.severity) >= minLevel) {
 vulns += advisory.findings.filter(envFilter).length
 }
 }

 if (vulns > 0) process.exitCode = 1
 if (opts.parseable) {
 return audit.printParseableReport(auditResult)
Expand Down

102 changes: 101 additions & 1 deletion
test/tap/audit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,12 @@ test('exits with zero exit code for vulnerabilities below the `audit-level` flag
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'low',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 low: 1
Expand DownExpand Up@@ -169,6 +175,12 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'high',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 high: 1
Expand All@@ -188,7 +200,7 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 })
})

test('exits with non-zero exit code for vulnerabilities at the `audit-level` flag', t => {
test('exits with non-zero exit code for vulnerabilities above the `audit-level` flag', t => {
 const fixture = new Tacks(new Dir({
 'package.json': new File({
 name: 'foo',
Expand DownExpand Up@@ -244,6 +256,12 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'high',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 high: 1
Expand All@@ -263,6 +281,88 @@ test('exits with non-zero exit code for vulnerabilities at the `audit-level` fla
 })
})

test('exits with zero exit code for vulnerabilities not included with --only, --also and --production flags', t => {
 const fixture = new Tacks(new Dir({
 'package.json': new File({
 name: 'foo',
 version: '1.0.0',
 dependencies: {
 baddep: '1.0.0'
 }
 })
 }))
 fixture.create(testDir)
 return tmock(t).then(srv => {
 srv.filteringRequestBody(req => 'ok')
 srv.post('/-/npm/v1/security/audits/quick', 'ok').reply(200, 'yeah')
 srv.get('/baddep').twice().reply(200, {
 name: 'baddep',
 'dist-tags': {
 'latest': '1.2.3'
 },
 versions: {
 '1.0.0': {
 name: 'baddep',
 version: '1.0.0',
 _hasShrinkwrap: false,
 dist: {
 shasum: 'deadbeef',
 tarball: common.registry + '/idk/-/idk-1.0.0.tgz'
 }
 },
 '1.2.3': {
 name: 'baddep',
 version: '1.2.3',
 _hasShrinkwrap: false,
 dist: {
 shasum: 'deadbeef',
 tarball: common.registry + '/idk/-/idk-1.2.3.tgz'
 }
 }
 }
 })
 return common.npm([
 'install',
 '--audit',
 '--json',
 '--package-lock-only',
 '--registry', common.registry,
 '--cache', path.join(testDir, 'npm-cache')
 ], EXEC_OPTS).then(([code, stdout, stderr]) => {
 srv.filteringRequestBody(req => 'ok')
 srv.post('/-/npm/v1/security/audits', 'ok').reply(200, {
 actions: [{
 action: 'update',
 module: 'baddep',
 target: '1.2.3',
 resolves: [{path: 'baddep'}]
 }],
 advisories: {
 '1': {
 severity: 'high',
 findings: [{dev: false}]
 }
 },
 metadata: {
 vulnerabilities: {
 high: 1
 }
 }
 })
 return common.npm([
 'audit',
 '--audit-level', 'moderate',
 '--only', 'development',
 '--json',
 '--registry', common.registry,
 '--cache', path.join(testDir, 'npm-cache')
 ], EXEC_OPTS).then(([code, stdout, stderr]) => {
 t.equal(code, 0, 'exited OK')
 })
 })
 })
})

test('cleanup', t => {
 return rimraf(testDir)
})