@trustify-da/trustify-da-javascript-client 0.3.0-ea.7ed8d8c → 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 (98) hide show
  1. package/README.md +388 -20
  2. package/dist/package.json +39 -26
  3. package/dist/src/analysis.d.ts +58 -20
  4. package/dist/src/analysis.js +134 -78
  5. package/dist/src/batch_opts.d.ts +24 -0
  6. package/dist/src/batch_opts.js +35 -0
  7. package/dist/src/cli.js +427 -12
  8. package/dist/src/config.d.ts +120 -0
  9. package/dist/src/config.js +260 -0
  10. package/dist/src/cyclone_dx_sbom.d.ts +30 -2
  11. package/dist/src/cyclone_dx_sbom.js +95 -9
  12. package/dist/src/index.d.ts +154 -16
  13. package/dist/src/index.js +372 -36
  14. package/dist/src/license/index.d.ts +28 -0
  15. package/dist/src/license/index.js +106 -0
  16. package/dist/src/license/license_utils.d.ts +40 -0
  17. package/dist/src/license/license_utils.js +137 -0
  18. package/dist/src/license/licenses_api.d.ts +34 -0
  19. package/dist/src/license/licenses_api.js +98 -0
  20. package/dist/src/license/project_license.d.ts +20 -0
  21. package/dist/src/license/project_license.js +62 -0
  22. package/dist/src/oci_image/images.d.ts +1 -1
  23. package/dist/src/oci_image/images.js +15 -1
  24. package/dist/src/oci_image/utils.d.ts +5 -5
  25. package/dist/src/oci_image/utils.js +11 -2
  26. package/dist/src/package_version.d.ts +8 -0
  27. package/dist/src/package_version.js +31 -0
  28. package/dist/src/provider.d.ts +16 -3
  29. package/dist/src/provider.js +33 -5
  30. package/dist/src/providers/base_java.d.ts +67 -12
  31. package/dist/src/providers/base_java.js +82 -61
  32. package/dist/src/providers/base_javascript.d.ts +99 -12
  33. package/dist/src/providers/base_javascript.js +244 -28
  34. package/dist/src/providers/base_pyproject.d.ts +158 -0
  35. package/dist/src/providers/base_pyproject.js +322 -0
  36. package/dist/src/providers/containerfile_parser.d.ts +5 -0
  37. package/dist/src/providers/containerfile_parser.js +20 -0
  38. package/dist/src/providers/golang_gomodules.d.ts +30 -13
  39. package/dist/src/providers/golang_gomodules.js +219 -122
  40. package/dist/src/providers/gomod_parser.d.ts +4 -0
  41. package/dist/src/providers/gomod_parser.js +16 -0
  42. package/dist/src/providers/java_gradle.d.ts +73 -0
  43. package/dist/src/providers/java_gradle.js +331 -23
  44. package/dist/src/providers/java_gradle_groovy.d.ts +1 -1
  45. package/dist/src/providers/java_gradle_kotlin.d.ts +1 -1
  46. package/dist/src/providers/java_maven.d.ts +44 -9
  47. package/dist/src/providers/java_maven.js +299 -13
  48. package/dist/src/providers/javascript_bun.d.ts +22 -0
  49. package/dist/src/providers/javascript_bun.js +141 -0
  50. package/dist/src/providers/javascript_npm.d.ts +19 -0
  51. package/dist/src/providers/javascript_npm.js +61 -1
  52. package/dist/src/providers/javascript_pnpm.d.ts +14 -1
  53. package/dist/src/providers/javascript_pnpm.js +55 -5
  54. package/dist/src/providers/javascript_yarn.d.ts +12 -0
  55. package/dist/src/providers/javascript_yarn.js +75 -2
  56. package/dist/src/providers/manifest.d.ts +2 -0
  57. package/dist/src/providers/manifest.js +28 -7
  58. package/dist/src/providers/marker_evaluator.d.ts +14 -0
  59. package/dist/src/providers/marker_evaluator.js +191 -0
  60. package/dist/src/providers/oci_dockerfile.d.ts +51 -0
  61. package/dist/src/providers/oci_dockerfile.js +177 -0
  62. package/dist/src/providers/processors/yarn_berry_processor.d.ts +6 -2
  63. package/dist/src/providers/processors/yarn_berry_processor.js +91 -7
  64. package/dist/src/providers/processors/yarn_classic_processor.d.ts +6 -2
  65. package/dist/src/providers/processors/yarn_classic_processor.js +8 -6
  66. package/dist/src/providers/python_controller.d.ts +5 -1
  67. package/dist/src/providers/python_controller.js +69 -8
  68. package/dist/src/providers/python_pip.d.ts +12 -0
  69. package/dist/src/providers/python_pip.js +18 -8
  70. package/dist/src/providers/python_pip_pyproject.d.ts +61 -0
  71. package/dist/src/providers/python_pip_pyproject.js +146 -0
  72. package/dist/src/providers/python_poetry.d.ts +98 -0
  73. package/dist/src/providers/python_poetry.js +286 -0
  74. package/dist/src/providers/python_uv.d.ts +46 -0
  75. package/dist/src/providers/python_uv.js +275 -0
  76. package/dist/src/providers/requirements_parser.js +6 -9
  77. package/dist/src/providers/rust_cargo.d.ts +56 -0
  78. package/dist/src/providers/rust_cargo.js +682 -0
  79. package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
  80. package/dist/src/providers/tree-sitter-gomod.wasm +0 -0
  81. package/dist/src/providers/tree-sitter-requirements.wasm +0 -0
  82. package/dist/src/remediate.d.ts +107 -0
  83. package/dist/src/remediate.js +244 -0
  84. package/dist/src/remediation.d.ts +81 -0
  85. package/dist/src/remediation.js +475 -0
  86. package/dist/src/remediation_report.d.ts +23 -0
  87. package/dist/src/remediation_report.js +180 -0
  88. package/dist/src/sbom.d.ts +28 -2
  89. package/dist/src/sbom.js +26 -4
  90. package/dist/src/tools.d.ts +53 -11
  91. package/dist/src/tools.js +147 -13
  92. package/dist/src/updaters/maven_updater.d.ts +58 -0
  93. package/dist/src/updaters/maven_updater.js +345 -0
  94. package/dist/src/updaters/toml_updater.d.ts +62 -0
  95. package/dist/src/updaters/toml_updater.js +276 -0
  96. package/dist/src/workspace.d.ts +71 -0
  97. package/dist/src/workspace.js +257 -0
  98. package/package.json +40 -27
