@trustify-da/trustify-da-javascript-client 0.3.0-ea.2ea1d77 → 0.3.0-ea.329b3cf
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 +75 -10
- package/dist/package.json +28 -24
- package/dist/src/analysis.d.ts +16 -7
- package/dist/src/analysis.js +36 -17
- package/dist/src/cli.js +109 -3
- package/dist/src/cyclone_dx_sbom.d.ts +14 -1
- package/dist/src/cyclone_dx_sbom.js +43 -8
- package/dist/src/index.d.ts +86 -11
- package/dist/src/index.js +97 -8
- package/dist/src/license/index.d.ts +3 -3
- package/dist/src/license/index.js +4 -1
- package/dist/src/license/license_utils.js +4 -1
- package/dist/src/license/licenses_api.d.ts +2 -2
- package/dist/src/oci_image/images.d.ts +1 -1
- package/dist/src/oci_image/images.js +15 -1
- package/dist/src/oci_image/utils.d.ts +5 -5
- package/dist/src/oci_image/utils.js +11 -2
- package/dist/src/provider.d.ts +4 -3
- package/dist/src/provider.js +12 -2
- package/dist/src/providers/base_java.d.ts +14 -12
- package/dist/src/providers/base_java.js +18 -44
- package/dist/src/providers/base_javascript.d.ts +36 -15
- package/dist/src/providers/base_javascript.js +100 -20
- package/dist/src/providers/base_pyproject.d.ts +158 -0
- package/dist/src/providers/base_pyproject.js +322 -0
- package/dist/src/providers/containerfile_parser.d.ts +5 -0
- package/dist/src/providers/containerfile_parser.js +20 -0
- package/dist/src/providers/golang_gomodules.d.ts +23 -13
- package/dist/src/providers/golang_gomodules.js +165 -119
- package/dist/src/providers/gomod_parser.d.ts +4 -0
- package/dist/src/providers/gomod_parser.js +16 -0
- package/dist/src/providers/java_gradle.d.ts +19 -0
- package/dist/src/providers/java_gradle.js +116 -2
- 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 +10 -2
- package/dist/src/providers/java_maven.js +165 -1
- package/dist/src/providers/javascript_bun.d.ts +10 -0
- package/dist/src/providers/javascript_bun.js +100 -0
- package/dist/src/providers/javascript_npm.d.ts +6 -0
- package/dist/src/providers/javascript_npm.js +21 -0
- package/dist/src/providers/javascript_pnpm.js +6 -2
- package/dist/src/providers/manifest.d.ts +2 -0
- package/dist/src/providers/manifest.js +22 -4
- package/dist/src/providers/marker_evaluator.d.ts +14 -0
- package/dist/src/providers/marker_evaluator.js +191 -0
- package/dist/src/providers/oci_dockerfile.d.ts +51 -0
- package/dist/src/providers/oci_dockerfile.js +177 -0
- package/dist/src/providers/processors/yarn_berry_processor.d.ts +2 -2
- package/dist/src/providers/processors/yarn_berry_processor.js +88 -5
- package/dist/src/providers/processors/yarn_classic_processor.d.ts +2 -2
- package/dist/src/providers/python_controller.d.ts +5 -1
- package/dist/src/providers/python_controller.js +69 -8
- package/dist/src/providers/python_pip.d.ts +5 -0
- package/dist/src/providers/python_pip.js +6 -6
- package/dist/src/providers/python_pip_pyproject.d.ts +61 -0
- package/dist/src/providers/python_pip_pyproject.js +146 -0
- package/dist/src/providers/python_poetry.d.ts +98 -0
- package/dist/src/providers/python_poetry.js +286 -0
- package/dist/src/providers/python_uv.d.ts +46 -0
- package/dist/src/providers/python_uv.js +269 -0
- package/dist/src/providers/rust_cargo.d.ts +6 -2
- package/dist/src/providers/rust_cargo.js +31 -4
- package/dist/src/providers/tree-sitter-containerfile.wasm +0 -0
- package/dist/src/providers/tree-sitter-gomod.wasm +0 -0
- package/dist/src/remediation.d.ts +34 -0
- package/dist/src/remediation.js +321 -0
- package/dist/src/remediation_report.d.ts +40 -0
- package/dist/src/remediation_report.js +159 -0
- package/dist/src/sbom.d.ts +14 -1
- package/dist/src/sbom.js +13 -2
- package/dist/src/tools.d.ts +28 -2
- package/dist/src/tools.js +58 -0
- package/dist/src/updaters/maven_updater.d.ts +26 -0
- package/dist/src/updaters/maven_updater.js +322 -0
- package/dist/src/updaters/toml_updater.d.ts +33 -0
- package/dist/src/updaters/toml_updater.js +244 -0
- package/dist/src/workspace.d.ts +9 -0
- package/dist/src/workspace.js +1 -1
- package/package.json +29 -25
|
@@ -135,7 +135,7 @@ function execSyft(imageRef, opts = {}) {
|
|
|
135
135
|
function getSyftEnvs(dockerPath, podmanPath) {
|
|
136
136
|
let path = null;
|
|
137
137
|
if (dockerPath && podmanPath) {
|
|
138
|
-
path = `${dockerPath}${
|
|
138
|
+
path = `${dockerPath}${delimiter}${podmanPath}`;
|
|
139
139
|
}
|
|
140
140
|
else if (dockerPath) {
|
|
141
141
|
path = dockerPath;
|
|
@@ -276,7 +276,16 @@ function podmanGetVariant(opts = {}) {
|
|
|
276
276
|
* @returns {string} - The information
|
|
277
277
|
*/
|
|
278
278
|
function dockerPodmanInfo(dockerSupplier, podmanSupplier, opts = {}) {
|
|
279
|
-
|
|
279
|
+
try {
|
|
280
|
+
const result = dockerSupplier(opts);
|
|
281
|
+
if (result) {
|
|
282
|
+
return result;
|
|
283
|
+
}
|
|
284
|
+
}
|
|
285
|
+
catch (_) {
|
|
286
|
+
// docker not available, fall through to podman
|
|
287
|
+
}
|
|
288
|
+
return podmanSupplier(opts);
|
|
280
289
|
}
|
|
281
290
|
/**
|
|
282
291
|
* Gets the digests for an image
|
package/dist/src/provider.d.ts
CHANGED
|
@@ -21,7 +21,7 @@ export function match(manifest: string, providers: [Provider], opts?: {
|
|
|
21
21
|
TRUSTIFY_DA_WORKSPACE_DIR?: string;
|
|
22
22
|
}): Provider;
|
|
23
23
|
/** @typedef {{ecosystem: string, contentType: string, content: string}} Provided */
|
|
24
|
-
/** @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}} Provider */
|
|
24
|
+
/** @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 */
|
|
25
25
|
/**
|
|
26
26
|
* MUST include all providers here.
|
|
27
27
|
* @type {[Provider]}
|
|
@@ -34,8 +34,9 @@ export type Provided = {
|
|
|
34
34
|
};
|
|
35
35
|
export type Provider = {
|
|
36
36
|
isSupported: (arg0: string) => boolean;
|
|
37
|
-
validateLockFile: (arg0: string, arg1:
|
|
37
|
+
validateLockFile: (arg0: string, arg1: Object) => void;
|
|
38
38
|
provideComponent: (arg0: string, arg1: {}) => Provided | Promise<Provided>;
|
|
39
39
|
provideStack: (arg0: string, arg1: {}) => Provided | Promise<Provided>;
|
|
40
|
-
readLicenseFromManifest: (arg0: string) => string | null;
|
|
40
|
+
readLicenseFromManifest: (arg0: string, arg1: Object | undefined) => string | null;
|
|
41
|
+
packageManagerName: () => string;
|
|
41
42
|
};
|
package/dist/src/provider.js
CHANGED
|
@@ -3,13 +3,18 @@ import golangGomodulesProvider from './providers/golang_gomodules.js';
|
|
|
3
3
|
import Java_gradle_groovy from "./providers/java_gradle_groovy.js";
|
|
4
4
|
import Java_gradle_kotlin from "./providers/java_gradle_kotlin.js";
|
|
5
5
|
import Java_maven from "./providers/java_maven.js";
|
|
6
|
+
import Javascript_bun from './providers/javascript_bun.js';
|
|
6
7
|
import Javascript_npm from './providers/javascript_npm.js';
|
|
7
8
|
import Javascript_pnpm from './providers/javascript_pnpm.js';
|
|
8
9
|
import Javascript_yarn from './providers/javascript_yarn.js';
|
|
10
|
+
import dockerfileProvider from './providers/oci_dockerfile.js';
|
|
9
11
|
import pythonPipProvider from './providers/python_pip.js';
|
|
12
|
+
import Python_pip_pyproject from './providers/python_pip_pyproject.js';
|
|
13
|
+
import Python_poetry from './providers/python_poetry.js';
|
|
14
|
+
import Python_uv from './providers/python_uv.js';
|
|
10
15
|
import rustCargoProvider from './providers/rust_cargo.js';
|
|
11
16
|
/** @typedef {{ecosystem: string, contentType: string, content: string}} Provided */
|
|
12
|
-
/** @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}} 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 */
|
|
13
18
|
/**
|
|
14
19
|
* MUST include all providers here.
|
|
15
20
|
* @type {[Provider]}
|
|
@@ -18,12 +23,17 @@ export const availableProviders = [
|
|
|
18
23
|
new Java_maven(),
|
|
19
24
|
new Java_gradle_groovy(),
|
|
20
25
|
new Java_gradle_kotlin(),
|
|
26
|
+
new Javascript_bun(),
|
|
21
27
|
new Javascript_pnpm(),
|
|
22
28
|
new Javascript_yarn(),
|
|
23
29
|
new Javascript_npm(),
|
|
24
30
|
golangGomodulesProvider,
|
|
25
31
|
pythonPipProvider,
|
|
26
|
-
|
|
32
|
+
new Python_poetry(),
|
|
33
|
+
new Python_uv(),
|
|
34
|
+
new Python_pip_pyproject(),
|
|
35
|
+
rustCargoProvider,
|
|
36
|
+
dockerfileProvider
|
|
27
37
|
];
|
|
28
38
|
/**
|
|
29
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 */
|
|
@@ -20,6 +20,11 @@ export default class Base_Java {
|
|
|
20
20
|
CONFLICT_REGEX: RegExp;
|
|
21
21
|
globalBinary: string;
|
|
22
22
|
localWrapper: string;
|
|
23
|
+
/**
|
|
24
|
+
* Returns the package manager name (e.g. mvn, gradle)
|
|
25
|
+
* @returns {string}
|
|
26
|
+
*/
|
|
27
|
+
packageManagerName(): string;
|
|
23
28
|
/**
|
|
24
29
|
* Recursively populates the SBOM instance with the parsed graph
|
|
25
30
|
* @param {string} src - Source dependency to start the calculations from
|
|
@@ -28,6 +33,13 @@ export default class Base_Java {
|
|
|
28
33
|
* @param {Sbom} sbom - The SBOM where the dependencies are being added
|
|
29
34
|
*/
|
|
30
35
|
parseDependencyTree(src: string, srcDepth: number, lines: any[], sbom: Sbom): void;
|
|
36
|
+
/**
|
|
37
|
+
* Calculates how deep in the graph is the given line
|
|
38
|
+
* @param {string} line - line to calculate the depth from
|
|
39
|
+
* @returns {number} The calculated depth
|
|
40
|
+
* @protected
|
|
41
|
+
*/
|
|
42
|
+
protected _getDepth(line: string): number;
|
|
31
43
|
/**
|
|
32
44
|
* Create a PackageURL from any line in a Text Graph dependency tree for a manifest path.
|
|
33
45
|
* @param {string} line - line to parse from a dependencies.txt file
|
|
@@ -57,18 +69,8 @@ export default class Base_Java {
|
|
|
57
69
|
* @returns string
|
|
58
70
|
*/
|
|
59
71
|
selectToolBinary(manifestPath: string, opts: {}): string | null;
|
|
60
|
-
/**
|
|
61
|
-
*
|
|
62
|
-
* @param {string} startingManifest - the path of the manifest from which to start searching for the wrapper
|
|
63
|
-
* @param {string} repoRoot - the root of the repository at which point to stop searching for mvnw, derived via git if unset and then fallsback
|
|
64
|
-
* to the root of the drive the manifest is on (assumes absolute path is given)
|
|
65
|
-
* @returns {string|undefined}
|
|
66
|
-
*/
|
|
67
|
-
traverseForWrapper(startingManifest: string, repoRoot?: string): string | undefined;
|
|
68
|
-
normalizePath(thePath: any): string;
|
|
69
|
-
#private;
|
|
70
72
|
}
|
|
71
|
-
export type Provided =
|
|
73
|
+
export type Provided = any;
|
|
72
74
|
export type Package = {
|
|
73
75
|
name: string;
|
|
74
76
|
version: string;
|
|
@@ -1,7 +1,6 @@
|
|
|
1
|
-
import fs from 'node:fs';
|
|
2
1
|
import path from 'node:path';
|
|
3
2
|
import { PackageURL } from 'packageurl-js';
|
|
4
|
-
import { getCustomPath,
|
|
3
|
+
import { getCustomPath, getWrapperPreference, invokeCommand, traverseForWrapper } from "../tools.js";
|
|
5
4
|
/** @typedef {import('../provider').Provider} */
|
|
6
5
|
/** @typedef {import('../provider').Provided} Provided */
|
|
7
6
|
/** @typedef {{name: string, version: string}} Package */
|
|
@@ -26,6 +25,13 @@ export default class Base_Java {
|
|
|
26
25
|
this.globalBinary = globalBinary;
|
|
27
26
|
this.localWrapper = localWrapper;
|
|
28
27
|
}
|
|
28
|
+
/**
|
|
29
|
+
* Returns the package manager name (e.g. mvn, gradle)
|
|
30
|
+
* @returns {string}
|
|
31
|
+
*/
|
|
32
|
+
packageManagerName() {
|
|
33
|
+
return this.globalBinary;
|
|
34
|
+
}
|
|
29
35
|
/**
|
|
30
36
|
* Recursively populates the SBOM instance with the parsed graph
|
|
31
37
|
* @param {string} src - Source dependency to start the calculations from
|
|
@@ -42,7 +48,7 @@ export default class Base_Java {
|
|
|
42
48
|
}
|
|
43
49
|
let index = 0;
|
|
44
50
|
let target = lines[index];
|
|
45
|
-
let targetDepth = this
|
|
51
|
+
let targetDepth = this._getDepth(target);
|
|
46
52
|
while (targetDepth > srcDepth && index < lines.length) {
|
|
47
53
|
if (targetDepth === srcDepth + 1) {
|
|
48
54
|
let from = this.parseDep(src);
|
|
@@ -55,22 +61,25 @@ export default class Base_Java {
|
|
|
55
61
|
}
|
|
56
62
|
}
|
|
57
63
|
else {
|
|
58
|
-
this.parseDependencyTree(lines[index - 1], this
|
|
64
|
+
this.parseDependencyTree(lines[index - 1], this._getDepth(lines[index - 1]), lines.slice(index), sbom);
|
|
59
65
|
}
|
|
60
66
|
target = lines[++index];
|
|
61
|
-
targetDepth = this
|
|
67
|
+
targetDepth = this._getDepth(target);
|
|
62
68
|
}
|
|
63
69
|
}
|
|
64
70
|
/**
|
|
65
71
|
* Calculates how deep in the graph is the given line
|
|
66
72
|
* @param {string} line - line to calculate the depth from
|
|
67
73
|
* @returns {number} The calculated depth
|
|
68
|
-
* @
|
|
74
|
+
* @protected
|
|
69
75
|
*/
|
|
70
|
-
|
|
71
|
-
if (line ===
|
|
76
|
+
_getDepth(line) {
|
|
77
|
+
if (!line || line.trim() === '') {
|
|
72
78
|
return -1;
|
|
73
79
|
}
|
|
80
|
+
if (line.match(/^\w/)) {
|
|
81
|
+
return 0;
|
|
82
|
+
}
|
|
74
83
|
return ((line.indexOf('-') - 1) / 3) + 1;
|
|
75
84
|
}
|
|
76
85
|
/**
|
|
@@ -131,7 +140,7 @@ export default class Base_Java {
|
|
|
131
140
|
const toolPath = getCustomPath(this.globalBinary, opts);
|
|
132
141
|
const useWrapper = getWrapperPreference(this.globalBinary, opts);
|
|
133
142
|
if (useWrapper) {
|
|
134
|
-
const wrapper = this.
|
|
143
|
+
const wrapper = traverseForWrapper(manifestDir, this.localWrapper);
|
|
135
144
|
if (wrapper !== undefined) {
|
|
136
145
|
try {
|
|
137
146
|
this._invokeCommand(wrapper, ['--version'], { cwd: manifestDir });
|
|
@@ -156,39 +165,4 @@ export default class Base_Java {
|
|
|
156
165
|
}
|
|
157
166
|
return toolPath;
|
|
158
167
|
}
|
|
159
|
-
/**
|
|
160
|
-
*
|
|
161
|
-
* @param {string} startingManifest - the path of the manifest from which to start searching for the wrapper
|
|
162
|
-
* @param {string} repoRoot - the root of the repository at which point to stop searching for mvnw, derived via git if unset and then fallsback
|
|
163
|
-
* to the root of the drive the manifest is on (assumes absolute path is given)
|
|
164
|
-
* @returns {string|undefined}
|
|
165
|
-
*/
|
|
166
|
-
traverseForWrapper(startingManifest, repoRoot = undefined) {
|
|
167
|
-
const normalizedManifest = this.normalizePath(startingManifest);
|
|
168
|
-
const currentDir = this.normalizePath(path.dirname(normalizedManifest));
|
|
169
|
-
repoRoot = repoRoot || getGitRootDir(currentDir) || path.parse(normalizedManifest).root;
|
|
170
|
-
const wrapperPath = path.join(currentDir, this.localWrapper);
|
|
171
|
-
try {
|
|
172
|
-
fs.accessSync(wrapperPath, fs.constants.X_OK);
|
|
173
|
-
return wrapperPath;
|
|
174
|
-
}
|
|
175
|
-
catch (error) {
|
|
176
|
-
if (error.code === 'ENOENT') {
|
|
177
|
-
const rootDir = path.parse(currentDir).root;
|
|
178
|
-
if (currentDir === repoRoot || currentDir === rootDir) {
|
|
179
|
-
return undefined;
|
|
180
|
-
}
|
|
181
|
-
const parentDir = path.dirname(currentDir);
|
|
182
|
-
if (parentDir === currentDir || parentDir === rootDir) {
|
|
183
|
-
return undefined;
|
|
184
|
-
}
|
|
185
|
-
return this.traverseForWrapper(path.join(parentDir, path.basename(normalizedManifest)), repoRoot);
|
|
186
|
-
}
|
|
187
|
-
throw new Error(`failure searching for ${this.localWrapper}`, { cause: error });
|
|
188
|
-
}
|
|
189
|
-
}
|
|
190
|
-
normalizePath(thePath) {
|
|
191
|
-
const normalized = path.resolve(thePath).normalize();
|
|
192
|
-
return process.platform === 'win32' ? normalized.toLowerCase() : normalized;
|
|
193
|
-
}
|
|
194
168
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export type purlType =
|
|
1
|
+
export type purlType = any;
|
|
2
2
|
/** @typedef {import('../provider').Provider} */
|
|
3
3
|
/** @typedef {import('../provider').Provided} Provided */
|
|
4
4
|
/**
|
|
@@ -19,7 +19,7 @@ export default class Base_javascript {
|
|
|
19
19
|
* @param {Object} opts - Configuration options for the provider
|
|
20
20
|
* @protected
|
|
21
21
|
*/
|
|
22
|
-
protected _setUp(manifestPath: string, opts:
|
|
22
|
+
protected _setUp(manifestPath: string, opts: Object): void;
|
|
23
23
|
/**
|
|
24
24
|
* Gets the current manifest object
|
|
25
25
|
* @returns {Manifest} The manifest object
|
|
@@ -47,6 +47,11 @@ export default class Base_javascript {
|
|
|
47
47
|
*/
|
|
48
48
|
protected _cmdName(): string;
|
|
49
49
|
/**
|
|
50
|
+
* Returns the package manager name (e.g. npm, yarn, pnpm, bun)
|
|
51
|
+
* @returns {string} The package manager name
|
|
52
|
+
*/
|
|
53
|
+
packageManagerName(): string;
|
|
54
|
+
/**
|
|
50
55
|
* Returns the command arguments for listing dependencies
|
|
51
56
|
* @returns {Array<string>} The command arguments
|
|
52
57
|
* @abstract
|
|
@@ -67,30 +72,40 @@ export default class Base_javascript {
|
|
|
67
72
|
*/
|
|
68
73
|
isSupported(manifestName: string): boolean;
|
|
69
74
|
/**
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
75
|
+
* Walks up the directory tree from manifestDir looking for the lock file.
|
|
76
|
+
* Stops when the lock file is found, when a package.json with a "workspaces"
|
|
77
|
+
* field is encountered without a lock file (workspace root boundary), or
|
|
78
|
+
* when the filesystem root is reached.
|
|
79
|
+
*
|
|
80
|
+
* When TRUSTIFY_DA_WORKSPACE_DIR is set, checks only that directory (no walk-up).
|
|
81
|
+
*
|
|
82
|
+
* @param {string} manifestDir - The directory to start searching from
|
|
83
|
+
* @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
|
|
84
|
+
* @returns {string|null} The directory containing the lock file, or null
|
|
85
|
+
* @protected
|
|
86
|
+
*/
|
|
87
|
+
protected _isWorkspaceRoot(dir: any): string | null;
|
|
88
|
+
_findLockFileDir(manifestDir: any, opts?: {}): string | null;
|
|
89
|
+
/**
|
|
73
90
|
* @param {string} manifestDir - The base directory where the manifest is located
|
|
74
|
-
* @param {
|
|
91
|
+
* @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
|
|
75
92
|
* @returns {boolean} True if the lock file exists
|
|
76
93
|
*/
|
|
77
|
-
validateLockFile(manifestDir: string, opts?:
|
|
78
|
-
TRUSTIFY_DA_WORKSPACE_DIR?: string;
|
|
79
|
-
}): boolean;
|
|
94
|
+
validateLockFile(manifestDir: string, opts?: Object): boolean;
|
|
80
95
|
/**
|
|
81
96
|
* Provides content and content type for stack analysis
|
|
82
97
|
* @param {string} manifestPath - The manifest path or name
|
|
83
98
|
* @param {Object} [opts={}] - Optional configuration options
|
|
84
99
|
* @returns {Provided} The provided data for stack analysis
|
|
85
100
|
*/
|
|
86
|
-
provideStack(manifestPath: string, opts?:
|
|
101
|
+
provideStack(manifestPath: string, opts?: Object): Provided;
|
|
87
102
|
/**
|
|
88
103
|
* Provides content and content type for component analysis
|
|
89
104
|
* @param {string} manifestPath - Path to package.json for component report
|
|
90
105
|
* @param {Object} [opts={}] - Optional configuration options
|
|
91
106
|
* @returns {Provided} The provided data for component analysis
|
|
92
107
|
*/
|
|
93
|
-
provideComponent(manifestPath: string, opts?:
|
|
108
|
+
provideComponent(manifestPath: string, opts?: Object): Provided;
|
|
94
109
|
/**
|
|
95
110
|
* Read license from manifest (package.json). Reused by npm, pnpm, yarn.
|
|
96
111
|
* @param {string} manifestPath - path to package.json
|
|
@@ -104,21 +119,21 @@ export default class Base_javascript {
|
|
|
104
119
|
* @returns {Object} The dependency tree
|
|
105
120
|
* @protected
|
|
106
121
|
*/
|
|
107
|
-
protected _buildDependencyTree(includeTransitive: boolean, opts?:
|
|
122
|
+
protected _buildDependencyTree(includeTransitive: boolean, opts?: Object): Object;
|
|
108
123
|
/**
|
|
109
124
|
* Recursively builds the Sbom from the JSON that npm listing returns
|
|
110
125
|
* @param {Sbom} sbom - The SBOM object to add dependencies to
|
|
111
126
|
* @param {Object} depTree - The current dependency tree
|
|
112
127
|
* @protected
|
|
113
128
|
*/
|
|
114
|
-
protected _addDependenciesToSbom(sbom: Sbom, depTree:
|
|
129
|
+
protected _addDependenciesToSbom(sbom: Sbom, depTree: Object): void;
|
|
115
130
|
/**
|
|
116
131
|
* Extracts root dependencies from the dependency tree
|
|
117
132
|
* @param {Object} depTree - The dependency tree object
|
|
118
133
|
* @returns {Map<string, PackageURL>} Map of dependency names to their PackageURL objects
|
|
119
134
|
* @protected
|
|
120
135
|
*/
|
|
121
|
-
protected _getRootDependencies(depTree:
|
|
136
|
+
protected _getRootDependencies(depTree: Object): Map<string, PackageURL>;
|
|
122
137
|
/**
|
|
123
138
|
* Gets the version of the package manager
|
|
124
139
|
* @returns {string} The version string of the package manager
|
|
@@ -126,6 +141,12 @@ export default class Base_javascript {
|
|
|
126
141
|
*/
|
|
127
142
|
protected _version(): string;
|
|
128
143
|
/**
|
|
144
|
+
* Creates or updates the lock file for the package manager
|
|
145
|
+
* @param {string} manifestDir - Directory containing the manifest file
|
|
146
|
+
* @protected
|
|
147
|
+
*/
|
|
148
|
+
protected _createLockFile(manifestDir: string): void;
|
|
149
|
+
/**
|
|
129
150
|
* Parses the dependency tree output
|
|
130
151
|
* @param {string} output - The output to parse
|
|
131
152
|
* @returns {string} The parsed output
|
|
@@ -134,6 +155,6 @@ export default class Base_javascript {
|
|
|
134
155
|
protected _parseDepTreeOutput(output: string): string;
|
|
135
156
|
#private;
|
|
136
157
|
}
|
|
137
|
-
export type Provided =
|
|
158
|
+
export type Provided = any;
|
|
138
159
|
import Manifest from './manifest.js';
|
|
139
160
|
import Sbom from '../sbom.js';
|
|
@@ -71,6 +71,13 @@ export default class Base_javascript {
|
|
|
71
71
|
throw new TypeError("_cmdName must be implemented");
|
|
72
72
|
}
|
|
73
73
|
/**
|
|
74
|
+
* Returns the package manager name (e.g. npm, yarn, pnpm, bun)
|
|
75
|
+
* @returns {string} The package manager name
|
|
76
|
+
*/
|
|
77
|
+
packageManagerName() {
|
|
78
|
+
return this._cmdName();
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
74
81
|
* Returns the command arguments for listing dependencies
|
|
75
82
|
* @returns {Array<string>} The command arguments
|
|
76
83
|
* @abstract
|
|
@@ -97,18 +104,63 @@ export default class Base_javascript {
|
|
|
97
104
|
return 'package.json' === manifestName;
|
|
98
105
|
}
|
|
99
106
|
/**
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
107
|
+
* Walks up the directory tree from manifestDir looking for the lock file.
|
|
108
|
+
* Stops when the lock file is found, when a package.json with a "workspaces"
|
|
109
|
+
* field is encountered without a lock file (workspace root boundary), or
|
|
110
|
+
* when the filesystem root is reached.
|
|
111
|
+
*
|
|
112
|
+
* When TRUSTIFY_DA_WORKSPACE_DIR is set, checks only that directory (no walk-up).
|
|
113
|
+
*
|
|
114
|
+
* @param {string} manifestDir - The directory to start searching from
|
|
115
|
+
* @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
|
|
116
|
+
* @returns {string|null} The directory containing the lock file, or null
|
|
117
|
+
* @protected
|
|
118
|
+
*/
|
|
119
|
+
_isWorkspaceRoot(dir) {
|
|
120
|
+
if (fs.existsSync(path.join(dir, 'pnpm-workspace.yaml'))) {
|
|
121
|
+
return true;
|
|
122
|
+
}
|
|
123
|
+
const pkgJsonPath = path.join(dir, 'package.json');
|
|
124
|
+
if (fs.existsSync(pkgJsonPath)) {
|
|
125
|
+
try {
|
|
126
|
+
const content = JSON.parse(fs.readFileSync(pkgJsonPath, 'utf-8'));
|
|
127
|
+
if (content.workspaces) {
|
|
128
|
+
return true;
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
catch (_) {
|
|
132
|
+
// ignore parse errors
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
return false;
|
|
136
|
+
}
|
|
137
|
+
_findLockFileDir(manifestDir, opts = {}) {
|
|
138
|
+
const workspaceDir = getCustom('TRUSTIFY_DA_WORKSPACE_DIR', null, opts);
|
|
139
|
+
if (workspaceDir) {
|
|
140
|
+
const dir = path.resolve(workspaceDir);
|
|
141
|
+
return fs.existsSync(path.join(dir, this._lockFileName())) ? dir : null;
|
|
142
|
+
}
|
|
143
|
+
let dir = path.resolve(manifestDir);
|
|
144
|
+
let parent = dir;
|
|
145
|
+
do {
|
|
146
|
+
dir = parent;
|
|
147
|
+
if (fs.existsSync(path.join(dir, this._lockFileName()))) {
|
|
148
|
+
return dir;
|
|
149
|
+
}
|
|
150
|
+
if (this._isWorkspaceRoot(dir)) {
|
|
151
|
+
return null;
|
|
152
|
+
}
|
|
153
|
+
parent = path.dirname(dir);
|
|
154
|
+
} while (parent !== dir);
|
|
155
|
+
return null;
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
103
158
|
* @param {string} manifestDir - The base directory where the manifest is located
|
|
104
|
-
* @param {
|
|
159
|
+
* @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
|
|
105
160
|
* @returns {boolean} True if the lock file exists
|
|
106
161
|
*/
|
|
107
162
|
validateLockFile(manifestDir, opts = {}) {
|
|
108
|
-
|
|
109
|
-
const dirToCheck = workspaceDir ? path.resolve(workspaceDir) : manifestDir;
|
|
110
|
-
const lock = path.join(dirToCheck, this._lockFileName());
|
|
111
|
-
return fs.existsSync(lock);
|
|
163
|
+
return this._findLockFileDir(manifestDir, opts) !== null;
|
|
112
164
|
}
|
|
113
165
|
/**
|
|
114
166
|
* Provides content and content type for stack analysis
|
|
@@ -171,9 +223,8 @@ export default class Base_javascript {
|
|
|
171
223
|
_buildDependencyTree(includeTransitive, opts = {}) {
|
|
172
224
|
this._version();
|
|
173
225
|
const manifestDir = path.dirname(this.#manifest.manifestPath);
|
|
174
|
-
const
|
|
175
|
-
|
|
176
|
-
this.#createLockFile(cmdDir);
|
|
226
|
+
const cmdDir = this._findLockFileDir(manifestDir, opts) || manifestDir;
|
|
227
|
+
this._createLockFile(cmdDir);
|
|
177
228
|
let output = this.#executeListCmd(includeTransitive, cmdDir);
|
|
178
229
|
output = this._parseDepTreeOutput(output);
|
|
179
230
|
return JSON.parse(output);
|
|
@@ -191,9 +242,32 @@ export default class Base_javascript {
|
|
|
191
242
|
let sbom = new Sbom();
|
|
192
243
|
sbom.addRoot(mainComponent, license);
|
|
193
244
|
this._addDependenciesToSbom(sbom, depsObject);
|
|
245
|
+
this.#ensurePeerAndOptionalDeps(sbom);
|
|
194
246
|
sbom.filterIgnoredDeps(this.#manifest.ignored);
|
|
195
247
|
return sbom.getAsJsonString(opts);
|
|
196
248
|
}
|
|
249
|
+
/**
|
|
250
|
+
* Ensures peer and optional dependencies declared in the manifest are
|
|
251
|
+
* present in the SBOM, even when the package manager does not resolve them
|
|
252
|
+
* (e.g. yarn does not include peer deps in its dependency listing).
|
|
253
|
+
* @param {Sbom} sbom - The SBOM to supplement
|
|
254
|
+
* @private
|
|
255
|
+
*/
|
|
256
|
+
#ensurePeerAndOptionalDeps(sbom) {
|
|
257
|
+
const rootPurl = toPurl(purlType, this.#manifest.name, this.#manifest.version);
|
|
258
|
+
const depSources = [this.#manifest.peerDependencies, this.#manifest.optionalDependencies];
|
|
259
|
+
for (const source of depSources) {
|
|
260
|
+
for (const [name, version] of Object.entries(source)) {
|
|
261
|
+
// Build the purl prefix for exact matching (e.g. "pkg:npm/minimist@"
|
|
262
|
+
// or "pkg:npm/%40hapi/joi@") to avoid substring false positives
|
|
263
|
+
const probe = toPurl(purlType, name, version);
|
|
264
|
+
const purlPrefix = probe.toString().replace(/@[^@]*$/, '@');
|
|
265
|
+
if (!sbom.checkDependsOnByPurlPrefix(rootPurl, purlPrefix)) {
|
|
266
|
+
sbom.addDependency(rootPurl, probe);
|
|
267
|
+
}
|
|
268
|
+
}
|
|
269
|
+
}
|
|
270
|
+
}
|
|
197
271
|
/**
|
|
198
272
|
* Recursively builds the Sbom from the JSON that npm listing returns
|
|
199
273
|
* @param {Sbom} sbom - The SBOM object to add dependencies to
|
|
@@ -201,7 +275,10 @@ export default class Base_javascript {
|
|
|
201
275
|
* @protected
|
|
202
276
|
*/
|
|
203
277
|
_addDependenciesToSbom(sbom, depTree) {
|
|
204
|
-
const dependencies =
|
|
278
|
+
const dependencies = {
|
|
279
|
+
...depTree["dependencies"],
|
|
280
|
+
...depTree["optionalDependencies"],
|
|
281
|
+
};
|
|
205
282
|
Object.entries(dependencies)
|
|
206
283
|
.forEach(entry => {
|
|
207
284
|
const [name, artifact] = entry;
|
|
@@ -251,6 +328,7 @@ export default class Base_javascript {
|
|
|
251
328
|
const rootPurl = toPurlFromString(sbom.getRoot().purl);
|
|
252
329
|
sbom.addDependency(rootPurl, rootDeps.get(key));
|
|
253
330
|
}
|
|
331
|
+
this.#ensurePeerAndOptionalDeps(sbom);
|
|
254
332
|
sbom.filterIgnoredDeps(this.#manifest.ignored);
|
|
255
333
|
return sbom.getAsJsonString(opts);
|
|
256
334
|
}
|
|
@@ -261,10 +339,14 @@ export default class Base_javascript {
|
|
|
261
339
|
* @protected
|
|
262
340
|
*/
|
|
263
341
|
_getRootDependencies(depTree) {
|
|
264
|
-
|
|
342
|
+
const allDeps = {
|
|
343
|
+
...depTree.dependencies,
|
|
344
|
+
...depTree.optionalDependencies,
|
|
345
|
+
};
|
|
346
|
+
if (Object.keys(allDeps).length === 0) {
|
|
265
347
|
return new Map();
|
|
266
348
|
}
|
|
267
|
-
return new Map(Object.entries(
|
|
349
|
+
return new Map(Object.entries(allDeps).map(([key, value]) => [key, toPurl(purlType, key, value.version)]));
|
|
268
350
|
}
|
|
269
351
|
/**
|
|
270
352
|
* Executes the list command to get dependencies
|
|
@@ -275,7 +357,7 @@ export default class Base_javascript {
|
|
|
275
357
|
*/
|
|
276
358
|
#executeListCmd(includeTransitive, manifestDir) {
|
|
277
359
|
const listArgs = this._listCmdArgs(includeTransitive, manifestDir);
|
|
278
|
-
return this.#invokeCommand(listArgs);
|
|
360
|
+
return this.#invokeCommand(listArgs, { cwd: manifestDir });
|
|
279
361
|
}
|
|
280
362
|
/**
|
|
281
363
|
* Gets the version of the package manager
|
|
@@ -288,19 +370,17 @@ export default class Base_javascript {
|
|
|
288
370
|
/**
|
|
289
371
|
* Creates or updates the lock file for the package manager
|
|
290
372
|
* @param {string} manifestDir - Directory containing the manifest file
|
|
291
|
-
* @
|
|
373
|
+
* @protected
|
|
292
374
|
*/
|
|
293
|
-
|
|
375
|
+
_createLockFile(manifestDir) {
|
|
294
376
|
const originalDir = process.cwd();
|
|
295
377
|
const isWindows = os.platform() === 'win32';
|
|
296
378
|
if (isWindows) {
|
|
297
|
-
// On Windows, --prefix flag doesn't work as expected
|
|
298
|
-
// Instead of installing from the prefix folder, it installs from current working directory
|
|
299
379
|
process.chdir(manifestDir);
|
|
300
380
|
}
|
|
301
381
|
try {
|
|
302
382
|
const args = this._updateLockFileCmdArgs(manifestDir);
|
|
303
|
-
this.#invokeCommand(args);
|
|
383
|
+
this.#invokeCommand(args, { cwd: manifestDir });
|
|
304
384
|
}
|
|
305
385
|
finally {
|
|
306
386
|
if (isWindows) {
|