@trustify-da/trustify-da-javascript-client 0.3.0-ea.b8af0f8 → 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.
- package/README.md +250 -11
- package/dist/package.json +33 -25
- package/dist/src/analysis.d.ts +14 -7
- package/dist/src/analysis.js +32 -15
- package/dist/src/cli.js +156 -3
- package/dist/src/cyclone_dx_sbom.d.ts +27 -1
- package/dist/src/cyclone_dx_sbom.js +82 -9
- package/dist/src/index.d.ts +86 -11
- package/dist/src/index.js +102 -30
- package/dist/src/license/index.d.ts +3 -3
- package/dist/src/license/index.js +4 -1
- package/dist/src/license/license_utils.js +4 -1
- package/dist/src/license/licenses_api.d.ts +2 -2
- package/dist/src/oci_image/images.d.ts +1 -1
- package/dist/src/oci_image/images.js +15 -1
- package/dist/src/oci_image/utils.d.ts +5 -5
- package/dist/src/oci_image/utils.js +11 -2
- package/dist/src/package_version.d.ts +8 -0
- package/dist/src/package_version.js +31 -0
- package/dist/src/provider.d.ts +4 -3
- package/dist/src/provider.js +12 -2
- package/dist/src/providers/base_java.d.ts +67 -12
- package/dist/src/providers/base_java.js +82 -61
- package/dist/src/providers/base_javascript.d.ts +74 -9
- package/dist/src/providers/base_javascript.js +149 -9
- package/dist/src/providers/base_pyproject.d.ts +158 -0
- package/dist/src/providers/base_pyproject.js +322 -0
- package/dist/src/providers/containerfile_parser.d.ts +5 -0
- package/dist/src/providers/containerfile_parser.js +20 -0
- package/dist/src/providers/golang_gomodules.d.ts +23 -13
- package/dist/src/providers/golang_gomodules.js +207 -120
- package/dist/src/providers/gomod_parser.d.ts +4 -0
- package/dist/src/providers/gomod_parser.js +16 -0
- package/dist/src/providers/java_gradle.d.ts +67 -0
- package/dist/src/providers/java_gradle.js +310 -17
- package/dist/src/providers/java_gradle_groovy.d.ts +1 -1
- package/dist/src/providers/java_gradle_kotlin.d.ts +1 -1
- package/dist/src/providers/java_maven.d.ts +38 -5
- package/dist/src/providers/java_maven.js +261 -8
- package/dist/src/providers/javascript_bun.d.ts +22 -0
- package/dist/src/providers/javascript_bun.js +141 -0
- package/dist/src/providers/javascript_npm.d.ts +19 -0
- package/dist/src/providers/javascript_npm.js +61 -1
- package/dist/src/providers/javascript_pnpm.d.ts +13 -0
- package/dist/src/providers/javascript_pnpm.js +53 -3
- package/dist/src/providers/javascript_yarn.d.ts +12 -0
- package/dist/src/providers/javascript_yarn.js +75 -2
- package/dist/src/providers/manifest.d.ts +2 -0
- package/dist/src/providers/manifest.js +22 -4
- package/dist/src/providers/marker_evaluator.d.ts +14 -0
- package/dist/src/providers/marker_evaluator.js +191 -0
- package/dist/src/providers/oci_dockerfile.d.ts +51 -0
- package/dist/src/providers/oci_dockerfile.js +177 -0
- package/dist/src/providers/processors/yarn_berry_processor.d.ts +6 -2
- package/dist/src/providers/processors/yarn_berry_processor.js +91 -7
- package/dist/src/providers/processors/yarn_classic_processor.d.ts +6 -2
- package/dist/src/providers/processors/yarn_classic_processor.js +8 -6
- package/dist/src/providers/python_controller.d.ts +5 -1
- package/dist/src/providers/python_controller.js +69 -8
- package/dist/src/providers/python_pip.d.ts +5 -0
- package/dist/src/providers/python_pip.js +6 -6
- package/dist/src/providers/python_pip_pyproject.d.ts +61 -0
- package/dist/src/providers/python_pip_pyproject.js +146 -0
- package/dist/src/providers/python_poetry.d.ts +98 -0
- package/dist/src/providers/python_poetry.js +286 -0
- package/dist/src/providers/python_uv.d.ts +46 -0
- package/dist/src/providers/python_uv.js +269 -0
- package/dist/src/providers/rust_cargo.d.ts +6 -2
- package/dist/src/providers/rust_cargo.js +101 -33
- package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
- package/dist/src/providers/tree-sitter-gomod.wasm +0 -0
- package/dist/src/remediate.d.ts +21 -0
- package/dist/src/remediate.js +149 -0
- package/dist/src/remediation.d.ts +57 -0
- package/dist/src/remediation.js +436 -0
- package/dist/src/remediation_report.d.ts +40 -0
- package/dist/src/remediation_report.js +159 -0
- package/dist/src/sbom.d.ts +25 -1
- package/dist/src/sbom.js +23 -2
- package/dist/src/tools.d.ts +28 -2
- package/dist/src/tools.js +82 -1
- package/dist/src/updaters/maven_updater.d.ts +26 -0
- package/dist/src/updaters/maven_updater.js +322 -0
- package/dist/src/updaters/toml_updater.d.ts +33 -0
- package/dist/src/updaters/toml_updater.js +244 -0
- package/dist/src/workspace.d.ts +9 -0
- package/dist/src/workspace.js +1 -1
- package/package.json +34 -26
package/dist/src/cli.js
CHANGED
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
+
import fs from 'node:fs';
|
|
2
3
|
import * as path from "path";
|
|
3
4
|
import yargs from 'yargs';
|
|
4
5
|
import { hideBin } from 'yargs/helpers';
|
|
5
6
|
import { getProjectLicense, getLicenseDetails } from './license/index.js';
|
|
6
|
-
import
|
|
7
|
+
import { runRemediation } from './remediate.js';
|
|
8
|
+
import client, { selectTrustifyDABackend, generateSbom } from './index.js';
|
|
7
9
|
// command for component analysis take manifest type and content
|
|
8
10
|
const component = {
|
|
9
11
|
command: 'component </path/to/manifest>',
|
|
@@ -18,11 +20,25 @@ const component = {
|
|
|
18
20
|
desc: 'Workspace root directory (for monorepos; lock file is expected here)',
|
|
19
21
|
type: 'string',
|
|
20
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',
|
|
21
31
|
}
|
|
22
32
|
}),
|
|
23
33
|
handler: async (args) => {
|
|
24
34
|
let manifestName = args['/path/to/manifest'];
|
|
25
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
|
+
}
|
|
26
42
|
let res = await client.componentAnalysis(manifestName, opts);
|
|
27
43
|
console.log(JSON.stringify(res, null, 2));
|
|
28
44
|
}
|
|
@@ -71,6 +87,14 @@ const image = {
|
|
|
71
87
|
desc: 'For JSON report, get only the \'summary\'',
|
|
72
88
|
type: 'boolean',
|
|
73
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',
|
|
74
98
|
}
|
|
75
99
|
}),
|
|
76
100
|
handler: async (args) => {
|
|
@@ -80,7 +104,14 @@ const image = {
|
|
|
80
104
|
}
|
|
81
105
|
let html = args['html'];
|
|
82
106
|
let summary = args['summary'];
|
|
83
|
-
|
|
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);
|
|
84
115
|
if (summary && !html) {
|
|
85
116
|
let summaries = {};
|
|
86
117
|
for (let [imageRef, report] of Object.entries(res)) {
|
|
@@ -131,6 +162,14 @@ const stack = {
|
|
|
131
162
|
desc: 'Workspace root directory (for monorepos; lock file is expected here)',
|
|
132
163
|
type: 'string',
|
|
133
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',
|
|
134
173
|
}
|
|
135
174
|
}),
|
|
136
175
|
handler: async (args) => {
|
|
@@ -138,6 +177,12 @@ const stack = {
|
|
|
138
177
|
let html = args['html'];
|
|
139
178
|
let summary = args['summary'];
|
|
140
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
|
+
}
|
|
141
186
|
let theProvidersSummary = new Map();
|
|
142
187
|
let theProvidersObject = {};
|
|
143
188
|
let res = await client.stackAnalysis(manifest, html, opts);
|
|
@@ -200,6 +245,14 @@ const stackBatch = {
|
|
|
200
245
|
desc: 'Stop on first invalid package.json or SBOM error (env: TRUSTIFY_DA_CONTINUE_ON_ERROR=false)',
|
|
201
246
|
type: 'boolean',
|
|
202
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',
|
|
203
256
|
}
|
|
204
257
|
}),
|
|
205
258
|
handler: async (args) => {
|
|
@@ -220,6 +273,12 @@ const stackBatch = {
|
|
|
220
273
|
if (args.failFast) {
|
|
221
274
|
opts.continueOnError = false;
|
|
222
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
|
+
}
|
|
223
282
|
let res = await client.stackAnalysisBatch(workspaceRoot, html, opts);
|
|
224
283
|
const batchAnalysis = res && typeof res === 'object' && res != null && 'analysis' in res ? res.analysis : res;
|
|
225
284
|
if (summary && !html && typeof batchAnalysis === 'object') {
|
|
@@ -325,15 +384,109 @@ const license = {
|
|
|
325
384
|
console.log(JSON.stringify(output, null, 2));
|
|
326
385
|
}
|
|
327
386
|
};
|
|
387
|
+
const sbom = {
|
|
388
|
+
command: 'sbom </path/to/manifest> [--output]',
|
|
389
|
+
desc: 'generate a CycloneDX SBOM from a manifest file',
|
|
390
|
+
builder: yargs => yargs.positional('/path/to/manifest', {
|
|
391
|
+
desc: 'manifest path for SBOM generation',
|
|
392
|
+
type: 'string',
|
|
393
|
+
normalize: true,
|
|
394
|
+
}).options({
|
|
395
|
+
output: {
|
|
396
|
+
alias: 'o',
|
|
397
|
+
desc: 'Write SBOM JSON to a file instead of stdout',
|
|
398
|
+
type: 'string',
|
|
399
|
+
normalize: true,
|
|
400
|
+
},
|
|
401
|
+
workspaceDir: {
|
|
402
|
+
alias: 'w',
|
|
403
|
+
desc: 'Workspace root directory (for monorepos; lock file is expected here)',
|
|
404
|
+
type: 'string',
|
|
405
|
+
normalize: true,
|
|
406
|
+
}
|
|
407
|
+
}),
|
|
408
|
+
handler: async (args) => {
|
|
409
|
+
let manifest = args['/path/to/manifest'];
|
|
410
|
+
const opts = args.workspaceDir ? { TRUSTIFY_DA_WORKSPACE_DIR: args.workspaceDir } : {};
|
|
411
|
+
let result;
|
|
412
|
+
try {
|
|
413
|
+
result = await generateSbom(manifest, opts);
|
|
414
|
+
}
|
|
415
|
+
catch (err) {
|
|
416
|
+
console.error(JSON.stringify({ error: `Failed to generate SBOM: ${err.message}` }, null, 2));
|
|
417
|
+
process.exit(1);
|
|
418
|
+
}
|
|
419
|
+
const json = JSON.stringify(result, null, 2);
|
|
420
|
+
if (args.output) {
|
|
421
|
+
try {
|
|
422
|
+
fs.writeFileSync(args.output, json);
|
|
423
|
+
}
|
|
424
|
+
catch (err) {
|
|
425
|
+
console.error(JSON.stringify({ error: `Failed to write output file: ${err.message}` }, null, 2));
|
|
426
|
+
process.exit(1);
|
|
427
|
+
}
|
|
428
|
+
}
|
|
429
|
+
else {
|
|
430
|
+
console.log(json);
|
|
431
|
+
}
|
|
432
|
+
}
|
|
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
|
+
};
|
|
328
479
|
// parse and invoke the command
|
|
329
480
|
yargs(hideBin(process.argv))
|
|
330
|
-
.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}`)
|
|
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}`)
|
|
331
482
|
.command(stack)
|
|
332
483
|
.command(stackBatch)
|
|
333
484
|
.command(component)
|
|
334
485
|
.command(image)
|
|
335
486
|
.command(validateToken)
|
|
336
487
|
.command(license)
|
|
488
|
+
.command(sbom)
|
|
489
|
+
.command(remediate)
|
|
337
490
|
.scriptName('')
|
|
338
491
|
.version(false)
|
|
339
492
|
.demandCommand(1)
|
|
@@ -18,9 +18,27 @@ export default class CycloneDxSbom {
|
|
|
18
18
|
* Adds a dependency relationship between two components in the SBOM
|
|
19
19
|
* @param {PackageURL} sourceRef - The source component (parent)
|
|
20
20
|
* @param {PackageURL} targetRef - The target component (dependency)
|
|
21
|
+
* @param {string} [scope] - Scope of the dependency
|
|
22
|
+
* @param {Array<{alg: string, content: string}>} [targetHashes] - Optional hashes for the target component
|
|
21
23
|
* @return {CycloneDxSbom} The updated SBOM
|
|
22
24
|
*/
|
|
23
|
-
addDependency(sourceRef: PackageURL, targetRef: PackageURL, scope
|
|
25
|
+
addDependency(sourceRef: PackageURL, targetRef: PackageURL, scope?: string, targetHashes?: Array<{
|
|
26
|
+
alg: string;
|
|
27
|
+
content: string;
|
|
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;
|
|
24
42
|
/** @param {{}} opts - various options, settings and configuration of application.
|
|
25
43
|
* @return String CycloneDx Sbom json object in a string format
|
|
26
44
|
*/
|
|
@@ -50,6 +68,7 @@ export default class CycloneDxSbom {
|
|
|
50
68
|
version: any;
|
|
51
69
|
scope: any;
|
|
52
70
|
licenses?: any;
|
|
71
|
+
hashes?: any;
|
|
53
72
|
};
|
|
54
73
|
/**
|
|
55
74
|
* This method gets an array of dependencies to be ignored, and remove all of them from CycloneDx Sbom
|
|
@@ -70,6 +89,13 @@ export default class CycloneDxSbom {
|
|
|
70
89
|
* @return {boolean}
|
|
71
90
|
*/
|
|
72
91
|
checkIfPackageInsideDependsOnList(component: any, name: string): boolean;
|
|
92
|
+
/**
|
|
93
|
+
* Checks if any entry in the dependsOn list of sourceRef starts with the given purl prefix.
|
|
94
|
+
* @param {PackageURL} sourceRef - The source component
|
|
95
|
+
* @param {string} purlPrefix - The purl prefix to match (e.g. "pkg:npm/minimist@")
|
|
96
|
+
* @return {boolean}
|
|
97
|
+
*/
|
|
98
|
+
checkDependsOnByPurlPrefix(sourceRef: PackageURL, purlPrefix: string): boolean;
|
|
73
99
|
/** Removes the root component from the sbom
|
|
74
100
|
*/
|
|
75
101
|
removeRootComponent(): void;
|
|
@@ -1,15 +1,23 @@
|
|
|
1
1
|
import { EOL } from "os";
|
|
2
2
|
import { PackageURL } from "packageurl-js";
|
|
3
|
+
import { getPackageVersion } from "./package_version.js";
|
|
4
|
+
/**
|
|
5
|
+
* This client's version, read once at module load, used to populate
|
|
6
|
+
* metadata.tools.components[].version in the generated SBOM.
|
|
7
|
+
* @type {string|undefined}
|
|
8
|
+
*/
|
|
9
|
+
const PACKAGE_VERSION = getPackageVersion();
|
|
3
10
|
/**
|
|
4
11
|
*
|
|
5
12
|
* @param component {PackageURL}
|
|
6
13
|
* @param type type of package - application or library
|
|
7
14
|
* @param scope scope of the component - runtime or compile
|
|
8
15
|
* @param licenses optional license string or array of licenses for the component
|
|
9
|
-
* @
|
|
16
|
+
* @param hashes optional array of hash objects for the component, e.g. [{alg: "SHA-256", content: "..."}]
|
|
17
|
+
* @return {{"bom-ref": string, name, purl: string, type, version, scope, licenses?, hashes?}}
|
|
10
18
|
* @private
|
|
11
19
|
*/
|
|
12
|
-
function getComponent(component, type, scope, licenses) {
|
|
20
|
+
function getComponent(component, type, scope, licenses, hashes) {
|
|
13
21
|
let componentObject;
|
|
14
22
|
if (component instanceof PackageURL) {
|
|
15
23
|
if (component.namespace) {
|
|
@@ -40,12 +48,24 @@ function getComponent(component, type, scope, licenses) {
|
|
|
40
48
|
// Add licenses if provided (CycloneDX format). Callers must provide valid SPDX identifiers.
|
|
41
49
|
if (licenses) {
|
|
42
50
|
const licenseArray = Array.isArray(licenses) ? licenses : [licenses];
|
|
43
|
-
|
|
51
|
+
const validLicenses = licenseArray
|
|
52
|
+
.map(lic => {
|
|
44
53
|
if (typeof lic === 'string') {
|
|
45
54
|
return { license: { id: lic } };
|
|
46
55
|
}
|
|
47
|
-
|
|
48
|
-
|
|
56
|
+
if (typeof lic === 'object' && lic !== null && ('license' in lic || 'expression' in lic)) {
|
|
57
|
+
return lic;
|
|
58
|
+
}
|
|
59
|
+
return null;
|
|
60
|
+
})
|
|
61
|
+
.filter(Boolean);
|
|
62
|
+
if (validLicenses.length > 0) {
|
|
63
|
+
componentObject.licenses = validLicenses;
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
// Add hashes if provided (CycloneDX 1.4 format).
|
|
67
|
+
if (hashes && hashes.length > 0) {
|
|
68
|
+
componentObject.hashes = hashes;
|
|
49
69
|
}
|
|
50
70
|
return componentObject;
|
|
51
71
|
}
|
|
@@ -86,16 +106,24 @@ export default class CycloneDxSbom {
|
|
|
86
106
|
* Adds a dependency relationship between two components in the SBOM
|
|
87
107
|
* @param {PackageURL} sourceRef - The source component (parent)
|
|
88
108
|
* @param {PackageURL} targetRef - The target component (dependency)
|
|
109
|
+
* @param {string} [scope] - Scope of the dependency
|
|
110
|
+
* @param {Array<{alg: string, content: string}>} [targetHashes] - Optional hashes for the target component
|
|
89
111
|
* @return {CycloneDxSbom} The updated SBOM
|
|
90
112
|
*/
|
|
91
|
-
addDependency(sourceRef, targetRef, scope) {
|
|
113
|
+
addDependency(sourceRef, targetRef, scope, targetHashes) {
|
|
92
114
|
const sourcePurl = sourceRef.toString();
|
|
93
115
|
const targetPurl = targetRef.toString();
|
|
94
116
|
// Ensure both components exist in the components list
|
|
95
117
|
[sourceRef, targetRef].forEach((ref, index) => {
|
|
96
118
|
const purl = index === 0 ? sourcePurl : targetPurl;
|
|
97
|
-
|
|
98
|
-
|
|
119
|
+
const existingIndex = this.getComponentIndex(purl);
|
|
120
|
+
if (existingIndex < 0) {
|
|
121
|
+
const hashes = index === 1 ? targetHashes : undefined;
|
|
122
|
+
this.components.push(getComponent(ref, "library", scope, undefined, hashes));
|
|
123
|
+
}
|
|
124
|
+
else if (index === 1 && targetHashes && targetHashes.length > 0 && !this.components[existingIndex].hashes) {
|
|
125
|
+
// Update hashes if the component was first seen without them (e.g. as a source)
|
|
126
|
+
this.components[existingIndex].hashes = targetHashes;
|
|
99
127
|
}
|
|
100
128
|
});
|
|
101
129
|
// Ensure source dependency exists
|
|
@@ -114,6 +142,30 @@ export default class CycloneDxSbom {
|
|
|
114
142
|
}
|
|
115
143
|
return this;
|
|
116
144
|
}
|
|
145
|
+
/**
|
|
146
|
+
* Attach hashes to already-added components by matching their PURL. This is a
|
|
147
|
+
* post-processing step so ecosystem-specific hash sources (e.g. Maven reading
|
|
148
|
+
* the local .m2 cache) can enrich the SBOM without threading their concern
|
|
149
|
+
* through the shared dependency-tree parser. Components without a matching
|
|
150
|
+
* entry, or whose hashes are already set, are left untouched.
|
|
151
|
+
* @param {Map<string, Array<{alg: string, content: string}>>} hashMap - PURL→hashes map
|
|
152
|
+
* @return {CycloneDxSbom} the updated SBOM
|
|
153
|
+
*/
|
|
154
|
+
attachHashes(hashMap) {
|
|
155
|
+
if (!hashMap || hashMap.size === 0) {
|
|
156
|
+
return this;
|
|
157
|
+
}
|
|
158
|
+
for (const component of this.components) {
|
|
159
|
+
if (component.hashes) {
|
|
160
|
+
continue;
|
|
161
|
+
}
|
|
162
|
+
const hashes = hashMap.get(component.purl);
|
|
163
|
+
if (hashes && hashes.length > 0) {
|
|
164
|
+
component.hashes = hashes;
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
return this;
|
|
168
|
+
}
|
|
117
169
|
/** @param {{}} opts - various options, settings and configuration of application.
|
|
118
170
|
* @return String CycloneDx Sbom json object in a string format
|
|
119
171
|
*/
|
|
@@ -123,11 +175,18 @@ export default class CycloneDxSbom {
|
|
|
123
175
|
const rootPurl = this.rootComponent?.purl;
|
|
124
176
|
this.sbomObject = {
|
|
125
177
|
"bomFormat": "CycloneDX",
|
|
126
|
-
"specVersion": "1.
|
|
178
|
+
"specVersion": "1.6",
|
|
127
179
|
"version": 1,
|
|
128
180
|
"metadata": {
|
|
129
181
|
"timestamp": new Date(),
|
|
130
182
|
"component": this.rootComponent,
|
|
183
|
+
"tools": {
|
|
184
|
+
"components": [{
|
|
185
|
+
"type": "application",
|
|
186
|
+
"name": "trustify-da-javascript-client",
|
|
187
|
+
"version": PACKAGE_VERSION
|
|
188
|
+
}]
|
|
189
|
+
},
|
|
131
190
|
"properties": new Array()
|
|
132
191
|
},
|
|
133
192
|
"components": this.components.filter(c => c.purl !== rootPurl),
|
|
@@ -242,6 +301,20 @@ export default class CycloneDxSbom {
|
|
|
242
301
|
return false;
|
|
243
302
|
}
|
|
244
303
|
}
|
|
304
|
+
/**
|
|
305
|
+
* Checks if any entry in the dependsOn list of sourceRef starts with the given purl prefix.
|
|
306
|
+
* @param {PackageURL} sourceRef - The source component
|
|
307
|
+
* @param {string} purlPrefix - The purl prefix to match (e.g. "pkg:npm/minimist@")
|
|
308
|
+
* @return {boolean}
|
|
309
|
+
*/
|
|
310
|
+
checkDependsOnByPurlPrefix(sourceRef, purlPrefix) {
|
|
311
|
+
const sourcePurl = sourceRef.toString();
|
|
312
|
+
const depIndex = this.getDependencyIndex(sourcePurl);
|
|
313
|
+
if (depIndex < 0) {
|
|
314
|
+
return false;
|
|
315
|
+
}
|
|
316
|
+
return this.dependencies[depIndex].dependsOn.some(dep => dep.startsWith(purlPrefix));
|
|
317
|
+
}
|
|
245
318
|
/** Removes the root component from the sbom
|
|
246
319
|
*/
|
|
247
320
|
removeRootComponent() {
|
package/dist/src/index.d.ts
CHANGED
|
@@ -13,14 +13,25 @@ export function selectTrustifyDABackend(opts?: {
|
|
|
13
13
|
TRUSTIFY_DA_DEBUG?: string | undefined;
|
|
14
14
|
TRUSTIFY_DA_BACKEND_URL?: string | undefined;
|
|
15
15
|
}): string;
|
|
16
|
+
/**
|
|
17
|
+
* Generate a CycloneDX SBOM from a manifest file. No backend HTTP request is made.
|
|
18
|
+
*
|
|
19
|
+
* @param {string} manifestPath - path to the manifest file (e.g. pom.xml, package.json)
|
|
20
|
+
* @param {Options} [opts={}] - optional options (e.g. workspace dir, tool paths)
|
|
21
|
+
* @returns {Promise<object>} parsed CycloneDX SBOM JSON object
|
|
22
|
+
* @throws {Error} if the manifest is unsupported or SBOM generation fails
|
|
23
|
+
*/
|
|
24
|
+
export function generateSbom(manifestPath: string, opts?: Options): Promise<object>;
|
|
16
25
|
export { parseImageRef } from "./oci_image/utils.js";
|
|
17
26
|
export { ImageRef } from "./oci_image/images.js";
|
|
27
|
+
export { extractRemediations } from "./remediation.js";
|
|
18
28
|
declare namespace _default {
|
|
19
29
|
export { componentAnalysis };
|
|
20
30
|
export { stackAnalysis };
|
|
21
31
|
export { stackAnalysisBatch };
|
|
22
32
|
export { imageAnalysis };
|
|
23
33
|
export { validateToken };
|
|
34
|
+
export { generateSbom };
|
|
24
35
|
}
|
|
25
36
|
export default _default;
|
|
26
37
|
export type Options = {
|
|
@@ -43,7 +54,9 @@ export type Options = {
|
|
|
43
54
|
TRUSTIFY_DA_PYTHON_PATH?: string | undefined;
|
|
44
55
|
TRUSTIFY_DA_PYTHON_VIRTUAL_ENV?: string | undefined;
|
|
45
56
|
TRUSTIFY_DA_PYTHON3_PATH?: string | undefined;
|
|
46
|
-
|
|
57
|
+
TRUSTIFY_DA_PROVIDERS?: string | undefined;
|
|
58
|
+
TRUSTIFY_DA_RECOMMEND?: string | undefined;
|
|
59
|
+
TRUSTIFY_DA_SOURCES?: string | undefined;
|
|
47
60
|
TRUSTIFY_DA_SKOPEO_CONFIG_PATH?: string | undefined;
|
|
48
61
|
TRUSTIFY_DA_SKOPEO_PATH?: string | undefined;
|
|
49
62
|
TRUSTIFY_DA_SYFT_CONFIG_PATH?: string | undefined;
|
|
@@ -64,11 +77,13 @@ export type Options = {
|
|
|
64
77
|
TRUSTIFY_DA_CONTINUE_ON_ERROR?: string | undefined;
|
|
65
78
|
batchMetadata?: boolean | undefined;
|
|
66
79
|
TRUSTIFY_DA_BATCH_METADATA?: string | undefined;
|
|
80
|
+
TRUSTIFY_DA_UV_PATH?: string | undefined;
|
|
81
|
+
TRUSTIFY_DA_POETRY_PATH?: string | undefined;
|
|
67
82
|
[key: string]: string | number | boolean | string[] | undefined;
|
|
68
83
|
};
|
|
69
84
|
export type BatchAnalysisMetadata = {
|
|
70
85
|
workspaceRoot: string;
|
|
71
|
-
ecosystem: "javascript" | "cargo" | "unknown";
|
|
86
|
+
ecosystem: "javascript" | "cargo" | "pyproject" | "unknown";
|
|
72
87
|
total: number;
|
|
73
88
|
successful: number;
|
|
74
89
|
failed: number;
|
|
@@ -94,7 +109,7 @@ export type SbomResult = {
|
|
|
94
109
|
* @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
|
|
95
110
|
* @throws {Error} if no matching provider, failed to get create content, or backend request failed
|
|
96
111
|
*/
|
|
97
|
-
declare function componentAnalysis(manifest: string, opts?: Options): Promise<
|
|
112
|
+
declare function componentAnalysis(manifest: string, opts?: Options): Promise<any>;
|
|
98
113
|
/**
|
|
99
114
|
* @overload
|
|
100
115
|
* @param {string} manifest
|
|
@@ -112,7 +127,7 @@ declare function stackAnalysis(manifest: string, html: true, opts?: Options | un
|
|
|
112
127
|
* @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
|
|
113
128
|
* @throws {Error}
|
|
114
129
|
*/
|
|
115
|
-
declare function stackAnalysis(manifest: string, html: false, opts?: Options | undefined): Promise<
|
|
130
|
+
declare function stackAnalysis(manifest: string, html: false, opts?: Options | undefined): Promise<any>;
|
|
116
131
|
/**
|
|
117
132
|
* Get stack analysis report for a manifest file.
|
|
118
133
|
* @overload
|
|
@@ -123,24 +138,79 @@ declare function stackAnalysis(manifest: string, html: false, opts?: Options | u
|
|
|
123
138
|
* @throws {Error} if manifest inaccessible, no matching provider, failed to get create content,
|
|
124
139
|
* or backend request failed
|
|
125
140
|
*/
|
|
126
|
-
declare function stackAnalysis(manifest: string, html?: boolean | undefined, opts?: Options | undefined): Promise<string |
|
|
141
|
+
declare function stackAnalysis(manifest: string, html?: boolean | undefined, opts?: Options | undefined): Promise<string | any>;
|
|
142
|
+
/**
|
|
143
|
+
* @overload
|
|
144
|
+
* @param {string} workspaceRoot
|
|
145
|
+
* @param {true} html
|
|
146
|
+
* @param {Options & { batchMetadata: true }} opts
|
|
147
|
+
* @returns {Promise<{ analysis: string, metadata: BatchAnalysisMetadata }>}
|
|
148
|
+
* @throws {Error}
|
|
149
|
+
*/
|
|
150
|
+
declare function stackAnalysisBatch(workspaceRoot: string, html: true, opts: Options & {
|
|
151
|
+
batchMetadata: true;
|
|
152
|
+
}): Promise<{
|
|
153
|
+
analysis: string;
|
|
154
|
+
metadata: BatchAnalysisMetadata;
|
|
155
|
+
}>;
|
|
156
|
+
/**
|
|
157
|
+
* @overload
|
|
158
|
+
* @param {string} workspaceRoot
|
|
159
|
+
* @param {true} html
|
|
160
|
+
* @param {Options & { batchMetadata?: false }} [opts={}]
|
|
161
|
+
* @returns {Promise<string>}
|
|
162
|
+
* @throws {Error}
|
|
163
|
+
*/
|
|
164
|
+
declare function stackAnalysisBatch(workspaceRoot: string, html: true, opts?: (Options & {
|
|
165
|
+
batchMetadata?: false;
|
|
166
|
+
}) | undefined): Promise<string>;
|
|
167
|
+
/**
|
|
168
|
+
* @overload
|
|
169
|
+
* @param {string} workspaceRoot
|
|
170
|
+
* @param {false} html
|
|
171
|
+
* @param {Options & { batchMetadata: true }} opts
|
|
172
|
+
* @returns {Promise<{ analysis: Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>, metadata: BatchAnalysisMetadata }>}
|
|
173
|
+
* @throws {Error}
|
|
174
|
+
*/
|
|
175
|
+
declare function stackAnalysisBatch(workspaceRoot: string, html: false, opts: Options & {
|
|
176
|
+
batchMetadata: true;
|
|
177
|
+
}): Promise<{
|
|
178
|
+
analysis: {
|
|
179
|
+
[x: string]: any;
|
|
180
|
+
};
|
|
181
|
+
metadata: BatchAnalysisMetadata;
|
|
182
|
+
}>;
|
|
183
|
+
/**
|
|
184
|
+
* @overload
|
|
185
|
+
* @param {string} workspaceRoot
|
|
186
|
+
* @param {false} html
|
|
187
|
+
* @param {Options & { batchMetadata?: false }} [opts={}]
|
|
188
|
+
* @returns {Promise<Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
|
|
189
|
+
* @throws {Error}
|
|
190
|
+
*/
|
|
191
|
+
declare function stackAnalysisBatch(workspaceRoot: string, html: false, opts?: (Options & {
|
|
192
|
+
batchMetadata?: false;
|
|
193
|
+
}) | undefined): Promise<{
|
|
194
|
+
[x: string]: any;
|
|
195
|
+
}>;
|
|
127
196
|
/**
|
|
128
197
|
* Get stack analysis for all workspace packages/crates (batch).
|
|
129
198
|
* Detects ecosystem from workspace root: Cargo (Cargo.toml + Cargo.lock) or JS/TS (package.json + lock file).
|
|
130
199
|
* SBOMs are generated in parallel (see `batchConcurrency`) unless `continueOnError: false` (fail-fast sequential).
|
|
131
200
|
* With `opts.batchMetadata` / `TRUSTIFY_DA_BATCH_METADATA`, returns `{ analysis, metadata }` including validation and SBOM errors.
|
|
132
201
|
*
|
|
202
|
+
* @overload
|
|
133
203
|
* @param {string} workspaceRoot - Path to workspace root (containing lock file and workspace config)
|
|
134
204
|
* @param {boolean} [html=false] - true returns HTML, false returns JSON report
|
|
135
205
|
* @param {Options} [opts={}] - `batchConcurrency`, discovery ignores, `continueOnError` (default true), `batchMetadata` (default false)
|
|
136
206
|
* @returns {Promise<string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>|{ analysis: string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>, metadata: BatchAnalysisMetadata }>}
|
|
137
207
|
* @throws {Error} if workspace root invalid, no manifests found, no packages pass validation, no SBOMs produced, or backend request failed. When `opts.batchMetadata` is set, `error.batchMetadata` may be set on thrown errors.
|
|
138
208
|
*/
|
|
139
|
-
declare function stackAnalysisBatch(workspaceRoot: string, html?: boolean, opts?: Options): Promise<string | {
|
|
140
|
-
[x: string]:
|
|
209
|
+
declare function stackAnalysisBatch(workspaceRoot: string, html?: boolean | undefined, opts?: Options | undefined): Promise<string | {
|
|
210
|
+
[x: string]: any;
|
|
141
211
|
} | {
|
|
142
212
|
analysis: string | {
|
|
143
|
-
[x: string]:
|
|
213
|
+
[x: string]: any;
|
|
144
214
|
};
|
|
145
215
|
metadata: BatchAnalysisMetadata;
|
|
146
216
|
}>;
|
|
@@ -162,7 +232,7 @@ declare function imageAnalysis(imageRefs: Array<string>, html: true, opts?: Opti
|
|
|
162
232
|
* @throws {Error}
|
|
163
233
|
*/
|
|
164
234
|
declare function imageAnalysis(imageRefs: Array<string>, html: false, opts?: Options | undefined): Promise<{
|
|
165
|
-
[x: string]:
|
|
235
|
+
[x: string]: any;
|
|
166
236
|
}>;
|
|
167
237
|
/**
|
|
168
238
|
* Get image analysis report for a set of OCI image references.
|
|
@@ -175,7 +245,7 @@ declare function imageAnalysis(imageRefs: Array<string>, html: false, opts?: Opt
|
|
|
175
245
|
* or backend request failed
|
|
176
246
|
*/
|
|
177
247
|
declare function imageAnalysis(imageRefs: Array<string>, html?: boolean | undefined, opts?: Options | undefined): Promise<string | {
|
|
178
|
-
[x: string]:
|
|
248
|
+
[x: string]: any;
|
|
179
249
|
}>;
|
|
180
250
|
/**
|
|
181
251
|
* Validates the Exhort token.
|
|
@@ -184,6 +254,10 @@ declare function imageAnalysis(imageRefs: Array<string>, html?: boolean | undefi
|
|
|
184
254
|
* @throws {Error} if the backend request failed.
|
|
185
255
|
*/
|
|
186
256
|
declare function validateToken(opts?: Options): Promise<object>;
|
|
257
|
+
import { discoverMavenModules } from './providers/java_maven.js';
|
|
258
|
+
import { discoverGradleSubprojects } from './providers/java_gradle.js';
|
|
259
|
+
import { discoverGoWorkspaceModules } from './providers/golang_gomodules.js';
|
|
260
|
+
import { discoverUvWorkspaceMembers } from './providers/python_uv.js';
|
|
187
261
|
import { discoverWorkspacePackages } from './workspace.js';
|
|
188
262
|
import { discoverWorkspaceCrates } from './workspace.js';
|
|
189
263
|
import { validatePackageJson } from './workspace.js';
|
|
@@ -191,5 +265,6 @@ import { resolveWorkspaceDiscoveryIgnore } from './workspace.js';
|
|
|
191
265
|
import { filterManifestPathsByDiscoveryIgnore } from './workspace.js';
|
|
192
266
|
import { resolveContinueOnError } from './batch_opts.js';
|
|
193
267
|
import { resolveBatchMetadata } from './batch_opts.js';
|
|
194
|
-
export { discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata };
|
|
268
|
+
export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceModules, discoverUvWorkspaceMembers, discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata };
|
|
195
269
|
export { getProjectLicense, findLicenseFilePath, identifyLicense, getLicenseDetails, licensesFromReport, normalizeLicensesResponse, runLicenseCheck, getCompatibility } from "./license/index.js";
|
|
270
|
+
export { generateReport, generateDeduplicationKey } from "./remediation_report.js";
|