@@ -1,14 +1,19 @@
1
+ import crypto from 'node:crypto';
1
2
  import fs from 'node:fs';
3
+ import os from 'node:os';
2
4
  import path from 'node:path';
3
5
  import { EOL } from 'os';
4
- import TOML from 'fast-toml';
6
+ import { parse as parseToml } from 'smol-toml';
7
+ import { readLicenseFile } from '../license/license_utils.js';
5
8
  import Sbom from '../sbom.js';
9
+ import { invokeCommand } from '../tools.js';
10
+ import { filterManifestPathsByDiscoveryIgnore, resolveWorkspaceDiscoveryIgnore } from '../workspace.js';
6
11
  import Base_java, { ecosystem_gradle } from "./base_java.js";
7
12
  /** @typedef {import('../provider.js').Provider} */
8
13
  /** @typedef {import('../provider.js').Provided} Provided */
9
14
  const ROOT_PROJECT_KEY_NAME = "root-project";
10
- const TRUSTIFY_DA_IGNORE_REGEX_LINE = /.*\s?exhortignore\s*$/g;
11
- 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)/;
12
17
  /**
13
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.
14
19
  * @param {string} depToBeIgnored
@@ -49,16 +54,22 @@ export default class Java_gradle extends Base_java {
49
54
  * @param {string} manifestDir - the directory where the manifest lies
50
55
  */
51
56
  validateLockFile() { return true; }
57
+ /**
58
+ * Gradle manifests (build.gradle, build.gradle.kts) have no standard license field.
59
+ * @param {string} manifestPath - path to manifest
60
+ * @returns {null}
61
+ */
62
+ readLicenseFromManifest(manifestPath) { return readLicenseFile(manifestPath); }
52
63
  /**
53
64
  * Provide content and content type for stack analysis.
54
65
  * @param {string} manifest - the manifest path or name
55
66
  * @param {{}} [opts={}] - optional various options to pass along the application
56
67
  * @returns {Provided}
57
68
  */
