@trustify-da/trustify-da-javascript-client 0.3.0-ea.63ae5c2 → 0.3.0-ea.7144952
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 +119 -4
- package/dist/package.json +10 -2
- package/dist/src/analysis.d.ts +16 -6
- package/dist/src/analysis.js +69 -66
- package/dist/src/batch_opts.d.ts +24 -0
- package/dist/src/batch_opts.js +35 -0
- package/dist/src/cli.js +192 -8
- package/dist/src/cyclone_dx_sbom.d.ts +3 -1
- package/dist/src/cyclone_dx_sbom.js +18 -5
- package/dist/src/index.d.ts +64 -1
- package/dist/src/index.js +267 -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/provider.d.ts +15 -3
- package/dist/src/provider.js +23 -5
- package/dist/src/providers/base_javascript.d.ts +19 -7
- package/dist/src/providers/base_javascript.js +48 -14
- package/dist/src/providers/golang_gomodules.d.ts +8 -1
- package/dist/src/providers/golang_gomodules.js +13 -4
- 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/python_pip.d.ts +7 -0
- package/dist/src/providers/python_pip.js +13 -3
- 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-requirements.wasm +0 -0
- package/dist/src/sbom.d.ts +3 -1
- package/dist/src/sbom.js +3 -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 +11 -3
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Client for the Trustify DA backend License Analysis API (POST /api/v5/licenses).
|
|
3
|
+
* The same license data shape is returned in the dependency analysis JSON report (result.licenses).
|
|
4
|
+
* @see https://github.com/guacsec/trustify-dependency-analytics#license-analysis-apiv5licenses
|
|
5
|
+
* @see https://github.com/guacsec/trustify-da-api-spec/blob/main/api/v5/openapi.yaml
|
|
6
|
+
*/
|
|
7
|
+
import { PackageURL } from 'packageurl-js';
|
|
8
|
+
import { selectTrustifyDABackend } from '../index.js';
|
|
9
|
+
import { addProxyAgent, getTokenHeaders } from '../tools.js';
|
|
10
|
+
/**
|
|
11
|
+
* Fetch license details by SPDX identifier from the backend GET /api/v5/licenses/{spdx}.
|
|
12
|
+
* Returns detailed information about a specific license including category, name, and text.
|
|
13
|
+
*
|
|
14
|
+
* @param {string} spdxId - SPDX identifier (e.g., "Apache-2.0", "MIT")
|
|
15
|
+
* @param {import('../index.js').Options} [opts={}] - options (proxy, token, TRUSTIFY_DA_BACKEND_URL, etc.)
|
|
16
|
+
* @returns {Promise<Object|null>} License details or null if not found
|
|
17
|
+
*/
|
|
18
|
+
export async function getLicenseDetails(spdxId, opts = {}) {
|
|
19
|
+
if (!spdxId) {
|
|
20
|
+
return null;
|
|
21
|
+
}
|
|
22
|
+
const url = selectTrustifyDABackend(opts);
|
|
23
|
+
const finalUrl = new URL(`${url}/api/v5/licenses/${encodeURIComponent(spdxId)}`);
|
|
24
|
+
const fetchOptions = addProxyAgent({
|
|
25
|
+
method: 'GET',
|
|
26
|
+
headers: {
|
|
27
|
+
'Accept': 'application/json',
|
|
28
|
+
...getTokenHeaders(opts)
|
|
29
|
+
},
|
|
30
|
+
}, opts);
|
|
31
|
+
try {
|
|
32
|
+
const resp = await fetch(finalUrl, fetchOptions);
|
|
33
|
+
if (!resp.ok) {
|
|
34
|
+
const errorText = await resp.text().catch(() => '');
|
|
35
|
+
throw new Error(`HTTP ${resp.status}: ${errorText || resp.statusText}`);
|
|
36
|
+
}
|
|
37
|
+
return await resp.json();
|
|
38
|
+
}
|
|
39
|
+
catch (err) {
|
|
40
|
+
throw new Error(`Failed to fetch license details: ${err.message}`);
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
function normalizePurlString(purl) {
|
|
44
|
+
const parsed = PackageURL.fromString(purl);
|
|
45
|
+
return new PackageURL(parsed.type, parsed.namespace, parsed.name, parsed.version, null, null).toString();
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Normalize the LicensesResponse shape (array of LicenseProviderResult) into a map of purl -> license info.
|
|
49
|
+
* Each provider result has { status, summary, packages } where packages is { [purl]: { concluded, evidence } }.
|
|
50
|
+
* We merge the first successful provider's packages; concluded has identifiers[], category (PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN).
|
|
51
|
+
*
|
|
52
|
+
* @param {unknown} data - LicensesResponse (array) or analysis report's licenses field
|
|
53
|
+
* @param {string[]} [purls] - optional list of purls to restrict to (for consistency with getLicensesByPurl)
|
|
54
|
+
* @returns {Map<string, { licenses: string[], category?: string }>}
|
|
55
|
+
*/
|
|
56
|
+
export function normalizeLicensesResponse(data, purls = []) {
|
|
57
|
+
const map = new Map();
|
|
58
|
+
if (!data || !Array.isArray(data)) {
|
|
59
|
+
return map;
|
|
60
|
+
}
|
|
61
|
+
const normalizedPurlsSet = purls.length > 0 ? new Set(purls.map(normalizePurlString)) : null;
|
|
62
|
+
for (const providerResult of data) {
|
|
63
|
+
const packages = providerResult?.packages;
|
|
64
|
+
if (!packages || typeof packages !== 'object') {
|
|
65
|
+
continue;
|
|
66
|
+
}
|
|
67
|
+
for (const [purl, pkgLicense] of Object.entries(packages)) {
|
|
68
|
+
const concluded = pkgLicense?.concluded;
|
|
69
|
+
const identifiers = Array.isArray(concluded?.identifiers) ? concluded.identifiers : [];
|
|
70
|
+
const expression = concluded?.expression;
|
|
71
|
+
const licenses = identifiers.length > 0 ? identifiers : (expression ? [expression] : []);
|
|
72
|
+
const category = concluded?.category; // PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN
|
|
73
|
+
const normalizedPurl = normalizePurlString(purl);
|
|
74
|
+
if (normalizedPurlsSet === null || normalizedPurlsSet.has(normalizedPurl)) {
|
|
75
|
+
map.set(normalizedPurl, { licenses: licenses.filter(Boolean), category });
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
// Use first provider that has packages; backend may return multiple (e.g. deps.dev)
|
|
79
|
+
if (map.size > 0) {
|
|
80
|
+
break;
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
return map;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Build license map from an analysis report that already includes license data (result.licenses).
|
|
87
|
+
* Use this when the dependency analysis response already contains the licenses array to avoid a second request.
|
|
88
|
+
*
|
|
89
|
+
* @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport} analysisReport - full analysis JSON
|
|
90
|
+
* @param {string[]} [purls] - optional list of purls to restrict to
|
|
91
|
+
* @returns {Map<string, { licenses: string[], category?: string }>}
|
|
92
|
+
*/
|
|
93
|
+
export function licensesFromReport(analysisReport, purls = []) {
|
|
94
|
+
if (!analysisReport?.licenses) {
|
|
95
|
+
return new Map();
|
|
96
|
+
}
|
|
97
|
+
return normalizeLicensesResponse(analysisReport.licenses, purls);
|
|
98
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Resolve project license from manifest and from LICENSE / LICENSE.md in manifest dir or git root.
|
|
3
|
+
* Uses local pattern matching for LICENSE file identification (synchronous).
|
|
4
|
+
* For more accurate backend-based identification, use identifyLicense() separately.
|
|
5
|
+
* @param {string} manifestPath - path to manifest
|
|
6
|
+
* @returns {{ fromManifest: string|null, fromFile: string|null, mismatch: boolean }}
|
|
7
|
+
*/
|
|
8
|
+
export function getProjectLicense(manifestPath: string): {
|
|
9
|
+
fromManifest: string | null;
|
|
10
|
+
fromFile: string | null;
|
|
11
|
+
mismatch: boolean;
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* Call backend /licenses/identify endpoint to identify license from file.
|
|
15
|
+
* @param {string} licenseFilePath - path to LICENSE file
|
|
16
|
+
* @param {{}} [opts={}] - options (proxy, token, etc.)
|
|
17
|
+
* @returns {Promise<string|null>} - SPDX identifier or null
|
|
18
|
+
*/
|
|
19
|
+
export function identifyLicense(licenseFilePath: string, opts?: {}): Promise<string | null>;
|
|
20
|
+
export { findLicenseFilePath, readLicenseFile } from "./license_utils.js";
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Resolves the project license from the manifest and from a LICENSE / LICENSE.md file.
|
|
3
|
+
* Used to report manifest-vs-file mismatch and as the baseline for dependency license compatibility.
|
|
4
|
+
*/
|
|
5
|
+
import fs from 'node:fs';
|
|
6
|
+
import path from 'node:path';
|
|
7
|
+
import { selectTrustifyDABackend } from '../index.js';
|
|
8
|
+
import { matchForLicense, availableProviders } from '../provider.js';
|
|
9
|
+
import { addProxyAgent, getTokenHeaders } from '../tools.js';
|
|
10
|
+
import { normalizeSpdx, readLicenseFile } from './license_utils.js';
|
|
11
|
+
/**
|
|
12
|
+
* Resolve project license from manifest and from LICENSE / LICENSE.md in manifest dir or git root.
|
|
13
|
+
* Uses local pattern matching for LICENSE file identification (synchronous).
|
|
14
|
+
* For more accurate backend-based identification, use identifyLicense() separately.
|
|
15
|
+
* @param {string} manifestPath - path to manifest
|
|
16
|
+
* @returns {{ fromManifest: string|null, fromFile: string|null, mismatch: boolean }}
|
|
17
|
+
*/
|
|
18
|
+
export function getProjectLicense(manifestPath) {
|
|
19
|
+
const resolved = path.resolve(manifestPath);
|
|
20
|
+
const provider = matchForLicense(resolved, availableProviders);
|
|
21
|
+
const fromManifest = provider.readLicenseFromManifest(resolved);
|
|
22
|
+
const fromFile = readLicenseFile(resolved);
|
|
23
|
+
const mismatch = Boolean(fromManifest && fromFile && normalizeSpdx(fromManifest) !== normalizeSpdx(fromFile));
|
|
24
|
+
return {
|
|
25
|
+
fromManifest: fromManifest || null,
|
|
26
|
+
fromFile: fromFile || null,
|
|
27
|
+
mismatch
|
|
28
|
+
};
|
|
29
|
+
}
|
|
30
|
+
export { findLicenseFilePath, readLicenseFile } from './license_utils.js';
|
|
31
|
+
/**
|
|
32
|
+
* Call backend /licenses/identify endpoint to identify license from file.
|
|
33
|
+
* @param {string} licenseFilePath - path to LICENSE file
|
|
34
|
+
* @param {{}} [opts={}] - options (proxy, token, etc.)
|
|
35
|
+
* @returns {Promise<string|null>} - SPDX identifier or null
|
|
36
|
+
*/
|
|
37
|
+
export async function identifyLicense(licenseFilePath, opts = {}) {
|
|
38
|
+
try {
|
|
39
|
+
const fileContent = fs.readFileSync(licenseFilePath);
|
|
40
|
+
const backendUrl = selectTrustifyDABackend(opts);
|
|
41
|
+
const url = new URL(`${backendUrl}/api/v5/licenses/identify`);
|
|
42
|
+
const tokenHeaders = getTokenHeaders(opts);
|
|
43
|
+
const fetchOptions = addProxyAgent({
|
|
44
|
+
method: 'POST',
|
|
45
|
+
headers: {
|
|
46
|
+
'Content-Type': 'application/octet-stream',
|
|
47
|
+
...tokenHeaders,
|
|
48
|
+
},
|
|
49
|
+
body: fileContent,
|
|
50
|
+
}, opts);
|
|
51
|
+
const resp = await fetch(url, fetchOptions);
|
|
52
|
+
if (!resp.ok) {
|
|
53
|
+
return null; // Fallback to local detection on error
|
|
54
|
+
}
|
|
55
|
+
const data = await resp.json();
|
|
56
|
+
// Extract SPDX identifier from backend response
|
|
57
|
+
return data?.license?.id || data?.spdx_id || data?.identifier || null;
|
|
58
|
+
}
|
|
59
|
+
catch {
|
|
60
|
+
return null; // Fallback to local detection on error
|
|
61
|
+
}
|
|
62
|
+
}
|
package/dist/src/provider.d.ts
CHANGED
|
@@ -1,3 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Match a provider by manifest type only (no lock file check). Used for license reading.
|
|
3
|
+
* @param {string} manifestPath - path or name of the manifest
|
|
4
|
+
* @param {[Provider]} providers - list of providers to iterate over
|
|
5
|
+
* @returns {Provider}
|
|
6
|
+
* @throws {Error} when the manifest is not supported and no provider was matched
|
|
7
|
+
*/
|
|
8
|
+
export function matchForLicense(manifestPath: string, providers: [Provider]): Provider;
|
|
1
9
|
/**
|
|
2
10
|
* Match a provider from a list or providers based on file type.
|
|
3
11
|
* Each provider MUST export 'isSupported' taking a file name-type and returning true if supported.
|
|
@@ -5,12 +13,15 @@
|
|
|
5
13
|
* Each provider MUST export 'provideStack' taking manifest path returning a {@link Provided}.
|
|
6
14
|
* @param {string} manifest - the name-type or path of the manifest
|
|
7
15
|
* @param {[Provider]} providers - list of providers to iterate over
|
|
16
|
+
* @param {{TRUSTIFY_DA_WORKSPACE_DIR?: string}} [opts={}] - optional; TRUSTIFY_DA_WORKSPACE_DIR overrides lock file location for workspaces
|
|
8
17
|
* @returns {Provider}
|
|
9
18
|
* @throws {Error} when the manifest is not supported and no provider was matched
|
|
10
19
|
*/
|
|
11
|
-
export function match(manifest: string, providers: [Provider]
|
|
20
|
+
export function match(manifest: string, providers: [Provider], opts?: {
|
|
21
|
+
TRUSTIFY_DA_WORKSPACE_DIR?: string;
|
|
22
|
+
}): Provider;
|
|
12
23
|
/** @typedef {{ecosystem: string, contentType: string, content: string}} Provided */
|
|
13
|
-
/** @typedef {{isSupported: function(string): boolean, validateLockFile: function(string): void, provideComponent: function(string, {}): Provided | Promise<Provided>, provideStack: function(string, {}): Provided | Promise<Provided
|
|
24
|
+
/** @typedef {{isSupported: function(string): boolean, validateLockFile: function(string, Object): void, provideComponent: function(string, {}): Provided | Promise<Provided>, provideStack: function(string, {}): Provided | Promise<Provided>, readLicenseFromManifest: function(string): string | null}} Provider */
|
|
14
25
|
/**
|
|
15
26
|
* MUST include all providers here.
|
|
16
27
|
* @type {[Provider]}
|
|
@@ -23,7 +34,8 @@ export type Provided = {
|
|
|
23
34
|
};
|
|
24
35
|
export type Provider = {
|
|
25
36
|
isSupported: (arg0: string) => boolean;
|
|
26
|
-
validateLockFile: (arg0: string) => void;
|
|
37
|
+
validateLockFile: (arg0: string, arg1: any) => void;
|
|
27
38
|
provideComponent: (arg0: string, arg1: {}) => Provided | Promise<Provided>;
|
|
28
39
|
provideStack: (arg0: string, arg1: {}) => Provided | Promise<Provided>;
|
|
40
|
+
readLicenseFromManifest: (arg0: string) => string | null;
|
|
29
41
|
};
|
package/dist/src/provider.js
CHANGED
|
@@ -7,8 +7,9 @@ import Javascript_npm from './providers/javascript_npm.js';
|
|
|
7
7
|
import Javascript_pnpm from './providers/javascript_pnpm.js';
|
|
8
8
|
import Javascript_yarn from './providers/javascript_yarn.js';
|
|
9
9
|
import pythonPipProvider from './providers/python_pip.js';
|
|
10
|
+
import rustCargoProvider from './providers/rust_cargo.js';
|
|
10
11
|
/** @typedef {{ecosystem: string, contentType: string, content: string}} Provided */
|
|
11
|
-
/** @typedef {{isSupported: function(string): boolean, validateLockFile: function(string): void, provideComponent: function(string, {}): Provided | Promise<Provided>, provideStack: function(string, {}): Provided | Promise<Provided
|
|
12
|
+
/** @typedef {{isSupported: function(string): boolean, validateLockFile: function(string, Object): void, provideComponent: function(string, {}): Provided | Promise<Provided>, provideStack: function(string, {}): Provided | Promise<Provided>, readLicenseFromManifest: function(string): string | null}} Provider */
|
|
12
13
|
/**
|
|
13
14
|
* MUST include all providers here.
|
|
14
15
|
* @type {[Provider]}
|
|
@@ -17,12 +18,28 @@ export const availableProviders = [
|
|
|
17
18
|
new Java_maven(),
|
|
18
19
|
new Java_gradle_groovy(),
|
|
19
20
|
new Java_gradle_kotlin(),
|
|
20
|
-
new Javascript_npm(),
|
|
21
21
|
new Javascript_pnpm(),
|
|
22
22
|
new Javascript_yarn(),
|
|
23
|
+
new Javascript_npm(),
|
|
23
24
|
golangGomodulesProvider,
|
|
24
|
-
pythonPipProvider
|
|
25
|
+
pythonPipProvider,
|
|
26
|
+
rustCargoProvider
|
|
25
27
|
];
|
|
28
|
+
/**
|
|
29
|
+
* Match a provider by manifest type only (no lock file check). Used for license reading.
|
|
30
|
+
* @param {string} manifestPath - path or name of the manifest
|
|
31
|
+
* @param {[Provider]} providers - list of providers to iterate over
|
|
32
|
+
* @returns {Provider}
|
|
33
|
+
* @throws {Error} when the manifest is not supported and no provider was matched
|
|
34
|
+
*/
|
|
35
|
+
export function matchForLicense(manifestPath, providers) {
|
|
36
|
+
const base = path.parse(manifestPath).base;
|
|
37
|
+
const provider = providers.find(prov => prov.isSupported(base));
|
|
38
|
+
if (!provider) {
|
|
39
|
+
throw new Error(`${base} is not supported`);
|
|
40
|
+
}
|
|
41
|
+
return provider;
|
|
42
|
+
}
|
|
26
43
|
/**
|
|
27
44
|
* Match a provider from a list or providers based on file type.
|
|
28
45
|
* Each provider MUST export 'isSupported' taking a file name-type and returning true if supported.
|
|
@@ -30,16 +47,17 @@ export const availableProviders = [
|
|
|
30
47
|
* Each provider MUST export 'provideStack' taking manifest path returning a {@link Provided}.
|
|
31
48
|
* @param {string} manifest - the name-type or path of the manifest
|
|
32
49
|
* @param {[Provider]} providers - list of providers to iterate over
|
|
50
|
+
* @param {{TRUSTIFY_DA_WORKSPACE_DIR?: string}} [opts={}] - optional; TRUSTIFY_DA_WORKSPACE_DIR overrides lock file location for workspaces
|
|
33
51
|
* @returns {Provider}
|
|
34
52
|
* @throws {Error} when the manifest is not supported and no provider was matched
|
|
35
53
|
*/
|
|
36
|
-
export function match(manifest, providers) {
|
|
54
|
+
export function match(manifest, providers, opts = {}) {
|
|
37
55
|
const manifestPath = path.parse(manifest);
|
|
38
56
|
const supported = providers.filter(prov => prov.isSupported(manifestPath.base));
|
|
39
57
|
if (supported.length === 0) {
|
|
40
58
|
throw new Error(`${manifestPath.base} is not supported`);
|
|
41
59
|
}
|
|
42
|
-
const provider = supported.find(prov => prov.validateLockFile(manifestPath.dir));
|
|
60
|
+
const provider = supported.find(prov => prov.validateLockFile(manifestPath.dir, opts));
|
|
43
61
|
if (!provider) {
|
|
44
62
|
throw new Error(`${manifestPath.base} requires a lock file. Use your preferred package manager to generate the lock file.`);
|
|
45
63
|
}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
|
|
2
|
-
/** @typedef {import('../provider
|
|
1
|
+
export type purlType = import("../provider").Provider;
|
|
2
|
+
/** @typedef {import('../provider').Provider} */
|
|
3
|
+
/** @typedef {import('../provider').Provided} Provided */
|
|
3
4
|
/**
|
|
4
5
|
* The ecosystem identifier for JavaScript/npm packages
|
|
5
6
|
* @type {string}
|
|
@@ -66,11 +67,16 @@ export default class Base_javascript {
|
|
|
66
67
|
*/
|
|
67
68
|
isSupported(manifestName: string): boolean;
|
|
68
69
|
/**
|
|
69
|
-
* Checks if a required lock file exists in the
|
|
70
|
+
* Checks if a required lock file exists in the manifest directory or at the workspace root.
|
|
71
|
+
* When TRUSTIFY_DA_WORKSPACE_DIR is provided (via env var or opts),
|
|
72
|
+
* checks only that directory for the lock file.
|
|
70
73
|
* @param {string} manifestDir - The base directory where the manifest is located
|
|
74
|
+
* @param {{TRUSTIFY_DA_WORKSPACE_DIR?: string}} [opts={}] - optional workspace root
|
|
71
75
|
* @returns {boolean} True if the lock file exists
|
|
72
76
|
*/
|
|
73
|
-
validateLockFile(manifestDir: string
|
|
77
|
+
validateLockFile(manifestDir: string, opts?: {
|
|
78
|
+
TRUSTIFY_DA_WORKSPACE_DIR?: string;
|
|
79
|
+
}): boolean;
|
|
74
80
|
/**
|
|
75
81
|
* Provides content and content type for stack analysis
|
|
76
82
|
* @param {string} manifestPath - The manifest path or name
|
|
@@ -85,13 +91,20 @@ export default class Base_javascript {
|
|
|
85
91
|
* @returns {Provided} The provided data for component analysis
|
|
86
92
|
*/
|
|
87
93
|
provideComponent(manifestPath: string, opts?: any): Provided;
|
|
94
|
+
/**
|
|
95
|
+
* Read license from manifest (package.json). Reused by npm, pnpm, yarn.
|
|
96
|
+
* @param {string} manifestPath - path to package.json
|
|
97
|
+
* @returns {string|null}
|
|
98
|
+
*/
|
|
99
|
+
readLicenseFromManifest(manifestPath: string): string | null;
|
|
88
100
|
/**
|
|
89
101
|
* Builds the dependency tree for the project
|
|
90
102
|
* @param {boolean} includeTransitive - Whether to include transitive dependencies
|
|
103
|
+
* @param {Object} [opts={}] - Configuration options; when `TRUSTIFY_DA_WORKSPACE_DIR` is set, commands run from workspace root
|
|
91
104
|
* @returns {Object} The dependency tree
|
|
92
105
|
* @protected
|
|
93
106
|
*/
|
|
94
|
-
protected _buildDependencyTree(includeTransitive: boolean): any;
|
|
107
|
+
protected _buildDependencyTree(includeTransitive: boolean, opts?: any): any;
|
|
95
108
|
/**
|
|
96
109
|
* Recursively builds the Sbom from the JSON that npm listing returns
|
|
97
110
|
* @param {Sbom} sbom - The SBOM object to add dependencies to
|
|
@@ -121,7 +134,6 @@ export default class Base_javascript {
|
|
|
121
134
|
protected _parseDepTreeOutput(output: string): string;
|
|
122
135
|
#private;
|
|
123
136
|
}
|
|
124
|
-
export type
|
|
125
|
-
export type Provided = import("../provider.js").Provided;
|
|
137
|
+
export type Provided = import("../provider").Provided;
|
|
126
138
|
import Manifest from './manifest.js';
|
|
127
139
|
import Sbom from '../sbom.js';
|
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
import fs from 'node:fs';
|
|
2
2
|
import os from "node:os";
|
|
3
3
|
import path from 'node:path';
|
|
4
|
+
import { getLicense } from '../license/license_utils.js';
|
|
4
5
|
import Sbom from '../sbom.js';
|
|
5
|
-
import { getCustom, getCustomPath, invokeCommand, toPurl, toPurlFromString } from
|
|
6
|
+
import { getCustom, getCustomPath, invokeCommand, toPurl, toPurlFromString } from '../tools.js';
|
|
6
7
|
import Manifest from './manifest.js';
|
|
7
|
-
/** @typedef {import('../provider
|
|
8
|
-
/** @typedef {import('../provider
|
|
8
|
+
/** @typedef {import('../provider').Provider} */
|
|
9
|
+
/** @typedef {import('../provider').Provided} Provided */
|
|
9
10
|
/**
|
|
10
11
|
* The ecosystem identifier for JavaScript/npm packages
|
|
11
12
|
* @type {string}
|
|
@@ -96,12 +97,17 @@ export default class Base_javascript {
|
|
|
96
97
|
return 'package.json' === manifestName;
|
|
97
98
|
}
|
|
98
99
|
/**
|
|
99
|
-
* Checks if a required lock file exists in the
|
|
100
|
+
* Checks if a required lock file exists in the manifest directory or at the workspace root.
|
|
101
|
+
* When TRUSTIFY_DA_WORKSPACE_DIR is provided (via env var or opts),
|
|
102
|
+
* checks only that directory for the lock file.
|
|
100
103
|
* @param {string} manifestDir - The base directory where the manifest is located
|
|
104
|
+
* @param {{TRUSTIFY_DA_WORKSPACE_DIR?: string}} [opts={}] - optional workspace root
|
|
101
105
|
* @returns {boolean} True if the lock file exists
|
|
102
106
|
*/
|
|
103
|
-
validateLockFile(manifestDir) {
|
|
104
|
-
const
|
|
107
|
+
validateLockFile(manifestDir, opts = {}) {
|
|
108
|
+
const workspaceDir = getCustom('TRUSTIFY_DA_WORKSPACE_DIR', null, opts);
|
|
109
|
+
const dirToCheck = workspaceDir ? path.resolve(workspaceDir) : manifestDir;
|
|
110
|
+
const lock = path.join(dirToCheck, this._lockFileName());
|
|
105
111
|
return fs.existsSync(lock);
|
|
106
112
|
}
|
|
107
113
|
/**
|
|
@@ -132,17 +138,43 @@ export default class Base_javascript {
|
|
|
132
138
|
contentType: 'application/vnd.cyclonedx+json'
|
|
133
139
|
};
|
|
134
140
|
}
|
|
141
|
+
/**
|
|
142
|
+
* Read license from manifest (package.json). Reused by npm, pnpm, yarn.
|
|
143
|
+
* @param {string} manifestPath - path to package.json
|
|
144
|
+
* @returns {string|null}
|
|
145
|
+
*/
|
|
146
|
+
readLicenseFromManifest(manifestPath) {
|
|
147
|
+
let manifestLicense;
|
|
148
|
+
try {
|
|
149
|
+
const content = JSON.parse(fs.readFileSync(manifestPath, 'utf-8'));
|
|
150
|
+
if (typeof content.license === 'string') {
|
|
151
|
+
manifestLicense = content.license.trim() || null;
|
|
152
|
+
}
|
|
153
|
+
else if (Array.isArray(content.licenses) && content.licenses.length > 0) {
|
|
154
|
+
const first = content.licenses[0];
|
|
155
|
+
const name = first.type || first.name;
|
|
156
|
+
manifestLicense = (typeof name === 'string' ? name.trim() : null);
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
catch {
|
|
160
|
+
manifestLicense = null;
|
|
161
|
+
}
|
|
162
|
+
return getLicense(manifestLicense, manifestPath);
|
|
163
|
+
}
|
|
135
164
|
/**
|
|
136
165
|
* Builds the dependency tree for the project
|
|
137
166
|
* @param {boolean} includeTransitive - Whether to include transitive dependencies
|
|
167
|
+
* @param {Object} [opts={}] - Configuration options; when `TRUSTIFY_DA_WORKSPACE_DIR` is set, commands run from workspace root
|
|
138
168
|
* @returns {Object} The dependency tree
|
|
139
169
|
* @protected
|
|
140
170
|
*/
|
|
141
|
-
_buildDependencyTree(includeTransitive) {
|
|
171
|
+
_buildDependencyTree(includeTransitive, opts = {}) {
|
|
142
172
|
this._version();
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
173
|
+
const manifestDir = path.dirname(this.#manifest.manifestPath);
|
|
174
|
+
const workspaceDir = getCustom('TRUSTIFY_DA_WORKSPACE_DIR', null, opts);
|
|
175
|
+
const cmdDir = workspaceDir ? path.resolve(workspaceDir) : manifestDir;
|
|
176
|
+
this.#createLockFile(cmdDir);
|
|
177
|
+
let output = this.#executeListCmd(includeTransitive, cmdDir);
|
|
146
178
|
output = this._parseDepTreeOutput(output);
|
|
147
179
|
return JSON.parse(output);
|
|
148
180
|
}
|
|
@@ -153,10 +185,11 @@ export default class Base_javascript {
|
|
|
153
185
|
* @private
|
|
154
186
|
*/
|
|
155
187
|
#getSBOM(opts = {}) {
|
|
156
|
-
const depsObject = this._buildDependencyTree(true);
|
|
188
|
+
const depsObject = this._buildDependencyTree(true, opts);
|
|
157
189
|
let mainComponent = toPurl(purlType, this.#manifest.name, this.#manifest.version);
|
|
190
|
+
const license = this.readLicenseFromManifest(this.#manifest.manifestPath);
|
|
158
191
|
let sbom = new Sbom();
|
|
159
|
-
sbom.addRoot(mainComponent);
|
|
192
|
+
sbom.addRoot(mainComponent, license);
|
|
160
193
|
this._addDependenciesToSbom(sbom, depsObject);
|
|
161
194
|
sbom.filterIgnoredDeps(this.#manifest.ignored);
|
|
162
195
|
return sbom.getAsJsonString(opts);
|
|
@@ -204,10 +237,11 @@ export default class Base_javascript {
|
|
|
204
237
|
* @private
|
|
205
238
|
*/
|
|
206
239
|
#getDirectDependencySbom(opts = {}) {
|
|
207
|
-
const depTree = this._buildDependencyTree(false);
|
|
240
|
+
const depTree = this._buildDependencyTree(false, opts);
|
|
208
241
|
let mainComponent = toPurl(purlType, this.#manifest.name, this.#manifest.version);
|
|
242
|
+
const license = this.readLicenseFromManifest(this.#manifest.manifestPath);
|
|
209
243
|
let sbom = new Sbom();
|
|
210
|
-
sbom.addRoot(mainComponent);
|
|
244
|
+
sbom.addRoot(mainComponent, license);
|
|
211
245
|
const rootDeps = this._getRootDependencies(depTree);
|
|
212
246
|
const sortedDepsKeys = Array
|
|
213
247
|
.from(rootDeps.keys())
|
|
@@ -3,6 +3,7 @@ declare namespace _default {
|
|
|
3
3
|
export { validateLockFile };
|
|
4
4
|
export { provideComponent };
|
|
5
5
|
export { provideStack };
|
|
6
|
+
export { readLicenseFromManifest };
|
|
6
7
|
}
|
|
7
8
|
export default _default;
|
|
8
9
|
export type Provided = import("../provider").Provided;
|
|
@@ -20,7 +21,7 @@ export type Dependency = {
|
|
|
20
21
|
/**
|
|
21
22
|
* @param {string} manifestName - the subject manifest name-type
|
|
22
23
|
* @returns {boolean} - return true if `pom.xml` is the manifest name-type
|
|
23
|
-
|
|
24
|
+
*/
|
|
24
25
|
declare function isSupported(manifestName: string): boolean;
|
|
25
26
|
/**
|
|
26
27
|
* @param {string} manifestDir - the directory where the manifest lies
|
|
@@ -40,3 +41,9 @@ declare function provideComponent(manifest: string, opts?: {}): Provided;
|
|
|
40
41
|
* @returns {Provided}
|
|
41
42
|
*/
|
|
42
43
|
declare function provideStack(manifest: string, opts?: {}): Provided;
|
|
44
|
+
/**
|
|
45
|
+
* Go modules have no standard license field in go.mod
|
|
46
|
+
* @param {string} manifestPath - path to go.mod
|
|
47
|
+
* @returns {string|null}
|
|
48
|
+
*/
|
|
49
|
+
declare function readLicenseFromManifest(manifestPath: string): string | null;
|
|
@@ -2,9 +2,10 @@ import fs from 'node:fs';
|
|
|
2
2
|
import path from 'node:path';
|
|
3
3
|
import { EOL } from "os";
|
|
4
4
|
import { PackageURL } from 'packageurl-js';
|
|
5
|
+
import { readLicenseFile } from '../license/license_utils.js';
|
|
5
6
|
import Sbom from '../sbom.js';
|
|
6
7
|
import { getCustom, getCustomPath, invokeCommand } from "../tools.js";
|
|
7
|
-
export default { isSupported, validateLockFile, provideComponent, provideStack };
|
|
8
|
+
export default { isSupported, validateLockFile, provideComponent, provideStack, readLicenseFromManifest };
|
|
8
9
|
/** @typedef {import('../provider').Provider} */
|
|
9
10
|
/** @typedef {import('../provider').Provided} Provided */
|
|
10
11
|
/** @typedef {{name: string, version: string}} Package */
|
|
@@ -12,16 +13,23 @@ export default { isSupported, validateLockFile, provideComponent, provideStack }
|
|
|
12
13
|
/**
|
|
13
14
|
* @type {string} ecosystem for npm-npm is 'maven'
|
|
14
15
|
* @private
|
|
15
|
-
|
|
16
|
+
*/
|
|
16
17
|
const ecosystem = 'golang';
|
|
17
18
|
const defaultMainModuleVersion = "v0.0.0";
|
|
18
19
|
/**
|
|
19
20
|
* @param {string} manifestName - the subject manifest name-type
|
|
20
21
|
* @returns {boolean} - return true if `pom.xml` is the manifest name-type
|
|
21
|
-
|
|
22
|
+
*/
|
|
22
23
|
function isSupported(manifestName) {
|
|
23
24
|
return 'go.mod' === manifestName;
|
|
24
25
|
}
|
|
26
|
+
/**
|
|
27
|
+
* Go modules have no standard license field in go.mod
|
|
28
|
+
* @param {string} manifestPath - path to go.mod
|
|
29
|
+
* @returns {string|null}
|
|
30
|
+
*/
|
|
31
|
+
// eslint-disable-next-line no-unused-vars
|
|
32
|
+
function readLicenseFromManifest(manifestPath) { return readLicenseFile(manifestPath); }
|
|
25
33
|
/**
|
|
26
34
|
* @param {string} manifestDir - the directory where the manifest lies
|
|
27
35
|
*/
|
|
@@ -250,7 +258,8 @@ function getSBOM(manifest, opts = {}, includeTransitive) {
|
|
|
250
258
|
performManifestVersionsCheck(root, rows, manifest);
|
|
251
259
|
}
|
|
252
260
|
const mainModule = toPurl(root, "@");
|
|
253
|
-
|
|
261
|
+
const license = readLicenseFromManifest(manifest);
|
|
262
|
+
sbom.addRoot(mainModule, license);
|
|
254
263
|
const exhortGoMvsLogicEnabled = getCustom("TRUSTIFY_DA_GO_MVS_LOGIC_ENABLED", "true", opts);
|
|
255
264
|
if (includeTransitive && exhortGoMvsLogicEnabled === "true") {
|
|
256
265
|
rows = getFinalPackagesVersionsForModule(rows, manifest, goBin);
|
|
@@ -15,6 +15,12 @@ export default class Java_gradle extends Base_java {
|
|
|
15
15
|
* @param {string} manifestDir - the directory where the manifest lies
|
|
16
16
|
*/
|
|
17
17
|
validateLockFile(): boolean;
|
|
18
|
+
/**
|
|
19
|
+
* Gradle manifests (build.gradle, build.gradle.kts) have no standard license field.
|
|
20
|
+
* @param {string} manifestPath - path to manifest
|
|
21
|
+
* @returns {null}
|
|
22
|
+
*/
|
|
23
|
+
readLicenseFromManifest(manifestPath: string): null;
|
|
18
24
|
/**
|
|
19
25
|
* Provide content and content type for stack analysis.
|
|
20
26
|
* @param {string} manifest - the manifest path or name
|
|
@@ -2,6 +2,7 @@ import fs from 'node:fs';
|
|
|
2
2
|
import path from 'node:path';
|
|
3
3
|
import { EOL } from 'os';
|
|
4
4
|
import TOML from 'fast-toml';
|
|
5
|
+
import { readLicenseFile } from '../license/license_utils.js';
|
|
5
6
|
import Sbom from '../sbom.js';
|
|
6
7
|
import Base_java, { ecosystem_gradle } from "./base_java.js";
|
|
7
8
|
/** @typedef {import('../provider.js').Provider} */
|
|
@@ -49,6 +50,13 @@ export default class Java_gradle extends Base_java {
|
|
|
49
50
|
* @param {string} manifestDir - the directory where the manifest lies
|
|
50
51
|
*/
|
|
51
52
|
validateLockFile() { return true; }
|
|
53
|
+
/**
|
|
54
|
+
* Gradle manifests (build.gradle, build.gradle.kts) have no standard license field.
|
|
55
|
+
* @param {string} manifestPath - path to manifest
|
|
56
|
+
* @returns {null}
|
|
57
|
+
*/
|
|
58
|
+
// eslint-disable-next-line no-unused-vars
|
|
59
|
+
readLicenseFromManifest(manifestPath) { return readLicenseFile(manifestPath); }
|
|
52
60
|
/**
|
|
53
61
|
* Provide content and content type for stack analysis.
|
|
54
62
|
* @param {string} manifest - the manifest path or name
|
|
@@ -158,7 +166,8 @@ export default class Java_gradle extends Base_java {
|
|
|
158
166
|
let sbom = new Sbom();
|
|
159
167
|
let root = `${properties.group}:${properties[ROOT_PROJECT_KEY_NAME].match(/Root project '(.+)'/)[1]}:jar:${properties.version}`;
|
|
160
168
|
let rootPurl = this.parseDep(root);
|
|
161
|
-
|
|
169
|
+
const license = this.readLicenseFromManifest(manifestPath);
|
|
170
|
+
sbom.addRoot(rootPurl, license);
|
|
162
171
|
let ignoredDeps = this.#getIgnoredDeps(manifestPath);
|
|
163
172
|
const [runtimeConfig, compileConfig] = this.#extractConfigurations(content);
|
|
164
173
|
const processedDeps = new Set();
|
|
@@ -298,7 +307,8 @@ export default class Java_gradle extends Base_java {
|
|
|
298
307
|
let sbom = new Sbom();
|
|
299
308
|
let root = `${properties.group}:${properties[ROOT_PROJECT_KEY_NAME].match(/Root project '(.+)'/)[1]}:jar:${properties.version}`;
|
|
300
309
|
let rootPurl = this.parseDep(root);
|
|
301
|
-
|
|
310
|
+
const license = this.readLicenseFromManifest(manifestPath);
|
|
311
|
+
sbom.addRoot(rootPurl, license);
|
|
302
312
|
let ignoredDeps = this.#getIgnoredDeps(manifestPath);
|
|
303
313
|
const [runtimeConfig, compileConfig] = this.#extractConfigurations(content);
|
|
304
314
|
let directDependencies = new Map();
|
|
@@ -27,13 +27,20 @@ export default class Java_maven extends Base_java {
|
|
|
27
27
|
* @returns {Provided}
|
|
28
28
|
*/
|
|
29
29
|
provideComponent(manifest: string, opts?: {}): Provided;
|
|
30
|
+
/**
|
|
31
|
+
* Read license from pom.xml manifest, with fallback to LICENSE file
|
|
32
|
+
* @param {string} manifestPath - path to pom.xml
|
|
33
|
+
* @returns {string|null}
|
|
34
|
+
*/
|
|
35
|
+
readLicenseFromManifest(manifestPath: string): string | null;
|
|
30
36
|
/**
|
|
31
37
|
*
|
|
32
38
|
* @param {String} textGraphList Text graph String of the manifest
|
|
33
39
|
* @param {[String]} ignoredDeps List of ignored dependencies to be omitted from sbom
|
|
40
|
+
* @param {String} manifestPath Path to the pom.xml manifest
|
|
34
41
|
* @return {String} formatted sbom Json String with all dependencies
|
|
35
42
|
*/
|
|
36
|
-
createSbomFileFromTextFormat(textGraphList: string, ignoredDeps: [string], opts: any): string;
|
|
43
|
+
createSbomFileFromTextFormat(textGraphList: string, ignoredDeps: [string], opts: any, manifestPath: string): string;
|
|
37
44
|
#private;
|
|
38
45
|
}
|
|
39
46
|
export type Java_maven = import("../provider").Provider;
|