@trustify-da/trustify-da-javascript-client 0.3.0-ea.b68592e → 0.3.0-ea.b77d624

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.
Files changed (57) hide show
  1. package/README.md +189 -3
  2. package/dist/package.json +16 -7
  3. package/dist/src/analysis.d.ts +7 -0
  4. package/dist/src/analysis.js +29 -13
  5. package/dist/src/cli.js +106 -2
  6. package/dist/src/cyclone_dx_sbom.d.ts +13 -0
  7. package/dist/src/cyclone_dx_sbom.js +39 -1
  8. package/dist/src/index.d.ts +5 -1
  9. package/dist/src/index.js +12 -25
  10. package/dist/src/oci_image/images.js +15 -1
  11. package/dist/src/package_version.d.ts +8 -0
  12. package/dist/src/package_version.js +31 -0
  13. package/dist/src/provider.js +3 -1
  14. package/dist/src/providers/base_java.d.ts +53 -0
  15. package/dist/src/providers/base_java.js +64 -17
  16. package/dist/src/providers/base_javascript.d.ts +54 -0
  17. package/dist/src/providers/base_javascript.js +105 -3
  18. package/dist/src/providers/containerfile_parser.d.ts +5 -0
  19. package/dist/src/providers/containerfile_parser.js +20 -0
  20. package/dist/src/providers/golang_gomodules.js +49 -7
  21. package/dist/src/providers/java_gradle.d.ts +48 -0
  22. package/dist/src/providers/java_gradle.js +196 -18
  23. package/dist/src/providers/java_maven.d.ts +28 -8
  24. package/dist/src/providers/java_maven.js +104 -10
  25. package/dist/src/providers/javascript_bun.d.ts +12 -0
  26. package/dist/src/providers/javascript_bun.js +42 -1
  27. package/dist/src/providers/javascript_npm.d.ts +13 -0
  28. package/dist/src/providers/javascript_npm.js +40 -1
  29. package/dist/src/providers/javascript_pnpm.d.ts +13 -0
  30. package/dist/src/providers/javascript_pnpm.js +47 -1
  31. package/dist/src/providers/javascript_yarn.d.ts +12 -0
  32. package/dist/src/providers/javascript_yarn.js +75 -2
  33. package/dist/src/providers/manifest.js +6 -3
  34. package/dist/src/providers/oci_dockerfile.d.ts +51 -0
  35. package/dist/src/providers/oci_dockerfile.js +177 -0
  36. package/dist/src/providers/processors/yarn_berry_processor.d.ts +5 -1
  37. package/dist/src/providers/processors/yarn_berry_processor.js +3 -2
  38. package/dist/src/providers/processors/yarn_classic_processor.d.ts +5 -1
  39. package/dist/src/providers/processors/yarn_classic_processor.js +8 -6
  40. package/dist/src/providers/python_controller.js +4 -1
  41. package/dist/src/providers/requirements_parser.js +1 -1
  42. package/dist/src/providers/rust_cargo.js +70 -29
  43. package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
  44. package/dist/src/remediate.d.ts +21 -0
  45. package/dist/src/remediate.js +149 -0
  46. package/dist/src/remediation.d.ts +57 -0
  47. package/dist/src/remediation.js +436 -0
  48. package/dist/src/remediation_report.d.ts +40 -0
  49. package/dist/src/remediation_report.js +159 -0
  50. package/dist/src/sbom.d.ts +11 -0
  51. package/dist/src/sbom.js +10 -0
  52. package/dist/src/tools.js +24 -1
  53. package/dist/src/updaters/maven_updater.d.ts +26 -0
  54. package/dist/src/updaters/maven_updater.js +322 -0
  55. package/dist/src/updaters/toml_updater.d.ts +33 -0
  56. package/dist/src/updaters/toml_updater.js +244 -0
  57. package/package.json +17 -8
@@ -1,5 +1,12 @@
1
1
  import { EOL } from "os";
2
2
  import { PackageURL } from "packageurl-js";