58
- provideStack(manifest, opts = {}) {
69
+ async provideStack(manifest, opts = {}) {
59
70
  return {
60
71
  ecosystem: ecosystem_gradle,
61
- content: this.#createSbomStackAnalysis(manifest, opts),
72
+ content: await this.#createSbomStackAnalysis(manifest, opts),
62
73
  contentType: 'application/vnd.cyclonedx+json'
63
74
  };
64
75
  }
@@ -68,10 +79,10 @@ export default class Java_gradle extends Base_java {
68
79
  * @param {{}} [opts={}] - optional various options to pass along the application
69
80
  * @returns {Provided}
70
81
  */
71
- provideComponent(manifest, opts = {}) {
82
+ async provideComponent(manifest, opts = {}) {
72
83
  return {
73
84
  ecosystem: ecosystem_gradle,
74
- content: this.#getSbomForComponentAnalysis(manifest, opts),
85
+ content: await this.#getSbomForComponentAnalysis(manifest, opts),
75
86
  contentType: 'application/vnd.cyclonedx+json'
76
87
  };
77
88
  }
@@ -121,9 +132,10 @@ export default class Java_gradle extends Base_java {
121
132
  * @param {Sbom} sbom - the SBOM object to add dependencies to
122
133
  * @param {Set} processedDeps - set of already processed dependencies
123
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
124
136
  * @private
125
137
  */
126
- #processDependencyTree(config, parentPurl, sbom, processedDeps, scope) {
138
+ #processDependencyTree(config, parentPurl, sbom, processedDeps, scope, hashMap) {
127
139
  const processedLines = this.#prepareLinesForParsingDependencyTree(config);
128
140
  let parentStack = [parentPurl];
129
141
  for (const { line, depth } of processedLines) {
@@ -141,12 +153,18 @@ export default class Java_gradle extends Base_java {
141
153
  // Add dependency to SBOM if not already processed
142
154
  if (!processedDeps.has(depKey)) {
143
155
  processedDeps.add(depKey);
144
- sbom.addDependency(currentParent, purl, scope);
156
+ sbom.addDependency(currentParent, purl, scope, hashMap?.get(purl.toString()));
145
157
  }
146
158
  parentStack.push(purl);
147
159
  }
148
160
  }
149
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
+ }
150
168
  /**
151
169
  * Create a Dot Graph dependency tree for a manifest path.
152
170
  * @param {string} manifest - path for pom.xml
@@ -154,16 +172,17 @@ export default class Java_gradle extends Base_java {
154
172
  * @returns {string} the Dot Graph content
155
173
  * @private
156
174
  */
157
- #buildSbom(content, properties, manifestPath, opts = {}) {
175
+ #buildSbom(content, properties, manifestPath, opts = {}, hashMap) {
158
176
  let sbom = new Sbom();
159
- let root = `${properties.group}:${properties[ROOT_PROJECT_KEY_NAME].match(/Root project '(.+)'/)[1]}:jar:${properties.version}`;
177
+ let root = this.#buildRootCoordinate(properties);
160
178
  let rootPurl = this.parseDep(root);
161
- sbom.addRoot(rootPurl);
179
+ const license = this.readLicenseFromManifest(manifestPath);
180
+ sbom.addRoot(rootPurl, license);
162
181
  let ignoredDeps = this.#getIgnoredDeps(manifestPath);
163
182
  const [runtimeConfig, compileConfig] = this.#extractConfigurations(content);
164
183
  const processedDeps = new Set();
165
- this.#processDependencyTree(runtimeConfig, rootPurl, sbom, processedDeps, 'required');
166
- 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);
167
186
  return sbom.filterIgnoredDepsIncludingVersion(ignoredDeps).getAsJsonString(opts);
168
187
  }
169
188
  /**
@@ -173,14 +192,15 @@ export default class Java_gradle extends Base_java {
173
192
  * @returns {string} the Dot Graph content
174
193
  * @private
175
194
  */
176
- #createSbomStackAnalysis(manifest, opts = {}) {
195
+ async #createSbomStackAnalysis(manifest, opts = {}) {
177
196
  let content = this.#getDependencies(manifest, opts);
178
197
  let properties = this.#extractProperties(manifest, opts);
198
+ let hashMap = await this.parseGradleHashes(manifest, opts);
179
199
  // read dependency tree from temp file
180
200
  if (process.env["TRUSTIFY_DA_DEBUG"] === "true") {
181
201
  console.log("Dependency tree that will be used as input for creating the BOM =>" + EOL + EOL + content);
182
202
  }
183
- let sbom = this.#buildSbom(content, properties, manifest, opts);
203
+ let sbom = this.#buildSbom(content, properties, manifest, opts, hashMap);
184
204
  return sbom;
185
205
  }
