@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.
Files changed (75) hide show
  1. package/README.md +177 -3
  2. package/dist/package.json +29 -22
  3. package/dist/src/analysis.d.ts +14 -7
  4. package/dist/src/analysis.js +29 -13
  5. package/dist/src/cli.js +106 -2
  6. package/dist/src/cyclone_dx_sbom.d.ts +13 -0
  7. package/dist/src/cyclone_dx_sbom.js +50 -4
  8. package/dist/src/index.d.ts +14 -10
  9. package/dist/src/index.js +15 -26
  10. package/dist/src/license/index.d.ts +3 -3
  11. package/dist/src/license/index.js +4 -1
  12. package/dist/src/license/license_utils.js +4 -1
  13. package/dist/src/license/licenses_api.d.ts +2 -2
  14. package/dist/src/oci_image/images.d.ts +1 -1
  15. package/dist/src/oci_image/images.js +15 -1
  16. package/dist/src/oci_image/utils.d.ts +5 -5
  17. package/dist/src/package_version.d.ts +8 -0
  18. package/dist/src/package_version.js +31 -0
  19. package/dist/src/provider.d.ts +4 -3
  20. package/dist/src/provider.js +4 -2
  21. package/dist/src/providers/base_java.d.ts +67 -3
  22. package/dist/src/providers/base_java.js +80 -23
  23. package/dist/src/providers/base_javascript.d.ts +68 -9
  24. package/dist/src/providers/base_javascript.js +112 -3
  25. package/dist/src/providers/base_pyproject.d.ts +10 -5
  26. package/dist/src/providers/base_pyproject.js +7 -0
  27. package/dist/src/providers/containerfile_parser.d.ts +5 -0
  28. package/dist/src/providers/containerfile_parser.js +20 -0
  29. package/dist/src/providers/golang_gomodules.d.ts +2 -1
  30. package/dist/src/providers/golang_gomodules.js +44 -3
  31. package/dist/src/providers/java_gradle.d.ts +48 -0
  32. package/dist/src/providers/java_gradle.js +194 -15
  33. package/dist/src/providers/java_gradle_groovy.d.ts +1 -1
  34. package/dist/src/providers/java_gradle_kotlin.d.ts +1 -1
  35. package/dist/src/providers/java_maven.d.ts +30 -5
  36. package/dist/src/providers/java_maven.js +168 -7
  37. package/dist/src/providers/javascript_bun.d.ts +12 -0
  38. package/dist/src/providers/javascript_bun.js +42 -1
  39. package/dist/src/providers/javascript_npm.d.ts +19 -1
  40. package/dist/src/providers/javascript_npm.js +40 -1
  41. package/dist/src/providers/javascript_pnpm.d.ts +13 -0
  42. package/dist/src/providers/javascript_pnpm.js +47 -1
  43. package/dist/src/providers/javascript_yarn.d.ts +12 -0
  44. package/dist/src/providers/javascript_yarn.js +75 -2
  45. package/dist/src/providers/oci_dockerfile.d.ts +51 -0
  46. package/dist/src/providers/oci_dockerfile.js +177 -0
  47. package/dist/src/providers/processors/yarn_berry_processor.d.ts +6 -2
  48. package/dist/src/providers/processors/yarn_berry_processor.js +3 -2
  49. package/dist/src/providers/processors/yarn_classic_processor.d.ts +6 -2
  50. package/dist/src/providers/processors/yarn_classic_processor.js +8 -6
  51. package/dist/src/providers/python_controller.js +61 -4
  52. package/dist/src/providers/python_pip.d.ts +1 -0
  53. package/dist/src/providers/python_pip.js +1 -1
  54. package/dist/src/providers/python_poetry.d.ts +31 -8
  55. package/dist/src/providers/python_poetry.js +62 -14
  56. package/dist/src/providers/python_uv.d.ts +5 -14
  57. package/dist/src/providers/python_uv.js +44 -2
  58. package/dist/src/providers/rust_cargo.d.ts +6 -2
  59. package/dist/src/providers/rust_cargo.js +101 -33
  60. package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
  61. package/dist/src/remediate.d.ts +21 -0
  62. package/dist/src/remediate.js +149 -0
  63. package/dist/src/remediation.d.ts +57 -0
  64. package/dist/src/remediation.js +436 -0
  65. package/dist/src/remediation_report.d.ts +40 -0
  66. package/dist/src/remediation_report.js +159 -0
  67. package/dist/src/sbom.d.ts +11 -0
  68. package/dist/src/sbom.js +10 -0
  69. package/dist/src/tools.d.ts +2 -2
  70. package/dist/src/tools.js +24 -1
  71. package/dist/src/updaters/maven_updater.d.ts +26 -0
  72. package/dist/src/updaters/maven_updater.js +322 -0
  73. package/dist/src/updaters/toml_updater.d.ts +33 -0
  74. package/dist/src/updaters/toml_updater.js +244 -0
  75. package/package.json +30 -23
