@trustify-da/trustify-da-javascript-client 0.3.0-ea.3aa2054 → 0.3.0-ea.41ca049
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 +199 -11
- package/dist/package.json +30 -26
- package/dist/src/analysis.d.ts +50 -22
- package/dist/src/analysis.js +70 -18
- package/dist/src/cli.js +188 -6
- package/dist/src/config.d.ts +120 -0
- package/dist/src/config.js +260 -0
- package/dist/src/cyclone_dx_sbom.d.ts +20 -1
- package/dist/src/cyclone_dx_sbom.js +68 -9
- package/dist/src/index.d.ts +85 -21
- package/dist/src/index.js +96 -40
- package/dist/src/license/index.d.ts +4 -4
- package/dist/src/license/index.js +13 -7
- package/dist/src/license/license_utils.js +4 -1
- package/dist/src/license/licenses_api.d.ts +3 -3
- package/dist/src/license/licenses_api.js +1 -1
- package/dist/src/oci_image/images.d.ts +1 -1
- package/dist/src/oci_image/images.js +15 -1
- package/dist/src/oci_image/utils.d.ts +5 -5
- package/dist/src/package_version.d.ts +8 -0
- package/dist/src/package_version.js +31 -0
- package/dist/src/provider.d.ts +4 -3
- package/dist/src/provider.js +8 -2
- package/dist/src/providers/base_java.d.ts +67 -12
- package/dist/src/providers/base_java.js +82 -61
- package/dist/src/providers/base_javascript.d.ts +74 -9
- package/dist/src/providers/base_javascript.js +116 -7
- package/dist/src/providers/base_pyproject.d.ts +19 -31
- package/dist/src/providers/base_pyproject.js +57 -73
- package/dist/src/providers/containerfile_parser.d.ts +5 -0
- package/dist/src/providers/containerfile_parser.js +20 -0
- package/dist/src/providers/golang_gomodules.d.ts +11 -1
- package/dist/src/providers/golang_gomodules.js +114 -15
- package/dist/src/providers/java_gradle.d.ts +67 -0
- package/dist/src/providers/java_gradle.js +312 -20
- package/dist/src/providers/java_gradle_groovy.d.ts +1 -1
- package/dist/src/providers/java_gradle_kotlin.d.ts +1 -1
- package/dist/src/providers/java_maven.d.ts +37 -9
- package/dist/src/providers/java_maven.js +269 -11
- package/dist/src/providers/javascript_bun.d.ts +22 -0
- package/dist/src/providers/javascript_bun.js +141 -0
- package/dist/src/providers/javascript_npm.d.ts +19 -0
- package/dist/src/providers/javascript_npm.js +61 -1
- package/dist/src/providers/javascript_pnpm.d.ts +13 -0
- package/dist/src/providers/javascript_pnpm.js +53 -3
- package/dist/src/providers/javascript_yarn.d.ts +12 -0
- package/dist/src/providers/javascript_yarn.js +75 -2
- package/dist/src/providers/manifest.js +6 -3
- package/dist/src/providers/marker_evaluator.d.ts +14 -0
- package/dist/src/providers/marker_evaluator.js +191 -0
- package/dist/src/providers/oci_dockerfile.d.ts +51 -0
- package/dist/src/providers/oci_dockerfile.js +177 -0
- package/dist/src/providers/processors/yarn_berry_processor.d.ts +6 -2
- package/dist/src/providers/processors/yarn_berry_processor.js +9 -4
- package/dist/src/providers/processors/yarn_classic_processor.d.ts +6 -2
- package/dist/src/providers/processors/yarn_classic_processor.js +8 -6
- package/dist/src/providers/python_controller.d.ts +5 -1
- package/dist/src/providers/python_controller.js +69 -8
- package/dist/src/providers/python_pip.d.ts +5 -0
- package/dist/src/providers/python_pip.js +5 -5
- 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 +64 -8
- package/dist/src/providers/python_poetry.js +139 -22
- package/dist/src/providers/python_uv.d.ts +20 -1
- package/dist/src/providers/python_uv.js +126 -3
- package/dist/src/providers/requirements_parser.js +1 -1
- package/dist/src/providers/rust_cargo.d.ts +6 -2
- package/dist/src/providers/rust_cargo.js +101 -33
- package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
- package/dist/src/remediate.d.ts +120 -0
- package/dist/src/remediate.js +253 -0
- package/dist/src/remediation.d.ts +58 -0
- package/dist/src/remediation.js +425 -0
- package/dist/src/remediation_report.d.ts +40 -0
- package/dist/src/remediation_report.js +159 -0
- package/dist/src/sbom.d.ts +18 -1
- package/dist/src/sbom.js +14 -2
- package/dist/src/tools.d.ts +37 -13
- package/dist/src/tools.js +92 -13
- package/dist/src/updaters/maven_updater.d.ts +58 -0
- package/dist/src/updaters/maven_updater.js +345 -0
- package/dist/src/updaters/toml_updater.d.ts +62 -0
- package/dist/src/updaters/toml_updater.js +276 -0
- package/dist/src/workspace.d.ts +11 -1
- package/dist/src/workspace.js +3 -2
- package/package.json +31 -27
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/** @typedef {{name: string, version: string, children: string[]}} GraphEntry */
|
|
1
|
+
/** @typedef {{name: string, version: string, children: string[], hashes?: Array<{alg: string, content: string}>}} GraphEntry */
|
|
2
2
|
/** @typedef {{name: string, version: string, dependencies: DepTreeEntry[]}} DepTreeEntry */
|
|
3
3
|
/** @typedef {{directDeps: string[], graph: Map<string, GraphEntry>}} DependencyData */
|
|
4
4
|
/** @typedef {{ecosystem: string, content: string, contentType: string}} Provided */
|
|
@@ -13,7 +13,7 @@ export default class Base_pyproject {
|
|
|
13
13
|
* @param {Object} [opts={}]
|
|
14
14
|
* @returns {boolean}
|
|
15
15
|
*/
|
|
16
|
-
validateLockFile(manifestDir: string, opts?:
|
|
16
|
+
validateLockFile(manifestDir: string, opts?: Object): boolean;
|
|
17
17
|
/**
|
|
18
18
|
* Walk up from manifestDir to find the directory containing the lock file.
|
|
19
19
|
* Follows the same pattern as Base_javascript._findLockFileDir().
|
|
@@ -22,7 +22,7 @@ export default class Base_pyproject {
|
|
|
22
22
|
* @returns {string|null}
|
|
23
23
|
* @protected
|
|
24
24
|
*/
|
|
25
|
-
protected _findLockFileDir(manifestDir: string, opts?:
|
|
25
|
+
protected _findLockFileDir(manifestDir: string, opts?: Object): string | null;
|
|
26
26
|
/**
|
|
27
27
|
* Detect workspace root boundaries.
|
|
28
28
|
* Currently only uv has native workspace support ([tool.uv.workspace] in pyproject.toml).
|
|
@@ -44,13 +44,13 @@ export default class Base_pyproject {
|
|
|
44
44
|
* @param {Object} [opts={}]
|
|
45
45
|
* @returns {Promise<Provided>}
|
|
46
46
|
*/
|
|
47
|
-
provideStack(manifest: string, opts?:
|
|
47
|
+
provideStack(manifest: string, opts?: Object): Promise<Provided>;
|
|
48
48
|
/**
|
|
49
49
|
* @param {string} manifest - path to pyproject.toml
|
|
50
50
|
* @param {Object} [opts={}]
|
|
51
51
|
* @returns {Promise<Provided>}
|
|
52
52
|
*/
|
|
53
|
-
provideComponent(manifest: string, opts?:
|
|
53
|
+
provideComponent(manifest: string, opts?: Object): Promise<Provided>;
|
|
54
54
|
/**
|
|
55
55
|
* @returns {string}
|
|
56
56
|
* @protected
|
|
@@ -61,6 +61,11 @@ export default class Base_pyproject {
|
|
|
61
61
|
* @protected
|
|
62
62
|
*/
|
|
63
63
|
protected _cmdName(): string;
|
|
64
|
+
/**
|
|
65
|
+
* Returns the package manager name (e.g. pip, poetry, uv)
|
|
66
|
+
* @returns {string}
|
|
67
|
+
*/
|
|
68
|
+
packageManagerName(): string;
|
|
64
69
|
/**
|
|
65
70
|
* Resolve dependencies using the tool-specific command and parser.
|
|
66
71
|
*
|
|
@@ -72,7 +77,7 @@ export default class Base_pyproject {
|
|
|
72
77
|
* @returns {Promise<DependencyData>}
|
|
73
78
|
* @protected
|
|
74
79
|
*/
|
|
75
|
-
protected _getDependencyData(manifestDir: string, workspaceDir: string, parsed: object, opts:
|
|
80
|
+
protected _getDependencyData(manifestDir: string, workspaceDir: string, parsed: object, opts: Object): Promise<DependencyData>;
|
|
76
81
|
/**
|
|
77
82
|
* Canonicalize a Python package name per PEP 503.
|
|
78
83
|
* @param {string} name
|
|
@@ -102,26 +107,14 @@ export default class Base_pyproject {
|
|
|
102
107
|
*/
|
|
103
108
|
protected _getIgnoredDeps(manifestPath: string): Set<string>;
|
|
104
109
|
/**
|
|
105
|
-
*
|
|
110
|
+
* Compute the set of graph nodes reachable from direct deps, excluding ignored.
|
|
106
111
|
* @param {Map<string, GraphEntry>} graph
|
|
107
|
-
* @param {string[]} directDeps
|
|
112
|
+
* @param {string[]} directDeps
|
|
108
113
|
* @param {Set<string>} ignoredDeps
|
|
109
|
-
* @
|
|
110
|
-
* @returns {DepTreeEntry[]}
|
|
111
|
-
* @protected
|
|
112
|
-
*/
|
|
113
|
-
protected _buildDependencyTree(graph: Map<string, GraphEntry>, directDeps: string[], ignoredDeps: Set<string>, includeTransitive: boolean): DepTreeEntry[];
|
|
114
|
-
/**
|
|
115
|
-
* Recursively collect transitive dependencies.
|
|
116
|
-
* @param {Map<string, GraphEntry>} graph
|
|
117
|
-
* @param {string[]} childKeys
|
|
118
|
-
* @param {DepTreeEntry[]} result - mutated in place
|
|
119
|
-
* @param {Set<string>} ignoredDeps
|
|
120
|
-
* @param {Set<string>} visited
|
|
121
|
-
* @returns {void}
|
|
114
|
+
* @returns {Set<string>}
|
|
122
115
|
* @protected
|
|
123
116
|
*/
|
|
124
|
-
protected
|
|
117
|
+
protected _reachableNodes(graph: Map<string, GraphEntry>, directDeps: string[], ignoredDeps: Set<string>): Set<string>;
|
|
125
118
|
/**
|
|
126
119
|
* @param {string} name
|
|
127
120
|
* @param {string} version
|
|
@@ -129,15 +122,6 @@ export default class Base_pyproject {
|
|
|
129
122
|
* @protected
|
|
130
123
|
*/
|
|
131
124
|
protected _toPurl(name: string, version: string): PackageURL;
|
|
132
|
-
/**
|
|
133
|
-
* Recursively add a dependency and its transitive deps to the SBOM.
|
|
134
|
-
* @param {PackageURL} source
|
|
135
|
-
* @param {DepTreeEntry} dep
|
|
136
|
-
* @param {Sbom} sbom
|
|
137
|
-
* @returns {void}
|
|
138
|
-
* @private
|
|
139
|
-
*/
|
|
140
|
-
private _addAllDependencies;
|
|
141
125
|
/**
|
|
142
126
|
* Create SBOM json string for a pyproject.toml project.
|
|
143
127
|
* @param {string} manifest - path to pyproject.toml
|
|
@@ -152,6 +136,10 @@ export type GraphEntry = {
|
|
|
152
136
|
name: string;
|
|
153
137
|
version: string;
|
|
154
138
|
children: string[];
|
|
139
|
+
hashes?: Array<{
|
|
140
|
+
alg: string;
|
|
141
|
+
content: string;
|
|
142
|
+
}>;
|
|
155
143
|
};
|
|
156
144
|
export type DepTreeEntry = {
|
|
157
145
|
name: string;
|
|
@@ -7,9 +7,10 @@ import Sbom from '../sbom.js';
|
|
|
7
7
|
import { getCustom } from '../tools.js';
|
|
8
8
|
const ecosystem = 'pip';
|
|
9
9
|
const IGNORE_MARKERS = ['exhortignore', 'trustify-da-ignore'];
|
|
10
|
+
const NO_SCOPE = undefined;
|
|
10
11
|
const DEFAULT_ROOT_NAME = 'default-pip-root';
|
|
11
12
|
const DEFAULT_ROOT_VERSION = '0.0.0';
|
|
12
|
-
/** @typedef {{name: string, version: string, children: string[]}} GraphEntry */
|
|
13
|
+
/** @typedef {{name: string, version: string, children: string[], hashes?: Array<{alg: string, content: string}>}} GraphEntry */
|
|
13
14
|
/** @typedef {{name: string, version: string, dependencies: DepTreeEntry[]}} DepTreeEntry */
|
|
14
15
|
/** @typedef {{directDeps: string[], graph: Map<string, GraphEntry>}} DependencyData */
|
|
15
16
|
/** @typedef {{ecosystem: string, content: string, contentType: string}} Provided */
|
|
@@ -144,6 +145,13 @@ export default class Base_pyproject {
|
|
|
144
145
|
_cmdName() {
|
|
145
146
|
throw new TypeError('_cmdName must be implemented');
|
|
146
147
|
}
|
|
148
|
+
/**
|
|
149
|
+
* Returns the package manager name (e.g. pip, poetry, uv)
|
|
150
|
+
* @returns {string}
|
|
151
|
+
*/
|
|
152
|
+
packageManagerName() {
|
|
153
|
+
return this._cmdName();
|
|
154
|
+
}
|
|
147
155
|
/**
|
|
148
156
|
* Resolve dependencies using the tool-specific command and parser.
|
|
149
157
|
*
|
|
@@ -220,64 +228,29 @@ export default class Base_pyproject {
|
|
|
220
228
|
return ignored;
|
|
221
229
|
}
|
|
222
230
|
/**
|
|
223
|
-
*
|
|
224
|
-
* @param {Map<string, GraphEntry>} graph
|
|
225
|
-
* @param {string[]} directDeps - canonical names of direct deps
|
|
226
|
-
* @param {Set<string>} ignoredDeps
|
|
227
|
-
* @param {boolean} includeTransitive
|
|
228
|
-
* @returns {DepTreeEntry[]}
|
|
229
|
-
* @protected
|
|
230
|
-
*/
|
|
231
|
-
_buildDependencyTree(graph, directDeps, ignoredDeps, includeTransitive) {
|
|
232
|
-
let result = [];
|
|
233
|
-
for (let key of directDeps) {
|
|
234
|
-
if (ignoredDeps.has(key)) {
|
|
235
|
-
continue;
|
|
236
|
-
}
|
|
237
|
-
let entry = graph.get(key);
|
|
238
|
-
if (!entry) {
|
|
239
|
-
continue;
|
|
240
|
-
}
|
|
241
|
-
let depTree = [];
|
|
242
|
-
if (includeTransitive) {
|
|
243
|
-
let visited = new Set();
|
|
244
|
-
visited.add(key);
|
|
245
|
-
this._collectTransitive(graph, entry.children, depTree, ignoredDeps, visited);
|
|
246
|
-
}
|
|
247
|
-
result.push({ name: entry.name, version: entry.version, dependencies: depTree });
|
|
248
|
-
}
|
|
249
|
-
result.sort((a, b) => a.name.toLowerCase().localeCompare(b.name.toLowerCase()));
|
|
250
|
-
return result;
|
|
251
|
-
}
|
|
252
|
-
/**
|
|
253
|
-
* Recursively collect transitive dependencies.
|
|
231
|
+
* Compute the set of graph nodes reachable from direct deps, excluding ignored.
|
|
254
232
|
* @param {Map<string, GraphEntry>} graph
|
|
255
|
-
* @param {string[]}
|
|
256
|
-
* @param {DepTreeEntry[]} result - mutated in place
|
|
233
|
+
* @param {string[]} directDeps
|
|
257
234
|
* @param {Set<string>} ignoredDeps
|
|
258
|
-
* @
|
|
259
|
-
* @returns {void}
|
|
235
|
+
* @returns {Set<string>}
|
|
260
236
|
* @protected
|
|
261
237
|
*/
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
238
|
+
_reachableNodes(graph, directDeps, ignoredDeps) {
|
|
239
|
+
let reachable = new Set();
|
|
240
|
+
let queue = directDeps.filter(k => !ignoredDeps.has(k) && graph.has(k));
|
|
241
|
+
while (queue.length > 0) {
|
|
242
|
+
let key = queue.shift();
|
|
243
|
+
if (reachable.has(key)) {
|
|
266
244
|
continue;
|
|
267
245
|
}
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
if (!entry) {
|
|
274
|
-
continue;
|
|
246
|
+
reachable.add(key);
|
|
247
|
+
for (let child of graph.get(key).children) {
|
|
248
|
+
if (!ignoredDeps.has(child) && graph.has(child) && !reachable.has(child)) {
|
|
249
|
+
queue.push(child);
|
|
250
|
+
}
|
|
275
251
|
}
|
|
276
|
-
let childDeps = [];
|
|
277
|
-
this._collectTransitive(graph, entry.children, childDeps, ignoredDeps, visited);
|
|
278
|
-
result.push({ name: entry.name, version: entry.version, dependencies: childDeps });
|
|
279
252
|
}
|
|
280
|
-
|
|
253
|
+
return reachable;
|
|
281
254
|
}
|
|
282
255
|
/**
|
|
283
256
|
* @param {string} name
|
|
@@ -288,21 +261,6 @@ export default class Base_pyproject {
|
|
|
288
261
|
_toPurl(name, version) {
|
|
289
262
|
return new PackageURL('pypi', undefined, name, version, undefined, undefined);
|
|
290
263
|
}
|
|
291
|
-
/**
|
|
292
|
-
* Recursively add a dependency and its transitive deps to the SBOM.
|
|
293
|
-
* @param {PackageURL} source
|
|
294
|
-
* @param {DepTreeEntry} dep
|
|
295
|
-
* @param {Sbom} sbom
|
|
296
|
-
* @returns {void}
|
|
297
|
-
* @private
|
|
298
|
-
*/
|
|
299
|
-
_addAllDependencies(source, dep, sbom) {
|
|
300
|
-
let targetPurl = this._toPurl(dep.name, dep.version);
|
|
301
|
-
sbom.addDependency(source, targetPurl);
|
|
302
|
-
if (dep.dependencies && dep.dependencies.length > 0) {
|
|
303
|
-
dep.dependencies.forEach(child => this._addAllDependencies(this._toPurl(dep.name, dep.version), child, sbom));
|
|
304
|
-
}
|
|
305
|
-
}
|
|
306
264
|
/**
|
|
307
265
|
* Create SBOM json string for a pyproject.toml project.
|
|
308
266
|
* @param {string} manifest - path to pyproject.toml
|
|
@@ -318,21 +276,47 @@ export default class Base_pyproject {
|
|
|
318
276
|
let workspaceDir = this._findLockFileDir(manifestDir, opts) || manifestDir;
|
|
319
277
|
let { directDeps, graph } = await this._getDependencyData(manifestDir, workspaceDir, parsed, opts);
|
|
320
278
|
let ignoredDeps = this._getIgnoredDeps(manifest);
|
|
321
|
-
let dependencies = this._buildDependencyTree(graph, directDeps, ignoredDeps, includeTransitive);
|
|
322
279
|
let sbom = new Sbom();
|
|
323
280
|
let rootName = this._getProjectName(parsed) || DEFAULT_ROOT_NAME;
|
|
324
281
|
let rootVersion = this._getProjectVersion(parsed) || DEFAULT_ROOT_VERSION;
|
|
325
282
|
let rootPurl = this._toPurl(rootName, rootVersion);
|
|
326
283
|
let license = this.readLicenseFromManifest(manifest);
|
|
327
284
|
sbom.addRoot(rootPurl, license);
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
285
|
+
if (includeTransitive) {
|
|
286
|
+
let reachable = this._reachableNodes(graph, directDeps, ignoredDeps);
|
|
287
|
+
for (let key of directDeps) {
|
|
288
|
+
if (!reachable.has(key)) {
|
|
289
|
+
continue;
|
|
290
|
+
}
|
|
291
|
+
let entry = graph.get(key);
|
|
292
|
+
sbom.addDependency(rootPurl, this._toPurl(entry.name, entry.version), NO_SCOPE, entry.hashes);
|
|
293
|
+
}
|
|
294
|
+
for (let [key, entry] of graph) {
|
|
295
|
+
if (!reachable.has(key)) {
|
|
296
|
+
continue;
|
|
297
|
+
}
|
|
298
|
+
let parentPurl = this._toPurl(entry.name, entry.version);
|
|
299
|
+
for (let child of entry.children) {
|
|
300
|
+
if (!reachable.has(child)) {
|
|
301
|
+
continue;
|
|
302
|
+
}
|
|
303
|
+
let childEntry = graph.get(child);
|
|
304
|
+
sbom.addDependency(parentPurl, this._toPurl(childEntry.name, childEntry.version), NO_SCOPE, childEntry.hashes);
|
|
305
|
+
}
|
|
331
306
|
}
|
|
332
|
-
|
|
333
|
-
|
|
307
|
+
}
|
|
308
|
+
else {
|
|
309
|
+
for (let key of directDeps) {
|
|
310
|
+
if (ignoredDeps.has(key)) {
|
|
311
|
+
continue;
|
|
312
|
+
}
|
|
313
|
+
let entry = graph.get(key);
|
|
314
|
+
if (!entry) {
|
|
315
|
+
continue;
|
|
316
|
+
}
|
|
317
|
+
sbom.addDependency(rootPurl, this._toPurl(entry.name, entry.version), NO_SCOPE, entry.hashes);
|
|
334
318
|
}
|
|
335
|
-
}
|
|
319
|
+
}
|
|
336
320
|
return sbom.getAsJsonString(opts);
|
|
337
321
|
}
|
|
338
322
|
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { readFile } from 'node:fs/promises';
|
|
2
|
+
import { Language, Parser, Query } from 'web-tree-sitter';
|
|
3
|
+
const wasmUrl = new URL('./tree-sitter-containerfile.wasm', import.meta.url);
|
|
4
|
+
async function init() {
|
|
5
|
+
await Parser.init();
|
|
6
|
+
const wasmBytes = new Uint8Array(await readFile(wasmUrl));
|
|
7
|
+
return await Language.load(wasmBytes);
|
|
8
|
+
}
|
|
9
|
+
export async function getParser() {
|
|
10
|
+
const language = await init();
|
|
11
|
+
return new Parser().setLanguage(language);
|
|
12
|
+
}
|
|
13
|
+
export async function getFromQuery() {
|
|
14
|
+
const language = await init();
|
|
15
|
+
return new Query(language, '(from_instruction (image_spec) @image)');
|
|
16
|
+
}
|
|
17
|
+
export async function getArgQuery() {
|
|
18
|
+
const language = await init();
|
|
19
|
+
return new Query(language, '(arg_instruction (arg_pair name: (_) @name default: (_) @default))');
|
|
20
|
+
}
|
|
@@ -1,12 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Discover all go.mod manifest paths in a Go workspace.
|
|
3
|
+
* Uses `go work edit -json` to get workspace members.
|
|
4
|
+
*
|
|
5
|
+
* @param {string} workspaceRoot - Absolute or relative path to workspace root (must contain go.work)
|
|
6
|
+
* @param {import('../index.js').Options} [opts={}]
|
|
7
|
+
* @returns {Promise<string[]>} Paths to go.mod files (absolute)
|
|
8
|
+
*/
|
|
9
|
+
export function discoverGoWorkspaceModules(workspaceRoot: string, opts?: import("../index.js").Options): Promise<string[]>;
|
|
1
10
|
declare namespace _default {
|
|
2
11
|
export { isSupported };
|
|
3
12
|
export { validateLockFile };
|
|
4
13
|
export { provideComponent };
|
|
5
14
|
export { provideStack };
|
|
6
15
|
export { readLicenseFromManifest };
|
|
16
|
+
export function packageManagerName(): string;
|
|
7
17
|
}
|
|
8
18
|
export default _default;
|
|
9
|
-
export type Provided =
|
|
19
|
+
export type Provided = any;
|
|
10
20
|
export type Package = {
|
|
11
21
|
name: string;
|
|
12
22
|
version: string;
|
|
@@ -4,8 +4,9 @@ import { PackageURL } from 'packageurl-js';
|
|
|
4
4
|
import { readLicenseFile } from '../license/license_utils.js';
|
|
5
5
|
import Sbom from '../sbom.js';
|
|
6
6
|
import { getCustom, getCustomPath, invokeCommand } from "../tools.js";
|
|
7
|
+
import { filterManifestPathsByDiscoveryIgnore, resolveWorkspaceDiscoveryIgnore } from '../workspace.js';
|
|
7
8
|
import { getParser, getRequireQuery } from './gomod_parser.js';
|
|
8
|
-
export default { isSupported, validateLockFile, provideComponent, provideStack, readLicenseFromManifest };
|
|
9
|
+
export default { isSupported, validateLockFile, provideComponent, provideStack, readLicenseFromManifest, packageManagerName() { return 'go'; } };
|
|
9
10
|
/** @typedef {import('../provider').Provider} */
|
|
10
11
|
/** @typedef {import('../provider').Provided} Provided */
|
|
11
12
|
/** @typedef {{name: string, version: string}} Package */
|
|
@@ -77,9 +78,10 @@ function getChildVertexFromEdge(edge) {
|
|
|
77
78
|
return edge.split(" ")[1];
|
|
78
79
|
}
|
|
79
80
|
/**
|
|
80
|
-
* Check whether a require_spec has a valid
|
|
81
|
-
*
|
|
82
|
-
* For
|
|
81
|
+
* Check whether a require_spec has a valid ignore marker.
|
|
82
|
+
* Supports both the legacy `exhortignore` marker and the new `trustify-da-ignore` marker.
|
|
83
|
+
* For direct dependencies: `//exhortignore` or `// trustify-da-ignore`
|
|
84
|
+
* For indirect dependencies: `// indirect; exhortignore` or `// indirect; trustify-da-ignore` (semicolon-separated)
|
|
83
85
|
* @param {import('web-tree-sitter').SyntaxNode} specNode
|
|
84
86
|
* @return {boolean}
|
|
85
87
|
*/
|
|
@@ -91,10 +93,10 @@ function hasExhortIgnore(specNode) {
|
|
|
91
93
|
let comments = specNode.children.filter(c => c.type === 'comment');
|
|
92
94
|
for (let comment of comments) {
|
|
93
95
|
let text = comment.text;
|
|
94
|
-
if (/^\/\/\s*indirect;\s*exhortignore/.test(text)) {
|
|
96
|
+
if (/^\/\/\s*indirect;\s*(exhortignore|trustify-da-ignore)(?![\w-])/.test(text)) {
|
|
95
97
|
return true;
|
|
96
98
|
}
|
|
97
|
-
if (/^\/\/\s*exhortignore/.test(text)) {
|
|
99
|
+
if (/^\/\/\s*(exhortignore|trustify-da-ignore)(?![\w-])/.test(text)) {
|
|
98
100
|
return true;
|
|
99
101
|
}
|
|
100
102
|
}
|
|
@@ -186,6 +188,36 @@ function performManifestVersionsCheck(rootElementName, goModGraphOutputRows, man
|
|
|
186
188
|
throw error;
|
|
187
189
|
}
|
|
188
190
|
}
|
|
191
|
+
/** Parses go.sum to build a hash map of module@version to CycloneDX hashes. */
|
|
192
|
+
function parseGoSumHashes(manifestDir) {
|
|
193
|
+
let goSumPath = path.join(manifestDir, 'go.sum');
|
|
194
|
+
if (!fs.existsSync(goSumPath)) {
|
|
195
|
+
return new Map();
|
|
196
|
+
}
|
|
197
|
+
let hashMap = new Map();
|
|
198
|
+
let content = fs.readFileSync(goSumPath, 'utf-8');
|
|
199
|
+
for (let line of content.split('\n')) {
|
|
200
|
+
line = line.trim();
|
|
201
|
+
if (!line) {
|
|
202
|
+
continue;
|
|
203
|
+
}
|
|
204
|
+
let parts = line.split(/\s+/);
|
|
205
|
+
if (parts.length < 3) {
|
|
206
|
+
continue;
|
|
207
|
+
}
|
|
208
|
+
let [mod, version, hash] = parts;
|
|
209
|
+
if (version.endsWith('/go.mod')) {
|
|
210
|
+
continue;
|
|
211
|
+
}
|
|
212
|
+
if (!hash.startsWith('h1:')) {
|
|
213
|
+
continue;
|
|
214
|
+
}
|
|
215
|
+
let base64Part = hash.slice(3);
|
|
216
|
+
let hexDigest = Buffer.from(base64Part, 'base64').toString('hex');
|
|
217
|
+
hashMap.set(`${mod}@${version}`, [{ alg: "SHA-256", content: hexDigest }]);
|
|
218
|
+
}
|
|
219
|
+
return hashMap;
|
|
220
|
+
}
|
|
189
221
|
/**
|
|
190
222
|
* Create SBOM json string for go Module.
|
|
191
223
|
* @param {string} manifest - path for go.mod
|
|
@@ -240,6 +272,7 @@ async function getSBOM(manifest, opts = {}, includeTransitive) {
|
|
|
240
272
|
if (matchManifestVersions === "true") {
|
|
241
273
|
performManifestVersionsCheck(root, rows, manifestContent, parser, requireQuery);
|
|
242
274
|
}
|
|
275
|
+
let goSumHashes = parseGoSumHashes(manifestDir);
|
|
243
276
|
const mainModule = toPurl(root, "@");
|
|
244
277
|
const license = readLicenseFromManifest(manifest);
|
|
245
278
|
sbom.addRoot(mainModule, license);
|
|
@@ -261,7 +294,7 @@ async function getSBOM(manifest, opts = {}, includeTransitive) {
|
|
|
261
294
|
if (getParentVertexFromEdge(row) === root && !directDepPaths.has(getPackageName(child))) {
|
|
262
295
|
return;
|
|
263
296
|
}
|
|
264
|
-
sbom.addDependency(source, target);
|
|
297
|
+
sbom.addDependency(source, target, undefined, goSumHashes.get(child));
|
|
265
298
|
});
|
|
266
299
|
// at the end, filter out all ignored dependencies including versions.
|
|
267
300
|
sbom.filterIgnoredDepsIncludingVersion(allIgnoredDeps);
|
|
@@ -274,12 +307,22 @@ async function getSBOM(manifest, opts = {}, includeTransitive) {
|
|
|
274
307
|
let target = toPurl(child, "@");
|
|
275
308
|
if (dependencyNotIgnored(ignoredDeps, target)) {
|
|
276
309
|
if (directDepPaths.has(getPackageName(child))) {
|
|
277
|
-
sbom.addDependency(mainModule, target);
|
|
310
|
+
sbom.addDependency(mainModule, target, undefined, goSumHashes.get(child));
|
|
278
311
|
}
|
|
279
312
|
}
|
|
280
313
|
});
|
|
281
314
|
enforceRemovingIgnoredDepsInCaseOfAutomaticVersionUpdate(ignoredDeps, sbom);
|
|
282
315
|
}
|
|
316
|
+
// Backfill hashes for components that were only seen as dependency sources
|
|
317
|
+
for (const comp of sbom.sbomModel.components) {
|
|
318
|
+
if (!comp.hashes && comp.purl) {
|
|
319
|
+
let key = decodeURIComponent(comp.purl.replace('pkg:golang/', ''));
|
|
320
|
+
let hashes = goSumHashes.get(key);
|
|
321
|
+
if (hashes) {
|
|
322
|
+
comp.hashes = hashes;
|
|
323
|
+
}
|
|
324
|
+
}
|
|
325
|
+
}
|
|
283
326
|
return sbom.getAsJsonString(opts);
|
|
284
327
|
}
|
|
285
328
|
/**
|
|
@@ -328,13 +371,7 @@ function getFinalPackagesVersionsForModule(rows, manifestPath, goBin) {
|
|
|
328
371
|
catch (error) {
|
|
329
372
|
throw new Error('failed to list all modules', { cause: error });
|
|
330
373
|
}
|
|
331
|
-
let finalVersionModules =
|
|
332
|
-
finalVersionsForAllModules.split(getLineSeparatorGolang()).filter(string => string.trim() !== "")
|
|
333
|
-
.filter(string => string.trim().split(" ").length === 2)
|
|
334
|
-
.forEach((dependency) => {
|
|
335
|
-
let dep = dependency.split(" ");
|
|
336
|
-
finalVersionModules[dep[0]] = dep[1];
|
|
337
|
-
});
|
|
374
|
+
let finalVersionModules = parseModuleVersions(finalVersionsForAllModules);
|
|
338
375
|
let finalVersionModulesArray = new Array();
|
|
339
376
|
rows.filter(string => string.trim() !== "").forEach(module => {
|
|
340
377
|
let child = getChildVertexFromEdge(module);
|
|
@@ -395,7 +432,69 @@ function getVersionOfPackage(fullPackage) {
|
|
|
395
432
|
let parts = fullPackage.split("@");
|
|
396
433
|
return parts.length > 1 ? parts[1] : undefined;
|
|
397
434
|
}
|
|
435
|
+
function parseModuleVersions(goListOutput) {
|
|
436
|
+
let modules = {};
|
|
437
|
+
goListOutput.split(getLineSeparatorGolang()).filter(string => string.trim() !== "")
|
|
438
|
+
.forEach((line) => {
|
|
439
|
+
let parts = line.trim().split(" ");
|
|
440
|
+
if (parts.length === 2) {
|
|
441
|
+
modules[parts[0]] = parts[1];
|
|
442
|
+
}
|
|
443
|
+
else if (parts.length >= 4 && parts[2] === "=>") {
|
|
444
|
+
modules[parts[0]] = parts[parts.length - 1];
|
|
445
|
+
}
|
|
446
|
+
});
|
|
447
|
+
return modules;
|
|
448
|
+
}
|
|
398
449
|
function getLineSeparatorGolang() {
|
|
399
450
|
let reg = /\n|\r\n/;
|
|
400
451
|
return reg;
|
|
401
452
|
}
|
|
453
|
+
/**
|
|
454
|
+
* Discover all go.mod manifest paths in a Go workspace.
|
|
455
|
+
* Uses `go work edit -json` to get workspace members.
|
|
456
|
+
*
|
|
457
|
+
* @param {string} workspaceRoot - Absolute or relative path to workspace root (must contain go.work)
|
|
458
|
+
* @param {import('../index.js').Options} [opts={}]
|
|
459
|
+
* @returns {Promise<string[]>} Paths to go.mod files (absolute)
|
|
460
|
+
*/
|
|
461
|
+
export async function discoverGoWorkspaceModules(workspaceRoot, opts = {}) {
|
|
462
|
+
const root = path.resolve(workspaceRoot);
|
|
463
|
+
const goWork = path.join(root, 'go.work');
|
|
464
|
+
if (!fs.existsSync(goWork)) {
|
|
465
|
+
return [];
|
|
466
|
+
}
|
|
467
|
+
const goBin = getCustomPath('go', opts);
|
|
468
|
+
let output;
|
|
469
|
+
try {
|
|
470
|
+
output = invokeCommand(goBin, ['work', 'edit', '-json', goWork], { cwd: root });
|
|
471
|
+
}
|
|
472
|
+
catch {
|
|
473
|
+
return [];
|
|
474
|
+
}
|
|
475
|
+
let workspace;
|
|
476
|
+
try {
|
|
477
|
+
workspace = JSON.parse(output.toString().trim());
|
|
478
|
+
}
|
|
479
|
+
catch {
|
|
480
|
+
return [];
|
|
481
|
+
}
|
|
482
|
+
const useEntries = workspace.Use || [];
|
|
483
|
+
if (useEntries.length === 0) {
|
|
484
|
+
return [];
|
|
485
|
+
}
|
|
486
|
+
const manifestPaths = [];
|
|
487
|
+
for (const entry of useEntries) {
|
|
488
|
+
const diskPath = entry.DiskPath;
|
|
489
|
+
if (!diskPath) {
|
|
490
|
+
continue;
|
|
491
|
+
}
|
|
492
|
+
const moduleDir = path.resolve(root, diskPath);
|
|
493
|
+
const goMod = path.join(moduleDir, 'go.mod');
|
|
494
|
+
if (fs.existsSync(goMod)) {
|
|
495
|
+
manifestPaths.push(goMod);
|
|
496
|
+
}
|
|
497
|
+
}
|
|
498
|
+
const ignorePatterns = resolveWorkspaceDiscoveryIgnore(opts);
|
|
499
|
+
return filterManifestPathsByDiscoveryIgnore(manifestPaths, root, ignorePatterns);
|
|
500
|
+
}
|
|
@@ -1,3 +1,46 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Discover all build.gradle[.kts] manifest paths in a Gradle multi-project build.
|
|
3
|
+
* Uses a custom init script to get structured project listing.
|
|
4
|
+
*
|
|
5
|
+
* @param {string} workspaceRoot - Absolute or relative path to workspace root (must contain settings.gradle[.kts])
|
|
6
|
+
* @param {import('../index.js').Options} [opts={}]
|
|
7
|
+
* @returns {Promise<string[]>} Paths to build.gradle[.kts] files (absolute)
|
|
8
|
+
*/
|
|
9
|
+
export function discoverGradleSubprojects(workspaceRoot: string, opts?: import("../index.js").Options): Promise<string[]>;
|
|
10
|
+
/**
|
|
11
|
+
* Parse the structured output from the Gradle init script.
|
|
12
|
+
*
|
|
13
|
+
* @param {string} raw - Raw stdout from gradle
|
|
14
|
+
* @returns {{ path: string, dir: string }[]}
|
|
15
|
+
*/
|
|
16
|
+
export function parseGradleInitScriptOutput(raw: string): {
|
|
17
|
+
path: string;
|
|
18
|
+
dir: string;
|
|
19
|
+
}[];
|
|
20
|
+
/**
|
|
21
|
+
* Parse the structured output from the Gradle hash init script.
|
|
22
|
+
* Each recognised line has the form `::DA_HASH::group:name:version::<file-path>`.
|
|
23
|
+
*
|
|
24
|
+
* @param {string} raw - Raw stdout from gradle
|
|
25
|
+
* @returns {{ id: string, file: string }[]} component id (`group:name:version`) and absolute artifact file path
|
|
26
|
+
*/
|
|
27
|
+
export function parseGradleHashScriptOutput(raw: string): {
|
|
28
|
+
id: string;
|
|
29
|
+
file: string;
|
|
30
|
+
}[];
|
|
31
|
+
/**
|
|
32
|
+
* Parse a Gradle module component id (`group:name:version`) into its coordinate
|
|
33
|
+
* parts. The caller builds the canonical PURL key from these parts using the same
|
|
34
|
+
* builder {@link parseDep} uses, so the stored key and the lookup key cannot drift.
|
|
35
|
+
*
|
|
36
|
+
* @param {string} id - the Gradle component id
|
|
37
|
+
* @returns {{group: string, name: string, version: string}|null} the parsed coordinate, or null when the id is malformed
|
|
38
|
+
*/
|
|
39
|
+
export function parseComponentId(id: string): {
|
|
40
|
+
group: string;
|
|
41
|
+
name: string;
|
|
42
|
+
version: string;
|
|
43
|
+
} | null;
|
|
1
44
|
/**
|
|
2
45
|
* This class provides common functionality for Groovy and Kotlin DSL files.
|
|
3
46
|
*/
|
|
@@ -35,6 +78,30 @@ export default class Java_gradle extends Base_java {
|
|
|
35
78
|
* @returns {Provided}
|
|
36
79
|
*/
|
|
37
80
|
provideComponent(manifest: string, opts?: {}): Provided;
|
|
81
|
+
/**
|
|
82
|
+
* Compute SHA-256 hashes for the resolved artifacts of a Gradle manifest.
|
|
83
|
+
*
|
|
84
|
+
* Rather than scanning the local Gradle cache, this asks Gradle itself for
|
|
85
|
+
* the resolved artifact files via an init script (mirroring the pattern used
|
|
86
|
+
* by {@link discoverGradleSubprojects}), then hashes each file with the
|
|
87
|
+
* Node.js `crypto` module. The result is keyed by the canonical PURL string
|
|
88
|
+
* built via {@link Base_java#toPurl} — the same builder {@link parseDep} uses
|
|
89
|
+
* for the lookup — so the stored key and the lookup key cannot drift.
|
|
90
|
+
*
|
|
91
|
+
* Degrades gracefully: if Gradle cannot be invoked, the init script fails, or
|
|
92
|
+
* an artifact has no readable file (e.g. BOM/`platform()` dependencies), the
|
|
93
|
+
* hash for that component is omitted rather than throwing. A warning is emitted
|
|
94
|
+
* on every degradation path so incomplete hash coverage is visible even without
|
|
95
|
+
* `TRUSTIFY_DA_DEBUG` (mirroring the pip/cargo providers).
|
|
96
|
+
*
|
|
97
|
+
* @param {string} manifest - path to build.gradle[.kts]
|
|
98
|
+
* @param {{}} [opts={}] - optional various options to pass along the application
|
|
99
|
+
* @returns {Promise<Map<string, Array<{alg: string, content: string}>>>} map of canonical PURL string to CycloneDX hashes
|
|
100
|
+
*/
|
|
101
|
+
parseGradleHashes(manifest: string, opts?: {}): Promise<Map<string, Array<{
|
|
102
|
+
alg: string;
|
|
103
|
+
content: string;
|
|
104
|
+
}>>>;
|
|
38
105
|
#private;
|
|
39
106
|
}
|
|
40
107
|
export type Provided = import("../provider.js").Provided;
|