3
+ import { getPackageVersion } from "./package_version.js";
4
+ /**
5
+ * This client's version, read once at module load, used to populate
6
+ * metadata.tools.components[].version in the generated SBOM.
7
+ * @type {string|undefined}
8
+ */
9
+ const PACKAGE_VERSION = getPackageVersion();
3
10
  /**
4
11
  *
5
12
  * @param component {PackageURL}
@@ -135,6 +142,30 @@ export default class CycloneDxSbom {
135
142
  }
136
143
  return this;
137
144
  }
145
+ /**
146
+ * Attach hashes to already-added components by matching their PURL. This is a
147
+ * post-processing step so ecosystem-specific hash sources (e.g. Maven reading
148
+ * the local .m2 cache) can enrich the SBOM without threading their concern
149
+ * through the shared dependency-tree parser. Components without a matching
150
+ * entry, or whose hashes are already set, are left untouched.
151
+ * @param {Map<string, Array<{alg: string, content: string}>>} hashMap - PURL→hashes map
152
+ * @return {CycloneDxSbom} the updated SBOM
153
+ */
154
+ attachHashes(hashMap) {
155
+ if (!hashMap || hashMap.size === 0) {
156
+ return this;
157
+ }
158
+ for (const component of this.components) {
159
+ if (component.hashes) {
160
+ continue;
161
+ }
162
+ const hashes = hashMap.get(component.purl);
163
+ if (hashes && hashes.length > 0) {
164
+ component.hashes = hashes;
165
+ }
166
+ }
167
+ return this;
168
+ }
138
169
  /** @param {{}} opts - various options, settings and configuration of application.
139
170
  * @return String CycloneDx Sbom json object in a string format
140
171
  */
