@trustify-da/trustify-da-javascript-client 0.3.0-ea.76e1fef → 0.3.0-ea.7ee4047

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.
Files changed (83) hide show
  1. package/README.md +199 -11
  2. package/dist/package.json +30 -26
  3. package/dist/src/analysis.d.ts +50 -22
  4. package/dist/src/analysis.js +70 -18
  5. package/dist/src/cli.js +188 -6
  6. package/dist/src/config.d.ts +120 -0
  7. package/dist/src/config.js +260 -0
  8. package/dist/src/cyclone_dx_sbom.d.ts +13 -0
  9. package/dist/src/cyclone_dx_sbom.js +50 -4
  10. package/dist/src/index.d.ts +27 -23
  11. package/dist/src/index.js +32 -41
  12. package/dist/src/license/index.d.ts +4 -4
  13. package/dist/src/license/index.js +13 -7
  14. package/dist/src/license/license_utils.js +4 -1
  15. package/dist/src/license/licenses_api.d.ts +3 -3
  16. package/dist/src/license/licenses_api.js +1 -1
  17. package/dist/src/oci_image/images.d.ts +1 -1
  18. package/dist/src/oci_image/images.js +15 -1
  19. package/dist/src/oci_image/utils.d.ts +5 -5
  20. package/dist/src/package_version.d.ts +8 -0
  21. package/dist/src/package_version.js +31 -0
  22. package/dist/src/provider.d.ts +4 -3
  23. package/dist/src/provider.js +6 -2
  24. package/dist/src/providers/base_java.d.ts +67 -3
  25. package/dist/src/providers/base_java.js +80 -23
  26. package/dist/src/providers/base_javascript.d.ts +74 -9
  27. package/dist/src/providers/base_javascript.js +116 -7
  28. package/dist/src/providers/base_pyproject.d.ts +10 -5
  29. package/dist/src/providers/base_pyproject.js +7 -0
  30. package/dist/src/providers/containerfile_parser.d.ts +5 -0
  31. package/dist/src/providers/containerfile_parser.js +20 -0
  32. package/dist/src/providers/golang_gomodules.d.ts +2 -1
  33. package/dist/src/providers/golang_gomodules.js +50 -8
  34. package/dist/src/providers/java_gradle.d.ts +48 -0
  35. package/dist/src/providers/java_gradle.js +206 -22
  36. package/dist/src/providers/java_gradle_groovy.d.ts +1 -1
  37. package/dist/src/providers/java_gradle_kotlin.d.ts +1 -1
  38. package/dist/src/providers/java_maven.d.ts +29 -9
  39. package/dist/src/providers/java_maven.js +176 -10
  40. package/dist/src/providers/javascript_bun.d.ts +22 -0
  41. package/dist/src/providers/javascript_bun.js +141 -0
  42. package/dist/src/providers/javascript_npm.d.ts +19 -1
  43. package/dist/src/providers/javascript_npm.js +40 -1
  44. package/dist/src/providers/javascript_pnpm.d.ts +13 -0
  45. package/dist/src/providers/javascript_pnpm.js +47 -1
  46. package/dist/src/providers/javascript_yarn.d.ts +12 -0
  47. package/dist/src/providers/javascript_yarn.js +75 -2
  48. package/dist/src/providers/manifest.js +6 -3
  49. package/dist/src/providers/oci_dockerfile.d.ts +51 -0
  50. package/dist/src/providers/oci_dockerfile.js +177 -0
  51. package/dist/src/providers/processors/yarn_berry_processor.d.ts +6 -2
  52. package/dist/src/providers/processors/yarn_berry_processor.js +3 -2
  53. package/dist/src/providers/processors/yarn_classic_processor.d.ts +6 -2
  54. package/dist/src/providers/processors/yarn_classic_processor.js +8 -6
  55. package/dist/src/providers/python_controller.js +61 -4
  56. package/dist/src/providers/python_pip.d.ts +1 -0
  57. package/dist/src/providers/python_pip.js +1 -1
  58. package/dist/src/providers/python_pip_pyproject.js +3 -1
  59. package/dist/src/providers/python_poetry.d.ts +31 -8
  60. package/dist/src/providers/python_poetry.js +62 -14
  61. package/dist/src/providers/python_uv.d.ts +5 -14
  62. package/dist/src/providers/python_uv.js +50 -2
  63. package/dist/src/providers/requirements_parser.js +1 -1
  64. package/dist/src/providers/rust_cargo.d.ts +6 -2
  65. package/dist/src/providers/rust_cargo.js +101 -33
  66. package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
  67. package/dist/src/remediate.d.ts +107 -0
  68. package/dist/src/remediate.js +244 -0
  69. package/dist/src/remediation.d.ts +81 -0
  70. package/dist/src/remediation.js +475 -0
  71. package/dist/src/remediation_report.d.ts +23 -0
  72. package/dist/src/remediation_report.js +180 -0
  73. package/dist/src/sbom.d.ts +11 -0
  74. package/dist/src/sbom.js +10 -0
  75. package/dist/src/tools.d.ts +11 -13
  76. package/dist/src/tools.js +34 -13
  77. package/dist/src/updaters/maven_updater.d.ts +58 -0
  78. package/dist/src/updaters/maven_updater.js +345 -0
  79. package/dist/src/updaters/toml_updater.d.ts +62 -0
  80. package/dist/src/updaters/toml_updater.js +276 -0
  81. package/dist/src/workspace.d.ts +2 -1
  82. package/dist/src/workspace.js +2 -1
  83. package/package.json +31 -27
