@trustify-da/trustify-da-javascript-client 0.3.0-ea.ce73b2f → 0.3.0-ea.d2fee6b
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 +23 -10
- package/dist/src/analysis.d.ts +21 -5
- package/dist/src/analysis.js +74 -80
- 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 +17 -3
- package/dist/src/cyclone_dx_sbom.js +48 -8
- package/dist/src/index.d.ts +196 -11
- package/dist/src/index.js +345 -7
- 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/images.d.ts +4 -5
- package/dist/src/oci_image/utils.d.ts +4 -4
- package/dist/src/oci_image/utils.js +11 -2
- package/dist/src/provider.d.ts +17 -5
- package/dist/src/provider.js +29 -5
- package/dist/src/providers/base_java.d.ts +3 -14
- package/dist/src/providers/base_java.js +2 -38
- 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 +153 -0
- package/dist/src/providers/base_pyproject.js +315 -0
- package/dist/src/providers/golang_gomodules.d.ts +29 -13
- package/dist/src/providers/golang_gomodules.js +161 -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 +28 -3
- package/dist/src/providers/java_gradle.js +126 -2
- 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 +20 -5
- package/dist/src/providers/java_maven.js +126 -6
- package/dist/src/providers/javascript_npm.d.ts +1 -0
- package/dist/src/providers/javascript_npm.js +21 -0
- package/dist/src/providers/javascript_pnpm.d.ts +1 -1
- package/dist/src/providers/javascript_pnpm.js +8 -4
- 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/processors/yarn_berry_processor.js +88 -5
- package/dist/src/providers/python_controller.d.ts +10 -3
- package/dist/src/providers/python_controller.js +61 -59
- package/dist/src/providers/python_pip.d.ts +15 -4
- package/dist/src/providers/python_pip.js +51 -58
- 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 +75 -0
- package/dist/src/providers/python_poetry.js +238 -0
- package/dist/src/providers/python_uv.d.ts +42 -0
- package/dist/src/providers/python_uv.js +160 -0
- package/dist/src/providers/requirements_parser.d.ts +6 -0
- package/dist/src/providers/requirements_parser.js +24 -0
- 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 +17 -2
- package/dist/src/sbom.js +16 -4
- package/dist/src/tools.d.ts +48 -6
- package/dist/src/tools.js +114 -1
- package/dist/src/workspace.d.ts +61 -0
- package/dist/src/workspace.js +256 -0
- package/package.json +24 -11
package/dist/src/index.js
CHANGED
|
@@ -1,16 +1,25 @@
|
|
|
1
1
|
import path from "node:path";
|
|
2
2
|
import { EOL } from "os";
|
|
3
|
+
import pLimit from 'p-limit';
|
|
3
4
|
import { availableProviders, match } from './provider.js';
|
|
4
5
|
import analysis from './analysis.js';
|
|
5
6
|
import fs from 'node:fs';
|
|
6
7
|
import { getCustom } from "./tools.js";
|
|
8
|
+
import { resolveBatchMetadata, resolveContinueOnError } from './batch_opts.js';
|
|
9
|
+
import { discoverMavenModules } from './providers/java_maven.js';
|
|
10
|
+
import { discoverGradleSubprojects } from './providers/java_gradle.js';
|
|
11
|
+
import { discoverGoWorkspaceModules } from './providers/golang_gomodules.js';
|
|
12
|
+
import { discoverWorkspaceCrates, discoverWorkspacePackages, filterManifestPathsByDiscoveryIgnore, resolveWorkspaceDiscoveryIgnore, validatePackageJson, } from './workspace.js';
|
|
7
13
|
import.meta.dirname;
|
|
8
14
|
import * as url from 'url';
|
|
9
15
|
export { parseImageRef } from "./oci_image/utils.js";
|
|
10
16
|
export { ImageRef } from "./oci_image/images.js";
|
|
11
|
-
export
|
|
17
|
+
export { getProjectLicense, findLicenseFilePath, identifyLicense, getLicenseDetails, licensesFromReport, normalizeLicensesResponse, runLicenseCheck, getCompatibility } from "./license/index.js";
|
|
18
|
+
export default { componentAnalysis, stackAnalysis, stackAnalysisBatch, imageAnalysis, validateToken, generateSbom };
|
|
19
|
+
export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceModules, discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata, };
|
|
12
20
|
/**
|
|
13
21
|
* @typedef {{
|
|
22
|
+
* TRUSTIFY_DA_CARGO_PATH?: string | undefined,
|
|
14
23
|
* TRUSTIFY_DA_DOCKER_PATH?: string | undefined,
|
|
15
24
|
* TRUSTIFY_DA_GO_MVS_LOGIC_ENABLED?: string | undefined,
|
|
16
25
|
* TRUSTIFY_DA_GO_PATH?: string | undefined,
|
|
@@ -35,13 +44,36 @@ export default { componentAnalysis, stackAnalysis, imageAnalysis, validateToken
|
|
|
35
44
|
* TRUSTIFY_DA_SYFT_CONFIG_PATH?: string | undefined,
|
|
36
45
|
* TRUSTIFY_DA_SYFT_PATH?: string | undefined,
|
|
37
46
|
* TRUSTIFY_DA_YARN_PATH?: string | undefined,
|
|
47
|
+
* TRUSTIFY_DA_WORKSPACE_DIR?: string | undefined,
|
|
48
|
+
* TRUSTIFY_DA_LICENSE_CHECK?: string | undefined,
|
|
38
49
|
* MATCH_MANIFEST_VERSIONS?: string | undefined,
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
50
|
+
* TRUSTIFY_DA_SOURCE?: string | undefined,
|
|
51
|
+
* TRUSTIFY_DA_TOKEN?: string | undefined,
|
|
52
|
+
* TRUSTIFY_DA_TELEMETRY_ID?: string | undefined,
|
|
53
|
+
* TRUSTIFY_DA_WORKSPACE_DIR?: string | undefined,
|
|
54
|
+
* batchConcurrency?: number | undefined,
|
|
55
|
+
* TRUSTIFY_DA_BATCH_CONCURRENCY?: string | undefined,
|
|
56
|
+
* workspaceDiscoveryIgnore?: string[] | undefined,
|
|
57
|
+
* TRUSTIFY_DA_WORKSPACE_DISCOVERY_IGNORE?: string | undefined,
|
|
58
|
+
* continueOnError?: boolean | undefined,
|
|
59
|
+
* TRUSTIFY_DA_CONTINUE_ON_ERROR?: string | undefined,
|
|
60
|
+
* batchMetadata?: boolean | undefined,
|
|
61
|
+
* TRUSTIFY_DA_BATCH_METADATA?: string | undefined,
|
|
62
|
+
* TRUSTIFY_DA_UV_PATH?: string | undefined,
|
|
63
|
+
* TRUSTIFY_DA_POETRY_PATH?: string | undefined,
|
|
64
|
+
* [key: string]: string | number | boolean | string[] | undefined,
|
|
43
65
|
* }} Options
|
|
44
66
|
*/
|
|
67
|
+
/**
|
|
68
|
+
* @typedef {{
|
|
69
|
+
* workspaceRoot: string,
|
|
70
|
+
* ecosystem: 'javascript' | 'cargo' | 'unknown',
|
|
71
|
+
* total: number,
|
|
72
|
+
* successful: number,
|
|
73
|
+
* failed: number,
|
|
74
|
+
* errors: Array<{ manifestPath: string, phase: 'validation' | 'sbom', reason: string }>
|
|
75
|
+
* }} BatchAnalysisMetadata
|
|
76
|
+
*/
|
|
45
77
|
/**
|
|
46
78
|
* Logs messages to the console if the TRUSTIFY_DA_DEBUG environment variable is set to "true".
|
|
47
79
|
* @param {string} alongsideText - The text to prepend to the log message.
|
|
@@ -127,7 +159,7 @@ export function selectTrustifyDABackend(opts = {}) {
|
|
|
127
159
|
async function stackAnalysis(manifest, html = false, opts = {}) {
|
|
128
160
|
const theUrl = selectTrustifyDABackend(opts);
|
|
129
161
|
fs.accessSync(manifest, fs.constants.R_OK); // throws error if file unreadable
|
|
130
|
-
let provider = match(manifest, availableProviders); // throws error if no matching provider
|
|
162
|
+
let provider = match(manifest, availableProviders, opts); // throws error if no matching provider
|
|
131
163
|
return await analysis.requestStack(provider, manifest, theUrl, html, opts); // throws error request sending failed
|
|
132
164
|
}
|
|
133
165
|
/**
|
|
@@ -141,7 +173,7 @@ async function componentAnalysis(manifest, opts = {}) {
|
|
|
141
173
|
const theUrl = selectTrustifyDABackend(opts);
|
|
142
174
|
fs.accessSync(manifest, fs.constants.R_OK);
|
|
143
175
|
opts["manifest-type"] = path.basename(manifest);
|
|
144
|
-
let provider = match(manifest, availableProviders); // throws error if no matching provider
|
|
176
|
+
let provider = match(manifest, availableProviders, opts); // throws error if no matching provider
|
|
145
177
|
return await analysis.requestComponent(provider, manifest, theUrl, opts); // throws error request sending failed
|
|
146
178
|
}
|
|
147
179
|
/**
|
|
@@ -174,6 +206,312 @@ async function imageAnalysis(imageRefs, html = false, opts = {}) {
|
|
|
174
206
|
const theUrl = selectTrustifyDABackend(opts);
|
|
175
207
|
return await analysis.requestImages(imageRefs, theUrl, html, opts);
|
|
176
208
|
}
|
|
209
|
+
/**
|
|
210
|
+
* Max concurrent SBOM generations for batch workspace analysis. Env/opts override default 10.
|
|
211
|
+
* @param {Options} opts
|
|
212
|
+
* @returns {number}
|
|
213
|
+
* @private
|
|
214
|
+
*/
|
|
215
|
+
function resolveBatchConcurrency(opts) {
|
|
216
|
+
const fromEnv = getCustom('TRUSTIFY_DA_BATCH_CONCURRENCY', null, opts);
|
|
217
|
+
const raw = opts.batchConcurrency ?? fromEnv ?? '10';
|
|
218
|
+
const n = typeof raw === 'number' ? raw : parseInt(String(raw), 10);
|
|
219
|
+
if (!Number.isFinite(n) || n < 1) {
|
|
220
|
+
return 10;
|
|
221
|
+
}
|
|
222
|
+
return Math.min(256, n);
|
|
223
|
+
}
|
|
224
|
+
/**
|
|
225
|
+
* @param {string} root
|
|
226
|
+
* @param {'javascript' | 'cargo' | 'unknown'} ecosystem
|
|
227
|
+
* @param {number} totalSbomAttempts
|
|
228
|
+
* @param {number} successfulSbomCount
|
|
229
|
+
* @param {Array<{ manifestPath: string, phase: 'validation' | 'sbom', reason: string }>} errors
|
|
230
|
+
* @returns {BatchAnalysisMetadata}
|
|
231
|
+
* @private
|
|
232
|
+
*/
|
|
233
|
+
function buildBatchAnalysisMetadata(root, ecosystem, totalSbomAttempts, successfulSbomCount, errors) {
|
|
234
|
+
return {
|
|
235
|
+
workspaceRoot: root,
|
|
236
|
+
ecosystem,
|
|
237
|
+
total: totalSbomAttempts,
|
|
238
|
+
successful: successfulSbomCount,
|
|
239
|
+
failed: errors.length,
|
|
240
|
+
errors: [...errors],
|
|
241
|
+
};
|
|
242
|
+
}
|
|
243
|
+
/**
|
|
244
|
+
* Generate a CycloneDX SBOM from a manifest file. No backend HTTP request is made.
|
|
245
|
+
*
|
|
246
|
+
* @param {string} manifestPath - path to the manifest file (e.g. pom.xml, package.json)
|
|
247
|
+
* @param {Options} [opts={}] - optional options (e.g. workspace dir, tool paths)
|
|
248
|
+
* @returns {Promise<object>} parsed CycloneDX SBOM JSON object
|
|
249
|
+
* @throws {Error} if the manifest is unsupported or SBOM generation fails
|
|
250
|
+
*/
|
|
251
|
+
export async function generateSbom(manifestPath, opts = {}) {
|
|
252
|
+
fs.accessSync(manifestPath, fs.constants.R_OK);
|
|
253
|
+
const result = await generateOneSbom(manifestPath, opts);
|
|
254
|
+
if (!result.ok) {
|
|
255
|
+
throw new Error(`Failed to generate SBOM for ${result.manifestPath}: ${result.reason}`);
|
|
256
|
+
}
|
|
257
|
+
return result.sbom;
|
|
258
|
+
}
|
|
259
|
+
/**
|
|
260
|
+
* @typedef {{ ok: true, purl: string, sbom: object } | { ok: false, manifestPath: string, reason: string }} SbomResult
|
|
261
|
+
*/
|
|
262
|
+
/**
|
|
263
|
+
* Generate an SBOM for a single manifest, returning a normalized result.
|
|
264
|
+
*
|
|
265
|
+
* @param {string} manifestPath
|
|
266
|
+
* @param {Options} workspaceOpts - opts with `TRUSTIFY_DA_WORKSPACE_DIR` set
|
|
267
|
+
* @returns {Promise<SbomResult>}
|
|
268
|
+
* @private
|
|
269
|
+
*/
|
|
270
|
+
async function generateOneSbom(manifestPath, workspaceOpts) {
|
|
271
|
+
const provider = match(manifestPath, availableProviders, workspaceOpts);
|
|
272
|
+
const provided = await provider.provideStack(manifestPath, workspaceOpts);
|
|
273
|
+
const sbom = JSON.parse(provided.content);
|
|
274
|
+
const purl = sbom?.metadata?.component?.purl || sbom?.metadata?.component?.['bom-ref'];
|
|
275
|
+
if (!purl) {
|
|
276
|
+
return { ok: false, manifestPath, reason: 'missing purl in SBOM' };
|
|
277
|
+
}
|
|
278
|
+
return { ok: true, purl, sbom };
|
|
279
|
+
}
|
|
280
|
+
/**
|
|
281
|
+
* Detect the workspace ecosystem and discover manifest paths.
|
|
282
|
+
*
|
|
283
|
+
* @param {string} root - Resolved workspace root
|
|
284
|
+
* @param {Options} opts
|
|
285
|
+
* @returns {Promise<{ ecosystem: 'javascript' | 'cargo' | 'maven' | 'gradle' | 'gomodules' | 'unknown', manifestPaths: string[] }>}
|
|
286
|
+
* @private
|
|
287
|
+
*/
|
|
288
|
+
async function detectWorkspaceManifests(root, opts) {
|
|
289
|
+
const cargoToml = path.join(root, 'Cargo.toml');
|
|
290
|
+
const cargoLock = path.join(root, 'Cargo.lock');
|
|
291
|
+
const packageJson = path.join(root, 'package.json');
|
|
292
|
+
const pomXml = path.join(root, 'pom.xml');
|
|
293
|
+
if (fs.existsSync(cargoToml) && fs.existsSync(cargoLock)) {
|
|
294
|
+
return { ecosystem: 'cargo', manifestPaths: await discoverWorkspaceCrates(root, opts) };
|
|
295
|
+
}
|
|
296
|
+
if (fs.existsSync(pomXml)) {
|
|
297
|
+
const manifestPaths = await discoverMavenModules(root, opts);
|
|
298
|
+
if (manifestPaths.length > 0) {
|
|
299
|
+
return { ecosystem: 'maven', manifestPaths };
|
|
300
|
+
}
|
|
301
|
+
}
|
|
302
|
+
const hasGradleSettings = fs.existsSync(path.join(root, 'settings.gradle'))
|
|
303
|
+
|| fs.existsSync(path.join(root, 'settings.gradle.kts'));
|
|
304
|
+
if (hasGradleSettings) {
|
|
305
|
+
const manifestPaths = await discoverGradleSubprojects(root, opts);
|
|
306
|
+
if (manifestPaths.length > 0) {
|
|
307
|
+
return { ecosystem: 'gradle', manifestPaths };
|
|
308
|
+
}
|
|
309
|
+
}
|
|
310
|
+
if (fs.existsSync(path.join(root, 'go.work'))) {
|
|
311
|
+
const manifestPaths = await discoverGoWorkspaceModules(root, opts);
|
|
312
|
+
if (manifestPaths.length > 0) {
|
|
313
|
+
return { ecosystem: 'gomodules', manifestPaths };
|
|
314
|
+
}
|
|
315
|
+
}
|
|
316
|
+
const hasJsLock = fs.existsSync(path.join(root, 'pnpm-lock.yaml'))
|
|
317
|
+
|| fs.existsSync(path.join(root, 'yarn.lock'))
|
|
318
|
+
|| fs.existsSync(path.join(root, 'package-lock.json'));
|
|
319
|
+
if (fs.existsSync(packageJson) && hasJsLock) {
|
|
320
|
+
let manifestPaths = await discoverWorkspacePackages(root, opts);
|
|
321
|
+
if (manifestPaths.length === 0) {
|
|
322
|
+
manifestPaths = [packageJson];
|
|
323
|
+
}
|
|
324
|
+
return { ecosystem: 'javascript', manifestPaths };
|
|
325
|
+
}
|
|
326
|
+
return { ecosystem: 'unknown', manifestPaths: [] };
|
|
327
|
+
}
|
|
328
|
+
/**
|
|
329
|
+
* Validate discovered JS package.json manifests, collecting errors.
|
|
330
|
+
*
|
|
331
|
+
* @param {string[]} manifestPaths
|
|
332
|
+
* @param {boolean} continueOnError
|
|
333
|
+
* @param {Array<{ manifestPath: string, phase: 'validation' | 'sbom', reason: string }>} collectedErrors - mutated in place
|
|
334
|
+
* @returns {{ validPaths: string[] }}
|
|
335
|
+
* @throws {Error} on first invalid manifest when `continueOnError` is false
|
|
336
|
+
* @private
|
|
337
|
+
*/
|
|
338
|
+
function validateJsManifests(manifestPaths, continueOnError, collectedErrors) {
|
|
339
|
+
const validPaths = [];
|
|
340
|
+
for (const p of manifestPaths) {
|
|
341
|
+
const v = validatePackageJson(p);
|
|
342
|
+
if (v.valid) {
|
|
343
|
+
validPaths.push(p);
|
|
344
|
+
}
|
|
345
|
+
else {
|
|
346
|
+
collectedErrors.push({ manifestPath: p, phase: 'validation', reason: v.error });
|
|
347
|
+
console.warn(`Skipping invalid package.json (${v.error}): ${p}`);
|
|
348
|
+
if (!continueOnError) {
|
|
349
|
+
throw new Error(`Invalid package.json (${v.error}): ${p}`);
|
|
350
|
+
}
|
|
351
|
+
}
|
|
352
|
+
}
|
|
353
|
+
return { validPaths };
|
|
354
|
+
}
|
|
355
|
+
/**
|
|
356
|
+
* Generate SBOMs for all manifests. In fail-fast mode, stops on first error.
|
|
357
|
+
* In continue-on-error mode, runs concurrently and collects failures.
|
|
358
|
+
*
|
|
359
|
+
* @param {string[]} manifestPaths
|
|
360
|
+
* @param {Options} workspaceOpts
|
|
361
|
+
* @param {boolean} continueOnError
|
|
362
|
+
* @param {number} concurrency
|
|
363
|
+
* @param {Array<{ manifestPath: string, phase: 'validation' | 'sbom', reason: string }>} collectedErrors - mutated in place
|
|
364
|
+
* @returns {Promise<Object.<string, object>>} sbomByPurl map
|
|
365
|
+
* @throws {Error} on first SBOM failure when `continueOnError` is false
|
|
366
|
+
* @private
|
|
367
|
+
*/
|
|
368
|
+
async function generateSboms(manifestPaths, workspaceOpts, continueOnError, concurrency, collectedErrors) {
|
|
369
|
+
/** @type {SbomResult[]} */
|
|
370
|
+
const results = [];
|
|
371
|
+
if (!continueOnError) {
|
|
372
|
+
for (const manifestPath of manifestPaths) {
|
|
373
|
+
const result = await generateOneSbom(manifestPath, workspaceOpts);
|
|
374
|
+
if (!result.ok) {
|
|
375
|
+
collectedErrors.push({ manifestPath: result.manifestPath, phase: 'sbom', reason: result.reason });
|
|
376
|
+
throw new Error(`${result.manifestPath}: ${result.reason}`);
|
|
377
|
+
}
|
|
378
|
+
results.push(result);
|
|
379
|
+
}
|
|
380
|
+
}
|
|
381
|
+
else {
|
|
382
|
+
const limit = pLimit(concurrency);
|
|
383
|
+
const settled = await Promise.all(manifestPaths.map(manifestPath => limit(async () => {
|
|
384
|
+
try {
|
|
385
|
+
return await generateOneSbom(manifestPath, workspaceOpts);
|
|
386
|
+
}
|
|
387
|
+
catch (err) {
|
|
388
|
+
const msg = err instanceof Error ? err.message : String(err);
|
|
389
|
+
if (process.env["TRUSTIFY_DA_DEBUG"] === "true") {
|
|
390
|
+
console.log(`Skipping ${manifestPath}: ${msg}`);
|
|
391
|
+
}
|
|
392
|
+
return { ok: false, manifestPath, reason: msg };
|
|
393
|
+
}
|
|
394
|
+
})));
|
|
395
|
+
for (const r of settled) {
|
|
396
|
+
results.push(r);
|
|
397
|
+
if (!r.ok) {
|
|
398
|
+
collectedErrors.push({ manifestPath: r.manifestPath, phase: 'sbom', reason: r.reason });
|
|
399
|
+
}
|
|
400
|
+
}
|
|
401
|
+
}
|
|
402
|
+
const sbomByPurl = {};
|
|
403
|
+
for (const r of results) {
|
|
404
|
+
if (r.ok) {
|
|
405
|
+
sbomByPurl[r.purl] = r.sbom;
|
|
406
|
+
}
|
|
407
|
+
}
|
|
408
|
+
return sbomByPurl;
|
|
409
|
+
}
|
|
410
|
+
/**
|
|
411
|
+
* Create an Error with optional `batchMetadata` attached.
|
|
412
|
+
* @param {string} message
|
|
413
|
+
* @param {boolean} wantMetadata
|
|
414
|
+
* @param {BatchAnalysisMetadata} [metadata]
|
|
415
|
+
* @returns {Error}
|
|
416
|
+
* @private
|
|
417
|
+
*/
|
|
418
|
+
function batchError(message, wantMetadata, metadata) {
|
|
419
|
+
const err = new Error(message);
|
|
420
|
+
if (wantMetadata && metadata) {
|
|
421
|
+
err.batchMetadata = metadata;
|
|
422
|
+
}
|
|
423
|
+
return err;
|
|
424
|
+
}
|
|
425
|
+
/**
|
|
426
|
+
* @overload
|
|
427
|
+
* @param {string} workspaceRoot
|
|
428
|
+
* @param {true} html
|
|
429
|
+
* @param {Options & { batchMetadata: true }} opts
|
|
430
|
+
* @returns {Promise<{ analysis: string, metadata: BatchAnalysisMetadata }>}
|
|
431
|
+
* @throws {Error}
|
|
432
|
+
*/
|
|
433
|
+
/**
|
|
434
|
+
* @overload
|
|
435
|
+
* @param {string} workspaceRoot
|
|
436
|
+
* @param {true} html
|
|
437
|
+
* @param {Options & { batchMetadata?: false }} [opts={}]
|
|
438
|
+
* @returns {Promise<string>}
|
|
439
|
+
* @throws {Error}
|
|
440
|
+
*/
|
|
441
|
+
/**
|
|
442
|
+
* @overload
|
|
443
|
+
* @param {string} workspaceRoot
|
|
444
|
+
* @param {false} html
|
|
445
|
+
* @param {Options & { batchMetadata: true }} opts
|
|
446
|
+
* @returns {Promise<{ analysis: Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>, metadata: BatchAnalysisMetadata }>}
|
|
447
|
+
* @throws {Error}
|
|
448
|
+
*/
|
|
449
|
+
/**
|
|
450
|
+
* @overload
|
|
451
|
+
* @param {string} workspaceRoot
|
|
452
|
+
* @param {false} html
|
|
453
|
+
* @param {Options & { batchMetadata?: false }} [opts={}]
|
|
454
|
+
* @returns {Promise<Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
|
|
455
|
+
* @throws {Error}
|
|
456
|
+
*/
|
|
457
|
+
/**
|
|
458
|
+
* Get stack analysis for all workspace packages/crates (batch).
|
|
459
|
+
* Detects ecosystem from workspace root: Cargo (Cargo.toml + Cargo.lock) or JS/TS (package.json + lock file).
|
|
460
|
+
* SBOMs are generated in parallel (see `batchConcurrency`) unless `continueOnError: false` (fail-fast sequential).
|
|
461
|
+
* With `opts.batchMetadata` / `TRUSTIFY_DA_BATCH_METADATA`, returns `{ analysis, metadata }` including validation and SBOM errors.
|
|
462
|
+
*
|
|
463
|
+
* @overload
|
|
464
|
+
* @param {string} workspaceRoot - Path to workspace root (containing lock file and workspace config)
|
|
465
|
+
* @param {boolean} [html=false] - true returns HTML, false returns JSON report
|
|
466
|
+
* @param {Options} [opts={}] - `batchConcurrency`, discovery ignores, `continueOnError` (default true), `batchMetadata` (default false)
|
|
467
|
+
* @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 }>}
|
|
468
|
+
* @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.
|
|
469
|
+
*/
|
|
470
|
+
async function stackAnalysisBatch(workspaceRoot, html = false, opts = {}) {
|
|
471
|
+
const theUrl = selectTrustifyDABackend(opts);
|
|
472
|
+
const root = path.resolve(workspaceRoot);
|
|
473
|
+
fs.accessSync(root, fs.constants.R_OK);
|
|
474
|
+
const continueOnError = resolveContinueOnError(opts);
|
|
475
|
+
const wantMetadata = resolveBatchMetadata(opts);
|
|
476
|
+
/** @type {Array<{ manifestPath: string, phase: 'validation' | 'sbom', reason: string }>} */
|
|
477
|
+
const collectedErrors = [];
|
|
478
|
+
const { ecosystem, manifestPaths: discovered } = await detectWorkspaceManifests(root, opts);
|
|
479
|
+
let manifestPaths = discovered;
|
|
480
|
+
if (ecosystem === 'javascript') {
|
|
481
|
+
try {
|
|
482
|
+
const { validPaths } = validateJsManifests(manifestPaths, continueOnError, collectedErrors);
|
|
483
|
+
manifestPaths = validPaths;
|
|
484
|
+
}
|
|
485
|
+
catch (err) {
|
|
486
|
+
throw batchError(err.message, wantMetadata, buildBatchAnalysisMetadata(root, ecosystem, 0, 0, collectedErrors));
|
|
487
|
+
}
|
|
488
|
+
if (manifestPaths.length === 0 && discovered.length > 0) {
|
|
489
|
+
const detail = collectedErrors.map(e => `${e.manifestPath}: ${e.reason}`).join('; ');
|
|
490
|
+
throw batchError(`No valid packages after validation at ${root}. ${detail}`, wantMetadata, buildBatchAnalysisMetadata(root, ecosystem, 0, 0, collectedErrors));
|
|
491
|
+
}
|
|
492
|
+
}
|
|
493
|
+
if (manifestPaths.length === 0) {
|
|
494
|
+
throw new Error(`No workspace manifests found at ${root}. Ensure a supported workspace root exists (Cargo.toml+Cargo.lock, go.work, or package.json+lock file).`);
|
|
495
|
+
}
|
|
496
|
+
const workspaceOpts = { ...opts, TRUSTIFY_DA_WORKSPACE_DIR: root };
|
|
497
|
+
const concurrency = resolveBatchConcurrency(opts);
|
|
498
|
+
let sbomByPurl;
|
|
499
|
+
try {
|
|
500
|
+
sbomByPurl = await generateSboms(manifestPaths, workspaceOpts, continueOnError, concurrency, collectedErrors);
|
|
501
|
+
}
|
|
502
|
+
catch (err) {
|
|
503
|
+
throw batchError(err.message, wantMetadata, buildBatchAnalysisMetadata(root, ecosystem, manifestPaths.length, 0, collectedErrors));
|
|
504
|
+
}
|
|
505
|
+
if (Object.keys(sbomByPurl).length === 0) {
|
|
506
|
+
throw batchError(`No valid SBOMs produced from ${manifestPaths.length} manifest(s) at ${root}`, wantMetadata, buildBatchAnalysisMetadata(root, ecosystem, manifestPaths.length, 0, collectedErrors));
|
|
507
|
+
}
|
|
508
|
+
const analysisResult = await analysis.requestStackBatch(sbomByPurl, theUrl, html, opts);
|
|
509
|
+
const meta = buildBatchAnalysisMetadata(root, ecosystem, manifestPaths.length, Object.keys(sbomByPurl).length, collectedErrors);
|
|
510
|
+
if (wantMetadata) {
|
|
511
|
+
return { analysis: analysisResult, metadata: meta };
|
|
512
|
+
}
|
|
513
|
+
return analysisResult;
|
|
514
|
+
}
|
|
177
515
|
/**
|
|
178
516
|
* Validates the Exhort token.
|
|
179
517
|
* @param {Options} [opts={}] - Optional parameters, potentially including token override.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Run full license check: resolve project license (with backend identification and details),
|
|
3
|
+
* get dependency licenses from analysis report, and compute incompatibilities.
|
|
4
|
+
*
|
|
5
|
+
* @param {string} sbomContent - CycloneDX SBOM JSON string (the one sent for component analysis)
|
|
6
|
+
* @param {string} manifestPath - path to manifest
|
|
7
|
+
* @param {string} url - the backend url to send the request to
|
|
8
|
+
* @param {import('../index.js').Options} [opts={}]
|
|
9
|
+
* @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport} [analysisResult] - analysis result that includes licenses array from backend
|
|
10
|
+
* @returns {Promise<{ projectLicense: { manifest: Object|null, file: Object|null, mismatch: boolean }, incompatibleDependencies: Array<{ purl: string, licenses: string[], category?: string, reason: string }>, error?: string }>}
|
|
11
|
+
*/
|
|
12
|
+
export function runLicenseCheck(sbomContent: string, manifestPath: string, url: string, opts?: import("../index.js").Options, analysisResult?: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport): Promise<{
|
|
13
|
+
projectLicense: {
|
|
14
|
+
manifest: any | null;
|
|
15
|
+
file: any | null;
|
|
16
|
+
mismatch: boolean;
|
|
17
|
+
};
|
|
18
|
+
incompatibleDependencies: Array<{
|
|
19
|
+
purl: string;
|
|
20
|
+
licenses: string[];
|
|
21
|
+
category?: string;
|
|
22
|
+
reason: string;
|
|
23
|
+
}>;
|
|
24
|
+
error?: string;
|
|
25
|
+
}>;
|
|
26
|
+
export { getCompatibility } from "./license_utils.js";
|
|
27
|
+
export { getProjectLicense, findLicenseFilePath, identifyLicense } from "./project_license.js";
|
|
28
|
+
export { licensesFromReport, normalizeLicensesResponse, getLicenseDetails } from "./licenses_api.js";
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* License resolution and dependency license compatibility for component analysis.
|
|
3
|
+
*/
|
|
4
|
+
import { getProjectLicense, findLicenseFilePath, identifyLicense } from './project_license.js';
|
|
5
|
+
import { licensesFromReport, getLicenseDetails } from './licenses_api.js';
|
|
6
|
+
import { getCompatibility } from './license_utils.js';
|
|
7
|
+
export { getProjectLicense, findLicenseFilePath, identifyLicense } from './project_license.js';
|
|
8
|
+
export { licensesFromReport, normalizeLicensesResponse, getLicenseDetails } from './licenses_api.js';
|
|
9
|
+
export { getCompatibility } from './license_utils.js';
|
|
10
|
+
/**
|
|
11
|
+
* Run full license check: resolve project license (with backend identification and details),
|
|
12
|
+
* get dependency licenses from analysis report, and compute incompatibilities.
|
|
13
|
+
*
|
|
14
|
+
* @param {string} sbomContent - CycloneDX SBOM JSON string (the one sent for component analysis)
|
|
15
|
+
* @param {string} manifestPath - path to manifest
|
|
16
|
+
* @param {string} url - the backend url to send the request to
|
|
17
|
+
* @param {import('../index.js').Options} [opts={}]
|
|
18
|
+
* @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport} [analysisResult] - analysis result that includes licenses array from backend
|
|
19
|
+
* @returns {Promise<{ projectLicense: { manifest: Object|null, file: Object|null, mismatch: boolean }, incompatibleDependencies: Array<{ purl: string, licenses: string[], category?: string, reason: string }>, error?: string }>}
|
|
20
|
+
*/
|
|
21
|
+
export async function runLicenseCheck(sbomContent, manifestPath, url, opts = {}, analysisResult = null) {
|
|
22
|
+
// Resolve project license from manifest and LICENSE file
|
|
23
|
+
const projectLicense = getProjectLicense(manifestPath);
|
|
24
|
+
// Try backend identification for LICENSE file (more accurate than local pattern matching)
|
|
25
|
+
const licenseFilePath = findLicenseFilePath(manifestPath);
|
|
26
|
+
let backendFileId = null;
|
|
27
|
+
if (licenseFilePath) {
|
|
28
|
+
try {
|
|
29
|
+
backendFileId = await identifyLicense(licenseFilePath, { ...opts, TRUSTIFY_DA_BACKEND_URL: url });
|
|
30
|
+
}
|
|
31
|
+
catch {
|
|
32
|
+
// Fall back to local detection
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
// Determine final license identifiers
|
|
36
|
+
const manifestSpdx = projectLicense.fromManifest;
|
|
37
|
+
const fileSpdx = backendFileId || projectLicense.fromFile;
|
|
38
|
+
const mismatch = Boolean(manifestSpdx && fileSpdx && manifestSpdx.toLowerCase() !== fileSpdx.toLowerCase());
|
|
39
|
+
// Fetch detailed license info from backend (avoid duplicate calls if same license)
|
|
40
|
+
const licenseDetailsCache = new Map();
|
|
41
|
+
async function getDetails(spdxId) {
|
|
42
|
+
if (!spdxId || !url)
|
|
43
|
+
return null;
|
|
44
|
+
if (licenseDetailsCache.has(spdxId))
|
|
45
|
+
return licenseDetailsCache.get(spdxId);
|
|
46
|
+
try {
|
|
47
|
+
const details = await getLicenseDetails(spdxId, { ...opts, TRUSTIFY_DA_BACKEND_URL: url });
|
|
48
|
+
licenseDetailsCache.set(spdxId, details);
|
|
49
|
+
return details;
|
|
50
|
+
}
|
|
51
|
+
catch {
|
|
52
|
+
return null;
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
const manifestLicenseInfo = await getDetails(manifestSpdx);
|
|
56
|
+
const fileLicenseInfo = await getDetails(fileSpdx);
|
|
57
|
+
// Extract dependency purls from SBOM (exclude root component)
|
|
58
|
+
const sbomObj = typeof sbomContent === 'string' ? JSON.parse(sbomContent) : sbomContent;
|
|
59
|
+
const rootRef = sbomObj?.metadata?.component?.["bom-ref"] || sbomObj?.metadata?.component?.purl;
|
|
60
|
+
const purls = (sbomObj?.components || [])
|
|
61
|
+
.map(c => c.purl || c["bom-ref"])
|
|
62
|
+
.filter(Boolean)
|
|
63
|
+
.filter(purl => !rootRef || purl !== rootRef);
|
|
64
|
+
if (purls.length === 0) {
|
|
65
|
+
return {
|
|
66
|
+
projectLicense: { manifest: manifestLicenseInfo, file: fileLicenseInfo, mismatch },
|
|
67
|
+
incompatibleDependencies: []
|
|
68
|
+
};
|
|
69
|
+
}
|
|
70
|
+
// Get dependency licenses from analysis report
|
|
71
|
+
const licenseByPurl = licensesFromReport(analysisResult, purls);
|
|
72
|
+
if (licenseByPurl.size === 0 && analysisResult) {
|
|
73
|
+
return {
|
|
74
|
+
projectLicense: { manifest: manifestLicenseInfo, file: fileLicenseInfo, mismatch },
|
|
75
|
+
incompatibleDependencies: [],
|
|
76
|
+
error: 'No license data available in analysis report'
|
|
77
|
+
};
|
|
78
|
+
}
|
|
79
|
+
// Check compatibility for each dependency
|
|
80
|
+
const projectCategory = manifestLicenseInfo?.category || fileLicenseInfo?.category;
|
|
81
|
+
const incompatibleDependencies = [];
|
|
82
|
+
for (const purl of purls) {
|
|
83
|
+
const entry = licenseByPurl.get(purl);
|
|
84
|
+
if (!entry)
|
|
85
|
+
continue;
|
|
86
|
+
const status = getCompatibility(projectCategory, entry.category);
|
|
87
|
+
if (status === 'incompatible') {
|
|
88
|
+
incompatibleDependencies.push({
|
|
89
|
+
purl,
|
|
90
|
+
licenses: entry.licenses,
|
|
91
|
+
category: entry.category,
|
|
92
|
+
reason: 'Dependency license(s) are incompatible with the project license.'
|
|
93
|
+
});
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
return {
|
|
97
|
+
projectLicense: { manifest: manifestLicenseInfo, file: fileLicenseInfo, mismatch },
|
|
98
|
+
incompatibleDependencies
|
|
99
|
+
};
|
|
100
|
+
}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Find LICENSE file path in the same directory as the manifest.
|
|
3
|
+
* @param {string} manifestPath
|
|
4
|
+
* @returns {string|null} - path to LICENSE file or null if not found
|
|
5
|
+
*/
|
|
6
|
+
export function findLicenseFilePath(manifestPath: string): string | null;
|
|
7
|
+
/**
|
|
8
|
+
* Very simple SPDX detection from common license text (first ~500 chars).
|
|
9
|
+
* @param {string} text
|
|
10
|
+
* @returns {string|null}
|
|
11
|
+
*/
|
|
12
|
+
export function detectSpdxFromText(text: string): string | null;
|
|
13
|
+
/**
|
|
14
|
+
* Read LICENSE file and detect SPDX identifier.
|
|
15
|
+
* @param {string} manifestPath - path to manifest
|
|
16
|
+
* @returns {string|null} - SPDX identifier from LICENSE file or null
|
|
17
|
+
*/
|
|
18
|
+
export function readLicenseFile(manifestPath: string): string | null;
|
|
19
|
+
/**
|
|
20
|
+
* Get project license from manifest or LICENSE file.
|
|
21
|
+
* Returns manifestLicense if provided, otherwise tries LICENSE file.
|
|
22
|
+
* @param {string|null} manifestLicense - license from manifest (or null)
|
|
23
|
+
* @param {string} manifestPath - path to manifest
|
|
24
|
+
* @returns {string|null} - SPDX identifier or null
|
|
25
|
+
*/
|
|
26
|
+
export function getLicense(manifestLicense: string | null, manifestPath: string): string | null;
|
|
27
|
+
/**
|
|
28
|
+
* Normalize SPDX identifier for comparison (lowercase, strip common suffixes).
|
|
29
|
+
* @param {string} spdxOrName
|
|
30
|
+
* @returns {string}
|
|
31
|
+
*/
|
|
32
|
+
export function normalizeSpdx(spdxOrName: string): string;
|
|
33
|
+
/**
|
|
34
|
+
* Check if a dependency's license is compatible with the project license based on backend categories.
|
|
35
|
+
*
|
|
36
|
+
* @param {string} [projectCategory] - backend category for project license: PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN
|
|
37
|
+
* @param {string} [dependencyCategory] - backend category for dependency license: PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN
|
|
38
|
+
* @returns {'compatible'|'incompatible'|'unknown'}
|
|
39
|
+
*/
|
|
40
|
+
export function getCompatibility(projectCategory?: string, dependencyCategory?: string): "compatible" | "incompatible" | "unknown";
|