@@ -13,27 +13,18 @@ export function discoverUvWorkspaceMembers(workspaceRoot: string, opts?: {
13
13
  }): Promise<string[]>;
14
14
  export default class Python_uv extends Base_pyproject {
15
15
  /**
16
- * @param {string} manifestDir - directory containing the target pyproject.toml
17
- * @param {string} workspaceDir - workspace root (for resolving editable install paths)
18
- * @param {object} parsed - parsed pyproject.toml
19
- * @param {Object} opts
20
- * @returns {Promise<{directDeps: string[], graph: Map<string, {name: string, version: string, children: string[]}>}>}
16
+ * Parse uv.lock and attach SHA-256 hashes to graph entries.
17
+ * @param {string} lockFilePath - path to uv.lock
18
+ * @param {Map<string, import('./base_pyproject.js').GraphEntry>} graph
21
19
  */
22
- _getDependencyData(manifestDir: string, workspaceDir: string, parsed: object, opts: any): Promise<{
23
- directDeps: string[];
24
- graph: Map<string, {
25
- name: string;
26
- version: string;
27
- children: string[];
28
- }>;
29
- }>;
20
+ _attachHashesFromLockFile(lockFilePath: string, graph: Map<string, import("./base_pyproject.js").GraphEntry>): Promise<void>;
30
21
  /**
31
22
  * Get the uv export output, either from env var or by running the command.
32
23
  * @param {string} manifestDir
33
24
  * @param {Object} opts
34
25
  * @returns {string}
35
26
  */
36
- _getUvExportOutput(manifestDir: string, opts: any): string;
27
+ _getUvExportOutput(manifestDir: string, opts: Object): string;
37
28
  /**
38
29
  * Parse uv export output into a dependency graph using tree-sitter-requirements
39
30
  * for package/version extraction and string parsing for "# via" comments.
@@ -21,12 +21,54 @@ export default class Python_uv extends Base_pyproject {
21
21
  * @param {string} workspaceDir - workspace root (for resolving editable install paths)
22
22
  * @param {object} parsed - parsed pyproject.toml
23
23
  * @param {Object} opts
24
- * @returns {Promise<{directDeps: string[], graph: Map<string, {name: string, version: string, children: string[]}>}>}
24
+ * @returns {Promise<{directDeps: string[], graph: Map<string, import('./base_pyproject.js').GraphEntry>}>}
25
25
  */
26
26
  async _getDependencyData(manifestDir, workspaceDir, parsed, opts) {
27
27
  let projectName = this._getProjectName(parsed);
28
28
  let uvOutput = this._getUvExportOutput(manifestDir, opts);
29
- return this._parseUvExport(uvOutput, projectName, workspaceDir);
29
+ let { directDeps, graph } = await this._parseUvExport(uvOutput, projectName, workspaceDir);
30
+ await this._attachHashesFromLockFile(path.join(workspaceDir, 'uv.lock'), graph);
31
+ return { directDeps, graph };
32
+ }
33
+ /**
34
+ * Parse uv.lock and attach SHA-256 hashes to graph entries.
35
+ * @param {string} lockFilePath - path to uv.lock
36
+ * @param {Map<string, import('./base_pyproject.js').GraphEntry>} graph
37
+ */
38
+ async _attachHashesFromLockFile(lockFilePath, graph) {
39
+ let lockContent;
40
+ try {
41
+ lockContent = await fs.promises.readFile(lockFilePath, 'utf-8');
42
+ }
43
+ catch {
44
+ return;
45
+ }
46
+ let parsed;
47
+ try {
48
+ parsed = parseToml(lockContent);
49
+ }
50
+ catch {
51
+ return;
52
+ }
53
+ let packages = parsed.package;
54
+ if (!Array.isArray(packages)) {
55
+ return;
56
+ }
57
+ for (let pkg of packages) {
58
+ if (!pkg.name) {
59
+ continue;
60
+ }
61
+ let hashStr = pkg.sdist?.hash || pkg.wheels?.[0]?.hash;
62
+ if (!hashStr || !hashStr.startsWith('sha256:')) {
63
+ continue;
64
+ }
65
+ let key = this._canonicalize(pkg.name);
66
+ let entry = graph.get(key);
67
+ if (!entry || entry.hashes) {
68
+ continue;
69
+ }
70
+ entry.hashes = [{ alg: "SHA-256", content: hashStr.slice(7) }];
71
+ }
30
72
  }
31
73
  /**
32
74
  * Get the uv export output, either from env var or by running the command.
@@ -4,9 +4,10 @@ declare namespace _default {
4
4
  export { provideComponent };
5
5
  export { provideStack };
6
6
  export { readLicenseFromManifest };
7
+ export function packageManagerName(): string;
7
8
  }
8
9
  export default _default;
9
- export type Provided = import("../provider").Provided;
10
+ export type Provided = any;
10
11
  /**
11
12
  * @param {string} manifestName - the subject manifest name-type
12
13
  * @returns {boolean} - return true if `Cargo.toml` is the manifest name-type
@@ -46,7 +47,10 @@ declare function provideStack(manifest: string, opts?: {}): Provided;
46
47
  * Read project license from Cargo.toml, with fallback to LICENSE file.
47
48
  * Supports the `license` field under `[package]` (single crate / workspace
48
49
  * with root) and under `[workspace.package]` (virtual workspaces).
50
+ * When a member crate uses `license = { workspace = true }`, the actual
51
+ * license is resolved from the workspace root Cargo.toml.
49
52
  * @param {string} manifestPath - path to Cargo.toml
53
+ * @param {object} [metadata] - cargo metadata output (needed for workspace license resolution)
50
54
  * @returns {string|null} SPDX identifier or null
51
55
  */
52
- declare function readLicenseFromManifest(manifestPath: string): string | null;
56
+ declare function readLicenseFromManifest(manifestPath: string, metadata?: object): string | null;
@@ -5,7 +5,7 @@ import { parse as parseToml } from 'smol-toml';
5
5
  import { getLicense } from '../license/license_utils.js';
6
6
  import Sbom from '../sbom.js';
7
7
  import { getCustom, getCustomPath, invokeCommand } from '../tools.js';
8
- export default { isSupported, validateLockFile, provideComponent, provideStack, readLicenseFromManifest };
8
+ export default { isSupported, validateLockFile, provideComponent, provideStack, readLicenseFromManifest, packageManagerName() { return 'cargo'; } };
9
9
  /** @typedef {import('../provider').Provider} */
10
10
  /** @typedef {import('../provider').Provided} Provided */
11
11
  /**
@@ -71,15 +71,22 @@ function isSupported(manifestName) {
71
71
  * Read project license from Cargo.toml, with fallback to LICENSE file.
72
72
  * Supports the `license` field under `[package]` (single crate / workspace
73
73
  * with root) and under `[workspace.package]` (virtual workspaces).
74
+ * When a member crate uses `license = { workspace = true }`, the actual
75
+ * license is resolved from the workspace root Cargo.toml.
74
76
  * @param {string} manifestPath - path to Cargo.toml
77
+ * @param {object} [metadata] - cargo metadata output (needed for workspace license resolution)
75
78
  * @returns {string|null} SPDX identifier or null
76
79
  */
77
- function readLicenseFromManifest(manifestPath) {
80
+ function readLicenseFromManifest(manifestPath, metadata) {
78
81
  let fromManifest = null;
79
82
  try {
80
83
  let content = fs.readFileSync(manifestPath, 'utf-8');
81
84
  let parsed = parseToml(content);
82
- fromManifest = parsed.package?.license
85
+ let packageLicense = parsed.package?.license;
86
+ if (typeof packageLicense === 'object' && packageLicense?.workspace === true) {
87
+ packageLicense = resolveWorkspaceLicense(parsed, metadata);
88
+ }
89
+ fromManifest = packageLicense
83
90
  || parsed.workspace?.package?.license
84
91
  || null;
85
92
  }
@@ -89,30 +96,45 @@ function readLicenseFromManifest(manifestPath) {
89
96
  return getLicense(fromManifest, manifestPath);
90
97
  }
91
98
  /**
92
- * Validates that Cargo.lock exists in the manifest directory or in a parent
93
- * workspace root directory. In Cargo workspaces the lock file always lives at
94
- * the workspace root, so when a member crate's Cargo.toml is provided we walk
95
- * up the directory tree looking for Cargo.lock (stopping when we find a
96
- * Cargo.toml that contains a [workspace] section, or when we reach the
97
- * filesystem root).
98
- * When TRUSTIFY_DA_WORKSPACE_DIR is provided (via env var or opts),
99
- * checks only that directory for Cargo.lock — no walk-up.
99
+ * Resolve a workspace-inherited license from the workspace root Cargo.toml.
100
+ * @param {object} parsed - the parsed member crate Cargo.toml
101
+ * @param {object} [metadata] - cargo metadata output with workspace_root
102
+ * @returns {string|null} resolved license string or null
103
+ */
104
+ function resolveWorkspaceLicense(parsed, metadata) {
105
+ if (metadata?.workspace_root) {
106
+ let cargoTomlPath = path.join(metadata.workspace_root, 'Cargo.toml');
107
+ try {
108
+ let content = fs.readFileSync(cargoTomlPath, 'utf-8');
109
+ let workspaceParsed = parseToml(content);
110
+ return workspaceParsed.workspace?.package?.license || null;
111
+ }
112
+ catch (_) {
113
+ // fall through
114
+ }
115
+ }
116
+ return parsed.workspace?.package?.license || null;
117
+ }
118
+ /**
119
+ * Finds the directory containing Cargo.lock, honoring TRUSTIFY_DA_WORKSPACE_DIR.
120
+ * Walks up from manifestDir looking for Cargo.lock, stopping at workspace root or filesystem root.
100
121
  * @param {string} manifestDir - the directory where the manifest lies
101
122
  * @param {{TRUSTIFY_DA_WORKSPACE_DIR?: string}} [opts={}] - optional workspace root
102
- * @returns {boolean} true if Cargo.lock is found
123
+ * @returns {string|null} the directory path containing Cargo.lock, or null if not found
124
+ * @private
103
125
  */
104
- function validateLockFile(manifestDir, opts = {}) {
126
+ function _findCargoLockDir(manifestDir, opts = {}) {
105
127
  const workspaceDir = getCustom('TRUSTIFY_DA_WORKSPACE_DIR', null, opts);
106
128
  if (workspaceDir) {
107
129
  const dir = path.resolve(workspaceDir);
108
- return fs.existsSync(path.join(dir, 'Cargo.lock'));
130
+ return fs.existsSync(path.join(dir, 'Cargo.lock')) ? dir : null;
109
131
  }
110
132
  let dir = path.resolve(manifestDir);
111
133
  let parent = dir;
112
134
  do {
113
135
  dir = parent;
114
136
  if (fs.existsSync(path.join(dir, 'Cargo.lock'))) {
115
- return true;
137
+ return dir;
116
138
  }
117
139
  // If this directory has a Cargo.toml with [workspace], the lock file
118
140
  // should have been here — stop searching.
@@ -121,7 +143,7 @@ function validateLockFile(manifestDir, opts = {}) {
121
143
  try {
122
144
  let content = fs.readFileSync(cargoToml, 'utf-8');
123
145
  if (/\[workspace\]/.test(content)) {
124
- return false;
146
+ return null;
125
147
  }
126
148
  }
127
149
  catch (_) {
@@ -130,7 +152,23 @@ function validateLockFile(manifestDir, opts = {}) {
130
152
  }
131
153
  parent = path.dirname(dir);
132
154
  } while (parent !== dir);
133
- return false;
155
+ return null;
156
+ }
157
+ /**
158
+ * Validates that Cargo.lock exists in the manifest directory or in a parent
159
+ * workspace root directory. In Cargo workspaces the lock file always lives at
160
+ * the workspace root, so when a member crate's Cargo.toml is provided we walk
161
+ * up the directory tree looking for Cargo.lock (stopping when we find a
162
+ * Cargo.toml that contains a [workspace] section, or when we reach the
163
+ * filesystem root).
164
+ * When TRUSTIFY_DA_WORKSPACE_DIR is provided (via env var or opts),
165
+ * checks only that directory for Cargo.lock — no walk-up.
166
+ * @param {string} manifestDir - the directory where the manifest lies
167
+ * @param {{TRUSTIFY_DA_WORKSPACE_DIR?: string}} [opts={}] - optional workspace root
168
+ * @returns {boolean} true if Cargo.lock is found
169
+ */
170
+ function validateLockFile(manifestDir, opts = {}) {
171
+ return _findCargoLockDir(manifestDir, opts) !== null;
134
172
  }
135
173
  /**
136
174
  * Provide content and content type for Cargo stack analysis.
@@ -173,13 +211,14 @@ function getSBOM(manifest, opts = {}, includeTransitive) {
173
211
  let metadata = executeCargoMetadata(cargoBin, manifestDir);
174
212
  let ignoredDeps = getIgnoredDeps(manifest, metadata);
175
213
  let crateType = detectCrateType(metadata);
176
- let license = readLicenseFromManifest(manifest);
214
+ let license = readLicenseFromManifest(manifest, metadata);
215
+ let hashMap = parseCargoLockHashes(manifestDir, opts);
177
216
  let sbom;
178
217
  if (crateType === CrateType.WORKSPACE_VIRTUAL) {
179
- sbom = handleVirtualWorkspace(manifest, metadata, ignoredDeps, includeTransitive, opts, license);
218
+ sbom = handleVirtualWorkspace(manifest, metadata, ignoredDeps, includeTransitive, opts, license, hashMap);
180
219
  }
181
220
  else {
182
- sbom = handleSingleCrate(metadata, ignoredDeps, includeTransitive, opts, license);
221
+ sbom = handleSingleCrate(metadata, ignoredDeps, includeTransitive, opts, license, hashMap);
183
222
  }
184
223
  return sbom;
185
224
  }
@@ -217,6 +256,34 @@ function executeCargoMetadata(cargoBin, manifestDir) {
217
256
  throw new Error('failed to execute cargo metadata', { cause: error });
218
257
  }
219
258
  }
259
+ /**
260
+ * Parses Cargo.lock to extract SHA-256 checksums for each package.
261
+ * @param {string} manifestDir - directory containing Cargo.toml (Cargo.lock is searched upward)
262
+ * @param {{TRUSTIFY_DA_WORKSPACE_DIR?: string}} [opts={}] - optional workspace root
263
+ * @returns {Map<string, Array<{alg: string, content: string}>>} map of "name@version" to CycloneDX hashes
264
+ * @private
265
+ */
266
+ function parseCargoLockHashes(manifestDir, opts = {}) {
267
+ let hashMap = new Map();
268
+ let lockDir = _findCargoLockDir(manifestDir, opts);
269
+ if (!lockDir) {
270
+ return hashMap;
271
+ }
272
+ let lockPath = path.join(lockDir, 'Cargo.lock');
273
+ try {
274
+ let content = fs.readFileSync(lockPath, 'utf-8');
275
+ let parsed = parseToml(content);
276
+ for (let pkg of (parsed.package || [])) {
277
+ if (pkg.name && pkg.version && pkg.checksum) {
278
+ hashMap.set(`${pkg.name}@${pkg.version}`, [{ alg: 'SHA-256', content: pkg.checksum }]);
279
+ }
280
+ }
281
+ }
282
+ catch (error) {
283
+ console.warn('Failed to parse Cargo.lock for hashes, SBOM will be generated without hashes');
284
+ }
285
+ return hashMap;
286
+ }
220
287
  /**
221
288
  * Detects the type of Cargo project from metadata.
222
289
  * @param {object} metadata - parsed cargo metadata
@@ -248,7 +315,7 @@ function detectCrateType(metadata) {
248
315
  * @returns {string} SBOM json string
249
316
  * @private
250
317
  */
251
- function handleSingleCrate(metadata, ignoredDeps, includeTransitive, opts, license) {
318
+ function handleSingleCrate(metadata, ignoredDeps, includeTransitive, opts, license, hashMap) {
252
319
  let rootPackageId = metadata.resolve.root;
253
320
  let rootPackage = findPackageById(metadata, rootPackageId);
254
321
  let rootPurl = toPurl(rootPackage.name, rootPackage.version);
@@ -259,10 +326,10 @@ function handleSingleCrate(metadata, ignoredDeps, includeTransitive, opts, licen
259
326
  return sbom.getAsJsonString(opts);
260
327
  }
261
328
  if (includeTransitive) {
262
- addTransitiveDeps(sbom, metadata, rootPackageId, ignoredDeps, new Set(), rootPurl);
329
+ addTransitiveDeps(sbom, metadata, rootPackageId, ignoredDeps, new Set(), hashMap, rootPurl);
263
330
  }
264
331
  else {
265
- addDirectDeps(sbom, metadata, rootPackageId, rootPurl, ignoredDeps);
332
+ addDirectDeps(sbom, metadata, rootPackageId, rootPurl, ignoredDeps, hashMap);
266
333
  }
267
334
  return sbom.getAsJsonString(opts);
268
335
  }
@@ -288,7 +355,7 @@ function handleSingleCrate(metadata, ignoredDeps, includeTransitive, opts, licen
288
355
  * @returns {string} SBOM json string
289
356
  * @private
290
357
  */
291
- function handleVirtualWorkspace(manifest, metadata, ignoredDeps, includeTransitive, opts, license) {
358
+ function handleVirtualWorkspace(manifest, metadata, ignoredDeps, includeTransitive, opts, license, hashMap) {
292
359
  let workspaceRoot = metadata.workspace_root;
293
360
  let rootName = path.basename(workspaceRoot);
294
361
  let workspaceVersion = getWorkspaceVersion(metadata);
@@ -296,7 +363,6 @@ function handleVirtualWorkspace(manifest, metadata, ignoredDeps, includeTransiti
296
363
  let sbom = new Sbom();
297
364
  sbom.addRoot(rootPurl, license);
298
365
  if (includeTransitive) {
299
- // Stack analysis: walk all members and their full dependency trees
300
366
  let workspaceMembers = metadata.workspace_members || [];
301
367
  for (let memberId of workspaceMembers) {
302
368
  let memberPackage = findPackageById(metadata, memberId);
@@ -307,11 +373,10 @@ function handleVirtualWorkspace(manifest, metadata, ignoredDeps, includeTransiti
307
373
  ? toPathDepPurl(memberPackage.name, memberPackage.version)
308
374
  : toPurl(memberPackage.name, memberPackage.version);
309
375
  sbom.addDependency(rootPurl, memberPurl);
310
- addTransitiveDeps(sbom, metadata, memberId, ignoredDeps, new Set(), memberPurl);
376
+ addTransitiveDeps(sbom, metadata, memberId, ignoredDeps, new Set(), hashMap, memberPurl);
311
377
  }
312
378
  }
313
379
  else {
314
- // Component analysis: only [workspace.dependencies] from root Cargo.toml
315
380
  let workspaceDeps = getWorkspaceDepsFromManifest(manifest);
316
381
  for (let depName of workspaceDeps) {
317
382
  if (isDepIgnored(depName, ignoredDeps)) {
@@ -328,7 +393,8 @@ function handleVirtualWorkspace(manifest, metadata, ignoredDeps, includeTransiti
328
393
  let depPurl = pkg.source == null
329
394
  ? toPathDepPurl(pkg.name, pkg.version)
330
395
  : toPurl(pkg.name, pkg.version);
331
- sbom.addDependency(rootPurl, depPurl);
396
+ let hashes = hashMap.get(`${pkg.name}@${pkg.version}`);
397
+ sbom.addDependency(rootPurl, depPurl, undefined, hashes);
332
398
  }
333
399
  }
334
400
  return sbom.getAsJsonString(opts);
@@ -347,7 +413,7 @@ function handleVirtualWorkspace(manifest, metadata, ignoredDeps, includeTransiti
347
413
  * so callers can ensure it matches the purl already added to the SBOM
348
414
  * @private
349
415
  */
350
- function addTransitiveDeps(sbom, metadata, packageId, ignoredDeps, visited, startingPurl) {
416
+ function addTransitiveDeps(sbom, metadata, packageId, ignoredDeps, visited, hashMap, startingPurl) {
351
417
  if (visited.has(packageId)) {
352
418
  return;
353
419
  }
@@ -375,8 +441,9 @@ function addTransitiveDeps(sbom, metadata, packageId, ignoredDeps, visited, star
375
441
  let depPurl = depPackage.source == null
376
442
  ? toPathDepPurl(depPackage.name, depPackage.version)
377
443
  : toPurl(depPackage.name, depPackage.version);
378
- sbom.addDependency(sourcePurl, depPurl);
379
- addTransitiveDeps(sbom, metadata, depId, ignoredDeps, visited);
444
+ let hashes = hashMap ? hashMap.get(`${depPackage.name}@${depPackage.version}`) : undefined;
445
+ sbom.addDependency(sourcePurl, depPurl, undefined, hashes);
446
+ addTransitiveDeps(sbom, metadata, depId, ignoredDeps, visited, hashMap);
380
447
  }
381
448
  }
382
449
  /**
@@ -389,7 +456,7 @@ function addTransitiveDeps(sbom, metadata, packageId, ignoredDeps, visited, star
389
456
  * @param {Set<string>} ignoredDeps - set of ignored dependency names
390
457
  * @private
391
458
  */
392
- function addDirectDeps(sbom, metadata, packageId, parentPurl, ignoredDeps) {
459
+ function addDirectDeps(sbom, metadata, packageId, parentPurl, ignoredDeps, hashMap) {
393
460
  let resolveNode = findResolveNode(metadata, packageId);
394
461
  if (!resolveNode) {
395
462
  return;
@@ -406,7 +473,8 @@ function addDirectDeps(sbom, metadata, packageId, parentPurl, ignoredDeps) {
406
473
  let depPurl = depPackage.source == null
407
474
  ? toPathDepPurl(depPackage.name, depPackage.version)
408
475
  : toPurl(depPackage.name, depPackage.version);
409
- sbom.addDependency(parentPurl, depPurl);
476
+ let hashes = hashMap ? hashMap.get(`${depPackage.name}@${depPackage.version}`) : undefined;
477
+ sbom.addDependency(parentPurl, depPurl, undefined, hashes);
410
478
  }
411
479
  }
412
480
  /**
@@ -0,0 +1,21 @@
1
+ /**
2
+ * Orchestrates the full remediation pipeline for a single manifest or directory:
3
+ * discover manifests → scan via DA backend → extract remediations → apply or preview.
4
+ *
5
+ * @param {string} targetPath - path to a manifest file or directory
6
+ * @param {object} [options]
7
+ * @param {boolean} [options.dryRun=false] - preview changes without modifying files (applies by default)
8
+ * @param {string} [options.providers] - comma-separated provider list
9
+ * @param {string} [options.sources] - comma-separated source list
10
+ * @param {'dependency'|'bundle'} [options.groupBy='dependency'] - report grouping strategy
11
+ * @returns {Promise<{exitCode: number, output: string}>}
12
+ */
13
+ export function runRemediation(targetPath: string, options?: {
14
+ dryRun?: boolean | undefined;
15
+ providers?: string | undefined;
16
+ sources?: string | undefined;
17
+ groupBy?: "bundle" | "dependency" | undefined;
18
+ }): Promise<{
19
+ exitCode: number;
20
+ output: string;
21
+ }>;
@@ -0,0 +1,149 @@
1
+ import fs from 'node:fs';
2
+ import path from 'node:path';
3
+ import analysis from './analysis.js';
4
+ import { availableProviders, match } from './provider.js';
5
+ import { extractRemediations } from './remediation.js';
6
+ import { generateReport } from './remediation_report.js';
7
+ import { updateMavenVersions } from './updaters/maven_updater.js';
8
+ import { updateTomlVersions } from './updaters/toml_updater.js';
9
+ import { selectTrustifyDABackend } from './index.js';
10
+ // Mirrors DEFAULT_WORKSPACE_DISCOVERY_IGNORE in workspace.js
11
+ const SKIP_DIRS = new Set(['node_modules', '.git']);
12
+ const MANIFEST_TYPES = [
13
+ {
14
+ test: (basename) => basename === 'pom.xml',
15
+ updater: updateMavenVersions,
16
+ label: 'maven',
17
+ },
18
+ {
19
+ test: (basename) => basename.endsWith('.versions.toml') || basename === 'libs.versions.toml',
20
+ updater: updateTomlVersions,
21
+ label: 'toml',
22
+ },
23
+ ];
24
+ /**
25
+ * Discovers supported manifest files recursively within a directory.
26
+ * @param {string} dirPath - absolute path to the directory
27
+ * @returns {string[]} array of absolute paths to supported manifest files
28
+ */
29
+ function discoverManifests(dirPath) {
30
+ const manifests = [];
31
+ function walk(dir) {
32
+ const entries = fs.readdirSync(dir, { withFileTypes: true });
33
+ for (const entry of entries) {
34
+ if (SKIP_DIRS.has(entry.name)) {
35
+ continue;
36
+ }
37
+ const fullPath = path.join(dir, entry.name);
38
+ if (entry.isDirectory()) {
39
+ walk(fullPath);
40
+ }
41
+ else if (getManifestType(entry.name)) {
42
+ manifests.push(fullPath);
43
+ }
44
+ }
45
+ }
46
+ walk(dirPath);
47
+ return manifests;
48
+ }
49
+ /**
50
+ * Returns the manifest type descriptor for a given filename, or null if unsupported.
51
+ * @param {string} basename - the file name to check
52
+ * @returns {{test: function, updater: function, label: string}|null}
53
+ */
54
+ function getManifestType(basename) {
55
+ return MANIFEST_TYPES.find(t => t.test(basename)) || null;
56
+ }
57
+ /**
58
+ * Orchestrates the full remediation pipeline for a single manifest or directory:
59
+ * discover manifests → scan via DA backend → extract remediations → apply or preview.
60
+ *
61
+ * @param {string} targetPath - path to a manifest file or directory
62
+ * @param {object} [options]
63
+ * @param {boolean} [options.dryRun=false] - preview changes without modifying files (applies by default)
64
+ * @param {string} [options.providers] - comma-separated provider list
65
+ * @param {string} [options.sources] - comma-separated source list
66
+ * @param {'dependency'|'bundle'} [options.groupBy='dependency'] - report grouping strategy
67
+ * @returns {Promise<{exitCode: number, output: string}>}
68
+ */
69
+ export async function runRemediation(targetPath, options = {}) {
70
+ const { dryRun = false, providers, sources, groupBy = 'dependency' } = options;
71
+ const resolvedPath = path.resolve(targetPath);
72
+ let manifestPaths;
73
+ let stat;
74
+ try {
75
+ stat = fs.statSync(resolvedPath);
76
+ }
77
+ catch {
78
+ throw new Error(`Path not found: ${resolvedPath}`);
79
+ }
80
+ if (stat.isDirectory()) {
81
+ manifestPaths = discoverManifests(resolvedPath);
82
+ if (manifestPaths.length === 0) {
83
+ return { exitCode: 0, output: 'No supported manifest files found.' };
84
+ }
85
+ }
86
+ else {
87
+ const basename = path.basename(resolvedPath);
88
+ if (!getManifestType(basename)) {
89
+ throw new Error(`Unsupported manifest type: ${basename}`);
90
+ }
91
+ manifestPaths = [resolvedPath];
92
+ }
93
+ const opts = {};
94
+ if (providers) {
95
+ opts.TRUSTIFY_DA_PROVIDERS = providers;
96
+ }
97
+ if (sources) {
98
+ opts.TRUSTIFY_DA_SOURCES = sources;
99
+ }
100
+ const url = selectTrustifyDABackend(opts);
101
+ const allRemediations = [];
102
+ const appliedFiles = [];
103
+ for (const manifestPath of manifestPaths) {
104
+ const basename = path.basename(manifestPath);
105
+ const manifestType = getManifestType(basename);
106
+ if (!manifestType) {
107
+ continue;
108
+ }
109
+ let provider;
110
+ try {
111
+ provider = match(manifestPath, availableProviders, opts);
112
+ }
113
+ catch {
114
+ continue;
115
+ }
116
+ const analysisReport = await analysis.requestStack(provider, manifestPath, url, false, opts);
117
+ const remediations = extractRemediations(analysisReport, {
118
+ providerPriority: providers ? providers.split(',').map(p => p.trim()).filter(Boolean) : undefined,
119
+ });
120
+ if (remediations.length === 0) {
121
+ continue;
122
+ }
123
+ allRemediations.push(...remediations);
124
+ if (!dryRun) {
125
+ const content = fs.readFileSync(manifestPath, 'utf-8');
126
+ const versionChanges = remediations.map(r => ({
127
+ groupId: r.groupId,
128
+ artifactId: r.artifactId,
129
+ newVersion: r.fixedInVersion,
130
+ }));
131
+ const result = manifestType.updater(content, versionChanges);
132
+ if (result.applied.length > 0) {
133
+ fs.writeFileSync(manifestPath, result.content, 'utf-8');
134
+ appliedFiles.push(manifestPath);
135
+ }
136
+ }
137
+ }
138
+ if (allRemediations.length === 0) {
139
+ return { exitCode: 0, output: 'No remediations found.' };
140
+ }
141
+ const report = generateReport(allRemediations, { groupBy });
142
+ if (dryRun) {
143
+ return { exitCode: 2, output: report };
144
+ }
145
+ const summary = appliedFiles.length > 0
146
+ ? `Updated ${appliedFiles.length} file(s):\n${appliedFiles.map(f => ` ${f}`).join('\n')}\n\n${report}`
147
+ : report;
148
+ return { exitCode: 0, output: summary };
149
+ }
@@ -0,0 +1,57 @@
1
+ /**
2
+ * Extracts actionable remediation instructions from a DA AnalysisReport response.
3
+ *
4
+ * Walks the provider/source/dependency/issue tree, collects fixedIn and trustedContent
5
+ * remediation data, applies provider priority resolution, and uses the configured
6
+ * version selection strategy to resolve conflicts. Dependencies with no remediation
7
+ * data are skipped.
8
+ *
9
+ * @param {object} analysisReport - raw DA AnalysisReport JSON response
10
+ * @param {object} [options] - extraction options
11
+ * @param {string[]} [options.providerPriority] - provider names in descending priority order.
12
+ * The first entry has the highest priority. Providers not listed share the lowest priority.
13
+ * When omitted or empty, all providers are treated equally and the highest fix version wins.
14
+ * @param {object} [options.versionStrategy] - version selection strategy with selectVersion
15
+ * and resolveConflict methods. Defaults to closestCoverageStrategy.
16
+ * @returns {Array<{purl: string, groupId: string, artifactId: string, currentVersion: string, fixedInVersion: string, fixedInPurl: string, provider: string, source: string, advisories: Array<{id: string, url: string}>, severity: string, cves: string[]}>}
17
+ */
18
+ export function extractRemediations(analysisReport: object, options?: {
19
+ providerPriority?: string[] | undefined;
20
+ versionStrategy?: object | undefined;
21
+ }): Array<{
22
+ purl: string;
23
+ groupId: string;
24
+ artifactId: string;
25
+ currentVersion: string;
26
+ fixedInVersion: string;
27
+ fixedInPurl: string;
28
+ provider: string;
29
+ source: string;
30
+ advisories: Array<{
31
+ id: string;
32
+ url: string;
33
+ }>;
34
+ severity: string;
35
+ cves: string[];
36
+ }>;
37
+ /**
38
+ * Version selection strategy that prefers the closest compatible version
39
+ * within the same major version stream. Falls back to the lowest cross-major
40
+ * version when no same-major option exists.
41
+ * @type {{selectVersion: function(string[], string): string, resolveConflict: function(object, object): string}}
42
+ */
43
+ export const closestCoverageStrategy: {
44
+ selectVersion: (arg0: string[], arg1: string) => string;
45
+ resolveConflict: (arg0: object, arg1: object) => string;
46
+ };
47
+ /**
48
+ * Version selection strategy that always picks the highest version regardless
49
+ * of major version distance. Guarantees maximum CVE coverage but may produce
50
+ * large version jumps. This is the original behavior before pluggable strategies.
51
+ * @type {{selectVersion: function(string[], string): string, resolveConflict: function(object, object): string}}
52
+ */
53
+ export const highestStrategy: {
54
+ selectVersion: (arg0: string[], arg1: string) => string;
55
+ resolveConflict: (arg0: object, arg1: object) => string;
56
+ };
57
+ export const SEVERITY_ORDER: string[];