/
vulnerabilities.ts
594 lines (528 loc) · 17.6 KB
/
vulnerabilities.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
// TODO #7154
import { Ecosystem, Osv, OsvOffline } from '@renovatebot/osv-offline';
import is from '@sindresorhus/is';
import type { CvssScore } from 'vuln-vects';
import { parseCvssVector } from 'vuln-vects';
import { getManagerConfig, mergeChildConfig } from '../../../config';
import type { PackageRule, RenovateConfig } from '../../../config/types';
import { logger } from '../../../logger';
import { getDefaultVersioning } from '../../../modules/datasource';
import type {
PackageDependency,
PackageFile,
} from '../../../modules/manager/types';
import {
VersioningApi,
get as getVersioning,
} from '../../../modules/versioning';
import { sanitizeMarkdown } from '../../../util/markdown';
import * as p from '../../../util/promises';
import { regEx } from '../../../util/regex';
import { titleCase } from '../../../util/string';
import type {
DependencyVulnerabilities,
SeverityDetails,
Vulnerability,
} from './types';
export class Vulnerabilities {
private osvOffline: OsvOffline | undefined;
private static readonly datasourceEcosystemMap: Record<
string,
Ecosystem | undefined
> = {
crate: 'crates.io',
go: 'Go',
hex: 'Hex',
maven: 'Maven',
npm: 'npm',
nuget: 'NuGet',
packagist: 'Packagist',
pypi: 'PyPI',
rubygems: 'RubyGems',
};
// eslint-disable-next-line @typescript-eslint/no-empty-function
private constructor() {}
private async initialize(): Promise<void> {
this.osvOffline = await OsvOffline.create();
}
static async create(): Promise<Vulnerabilities> {
const instance = new Vulnerabilities();
await instance.initialize();
return instance;
}
async appendVulnerabilityPackageRules(
config: RenovateConfig,
packageFiles: Record<string, PackageFile[]>
): Promise<void> {
const dependencyVulnerabilities = await this.fetchDependencyVulnerabilities(
config,
packageFiles
);
config.packageRules ??= [];
for (const {
vulnerabilities,
versioningApi,
} of dependencyVulnerabilities) {
const groupPackageRules: PackageRule[] = [];
for (const vulnerability of vulnerabilities) {
const rule = this.vulnerabilityToPackageRules(vulnerability);
if (is.nullOrUndefined(rule)) {
continue;
}
groupPackageRules.push(rule);
}
this.sortByFixedVersion(groupPackageRules, versioningApi);
config.packageRules.push(...groupPackageRules);
}
}
async fetchVulnerabilities(
config: RenovateConfig,
packageFiles: Record<string, PackageFile[]>
): Promise<Vulnerability[]> {
const groups = await this.fetchDependencyVulnerabilities(
config,
packageFiles
);
return groups.flatMap((group) => group.vulnerabilities);
}
private async fetchDependencyVulnerabilities(
config: RenovateConfig,
packageFiles: Record<string, PackageFile[]>
): Promise<DependencyVulnerabilities[]> {
const managers = Object.keys(packageFiles);
const allManagerJobs = managers.map((manager) =>
this.fetchManagerVulnerabilities(config, packageFiles, manager)
);
return (await Promise.all(allManagerJobs)).flat();
}
private async fetchManagerVulnerabilities(
config: RenovateConfig,
packageFiles: Record<string, PackageFile[]>,
manager: string
): Promise<DependencyVulnerabilities[]> {
const managerConfig = getManagerConfig(config, manager);
const queue = packageFiles[manager].map(
(pFile) => (): Promise<DependencyVulnerabilities[]> =>
this.fetchManagerPackageFileVulnerabilities(managerConfig, pFile)
);
logger.trace(
{ manager, queueLength: queue.length },
'fetchManagerVulnerabilities starting'
);
const result = (await p.all(queue)).flat();
logger.trace({ manager }, 'fetchManagerVulnerabilities finished');
return result;
}
private async fetchManagerPackageFileVulnerabilities(
managerConfig: RenovateConfig,
pFile: PackageFile
): Promise<DependencyVulnerabilities[]> {
const { packageFile } = pFile;
const packageFileConfig = mergeChildConfig(managerConfig, pFile);
const { manager } = packageFileConfig;
const queue = pFile.deps.map(
(dep) => (): Promise<DependencyVulnerabilities | null> =>
this.fetchDependencyVulnerability(packageFileConfig, dep)
);
logger.trace(
{ manager, packageFile, queueLength: queue.length },
'fetchManagerPackageFileVulnerabilities starting with concurrency'
);
const result = await p.all(queue);
logger.trace(
{ packageFile },
'fetchManagerPackageFileVulnerabilities finished'
);
return result.filter(is.truthy);
}
private async fetchDependencyVulnerability(
packageFileConfig: RenovateConfig & PackageFile,
dep: PackageDependency
): Promise<DependencyVulnerabilities | null> {
const ecosystem = Vulnerabilities.datasourceEcosystemMap[dep.datasource!];
if (!ecosystem) {
logger.trace(`Cannot map datasource ${dep.datasource!} to OSV ecosystem`);
return null;
}
let packageName = dep.packageName ?? dep.depName!;
if (ecosystem === 'PyPI') {
// https://peps.python.org/pep-0503/#normalized-names
packageName = packageName.toLowerCase().replace(regEx(/[_.-]+/g), '-');
}
try {
const osvVulnerabilities = await this.osvOffline?.getVulnerabilities(
ecosystem,
packageName
);
if (
is.nullOrUndefined(osvVulnerabilities) ||
is.emptyArray(osvVulnerabilities)
) {
logger.trace(
`No vulnerabilities found in OSV database for ${packageName}`
);
return null;
}
const depVersion =
dep.lockedVersion ?? dep.currentVersion ?? dep.currentValue!;
const versioning = dep.versioning ?? getDefaultVersioning(dep.datasource);
const versioningApi = getVersioning(versioning);
if (!versioningApi.isVersion(depVersion)) {
logger.debug(
`Skipping vulnerability lookup for package ${packageName} due to unsupported version ${depVersion}`
);
return null;
}
const vulnerabilities: Vulnerability[] = [];
for (const osvVulnerability of osvVulnerabilities) {
if (osvVulnerability.withdrawn) {
logger.trace(
`Skipping withdrawn vulnerability ${osvVulnerability.id}`
);
continue;
}
for (const affected of osvVulnerability.affected ?? []) {
const isVulnerable = this.isPackageVulnerable(
ecosystem,
packageName,
depVersion,
affected,
versioningApi
);
if (!isVulnerable) {
continue;
}
logger.debug(
`Vulnerability ${osvVulnerability.id} affects ${packageName} ${depVersion}`
);
const fixedVersion = this.getFixedVersion(
ecosystem,
depVersion,
affected,
versioningApi
);
vulnerabilities.push({
packageName,
vulnerability: osvVulnerability,
affected,
depVersion,
fixedVersion,
datasource: dep.datasource!,
packageFileConfig,
});
}
}
return { vulnerabilities, versioningApi };
} catch (err) {
logger.warn(
{ err },
`Error fetching vulnerability information for ${packageName}`
);
return null;
}
}
private sortByFixedVersion(
packageRules: PackageRule[],
versioningApi: VersioningApi
): void {
const versionsCleaned: Record<string, string> = {};
for (const rule of packageRules) {
const version = rule.allowedVersions as string;
versionsCleaned[version] = version.replace(regEx(/[=> ]+/g), '');
}
packageRules.sort((a, b) =>
versioningApi.sortVersions(
versionsCleaned[a.allowedVersions as string],
versionsCleaned[b.allowedVersions as string]
)
);
}
// https://ossf.github.io/osv-schema/#affectedrangesevents-fields
private sortEvents(
events: Osv.Event[],
versioningApi: VersioningApi
): Osv.Event[] {
const sortedCopy: Osv.Event[] = [];
let zeroEvent: Osv.Event | null = null;
for (const event of events) {
if (event.introduced === '0') {
zeroEvent = event;
} else if (versioningApi.isVersion(Object.values(event)[0])) {
sortedCopy.push(event);
} else {
logger.debug({ event }, 'Skipping OSV event with invalid version');
}
}
sortedCopy.sort((a, b) =>
// no pre-processing, as there are only very few values to sort
versioningApi.sortVersions(Object.values(a)[0], Object.values(b)[0])
);
if (zeroEvent) {
sortedCopy.unshift(zeroEvent);
}
return sortedCopy;
}
private isPackageAffected(
ecosystem: Ecosystem,
packageName: string,
affected: Osv.Affected
): boolean {
return (
affected.package?.name === packageName &&
affected.package?.ecosystem === ecosystem
);
}
private includedInVersions(
depVersion: string,
affected: Osv.Affected
): boolean {
return !!affected.versions?.includes(depVersion);
}
private includedInRanges(
depVersion: string,
affected: Osv.Affected,
versioningApi: VersioningApi
): boolean {
for (const range of affected.ranges ?? []) {
if (range.type === 'GIT') {
continue;
}
let vulnerable = false;
for (const event of this.sortEvents(range.events, versioningApi)) {
if (
is.nonEmptyString(event.introduced) &&
(event.introduced === '0' ||
this.isVersionGtOrEq(depVersion, event.introduced, versioningApi))
) {
vulnerable = true;
} else if (
is.nonEmptyString(event.fixed) &&
this.isVersionGtOrEq(depVersion, event.fixed, versioningApi)
) {
vulnerable = false;
} else if (
is.nonEmptyString(event.last_affected) &&
this.isVersionGt(depVersion, event.last_affected, versioningApi)
) {
vulnerable = false;
}
}
if (vulnerable) {
return true;
}
}
return false;
}
// https://ossf.github.io/osv-schema/#evaluation
private isPackageVulnerable(
ecosystem: Ecosystem,
packageName: string,
depVersion: string,
affected: Osv.Affected,
versioningApi: VersioningApi
): boolean {
return (
this.isPackageAffected(ecosystem, packageName, affected) &&
(this.includedInVersions(depVersion, affected) ||
this.includedInRanges(depVersion, affected, versioningApi))
);
}
private getFixedVersion(
ecosystem: Ecosystem,
depVersion: string,
affected: Osv.Affected,
versioningApi: VersioningApi
): string | null {
const fixedVersions: string[] = [];
const lastAffectedVersions: string[] = [];
for (const range of affected.ranges ?? []) {
if (range.type === 'GIT') {
continue;
}
for (const event of range.events) {
if (
is.nonEmptyString(event.fixed) &&
versioningApi.isVersion(event.fixed)
) {
fixedVersions.push(event.fixed);
} else if (
is.nonEmptyString(event.last_affected) &&
versioningApi.isVersion(event.last_affected)
) {
lastAffectedVersions.push(event.last_affected);
}
}
}
fixedVersions.sort((a, b) => versioningApi.sortVersions(a, b));
const fixedVersion = fixedVersions.find((version) =>
this.isVersionGt(version, depVersion, versioningApi)
);
if (fixedVersion) {
return ecosystem === 'PyPI' ? `==${fixedVersion}` : fixedVersion;
}
lastAffectedVersions.sort((a, b) => versioningApi.sortVersions(a, b));
const lastAffected = lastAffectedVersions.find((version) =>
this.isVersionGtOrEq(version, depVersion, versioningApi)
);
if (lastAffected) {
return `> ${lastAffected}`;
}
return null;
}
private isVersionGt(
version: string,
other: string,
versioningApi: VersioningApi
): boolean {
return (
versioningApi.isVersion(version) &&
versioningApi.isVersion(other) &&
versioningApi.isGreaterThan(version, other)
);
}
private isVersionGtOrEq(
version: string,
other: string,
versioningApi: VersioningApi
): boolean {
return (
versioningApi.isVersion(version) &&
versioningApi.isVersion(other) &&
(versioningApi.equals(version, other) ||
versioningApi.isGreaterThan(version, other))
);
}
private vulnerabilityToPackageRules(vul: Vulnerability): PackageRule | null {
const {
vulnerability,
affected,
packageName,
depVersion,
fixedVersion,
datasource,
packageFileConfig,
} = vul;
if (is.nullOrUndefined(fixedVersion)) {
logger.info(
`No fixed version available for vulnerability ${vulnerability.id} in ${packageName} ${depVersion}`
);
return null;
}
logger.debug(
`Setting allowed version ${fixedVersion} to fix vulnerability ${vulnerability.id} in ${packageName} ${depVersion}`
);
const severityDetails = this.extractSeverityDetails(
vulnerability,
affected
);
return {
matchDatasources: [datasource],
matchPackageNames: [packageName],
matchCurrentVersion: depVersion,
allowedVersions: fixedVersion,
isVulnerabilityAlert: true,
vulnerabilitySeverity: severityDetails.severityLevel,
prBodyNotes: this.generatePrBodyNotes(vulnerability, affected),
force: {
...packageFileConfig.vulnerabilityAlerts,
},
};
}
private evaluateCvssVector(vector: string): [string, string] {
try {
const parsedCvss: CvssScore = parseCvssVector(vector);
const severityLevel = parsedCvss.cvss3OverallSeverityText;
return [parsedCvss.baseScore.toFixed(1), severityLevel];
} catch (err) {
logger.debug(`Error processing CVSS vector ${vector}`);
}
return ['', ''];
}
private generatePrBodyNotes(
vulnerability: Osv.Vulnerability,
affected: Osv.Affected
): string[] {
let aliases = [vulnerability.id].concat(vulnerability.aliases ?? []).sort();
aliases = aliases.map((id) => {
if (id.startsWith('CVE-')) {
return `[${id}](https://nvd.nist.gov/vuln/detail/${id})`;
} else if (id.startsWith('GHSA-')) {
return `[${id}](https://github.com/advisories/${id})`;
} else if (id.startsWith('GO-')) {
return `[${id}](https://pkg.go.dev/vuln/${id})`;
} else if (id.startsWith('RUSTSEC-')) {
return `[${id}](https://rustsec.org/advisories/${id}.html)`;
}
return id;
});
let content = '\n\n---\n\n### ';
content += vulnerability.summary ? `${vulnerability.summary}\n` : '';
content += `${aliases.join(' / ')}\n`;
content += `\n<details>\n<summary>More information</summary>\n`;
const details = vulnerability.details?.replace(
regEx(/^#{1,4} /gm),
'##### '
);
content += `#### Details\n${details ?? 'No details.'}\n`;
content += '#### Severity\n';
const severityDetails = this.extractSeverityDetails(
vulnerability,
affected
);
if (severityDetails.cvssVector) {
content += `- CVSS Score: ${severityDetails.score}\n`;
content += `- Vector String: \`${severityDetails.cvssVector}\`\n`;
} else {
content += `${titleCase(severityDetails.severityLevel)}\n`;
}
content += `\n#### References\n${
vulnerability.references
?.map((ref) => {
return `- [${ref.url}](${ref.url})`;
})
.join('\n') ?? 'No references.'
}`;
let attribution = '';
if (vulnerability.id.startsWith('GHSA-')) {
attribution = ` and the [GitHub Advisory Database](https://github.com/github/advisory-database) ([CC-BY 4.0](https://github.com/github/advisory-database/blob/main/LICENSE.md))`;
} else if (vulnerability.id.startsWith('GO-')) {
attribution = ` and the [Go Vulnerability Database](https://github.com/golang/vulndb) ([CC-BY 4.0](https://github.com/golang/vulndb#license))`;
} else if (vulnerability.id.startsWith('PYSEC-')) {
attribution = ` and the [PyPI Advisory Database](https://github.com/pypa/advisory-database) ([CC-BY 4.0](https://github.com/pypa/advisory-database/blob/main/LICENSE))`;
} else if (vulnerability.id.startsWith('RUSTSEC-')) {
attribution = ` and the [Rust Advisory Database](https://github.com/RustSec/advisory-db) ([CC0 1.0](https://github.com/rustsec/advisory-db/blob/main/LICENSE.txt))`;
}
content += `\n\nThis data is provided by [OSV](https://osv.dev/vulnerability/${vulnerability.id})${attribution}.\n`;
content += `</details>`;
return [sanitizeMarkdown(content)];
}
private extractSeverityDetails(
vulnerability: Osv.Vulnerability,
affected: Osv.Affected
): SeverityDetails {
let severityLevel = 'UNKNOWN';
let score = 'Unknown';
const cvssVector =
vulnerability.severity?.find((e) => e.type === 'CVSS_V3')?.score ??
vulnerability.severity?.[0]?.score ??
(affected.database_specific?.cvss as string); // RUSTSEC
if (cvssVector) {
const [baseScore, severity] = this.evaluateCvssVector(cvssVector);
severityLevel = severity.toUpperCase();
score = baseScore
? `${baseScore} / 10 (${titleCase(severityLevel)})`
: 'Unknown';
} else if (
vulnerability.id.startsWith('GHSA-') &&
vulnerability.database_specific?.severity
) {
const severity = vulnerability.database_specific.severity as string;
severityLevel = severity.toUpperCase();
}
return {
cvssVector,
score,
severityLevel,
};
}
}