@@ -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 */
@@ -78,9 +78,10 @@ function getChildVertexFromEdge(edge) {
78
78
  return edge.split(" ")[1];
79
79
  }
80
80
  /**
81
- * Check whether a require_spec has a valid exhortignore marker.
82
- * For direct dependencies: `//exhortignore` or `// exhortignore`
83
- * For indirect dependencies: `// indirect; exhortignore` (semicolon-separated)
81
+ * Check whether a require_spec has a valid ignore marker.
82
+ * Supports both the legacy `exhortignore` marker and the new `trustify-da-ignore` marker.
83
+ * For direct dependencies: `//exhortignore` or `// trustify-da-ignore`
84
+ * For indirect dependencies: `// indirect; exhortignore` or `// indirect; trustify-da-ignore` (semicolon-separated)
84
85
  * @param {import('web-tree-sitter').SyntaxNode} specNode
85
86
  * @return {boolean}
86
87
  */
@@ -92,10 +93,10 @@ function hasExhortIgnore(specNode) {
92
93
  let comments = specNode.children.filter(c => c.type === 'comment');
93
94
  for (let comment of comments) {
94
95
  let text = comment.text;
95
- if (/^\/\/\s*indirect;\s*exhortignore/.test(text)) {
96
+ if (/^\/\/\s*indirect;\s*(exhortignore|trustify-da-ignore)(?![\w-])/.test(text)) {
96
97
  return true;
97
98
  }
98
- if (/^\/\/\s*exhortignore/.test(text)) {
99
+ if (/^\/\/\s*(exhortignore|trustify-da-ignore)(?![\w-])/.test(text)) {
99
100
  return true;
100
101
  }
101
102
  }
@@ -187,6 +188,36 @@ function performManifestVersionsCheck(rootElementName, goModGraphOutputRows, man
187
188
  throw error;
188
189
  }
189
190
  }
191
+ /** Parses go.sum to build a hash map of module@version to CycloneDX hashes. */
192
+ function parseGoSumHashes(manifestDir) {
193
+ let goSumPath = path.join(manifestDir, 'go.sum');
194
+ if (!fs.existsSync(goSumPath)) {
195
+ return new Map();
196
+ }
197
+ let hashMap = new Map();
198
+ let content = fs.readFileSync(goSumPath, 'utf-8');
199
+ for (let line of content.split('\n')) {
200
+ line = line.trim();
201
+ if (!line) {
202
+ continue;
203
+ }
204
+ let parts = line.split(/\s+/);
205
+ if (parts.length < 3) {
206
+ continue;
207
+ }
208
+ let [mod, version, hash] = parts;
209
+ if (version.endsWith('/go.mod')) {
210
+ continue;
211
+ }
212
+ if (!hash.startsWith('h1:')) {
213
+ continue;
214
+ }
215
+ let base64Part = hash.slice(3);
216
+ let hexDigest = Buffer.from(base64Part, 'base64').toString('hex');
217
+ hashMap.set(`${mod}@${version}`, [{ alg: "SHA-256", content: hexDigest }]);
218
+ }
219
+ return hashMap;
220
+ }
190
221
  /**
191
222
  * Create SBOM json string for go Module.
192
223
  * @param {string} manifest - path for go.mod
@@ -241,6 +272,7 @@ async function getSBOM(manifest, opts = {}, includeTransitive) {
241
272
  if (matchManifestVersions === "true") {
242
273
  performManifestVersionsCheck(root, rows, manifestContent, parser, requireQuery);
243
274
  }
275
+ let goSumHashes = parseGoSumHashes(manifestDir);
244
276
  const mainModule = toPurl(root, "@");
245
277
  const license = readLicenseFromManifest(manifest);
246
278
  sbom.addRoot(mainModule, license);
@@ -262,7 +294,7 @@ async function getSBOM(manifest, opts = {}, includeTransitive) {
262
294
  if (getParentVertexFromEdge(row) === root && !directDepPaths.has(getPackageName(child))) {
263
295
  return;
264
296
  }
265
- sbom.addDependency(source, target);
297
+ sbom.addDependency(source, target, undefined, goSumHashes.get(child));
266
298
  });
267
299
  // at the end, filter out all ignored dependencies including versions.
268
300
  sbom.filterIgnoredDepsIncludingVersion(allIgnoredDeps);
@@ -275,12 +307,22 @@ async function getSBOM(manifest, opts = {}, includeTransitive) {
275
307
  let target = toPurl(child, "@");
276
308
  if (dependencyNotIgnored(ignoredDeps, target)) {
277
309
  if (directDepPaths.has(getPackageName(child))) {
278
- sbom.addDependency(mainModule, target);
310
+ sbom.addDependency(mainModule, target, undefined, goSumHashes.get(child));
279
311
  }
280
312
  }
281
313
  });
282
314
  enforceRemovingIgnoredDepsInCaseOfAutomaticVersionUpdate(ignoredDeps, sbom);
283
315
  }
316
+ // Backfill hashes for components that were only seen as dependency sources
317
+ for (const comp of sbom.sbomModel.components) {
318
+ if (!comp.hashes && comp.purl) {
319
+ let key = decodeURIComponent(comp.purl.replace('pkg:golang/', ''));
320
+ let hashes = goSumHashes.get(key);
321
+ if (hashes) {
322
+ comp.hashes = hashes;
323
+ }
324
+ }
325
+ }
284
326
  return sbom.getAsJsonString(opts);
285
327
  }
286
328
  /**
@@ -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;
@@ -3,7 +3,7 @@ import fs from 'node:fs';
3
3
  import os from 'node:os';
4
4
  import path from 'node:path';
5
5
  import { EOL } from 'os';
6
- import TOML from 'fast-toml';
6
+ import { parse as parseToml } from 'smol-toml';
7
7
  import { readLicenseFile } from '../license/license_utils.js';
8
8
  import Sbom from '../sbom.js';
9
9
  import { invokeCommand } from '../tools.js';
@@ -12,8 +12,8 @@ import Base_java, { ecosystem_gradle } from "./base_java.js";
12
12
  /** @typedef {import('../provider.js').Provider} */
13
13
  /** @typedef {import('../provider.js').Provided} Provided */
14
14
  const ROOT_PROJECT_KEY_NAME = "root-project";
15
- const TRUSTIFY_DA_IGNORE_REGEX_LINE = /.*\s?exhortignore\s*$/g;
16
- const TRUSTIFY_DA_IGNORE_REGEX = /\/\/\s?exhortignore/;
15
+ const TRUSTIFY_DA_IGNORE_REGEX_LINE = /.*\s?(exhortignore|trustify-da-ignore)\s*$/g;
16
+ const TRUSTIFY_DA_IGNORE_REGEX = /\/\/\s?(exhortignore|trustify-da-ignore)/;
17
17
  /**
18
18
  * Check if the dependency marked for exclusion has libs notation , so if it's true the rest of coordinates( GAV) should be fetched from TOML file.
19
19
  * @param {string} depToBeIgnored
@@ -59,7 +59,6 @@ export default class Java_gradle extends Base_java {
59
59
  * @param {string} manifestPath - path to manifest
60
60
  * @returns {null}
61
61
  */
62
- // eslint-disable-next-line no-unused-vars
63
62
  readLicenseFromManifest(manifestPath) { return readLicenseFile(manifestPath); }
64
63
  /**
65
64
  * Provide content and content type for stack analysis.
@@ -67,10 +66,10 @@ export default class Java_gradle extends Base_java {
67
66
  * @param {{}} [opts={}] - optional various options to pass along the application
68
67
  * @returns {Provided}
69
68
  */
70
- provideStack(manifest, opts = {}) {
69
+ async provideStack(manifest, opts = {}) {
71
70
  return {
72
71
  ecosystem: ecosystem_gradle,
73
- content: this.#createSbomStackAnalysis(manifest, opts),
72
+ content: await this.#createSbomStackAnalysis(manifest, opts),
74
73
  contentType: 'application/vnd.cyclonedx+json'
75
74
  };
76
75
  }
@@ -80,10 +79,10 @@ export default class Java_gradle extends Base_java {
80
79
  * @param {{}} [opts={}] - optional various options to pass along the application
81
80
  * @returns {Provided}
82
81
  */
83
- provideComponent(manifest, opts = {}) {
82
+ async provideComponent(manifest, opts = {}) {
84
83
  return {
85
84
  ecosystem: ecosystem_gradle,
86
- content: this.#getSbomForComponentAnalysis(manifest, opts),
85
+ content: await this.#getSbomForComponentAnalysis(manifest, opts),
87
86
  contentType: 'application/vnd.cyclonedx+json'
88
87
  };
89
88
  }
@@ -133,9 +132,10 @@ export default class Java_gradle extends Base_java {
133
132
  * @param {Sbom} sbom - the SBOM object to add dependencies to
134
133
  * @param {Set} processedDeps - set of already processed dependencies
135
134
  * @param {string} scope - the dependency scope
135
+ * @param {Map<string, Array<{alg: string, content: string}>>} [hashMap] - map of "group:name@version" to CycloneDX hashes
136
136
  * @private
137
137
  */
138
- #processDependencyTree(config, parentPurl, sbom, processedDeps, scope) {
138
+ #processDependencyTree(config, parentPurl, sbom, processedDeps, scope, hashMap) {
139
139
  const processedLines = this.#prepareLinesForParsingDependencyTree(config);
140
140
  let parentStack = [parentPurl];
141
141
  for (const { line, depth } of processedLines) {
@@ -153,12 +153,18 @@ export default class Java_gradle extends Base_java {
153
153
  // Add dependency to SBOM if not already processed
154
154
  if (!processedDeps.has(depKey)) {
155
155
  processedDeps.add(depKey);
156
- sbom.addDependency(currentParent, purl, scope);
156
+ sbom.addDependency(currentParent, purl, scope, hashMap?.get(purl.toString()));
157
157
  }
158
158
  parentStack.push(purl);
159
159
  }
160
160
  }
161
161
  }
162
+ #buildRootCoordinate(properties) {
163
+ const group = properties.group || 'unknown';
164
+ const version = properties.version || '0.0.0';
165
+ const rootName = properties[ROOT_PROJECT_KEY_NAME]?.match(/Root project '(.+)'/)?.[1] || 'unknown';
166
+ return `${group}:${rootName}:jar:${version}`;
167
+ }
162
168
  /**
163
169
  * Create a Dot Graph dependency tree for a manifest path.
164
170
  * @param {string} manifest - path for pom.xml
@@ -166,17 +172,17 @@ export default class Java_gradle extends Base_java {
166
172
  * @returns {string} the Dot Graph content
167
173
  * @private
168
174
  */
169
- #buildSbom(content, properties, manifestPath, opts = {}) {
175
+ #buildSbom(content, properties, manifestPath, opts = {}, hashMap) {
170
176
  let sbom = new Sbom();
171
- let root = `${properties.group}:${properties[ROOT_PROJECT_KEY_NAME].match(/Root project '(.+)'/)[1]}:jar:${properties.version}`;
177
+ let root = this.#buildRootCoordinate(properties);
172
178
  let rootPurl = this.parseDep(root);
173
179
  const license = this.readLicenseFromManifest(manifestPath);
174
180
  sbom.addRoot(rootPurl, license);
175
181
  let ignoredDeps = this.#getIgnoredDeps(manifestPath);
176
182
  const [runtimeConfig, compileConfig] = this.#extractConfigurations(content);
177
183
  const processedDeps = new Set();
178
- this.#processDependencyTree(runtimeConfig, rootPurl, sbom, processedDeps, 'required');
179
- this.#processDependencyTree(compileConfig, rootPurl, sbom, processedDeps, 'optional');
184
+ this.#processDependencyTree(runtimeConfig, rootPurl, sbom, processedDeps, 'required', hashMap);
185
+ this.#processDependencyTree(compileConfig, rootPurl, sbom, processedDeps, 'optional', hashMap);
180
186
  return sbom.filterIgnoredDepsIncludingVersion(ignoredDeps).getAsJsonString(opts);
181
187
  }
182
188
  /**
@@ -186,14 +192,15 @@ export default class Java_gradle extends Base_java {
186
192
  * @returns {string} the Dot Graph content
187
193
  * @private
188
194
  */
189
- #createSbomStackAnalysis(manifest, opts = {}) {
195
+ async #createSbomStackAnalysis(manifest, opts = {}) {
190
196
  let content = this.#getDependencies(manifest, opts);
191
197
  let properties = this.#extractProperties(manifest, opts);
198
+ let hashMap = await this.parseGradleHashes(manifest, opts);
192
199
  // read dependency tree from temp file
193
200
  if (process.env["TRUSTIFY_DA_DEBUG"] === "true") {
194
201
  console.log("Dependency tree that will be used as input for creating the BOM =>" + EOL + EOL + content);
195
202
  }
196
- let sbom = this.#buildSbom(content, properties, manifest, opts);
203
+ let sbom = this.#buildSbom(content, properties, manifest, opts, hashMap);
197
204
  return sbom;
198
205
  }
199
206
  /**
@@ -238,10 +245,11 @@ export default class Java_gradle extends Base_java {
238
245
  * @returns {string} - sbom string of the direct dependencies of build.gradle
239
246
  * @private
240
247
  */
241
- #getSbomForComponentAnalysis(manifestPath, opts = {}) {
248
+ async #getSbomForComponentAnalysis(manifestPath, opts = {}) {
242
249
  let content = this.#getDependencies(manifestPath, opts);
243
250
  let properties = this.#extractProperties(manifestPath, opts);
244
- let sbom = this.#buildDirectDependenciesSbom(content, properties, manifestPath, opts);
251
+ let hashMap = await this.parseGradleHashes(manifestPath, opts);
252
+ let sbom = this.#buildDirectDependenciesSbom(content, properties, manifestPath, opts, hashMap);
245
253
  return sbom;
246
254
  }
247
255
  /**
@@ -260,6 +268,112 @@ export default class Java_gradle extends Base_java {
260
268
  throw new Error(`Couldn't run gradle dependencies command, error message returned from gradle binary => ${EOL} ${error.message}`);
261
269
  }
262
270
  }
271
+ /**
272
+ * Hash a file using SHA-256 with streaming to handle large files efficiently.
273
+ * @param {string} filePath - path to the file to hash
274
+ * @returns {Promise<string>} hex-encoded SHA-256 digest
275
+ * @private
276
+ */
277
+ #hashFileStream(filePath) {
278
+ return new Promise((resolve, reject) => {
279
+ const hash = crypto.createHash('sha256');
280
+ const stream = fs.createReadStream(filePath);
281
+ stream.on('data', chunk => hash.update(chunk));
282
+ stream.on('end', () => resolve(hash.digest('hex')));
283
+ stream.on('error', reject);
284
+ });
285
+ }
286
+ /**
287
+ * Compute SHA-256 hashes for the resolved artifacts of a Gradle manifest.
288
+ *
289
+ * Rather than scanning the local Gradle cache, this asks Gradle itself for
290
+ * the resolved artifact files via an init script (mirroring the pattern used
291
+ * by {@link discoverGradleSubprojects}), then hashes each file with the
292
+ * Node.js `crypto` module. The result is keyed by the canonical PURL string
293
+ * built via {@link Base_java#toPurl} — the same builder {@link parseDep} uses
294
+ * for the lookup — so the stored key and the lookup key cannot drift.
295
+ *
296
+ * Degrades gracefully: if Gradle cannot be invoked, the init script fails, or
297
+ * an artifact has no readable file (e.g. BOM/`platform()` dependencies), the
298
+ * hash for that component is omitted rather than throwing. A warning is emitted
299
+ * on every degradation path so incomplete hash coverage is visible even without
300
+ * `TRUSTIFY_DA_DEBUG` (mirroring the pip/cargo providers).
301
+ *
302
+ * @param {string} manifest - path to build.gradle[.kts]
303
+ * @param {{}} [opts={}] - optional various options to pass along the application
304
+ * @returns {Promise<Map<string, Array<{alg: string, content: string}>>>} map of canonical PURL string to CycloneDX hashes
305
+ */
306
+ async parseGradleHashes(manifest, opts = {}) {
307
+ const hashMap = new Map();
308
+ const debug = process.env["TRUSTIFY_DA_DEBUG"] === "true";
309
+ let gradle;
310
+ try {
311
+ gradle = this.selectToolBinary(manifest, opts);
312
+ }
313
+ catch (error) {
314
+ console.warn(`Gradle could not be invoked to compute artifact hashes, SBOM will be generated without hashes: ${error.stack || error.message}`);
315
+ return hashMap;
316
+ }
317
+ const initScriptPath = path.join(os.tmpdir(), `da-list-hashes-${crypto.randomUUID()}.gradle`);
318
+ try {
319
+ fs.writeFileSync(initScriptPath, GRADLE_HASH_INIT_SCRIPT);
320
+ let output;
321
+ try {
322
+ output = this._invokeCommand(gradle, [
323
+ '-q', '--no-daemon',
324
+ '--init-script', initScriptPath,
325
+ 'daListHashes',
326
+ ], { cwd: path.dirname(manifest) });
327
+ }
328
+ catch (error) {
329
+ console.warn(`Gradle hash init script failed, SBOM will be generated without hashes: ${error.stack || error.message}`);
330
+ return hashMap;
331
+ }
332
+ let attempted = 0;
333
+ let missed = 0;
334
+ for (const { id, file } of parseGradleHashScriptOutput(output.toString())) {
335
+ const coord = parseComponentId(id);
336
+ if (!coord) {
337
+ continue;
338
+ }
339
+ // Build the key with the same canonical PURL builder parseDep uses for
340
+ // the lookup, so the stored key and the lookup key cannot drift.
341
+ const key = this.toPurl(coord.group, coord.name, coord.version).toString();
342
+ if (hashMap.has(key)) {
343
+ continue;
344
+ }
345
+ attempted++;
346
+ try {
347
+ const digest = await this.#hashFileStream(file);
348
+ hashMap.set(key, [{ alg: 'SHA-256', content: digest }]);
349
+ }
350
+ catch (error) {
351
+ // artifact file missing/unreadable — omit the hash for this component
352
+ missed++;
353
+ if (debug) {
354
+ console.error(`Gradle hash: could not read artifact ${file} => ${error.message}`);
355
+ }
356
+ }
357
+ }
358
+ if (missed > 0) {
359
+ console.warn(`Gradle hash: ${missed} of ${attempted} resolved artifacts could not be read, SBOM will be generated without hashes for those components`);
360
+ }
361
+ }
362
+ catch (error) {
363
+ // Unexpected failure (e.g. a programming error) is degraded to keep SBOM
364
+ // generation working, but the error is surfaced so it is not mistaken
365
+ // for ordinary graceful degradation.
366
+ console.warn(`Gradle artifact hashing failed, SBOM will be generated without hashes: ${error.stack || error.message}`);
367
+ return hashMap;
368
+ }
369
+ finally {
370
+ try {
371
+ fs.unlinkSync(initScriptPath);
372
+ }
373
+ catch { /* ignore */ }
374
+ }
375
+ return hashMap;
376
+ }
263
377
  /**
264
378
  * Extracts runtime and compile configurations from the dependency tree
265
379
  * @param {string} content - the dependency tree content
@@ -307,9 +421,9 @@ export default class Java_gradle extends Base_java {
307
421
  * @param properties {Object} - properties of the gradle project.
308
422
  * @return {string} return sbom json string of the build.gradle manifest file
309
423
  */
