@trustify-da/trustify-da-javascript-client 0.3.0-ea.0e9ba23 → 0.3.0-ea.156bb77
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 +180 -12
- package/dist/package.json +34 -22
- package/dist/src/analysis.d.ts +21 -5
- package/dist/src/analysis.js +62 -7
- package/dist/src/batch_opts.d.ts +24 -0
- package/dist/src/batch_opts.js +35 -0
- package/dist/src/cli.js +171 -4
- package/dist/src/cyclone_dx_sbom.d.ts +14 -1
- package/dist/src/cyclone_dx_sbom.js +45 -9
- package/dist/src/index.d.ts +140 -8
- package/dist/src/index.js +353 -7
- package/dist/src/license/index.d.ts +5 -5
- package/dist/src/license/index.js +8 -5
- package/dist/src/license/license_utils.d.ts +40 -0
- package/dist/src/license/license_utils.js +137 -0
- package/dist/src/license/licenses_api.d.ts +2 -2
- package/dist/src/license/licenses_api.js +9 -2
- package/dist/src/license/project_license.d.ts +1 -6
- package/dist/src/license/project_license.js +4 -81
- package/dist/src/oci_image/images.d.ts +1 -1
- package/dist/src/oci_image/images.js +15 -1
- package/dist/src/oci_image/utils.d.ts +5 -5
- package/dist/src/oci_image/utils.js +11 -2
- package/dist/src/provider.d.ts +8 -4
- package/dist/src/provider.js +18 -5
- package/dist/src/providers/base_java.d.ts +14 -12
- package/dist/src/providers/base_java.js +18 -44
- package/dist/src/providers/base_javascript.d.ts +37 -10
- package/dist/src/providers/base_javascript.js +115 -25
- package/dist/src/providers/base_pyproject.d.ts +158 -0
- package/dist/src/providers/base_pyproject.js +322 -0
- package/dist/src/providers/containerfile_parser.d.ts +5 -0
- package/dist/src/providers/containerfile_parser.js +20 -0
- package/dist/src/providers/golang_gomodules.d.ts +23 -13
- package/dist/src/providers/golang_gomodules.js +167 -120
- package/dist/src/providers/gomod_parser.d.ts +4 -0
- package/dist/src/providers/gomod_parser.js +16 -0
- package/dist/src/providers/java_gradle.d.ts +19 -0
- package/dist/src/providers/java_gradle.js +118 -3
- 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 +11 -3
- package/dist/src/providers/java_maven.js +175 -10
- package/dist/src/providers/javascript_bun.d.ts +10 -0
- package/dist/src/providers/javascript_bun.js +100 -0
- package/dist/src/providers/javascript_npm.d.ts +6 -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/oci_dockerfile.d.ts +51 -0
- package/dist/src/providers/oci_dockerfile.js +177 -0
- package/dist/src/providers/processors/yarn_berry_processor.d.ts +2 -2
- package/dist/src/providers/processors/yarn_berry_processor.js +88 -5
- package/dist/src/providers/processors/yarn_classic_processor.d.ts +2 -2
- package/dist/src/providers/python_controller.d.ts +5 -1
- package/dist/src/providers/python_controller.js +65 -7
- package/dist/src/providers/python_pip.d.ts +5 -0
- package/dist/src/providers/python_pip.js +8 -7
- package/dist/src/providers/python_pip_pyproject.d.ts +61 -0
- package/dist/src/providers/python_pip_pyproject.js +146 -0
- package/dist/src/providers/python_poetry.d.ts +98 -0
- package/dist/src/providers/python_poetry.js +286 -0
- package/dist/src/providers/python_uv.d.ts +46 -0
- package/dist/src/providers/python_uv.js +269 -0
- package/dist/src/providers/requirements_parser.js +5 -8
- package/dist/src/providers/rust_cargo.d.ts +56 -0
- package/dist/src/providers/rust_cargo.js +641 -0
- package/dist/src/providers/tree-sitter-containerfile.wasm +0 -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 +14 -1
- package/dist/src/sbom.js +13 -2
- package/dist/src/tools.d.ts +28 -2
- package/dist/src/tools.js +58 -0
- package/dist/src/workspace.d.ts +70 -0
- package/dist/src/workspace.js +256 -0
- package/package.json +35 -23
- package/dist/src/license/compatibility.d.ts +0 -18
- package/dist/src/license/compatibility.js +0 -45
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
* @see https://github.com/guacsec/trustify-dependency-analytics#license-analysis-apiv5licenses
|
|
5
5
|
* @see https://github.com/guacsec/trustify-da-api-spec/blob/main/api/v5/openapi.yaml
|
|
6
6
|
*/
|
|
7
|
+
import { PackageURL } from 'packageurl-js';
|
|
7
8
|
import { selectTrustifyDABackend } from '../index.js';
|
|
8
9
|
import { addProxyAgent, getTokenHeaders } from '../tools.js';
|
|
9
10
|
/**
|
|
@@ -39,6 +40,10 @@ export async function getLicenseDetails(spdxId, opts = {}) {
|
|
|
39
40
|
throw new Error(`Failed to fetch license details: ${err.message}`);
|
|
40
41
|
}
|
|
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
|
+
}
|
|
42
47
|
/**
|
|
43
48
|
* Normalize the LicensesResponse shape (array of LicenseProviderResult) into a map of purl -> license info.
|
|
44
49
|
* Each provider result has { status, summary, packages } where packages is { [purl]: { concluded, evidence } }.
|
|
@@ -53,6 +58,7 @@ export function normalizeLicensesResponse(data, purls = []) {
|
|
|
53
58
|
if (!data || !Array.isArray(data)) {
|
|
54
59
|
return map;
|
|
55
60
|
}
|
|
61
|
+
const normalizedPurlsSet = purls.length > 0 ? new Set(purls.map(normalizePurlString)) : null;
|
|
56
62
|
for (const providerResult of data) {
|
|
57
63
|
const packages = providerResult?.packages;
|
|
58
64
|
if (!packages || typeof packages !== 'object') {
|
|
@@ -64,8 +70,9 @@ export function normalizeLicensesResponse(data, purls = []) {
|
|
|
64
70
|
const expression = concluded?.expression;
|
|
65
71
|
const licenses = identifiers.length > 0 ? identifiers : (expression ? [expression] : []);
|
|
66
72
|
const category = concluded?.category; // PERMISSIVE | WEAK_COPYLEFT | STRONG_COPYLEFT | UNKNOWN
|
|
67
|
-
|
|
68
|
-
|
|
73
|
+
const normalizedPurl = normalizePurlString(purl);
|
|
74
|
+
if (normalizedPurlsSet === null || normalizedPurlsSet.has(normalizedPurl)) {
|
|
75
|
+
map.set(normalizedPurl, { licenses: licenses.filter(Boolean), category });
|
|
69
76
|
}
|
|
70
77
|
}
|
|
71
78
|
// Use first provider that has packages; backend may return multiple (e.g. deps.dev)
|
|
@@ -10,12 +10,6 @@ export function getProjectLicense(manifestPath: string): {
|
|
|
10
10
|
fromFile: string | null;
|
|
11
11
|
mismatch: boolean;
|
|
12
12
|
};
|
|
13
|
-
/**
|
|
14
|
-
* Find LICENSE file path in the same directory as the manifest.
|
|
15
|
-
* @param {string} manifestPath
|
|
16
|
-
* @returns {string|null} - path to LICENSE file or null if not found
|
|
17
|
-
*/
|
|
18
|
-
export function findLicenseFilePath(manifestPath: string): string | null;
|
|
19
13
|
/**
|
|
20
14
|
* Call backend /licenses/identify endpoint to identify license from file.
|
|
21
15
|
* @param {string} licenseFilePath - path to LICENSE file
|
|
@@ -23,3 +17,4 @@ export function findLicenseFilePath(manifestPath: string): string | null;
|
|
|
23
17
|
* @returns {Promise<string|null>} - SPDX identifier or null
|
|
24
18
|
*/
|
|
25
19
|
export function identifyLicense(licenseFilePath: string, opts?: {}): Promise<string | null>;
|
|
20
|
+
export { findLicenseFilePath, readLicenseFile } from "./license_utils.js";
|
|
@@ -7,7 +7,7 @@ import path from 'node:path';
|
|
|
7
7
|
import { selectTrustifyDABackend } from '../index.js';
|
|
8
8
|
import { matchForLicense, availableProviders } from '../provider.js';
|
|
9
9
|
import { addProxyAgent, getTokenHeaders } from '../tools.js';
|
|
10
|
-
|
|
10
|
+
import { normalizeSpdx, readLicenseFile } from './license_utils.js';
|
|
11
11
|
/**
|
|
12
12
|
* Resolve project license from manifest and from LICENSE / LICENSE.md in manifest dir or git root.
|
|
13
13
|
* Uses local pattern matching for LICENSE file identification (synchronous).
|
|
@@ -19,7 +19,7 @@ export function getProjectLicense(manifestPath) {
|
|
|
19
19
|
const resolved = path.resolve(manifestPath);
|
|
20
20
|
const provider = matchForLicense(resolved, availableProviders);
|
|
21
21
|
const fromManifest = provider.readLicenseFromManifest(resolved);
|
|
22
|
-
const fromFile =
|
|
22
|
+
const fromFile = readLicenseFile(resolved);
|
|
23
23
|
const mismatch = Boolean(fromManifest && fromFile && normalizeSpdx(fromManifest) !== normalizeSpdx(fromFile));
|
|
24
24
|
return {
|
|
25
25
|
fromManifest: fromManifest || null,
|
|
@@ -27,26 +27,7 @@ export function getProjectLicense(manifestPath) {
|
|
|
27
27
|
mismatch
|
|
28
28
|
};
|
|
29
29
|
}
|
|
30
|
-
|
|
31
|
-
* Find LICENSE file path in the same directory as the manifest.
|
|
32
|
-
* @param {string} manifestPath
|
|
33
|
-
* @returns {string|null} - path to LICENSE file or null if not found
|
|
34
|
-
*/
|
|
35
|
-
export function findLicenseFilePath(manifestPath) {
|
|
36
|
-
const manifestDir = path.dirname(path.resolve(manifestPath));
|
|
37
|
-
for (const name of LICENSE_FILES) {
|
|
38
|
-
const filePath = path.join(manifestDir, name);
|
|
39
|
-
try {
|
|
40
|
-
if (fs.statSync(filePath).isFile()) {
|
|
41
|
-
return filePath;
|
|
42
|
-
}
|
|
43
|
-
}
|
|
44
|
-
catch {
|
|
45
|
-
// skip
|
|
46
|
-
}
|
|
47
|
-
}
|
|
48
|
-
return null;
|
|
49
|
-
}
|
|
30
|
+
export { findLicenseFilePath, readLicenseFile } from './license_utils.js';
|
|
50
31
|
/**
|
|
51
32
|
* Call backend /licenses/identify endpoint to identify license from file.
|
|
52
33
|
* @param {string} licenseFilePath - path to LICENSE file
|
|
@@ -57,7 +38,7 @@ export async function identifyLicense(licenseFilePath, opts = {}) {
|
|
|
57
38
|
try {
|
|
58
39
|
const fileContent = fs.readFileSync(licenseFilePath);
|
|
59
40
|
const backendUrl = selectTrustifyDABackend(opts);
|
|
60
|
-
const url = new URL(`${backendUrl}/licenses/identify`);
|
|
41
|
+
const url = new URL(`${backendUrl}/api/v5/licenses/identify`);
|
|
61
42
|
const tokenHeaders = getTokenHeaders(opts);
|
|
62
43
|
const fetchOptions = addProxyAgent({
|
|
63
44
|
method: 'POST',
|
|
@@ -79,61 +60,3 @@ export async function identifyLicense(licenseFilePath, opts = {}) {
|
|
|
79
60
|
return null; // Fallback to local detection on error
|
|
80
61
|
}
|
|
81
62
|
}
|
|
82
|
-
/**
|
|
83
|
-
* Find and read LICENSE or LICENSE.md; use local pattern matching for identification.
|
|
84
|
-
* @param {string} manifestPath
|
|
85
|
-
* @returns {string|null}
|
|
86
|
-
*/
|
|
87
|
-
function readLicenseFromFile(manifestPath) {
|
|
88
|
-
const licenseFilePath = findLicenseFilePath(manifestPath);
|
|
89
|
-
if (!licenseFilePath) {
|
|
90
|
-
return null;
|
|
91
|
-
}
|
|
92
|
-
try {
|
|
93
|
-
const content = fs.readFileSync(licenseFilePath, 'utf-8');
|
|
94
|
-
return detectSpdxFromText(content) || content.split('\n')[0]?.trim() || null;
|
|
95
|
-
}
|
|
96
|
-
catch {
|
|
97
|
-
return null;
|
|
98
|
-
}
|
|
99
|
-
}
|
|
100
|
-
/**
|
|
101
|
-
* Very simple SPDX detection from common license text (first ~500 chars).
|
|
102
|
-
* @param {string} text
|
|
103
|
-
* @returns {string|null}
|
|
104
|
-
*/
|
|
105
|
-
function detectSpdxFromText(text) {
|
|
106
|
-
const head = text.slice(0, 500);
|
|
107
|
-
if (/Apache License,?\s*Version 2\.0/i.test(head)) {
|
|
108
|
-
return 'Apache-2.0';
|
|
109
|
-
}
|
|
110
|
-
if (/MIT License/i.test(head) && /Permission is hereby granted/i.test(head)) {
|
|
111
|
-
return 'MIT';
|
|
112
|
-
}
|
|
113
|
-
if (/GNU GENERAL PUBLIC LICENSE\s+Version 2/i.test(head)) {
|
|
114
|
-
return 'GPL-2.0-only';
|
|
115
|
-
}
|
|
116
|
-
if (/GNU GENERAL PUBLIC LICENSE\s+Version 3/i.test(head)) {
|
|
117
|
-
return 'GPL-3.0-only';
|
|
118
|
-
}
|
|
119
|
-
if (/BSD 2-Clause/i.test(head)) {
|
|
120
|
-
return 'BSD-2-Clause';
|
|
121
|
-
}
|
|
122
|
-
if (/BSD 3-Clause/i.test(head)) {
|
|
123
|
-
return 'BSD-3-Clause';
|
|
124
|
-
}
|
|
125
|
-
return null;
|
|
126
|
-
}
|
|
127
|
-
/**
|
|
128
|
-
* Normalize for comparison (lowercase, strip common suffixes).
|
|
129
|
-
* @param {string} spdxOrName
|
|
130
|
-
* @returns {string}
|
|
131
|
-
*/
|
|
132
|
-
function normalizeSpdx(spdxOrName) {
|
|
133
|
-
const s = String(spdxOrName).trim().toLowerCase();
|
|
134
|
-
// e.g. "MIT" vs "MIT License"
|
|
135
|
-
if (s.endsWith(' license')) {
|
|
136
|
-
return s.slice(0, -8);
|
|
137
|
-
}
|
|
138
|
-
return s;
|
|
139
|
-
}
|
|
@@ -78,7 +78,7 @@ export class ImageRef {
|
|
|
78
78
|
* @param {string} [platform]
|
|
79
79
|
* @param {import("index.js").Options} [opts={}]
|
|
80
80
|
*/
|
|
81
|
-
constructor(image: string, platform?: string, opts?:
|
|
81
|
+
constructor(image: string, platform?: string, opts?: any);
|
|
82
82
|
/** @type {Image} */
|
|
83
83
|
image: Image;
|
|
84
84
|
/** @type {Platform} */
|
|
@@ -242,8 +242,22 @@ export class ImageRef {
|
|
|
242
242
|
getPackageURL() {
|
|
243
243
|
/** @type {Object.<string, string>} */
|
|
244
244
|
const qualifiers = {};
|
|
245
|
-
|
|
245
|
+
let repositoryUrl = this.image.getNameWithoutTag();
|
|
246
246
|
const simpleName = this.image.getSimpleName();
|
|
247
|
+
// Normalize Docker Hub image references so all forms produce the same PURL:
|
|
248
|
+
// node → docker.io/node
|
|
249
|
+
// docker.io/library/node → docker.io/node
|
|
250
|
+
if (repositoryUrl != null) {
|
|
251
|
+
const lower = repositoryUrl.toLowerCase();
|
|
252
|
+
if (lower === simpleName.toLowerCase()) {
|
|
253
|
+
// Bare name (e.g. "node") — default to docker.io
|
|
254
|
+
repositoryUrl = `docker.io/${simpleName}`;
|
|
255
|
+
}
|
|
256
|
+
else if (lower.startsWith('docker.io/library/')) {
|
|
257
|
+
// Official image with library/ prefix — strip it
|
|
258
|
+
repositoryUrl = `docker.io/${lower.substring('docker.io/library/'.length)}`;
|
|
259
|
+
}
|
|
260
|
+
}
|
|
247
261
|
if (repositoryUrl != null && repositoryUrl.toLowerCase() !== simpleName.toLowerCase()) {
|
|
248
262
|
qualifiers[ImageRef.REPOSITORY_QUALIFIER] = repositoryUrl.toLowerCase();
|
|
249
263
|
}
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* @param {import("../index.js").Options} [opts={}] - optional various options to pass along the application
|
|
5
5
|
* @returns {{}}
|
|
6
6
|
*/
|
|
7
|
-
export function generateImageSBOM(imageRef:
|
|
7
|
+
export function generateImageSBOM(imageRef: any, opts?: import("../index.js").Options): {};
|
|
8
8
|
/**
|
|
9
9
|
*
|
|
10
10
|
* @param {string} image
|
|
@@ -25,7 +25,7 @@ export function getImagePlatform(opts?: import("../index.js").Options): Platform
|
|
|
25
25
|
* @returns {Object.<string, string>} - The image digests
|
|
26
26
|
* @throws {Error} If the image info is invalid
|
|
27
27
|
*/
|
|
28
|
-
export function getImageDigests(imageRef:
|
|
28
|
+
export function getImageDigests(imageRef: any, opts?: import("../index.js").Options): {
|
|
29
29
|
[x: string]: string;
|
|
30
30
|
};
|
|
31
31
|
export type SyftImageSource = {
|
|
@@ -34,9 +34,9 @@ export type SyftImageSource = {
|
|
|
34
34
|
getVariant: () => string;
|
|
35
35
|
};
|
|
36
36
|
export type SyftImageSourceType = {
|
|
37
|
-
getOs: (arg0:
|
|
38
|
-
getArch: (arg0:
|
|
39
|
-
getVariant: (arg0:
|
|
37
|
+
getOs: (arg0: Object) => string;
|
|
38
|
+
getArch: (arg0: Object) => string;
|
|
39
|
+
getVariant: (arg0: Object) => string;
|
|
40
40
|
};
|
|
41
41
|
import { ImageRef } from './images.js';
|
|
42
42
|
import { Platform } from './platform.js';
|
|
@@ -135,7 +135,7 @@ function execSyft(imageRef, opts = {}) {
|
|
|
135
135
|
function getSyftEnvs(dockerPath, podmanPath) {
|
|
136
136
|
let path = null;
|
|
137
137
|
if (dockerPath && podmanPath) {
|
|
138
|
-
path = `${dockerPath}${
|
|
138
|
+
path = `${dockerPath}${delimiter}${podmanPath}`;
|
|
139
139
|
}
|
|
140
140
|
else if (dockerPath) {
|
|
141
141
|
path = dockerPath;
|
|
@@ -276,7 +276,16 @@ function podmanGetVariant(opts = {}) {
|
|
|
276
276
|
* @returns {string} - The information
|
|
277
277
|
*/
|
|
278
278
|
function dockerPodmanInfo(dockerSupplier, podmanSupplier, opts = {}) {
|
|
279
|
-
|
|
279
|
+
try {
|
|
280
|
+
const result = dockerSupplier(opts);
|
|
281
|
+
if (result) {
|
|
282
|
+
return result;
|
|
283
|
+
}
|
|
284
|
+
}
|
|
285
|
+
catch (_) {
|
|
286
|
+
// docker not available, fall through to podman
|
|
287
|
+
}
|
|
288
|
+
return podmanSupplier(opts);
|
|
280
289
|
}
|
|
281
290
|
/**
|
|
282
291
|
* Gets the digests for an image
|
package/dist/src/provider.d.ts
CHANGED
|
@@ -13,12 +13,15 @@ export function matchForLicense(manifestPath: string, providers: [Provider]): Pr
|
|
|
13
13
|
* Each provider MUST export 'provideStack' taking manifest path returning a {@link Provided}.
|
|
14
14
|
* @param {string} manifest - the name-type or path of the manifest
|
|
15
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
|
|
16
17
|
* @returns {Provider}
|
|
17
18
|
* @throws {Error} when the manifest is not supported and no provider was matched
|
|
18
19
|
*/
|
|
19
|
-
export function match(manifest: string, providers: [Provider]
|
|
20
|
+
export function match(manifest: string, providers: [Provider], opts?: {
|
|
21
|
+
TRUSTIFY_DA_WORKSPACE_DIR?: string;
|
|
22
|
+
}): Provider;
|
|
20
23
|
/** @typedef {{ecosystem: string, contentType: string, content: string}} Provided */
|
|
21
|
-
/** @typedef {{isSupported: function(string): boolean, validateLockFile: function(string): void, provideComponent: function(string, {}): Provided | Promise<Provided>, provideStack: function(string, {}): Provided | Promise<Provided>, readLicenseFromManifest: function(string): string | null}} Provider */
|
|
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, Object=): string | null, packageManagerName: function(): string}} Provider */
|
|
22
25
|
/**
|
|
23
26
|
* MUST include all providers here.
|
|
24
27
|
* @type {[Provider]}
|
|
@@ -31,8 +34,9 @@ export type Provided = {
|
|
|
31
34
|
};
|
|
32
35
|
export type Provider = {
|
|
33
36
|
isSupported: (arg0: string) => boolean;
|
|
34
|
-
validateLockFile: (arg0: string) => void;
|
|
37
|
+
validateLockFile: (arg0: string, arg1: Object) => void;
|
|
35
38
|
provideComponent: (arg0: string, arg1: {}) => Provided | Promise<Provided>;
|
|
36
39
|
provideStack: (arg0: string, arg1: {}) => Provided | Promise<Provided>;
|
|
37
|
-
readLicenseFromManifest: (arg0: string) => string | null;
|
|
40
|
+
readLicenseFromManifest: (arg0: string, arg1: Object | undefined) => string | null;
|
|
41
|
+
packageManagerName: () => string;
|
|
38
42
|
};
|
package/dist/src/provider.js
CHANGED
|
@@ -3,12 +3,18 @@ import golangGomodulesProvider from './providers/golang_gomodules.js';
|
|
|
3
3
|
import Java_gradle_groovy from "./providers/java_gradle_groovy.js";
|
|
4
4
|
import Java_gradle_kotlin from "./providers/java_gradle_kotlin.js";
|
|
5
5
|
import Java_maven from "./providers/java_maven.js";
|
|
6
|
+
import Javascript_bun from './providers/javascript_bun.js';
|
|
6
7
|
import Javascript_npm from './providers/javascript_npm.js';
|
|
7
8
|
import Javascript_pnpm from './providers/javascript_pnpm.js';
|
|
8
9
|
import Javascript_yarn from './providers/javascript_yarn.js';
|
|
10
|
+
import dockerfileProvider from './providers/oci_dockerfile.js';
|
|
9
11
|
import pythonPipProvider from './providers/python_pip.js';
|
|
12
|
+
import Python_pip_pyproject from './providers/python_pip_pyproject.js';
|
|
13
|
+
import Python_poetry from './providers/python_poetry.js';
|
|
14
|
+
import Python_uv from './providers/python_uv.js';
|
|
15
|
+
import rustCargoProvider from './providers/rust_cargo.js';
|
|
10
16
|
/** @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>, readLicenseFromManifest: function(string): string | null}} Provider */
|
|
17
|
+
/** @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, Object=): string | null, packageManagerName: function(): string}} Provider */
|
|
12
18
|
/**
|
|
13
19
|
* MUST include all providers here.
|
|
14
20
|
* @type {[Provider]}
|
|
@@ -17,11 +23,17 @@ export const availableProviders = [
|
|
|
17
23
|
new Java_maven(),
|
|
18
24
|
new Java_gradle_groovy(),
|
|
19
25
|
new Java_gradle_kotlin(),
|
|
20
|
-
new
|
|
26
|
+
new Javascript_bun(),
|
|
21
27
|
new Javascript_pnpm(),
|
|
22
28
|
new Javascript_yarn(),
|
|
29
|
+
new Javascript_npm(),
|
|
23
30
|
golangGomodulesProvider,
|
|
24
|
-
pythonPipProvider
|
|
31
|
+
pythonPipProvider,
|
|
32
|
+
new Python_poetry(),
|
|
33
|
+
new Python_uv(),
|
|
34
|
+
new Python_pip_pyproject(),
|
|
35
|
+
rustCargoProvider,
|
|
36
|
+
dockerfileProvider
|
|
25
37
|
];
|
|
26
38
|
/**
|
|
27
39
|
* Match a provider by manifest type only (no lock file check). Used for license reading.
|
|
@@ -45,16 +57,17 @@ export function matchForLicense(manifestPath, providers) {
|
|
|
45
57
|
* Each provider MUST export 'provideStack' taking manifest path returning a {@link Provided}.
|
|
46
58
|
* @param {string} manifest - the name-type or path of the manifest
|
|
47
59
|
* @param {[Provider]} providers - list of providers to iterate over
|
|
60
|
+
* @param {{TRUSTIFY_DA_WORKSPACE_DIR?: string}} [opts={}] - optional; TRUSTIFY_DA_WORKSPACE_DIR overrides lock file location for workspaces
|
|
48
61
|
* @returns {Provider}
|
|
49
62
|
* @throws {Error} when the manifest is not supported and no provider was matched
|
|
50
63
|
*/
|
|
51
|
-
export function match(manifest, providers) {
|
|
64
|
+
export function match(manifest, providers, opts = {}) {
|
|
52
65
|
const manifestPath = path.parse(manifest);
|
|
53
66
|
const supported = providers.filter(prov => prov.isSupported(manifestPath.base));
|
|
54
67
|
if (supported.length === 0) {
|
|
55
68
|
throw new Error(`${manifestPath.base} is not supported`);
|
|
56
69
|
}
|
|
57
|
-
const provider = supported.find(prov => prov.validateLockFile(manifestPath.dir));
|
|
70
|
+
const provider = supported.find(prov => prov.validateLockFile(manifestPath.dir, opts));
|
|
58
71
|
if (!provider) {
|
|
59
72
|
throw new Error(`${manifestPath.base} requires a lock file. Use your preferred package manager to generate the lock file.`);
|
|
60
73
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export type ecosystem_maven =
|
|
1
|
+
export type ecosystem_maven = any;
|
|
2
2
|
/** @typedef {import('../provider').Provider} */
|
|
3
3
|
/** @typedef {import('../provider').Provided} Provided */
|
|
4
4
|
/** @typedef {{name: string, version: string}} Package */
|
|
@@ -20,6 +20,11 @@ export default class Base_Java {
|
|
|
20
20
|
CONFLICT_REGEX: RegExp;
|
|
21
21
|
globalBinary: string;
|
|
22
22
|
localWrapper: string;
|
|
23
|
+
/**
|
|
24
|
+
* Returns the package manager name (e.g. mvn, gradle)
|
|
25
|
+
* @returns {string}
|
|
26
|
+
*/
|
|
27
|
+
packageManagerName(): string;
|
|
23
28
|
/**
|
|
24
29
|
* Recursively populates the SBOM instance with the parsed graph
|
|
25
30
|
* @param {string} src - Source dependency to start the calculations from
|
|
@@ -28,6 +33,13 @@ export default class Base_Java {
|
|
|
28
33
|
* @param {Sbom} sbom - The SBOM where the dependencies are being added
|
|
29
34
|
*/
|
|
30
35
|
parseDependencyTree(src: string, srcDepth: number, lines: any[], sbom: Sbom): void;
|
|
36
|
+
/**
|
|
37
|
+
* Calculates how deep in the graph is the given line
|
|
38
|
+
* @param {string} line - line to calculate the depth from
|
|
39
|
+
* @returns {number} The calculated depth
|
|
40
|
+
* @protected
|
|
41
|
+
*/
|
|
42
|
+
protected _getDepth(line: string): number;
|
|
31
43
|
/**
|
|
32
44
|
* Create a PackageURL from any line in a Text Graph dependency tree for a manifest path.
|
|
33
45
|
* @param {string} line - line to parse from a dependencies.txt file
|
|
@@ -57,18 +69,8 @@ export default class Base_Java {
|
|
|
57
69
|
* @returns string
|
|
58
70
|
*/
|
|
59
71
|
selectToolBinary(manifestPath: string, opts: {}): string | null;
|
|
60
|
-
/**
|
|
61
|
-
*
|
|
62
|
-
* @param {string} startingManifest - the path of the manifest from which to start searching for the wrapper
|
|
63
|
-
* @param {string} repoRoot - the root of the repository at which point to stop searching for mvnw, derived via git if unset and then fallsback
|
|
64
|
-
* to the root of the drive the manifest is on (assumes absolute path is given)
|
|
65
|
-
* @returns {string|undefined}
|
|
66
|
-
*/
|
|
67
|
-
traverseForWrapper(startingManifest: string, repoRoot?: string): string | undefined;
|
|
68
|
-
normalizePath(thePath: any): string;
|
|
69
|
-
#private;
|
|
70
72
|
}
|
|
71
|
-
export type Provided =
|
|
73
|
+
export type Provided = any;
|
|
72
74
|
export type Package = {
|
|
73
75
|
name: string;
|
|
74
76
|
version: string;
|
|
@@ -1,7 +1,6 @@
|
|
|
1
|
-
import fs from 'node:fs';
|
|
2
1
|
import path from 'node:path';
|
|
3
2
|
import { PackageURL } from 'packageurl-js';
|
|
4
|
-
import { getCustomPath,
|
|
3
|
+
import { getCustomPath, getWrapperPreference, invokeCommand, traverseForWrapper } from "../tools.js";
|
|
5
4
|
/** @typedef {import('../provider').Provider} */
|
|
6
5
|
/** @typedef {import('../provider').Provided} Provided */
|
|
7
6
|
/** @typedef {{name: string, version: string}} Package */
|
|
@@ -26,6 +25,13 @@ export default class Base_Java {
|
|
|
26
25
|
this.globalBinary = globalBinary;
|
|
27
26
|
this.localWrapper = localWrapper;
|
|
28
27
|
}
|
|
28
|
+
/**
|
|
29
|
+
* Returns the package manager name (e.g. mvn, gradle)
|
|
30
|
+
* @returns {string}
|
|
31
|
+
*/
|
|
32
|
+
packageManagerName() {
|
|
33
|
+
return this.globalBinary;
|
|
34
|
+
}
|
|
29
35
|
/**
|
|
30
36
|
* Recursively populates the SBOM instance with the parsed graph
|
|
31
37
|
* @param {string} src - Source dependency to start the calculations from
|
|
@@ -42,7 +48,7 @@ export default class Base_Java {
|
|
|
42
48
|
}
|
|
43
49
|
let index = 0;
|
|
44
50
|
let target = lines[index];
|
|
45
|
-
let targetDepth = this
|
|
51
|
+
let targetDepth = this._getDepth(target);
|
|
46
52
|
while (targetDepth > srcDepth && index < lines.length) {
|
|
47
53
|
if (targetDepth === srcDepth + 1) {
|
|
48
54
|
let from = this.parseDep(src);
|
|
@@ -55,22 +61,25 @@ export default class Base_Java {
|
|
|
55
61
|
}
|
|
56
62
|
}
|
|
57
63
|
else {
|
|
58
|
-
this.parseDependencyTree(lines[index - 1], this
|
|
64
|
+
this.parseDependencyTree(lines[index - 1], this._getDepth(lines[index - 1]), lines.slice(index), sbom);
|
|
59
65
|
}
|
|
60
66
|
target = lines[++index];
|
|
61
|
-
targetDepth = this
|
|
67
|
+
targetDepth = this._getDepth(target);
|
|
62
68
|
}
|
|
63
69
|
}
|
|
64
70
|
/**
|
|
65
71
|
* Calculates how deep in the graph is the given line
|
|
66
72
|
* @param {string} line - line to calculate the depth from
|
|
67
73
|
* @returns {number} The calculated depth
|
|
68
|
-
* @
|
|
74
|
+
* @protected
|
|
69
75
|
*/
|
|
70
|
-
|
|
71
|
-
if (line ===
|
|
76
|
+
_getDepth(line) {
|
|
77
|
+
if (!line || line.trim() === '') {
|
|
72
78
|
return -1;
|
|
73
79
|
}
|
|
80
|
+
if (line.match(/^\w/)) {
|
|
81
|
+
return 0;
|
|
82
|
+
}
|
|
74
83
|
return ((line.indexOf('-') - 1) / 3) + 1;
|
|
75
84
|
}
|
|
76
85
|
/**
|
|
@@ -131,7 +140,7 @@ export default class Base_Java {
|
|
|
131
140
|
const toolPath = getCustomPath(this.globalBinary, opts);
|
|
132
141
|
const useWrapper = getWrapperPreference(this.globalBinary, opts);
|
|
133
142
|
if (useWrapper) {
|
|
134
|
-
const wrapper = this.
|
|
143
|
+
const wrapper = traverseForWrapper(manifestDir, this.localWrapper);
|
|
135
144
|
if (wrapper !== undefined) {
|
|
136
145
|
try {
|
|
137
146
|
this._invokeCommand(wrapper, ['--version'], { cwd: manifestDir });
|
|
@@ -156,39 +165,4 @@ export default class Base_Java {
|
|
|
156
165
|
}
|
|
157
166
|
return toolPath;
|
|
158
167
|
}
|
|
159
|
-
/**
|
|
160
|
-
*
|
|
161
|
-
* @param {string} startingManifest - the path of the manifest from which to start searching for the wrapper
|
|
162
|
-
* @param {string} repoRoot - the root of the repository at which point to stop searching for mvnw, derived via git if unset and then fallsback
|
|
163
|
-
* to the root of the drive the manifest is on (assumes absolute path is given)
|
|
164
|
-
* @returns {string|undefined}
|
|
165
|
-
*/
|
|
166
|
-
traverseForWrapper(startingManifest, repoRoot = undefined) {
|
|
167
|
-
const normalizedManifest = this.normalizePath(startingManifest);
|
|
168
|
-
const currentDir = this.normalizePath(path.dirname(normalizedManifest));
|
|
169
|
-
repoRoot = repoRoot || getGitRootDir(currentDir) || path.parse(normalizedManifest).root;
|
|
170
|
-
const wrapperPath = path.join(currentDir, this.localWrapper);
|
|
171
|
-
try {
|
|
172
|
-
fs.accessSync(wrapperPath, fs.constants.X_OK);
|
|
173
|
-
return wrapperPath;
|
|
174
|
-
}
|
|
175
|
-
catch (error) {
|
|
176
|
-
if (error.code === 'ENOENT') {
|
|
177
|
-
const rootDir = path.parse(currentDir).root;
|
|
178
|
-
if (currentDir === repoRoot || currentDir === rootDir) {
|
|
179
|
-
return undefined;
|
|
180
|
-
}
|
|
181
|
-
const parentDir = path.dirname(currentDir);
|
|
182
|
-
if (parentDir === currentDir || parentDir === rootDir) {
|
|
183
|
-
return undefined;
|
|
184
|
-
}
|
|
185
|
-
return this.traverseForWrapper(path.join(parentDir, path.basename(normalizedManifest)), repoRoot);
|
|
186
|
-
}
|
|
187
|
-
throw new Error(`failure searching for ${this.localWrapper}`, { cause: error });
|
|
188
|
-
}
|
|
189
|
-
}
|
|
190
|
-
normalizePath(thePath) {
|
|
191
|
-
const normalized = path.resolve(thePath).normalize();
|
|
192
|
-
return process.platform === 'win32' ? normalized.toLowerCase() : normalized;
|
|
193
|
-
}
|
|
194
168
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export type purlType =
|
|
1
|
+
export type purlType = any;
|
|
2
2
|
/** @typedef {import('../provider').Provider} */
|
|
3
3
|
/** @typedef {import('../provider').Provided} Provided */
|
|
4
4
|
/**
|
|
@@ -19,7 +19,7 @@ export default class Base_javascript {
|
|
|
19
19
|
* @param {Object} opts - Configuration options for the provider
|
|
20
20
|
* @protected
|
|
21
21
|
*/
|
|
22
|
-
protected _setUp(manifestPath: string, opts:
|
|
22
|
+
protected _setUp(manifestPath: string, opts: Object): void;
|
|
23
23
|
/**
|
|
24
24
|
* Gets the current manifest object
|
|
25
25
|
* @returns {Manifest} The manifest object
|
|
@@ -47,6 +47,11 @@ export default class Base_javascript {
|
|
|
47
47
|
*/
|
|
48
48
|
protected _cmdName(): string;
|
|
49
49
|
/**
|
|
50
|
+
* Returns the package manager name (e.g. npm, yarn, pnpm, bun)
|
|
51
|
+
* @returns {string} The package manager name
|
|
52
|
+
*/
|
|
53
|
+
packageManagerName(): string;
|
|
54
|
+
/**
|
|
50
55
|
* Returns the command arguments for listing dependencies
|
|
51
56
|
* @returns {Array<string>} The command arguments
|
|
52
57
|
* @abstract
|
|
@@ -67,25 +72,40 @@ export default class Base_javascript {
|
|
|
67
72
|
*/
|
|
68
73
|
isSupported(manifestName: string): boolean;
|
|
69
74
|
/**
|
|
70
|
-
*
|
|
75
|
+
* Walks up the directory tree from manifestDir looking for the lock file.
|
|
76
|
+
* Stops when the lock file is found, when a package.json with a "workspaces"
|
|
77
|
+
* field is encountered without a lock file (workspace root boundary), or
|
|
78
|
+
* when the filesystem root is reached.
|
|
79
|
+
*
|
|
80
|
+
* When TRUSTIFY_DA_WORKSPACE_DIR is set, checks only that directory (no walk-up).
|
|
81
|
+
*
|
|
82
|
+
* @param {string} manifestDir - The directory to start searching from
|
|
83
|
+
* @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
|
|
84
|
+
* @returns {string|null} The directory containing the lock file, or null
|
|
85
|
+
* @protected
|
|
86
|
+
*/
|
|
87
|
+
protected _isWorkspaceRoot(dir: any): string | null;
|
|
88
|
+
_findLockFileDir(manifestDir: any, opts?: {}): string | null;
|
|
89
|
+
/**
|
|
71
90
|
* @param {string} manifestDir - The base directory where the manifest is located
|
|
91
|
+
* @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
|
|
72
92
|
* @returns {boolean} True if the lock file exists
|
|
73
93
|
*/
|
|
74
|
-
validateLockFile(manifestDir: string): boolean;
|
|
94
|
+
validateLockFile(manifestDir: string, opts?: Object): boolean;
|
|
75
95
|
/**
|
|
76
96
|
* Provides content and content type for stack analysis
|
|
77
97
|
* @param {string} manifestPath - The manifest path or name
|
|
78
98
|
* @param {Object} [opts={}] - Optional configuration options
|
|
79
99
|
* @returns {Provided} The provided data for stack analysis
|
|
80
100
|
*/
|
|
81
|
-
provideStack(manifestPath: string, opts?:
|
|
101
|
+
provideStack(manifestPath: string, opts?: Object): Provided;
|
|
82
102
|
/**
|
|
83
103
|
* Provides content and content type for component analysis
|
|
84
104
|
* @param {string} manifestPath - Path to package.json for component report
|
|
85
105
|
* @param {Object} [opts={}] - Optional configuration options
|
|
86
106
|
* @returns {Provided} The provided data for component analysis
|
|
87
107
|
*/
|
|
88
|
-
provideComponent(manifestPath: string, opts?:
|
|
108
|
+
provideComponent(manifestPath: string, opts?: Object): Provided;
|
|
89
109
|
/**
|
|
90
110
|
* Read license from manifest (package.json). Reused by npm, pnpm, yarn.
|
|
91
111
|
* @param {string} manifestPath - path to package.json
|
|
@@ -95,24 +115,25 @@ export default class Base_javascript {
|
|
|
95
115
|
/**
|
|
96
116
|
* Builds the dependency tree for the project
|
|
97
117
|
* @param {boolean} includeTransitive - Whether to include transitive dependencies
|
|
118
|
+
* @param {Object} [opts={}] - Configuration options; when `TRUSTIFY_DA_WORKSPACE_DIR` is set, commands run from workspace root
|
|
98
119
|
* @returns {Object} The dependency tree
|
|
99
120
|
* @protected
|
|
100
121
|
*/
|
|
101
|
-
protected _buildDependencyTree(includeTransitive: boolean):
|
|
122
|
+
protected _buildDependencyTree(includeTransitive: boolean, opts?: Object): Object;
|
|
102
123
|
/**
|
|
103
124
|
* Recursively builds the Sbom from the JSON that npm listing returns
|
|
104
125
|
* @param {Sbom} sbom - The SBOM object to add dependencies to
|
|
105
126
|
* @param {Object} depTree - The current dependency tree
|
|
106
127
|
* @protected
|
|
107
128
|
*/
|
|
108
|
-
protected _addDependenciesToSbom(sbom: Sbom, depTree:
|
|
129
|
+
protected _addDependenciesToSbom(sbom: Sbom, depTree: Object): void;
|
|
109
130
|
/**
|
|
110
131
|
* Extracts root dependencies from the dependency tree
|
|
111
132
|
* @param {Object} depTree - The dependency tree object
|
|
112
133
|
* @returns {Map<string, PackageURL>} Map of dependency names to their PackageURL objects
|
|
113
134
|
* @protected
|
|
114
135
|
*/
|
|
115
|
-
protected _getRootDependencies(depTree:
|
|
136
|
+
protected _getRootDependencies(depTree: Object): Map<string, PackageURL>;
|
|
116
137
|
/**
|
|
117
138
|
* Gets the version of the package manager
|
|
118
139
|
* @returns {string} The version string of the package manager
|
|
@@ -120,6 +141,12 @@ export default class Base_javascript {
|
|
|
120
141
|
*/
|
|
121
142
|
protected _version(): string;
|
|
122
143
|
/**
|
|
144
|
+
* Creates or updates the lock file for the package manager
|
|
145
|
+
* @param {string} manifestDir - Directory containing the manifest file
|
|
146
|
+
* @protected
|
|
147
|
+
*/
|
|
148
|
+
protected _createLockFile(manifestDir: string): void;
|
|
149
|
+
/**
|
|
123
150
|
* Parses the dependency tree output
|
|
124
151
|
* @param {string} output - The output to parse
|
|
125
152
|
* @returns {string} The parsed output
|
|
@@ -128,6 +155,6 @@ export default class Base_javascript {
|
|
|
128
155
|
protected _parseDepTreeOutput(output: string): string;
|
|
129
156
|
#private;
|
|
130
157
|
}
|
|
131
|
-
export type Provided =
|
|
158
|
+
export type Provided = any;
|
|
132
159
|
import Manifest from './manifest.js';
|
|
133
160
|
import Sbom from '../sbom.js';
|