@trustify-da/trustify-da-javascript-client 0.3.0-ea.bbe2094 → 0.3.0-ea.bdaadb2
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 +177 -3
- package/dist/package.json +29 -22
- package/dist/src/analysis.d.ts +14 -7
- package/dist/src/analysis.js +29 -13
- package/dist/src/cli.js +106 -2
- package/dist/src/cyclone_dx_sbom.d.ts +13 -0
- package/dist/src/cyclone_dx_sbom.js +50 -4
- package/dist/src/index.d.ts +14 -10
- package/dist/src/index.js +15 -26
- package/dist/src/license/index.d.ts +3 -3
- package/dist/src/license/index.js +4 -1
- package/dist/src/license/license_utils.js +4 -1
- package/dist/src/license/licenses_api.d.ts +2 -2
- package/dist/src/oci_image/images.d.ts +1 -1
- package/dist/src/oci_image/images.js +15 -1
- package/dist/src/oci_image/utils.d.ts +5 -5
- package/dist/src/package_version.d.ts +8 -0
- package/dist/src/package_version.js +31 -0
- package/dist/src/provider.d.ts +4 -3
- package/dist/src/provider.js +4 -2
- package/dist/src/providers/base_java.d.ts +67 -3
- package/dist/src/providers/base_java.js +80 -23
- package/dist/src/providers/base_javascript.d.ts +68 -9
- package/dist/src/providers/base_javascript.js +112 -3
- package/dist/src/providers/base_pyproject.d.ts +10 -5
- package/dist/src/providers/base_pyproject.js +7 -0
- package/dist/src/providers/containerfile_parser.d.ts +5 -0
- package/dist/src/providers/containerfile_parser.js +20 -0
- package/dist/src/providers/golang_gomodules.d.ts +2 -1
- package/dist/src/providers/golang_gomodules.js +44 -3
- package/dist/src/providers/java_gradle.d.ts +48 -0
- package/dist/src/providers/java_gradle.js +194 -15
- package/dist/src/providers/java_gradle_groovy.d.ts +1 -1
- package/dist/src/providers/java_gradle_kotlin.d.ts +1 -1
- package/dist/src/providers/java_maven.d.ts +30 -5
- package/dist/src/providers/java_maven.js +168 -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 +19 -1
- 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/oci_dockerfile.d.ts +51 -0
- package/dist/src/providers/oci_dockerfile.js +177 -0
- package/dist/src/providers/processors/yarn_berry_processor.d.ts +6 -2
- package/dist/src/providers/processors/yarn_berry_processor.js +3 -2
- package/dist/src/providers/processors/yarn_classic_processor.d.ts +6 -2
- package/dist/src/providers/processors/yarn_classic_processor.js +8 -6
- package/dist/src/providers/python_controller.js +61 -4
- package/dist/src/providers/python_pip.d.ts +1 -0
- package/dist/src/providers/python_pip.js +1 -1
- package/dist/src/providers/python_poetry.d.ts +31 -8
- package/dist/src/providers/python_poetry.js +62 -14
- package/dist/src/providers/python_uv.d.ts +5 -14
- package/dist/src/providers/python_uv.js +44 -2
- package/dist/src/providers/rust_cargo.d.ts +6 -2
- package/dist/src/providers/rust_cargo.js +101 -33
- package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
- package/dist/src/remediate.d.ts +21 -0
- package/dist/src/remediate.js +149 -0
- package/dist/src/remediation.d.ts +57 -0
- package/dist/src/remediation.js +436 -0
- 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.d.ts +2 -2
- package/dist/src/tools.js +24 -1
- package/dist/src/updaters/maven_updater.d.ts +26 -0
- package/dist/src/updaters/maven_updater.js +322 -0
- package/dist/src/updaters/toml_updater.d.ts +33 -0
- package/dist/src/updaters/toml_updater.js +244 -0
- package/package.json +30 -23
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { readFile } from 'node:fs/promises';
|
|
2
|
+
import { Language, Parser, Query } from 'web-tree-sitter';
|
|
3
|
+
const wasmUrl = new URL('./tree-sitter-containerfile.wasm', import.meta.url);
|
|
4
|
+
async function init() {
|
|
5
|
+
await Parser.init();
|
|
6
|
+
const wasmBytes = new Uint8Array(await readFile(wasmUrl));
|
|
7
|
+
return await Language.load(wasmBytes);
|
|
8
|
+
}
|
|
9
|
+
export async function getParser() {
|
|
10
|
+
const language = await init();
|
|
11
|
+
return new Parser().setLanguage(language);
|
|
12
|
+
}
|
|
13
|
+
export async function getFromQuery() {
|
|
14
|
+
const language = await init();
|
|
15
|
+
return new Query(language, '(from_instruction (image_spec) @image)');
|
|
16
|
+
}
|
|
17
|
+
export async function getArgQuery() {
|
|
18
|
+
const language = await init();
|
|
19
|
+
return new Query(language, '(arg_instruction (arg_pair name: (_) @name default: (_) @default))');
|
|
20
|
+
}
|
|
@@ -13,9 +13,10 @@ declare namespace _default {
|
|
|
13
13
|
export { provideComponent };
|
|
14
14
|
export { provideStack };
|
|
15
15
|
export { readLicenseFromManifest };
|
|
16
|
+
export function packageManagerName(): string;
|
|
16
17
|
}
|
|
17
18
|
export default _default;
|
|
18
|
-
export type Provided =
|
|
19
|
+
export type Provided = any;
|
|
19
20
|
export type Package = {
|
|
20
21
|
name: string;
|
|
21
22
|
version: string;
|
|
@@ -6,7 +6,7 @@ import Sbom from '../sbom.js';
|
|
|
6
6
|
import { getCustom, getCustomPath, invokeCommand } from "../tools.js";
|
|
7
7
|
import { filterManifestPathsByDiscoveryIgnore, resolveWorkspaceDiscoveryIgnore } from '../workspace.js';
|
|
8
8
|
import { getParser, getRequireQuery } from './gomod_parser.js';
|
|
9
|
-
export default { isSupported, validateLockFile, provideComponent, provideStack, readLicenseFromManifest };
|
|
9
|
+
export default { isSupported, validateLockFile, provideComponent, provideStack, readLicenseFromManifest, packageManagerName() { return 'go'; } };
|
|
10
10
|
/** @typedef {import('../provider').Provider} */
|
|
11
11
|
/** @typedef {import('../provider').Provided} Provided */
|
|
12
12
|
/** @typedef {{name: string, version: string}} Package */
|
|
@@ -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
|
/**
|
|
@@ -17,6 +17,30 @@ export function parseGradleInitScriptOutput(raw: string): {
|
|
|
17
17
|
path: string;
|
|
18
18
|
dir: string;
|
|
19
19
|
}[];
|
|
20
|
+
/**
|
|
21
|
+
* Parse the structured output from the Gradle hash init script.
|
|
22
|
+
* Each recognised line has the form `::DA_HASH::group:name:version::<file-path>`.
|
|
23
|
+
*
|
|
24
|
+
* @param {string} raw - Raw stdout from gradle
|
|
25
|
+
* @returns {{ id: string, file: string }[]} component id (`group:name:version`) and absolute artifact file path
|
|
26
|
+
*/
|
|
27
|
+
export function parseGradleHashScriptOutput(raw: string): {
|
|
28
|
+
id: string;
|
|
29
|
+
file: string;
|
|
30
|
+
}[];
|
|
31
|
+
/**
|
|
32
|
+
* Parse a Gradle module component id (`group:name:version`) into its coordinate
|
|
33
|
+
* parts. The caller builds the canonical PURL key from these parts using the same
|
|
34
|
+
* builder {@link parseDep} uses, so the stored key and the lookup key cannot drift.
|
|
35
|
+
*
|
|
36
|
+
* @param {string} id - the Gradle component id
|
|
37
|
+
* @returns {{group: string, name: string, version: string}|null} the parsed coordinate, or null when the id is malformed
|
|
38
|
+
*/
|
|
39
|
+
export function parseComponentId(id: string): {
|
|
40
|
+
group: string;
|
|
41
|
+
name: string;
|
|
42
|
+
version: string;
|
|
43
|
+
} | null;
|
|
20
44
|
/**
|
|
21
45
|
* This class provides common functionality for Groovy and Kotlin DSL files.
|
|
22
46
|
*/
|
|
@@ -54,6 +78,30 @@ export default class Java_gradle extends Base_java {
|
|
|
54
78
|
* @returns {Provided}
|
|
55
79
|
*/
|
|
56
80
|
provideComponent(manifest: string, opts?: {}): Provided;
|
|
81
|
+
/**
|
|
82
|
+
* Compute SHA-256 hashes for the resolved artifacts of a Gradle manifest.
|
|
83
|
+
*
|
|
84
|
+
* Rather than scanning the local Gradle cache, this asks Gradle itself for
|
|
85
|
+
* the resolved artifact files via an init script (mirroring the pattern used
|
|
86
|
+
* by {@link discoverGradleSubprojects}), then hashes each file with the
|
|
87
|
+
* Node.js `crypto` module. The result is keyed by the canonical PURL string
|
|
88
|
+
* built via {@link Base_java#toPurl} — the same builder {@link parseDep} uses
|
|
89
|
+
* for the lookup — so the stored key and the lookup key cannot drift.
|
|
90
|
+
*
|
|
91
|
+
* Degrades gracefully: if Gradle cannot be invoked, the init script fails, or
|
|
92
|
+
* an artifact has no readable file (e.g. BOM/`platform()` dependencies), the
|
|
93
|
+
* hash for that component is omitted rather than throwing. A warning is emitted
|
|
94
|
+
* on every degradation path so incomplete hash coverage is visible even without
|
|
95
|
+
* `TRUSTIFY_DA_DEBUG` (mirroring the pip/cargo providers).
|
|
96
|
+
*
|
|
97
|
+
* @param {string} manifest - path to build.gradle[.kts]
|
|
98
|
+
* @param {{}} [opts={}] - optional various options to pass along the application
|
|
99
|
+
* @returns {Promise<Map<string, Array<{alg: string, content: string}>>>} map of canonical PURL string to CycloneDX hashes
|
|
100
|
+
*/
|
|
101
|
+
parseGradleHashes(manifest: string, opts?: {}): Promise<Map<string, Array<{
|
|
102
|
+
alg: string;
|
|
103
|
+
content: string;
|
|
104
|
+
}>>>;
|
|
57
105
|
#private;
|
|
58
106
|
}
|
|
59
107
|
export type Provided = import("../provider.js").Provided;
|
|
@@ -67,10 +67,10 @@ export default class Java_gradle extends Base_java {
|
|
|
67
67
|
* @param {{}} [opts={}] - optional various options to pass along the application
|
|
68
68
|
* @returns {Provided}
|
|
69
69
|
*/
|
|
70
|
-
provideStack(manifest, opts = {}) {
|
|
70
|
+
async provideStack(manifest, opts = {}) {
|
|
71
71
|
return {
|
|
72
72
|
ecosystem: ecosystem_gradle,
|
|
73
|
-
content: this.#createSbomStackAnalysis(manifest, opts),
|
|
73
|
+
content: await this.#createSbomStackAnalysis(manifest, opts),
|
|
74
74
|
contentType: 'application/vnd.cyclonedx+json'
|
|
75
75
|
};
|
|
76
76
|
}
|
|
@@ -80,10 +80,10 @@ export default class Java_gradle extends Base_java {
|
|
|
80
80
|
* @param {{}} [opts={}] - optional various options to pass along the application
|
|
81
81
|
* @returns {Provided}
|
|
82
82
|
*/
|
|
83
|
-
provideComponent(manifest, opts = {}) {
|
|
83
|
+
async provideComponent(manifest, opts = {}) {
|
|
84
84
|
return {
|
|
85
85
|
ecosystem: ecosystem_gradle,
|
|
86
|
-
content: this.#getSbomForComponentAnalysis(manifest, opts),
|
|
86
|
+
content: await this.#getSbomForComponentAnalysis(manifest, opts),
|
|
87
87
|
contentType: 'application/vnd.cyclonedx+json'
|
|
88
88
|
};
|
|
89
89
|
}
|
|
@@ -133,9 +133,10 @@ export default class Java_gradle extends Base_java {
|
|
|
133
133
|
* @param {Sbom} sbom - the SBOM object to add dependencies to
|
|
134
134
|
* @param {Set} processedDeps - set of already processed dependencies
|
|
135
135
|
* @param {string} scope - the dependency scope
|
|
136
|
+
* @param {Map<string, Array<{alg: string, content: string}>>} [hashMap] - map of "group:name@version" to CycloneDX hashes
|
|
136
137
|
* @private
|
|
137
138
|
*/
|
|
138
|
-
#processDependencyTree(config, parentPurl, sbom, processedDeps, scope) {
|
|
139
|
+
#processDependencyTree(config, parentPurl, sbom, processedDeps, scope, hashMap) {
|
|
139
140
|
const processedLines = this.#prepareLinesForParsingDependencyTree(config);
|
|
140
141
|
let parentStack = [parentPurl];
|
|
141
142
|
for (const { line, depth } of processedLines) {
|
|
@@ -153,7 +154,7 @@ export default class Java_gradle extends Base_java {
|
|
|
153
154
|
// Add dependency to SBOM if not already processed
|
|
154
155
|
if (!processedDeps.has(depKey)) {
|
|
155
156
|
processedDeps.add(depKey);
|
|
156
|
-
sbom.addDependency(currentParent, purl, scope);
|
|
157
|
+
sbom.addDependency(currentParent, purl, scope, hashMap?.get(purl.toString()));
|
|
157
158
|
}
|
|
158
159
|
parentStack.push(purl);
|
|
159
160
|
}
|
|
@@ -166,7 +167,7 @@ export default class Java_gradle extends Base_java {
|
|
|
166
167
|
* @returns {string} the Dot Graph content
|
|
167
168
|
* @private
|
|
168
169
|
*/
|
|
169
|
-
#buildSbom(content, properties, manifestPath, opts = {}) {
|
|
170
|
+
#buildSbom(content, properties, manifestPath, opts = {}, hashMap) {
|
|
170
171
|
let sbom = new Sbom();
|
|
171
172
|
let root = `${properties.group}:${properties[ROOT_PROJECT_KEY_NAME].match(/Root project '(.+)'/)[1]}:jar:${properties.version}`;
|
|
172
173
|
let rootPurl = this.parseDep(root);
|
|
@@ -175,8 +176,8 @@ export default class Java_gradle extends Base_java {
|
|
|
175
176
|
let ignoredDeps = this.#getIgnoredDeps(manifestPath);
|
|
176
177
|
const [runtimeConfig, compileConfig] = this.#extractConfigurations(content);
|
|
177
178
|
const processedDeps = new Set();
|
|
178
|
-
this.#processDependencyTree(runtimeConfig, rootPurl, sbom, processedDeps, 'required');
|
|
179
|
-
this.#processDependencyTree(compileConfig, rootPurl, sbom, processedDeps, 'optional');
|
|
179
|
+
this.#processDependencyTree(runtimeConfig, rootPurl, sbom, processedDeps, 'required', hashMap);
|
|
180
|
+
this.#processDependencyTree(compileConfig, rootPurl, sbom, processedDeps, 'optional', hashMap);
|
|
180
181
|
return sbom.filterIgnoredDepsIncludingVersion(ignoredDeps).getAsJsonString(opts);
|
|
181
182
|
}
|
|
182
183
|
/**
|
|
@@ -186,14 +187,15 @@ export default class Java_gradle extends Base_java {
|
|
|
186
187
|
* @returns {string} the Dot Graph content
|
|
187
188
|
* @private
|
|
188
189
|
*/
|
|
189
|
-
#createSbomStackAnalysis(manifest, opts = {}) {
|
|
190
|
+
async #createSbomStackAnalysis(manifest, opts = {}) {
|
|
190
191
|
let content = this.#getDependencies(manifest, opts);
|
|
191
192
|
let properties = this.#extractProperties(manifest, opts);
|
|
193
|
+
let hashMap = await this.parseGradleHashes(manifest, opts);
|
|
192
194
|
// read dependency tree from temp file
|
|
193
195
|
if (process.env["TRUSTIFY_DA_DEBUG"] === "true") {
|
|
194
196
|
console.log("Dependency tree that will be used as input for creating the BOM =>" + EOL + EOL + content);
|
|
195
197
|
}
|
|
196
|
-
let sbom = this.#buildSbom(content, properties, manifest, opts);
|
|
198
|
+
let sbom = this.#buildSbom(content, properties, manifest, opts, hashMap);
|
|
197
199
|
return sbom;
|
|
198
200
|
}
|
|
199
201
|
/**
|
|
@@ -238,10 +240,11 @@ export default class Java_gradle extends Base_java {
|
|
|
238
240
|
* @returns {string} - sbom string of the direct dependencies of build.gradle
|
|
239
241
|
* @private
|
|
240
242
|
*/
|
|
241
|
-
#getSbomForComponentAnalysis(manifestPath, opts = {}) {
|
|
243
|
+
async #getSbomForComponentAnalysis(manifestPath, opts = {}) {
|
|
242
244
|
let content = this.#getDependencies(manifestPath, opts);
|
|
243
245
|
let properties = this.#extractProperties(manifestPath, opts);
|
|
244
|
-
let
|
|
246
|
+
let hashMap = await this.parseGradleHashes(manifestPath, opts);
|
|
247
|
+
let sbom = this.#buildDirectDependenciesSbom(content, properties, manifestPath, opts, hashMap);
|
|
245
248
|
return sbom;
|
|
246
249
|
}
|
|
247
250
|
/**
|
|
@@ -260,6 +263,112 @@ export default class Java_gradle extends Base_java {
|
|
|
260
263
|
throw new Error(`Couldn't run gradle dependencies command, error message returned from gradle binary => ${EOL} ${error.message}`);
|
|
261
264
|
}
|
|
262
265
|
}
|
|
266
|
+
/**
|
|
267
|
+
* Hash a file using SHA-256 with streaming to handle large files efficiently.
|
|
268
|
+
* @param {string} filePath - path to the file to hash
|
|
269
|
+
* @returns {Promise<string>} hex-encoded SHA-256 digest
|
|
270
|
+
* @private
|
|
271
|
+
*/
|
|
272
|
+
#hashFileStream(filePath) {
|
|
273
|
+
return new Promise((resolve, reject) => {
|
|
274
|
+
const hash = crypto.createHash('sha256');
|
|
275
|
+
const stream = fs.createReadStream(filePath);
|
|
276
|
+
stream.on('data', chunk => hash.update(chunk));
|
|
277
|
+
stream.on('end', () => resolve(hash.digest('hex')));
|
|
278
|
+
stream.on('error', reject);
|
|
279
|
+
});
|
|
280
|
+
}
|
|
281
|
+
/**
|
|
282
|
+
* Compute SHA-256 hashes for the resolved artifacts of a Gradle manifest.
|
|
283
|
+
*
|
|
284
|
+
* Rather than scanning the local Gradle cache, this asks Gradle itself for
|
|
285
|
+
* the resolved artifact files via an init script (mirroring the pattern used
|
|
286
|
+
* by {@link discoverGradleSubprojects}), then hashes each file with the
|
|
287
|
+
* Node.js `crypto` module. The result is keyed by the canonical PURL string
|
|
288
|
+
* built via {@link Base_java#toPurl} — the same builder {@link parseDep} uses
|
|
289
|
+
* for the lookup — so the stored key and the lookup key cannot drift.
|
|
290
|
+
*
|
|
291
|
+
* Degrades gracefully: if Gradle cannot be invoked, the init script fails, or
|
|
292
|
+
* an artifact has no readable file (e.g. BOM/`platform()` dependencies), the
|
|
293
|
+
* hash for that component is omitted rather than throwing. A warning is emitted
|
|
294
|
+
* on every degradation path so incomplete hash coverage is visible even without
|
|
295
|
+
* `TRUSTIFY_DA_DEBUG` (mirroring the pip/cargo providers).
|
|
296
|
+
*
|
|
297
|
+
* @param {string} manifest - path to build.gradle[.kts]
|
|
298
|
+
* @param {{}} [opts={}] - optional various options to pass along the application
|
|
299
|
+
* @returns {Promise<Map<string, Array<{alg: string, content: string}>>>} map of canonical PURL string to CycloneDX hashes
|
|
300
|
+
*/
|
|
301
|
+
async parseGradleHashes(manifest, opts = {}) {
|
|
302
|
+
const hashMap = new Map();
|
|
303
|
+
const debug = process.env["TRUSTIFY_DA_DEBUG"] === "true";
|
|
304
|
+
let gradle;
|
|
305
|
+
try {
|
|
306
|
+
gradle = this.selectToolBinary(manifest, opts);
|
|
307
|
+
}
|
|
308
|
+
catch (error) {
|
|
309
|
+
console.warn(`Gradle could not be invoked to compute artifact hashes, SBOM will be generated without hashes: ${error.stack || error.message}`);
|
|
310
|
+
return hashMap;
|
|
311
|
+
}
|
|
312
|
+
const initScriptPath = path.join(os.tmpdir(), `da-list-hashes-${crypto.randomUUID()}.gradle`);
|
|
313
|
+
try {
|
|
314
|
+
fs.writeFileSync(initScriptPath, GRADLE_HASH_INIT_SCRIPT);
|
|
315
|
+
let output;
|
|
316
|
+
try {
|
|
317
|
+
output = this._invokeCommand(gradle, [
|
|
318
|
+
'-q', '--no-daemon',
|
|
319
|
+
'--init-script', initScriptPath,
|
|
320
|
+
'daListHashes',
|
|
321
|
+
], { cwd: path.dirname(manifest) });
|
|
322
|
+
}
|
|
323
|
+
catch (error) {
|
|
324
|
+
console.warn(`Gradle hash init script failed, SBOM will be generated without hashes: ${error.stack || error.message}`);
|
|
325
|
+
return hashMap;
|
|
326
|
+
}
|
|
327
|
+
let attempted = 0;
|
|
328
|
+
let missed = 0;
|
|
329
|
+
for (const { id, file } of parseGradleHashScriptOutput(output.toString())) {
|
|
330
|
+
const coord = parseComponentId(id);
|
|
331
|
+
if (!coord) {
|
|
332
|
+
continue;
|
|
333
|
+
}
|
|
334
|
+
// Build the key with the same canonical PURL builder parseDep uses for
|
|
335
|
+
// the lookup, so the stored key and the lookup key cannot drift.
|
|
336
|
+
const key = this.toPurl(coord.group, coord.name, coord.version).toString();
|
|
337
|
+
if (hashMap.has(key)) {
|
|
338
|
+
continue;
|
|
339
|
+
}
|
|
340
|
+
attempted++;
|
|
341
|
+
try {
|
|
342
|
+
const digest = await this.#hashFileStream(file);
|
|
343
|
+
hashMap.set(key, [{ alg: 'SHA-256', content: digest }]);
|
|
344
|
+
}
|
|
345
|
+
catch (error) {
|
|
346
|
+
// artifact file missing/unreadable — omit the hash for this component
|
|
347
|
+
missed++;
|
|
348
|
+
if (debug) {
|
|
349
|
+
console.error(`Gradle hash: could not read artifact ${file} => ${error.message}`);
|
|
350
|
+
}
|
|
351
|
+
}
|
|
352
|
+
}
|
|
353
|
+
if (missed > 0) {
|
|
354
|
+
console.warn(`Gradle hash: ${missed} of ${attempted} resolved artifacts could not be read, SBOM will be generated without hashes for those components`);
|
|
355
|
+
}
|
|
356
|
+
}
|
|
357
|
+
catch (error) {
|
|
358
|
+
// Unexpected failure (e.g. a programming error) is degraded to keep SBOM
|
|
359
|
+
// generation working, but the error is surfaced so it is not mistaken
|
|
360
|
+
// for ordinary graceful degradation.
|
|
361
|
+
console.warn(`Gradle artifact hashing failed, SBOM will be generated without hashes: ${error.stack || error.message}`);
|
|
362
|
+
return hashMap;
|
|
363
|
+
}
|
|
364
|
+
finally {
|
|
365
|
+
try {
|
|
366
|
+
fs.unlinkSync(initScriptPath);
|
|
367
|
+
}
|
|
368
|
+
catch { /* ignore */ }
|
|
369
|
+
}
|
|
370
|
+
return hashMap;
|
|
371
|
+
}
|
|
263
372
|
/**
|
|
264
373
|
* Extracts runtime and compile configurations from the dependency tree
|
|
265
374
|
* @param {string} content - the dependency tree content
|
|
@@ -307,7 +416,7 @@ export default class Java_gradle extends Base_java {
|
|
|
307
416
|
* @param properties {Object} - properties of the gradle project.
|
|
308
417
|
* @return {string} return sbom json string of the build.gradle manifest file
|
|
309
418
|
*/
|
|
310
|
-
#buildDirectDependenciesSbom(content, properties, manifestPath, opts = {}) {
|
|
419
|
+
#buildDirectDependenciesSbom(content, properties, manifestPath, opts = {}, hashMap) {
|
|
311
420
|
let sbom = new Sbom();
|
|
312
421
|
let root = `${properties.group}:${properties[ROOT_PROJECT_KEY_NAME].match(/Root project '(.+)'/)[1]}:jar:${properties.version}`;
|
|
313
422
|
let rootPurl = this.parseDep(root);
|
|
@@ -321,7 +430,7 @@ export default class Java_gradle extends Base_java {
|
|
|
321
430
|
directDependencies.forEach((scope, dep) => {
|
|
322
431
|
const purl = this.parseDep(dep);
|
|
323
432
|
purl.scope = scope;
|
|
324
|
-
sbom.addDependency(rootPurl, purl, scope);
|
|
433
|
+
sbom.addDependency(rootPurl, purl, scope, hashMap?.get(purl.toString()));
|
|
325
434
|
});
|
|
326
435
|
return sbom.filterIgnoredDepsIncludingVersion(ignoredDeps).getAsJsonString(opts);
|
|
327
436
|
}
|
|
@@ -424,6 +533,29 @@ const GRADLE_INIT_SCRIPT = `allprojects {
|
|
|
424
533
|
}
|
|
425
534
|
}
|
|
426
535
|
`;
|
|
536
|
+
/**
|
|
537
|
+
* Gradle init script that emits, per resolved module artifact, a structured line
|
|
538
|
+
* of the form `::DA_HASH::group:name:version::/absolute/file/path`. It obtains
|
|
539
|
+
* files from Gradle's resolution API (the same approach as the CycloneDX Gradle
|
|
540
|
+
* plugin) so it is robust to cache-layout changes and correctly reports
|
|
541
|
+
* classifiers and non-jar artifacts. Uses a lenient artifact view so
|
|
542
|
+
* unresolved/fileless artifacts are skipped rather than failing the build.
|
|
543
|
+
*/
|
|
544
|
+
const GRADLE_HASH_INIT_SCRIPT = `allprojects {
|
|
545
|
+
task daListHashes {
|
|
546
|
+
doLast {
|
|
547
|
+
configurations.findAll { it.canBeResolved }.each { cfg ->
|
|
548
|
+
cfg.incoming.artifactView { lenient = true }.artifacts.each { artifact ->
|
|
549
|
+
def cid = artifact.id.componentIdentifier
|
|
550
|
+
if (cid instanceof org.gradle.api.artifacts.component.ModuleComponentIdentifier) {
|
|
551
|
+
println "::DA_HASH::\${cid.group}:\${cid.module}:\${cid.version}::\${artifact.file.absolutePath}"
|
|
552
|
+
}
|
|
553
|
+
}
|
|
554
|
+
}
|
|
555
|
+
}
|
|
556
|
+
}
|
|
557
|
+
}
|
|
558
|
+
`;
|
|
427
559
|
/**
|
|
428
560
|
* Discover all build.gradle[.kts] manifest paths in a Gradle multi-project build.
|
|
429
561
|
* Uses a custom init script to get structured project listing.
|
|
@@ -521,3 +653,50 @@ export function parseGradleInitScriptOutput(raw) {
|
|
|
521
653
|
}
|
|
522
654
|
return projects;
|
|
523
655
|
}
|
|
656
|
+
/**
|
|
657
|
+
* Parse the structured output from the Gradle hash init script.
|
|
658
|
+
* Each recognised line has the form `::DA_HASH::group:name:version::<file-path>`.
|
|
659
|
+
*
|
|
660
|
+
* @param {string} raw - Raw stdout from gradle
|
|
661
|
+
* @returns {{ id: string, file: string }[]} component id (`group:name:version`) and absolute artifact file path
|
|
662
|
+
*/
|
|
663
|
+
export function parseGradleHashScriptOutput(raw) {
|
|
664
|
+
const artifacts = [];
|
|
665
|
+
for (const rawLine of raw.split('\n')) {
|
|
666
|
+
const line = rawLine.trimEnd();
|
|
667
|
+
if (!line.startsWith('::DA_HASH::')) {
|
|
668
|
+
continue;
|
|
669
|
+
}
|
|
670
|
+
const prefix = '::DA_HASH::';
|
|
671
|
+
const remainder = line.substring(prefix.length);
|
|
672
|
+
const lastSep = remainder.lastIndexOf('::');
|
|
673
|
+
if (lastSep < 0) {
|
|
674
|
+
continue;
|
|
675
|
+
}
|
|
676
|
+
const id = remainder.substring(0, lastSep);
|
|
677
|
+
const file = remainder.substring(lastSep + 2);
|
|
678
|
+
if (id && file) {
|
|
679
|
+
artifacts.push({ id, file });
|
|
680
|
+
}
|
|
681
|
+
}
|
|
682
|
+
return artifacts;
|
|
683
|
+
}
|
|
684
|
+
/**
|
|
685
|
+
* Parse a Gradle module component id (`group:name:version`) into its coordinate
|
|
686
|
+
* parts. The caller builds the canonical PURL key from these parts using the same
|
|
687
|
+
* builder {@link parseDep} uses, so the stored key and the lookup key cannot drift.
|
|
688
|
+
*
|
|
689
|
+
* @param {string} id - the Gradle component id
|
|
690
|
+
* @returns {{group: string, name: string, version: string}|null} the parsed coordinate, or null when the id is malformed
|
|
691
|
+
*/
|
|
692
|
+
export function parseComponentId(id) {
|
|
693
|
+
const parts = id.split(':');
|
|
694
|
+
if (parts.length < 3) {
|
|
695
|
+
return null;
|
|
696
|
+
}
|
|
697
|
+
const [group, name, version] = parts;
|
|
698
|
+
if (!group || !name || !version) {
|
|
699
|
+
return null;
|
|
700
|
+
}
|
|
701
|
+
return { group, name, version };
|
|
702
|
+
}
|
|
@@ -3,5 +3,5 @@ export default class Java_gradle_groovy extends Java_gradle {
|
|
|
3
3
|
_parseAliasForLibsNotation(alias: any): any;
|
|
4
4
|
_extractDepToBeIgnored(dep: any): any;
|
|
5
5
|
}
|
|
6
|
-
export type Provided =
|
|
6
|
+
export type Provided = any;
|
|
7
7
|
import Java_gradle from './java_gradle.js';
|
|
@@ -7,5 +7,5 @@ export default class Java_gradle_kotlin extends Java_gradle {
|
|
|
7
7
|
_parseAliasForLibsNotation(alias: any): any;
|
|
8
8
|
_extractDepToBeIgnored(dep: any): string | null;
|
|
9
9
|
}
|
|
10
|
-
export type Provided =
|
|
10
|
+
export type Provided = any;
|
|
11
11
|
import Java_gradle from './java_gradle.js';
|
|
@@ -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,17 +46,38 @@ 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
|
-
export type Java_maven =
|
|
55
|
-
export type Provided =
|
|
79
|
+
export type Java_maven = any;
|
|
80
|
+
export type Provided = any;
|
|
56
81
|
export type Package = {
|
|
57
82
|
name: string;
|
|
58
83
|
version: string;
|