186
206
  /**
@@ -225,10 +245,11 @@ export default class Java_gradle extends Base_java {
225
245
  * @returns {string} - sbom string of the direct dependencies of build.gradle
226
246
  * @private
227
247
  */
228
- #getSbomForComponentAnalysis(manifestPath, opts = {}) {
248
+ async #getSbomForComponentAnalysis(manifestPath, opts = {}) {
229
249
  let content = this.#getDependencies(manifestPath, opts);
230
250
  let properties = this.#extractProperties(manifestPath, opts);
231
- 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);
232
253
  return sbom;
233
254
  }
234
255
  /**
@@ -247,6 +268,112 @@ export default class Java_gradle extends Base_java {
247
268
  throw new Error(`Couldn't run gradle dependencies command, error message returned from gradle binary => ${EOL} ${error.message}`);
248
269
  }
249
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
+ }
250
377
  /**
251
378
  * Extracts runtime and compile configurations from the dependency tree
252
379
  * @param {string} content - the dependency tree content
@@ -294,11 +421,12 @@ export default class Java_gradle extends Base_java {
294
421
  * @param properties {Object} - properties of the gradle project.
295
422
  * @return {string} return sbom json string of the build.gradle manifest file
296
423
  */
297
- #buildDirectDependenciesSbom(content, properties, manifestPath, opts = {}) {
424
+ #buildDirectDependenciesSbom(content, properties, manifestPath, opts = {}, hashMap) {
298
425
  let sbom = new Sbom();
299
- let root = `${properties.group}:${properties[ROOT_PROJECT_KEY_NAME].match(/Root project '(.+)'/)[1]}:jar:${properties.version}`;
426
+ let root = this.#buildRootCoordinate(properties);
300
427
  let rootPurl = this.parseDep(root);
301
- sbom.addRoot(rootPurl);
428
+ const license = this.readLicenseFromManifest(manifestPath);
429
+ sbom.addRoot(rootPurl, license);
302
430
  let ignoredDeps = this.#getIgnoredDeps(manifestPath);
303
431
  const [runtimeConfig, compileConfig] = this.#extractConfigurations(content);
304
432
  let directDependencies = new Map();
@@ -307,7 +435,7 @@ export default class Java_gradle extends Base_java {
307
435
  directDependencies.forEach((scope, dep) => {
308
436
  const purl = this.parseDep(dep);
309
437
  purl.scope = scope;
310
- sbom.addDependency(rootPurl, purl, scope);
438
+ sbom.addDependency(rootPurl, purl, scope, hashMap?.get(purl.toString()));
311
439
  });
312
440
  return sbom.filterIgnoredDepsIncludingVersion(ignoredDeps).getAsJsonString(opts);
313
441
  }
@@ -352,7 +480,7 @@ export default class Java_gradle extends Base_java {
352
480
  // Read and parse the TOML file
353
481
  let pathOfToml = path.join(path.dirname(manifestPath), "gradle", "libs.versions.toml");
354
482
  const tomlString = fs.readFileSync(pathOfToml).toString();
355
- let tomlObject = TOML.parse(tomlString);
483
+ let tomlObject = parseToml(tomlString);
356
484
  let groupPlusArtifactObject = tomlObject.libraries[alias];
357
485
  let parts = groupPlusArtifactObject.module.split(":");
358
486
  let groupId = parts[0];
@@ -397,3 +525,183 @@ export default class Java_gradle extends Base_java {
397
525
  return undefined;
398
526
  }
399
527
  }
