@trustify-da/trustify-da-javascript-client 0.3.0-ea.c2f6c64 → 0.3.0-ea.c300d9f

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 (86) hide show
  1. package/README.md +199 -11
  2. package/dist/package.json +30 -26
  3. package/dist/src/analysis.d.ts +14 -7
  4. package/dist/src/analysis.js +32 -14
  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 +20 -1
  9. package/dist/src/cyclone_dx_sbom.js +68 -9
  10. package/dist/src/index.d.ts +79 -15
  11. package/dist/src/index.js +90 -34
  12. package/dist/src/license/index.d.ts +3 -3
  13. package/dist/src/license/index.js +4 -1
  14. package/dist/src/license/license_utils.js +4 -1
  15. package/dist/src/license/licenses_api.d.ts +2 -2
  16. package/dist/src/oci_image/images.d.ts +1 -1
  17. package/dist/src/oci_image/images.js +15 -1
  18. package/dist/src/oci_image/utils.d.ts +5 -5
  19. package/dist/src/package_version.d.ts +8 -0
  20. package/dist/src/package_version.js +31 -0
  21. package/dist/src/provider.d.ts +4 -3
  22. package/dist/src/provider.js +8 -2
  23. package/dist/src/providers/base_java.d.ts +67 -12
  24. package/dist/src/providers/base_java.js +82 -61
  25. package/dist/src/providers/base_javascript.d.ts +74 -9
  26. package/dist/src/providers/base_javascript.js +116 -7
  27. package/dist/src/providers/base_pyproject.d.ts +42 -31
  28. package/dist/src/providers/base_pyproject.js +121 -78
  29. package/dist/src/providers/containerfile_parser.d.ts +5 -0
  30. package/dist/src/providers/containerfile_parser.js +20 -0
  31. package/dist/src/providers/golang_gomodules.d.ts +11 -1
  32. package/dist/src/providers/golang_gomodules.js +114 -15
  33. package/dist/src/providers/java_gradle.d.ts +67 -0
  34. package/dist/src/providers/java_gradle.js +312 -20
  35. package/dist/src/providers/java_gradle_groovy.d.ts +1 -1
  36. package/dist/src/providers/java_gradle_kotlin.d.ts +1 -1
  37. package/dist/src/providers/java_maven.d.ts +37 -9
  38. package/dist/src/providers/java_maven.js +269 -11
  39. package/dist/src/providers/javascript_bun.d.ts +22 -0
  40. package/dist/src/providers/javascript_bun.js +141 -0
  41. package/dist/src/providers/javascript_npm.d.ts +19 -0
  42. package/dist/src/providers/javascript_npm.js +61 -1
  43. package/dist/src/providers/javascript_pnpm.d.ts +13 -0
  44. package/dist/src/providers/javascript_pnpm.js +53 -3
  45. package/dist/src/providers/javascript_yarn.d.ts +12 -0
  46. package/dist/src/providers/javascript_yarn.js +75 -2
  47. package/dist/src/providers/manifest.js +6 -3
  48. package/dist/src/providers/marker_evaluator.d.ts +14 -0
  49. package/dist/src/providers/marker_evaluator.js +191 -0
  50. package/dist/src/providers/oci_dockerfile.d.ts +51 -0
  51. package/dist/src/providers/oci_dockerfile.js +177 -0
  52. package/dist/src/providers/processors/yarn_berry_processor.d.ts +6 -2
  53. package/dist/src/providers/processors/yarn_berry_processor.js +9 -4
  54. package/dist/src/providers/processors/yarn_classic_processor.d.ts +6 -2
  55. package/dist/src/providers/processors/yarn_classic_processor.js +8 -6
  56. package/dist/src/providers/python_controller.d.ts +5 -1
  57. package/dist/src/providers/python_controller.js +69 -8
  58. package/dist/src/providers/python_pip.d.ts +5 -0
  59. package/dist/src/providers/python_pip.js +5 -5
  60. package/dist/src/providers/python_pip_pyproject.d.ts +61 -0
  61. package/dist/src/providers/python_pip_pyproject.js +146 -0
  62. package/dist/src/providers/python_poetry.d.ts +64 -8
  63. package/dist/src/providers/python_poetry.js +165 -25
  64. package/dist/src/providers/python_uv.d.ts +22 -2
  65. package/dist/src/providers/python_uv.js +157 -6
  66. package/dist/src/providers/requirements_parser.js +1 -1
  67. package/dist/src/providers/rust_cargo.d.ts +6 -2
  68. package/dist/src/providers/rust_cargo.js +101 -33
  69. package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
  70. package/dist/src/remediate.d.ts +120 -0
  71. package/dist/src/remediate.js +253 -0
  72. package/dist/src/remediation.d.ts +57 -0
  73. package/dist/src/remediation.js +436 -0
  74. package/dist/src/remediation_report.d.ts +40 -0
  75. package/dist/src/remediation_report.js +159 -0
  76. package/dist/src/sbom.d.ts +18 -1
  77. package/dist/src/sbom.js +14 -2
  78. package/dist/src/tools.d.ts +37 -13
  79. package/dist/src/tools.js +92 -13
  80. package/dist/src/updaters/maven_updater.d.ts +58 -0
  81. package/dist/src/updaters/maven_updater.js +345 -0
  82. package/dist/src/updaters/toml_updater.d.ts +62 -0
  83. package/dist/src/updaters/toml_updater.js +276 -0
  84. package/dist/src/workspace.d.ts +11 -1
  85. package/dist/src/workspace.js +3 -2
  86. package/package.json +31 -27
