@trustify-da/trustify-da-javascript-client 0.3.0-ea.a783c26 → 0.3.0-ea.a87208f
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 +177 -3
- package/dist/package.json +27 -22
- package/dist/src/analysis.d.ts +14 -7
- package/dist/src/analysis.js +29 -13
- package/dist/src/cli.js +106 -2
- 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 +74 -11
- package/dist/src/index.js +83 -29
- package/dist/src/license/index.d.ts +3 -3
- package/dist/src/license/index.js +4 -1
- package/dist/src/license/license_utils.js +4 -1
- package/dist/src/license/licenses_api.d.ts +2 -2
- 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 +6 -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 +115 -6
- package/dist/src/providers/base_pyproject.d.ts +15 -6
- package/dist/src/providers/base_pyproject.js +12 -4
- 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 +108 -10
- package/dist/src/providers/java_gradle.d.ts +19 -0
- package/dist/src/providers/java_gradle.js +116 -2
- 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 +38 -5
- package/dist/src/providers/java_maven.js +261 -8
- 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 -1
- package/dist/src/providers/javascript_npm.js +40 -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/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 +3 -2
- 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 +62 -5
- 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.js +3 -1
- package/dist/src/providers/python_poetry.d.ts +63 -8
- package/dist/src/providers/python_poetry.js +132 -21
- package/dist/src/providers/python_uv.d.ts +20 -1
- package/dist/src/providers/python_uv.js +122 -2
- package/dist/src/providers/rust_cargo.d.ts +6 -2
- package/dist/src/providers/rust_cargo.js +105 -19
- package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
- package/dist/src/remediate.d.ts +21 -0
- package/dist/src/remediate.js +149 -0
- package/dist/src/remediation.d.ts +57 -0
- package/dist/src/remediation.js +436 -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 +28 -2
- package/dist/src/tools.js +82 -1
- package/dist/src/updaters/maven_updater.d.ts +26 -0
- package/dist/src/updaters/maven_updater.js +322 -0
- package/dist/src/updaters/toml_updater.d.ts +33 -0
- package/dist/src/updaters/toml_updater.js +244 -0
- package/dist/src/workspace.d.ts +9 -0
- package/dist/src/workspace.js +1 -1
- package/package.json +28 -23
|
@@ -12,6 +12,49 @@ import Manifest from './manifest.js';
|
|
|
12
12
|
* @type {string}
|
|
13
13
|
*/
|
|
14
14
|
export const purlType = 'npm';
|
|
15
|
+
/**
|
|
16
|
+
* Maps a Subresource Integrity (SRI) algorithm token to its CycloneDX label.
|
|
17
|
+
* @type {Object<string, string>}
|
|
18
|
+
*/
|
|
19
|
+
const SRI_ALG_LABELS = {
|
|
20
|
+
sha1: 'SHA-1',
|
|
21
|
+
sha256: 'SHA-256',
|
|
22
|
+
sha384: 'SHA-384',
|
|
23
|
+
sha512: 'SHA-512',
|
|
24
|
+
};
|
|
25
|
+
/**
|
|
26
|
+
* Converts a Subresource Integrity (SRI) string to a CycloneDX hash object.
|
|
27
|
+
* SRI is formatted as `<alg>-<base64>` (e.g. `sha512-Ab3d...`). CycloneDX
|
|
28
|
+
* expects an uppercased algorithm label (e.g. `SHA-512`) and a hex-encoded
|
|
29
|
+
* digest. When the SRI string contains multiple space-separated hashes, only
|
|
30
|
+
* the first is used.
|
|
31
|
+
* @param {string} integrity - SRI string from a lock file
|
|
32
|
+
* @returns {{alg: string, content: string}|null} CycloneDX hash, or null when unparseable
|
|
33
|
+
*/
|
|
34
|
+
export function sriToHash(integrity) {
|
|
35
|
+
if (typeof integrity !== 'string') {
|
|
36
|
+
return null;
|
|
37
|
+
}
|
|
38
|
+
const first = integrity.trim().split(/\s+/)[0];
|
|
39
|
+
if (!first) {
|
|
40
|
+
return null;
|
|
41
|
+
}
|
|
42
|
+
const dash = first.indexOf('-');
|
|
43
|
+
if (dash < 0) {
|
|
44
|
+
return null;
|
|
45
|
+
}
|
|
46
|
+
const alg = SRI_ALG_LABELS[first.slice(0, dash).toLowerCase()];
|
|
47
|
+
// Strip any SRI options (e.g. "?foo") that may follow the base64 payload
|
|
48
|
+
const base64 = first.slice(dash + 1).split('?')[0];
|
|
49
|
+
if (!alg || !base64) {
|
|
50
|
+
return null;
|
|
51
|
+
}
|
|
52
|
+
const content = Buffer.from(base64, 'base64').toString('hex');
|
|
53
|
+
if (!content) {
|
|
54
|
+
return null;
|
|
55
|
+
}
|
|
56
|
+
return { alg, content };
|
|
57
|
+
}
|
|
15
58
|
/**
|
|
16
59
|
* Base class for JavaScript package manager providers.
|
|
17
60
|
* This class provides common functionality for different JavaScript package managers
|
|
@@ -25,6 +68,11 @@ export default class Base_javascript {
|
|
|
25
68
|
#cmd;
|
|
26
69
|
/** @type {string} */
|
|
27
70
|
#ecosystem;
|
|
71
|
+
/**
|
|
72
|
+
* Lock-file hashes keyed by `name@version`.
|
|
73
|
+
* @type {Map<string, Array<{alg: string, content: string}>>}
|
|
74
|
+
*/
|
|
75
|
+
#hashes = new Map();
|
|
28
76
|
/**
|
|
29
77
|
* Sets up the provider with the manifest path and options
|
|
30
78
|
* @param {string} manifestPath - Path to the package.json manifest file
|
|
@@ -71,6 +119,13 @@ export default class Base_javascript {
|
|
|
71
119
|
throw new TypeError("_cmdName must be implemented");
|
|
72
120
|
}
|
|
73
121
|
/**
|
|
122
|
+
* Returns the package manager name (e.g. npm, yarn, pnpm, bun)
|
|
123
|
+
* @returns {string} The package manager name
|
|
124
|
+
*/
|
|
125
|
+
packageManagerName() {
|
|
126
|
+
return this._cmdName();
|
|
127
|
+
}
|
|
128
|
+
/**
|
|
74
129
|
* Returns the command arguments for listing dependencies
|
|
75
130
|
* @returns {Array<string>} The command arguments
|
|
76
131
|
* @abstract
|
|
@@ -88,6 +143,58 @@ export default class Base_javascript {
|
|
|
88
143
|
_updateLockFileCmdArgs() {
|
|
89
144
|
throw new TypeError("_updateLockFileCmdArgs must be implemented");
|
|
90
145
|
}
|
|
146
|
+
/**
|
|
147
|
+
* Parses the provider's lock file into a hash map keyed by `name@version`.
|
|
148
|
+
* Subclasses override this (accepting the lock directory) to support their
|
|
149
|
+
* lock file format. The default implementation returns an empty map so
|
|
150
|
+
* providers without lock parsing (or without a lock file present) gracefully
|
|
151
|
+
* omit hashes.
|
|
152
|
+
* @returns {Map<string, Array<{alg: string, content: string}>>} Hash map
|
|
153
|
+
* @protected
|
|
154
|
+
*/
|
|
155
|
+
_parseLockFileHashes() {
|
|
156
|
+
return new Map();
|
|
157
|
+
}
|
|
158
|
+
/**
|
|
159
|
+
* Loads lock-file hashes for the given directory into internal state.
|
|
160
|
+
* Parsing failures degrade gracefully to an empty map (no hashes emitted).
|
|
161
|
+
* @param {string} lockDir - Directory containing the lock file
|
|
162
|
+
* @protected
|
|
163
|
+
*/
|
|
164
|
+
_loadHashes(lockDir) {
|
|
165
|
+
try {
|
|
166
|
+
this.#hashes = this._parseLockFileHashes(lockDir) || new Map();
|
|
167
|
+
}
|
|
168
|
+
catch (_) {
|
|
169
|
+
this.#hashes = new Map();
|
|
170
|
+
}
|
|
171
|
+
}
|
|
172
|
+
/**
|
|
173
|
+
* Looks up CycloneDX hashes for a package by name and resolved version.
|
|
174
|
+
* @param {string} name - The package name (including scope, e.g. `@hapi/joi`)
|
|
175
|
+
* @param {string} version - The resolved package version
|
|
176
|
+
* @returns {Array<{alg: string, content: string}>|undefined} Hashes, or undefined
|
|
177
|
+
* @protected
|
|
178
|
+
*/
|
|
179
|
+
_hashesFor(name, version) {
|
|
180
|
+
if (!name || !version) {
|
|
181
|
+
return undefined;
|
|
182
|
+
}
|
|
183
|
+
return this.#hashes.get(`${name}@${version}`);
|
|
184
|
+
}
|
|
185
|
+
/**
|
|
186
|
+
* Looks up CycloneDX hashes for a package described by a PackageURL.
|
|
187
|
+
* @param {PackageURL} purl - The package URL
|
|
188
|
+
* @returns {Array<{alg: string, content: string}>|undefined} Hashes, or undefined
|
|
189
|
+
* @protected
|
|
190
|
+
*/
|
|
191
|
+
_hashesForPurl(purl) {
|
|
192
|
+
if (!purl) {
|
|
193
|
+
return undefined;
|
|
194
|
+
}
|
|
195
|
+
const name = purl.namespace ? `${purl.namespace}/${purl.name}` : purl.name;
|
|
196
|
+
return this._hashesFor(name, purl.version);
|
|
197
|
+
}
|
|
91
198
|
/**
|
|
92
199
|
* Checks if the provider supports the given manifest name
|
|
93
200
|
* @param {string} manifestName - The manifest name to check
|
|
@@ -217,7 +324,8 @@ export default class Base_javascript {
|
|
|
217
324
|
this._version();
|
|
218
325
|
const manifestDir = path.dirname(this.#manifest.manifestPath);
|
|
219
326
|
const cmdDir = this._findLockFileDir(manifestDir, opts) || manifestDir;
|
|
220
|
-
this
|
|
327
|
+
this._createLockFile(cmdDir);
|
|
328
|
+
this._loadHashes(cmdDir);
|
|
221
329
|
let output = this.#executeListCmd(includeTransitive, cmdDir);
|
|
222
330
|
output = this._parseDepTreeOutput(output);
|
|
223
331
|
return JSON.parse(output);
|
|
@@ -277,7 +385,7 @@ export default class Base_javascript {
|
|
|
277
385
|
const [name, artifact] = entry;
|
|
278
386
|
const target = toPurl(purlType, name, artifact.version);
|
|
279
387
|
const rootPurl = toPurl(purlType, this.#manifest.name, this.#manifest.version);
|
|
280
|
-
sbom.addDependency(rootPurl, target);
|
|
388
|
+
sbom.addDependency(rootPurl, target, undefined, this._hashesFor(name, artifact.version));
|
|
281
389
|
this.#addDependenciesOf(sbom, target, artifact);
|
|
282
390
|
});
|
|
283
391
|
}
|
|
@@ -295,7 +403,7 @@ export default class Base_javascript {
|
|
|
295
403
|
const [name, depArtifact] = entry;
|
|
296
404
|
if (depArtifact.version !== undefined) {
|
|
297
405
|
const target = toPurl(purlType, name, depArtifact.version);
|
|
298
|
-
sbom.addDependency(from, target);
|
|
406
|
+
sbom.addDependency(from, target, undefined, this._hashesFor(name, depArtifact.version));
|
|
299
407
|
this.#addDependenciesOf(sbom, target, depArtifact);
|
|
300
408
|
}
|
|
301
409
|
});
|
|
@@ -319,7 +427,8 @@ export default class Base_javascript {
|
|
|
319
427
|
.sort();
|
|
320
428
|
for (const key of sortedDepsKeys) {
|
|
321
429
|
const rootPurl = toPurlFromString(sbom.getRoot().purl);
|
|
322
|
-
|
|
430
|
+
const targetPurl = rootDeps.get(key);
|
|
431
|
+
sbom.addDependency(rootPurl, targetPurl, undefined, this._hashesForPurl(targetPurl));
|
|
323
432
|
}
|
|
324
433
|
this.#ensurePeerAndOptionalDeps(sbom);
|
|
325
434
|
sbom.filterIgnoredDeps(this.#manifest.ignored);
|
|
@@ -363,9 +472,9 @@ export default class Base_javascript {
|
|
|
363
472
|
/**
|
|
364
473
|
* Creates or updates the lock file for the package manager
|
|
365
474
|
* @param {string} manifestDir - Directory containing the manifest file
|
|
366
|
-
* @
|
|
475
|
+
* @protected
|
|
367
476
|
*/
|
|
368
|
-
|
|
477
|
+
_createLockFile(manifestDir) {
|
|
369
478
|
const originalDir = process.cwd();
|
|
370
479
|
const isWindows = os.platform() === 'win32';
|
|
371
480
|
if (isWindows) {
|
|
@@ -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
|
|
@@ -131,6 +136,10 @@ export type GraphEntry = {
|
|
|
131
136
|
name: string;
|
|
132
137
|
version: string;
|
|
133
138
|
children: string[];
|
|
139
|
+
hashes?: Array<{
|
|
140
|
+
alg: string;
|
|
141
|
+
content: string;
|
|
142
|
+
}>;
|
|
134
143
|
};
|
|
135
144
|
export type DepTreeEntry = {
|
|
136
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
|
*
|
|
@@ -281,7 +289,7 @@ export default class Base_pyproject {
|
|
|
281
289
|
continue;
|
|
282
290
|
}
|
|
283
291
|
let entry = graph.get(key);
|
|
284
|
-
sbom.addDependency(rootPurl, this._toPurl(entry.name, entry.version));
|
|
292
|
+
sbom.addDependency(rootPurl, this._toPurl(entry.name, entry.version), NO_SCOPE, entry.hashes);
|
|
285
293
|
}
|
|
286
294
|
for (let [key, entry] of graph) {
|
|
287
295
|
if (!reachable.has(key)) {
|
|
@@ -293,7 +301,7 @@ export default class Base_pyproject {
|
|
|
293
301
|
continue;
|
|
294
302
|
}
|
|
295
303
|
let childEntry = graph.get(child);
|
|
296
|
-
sbom.addDependency(parentPurl, this._toPurl(childEntry.name, childEntry.version));
|
|
304
|
+
sbom.addDependency(parentPurl, this._toPurl(childEntry.name, childEntry.version), NO_SCOPE, childEntry.hashes);
|
|
297
305
|
}
|
|
298
306
|
}
|
|
299
307
|
}
|
|
@@ -306,7 +314,7 @@ export default class Base_pyproject {
|
|
|
306
314
|
if (!entry) {
|
|
307
315
|
continue;
|
|
308
316
|
}
|
|
309
|
-
sbom.addDependency(rootPurl, this._toPurl(entry.name, entry.version));
|
|
317
|
+
sbom.addDependency(rootPurl, this._toPurl(entry.name, entry.version), NO_SCOPE, entry.hashes);
|
|
310
318
|
}
|
|
311
319
|
}
|
|
312
320
|
return sbom.getAsJsonString(opts);
|
|
@@ -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 */
|
|
@@ -186,6 +187,36 @@ function performManifestVersionsCheck(rootElementName, goModGraphOutputRows, man
|
|
|
186
187
|
throw error;
|
|
187
188
|
}
|
|
188
189
|
}
|
|
190
|
+
/** Parses go.sum to build a hash map of module@version to CycloneDX hashes. */
|
|
191
|
+
function parseGoSumHashes(manifestDir) {
|
|
192
|
+
let goSumPath = path.join(manifestDir, 'go.sum');
|
|
193
|
+
if (!fs.existsSync(goSumPath)) {
|
|
194
|
+
return new Map();
|
|
195
|
+
}
|
|
196
|
+
let hashMap = new Map();
|
|
197
|
+
let content = fs.readFileSync(goSumPath, 'utf-8');
|
|
198
|
+
for (let line of content.split('\n')) {
|
|
199
|
+
line = line.trim();
|
|
200
|
+
if (!line) {
|
|
201
|
+
continue;
|
|
202
|
+
}
|
|
203
|
+
let parts = line.split(/\s+/);
|
|
204
|
+
if (parts.length < 3) {
|
|
205
|
+
continue;
|
|
206
|
+
}
|
|
207
|
+
let [mod, version, hash] = parts;
|
|
208
|
+
if (version.endsWith('/go.mod')) {
|
|
209
|
+
continue;
|
|
210
|
+
}
|
|
211
|
+
if (!hash.startsWith('h1:')) {
|
|
212
|
+
continue;
|
|
213
|
+
}
|
|
214
|
+
let base64Part = hash.slice(3);
|
|
215
|
+
let hexDigest = Buffer.from(base64Part, 'base64').toString('hex');
|
|
216
|
+
hashMap.set(`${mod}@${version}`, [{ alg: "SHA-256", content: hexDigest }]);
|
|
217
|
+
}
|
|
218
|
+
return hashMap;
|
|
219
|
+
}
|
|
189
220
|
/**
|
|
190
221
|
* Create SBOM json string for go Module.
|
|
191
222
|
* @param {string} manifest - path for go.mod
|
|
@@ -240,6 +271,7 @@ async function getSBOM(manifest, opts = {}, includeTransitive) {
|
|
|
240
271
|
if (matchManifestVersions === "true") {
|
|
241
272
|
performManifestVersionsCheck(root, rows, manifestContent, parser, requireQuery);
|
|
242
273
|
}
|
|
274
|
+
let goSumHashes = parseGoSumHashes(manifestDir);
|
|
243
275
|
const mainModule = toPurl(root, "@");
|
|
244
276
|
const license = readLicenseFromManifest(manifest);
|
|
245
277
|
sbom.addRoot(mainModule, license);
|
|
@@ -261,7 +293,7 @@ async function getSBOM(manifest, opts = {}, includeTransitive) {
|
|
|
261
293
|
if (getParentVertexFromEdge(row) === root && !directDepPaths.has(getPackageName(child))) {
|
|
262
294
|
return;
|
|
263
295
|
}
|
|
264
|
-
sbom.addDependency(source, target);
|
|
296
|
+
sbom.addDependency(source, target, undefined, goSumHashes.get(child));
|
|
265
297
|
});
|
|
266
298
|
// at the end, filter out all ignored dependencies including versions.
|
|
267
299
|
sbom.filterIgnoredDepsIncludingVersion(allIgnoredDeps);
|
|
@@ -274,12 +306,22 @@ async function getSBOM(manifest, opts = {}, includeTransitive) {
|
|
|
274
306
|
let target = toPurl(child, "@");
|
|
275
307
|
if (dependencyNotIgnored(ignoredDeps, target)) {
|
|
276
308
|
if (directDepPaths.has(getPackageName(child))) {
|
|
277
|
-
sbom.addDependency(mainModule, target);
|
|
309
|
+
sbom.addDependency(mainModule, target, undefined, goSumHashes.get(child));
|
|
278
310
|
}
|
|
279
311
|
}
|
|
280
312
|
});
|
|
281
313
|
enforceRemovingIgnoredDepsInCaseOfAutomaticVersionUpdate(ignoredDeps, sbom);
|
|
282
314
|
}
|
|
315
|
+
// Backfill hashes for components that were only seen as dependency sources
|
|
316
|
+
for (const comp of sbom.sbomModel.components) {
|
|
317
|
+
if (!comp.hashes && comp.purl) {
|
|
318
|
+
let key = decodeURIComponent(comp.purl.replace('pkg:golang/', ''));
|
|
319
|
+
let hashes = goSumHashes.get(key);
|
|
320
|
+
if (hashes) {
|
|
321
|
+
comp.hashes = hashes;
|
|
322
|
+
}
|
|
323
|
+
}
|
|
324
|
+
}
|
|
283
325
|
return sbom.getAsJsonString(opts);
|
|
284
326
|
}
|
|
285
327
|
/**
|
|
@@ -328,13 +370,7 @@ function getFinalPackagesVersionsForModule(rows, manifestPath, goBin) {
|
|
|
328
370
|
catch (error) {
|
|
329
371
|
throw new Error('failed to list all modules', { cause: error });
|
|
330
372
|
}
|
|
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
|
-
});
|
|
373
|
+
let finalVersionModules = parseModuleVersions(finalVersionsForAllModules);
|
|
338
374
|
let finalVersionModulesArray = new Array();
|
|
339
375
|
rows.filter(string => string.trim() !== "").forEach(module => {
|
|
340
376
|
let child = getChildVertexFromEdge(module);
|
|
@@ -395,7 +431,69 @@ function getVersionOfPackage(fullPackage) {
|
|
|
395
431
|
let parts = fullPackage.split("@");
|
|
396
432
|
return parts.length > 1 ? parts[1] : undefined;
|
|
397
433
|
}
|
|
434
|
+
function parseModuleVersions(goListOutput) {
|
|
435
|
+
let modules = {};
|
|
436
|
+
goListOutput.split(getLineSeparatorGolang()).filter(string => string.trim() !== "")
|
|
437
|
+
.forEach((line) => {
|
|
438
|
+
let parts = line.trim().split(" ");
|
|
439
|
+
if (parts.length === 2) {
|
|
440
|
+
modules[parts[0]] = parts[1];
|
|
441
|
+
}
|
|
442
|
+
else if (parts.length >= 4 && parts[2] === "=>") {
|
|
443
|
+
modules[parts[0]] = parts[parts.length - 1];
|
|
444
|
+
}
|
|
445
|
+
});
|
|
446
|
+
return modules;
|
|
447
|
+
}
|
|
398
448
|
function getLineSeparatorGolang() {
|
|
399
449
|
let reg = /\n|\r\n/;
|
|
400
450
|
return reg;
|
|
401
451
|
}
|
|
452
|
+
/**
|
|
453
|
+
* Discover all go.mod manifest paths in a Go workspace.
|
|
454
|
+
* Uses `go work edit -json` to get workspace members.
|
|
455
|
+
*
|
|
456
|
+
* @param {string} workspaceRoot - Absolute or relative path to workspace root (must contain go.work)
|
|
457
|
+
* @param {import('../index.js').Options} [opts={}]
|
|
458
|
+
* @returns {Promise<string[]>} Paths to go.mod files (absolute)
|
|
459
|
+
*/
|
|
460
|
+
export async function discoverGoWorkspaceModules(workspaceRoot, opts = {}) {
|
|
461
|
+
const root = path.resolve(workspaceRoot);
|
|
462
|
+
const goWork = path.join(root, 'go.work');
|
|
463
|
+
if (!fs.existsSync(goWork)) {
|
|
464
|
+
return [];
|
|
465
|
+
}
|
|
466
|
+
const goBin = getCustomPath('go', opts);
|
|
467
|
+
let output;
|
|
468
|
+
try {
|
|
469
|
+
output = invokeCommand(goBin, ['work', 'edit', '-json', goWork], { cwd: root });
|
|
470
|
+
}
|
|
471
|
+
catch {
|
|
472
|
+
return [];
|
|
473
|
+
}
|
|
474
|
+
let workspace;
|
|
475
|
+
try {
|
|
476
|
+
workspace = JSON.parse(output.toString().trim());
|
|
477
|
+
}
|
|
478
|
+
catch {
|
|
479
|
+
return [];
|
|
480
|
+
}
|
|
481
|
+
const useEntries = workspace.Use || [];
|
|
482
|
+
if (useEntries.length === 0) {
|
|
483
|
+
return [];
|
|
484
|
+
}
|
|
485
|
+
const manifestPaths = [];
|
|
486
|
+
for (const entry of useEntries) {
|
|
487
|
+
const diskPath = entry.DiskPath;
|
|
488
|
+
if (!diskPath) {
|
|
489
|
+
continue;
|
|
490
|
+
}
|
|
491
|
+
const moduleDir = path.resolve(root, diskPath);
|
|
492
|
+
const goMod = path.join(moduleDir, 'go.mod');
|
|
493
|
+
if (fs.existsSync(goMod)) {
|
|
494
|
+
manifestPaths.push(goMod);
|
|
495
|
+
}
|
|
496
|
+
}
|
|
497
|
+
const ignorePatterns = resolveWorkspaceDiscoveryIgnore(opts);
|
|
498
|
+
return filterManifestPathsByDiscoveryIgnore(manifestPaths, root, ignorePatterns);
|
|
499
|
+
}
|
|
@@ -1,3 +1,22 @@
|
|
|
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
|
+
}[];
|
|
1
20
|
/**
|
|
2
21
|
* This class provides common functionality for Groovy and Kotlin DSL files.
|
|
3
22
|
*/
|