@trustify-da/trustify-da-javascript-client 0.3.0-ea.ec6824b → 0.3.0-ea.efdc87d
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +199 -11
- package/dist/package.json +15 -10
- package/dist/src/analysis.d.ts +47 -19
- package/dist/src/analysis.js +70 -18
- package/dist/src/cli.js +188 -6
- package/dist/src/config.d.ts +120 -0
- package/dist/src/config.js +260 -0
- package/dist/src/cyclone_dx_sbom.d.ts +13 -0
- package/dist/src/cyclone_dx_sbom.js +39 -1
- package/dist/src/index.d.ts +27 -22
- package/dist/src/index.js +27 -38
- package/dist/src/license/index.d.ts +2 -2
- package/dist/src/license/index.js +9 -6
- package/dist/src/license/licenses_api.d.ts +2 -2
- package/dist/src/license/licenses_api.js +1 -1
- package/dist/src/oci_image/images.js +15 -1
- package/dist/src/package_version.d.ts +8 -0
- package/dist/src/package_version.js +31 -0
- package/dist/src/provider.js +3 -1
- package/dist/src/providers/base_java.d.ts +53 -0
- package/dist/src/providers/base_java.js +64 -17
- package/dist/src/providers/base_javascript.d.ts +54 -0
- package/dist/src/providers/base_javascript.js +106 -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.js +49 -7
- package/dist/src/providers/java_gradle.d.ts +48 -0
- package/dist/src/providers/java_gradle.js +196 -18
- package/dist/src/providers/java_maven.d.ts +28 -8
- package/dist/src/providers/java_maven.js +104 -10
- package/dist/src/providers/javascript_bun.d.ts +12 -0
- package/dist/src/providers/javascript_bun.js +42 -1
- package/dist/src/providers/javascript_npm.d.ts +13 -0
- 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 +47 -1
- package/dist/src/providers/javascript_yarn.d.ts +12 -0
- package/dist/src/providers/javascript_yarn.js +75 -2
- package/dist/src/providers/manifest.js +6 -3
- package/dist/src/providers/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 +5 -1
- package/dist/src/providers/processors/yarn_berry_processor.js +3 -2
- package/dist/src/providers/processors/yarn_classic_processor.d.ts +5 -1
- package/dist/src/providers/processors/yarn_classic_processor.js +8 -6
- package/dist/src/providers/python_controller.js +4 -1
- package/dist/src/providers/requirements_parser.js +1 -1
- package/dist/src/providers/rust_cargo.js +70 -29
- package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
- package/dist/src/remediate.d.ts +120 -0
- package/dist/src/remediate.js +253 -0
- package/dist/src/remediation.d.ts +58 -0
- package/dist/src/remediation.js +425 -0
- package/dist/src/remediation_report.d.ts +40 -0
- package/dist/src/remediation_report.js +159 -0
- package/dist/src/sbom.d.ts +11 -0
- package/dist/src/sbom.js +10 -0
- package/dist/src/tools.d.ts +9 -11
- package/dist/src/tools.js +34 -13
- package/dist/src/updaters/maven_updater.d.ts +58 -0
- package/dist/src/updaters/maven_updater.js +345 -0
- package/dist/src/updaters/toml_updater.d.ts +62 -0
- package/dist/src/updaters/toml_updater.js +276 -0
- package/dist/src/workspace.d.ts +2 -1
- package/dist/src/workspace.js +2 -1
- package/package.json +16 -11
|
@@ -6,11 +6,11 @@
|
|
|
6
6
|
* @returns {Promise<string[]>} Paths to pom.xml files (absolute)
|
|
7
7
|
*/
|
|
8
8
|
export function discoverMavenModules(workspaceRoot: string, opts?: object): Promise<string[]>;
|
|
9
|
-
/** @typedef {import('../provider').Provider} */
|
|
10
|
-
/** @typedef {import('../provider').Provided} Provided */
|
|
11
|
-
/** @typedef {{name: string, version: string}} Package */
|
|
12
|
-
/** @typedef {{groupId: string, artifactId: string, version: string, scope: string, ignore: boolean}} Dependency */
|
|
13
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
|
+
};
|
|
14
14
|
constructor();
|
|
15
15
|
/**
|
|
16
16
|
* @param {string} manifestName - the subject manifest name-type
|
|
@@ -25,9 +25,9 @@ export default class Java_maven extends Base_java {
|
|
|
25
25
|
* Provide content and content type for maven-maven stack analysis.
|
|
26
26
|
* @param {string} manifest - the manifest path or name
|
|
27
27
|
* @param {{}} [opts={}] - optional various options to pass along the application
|
|
28
|
-
* @returns {Provided}
|
|
28
|
+
* @returns {Promise<Provided>}
|
|
29
29
|
*/
|
|
30
|
-
provideStack(manifest: string, opts?: {}): Provided
|
|
30
|
+
provideStack(manifest: string, opts?: {}): Promise<Provided>;
|
|
31
31
|
/**
|
|
32
32
|
* Provide content and content type for maven-maven component analysis.
|
|
33
33
|
* @param {string} manifest - path to the manifest file
|
|
@@ -42,16 +42,36 @@ export default class Java_maven extends Base_java {
|
|
|
42
42
|
*/
|
|
43
43
|
readLicenseFromManifest(manifestPath: string): string | null;
|
|
44
44
|
/**
|
|
45
|
+
* Build a Map of PURL string → CycloneDX hash entries by reading artifact files from the local Maven repository.
|
|
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.
|
|
45
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
|
+
/**
|
|
46
62
|
* @param {String} textGraphList Text graph String of the manifest
|
|
47
63
|
* @param {[String]} ignoredDeps List of ignored dependencies to be omitted from sbom
|
|
64
|
+
* @param {{}} opts Options
|
|
48
65
|
* @param {String} manifestPath Path to the pom.xml manifest
|
|
66
|
+
* @param {Map<string, Array<{alg: string, content: string}>>} [hashMap] PURL→hashes map
|
|
49
67
|
* @return {String} formatted sbom Json String with all dependencies
|
|
50
68
|
*/
|
|
51
|
-
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;
|
|
52
73
|
#private;
|
|
53
74
|
}
|
|
54
|
-
export type Java_maven = any;
|
|
55
75
|
export type Provided = any;
|
|
56
76
|
export type Package = {
|
|
57
77
|
name: string;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import crypto from 'node:crypto';
|
|
1
2
|
import fs from 'node:fs';
|
|
2
3
|
import os from 'node:os';
|
|
3
4
|
import path from 'node:path';
|
|
@@ -12,6 +13,10 @@ import Base_java, { ecosystem_maven } from "./base_java.js";
|
|
|
12
13
|
/** @typedef {import('../provider').Provided} Provided */
|
|
13
14
|
/** @typedef {{name: string, version: string}} Package */
|
|
14
15
|
/** @typedef {{groupId: string, artifactId: string, version: string, scope: string, ignore: boolean}} Dependency */
|
|
16
|
+
// Matches the legacy `exhortignore` and new `trustify-da-ignore` markers as whole
|
|
17
|
+
// tokens. The trailing `(?![\w-])` boundary prevents lookalikes such as
|
|
18
|
+
// `trustify-da-ignore-disabled` from being treated as ignore directives.
|
|
19
|
+
const IGNORE_MARKER_REGEX = /(exhortignore|trustify-da-ignore)(?![\w-])/;
|
|
15
20
|
export default class Java_maven extends Base_java {
|
|
16
21
|
constructor() {
|
|
17
22
|
super('mvn', 'mvnw' + (process.platform === 'win32' ? '.cmd' : ''));
|
|
@@ -31,12 +36,12 @@ export default class Java_maven extends Base_java {
|
|
|
31
36
|
* Provide content and content type for maven-maven stack analysis.
|
|
32
37
|
* @param {string} manifest - the manifest path or name
|
|
33
38
|
* @param {{}} [opts={}] - optional various options to pass along the application
|
|
34
|
-
* @returns {Provided}
|
|
39
|
+
* @returns {Promise<Provided>}
|
|
35
40
|
*/
|
|
36
|
-
provideStack(manifest, opts = {}) {
|
|
41
|
+
async provideStack(manifest, opts = {}) {
|
|
37
42
|
return {
|
|
38
43
|
ecosystem: ecosystem_maven,
|
|
39
|
-
content: this.#createSbomStackAnalysis(manifest, opts),
|
|
44
|
+
content: await this.#createSbomStackAnalysis(manifest, opts),
|
|
40
45
|
contentType: 'application/vnd.cyclonedx+json'
|
|
41
46
|
};
|
|
42
47
|
}
|
|
@@ -81,10 +86,10 @@ export default class Java_maven extends Base_java {
|
|
|
81
86
|
* Create a Dot Graph dependency tree for a manifest path.
|
|
82
87
|
* @param {string} manifest - path for pom.xml
|
|
83
88
|
* @param {{}} [opts={}] - optional various options to pass along the application
|
|
84
|
-
* @returns {string} the Dot Graph content
|
|
89
|
+
* @returns {Promise<string>} the Dot Graph content
|
|
85
90
|
* @private
|
|
86
91
|
*/
|
|
87
|
-
#createSbomStackAnalysis(manifest, opts = {}) {
|
|
92
|
+
async #createSbomStackAnalysis(manifest, opts = {}) {
|
|
88
93
|
const manifestDir = path.dirname(manifest);
|
|
89
94
|
const mvn = this.selectToolBinary(manifest, opts);
|
|
90
95
|
const mvnArgs = JSON.parse(getCustom('TRUSTIFY_DA_MVN_ARGS', '[]', opts));
|
|
@@ -131,20 +136,105 @@ export default class Java_maven extends Base_java {
|
|
|
131
136
|
if (process.env["TRUSTIFY_DA_DEBUG"] === "true") {
|
|
132
137
|
console.error("Dependency tree that will be used as input for creating the BOM =>" + EOL + EOL + content.toString());
|
|
133
138
|
}
|
|
134
|
-
|
|
139
|
+
const depTreeContent = content.toString();
|
|
140
|
+
const hashMap = await this._buildMavenHashMap(depTreeContent, opts);
|
|
141
|
+
let sbom = this.createSbomFileFromTextFormat(depTreeContent, ignoredDeps, opts, manifest, hashMap);
|
|
135
142
|
// delete temp file and directory
|
|
136
143
|
fs.rmSync(tmpDir, { recursive: true, force: true });
|
|
137
144
|
// return dependency graph as string
|
|
138
145
|
return sbom;
|
|
139
146
|
}
|
|
147
|
+
/** @type {Object<string, string>} Packaging types that produce .jar files despite non-jar packaging names. */
|
|
148
|
+
static PACKAGING_TO_JAR = { 'bundle': 'jar', 'eclipse-plugin': 'jar' };
|
|
140
149
|
/**
|
|
150
|
+
* Build a Map of PURL string → CycloneDX hash entries by reading artifact files from the local Maven repository.
|
|
151
|
+
*
|
|
152
|
+
* Both the artifact file path and the hash-map key are derived from the
|
|
153
|
+
* shared {@link Base_java#parseCoordinate} parser: the file path uses the
|
|
154
|
+
* resolved version and raw classifier, while the key uses the same canonical
|
|
155
|
+
* PURL builder as {@link Base_java#parseDep}. This guarantees the key always
|
|
156
|
+
* matches the PURL that {@link Base_java#parseDependencyTree} looks up.
|
|
141
157
|
*
|
|
158
|
+
* @param {string} depTreeText Raw dependency tree text from mvn dependency:tree
|
|
159
|
+
* @param {{}} [opts={}] Options bag (may contain TRUSTIFY_DA_MVN_REPO)
|
|
160
|
+
* @returns {Promise<Map<string, Array<{alg: string, content: string}>>>}
|
|
161
|
+
*/
|
|
162
|
+
async _buildMavenHashMap(depTreeText, opts = {}) {
|
|
163
|
+
const m2Repo = getCustom('TRUSTIFY_DA_MVN_REPO', path.join(os.homedir(), '.m2', 'repository'), opts);
|
|
164
|
+
const hashMap = new Map();
|
|
165
|
+
const lines = depTreeText.split(EOL);
|
|
166
|
+
// Track hash coverage so an incomplete .m2 cache (e.g. ephemeral CI
|
|
167
|
+
// containers or resolve-only phases) surfaces a summary warning instead
|
|
168
|
+
// of silently producing an SBOM with missing hashes.
|
|
169
|
+
let attempted = 0;
|
|
170
|
+
let missed = 0;
|
|
171
|
+
for (const rawLine of lines) {
|
|
172
|
+
const trimmed = rawLine.trim();
|
|
173
|
+
// Strip leading tree-drawing characters (e.g. "\-", "+-", "|") so the
|
|
174
|
+
// parenthesized-line check sees the coordinate itself. Omitted
|
|
175
|
+
// duplicate/conflict lines start with these characters after trim(),
|
|
176
|
+
// then an opening "(" — without stripping, the "(" check never fires.
|
|
177
|
+
const cleaned = trimmed.replace(/^[|+\\\- ]+/, '');
|
|
178
|
+
if (!cleaned || cleaned.startsWith('(')) {
|
|
179
|
+
continue;
|
|
180
|
+
}
|
|
181
|
+
const coord = this.parseCoordinate(rawLine);
|
|
182
|
+
if (!coord.groupId || !coord.artifactId || !coord.packaging) {
|
|
183
|
+
continue;
|
|
184
|
+
}
|
|
185
|
+
if (coord.packaging === 'pom') {
|
|
186
|
+
continue;
|
|
187
|
+
}
|
|
188
|
+
// Key by the exact PURL parseDep() produces, so the lookup in
|
|
189
|
+
// parseDependencyTree (hashMap.get(to.toString())) always hits.
|
|
190
|
+
const purl = this._coordinateToPurl(coord).toString();
|
|
191
|
+
// The same artifact recurs across dependency-tree branches — notably in
|
|
192
|
+
// multi-module reactor builds, where every module re-lists shared deps.
|
|
193
|
+
// The digest is deterministic per PURL, so skip the redundant file read
|
|
194
|
+
// and SHA-256 computation once this PURL is already hashed.
|
|
195
|
+
if (hashMap.has(purl)) {
|
|
196
|
+
continue;
|
|
197
|
+
}
|
|
198
|
+
const ext = Java_maven.PACKAGING_TO_JAR[coord.packaging] || coord.packaging;
|
|
199
|
+
const groupPath = coord.groupId.replaceAll('.', path.sep);
|
|
200
|
+
const fileName = coord.classifier
|
|
201
|
+
? `${coord.artifactId}-${coord.version}-${coord.classifier}.${ext}`
|
|
202
|
+
: `${coord.artifactId}-${coord.version}.${ext}`;
|
|
203
|
+
const artifactPath = path.join(m2Repo, groupPath, coord.artifactId, coord.version, fileName);
|
|
204
|
+
attempted++;
|
|
205
|
+
try {
|
|
206
|
+
const stream = fs.createReadStream(artifactPath);
|
|
207
|
+
const hash = crypto.createHash('sha256');
|
|
208
|
+
for await (const chunk of stream) {
|
|
209
|
+
hash.update(chunk);
|
|
210
|
+
}
|
|
211
|
+
const digest = hash.digest('hex');
|
|
212
|
+
hashMap.set(purl, [{ alg: 'SHA-256', content: digest }]);
|
|
213
|
+
}
|
|
214
|
+
catch {
|
|
215
|
+
missed++;
|
|
216
|
+
if (process.env['TRUSTIFY_DA_DEBUG'] === 'true') {
|
|
217
|
+
console.error(`Maven hash: artifact not found at ${artifactPath}, omitting hash`);
|
|
218
|
+
}
|
|
219
|
+
}
|
|
220
|
+
}
|
|
221
|
+
// Mirror the pip provider's convention (python_controller.js): surface an
|
|
222
|
+
// unconditional warning when hashes could not be computed, so incomplete
|
|
223
|
+
// hash coverage is visible even without TRUSTIFY_DA_DEBUG.
|
|
224
|
+
if (missed > 0) {
|
|
225
|
+
console.warn(`Maven hash: ${missed} of ${attempted} artifacts could not be read from the local .m2 cache; SBOM will be generated without hashes for those components.`);
|
|
226
|
+
}
|
|
227
|
+
return hashMap;
|
|
228
|
+
}
|
|
229
|
+
/**
|
|
142
230
|
* @param {String} textGraphList Text graph String of the manifest
|
|
143
231
|
* @param {[String]} ignoredDeps List of ignored dependencies to be omitted from sbom
|
|
232
|
+
* @param {{}} opts Options
|
|
144
233
|
* @param {String} manifestPath Path to the pom.xml manifest
|
|
234
|
+
* @param {Map<string, Array<{alg: string, content: string}>>} [hashMap] PURL→hashes map
|
|
145
235
|
* @return {String} formatted sbom Json String with all dependencies
|
|
146
236
|
*/
|
|
147
|
-
createSbomFileFromTextFormat(textGraphList, ignoredDeps, opts, manifestPath) {
|
|
237
|
+
createSbomFileFromTextFormat(textGraphList, ignoredDeps, opts, manifestPath, hashMap) {
|
|
148
238
|
let lines = textGraphList.split(EOL);
|
|
149
239
|
// get root component
|
|
150
240
|
let root = lines[0];
|
|
@@ -153,6 +243,9 @@ export default class Java_maven extends Base_java {
|
|
|
153
243
|
let sbom = new Sbom();
|
|
154
244
|
sbom.addRoot(rootPurl, license);
|
|
155
245
|
this.parseDependencyTree(root, 0, lines.slice(1), sbom);
|
|
246
|
+
// Attach Maven artifact hashes as a post-processing step, keeping this
|
|
247
|
+
// Maven-specific concern out of the shared dependency-tree parser.
|
|
248
|
+
sbom.attachHashes(hashMap);
|
|
156
249
|
return sbom.filterIgnoredDeps(ignoredDeps).getAsJsonString(opts);
|
|
157
250
|
}
|
|
158
251
|
/**
|
|
@@ -229,7 +322,8 @@ export default class Java_maven extends Base_java {
|
|
|
229
322
|
return rootDependency;
|
|
230
323
|
}
|
|
231
324
|
/**
|
|
232
|
-
* Get a list of dependencies with marking of dependencies commented with
|
|
325
|
+
* Get a list of dependencies with marking of dependencies commented with
|
|
326
|
+
* <!--exhortignore--> or <!--trustify-da-ignore-->.
|
|
233
327
|
* @param {string} manifest - path for pom.xml
|
|
234
328
|
* @returns {[Dependency]} an array of dependencies
|
|
235
329
|
* @private
|
|
@@ -247,7 +341,7 @@ export default class Java_maven extends Base_java {
|
|
|
247
341
|
let buf = fs.readFileSync(manifest);
|
|
248
342
|
// parse manifest pom.xml to json
|
|
249
343
|
let pomJson = parser.parse(buf.toString());
|
|
250
|
-
// iterate over all dependencies and chery pick dependencies with
|
|
344
|
+
// iterate over all dependencies and chery pick dependencies with an ignore comment
|
|
251
345
|
let pomXml;
|
|
252
346
|
// project without modules
|
|
253
347
|
if (pomJson['project']) {
|
|
@@ -263,7 +357,7 @@ export default class Java_maven extends Base_java {
|
|
|
263
357
|
}
|
|
264
358
|
pomXml.forEach(dep => {
|
|
265
359
|
let ignore = false;
|
|
266
|
-
if (dep['#comment'] && dep['#comment'].
|
|
360
|
+
if (dep['#comment'] && [].concat(dep['#comment']).some(comment => IGNORE_MARKER_REGEX.test(comment))) { // #comment is an array or a string
|
|
267
361
|
ignore = true;
|
|
268
362
|
}
|
|
269
363
|
if (dep['scope'] !== 'test') {
|
|
@@ -1,4 +1,16 @@
|
|
|
1
1
|
export default class Javascript_bun extends Base_javascript {
|
|
2
|
+
/**
|
|
3
|
+
* Parses `bun.lock` into a hash map keyed by `name@version`. Each entry in
|
|
4
|
+
* the `packages` section is an array whose first element is the resolved id
|
|
5
|
+
* (`name@version`) and whose fourth element is the SRI integrity string.
|
|
6
|
+
* @param {string} lockDir - Directory containing bun.lock
|
|
7
|
+
* @returns {Map<string, Array<{alg: string, content: string}>>} Hash map
|
|
8
|
+
* @protected
|
|
9
|
+
*/
|
|
10
|
+
protected _parseLockFileHashes(lockDir: string): Map<string, Array<{
|
|
11
|
+
alg: string;
|
|
12
|
+
content: string;
|
|
13
|
+
}>>;
|
|
2
14
|
_listCmdArgs(): void;
|
|
3
15
|
_buildDependencyTree(includeTransitive: any, opts?: {}): {
|
|
4
16
|
name: any;
|
|
@@ -1,11 +1,51 @@
|
|
|
1
1
|
import fs from 'node:fs';
|
|
2
2
|
import path from 'node:path';
|
|
3
3
|
import { parse } from 'jsonc-parser';
|
|
4
|
-
import Base_javascript from './base_javascript.js';
|
|
4
|
+
import Base_javascript, { sriToHash } from './base_javascript.js';
|
|
5
5
|
export default class Javascript_bun extends Base_javascript {
|
|
6
6
|
_lockFileName() {
|
|
7
7
|
return "bun.lock";
|
|
8
8
|
}
|
|
9
|
+
/**
|
|
10
|
+
* Parses `bun.lock` into a hash map keyed by `name@version`. Each entry in
|
|
11
|
+
* the `packages` section is an array whose first element is the resolved id
|
|
12
|
+
* (`name@version`) and whose fourth element is the SRI integrity string.
|
|
13
|
+
* @param {string} lockDir - Directory containing bun.lock
|
|
14
|
+
* @returns {Map<string, Array<{alg: string, content: string}>>} Hash map
|
|
15
|
+
* @protected
|
|
16
|
+
*/
|
|
17
|
+
_parseLockFileHashes(lockDir) {
|
|
18
|
+
const map = new Map();
|
|
19
|
+
const lockPath = path.join(lockDir, this._lockFileName());
|
|
20
|
+
if (!fs.existsSync(lockPath)) {
|
|
21
|
+
return map;
|
|
22
|
+
}
|
|
23
|
+
let lockData;
|
|
24
|
+
try {
|
|
25
|
+
lockData = parse(fs.readFileSync(lockPath, 'utf-8'));
|
|
26
|
+
}
|
|
27
|
+
catch (_) {
|
|
28
|
+
return map;
|
|
29
|
+
}
|
|
30
|
+
const packages = lockData?.packages || {};
|
|
31
|
+
for (const entry of Object.values(packages)) {
|
|
32
|
+
if (!Array.isArray(entry) || typeof entry[0] !== 'string' || typeof entry[3] !== 'string') {
|
|
33
|
+
continue;
|
|
34
|
+
}
|
|
35
|
+
const id = entry[0];
|
|
36
|
+
const at = id.lastIndexOf('@');
|
|
37
|
+
if (at <= 0) {
|
|
38
|
+
continue;
|
|
39
|
+
}
|
|
40
|
+
const name = id.slice(0, at);
|
|
41
|
+
const version = id.slice(at + 1);
|
|
42
|
+
const hash = sriToHash(entry[3]);
|
|
43
|
+
if (name && version && hash) {
|
|
44
|
+
map.set(`${name}@${version}`, [hash]);
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
return map;
|
|
48
|
+
}
|
|
9
49
|
_cmdName() {
|
|
10
50
|
return "bun";
|
|
11
51
|
}
|
|
@@ -20,6 +60,7 @@ export default class Javascript_bun extends Base_javascript {
|
|
|
20
60
|
const manifestDir = path.dirname(this._getManifest().manifestPath);
|
|
21
61
|
const lockDir = this._findLockFileDir(manifestDir, opts) || manifestDir;
|
|
22
62
|
this._createLockFile(lockDir);
|
|
63
|
+
this._loadHashes(lockDir);
|
|
23
64
|
const lockContent = fs.readFileSync(path.join(lockDir, 'bun.lock'), 'utf-8');
|
|
24
65
|
const lockData = parse(lockContent);
|
|
25
66
|
const packages = lockData.packages || {};
|
|
@@ -1,4 +1,17 @@
|
|
|
1
1
|
export default class Javascript_npm extends Base_javascript {
|
|
2
|
+
/**
|
|
3
|
+
* Parses `package-lock.json` (lockfileVersion 2/3) into a hash map keyed by
|
|
4
|
+
* `name@version`. Each `packages` entry is keyed by its install path
|
|
5
|
+
* (e.g. `node_modules/@hapi/joi`); the package name is the segment after the
|
|
6
|
+
* final `node_modules/`. The `integrity` field holds an SRI string.
|
|
7
|
+
* @param {string} lockDir - Directory containing package-lock.json
|
|
8
|
+
* @returns {Map<string, Array<{alg: string, content: string}>>} Hash map
|
|
9
|
+
* @protected
|
|
10
|
+
*/
|
|
11
|
+
protected _parseLockFileHashes(lockDir: string): Map<string, Array<{
|
|
12
|
+
alg: string;
|
|
13
|
+
content: string;
|
|
14
|
+
}>>;
|
|
2
15
|
_listCmdArgs(includeTransitive: any): string[];
|
|
3
16
|
_buildDependencyTree(includeTransitive: any, opts?: {}): Object | {
|
|
4
17
|
name: any;
|
|
@@ -1,8 +1,47 @@
|
|
|
1
|
-
import
|
|
1
|
+
import fs from 'node:fs';
|
|
2
|
+
import path from 'node:path';
|
|
3
|
+
import Base_javascript, { sriToHash } from './base_javascript.js';
|
|
2
4
|
export default class Javascript_npm extends Base_javascript {
|
|
3
5
|
_lockFileName() {
|
|
4
6
|
return "package-lock.json";
|
|
5
7
|
}
|
|
8
|
+
/**
|
|
9
|
+
* Parses `package-lock.json` (lockfileVersion 2/3) into a hash map keyed by
|
|
10
|
+
* `name@version`. Each `packages` entry is keyed by its install path
|
|
11
|
+
* (e.g. `node_modules/@hapi/joi`); the package name is the segment after the
|
|
12
|
+
* final `node_modules/`. The `integrity` field holds an SRI string.
|
|
13
|
+
* @param {string} lockDir - Directory containing package-lock.json
|
|
14
|
+
* @returns {Map<string, Array<{alg: string, content: string}>>} Hash map
|
|
15
|
+
* @protected
|
|
16
|
+
*/
|
|
17
|
+
_parseLockFileHashes(lockDir) {
|
|
18
|
+
const map = new Map();
|
|
19
|
+
const lockPath = path.join(lockDir, this._lockFileName());
|
|
20
|
+
if (!fs.existsSync(lockPath)) {
|
|
21
|
+
return map;
|
|
22
|
+
}
|
|
23
|
+
let lock;
|
|
24
|
+
try {
|
|
25
|
+
lock = JSON.parse(fs.readFileSync(lockPath, 'utf-8'));
|
|
26
|
+
}
|
|
27
|
+
catch (_) {
|
|
28
|
+
return map;
|
|
29
|
+
}
|
|
30
|
+
const packages = lock.packages || {};
|
|
31
|
+
for (const [pkgPath, entry] of Object.entries(packages)) {
|
|
32
|
+
if (!pkgPath || !entry || !entry.integrity || !entry.version) {
|
|
33
|
+
continue;
|
|
34
|
+
}
|
|
35
|
+
const marker = 'node_modules/';
|
|
36
|
+
const idx = pkgPath.lastIndexOf(marker);
|
|
37
|
+
const name = idx < 0 ? pkgPath : pkgPath.slice(idx + marker.length);
|
|
38
|
+
const hash = sriToHash(entry.integrity);
|
|
39
|
+
if (name && hash) {
|
|
40
|
+
map.set(`${name}@${entry.version}`, [hash]);
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
return map;
|
|
44
|
+
}
|
|
6
45
|
_cmdName() {
|
|
7
46
|
return "npm";
|
|
8
47
|
}
|
|
@@ -1,4 +1,17 @@
|
|
|
1
1
|
export default class Javascript_pnpm extends Base_javascript {
|
|
2
|
+
/**
|
|
3
|
+
* Parses `pnpm-lock.yaml` (lockfileVersion 9) into a hash map keyed by
|
|
4
|
+
* `name@version`. Entries in the `packages` section are keyed by
|
|
5
|
+
* `<name>@<version>` (optionally followed by a `(peer@x)` suffix); the
|
|
6
|
+
* `resolution.integrity` field holds an SRI string.
|
|
7
|
+
* @param {string} lockDir - Directory containing pnpm-lock.yaml
|
|
8
|
+
* @returns {Map<string, Array<{alg: string, content: string}>>} Hash map
|
|
9
|
+
* @protected
|
|
10
|
+
*/
|
|
11
|
+
protected _parseLockFileHashes(lockDir: string): Map<string, Array<{
|
|
12
|
+
alg: string;
|
|
13
|
+
content: string;
|
|
14
|
+
}>>;
|
|
2
15
|
_listCmdArgs(includeTransitive: any): string[];
|
|
3
16
|
_buildDependencyTree(includeTransitive: any, opts?: {}): any;
|
|
4
17
|
}
|
|
@@ -1,8 +1,54 @@
|
|
|
1
|
-
import
|
|
1
|
+
import fs from 'node:fs';
|
|
2
|
+
import path from 'node:path';
|
|
3
|
+
import { load as yamlLoad } from 'js-yaml';
|
|
4
|
+
import Base_javascript, { sriToHash } from './base_javascript.js';
|
|
2
5
|
export default class Javascript_pnpm extends Base_javascript {
|
|
3
6
|
_lockFileName() {
|
|
4
7
|
return "pnpm-lock.yaml";
|
|
5
8
|
}
|
|
9
|
+
/**
|
|
10
|
+
* Parses `pnpm-lock.yaml` (lockfileVersion 9) into a hash map keyed by
|
|
11
|
+
* `name@version`. Entries in the `packages` section are keyed by
|
|
12
|
+
* `<name>@<version>` (optionally followed by a `(peer@x)` suffix); the
|
|
13
|
+
* `resolution.integrity` field holds an SRI string.
|
|
14
|
+
* @param {string} lockDir - Directory containing pnpm-lock.yaml
|
|
15
|
+
* @returns {Map<string, Array<{alg: string, content: string}>>} Hash map
|
|
16
|
+
* @protected
|
|
17
|
+
*/
|
|
18
|
+
_parseLockFileHashes(lockDir) {
|
|
19
|
+
const map = new Map();
|
|
20
|
+
const lockPath = path.join(lockDir, this._lockFileName());
|
|
21
|
+
if (!fs.existsSync(lockPath)) {
|
|
22
|
+
return map;
|
|
23
|
+
}
|
|
24
|
+
let lock;
|
|
25
|
+
try {
|
|
26
|
+
lock = yamlLoad(fs.readFileSync(lockPath, 'utf-8'));
|
|
27
|
+
}
|
|
28
|
+
catch (_) {
|
|
29
|
+
return map;
|
|
30
|
+
}
|
|
31
|
+
const packages = lock?.packages || {};
|
|
32
|
+
for (const [key, entry] of Object.entries(packages)) {
|
|
33
|
+
const integrity = entry?.resolution?.integrity;
|
|
34
|
+
if (!key || !integrity) {
|
|
35
|
+
continue;
|
|
36
|
+
}
|
|
37
|
+
// Strip any peer-dependency suffix, then split name from version
|
|
38
|
+
const base = key.split('(')[0];
|
|
39
|
+
const at = base.lastIndexOf('@');
|
|
40
|
+
if (at <= 0) {
|
|
41
|
+
continue;
|
|
42
|
+
}
|
|
43
|
+
const name = base.slice(0, at);
|
|
44
|
+
const version = base.slice(at + 1);
|
|
45
|
+
const hash = sriToHash(integrity);
|
|
46
|
+
if (name && version && hash) {
|
|
47
|
+
map.set(`${name}@${version}`, [hash]);
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
return map;
|
|
51
|
+
}
|
|
6
52
|
_cmdName() {
|
|
7
53
|
return "pnpm";
|
|
8
54
|
}
|
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
export default class Javascript_yarn extends Base_javascript {
|
|
2
2
|
static VERSION_PATTERN: RegExp;
|
|
3
|
+
/**
|
|
4
|
+
* Parses `yarn.lock` into a hash map keyed by `name@version`. Supports both
|
|
5
|
+
* Yarn Classic (v1) entries with an `integrity` SRI field and Yarn Berry
|
|
6
|
+
* (v2+) entries with a `checksum` field.
|
|
7
|
+
* @param {string} lockDir - Directory containing yarn.lock
|
|
8
|
+
* @returns {Map<string, Array<{alg: string, content: string}>>} Hash map
|
|
9
|
+
* @protected
|
|
10
|
+
*/
|
|
11
|
+
protected _parseLockFileHashes(lockDir: string): Map<string, Array<{
|
|
12
|
+
alg: string;
|
|
13
|
+
content: string;
|
|
14
|
+
}>>;
|
|
3
15
|
_listCmdArgs(includeTransitive: any, manifestDir: any): any;
|
|
4
16
|
_updateLockFileCmdArgs(manifestDir: any): any;
|
|
5
17
|
_setUp(manifestPath: any, opts: any): void;
|
|
@@ -1,12 +1,85 @@
|
|
|
1
|
-
import
|
|
1
|
+
import fs from 'node:fs';
|
|
2
|
+
import path from 'node:path';
|
|
3
|
+
import { parseSyml } from '@yarnpkg/parsers';
|
|
4
|
+
import Base_javascript, { sriToHash } from './base_javascript.js';
|
|
2
5
|
import Yarn_berry_processor from './processors/yarn_berry_processor.js';
|
|
3
6
|
import Yarn_classic_processor from './processors/yarn_classic_processor.js';
|
|
7
|
+
/**
|
|
8
|
+
* Converts a Yarn Berry `checksum` value to a CycloneDX hash object. Berry
|
|
9
|
+
* checksums are formatted as `<cacheKey>/<hex-sha512>`; the digest is the
|
|
10
|
+
* hex-encoded SHA-512 following the final slash.
|
|
11
|
+
* @param {string} checksum - The checksum field value
|
|
12
|
+
* @returns {{alg: string, content: string}|null} CycloneDX hash, or null
|
|
13
|
+
*/
|
|
14
|
+
function berryChecksumToHash(checksum) {
|
|
15
|
+
if (typeof checksum !== 'string') {
|
|
16
|
+
return null;
|
|
17
|
+
}
|
|
18
|
+
const slash = checksum.lastIndexOf('/');
|
|
19
|
+
const hex = (slash >= 0 ? checksum.slice(slash + 1) : checksum).trim();
|
|
20
|
+
if (!/^[0-9a-f]+$/i.test(hex)) {
|
|
21
|
+
return null;
|
|
22
|
+
}
|
|
23
|
+
return { alg: 'SHA-512', content: hex.toLowerCase() };
|
|
24
|
+
}
|
|
4
25
|
export default class Javascript_yarn extends Base_javascript {
|
|
5
26
|
static VERSION_PATTERN = /^([0-9]+)\./;
|
|
6
27
|
#processor;
|
|
7
28
|
_lockFileName() {
|
|
8
29
|
return "yarn.lock";
|
|
9
30
|
}
|
|
31
|
+
/**
|
|
32
|
+
* Parses `yarn.lock` into a hash map keyed by `name@version`. Supports both
|
|
33
|
+
* Yarn Classic (v1) entries with an `integrity` SRI field and Yarn Berry
|
|
34
|
+
* (v2+) entries with a `checksum` field.
|
|
35
|
+
* @param {string} lockDir - Directory containing yarn.lock
|
|
36
|
+
* @returns {Map<string, Array<{alg: string, content: string}>>} Hash map
|
|
37
|
+
* @protected
|
|
38
|
+
*/
|
|
39
|
+
_parseLockFileHashes(lockDir) {
|
|
40
|
+
const map = new Map();
|
|
41
|
+
const lockPath = path.join(lockDir, this._lockFileName());
|
|
42
|
+
if (!fs.existsSync(lockPath)) {
|
|
43
|
+
return map;
|
|
44
|
+
}
|
|
45
|
+
let content;
|
|
46
|
+
try {
|
|
47
|
+
content = fs.readFileSync(lockPath, 'utf-8');
|
|
48
|
+
}
|
|
49
|
+
catch (_) {
|
|
50
|
+
return map;
|
|
51
|
+
}
|
|
52
|
+
const parsed = parseSyml(content);
|
|
53
|
+
for (const [spec, entry] of Object.entries(parsed)) {
|
|
54
|
+
if (spec === '__metadata') {
|
|
55
|
+
continue;
|
|
56
|
+
}
|
|
57
|
+
const version = entry.version;
|
|
58
|
+
if (!version) {
|
|
59
|
+
continue;
|
|
60
|
+
}
|
|
61
|
+
let hash = null;
|
|
62
|
+
if (entry.integrity) {
|
|
63
|
+
hash = sriToHash(entry.integrity);
|
|
64
|
+
}
|
|
65
|
+
else if (entry.checksum) {
|
|
66
|
+
hash = berryChecksumToHash(entry.checksum);
|
|
67
|
+
}
|
|
68
|
+
if (!hash) {
|
|
69
|
+
continue;
|
|
70
|
+
}
|
|
71
|
+
// Handle comma-separated specifiers (e.g., "pkg@^1.0.0, pkg@^2.0.0")
|
|
72
|
+
for (const rawSpec of spec.split(',')) {
|
|
73
|
+
const trimmed = rawSpec.trim();
|
|
74
|
+
const atIndex = trimmed.lastIndexOf('@');
|
|
75
|
+
if (atIndex > 0) {
|
|
76
|
+
const name = trimmed.slice(0, atIndex);
|
|
77
|
+
map.set(`${name}@${version}`, [hash]);
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
return map;
|
|
82
|
+
}
|
|
10
83
|
_cmdName() {
|
|
11
84
|
return "yarn";
|
|
12
85
|
}
|
|
@@ -34,6 +107,6 @@ export default class Javascript_yarn extends Base_javascript {
|
|
|
34
107
|
return this.#processor.parseDepTreeOutput(output);
|
|
35
108
|
}
|
|
36
109
|
_addDependenciesToSbom(sbom, depTree) {
|
|
37
|
-
this.#processor.addDependenciesToSbom(sbom, depTree);
|
|
110
|
+
this.#processor.addDependenciesToSbom(sbom, depTree, purl => this._hashesForPurl(purl));
|
|
38
111
|
}
|
|
39
112
|
}
|
|
@@ -55,11 +55,14 @@ export default class Manifest {
|
|
|
55
55
|
}
|
|
56
56
|
loadIgnored(content) {
|
|
57
57
|
let deps = [];
|
|
58
|
-
|
|
58
|
+
// Prefer the new 'trustify-da-ignore' key, falling back to the legacy
|
|
59
|
+
// 'exhortignore' key for backwards compatibility.
|
|
60
|
+
let ignored = content['trustify-da-ignore'] || content.exhortignore;
|
|
61
|
+
if (!ignored) {
|
|
59
62
|
return deps;
|
|
60
63
|
}
|
|
61
|
-
for (let i = 0; i <
|
|
62
|
-
deps.push(toPurl("npm",
|
|
64
|
+
for (let i = 0; i < ignored.length; i++) {
|
|
65
|
+
deps.push(toPurl("npm", ignored[i]));
|
|
63
66
|
}
|
|
64
67
|
return deps;
|
|
65
68
|
}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Parse all FROM instructions from a Dockerfile using tree-sitter to extract base image references.
|
|
3
|
+
* In multi-stage builds, every FROM line is returned so each image can be analyzed independently.
|
|
4
|
+
* ARG substitutions are resolved using declared default values. FROM lines with unresolvable
|
|
5
|
+
* variables (ARGs without defaults) are silently skipped.
|
|
6
|
+
* @param {string} manifestContent the content of the Dockerfile
|
|
7
|
+
* @returns {Promise<string[]>} array of image references from all resolvable FROM instructions
|
|
8
|
+
* @throws {Error} when no FROM instruction is found or when no FROM lines can be resolved
|
|
9
|
+
*/
|
|
10
|
+
export function parseAllFromImages(manifestContent: string): Promise<string[]>;
|
|
11
|
+
declare namespace _default {
|
|
12
|
+
export { isSupported };
|
|
13
|
+
export { validateLockFile };
|
|
14
|
+
export { provideComponent };
|
|
15
|
+
export { provideStack };
|
|
16
|
+
export { readLicenseFromManifest };
|
|
17
|
+
export function packageManagerName(): string;
|
|
18
|
+
}
|
|
19
|
+
export default _default;
|
|
20
|
+
export type Provided = any;
|
|
21
|
+
/**
|
|
22
|
+
* Check if the given manifest name is a Dockerfile or Containerfile.
|
|
23
|
+
* Supports dot-suffixed variants such as Dockerfile.dev or Containerfile.prod.
|
|
24
|
+
* @param {string} manifestName the manifest file name to check
|
|
25
|
+
* @returns {boolean} true if the manifest is a Dockerfile or Containerfile
|
|
26
|
+
*/
|
|
27
|
+
declare function isSupported(manifestName: string): boolean;
|
|
28
|
+
/**
|
|
29
|
+
* Dockerfiles have no lock file, so validation always passes.
|
|
30
|
+
* @returns {boolean} always true
|
|
31
|
+
*/
|
|
32
|
+
declare function validateLockFile(): boolean;
|
|
33
|
+
/**
|
|
34
|
+
* Provide content and content type for Dockerfile component analysis.
|
|
35
|
+
* @param {string} manifest path to the Dockerfile
|
|
36
|
+
* @param {{}} [opts={}] optional various options to pass along the application
|
|
37
|
+
* @returns {Promise<Provided>}
|
|
38
|
+
*/
|
|
39
|
+
declare function provideComponent(manifest: string, opts?: {}): Promise<Provided>;
|
|
40
|
+
/**
|
|
41
|
+
* Provide content and content type for Dockerfile stack analysis.
|
|
42
|
+
* @param {string} manifest path to the Dockerfile
|
|
43
|
+
* @param {{}} [opts={}] optional various options to pass along the application
|
|
44
|
+
* @returns {Promise<Provided>}
|
|
45
|
+
*/
|
|
46
|
+
declare function provideStack(manifest: string, opts?: {}): Promise<Provided>;
|
|
47
|
+
/**
|
|
48
|
+
* Dockerfiles contain no license information.
|
|
49
|
+
* @returns {null} always null
|
|
50
|
+
*/
|
|
51
|
+
declare function readLicenseFromManifest(): null;
|