@@ -4,8 +4,9 @@ import { PackageURL } from 'packageurl-js';
4
4
  import { readLicenseFile } from '../license/license_utils.js';
5
5
  import Sbom from '../sbom.js';
6
6
  import { getCustom, getCustomPath, invokeCommand } from "../tools.js";
7
+ import { filterManifestPathsByDiscoveryIgnore, resolveWorkspaceDiscoveryIgnore } from '../workspace.js';
7
8
  import { getParser, getRequireQuery } from './gomod_parser.js';
8
- export default { isSupported, validateLockFile, provideComponent, provideStack, readLicenseFromManifest };
9
+ export default { isSupported, validateLockFile, provideComponent, provideStack, readLicenseFromManifest, packageManagerName() { return 'go'; } };
9
10
  /** @typedef {import('../provider').Provider} */
10
11
  /** @typedef {import('../provider').Provided} Provided */
11
12
  /** @typedef {{name: string, version: string}} Package */
@@ -77,9 +78,10 @@ function getChildVertexFromEdge(edge) {
77
78
  return edge.split(" ")[1];
78
79
  }
79
80
  /**
80
- * Check whether a require_spec has a valid exhortignore marker.
81
- * For direct dependencies: `//exhortignore` or `// exhortignore`
82
- * 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)
83
85
  * @param {import('web-tree-sitter').SyntaxNode} specNode
84
86
  * @return {boolean}
85
87
  */
