@trustify-da/trustify-da-javascript-client 0.3.0-ea.29f6867 → 0.3.0-ea.38515a7
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 +151 -13
- package/dist/package.json +10 -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 +121 -3
- package/dist/src/cyclone_dx_sbom.d.ts +7 -0
- package/dist/src/cyclone_dx_sbom.js +16 -1
- package/dist/src/index.d.ts +64 -1
- package/dist/src/index.js +267 -4
- package/dist/src/license/licenses_api.js +9 -2
- package/dist/src/license/project_license.d.ts +0 -8
- package/dist/src/license/project_license.js +0 -11
- package/dist/src/oci_image/utils.js +11 -2
- package/dist/src/provider.d.ts +6 -3
- package/dist/src/provider.js +12 -5
- package/dist/src/providers/base_javascript.d.ts +19 -3
- package/dist/src/providers/base_javascript.js +99 -18
- package/dist/src/providers/base_pyproject.d.ts +147 -0
- package/dist/src/providers/base_pyproject.js +279 -0
- package/dist/src/providers/golang_gomodules.d.ts +12 -12
- package/dist/src/providers/golang_gomodules.js +100 -111
- package/dist/src/providers/gomod_parser.d.ts +4 -0
- package/dist/src/providers/gomod_parser.js +16 -0
- package/dist/src/providers/javascript_pnpm.d.ts +1 -1
- package/dist/src/providers/javascript_pnpm.js +2 -2
- package/dist/src/providers/manifest.d.ts +2 -0
- package/dist/src/providers/manifest.js +22 -4
- package/dist/src/providers/processors/yarn_berry_processor.js +82 -3
- package/dist/src/providers/python_pip.js +1 -1
- package/dist/src/providers/python_poetry.d.ts +42 -0
- package/dist/src/providers/python_poetry.js +146 -0
- package/dist/src/providers/python_uv.d.ts +26 -0
- package/dist/src/providers/python_uv.js +118 -0
- package/dist/src/providers/rust_cargo.d.ts +52 -0
- package/dist/src/providers/rust_cargo.js +614 -0
- package/dist/src/providers/tree-sitter-gomod.wasm +0 -0
- package/dist/src/sbom.d.ts +7 -0
- package/dist/src/sbom.js +9 -0
- package/dist/src/workspace.d.ts +61 -0
- package/dist/src/workspace.js +256 -0
- package/package.json +11 -5
|
@@ -17,12 +17,4 @@ export function getProjectLicense(manifestPath: string): {
|
|
|
17
17
|
* @returns {Promise<string|null>} - SPDX identifier or null
|
|
18
18
|
*/
|
|
19
19
|
export function identifyLicense(licenseFilePath: string, opts?: {}): Promise<string | null>;
|
|
20
|
-
/**
|
|
21
|
-
* Get license for SBOM root component with fallback to LICENSE file.
|
|
22
|
-
* Priority: manifest license > LICENSE file > null
|
|
23
|
-
* This is used by providers to populate the license field in the SBOM.
|
|
24
|
-
* @param {string} manifestPath - path to manifest
|
|
25
|
-
* @returns {string|null} - SPDX identifier or null
|
|
26
|
-
*/
|
|
27
|
-
export function getLicenseForSbom(manifestPath: string): string | null;
|
|
28
20
|
export { findLicenseFilePath, readLicenseFile } from "./license_utils.js";
|
|
@@ -60,14 +60,3 @@ export async function identifyLicense(licenseFilePath, opts = {}) {
|
|
|
60
60
|
return null; // Fallback to local detection on error
|
|
61
61
|
}
|
|
62
62
|
}
|
|
63
|
-
/**
|
|
64
|
-
* Get license for SBOM root component with fallback to LICENSE file.
|
|
65
|
-
* Priority: manifest license > LICENSE file > null
|
|
66
|
-
* This is used by providers to populate the license field in the SBOM.
|
|
67
|
-
* @param {string} manifestPath - path to manifest
|
|
68
|
-
* @returns {string|null} - SPDX identifier or null
|
|
69
|
-
*/
|
|
70
|
-
export function getLicenseForSbom(manifestPath) {
|
|
71
|
-
const { fromManifest, fromFile } = getProjectLicense(manifestPath);
|
|
72
|
-
return fromManifest || fromFile || null;
|
|
73
|
-
}
|
|
@@ -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}} Provider */
|
|
22
25
|
/**
|
|
23
26
|
* MUST include all providers here.
|
|
24
27
|
* @type {[Provider]}
|
|
@@ -31,7 +34,7 @@ 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;
|
package/dist/src/provider.js
CHANGED
|
@@ -7,8 +7,11 @@ 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 Python_poetry from './providers/python_poetry.js';
|
|
11
|
+
import Python_uv from './providers/python_uv.js';
|
|
12
|
+
import rustCargoProvider from './providers/rust_cargo.js';
|
|
10
13
|
/** @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 */
|
|
14
|
+
/** @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
15
|
/**
|
|
13
16
|
* MUST include all providers here.
|
|
14
17
|
* @type {[Provider]}
|
|
@@ -17,11 +20,14 @@ export const availableProviders = [
|
|
|
17
20
|
new Java_maven(),
|
|
18
21
|
new Java_gradle_groovy(),
|
|
19
22
|
new Java_gradle_kotlin(),
|
|
20
|
-
new Javascript_npm(),
|
|
21
23
|
new Javascript_pnpm(),
|
|
22
24
|
new Javascript_yarn(),
|
|
25
|
+
new Javascript_npm(),
|
|
23
26
|
golangGomodulesProvider,
|
|
24
|
-
pythonPipProvider
|
|
27
|
+
pythonPipProvider,
|
|
28
|
+
new Python_poetry(),
|
|
29
|
+
new Python_uv(),
|
|
30
|
+
rustCargoProvider
|
|
25
31
|
];
|
|
26
32
|
/**
|
|
27
33
|
* Match a provider by manifest type only (no lock file check). Used for license reading.
|
|
@@ -45,16 +51,17 @@ export function matchForLicense(manifestPath, providers) {
|
|
|
45
51
|
* Each provider MUST export 'provideStack' taking manifest path returning a {@link Provided}.
|
|
46
52
|
* @param {string} manifest - the name-type or path of the manifest
|
|
47
53
|
* @param {[Provider]} providers - list of providers to iterate over
|
|
54
|
+
* @param {{TRUSTIFY_DA_WORKSPACE_DIR?: string}} [opts={}] - optional; TRUSTIFY_DA_WORKSPACE_DIR overrides lock file location for workspaces
|
|
48
55
|
* @returns {Provider}
|
|
49
56
|
* @throws {Error} when the manifest is not supported and no provider was matched
|
|
50
57
|
*/
|
|
51
|
-
export function match(manifest, providers) {
|
|
58
|
+
export function match(manifest, providers, opts = {}) {
|
|
52
59
|
const manifestPath = path.parse(manifest);
|
|
53
60
|
const supported = providers.filter(prov => prov.isSupported(manifestPath.base));
|
|
54
61
|
if (supported.length === 0) {
|
|
55
62
|
throw new Error(`${manifestPath.base} is not supported`);
|
|
56
63
|
}
|
|
57
|
-
const provider = supported.find(prov => prov.validateLockFile(manifestPath.dir));
|
|
64
|
+
const provider = supported.find(prov => prov.validateLockFile(manifestPath.dir, opts));
|
|
58
65
|
if (!provider) {
|
|
59
66
|
throw new Error(`${manifestPath.base} requires a lock file. Use your preferred package manager to generate the lock file.`);
|
|
60
67
|
}
|
|
@@ -67,11 +67,26 @@ export default class Base_javascript {
|
|
|
67
67
|
*/
|
|
68
68
|
isSupported(manifestName: string): boolean;
|
|
69
69
|
/**
|
|
70
|
-
*
|
|
70
|
+
* Walks up the directory tree from manifestDir looking for the lock file.
|
|
71
|
+
* Stops when the lock file is found, when a package.json with a "workspaces"
|
|
72
|
+
* field is encountered without a lock file (workspace root boundary), or
|
|
73
|
+
* when the filesystem root is reached.
|
|
74
|
+
*
|
|
75
|
+
* When TRUSTIFY_DA_WORKSPACE_DIR is set, checks only that directory (no walk-up).
|
|
76
|
+
*
|
|
77
|
+
* @param {string} manifestDir - The directory to start searching from
|
|
78
|
+
* @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
|
|
79
|
+
* @returns {string|null} The directory containing the lock file, or null
|
|
80
|
+
* @protected
|
|
81
|
+
*/
|
|
82
|
+
protected _isWorkspaceRoot(dir: any): string | null;
|
|
83
|
+
_findLockFileDir(manifestDir: any, opts?: {}): string | null;
|
|
84
|
+
/**
|
|
71
85
|
* @param {string} manifestDir - The base directory where the manifest is located
|
|
86
|
+
* @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
|
|
72
87
|
* @returns {boolean} True if the lock file exists
|
|
73
88
|
*/
|
|
74
|
-
validateLockFile(manifestDir: string): boolean;
|
|
89
|
+
validateLockFile(manifestDir: string, opts?: any): boolean;
|
|
75
90
|
/**
|
|
76
91
|
* Provides content and content type for stack analysis
|
|
77
92
|
* @param {string} manifestPath - The manifest path or name
|
|
@@ -95,10 +110,11 @@ export default class Base_javascript {
|
|
|
95
110
|
/**
|
|
96
111
|
* Builds the dependency tree for the project
|
|
97
112
|
* @param {boolean} includeTransitive - Whether to include transitive dependencies
|
|
113
|
+
* @param {Object} [opts={}] - Configuration options; when `TRUSTIFY_DA_WORKSPACE_DIR` is set, commands run from workspace root
|
|
98
114
|
* @returns {Object} The dependency tree
|
|
99
115
|
* @protected
|
|
100
116
|
*/
|
|
101
|
-
protected _buildDependencyTree(includeTransitive: boolean): any;
|
|
117
|
+
protected _buildDependencyTree(includeTransitive: boolean, opts?: any): any;
|
|
102
118
|
/**
|
|
103
119
|
* Recursively builds the Sbom from the JSON that npm listing returns
|
|
104
120
|
* @param {Sbom} sbom - The SBOM object to add dependencies to
|
|
@@ -3,7 +3,7 @@ import os from "node:os";
|
|
|
3
3
|
import path from 'node:path';
|
|
4
4
|
import { getLicense } from '../license/license_utils.js';
|
|
5
5
|
import Sbom from '../sbom.js';
|
|
6
|
-
import { getCustom, getCustomPath, invokeCommand, toPurl, toPurlFromString } from
|
|
6
|
+
import { getCustom, getCustomPath, invokeCommand, toPurl, toPurlFromString } from '../tools.js';
|
|
7
7
|
import Manifest from './manifest.js';
|
|
8
8
|
/** @typedef {import('../provider').Provider} */
|
|
9
9
|
/** @typedef {import('../provider').Provided} Provided */
|
|
@@ -97,13 +97,63 @@ export default class Base_javascript {
|
|
|
97
97
|
return 'package.json' === manifestName;
|
|
98
98
|
}
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
* Walks up the directory tree from manifestDir looking for the lock file.
|
|
101
|
+
* Stops when the lock file is found, when a package.json with a "workspaces"
|
|
102
|
+
* field is encountered without a lock file (workspace root boundary), or
|
|
103
|
+
* when the filesystem root is reached.
|
|
104
|
+
*
|
|
105
|
+
* When TRUSTIFY_DA_WORKSPACE_DIR is set, checks only that directory (no walk-up).
|
|
106
|
+
*
|
|
107
|
+
* @param {string} manifestDir - The directory to start searching from
|
|
108
|
+
* @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
|
|
109
|
+
* @returns {string|null} The directory containing the lock file, or null
|
|
110
|
+
* @protected
|
|
111
|
+
*/
|
|
112
|
+
_isWorkspaceRoot(dir) {
|
|
113
|
+
if (fs.existsSync(path.join(dir, 'pnpm-workspace.yaml'))) {
|
|
114
|
+
return true;
|
|
115
|
+
}
|
|
116
|
+
const pkgJsonPath = path.join(dir, 'package.json');
|
|
117
|
+
if (fs.existsSync(pkgJsonPath)) {
|
|
118
|
+
try {
|
|
119
|
+
const content = JSON.parse(fs.readFileSync(pkgJsonPath, 'utf-8'));
|
|
120
|
+
if (content.workspaces) {
|
|
121
|
+
return true;
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
catch (_) {
|
|
125
|
+
// ignore parse errors
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
return false;
|
|
129
|
+
}
|
|
130
|
+
_findLockFileDir(manifestDir, opts = {}) {
|
|
131
|
+
const workspaceDir = getCustom('TRUSTIFY_DA_WORKSPACE_DIR', null, opts);
|
|
132
|
+
if (workspaceDir) {
|
|
133
|
+
const dir = path.resolve(workspaceDir);
|
|
134
|
+
return fs.existsSync(path.join(dir, this._lockFileName())) ? dir : null;
|
|
135
|
+
}
|
|
136
|
+
let dir = path.resolve(manifestDir);
|
|
137
|
+
let parent = dir;
|
|
138
|
+
do {
|
|
139
|
+
dir = parent;
|
|
140
|
+
if (fs.existsSync(path.join(dir, this._lockFileName()))) {
|
|
141
|
+
return dir;
|
|
142
|
+
}
|
|
143
|
+
if (this._isWorkspaceRoot(dir)) {
|
|
144
|
+
return null;
|
|
145
|
+
}
|
|
146
|
+
parent = path.dirname(dir);
|
|
147
|
+
} while (parent !== dir);
|
|
148
|
+
return null;
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
101
151
|
* @param {string} manifestDir - The base directory where the manifest is located
|
|
152
|
+
* @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
|
|
102
153
|
* @returns {boolean} True if the lock file exists
|
|
103
154
|
*/
|
|
104
|
-
validateLockFile(manifestDir) {
|
|
105
|
-
|
|
106
|
-
return fs.existsSync(lock);
|
|
155
|
+
validateLockFile(manifestDir, opts = {}) {
|
|
156
|
+
return this._findLockFileDir(manifestDir, opts) !== null;
|
|
107
157
|
}
|
|
108
158
|
/**
|
|
109
159
|
* Provides content and content type for stack analysis
|
|
@@ -159,14 +209,16 @@ export default class Base_javascript {
|
|
|
159
209
|
/**
|
|
160
210
|
* Builds the dependency tree for the project
|
|
161
211
|
* @param {boolean} includeTransitive - Whether to include transitive dependencies
|
|
212
|
+
* @param {Object} [opts={}] - Configuration options; when `TRUSTIFY_DA_WORKSPACE_DIR` is set, commands run from workspace root
|
|
162
213
|
* @returns {Object} The dependency tree
|
|
163
214
|
* @protected
|
|
164
215
|
*/
|
|
165
|
-
_buildDependencyTree(includeTransitive) {
|
|
216
|
+
_buildDependencyTree(includeTransitive, opts = {}) {
|
|
166
217
|
this._version();
|
|
167
|
-
|
|
168
|
-
this
|
|
169
|
-
|
|
218
|
+
const manifestDir = path.dirname(this.#manifest.manifestPath);
|
|
219
|
+
const cmdDir = this._findLockFileDir(manifestDir, opts) || manifestDir;
|
|
220
|
+
this.#createLockFile(cmdDir);
|
|
221
|
+
let output = this.#executeListCmd(includeTransitive, cmdDir);
|
|
170
222
|
output = this._parseDepTreeOutput(output);
|
|
171
223
|
return JSON.parse(output);
|
|
172
224
|
}
|
|
@@ -177,15 +229,38 @@ export default class Base_javascript {
|
|
|
177
229
|
* @private
|
|
178
230
|
*/
|
|
179
231
|
#getSBOM(opts = {}) {
|
|
180
|
-
const depsObject = this._buildDependencyTree(true);
|
|
232
|
+
const depsObject = this._buildDependencyTree(true, opts);
|
|
181
233
|
let mainComponent = toPurl(purlType, this.#manifest.name, this.#manifest.version);
|
|
182
234
|
const license = this.readLicenseFromManifest(this.#manifest.manifestPath);
|
|
183
235
|
let sbom = new Sbom();
|
|
184
236
|
sbom.addRoot(mainComponent, license);
|
|
185
237
|
this._addDependenciesToSbom(sbom, depsObject);
|
|
238
|
+
this.#ensurePeerAndOptionalDeps(sbom);
|
|
186
239
|
sbom.filterIgnoredDeps(this.#manifest.ignored);
|
|
187
240
|
return sbom.getAsJsonString(opts);
|
|
188
241
|
}
|
|
242
|
+
/**
|
|
243
|
+
* Ensures peer and optional dependencies declared in the manifest are
|
|
244
|
+
* present in the SBOM, even when the package manager does not resolve them
|
|
245
|
+
* (e.g. yarn does not include peer deps in its dependency listing).
|
|
246
|
+
* @param {Sbom} sbom - The SBOM to supplement
|
|
247
|
+
* @private
|
|
248
|
+
*/
|
|
249
|
+
#ensurePeerAndOptionalDeps(sbom) {
|
|
250
|
+
const rootPurl = toPurl(purlType, this.#manifest.name, this.#manifest.version);
|
|
251
|
+
const depSources = [this.#manifest.peerDependencies, this.#manifest.optionalDependencies];
|
|
252
|
+
for (const source of depSources) {
|
|
253
|
+
for (const [name, version] of Object.entries(source)) {
|
|
254
|
+
// Build the purl prefix for exact matching (e.g. "pkg:npm/minimist@"
|
|
255
|
+
// or "pkg:npm/%40hapi/joi@") to avoid substring false positives
|
|
256
|
+
const probe = toPurl(purlType, name, version);
|
|
257
|
+
const purlPrefix = probe.toString().replace(/@[^@]*$/, '@');
|
|
258
|
+
if (!sbom.checkDependsOnByPurlPrefix(rootPurl, purlPrefix)) {
|
|
259
|
+
sbom.addDependency(rootPurl, probe);
|
|
260
|
+
}
|
|
261
|
+
}
|
|
262
|
+
}
|
|
263
|
+
}
|
|
189
264
|
/**
|
|
190
265
|
* Recursively builds the Sbom from the JSON that npm listing returns
|
|
191
266
|
* @param {Sbom} sbom - The SBOM object to add dependencies to
|
|
@@ -193,7 +268,10 @@ export default class Base_javascript {
|
|
|
193
268
|
* @protected
|
|
194
269
|
*/
|
|
195
270
|
_addDependenciesToSbom(sbom, depTree) {
|
|
196
|
-
const dependencies =
|
|
271
|
+
const dependencies = {
|
|
272
|
+
...depTree["dependencies"],
|
|
273
|
+
...depTree["optionalDependencies"],
|
|
274
|
+
};
|
|
197
275
|
Object.entries(dependencies)
|
|
198
276
|
.forEach(entry => {
|
|
199
277
|
const [name, artifact] = entry;
|
|
@@ -229,7 +307,7 @@ export default class Base_javascript {
|
|
|
229
307
|
* @private
|
|
230
308
|
*/
|
|
231
309
|
#getDirectDependencySbom(opts = {}) {
|
|
232
|
-
const depTree = this._buildDependencyTree(false);
|
|
310
|
+
const depTree = this._buildDependencyTree(false, opts);
|
|
233
311
|
let mainComponent = toPurl(purlType, this.#manifest.name, this.#manifest.version);
|
|
234
312
|
const license = this.readLicenseFromManifest(this.#manifest.manifestPath);
|
|
235
313
|
let sbom = new Sbom();
|
|
@@ -243,6 +321,7 @@ export default class Base_javascript {
|
|
|
243
321
|
const rootPurl = toPurlFromString(sbom.getRoot().purl);
|
|
244
322
|
sbom.addDependency(rootPurl, rootDeps.get(key));
|
|
245
323
|
}
|
|
324
|
+
this.#ensurePeerAndOptionalDeps(sbom);
|
|
246
325
|
sbom.filterIgnoredDeps(this.#manifest.ignored);
|
|
247
326
|
return sbom.getAsJsonString(opts);
|
|
248
327
|
}
|
|
@@ -253,10 +332,14 @@ export default class Base_javascript {
|
|
|
253
332
|
* @protected
|
|
254
333
|
*/
|
|
255
334
|
_getRootDependencies(depTree) {
|
|
256
|
-
|
|
335
|
+
const allDeps = {
|
|
336
|
+
...depTree.dependencies,
|
|
337
|
+
...depTree.optionalDependencies,
|
|
338
|
+
};
|
|
339
|
+
if (Object.keys(allDeps).length === 0) {
|
|
257
340
|
return new Map();
|
|
258
341
|
}
|
|
259
|
-
return new Map(Object.entries(
|
|
342
|
+
return new Map(Object.entries(allDeps).map(([key, value]) => [key, toPurl(purlType, key, value.version)]));
|
|
260
343
|
}
|
|
261
344
|
/**
|
|
262
345
|
* Executes the list command to get dependencies
|
|
@@ -267,7 +350,7 @@ export default class Base_javascript {
|
|
|
267
350
|
*/
|
|
268
351
|
#executeListCmd(includeTransitive, manifestDir) {
|
|
269
352
|
const listArgs = this._listCmdArgs(includeTransitive, manifestDir);
|
|
270
|
-
return this.#invokeCommand(listArgs);
|
|
353
|
+
return this.#invokeCommand(listArgs, { cwd: manifestDir });
|
|
271
354
|
}
|
|
272
355
|
/**
|
|
273
356
|
* Gets the version of the package manager
|
|
@@ -286,13 +369,11 @@ export default class Base_javascript {
|
|
|
286
369
|
const originalDir = process.cwd();
|
|
287
370
|
const isWindows = os.platform() === 'win32';
|
|
288
371
|
if (isWindows) {
|
|
289
|
-
// On Windows, --prefix flag doesn't work as expected
|
|
290
|
-
// Instead of installing from the prefix folder, it installs from current working directory
|
|
291
372
|
process.chdir(manifestDir);
|
|
292
373
|
}
|
|
293
374
|
try {
|
|
294
375
|
const args = this._updateLockFileCmdArgs(manifestDir);
|
|
295
|
-
this.#invokeCommand(args);
|
|
376
|
+
this.#invokeCommand(args, { cwd: manifestDir });
|
|
296
377
|
}
|
|
297
378
|
finally {
|
|
298
379
|
if (isWindows) {
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
/** @typedef {{name: string, version: string, children: string[]}} GraphEntry */
|
|
2
|
+
/** @typedef {{name: string, version: string, dependencies: DepTreeEntry[]}} DepTreeEntry */
|
|
3
|
+
/** @typedef {{directDeps: string[], graph: Map<string, GraphEntry>}} DependencyData */
|
|
4
|
+
/** @typedef {{ecosystem: string, content: string, contentType: string}} Provided */
|
|
5
|
+
export default class Base_pyproject {
|
|
6
|
+
/**
|
|
7
|
+
* @param {string} manifestName
|
|
8
|
+
* @returns {boolean}
|
|
9
|
+
*/
|
|
10
|
+
isSupported(manifestName: string): boolean;
|
|
11
|
+
/**
|
|
12
|
+
* @param {string} manifestDir
|
|
13
|
+
* @returns {boolean}
|
|
14
|
+
*/
|
|
15
|
+
validateLockFile(manifestDir: string): boolean;
|
|
16
|
+
/**
|
|
17
|
+
* Read project license from pyproject.toml, with fallback to LICENSE file.
|
|
18
|
+
* @param {string} manifestPath
|
|
19
|
+
* @returns {string|null}
|
|
20
|
+
*/
|
|
21
|
+
readLicenseFromManifest(manifestPath: string): string | null;
|
|
22
|
+
/**
|
|
23
|
+
* @param {string} manifest - path to pyproject.toml
|
|
24
|
+
* @param {Object} [opts={}]
|
|
25
|
+
* @returns {Promise<Provided>}
|
|
26
|
+
*/
|
|
27
|
+
provideStack(manifest: string, opts?: any): Promise<Provided>;
|
|
28
|
+
/**
|
|
29
|
+
* @param {string} manifest - path to pyproject.toml
|
|
30
|
+
* @param {Object} [opts={}]
|
|
31
|
+
* @returns {Promise<Provided>}
|
|
32
|
+
*/
|
|
33
|
+
provideComponent(manifest: string, opts?: any): Promise<Provided>;
|
|
34
|
+
/**
|
|
35
|
+
* @returns {string}
|
|
36
|
+
* @protected
|
|
37
|
+
*/
|
|
38
|
+
protected _lockFileName(): string;
|
|
39
|
+
/**
|
|
40
|
+
* @returns {string}
|
|
41
|
+
* @protected
|
|
42
|
+
*/
|
|
43
|
+
protected _cmdName(): string;
|
|
44
|
+
/**
|
|
45
|
+
* Resolve dependencies using the tool-specific command and parser.
|
|
46
|
+
* @param {string} manifestDir
|
|
47
|
+
* @param {object} parsed - parsed pyproject.toml
|
|
48
|
+
* @param {Object} opts
|
|
49
|
+
* @returns {Promise<DependencyData>}
|
|
50
|
+
* @protected
|
|
51
|
+
*/
|
|
52
|
+
protected _getDependencyData(manifestDir: string, parsed: object, opts: any): Promise<DependencyData>;
|
|
53
|
+
/**
|
|
54
|
+
* Canonicalize a Python package name per PEP 503.
|
|
55
|
+
* @param {string} name
|
|
56
|
+
* @returns {string}
|
|
57
|
+
* @protected
|
|
58
|
+
*/
|
|
59
|
+
protected _canonicalize(name: string): string;
|
|
60
|
+
/**
|
|
61
|
+
* Get the project name from pyproject.toml.
|
|
62
|
+
* @param {object} parsed
|
|
63
|
+
* @returns {string|null}
|
|
64
|
+
* @protected
|
|
65
|
+
*/
|
|
66
|
+
protected _getProjectName(parsed: object): string | null;
|
|
67
|
+
/**
|
|
68
|
+
* Get the project version from pyproject.toml.
|
|
69
|
+
* @param {object} parsed
|
|
70
|
+
* @returns {string|null}
|
|
71
|
+
* @protected
|
|
72
|
+
*/
|
|
73
|
+
protected _getProjectVersion(parsed: object): string | null;
|
|
74
|
+
/**
|
|
75
|
+
* Scan raw pyproject.toml text for dependencies with ignore markers.
|
|
76
|
+
* @param {string} manifestPath
|
|
77
|
+
* @returns {Set<string>}
|
|
78
|
+
* @protected
|
|
79
|
+
*/
|
|
80
|
+
protected _getIgnoredDeps(manifestPath: string): Set<string>;
|
|
81
|
+
/**
|
|
82
|
+
* Build dependency tree from graph, starting from direct deps.
|
|
83
|
+
* @param {Map<string, GraphEntry>} graph
|
|
84
|
+
* @param {string[]} directDeps - canonical names of direct deps
|
|
85
|
+
* @param {Set<string>} ignoredDeps
|
|
86
|
+
* @param {boolean} includeTransitive
|
|
87
|
+
* @returns {DepTreeEntry[]}
|
|
88
|
+
* @protected
|
|
89
|
+
*/
|
|
90
|
+
protected _buildDependencyTree(graph: Map<string, GraphEntry>, directDeps: string[], ignoredDeps: Set<string>, includeTransitive: boolean): DepTreeEntry[];
|
|
91
|
+
/**
|
|
92
|
+
* Recursively collect transitive dependencies.
|
|
93
|
+
* @param {Map<string, GraphEntry>} graph
|
|
94
|
+
* @param {string[]} childKeys
|
|
95
|
+
* @param {DepTreeEntry[]} result - mutated in place
|
|
96
|
+
* @param {Set<string>} ignoredDeps
|
|
97
|
+
* @param {Set<string>} visited
|
|
98
|
+
* @returns {void}
|
|
99
|
+
* @protected
|
|
100
|
+
*/
|
|
101
|
+
protected _collectTransitive(graph: Map<string, GraphEntry>, childKeys: string[], result: DepTreeEntry[], ignoredDeps: Set<string>, visited: Set<string>): void;
|
|
102
|
+
/**
|
|
103
|
+
* @param {string} name
|
|
104
|
+
* @param {string} version
|
|
105
|
+
* @returns {PackageURL}
|
|
106
|
+
* @protected
|
|
107
|
+
*/
|
|
108
|
+
protected _toPurl(name: string, version: string): PackageURL;
|
|
109
|
+
/**
|
|
110
|
+
* Recursively add a dependency and its transitive deps to the SBOM.
|
|
111
|
+
* @param {PackageURL} source
|
|
112
|
+
* @param {DepTreeEntry} dep
|
|
113
|
+
* @param {Sbom} sbom
|
|
114
|
+
* @returns {void}
|
|
115
|
+
* @private
|
|
116
|
+
*/
|
|
117
|
+
private _addAllDependencies;
|
|
118
|
+
/**
|
|
119
|
+
* Create SBOM json string for a pyproject.toml project.
|
|
120
|
+
* @param {string} manifest - path to pyproject.toml
|
|
121
|
+
* @param {Object} opts
|
|
122
|
+
* @param {boolean} includeTransitive
|
|
123
|
+
* @returns {Promise<string>}
|
|
124
|
+
* @private
|
|
125
|
+
*/
|
|
126
|
+
private _createSbom;
|
|
127
|
+
}
|
|
128
|
+
export type GraphEntry = {
|
|
129
|
+
name: string;
|
|
130
|
+
version: string;
|
|
131
|
+
children: string[];
|
|
132
|
+
};
|
|
133
|
+
export type DepTreeEntry = {
|
|
134
|
+
name: string;
|
|
135
|
+
version: string;
|
|
136
|
+
dependencies: DepTreeEntry[];
|
|
137
|
+
};
|
|
138
|
+
export type DependencyData = {
|
|
139
|
+
directDeps: string[];
|
|
140
|
+
graph: Map<string, GraphEntry>;
|
|
141
|
+
};
|
|
142
|
+
export type Provided = {
|
|
143
|
+
ecosystem: string;
|
|
144
|
+
content: string;
|
|
145
|
+
contentType: string;
|
|
146
|
+
};
|
|
147
|
+
import { PackageURL } from 'packageurl-js';
|