This repository has been archived by the owner on Jan 20, 2022. It is now read-only.
/
audit-report.js
404 lines (343 loc) · 13.2 KB
/
audit-report.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
const t = require('tap')
const AuditReport = require('../lib/audit-report.js')
const {auditToBulk} = AuditReport
const Node = require('../lib/node.js')
const Arborist = require('../')
const registryServer = require('./fixtures/registry-mocks/server.js')
const {registry, auditResponse, failAudit, advisoryBulkResponse} = registryServer
const {resolve} = require('path')
const fixtures = resolve(__dirname, 'fixtures')
const cache = t.testdir()
const newArb = (path, opts = {}) => new Arborist({path, registry, cache, ...opts})
const sortReport = report => {
const entries = Object.entries(report.vulnerabilities)
const vulns = entries.sort(([a], [b]) => a.localeCompare(b))
.map(([name, vuln]) => [
name,
{
...vuln,
via: (vuln.via || []).sort((a, b) =>
String(a.source || a).localeCompare(String(b.source || b))),
effects: (vuln.effects || []).sort((a, b) => a.localeCompare(b)),
},
])
report.vulnerabilities = vulns.reduce((set, [k, v]) => {
set[k] = v
return set
}, {})
}
t.test('setup server', { bail: true }, registryServer)
t.test('all severity levels', async t => {
const path = resolve(fixtures, 'audit-all-severities')
const auditFile = resolve(path, 'audit.json')
t.teardown(auditResponse(auditFile))
const arb = newArb(path)
const tree = await arb.loadVirtual()
const report = await AuditReport.load(tree, arb.options)
t.matchSnapshot(JSON.stringify(report, 0, 2), 'json version')
t.equal(report.topVulns.size, 2)
})
t.test('vulnerable dep not from registry', async t => {
const path = resolve(fixtures, 'minimist-git-dep')
const auditFile = resolve(path, 'audit.json')
t.teardown(auditResponse(auditFile))
const arb = newArb(path)
const tree = await arb.loadVirtual()
const report = await AuditReport.load(tree, arb.options)
t.matchSnapshot(JSON.stringify(report, 0, 2), 'json version')
t.equal(report.has('minimist'), true)
t.equal(report.topVulns.has('minimist'), true)
t.equal(report.isVulnerable(tree.children.get('minimist')), true)
})
t.test('metavuln where dep is not a registry dep', async t => {
const path = resolve(fixtures, 'minimist-git-metadep')
const auditFile = resolve(path, 'audit.json')
t.teardown(auditResponse(auditFile))
const arb = newArb(path)
const tree = await arb.loadVirtual()
const report = await AuditReport.load(tree, arb.options)
t.matchSnapshot(JSON.stringify(report, 0, 2), 'json version')
t.equal(report.has('@isaacs/minimist-git-dep'), true)
t.equal(report.has('minimist'), true)
t.equal(report.topVulns.has('@isaacs/minimist-git-dep'), true)
})
t.test('metavuln where a dep is not on the registry at all', async t => {
const path = resolve(fixtures, 'audit-missing-packument')
const auditFile = resolve(path, 'audit.json')
t.teardown(auditResponse(auditFile))
const arb = newArb(path)
const tree = await arb.loadVirtual()
const report = await AuditReport.load(tree, arb.options)
t.matchSnapshot(JSON.stringify(report, 0, 2), 'json version')
t.equal(report.topVulns.size, 1)
})
t.test('get advisory about node not in tree', async t => {
// this should never happen, but if it does, we're prepared for it
const path = resolve(fixtures, 'audit-nyc-mkdirp')
const auditFile = resolve(path, 'audit.json')
t.teardown(auditResponse(auditFile))
const arb = newArb(path)
const tree = await arb.loadVirtual()
tree.children.get('mkdirp').parent = null
tree.children.get('nyc').parent = null
tree.children.get('minimist').parent = null
new Node({
parent: tree,
path: resolve(path, 'node_modules/fooo'),
pkg: { name: 'fooo', version: '1.2.3' },
})
tree.package = { dependencies: {
fooo: '',
}}
const report = await AuditReport.load(tree, arb.options)
// just a gut-check that the registry server is actually doing stuff
t.match(report.report, auditToBulk(require(auditFile)), 'got expected response')
t.equal(report.topVulns.size, 0, 'one top node found vulnerable')
t.equal(report.size, 0, 'no vulns that were relevant')
t.equal(report.get('nyc'), undefined)
t.equal(report.get('mkdirp'), undefined)
})
t.test('unfixable, but not a semver major forced fix', async t => {
const path = resolve(fixtures, 'mkdirp-pinned')
const auditFile = resolve(fixtures, 'audit-nyc-mkdirp/audit.json')
t.teardown(auditResponse(auditFile))
const arb = newArb(path)
const tree = await arb.loadVirtual()
const report = await AuditReport.load(tree, arb.options)
t.matchSnapshot(JSON.stringify(report, 0, 2), 'json version')
t.equal(report.topVulns.size, 1)
})
t.test('audit outdated nyc and mkdirp', async t => {
const path = resolve(fixtures, 'audit-nyc-mkdirp')
const auditFile = resolve(path, 'audit.json')
t.teardown(auditResponse(auditFile))
const arb = newArb(path)
const tree = await arb.loadVirtual()
const report = await AuditReport.load(tree, arb.options)
t.matchSnapshot(JSON.stringify(report, 0, 2), 'json version')
// just a gut-check that the registry server is actually doing stuff
t.match(report.report, auditToBulk(require(auditFile)), 'got expected response')
t.throws(() => report.set('foo', 'bar'), {
message: 'do not call AuditReport.set() directly',
})
t.equal(report.topVulns.size, 1, 'one top node found vulnerable')
t.equal(report.get('nyc').simpleRange, '6.2.0-alpha - 13.1.0')
t.equal(report.get('mkdirp').simpleRange, '0.4.1 - 0.5.1')
})
t.test('audit outdated nyc and mkdirp with newer endpoint', async t => {
const path = resolve(fixtures, 'audit-nyc-mkdirp')
const auditFile = resolve(path, 'advisory-bulk.json')
t.teardown(advisoryBulkResponse(auditFile))
const arb = newArb(path)
const tree = await arb.loadVirtual()
const report = await AuditReport.load(tree, arb.options)
t.matchSnapshot(JSON.stringify(report, 0, 2), 'json version')
// just a gut-check that the registry server is actually doing stuff
t.match(report.report, require(auditFile), 'got expected response')
t.throws(() => report.set('foo', 'bar'), {
message: 'do not call AuditReport.set() directly',
})
t.equal(report.topVulns.size, 1, 'one top node found vulnerable')
t.equal(report.get('nyc').simpleRange, '6.2.0-alpha - 13.1.0')
t.equal(report.get('mkdirp').simpleRange, '0.4.1 - 0.5.1')
})
t.test('audit outdated nyc and mkdirp with before: option', async t => {
const path = resolve(fixtures, 'audit-nyc-mkdirp')
const auditFile = resolve(path, 'audit.json')
t.teardown(auditResponse(auditFile))
const arb = newArb(path, { before: new Date('2020-01-01') })
const tree = await arb.loadVirtual()
const report = await AuditReport.load(tree, arb.options)
t.matchSnapshot(JSON.stringify(report, 0, 2), 'json version')
// just a gut-check that the registry server is actually doing stuff
t.match(report.report, auditToBulk(require(auditFile)), 'got expected response')
t.equal(report.topVulns.size, 1, 'one top node found vulnerable')
t.equal(report.get('nyc').simpleRange, '6.2.0-alpha - 13.1.0')
t.equal(report.get('mkdirp').simpleRange, '0.4.1 - 0.5.1')
})
t.test('audit returns an error', async t => {
const path = resolve(fixtures, 'audit-nyc-mkdirp')
const auditFile = resolve(path, 'audit.json')
t.teardown(auditResponse(auditFile))
t.teardown(failAudit())
const logs = []
const onlog = (...msg) => logs.push(msg)
process.on('log', onlog)
t.teardown(() => process.removeListener('log', onlog))
const arb = newArb(path)
const tree = await arb.loadVirtual()
const report = await AuditReport.load(tree, arb.options)
t.equal(report.report, null, 'did not get audit response')
t.equal(report.size, 0, 'did not find any vulnerabilities')
t.match(logs, [
[
'verbose',
'audit error',
report.error,
],
['silly', 'audit error', 'no audit for you'],
], 'logged audit failure')
t.match(report.error, Error)
})
t.test('audit disabled by config', async t => {
const path = resolve(fixtures, 'audit-nyc-mkdirp')
const logs = []
const onlog = (...msg) => logs.push(msg)
process.on('log', onlog)
t.teardown(() => process.removeListener('log', onlog))
const arb = newArb(path, { audit: false })
const tree = await arb.loadVirtual()
const report = await AuditReport.load(tree, arb.options)
t.equal(report.report, null, 'did not get audit response')
t.equal(report.size, 0, 'did not find any vulnerabilities')
t.match(logs, [], 'no logs of error')
t.equal(report.error, null, 'no error encountered')
})
t.test('one vulnerability', async t => {
const path = resolve(fixtures, 'audit-one-vuln')
const auditFile = resolve(path, 'audit.json')
t.teardown(auditResponse(auditFile))
const arb = newArb(path)
const tree = await arb.loadVirtual()
const report = await AuditReport.load(tree, arb.options)
t.matchSnapshot(JSON.stringify(report, 0, 2), 'json version')
t.equal(report.topVulns.size, 0)
})
t.test('a dep vuln that also has its own advisory against it', async t => {
const path = resolve(fixtures, 'audit-dep-vuln-with-own-advisory')
const auditFile = resolve(path, 'audit.json')
t.teardown(auditResponse(auditFile))
const arb = newArb(path)
const tree = await arb.loadVirtual()
const report = await AuditReport.load(tree, arb.options)
t.matchSnapshot(JSON.stringify(report, 0, 2), 'json version')
t.equal(report.topVulns.size, 0)
})
t.test('get default opts when loaded without opts', async t => {
const ar = new AuditReport()
t.equal(ar.tree, undefined)
t.strictSame(ar.options, {})
})
t.test('error on audit response with no advisories object', async t => {
const dir = t.testdir({
'audit.json': JSON.stringify({no: 'advisories', at: 'all'}),
})
const path = resolve(fixtures, 'audit-nyc-mkdirp')
const auditFile = resolve(dir, 'audit.json')
t.teardown(auditResponse(auditFile))
const arb = newArb(path)
const tree = await arb.loadVirtual()
const report = await AuditReport.load(tree, arb.options)
t.match(report.error, {
message: 'Invalid advisory report',
body: JSON.stringify({no: 'advisories', at: 'all'}),
})
})
t.test('audit report with a lying v5 lockfile', async t => {
// npm v5 stored the resolved dependency version in the `requires`
// set, rather than the spec that is actually required. As a result,
// a dep may _appear_ to be a metavuln, but when we scan the
// packument, it turns out that it matches no nodes, and gets deleted.
const path = resolve(fixtures, 'eslintme')
const arb = newArb(path)
const auditFile = resolve(path, 'audit.json')
t.teardown(advisoryBulkResponse(auditFile))
const tree = await arb.loadVirtual()
const report = await AuditReport.load(tree, arb.options)
// also try to delete something that just very much is not present
report.delete('eslint')
report.delete('eslint')
t.matchSnapshot(report.toJSON())
})
t.test('omit options', async t => {
const path = resolve(fixtures, 'audit-omit')
const quick = resolve(path, 'quick.json')
// quick response doesn't change for omit args
t.teardown(auditResponse(quick))
const omits = [
[],
['dev'],
['optional'],
['dev', 'optional'],
['peer'],
['peer', 'dev'],
['peer', 'dev', 'optional'], // empty
]
const arb = newArb(path)
const tree = await arb.loadVirtual()
for (const omit of omits) {
t.test(`omit=[${omit.join(',')}]`, async t => {
const s = omit.map(o => `-omit${o}`).join('')
const bulk = resolve(path, `bulk${s}.json`)
const rmBulk = advisoryBulkResponse(bulk)
const r1 = (await AuditReport.load(tree, { ...arb.options, omit })).toJSON()
sortReport(r1)
rmBulk()
t.matchSnapshot(r1, 'bulk')
const r2 = (await AuditReport.load(tree, { ...arb.options, omit })).toJSON()
sortReport(r2)
t.strictSame(r1, r2, 'same results')
t.end()
})
}
t.end()
})
t.test('audit when tree is empty', async t => {
const tree = new Node({
path: '/path/to/tree',
})
const auditReport = new AuditReport(tree)
const { report } = await auditReport.run()
t.strictSame(report, null)
})
t.test('audit when bulk report doenst have anything in it', async t => {
const tree = new Node({
path: '/path/to/tree',
pkg: {
name: 'tree',
version: '1.2.3',
devDependencies: { something: '1.2.3' },
},
children: [
{ pkg: { name: 'something', version: '1.2.3' } },
],
})
const auditReport = new AuditReport(tree, { omit: ['dev'] })
const { report } = await auditReport.run()
t.strictSame(report, null)
})
t.test('default severity=high, vulnerable_versions=*', async t => {
const audit = {
actions: [],
advisories: {
755: {
findings: [
{
version: '1.2.3',
paths: [
'something',
],
},
],
id: 755,
title: 'no severity or vulnerable versions',
module_name: 'something',
overview: 'should default severity=high, vulnerable_versions=*',
recommendation: "don't use this thing",
url: 'https://npmjs.com/advisories/755',
},
},
muted: [],
metadata: {
vulnerabilities: {},
dependencies: 1,
devDependencies: 0,
optionalDependencies: 0,
totalDependencies: 1,
},
runId: 'just-some-unique-identifier',
}
const bulk = auditToBulk(audit)
t.match(bulk, { something: [{ severity: 'high', vulnerable_versions: '*' }] })
t.end()
})