310
- #buildDirectDependenciesSbom(content, properties, manifestPath, opts = {}) {
424
+ #buildDirectDependenciesSbom(content, properties, manifestPath, opts = {}, hashMap) {
311
425
  let sbom = new Sbom();
312
- let root = `${properties.group}:${properties[ROOT_PROJECT_KEY_NAME].match(/Root project '(.+)'/)[1]}:jar:${properties.version}`;
426
+ let root = this.#buildRootCoordinate(properties);
313
427
  let rootPurl = this.parseDep(root);
314
428
  const license = this.readLicenseFromManifest(manifestPath);
315
429
  sbom.addRoot(rootPurl, license);
@@ -321,7 +435,7 @@ export default class Java_gradle extends Base_java {
321
435
  directDependencies.forEach((scope, dep) => {
322
436
  const purl = this.parseDep(dep);
323
437
  purl.scope = scope;
324
- sbom.addDependency(rootPurl, purl, scope);
438
+ sbom.addDependency(rootPurl, purl, scope, hashMap?.get(purl.toString()));
325
439
  });
326
440
  return sbom.filterIgnoredDepsIncludingVersion(ignoredDeps).getAsJsonString(opts);
327
441
  }
@@ -366,7 +480,7 @@ export default class Java_gradle extends Base_java {
366
480
  // Read and parse the TOML file
367
481
  let pathOfToml = path.join(path.dirname(manifestPath), "gradle", "libs.versions.toml");
368
482
  const tomlString = fs.readFileSync(pathOfToml).toString();
369
- let tomlObject = TOML.parse(tomlString);
483
+ let tomlObject = parseToml(tomlString);
370
484
  let groupPlusArtifactObject = tomlObject.libraries[alias];
371
485
  let parts = groupPlusArtifactObject.module.split(":");
372
486
  let groupId = parts[0];
@@ -424,6 +538,29 @@ const GRADLE_INIT_SCRIPT = `allprojects {
424
538
  }
425
539
  }
426
540
  `;
541
+ /**
542
+ * Gradle init script that emits, per resolved module artifact, a structured line
543
+ * of the form `::DA_HASH::group:name:version::/absolute/file/path`. It obtains
544
+ * files from Gradle's resolution API (the same approach as the CycloneDX Gradle
545
+ * plugin) so it is robust to cache-layout changes and correctly reports
546
+ * classifiers and non-jar artifacts. Uses a lenient artifact view so
547
+ * unresolved/fileless artifacts are skipped rather than failing the build.
548
+ */
549
+ const GRADLE_HASH_INIT_SCRIPT = `allprojects {
550
+ task daListHashes {
551
+ doLast {
552
+ configurations.findAll { it.canBeResolved }.each { cfg ->
553
+ cfg.incoming.artifactView { lenient = true }.artifacts.each { artifact ->
554
+ def cid = artifact.id.componentIdentifier
555
+ if (cid instanceof org.gradle.api.artifacts.component.ModuleComponentIdentifier) {
556
+ println "::DA_HASH::\${cid.group}:\${cid.module}:\${cid.version}::\${artifact.file.absolutePath}"
557
+ }
558
+ }
559
+ }
560
+ }
561
+ }
562
+ }
563
+ `;
427
564
  /**
428
565
  * Discover all build.gradle[.kts] manifest paths in a Gradle multi-project build.
429
566
  * Uses a custom init script to get structured project listing.
@@ -521,3 +658,50 @@ export function parseGradleInitScriptOutput(raw) {
521
658
  }
522
659
  return projects;
523
660
  }
661
+ /**
662
+ * Parse the structured output from the Gradle hash init script.
663
+ * Each recognised line has the form `::DA_HASH::group:name:version::<file-path>`.
664
+ *
665
+ * @param {string} raw - Raw stdout from gradle
666
+ * @returns {{ id: string, file: string }[]} component id (`group:name:version`) and absolute artifact file path
667
+ */
668
+ export function parseGradleHashScriptOutput(raw) {
669
+ const artifacts = [];
670
+ for (const rawLine of raw.split('\n')) {
671
+ const line = rawLine.trimEnd();
672
+ if (!line.startsWith('::DA_HASH::')) {
673
+ continue;
674
+ }
675
+ const prefix = '::DA_HASH::';
676
+ const remainder = line.substring(prefix.length);
677
+ const lastSep = remainder.lastIndexOf('::');
678
+ if (lastSep < 0) {
679
+ continue;
680
+ }
681
+ const id = remainder.substring(0, lastSep);
682
+ const file = remainder.substring(lastSep + 2);
683
+ if (id && file) {
684
+ artifacts.push({ id, file });
685
+ }
686
+ }
687
+ return artifacts;
688
+ }
689
+ /**
690
+ * Parse a Gradle module component id (`group:name:version`) into its coordinate
691
+ * parts. The caller builds the canonical PURL key from these parts using the same
692
+ * builder {@link parseDep} uses, so the stored key and the lookup key cannot drift.
693
+ *
694
+ * @param {string} id - the Gradle component id
695
+ * @returns {{group: string, name: string, version: string}|null} the parsed coordinate, or null when the id is malformed
696
+ */
697
+ export function parseComponentId(id) {
698
+ const parts = id.split(':');
699
+ if (parts.length < 3) {
700
+ return null;
701
+ }
702
+ const [group, name, version] = parts;
703
+ if (!group || !name || !version) {
704
+ return null;
705
+ }
706
+ return { group, name, version };
707
+ }
@@ -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 = import("../provider").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 = import("../provider").Provided;
10
+ export type Provided = any;
11
11
  import Java_gradle from './java_gradle.js';
@@ -6,11 +6,11 @@
6
6
  * @returns {Promise<string[]>} Paths to pom.xml files (absolute)
7
7
  */
8
8
  export function discoverMavenModules(workspaceRoot: string, opts?: object): Promise<string[]>;
9
- /** @typedef {import('../provider').Provider} */
10
- /** @typedef {import('../provider').Provided} Provided */
11
- /** @typedef {{name: string, version: string}} Package */
12
- /** @typedef {{groupId: string, artifactId: string, version: string, scope: string, ignore: boolean}} Dependency */
13
9
  export default class Java_maven extends Base_java {
10
+ /** @type {Object<string, string>} Packaging types that produce .jar files despite non-jar packaging names. */
11
+ static PACKAGING_TO_JAR: {
12
+ [x: string]: string;
13
+ };
14
14
  constructor();
15
15
  /**
16
16
  * @param {string} manifestName - the subject manifest name-type
@@ -25,9 +25,9 @@ export default class Java_maven extends Base_java {
25
25
  * Provide content and content type for maven-maven stack analysis.
26
26
  * @param {string} manifest - the manifest path or name
27
27
  * @param {{}} [opts={}] - optional various options to pass along the application
28
- * @returns {Provided}
28
+ * @returns {Promise<Provided>}
29
29
  */
30
- provideStack(manifest: string, opts?: {}): Provided;
30
+ provideStack(manifest: string, opts?: {}): Promise<Provided>;
31
31
  /**
32
32
  * Provide content and content type for maven-maven component analysis.
33
33
  * @param {string} manifest - path to the manifest file
@@ -42,17 +42,37 @@ export default class Java_maven extends Base_java {
42
42
  */
43
43
  readLicenseFromManifest(manifestPath: string): string | null;
44
44
  /**
45
+ * Build a Map of PURL string → CycloneDX hash entries by reading artifact files from the local Maven repository.
46
+ *
47
+ * Both the artifact file path and the hash-map key are derived from the
48
+ * shared {@link Base_java#parseCoordinate} parser: the file path uses the
49
+ * resolved version and raw classifier, while the key uses the same canonical
50
+ * PURL builder as {@link Base_java#parseDep}. This guarantees the key always
51
+ * matches the PURL that {@link Base_java#parseDependencyTree} looks up.
45
52
  *
53
+ * @param {string} depTreeText Raw dependency tree text from mvn dependency:tree
54
+ * @param {{}} [opts={}] Options bag (may contain TRUSTIFY_DA_MVN_REPO)
55
+ * @returns {Promise<Map<string, Array<{alg: string, content: string}>>>}
56
+ */
57
+ _buildMavenHashMap(depTreeText: string, opts?: {}): Promise<Map<string, Array<{
58
+ alg: string;
59
+ content: string;
60
+ }>>>;
61
+ /**
46
62
  * @param {String} textGraphList Text graph String of the manifest
47
63
  * @param {[String]} ignoredDeps List of ignored dependencies to be omitted from sbom
64
+ * @param {{}} opts Options
48
65
  * @param {String} manifestPath Path to the pom.xml manifest
66
+ * @param {Map<string, Array<{alg: string, content: string}>>} [hashMap] PURL→hashes map
49
67
  * @return {String} formatted sbom Json String with all dependencies
50
68
  */
51
- createSbomFileFromTextFormat(textGraphList: string, ignoredDeps: [string], opts: any, manifestPath: string): string;
69
+ createSbomFileFromTextFormat(textGraphList: string, ignoredDeps: [string], opts: {}, manifestPath: string, hashMap?: Map<string, Array<{
70
+ alg: string;
71
+ content: string;
72
+ }>>): string;
52
73
  #private;
53
74
  }
54
- export type Java_maven = import("../provider").Provider;
55
- export type Provided = import("../provider").Provided;
75
+ export type Provided = any;
56
76
  export type Package = {
57
77
  name: string;
58
78
  version: string;