@trustify-da/trustify-da-javascript-client 0.3.0-ea.ff266a3 → 0.3.0-ea.ff694a0
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 +179 -11
- package/dist/package.json +13 -4
- package/dist/src/analysis.d.ts +16 -0
- package/dist/src/analysis.js +53 -4
- 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 +34 -6
- package/dist/src/index.d.ts +134 -2
- package/dist/src/index.js +352 -6
- package/dist/src/license/index.d.ts +2 -2
- package/dist/src/license/index.js +4 -4
- 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.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/utils.js +11 -2
- package/dist/src/provider.d.ts +7 -3
- package/dist/src/provider.js +16 -5
- package/dist/src/providers/base_java.d.ts +5 -9
- package/dist/src/providers/base_java.js +9 -38
- package/dist/src/providers/base_javascript.d.ts +30 -3
- 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/golang_gomodules.d.ts +22 -12
- 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_maven.d.ts +9 -1
- package/dist/src/providers/java_maven.js +103 -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 +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 +5 -1
- package/dist/src/providers/python_controller.js +8 -4
- 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 +75 -0
- package/dist/src/providers/python_poetry.js +238 -0
- package/dist/src/providers/python_uv.d.ts +55 -0
- package/dist/src/providers/python_uv.js +227 -0
- package/dist/src/providers/requirements_parser.js +4 -3
- package/dist/src/providers/rust_cargo.d.ts +53 -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 +14 -1
- package/dist/src/sbom.js +13 -2
- package/dist/src/tools.d.ts +26 -0
- 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 +14 -5
- package/dist/src/license/compatibility.d.ts +0 -18
- package/dist/src/license/compatibility.js +0 -45
|
@@ -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
|
-
}
|
|
@@ -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): 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: any) => void;
|
|
35
38
|
provideComponent: (arg0: string, arg1: {}) => Provided | Promise<Provided>;
|
|
36
39
|
provideStack: (arg0: string, arg1: {}) => Provided | Promise<Provided>;
|
|
37
40
|
readLicenseFromManifest: (arg0: string) => string | null;
|
|
41
|
+
packageManagerName: () => string;
|
|
38
42
|
};
|
package/dist/src/provider.js
CHANGED
|
@@ -3,12 +3,17 @@ 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';
|
|
9
10
|
import pythonPipProvider from './providers/python_pip.js';
|
|
11
|
+
import Python_pip_pyproject from './providers/python_pip_pyproject.js';
|
|
12
|
+
import Python_poetry from './providers/python_poetry.js';
|
|
13
|
+
import Python_uv from './providers/python_uv.js';
|
|
14
|
+
import rustCargoProvider from './providers/rust_cargo.js';
|
|
10
15
|
/** @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 */
|
|
16
|
+
/** @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, packageManagerName: function(): string}} Provider */
|
|
12
17
|
/**
|
|
13
18
|
* MUST include all providers here.
|
|
14
19
|
* @type {[Provider]}
|
|
@@ -17,11 +22,16 @@ export const availableProviders = [
|
|
|
17
22
|
new Java_maven(),
|
|
18
23
|
new Java_gradle_groovy(),
|
|
19
24
|
new Java_gradle_kotlin(),
|
|
20
|
-
new
|
|
25
|
+
new Javascript_bun(),
|
|
21
26
|
new Javascript_pnpm(),
|
|
22
27
|
new Javascript_yarn(),
|
|
28
|
+
new Javascript_npm(),
|
|
23
29
|
golangGomodulesProvider,
|
|
24
|
-
pythonPipProvider
|
|
30
|
+
pythonPipProvider,
|
|
31
|
+
new Python_poetry(),
|
|
32
|
+
new Python_uv(),
|
|
33
|
+
new Python_pip_pyproject(),
|
|
34
|
+
rustCargoProvider
|
|
25
35
|
];
|
|
26
36
|
/**
|
|
27
37
|
* Match a provider by manifest type only (no lock file check). Used for license reading.
|
|
@@ -45,16 +55,17 @@ export function matchForLicense(manifestPath, providers) {
|
|
|
45
55
|
* Each provider MUST export 'provideStack' taking manifest path returning a {@link Provided}.
|
|
46
56
|
* @param {string} manifest - the name-type or path of the manifest
|
|
47
57
|
* @param {[Provider]} providers - list of providers to iterate over
|
|
58
|
+
* @param {{TRUSTIFY_DA_WORKSPACE_DIR?: string}} [opts={}] - optional; TRUSTIFY_DA_WORKSPACE_DIR overrides lock file location for workspaces
|
|
48
59
|
* @returns {Provider}
|
|
49
60
|
* @throws {Error} when the manifest is not supported and no provider was matched
|
|
50
61
|
*/
|
|
51
|
-
export function match(manifest, providers) {
|
|
62
|
+
export function match(manifest, providers, opts = {}) {
|
|
52
63
|
const manifestPath = path.parse(manifest);
|
|
53
64
|
const supported = providers.filter(prov => prov.isSupported(manifestPath.base));
|
|
54
65
|
if (supported.length === 0) {
|
|
55
66
|
throw new Error(`${manifestPath.base} is not supported`);
|
|
56
67
|
}
|
|
57
|
-
const provider = supported.find(prov => prov.validateLockFile(manifestPath.dir));
|
|
68
|
+
const provider = supported.find(prov => prov.validateLockFile(manifestPath.dir, opts));
|
|
58
69
|
if (!provider) {
|
|
59
70
|
throw new Error(`${manifestPath.base} requires a lock file. Use your preferred package manager to generate the lock file.`);
|
|
60
71
|
}
|
|
@@ -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
|
|
@@ -57,15 +62,6 @@ export default class Base_Java {
|
|
|
57
62
|
* @returns string
|
|
58
63
|
*/
|
|
59
64
|
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
65
|
#private;
|
|
70
66
|
}
|
|
71
67
|
export type Provided = import("../provider").Provided;
|
|
@@ -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
|
|
@@ -131,7 +137,7 @@ export default class Base_Java {
|
|
|
131
137
|
const toolPath = getCustomPath(this.globalBinary, opts);
|
|
132
138
|
const useWrapper = getWrapperPreference(this.globalBinary, opts);
|
|
133
139
|
if (useWrapper) {
|
|
134
|
-
const wrapper = this.
|
|
140
|
+
const wrapper = traverseForWrapper(manifestDir, this.localWrapper);
|
|
135
141
|
if (wrapper !== undefined) {
|
|
136
142
|
try {
|
|
137
143
|
this._invokeCommand(wrapper, ['--version'], { cwd: manifestDir });
|
|
@@ -156,39 +162,4 @@ export default class Base_Java {
|
|
|
156
162
|
}
|
|
157
163
|
return toolPath;
|
|
158
164
|
}
|
|
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
165
|
}
|
|
@@ -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,11 +72,26 @@ 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?: any): boolean;
|
|
75
95
|
/**
|
|
76
96
|
* Provides content and content type for stack analysis
|
|
77
97
|
* @param {string} manifestPath - The manifest path or name
|
|
@@ -95,10 +115,11 @@ 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): any;
|
|
122
|
+
protected _buildDependencyTree(includeTransitive: boolean, opts?: any): any;
|
|
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
|
|
@@ -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
|
|
@@ -1,8 +1,9 @@
|
|
|
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
8
|
/** @typedef {import('../provider').Provider} */
|
|
8
9
|
/** @typedef {import('../provider').Provided} Provided */
|
|
@@ -70,6 +71,13 @@ export default class Base_javascript {
|
|
|
70
71
|
throw new TypeError("_cmdName must be implemented");
|
|
71
72
|
}
|
|
72
73
|
/**
|
|
74
|
+
* Returns the package manager name (e.g. npm, yarn, pnpm, bun)
|
|
75
|
+
* @returns {string} The package manager name
|
|
76
|
+
*/
|
|
77
|
+
packageManagerName() {
|
|
78
|
+
return this._cmdName();
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
73
81
|
* Returns the command arguments for listing dependencies
|
|
74
82
|
* @returns {Array<string>} The command arguments
|
|
75
83
|
* @abstract
|
|
@@ -96,13 +104,63 @@ export default class Base_javascript {
|
|
|
96
104
|
return 'package.json' === manifestName;
|
|
97
105
|
}
|
|
98
106
|
/**
|
|
99
|
-
*
|
|
107
|
+
* Walks up the directory tree from manifestDir looking for the lock file.
|
|
108
|
+
* Stops when the lock file is found, when a package.json with a "workspaces"
|
|
109
|
+
* field is encountered without a lock file (workspace root boundary), or
|
|
110
|
+
* when the filesystem root is reached.
|
|
111
|
+
*
|
|
112
|
+
* When TRUSTIFY_DA_WORKSPACE_DIR is set, checks only that directory (no walk-up).
|
|
113
|
+
*
|
|
114
|
+
* @param {string} manifestDir - The directory to start searching from
|
|
115
|
+
* @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
|
|
116
|
+
* @returns {string|null} The directory containing the lock file, or null
|
|
117
|
+
* @protected
|
|
118
|
+
*/
|
|
119
|
+
_isWorkspaceRoot(dir) {
|
|
120
|
+
if (fs.existsSync(path.join(dir, 'pnpm-workspace.yaml'))) {
|
|
121
|
+
return true;
|
|
122
|
+
}
|
|
123
|
+
const pkgJsonPath = path.join(dir, 'package.json');
|
|
124
|
+
if (fs.existsSync(pkgJsonPath)) {
|
|
125
|
+
try {
|
|
126
|
+
const content = JSON.parse(fs.readFileSync(pkgJsonPath, 'utf-8'));
|
|
127
|
+
if (content.workspaces) {
|
|
128
|
+
return true;
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
catch (_) {
|
|
132
|
+
// ignore parse errors
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
return false;
|
|
136
|
+
}
|
|
137
|
+
_findLockFileDir(manifestDir, opts = {}) {
|
|
138
|
+
const workspaceDir = getCustom('TRUSTIFY_DA_WORKSPACE_DIR', null, opts);
|
|
139
|
+
if (workspaceDir) {
|
|
140
|
+
const dir = path.resolve(workspaceDir);
|
|
141
|
+
return fs.existsSync(path.join(dir, this._lockFileName())) ? dir : null;
|
|
142
|
+
}
|
|
143
|
+
let dir = path.resolve(manifestDir);
|
|
144
|
+
let parent = dir;
|
|
145
|
+
do {
|
|
146
|
+
dir = parent;
|
|
147
|
+
if (fs.existsSync(path.join(dir, this._lockFileName()))) {
|
|
148
|
+
return dir;
|
|
149
|
+
}
|
|
150
|
+
if (this._isWorkspaceRoot(dir)) {
|
|
151
|
+
return null;
|
|
152
|
+
}
|
|
153
|
+
parent = path.dirname(dir);
|
|
154
|
+
} while (parent !== dir);
|
|
155
|
+
return null;
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
100
158
|
* @param {string} manifestDir - The base directory where the manifest is located
|
|
159
|
+
* @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
|
|
101
160
|
* @returns {boolean} True if the lock file exists
|
|
102
161
|
*/
|
|
103
|
-
validateLockFile(manifestDir) {
|
|
104
|
-
|
|
105
|
-
return fs.existsSync(lock);
|
|
162
|
+
validateLockFile(manifestDir, opts = {}) {
|
|
163
|
+
return this._findLockFileDir(manifestDir, opts) !== null;
|
|
106
164
|
}
|
|
107
165
|
/**
|
|
108
166
|
* Provides content and content type for stack analysis
|
|
@@ -138,33 +196,36 @@ export default class Base_javascript {
|
|
|
138
196
|
* @returns {string|null}
|
|
139
197
|
*/
|
|
140
198
|
readLicenseFromManifest(manifestPath) {
|
|
199
|
+
let manifestLicense;
|
|
141
200
|
try {
|
|
142
201
|
const content = JSON.parse(fs.readFileSync(manifestPath, 'utf-8'));
|
|
143
202
|
if (typeof content.license === 'string') {
|
|
144
|
-
|
|
203
|
+
manifestLicense = content.license.trim() || null;
|
|
145
204
|
}
|
|
146
|
-
if (Array.isArray(content.licenses) && content.licenses.length > 0) {
|
|
205
|
+
else if (Array.isArray(content.licenses) && content.licenses.length > 0) {
|
|
147
206
|
const first = content.licenses[0];
|
|
148
207
|
const name = first.type || first.name;
|
|
149
|
-
|
|
208
|
+
manifestLicense = (typeof name === 'string' ? name.trim() : null);
|
|
150
209
|
}
|
|
151
|
-
return null;
|
|
152
210
|
}
|
|
153
211
|
catch {
|
|
154
|
-
|
|
212
|
+
manifestLicense = null;
|
|
155
213
|
}
|
|
214
|
+
return getLicense(manifestLicense, manifestPath);
|
|
156
215
|
}
|
|
157
216
|
/**
|
|
158
217
|
* Builds the dependency tree for the project
|
|
159
218
|
* @param {boolean} includeTransitive - Whether to include transitive dependencies
|
|
219
|
+
* @param {Object} [opts={}] - Configuration options; when `TRUSTIFY_DA_WORKSPACE_DIR` is set, commands run from workspace root
|
|
160
220
|
* @returns {Object} The dependency tree
|
|
161
221
|
* @protected
|
|
162
222
|
*/
|
|
163
|
-
_buildDependencyTree(includeTransitive) {
|
|
223
|
+
_buildDependencyTree(includeTransitive, opts = {}) {
|
|
164
224
|
this._version();
|
|
165
|
-
|
|
166
|
-
this
|
|
167
|
-
|
|
225
|
+
const manifestDir = path.dirname(this.#manifest.manifestPath);
|
|
226
|
+
const cmdDir = this._findLockFileDir(manifestDir, opts) || manifestDir;
|
|
227
|
+
this._createLockFile(cmdDir);
|
|
228
|
+
let output = this.#executeListCmd(includeTransitive, cmdDir);
|
|
168
229
|
output = this._parseDepTreeOutput(output);
|
|
169
230
|
return JSON.parse(output);
|
|
170
231
|
}
|
|
@@ -175,15 +236,38 @@ export default class Base_javascript {
|
|
|
175
236
|
* @private
|
|
176
237
|
*/
|
|
177
238
|
#getSBOM(opts = {}) {
|
|
178
|
-
const depsObject = this._buildDependencyTree(true);
|
|
239
|
+
const depsObject = this._buildDependencyTree(true, opts);
|
|
179
240
|
let mainComponent = toPurl(purlType, this.#manifest.name, this.#manifest.version);
|
|
180
241
|
const license = this.readLicenseFromManifest(this.#manifest.manifestPath);
|
|
181
242
|
let sbom = new Sbom();
|
|
182
243
|
sbom.addRoot(mainComponent, license);
|
|
183
244
|
this._addDependenciesToSbom(sbom, depsObject);
|
|
245
|
+
this.#ensurePeerAndOptionalDeps(sbom);
|
|
184
246
|
sbom.filterIgnoredDeps(this.#manifest.ignored);
|
|
185
247
|
return sbom.getAsJsonString(opts);
|
|
186
248
|
}
|
|
249
|
+
/**
|
|
250
|
+
* Ensures peer and optional dependencies declared in the manifest are
|
|
251
|
+
* present in the SBOM, even when the package manager does not resolve them
|
|
252
|
+
* (e.g. yarn does not include peer deps in its dependency listing).
|
|
253
|
+
* @param {Sbom} sbom - The SBOM to supplement
|
|
254
|
+
* @private
|
|
255
|
+
*/
|
|
256
|
+
#ensurePeerAndOptionalDeps(sbom) {
|
|
257
|
+
const rootPurl = toPurl(purlType, this.#manifest.name, this.#manifest.version);
|
|
258
|
+
const depSources = [this.#manifest.peerDependencies, this.#manifest.optionalDependencies];
|
|
259
|
+
for (const source of depSources) {
|
|
260
|
+
for (const [name, version] of Object.entries(source)) {
|
|
261
|
+
// Build the purl prefix for exact matching (e.g. "pkg:npm/minimist@"
|
|
262
|
+
// or "pkg:npm/%40hapi/joi@") to avoid substring false positives
|
|
263
|
+
const probe = toPurl(purlType, name, version);
|
|
264
|
+
const purlPrefix = probe.toString().replace(/@[^@]*$/, '@');
|
|
265
|
+
if (!sbom.checkDependsOnByPurlPrefix(rootPurl, purlPrefix)) {
|
|
266
|
+
sbom.addDependency(rootPurl, probe);
|
|
267
|
+
}
|
|
268
|
+
}
|
|
269
|
+
}
|
|
270
|
+
}
|
|
187
271
|
/**
|
|
188
272
|
* Recursively builds the Sbom from the JSON that npm listing returns
|
|
189
273
|
* @param {Sbom} sbom - The SBOM object to add dependencies to
|
|
@@ -191,7 +275,10 @@ export default class Base_javascript {
|
|
|
191
275
|
* @protected
|
|
192
276
|
*/
|
|
193
277
|
_addDependenciesToSbom(sbom, depTree) {
|
|
194
|
-
const dependencies =
|
|
278
|
+
const dependencies = {
|
|
279
|
+
...depTree["dependencies"],
|
|
280
|
+
...depTree["optionalDependencies"],
|
|
281
|
+
};
|
|
195
282
|
Object.entries(dependencies)
|
|
196
283
|
.forEach(entry => {
|
|
197
284
|
const [name, artifact] = entry;
|
|
@@ -227,7 +314,7 @@ export default class Base_javascript {
|
|
|
227
314
|
* @private
|
|
228
315
|
*/
|
|
229
316
|
#getDirectDependencySbom(opts = {}) {
|
|
230
|
-
const depTree = this._buildDependencyTree(false);
|
|
317
|
+
const depTree = this._buildDependencyTree(false, opts);
|
|
231
318
|
let mainComponent = toPurl(purlType, this.#manifest.name, this.#manifest.version);
|
|
232
319
|
const license = this.readLicenseFromManifest(this.#manifest.manifestPath);
|
|
233
320
|
let sbom = new Sbom();
|
|
@@ -241,6 +328,7 @@ export default class Base_javascript {
|
|
|
241
328
|
const rootPurl = toPurlFromString(sbom.getRoot().purl);
|
|
242
329
|
sbom.addDependency(rootPurl, rootDeps.get(key));
|
|
243
330
|
}
|
|
331
|
+
this.#ensurePeerAndOptionalDeps(sbom);
|
|
244
332
|
sbom.filterIgnoredDeps(this.#manifest.ignored);
|
|
245
333
|
return sbom.getAsJsonString(opts);
|
|
246
334
|
}
|
|
@@ -251,10 +339,14 @@ export default class Base_javascript {
|
|
|
251
339
|
* @protected
|
|
252
340
|
*/
|
|
253
341
|
_getRootDependencies(depTree) {
|
|
254
|
-
|
|
342
|
+
const allDeps = {
|
|
343
|
+
...depTree.dependencies,
|
|
344
|
+
...depTree.optionalDependencies,
|
|
345
|
+
};
|
|
346
|
+
if (Object.keys(allDeps).length === 0) {
|
|
255
347
|
return new Map();
|
|
256
348
|
}
|
|
257
|
-
return new Map(Object.entries(
|
|
349
|
+
return new Map(Object.entries(allDeps).map(([key, value]) => [key, toPurl(purlType, key, value.version)]));
|
|
258
350
|
}
|
|
259
351
|
/**
|
|
260
352
|
* Executes the list command to get dependencies
|
|
@@ -265,7 +357,7 @@ export default class Base_javascript {
|
|
|
265
357
|
*/
|
|
266
358
|
#executeListCmd(includeTransitive, manifestDir) {
|
|
267
359
|
const listArgs = this._listCmdArgs(includeTransitive, manifestDir);
|
|
268
|
-
return this.#invokeCommand(listArgs);
|
|
360
|
+
return this.#invokeCommand(listArgs, { cwd: manifestDir });
|
|
269
361
|
}
|
|
270
362
|
/**
|
|
271
363
|
* Gets the version of the package manager
|
|
@@ -278,19 +370,17 @@ export default class Base_javascript {
|
|
|
278
370
|
/**
|
|
279
371
|
* Creates or updates the lock file for the package manager
|
|
280
372
|
* @param {string} manifestDir - Directory containing the manifest file
|
|
281
|
-
* @
|
|
373
|
+
* @protected
|
|
282
374
|
*/
|
|
283
|
-
|
|
375
|
+
_createLockFile(manifestDir) {
|
|
284
376
|
const originalDir = process.cwd();
|
|
285
377
|
const isWindows = os.platform() === 'win32';
|
|
286
378
|
if (isWindows) {
|
|
287
|
-
// On Windows, --prefix flag doesn't work as expected
|
|
288
|
-
// Instead of installing from the prefix folder, it installs from current working directory
|
|
289
379
|
process.chdir(manifestDir);
|
|
290
380
|
}
|
|
291
381
|
try {
|
|
292
382
|
const args = this._updateLockFileCmdArgs(manifestDir);
|
|
293
|
-
this.#invokeCommand(args);
|
|
383
|
+
this.#invokeCommand(args, { cwd: manifestDir });
|
|
294
384
|
}
|
|
295
385
|
finally {
|
|
296
386
|
if (isWindows) {
|