@trustify-da/trustify-da-javascript-client 0.3.0-ea.0e9ba23 → 0.3.0-ea.1b02307
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 +45 -9
- 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 +8 -4
- 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 +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 +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 +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-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
|
@@ -15,7 +15,10 @@ export default class Yarn_berry_processor extends Yarn_processor {
|
|
|
15
15
|
* @returns {string[]} Command arguments for listing dependencies
|
|
16
16
|
*/
|
|
17
17
|
listCmdArgs(includeTransitive) {
|
|
18
|
-
|
|
18
|
+
// --all is needed to include workspace members in the output
|
|
19
|
+
return includeTransitive
|
|
20
|
+
? ['info', '--recursive', '--all', '--json']
|
|
21
|
+
: ['info', '--all', '--json'];
|
|
19
22
|
}
|
|
20
23
|
/**
|
|
21
24
|
* Returns the command arguments for updating the lock file
|
|
@@ -48,13 +51,15 @@ export default class Yarn_berry_processor extends Yarn_processor {
|
|
|
48
51
|
if (!depTree) {
|
|
49
52
|
return new Map();
|
|
50
53
|
}
|
|
51
|
-
return new Map(depTree.filter(dep => !this.#isRoot(dep.value))
|
|
54
|
+
return new Map(depTree.filter(dep => !this.#isRoot(dep.value))
|
|
55
|
+
.map(dep => {
|
|
52
56
|
const depName = dep.value;
|
|
53
57
|
const idx = depName.lastIndexOf('@');
|
|
54
58
|
const name = depName.substring(0, idx);
|
|
55
59
|
const version = dep.children.Version;
|
|
56
60
|
return [name, toPurl(purlType, name, version)];
|
|
57
|
-
})
|
|
61
|
+
})
|
|
62
|
+
.filter(([name]) => this._manifest.dependencies.includes(name)));
|
|
58
63
|
}
|
|
59
64
|
/**
|
|
60
65
|
* Checks if a dependency is the root package
|
|
@@ -66,7 +71,8 @@ export default class Yarn_berry_processor extends Yarn_processor {
|
|
|
66
71
|
if (!name) {
|
|
67
72
|
return false;
|
|
68
73
|
}
|
|
69
|
-
|
|
74
|
+
// Workspace members use paths like "member-a@workspace:packages/member-a", not just "@workspace:."
|
|
75
|
+
return name.startsWith(`${this._manifest.name}@workspace:`);
|
|
70
76
|
}
|
|
71
77
|
/**
|
|
72
78
|
* Adds dependencies to the SBOM
|
|
@@ -77,14 +83,58 @@ export default class Yarn_berry_processor extends Yarn_processor {
|
|
|
77
83
|
if (!depTree) {
|
|
78
84
|
return;
|
|
79
85
|
}
|
|
86
|
+
// Build index of nodes by their value for quick lookup
|
|
87
|
+
const nodeIndex = new Map();
|
|
88
|
+
depTree.forEach(n => nodeIndex.set(n.value, n));
|
|
89
|
+
// Determine the set of node values reachable from root via production deps
|
|
90
|
+
const prodDeps = new Set(this._manifest.dependencies);
|
|
91
|
+
const reachable = new Set();
|
|
92
|
+
const queue = [];
|
|
93
|
+
// Seed with root's production dependencies
|
|
94
|
+
const rootNode = depTree.find(n => this.#isRoot(n.value));
|
|
95
|
+
if (rootNode?.children?.Dependencies) {
|
|
96
|
+
for (const d of rootNode.children.Dependencies) {
|
|
97
|
+
const to = this.#purlFromLocator(d.locator);
|
|
98
|
+
if (to) {
|
|
99
|
+
const fullName = to.namespace ? `${to.namespace}/${to.name}` : to.name;
|
|
100
|
+
if (prodDeps.has(fullName)) {
|
|
101
|
+
queue.push(d.locator);
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
// BFS to find all transitively reachable packages
|
|
107
|
+
while (queue.length > 0) {
|
|
108
|
+
const locator = queue.shift();
|
|
109
|
+
if (reachable.has(locator)) {
|
|
110
|
+
continue;
|
|
111
|
+
}
|
|
112
|
+
reachable.add(locator);
|
|
113
|
+
const node = nodeIndex.get(this.#nodeValueFromLocator(locator));
|
|
114
|
+
if (node?.children?.Dependencies) {
|
|
115
|
+
for (const d of node.children.Dependencies) {
|
|
116
|
+
if (!reachable.has(d.locator)) {
|
|
117
|
+
queue.push(d.locator);
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
// Only emit edges for root and reachable nodes
|
|
80
123
|
depTree.forEach(n => {
|
|
81
124
|
const depName = n.value;
|
|
82
|
-
const
|
|
125
|
+
const isRoot = this.#isRoot(depName);
|
|
126
|
+
if (!isRoot && !this.#isReachableNode(depName, reachable)) {
|
|
127
|
+
return;
|
|
128
|
+
}
|
|
129
|
+
const from = isRoot ? toPurlFromString(sbom.getRoot().purl) : this.#purlFromNode(depName, n);
|
|
83
130
|
const deps = n.children?.Dependencies;
|
|
84
131
|
if (!deps) {
|
|
85
132
|
return;
|
|
86
133
|
}
|
|
87
134
|
deps.forEach(d => {
|
|
135
|
+
if (!reachable.has(d.locator)) {
|
|
136
|
+
return;
|
|
137
|
+
}
|
|
88
138
|
const to = this.#purlFromLocator(d.locator);
|
|
89
139
|
if (to) {
|
|
90
140
|
sbom.addDependency(from, to);
|
|
@@ -92,6 +142,39 @@ export default class Yarn_berry_processor extends Yarn_processor {
|
|
|
92
142
|
});
|
|
93
143
|
});
|
|
94
144
|
}
|
|
145
|
+
/**
|
|
146
|
+
* Converts a locator to the node value format used in yarn info output
|
|
147
|
+
* @param {string} locator - e.g. "express@npm:4.17.1"
|
|
148
|
+
* @returns {string} The node value, same as locator for non-virtual
|
|
149
|
+
* @private
|
|
150
|
+
*/
|
|
151
|
+
#nodeValueFromLocator(locator) {
|
|
152
|
+
// Virtual locators: "@scope/name@virtual:hash#npm:version" → "@scope/name@npm:version"
|
|
153
|
+
const virtualMatch = Yarn_berry_processor.VIRTUAL_LOCATOR_PATTERN.exec(locator);
|
|
154
|
+
if (virtualMatch) {
|
|
155
|
+
return `${virtualMatch[1]}@npm:${virtualMatch[2]}`;
|
|
156
|
+
}
|
|
157
|
+
return locator;
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
* Checks if a node is in the reachable set by matching its value against reachable locators
|
|
161
|
+
* @param {string} depName - The node value (e.g. "express@npm:4.17.1")
|
|
162
|
+
* @param {Set<string>} reachable - Set of reachable locators
|
|
163
|
+
* @returns {boolean}
|
|
164
|
+
* @private
|
|
165
|
+
*/
|
|
166
|
+
#isReachableNode(depName, reachable) {
|
|
167
|
+
if (reachable.has(depName)) {
|
|
168
|
+
return true;
|
|
169
|
+
}
|
|
170
|
+
// Check if any reachable locator resolves to this node value
|
|
171
|
+
for (const locator of reachable) {
|
|
172
|
+
if (this.#nodeValueFromLocator(locator) === depName) {
|
|
173
|
+
return true;
|
|
174
|
+
}
|
|
175
|
+
}
|
|
176
|
+
return false;
|
|
177
|
+
}
|
|
95
178
|
/**
|
|
96
179
|
* Creates a PackageURL from a dependency locator
|
|
97
180
|
* @param {string} locator - The dependency locator
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/** @typedef {{name: string, version: string, dependencies: DependencyEntry[]}} DependencyEntry */
|
|
1
|
+
/** @typedef {{name: string, version: string, dependencies: DependencyEntry[], hashes?: Array<{alg: string, content: string}>}} DependencyEntry */
|
|
2
2
|
export default class Python_controller {
|
|
3
3
|
/**
|
|
4
4
|
* Constructor to create new python controller instance to interact with pip package manager
|
|
@@ -31,4 +31,8 @@ export type DependencyEntry = {
|
|
|
31
31
|
name: string;
|
|
32
32
|
version: string;
|
|
33
33
|
dependencies: DependencyEntry[];
|
|
34
|
+
hashes?: Array<{
|
|
35
|
+
alg: string;
|
|
36
|
+
content: string;
|
|
37
|
+
}>;
|
|
34
38
|
};
|
|
@@ -19,7 +19,54 @@ function getPipShowOutput(depNames) {
|
|
|
19
19
|
throw new Error('fail invoking \'pip show\' to fetch metadata for all installed packages in environment', { cause: error });
|
|
20
20
|
}
|
|
21
21
|
}
|
|
22
|
-
/**
|
|
22
|
+
/**
|
|
23
|
+
* Get pip inspect output from env var override or by invoking pip inspect.
|
|
24
|
+
* Returns null if pip inspect is unavailable (pip < 22.2) or if freeze/show
|
|
25
|
+
* env vars are set without an inspect override (to avoid inconsistent data).
|
|
26
|
+
* @return {string|null} pip inspect JSON output, or null on failure
|
|
27
|
+
*/
|
|
28
|
+
function getPipInspectOutput() {
|
|
29
|
+
if (environmentVariableIsPopulated("TRUSTIFY_DA_PIP_INSPECT")) {
|
|
30
|
+
return new Buffer.from(process.env["TRUSTIFY_DA_PIP_INSPECT"], 'base64').toString('ascii');
|
|
31
|
+
}
|
|
32
|
+
if (environmentVariableIsPopulated("TRUSTIFY_DA_PIP_FREEZE") || environmentVariableIsPopulated("TRUSTIFY_DA_PIP_SHOW")) {
|
|
33
|
+
return null;
|
|
34
|
+
}
|
|
35
|
+
try {
|
|
36
|
+
return invokeCommand(this.pathToPipBin, ['inspect']).toString();
|
|
37
|
+
}
|
|
38
|
+
catch (error) {
|
|
39
|
+
console.warn('pip inspect is not available (requires pip 22.2+), SBOM will be generated without hashes');
|
|
40
|
+
return null;
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Parse pip inspect JSON output and build a hash lookup map.
|
|
45
|
+
* @param {string|null} inspectOutput - raw pip inspect JSON string
|
|
46
|
+
* @return {Map<string, Array<{alg: string, content: string}>>} map of lowercase package name to hashes
|
|
47
|
+
*/
|
|
48
|
+
function parsePipInspectHashes(inspectOutput) {
|
|
49
|
+
if (!inspectOutput) {
|
|
50
|
+
return new Map();
|
|
51
|
+
}
|
|
52
|
+
try {
|
|
53
|
+
let inspectData = JSON.parse(inspectOutput);
|
|
54
|
+
let hashMap = new Map();
|
|
55
|
+
for (let pkg of (inspectData.installed || [])) {
|
|
56
|
+
let name = pkg.metadata?.name;
|
|
57
|
+
let sha256 = pkg.download_info?.archive_info?.hashes?.sha256;
|
|
58
|
+
if (name && sha256) {
|
|
59
|
+
hashMap.set(name.toLowerCase(), [{ alg: "SHA-256", content: sha256 }]);
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
return hashMap;
|
|
63
|
+
}
|
|
64
|
+
catch (error) {
|
|
65
|
+
console.warn('Failed to parse pip inspect output, SBOM will be generated without hashes');
|
|
66
|
+
return new Map();
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
/** @typedef {{name: string, version: string, dependencies: DependencyEntry[], hashes?: Array<{alg: string, content: string}>}} DependencyEntry */
|
|
23
70
|
export default class Python_controller {
|
|
24
71
|
pythonEnvDir;
|
|
25
72
|
pathToPipBin;
|
|
@@ -95,7 +142,7 @@ export default class Python_controller {
|
|
|
95
142
|
}
|
|
96
143
|
/**
|
|
97
144
|
* Parse the requirements.txt file using tree-sitter and return structured requirement data.
|
|
98
|
-
* @return {Promise<{name: string, version: string|null}[]>}
|
|
145
|
+
* @return {Promise<{name: string, version: string|null, hasMarker: boolean}[]>}
|
|
99
146
|
*/
|
|
100
147
|
async #parseRequirements() {
|
|
101
148
|
const content = fs.readFileSync(this.pathToRequirements).toString();
|
|
@@ -107,7 +154,8 @@ export default class Python_controller {
|
|
|
107
154
|
const version = versionMatches.length > 0
|
|
108
155
|
? versionMatches[0].captures.find(c => c.name === 'version').node.text
|
|
109
156
|
: null;
|
|
110
|
-
|
|
157
|
+
const hasMarker = reqNode.children.some(c => c.type === 'marker_spec');
|
|
158
|
+
return { name, version, hasMarker };
|
|
111
159
|
}));
|
|
112
160
|
}
|
|
113
161
|
#decideIfWindowsOrLinuxPath(fileName) {
|
|
@@ -224,7 +272,12 @@ export default class Python_controller {
|
|
|
224
272
|
CachedEnvironmentDeps[packageName.replace("_", "-")] = pipDepTreeEntryForCache;
|
|
225
273
|
});
|
|
226
274
|
}
|
|
227
|
-
|
|
275
|
+
const inspectOutput = getPipInspectOutput.call(this);
|
|
276
|
+
const hashMap = parsePipInspectHashes(inspectOutput);
|
|
277
|
+
parsedRequirements.forEach(({ name: depName, version: manifestVersion, hasMarker }) => {
|
|
278
|
+
if (hasMarker && CachedEnvironmentDeps[depName.toLowerCase()] === undefined) {
|
|
279
|
+
return;
|
|
280
|
+
}
|
|
228
281
|
if (matchManifestVersions === "true" && manifestVersion != null) {
|
|
229
282
|
let installedVersion;
|
|
230
283
|
if (CachedEnvironmentDeps[depName.toLowerCase()] !== undefined) {
|
|
@@ -243,7 +296,7 @@ export default class Python_controller {
|
|
|
243
296
|
}
|
|
244
297
|
let path = [];
|
|
245
298
|
path.push(depName.toLowerCase());
|
|
246
|
-
bringAllDependencies(dependencies, depName, CachedEnvironmentDeps, includeTransitive, path, usePipDepTree);
|
|
299
|
+
bringAllDependencies(dependencies, depName, CachedEnvironmentDeps, includeTransitive, path, usePipDepTree, hashMap);
|
|
247
300
|
});
|
|
248
301
|
dependencies.sort((dep1, dep2) => {
|
|
249
302
|
const DEP1 = dep1.name.toLowerCase();
|
|
@@ -323,8 +376,9 @@ function getDepsList(record) {
|
|
|
323
376
|
* @param includeTransitive
|
|
324
377
|
* @param usePipDepTree
|
|
325
378
|
* @param {[string]}path array representing the path of the current branch in dependency tree, starting with a root dependency - that is - a given dependency in requirements.txt
|
|
379
|
+
* @param {Map<string, Array<{alg: string, content: string}>>} hashMap - map of lowercase package name to hashes
|
|
326
380
|
*/
|
|
327
|
-
function bringAllDependencies(dependencies, dependencyName, cachedEnvironmentDeps, includeTransitive, path, usePipDepTree) {
|
|
381
|
+
function bringAllDependencies(dependencies, dependencyName, cachedEnvironmentDeps, includeTransitive, path, usePipDepTree, hashMap) {
|
|
328
382
|
if (dependencyName?.trim() === "") {
|
|
329
383
|
return;
|
|
330
384
|
}
|
|
@@ -346,7 +400,11 @@ function bringAllDependencies(dependencies, dependencyName, cachedEnvironmentDep
|
|
|
346
400
|
directDeps = record.dependencies;
|
|
347
401
|
}
|
|
348
402
|
let targetDeps = [];
|
|
403
|
+
let hashes = hashMap?.get(depName.toLowerCase());
|
|
349
404
|
let entry = { "name": depName, "version": version, "dependencies": [] };
|
|
405
|
+
if (hashes) {
|
|
406
|
+
entry.hashes = hashes;
|
|
407
|
+
}
|
|
350
408
|
dependencies.push(entry);
|
|
351
409
|
directDeps.forEach((dep) => {
|
|
352
410
|
let depArray = [];
|
|
@@ -356,7 +414,7 @@ function bringAllDependencies(dependencies, dependencyName, cachedEnvironmentDep
|
|
|
356
414
|
depArray.push(dep.toLowerCase());
|
|
357
415
|
if (includeTransitive) {
|
|
358
416
|
// send to recurrsion the array of all deps in path + the current dependency name which is not on the path.
|
|
359
|
-
bringAllDependencies(targetDeps, dep, cachedEnvironmentDeps, includeTransitive, path.concat(depArray), usePipDepTree);
|
|
417
|
+
bringAllDependencies(targetDeps, dep, cachedEnvironmentDeps, includeTransitive, path.concat(depArray), usePipDepTree, hashMap);
|
|
360
418
|
}
|
|
361
419
|
}
|
|
362
420
|
// sort ra
|
|
@@ -4,12 +4,17 @@ declare namespace _default {
|
|
|
4
4
|
export { provideComponent };
|
|
5
5
|
export { provideStack };
|
|
6
6
|
export { readLicenseFromManifest };
|
|
7
|
+
export function packageManagerName(): string;
|
|
7
8
|
}
|
|
8
9
|
export default _default;
|
|
9
10
|
export type DependencyEntry = {
|
|
10
11
|
name: string;
|
|
11
12
|
version: string;
|
|
12
13
|
dependencies: DependencyEntry[];
|
|
14
|
+
hashes?: Array<{
|
|
15
|
+
alg: string;
|
|
16
|
+
content: string;
|
|
17
|
+
}>;
|
|
13
18
|
};
|
|
14
19
|
/**
|
|
15
20
|
* @param {string} manifestName - the subject manifest name-type
|
|
@@ -1,16 +1,18 @@
|
|
|
1
1
|
import fs from 'node:fs';
|
|
2
2
|
import { PackageURL } from 'packageurl-js';
|
|
3
|
+
import { readLicenseFile } from '../license/license_utils.js';
|
|
3
4
|
import Sbom from '../sbom.js';
|
|
4
5
|
import { environmentVariableIsPopulated, getCustom, getCustomPath, invokeCommand } from "../tools.js";
|
|
5
6
|
import Python_controller from './python_controller.js';
|
|
6
7
|
import { getParser, getIgnoreQuery, getPinnedVersionQuery } from './requirements_parser.js';
|
|
7
|
-
export default { isSupported, validateLockFile, provideComponent, provideStack, readLicenseFromManifest };
|
|
8
|
-
/** @typedef {{name: string, version: string, dependencies: DependencyEntry[]}} DependencyEntry */
|
|
8
|
+
export default { isSupported, validateLockFile, provideComponent, provideStack, readLicenseFromManifest, packageManagerName() { return 'pip'; } };
|
|
9
|
+
/** @typedef {{name: string, version: string, dependencies: DependencyEntry[], hashes?: Array<{alg: string, content: string}>}} DependencyEntry */
|
|
9
10
|
/**
|
|
10
11
|
* @type {string} ecosystem for python-pip is 'pip'
|
|
11
12
|
* @private
|
|
12
13
|
*/
|
|
13
14
|
const ecosystem = 'pip';
|
|
15
|
+
const NO_SCOPE = undefined;
|
|
14
16
|
/**
|
|
15
17
|
* @param {string} manifestName - the subject manifest name-type
|
|
16
18
|
* @returns {boolean} - return true if `requirements.txt` is the manifest name-type
|
|
@@ -24,7 +26,7 @@ function isSupported(manifestName) {
|
|
|
24
26
|
* @returns {string|null}
|
|
25
27
|
*/
|
|
26
28
|
// eslint-disable-next-line no-unused-vars
|
|
27
|
-
function readLicenseFromManifest(manifestPath) { return
|
|
29
|
+
function readLicenseFromManifest(manifestPath) { return readLicenseFile(manifestPath); }
|
|
28
30
|
/**
|
|
29
31
|
* @param {string} manifestDir - the directory where the manifest lies
|
|
30
32
|
*/
|
|
@@ -55,7 +57,6 @@ async function provideComponent(manifest, opts = {}) {
|
|
|
55
57
|
contentType: 'application/vnd.cyclonedx+json'
|
|
56
58
|
};
|
|
57
59
|
}
|
|
58
|
-
/** @typedef {{name: string, , version: string, dependencies: DependencyEntry[]}} DependencyEntry */
|
|
59
60
|
/**
|
|
60
61
|
*
|
|
61
62
|
* @param {PackageURL}source
|
|
@@ -65,7 +66,7 @@ async function provideComponent(manifest, opts = {}) {
|
|
|
65
66
|
*/
|
|
66
67
|
function addAllDependencies(source, dep, sbom) {
|
|
67
68
|
let targetPurl = toPurl(dep["name"], dep["version"]);
|
|
68
|
-
sbom.addDependency(source, targetPurl);
|
|
69
|
+
sbom.addDependency(source, targetPurl, NO_SCOPE, dep["hashes"]);
|
|
69
70
|
let directDeps = dep["dependencies"];
|
|
70
71
|
if (directDeps !== undefined && directDeps.length > 0) {
|
|
71
72
|
directDeps.forEach((dependency) => { addAllDependencies(toPurl(dep["name"], dep["version"]), dependency, sbom); });
|
|
@@ -74,7 +75,7 @@ function addAllDependencies(source, dep, sbom) {
|
|
|
74
75
|
/**
|
|
75
76
|
*
|
|
76
77
|
* @param {string} manifest - path to requirements.txt
|
|
77
|
-
* @return {PackageURL
|
|
78
|
+
* @return {Promise<PackageURL[]>}
|
|
78
79
|
*/
|
|
79
80
|
async function getIgnoredDependencies(manifest) {
|
|
80
81
|
const [parser, ignoreQuery, pinnedVersionQuery] = await Promise.all([
|
|
@@ -201,7 +202,7 @@ async function getSbomForComponentAnalysis(manifest, opts = {}) {
|
|
|
201
202
|
const license = readLicenseFromManifest(manifest);
|
|
202
203
|
sbom.addRoot(rootPurl, license);
|
|
203
204
|
dependencies.forEach(dep => {
|
|
204
|
-
sbom.addDependency(rootPurl, toPurl(dep.name, dep.version));
|
|
205
|
+
sbom.addDependency(rootPurl, toPurl(dep.name, dep.version), NO_SCOPE, dep.hashes);
|
|
205
206
|
});
|
|
206
207
|
await handleIgnoredDependencies(manifest, sbom, opts);
|
|
207
208
|
// In python there is no root component, then we must remove the dummy root we added, so the sbom json will be accepted by the DA backend
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Python provider for pyproject.toml files using PEP 621 format without a lock file.
|
|
3
|
+
* Uses `pip install --dry-run --ignore-installed --report` to resolve the full dependency tree.
|
|
4
|
+
* Acts as the fallback provider when no lock file (uv.lock/poetry.lock) is found.
|
|
5
|
+
*/
|
|
6
|
+
export default class Python_pip_pyproject extends Base_pyproject {
|
|
7
|
+
/**
|
|
8
|
+
* Always returns true — pip provider is the fallback when no lock file is found.
|
|
9
|
+
* @param {string} manifestDir
|
|
10
|
+
* @param {{}} [opts={}]
|
|
11
|
+
* @returns {boolean}
|
|
12
|
+
*/
|
|
13
|
+
validateLockFile(manifestDir: string, opts?: {}): boolean;
|
|
14
|
+
/**
|
|
15
|
+
* Get pip report output from env var override or by running pip.
|
|
16
|
+
* @param {string} manifestDir - directory containing pyproject.toml
|
|
17
|
+
* @param {{}} [opts={}]
|
|
18
|
+
* @returns {string} pip report JSON string
|
|
19
|
+
*/
|
|
20
|
+
_getPipReportOutput(manifestDir: string, opts?: {}): string;
|
|
21
|
+
/**
|
|
22
|
+
* Parse pip report JSON and build dependency graph.
|
|
23
|
+
* @param {string} reportJson - pip report JSON string
|
|
24
|
+
* @returns {{directDeps: string[], graph: Map<string, {name: string, version: string, children: string[]}>}}
|
|
25
|
+
*/
|
|
26
|
+
_parsePipReport(reportJson: string): {
|
|
27
|
+
directDeps: string[];
|
|
28
|
+
graph: Map<string, {
|
|
29
|
+
name: string;
|
|
30
|
+
version: string;
|
|
31
|
+
children: string[];
|
|
32
|
+
}>;
|
|
33
|
+
};
|
|
34
|
+
/**
|
|
35
|
+
* Check if a requires_dist entry is an extras-only dependency.
|
|
36
|
+
* @param {string} req - e.g. "PySocks!=1.5.7,>=1.5.6; extra == \"socks\""
|
|
37
|
+
* @returns {boolean}
|
|
38
|
+
*/
|
|
39
|
+
_hasExtraMarker(req: string): boolean;
|
|
40
|
+
/**
|
|
41
|
+
* Extract package name from a requires_dist entry.
|
|
42
|
+
* @param {string} req - e.g. "charset_normalizer<4,>=2"
|
|
43
|
+
* @returns {string|null}
|
|
44
|
+
*/
|
|
45
|
+
_extractDepName(req: string): string | null;
|
|
46
|
+
/**
|
|
47
|
+
* Resolve dependencies using pip install --dry-run --report.
|
|
48
|
+
* @param {string} manifestDir
|
|
49
|
+
* @param {string} _workspaceDir - unused (pip resolves from manifest directory)
|
|
50
|
+
* @param {object} parsed - parsed pyproject.toml
|
|
51
|
+
* @param {{}} [opts={}]
|
|
52
|
+
* @returns {Promise<{directDeps: string[], graph: Map}>}
|
|
53
|
+
*/
|
|
54
|
+
_getDependencyData(manifestDir: string, _workspaceDir: string, parsed: object, opts?: {}): Promise<{
|
|
55
|
+
directDeps: string[];
|
|
56
|
+
graph: Map<any, any>;
|
|
57
|
+
}>;
|
|
58
|
+
_findEggInfoDirs(dir: any): string[];
|
|
59
|
+
_cleanupEggInfo(dir: any, existing: any): void;
|
|
60
|
+
}
|
|
61
|
+
import Base_pyproject from './base_pyproject.js';
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
import fs from 'node:fs';
|
|
2
|
+
import path from 'node:path';
|
|
3
|
+
import { environmentVariableIsPopulated, getCustomPath, invokeCommand } from '../tools.js';
|
|
4
|
+
import Base_pyproject from './base_pyproject.js';
|
|
5
|
+
/**
|
|
6
|
+
* Python provider for pyproject.toml files using PEP 621 format without a lock file.
|
|
7
|
+
* Uses `pip install --dry-run --ignore-installed --report` to resolve the full dependency tree.
|
|
8
|
+
* Acts as the fallback provider when no lock file (uv.lock/poetry.lock) is found.
|
|
9
|
+
*/
|
|
10
|
+
export default class Python_pip_pyproject extends Base_pyproject {
|
|
11
|
+
/** @returns {string} */
|
|
12
|
+
_lockFileName() {
|
|
13
|
+
return '.pip-lock-nonexistent';
|
|
14
|
+
}
|
|
15
|
+
/** @returns {string} */
|
|
16
|
+
_cmdName() {
|
|
17
|
+
return 'pip';
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Always returns true — pip provider is the fallback when no lock file is found.
|
|
21
|
+
* @param {string} manifestDir
|
|
22
|
+
* @param {{}} [opts={}]
|
|
23
|
+
* @returns {boolean}
|
|
24
|
+
*/
|
|
25
|
+
// eslint-disable-next-line no-unused-vars
|
|
26
|
+
validateLockFile(manifestDir, opts = {}) {
|
|
27
|
+
return true;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Get pip report output from env var override or by running pip.
|
|
31
|
+
* @param {string} manifestDir - directory containing pyproject.toml
|
|
32
|
+
* @param {{}} [opts={}]
|
|
33
|
+
* @returns {string} pip report JSON string
|
|
34
|
+
*/
|
|
35
|
+
_getPipReportOutput(manifestDir, opts) {
|
|
36
|
+
if (environmentVariableIsPopulated('TRUSTIFY_DA_PIP_REPORT')) {
|
|
37
|
+
return Buffer.from(process.env['TRUSTIFY_DA_PIP_REPORT'], 'base64').toString('ascii');
|
|
38
|
+
}
|
|
39
|
+
let pipBin = getCustomPath('pip3', opts);
|
|
40
|
+
try {
|
|
41
|
+
invokeCommand(pipBin, ['--version']);
|
|
42
|
+
}
|
|
43
|
+
catch {
|
|
44
|
+
pipBin = getCustomPath('pip', opts);
|
|
45
|
+
}
|
|
46
|
+
let eggInfoDirs = this._findEggInfoDirs(manifestDir);
|
|
47
|
+
let result = invokeCommand(pipBin, [
|
|
48
|
+
'install', '--dry-run', '--ignore-installed', '--quiet', '--report', '-', '.'
|
|
49
|
+
], { cwd: manifestDir }).toString();
|
|
50
|
+
this._cleanupEggInfo(manifestDir, eggInfoDirs);
|
|
51
|
+
return result;
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Parse pip report JSON and build dependency graph.
|
|
55
|
+
* @param {string} reportJson - pip report JSON string
|
|
56
|
+
* @returns {{directDeps: string[], graph: Map<string, {name: string, version: string, children: string[]}>}}
|
|
57
|
+
*/
|
|
58
|
+
_parsePipReport(reportJson) {
|
|
59
|
+
let report = JSON.parse(reportJson);
|
|
60
|
+
let packages = report.install || [];
|
|
61
|
+
let rootEntry = packages.find(p => p.download_info?.dir_info !== undefined);
|
|
62
|
+
let rootRequires = rootEntry?.metadata?.requires_dist || [];
|
|
63
|
+
let directDepNames = new Set();
|
|
64
|
+
for (let req of rootRequires) {
|
|
65
|
+
if (this._hasExtraMarker(req)) {
|
|
66
|
+
continue;
|
|
67
|
+
}
|
|
68
|
+
let name = this._extractDepName(req);
|
|
69
|
+
if (name) {
|
|
70
|
+
directDepNames.add(this._canonicalize(name));
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
let graph = new Map();
|
|
74
|
+
let nonRootPackages = packages.filter(p => p !== rootEntry);
|
|
75
|
+
for (let pkg of nonRootPackages) {
|
|
76
|
+
let name = pkg.metadata.name;
|
|
77
|
+
let version = pkg.metadata.version;
|
|
78
|
+
let key = this._canonicalize(name);
|
|
79
|
+
let sha256 = pkg.download_info?.archive_info?.hashes?.sha256;
|
|
80
|
+
let hashes = sha256 ? [{ alg: "SHA-256", content: sha256 }] : undefined;
|
|
81
|
+
graph.set(key, { name, version, children: [], hashes });
|
|
82
|
+
}
|
|
83
|
+
for (let pkg of nonRootPackages) {
|
|
84
|
+
let key = this._canonicalize(pkg.metadata.name);
|
|
85
|
+
let entry = graph.get(key);
|
|
86
|
+
let requires = pkg.metadata.requires_dist || [];
|
|
87
|
+
for (let req of requires) {
|
|
88
|
+
let depName = this._extractDepName(req);
|
|
89
|
+
if (!depName) {
|
|
90
|
+
continue;
|
|
91
|
+
}
|
|
92
|
+
let depKey = this._canonicalize(depName);
|
|
93
|
+
if (graph.has(depKey)) {
|
|
94
|
+
entry.children.push(depKey);
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
let directDeps = [...directDepNames].filter(key => graph.has(key));
|
|
99
|
+
return { directDeps, graph };
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* Check if a requires_dist entry is an extras-only dependency.
|
|
103
|
+
* @param {string} req - e.g. "PySocks!=1.5.7,>=1.5.6; extra == \"socks\""
|
|
104
|
+
* @returns {boolean}
|
|
105
|
+
*/
|
|
106
|
+
_hasExtraMarker(req) {
|
|
107
|
+
return /;\s*.*extra\s*==/.test(req);
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* Extract package name from a requires_dist entry.
|
|
111
|
+
* @param {string} req - e.g. "charset_normalizer<4,>=2"
|
|
112
|
+
* @returns {string|null}
|
|
113
|
+
*/
|
|
114
|
+
_extractDepName(req) {
|
|
115
|
+
let match = req.match(/^([A-Za-z0-9]([A-Za-z0-9._-]*[A-Za-z0-9])?)/);
|
|
116
|
+
return match ? match[1] : null;
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* Resolve dependencies using pip install --dry-run --report.
|
|
120
|
+
* @param {string} manifestDir
|
|
121
|
+
* @param {string} _workspaceDir - unused (pip resolves from manifest directory)
|
|
122
|
+
* @param {object} parsed - parsed pyproject.toml
|
|
123
|
+
* @param {{}} [opts={}]
|
|
124
|
+
* @returns {Promise<{directDeps: string[], graph: Map}>}
|
|
125
|
+
*/
|
|
126
|
+
// eslint-disable-next-line no-unused-vars
|
|
127
|
+
async _getDependencyData(manifestDir, _workspaceDir, parsed, opts) {
|
|
128
|
+
let reportOutput = this._getPipReportOutput(manifestDir, opts);
|
|
129
|
+
return this._parsePipReport(reportOutput);
|
|
130
|
+
}
|
|
131
|
+
_findEggInfoDirs(dir) {
|
|
132
|
+
try {
|
|
133
|
+
return fs.readdirSync(dir).filter(f => f.endsWith('.egg-info'));
|
|
134
|
+
}
|
|
135
|
+
catch {
|
|
136
|
+
return [];
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
_cleanupEggInfo(dir, existing) {
|
|
140
|
+
for (let entry of this._findEggInfoDirs(dir)) {
|
|
141
|
+
if (!existing.includes(entry)) {
|
|
142
|
+
fs.rmSync(path.join(dir, entry), { recursive: true, force: true });
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
}
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
export default class Python_poetry extends Base_pyproject {
|
|
2
|
+
/**
|
|
3
|
+
* @param {string} manifestDir
|
|
4
|
+
* @param {string} _workspaceDir - unused (poetry has no workspace support)
|
|
5
|
+
* @param {object} parsed - parsed pyproject.toml
|
|
6
|
+
* @param {Object} opts
|
|
7
|
+
* @returns {Promise<{directDeps: string[], graph: Map<string, {name: string, version: string, children: string[]}>}>}
|
|
8
|
+
*/
|
|
9
|
+
_getDependencyData(manifestDir: string, _workspaceDir: string, parsed: object, opts: any): Promise<{
|
|
10
|
+
directDeps: string[];
|
|
11
|
+
graph: Map<string, {
|
|
12
|
+
name: string;
|
|
13
|
+
version: string;
|
|
14
|
+
children: string[];
|
|
15
|
+
}>;
|
|
16
|
+
}>;
|
|
17
|
+
/**
|
|
18
|
+
* Get poetry show --tree output.
|
|
19
|
+
* @param {string} manifestDir
|
|
20
|
+
* @param {boolean} hasDevGroup
|
|
21
|
+
* @param {Object} opts
|
|
22
|
+
* @returns {string}
|
|
23
|
+
*/
|
|
24
|
+
_getPoetryShowTreeOutput(manifestDir: string, hasDevGroup: boolean, opts: any): string;
|
|
25
|
+
/**
|
|
26
|
+
* Get poetry show --all output (flat list with resolved versions).
|
|
27
|
+
* @param {string} manifestDir
|
|
28
|
+
* @param {Object} opts
|
|
29
|
+
* @returns {string}
|
|
30
|
+
*/
|
|
31
|
+
_getPoetryShowAllOutput(manifestDir: string, opts: any): string;
|
|
32
|
+
/**
|
|
33
|
+
* Parse poetry show --all output into a version map.
|
|
34
|
+
* Lines look like: "name (!) 1.2.3 Description text..."
|
|
35
|
+
* or: "name 1.2.3 Description text..."
|
|
36
|
+
* @param {string} output
|
|
37
|
+
* @returns {Map<string, string>} canonical name -> version
|
|
38
|
+
*/
|
|
39
|
+
_parsePoetryShowAll(output: string): Map<string, string>;
|
|
40
|
+
/**
|
|
41
|
+
* Collects PEP 508 marker expressions for direct and transitive deps.
|
|
42
|
+
* Direct markers come from pyproject.toml dependency strings, e.g.:
|
|
43
|
+
* "pywin32>=311 ; sys_platform == 'win32'" → directMarkers['pywin32'] = "sys_platform == 'win32'"
|
|
44
|
+
* Transitive markers come from poetry.lock [package.dependencies] entries, e.g.:
|
|
45
|
+
* colorama = {version = "*", markers = "sys_platform == 'win32'"}
|
|
46
|
+
* → transitiveMarkers['click']['colorama'] = "sys_platform == 'win32'"
|
|
47
|
+
* @param {string|null} lockDir
|
|
48
|
+
* @param {object} parsed - parsed pyproject.toml
|
|
49
|
+
* @returns {{directMarkers: Map<string, string>, transitiveMarkers: Map<string, Map<string, string>>}}
|
|
50
|
+
*/
|
|
51
|
+
_extractMarkerData(lockDir: string | null, parsed: object): {
|
|
52
|
+
directMarkers: Map<string, string>;
|
|
53
|
+
transitiveMarkers: Map<string, Map<string, string>>;
|
|
54
|
+
};
|
|
55
|
+
/**
|
|
56
|
+
* Parse poetry show --tree output into a dependency graph structure.
|
|
57
|
+
*
|
|
58
|
+
* @param {string} treeOutput
|
|
59
|
+
* @param {Map<string, string>} versionMap - canonical name -> resolved version
|
|
60
|
+
* @param {{directMarkers: Map<string, string>, transitiveMarkers: Map<string, Map<string, string>>}} markerData
|
|
61
|
+
* @returns {{directDeps: string[], graph: Map<string, {name: string, version: string, children: string[]}>}}
|
|
62
|
+
*/
|
|
63
|
+
_parsePoetryTree(treeOutput: string, versionMap: Map<string, string>, markerData: {
|
|
64
|
+
directMarkers: Map<string, string>;
|
|
65
|
+
transitiveMarkers: Map<string, Map<string, string>>;
|
|
66
|
+
}): {
|
|
67
|
+
directDeps: string[];
|
|
68
|
+
graph: Map<string, {
|
|
69
|
+
name: string;
|
|
70
|
+
version: string;
|
|
71
|
+
children: string[];
|
|
72
|
+
}>;
|
|
73
|
+
};
|
|
74
|
+
}
|
|
75
|
+
import Base_pyproject from './base_pyproject.js';
|