@trustify-da/trustify-da-javascript-client 0.3.0-ea.477151f → 0.3.0-ea.5047f15
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 +191 -11
- package/dist/package.json +13 -4
- package/dist/src/analysis.d.ts +16 -6
- package/dist/src/analysis.js +72 -68
- package/dist/src/batch_opts.d.ts +24 -0
- package/dist/src/batch_opts.js +35 -0
- package/dist/src/cli.js +241 -8
- package/dist/src/cyclone_dx_sbom.d.ts +10 -1
- package/dist/src/cyclone_dx_sbom.js +32 -5
- package/dist/src/index.d.ts +76 -1
- package/dist/src/index.js +285 -4
- package/dist/src/license/index.d.ts +28 -0
- package/dist/src/license/index.js +100 -0
- package/dist/src/license/license_utils.d.ts +40 -0
- package/dist/src/license/license_utils.js +134 -0
- package/dist/src/license/licenses_api.d.ts +34 -0
- package/dist/src/license/licenses_api.js +98 -0
- package/dist/src/license/project_license.d.ts +20 -0
- package/dist/src/license/project_license.js +62 -0
- package/dist/src/oci_image/utils.js +11 -2
- package/dist/src/provider.d.ts +15 -3
- package/dist/src/provider.js +29 -5
- package/dist/src/providers/base_javascript.d.ts +29 -7
- package/dist/src/providers/base_javascript.js +129 -22
- package/dist/src/providers/base_pyproject.d.ts +149 -0
- package/dist/src/providers/base_pyproject.js +314 -0
- package/dist/src/providers/golang_gomodules.d.ts +19 -12
- package/dist/src/providers/golang_gomodules.js +112 -114
- 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 +6 -0
- package/dist/src/providers/java_gradle.js +12 -2
- package/dist/src/providers/java_maven.d.ts +8 -1
- package/dist/src/providers/java_maven.js +32 -4
- package/dist/src/providers/javascript_pnpm.d.ts +1 -1
- package/dist/src/providers/javascript_pnpm.js +2 -2
- package/dist/src/providers/manifest.d.ts +2 -0
- package/dist/src/providers/manifest.js +22 -4
- package/dist/src/providers/processors/yarn_berry_processor.js +82 -3
- package/dist/src/providers/python_controller.js +7 -3
- package/dist/src/providers/python_pip.d.ts +7 -0
- package/dist/src/providers/python_pip.js +14 -4
- package/dist/src/providers/python_pip_pyproject.d.ts +61 -0
- package/dist/src/providers/python_pip_pyproject.js +144 -0
- package/dist/src/providers/python_poetry.d.ts +43 -0
- package/dist/src/providers/python_poetry.js +175 -0
- package/dist/src/providers/python_uv.d.ts +27 -0
- package/dist/src/providers/python_uv.js +149 -0
- package/dist/src/providers/requirements_parser.js +5 -8
- package/dist/src/providers/rust_cargo.d.ts +52 -0
- package/dist/src/providers/rust_cargo.js +614 -0
- package/dist/src/providers/tree-sitter-gomod.wasm +0 -0
- package/dist/src/providers/tree-sitter-requirements.wasm +0 -0
- package/dist/src/sbom.d.ts +10 -1
- package/dist/src/sbom.js +12 -2
- package/dist/src/tools.d.ts +18 -0
- package/dist/src/tools.js +55 -0
- package/dist/src/workspace.d.ts +61 -0
- package/dist/src/workspace.js +256 -0
- package/package.json +14 -5
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Whether to skip failed manifests and continue (default), or fail on first SBOM/validation error.
|
|
3
|
+
* `opts.continueOnError` overrides; env `TRUSTIFY_DA_CONTINUE_ON_ERROR=false` disables continuation.
|
|
4
|
+
*
|
|
5
|
+
* @param {{ continueOnError?: boolean, TRUSTIFY_DA_CONTINUE_ON_ERROR?: string, [key: string]: unknown }} [opts={}]
|
|
6
|
+
* @returns {boolean} true = collect errors (default), false = fail-fast
|
|
7
|
+
*/
|
|
8
|
+
export function resolveContinueOnError(opts?: {
|
|
9
|
+
continueOnError?: boolean;
|
|
10
|
+
TRUSTIFY_DA_CONTINUE_ON_ERROR?: string;
|
|
11
|
+
[key: string]: unknown;
|
|
12
|
+
}): boolean;
|
|
13
|
+
/**
|
|
14
|
+
* When true, `stackAnalysisBatch` returns `{ analysis, metadata }` instead of the backend response only.
|
|
15
|
+
* `opts.batchMetadata` overrides; env `TRUSTIFY_DA_BATCH_METADATA=true` enables.
|
|
16
|
+
*
|
|
17
|
+
* @param {{ batchMetadata?: boolean, TRUSTIFY_DA_BATCH_METADATA?: string, [key: string]: unknown }} [opts={}]
|
|
18
|
+
* @returns {boolean}
|
|
19
|
+
*/
|
|
20
|
+
export function resolveBatchMetadata(opts?: {
|
|
21
|
+
batchMetadata?: boolean;
|
|
22
|
+
TRUSTIFY_DA_BATCH_METADATA?: string;
|
|
23
|
+
[key: string]: unknown;
|
|
24
|
+
}): boolean;
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { getCustom } from './tools.js';
|
|
2
|
+
/**
|
|
3
|
+
* Whether to skip failed manifests and continue (default), or fail on first SBOM/validation error.
|
|
4
|
+
* `opts.continueOnError` overrides; env `TRUSTIFY_DA_CONTINUE_ON_ERROR=false` disables continuation.
|
|
5
|
+
*
|
|
6
|
+
* @param {{ continueOnError?: boolean, TRUSTIFY_DA_CONTINUE_ON_ERROR?: string, [key: string]: unknown }} [opts={}]
|
|
7
|
+
* @returns {boolean} true = collect errors (default), false = fail-fast
|
|
8
|
+
*/
|
|
9
|
+
export function resolveContinueOnError(opts = {}) {
|
|
10
|
+
if (typeof opts.continueOnError === 'boolean') {
|
|
11
|
+
return opts.continueOnError;
|
|
12
|
+
}
|
|
13
|
+
const v = getCustom('TRUSTIFY_DA_CONTINUE_ON_ERROR', null, opts);
|
|
14
|
+
if (v != null && String(v).trim() !== '') {
|
|
15
|
+
return String(v).toLowerCase() !== 'false';
|
|
16
|
+
}
|
|
17
|
+
return true;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* When true, `stackAnalysisBatch` returns `{ analysis, metadata }` instead of the backend response only.
|
|
21
|
+
* `opts.batchMetadata` overrides; env `TRUSTIFY_DA_BATCH_METADATA=true` enables.
|
|
22
|
+
*
|
|
23
|
+
* @param {{ batchMetadata?: boolean, TRUSTIFY_DA_BATCH_METADATA?: string, [key: string]: unknown }} [opts={}]
|
|
24
|
+
* @returns {boolean}
|
|
25
|
+
*/
|
|
26
|
+
export function resolveBatchMetadata(opts = {}) {
|
|
27
|
+
if (typeof opts.batchMetadata === 'boolean') {
|
|
28
|
+
return opts.batchMetadata;
|
|
29
|
+
}
|
|
30
|
+
const v = getCustom('TRUSTIFY_DA_BATCH_METADATA', null, opts);
|
|
31
|
+
if (v != null && String(v).trim() !== '') {
|
|
32
|
+
return String(v).toLowerCase() === 'true';
|
|
33
|
+
}
|
|
34
|
+
return false;
|
|
35
|
+
}
|
package/dist/src/cli.js
CHANGED
|
@@ -1,8 +1,10 @@
|
|
|
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
|
-
import
|
|
6
|
+
import { getProjectLicense, getLicenseDetails } from './license/index.js';
|
|
7
|
+
import client, { selectTrustifyDABackend, generateSbom } from './index.js';
|
|
6
8
|
// command for component analysis take manifest type and content
|
|
7
9
|
const component = {
|
|
8
10
|
command: 'component </path/to/manifest>',
|
|
@@ -11,10 +13,18 @@ const component = {
|
|
|
11
13
|
desc: 'manifest path for analyzing',
|
|
12
14
|
type: 'string',
|
|
13
15
|
normalize: true,
|
|
16
|
+
}).options({
|
|
17
|
+
workspaceDir: {
|
|
18
|
+
alias: 'w',
|
|
19
|
+
desc: 'Workspace root directory (for monorepos; lock file is expected here)',
|
|
20
|
+
type: 'string',
|
|
21
|
+
normalize: true,
|
|
22
|
+
}
|
|
14
23
|
}),
|
|
15
24
|
handler: async (args) => {
|
|
16
25
|
let manifestName = args['/path/to/manifest'];
|
|
17
|
-
|
|
26
|
+
const opts = args.workspaceDir ? { TRUSTIFY_DA_WORKSPACE_DIR: args.workspaceDir } : {};
|
|
27
|
+
let res = await client.componentAnalysis(manifestName, opts);
|
|
18
28
|
console.log(JSON.stringify(res, null, 2));
|
|
19
29
|
}
|
|
20
30
|
};
|
|
@@ -22,9 +32,8 @@ const validateToken = {
|
|
|
22
32
|
command: 'validate-token <token-provider> [--token-value thevalue]',
|
|
23
33
|
desc: 'Validates input token if authentic and authorized',
|
|
24
34
|
builder: yargs => yargs.positional('token-provider', {
|
|
25
|
-
desc: 'the token provider',
|
|
26
|
-
type: 'string'
|
|
27
|
-
choices: ['snyk', 'oss-index'],
|
|
35
|
+
desc: 'the token provider name',
|
|
36
|
+
type: 'string'
|
|
28
37
|
}).options({
|
|
29
38
|
tokenValue: {
|
|
30
39
|
alias: 'value',
|
|
@@ -37,7 +46,7 @@ const validateToken = {
|
|
|
37
46
|
let opts = {};
|
|
38
47
|
if (args['tokenValue'] !== undefined && args['tokenValue'].trim() !== "") {
|
|
39
48
|
let tokenValue = args['tokenValue'].trim();
|
|
40
|
-
opts[`
|
|
49
|
+
opts[`TRUSTIFY_DA_PROVIDER_${tokenProvider}_TOKEN`] = tokenValue;
|
|
41
50
|
}
|
|
42
51
|
let res = await client.validateToken(opts);
|
|
43
52
|
console.log(res);
|
|
@@ -117,15 +126,22 @@ const stack = {
|
|
|
117
126
|
desc: 'For JSON report, get only the \'summary\'',
|
|
118
127
|
type: 'boolean',
|
|
119
128
|
conflicts: 'html'
|
|
129
|
+
},
|
|
130
|
+
workspaceDir: {
|
|
131
|
+
alias: 'w',
|
|
132
|
+
desc: 'Workspace root directory (for monorepos; lock file is expected here)',
|
|
133
|
+
type: 'string',
|
|
134
|
+
normalize: true,
|
|
120
135
|
}
|
|
121
136
|
}),
|
|
122
137
|
handler: async (args) => {
|
|
123
138
|
let manifest = args['/path/to/manifest'];
|
|
124
139
|
let html = args['html'];
|
|
125
140
|
let summary = args['summary'];
|
|
141
|
+
const opts = args.workspaceDir ? { TRUSTIFY_DA_WORKSPACE_DIR: args.workspaceDir } : {};
|
|
126
142
|
let theProvidersSummary = new Map();
|
|
127
143
|
let theProvidersObject = {};
|
|
128
|
-
let res = await client.stackAnalysis(manifest, html);
|
|
144
|
+
let res = await client.stackAnalysis(manifest, html, opts);
|
|
129
145
|
if (summary) {
|
|
130
146
|
for (let provider in res.providers) {
|
|
131
147
|
if (res.providers[provider].sources !== undefined) {
|
|
@@ -143,13 +159,230 @@ const stack = {
|
|
|
143
159
|
console.log(html ? res : JSON.stringify(!html && summary ? theProvidersObject : res, null, 2));
|
|
144
160
|
}
|
|
145
161
|
};
|
|
162
|
+
// command for batch stack analysis (workspace)
|
|
163
|
+
const stackBatch = {
|
|
164
|
+
command: 'stack-batch </path/to/workspace-root> [--html|--summary] [--concurrency <n>] [--ignore <pattern>...] [--metadata] [--fail-fast]',
|
|
165
|
+
desc: 'produce stack report for all packages/crates in a workspace (Cargo or JS/TS)',
|
|
166
|
+
builder: yargs => yargs.positional('/path/to/workspace-root', {
|
|
167
|
+
desc: 'workspace root directory (containing Cargo.toml+Cargo.lock or package.json+lock file)',
|
|
168
|
+
type: 'string',
|
|
169
|
+
normalize: true,
|
|
170
|
+
}).options({
|
|
171
|
+
html: {
|
|
172
|
+
alias: 'r',
|
|
173
|
+
desc: 'Get the report as HTML instead of JSON',
|
|
174
|
+
type: 'boolean',
|
|
175
|
+
conflicts: 'summary'
|
|
176
|
+
},
|
|
177
|
+
summary: {
|
|
178
|
+
alias: 's',
|
|
179
|
+
desc: 'For JSON report, get only the \'summary\' per package',
|
|
180
|
+
type: 'boolean',
|
|
181
|
+
conflicts: 'html'
|
|
182
|
+
},
|
|
183
|
+
concurrency: {
|
|
184
|
+
alias: 'c',
|
|
185
|
+
desc: 'Max parallel SBOM generations (default: 10, env: TRUSTIFY_DA_BATCH_CONCURRENCY)',
|
|
186
|
+
type: 'number',
|
|
187
|
+
},
|
|
188
|
+
ignore: {
|
|
189
|
+
alias: 'i',
|
|
190
|
+
desc: 'Extra glob patterns excluded from workspace discovery (merged with defaults). Repeat flag per pattern. Env: TRUSTIFY_DA_WORKSPACE_DISCOVERY_IGNORE (comma-separated)',
|
|
191
|
+
type: 'string',
|
|
192
|
+
array: true,
|
|
193
|
+
},
|
|
194
|
+
metadata: {
|
|
195
|
+
alias: 'm',
|
|
196
|
+
desc: 'Return { analysis, metadata } with per-manifest errors (env: TRUSTIFY_DA_BATCH_METADATA=true)',
|
|
197
|
+
type: 'boolean',
|
|
198
|
+
default: false,
|
|
199
|
+
},
|
|
200
|
+
failFast: {
|
|
201
|
+
desc: 'Stop on first invalid package.json or SBOM error (env: TRUSTIFY_DA_CONTINUE_ON_ERROR=false)',
|
|
202
|
+
type: 'boolean',
|
|
203
|
+
default: false,
|
|
204
|
+
}
|
|
205
|
+
}),
|
|
206
|
+
handler: async (args) => {
|
|
207
|
+
const workspaceRoot = args['/path/to/workspace-root'];
|
|
208
|
+
const html = args['html'];
|
|
209
|
+
const summary = args['summary'];
|
|
210
|
+
const opts = {};
|
|
211
|
+
if (args.concurrency != null) {
|
|
212
|
+
opts.batchConcurrency = args.concurrency;
|
|
213
|
+
}
|
|
214
|
+
const extraIgnores = Array.isArray(args.ignore) ? args.ignore.filter(p => p != null && String(p).trim()) : [];
|
|
215
|
+
if (extraIgnores.length > 0) {
|
|
216
|
+
opts.workspaceDiscoveryIgnore = extraIgnores;
|
|
217
|
+
}
|
|
218
|
+
if (args.metadata) {
|
|
219
|
+
opts.batchMetadata = true;
|
|
220
|
+
}
|
|
221
|
+
if (args.failFast) {
|
|
222
|
+
opts.continueOnError = false;
|
|
223
|
+
}
|
|
224
|
+
let res = await client.stackAnalysisBatch(workspaceRoot, html, opts);
|
|
225
|
+
const batchAnalysis = res && typeof res === 'object' && res != null && 'analysis' in res ? res.analysis : res;
|
|
226
|
+
if (summary && !html && typeof batchAnalysis === 'object') {
|
|
227
|
+
const summaries = {};
|
|
228
|
+
for (const [purl, report] of Object.entries(batchAnalysis)) {
|
|
229
|
+
if (report?.providers) {
|
|
230
|
+
for (const provider of Object.keys(report.providers)) {
|
|
231
|
+
const sources = report.providers[provider]?.sources;
|
|
232
|
+
if (sources) {
|
|
233
|
+
for (const [source, data] of Object.entries(sources)) {
|
|
234
|
+
if (data?.summary) {
|
|
235
|
+
if (!summaries[purl]) {
|
|
236
|
+
summaries[purl] = {};
|
|
237
|
+
}
|
|
238
|
+
if (!summaries[purl][provider]) {
|
|
239
|
+
summaries[purl][provider] = {};
|
|
240
|
+
}
|
|
241
|
+
summaries[purl][provider][source] = data.summary;
|
|
242
|
+
}
|
|
243
|
+
}
|
|
244
|
+
}
|
|
245
|
+
}
|
|
246
|
+
}
|
|
247
|
+
}
|
|
248
|
+
if (res && typeof res === 'object' && res != null && 'metadata' in res) {
|
|
249
|
+
res = { analysis: summaries, metadata: res.metadata };
|
|
250
|
+
}
|
|
251
|
+
else {
|
|
252
|
+
res = summaries;
|
|
253
|
+
}
|
|
254
|
+
}
|
|
255
|
+
if (html) {
|
|
256
|
+
const htmlContent = res && typeof res === 'object' && 'analysis' in res ? res.analysis : res;
|
|
257
|
+
console.log(htmlContent);
|
|
258
|
+
}
|
|
259
|
+
else {
|
|
260
|
+
console.log(JSON.stringify(res, null, 2));
|
|
261
|
+
}
|
|
262
|
+
}
|
|
263
|
+
};
|
|
264
|
+
// command for license checking
|
|
265
|
+
const license = {
|
|
266
|
+
command: 'license </path/to/manifest>',
|
|
267
|
+
desc: 'Display project license information from manifest and LICENSE file in JSON format',
|
|
268
|
+
builder: yargs => yargs.positional('/path/to/manifest', {
|
|
269
|
+
desc: 'manifest path for license analysis',
|
|
270
|
+
type: 'string',
|
|
271
|
+
normalize: true,
|
|
272
|
+
}),
|
|
273
|
+
handler: async (args) => {
|
|
274
|
+
let manifestPath = args['/path/to/manifest'];
|
|
275
|
+
const opts = {}; // CLI options can be extended in the future
|
|
276
|
+
try {
|
|
277
|
+
selectTrustifyDABackend(opts);
|
|
278
|
+
}
|
|
279
|
+
catch (err) {
|
|
280
|
+
console.error(JSON.stringify({ error: err.message }, null, 2));
|
|
281
|
+
process.exit(1);
|
|
282
|
+
}
|
|
283
|
+
let localResult;
|
|
284
|
+
try {
|
|
285
|
+
localResult = getProjectLicense(manifestPath);
|
|
286
|
+
}
|
|
287
|
+
catch (err) {
|
|
288
|
+
console.error(JSON.stringify({ error: `Failed to read manifest: ${err.message}` }, null, 2));
|
|
289
|
+
process.exit(1);
|
|
290
|
+
}
|
|
291
|
+
const errors = [];
|
|
292
|
+
// Build LicenseInfo objects
|
|
293
|
+
const buildLicenseInfo = async (spdxId) => {
|
|
294
|
+
if (!spdxId) {
|
|
295
|
+
return null;
|
|
296
|
+
}
|
|
297
|
+
const licenseInfo = { spdxId };
|
|
298
|
+
try {
|
|
299
|
+
const details = await getLicenseDetails(spdxId, opts);
|
|
300
|
+
if (details) {
|
|
301
|
+
// Check if backend recognized the license as valid
|
|
302
|
+
if (details.category === 'UNKNOWN') {
|
|
303
|
+
errors.push(`"${spdxId}" is not a valid SPDX license identifier. Please use a valid SPDX expression (e.g., "Apache-2.0", "MIT"). See https://spdx.org/licenses/`);
|
|
304
|
+
}
|
|
305
|
+
else {
|
|
306
|
+
Object.assign(licenseInfo, details);
|
|
307
|
+
}
|
|
308
|
+
}
|
|
309
|
+
else {
|
|
310
|
+
errors.push(`No license details found for ${spdxId}`);
|
|
311
|
+
}
|
|
312
|
+
}
|
|
313
|
+
catch (err) {
|
|
314
|
+
errors.push(`Failed to fetch details for ${spdxId}: ${err.message}`);
|
|
315
|
+
}
|
|
316
|
+
return licenseInfo;
|
|
317
|
+
};
|
|
318
|
+
const output = {
|
|
319
|
+
manifestLicense: await buildLicenseInfo(localResult.fromManifest),
|
|
320
|
+
fileLicense: await buildLicenseInfo(localResult.fromFile),
|
|
321
|
+
mismatch: localResult.mismatch
|
|
322
|
+
};
|
|
323
|
+
if (errors.length > 0) {
|
|
324
|
+
output.errors = errors;
|
|
325
|
+
}
|
|
326
|
+
console.log(JSON.stringify(output, null, 2));
|
|
327
|
+
}
|
|
328
|
+
};
|
|
329
|
+
const sbom = {
|
|
330
|
+
command: 'sbom </path/to/manifest> [--output]',
|
|
331
|
+
desc: 'generate a CycloneDX SBOM from a manifest file',
|
|
332
|
+
builder: yargs => yargs.positional('/path/to/manifest', {
|
|
333
|
+
desc: 'manifest path for SBOM generation',
|
|
334
|
+
type: 'string',
|
|
335
|
+
normalize: true,
|
|
336
|
+
}).options({
|
|
337
|
+
output: {
|
|
338
|
+
alias: 'o',
|
|
339
|
+
desc: 'Write SBOM JSON to a file instead of stdout',
|
|
340
|
+
type: 'string',
|
|
341
|
+
normalize: true,
|
|
342
|
+
},
|
|
343
|
+
workspaceDir: {
|
|
344
|
+
alias: 'w',
|
|
345
|
+
desc: 'Workspace root directory (for monorepos; lock file is expected here)',
|
|
346
|
+
type: 'string',
|
|
347
|
+
normalize: true,
|
|
348
|
+
}
|
|
349
|
+
}),
|
|
350
|
+
handler: async (args) => {
|
|
351
|
+
let manifest = args['/path/to/manifest'];
|
|
352
|
+
const opts = args.workspaceDir ? { TRUSTIFY_DA_WORKSPACE_DIR: args.workspaceDir } : {};
|
|
353
|
+
let result;
|
|
354
|
+
try {
|
|
355
|
+
result = await generateSbom(manifest, opts);
|
|
356
|
+
}
|
|
357
|
+
catch (err) {
|
|
358
|
+
console.error(JSON.stringify({ error: `Failed to generate SBOM: ${err.message}` }, null, 2));
|
|
359
|
+
process.exit(1);
|
|
360
|
+
}
|
|
361
|
+
const json = JSON.stringify(result, null, 2);
|
|
362
|
+
if (args.output) {
|
|
363
|
+
try {
|
|
364
|
+
fs.writeFileSync(args.output, json);
|
|
365
|
+
}
|
|
366
|
+
catch (err) {
|
|
367
|
+
console.error(JSON.stringify({ error: `Failed to write output file: ${err.message}` }, null, 2));
|
|
368
|
+
process.exit(1);
|
|
369
|
+
}
|
|
370
|
+
}
|
|
371
|
+
else {
|
|
372
|
+
console.log(json);
|
|
373
|
+
}
|
|
374
|
+
}
|
|
375
|
+
};
|
|
146
376
|
// parse and invoke the command
|
|
147
377
|
yargs(hideBin(process.argv))
|
|
148
|
-
.usage(`Usage: ${process.argv[0].includes("node") ? path.parse(process.argv[1]).base : path.parse(process.argv[0]).base} {component|stack|image|validate-token}`)
|
|
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}`)
|
|
149
379
|
.command(stack)
|
|
380
|
+
.command(stackBatch)
|
|
150
381
|
.command(component)
|
|
151
382
|
.command(image)
|
|
152
383
|
.command(validateToken)
|
|
384
|
+
.command(license)
|
|
385
|
+
.command(sbom)
|
|
153
386
|
.scriptName('')
|
|
154
387
|
.version(false)
|
|
155
388
|
.demandCommand(1)
|
|
@@ -6,9 +6,10 @@ export default class CycloneDxSbom {
|
|
|
6
6
|
sourceManifestForAuditTrail: any;
|
|
7
7
|
/**
|
|
8
8
|
* @param {PackageURL} root - add main/root component for sbom
|
|
9
|
+
* @param {string|Array} [licenses] - optional license(s) for the root component
|
|
9
10
|
* @return {CycloneDxSbom} the CycloneDxSbom Sbom Object
|
|
10
11
|
*/
|
|
11
|
-
addRoot(root: PackageURL): CycloneDxSbom;
|
|
12
|
+
addRoot(root: PackageURL, licenses?: string | any[]): CycloneDxSbom;
|
|
12
13
|
/**
|
|
13
14
|
* @return {{{"bom-ref": string, name, purl: string, type, version}}} root component of sbom.
|
|
14
15
|
*/
|
|
@@ -48,6 +49,7 @@ export default class CycloneDxSbom {
|
|
|
48
49
|
type: any;
|
|
49
50
|
version: any;
|
|
50
51
|
scope: any;
|
|
52
|
+
licenses?: any;
|
|
51
53
|
};
|
|
52
54
|
/**
|
|
53
55
|
* This method gets an array of dependencies to be ignored, and remove all of them from CycloneDx Sbom
|
|
@@ -68,6 +70,13 @@ export default class CycloneDxSbom {
|
|
|
68
70
|
* @return {boolean}
|
|
69
71
|
*/
|
|
70
72
|
checkIfPackageInsideDependsOnList(component: any, name: string): boolean;
|
|
73
|
+
/**
|
|
74
|
+
* Checks if any entry in the dependsOn list of sourceRef starts with the given purl prefix.
|
|
75
|
+
* @param {PackageURL} sourceRef - The source component
|
|
76
|
+
* @param {string} purlPrefix - The purl prefix to match (e.g. "pkg:npm/minimist@")
|
|
77
|
+
* @return {boolean}
|
|
78
|
+
*/
|
|
79
|
+
checkDependsOnByPurlPrefix(sourceRef: PackageURL, purlPrefix: string): boolean;
|
|
71
80
|
/** Removes the root component from the sbom
|
|
72
81
|
*/
|
|
73
82
|
removeRootComponent(): void;
|
|
@@ -5,10 +5,11 @@ import { PackageURL } from "packageurl-js";
|
|
|
5
5
|
* @param component {PackageURL}
|
|
6
6
|
* @param type type of package - application or library
|
|
7
7
|
* @param scope scope of the component - runtime or compile
|
|
8
|
-
* @
|
|
8
|
+
* @param licenses optional license string or array of licenses for the component
|
|
9
|
+
* @return {{"bom-ref": string, name, purl: string, type, version, scope, licenses?}}
|
|
9
10
|
* @private
|
|
10
11
|
*/
|
|
11
|
-
function getComponent(component, type, scope) {
|
|
12
|
+
function getComponent(component, type, scope, licenses) {
|
|
12
13
|
let componentObject;
|
|
13
14
|
if (component instanceof PackageURL) {
|
|
14
15
|
if (component.namespace) {
|
|
@@ -36,6 +37,16 @@ function getComponent(component, type, scope) {
|
|
|
36
37
|
else {
|
|
37
38
|
componentObject = component;
|
|
38
39
|
}
|
|
40
|
+
// Add licenses if provided (CycloneDX format). Callers must provide valid SPDX identifiers.
|
|
41
|
+
if (licenses) {
|
|
42
|
+
const licenseArray = Array.isArray(licenses) ? licenses : [licenses];
|
|
43
|
+
componentObject.licenses = licenseArray.map(lic => {
|
|
44
|
+
if (typeof lic === 'string') {
|
|
45
|
+
return { license: { id: lic } };
|
|
46
|
+
}
|
|
47
|
+
return lic;
|
|
48
|
+
});
|
|
49
|
+
}
|
|
39
50
|
return componentObject;
|
|
40
51
|
}
|
|
41
52
|
function createDependency(dependency) {
|
|
@@ -56,11 +67,12 @@ export default class CycloneDxSbom {
|
|
|
56
67
|
}
|
|
57
68
|
/**
|
|
58
69
|
* @param {PackageURL} root - add main/root component for sbom
|
|
70
|
+
* @param {string|Array} [licenses] - optional license(s) for the root component
|
|
59
71
|
* @return {CycloneDxSbom} the CycloneDxSbom Sbom Object
|
|
60
72
|
*/
|
|
61
|
-
addRoot(root) {
|
|
73
|
+
addRoot(root, licenses) {
|
|
62
74
|
this.rootComponent =
|
|
63
|
-
getComponent(root, "application");
|
|
75
|
+
getComponent(root, "application", undefined, licenses);
|
|
64
76
|
this.components.push(this.rootComponent);
|
|
65
77
|
return this;
|
|
66
78
|
}
|
|
@@ -108,6 +120,7 @@ export default class CycloneDxSbom {
|
|
|
108
120
|
getAsJsonString(opts) {
|
|
109
121
|
let manifestType = opts["manifest-type"];
|
|
110
122
|
this.setSourceManifest(opts["source-manifest"]);
|
|
123
|
+
const rootPurl = this.rootComponent?.purl;
|
|
111
124
|
this.sbomObject = {
|
|
112
125
|
"bomFormat": "CycloneDX",
|
|
113
126
|
"specVersion": "1.4",
|
|
@@ -117,7 +130,7 @@ export default class CycloneDxSbom {
|
|
|
117
130
|
"component": this.rootComponent,
|
|
118
131
|
"properties": new Array()
|
|
119
132
|
},
|
|
120
|
-
"components": this.components,
|
|
133
|
+
"components": this.components.filter(c => c.purl !== rootPurl),
|
|
121
134
|
"dependencies": this.dependencies
|
|
122
135
|
};
|
|
123
136
|
if (this.rootComponent === undefined) {
|
|
@@ -229,6 +242,20 @@ export default class CycloneDxSbom {
|
|
|
229
242
|
return false;
|
|
230
243
|
}
|
|
231
244
|
}
|
|
245
|
+
/**
|
|
246
|
+
* Checks if any entry in the dependsOn list of sourceRef starts with the given purl prefix.
|
|
247
|
+
* @param {PackageURL} sourceRef - The source component
|
|
248
|
+
* @param {string} purlPrefix - The purl prefix to match (e.g. "pkg:npm/minimist@")
|
|
249
|
+
* @return {boolean}
|
|
250
|
+
*/
|
|
251
|
+
checkDependsOnByPurlPrefix(sourceRef, purlPrefix) {
|
|
252
|
+
const sourcePurl = sourceRef.toString();
|
|
253
|
+
const depIndex = this.getDependencyIndex(sourcePurl);
|
|
254
|
+
if (depIndex < 0) {
|
|
255
|
+
return false;
|
|
256
|
+
}
|
|
257
|
+
return this.dependencies[depIndex].dependsOn.some(dep => dep.startsWith(purlPrefix));
|
|
258
|
+
}
|
|
232
259
|
/** Removes the root component from the sbom
|
|
233
260
|
*/
|
|
234
261
|
removeRootComponent() {
|
package/dist/src/index.d.ts
CHANGED
|
@@ -13,16 +13,28 @@ 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";
|
|
18
27
|
declare namespace _default {
|
|
19
28
|
export { componentAnalysis };
|
|
20
29
|
export { stackAnalysis };
|
|
30
|
+
export { stackAnalysisBatch };
|
|
21
31
|
export { imageAnalysis };
|
|
22
32
|
export { validateToken };
|
|
33
|
+
export { generateSbom };
|
|
23
34
|
}
|
|
24
35
|
export default _default;
|
|
25
36
|
export type Options = {
|
|
37
|
+
TRUSTIFY_DA_CARGO_PATH?: string | undefined;
|
|
26
38
|
TRUSTIFY_DA_DOCKER_PATH?: string | undefined;
|
|
27
39
|
TRUSTIFY_DA_GO_MVS_LOGIC_ENABLED?: string | undefined;
|
|
28
40
|
TRUSTIFY_DA_GO_PATH?: string | undefined;
|
|
@@ -47,11 +59,45 @@ export type Options = {
|
|
|
47
59
|
TRUSTIFY_DA_SYFT_CONFIG_PATH?: string | undefined;
|
|
48
60
|
TRUSTIFY_DA_SYFT_PATH?: string | undefined;
|
|
49
61
|
TRUSTIFY_DA_YARN_PATH?: string | undefined;
|
|
62
|
+
TRUSTIFY_DA_WORKSPACE_DIR?: string | undefined;
|
|
63
|
+
TRUSTIFY_DA_LICENSE_CHECK?: string | undefined;
|
|
50
64
|
MATCH_MANIFEST_VERSIONS?: string | undefined;
|
|
51
65
|
TRUSTIFY_DA_SOURCE?: string | undefined;
|
|
52
66
|
TRUSTIFY_DA_TOKEN?: string | undefined;
|
|
53
67
|
TRUSTIFY_DA_TELEMETRY_ID?: string | undefined;
|
|
54
|
-
|
|
68
|
+
TRUSTIFY_DA_WORKSPACE_DIR?: string | undefined;
|
|
69
|
+
batchConcurrency?: number | undefined;
|
|
70
|
+
TRUSTIFY_DA_BATCH_CONCURRENCY?: string | undefined;
|
|
71
|
+
workspaceDiscoveryIgnore?: string[] | undefined;
|
|
72
|
+
TRUSTIFY_DA_WORKSPACE_DISCOVERY_IGNORE?: string | undefined;
|
|
73
|
+
continueOnError?: boolean | undefined;
|
|
74
|
+
TRUSTIFY_DA_CONTINUE_ON_ERROR?: string | undefined;
|
|
75
|
+
batchMetadata?: boolean | undefined;
|
|
76
|
+
TRUSTIFY_DA_BATCH_METADATA?: string | undefined;
|
|
77
|
+
TRUSTIFY_DA_UV_PATH?: string | undefined;
|
|
78
|
+
TRUSTIFY_DA_POETRY_PATH?: string | undefined;
|
|
79
|
+
[key: string]: string | number | boolean | string[] | undefined;
|
|
80
|
+
};
|
|
81
|
+
export type BatchAnalysisMetadata = {
|
|
82
|
+
workspaceRoot: string;
|
|
83
|
+
ecosystem: "javascript" | "cargo" | "unknown";
|
|
84
|
+
total: number;
|
|
85
|
+
successful: number;
|
|
86
|
+
failed: number;
|
|
87
|
+
errors: Array<{
|
|
88
|
+
manifestPath: string;
|
|
89
|
+
phase: "validation" | "sbom";
|
|
90
|
+
reason: string;
|
|
91
|
+
}>;
|
|
92
|
+
};
|
|
93
|
+
export type SbomResult = {
|
|
94
|
+
ok: true;
|
|
95
|
+
purl: string;
|
|
96
|
+
sbom: object;
|
|
97
|
+
} | {
|
|
98
|
+
ok: false;
|
|
99
|
+
manifestPath: string;
|
|
100
|
+
reason: string;
|
|
55
101
|
};
|
|
56
102
|
/**
|
|
57
103
|
* Get component analysis report for a manifest content.
|
|
@@ -90,6 +136,26 @@ declare function stackAnalysis(manifest: string, html: false, opts?: Options | u
|
|
|
90
136
|
* or backend request failed
|
|
91
137
|
*/
|
|
92
138
|
declare function stackAnalysis(manifest: string, html?: boolean | undefined, opts?: Options | undefined): Promise<string | import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport>;
|
|
139
|
+
/**
|
|
140
|
+
* Get stack analysis for all workspace packages/crates (batch).
|
|
141
|
+
* Detects ecosystem from workspace root: Cargo (Cargo.toml + Cargo.lock) or JS/TS (package.json + lock file).
|
|
142
|
+
* SBOMs are generated in parallel (see `batchConcurrency`) unless `continueOnError: false` (fail-fast sequential).
|
|
143
|
+
* With `opts.batchMetadata` / `TRUSTIFY_DA_BATCH_METADATA`, returns `{ analysis, metadata }` including validation and SBOM errors.
|
|
144
|
+
*
|
|
145
|
+
* @param {string} workspaceRoot - Path to workspace root (containing lock file and workspace config)
|
|
146
|
+
* @param {boolean} [html=false] - true returns HTML, false returns JSON report
|
|
147
|
+
* @param {Options} [opts={}] - `batchConcurrency`, discovery ignores, `continueOnError` (default true), `batchMetadata` (default false)
|
|
148
|
+
* @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 }>}
|
|
149
|
+
* @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.
|
|
150
|
+
*/
|
|
151
|
+
declare function stackAnalysisBatch(workspaceRoot: string, html?: boolean, opts?: Options): Promise<string | {
|
|
152
|
+
[x: string]: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport;
|
|
153
|
+
} | {
|
|
154
|
+
analysis: string | {
|
|
155
|
+
[x: string]: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport;
|
|
156
|
+
};
|
|
157
|
+
metadata: BatchAnalysisMetadata;
|
|
158
|
+
}>;
|
|
93
159
|
/**
|
|
94
160
|
* @overload
|
|
95
161
|
* @param {Array<string>} imageRefs
|
|
@@ -130,3 +196,12 @@ declare function imageAnalysis(imageRefs: Array<string>, html?: boolean | undefi
|
|
|
130
196
|
* @throws {Error} if the backend request failed.
|
|
131
197
|
*/
|
|
132
198
|
declare function validateToken(opts?: Options): Promise<object>;
|
|
199
|
+
import { discoverWorkspacePackages } from './workspace.js';
|
|
200
|
+
import { discoverWorkspaceCrates } from './workspace.js';
|
|
201
|
+
import { validatePackageJson } from './workspace.js';
|
|
202
|
+
import { resolveWorkspaceDiscoveryIgnore } from './workspace.js';
|
|
203
|
+
import { filterManifestPathsByDiscoveryIgnore } from './workspace.js';
|
|
204
|
+
import { resolveContinueOnError } from './batch_opts.js';
|
|
205
|
+
import { resolveBatchMetadata } from './batch_opts.js';
|
|
206
|
+
export { discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata };
|
|
207
|
+
export { getProjectLicense, findLicenseFilePath, identifyLicense, getLicenseDetails, licensesFromReport, normalizeLicensesResponse, runLicenseCheck, getCompatibility } from "./license/index.js";
|