@trustify-da/trustify-da-javascript-client 0.3.0-ea.0c4e031 → 0.3.0-ea.0d78462

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -103,14 +103,17 @@ Use as CLI Script
103
103
  ```shell
104
104
  $ npx @trustify-da/trustify-da-javascript-client help
105
105
 
106
- Usage: trustify-da-javascript-client {component|stack|image|validate-token|license}
106
+ Usage: trustify-da-javascript-client {component|stack|stack-batch|image|validate-token|license|sbom|remediate}
107
107
 
108
108
  Commands:
109
109
  trustify-da-javascript-client stack </path/to/manifest> [--workspace-dir <path>] [--html|--summary] produce stack report for manifest path
110
110
  trustify-da-javascript-client stack-batch </path/to/workspace-root> [--html|--summary] produce stack report for all packages/crates in workspace
111
111
  trustify-da-javascript-client component <path/to/manifest> [--workspace-dir <path>] produce component report for a manifest type and content
112
112
  trustify-da-javascript-client image <image-refs..> [--html|--summary] produce image analysis report for OCI image references
113
+ trustify-da-javascript-client validate-token <token-provider> [--token-value <value>] validate input token if authentic and authorized
113
114
  trustify-da-javascript-client license </path/to/manifest> display project license information from manifest and LICENSE file in JSON format
115
+ trustify-da-javascript-client sbom </path/to/manifest> [--output <file>] generate a CycloneDX SBOM from a manifest file
116
+ trustify-da-javascript-client remediate <path> [--dry-run] [--providers <list>] [--sources <list>] [--group-by <strategy>] scan and apply vulnerability remediations
114
117
 
115
118
  Options:
116
119
  --help Show help [boolean]
@@ -160,6 +163,27 @@ $ npx @trustify-da/trustify-da-javascript-client image httpd:2.4.49^^amd64
160
163
 
161
164
  # get project license information
162
165
  $ npx @trustify-da/trustify-da-javascript-client license /path/to/package.json
166
+
167
+ # generate a CycloneDX SBOM from a manifest file
168
+ $ npx @trustify-da/trustify-da-javascript-client sbom /path/to/pom.xml
169
+
170
+ # generate SBOM and write to a file
171
+ $ npx @trustify-da/trustify-da-javascript-client sbom /path/to/pom.xml --output sbom.json
172
+
173
+ # scan a manifest and apply vulnerability remediations
174
+ $ npx @trustify-da/trustify-da-javascript-client remediate /path/to/pom.xml
175
+
176
+ # preview remediations without modifying files
177
+ $ npx @trustify-da/trustify-da-javascript-client remediate /path/to/pom.xml --dry-run
178
+
179
+ # scan a directory for all supported manifests
180
+ $ npx @trustify-da/trustify-da-javascript-client remediate /path/to/project/
181
+
182
+ # filter by vulnerability providers (order determines priority)
183
+ $ npx @trustify-da/trustify-da-javascript-client remediate /path/to/pom.xml --providers provider1,provider2
184
+
185
+ # group report output by bundle instead of per-dependency
186
+ $ npx @trustify-da/trustify-da-javascript-client remediate /path/to/pom.xml --dry-run --group-by bundle
163
187
  ```
164
188
  </li>
165
189
 
@@ -213,6 +237,27 @@ $ trustify-da-javascript-client image httpd:2.4.49^^amd64
213
237
 
214
238
  # get project license information
215
239
  $ trustify-da-javascript-client license /path/to/package.json
