@trustify-da/trustify-da-javascript-client 0.3.0-ea.e12bc82 → 0.3.0-ea.e258fba
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 +367 -13
- package/dist/package.json +48 -28
- package/dist/src/analysis.d.ts +28 -5
- package/dist/src/analysis.js +99 -89
- package/dist/src/batch_opts.d.ts +24 -0
- package/dist/src/batch_opts.js +35 -0
- package/dist/src/cli.js +346 -9
- package/dist/src/cyclone_dx_sbom.d.ts +30 -3
- package/dist/src/cyclone_dx_sbom.js +95 -9
- package/dist/src/index.d.ts +202 -12
- package/dist/src/index.js +365 -30
- package/dist/src/license/index.d.ts +28 -0
- package/dist/src/license/index.js +103 -0
- package/dist/src/license/license_utils.d.ts +40 -0
- package/dist/src/license/license_utils.js +137 -0
- package/dist/src/license/licenses_api.d.ts +34 -0
- package/dist/src/license/licenses_api.js +98 -0
- package/dist/src/license/project_license.d.ts +20 -0
- package/dist/src/license/project_license.js +62 -0
- package/dist/src/oci_image/images.d.ts +4 -5
- package/dist/src/oci_image/images.js +15 -1
- package/dist/src/oci_image/utils.d.ts +7 -7
- 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 +18 -5
- package/dist/src/provider.js +33 -5
- package/dist/src/providers/base_java.d.ts +68 -15
- package/dist/src/providers/base_java.js +82 -61
- package/dist/src/providers/base_javascript.d.ts +99 -12
- package/dist/src/providers/base_javascript.js +243 -27
- 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 +30 -13
- package/dist/src/providers/golang_gomodules.js +219 -122
- 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 +76 -3
- package/dist/src/providers/java_gradle.js +323 -21
- 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 +45 -10
- package/dist/src/providers/java_maven.js +300 -14
- 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 +14 -1
- package/dist/src/providers/javascript_pnpm.js +55 -5
- 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 +28 -7
- 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 +10 -3
- package/dist/src/providers/python_controller.js +122 -63
- package/dist/src/providers/python_pip.d.ts +16 -4
- package/dist/src/providers/python_pip.js +51 -58
- 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/requirements_parser.d.ts +6 -0
- package/dist/src/providers/requirements_parser.js +24 -0
- package/dist/src/providers/rust_cargo.d.ts +56 -0
- package/dist/src/providers/rust_cargo.js +682 -0
- package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
- package/dist/src/providers/tree-sitter-gomod.wasm +0 -0
- package/dist/src/providers/tree-sitter-requirements.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 +28 -2
- package/dist/src/sbom.js +26 -4
- package/dist/src/tools.d.ts +48 -6
- package/dist/src/tools.js +138 -2
- 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 +70 -0
- package/dist/src/workspace.js +256 -0
- package/package.json +49 -29
|
@@ -1,14 +1,19 @@
|
|
|
1
|
+
import crypto from 'node:crypto';
|
|
1
2
|
import fs from 'node:fs';
|
|
3
|
+
import os from 'node:os';
|
|
2
4
|
import path from 'node:path';
|
|
3
5
|
import { EOL } from 'os';
|
|
4
|
-
import
|
|
6
|
+
import { parse as parseToml } from 'smol-toml';
|
|
7
|
+
import { readLicenseFile } from '../license/license_utils.js';
|
|
5
8
|
import Sbom from '../sbom.js';
|
|
9
|
+
import { invokeCommand } from '../tools.js';
|
|
10
|
+
import { filterManifestPathsByDiscoveryIgnore, resolveWorkspaceDiscoveryIgnore } from '../workspace.js';
|
|
6
11
|
import Base_java, { ecosystem_gradle } from "./base_java.js";
|
|
7
12
|
/** @typedef {import('../provider.js').Provider} */
|
|
8
13
|
/** @typedef {import('../provider.js').Provided} Provided */
|
|
9
14
|
const ROOT_PROJECT_KEY_NAME = "root-project";
|
|
10
|
-
const TRUSTIFY_DA_IGNORE_REGEX_LINE = /.*\s?exhortignore\s*$/g;
|
|
11
|
-
const TRUSTIFY_DA_IGNORE_REGEX = /\/\/\s?exhortignore/;
|
|
15
|
+
const TRUSTIFY_DA_IGNORE_REGEX_LINE = /.*\s?(exhortignore|trustify-da-ignore)\s*$/g;
|
|
16
|
+
const TRUSTIFY_DA_IGNORE_REGEX = /\/\/\s?(exhortignore|trustify-da-ignore)/;
|
|
12
17
|
/**
|
|
13
18
|
* Check if the dependency marked for exclusion has libs notation , so if it's true the rest of coordinates( GAV) should be fetched from TOML file.
|
|
14
19
|
* @param {string} depToBeIgnored
|
|
@@ -49,16 +54,22 @@ export default class Java_gradle extends Base_java {
|
|
|
49
54
|
* @param {string} manifestDir - the directory where the manifest lies
|
|
50
55
|
*/
|
|
51
56
|
validateLockFile() { return true; }
|
|
57
|
+
/**
|
|
58
|
+
* Gradle manifests (build.gradle, build.gradle.kts) have no standard license field.
|
|
59
|
+
* @param {string} manifestPath - path to manifest
|
|
60
|
+
* @returns {null}
|
|
61
|
+
*/
|
|
62
|
+
readLicenseFromManifest(manifestPath) { return readLicenseFile(manifestPath); }
|
|
52
63
|
/**
|
|
53
64
|
* Provide content and content type for stack analysis.
|
|
54
65
|
* @param {string} manifest - the manifest path or name
|
|
55
66
|
* @param {{}} [opts={}] - optional various options to pass along the application
|
|
56
67
|
* @returns {Provided}
|
|
57
68
|
*/
|
|
58
|
-
provideStack(manifest, opts = {}) {
|
|
69
|
+
async provideStack(manifest, opts = {}) {
|
|
59
70
|
return {
|
|
60
71
|
ecosystem: ecosystem_gradle,
|
|
61
|
-
content: this.#createSbomStackAnalysis(manifest, opts),
|
|
72
|
+
content: await this.#createSbomStackAnalysis(manifest, opts),
|
|
62
73
|
contentType: 'application/vnd.cyclonedx+json'
|
|
63
74
|
};
|
|
64
75
|
}
|
|
@@ -68,10 +79,10 @@ export default class Java_gradle extends Base_java {
|
|
|
68
79
|
* @param {{}} [opts={}] - optional various options to pass along the application
|
|
69
80
|
* @returns {Provided}
|
|
70
81
|
*/
|
|
71
|
-
provideComponent(manifest, opts = {}) {
|
|
82
|
+
async provideComponent(manifest, opts = {}) {
|
|
72
83
|
return {
|
|
73
84
|
ecosystem: ecosystem_gradle,
|
|
74
|
-
content: this.#getSbomForComponentAnalysis(manifest, opts),
|
|
85
|
+
content: await this.#getSbomForComponentAnalysis(manifest, opts),
|
|
75
86
|
contentType: 'application/vnd.cyclonedx+json'
|
|
76
87
|
};
|
|
77
88
|
}
|
|
@@ -121,9 +132,10 @@ export default class Java_gradle extends Base_java {
|
|
|
121
132
|
* @param {Sbom} sbom - the SBOM object to add dependencies to
|
|
122
133
|
* @param {Set} processedDeps - set of already processed dependencies
|
|
123
134
|
* @param {string} scope - the dependency scope
|
|
135
|
+
* @param {Map<string, Array<{alg: string, content: string}>>} [hashMap] - map of "group:name@version" to CycloneDX hashes
|
|
124
136
|
* @private
|
|
125
137
|
*/
|
|
126
|
-
#processDependencyTree(config, parentPurl, sbom, processedDeps, scope) {
|
|
138
|
+
#processDependencyTree(config, parentPurl, sbom, processedDeps, scope, hashMap) {
|
|
127
139
|
const processedLines = this.#prepareLinesForParsingDependencyTree(config);
|
|
128
140
|
let parentStack = [parentPurl];
|
|
129
141
|
for (const { line, depth } of processedLines) {
|
|
@@ -141,7 +153,7 @@ export default class Java_gradle extends Base_java {
|
|
|
141
153
|
// Add dependency to SBOM if not already processed
|
|
142
154
|
if (!processedDeps.has(depKey)) {
|
|
143
155
|
processedDeps.add(depKey);
|
|
144
|
-
sbom.addDependency(currentParent, purl, scope);
|
|
156
|
+
sbom.addDependency(currentParent, purl, scope, hashMap?.get(purl.toString()));
|
|
145
157
|
}
|
|
146
158
|
parentStack.push(purl);
|
|
147
159
|
}
|
|
@@ -154,16 +166,17 @@ export default class Java_gradle extends Base_java {
|
|
|
154
166
|
* @returns {string} the Dot Graph content
|
|
155
167
|
* @private
|
|
156
168
|
*/
|
|
157
|
-
#buildSbom(content, properties, manifestPath, opts = {}) {
|
|
169
|
+
#buildSbom(content, properties, manifestPath, opts = {}, hashMap) {
|
|
158
170
|
let sbom = new Sbom();
|
|
159
171
|
let root = `${properties.group}:${properties[ROOT_PROJECT_KEY_NAME].match(/Root project '(.+)'/)[1]}:jar:${properties.version}`;
|
|
160
172
|
let rootPurl = this.parseDep(root);
|
|
161
|
-
|
|
173
|
+
const license = this.readLicenseFromManifest(manifestPath);
|
|
174
|
+
sbom.addRoot(rootPurl, license);
|
|
162
175
|
let ignoredDeps = this.#getIgnoredDeps(manifestPath);
|
|
163
176
|
const [runtimeConfig, compileConfig] = this.#extractConfigurations(content);
|
|
164
177
|
const processedDeps = new Set();
|
|
165
|
-
this.#processDependencyTree(runtimeConfig, rootPurl, sbom, processedDeps, 'required');
|
|
166
|
-
this.#processDependencyTree(compileConfig, rootPurl, sbom, processedDeps, 'optional');
|
|
178
|
+
this.#processDependencyTree(runtimeConfig, rootPurl, sbom, processedDeps, 'required', hashMap);
|
|
179
|
+
this.#processDependencyTree(compileConfig, rootPurl, sbom, processedDeps, 'optional', hashMap);
|
|
167
180
|
return sbom.filterIgnoredDepsIncludingVersion(ignoredDeps).getAsJsonString(opts);
|
|
168
181
|
}
|
|
169
182
|
/**
|
|
@@ -173,14 +186,15 @@ export default class Java_gradle extends Base_java {
|
|
|
173
186
|
* @returns {string} the Dot Graph content
|
|
174
187
|
* @private
|
|
175
188
|
*/
|
|
176
|
-
#createSbomStackAnalysis(manifest, opts = {}) {
|
|
189
|
+
async #createSbomStackAnalysis(manifest, opts = {}) {
|
|
177
190
|
let content = this.#getDependencies(manifest, opts);
|
|
178
191
|
let properties = this.#extractProperties(manifest, opts);
|
|
192
|
+
let hashMap = await this.parseGradleHashes(manifest, opts);
|
|
179
193
|
// read dependency tree from temp file
|
|
180
194
|
if (process.env["TRUSTIFY_DA_DEBUG"] === "true") {
|
|
181
195
|
console.log("Dependency tree that will be used as input for creating the BOM =>" + EOL + EOL + content);
|
|
182
196
|
}
|
|
183
|
-
let sbom = this.#buildSbom(content, properties, manifest, opts);
|
|
197
|
+
let sbom = this.#buildSbom(content, properties, manifest, opts, hashMap);
|
|
184
198
|
return sbom;
|
|
185
199
|
}
|
|
186
200
|
/**
|
|
@@ -225,10 +239,11 @@ export default class Java_gradle extends Base_java {
|
|
|
225
239
|
* @returns {string} - sbom string of the direct dependencies of build.gradle
|
|
226
240
|
* @private
|
|
227
241
|
*/
|
|
228
|
-
#getSbomForComponentAnalysis(manifestPath, opts = {}) {
|
|
242
|
+
async #getSbomForComponentAnalysis(manifestPath, opts = {}) {
|
|
229
243
|
let content = this.#getDependencies(manifestPath, opts);
|
|
230
244
|
let properties = this.#extractProperties(manifestPath, opts);
|
|
231
|
-
let
|
|
245
|
+
let hashMap = await this.parseGradleHashes(manifestPath, opts);
|
|
246
|
+
let sbom = this.#buildDirectDependenciesSbom(content, properties, manifestPath, opts, hashMap);
|
|
232
247
|
return sbom;
|
|
233
248
|
}
|
|
234
249
|
/**
|
|
@@ -247,6 +262,112 @@ export default class Java_gradle extends Base_java {
|
|
|
247
262
|
throw new Error(`Couldn't run gradle dependencies command, error message returned from gradle binary => ${EOL} ${error.message}`);
|
|
248
263
|
}
|
|
249
264
|
}
|
|
265
|
+
/**
|
|
266
|
+
* Hash a file using SHA-256 with streaming to handle large files efficiently.
|
|
267
|
+
* @param {string} filePath - path to the file to hash
|
|
268
|
+
* @returns {Promise<string>} hex-encoded SHA-256 digest
|
|
269
|
+
* @private
|
|
270
|
+
*/
|
|
271
|
+
#hashFileStream(filePath) {
|
|
272
|
+
return new Promise((resolve, reject) => {
|
|
273
|
+
const hash = crypto.createHash('sha256');
|
|
274
|
+
const stream = fs.createReadStream(filePath);
|
|
275
|
+
stream.on('data', chunk => hash.update(chunk));
|
|
276
|
+
stream.on('end', () => resolve(hash.digest('hex')));
|
|
277
|
+
stream.on('error', reject);
|
|
278
|
+
});
|
|
279
|
+
}
|
|
280
|
+
/**
|
|
281
|
+
* Compute SHA-256 hashes for the resolved artifacts of a Gradle manifest.
|
|
282
|
+
*
|
|
283
|
+
* Rather than scanning the local Gradle cache, this asks Gradle itself for
|
|
284
|
+
* the resolved artifact files via an init script (mirroring the pattern used
|
|
285
|
+
* by {@link discoverGradleSubprojects}), then hashes each file with the
|
|
286
|
+
* Node.js `crypto` module. The result is keyed by the canonical PURL string
|
|
287
|
+
* built via {@link Base_java#toPurl} — the same builder {@link parseDep} uses
|
|
288
|
+
* for the lookup — so the stored key and the lookup key cannot drift.
|
|
289
|
+
*
|
|
290
|
+
* Degrades gracefully: if Gradle cannot be invoked, the init script fails, or
|
|
291
|
+
* an artifact has no readable file (e.g. BOM/`platform()` dependencies), the
|
|
292
|
+
* hash for that component is omitted rather than throwing. A warning is emitted
|
|
293
|
+
* on every degradation path so incomplete hash coverage is visible even without
|
|
294
|
+
* `TRUSTIFY_DA_DEBUG` (mirroring the pip/cargo providers).
|
|
295
|
+
*
|
|
296
|
+
* @param {string} manifest - path to build.gradle[.kts]
|
|
297
|
+
* @param {{}} [opts={}] - optional various options to pass along the application
|
|
298
|
+
* @returns {Promise<Map<string, Array<{alg: string, content: string}>>>} map of canonical PURL string to CycloneDX hashes
|
|
299
|
+
*/
|
|
300
|
+
async parseGradleHashes(manifest, opts = {}) {
|
|
301
|
+
const hashMap = new Map();
|
|
302
|
+
const debug = process.env["TRUSTIFY_DA_DEBUG"] === "true";
|
|
303
|
+
let gradle;
|
|
304
|
+
try {
|
|
305
|
+
gradle = this.selectToolBinary(manifest, opts);
|
|
306
|
+
}
|
|
307
|
+
catch (error) {
|
|
308
|
+
console.warn(`Gradle could not be invoked to compute artifact hashes, SBOM will be generated without hashes: ${error.stack || error.message}`);
|
|
309
|
+
return hashMap;
|
|
310
|
+
}
|
|
311
|
+
const initScriptPath = path.join(os.tmpdir(), `da-list-hashes-${crypto.randomUUID()}.gradle`);
|
|
312
|
+
try {
|
|
313
|
+
fs.writeFileSync(initScriptPath, GRADLE_HASH_INIT_SCRIPT);
|
|
314
|
+
let output;
|
|
315
|
+
try {
|
|
316
|
+
output = this._invokeCommand(gradle, [
|
|
317
|
+
'-q', '--no-daemon',
|
|
318
|
+
'--init-script', initScriptPath,
|
|
319
|
+
'daListHashes',
|
|
320
|
+
], { cwd: path.dirname(manifest) });
|
|
321
|
+
}
|
|
322
|
+
catch (error) {
|
|
323
|
+
console.warn(`Gradle hash init script failed, SBOM will be generated without hashes: ${error.stack || error.message}`);
|
|
324
|
+
return hashMap;
|
|
325
|
+
}
|
|
326
|
+
let attempted = 0;
|
|
327
|
+
let missed = 0;
|
|
328
|
+
for (const { id, file } of parseGradleHashScriptOutput(output.toString())) {
|
|
329
|
+
const coord = parseComponentId(id);
|
|
330
|
+
if (!coord) {
|
|
331
|
+
continue;
|
|
332
|
+
}
|
|
333
|
+
// Build the key with the same canonical PURL builder parseDep uses for
|
|
334
|
+
// the lookup, so the stored key and the lookup key cannot drift.
|
|
335
|
+
const key = this.toPurl(coord.group, coord.name, coord.version).toString();
|
|
336
|
+
if (hashMap.has(key)) {
|
|
337
|
+
continue;
|
|
338
|
+
}
|
|
339
|
+
attempted++;
|
|
340
|
+
try {
|
|
341
|
+
const digest = await this.#hashFileStream(file);
|
|
342
|
+
hashMap.set(key, [{ alg: 'SHA-256', content: digest }]);
|
|
343
|
+
}
|
|
344
|
+
catch (error) {
|
|
345
|
+
// artifact file missing/unreadable — omit the hash for this component
|
|
346
|
+
missed++;
|
|
347
|
+
if (debug) {
|
|
348
|
+
console.error(`Gradle hash: could not read artifact ${file} => ${error.message}`);
|
|
349
|
+
}
|
|
350
|
+
}
|
|
351
|
+
}
|
|
352
|
+
if (missed > 0) {
|
|
353
|
+
console.warn(`Gradle hash: ${missed} of ${attempted} resolved artifacts could not be read, SBOM will be generated without hashes for those components`);
|
|
354
|
+
}
|
|
355
|
+
}
|
|
356
|
+
catch (error) {
|
|
357
|
+
// Unexpected failure (e.g. a programming error) is degraded to keep SBOM
|
|
358
|
+
// generation working, but the error is surfaced so it is not mistaken
|
|
359
|
+
// for ordinary graceful degradation.
|
|
360
|
+
console.warn(`Gradle artifact hashing failed, SBOM will be generated without hashes: ${error.stack || error.message}`);
|
|
361
|
+
return hashMap;
|
|
362
|
+
}
|
|
363
|
+
finally {
|
|
364
|
+
try {
|
|
365
|
+
fs.unlinkSync(initScriptPath);
|
|
366
|
+
}
|
|
367
|
+
catch { /* ignore */ }
|
|
368
|
+
}
|
|
369
|
+
return hashMap;
|
|
370
|
+
}
|
|
250
371
|
/**
|
|
251
372
|
* Extracts runtime and compile configurations from the dependency tree
|
|
252
373
|
* @param {string} content - the dependency tree content
|
|
@@ -294,11 +415,12 @@ export default class Java_gradle extends Base_java {
|
|
|
294
415
|
* @param properties {Object} - properties of the gradle project.
|
|
295
416
|
* @return {string} return sbom json string of the build.gradle manifest file
|
|
296
417
|
*/
|
|
297
|
-
#buildDirectDependenciesSbom(content, properties, manifestPath, opts = {}) {
|
|
418
|
+
#buildDirectDependenciesSbom(content, properties, manifestPath, opts = {}, hashMap) {
|
|
298
419
|
let sbom = new Sbom();
|
|
299
420
|
let root = `${properties.group}:${properties[ROOT_PROJECT_KEY_NAME].match(/Root project '(.+)'/)[1]}:jar:${properties.version}`;
|
|
300
421
|
let rootPurl = this.parseDep(root);
|
|
301
|
-
|
|
422
|
+
const license = this.readLicenseFromManifest(manifestPath);
|
|
423
|
+
sbom.addRoot(rootPurl, license);
|
|
302
424
|
let ignoredDeps = this.#getIgnoredDeps(manifestPath);
|
|
303
425
|
const [runtimeConfig, compileConfig] = this.#extractConfigurations(content);
|
|
304
426
|
let directDependencies = new Map();
|
|
@@ -307,7 +429,7 @@ export default class Java_gradle extends Base_java {
|
|
|
307
429
|
directDependencies.forEach((scope, dep) => {
|
|
308
430
|
const purl = this.parseDep(dep);
|
|
309
431
|
purl.scope = scope;
|
|
310
|
-
sbom.addDependency(rootPurl, purl, scope);
|
|
432
|
+
sbom.addDependency(rootPurl, purl, scope, hashMap?.get(purl.toString()));
|
|
311
433
|
});
|
|
312
434
|
return sbom.filterIgnoredDepsIncludingVersion(ignoredDeps).getAsJsonString(opts);
|
|
313
435
|
}
|
|
@@ -352,7 +474,7 @@ export default class Java_gradle extends Base_java {
|
|
|
352
474
|
// Read and parse the TOML file
|
|
353
475
|
let pathOfToml = path.join(path.dirname(manifestPath), "gradle", "libs.versions.toml");
|
|
354
476
|
const tomlString = fs.readFileSync(pathOfToml).toString();
|
|
355
|
-
let tomlObject =
|
|
477
|
+
let tomlObject = parseToml(tomlString);
|
|
356
478
|
let groupPlusArtifactObject = tomlObject.libraries[alias];
|
|
357
479
|
let parts = groupPlusArtifactObject.module.split(":");
|
|
358
480
|
let groupId = parts[0];
|
|
@@ -397,3 +519,183 @@ export default class Java_gradle extends Base_java {
|
|
|
397
519
|
return undefined;
|
|
398
520
|
}
|
|
399
521
|
}
|
|
522
|
+
const DEFAULT_GRADLE_DISCOVERY_IGNORE = [
|
|
523
|
+
'**/build/**',
|
|
524
|
+
'**/.gradle/**',
|
|
525
|
+
];
|
|
526
|
+
/** Gradle init script that emits structured project listing. */
|
|
527
|
+
const GRADLE_INIT_SCRIPT = `allprojects {
|
|
528
|
+
task daListProjects {
|
|
529
|
+
doLast {
|
|
530
|
+
println "::DA_PROJECT::\${project.path}::\${project.projectDir}"
|
|
531
|
+
}
|
|
532
|
+
}
|
|
533
|
+
}
|
|
534
|
+
`;
|
|
535
|
+
/**
|
|
536
|
+
* Gradle init script that emits, per resolved module artifact, a structured line
|
|
537
|
+
* of the form `::DA_HASH::group:name:version::/absolute/file/path`. It obtains
|
|
538
|
+
* files from Gradle's resolution API (the same approach as the CycloneDX Gradle
|
|
539
|
+
* plugin) so it is robust to cache-layout changes and correctly reports
|
|
540
|
+
* classifiers and non-jar artifacts. Uses a lenient artifact view so
|
|
541
|
+
* unresolved/fileless artifacts are skipped rather than failing the build.
|
|
542
|
+
*/
|
|
543
|
+
const GRADLE_HASH_INIT_SCRIPT = `allprojects {
|
|
544
|
+
task daListHashes {
|
|
545
|
+
doLast {
|
|
546
|
+
configurations.findAll { it.canBeResolved }.each { cfg ->
|
|
547
|
+
cfg.incoming.artifactView { lenient = true }.artifacts.each { artifact ->
|
|
548
|
+
def cid = artifact.id.componentIdentifier
|
|
549
|
+
if (cid instanceof org.gradle.api.artifacts.component.ModuleComponentIdentifier) {
|
|
550
|
+
println "::DA_HASH::\${cid.group}:\${cid.module}:\${cid.version}::\${artifact.file.absolutePath}"
|
|
551
|
+
}
|
|
552
|
+
}
|
|
553
|
+
}
|
|
554
|
+
}
|
|
555
|
+
}
|
|
556
|
+
}
|
|
557
|
+
`;
|
|
558
|
+
/**
|
|
559
|
+
* Discover all build.gradle[.kts] manifest paths in a Gradle multi-project build.
|
|
560
|
+
* Uses a custom init script to get structured project listing.
|
|
561
|
+
*
|
|
562
|
+
* @param {string} workspaceRoot - Absolute or relative path to workspace root (must contain settings.gradle[.kts])
|
|
563
|
+
* @param {import('../index.js').Options} [opts={}]
|
|
564
|
+
* @returns {Promise<string[]>} Paths to build.gradle[.kts] files (absolute)
|
|
565
|
+
*/
|
|
566
|
+
export async function discoverGradleSubprojects(workspaceRoot, opts = {}) {
|
|
567
|
+
const root = path.resolve(workspaceRoot);
|
|
568
|
+
const hasSettings = fs.existsSync(path.join(root, 'settings.gradle'))
|
|
569
|
+
|| fs.existsSync(path.join(root, 'settings.gradle.kts'));
|
|
570
|
+
if (!hasSettings) {
|
|
571
|
+
return [];
|
|
572
|
+
}
|
|
573
|
+
const manifestPaths = [];
|
|
574
|
+
const rootBuildKts = path.join(root, 'build.gradle.kts');
|
|
575
|
+
const rootBuild = path.join(root, 'build.gradle');
|
|
576
|
+
const rootManifest = fs.existsSync(rootBuildKts) ? rootBuildKts : fs.existsSync(rootBuild) ? rootBuild : null;
|
|
577
|
+
if (rootManifest) {
|
|
578
|
+
manifestPaths.push(rootManifest);
|
|
579
|
+
}
|
|
580
|
+
let gradleBin;
|
|
581
|
+
try {
|
|
582
|
+
gradleBin = new Java_gradle().selectToolBinary(rootManifest || rootBuild, opts);
|
|
583
|
+
}
|
|
584
|
+
catch {
|
|
585
|
+
const ignorePatterns = [...resolveWorkspaceDiscoveryIgnore(opts), ...DEFAULT_GRADLE_DISCOVERY_IGNORE];
|
|
586
|
+
return filterManifestPathsByDiscoveryIgnore(manifestPaths, root, ignorePatterns);
|
|
587
|
+
}
|
|
588
|
+
const initScriptPath = path.join(os.tmpdir(), `da-list-projects-${crypto.randomUUID()}.gradle`);
|
|
589
|
+
try {
|
|
590
|
+
fs.writeFileSync(initScriptPath, GRADLE_INIT_SCRIPT);
|
|
591
|
+
let output;
|
|
592
|
+
try {
|
|
593
|
+
output = invokeCommand(gradleBin, [
|
|
594
|
+
'-q', '--no-daemon',
|
|
595
|
+
'--init-script', initScriptPath,
|
|
596
|
+
'daListProjects',
|
|
597
|
+
], { cwd: root });
|
|
598
|
+
}
|
|
599
|
+
catch {
|
|
600
|
+
const ignorePatterns = [...resolveWorkspaceDiscoveryIgnore(opts), ...DEFAULT_GRADLE_DISCOVERY_IGNORE];
|
|
601
|
+
return filterManifestPathsByDiscoveryIgnore(manifestPaths, root, ignorePatterns);
|
|
602
|
+
}
|
|
603
|
+
const projects = parseGradleInitScriptOutput(output.toString());
|
|
604
|
+
for (const proj of projects) {
|
|
605
|
+
if (proj.path === ':') {
|
|
606
|
+
continue;
|
|
607
|
+
}
|
|
608
|
+
const projDir = path.resolve(proj.dir);
|
|
609
|
+
const buildKts = path.join(projDir, 'build.gradle.kts');
|
|
610
|
+
const buildGroovy = path.join(projDir, 'build.gradle');
|
|
611
|
+
if (fs.existsSync(buildKts)) {
|
|
612
|
+
manifestPaths.push(buildKts);
|
|
613
|
+
}
|
|
614
|
+
else if (fs.existsSync(buildGroovy)) {
|
|
615
|
+
manifestPaths.push(buildGroovy);
|
|
616
|
+
}
|
|
617
|
+
}
|
|
618
|
+
}
|
|
619
|
+
finally {
|
|
620
|
+
try {
|
|
621
|
+
fs.unlinkSync(initScriptPath);
|
|
622
|
+
}
|
|
623
|
+
catch { /* ignore */ }
|
|
624
|
+
}
|
|
625
|
+
const ignorePatterns = [...resolveWorkspaceDiscoveryIgnore(opts), ...DEFAULT_GRADLE_DISCOVERY_IGNORE];
|
|
626
|
+
return filterManifestPathsByDiscoveryIgnore(manifestPaths, root, ignorePatterns);
|
|
627
|
+
}
|
|
628
|
+
/**
|
|
629
|
+
* Parse the structured output from the Gradle init script.
|
|
630
|
+
*
|
|
631
|
+
* @param {string} raw - Raw stdout from gradle
|
|
632
|
+
* @returns {{ path: string, dir: string }[]}
|
|
633
|
+
*/
|
|
634
|
+
export function parseGradleInitScriptOutput(raw) {
|
|
635
|
+
const projects = [];
|
|
636
|
+
for (const rawLine of raw.split('\n')) {
|
|
637
|
+
const line = rawLine.trimEnd();
|
|
638
|
+
if (!line.startsWith('::DA_PROJECT::')) {
|
|
639
|
+
continue;
|
|
640
|
+
}
|
|
641
|
+
const prefix = '::DA_PROJECT::';
|
|
642
|
+
const remainder = line.substring(prefix.length);
|
|
643
|
+
const lastSep = remainder.lastIndexOf('::');
|
|
644
|
+
if (lastSep < 0) {
|
|
645
|
+
continue;
|
|
646
|
+
}
|
|
647
|
+
const projPath = remainder.substring(0, lastSep);
|
|
648
|
+
const dir = remainder.substring(lastSep + 2);
|
|
649
|
+
if (projPath && dir) {
|
|
650
|
+
projects.push({ path: projPath, dir });
|
|
651
|
+
}
|
|
652
|
+
}
|
|
653
|
+
return projects;
|
|
654
|
+
}
|
|
655
|
+
/**
|
|
656
|
+
* Parse the structured output from the Gradle hash init script.
|
|
657
|
+
* Each recognised line has the form `::DA_HASH::group:name:version::<file-path>`.
|
|
658
|
+
*
|
|
659
|
+
* @param {string} raw - Raw stdout from gradle
|
|
660
|
+
* @returns {{ id: string, file: string }[]} component id (`group:name:version`) and absolute artifact file path
|
|
661
|
+
*/
|
|
662
|
+
export function parseGradleHashScriptOutput(raw) {
|
|
663
|
+
const artifacts = [];
|
|
664
|
+
for (const rawLine of raw.split('\n')) {
|
|
665
|
+
const line = rawLine.trimEnd();
|
|
666
|
+
if (!line.startsWith('::DA_HASH::')) {
|
|
667
|
+
continue;
|
|
668
|
+
}
|
|
669
|
+
const prefix = '::DA_HASH::';
|
|
670
|
+
const remainder = line.substring(prefix.length);
|
|
671
|
+
const lastSep = remainder.lastIndexOf('::');
|
|
672
|
+
if (lastSep < 0) {
|
|
673
|
+
continue;
|
|
674
|
+
}
|
|
675
|
+
const id = remainder.substring(0, lastSep);
|
|
676
|
+
const file = remainder.substring(lastSep + 2);
|
|
677
|
+
if (id && file) {
|
|
678
|
+
artifacts.push({ id, file });
|
|
679
|
+
}
|
|
680
|
+
}
|
|
681
|
+
return artifacts;
|
|
682
|
+
}
|
|
683
|
+
/**
|
|
684
|
+
* Parse a Gradle module component id (`group:name:version`) into its coordinate
|
|
685
|
+
* parts. The caller builds the canonical PURL key from these parts using the same
|
|
686
|
+
* builder {@link parseDep} uses, so the stored key and the lookup key cannot drift.
|
|
687
|
+
*
|
|
688
|
+
* @param {string} id - the Gradle component id
|
|
689
|
+
* @returns {{group: string, name: string, version: string}|null} the parsed coordinate, or null when the id is malformed
|
|
690
|
+
*/
|
|
691
|
+
export function parseComponentId(id) {
|
|
692
|
+
const parts = id.split(':');
|
|
693
|
+
if (parts.length < 3) {
|
|
694
|
+
return null;
|
|
695
|
+
}
|
|
696
|
+
const [group, name, version] = parts;
|
|
697
|
+
if (!group || !name || !version) {
|
|
698
|
+
return null;
|
|
699
|
+
}
|
|
700
|
+
return { group, name, version };
|
|
701
|
+
}
|
|
@@ -3,5 +3,5 @@ export default class Java_gradle_groovy extends Java_gradle {
|
|
|
3
3
|
_parseAliasForLibsNotation(alias: any): any;
|
|
4
4
|
_extractDepToBeIgnored(dep: any): any;
|
|
5
5
|
}
|
|
6
|
-
export type Provided =
|
|
6
|
+
export type Provided = any;
|
|
7
7
|
import Java_gradle from './java_gradle.js';
|
|
@@ -7,5 +7,5 @@ export default class Java_gradle_kotlin extends Java_gradle {
|
|
|
7
7
|
_parseAliasForLibsNotation(alias: any): any;
|
|
8
8
|
_extractDepToBeIgnored(dep: any): string | null;
|
|
9
9
|
}
|
|
10
|
-
export type Provided =
|
|
10
|
+
export type Provided = any;
|
|
11
11
|
import Java_gradle from './java_gradle.js';
|
|
@@ -1,8 +1,16 @@
|
|
|
1
|
-
/**
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
/**
|
|
2
|
+
* Discover all pom.xml manifest paths in a Maven multi-module project.
|
|
3
|
+
*
|
|
4
|
+
* @param {string} workspaceRoot - Absolute or relative path to workspace root (must contain pom.xml)
|
|
5
|
+
* @param {object} [opts={}]
|
|
6
|
+
* @returns {Promise<string[]>} Paths to pom.xml files (absolute)
|
|
7
|
+
*/
|
|
8
|
+
export function discoverMavenModules(workspaceRoot: string, opts?: object): Promise<string[]>;
|
|
5
9
|
export default class Java_maven extends Base_java {
|
|
10
|
+
/** @type {Object<string, string>} Packaging types that produce .jar files despite non-jar packaging names. */
|
|
11
|
+
static PACKAGING_TO_JAR: {
|
|
12
|
+
[x: string]: string;
|
|
13
|
+
};
|
|
6
14
|
constructor();
|
|
7
15
|
/**
|
|
8
16
|
* @param {string} manifestName - the subject manifest name-type
|
|
@@ -17,27 +25,54 @@ export default class Java_maven extends Base_java {
|
|
|
17
25
|
* Provide content and content type for maven-maven stack analysis.
|
|
18
26
|
* @param {string} manifest - the manifest path or name
|
|
19
27
|
* @param {{}} [opts={}] - optional various options to pass along the application
|
|
20
|
-
* @returns {Provided}
|
|
28
|
+
* @returns {Promise<Provided>}
|
|
21
29
|
*/
|
|
22
|
-
provideStack(manifest: string, opts?: {}
|
|
30
|
+
provideStack(manifest: string, opts?: {}): Promise<Provided>;
|
|
23
31
|
/**
|
|
24
32
|
* Provide content and content type for maven-maven component analysis.
|
|
25
33
|
* @param {string} manifest - path to the manifest file
|
|
26
34
|
* @param {{}} [opts={}] - optional various options to pass along the application
|
|
27
35
|
* @returns {Provided}
|
|
28
36
|
*/
|
|
29
|
-
provideComponent(manifest: string, opts?: {}
|
|
37
|
+
provideComponent(manifest: string, opts?: {}): Provided;
|
|
38
|
+
/**
|
|
39
|
+
* Read license from pom.xml manifest, with fallback to LICENSE file
|
|
40
|
+
* @param {string} manifestPath - path to pom.xml
|
|
41
|
+
* @returns {string|null}
|
|
42
|
+
*/
|
|
43
|
+
readLicenseFromManifest(manifestPath: string): string | null;
|
|
30
44
|
/**
|
|
45
|
+
* Build a Map of PURL string → CycloneDX hash entries by reading artifact files from the local Maven repository.
|
|
31
46
|
*
|
|
47
|
+
* Both the artifact file path and the hash-map key are derived from the
|
|
48
|
+
* shared {@link Base_java#parseCoordinate} parser: the file path uses the
|
|
49
|
+
* resolved version and raw classifier, while the key uses the same canonical
|
|
50
|
+
* PURL builder as {@link Base_java#parseDep}. This guarantees the key always
|
|
51
|
+
* matches the PURL that {@link Base_java#parseDependencyTree} looks up.
|
|
52
|
+
*
|
|
53
|
+
* @param {string} depTreeText Raw dependency tree text from mvn dependency:tree
|
|
54
|
+
* @param {{}} [opts={}] Options bag (may contain TRUSTIFY_DA_MVN_REPO)
|
|
55
|
+
* @returns {Promise<Map<string, Array<{alg: string, content: string}>>>}
|
|
56
|
+
*/
|
|
57
|
+
_buildMavenHashMap(depTreeText: string, opts?: {}): Promise<Map<string, Array<{
|
|
58
|
+
alg: string;
|
|
59
|
+
content: string;
|
|
60
|
+
}>>>;
|
|
61
|
+
/**
|
|
32
62
|
* @param {String} textGraphList Text graph String of the manifest
|
|
33
63
|
* @param {[String]} ignoredDeps List of ignored dependencies to be omitted from sbom
|
|
64
|
+
* @param {{}} opts Options
|
|
65
|
+
* @param {String} manifestPath Path to the pom.xml manifest
|
|
66
|
+
* @param {Map<string, Array<{alg: string, content: string}>>} [hashMap] PURL→hashes map
|
|
34
67
|
* @return {String} formatted sbom Json String with all dependencies
|
|
35
68
|
*/
|
|
36
|
-
createSbomFileFromTextFormat(textGraphList: string, ignoredDeps: [string], opts:
|
|
69
|
+
createSbomFileFromTextFormat(textGraphList: string, ignoredDeps: [string], opts: {}, manifestPath: string, hashMap?: Map<string, Array<{
|
|
70
|
+
alg: string;
|
|
71
|
+
content: string;
|
|
72
|
+
}>>): string;
|
|
37
73
|
#private;
|
|
38
74
|
}
|
|
39
|
-
export type
|
|
40
|
-
export type Provided = import('../provider').Provided;
|
|
75
|
+
export type Provided = any;
|
|
41
76
|
export type Package = {
|
|
42
77
|
name: string;
|
|
43
78
|
version: string;
|