@trustify-da/trustify-da-javascript-client 0.3.0-ea.00529d4 → 0.3.0-ea.01107e6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +176 -2
- package/dist/package.json +6 -2
- package/dist/src/cli.js +48 -1
- package/dist/src/cyclone_dx_sbom.d.ts +13 -0
- package/dist/src/cyclone_dx_sbom.js +39 -1
- package/dist/src/index.d.ts +1 -0
- package/dist/src/index.js +8 -24
- package/dist/src/package_version.d.ts +8 -0
- package/dist/src/package_version.js +31 -0
- package/dist/src/providers/base_java.d.ts +53 -0
- package/dist/src/providers/base_java.js +64 -17
- package/dist/src/providers/base_javascript.d.ts +54 -0
- package/dist/src/providers/base_javascript.js +105 -3
- package/dist/src/providers/golang_gomodules.js +43 -2
- package/dist/src/providers/java_maven.d.ts +28 -3
- package/dist/src/providers/java_maven.js +96 -7
- package/dist/src/providers/javascript_bun.d.ts +12 -0
- package/dist/src/providers/javascript_bun.js +42 -1
- package/dist/src/providers/javascript_npm.d.ts +13 -0
- package/dist/src/providers/javascript_npm.js +40 -1
- package/dist/src/providers/javascript_pnpm.d.ts +13 -0
- package/dist/src/providers/javascript_pnpm.js +47 -1
- package/dist/src/providers/javascript_yarn.d.ts +12 -0
- package/dist/src/providers/javascript_yarn.js +75 -2
- package/dist/src/providers/processors/yarn_berry_processor.d.ts +5 -1
- package/dist/src/providers/processors/yarn_berry_processor.js +3 -2
- package/dist/src/providers/processors/yarn_classic_processor.d.ts +5 -1
- package/dist/src/providers/processors/yarn_classic_processor.js +8 -6
- package/dist/src/providers/python_controller.js +4 -1
- package/dist/src/providers/rust_cargo.js +74 -15
- package/dist/src/remediate.d.ts +21 -0
- package/dist/src/remediate.js +149 -0
- package/dist/src/remediation.d.ts +27 -3
- package/dist/src/remediation.js +135 -20
- package/dist/src/remediation_report.d.ts +40 -0
- package/dist/src/remediation_report.js +159 -0
- package/dist/src/sbom.d.ts +11 -0
- package/dist/src/sbom.js +10 -0
- package/dist/src/tools.js +24 -1
- package/package.json +7 -3
|
@@ -14,6 +14,13 @@ export const ecosystem_gradle = 'gradle';
|
|
|
14
14
|
export default class Base_Java {
|
|
15
15
|
DEP_REGEX = /(([-a-zA-Z0-9._]{2,})|[0-9])/g;
|
|
16
16
|
CONFLICT_REGEX = /.*omitted for conflict with (\S+)\)/;
|
|
17
|
+
/**
|
|
18
|
+
* Maven dependency scopes. Used to detect whether the trailing column of a
|
|
19
|
+
* dependency-tree line is a scope keyword — which in turn signals that an
|
|
20
|
+
* optional classifier column is present between the packaging and version.
|
|
21
|
+
* @type {string[]}
|
|
22
|
+
*/
|
|
23
|
+
static MAVEN_SCOPES = ['compile', 'provided', 'runtime', 'test', 'system', 'import'];
|
|
17
24
|
globalBinary;
|
|
18
25
|
localWrapper;
|
|
19
26
|
/**
|
|
@@ -82,31 +89,71 @@ export default class Base_Java {
|
|
|
82
89
|
}
|
|
83
90
|
return ((line.indexOf('-') - 1) / 3) + 1;
|
|
84
91
|
}
|
|
92
|
+
/**
|
|
93
|
+
* Parse a single dependency-tree line into its Maven coordinate parts.
|
|
94
|
+
*
|
|
95
|
+
* This is the single source of truth for interpreting a dependency-tree
|
|
96
|
+
* line. Both {@link parseDep} (used to build SBOM component PURLs) and the
|
|
97
|
+
* Maven hash-map builder rely on it, so the PURL key and the artifact file
|
|
98
|
+
* path can never drift from one another.
|
|
99
|
+
*
|
|
100
|
+
* A line has the shape `groupId:artifactId:packaging[:classifier]:version[:scope]`.
|
|
101
|
+
* The classifier column is only present when a sixth column holds a known
|
|
102
|
+
* Maven scope keyword; otherwise the fourth column is the version.
|
|
103
|
+
*
|
|
104
|
+
* @param {string} line - line to parse from a dependency tree
|
|
105
|
+
* @returns {{groupId: string, artifactId: string, packaging: string, classifier: (string|null), version: string, scope: (string|null), overridden: boolean}}
|
|
106
|
+
* Parsed coordinate. `version` is the resolved concrete version — when the
|
|
107
|
+
* line carries a conflict override the override version replaces it and
|
|
108
|
+
* `overridden` is set, mirroring how Maven records the winning version.
|
|
109
|
+
*/
|
|
110
|
+
parseCoordinate(line) {
|
|
111
|
+
const parts = line.split(':').map(part => part ? part.match(this.DEP_REGEX)?.[0] ?? '' : '');
|
|
112
|
+
const groupId = parts[0] ?? '';
|
|
113
|
+
const artifactId = parts[1] ?? '';
|
|
114
|
+
const packaging = parts[2] ?? '';
|
|
115
|
+
// A classifier column exists only when a sixth column holds a scope keyword.
|
|
116
|
+
const hasClassifier = parts.length >= 6 && Base_Java.MAVEN_SCOPES.includes(parts[5]);
|
|
117
|
+
const classifier = hasClassifier ? parts[3] : null;
|
|
118
|
+
let version = (hasClassifier ? parts[4] : parts[3]) ?? '';
|
|
119
|
+
const scope = hasClassifier ? parts[5] : (parts.length >= 5 ? parts[4] : null);
|
|
120
|
+
// A conflict override replaces the resolved version entirely.
|
|
121
|
+
const override = line.match(this.CONFLICT_REGEX);
|
|
122
|
+
const overridden = Boolean(override);
|
|
123
|
+
if (overridden) {
|
|
124
|
+
version = override[1];
|
|
125
|
+
}
|
|
126
|
+
return { groupId, artifactId, packaging, classifier, version, scope, overridden };
|
|
127
|
+
}
|
|
128
|
+
/**
|
|
129
|
+
* Build the canonical PackageURL for a parsed coordinate.
|
|
130
|
+
*
|
|
131
|
+
* The classifier is folded into the version component (e.g.
|
|
132
|
+
* `4.1.0-linux-x86_64`) except when the version came from a conflict
|
|
133
|
+
* override, in which case the override version stands alone — matching the
|
|
134
|
+
* historical behavior of {@link parseDep}.
|
|
135
|
+
*
|
|
136
|
+
* @param {{groupId: string, artifactId: string, classifier: (string|null), version: string, overridden: boolean}} coord
|
|
137
|
+
* @returns {PackageURL} The canonical packageURL for the coordinate
|
|
138
|
+
* @protected
|
|
139
|
+
*/
|
|
140
|
+
_coordinateToPurl(coord) {
|
|
141
|
+
const purlVersion = (coord.classifier && !coord.overridden)
|
|
142
|
+
? `${coord.version}-${coord.classifier}`
|
|
143
|
+
: coord.version;
|
|
144
|
+
return this.toPurl(coord.groupId, coord.artifactId, purlVersion);
|
|
145
|
+
}
|
|
85
146
|
/**
|
|
86
147
|
* Create a PackageURL from any line in a Text Graph dependency tree for a manifest path.
|
|
87
148
|
* @param {string} line - line to parse from a dependencies.txt file
|
|
88
149
|
* @returns {PackageURL} The parsed packageURL
|
|
89
150
|
*/
|
|
90
151
|
parseDep(line) {
|
|
91
|
-
|
|
92
|
-
if (
|
|
93
|
-
throw new Error(`Unable generate SBOM from dependency tree. Line: ${line} cannot be parsed into a PackageURL`);
|
|
94
|
-
}
|
|
95
|
-
let version;
|
|
96
|
-
if (match.length >= 5 && ['compile', 'provided', 'runtime'].includes(match[5])) {
|
|
97
|
-
version = `${match[4]}-${match[3]}`;
|
|
98
|
-
}
|
|
99
|
-
else {
|
|
100
|
-
version = match[3];
|
|
101
|
-
}
|
|
102
|
-
let override = line.match(this.CONFLICT_REGEX);
|
|
103
|
-
if (override) {
|
|
104
|
-
version = override[1];
|
|
105
|
-
}
|
|
106
|
-
if (match[0].trim() === '') {
|
|
152
|
+
const coord = this.parseCoordinate(line);
|
|
153
|
+
if (coord.groupId.trim() === '') {
|
|
107
154
|
throw new Error(`Artifact coordinates should have a non-empty group ID: ${line}`);
|
|
108
155
|
}
|
|
109
|
-
return this.
|
|
156
|
+
return this._coordinateToPurl(coord);
|
|
110
157
|
}
|
|
111
158
|
/**
|
|
112
159
|
* Returns a PackageUrl For Java maven dependencies
|
|
@@ -1,3 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Converts a Subresource Integrity (SRI) string to a CycloneDX hash object.
|
|
3
|
+
* SRI is formatted as `<alg>-<base64>` (e.g. `sha512-Ab3d...`). CycloneDX
|
|
4
|
+
* expects an uppercased algorithm label (e.g. `SHA-512`) and a hex-encoded
|
|
5
|
+
* digest. When the SRI string contains multiple space-separated hashes, only
|
|
6
|
+
* the first is used.
|
|
7
|
+
* @param {string} integrity - SRI string from a lock file
|
|
8
|
+
* @returns {{alg: string, content: string}|null} CycloneDX hash, or null when unparseable
|
|
9
|
+
*/
|
|
10
|
+
export function sriToHash(integrity: string): {
|
|
11
|
+
alg: string;
|
|
12
|
+
content: string;
|
|
13
|
+
} | null;
|
|
1
14
|
export type purlType = any;
|
|
2
15
|
/** @typedef {import('../provider').Provider} */
|
|
3
16
|
/** @typedef {import('../provider').Provided} Provided */
|
|
@@ -65,6 +78,47 @@ export default class Base_javascript {
|
|
|
65
78
|
* @protected
|
|
66
79
|
*/
|
|
67
80
|
protected _updateLockFileCmdArgs(): Array<string>;
|
|
81
|
+
/**
|
|
82
|
+
* Parses the provider's lock file into a hash map keyed by `name@version`.
|
|
83
|
+
* Subclasses override this (accepting the lock directory) to support their
|
|
84
|
+
* lock file format. The default implementation returns an empty map so
|
|
85
|
+
* providers without lock parsing (or without a lock file present) gracefully
|
|
86
|
+
* omit hashes.
|
|
87
|
+
* @returns {Map<string, Array<{alg: string, content: string}>>} Hash map
|
|
88
|
+
* @protected
|
|
89
|
+
*/
|
|
90
|
+
protected _parseLockFileHashes(): Map<string, Array<{
|
|
91
|
+
alg: string;
|
|
92
|
+
content: string;
|
|
93
|
+
}>>;
|
|
94
|
+
/**
|
|
95
|
+
* Loads lock-file hashes for the given directory into internal state.
|
|
96
|
+
* Parsing failures degrade gracefully to an empty map (no hashes emitted).
|
|
97
|
+
* @param {string} lockDir - Directory containing the lock file
|
|
98
|
+
* @protected
|
|
99
|
+
*/
|
|
100
|
+
protected _loadHashes(lockDir: string): void;
|
|
101
|
+
/**
|
|
102
|
+
* Looks up CycloneDX hashes for a package by name and resolved version.
|
|
103
|
+
* @param {string} name - The package name (including scope, e.g. `@hapi/joi`)
|
|
104
|
+
* @param {string} version - The resolved package version
|
|
105
|
+
* @returns {Array<{alg: string, content: string}>|undefined} Hashes, or undefined
|
|
106
|
+
* @protected
|
|
107
|
+
*/
|
|
108
|
+
protected _hashesFor(name: string, version: string): Array<{
|
|
109
|
+
alg: string;
|
|
110
|
+
content: string;
|
|
111
|
+
}> | undefined;
|
|
112
|
+
/**
|
|
113
|
+
* Looks up CycloneDX hashes for a package described by a PackageURL.
|
|
114
|
+
* @param {PackageURL} purl - The package URL
|
|
115
|
+
* @returns {Array<{alg: string, content: string}>|undefined} Hashes, or undefined
|
|
116
|
+
* @protected
|
|
117
|
+
*/
|
|
118
|
+
protected _hashesForPurl(purl: PackageURL): Array<{
|
|
119
|
+
alg: string;
|
|
120
|
+
content: string;
|
|
121
|
+
}> | undefined;
|
|
68
122
|
/**
|
|
69
123
|
* Checks if the provider supports the given manifest name
|
|
70
124
|
* @param {string} manifestName - The manifest name to check
|
|
@@ -12,6 +12,49 @@ import Manifest from './manifest.js';
|
|
|
12
12
|
* @type {string}
|
|
13
13
|
*/
|
|
14
14
|
export const purlType = 'npm';
|
|
15
|
+
/**
|
|
16
|
+
* Maps a Subresource Integrity (SRI) algorithm token to its CycloneDX label.
|
|
17
|
+
* @type {Object<string, string>}
|
|
18
|
+
*/
|
|
19
|
+
const SRI_ALG_LABELS = {
|
|
20
|
+
sha1: 'SHA-1',
|
|
21
|
+
sha256: 'SHA-256',
|
|
22
|
+
sha384: 'SHA-384',
|
|
23
|
+
sha512: 'SHA-512',
|
|
24
|
+
};
|
|
25
|
+
/**
|
|
26
|
+
* Converts a Subresource Integrity (SRI) string to a CycloneDX hash object.
|
|
27
|
+
* SRI is formatted as `<alg>-<base64>` (e.g. `sha512-Ab3d...`). CycloneDX
|
|
28
|
+
* expects an uppercased algorithm label (e.g. `SHA-512`) and a hex-encoded
|
|
29
|
+
* digest. When the SRI string contains multiple space-separated hashes, only
|
|
30
|
+
* the first is used.
|
|
31
|
+
* @param {string} integrity - SRI string from a lock file
|
|
32
|
+
* @returns {{alg: string, content: string}|null} CycloneDX hash, or null when unparseable
|
|
33
|
+
*/
|
|
34
|
+
export function sriToHash(integrity) {
|
|
35
|
+
if (typeof integrity !== 'string') {
|
|
36
|
+
return null;
|
|
37
|
+
}
|
|
38
|
+
const first = integrity.trim().split(/\s+/)[0];
|
|
39
|
+
if (!first) {
|
|
40
|
+
return null;
|
|
41
|
+
}
|
|
42
|
+
const dash = first.indexOf('-');
|
|
43
|
+
if (dash < 0) {
|
|
44
|
+
return null;
|
|
45
|
+
}
|
|
46
|
+
const alg = SRI_ALG_LABELS[first.slice(0, dash).toLowerCase()];
|
|
47
|
+
// Strip any SRI options (e.g. "?foo") that may follow the base64 payload
|
|
48
|
+
const base64 = first.slice(dash + 1).split('?')[0];
|
|
49
|
+
if (!alg || !base64) {
|
|
50
|
+
return null;
|
|
51
|
+
}
|
|
52
|
+
const content = Buffer.from(base64, 'base64').toString('hex');
|
|
53
|
+
if (!content) {
|
|
54
|
+
return null;
|
|
55
|
+
}
|
|
56
|
+
return { alg, content };
|
|
57
|
+
}
|
|
15
58
|
/**
|
|
16
59
|
* Base class for JavaScript package manager providers.
|
|
17
60
|
* This class provides common functionality for different JavaScript package managers
|
|
@@ -25,6 +68,11 @@ export default class Base_javascript {
|
|
|
25
68
|
#cmd;
|
|
26
69
|
/** @type {string} */
|
|
27
70
|
#ecosystem;
|
|
71
|
+
/**
|
|
72
|
+
* Lock-file hashes keyed by `name@version`.
|
|
73
|
+
* @type {Map<string, Array<{alg: string, content: string}>>}
|
|
74
|
+
*/
|
|
75
|
+
#hashes = new Map();
|
|
28
76
|
/**
|
|
29
77
|
* Sets up the provider with the manifest path and options
|
|
30
78
|
* @param {string} manifestPath - Path to the package.json manifest file
|
|
@@ -95,6 +143,58 @@ export default class Base_javascript {
|
|
|
95
143
|
_updateLockFileCmdArgs() {
|
|
96
144
|
throw new TypeError("_updateLockFileCmdArgs must be implemented");
|
|
97
145
|
}
|
|
146
|
+
/**
|
|
147
|
+
* Parses the provider's lock file into a hash map keyed by `name@version`.
|
|
148
|
+
* Subclasses override this (accepting the lock directory) to support their
|
|
149
|
+
* lock file format. The default implementation returns an empty map so
|
|
150
|
+
* providers without lock parsing (or without a lock file present) gracefully
|
|
151
|
+
* omit hashes.
|
|
152
|
+
* @returns {Map<string, Array<{alg: string, content: string}>>} Hash map
|
|
153
|
+
* @protected
|
|
154
|
+
*/
|
|
155
|
+
_parseLockFileHashes() {
|
|
156
|
+
return new Map();
|
|
157
|
+
}
|
|
158
|
+
/**
|
|
159
|
+
* Loads lock-file hashes for the given directory into internal state.
|
|
160
|
+
* Parsing failures degrade gracefully to an empty map (no hashes emitted).
|
|
161
|
+
* @param {string} lockDir - Directory containing the lock file
|
|
162
|
+
* @protected
|
|
163
|
+
*/
|
|
164
|
+
_loadHashes(lockDir) {
|
|
165
|
+
try {
|
|
166
|
+
this.#hashes = this._parseLockFileHashes(lockDir) || new Map();
|
|
167
|
+
}
|
|
168
|
+
catch (_) {
|
|
169
|
+
this.#hashes = new Map();
|
|
170
|
+
}
|
|
171
|
+
}
|
|
172
|
+
/**
|
|
173
|
+
* Looks up CycloneDX hashes for a package by name and resolved version.
|
|
174
|
+
* @param {string} name - The package name (including scope, e.g. `@hapi/joi`)
|
|
175
|
+
* @param {string} version - The resolved package version
|
|
176
|
+
* @returns {Array<{alg: string, content: string}>|undefined} Hashes, or undefined
|
|
177
|
+
* @protected
|
|
178
|
+
*/
|
|
179
|
+
_hashesFor(name, version) {
|
|
180
|
+
if (!name || !version) {
|
|
181
|
+
return undefined;
|
|
182
|
+
}
|
|
183
|
+
return this.#hashes.get(`${name}@${version}`);
|
|
184
|
+
}
|
|
185
|
+
/**
|
|
186
|
+
* Looks up CycloneDX hashes for a package described by a PackageURL.
|
|
187
|
+
* @param {PackageURL} purl - The package URL
|
|
188
|
+
* @returns {Array<{alg: string, content: string}>|undefined} Hashes, or undefined
|
|
189
|
+
* @protected
|
|
190
|
+
*/
|
|
191
|
+
_hashesForPurl(purl) {
|
|
192
|
+
if (!purl) {
|
|
193
|
+
return undefined;
|
|
194
|
+
}
|
|
195
|
+
const name = purl.namespace ? `${purl.namespace}/${purl.name}` : purl.name;
|
|
196
|
+
return this._hashesFor(name, purl.version);
|
|
197
|
+
}
|
|
98
198
|
/**
|
|
99
199
|
* Checks if the provider supports the given manifest name
|
|
100
200
|
* @param {string} manifestName - The manifest name to check
|
|
@@ -225,6 +325,7 @@ export default class Base_javascript {
|
|
|
225
325
|
const manifestDir = path.dirname(this.#manifest.manifestPath);
|
|
226
326
|
const cmdDir = this._findLockFileDir(manifestDir, opts) || manifestDir;
|
|
227
327
|
this._createLockFile(cmdDir);
|
|
328
|
+
this._loadHashes(cmdDir);
|
|
228
329
|
let output = this.#executeListCmd(includeTransitive, cmdDir);
|
|
229
330
|
output = this._parseDepTreeOutput(output);
|
|
230
331
|
return JSON.parse(output);
|
|
@@ -284,7 +385,7 @@ export default class Base_javascript {
|
|
|
284
385
|
const [name, artifact] = entry;
|
|
285
386
|
const target = toPurl(purlType, name, artifact.version);
|
|
286
387
|
const rootPurl = toPurl(purlType, this.#manifest.name, this.#manifest.version);
|
|
287
|
-
sbom.addDependency(rootPurl, target);
|
|
388
|
+
sbom.addDependency(rootPurl, target, undefined, this._hashesFor(name, artifact.version));
|
|
288
389
|
this.#addDependenciesOf(sbom, target, artifact);
|
|
289
390
|
});
|
|
290
391
|
}
|
|
@@ -302,7 +403,7 @@ export default class Base_javascript {
|
|
|
302
403
|
const [name, depArtifact] = entry;
|
|
303
404
|
if (depArtifact.version !== undefined) {
|
|
304
405
|
const target = toPurl(purlType, name, depArtifact.version);
|
|
305
|
-
sbom.addDependency(from, target);
|
|
406
|
+
sbom.addDependency(from, target, undefined, this._hashesFor(name, depArtifact.version));
|
|
306
407
|
this.#addDependenciesOf(sbom, target, depArtifact);
|
|
307
408
|
}
|
|
308
409
|
});
|
|
@@ -326,7 +427,8 @@ export default class Base_javascript {
|
|
|
326
427
|
.sort();
|
|
327
428
|
for (const key of sortedDepsKeys) {
|
|
328
429
|
const rootPurl = toPurlFromString(sbom.getRoot().purl);
|
|
329
|
-
|
|
430
|
+
const targetPurl = rootDeps.get(key);
|
|
431
|
+
sbom.addDependency(rootPurl, targetPurl, undefined, this._hashesForPurl(targetPurl));
|
|
330
432
|
}
|
|
331
433
|
this.#ensurePeerAndOptionalDeps(sbom);
|
|
332
434
|
sbom.filterIgnoredDeps(this.#manifest.ignored);
|
|
@@ -187,6 +187,36 @@ function performManifestVersionsCheck(rootElementName, goModGraphOutputRows, man
|
|
|
187
187
|
throw error;
|
|
188
188
|
}
|
|
189
189
|
}
|
|
190
|
+
/** Parses go.sum to build a hash map of module@version to CycloneDX hashes. */
|
|
191
|
+
function parseGoSumHashes(manifestDir) {
|
|
192
|
+
let goSumPath = path.join(manifestDir, 'go.sum');
|
|
193
|
+
if (!fs.existsSync(goSumPath)) {
|
|
194
|
+
return new Map();
|
|
195
|
+
}
|
|
196
|
+
let hashMap = new Map();
|
|
197
|
+
let content = fs.readFileSync(goSumPath, 'utf-8');
|
|
198
|
+
for (let line of content.split('\n')) {
|
|
199
|
+
line = line.trim();
|
|
200
|
+
if (!line) {
|
|
201
|
+
continue;
|
|
202
|
+
}
|
|
203
|
+
let parts = line.split(/\s+/);
|
|
204
|
+
if (parts.length < 3) {
|
|
205
|
+
continue;
|
|
206
|
+
}
|
|
207
|
+
let [mod, version, hash] = parts;
|
|
208
|
+
if (version.endsWith('/go.mod')) {
|
|
209
|
+
continue;
|
|
210
|
+
}
|
|
211
|
+
if (!hash.startsWith('h1:')) {
|
|
212
|
+
continue;
|
|
213
|
+
}
|
|
214
|
+
let base64Part = hash.slice(3);
|
|
215
|
+
let hexDigest = Buffer.from(base64Part, 'base64').toString('hex');
|
|
216
|
+
hashMap.set(`${mod}@${version}`, [{ alg: "SHA-256", content: hexDigest }]);
|
|
217
|
+
}
|
|
218
|
+
return hashMap;
|
|
219
|
+
}
|
|
190
220
|
/**
|
|
191
221
|
* Create SBOM json string for go Module.
|
|
192
222
|
* @param {string} manifest - path for go.mod
|
|
@@ -241,6 +271,7 @@ async function getSBOM(manifest, opts = {}, includeTransitive) {
|
|
|
241
271
|
if (matchManifestVersions === "true") {
|
|
242
272
|
performManifestVersionsCheck(root, rows, manifestContent, parser, requireQuery);
|
|
243
273
|
}
|
|
274
|
+
let goSumHashes = parseGoSumHashes(manifestDir);
|
|
244
275
|
const mainModule = toPurl(root, "@");
|
|
245
276
|
const license = readLicenseFromManifest(manifest);
|
|
246
277
|
sbom.addRoot(mainModule, license);
|
|
@@ -262,7 +293,7 @@ async function getSBOM(manifest, opts = {}, includeTransitive) {
|
|
|
262
293
|
if (getParentVertexFromEdge(row) === root && !directDepPaths.has(getPackageName(child))) {
|
|
263
294
|
return;
|
|
264
295
|
}
|
|
265
|
-
sbom.addDependency(source, target);
|
|
296
|
+
sbom.addDependency(source, target, undefined, goSumHashes.get(child));
|
|
266
297
|
});
|
|
267
298
|
// at the end, filter out all ignored dependencies including versions.
|
|
268
299
|
sbom.filterIgnoredDepsIncludingVersion(allIgnoredDeps);
|
|
@@ -275,12 +306,22 @@ async function getSBOM(manifest, opts = {}, includeTransitive) {
|
|
|
275
306
|
let target = toPurl(child, "@");
|
|
276
307
|
if (dependencyNotIgnored(ignoredDeps, target)) {
|
|
277
308
|
if (directDepPaths.has(getPackageName(child))) {
|
|
278
|
-
sbom.addDependency(mainModule, target);
|
|
309
|
+
sbom.addDependency(mainModule, target, undefined, goSumHashes.get(child));
|
|
279
310
|
}
|
|
280
311
|
}
|
|
281
312
|
});
|
|
282
313
|
enforceRemovingIgnoredDepsInCaseOfAutomaticVersionUpdate(ignoredDeps, sbom);
|
|
283
314
|
}
|
|
315
|
+
// Backfill hashes for components that were only seen as dependency sources
|
|
316
|
+
for (const comp of sbom.sbomModel.components) {
|
|
317
|
+
if (!comp.hashes && comp.purl) {
|
|
318
|
+
let key = decodeURIComponent(comp.purl.replace('pkg:golang/', ''));
|
|
319
|
+
let hashes = goSumHashes.get(key);
|
|
320
|
+
if (hashes) {
|
|
321
|
+
comp.hashes = hashes;
|
|
322
|
+
}
|
|
323
|
+
}
|
|
324
|
+
}
|
|
284
325
|
return sbom.getAsJsonString(opts);
|
|
285
326
|
}
|
|
286
327
|
/**
|
|
@@ -11,6 +11,10 @@ export function discoverMavenModules(workspaceRoot: string, opts?: object): Prom
|
|
|
11
11
|
/** @typedef {{name: string, version: string}} Package */
|
|
12
12
|
/** @typedef {{groupId: string, artifactId: string, version: string, scope: string, ignore: boolean}} Dependency */
|
|
13
13
|
export default class Java_maven extends Base_java {
|
|
14
|
+
/** @type {Object<string, string>} Packaging types that produce .jar files despite non-jar packaging names. */
|
|
15
|
+
static PACKAGING_TO_JAR: {
|
|
16
|
+
[x: string]: string;
|
|
17
|
+
};
|
|
14
18
|
constructor();
|
|
15
19
|
/**
|
|
16
20
|
* @param {string} manifestName - the subject manifest name-type
|
|
@@ -25,9 +29,9 @@ export default class Java_maven extends Base_java {
|
|
|
25
29
|
* Provide content and content type for maven-maven stack analysis.
|
|
26
30
|
* @param {string} manifest - the manifest path or name
|
|
27
31
|
* @param {{}} [opts={}] - optional various options to pass along the application
|
|
28
|
-
* @returns {Provided}
|
|
32
|
+
* @returns {Promise<Provided>}
|
|
29
33
|
*/
|
|
30
|
-
provideStack(manifest: string, opts?: {}): Provided
|
|
34
|
+
provideStack(manifest: string, opts?: {}): Promise<Provided>;
|
|
31
35
|
/**
|
|
32
36
|
* Provide content and content type for maven-maven component analysis.
|
|
33
37
|
* @param {string} manifest - path to the manifest file
|
|
@@ -42,13 +46,34 @@ export default class Java_maven extends Base_java {
|
|
|
42
46
|
*/
|
|
43
47
|
readLicenseFromManifest(manifestPath: string): string | null;
|
|
44
48
|
/**
|
|
49
|
+
* Build a Map of PURL string → CycloneDX hash entries by reading artifact files from the local Maven repository.
|
|
50
|
+
*
|
|
51
|
+
* Both the artifact file path and the hash-map key are derived from the
|
|
52
|
+
* shared {@link Base_java#parseCoordinate} parser: the file path uses the
|
|
53
|
+
* resolved version and raw classifier, while the key uses the same canonical
|
|
54
|
+
* PURL builder as {@link Base_java#parseDep}. This guarantees the key always
|
|
55
|
+
* matches the PURL that {@link Base_java#parseDependencyTree} looks up.
|
|
45
56
|
*
|
|
57
|
+
* @param {string} depTreeText Raw dependency tree text from mvn dependency:tree
|
|
58
|
+
* @param {{}} [opts={}] Options bag (may contain TRUSTIFY_DA_MVN_REPO)
|
|
59
|
+
* @returns {Promise<Map<string, Array<{alg: string, content: string}>>>}
|
|
60
|
+
*/
|
|
61
|
+
_buildMavenHashMap(depTreeText: string, opts?: {}): Promise<Map<string, Array<{
|
|
62
|
+
alg: string;
|
|
63
|
+
content: string;
|
|
64
|
+
}>>>;
|
|
65
|
+
/**
|
|
46
66
|
* @param {String} textGraphList Text graph String of the manifest
|
|
47
67
|
* @param {[String]} ignoredDeps List of ignored dependencies to be omitted from sbom
|
|
68
|
+
* @param {{}} opts Options
|
|
48
69
|
* @param {String} manifestPath Path to the pom.xml manifest
|
|
70
|
+
* @param {Map<string, Array<{alg: string, content: string}>>} [hashMap] PURL→hashes map
|
|
49
71
|
* @return {String} formatted sbom Json String with all dependencies
|
|
50
72
|
*/
|
|
51
|
-
createSbomFileFromTextFormat(textGraphList: string, ignoredDeps: [string], opts:
|
|
73
|
+
createSbomFileFromTextFormat(textGraphList: string, ignoredDeps: [string], opts: {}, manifestPath: string, hashMap?: Map<string, Array<{
|
|
74
|
+
alg: string;
|
|
75
|
+
content: string;
|
|
76
|
+
}>>): string;
|
|
52
77
|
#private;
|
|
53
78
|
}
|
|
54
79
|
export type Java_maven = any;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import crypto from 'node:crypto';
|
|
1
2
|
import fs from 'node:fs';
|
|
2
3
|
import os from 'node:os';
|
|
3
4
|
import path from 'node:path';
|
|
@@ -31,12 +32,12 @@ export default class Java_maven extends Base_java {
|
|
|
31
32
|
* Provide content and content type for maven-maven stack analysis.
|
|
32
33
|
* @param {string} manifest - the manifest path or name
|
|
33
34
|
* @param {{}} [opts={}] - optional various options to pass along the application
|
|
34
|
-
* @returns {Provided}
|
|
35
|
+
* @returns {Promise<Provided>}
|
|
35
36
|
*/
|
|
36
|
-
provideStack(manifest, opts = {}) {
|
|
37
|
+
async provideStack(manifest, opts = {}) {
|
|
37
38
|
return {
|
|
38
39
|
ecosystem: ecosystem_maven,
|
|
39
|
-
content: this.#createSbomStackAnalysis(manifest, opts),
|
|
40
|
+
content: await this.#createSbomStackAnalysis(manifest, opts),
|
|
40
41
|
contentType: 'application/vnd.cyclonedx+json'
|
|
41
42
|
};
|
|
42
43
|
}
|
|
@@ -81,10 +82,10 @@ export default class Java_maven extends Base_java {
|
|
|
81
82
|
* Create a Dot Graph dependency tree for a manifest path.
|
|
82
83
|
* @param {string} manifest - path for pom.xml
|
|
83
84
|
* @param {{}} [opts={}] - optional various options to pass along the application
|
|
84
|
-
* @returns {string} the Dot Graph content
|
|
85
|
+
* @returns {Promise<string>} the Dot Graph content
|
|
85
86
|
* @private
|
|
86
87
|
*/
|
|
87
|
-
#createSbomStackAnalysis(manifest, opts = {}) {
|
|
88
|
+
async #createSbomStackAnalysis(manifest, opts = {}) {
|
|
88
89
|
const manifestDir = path.dirname(manifest);
|
|
89
90
|
const mvn = this.selectToolBinary(manifest, opts);
|
|
90
91
|
const mvnArgs = JSON.parse(getCustom('TRUSTIFY_DA_MVN_ARGS', '[]', opts));
|
|
@@ -131,20 +132,105 @@ export default class Java_maven extends Base_java {
|
|
|
131
132
|
if (process.env["TRUSTIFY_DA_DEBUG"] === "true") {
|
|
132
133
|
console.error("Dependency tree that will be used as input for creating the BOM =>" + EOL + EOL + content.toString());
|
|
133
134
|
}
|
|
134
|
-
|
|
135
|
+
const depTreeContent = content.toString();
|
|
136
|
+
const hashMap = await this._buildMavenHashMap(depTreeContent, opts);
|
|
137
|
+
let sbom = this.createSbomFileFromTextFormat(depTreeContent, ignoredDeps, opts, manifest, hashMap);
|
|
135
138
|
// delete temp file and directory
|
|
136
139
|
fs.rmSync(tmpDir, { recursive: true, force: true });
|
|
137
140
|
// return dependency graph as string
|
|
138
141
|
return sbom;
|
|
139
142
|
}
|
|
143
|
+
/** @type {Object<string, string>} Packaging types that produce .jar files despite non-jar packaging names. */
|
|
144
|
+
static PACKAGING_TO_JAR = { 'bundle': 'jar', 'eclipse-plugin': 'jar' };
|
|
140
145
|
/**
|
|
146
|
+
* Build a Map of PURL string → CycloneDX hash entries by reading artifact files from the local Maven repository.
|
|
147
|
+
*
|
|
148
|
+
* Both the artifact file path and the hash-map key are derived from the
|
|
149
|
+
* shared {@link Base_java#parseCoordinate} parser: the file path uses the
|
|
150
|
+
* resolved version and raw classifier, while the key uses the same canonical
|
|
151
|
+
* PURL builder as {@link Base_java#parseDep}. This guarantees the key always
|
|
152
|
+
* matches the PURL that {@link Base_java#parseDependencyTree} looks up.
|
|
141
153
|
*
|
|
154
|
+
* @param {string} depTreeText Raw dependency tree text from mvn dependency:tree
|
|
155
|
+
* @param {{}} [opts={}] Options bag (may contain TRUSTIFY_DA_MVN_REPO)
|
|
156
|
+
* @returns {Promise<Map<string, Array<{alg: string, content: string}>>>}
|
|
157
|
+
*/
|
|
158
|
+
async _buildMavenHashMap(depTreeText, opts = {}) {
|
|
159
|
+
const m2Repo = getCustom('TRUSTIFY_DA_MVN_REPO', path.join(os.homedir(), '.m2', 'repository'), opts);
|
|
160
|
+
const hashMap = new Map();
|
|
161
|
+
const lines = depTreeText.split(EOL);
|
|
162
|
+
// Track hash coverage so an incomplete .m2 cache (e.g. ephemeral CI
|
|
163
|
+
// containers or resolve-only phases) surfaces a summary warning instead
|
|
164
|
+
// of silently producing an SBOM with missing hashes.
|
|
165
|
+
let attempted = 0;
|
|
166
|
+
let missed = 0;
|
|
167
|
+
for (const rawLine of lines) {
|
|
168
|
+
const trimmed = rawLine.trim();
|
|
169
|
+
// Strip leading tree-drawing characters (e.g. "\-", "+-", "|") so the
|
|
170
|
+
// parenthesized-line check sees the coordinate itself. Omitted
|
|
171
|
+
// duplicate/conflict lines start with these characters after trim(),
|
|
172
|
+
// then an opening "(" — without stripping, the "(" check never fires.
|
|
173
|
+
const cleaned = trimmed.replace(/^[|+\\\- ]+/, '');
|
|
174
|
+
if (!cleaned || cleaned.startsWith('(')) {
|
|
175
|
+
continue;
|
|
176
|
+
}
|
|
177
|
+
const coord = this.parseCoordinate(rawLine);
|
|
178
|
+
if (!coord.groupId || !coord.artifactId || !coord.packaging) {
|
|
179
|
+
continue;
|
|
180
|
+
}
|
|
181
|
+
if (coord.packaging === 'pom') {
|
|
182
|
+
continue;
|
|
183
|
+
}
|
|
184
|
+
// Key by the exact PURL parseDep() produces, so the lookup in
|
|
185
|
+
// parseDependencyTree (hashMap.get(to.toString())) always hits.
|
|
186
|
+
const purl = this._coordinateToPurl(coord).toString();
|
|
187
|
+
// The same artifact recurs across dependency-tree branches — notably in
|
|
188
|
+
// multi-module reactor builds, where every module re-lists shared deps.
|
|
189
|
+
// The digest is deterministic per PURL, so skip the redundant file read
|
|
190
|
+
// and SHA-256 computation once this PURL is already hashed.
|
|
191
|
+
if (hashMap.has(purl)) {
|
|
192
|
+
continue;
|
|
193
|
+
}
|
|
194
|
+
const ext = Java_maven.PACKAGING_TO_JAR[coord.packaging] || coord.packaging;
|
|
195
|
+
const groupPath = coord.groupId.replaceAll('.', path.sep);
|
|
196
|
+
const fileName = coord.classifier
|
|
197
|
+
? `${coord.artifactId}-${coord.version}-${coord.classifier}.${ext}`
|
|
198
|
+
: `${coord.artifactId}-${coord.version}.${ext}`;
|
|
199
|
+
const artifactPath = path.join(m2Repo, groupPath, coord.artifactId, coord.version, fileName);
|
|
200
|
+
attempted++;
|
|
201
|
+
try {
|
|
202
|
+
const stream = fs.createReadStream(artifactPath);
|
|
203
|
+
const hash = crypto.createHash('sha256');
|
|
204
|
+
for await (const chunk of stream) {
|
|
205
|
+
hash.update(chunk);
|
|
206
|
+
}
|
|
207
|
+
const digest = hash.digest('hex');
|
|
208
|
+
hashMap.set(purl, [{ alg: 'SHA-256', content: digest }]);
|
|
209
|
+
}
|
|
210
|
+
catch {
|
|
211
|
+
missed++;
|
|
212
|
+
if (process.env['TRUSTIFY_DA_DEBUG'] === 'true') {
|
|
213
|
+
console.error(`Maven hash: artifact not found at ${artifactPath}, omitting hash`);
|
|
214
|
+
}
|
|
215
|
+
}
|
|
216
|
+
}
|
|
217
|
+
// Mirror the pip provider's convention (python_controller.js): surface an
|
|
218
|
+
// unconditional warning when hashes could not be computed, so incomplete
|
|
219
|
+
// hash coverage is visible even without TRUSTIFY_DA_DEBUG.
|
|
220
|
+
if (missed > 0) {
|
|
221
|
+
console.warn(`Maven hash: ${missed} of ${attempted} artifacts could not be read from the local .m2 cache; SBOM will be generated without hashes for those components.`);
|
|
222
|
+
}
|
|
223
|
+
return hashMap;
|
|
224
|
+
}
|
|
225
|
+
/**
|
|
142
226
|
* @param {String} textGraphList Text graph String of the manifest
|
|
143
227
|
* @param {[String]} ignoredDeps List of ignored dependencies to be omitted from sbom
|
|
228
|
+
* @param {{}} opts Options
|
|
144
229
|
* @param {String} manifestPath Path to the pom.xml manifest
|
|
230
|
+
* @param {Map<string, Array<{alg: string, content: string}>>} [hashMap] PURL→hashes map
|
|
145
231
|
* @return {String} formatted sbom Json String with all dependencies
|
|
146
232
|
*/
|
|
147
|
-
createSbomFileFromTextFormat(textGraphList, ignoredDeps, opts, manifestPath) {
|
|
233
|
+
createSbomFileFromTextFormat(textGraphList, ignoredDeps, opts, manifestPath, hashMap) {
|
|
148
234
|
let lines = textGraphList.split(EOL);
|
|
149
235
|
// get root component
|
|
150
236
|
let root = lines[0];
|
|
@@ -153,6 +239,9 @@ export default class Java_maven extends Base_java {
|
|
|
153
239
|
let sbom = new Sbom();
|
|
154
240
|
sbom.addRoot(rootPurl, license);
|
|
155
241
|
this.parseDependencyTree(root, 0, lines.slice(1), sbom);
|
|
242
|
+
// Attach Maven artifact hashes as a post-processing step, keeping this
|
|
243
|
+
// Maven-specific concern out of the shared dependency-tree parser.
|
|
244
|
+
sbom.attachHashes(hashMap);
|
|
156
245
|
return sbom.filterIgnoredDeps(ignoredDeps).getAsJsonString(opts);
|
|
157
246
|
}
|
|
158
247
|
/**
|
|
@@ -1,4 +1,16 @@
|
|
|
1
1
|
export default class Javascript_bun extends Base_javascript {
|
|
2
|
+
/**
|
|
3
|
+
* Parses `bun.lock` into a hash map keyed by `name@version`. Each entry in
|
|
4
|
+
* the `packages` section is an array whose first element is the resolved id
|
|
5
|
+
* (`name@version`) and whose fourth element is the SRI integrity string.
|
|
6
|
+
* @param {string} lockDir - Directory containing bun.lock
|
|
7
|
+
* @returns {Map<string, Array<{alg: string, content: string}>>} Hash map
|
|
8
|
+
* @protected
|
|
9
|
+
*/
|
|
10
|
+
protected _parseLockFileHashes(lockDir: string): Map<string, Array<{
|
|
11
|
+
alg: string;
|
|
12
|
+
content: string;
|
|
13
|
+
}>>;
|
|
2
14
|
_listCmdArgs(): void;
|
|
3
15
|
_buildDependencyTree(includeTransitive: any, opts?: {}): {
|
|
4
16
|
name: any;
|