@trustify-da/trustify-da-javascript-client 0.3.0-ea.b8af0f8 → 0.3.0-ea.bdaadb2
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 +250 -11
- package/dist/package.json +33 -25
- package/dist/src/analysis.d.ts +14 -7
- package/dist/src/analysis.js +32 -15
- package/dist/src/cli.js +156 -3
- package/dist/src/cyclone_dx_sbom.d.ts +27 -1
- package/dist/src/cyclone_dx_sbom.js +82 -9
- package/dist/src/index.d.ts +86 -11
- package/dist/src/index.js +102 -30
- 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/oci_image/utils.js +11 -2
- 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 +12 -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 +149 -9
- package/dist/src/providers/base_pyproject.d.ts +158 -0
- package/dist/src/providers/base_pyproject.js +322 -0
- 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 +23 -13
- package/dist/src/providers/golang_gomodules.js +207 -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 +67 -0
- package/dist/src/providers/java_gradle.js +310 -17
- 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 -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.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/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 +91 -7
- 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 +6 -6
- 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 +98 -0
- package/dist/src/providers/python_poetry.js +286 -0
- package/dist/src/providers/python_uv.d.ts +46 -0
- package/dist/src/providers/python_uv.js +269 -0
- 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/providers/tree-sitter-gomod.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 +25 -1
- package/dist/src/sbom.js +23 -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 +34 -26
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
import fs from 'node:fs';
|
|
2
2
|
import path from 'node:path';
|
|
3
|
-
import { EOL } from "os";
|
|
4
3
|
import { PackageURL } from 'packageurl-js';
|
|
5
4
|
import { readLicenseFile } from '../license/license_utils.js';
|
|
6
5
|
import Sbom from '../sbom.js';
|
|
7
6
|
import { getCustom, getCustomPath, invokeCommand } from "../tools.js";
|
|
8
|
-
|
|
7
|
+
import { filterManifestPathsByDiscoveryIgnore, resolveWorkspaceDiscoveryIgnore } from '../workspace.js';
|
|
8
|
+
import { getParser, getRequireQuery } from './gomod_parser.js';
|
|
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 */
|
|
@@ -17,46 +18,46 @@ export default { isSupported, validateLockFile, provideComponent, provideStack,
|
|
|
17
18
|
const ecosystem = 'golang';
|
|
18
19
|
const defaultMainModuleVersion = "v0.0.0";
|
|
19
20
|
/**
|
|
20
|
-
* @param {string} manifestName
|
|
21
|
-
* @returns {boolean}
|
|
21
|
+
* @param {string} manifestName the subject manifest name-type
|
|
22
|
+
* @returns {boolean} return true if `pom.xml` is the manifest name-type
|
|
22
23
|
*/
|
|
23
24
|
function isSupported(manifestName) {
|
|
24
25
|
return 'go.mod' === manifestName;
|
|
25
26
|
}
|
|
26
27
|
/**
|
|
27
28
|
* Go modules have no standard license field in go.mod
|
|
28
|
-
* @param {string} manifestPath
|
|
29
|
+
* @param {string} manifestPath path to go.mod
|
|
29
30
|
* @returns {string|null}
|
|
30
31
|
*/
|
|
31
32
|
// eslint-disable-next-line no-unused-vars
|
|
32
33
|
function readLicenseFromManifest(manifestPath) { return readLicenseFile(manifestPath); }
|
|
33
34
|
/**
|
|
34
|
-
* @param {string} manifestDir
|
|
35
|
+
* @param {string} manifestDir the directory where the manifest lies
|
|
35
36
|
*/
|
|
36
37
|
function validateLockFile() { return true; }
|
|
37
38
|
/**
|
|
38
39
|
* Provide content and content type for maven-maven stack analysis.
|
|
39
|
-
* @param {string} manifest
|
|
40
|
-
* @param {{}} [opts={}]
|
|
41
|
-
* @returns {Provided}
|
|
40
|
+
* @param {string} manifest the manifest path or name
|
|
41
|
+
* @param {{}} [opts={}] optional various options to pass along the application
|
|
42
|
+
* @returns {Promise<Provided>}
|
|
42
43
|
*/
|
|
43
|
-
function provideStack(manifest, opts = {}) {
|
|
44
|
+
async function provideStack(manifest, opts = {}) {
|
|
44
45
|
return {
|
|
45
46
|
ecosystem,
|
|
46
|
-
content: getSBOM(manifest, opts, true),
|
|
47
|
+
content: await getSBOM(manifest, opts, true),
|
|
47
48
|
contentType: 'application/vnd.cyclonedx+json'
|
|
48
49
|
};
|
|
49
50
|
}
|
|
50
51
|
/**
|
|
51
52
|
* Provide content and content type for maven-maven component analysis.
|
|
52
|
-
* @param {string} manifest
|
|
53
|
-
* @param {{}} [opts={}]
|
|
54
|
-
* @returns {Provided}
|
|
53
|
+
* @param {string} manifest path to go.mod for component report
|
|
54
|
+
* @param {{}} [opts={}] optional various options to pass along the application
|
|
55
|
+
* @returns {Promise<Provided>}
|
|
55
56
|
*/
|
|
56
|
-
function provideComponent(manifest, opts = {}) {
|
|
57
|
+
async function provideComponent(manifest, opts = {}) {
|
|
57
58
|
return {
|
|
58
59
|
ecosystem,
|
|
59
|
-
content: getSBOM(manifest, opts, false),
|
|
60
|
+
content: await getSBOM(manifest, opts, false),
|
|
60
61
|
contentType: 'application/vnd.cyclonedx+json'
|
|
61
62
|
};
|
|
62
63
|
}
|
|
@@ -77,50 +78,52 @@ function getChildVertexFromEdge(edge) {
|
|
|
77
78
|
return edge.split(" ")[1];
|
|
78
79
|
}
|
|
79
80
|
/**
|
|
80
|
-
*
|
|
81
|
-
*
|
|
82
|
-
*
|
|
81
|
+
* Check whether a require_spec has a valid exhortignore marker.
|
|
82
|
+
* For direct dependencies: `//exhortignore` or `// exhortignore`
|
|
83
|
+
* For indirect dependencies: `// indirect; exhortignore` (semicolon-separated)
|
|
84
|
+
* @param {import('web-tree-sitter').SyntaxNode} specNode
|
|
85
|
+
* @return {boolean}
|
|
83
86
|
*/
|
|
84
|
-
function
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
87
|
+
function hasExhortIgnore(specNode) {
|
|
88
|
+
// Ideally this would be the following tree-sitter query instead, but for some
|
|
89
|
+
// reason it throws an error here but not in the playground.
|
|
90
|
+
// (require_spec) ((module_path) @path (version) (comment) @comment (#match? @comment "^//.*exhortignore"))
|
|
91
|
+
// QueryError: Bad pattern structure at offset 53: '(comment) @comment (#match? @comment "^//.*exhortignore")) @spec'...
|
|
92
|
+
let comments = specNode.children.filter(c => c.type === 'comment');
|
|
93
|
+
for (let comment of comments) {
|
|
94
|
+
let text = comment.text;
|
|
95
|
+
if (/^\/\/\s*indirect;\s*exhortignore/.test(text)) {
|
|
96
|
+
return true;
|
|
97
|
+
}
|
|
98
|
+
if (/^\/\/\s*exhortignore/.test(text)) {
|
|
99
|
+
return true;
|
|
96
100
|
}
|
|
97
101
|
}
|
|
98
|
-
return
|
|
99
|
-
}
|
|
100
|
-
/**
|
|
101
|
-
* extract package name from go.mod line that contains exhortignore comment.
|
|
102
|
-
* @param line a row contains exhortignore as part of a comment
|
|
103
|
-
* @return {string} the full package name + group/namespace + version
|
|
104
|
-
* @private
|
|
105
|
-
*/
|
|
106
|
-
function extractPackageName(line) {
|
|
107
|
-
let trimmedRow = line.trim();
|
|
108
|
-
let firstRemarkNotationOccurrence = trimmedRow.indexOf("//");
|
|
109
|
-
return trimmedRow.substring(0, firstRemarkNotationOccurrence).trim();
|
|
102
|
+
return false;
|
|
110
103
|
}
|
|
111
104
|
/**
|
|
112
105
|
*
|
|
113
|
-
* @param {string
|
|
114
|
-
* @
|
|
106
|
+
* @param {string} manifestContent go.mod file contents
|
|
107
|
+
* @param {import('web-tree-sitter').Parser} parser
|
|
108
|
+
* @param {import('web-tree-sitter').Query} requireQuery
|
|
109
|
+
* @return {PackageURL[]} list of ignored dependencies
|
|
115
110
|
*/
|
|
116
|
-
function getIgnoredDeps(
|
|
117
|
-
let
|
|
118
|
-
|
|
119
|
-
|
|
111
|
+
function getIgnoredDeps(manifestContent, parser, requireQuery) {
|
|
112
|
+
let tree = parser.parse(manifestContent);
|
|
113
|
+
return requireQuery.matches(tree.rootNode)
|
|
114
|
+
.filter(match => {
|
|
115
|
+
let specNode = match.captures.find(c => c.name === 'spec').node;
|
|
116
|
+
return hasExhortIgnore(specNode);
|
|
117
|
+
})
|
|
118
|
+
.map(match => {
|
|
119
|
+
let name = match.captures.find(c => c.name === 'name').node.text;
|
|
120
|
+
let version = match.captures.find(c => c.name === 'version').node.text;
|
|
121
|
+
return toPurl(`${name} ${version}`, /[ ]{1,3}/);
|
|
122
|
+
});
|
|
120
123
|
}
|
|
121
124
|
/**
|
|
122
125
|
*
|
|
123
|
-
* @param {[
|
|
126
|
+
* @param {PackageURL[]} allIgnoredDeps list of purls of all dependencies that should be ignored
|
|
124
127
|
* @param {PackageURL} purl object to be checked if needed to be ignored
|
|
125
128
|
* @return {boolean}
|
|
126
129
|
*/
|
|
@@ -139,59 +142,29 @@ function enforceRemovingIgnoredDepsInCaseOfAutomaticVersionUpdate(ignoredDeps, s
|
|
|
139
142
|
}
|
|
140
143
|
/**
|
|
141
144
|
*
|
|
142
|
-
* @param {
|
|
143
|
-
* @param {
|
|
144
|
-
* @
|
|
145
|
+
* @param {string} manifestContent go.mod file contents
|
|
146
|
+
* @param {import('web-tree-sitter').Parser} parser
|
|
147
|
+
* @param {import('web-tree-sitter').Query} requireQuery
|
|
148
|
+
* @return {string[]} all dependencies from go.mod file as "name version" strings
|
|
145
149
|
*/
|
|
146
|
-
function collectAllDepsFromManifest(
|
|
147
|
-
let
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
while (requirePositionObject.index > -1) {
|
|
154
|
-
let depsInsideRequirementsBlock = currentSegmentOfGoMod.substring(requirePositionObject.index + requirePositionObject.startingOffeset).trim();
|
|
155
|
-
let endOfBlockIndex = depsInsideRequirementsBlock.indexOf(")");
|
|
156
|
-
let currentIndex = 0;
|
|
157
|
-
while (currentIndex < endOfBlockIndex) {
|
|
158
|
-
let endOfLinePosition = depsInsideRequirementsBlock.indexOf(EOL, currentIndex);
|
|
159
|
-
let dependency = depsInsideRequirementsBlock.substring(currentIndex, endOfLinePosition);
|
|
160
|
-
result.push(dependency.trim());
|
|
161
|
-
currentIndex = endOfLinePosition + 1;
|
|
162
|
-
}
|
|
163
|
-
currentSegmentOfGoMod = currentSegmentOfGoMod.substring(endOfBlockIndex + 1).trim();
|
|
164
|
-
requirePositionObject = decideRequireBlockIndex(currentSegmentOfGoMod);
|
|
165
|
-
}
|
|
166
|
-
function decideRequireBlockIndex(goMod) {
|
|
167
|
-
let object = {};
|
|
168
|
-
let index = goMod.indexOf("require(");
|
|
169
|
-
object.startingOffeset = "require(".length;
|
|
170
|
-
if (index === -1) {
|
|
171
|
-
index = goMod.indexOf("require (");
|
|
172
|
-
object.startingOffeset = "require (".length;
|
|
173
|
-
if (index === -1) {
|
|
174
|
-
index = goMod.indexOf("require (");
|
|
175
|
-
object.startingOffeset = "require (".length;
|
|
176
|
-
}
|
|
177
|
-
}
|
|
178
|
-
object.index = index;
|
|
179
|
-
return object;
|
|
180
|
-
}
|
|
181
|
-
return result;
|
|
150
|
+
function collectAllDepsFromManifest(manifestContent, parser, requireQuery) {
|
|
151
|
+
let tree = parser.parse(manifestContent);
|
|
152
|
+
return requireQuery.matches(tree.rootNode).map(match => {
|
|
153
|
+
let name = match.captures.find(c => c.name === 'name').node.text;
|
|
154
|
+
let version = match.captures.find(c => c.name === 'version').node.text;
|
|
155
|
+
return `${name} ${version}`;
|
|
156
|
+
});
|
|
182
157
|
}
|
|
183
158
|
/**
|
|
184
159
|
*
|
|
185
160
|
* @param {string} rootElementName the rootElementName element of go mod graph, to compare only direct deps from go mod graph against go.mod manifest
|
|
186
|
-
* @param{[
|
|
187
|
-
* @param {string
|
|
161
|
+
* @param {string[]} goModGraphOutputRows the goModGraphOutputRows from go mod graph' output
|
|
162
|
+
* @param {string} manifestContent go.mod file contents
|
|
188
163
|
* @private
|
|
189
164
|
*/
|
|
190
|
-
function performManifestVersionsCheck(rootElementName, goModGraphOutputRows,
|
|
191
|
-
let goMod = fs.readFileSync(manifest).toString().trim();
|
|
192
|
-
let lines = goMod.split(getLineSeparatorGolang());
|
|
165
|
+
function performManifestVersionsCheck(rootElementName, goModGraphOutputRows, manifestContent, parser, requireQuery) {
|
|
193
166
|
let comparisonLines = goModGraphOutputRows.filter((line) => line.startsWith(rootElementName)).map((line) => getChildVertexFromEdge(line));
|
|
194
|
-
let manifestDeps = collectAllDepsFromManifest(
|
|
167
|
+
let manifestDeps = collectAllDepsFromManifest(manifestContent, parser, requireQuery);
|
|
195
168
|
try {
|
|
196
169
|
comparisonLines.forEach((dependency) => {
|
|
197
170
|
let parts = dependency.split("@");
|
|
@@ -203,7 +176,7 @@ function performManifestVersionsCheck(rootElementName, goModGraphOutputRows, man
|
|
|
203
176
|
let currentVersion = components[1];
|
|
204
177
|
if (currentDepName === depName) {
|
|
205
178
|
if (currentVersion !== version) {
|
|
206
|
-
throw new Error(`
|
|
179
|
+
throw new Error(`version mismatch for dependency "${depName}", manifest version=${currentVersion}, installed version=${version}, if you want to allow version mismatch for analysis between installed and requested packages, set environment variable/setting MATCH_MANIFEST_VERSIONS=false`);
|
|
207
180
|
}
|
|
208
181
|
}
|
|
209
182
|
});
|
|
@@ -214,15 +187,45 @@ function performManifestVersionsCheck(rootElementName, goModGraphOutputRows, man
|
|
|
214
187
|
throw error;
|
|
215
188
|
}
|
|
216
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
|
+
}
|
|
217
220
|
/**
|
|
218
221
|
* Create SBOM json string for go Module.
|
|
219
222
|
* @param {string} manifest - path for go.mod
|
|
220
223
|
* @param {{}} [opts={}] - optional various options to pass along the application
|
|
221
224
|
* @param {boolean} includeTransitive - whether the sbom should contain transitive dependencies of the main module or not.
|
|
222
|
-
* @returns {string} the SBOM json content
|
|
225
|
+
* @returns {Promise<string>} the SBOM json content
|
|
223
226
|
* @private
|
|
224
227
|
*/
|
|
225
|
-
function getSBOM(manifest, opts = {}, includeTransitive) {
|
|
228
|
+
async function getSBOM(manifest, opts = {}, includeTransitive) {
|
|
226
229
|
// get custom goBin path
|
|
227
230
|
let goBin = getCustomPath('go', opts);
|
|
228
231
|
// verify goBin is accessible
|
|
@@ -248,15 +251,27 @@ function getSBOM(manifest, opts = {}, includeTransitive) {
|
|
|
248
251
|
catch (error) {
|
|
249
252
|
throw new Error('failed to determine root module name', { cause: error });
|
|
250
253
|
}
|
|
251
|
-
let
|
|
254
|
+
let manifestContent = fs.readFileSync(manifest).toString();
|
|
255
|
+
let [parser, requireQuery] = await Promise.all([getParser(), getRequireQuery()]);
|
|
256
|
+
let ignoredDeps = getIgnoredDeps(manifestContent, parser, requireQuery);
|
|
252
257
|
let allIgnoredDeps = ignoredDeps.map((dep) => dep.toString());
|
|
253
258
|
let sbom = new Sbom();
|
|
254
259
|
let rows = goGraphOutput.split(getLineSeparatorGolang()).filter(line => !line.includes(' go@'));
|
|
255
|
-
let root =
|
|
260
|
+
let root = goModEditOutput['Module']['Path'];
|
|
261
|
+
// Build set of direct dependency paths from go mod edit -json
|
|
262
|
+
let directDepPaths = new Set();
|
|
263
|
+
if (goModEditOutput['Require']) {
|
|
264
|
+
goModEditOutput['Require'].forEach(req => {
|
|
265
|
+
if (!req['Indirect']) {
|
|
266
|
+
directDepPaths.add(req['Path']);
|
|
267
|
+
}
|
|
268
|
+
});
|
|
269
|
+
}
|
|
256
270
|
let matchManifestVersions = getCustom("MATCH_MANIFEST_VERSIONS", "false", opts);
|
|
257
271
|
if (matchManifestVersions === "true") {
|
|
258
|
-
performManifestVersionsCheck(root, rows,
|
|
272
|
+
performManifestVersionsCheck(root, rows, manifestContent, parser, requireQuery);
|
|
259
273
|
}
|
|
274
|
+
let goSumHashes = parseGoSumHashes(manifestDir);
|
|
260
275
|
const mainModule = toPurl(root, "@");
|
|
261
276
|
const license = readLicenseFromManifest(manifest);
|
|
262
277
|
sbom.addRoot(mainModule, license);
|
|
@@ -273,8 +288,12 @@ function getSBOM(manifest, opts = {}, includeTransitive) {
|
|
|
273
288
|
currentParent = getParentVertexFromEdge(row);
|
|
274
289
|
source = toPurl(currentParent, "@");
|
|
275
290
|
}
|
|
276
|
-
let
|
|
277
|
-
|
|
291
|
+
let child = getChildVertexFromEdge(row);
|
|
292
|
+
let target = toPurl(child, "@");
|
|
293
|
+
if (getParentVertexFromEdge(row) === root && !directDepPaths.has(getPackageName(child))) {
|
|
294
|
+
return;
|
|
295
|
+
}
|
|
296
|
+
sbom.addDependency(source, target, undefined, goSumHashes.get(child));
|
|
278
297
|
});
|
|
279
298
|
// at the end, filter out all ignored dependencies including versions.
|
|
280
299
|
sbom.filterIgnoredDepsIncludingVersion(allIgnoredDeps);
|
|
@@ -283,20 +302,32 @@ function getSBOM(manifest, opts = {}, includeTransitive) {
|
|
|
283
302
|
else {
|
|
284
303
|
let directDependencies = rows.filter(row => row.startsWith(root));
|
|
285
304
|
directDependencies.forEach(pair => {
|
|
286
|
-
let
|
|
287
|
-
let
|
|
288
|
-
if (dependencyNotIgnored(ignoredDeps,
|
|
289
|
-
|
|
305
|
+
let child = getChildVertexFromEdge(pair);
|
|
306
|
+
let target = toPurl(child, "@");
|
|
307
|
+
if (dependencyNotIgnored(ignoredDeps, target)) {
|
|
308
|
+
if (directDepPaths.has(getPackageName(child))) {
|
|
309
|
+
sbom.addDependency(mainModule, target, undefined, goSumHashes.get(child));
|
|
310
|
+
}
|
|
290
311
|
}
|
|
291
312
|
});
|
|
292
313
|
enforceRemovingIgnoredDepsInCaseOfAutomaticVersionUpdate(ignoredDeps, sbom);
|
|
293
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
|
+
}
|
|
294
325
|
return sbom.getAsJsonString(opts);
|
|
295
326
|
}
|
|
296
327
|
/**
|
|
297
328
|
* Utility function for creating Purl String
|
|
298
329
|
|
|
299
|
-
* @param {string
|
|
330
|
+
* @param {string} dependency the name of the artifact, can include a namespace(group) or not - namespace/artifactName.
|
|
300
331
|
* @param {RegExp} delimiter delimiter between name of dependency and version
|
|
301
332
|
* @private
|
|
302
333
|
* @returns {PackageURL|null} PackageUrl Object ready to be used in SBOM
|
|
@@ -321,12 +352,12 @@ function toPurl(dependency, delimiter) {
|
|
|
321
352
|
}
|
|
322
353
|
return pkg;
|
|
323
354
|
}
|
|
324
|
-
/** This function gets rows from go mod graph
|
|
355
|
+
/** This function gets rows from go mod graph, and go.mod graph, and selecting for all
|
|
325
356
|
* packages the has more than one minor the final versions as selected by golang MVS algorithm.
|
|
326
|
-
* @param {[
|
|
357
|
+
* @param {string[]} rows all the rows from go modules dependency tree
|
|
327
358
|
* @param {string} manifestPath the path of the go.mod file
|
|
328
359
|
* @param {string} path to go binary
|
|
329
|
-
* @return {[
|
|
360
|
+
* @return {string[]} rows that contains final versions.
|
|
330
361
|
*/
|
|
331
362
|
function getFinalPackagesVersionsForModule(rows, manifestPath, goBin) {
|
|
332
363
|
let manifestDir = path.dirname(manifestPath);
|
|
@@ -339,13 +370,7 @@ function getFinalPackagesVersionsForModule(rows, manifestPath, goBin) {
|
|
|
339
370
|
catch (error) {
|
|
340
371
|
throw new Error('failed to list all modules', { cause: error });
|
|
341
372
|
}
|
|
342
|
-
let finalVersionModules =
|
|
343
|
-
finalVersionsForAllModules.split(getLineSeparatorGolang()).filter(string => string.trim() !== "")
|
|
344
|
-
.filter(string => string.trim().split(" ").length === 2)
|
|
345
|
-
.forEach((dependency) => {
|
|
346
|
-
let dep = dependency.split(" ");
|
|
347
|
-
finalVersionModules[dep[0]] = dep[1];
|
|
348
|
-
});
|
|
373
|
+
let finalVersionModules = parseModuleVersions(finalVersionsForAllModules);
|
|
349
374
|
let finalVersionModulesArray = new Array();
|
|
350
375
|
rows.filter(string => string.trim() !== "").forEach(module => {
|
|
351
376
|
let child = getChildVertexFromEdge(module);
|
|
@@ -381,7 +406,7 @@ function getFinalPackagesVersionsForModule(rows, manifestPath, goBin) {
|
|
|
381
406
|
/**
|
|
382
407
|
*
|
|
383
408
|
* @param {string} fullPackage - full package with its name and version
|
|
384
|
-
* @return
|
|
409
|
+
* @return {string} package name only
|
|
385
410
|
* @private
|
|
386
411
|
*/
|
|
387
412
|
function getPackageName(fullPackage) {
|
|
@@ -399,14 +424,76 @@ function isSpecialGoModule(moduleName) {
|
|
|
399
424
|
/**
|
|
400
425
|
*
|
|
401
426
|
* @param {string} fullPackage - full package with its name and version
|
|
402
|
-
* @return
|
|
427
|
+
* @return {string|undefined} package version only
|
|
403
428
|
* @private
|
|
404
429
|
*/
|
|
405
430
|
function getVersionOfPackage(fullPackage) {
|
|
406
431
|
let parts = fullPackage.split("@");
|
|
407
432
|
return parts.length > 1 ? parts[1] : undefined;
|
|
408
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
|
+
}
|
|
409
448
|
function getLineSeparatorGolang() {
|
|
410
449
|
let reg = /\n|\r\n/;
|
|
411
450
|
return reg;
|
|
412
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
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { readFile } from 'node:fs/promises';
|
|
2
|
+
import { Language, Parser, Query } from 'web-tree-sitter';
|
|
3
|
+
const wasmUrl = new URL('./tree-sitter-gomod.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 getRequireQuery() {
|
|
14
|
+
const language = await init();
|
|
15
|
+
return new Query(language, '(require_spec (module_path) @name (version) @version) @spec');
|
|
16
|
+
}
|
|
@@ -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;
|