@@ -91,10 +93,10 @@ function hasExhortIgnore(specNode) {
91
93
  let comments = specNode.children.filter(c => c.type === 'comment');
92
94
  for (let comment of comments) {
93
95
  let text = comment.text;
94
- if (/^\/\/\s*indirect;\s*exhortignore/.test(text)) {
96
+ if (/^\/\/\s*indirect;\s*(exhortignore|trustify-da-ignore)(?![\w-])/.test(text)) {
95
97
  return true;
96
98
  }
97
- if (/^\/\/\s*exhortignore/.test(text)) {
99
+ if (/^\/\/\s*(exhortignore|trustify-da-ignore)(?![\w-])/.test(text)) {
98
100
  return true;
99
101
  }
100
102
  }
@@ -186,6 +188,36 @@ function performManifestVersionsCheck(rootElementName, goModGraphOutputRows, man
186
188
  throw error;
187
189
  }
188
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
+ }
189
221
  /**
190
222
  * Create SBOM json string for go Module.
191
223
  * @param {string} manifest - path for go.mod
@@ -240,6 +272,7 @@ async function getSBOM(manifest, opts = {}, includeTransitive) {
240
272
  if (matchManifestVersions === "true") {
241
273
  performManifestVersionsCheck(root, rows, manifestContent, parser, requireQuery);
242
274
  }
275
+ let goSumHashes = parseGoSumHashes(manifestDir);
243
276
  const mainModule = toPurl(root, "@");
244
277
  const license = readLicenseFromManifest(manifest);
245
278
  sbom.addRoot(mainModule, license);
@@ -261,7 +294,7 @@ async function getSBOM(manifest, opts = {}, includeTransitive) {
261
294
  if (getParentVertexFromEdge(row) === root && !directDepPaths.has(getPackageName(child))) {
262
295
  return;
263
296
  }
264
- sbom.addDependency(source, target);
297
+ sbom.addDependency(source, target, undefined, goSumHashes.get(child));
265
298
  });
266
299
  // at the end, filter out all ignored dependencies including versions.
267
300
  sbom.filterIgnoredDepsIncludingVersion(allIgnoredDeps);
@@ -274,12 +307,22 @@ async function getSBOM(manifest, opts = {}, includeTransitive) {
274
307
  let target = toPurl(child, "@");
275
308
  if (dependencyNotIgnored(ignoredDeps, target)) {
276
309
  if (directDepPaths.has(getPackageName(child))) {
277
- sbom.addDependency(mainModule, target);
310
+ sbom.addDependency(mainModule, target, undefined, goSumHashes.get(child));
278
311
  }
279
312
  }
280
313
  });
281
314
  enforceRemovingIgnoredDepsInCaseOfAutomaticVersionUpdate(ignoredDeps, sbom);
282
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
+ }
283
326
  return sbom.getAsJsonString(opts);
284
327
  }
285
328
  /**
@@ -328,13 +371,7 @@ function getFinalPackagesVersionsForModule(rows, manifestPath, goBin) {
328
371
  catch (error) {
329
372
  throw new Error('failed to list all modules', { cause: error });
330
373
  }
331
- let finalVersionModules = new Map();
332
- finalVersionsForAllModules.split(getLineSeparatorGolang()).filter(string => string.trim() !== "")
333
- .filter(string => string.trim().split(" ").length === 2)
334
- .forEach((dependency) => {
335
- let dep = dependency.split(" ");
336
- finalVersionModules[dep[0]] = dep[1];
337
- });
374
+ let finalVersionModules = parseModuleVersions(finalVersionsForAllModules);
338
375
  let finalVersionModulesArray = new Array();
339
376
  rows.filter(string => string.trim() !== "").forEach(module => {
340
377
  let child = getChildVertexFromEdge(module);
@@ -395,7 +432,69 @@ function getVersionOfPackage(fullPackage) {
395
432
  let parts = fullPackage.split("@");
396
433
  return parts.length > 1 ? parts[1] : undefined;
397
434
  }
435
+ function parseModuleVersions(goListOutput) {
436
+ let modules = {};
437
+ goListOutput.split(getLineSeparatorGolang()).filter(string => string.trim() !== "")
438
+ .forEach((line) => {
439
+ let parts = line.trim().split(" ");
440
+ if (parts.length === 2) {
441
+ modules[parts[0]] = parts[1];
442
+ }
443
+ else if (parts.length >= 4 && parts[2] === "=>") {
444
+ modules[parts[0]] = parts[parts.length - 1];
445
+ }
446
+ });
447
+ return modules;
448
+ }
398
449
  function getLineSeparatorGolang() {
399
450
  let reg = /\n|\r\n/;
400
451
  return reg;
401
452
  }
453
+ /**
454
+ * Discover all go.mod manifest paths in a Go workspace.
455
+ * Uses `go work edit -json` to get workspace members.
456
+ *
457
+ * @param {string} workspaceRoot - Absolute or relative path to workspace root (must contain go.work)
458
+ * @param {import('../index.js').Options} [opts={}]
459
+ * @returns {Promise<string[]>} Paths to go.mod files (absolute)
460
+ */
461
+ export async function discoverGoWorkspaceModules(workspaceRoot, opts = {}) {
462
+ const root = path.resolve(workspaceRoot);
463
+ const goWork = path.join(root, 'go.work');
464
+ if (!fs.existsSync(goWork)) {
465
+ return [];
466
+ }
467
+ const goBin = getCustomPath('go', opts);
468
+ let output;
469
+ try {
470
+ output = invokeCommand(goBin, ['work', 'edit', '-json', goWork], { cwd: root });
471
+ }
472
+ catch {
473
+ return [];
474
+ }
475
+ let workspace;
476
+ try {
477
+ workspace = JSON.parse(output.toString().trim());
478
+ }
479
+ catch {
480
+ return [];
481
+ }
482
+ const useEntries = workspace.Use || [];
483
+ if (useEntries.length === 0) {
484
+ return [];
485
+ }
486
+ const manifestPaths = [];
487
+ for (const entry of useEntries) {
488
+ const diskPath = entry.DiskPath;
489
+ if (!diskPath) {
490
+ continue;
491
+ }
492
+ const moduleDir = path.resolve(root, diskPath);
493
+ const goMod = path.join(moduleDir, 'go.mod');
494
+ if (fs.existsSync(goMod)) {
495
+ manifestPaths.push(goMod);
496
+ }
497
+ }
498
+ const ignorePatterns = resolveWorkspaceDiscoveryIgnore(opts);
499
+ return filterManifestPathsByDiscoveryIgnore(manifestPaths, root, ignorePatterns);
500
+ }
@@ -1,3 +1,46 @@
1
+ /**
2
+ * Discover all build.gradle[.kts] manifest paths in a Gradle multi-project build.
3
+ * Uses a custom init script to get structured project listing.
4
+ *
5
+ * @param {string} workspaceRoot - Absolute or relative path to workspace root (must contain settings.gradle[.kts])
6
+ * @param {import('../index.js').Options} [opts={}]
7
+ * @returns {Promise<string[]>} Paths to build.gradle[.kts] files (absolute)
8
+ */
9
+ export function discoverGradleSubprojects(workspaceRoot: string, opts?: import("../index.js").Options): Promise<string[]>;
10
+ /**
11
+ * Parse the structured output from the Gradle init script.
12
+ *
13
+ * @param {string} raw - Raw stdout from gradle
14
+ * @returns {{ path: string, dir: string }[]}
15
+ */
16
+ export function parseGradleInitScriptOutput(raw: string): {
17
+ path: string;
18
+ dir: string;
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;
1
44
  /**
2
45
  * This class provides common functionality for Groovy and Kotlin DSL files.
3
46
  */
@@ -35,6 +78,30 @@ export default class Java_gradle extends Base_java {
35
78
  * @returns {Provided}
36
79
  */
37
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
+ }>>>;
38
105
  #private;
39
106
  }
40
107
  export type Provided = import("../provider.js").Provided;