240
+
241
+ # generate a CycloneDX SBOM from a manifest file
242
+ $ trustify-da-javascript-client sbom /path/to/pom.xml
243
+
244
+ # generate SBOM and write to a file
245
+ $ trustify-da-javascript-client sbom /path/to/pom.xml --output sbom.json
246
+
247
+ # scan a manifest and apply vulnerability remediations
248
+ $ trustify-da-javascript-client remediate /path/to/pom.xml
249
+
250
+ # preview remediations without modifying files
251
+ $ trustify-da-javascript-client remediate /path/to/pom.xml --dry-run
252
+
253
+ # scan a directory for all supported manifests
254
+ $ trustify-da-javascript-client remediate /path/to/project/
255
+
256
+ # filter by vulnerability providers (order determines priority)
257
+ $ trustify-da-javascript-client remediate /path/to/pom.xml --providers provider1,provider2
258
+
259
+ # group report output by bundle instead of per-dependency
260
+ $ trustify-da-javascript-client remediate /path/to/pom.xml --dry-run --group-by bundle
216
261
  ```
217
262
  </li>
218
263
  </ul>
@@ -688,7 +733,7 @@ This increasing the chances and the probability that the automatic installation
688
733
  ###### Usage
689
734
  A New setting is introduced - `TRUSTIFY_DA_PYTHON_INSTALL_BEST_EFFORTS` (as both env variable/key in `options` object)
690
735
  1. `TRUSTIFY_DA_PYTHON_INSTALL_BEST_EFFORTS`="false" - install requirements.txt while respecting declared versions for all packages.
691
- 2. `TRUSTIFY_DA_PYTHON_INSTALL_BEST_EFFORTS`="true" - install all packages from requirements.txt, not respecting the declared version, but trying to install a version tailored for the used python version. When using this setting, you must set setting `MATCH_MANIFEST_VERSIONS` to 'false'.
736
+ 2. `TRUSTIFY_DA_PYTHON_INSTALL_BEST_EFFORTS`="true" - install all packages from requirements.txt, not respecting the declared version, but trying to install a version tailored for the used python version. When using this setting, you must set `TRUSTIFY_DA_PYTHON_VIRTUAL_ENV` to 'true' and `MATCH_MANIFEST_VERSIONS` to 'false'.
692
737
 
693
738
  ##### Using `pipdeptree`
694
739
  By default, The API algorithm will use native commands of PIP installer as data source to build the dependency tree.
@@ -705,6 +750,135 @@ For some ecosystems we support passing additional CLI arguments to the underlyin
705
750
  |Maven |TRUSTIFY_DA_MVN_ARGS|
706
751
 
707
752
 
753
+ <h3>Remediation</h3>
754
+ <p>
755
+ The <code>remediate</code> command scans manifest files for known vulnerabilities and applies version upgrades to resolve them. By default, it modifies manifest files in place. Use <code>--dry-run</code> to preview changes without modifying any files.
756
+ </p>
757
+
758
+ <h4>Supported Manifest Formats</h4>
759
+ <ul>
760
+ <li><strong>Maven</strong> — <code>pom.xml</code> (single-module projects; updates dependency version elements and resolves property references)</li>
761
+ <li><strong>Gradle Version Catalog</strong> — <code>libs.versions.toml</code> or any <code>*.versions.toml</code> file (updates centralized version references and inline version declarations)</li>
762
+ </ul>
763
+
764
+ <h4>CLI Flags</h4>
765
+ <table>
766
+ <tr>
767
+ <th>Flag</th>
768
+ <th>Alias</th>
769
+ <th>Type</th>
770
+ <th>Default</th>
771
+ <th>Description</th>
772
+ </tr>
773
+ <tr>
774
+ <td><code>&lt;path&gt;</code></td>
775
+ <td>—</td>
776
+ <td>string (positional)</td>
777
+ <td><em>required</em></td>
778
+ <td>Path to a manifest file or directory to scan recursively</td>
779
+ </tr>
780
+ <tr>
781
+ <td><code>--dry-run</code></td>
782
+ <td><code>-d</code></td>
783
+ <td>boolean</td>
784
+ <td><code>false</code></td>
785
+ <td>Preview changes without modifying files</td>
786
+ </tr>
787
+ <tr>
788
+ <td><code>--providers</code></td>
789
+ <td>—</td>
790
+ <td>string</td>
791
+ <td>—</td>
792
+ <td>Comma-separated list of vulnerability providers (env: <code>TRUSTIFY_DA_PROVIDERS</code>)</td>
793
+ </tr>
794
+ <tr>
795
+ <td><code>--sources</code></td>
796
+ <td>—</td>
797
+ <td>string</td>
798
+ <td>—</td>
799
+ <td>Comma-separated list of vulnerability sources (env: <code>TRUSTIFY_DA_SOURCES</code>)</td>
800
+ </tr>
801
+ <tr>
802
+ <td><code>--group-by</code></td>
803
+ <td>—</td>
804
+ <td>string</td>
805
+ <td><code>dependency</code></td>
806
+ <td>Report grouping strategy (<code>dependency</code> or <code>bundle</code>)</td>
807
+ </tr>
808
+ </table>
809
+
810
+ <h4>Provider Priority Resolution</h4>
811
+ <p>
812
+ When multiple vulnerability providers suggest different remediation versions for the same dependency, the <code>--providers</code> flag determines priority. Providers listed first have the highest priority.
813
+ </p>
814
+ <ul>
815
+ <li>The provider ordering in <code>--providers</code> determines rank (first = highest priority).</li>
816
+ <li>Trustify vendor trusted packages always take precedence over non-trusted content at equal provider rank.</li>
817
+ <li>Two version selection strategies are used internally:
818
+ <ul>
819
+ <li><strong>Closest coverage</strong> (default) — prefers the remediation version closest to the current version within the same major version.</li>
820
+ <li><strong>Highest</strong> — always selects the highest available remediation version.</li>
821
+ </ul>
822
+ </li>
823
+ </ul>
824
+
825
+ <h4>Exit Codes</h4>
826
+ <ul>
827
+ <li><code>0</code> — no remediations needed, or remediations applied successfully</li>
828
+ <li><code>1</code> — error during execution</li>
829
+ <li><code>2</code> — remediations available (only returned in <code>--dry-run</code> mode when changes would be made; never returned when changes are applied)</li>
830
+ </ul>
831
+
832
+ <h4>Known Limitations</h4>
833
+ <ul>
834
+ <li>Gradle DSL files (<code>build.gradle</code>, <code>build.gradle.kts</code>) are not supported — only version catalog files (<code>*.versions.toml</code>).</li>
835
+ <li>Multi-module Maven projects with inherited dependency versions from parent POMs are not supported — only versions declared directly in the scanned <code>pom.xml</code> are updated.</li>
836
+ </ul>
837
+
838
+ <h4>Example: GitHub Action Workflow</h4>
839
+ <p>
840
+ The following workflow runs a scheduled remediation scan using the container image and opens a pull request with any version updates. Save this as <code>.github/workflows/trustify-da-remediation.yml</code> in your repository:
841
+ </p>
842
+
843
+ ```yaml
844
+ name: Trustify DA Remediation Scan
845
+
846
+ on:
847
+ schedule:
848
+ # Run weekly on Monday at 08:00 UTC
849
+ - cron: '0 8 * * 1'
850
+ workflow_dispatch:
851
+
852
+ permissions:
853
+ contents: write
854
+ pull-requests: write
855
+
856
+ jobs:
857
+ remediate:
858
+ runs-on: ubuntu-latest
859
+ steps:
860
+ - uses: actions/checkout@v4
861
+
862
+ - name: Run remediation scan
863
+ uses: docker://ghcr.io/guacsec/trustify-da-javascript-client:latest
864
+ env:
865
+ TRUSTIFY_DA_BACKEND_URL: ${{ secrets.TRUSTIFY_DA_BACKEND_URL }}
866
+ with:
867
+ entrypoint: trustify-da-javascript-client
868
+ args: remediate . --providers provider1,provider2
869
+
870
+ - name: Create pull request
871
+ uses: peter-evans/create-pull-request@v7
872
+ with:
873
+ title: 'fix(deps): apply Trustify DA vulnerability remediations'
874
+ body: |
875
+ Automated dependency version updates from Trustify Dependency Analytics.
876
+
877
+ This PR was generated by a scheduled remediation scan.
878
+ branch: trustify-da-remediation
879
+ commit-message: 'fix(deps): apply Trustify DA vulnerability remediations'
880
+ ```
881
+
708
882
  <!-- Badge links -->
709
883
  [0]: https://img.shields.io/github/v/release/guacsec/trustify-da-javascript-client?color=green&label=latest
710
884
  [1]: https://img.shields.io/github/v/release/guacsec/trustify-da-javascript-client?color=yellow&include_prereleases&label=early-access
@@ -6,6 +6,7 @@ declare namespace _default {
6
6
  export { requestStackBatch };
7
7
  export { requestImages };
8
8
  export { validateToken };
9
+ export { appendAnalysisQueryParams };
9
10
  }
10
11
  export default _default;
11
12
  /**
@@ -57,3 +58,9 @@ declare function requestImages(imageRefs: Array<string>, url: string, html?: boo
57
58
  * @return {Promise<number>} return the HTTP status Code of the response from the validate token request.
58
59
  */
59
60
  declare function validateToken(url: any, opts?: any): Promise<number>;
61
+ /**
62
+ * Append common analysis query parameters (recommend, providers, sources) to a URL.
63
+ * @param {URL} url - the URL object to append query parameters to
64
+ * @param {import("index.js").Options} [opts={}] - options containing parameter overrides
65
+ */
66
+ declare function appendAnalysisQueryParams(url: URL, opts?: any): void;
@@ -6,7 +6,7 @@ import { generateImageSBOM, parseImageRef } from "./oci_image/utils.js";
6
6
  import { addProxyAgent, getCustom, getTokenHeaders, TRUSTIFY_DA_OPERATION_TYPE_HEADER, TRUSTIFY_DA_PACKAGE_MANAGER_HEADER } from "./tools.js";
7
7
  /** Media type for CycloneDX JSON batch payloads (batch-analysis API). */
8
8
  export const CYCLONEDX_JSON_MEDIA_TYPE = 'application/vnd.cyclonedx+json';
9
- export default { requestComponent, requestStack, requestStackBatch, requestImages, validateToken };
9
+ export default { requestComponent, requestStack, requestStackBatch, requestImages, validateToken, appendAnalysisQueryParams };
10
10
  /**
11
11
  * Send a stack analysis request and get the report as 'text/html' or 'application/json'.
12
12
  * @param {import('./provider').Provider} provider - the provided data for constructing the request
@@ -41,9 +41,7 @@ async function requestStack(provider, manifest, url, html = false, opts = {}) {
41
41
  body: provided.content
42
42
  }, opts);
43
43
  const finalUrl = new URL(`${url}/api/v5/analysis`);
44
- if (getCustom('TRUSTIFY_DA_RECOMMEND', 'true', opts) === 'false') {
45
- finalUrl.searchParams.append('recommend', 'false');
46
- }
44
+ appendAnalysisQueryParams(finalUrl, opts);
47
45
  let resp = await fetch(finalUrl, fetchOptions);
48
46
  let result;
49
47
  if (resp.status === 200) {
@@ -101,9 +99,7 @@ async function requestComponent(provider, manifest, url, opts = {}) {
101
99
  body: provided.content
102
100
  }, opts);
103
101
  const finalUrl = new URL(`${url}/api/v5/analysis`);
104
- if (getCustom('TRUSTIFY_DA_RECOMMEND', 'true', opts) === 'false') {
105
- finalUrl.searchParams.append('recommend', 'false');
106
- }
102
+ appendAnalysisQueryParams(finalUrl, opts);
107
103
  let resp = await fetch(finalUrl, fetchOptions);
108
104
  let result;
109
105
  if (resp.status === 200) {
@@ -142,9 +138,7 @@ async function requestComponent(provider, manifest, url, opts = {}) {
142
138
  */
143
139
  async function requestStackBatch(sbomByPurl, url, html = false, opts = {}) {
144
140
  const finalUrl = new URL(`${url}/api/v5/batch-analysis`);
145
- if (getCustom('TRUSTIFY_DA_RECOMMEND', 'true', opts) === 'false') {
146
- finalUrl.searchParams.append('recommend', 'false');
147
- }
141
+ appendAnalysisQueryParams(finalUrl, opts);
148
142
  const fetchOptions = addProxyAgent({
149
143
  method: 'POST',
150
144
  headers: {
@@ -192,9 +186,7 @@ async function requestImages(imageRefs, url, html = false, opts = {}) {
192
186
  imageSboms[parsedImageRef.getPackageURL().toString()] = generateImageSBOM(parsedImageRef, opts);
193
187
  }
194
188
  const finalUrl = new URL(`${url}/api/v5/batch-analysis`);
195
- if (getCustom('TRUSTIFY_DA_RECOMMEND', 'true', opts) === 'false') {
196
- finalUrl.searchParams.append('recommend', 'false');
197
- }
189
+ appendAnalysisQueryParams(finalUrl, opts);
198
190
  const fetchOptions = addProxyAgent({
199
191
  method: 'POST',
200
192
  headers: {
@@ -228,6 +220,24 @@ async function requestImages(imageRefs, url, html = false, opts = {}) {
228
220
  throw new Error(`Got error response from Trustify DA backend - http return code : ${resp.status}, ex-request-id: ${resp.headers.get("ex-request-id")} error message => ${await resp.text()}`);
229
221
  }
230
222
  }
223
+ /**
224
+ * Append common analysis query parameters (recommend, providers, sources) to a URL.
225
+ * @param {URL} url - the URL object to append query parameters to
226
+ * @param {import("index.js").Options} [opts={}] - options containing parameter overrides
227
+ */
228
+ function appendAnalysisQueryParams(url, opts = {}) {
229
+ if (getCustom('TRUSTIFY_DA_RECOMMEND', 'true', opts) === 'false') {
230
+ url.searchParams.append('recommend', 'false');
231
+ }
232
+ const providers = getCustom('TRUSTIFY_DA_PROVIDERS', null, opts);
233
+ if (providers) {
234
+ url.searchParams.append('providers', providers);
235
+ }
236
+ const sources = getCustom('TRUSTIFY_DA_SOURCES', null, opts);
237
+ if (sources) {
238
+ url.searchParams.append('sources', sources);
239
+ }
240
+ }
231
241
  /**
232
242
  *
233
243
  * @param url the backend url to send the request to
package/dist/src/cli.js CHANGED
@@ -4,6 +4,7 @@ import * as path from "path";
4
4
  import yargs from 'yargs';
5
5
  import { hideBin } from 'yargs/helpers';
6
6
  import { getProjectLicense, getLicenseDetails } from './license/index.js';
7
+ import { runRemediation } from './remediate.js';
7
8
  import client, { selectTrustifyDABackend, generateSbom } from './index.js';
8
9
  // command for component analysis take manifest type and content
9
10
  const component = {
@@ -19,11 +20,25 @@ const component = {
19
20
  desc: 'Workspace root directory (for monorepos; lock file is expected here)',
20
21
  type: 'string',
21
22
  normalize: true,
23
+ },
24
+ providers: {
25
+ desc: 'Comma-separated list of vulnerability providers (env: TRUSTIFY_DA_PROVIDERS)',
26
+ type: 'string',
27
+ },
28
+ sources: {
29
+ desc: 'Comma-separated list of vulnerability sources (env: TRUSTIFY_DA_SOURCES)',
30
+ type: 'string',
22
31
  }
23
32
  }),
24
33
  handler: async (args) => {
25
34
  let manifestName = args['/path/to/manifest'];
26
35
  const opts = args.workspaceDir ? { TRUSTIFY_DA_WORKSPACE_DIR: args.workspaceDir } : {};
36
+ if (args.providers) {
37
+ opts.TRUSTIFY_DA_PROVIDERS = args.providers;
38
+ }
39
+ if (args.sources) {
40
+ opts.TRUSTIFY_DA_SOURCES = args.sources;
41
+ }
27
42
  let res = await client.componentAnalysis(manifestName, opts);
28
43
  console.log(JSON.stringify(res, null, 2));
29
44
  }
@@ -72,6 +87,14 @@ const image = {
72
87
  desc: 'For JSON report, get only the \'summary\'',
73
88
  type: 'boolean',
74
89
  conflicts: 'html'
90
+ },
91
+ providers: {
92
+ desc: 'Comma-separated list of vulnerability providers (env: TRUSTIFY_DA_PROVIDERS)',
93
+ type: 'string',
94
+ },
95
+ sources: {
96
+ desc: 'Comma-separated list of vulnerability sources (env: TRUSTIFY_DA_SOURCES)',
97
+ type: 'string',
75
98
  }
76
99
  }),
77
100
  handler: async (args) => {
@@ -81,7 +104,14 @@ const image = {
81
104
  }
82
105
  let html = args['html'];
83
106
  let summary = args['summary'];
84
- let res = await client.imageAnalysis(imageRefs, html);
107
+ const opts = {};
108
+ if (args.providers) {
109
+ opts.TRUSTIFY_DA_PROVIDERS = args.providers;
110
+ }
111
+ if (args.sources) {
112
+ opts.TRUSTIFY_DA_SOURCES = args.sources;
113
+ }
114
+ let res = await client.imageAnalysis(imageRefs, html, opts);
85
115
  if (summary && !html) {
86
116
  let summaries = {};
87
117
  for (let [imageRef, report] of Object.entries(res)) {
@@ -132,6 +162,14 @@ const stack = {
132
162
  desc: 'Workspace root directory (for monorepos; lock file is expected here)',
133
163
  type: 'string',
134
164
  normalize: true,
165
+ },
166
+ providers: {
167
+ desc: 'Comma-separated list of vulnerability providers (env: TRUSTIFY_DA_PROVIDERS)',
168
+ type: 'string',
169
+ },
170
+ sources: {
171
+ desc: 'Comma-separated list of vulnerability sources (env: TRUSTIFY_DA_SOURCES)',
172
+ type: 'string',
135
173
  }
136
174
  }),
137
175
  handler: async (args) => {
@@ -139,6 +177,12 @@ const stack = {
139
177
  let html = args['html'];
140
178
  let summary = args['summary'];
141
179
  const opts = args.workspaceDir ? { TRUSTIFY_DA_WORKSPACE_DIR: args.workspaceDir } : {};
180
+ if (args.providers) {
181
+ opts.TRUSTIFY_DA_PROVIDERS = args.providers;
182
+ }
183
+ if (args.sources) {
184
+ opts.TRUSTIFY_DA_SOURCES = args.sources;
185
+ }
142
186
  let theProvidersSummary = new Map();
143
187
  let theProvidersObject = {};
144
188
  let res = await client.stackAnalysis(manifest, html, opts);
@@ -201,6 +245,14 @@ const stackBatch = {
201
245
  desc: 'Stop on first invalid package.json or SBOM error (env: TRUSTIFY_DA_CONTINUE_ON_ERROR=false)',
202
246
  type: 'boolean',
203
247
  default: false,
248
+ },
249
+ providers: {
250
+ desc: 'Comma-separated list of vulnerability providers (env: TRUSTIFY_DA_PROVIDERS)',
251
+ type: 'string',
252
+ },
253
+ sources: {
254
+ desc: 'Comma-separated list of vulnerability sources (env: TRUSTIFY_DA_SOURCES)',
255
+ type: 'string',
204
256
  }
205
257
  }),
206
258
  handler: async (args) => {
@@ -221,6 +273,12 @@ const stackBatch = {
221
273
  if (args.failFast) {
222
274
  opts.continueOnError = false;
223
275
  }
276
+ if (args.providers) {
277
+ opts.TRUSTIFY_DA_PROVIDERS = args.providers;
278
+ }
279
+ if (args.sources) {
280
+ opts.TRUSTIFY_DA_SOURCES = args.sources;
281
+ }
224
282
  let res = await client.stackAnalysisBatch(workspaceRoot, html, opts);
225
283
  const batchAnalysis = res && typeof res === 'object' && res != null && 'analysis' in res ? res.analysis : res;
226
284
  if (summary && !html && typeof batchAnalysis === 'object') {
@@ -373,9 +431,54 @@ const sbom = {
373
431
  }
374
432
  }
375
433
  };
434
+ const remediate = {
435
+ command: 'remediate <path>',
436
+ desc: 'Scan and apply vulnerability remediations to manifest files',
437
+ builder: yargs => yargs.positional('path', {
438
+ desc: 'Path to manifest file or directory',
439
+ type: 'string',
440
+ normalize: true,
441
+ }).options({
442
+ 'dry-run': {
443
+ alias: 'd',
444
+ type: 'boolean',
445
+ desc: 'Preview changes without modifying files',
446
+ },
447
+ providers: {
448
+ desc: 'Comma-separated list of vulnerability providers (env: TRUSTIFY_DA_PROVIDERS)',
449
+ type: 'string',
450
+ },
451
+ sources: {
452
+ desc: 'Comma-separated list of vulnerability sources (env: TRUSTIFY_DA_SOURCES)',
453
+ type: 'string',
454
+ },
455
+ 'group-by': {
456
+ type: 'string',
457
+ choices: ['dependency', 'bundle'],
458
+ default: 'dependency',
459
+ desc: 'Report grouping strategy',
460
+ },
461
+ }),
462
+ handler: async (args) => {
463
+ try {
464
+ const result = await runRemediation(args.path, {
465
+ dryRun: args['dry-run'],
466
+ providers: args.providers,
467
+ sources: args.sources,
468
+ groupBy: args['group-by'],
469
+ });
470
+ console.log(result.output);
471
+ process.exit(result.exitCode);
472
+ }
473
+ catch (err) {
474
+ console.error(err.message);
475
+ process.exit(1);
476
+ }
477
+ }
478
+ };
376
479
  // parse and invoke the command
377
480
  yargs(hideBin(process.argv))
378
- .usage(`Usage: ${process.argv[0].includes("node") ? path.parse(process.argv[1]).base : path.parse(process.argv[0]).base} {component|stack|stack-batch|image|validate-token|license|sbom}`)
481
+ .usage(`Usage: ${process.argv[0].includes("node") ? path.parse(process.argv[1]).base : path.parse(process.argv[0]).base} {component|stack|stack-batch|image|validate-token|license|sbom|remediate}`)
379
482
  .command(stack)
380
483
  .command(stackBatch)
381
484
  .command(component)
@@ -383,6 +486,7 @@ yargs(hideBin(process.argv))
383
486
  .command(validateToken)
384
487
  .command(license)
385
488
  .command(sbom)
489
+ .command(remediate)
386
490
  .scriptName('')
387
491
  .version(false)
388
492
  .demandCommand(1)
@@ -26,6 +26,19 @@ export default class CycloneDxSbom {
26
26
  alg: string;
27
27
  content: string;
28
28
  }>): CycloneDxSbom;
29
+ /**
30
+ * Attach hashes to already-added components by matching their PURL. This is a
31
+ * post-processing step so ecosystem-specific hash sources (e.g. Maven reading
32
+ * the local .m2 cache) can enrich the SBOM without threading their concern
33
+ * through the shared dependency-tree parser. Components without a matching
34
+ * entry, or whose hashes are already set, are left untouched.
35
+ * @param {Map<string, Array<{alg: string, content: string}>>} hashMap - PURL→hashes map
36
+ * @return {CycloneDxSbom} the updated SBOM
37
+ */
38
+ attachHashes(hashMap: Map<string, Array<{
39
+ alg: string;
40
+ content: string;
41
+ }>>): CycloneDxSbom;
29
42
  /** @param {{}} opts - various options, settings and configuration of application.
30
43
  * @return String CycloneDx Sbom json object in a string format
31
44
  */
@@ -135,6 +135,30 @@ export default class CycloneDxSbom {
135
135
  }
136
136
  return this;
137
137
  }
138
+ /**
139
+ * Attach hashes to already-added components by matching their PURL. This is a
140
+ * post-processing step so ecosystem-specific hash sources (e.g. Maven reading
141
+ * the local .m2 cache) can enrich the SBOM without threading their concern
142
+ * through the shared dependency-tree parser. Components without a matching
143
+ * entry, or whose hashes are already set, are left untouched.
144
+ * @param {Map<string, Array<{alg: string, content: string}>>} hashMap - PURL→hashes map
145
+ * @return {CycloneDxSbom} the updated SBOM
146
+ */
147
+ attachHashes(hashMap) {
148
+ if (!hashMap || hashMap.size === 0) {
149
+ return this;
150
+ }
151
+ for (const component of this.components) {
152
+ if (component.hashes) {
153
+ continue;
154
+ }
155
+ const hashes = hashMap.get(component.purl);
156
+ if (hashes && hashes.length > 0) {
157
+ component.hashes = hashes;
158
+ }
159
+ }
160
+ return this;
161
+ }
138
162
  /** @param {{}} opts - various options, settings and configuration of application.
139
163
  * @return String CycloneDx Sbom json object in a string format
140
164
  */
@@ -24,6 +24,7 @@ export function selectTrustifyDABackend(opts?: {
24
24
  export function generateSbom(manifestPath: string, opts?: Options): Promise<object>;
25
25
  export { parseImageRef } from "./oci_image/utils.js";
26
26
  export { ImageRef } from "./oci_image/images.js";
27
+ export { extractRemediations } from "./remediation.js";
27
28
  declare namespace _default {
28
29
  export { componentAnalysis };
29
30
  export { stackAnalysis };
@@ -53,7 +54,9 @@ export type Options = {
53
54
  TRUSTIFY_DA_PYTHON_PATH?: string | undefined;
54
55
  TRUSTIFY_DA_PYTHON_VIRTUAL_ENV?: string | undefined;
55
56
  TRUSTIFY_DA_PYTHON3_PATH?: string | undefined;
57
+ TRUSTIFY_DA_PROVIDERS?: string | undefined;
56
58
  TRUSTIFY_DA_RECOMMEND?: string | undefined;
59
+ TRUSTIFY_DA_SOURCES?: string | undefined;
57
60
  TRUSTIFY_DA_SKOPEO_CONFIG_PATH?: string | undefined;
58
61
  TRUSTIFY_DA_SKOPEO_PATH?: string | undefined;
59
62
  TRUSTIFY_DA_SYFT_CONFIG_PATH?: string | undefined;
@@ -264,3 +267,4 @@ import { resolveContinueOnError } from './batch_opts.js';
264
267
  import { resolveBatchMetadata } from './batch_opts.js';
265
268
  export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceModules, discoverUvWorkspaceMembers, discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata };
266
269
  export { getProjectLicense, findLicenseFilePath, identifyLicense, getLicenseDetails, licensesFromReport, normalizeLicensesResponse, runLicenseCheck, getCompatibility } from "./license/index.js";
270
+ export { generateReport, generateDeduplicationKey } from "./remediation_report.js";
package/dist/src/index.js CHANGED
@@ -16,6 +16,8 @@ import * as url from 'url';
16
16
  export { parseImageRef } from "./oci_image/utils.js";
17
17
  export { ImageRef } from "./oci_image/images.js";
18
18
  export { getProjectLicense, findLicenseFilePath, identifyLicense, getLicenseDetails, licensesFromReport, normalizeLicensesResponse, runLicenseCheck, getCompatibility } from "./license/index.js";
19
+ export { extractRemediations } from "./remediation.js";
20
+ export { generateReport, generateDeduplicationKey } from './remediation_report.js';
19
21
  export default { componentAnalysis, stackAnalysis, stackAnalysisBatch, imageAnalysis, validateToken, generateSbom };
20
22
  export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceModules, discoverUvWorkspaceMembers, discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata, };
21
23
  /**
@@ -39,7 +41,9 @@ export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceMod
39
41
  * TRUSTIFY_DA_PYTHON_PATH?: string | undefined,
40
42
  * TRUSTIFY_DA_PYTHON_VIRTUAL_ENV?: string | undefined,
41
43
  * TRUSTIFY_DA_PYTHON3_PATH?: string | undefined,
44
+ * TRUSTIFY_DA_PROVIDERS?: string | undefined,
42
45
  * TRUSTIFY_DA_RECOMMEND?: string | undefined,
46
+ * TRUSTIFY_DA_SOURCES?: string | undefined,
43
47
  * TRUSTIFY_DA_SKOPEO_CONFIG_PATH?: string | undefined,
44
48
  * TRUSTIFY_DA_SKOPEO_PATH?: string | undefined,
45
49
  * TRUSTIFY_DA_SYFT_CONFIG_PATH?: string | undefined,
@@ -10,6 +10,13 @@ export type ecosystem_maven = any;
10
10
  export const ecosystem_maven: string;
11
11
  export const ecosystem_gradle: "gradle";
12
12
  export default class Base_Java {
13
+ /**
14
+ * Maven dependency scopes. Used to detect whether the trailing column of a
15
+ * dependency-tree line is a scope keyword — which in turn signals that an
16
+ * optional classifier column is present between the packaging and version.
17
+ * @type {string[]}
18
+ */
19
+ static MAVEN_SCOPES: string[];
13
20
  /**
14
21
  *
15
22
  * @param {string} globalBinary name of the global binary
@@ -40,6 +47,52 @@ export default class Base_Java {
40
47
  * @protected
41
48
  */
42
49
  protected _getDepth(line: string): number;
50
+ /**
51
+ * Parse a single dependency-tree line into its Maven coordinate parts.
52
+ *
53
+ * This is the single source of truth for interpreting a dependency-tree
54
+ * line. Both {@link parseDep} (used to build SBOM component PURLs) and the
55
+ * Maven hash-map builder rely on it, so the PURL key and the artifact file
56
+ * path can never drift from one another.
57
+ *
58
+ * A line has the shape `groupId:artifactId:packaging[:classifier]:version[:scope]`.
59
+ * The classifier column is only present when a sixth column holds a known
60
+ * Maven scope keyword; otherwise the fourth column is the version.
61
+ *
62
+ * @param {string} line - line to parse from a dependency tree
63
+ * @returns {{groupId: string, artifactId: string, packaging: string, classifier: (string|null), version: string, scope: (string|null), overridden: boolean}}
64
+ * Parsed coordinate. `version` is the resolved concrete version — when the
65
+ * line carries a conflict override the override version replaces it and
66
+ * `overridden` is set, mirroring how Maven records the winning version.
67
+ */
68
+ parseCoordinate(line: string): {
69
+ groupId: string;
70
+ artifactId: string;
71
+ packaging: string;
72
+ classifier: (string | null);
73
+ version: string;
74
+ scope: (string | null);
75
+ overridden: boolean;
76
+ };
77
+ /**
78
+ * Build the canonical PackageURL for a parsed coordinate.
79
+ *
80
+ * The classifier is folded into the version component (e.g.
81
+ * `4.1.0-linux-x86_64`) except when the version came from a conflict
82
+ * override, in which case the override version stands alone — matching the
83
+ * historical behavior of {@link parseDep}.
84
+ *
85
+ * @param {{groupId: string, artifactId: string, classifier: (string|null), version: string, overridden: boolean}} coord
86
+ * @returns {PackageURL} The canonical packageURL for the coordinate
87
+ * @protected
88
+ */
89
+ protected _coordinateToPurl(coord: {
90
+ groupId: string;
91
+ artifactId: string;
92
+ classifier: (string | null);
93
+ version: string;
94
+ overridden: boolean;
95
+ }): PackageURL;
43
96
  /**
44
97
  * Create a PackageURL from any line in a Text Graph dependency tree for a manifest path.
45
98
  * @param {string} line - line to parse from a dependencies.txt file