@@ -144,11 +175,18 @@ export default class CycloneDxSbom {
144
175
  const rootPurl = this.rootComponent?.purl;
145
176
  this.sbomObject = {
146
177
  "bomFormat": "CycloneDX",
147
- "specVersion": "1.4",
178
+ "specVersion": "1.6",
148
179
  "version": 1,
149
180
  "metadata": {
150
181
  "timestamp": new Date(),
151
182
  "component": this.rootComponent,
183
+ "tools": {
184
+ "components": [{
185
+ "type": "application",
186
+ "name": "trustify-da-javascript-client",
187
+ "version": PACKAGE_VERSION
188
+ }]
189
+ },
152
190
  "properties": new Array()
153
191
  },
154
192
  "components": this.components.filter(c => c.purl !== rootPurl),
@@ -24,6 +24,7 @@ export function selectTrustifyDABackend(opts?: {
24
24
  export function generateSbom(manifestPath: string, opts?: Options): Promise<object>;
25
25
  export { parseImageRef } from "./oci_image/utils.js";
26
26
  export { ImageRef } from "./oci_image/images.js";
27
+ export { extractRemediations } from "./remediation.js";
27
28
  declare namespace _default {
28
29
  export { componentAnalysis };
29
30
  export { stackAnalysis };
@@ -53,7 +54,9 @@ export type Options = {
53
54
  TRUSTIFY_DA_PYTHON_PATH?: string | undefined;
54
55
  TRUSTIFY_DA_PYTHON_VIRTUAL_ENV?: string | undefined;
55
56
  TRUSTIFY_DA_PYTHON3_PATH?: string | undefined;
56
- TRUSTIFY_DA_RECOMMENDATIONS_ENABLED?: string | undefined;
57
+ TRUSTIFY_DA_PROVIDERS?: string | undefined;
58
+ TRUSTIFY_DA_RECOMMEND?: string | undefined;
59
+ TRUSTIFY_DA_SOURCES?: string | undefined;
57
60
  TRUSTIFY_DA_SKOPEO_CONFIG_PATH?: string | undefined;
58
61
  TRUSTIFY_DA_SKOPEO_PATH?: string | undefined;
59
62
  TRUSTIFY_DA_SYFT_CONFIG_PATH?: string | undefined;
@@ -264,3 +267,4 @@ import { resolveContinueOnError } from './batch_opts.js';
264
267
  import { resolveBatchMetadata } from './batch_opts.js';
265
268
  export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceModules, discoverUvWorkspaceMembers, discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata };
266
269
  export { getProjectLicense, findLicenseFilePath, identifyLicense, getLicenseDetails, licensesFromReport, normalizeLicensesResponse, runLicenseCheck, getCompatibility } from "./license/index.js";
270
+ export { generateReport, generateDeduplicationKey } from "./remediation_report.js";
package/dist/src/index.js CHANGED
@@ -1,21 +1,22 @@
1
+ import fs from 'node:fs';
1
2
  import path from "node:path";
2
3
  import { EOL } from "os";
3
4
  import pLimit from 'p-limit';
4
- import { availableProviders, match } from './provider.js';
5
5
  import analysis from './analysis.js';
6
- import fs from 'node:fs';
7
- import { getCustom } from "./tools.js";
8
6
  import { resolveBatchMetadata, resolveContinueOnError } from './batch_opts.js';
9
- import { discoverMavenModules } from './providers/java_maven.js';
10
- import { discoverGradleSubprojects } from './providers/java_gradle.js';
7
+ import { getPackageVersion } from './package_version.js';
8
+ import { availableProviders, match } from './provider.js';
11
9
  import { discoverGoWorkspaceModules } from './providers/golang_gomodules.js';
10
+ import { discoverGradleSubprojects } from './providers/java_gradle.js';
11
+ import { discoverMavenModules } from './providers/java_maven.js';
12
12
  import { discoverUvWorkspaceMembers } from './providers/python_uv.js';
13
+ import { getCustom } from "./tools.js";
13
14
  import { discoverWorkspaceCrates, discoverWorkspacePackages, filterManifestPathsByDiscoveryIgnore, resolveWorkspaceDiscoveryIgnore, validatePackageJson, } from './workspace.js';
14
- import.meta.dirname;
15
- import * as url from 'url';
16
15
  export { parseImageRef } from "./oci_image/utils.js";
17
16
  export { ImageRef } from "./oci_image/images.js";
18
17
  export { getProjectLicense, findLicenseFilePath, identifyLicense, getLicenseDetails, licensesFromReport, normalizeLicensesResponse, runLicenseCheck, getCompatibility } from "./license/index.js";
18
+ export { extractRemediations } from "./remediation.js";
19
+ export { generateReport, generateDeduplicationKey } from './remediation_report.js';
19
20
  export default { componentAnalysis, stackAnalysis, stackAnalysisBatch, imageAnalysis, validateToken, generateSbom };
20
21
  export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceModules, discoverUvWorkspaceMembers, discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata, };
21
22
  /**
@@ -39,7 +40,9 @@ export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceMod
39
40
  * TRUSTIFY_DA_PYTHON_PATH?: string | undefined,
40
41
  * TRUSTIFY_DA_PYTHON_VIRTUAL_ENV?: string | undefined,
41
42
  * TRUSTIFY_DA_PYTHON3_PATH?: string | undefined,
42
- * TRUSTIFY_DA_RECOMMENDATIONS_ENABLED?: string | undefined,
43
+ * TRUSTIFY_DA_PROVIDERS?: string | undefined,
44
+ * TRUSTIFY_DA_RECOMMEND?: string | undefined,
45
+ * TRUSTIFY_DA_SOURCES?: string | undefined,
43
46
  * TRUSTIFY_DA_SKOPEO_CONFIG_PATH?: string | undefined,
44
47
  * TRUSTIFY_DA_SKOPEO_PATH?: string | undefined,
45
48
  * TRUSTIFY_DA_SYFT_CONFIG_PATH?: string | undefined,
@@ -91,23 +94,7 @@ function logOptionsAndEnvironmentsVariables(alongsideText, valueToBePrinted) {
91
94
  * @private
92
95
  */
93
96
  function readAndPrintVersionFromPackageJson() {
94
- let dirName;
95
- // new ESM way in nodeJS ( since node version 22 ) to bring module directory.
96
- dirName = import.meta.dirname;
97
- // old ESM way in nodeJS ( before node versions 22.00 to bring module directory)
98
- if (!dirName) {
99
- dirName = url.fileURLToPath(new URL('.', import.meta.url));
100
- }
101
- try {
102
- if (__dirname) {
103
- dirName = __dirname;
104
- }
105
- }
106
- catch (e) {
107
- console.log("__dirname is not defined, continue with fileUrlPath");
108
- }
109
- let packageJson = JSON.parse(fs.readFileSync(path.join(dirName, "..", "package.json")).toString());
110
- logOptionsAndEnvironmentsVariables("trustify-da-javascript-client analysis started, version: ", packageJson.version);
97
+ logOptionsAndEnvironmentsVariables("trustify-da-javascript-client analysis started, version: ", getPackageVersion());
111
98
  }
112
99
  /**
113
100
  * This function is used to determine the Trustify DA backend URL.
@@ -242,8 +242,22 @@ export class ImageRef {
242
242
  getPackageURL() {
243
243
  /** @type {Object.<string, string>} */
244
244
  const qualifiers = {};
245
- const repositoryUrl = this.image.getNameWithoutTag();
245
+ let repositoryUrl = this.image.getNameWithoutTag();
246
246
  const simpleName = this.image.getSimpleName();
247
+ // Normalize Docker Hub image references so all forms produce the same PURL:
248
+ // node → docker.io/node
249
+ // docker.io/library/node → docker.io/node
250
+ if (repositoryUrl != null) {
251
+ const lower = repositoryUrl.toLowerCase();
252
+ if (lower === simpleName.toLowerCase()) {
253
+ // Bare name (e.g. "node") — default to docker.io
254
+ repositoryUrl = `docker.io/${simpleName}`;
255
+ }
256
+ else if (lower.startsWith('docker.io/library/')) {
257
+ // Official image with library/ prefix — strip it
258
+ repositoryUrl = `docker.io/${lower.substring('docker.io/library/'.length)}`;
259
+ }
260
+ }
247
261
  if (repositoryUrl != null && repositoryUrl.toLowerCase() !== simpleName.toLowerCase()) {
248
262
  qualifiers[ImageRef.REPOSITORY_QUALIFIER] = repositoryUrl.toLowerCase();
249
263
  }
@@ -0,0 +1,8 @@
1
+ /**
2
+ * Reads this package's version from package.json, resolving the path relative
3
+ * to this module. Works under ESM (node >= 22 import.meta.dirname, older via
4
+ * import.meta.url) and CommonJS (__dirname). Returns undefined if the file
5
+ * cannot be read, so callers never fail on a missing version.
6
+ * @return {string|undefined} the package version, or undefined
7
+ */
8
+ export function getPackageVersion(): string | undefined;
@@ -0,0 +1,31 @@
1
+ import fs from "node:fs";
2
+ import path from "node:path";
3
+ import * as url from "url";
4
+ /**
5
+ * Reads this package's version from package.json, resolving the path relative
6
+ * to this module. Works under ESM (node >= 22 import.meta.dirname, older via
7
+ * import.meta.url) and CommonJS (__dirname). Returns undefined if the file
8
+ * cannot be read, so callers never fail on a missing version.
9
+ * @return {string|undefined} the package version, or undefined
10
+ */
11
+ export function getPackageVersion() {
12
+ try {
13
+ let dirName = import.meta.dirname;
14
+ if (!dirName) {
15
+ dirName = url.fileURLToPath(new URL('.', import.meta.url));
16
+ }
17
+ try {
18
+ if (__dirname) {
19
+ dirName = __dirname;
20
+ }
21
+ }
22
+ catch {
23
+ // __dirname not defined under ESM, continue with fileURLToPath
24
+ }
25
+ const packageJson = JSON.parse(fs.readFileSync(path.join(dirName, "..", "package.json")).toString());
26
+ return packageJson.version;
27
+ }
28
+ catch {
29
+ return undefined;
30
+ }
31
+ }
@@ -7,6 +7,7 @@ import Javascript_bun from './providers/javascript_bun.js';
7
7
  import Javascript_npm from './providers/javascript_npm.js';
8
8
  import Javascript_pnpm from './providers/javascript_pnpm.js';
9
9
  import Javascript_yarn from './providers/javascript_yarn.js';
10
+ import dockerfileProvider from './providers/oci_dockerfile.js';
10
11
  import pythonPipProvider from './providers/python_pip.js';
11
12
  import Python_pip_pyproject from './providers/python_pip_pyproject.js';
12
13
  import Python_poetry from './providers/python_poetry.js';
@@ -31,7 +32,8 @@ export const availableProviders = [
31
32
  new Python_poetry(),
32
33
  new Python_uv(),
33
34
  new Python_pip_pyproject(),
34
- rustCargoProvider
35
+ rustCargoProvider,
36
+ dockerfileProvider
35
37
  ];
36
38
  /**
37
39
  * Match a provider by manifest type only (no lock file check). Used for license reading.
@@ -10,6 +10,13 @@ export type ecosystem_maven = any;
10
10
  export const ecosystem_maven: string;
11
11
  export const ecosystem_gradle: "gradle";
12
12
  export default class Base_Java {
13
+ /**
14
+ * Maven dependency scopes. Used to detect whether the trailing column of a
15
+ * dependency-tree line is a scope keyword — which in turn signals that an
16
+ * optional classifier column is present between the packaging and version.
17
+ * @type {string[]}
18
+ */
19
+ static MAVEN_SCOPES: string[];
13
20
  /**
14
21
  *
15
22
  * @param {string} globalBinary name of the global binary
@@ -40,6 +47,52 @@ export default class Base_Java {
40
47
  * @protected
41
48
  */
42
49
  protected _getDepth(line: string): number;
50
+ /**
51
+ * Parse a single dependency-tree line into its Maven coordinate parts.
52
+ *
53
+ * This is the single source of truth for interpreting a dependency-tree
54
+ * line. Both {@link parseDep} (used to build SBOM component PURLs) and the
55
+ * Maven hash-map builder rely on it, so the PURL key and the artifact file
56
+ * path can never drift from one another.
57
+ *
58
+ * A line has the shape `groupId:artifactId:packaging[:classifier]:version[:scope]`.
59
+ * The classifier column is only present when a sixth column holds a known
60
+ * Maven scope keyword; otherwise the fourth column is the version.
61
+ *
62
+ * @param {string} line - line to parse from a dependency tree
63
+ * @returns {{groupId: string, artifactId: string, packaging: string, classifier: (string|null), version: string, scope: (string|null), overridden: boolean}}
64
+ * Parsed coordinate. `version` is the resolved concrete version — when the
65
+ * line carries a conflict override the override version replaces it and
66
+ * `overridden` is set, mirroring how Maven records the winning version.
67
+ */
68
+ parseCoordinate(line: string): {
69
+ groupId: string;
70
+ artifactId: string;
71
+ packaging: string;
72
+ classifier: (string | null);
73
+ version: string;
74
+ scope: (string | null);
75
+ overridden: boolean;
76
+ };
77
+ /**
78
+ * Build the canonical PackageURL for a parsed coordinate.
79
+ *
80
+ * The classifier is folded into the version component (e.g.
81
+ * `4.1.0-linux-x86_64`) except when the version came from a conflict
82
+ * override, in which case the override version stands alone — matching the
83
+ * historical behavior of {@link parseDep}.
84
+ *
85
+ * @param {{groupId: string, artifactId: string, classifier: (string|null), version: string, overridden: boolean}} coord
86
+ * @returns {PackageURL} The canonical packageURL for the coordinate
87
+ * @protected
88
+ */
89
+ protected _coordinateToPurl(coord: {
90
+ groupId: string;
91
+ artifactId: string;
92
+ classifier: (string | null);
93
+ version: string;
94
+ overridden: boolean;
95
+ }): PackageURL;
43
96
  /**
44
97
  * Create a PackageURL from any line in a Text Graph dependency tree for a manifest path.
45
98
  * @param {string} line - line to parse from a dependencies.txt file
@@ -14,6 +14,13 @@ export const ecosystem_gradle = 'gradle';
14
14
  export default class Base_Java {
15
15
  DEP_REGEX = /(([-a-zA-Z0-9._]{2,})|[0-9])/g;
16
16
  CONFLICT_REGEX = /.*omitted for conflict with (\S+)\)/;
17
+ /**
18
+ * Maven dependency scopes. Used to detect whether the trailing column of a
19
+ * dependency-tree line is a scope keyword — which in turn signals that an
20
+ * optional classifier column is present between the packaging and version.
21
+ * @type {string[]}
22
+ */
23
+ static MAVEN_SCOPES = ['compile', 'provided', 'runtime', 'test', 'system', 'import'];
17
24
  globalBinary;
18
25
  localWrapper;
19
26
  /**
@@ -82,31 +89,71 @@ export default class Base_Java {
82
89
  }
83
90
  return ((line.indexOf('-') - 1) / 3) + 1;
84
91
  }
92
+ /**
93
+ * Parse a single dependency-tree line into its Maven coordinate parts.
94
+ *
95
+ * This is the single source of truth for interpreting a dependency-tree
96
+ * line. Both {@link parseDep} (used to build SBOM component PURLs) and the
97
+ * Maven hash-map builder rely on it, so the PURL key and the artifact file
98
+ * path can never drift from one another.
99
+ *
100
+ * A line has the shape `groupId:artifactId:packaging[:classifier]:version[:scope]`.
101
+ * The classifier column is only present when a sixth column holds a known
102
+ * Maven scope keyword; otherwise the fourth column is the version.
103
+ *
104
+ * @param {string} line - line to parse from a dependency tree
105
+ * @returns {{groupId: string, artifactId: string, packaging: string, classifier: (string|null), version: string, scope: (string|null), overridden: boolean}}
106
+ * Parsed coordinate. `version` is the resolved concrete version — when the
107
+ * line carries a conflict override the override version replaces it and
108
+ * `overridden` is set, mirroring how Maven records the winning version.
109
+ */
110
+ parseCoordinate(line) {
111
+ const parts = line.split(':').map(part => part ? part.match(this.DEP_REGEX)?.[0] ?? '' : '');
112
+ const groupId = parts[0] ?? '';
113
+ const artifactId = parts[1] ?? '';
114
+ const packaging = parts[2] ?? '';
115
+ // A classifier column exists only when a sixth column holds a scope keyword.
116
+ const hasClassifier = parts.length >= 6 && Base_Java.MAVEN_SCOPES.includes(parts[5]);
117
+ const classifier = hasClassifier ? parts[3] : null;
118
+ let version = (hasClassifier ? parts[4] : parts[3]) ?? '';
119
+ const scope = hasClassifier ? parts[5] : (parts.length >= 5 ? parts[4] : null);
120
+ // A conflict override replaces the resolved version entirely.
121
+ const override = line.match(this.CONFLICT_REGEX);
122
+ const overridden = Boolean(override);
123
+ if (overridden) {
124
+ version = override[1];
125
+ }
126
+ return { groupId, artifactId, packaging, classifier, version, scope, overridden };
127
+ }
128
+ /**
129
+ * Build the canonical PackageURL for a parsed coordinate.
130
+ *
131
+ * The classifier is folded into the version component (e.g.
132
+ * `4.1.0-linux-x86_64`) except when the version came from a conflict
133
+ * override, in which case the override version stands alone — matching the
134
+ * historical behavior of {@link parseDep}.
135
+ *
136
+ * @param {{groupId: string, artifactId: string, classifier: (string|null), version: string, overridden: boolean}} coord
137
+ * @returns {PackageURL} The canonical packageURL for the coordinate
138
+ * @protected
139
+ */
140
+ _coordinateToPurl(coord) {
141
+ const purlVersion = (coord.classifier && !coord.overridden)
142
+ ? `${coord.version}-${coord.classifier}`
143
+ : coord.version;
144
+ return this.toPurl(coord.groupId, coord.artifactId, purlVersion);
145
+ }
85
146
  /**
86
147
  * Create a PackageURL from any line in a Text Graph dependency tree for a manifest path.
87
148
  * @param {string} line - line to parse from a dependencies.txt file
88
149
  * @returns {PackageURL} The parsed packageURL
89
150
  */
90
151
  parseDep(line) {
91
- let match = line.split(':').map(part => part ? part.match(this.DEP_REGEX)[0] : '');
92
- if (!match) {
93
- throw new Error(`Unable generate SBOM from dependency tree. Line: ${line} cannot be parsed into a PackageURL`);
94
- }
95
- let version;
96
- if (match.length >= 5 && ['compile', 'provided', 'runtime'].includes(match[5])) {
97
- version = `${match[4]}-${match[3]}`;
98
- }
99
- else {
100
- version = match[3];
101
- }
102
- let override = line.match(this.CONFLICT_REGEX);
103
- if (override) {
104
- version = override[1];
105
- }
106
- if (match[0].trim() === '') {
152
+ const coord = this.parseCoordinate(line);
153
+ if (coord.groupId.trim() === '') {
107
154
  throw new Error(`Artifact coordinates should have a non-empty group ID: ${line}`);
108
155
  }
109
- return this.toPurl(match[0], match[1], version);
156
+ return this._coordinateToPurl(coord);
110
157
  }
111
158
  /**
112
159
  * Returns a PackageUrl For Java maven dependencies
@@ -1,3 +1,16 @@
1
+ /**
2
+ * Converts a Subresource Integrity (SRI) string to a CycloneDX hash object.
3
+ * SRI is formatted as `<alg>-<base64>` (e.g. `sha512-Ab3d...`). CycloneDX
4
+ * expects an uppercased algorithm label (e.g. `SHA-512`) and a hex-encoded
5
+ * digest. When the SRI string contains multiple space-separated hashes, only
6
+ * the first is used.
7
+ * @param {string} integrity - SRI string from a lock file
8
+ * @returns {{alg: string, content: string}|null} CycloneDX hash, or null when unparseable
9
+ */
10
+ export function sriToHash(integrity: string): {
11
+ alg: string;
12
+ content: string;
13
+ } | null;
1
14
  export type purlType = any;
2
15
  /** @typedef {import('../provider').Provider} */
3
16
  /** @typedef {import('../provider').Provided} Provided */
@@ -65,6 +78,47 @@ export default class Base_javascript {
65
78
  * @protected
66
79
  */
67
80
  protected _updateLockFileCmdArgs(): Array<string>;
81
+ /**
82
+ * Parses the provider's lock file into a hash map keyed by `name@version`.
83
+ * Subclasses override this (accepting the lock directory) to support their
84
+ * lock file format. The default implementation returns an empty map so
85
+ * providers without lock parsing (or without a lock file present) gracefully
86
+ * omit hashes.
87
+ * @returns {Map<string, Array<{alg: string, content: string}>>} Hash map
88
+ * @protected
89
+ */
90
+ protected _parseLockFileHashes(): Map<string, Array<{
91
+ alg: string;
92
+ content: string;
93
+ }>>;
94
+ /**
95
+ * Loads lock-file hashes for the given directory into internal state.
96
+ * Parsing failures degrade gracefully to an empty map (no hashes emitted).
97
+ * @param {string} lockDir - Directory containing the lock file
98
+ * @protected
99
+ */
100
+ protected _loadHashes(lockDir: string): void;
101
+ /**
102
+ * Looks up CycloneDX hashes for a package by name and resolved version.
103
+ * @param {string} name - The package name (including scope, e.g. `@hapi/joi`)
104
+ * @param {string} version - The resolved package version
105
+ * @returns {Array<{alg: string, content: string}>|undefined} Hashes, or undefined
106
+ * @protected
107
+ */
108
+ protected _hashesFor(name: string, version: string): Array<{
109
+ alg: string;
110
+ content: string;
111
+ }> | undefined;
112
+ /**
113
+ * Looks up CycloneDX hashes for a package described by a PackageURL.
114
+ * @param {PackageURL} purl - The package URL
115
+ * @returns {Array<{alg: string, content: string}>|undefined} Hashes, or undefined
116
+ * @protected
117
+ */
118
+ protected _hashesForPurl(purl: PackageURL): Array<{
119
+ alg: string;
120
+ content: string;
121
+ }> | undefined;
68
122
  /**
69
123
  * Checks if the provider supports the given manifest name
70
124
  * @param {string} manifestName - The manifest name to check
@@ -12,6 +12,49 @@ import Manifest from './manifest.js';
12
12
  * @type {string}
13
13
  */
14
14
  export const purlType = 'npm';
15
+ /**
16
+ * Maps a Subresource Integrity (SRI) algorithm token to its CycloneDX label.
17
+ * @type {Object<string, string>}
18
+ */
19
+ const SRI_ALG_LABELS = {
20
+ sha1: 'SHA-1',
21
+ sha256: 'SHA-256',
22
+ sha384: 'SHA-384',
23
+ sha512: 'SHA-512',
24
+ };
25
+ /**
26
+ * Converts a Subresource Integrity (SRI) string to a CycloneDX hash object.
27
+ * SRI is formatted as `<alg>-<base64>` (e.g. `sha512-Ab3d...`). CycloneDX
28
+ * expects an uppercased algorithm label (e.g. `SHA-512`) and a hex-encoded
29
+ * digest. When the SRI string contains multiple space-separated hashes, only
30
+ * the first is used.
31
+ * @param {string} integrity - SRI string from a lock file
32
+ * @returns {{alg: string, content: string}|null} CycloneDX hash, or null when unparseable
33
+ */
34
+ export function sriToHash(integrity) {
35
+ if (typeof integrity !== 'string') {
36
+ return null;
37
+ }
38
+ const first = integrity.trim().split(/\s+/)[0];
39
+ if (!first) {
40
+ return null;
41
+ }
42
+ const dash = first.indexOf('-');
43
+ if (dash < 0) {
44
+ return null;
45
+ }
46
+ const alg = SRI_ALG_LABELS[first.slice(0, dash).toLowerCase()];
47
+ // Strip any SRI options (e.g. "?foo") that may follow the base64 payload
48
+ const base64 = first.slice(dash + 1).split('?')[0];
49
+ if (!alg || !base64) {
50
+ return null;
51
+ }
52
+ const content = Buffer.from(base64, 'base64').toString('hex');
53
+ if (!content) {
54
+ return null;
55
+ }
56
+ return { alg, content };
57
+ }
15
58
  /**
16
59
  * Base class for JavaScript package manager providers.
17
60
  * This class provides common functionality for different JavaScript package managers
@@ -25,6 +68,11 @@ export default class Base_javascript {
25
68
  #cmd;
26
69
  /** @type {string} */
27
70
  #ecosystem;
71
+ /**
72
+ * Lock-file hashes keyed by `name@version`.
73
+ * @type {Map<string, Array<{alg: string, content: string}>>}
74
+ */
75
+ #hashes = new Map();
28
76
  /**
29
77
  * Sets up the provider with the manifest path and options
30
78
  * @param {string} manifestPath - Path to the package.json manifest file
@@ -95,6 +143,58 @@ export default class Base_javascript {
95
143
  _updateLockFileCmdArgs() {
96
144
  throw new TypeError("_updateLockFileCmdArgs must be implemented");
97
145
  }
146
+ /**
147
+ * Parses the provider's lock file into a hash map keyed by `name@version`.
148
+ * Subclasses override this (accepting the lock directory) to support their
149
+ * lock file format. The default implementation returns an empty map so
150
+ * providers without lock parsing (or without a lock file present) gracefully
151
+ * omit hashes.
152
+ * @returns {Map<string, Array<{alg: string, content: string}>>} Hash map
153
+ * @protected
154
+ */
155
+ _parseLockFileHashes() {
156
+ return new Map();
157
+ }
158
+ /**
159
+ * Loads lock-file hashes for the given directory into internal state.
160
+ * Parsing failures degrade gracefully to an empty map (no hashes emitted).
161
+ * @param {string} lockDir - Directory containing the lock file
162
+ * @protected
163
+ */
164
+ _loadHashes(lockDir) {
165
+ try {
166
+ this.#hashes = this._parseLockFileHashes(lockDir) || new Map();
167
+ }
168
+ catch (_) {
169
+ this.#hashes = new Map();
170
+ }
171
+ }
172
+ /**
173
+ * Looks up CycloneDX hashes for a package by name and resolved version.
174
+ * @param {string} name - The package name (including scope, e.g. `@hapi/joi`)
175
+ * @param {string} version - The resolved package version
176
+ * @returns {Array<{alg: string, content: string}>|undefined} Hashes, or undefined
177
+ * @protected
178
+ */
179
+ _hashesFor(name, version) {
180
+ if (!name || !version) {
181
+ return undefined;
182
+ }
183
+ return this.#hashes.get(`${name}@${version}`);
184
+ }
185
+ /**
186
+ * Looks up CycloneDX hashes for a package described by a PackageURL.
187
+ * @param {PackageURL} purl - The package URL
188
+ * @returns {Array<{alg: string, content: string}>|undefined} Hashes, or undefined
189
+ * @protected
190
+ */
191
+ _hashesForPurl(purl) {
192
+ if (!purl) {
193
+ return undefined;
194
+ }
195
+ const name = purl.namespace ? `${purl.namespace}/${purl.name}` : purl.name;
196
+ return this._hashesFor(name, purl.version);
197
+ }
98
198
  /**
99
199
  * Checks if the provider supports the given manifest name
100
200
  * @param {string} manifestName - The manifest name to check
@@ -225,6 +325,7 @@ export default class Base_javascript {
225
325
  const manifestDir = path.dirname(this.#manifest.manifestPath);
226
326
  const cmdDir = this._findLockFileDir(manifestDir, opts) || manifestDir;
227
327
  this._createLockFile(cmdDir);
328
+ this._loadHashes(cmdDir);
228
329
  let output = this.#executeListCmd(includeTransitive, cmdDir);
229
330
  output = this._parseDepTreeOutput(output);
230
331
  return JSON.parse(output);
@@ -284,7 +385,7 @@ export default class Base_javascript {
284
385
  const [name, artifact] = entry;
285
386
  const target = toPurl(purlType, name, artifact.version);
286
387
  const rootPurl = toPurl(purlType, this.#manifest.name, this.#manifest.version);
287
- sbom.addDependency(rootPurl, target);
388
+ sbom.addDependency(rootPurl, target, undefined, this._hashesFor(name, artifact.version));
288
389
  this.#addDependenciesOf(sbom, target, artifact);
289
390
  });
290
391
  }
@@ -302,7 +403,7 @@ export default class Base_javascript {
302
403
  const [name, depArtifact] = entry;
303
404
  if (depArtifact.version !== undefined) {
304
405
  const target = toPurl(purlType, name, depArtifact.version);
305
- sbom.addDependency(from, target);
406
+ sbom.addDependency(from, target, undefined, this._hashesFor(name, depArtifact.version));
306
407
  this.#addDependenciesOf(sbom, target, depArtifact);
307
408
  }
308
409
  });
@@ -326,7 +427,8 @@ export default class Base_javascript {
326
427
  .sort();
327
428
  for (const key of sortedDepsKeys) {
328
429
  const rootPurl = toPurlFromString(sbom.getRoot().purl);
329
- sbom.addDependency(rootPurl, rootDeps.get(key));
430
+ const targetPurl = rootDeps.get(key);
431
+ sbom.addDependency(rootPurl, targetPurl, undefined, this._hashesForPurl(targetPurl));
330
432
  }
331
433
  this.#ensurePeerAndOptionalDeps(sbom);
332
434
  sbom.filterIgnoredDeps(this.#manifest.ignored);
@@ -0,0 +1,5 @@
1
+ export function getParser(): Promise<Parser>;
2
+ export function getFromQuery(): Promise<Query>;
3
+ export function getArgQuery(): Promise<Query>;
4
+ import { Parser } from 'web-tree-sitter';
5
+ import { Query } from 'web-tree-sitter';
@@ -0,0 +1,20 @@
1
+ import { readFile } from 'node:fs/promises';
2
+ import { Language, Parser, Query } from 'web-tree-sitter';
3
+ const wasmUrl = new URL('./tree-sitter-containerfile.wasm', import.meta.url);
4
+ async function init() {
5
+ await Parser.init();
6
+ const wasmBytes = new Uint8Array(await readFile(wasmUrl));
7
+ return await Language.load(wasmBytes);
8
+ }
9
+ export async function getParser() {
10
+ const language = await init();
11
+ return new Parser().setLanguage(language);
12
+ }
13
+ export async function getFromQuery() {
14
+ const language = await init();
15
+ return new Query(language, '(from_instruction (image_spec) @image)');
16
+ }
17
+ export async function getArgQuery() {
18
+ const language = await init();
19
+ return new Query(language, '(arg_instruction (arg_pair name: (_) @name default: (_) @default))');
20
+ }