528
+ const DEFAULT_GRADLE_DISCOVERY_IGNORE = [
529
+ '**/build/**',
530
+ '**/.gradle/**',
531
+ ];
532
+ /** Gradle init script that emits structured project listing. */
533
+ const GRADLE_INIT_SCRIPT = `allprojects {
534
+ task daListProjects {
535
+ doLast {
536
+ println "::DA_PROJECT::\${project.path}::\${project.projectDir}"
537
+ }
538
+ }
539
+ }
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
+ `;
564
+ /**
565
+ * Discover all build.gradle[.kts] manifest paths in a Gradle multi-project build.
566
+ * Uses a custom init script to get structured project listing.
567
+ *
568
+ * @param {string} workspaceRoot - Absolute or relative path to workspace root (must contain settings.gradle[.kts])
569
+ * @param {import('../index.js').Options} [opts={}]
570
+ * @returns {Promise<string[]>} Paths to build.gradle[.kts] files (absolute)
571
+ */
572
+ export async function discoverGradleSubprojects(workspaceRoot, opts = {}) {
573
+ const root = path.resolve(workspaceRoot);
574
+ const hasSettings = fs.existsSync(path.join(root, 'settings.gradle'))
575
+ || fs.existsSync(path.join(root, 'settings.gradle.kts'));
576
+ if (!hasSettings) {
577
+ return [];
578
+ }
579
+ const manifestPaths = [];
580
+ const rootBuildKts = path.join(root, 'build.gradle.kts');
581
+ const rootBuild = path.join(root, 'build.gradle');
582
+ const rootManifest = fs.existsSync(rootBuildKts) ? rootBuildKts : fs.existsSync(rootBuild) ? rootBuild : null;
583
+ if (rootManifest) {
584
+ manifestPaths.push(rootManifest);
585
+ }
586
+ let gradleBin;
587
+ try {
588
+ gradleBin = new Java_gradle().selectToolBinary(rootManifest || rootBuild, opts);
589
+ }
590
+ catch {
591
+ const ignorePatterns = [...resolveWorkspaceDiscoveryIgnore(opts), ...DEFAULT_GRADLE_DISCOVERY_IGNORE];
592
+ return filterManifestPathsByDiscoveryIgnore(manifestPaths, root, ignorePatterns);
593
+ }
594
+ const initScriptPath = path.join(os.tmpdir(), `da-list-projects-${crypto.randomUUID()}.gradle`);
595
+ try {
596
+ fs.writeFileSync(initScriptPath, GRADLE_INIT_SCRIPT);
597
+ let output;
598
+ try {
599
+ output = invokeCommand(gradleBin, [
600
+ '-q', '--no-daemon',
601
+ '--init-script', initScriptPath,
602
+ 'daListProjects',
603
+ ], { cwd: root });
604
+ }
605
+ catch {
606
+ const ignorePatterns = [...resolveWorkspaceDiscoveryIgnore(opts), ...DEFAULT_GRADLE_DISCOVERY_IGNORE];
607
+ return filterManifestPathsByDiscoveryIgnore(manifestPaths, root, ignorePatterns);
608
+ }
609
+ const projects = parseGradleInitScriptOutput(output.toString());
610
+ for (const proj of projects) {
611
+ if (proj.path === ':') {
612
+ continue;
613
+ }
614
+ const projDir = path.resolve(proj.dir);
615
+ const buildKts = path.join(projDir, 'build.gradle.kts');
616
+ const buildGroovy = path.join(projDir, 'build.gradle');
617
+ if (fs.existsSync(buildKts)) {
618
+ manifestPaths.push(buildKts);
619
+ }
620
+ else if (fs.existsSync(buildGroovy)) {
621
+ manifestPaths.push(buildGroovy);
622
+ }
623
+ }
624
+ }
625
+ finally {
626
+ try {
627
+ fs.unlinkSync(initScriptPath);
628
+ }
629
+ catch { /* ignore */ }
630
+ }
631
+ const ignorePatterns = [...resolveWorkspaceDiscoveryIgnore(opts), ...DEFAULT_GRADLE_DISCOVERY_IGNORE];
632
+ return filterManifestPathsByDiscoveryIgnore(manifestPaths, root, ignorePatterns);
633
+ }
634
+ /**
635
+ * Parse the structured output from the Gradle init script.
636
+ *
637
+ * @param {string} raw - Raw stdout from gradle
638
+ * @returns {{ path: string, dir: string }[]}
639
+ */
640
+ export function parseGradleInitScriptOutput(raw) {
641
+ const projects = [];
642
+ for (const rawLine of raw.split('\n')) {
643
+ const line = rawLine.trimEnd();
644
+ if (!line.startsWith('::DA_PROJECT::')) {
645
+ continue;
646
+ }
647
+ const prefix = '::DA_PROJECT::';
648
+ const remainder = line.substring(prefix.length);
649
+ const lastSep = remainder.lastIndexOf('::');
650
+ if (lastSep < 0) {
651
+ continue;
652
+ }
653
+ const projPath = remainder.substring(0, lastSep);
654
+ const dir = remainder.substring(lastSep + 2);
655
+ if (projPath && dir) {
656
+ projects.push({ path: projPath, dir });
657
+ }
658
+ }
659
+ return projects;
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';
@@ -1,8 +1,16 @@
1
- /** @typedef {import('../provider').Provider} */
2
- /** @typedef {import('../provider').Provided} Provided */
3
- /** @typedef {{name: string, version: string}} Package */
4
- /** @typedef {{groupId: string, artifactId: string, version: string, scope: string, ignore: boolean}} Dependency */
1
+ /**
2
+ * Discover all pom.xml manifest paths in a Maven multi-module project.
3
+ *
4
+ * @param {string} workspaceRoot - Absolute or relative path to workspace root (must contain pom.xml)
5
+ * @param {object} [opts={}]
6
+ * @returns {Promise<string[]>} Paths to pom.xml files (absolute)
7
+ */
8
+ export function discoverMavenModules(workspaceRoot: string, opts?: object): Promise<string[]>;
5
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
+ };
6
14
  constructor();
