/
run-test.ts
603 lines (551 loc) · 19.2 KB
/
run-test.ts
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
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
import * as fs from 'fs';
import * as _ from '@snyk/lodash';
import * as path from 'path';
import * as debugModule from 'debug';
import * as pathUtil from 'path';
import { parsePackageString as moduleToObject } from 'snyk-module';
import * as depGraphLib from '@snyk/dep-graph';
import { IacScan } from './payload-schema';
import {
TestResult,
DockerIssue,
AnnotatedIssue,
TestDepGraphResponse,
convertTestDepGraphResultToLegacy,
LegacyVulnApiResult,
} from './legacy';
import { IacTestResult } from './iac-test-result';
import {
AuthFailedError,
InternalServerError,
NoSupportedManifestsFoundError,
FailedToGetVulnerabilitiesError,
FailedToGetVulnsFromUnavailableResource,
FailedToRunTestError,
UnsupportedFeatureFlagError,
} from '../errors';
import * as snyk from '../';
import { isCI } from '../is-ci';
import * as common from './common';
import * as config from '../config';
import * as analytics from '../analytics';
import { maybePrintDepTree, maybePrintDepGraph } from '../print-deps';
import { GitTarget, ContainerTarget } from '../project-metadata/types';
import * as projectMetadata from '../project-metadata';
import {
DepTree,
Options,
TestOptions,
SupportedProjectTypes,
PolicyOptions,
} from '../types';
import { pruneGraph } from '../prune';
import { getDepsFromPlugin } from '../plugins/get-deps-from-plugin';
import { ScannedProjectCustom } from '../plugins/get-multi-plugin-result';
import request = require('../request');
import spinner = require('../spinner');
import { extractPackageManager } from '../plugins/extract-package-manager';
import { getSubProjectCount } from '../plugins/get-sub-project-count';
import { serializeCallGraphWithMetrics } from '../reachable-vulns';
import { validateOptions } from '../options-validator';
import { findAndLoadPolicy } from '../policy';
import { assembleIacLocalPayloads, parseIacTestResult } from './run-iac-test';
import { Payload, PayloadBody, DepTreeFromResolveDeps } from './types';
const debug = debugModule('snyk');
export = runTest;
async function sendAndParseResults(
payloads: Payload[],
spinnerLbl: string,
root: string,
options: Options & TestOptions,
): Promise<TestResult[]> {
const results: TestResult[] = [];
for (const payload of payloads) {
await spinner(spinnerLbl);
if (options.iac) {
const iacScan: IacScan = payload.body as IacScan;
analytics.add('iac type', !!iacScan.type);
const res = (await sendTestPayload(payload)) as IacTestResult;
const projectName =
iacScan.projectNameOverride || iacScan.originalProjectName;
const result = await parseIacTestResult(
res,
iacScan.targetFile,
projectName,
options.severityThreshold,
);
results.push(result);
} else {
const payloadBody: PayloadBody = payload.body as PayloadBody;
const payloadPolicy = payloadBody && payloadBody.policy;
const depGraph = payloadBody && payloadBody.depGraph;
const pkgManager =
depGraph &&
depGraph.pkgManager &&
(depGraph.pkgManager.name as SupportedProjectTypes);
const targetFile = payloadBody && payloadBody.targetFile;
const projectName =
_.get(payload, 'body.projectNameOverride') ||
_.get(payload, 'body.originalProjectName');
const foundProjectCount = _.get(payload, 'body.foundProjectCount');
const displayTargetFile = _.get(payload, 'body.displayTargetFile');
let dockerfilePackages;
if (
payloadBody &&
payloadBody.docker &&
payloadBody.docker.dockerfilePackages
) {
dockerfilePackages = payloadBody.docker.dockerfilePackages;
}
analytics.add('depGraph', !!depGraph);
analytics.add('isDocker', !!(payloadBody && payloadBody.docker));
// Type assertion might be a lie, but we are correcting that below
const res = (await sendTestPayload(payload)) as LegacyVulnApiResult;
const result = await parseRes(
depGraph,
pkgManager,
res,
options,
payload,
payloadPolicy,
root,
dockerfilePackages,
);
results.push({
...result,
targetFile,
projectName,
foundProjectCount,
displayTargetFile,
});
}
}
return results;
}
async function runTest(
projectType: SupportedProjectTypes | undefined,
root: string,
options: Options & TestOptions,
): Promise<TestResult[]> {
const spinnerLbl = 'Querying vulnerabilities database...';
try {
await validateOptions(options, options.packageManager);
const payloads = await assemblePayloads(root, options);
return await sendAndParseResults(payloads, spinnerLbl, root, options);
} catch (error) {
debug('Error running test', { error });
// handling denial from registry because of the feature flag
// currently done for go.mod
const isFeatureNotAllowed =
error.code === 403 && error.message.includes('Feature not allowed');
const hasFailedToGetVulnerabilities =
error.code === 404 &&
error.name.includes('FailedToGetVulnerabilitiesError');
if (isFeatureNotAllowed) {
throw NoSupportedManifestsFoundError([root]);
}
if (hasFailedToGetVulnerabilities) {
throw FailedToGetVulnsFromUnavailableResource(root, error.code);
}
throw new FailedToRunTestError(
error.userMessage ||
error.message ||
`Failed to test ${projectType} project`,
error.code,
);
} finally {
spinner.clear<void>(spinnerLbl)();
}
}
async function parseRes(
depGraph: depGraphLib.DepGraph | undefined,
pkgManager: SupportedProjectTypes | undefined,
res: LegacyVulnApiResult,
options: Options & TestOptions,
payload: Payload,
payloadPolicy: string | undefined,
root: string,
dockerfilePackages: any,
): Promise<TestResult> {
// TODO: docker doesn't have a package manager
// so this flow will not be applicable
// refactor to separate
if (depGraph && pkgManager) {
res = convertTestDepGraphResultToLegacy(
(res as any) as TestDepGraphResponse, // Double "as" required by Typescript for dodgy assertions
depGraph,
pkgManager,
options.severityThreshold,
);
// For Node.js: inject additional information (for remediation etc.) into the response.
if (payload.modules) {
res.dependencyCount =
payload.modules.numDependencies ||
depGraph.countPathsToRoot(depGraph.rootPkg);
if (res.vulnerabilities) {
res.vulnerabilities.forEach((vuln) => {
if (payload.modules && payload.modules.pluck) {
const plucked = payload.modules.pluck(
vuln.from,
vuln.name,
vuln.version,
);
vuln.__filename = plucked.__filename;
vuln.shrinkwrap = plucked.shrinkwrap;
vuln.bundled = plucked.bundled;
// this is an edgecase when we're testing the directly vuln pkg
if (vuln.from.length === 1) {
return;
}
const parentPkg = moduleToObject(vuln.from[1]);
const parent = payload.modules.pluck(
vuln.from.slice(0, 2),
parentPkg.name,
parentPkg.version,
);
vuln.parentDepType = parent.depType;
}
});
}
}
}
// TODO: is this needed? we filter on the other side already based on policy
// this will move to be filtered server side soon & it will support `'ignore-policy'`
analytics.add('vulns-pre-policy', res.vulnerabilities.length);
res.filesystemPolicy = !!payloadPolicy;
if (!options['ignore-policy']) {
res.policy = res.policy || (payloadPolicy as string);
const policy = await snyk.policy.loadFromText(res.policy);
res = policy.filter(res, root);
}
analytics.add('vulns', res.vulnerabilities.length);
if (res.docker && dockerfilePackages) {
res.vulnerabilities = res.vulnerabilities.map((vuln) => {
const dockerfilePackage = dockerfilePackages[vuln.name.split('/')[0]];
if (dockerfilePackage) {
(vuln as DockerIssue).dockerfileInstruction =
dockerfilePackage.instruction;
}
(vuln as DockerIssue).dockerBaseImage = res.docker!.baseImage;
return vuln;
});
}
if (options.docker && options.file && options['exclude-base-image-vulns']) {
res.vulnerabilities = res.vulnerabilities.filter(
(vuln) => (vuln as DockerIssue).dockerfileInstruction,
);
}
res.uniqueCount = countUniqueVulns(res.vulnerabilities);
return res;
}
function sendTestPayload(
payload: Payload,
): Promise<LegacyVulnApiResult | TestDepGraphResponse | IacTestResult> {
const filesystemPolicy = payload.body && !!payload.body.policy;
return new Promise((resolve, reject) => {
request(payload, (error, res, body) => {
if (error) {
return reject(error);
}
if (res.statusCode !== 200) {
const err = handleTestHttpErrorResponse(res, body);
return reject(err);
}
body.filesystemPolicy = filesystemPolicy;
resolve(body);
});
});
}
function handleTestHttpErrorResponse(res, body) {
const { statusCode } = res;
let err;
const userMessage = body && body.userMessage;
switch (statusCode) {
case 401:
case 403:
err = AuthFailedError(userMessage, statusCode);
err.innerError = body.stack;
break;
case 405:
err = new UnsupportedFeatureFlagError('reachableVulns');
err.innerError = body.stack;
break;
case 500:
err = new InternalServerError(userMessage);
err.innerError = body.stack;
break;
default:
err = new FailedToGetVulnerabilitiesError(userMessage, statusCode);
err.innerError = body.error;
}
return err;
}
function assemblePayloads(
root: string,
options: Options & TestOptions,
): Promise<Payload[]> {
let isLocal;
if (options.docker) {
isLocal = true;
} else {
// TODO: Refactor this check so we don't require files when tests are using mocks
isLocal = fs.existsSync(root);
}
analytics.add('local', isLocal);
if (isLocal) {
return assembleLocalPayloads(root, options);
}
return assembleRemotePayloads(root, options);
}
// Payload to send to the Registry for scanning a package from the local filesystem.
async function assembleLocalPayloads(
root,
options: Options & TestOptions & PolicyOptions,
): Promise<Payload[]> {
// For --all-projects packageManager is yet undefined here. Use 'all'
let analysisTypeText = 'all dependencies for ';
if (options.docker) {
analysisTypeText = 'docker dependencies for ';
} else if (options.iac) {
analysisTypeText = 'Infrastructure as code configurations for ';
} else if (options.packageManager) {
analysisTypeText = options.packageManager + ' dependencies for ';
}
const spinnerLbl =
'Analyzing ' +
analysisTypeText +
(path.relative('.', path.join(root, options.file || '')) ||
path.relative('..', '.') + ' project dir');
try {
const payloads: Payload[] = [];
await spinner(spinnerLbl);
if (options.iac) {
return assembleIacLocalPayloads(root, options);
}
const deps = await getDepsFromPlugin(root, options);
analytics.add('pluginName', deps.plugin.name);
const javaVersion = _.get(
deps.plugin,
'meta.versionBuildInfo.metaBuildVersion.javaVersion',
null,
);
const mvnVersion = _.get(
deps.plugin,
'meta.versionBuildInfo.metaBuildVersion.mvnVersion',
null,
);
if (javaVersion) {
analytics.add('javaVersion', javaVersion);
}
if (mvnVersion) {
analytics.add('mvnVersion', mvnVersion);
}
for (const scannedProject of deps.scannedProjects) {
if (!scannedProject.depTree && !scannedProject.depGraph) {
debug(
'scannedProject is missing depGraph or depTree, cannot run test/monitor',
);
throw new FailedToRunTestError(
'Your test request could not be completed. Please email support@snyk.io',
);
}
// prefer dep-graph fallback on dep tree
// TODO: clean up once dep-graphs only
const pkg:
| DepTree
| depGraphLib.DepGraph
| undefined = scannedProject.depGraph
? scannedProject.depGraph
: scannedProject.depTree;
if (options['print-deps']) {
if (scannedProject.depGraph) {
await spinner.clear<void>(spinnerLbl)();
maybePrintDepGraph(options, pkg as depGraphLib.DepGraph);
} else {
await spinner.clear<void>(spinnerLbl)();
maybePrintDepTree(options, pkg as DepTree);
}
}
const project = scannedProject as ScannedProjectCustom;
const packageManager = extractPackageManager(project, deps, options);
if ((pkg as DepTree).docker) {
const baseImageFromDockerfile = (pkg as DepTree).docker.baseImage;
if (!baseImageFromDockerfile && options['base-image']) {
(pkg as DepTree).docker.baseImage = options['base-image'];
}
if (baseImageFromDockerfile && deps.plugin && deps.plugin.imageLayers) {
analytics.add('BaseImage', baseImageFromDockerfile);
analytics.add('imageLayers', deps.plugin.imageLayers);
}
}
// todo: normalize what target file gets used across plugins and functions
const targetFile =
scannedProject.targetFile || deps.plugin.targetFile || options.file;
// Forcing options.path to be a string as pathUtil requires is to be stringified
const targetFileRelativePath = targetFile
? pathUtil.join(pathUtil.resolve(`${options.path || root}`), targetFile)
: '';
let targetFileDir;
if (targetFileRelativePath) {
const { dir } = path.parse(targetFileRelativePath);
targetFileDir = dir;
}
const policy = await findAndLoadPolicy(
root,
options.docker ? 'docker' : packageManager!,
options,
// TODO: fix this and send only send when we used resolve-deps for node
// it should be a ExpandedPkgTree type instead
pkg,
targetFileDir,
);
analytics.add('packageManager', packageManager);
if (scannedProject.depGraph) {
const depGraph = pkg as depGraphLib.DepGraph;
addPackageAnalytics(depGraph.rootPkg.name, depGraph.rootPkg.version!);
}
if (scannedProject.depTree) {
const depTree = pkg as DepTree;
addPackageAnalytics(depTree.name!, depTree.version!);
}
let target: GitTarget | ContainerTarget | null;
if (scannedProject.depGraph) {
target = await projectMetadata.getInfo(scannedProject, options);
} else {
target = await projectMetadata.getInfo(
scannedProject,
options,
pkg as DepTree,
);
}
const originalProjectName = scannedProject.depGraph
? (pkg as depGraphLib.DepGraph).rootPkg.name
: (pkg as DepTree).name;
let body: PayloadBody = {
// WARNING: be careful changing this as it affects project uniqueness
targetFile: project.plugin.targetFile,
// TODO: Remove relativePath prop once we gather enough ruby related logs
targetFileRelativePath: `${targetFileRelativePath}`, // Forcing string
projectNameOverride: options.projectName,
originalProjectName,
policy: policy ? policy.toString() : undefined,
foundProjectCount: getSubProjectCount(deps),
displayTargetFile: targetFile,
docker: (pkg as DepTree).docker,
hasDevDependencies: (pkg as any).hasDevDependencies,
target,
};
if (options.vulnEndpoint) {
// options.vulnEndpoint is only used by `snyk protect` (i.e. local filesystem tests).
body = { ...body, ...pkg };
} else {
let depGraph: depGraphLib.DepGraph;
if (scannedProject.depGraph) {
depGraph = scannedProject.depGraph;
} else {
// Graphs are more compact and robust representations.
// Legacy parts of the code are still using trees, but will eventually be fully migrated.
debug('converting dep-tree to dep-graph', {
name: (pkg as DepTree).name,
targetFile: scannedProject.targetFile || options.file,
});
depGraph = await depGraphLib.legacy.depTreeToGraph(
pkg as DepTree,
packageManager!,
);
debug('done converting dep-tree to dep-graph', {
uniquePkgsCount: depGraph.getPkgs().length,
});
}
const pruneIsRequired = options['prune-repeated-subdependencies'];
if (packageManager) {
depGraph = await pruneGraph(
depGraph,
packageManager,
pruneIsRequired,
);
}
body.depGraph = depGraph;
}
if (scannedProject.callGraph) {
const {
callGraph,
nodeCount,
edgeCount,
} = serializeCallGraphWithMetrics(scannedProject.callGraph);
debug(
`Adding call graph to payload, node count: ${nodeCount}, edge count: ${edgeCount}`,
);
const callGraphMetrics = _.get(
deps.plugin,
'meta.callGraphMetrics',
{},
);
analytics.add('callGraphMetrics', {
callGraphEdgeCount: edgeCount,
callGraphNodeCount: nodeCount,
...callGraphMetrics,
});
body.callGraph = callGraph;
}
const payload: Payload = {
method: 'POST',
url: config.API + (options.vulnEndpoint || '/test-dep-graph'),
json: true,
headers: {
'x-is-ci': isCI(),
authorization: 'token ' + (snyk as any).api,
},
qs: common.assembleQueryString(options),
body,
};
if (packageManager && ['yarn', 'npm'].indexOf(packageManager) !== -1) {
const isLockFileBased =
targetFile &&
(targetFile.endsWith('package-lock.json') ||
targetFile.endsWith('yarn.lock'));
if (!isLockFileBased || options.traverseNodeModules) {
payload.modules = pkg as DepTreeFromResolveDeps; // See the output of resolve-deps
}
}
payloads.push(payload);
}
return payloads;
} finally {
await spinner.clear<void>(spinnerLbl)();
}
}
// Payload to send to the Registry for scanning a remote package.
async function assembleRemotePayloads(root, options): Promise<Payload[]> {
const pkg = moduleToObject(root);
debug('testing remote: %s', pkg.name + '@' + pkg.version);
addPackageAnalytics(pkg.name, pkg.version);
const encodedName = encodeURIComponent(pkg.name + '@' + pkg.version);
// options.vulnEndpoint is only used by `snyk protect` (i.e. local filesystem tests)
const url = `${config.API}${options.vulnEndpoint ||
`/vuln/${options.packageManager}`}/${encodedName}`;
return [
{
method: 'GET',
url,
qs: common.assembleQueryString(options),
json: true,
headers: {
'x-is-ci': isCI(),
authorization: 'token ' + snyk.api,
},
},
];
}
function addPackageAnalytics(name: string, version: string): void {
analytics.add('packageName', name);
analytics.add('packageVersion', version);
analytics.add('package', name + '@' + version);
}
function countUniqueVulns(vulns: AnnotatedIssue[]): number {
const seen = {};
for (const curr of vulns) {
seen[curr.id] = true;
}
return Object.keys(seen).length;
}