@trustify-da/trustify-da-javascript-client 0.3.0-ea.212178e → 0.3.0-ea.243eaef
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +177 -3
- package/dist/package.json +29 -22
- package/dist/src/analysis.d.ts +14 -7
- package/dist/src/analysis.js +29 -13
- package/dist/src/cli.js +106 -2
- package/dist/src/cyclone_dx_sbom.d.ts +13 -0
- package/dist/src/cyclone_dx_sbom.js +50 -4
- package/dist/src/index.d.ts +14 -10
- package/dist/src/index.js +12 -25
- package/dist/src/license/index.d.ts +3 -3
- package/dist/src/license/index.js +4 -1
- package/dist/src/license/license_utils.js +4 -1
- package/dist/src/license/licenses_api.d.ts +2 -2
- package/dist/src/oci_image/images.d.ts +1 -1
- package/dist/src/oci_image/images.js +15 -1
- package/dist/src/oci_image/utils.d.ts +5 -5
- package/dist/src/package_version.d.ts +8 -0
- package/dist/src/package_version.js +31 -0
- package/dist/src/provider.d.ts +3 -3
- package/dist/src/provider.js +4 -2
- package/dist/src/providers/base_java.d.ts +62 -3
- package/dist/src/providers/base_java.js +73 -23
- package/dist/src/providers/base_javascript.d.ts +63 -9
- package/dist/src/providers/base_javascript.js +105 -3
- package/dist/src/providers/base_pyproject.d.ts +5 -5
- 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 +1 -1
- 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_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 +29 -9
- package/dist/src/providers/java_maven.js +176 -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 +19 -1
- package/dist/src/providers/javascript_npm.js +40 -1
- package/dist/src/providers/javascript_pnpm.d.ts +13 -0
- package/dist/src/providers/javascript_pnpm.js +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 +6 -2
- package/dist/src/providers/processors/yarn_berry_processor.js +3 -2
- package/dist/src/providers/processors/yarn_classic_processor.d.ts +6 -2
- package/dist/src/providers/processors/yarn_classic_processor.js +8 -6
- package/dist/src/providers/python_controller.js +4 -1
- package/dist/src/providers/python_poetry.d.ts +31 -8
- package/dist/src/providers/python_poetry.js +62 -14
- package/dist/src/providers/python_uv.d.ts +5 -14
- package/dist/src/providers/python_uv.js +44 -2
- package/dist/src/providers/requirements_parser.js +1 -1
- package/dist/src/providers/rust_cargo.d.ts +5 -2
- package/dist/src/providers/rust_cargo.js +100 -32
- package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
- package/dist/src/remediate.d.ts +21 -0
- package/dist/src/remediate.js +149 -0
- package/dist/src/remediation.d.ts +57 -0
- package/dist/src/remediation.js +436 -0
- package/dist/src/remediation_report.d.ts +40 -0
- package/dist/src/remediation_report.js +159 -0
- package/dist/src/sbom.d.ts +11 -0
- package/dist/src/sbom.js +10 -0
- package/dist/src/tools.d.ts +2 -2
- package/dist/src/tools.js +24 -1
- package/dist/src/updaters/maven_updater.d.ts +26 -0
- package/dist/src/updaters/maven_updater.js +322 -0
- package/dist/src/updaters/toml_updater.d.ts +33 -0
- package/dist/src/updaters/toml_updater.js +244 -0
- package/package.json +30 -23
package/dist/src/provider.js
CHANGED
|
@@ -7,13 +7,14 @@ 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';
|
|
13
14
|
import Python_uv from './providers/python_uv.js';
|
|
14
15
|
import rustCargoProvider from './providers/rust_cargo.js';
|
|
15
16
|
/** @typedef {{ecosystem: string, contentType: string, content: string}} Provided */
|
|
16
|
-
/** @typedef {{isSupported: function(string): boolean, validateLockFile: function(string, Object): void, provideComponent: function(string, {}): Provided | Promise<Provided>, provideStack: function(string, {}): Provided | Promise<Provided>, readLicenseFromManifest: function(string): string | null, packageManagerName: function(): string}} Provider */
|
|
17
|
+
/** @typedef {{isSupported: function(string): boolean, validateLockFile: function(string, Object): void, provideComponent: function(string, {}): Provided | Promise<Provided>, provideStack: function(string, {}): Provided | Promise<Provided>, readLicenseFromManifest: function(string, Object=): string | null, packageManagerName: function(): string}} Provider */
|
|
17
18
|
/**
|
|
18
19
|
* MUST include all providers here.
|
|
19
20
|
* @type {[Provider]}
|
|
@@ -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.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export type ecosystem_maven =
|
|
1
|
+
export type ecosystem_maven = any;
|
|
2
2
|
/** @typedef {import('../provider').Provider} */
|
|
3
3
|
/** @typedef {import('../provider').Provided} Provided */
|
|
4
4
|
/** @typedef {{name: string, version: string}} Package */
|
|
@@ -10,6 +10,13 @@ export type ecosystem_maven = import("../provider").Provider;
|
|
|
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
|
|
@@ -33,6 +40,59 @@ export default class Base_Java {
|
|
|
33
40
|
* @param {Sbom} sbom - The SBOM where the dependencies are being added
|
|
34
41
|
*/
|
|
35
42
|
parseDependencyTree(src: string, srcDepth: number, lines: any[], sbom: Sbom): void;
|
|
43
|
+
/**
|
|
44
|
+
* Calculates how deep in the graph is the given line
|
|
45
|
+
* @param {string} line - line to calculate the depth from
|
|
46
|
+
* @returns {number} The calculated depth
|
|
47
|
+
* @protected
|
|
48
|
+
*/
|
|
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;
|
|
36
96
|
/**
|
|
37
97
|
* Create a PackageURL from any line in a Text Graph dependency tree for a manifest path.
|
|
38
98
|
* @param {string} line - line to parse from a dependencies.txt file
|
|
@@ -62,9 +122,8 @@ export default class Base_Java {
|
|
|
62
122
|
* @returns string
|
|
63
123
|
*/
|
|
64
124
|
selectToolBinary(manifestPath: string, opts: {}): string | null;
|
|
65
|
-
#private;
|
|
66
125
|
}
|
|
67
|
-
export type Provided =
|
|
126
|
+
export type Provided = any;
|
|
68
127
|
export type Package = {
|
|
69
128
|
name: string;
|
|
70
129
|
version: string;
|
|
@@ -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
|
/**
|
|
@@ -48,7 +55,7 @@ export default class Base_Java {
|
|
|
48
55
|
}
|
|
49
56
|
let index = 0;
|
|
50
57
|
let target = lines[index];
|
|
51
|
-
let targetDepth = this
|
|
58
|
+
let targetDepth = this._getDepth(target);
|
|
52
59
|
while (targetDepth > srcDepth && index < lines.length) {
|
|
53
60
|
if (targetDepth === srcDepth + 1) {
|
|
54
61
|
let from = this.parseDep(src);
|
|
@@ -61,49 +68,92 @@ export default class Base_Java {
|
|
|
61
68
|
}
|
|
62
69
|
}
|
|
63
70
|
else {
|
|
64
|
-
this.parseDependencyTree(lines[index - 1], this
|
|
71
|
+
this.parseDependencyTree(lines[index - 1], this._getDepth(lines[index - 1]), lines.slice(index), sbom);
|
|
65
72
|
}
|
|
66
73
|
target = lines[++index];
|
|
67
|
-
targetDepth = this
|
|
74
|
+
targetDepth = this._getDepth(target);
|
|
68
75
|
}
|
|
69
76
|
}
|
|
70
77
|
/**
|
|
71
78
|
* Calculates how deep in the graph is the given line
|
|
72
79
|
* @param {string} line - line to calculate the depth from
|
|
73
80
|
* @returns {number} The calculated depth
|
|
74
|
-
* @
|
|
81
|
+
* @protected
|
|
75
82
|
*/
|
|
76
|
-
|
|
77
|
-
if (line ===
|
|
83
|
+
_getDepth(line) {
|
|
84
|
+
if (!line || line.trim() === '') {
|
|
78
85
|
return -1;
|
|
79
86
|
}
|
|
87
|
+
if (line.match(/^\w/)) {
|
|
88
|
+
return 0;
|
|
89
|
+
}
|
|
80
90
|
return ((line.indexOf('-') - 1) / 3) + 1;
|
|
81
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
|
+
}
|
|
82
146
|
/**
|
|
83
147
|
* Create a PackageURL from any line in a Text Graph dependency tree for a manifest path.
|
|
84
148
|
* @param {string} line - line to parse from a dependencies.txt file
|
|
85
149
|
* @returns {PackageURL} The parsed packageURL
|
|
86
150
|
*/
|
|
87
151
|
parseDep(line) {
|
|
88
|
-
|
|
89
|
-
if (
|
|
90
|
-
throw new Error(`Unable generate SBOM from dependency tree. Line: ${line} cannot be parsed into a PackageURL`);
|
|
91
|
-
}
|
|
92
|
-
let version;
|
|
93
|
-
if (match.length >= 5 && ['compile', 'provided', 'runtime'].includes(match[5])) {
|
|
94
|
-
version = `${match[4]}-${match[3]}`;
|
|
95
|
-
}
|
|
96
|
-
else {
|
|
97
|
-
version = match[3];
|
|
98
|
-
}
|
|
99
|
-
let override = line.match(this.CONFLICT_REGEX);
|
|
100
|
-
if (override) {
|
|
101
|
-
version = override[1];
|
|
102
|
-
}
|
|
103
|
-
if (match[0].trim() === '') {
|
|
152
|
+
const coord = this.parseCoordinate(line);
|
|
153
|
+
if (coord.groupId.trim() === '') {
|
|
104
154
|
throw new Error(`Artifact coordinates should have a non-empty group ID: ${line}`);
|
|
105
155
|
}
|
|
106
|
-
return this.
|
|
156
|
+
return this._coordinateToPurl(coord);
|
|
107
157
|
}
|
|
108
158
|
/**
|
|
109
159
|
* Returns a PackageUrl For Java maven dependencies
|
|
@@ -1,4 +1,17 @@
|
|
|
1
|
-
|
|
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;
|
|
14
|
+
export type purlType = any;
|
|
2
15
|
/** @typedef {import('../provider').Provider} */
|
|
3
16
|
/** @typedef {import('../provider').Provided} Provided */
|
|
4
17
|
/**
|
|
@@ -19,7 +32,7 @@ export default class Base_javascript {
|
|
|
19
32
|
* @param {Object} opts - Configuration options for the provider
|
|
20
33
|
* @protected
|
|
21
34
|
*/
|
|
22
|
-
protected _setUp(manifestPath: string, opts:
|
|
35
|
+
protected _setUp(manifestPath: string, opts: Object): void;
|
|
23
36
|
/**
|
|
24
37
|
* Gets the current manifest object
|
|
25
38
|
* @returns {Manifest} The manifest object
|
|
@@ -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
|
|
@@ -91,21 +145,21 @@ export default class Base_javascript {
|
|
|
91
145
|
* @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
|
|
92
146
|
* @returns {boolean} True if the lock file exists
|
|
93
147
|
*/
|
|
94
|
-
validateLockFile(manifestDir: string, opts?:
|
|
148
|
+
validateLockFile(manifestDir: string, opts?: Object): boolean;
|
|
95
149
|
/**
|
|
96
150
|
* Provides content and content type for stack analysis
|
|
97
151
|
* @param {string} manifestPath - The manifest path or name
|
|
98
152
|
* @param {Object} [opts={}] - Optional configuration options
|
|
99
153
|
* @returns {Provided} The provided data for stack analysis
|
|
100
154
|
*/
|
|
101
|
-
provideStack(manifestPath: string, opts?:
|
|
155
|
+
provideStack(manifestPath: string, opts?: Object): Provided;
|
|
102
156
|
/**
|
|
103
157
|
* Provides content and content type for component analysis
|
|
104
158
|
* @param {string} manifestPath - Path to package.json for component report
|
|
105
159
|
* @param {Object} [opts={}] - Optional configuration options
|
|
106
160
|
* @returns {Provided} The provided data for component analysis
|
|
107
161
|
*/
|
|
108
|
-
provideComponent(manifestPath: string, opts?:
|
|
162
|
+
provideComponent(manifestPath: string, opts?: Object): Provided;
|
|
109
163
|
/**
|
|
110
164
|
* Read license from manifest (package.json). Reused by npm, pnpm, yarn.
|
|
111
165
|
* @param {string} manifestPath - path to package.json
|
|
@@ -119,21 +173,21 @@ export default class Base_javascript {
|
|
|
119
173
|
* @returns {Object} The dependency tree
|
|
120
174
|
* @protected
|
|
121
175
|
*/
|
|
122
|
-
protected _buildDependencyTree(includeTransitive: boolean, opts?:
|
|
176
|
+
protected _buildDependencyTree(includeTransitive: boolean, opts?: Object): Object;
|
|
123
177
|
/**
|
|
124
178
|
* Recursively builds the Sbom from the JSON that npm listing returns
|
|
125
179
|
* @param {Sbom} sbom - The SBOM object to add dependencies to
|
|
126
180
|
* @param {Object} depTree - The current dependency tree
|
|
127
181
|
* @protected
|
|
128
182
|
*/
|
|
129
|
-
protected _addDependenciesToSbom(sbom: Sbom, depTree:
|
|
183
|
+
protected _addDependenciesToSbom(sbom: Sbom, depTree: Object): void;
|
|
130
184
|
/**
|
|
131
185
|
* Extracts root dependencies from the dependency tree
|
|
132
186
|
* @param {Object} depTree - The dependency tree object
|
|
133
187
|
* @returns {Map<string, PackageURL>} Map of dependency names to their PackageURL objects
|
|
134
188
|
* @protected
|
|
135
189
|
*/
|
|
136
|
-
protected _getRootDependencies(depTree:
|
|
190
|
+
protected _getRootDependencies(depTree: Object): Map<string, PackageURL>;
|
|
137
191
|
/**
|
|
138
192
|
* Gets the version of the package manager
|
|
139
193
|
* @returns {string} The version string of the package manager
|
|
@@ -155,6 +209,6 @@ export default class Base_javascript {
|
|
|
155
209
|
protected _parseDepTreeOutput(output: string): string;
|
|
156
210
|
#private;
|
|
157
211
|
}
|
|
158
|
-
export type Provided =
|
|
212
|
+
export type Provided = any;
|
|
159
213
|
import Manifest from './manifest.js';
|
|
160
214
|
import Sbom from '../sbom.js';
|
|
@@ -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
|
-
|
|
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);
|
|
@@ -13,7 +13,7 @@ export default class Base_pyproject {
|
|
|
13
13
|
* @param {Object} [opts={}]
|
|
14
14
|
* @returns {boolean}
|
|
15
15
|
*/
|
|
16
|
-
validateLockFile(manifestDir: string, opts?:
|
|
16
|
+
validateLockFile(manifestDir: string, opts?: Object): boolean;
|
|
17
17
|
/**
|
|
18
18
|
* Walk up from manifestDir to find the directory containing the lock file.
|
|
19
19
|
* Follows the same pattern as Base_javascript._findLockFileDir().
|
|
@@ -22,7 +22,7 @@ export default class Base_pyproject {
|
|
|
22
22
|
* @returns {string|null}
|
|
23
23
|
* @protected
|
|
24
24
|
*/
|
|
25
|
-
protected _findLockFileDir(manifestDir: string, opts?:
|
|
25
|
+
protected _findLockFileDir(manifestDir: string, opts?: Object): string | null;
|
|
26
26
|
/**
|
|
27
27
|
* Detect workspace root boundaries.
|
|
28
28
|
* Currently only uv has native workspace support ([tool.uv.workspace] in pyproject.toml).
|
|
@@ -44,13 +44,13 @@ export default class Base_pyproject {
|
|
|
44
44
|
* @param {Object} [opts={}]
|
|
45
45
|
* @returns {Promise<Provided>}
|
|
46
46
|
*/
|
|
47
|
-
provideStack(manifest: string, opts?:
|
|
47
|
+
provideStack(manifest: string, opts?: Object): Promise<Provided>;
|
|
48
48
|
/**
|
|
49
49
|
* @param {string} manifest - path to pyproject.toml
|
|
50
50
|
* @param {Object} [opts={}]
|
|
51
51
|
* @returns {Promise<Provided>}
|
|
52
52
|
*/
|
|
53
|
-
provideComponent(manifest: string, opts?:
|
|
53
|
+
provideComponent(manifest: string, opts?: Object): Promise<Provided>;
|
|
54
54
|
/**
|
|
55
55
|
* @returns {string}
|
|
56
56
|
* @protected
|
|
@@ -77,7 +77,7 @@ export default class Base_pyproject {
|
|
|
77
77
|
* @returns {Promise<DependencyData>}
|
|
78
78
|
* @protected
|
|
79
79
|
*/
|
|
80
|
-
protected _getDependencyData(manifestDir: string, workspaceDir: string, parsed: object, opts:
|
|
80
|
+
protected _getDependencyData(manifestDir: string, workspaceDir: string, parsed: object, opts: Object): Promise<DependencyData>;
|
|
81
81
|
/**
|
|
82
82
|
* Canonicalize a Python package name per PEP 503.
|
|
83
83
|
* @param {string} name
|
|
@@ -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
|
+
}
|
|
@@ -16,7 +16,7 @@ declare namespace _default {
|
|
|
16
16
|
export function packageManagerName(): string;
|
|
17
17
|
}
|
|
18
18
|
export default _default;
|
|
19
|
-
export type Provided =
|
|
19
|
+
export type Provided = any;
|
|
20
20
|
export type Package = {
|
|
21
21
|
name: string;
|
|
22
22
|
version: string;
|