7
15
  /**
8
16
  * @param {string} manifestName - the subject manifest name-type
@@ -17,9 +25,9 @@ export default class Java_maven extends Base_java {
17
25
  * Provide content and content type for maven-maven stack analysis.
18
26
  * @param {string} manifest - the manifest path or name
19
27
  * @param {{}} [opts={}] - optional various options to pass along the application
20
- * @returns {Provided}
28
+ * @returns {Promise<Provided>}
21
29
  */
22
- provideStack(manifest: string, opts?: {}): Provided;
30
+ provideStack(manifest: string, opts?: {}): Promise<Provided>;
23
31
  /**
24
32
  * Provide content and content type for maven-maven component analysis.
25
33
  * @param {string} manifest - path to the manifest file
@@ -28,16 +36,43 @@ export default class Java_maven extends Base_java {
28
36
  */
29
37
  provideComponent(manifest: string, opts?: {}): Provided;
30
38
  /**
39
+ * Read license from pom.xml manifest, with fallback to LICENSE file
40
+ * @param {string} manifestPath - path to pom.xml
41
+ * @returns {string|null}
42
+ */
43
+ readLicenseFromManifest(manifestPath: string): string | null;
44
+ /**
45
+ * Build a Map of PURL string → CycloneDX hash entries by reading artifact files from the local Maven repository.
31
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.
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
+ /**
32
62
  * @param {String} textGraphList Text graph String of the manifest
33
63
  * @param {[String]} ignoredDeps List of ignored dependencies to be omitted from sbom
64
+ * @param {{}} opts Options
65
+ * @param {String} manifestPath Path to the pom.xml manifest
66
+ * @param {Map<string, Array<{alg: string, content: string}>>} [hashMap] PURL→hashes map
34
67
  * @return {String} formatted sbom Json String with all dependencies
35
68
  */
36
- createSbomFileFromTextFormat(textGraphList: string, ignoredDeps: [string], opts: any): string;
69
+ createSbomFileFromTextFormat(textGraphList: string, ignoredDeps: [string], opts: {}, manifestPath: string, hashMap?: Map<string, Array<{
70
+ alg: string;
71
+ content: string;
72
+ }>>): string;
37
73
  #private;
38
74
  }
39
- export type Java_maven = import("../provider").Provider;
40
- export type Provided = import("../provider").Provided;
75
+ export type Provided = any;
41
76
  export type Package = {
42
77
  name: string;
43
78
  version: string;