@trustify-da/trustify-da-javascript-client 0.3.0-ea.f501753 → 0.3.0-ea.fa16f06
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 +2 -2
- package/dist/package.json +25 -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.js +11 -3
- package/dist/src/index.d.ts +17 -12
- package/dist/src/index.js +21 -7
- 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/provider.d.ts +4 -3
- package/dist/src/provider.js +6 -2
- package/dist/src/providers/base_java.d.ts +14 -3
- package/dist/src/providers/base_java.js +16 -6
- package/dist/src/providers/base_javascript.d.ts +20 -9
- package/dist/src/providers/base_javascript.js +10 -3
- package/dist/src/providers/base_pyproject.d.ts +10 -5
- package/dist/src/providers/base_pyproject.js +7 -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 +2 -1
- package/dist/src/providers/golang_gomodules.js +1 -1
- package/dist/src/providers/java_gradle.js +2 -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 +2 -2
- package/dist/src/providers/java_maven.js +72 -0
- 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 -1
- 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_classic_processor.d.ts +2 -2
- package/dist/src/providers/python_controller.js +61 -4
- package/dist/src/providers/python_pip.d.ts +1 -0
- package/dist/src/providers/python_pip.js +1 -1
- package/dist/src/providers/python_pip_pyproject.js +3 -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 +18 -14
- package/dist/src/providers/python_uv.js +111 -2
- package/dist/src/providers/rust_cargo.d.ts +6 -2
- package/dist/src/providers/rust_cargo.js +105 -19
- 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/tools.d.ts +2 -2
- package/dist/src/updaters/maven_updater.d.ts +26 -0
- package/dist/src/updaters/maven_updater.js +322 -0
- package/dist/src/updaters/toml_updater.d.ts +33 -0
- package/dist/src/updaters/toml_updater.js +244 -0
- package/dist/src/workspace.d.ts +9 -0
- package/dist/src/workspace.js +1 -1
- package/package.json +26 -23
package/README.md
CHANGED
|
@@ -688,14 +688,14 @@ This increasing the chances and the probability that the automatic installation
|
|
|
688
688
|
###### Usage
|
|
689
689
|
A New setting is introduced - `TRUSTIFY_DA_PYTHON_INSTALL_BEST_EFFORTS` (as both env variable/key in `options` object)
|
|
690
690
|
1. `TRUSTIFY_DA_PYTHON_INSTALL_BEST_EFFORTS`="false" - install requirements.txt while respecting declared versions for all packages.
|
|
691
|
-
2. `TRUSTIFY_DA_PYTHON_INSTALL_BEST_EFFORTS`="true" - install all packages from requirements.txt, not respecting the declared version, but trying to install a version tailored for the used python version. When using this setting, you must set
|
|
691
|
+
2. `TRUSTIFY_DA_PYTHON_INSTALL_BEST_EFFORTS`="true" - install all packages from requirements.txt, not respecting the declared version, but trying to install a version tailored for the used python version. When using this setting, you must set `TRUSTIFY_DA_PYTHON_VIRTUAL_ENV` to 'true' and `MATCH_MANIFEST_VERSIONS` to 'false'.
|
|
692
692
|
|
|
693
693
|
##### Using `pipdeptree`
|
|
694
694
|
By default, The API algorithm will use native commands of PIP installer as data source to build the dependency tree.
|
|
695
695
|
It's also possible to use the lightweight Python PIP utility [pipdeptree](https://pypi.org/project/pipdeptree/) as data source instead. In order to activate this, you need to set the environment variable/option `TRUSTIFY_DA_PIP_USE_DEP_TREE` to 'true'.
|
|
696
696
|
|
|
697
697
|
#### Toggle Red Hat Trusted Content recommendations
|
|
698
|
-
Both the HTML-based report and JSON response will by default contain recommendations for migrating to Red Hat-based Trusted Content repositories. This feature can be disabled by setting `
|
|
698
|
+
Both the HTML-based report and JSON response will by default contain recommendations for migrating to Red Hat-based Trusted Content repositories. This feature can be disabled by setting `TRUSTIFY_DA_RECOMMEND` to 'false' via environment variables or options.
|
|
699
699
|
|
|
700
700
|
#### Additional CLI arguments
|
|
701
701
|
For some ecosystems we support passing additional CLI arguments to the underlying tools. The following table outlines the supported ecosystems and the environment variable/option that configures this. Note that the arguments are expected to be in the format of a JSON array.
|
package/dist/package.json
CHANGED
|
@@ -35,32 +35,33 @@
|
|
|
35
35
|
"config/**/*"
|
|
36
36
|
],
|
|
37
37
|
"scripts": {
|
|
38
|
-
"lint": "eslint src test
|
|
39
|
-
"lint:fix": "eslint src test --
|
|
38
|
+
"lint": "eslint src test",
|
|
39
|
+
"lint:fix": "eslint src test --fix",
|
|
40
40
|
"test": "c8 npm run tests",
|
|
41
41
|
"tests": "mocha --config .mocharc.json",
|
|
42
42
|
"tests:rep": "mocha --reporter-option maxDiffSize=0 --reporter json > unit-tests-result.json",
|
|
43
|
-
"pretest": "cp node_modules/tree-sitter-requirements/tree-sitter-requirements.wasm src/providers/tree-sitter-requirements.wasm && cp node_modules/tree-sitter-gomod/tree-sitter-gomod.wasm src/providers/tree-sitter-gomod.wasm",
|
|
43
|
+
"pretest": "cp node_modules/tree-sitter-requirements/tree-sitter-requirements.wasm src/providers/tree-sitter-requirements.wasm && cp node_modules/tree-sitter-gomod/tree-sitter-gomod.wasm src/providers/tree-sitter-gomod.wasm && cp node_modules/tree-sitter-containerfile/tree-sitter-containerfile.wasm src/providers/tree-sitter-containerfile.wasm",
|
|
44
44
|
"precompile": "rm -rf dist",
|
|
45
45
|
"compile": "tsc -p tsconfig.json",
|
|
46
46
|
"compile:dev": "tsc -p tsconfig.dev.json",
|
|
47
|
-
"postcompile": "cp node_modules/tree-sitter-requirements/tree-sitter-requirements.wasm dist/src/providers/tree-sitter-requirements.wasm && cp node_modules/tree-sitter-gomod/tree-sitter-gomod.wasm dist/src/providers/tree-sitter-gomod.wasm"
|
|
47
|
+
"postcompile": "cp node_modules/tree-sitter-requirements/tree-sitter-requirements.wasm dist/src/providers/tree-sitter-requirements.wasm && cp node_modules/tree-sitter-gomod/tree-sitter-gomod.wasm dist/src/providers/tree-sitter-gomod.wasm && cp node_modules/tree-sitter-containerfile/tree-sitter-containerfile.wasm dist/src/providers/tree-sitter-containerfile.wasm"
|
|
48
48
|
},
|
|
49
49
|
"dependencies": {
|
|
50
50
|
"@babel/core": "^7.23.2",
|
|
51
|
-
"@cyclonedx/cyclonedx-library": "^
|
|
51
|
+
"@cyclonedx/cyclonedx-library": "^10.0.0",
|
|
52
52
|
"eslint-import-resolver-typescript": "^4.4.4",
|
|
53
53
|
"fast-glob": "^3.3.3",
|
|
54
|
-
"fast-toml": "^0.5.4",
|
|
55
54
|
"fast-xml-parser": "^5.3.4",
|
|
56
55
|
"help": "^3.0.2",
|
|
57
|
-
"https-proxy-agent": "^
|
|
56
|
+
"https-proxy-agent": "^9.0.0",
|
|
58
57
|
"js-yaml": "^4.1.1",
|
|
58
|
+
"jsonc-parser": "^3.3.1",
|
|
59
59
|
"micromatch": "^4.0.8",
|
|
60
60
|
"node-fetch": "^3.3.2",
|
|
61
|
-
"p-limit": "^
|
|
61
|
+
"p-limit": "^7.3.0",
|
|
62
62
|
"packageurl-js": "~1.0.2",
|
|
63
63
|
"smol-toml": "^1.6.0",
|
|
64
|
+
"tree-sitter-containerfile": "^0.8.1",
|
|
64
65
|
"tree-sitter-gomod": "github:strum355/tree-sitter-go-mod#56326f2ad478892ace58ff247a97d492a3cbcdda",
|
|
65
66
|
"tree-sitter-requirements": "github:Strum355/tree-sitter-requirements#d0261ee76b84253997fe70d7d397e78c006c3801",
|
|
66
67
|
"web-tree-sitter": "^0.26.7",
|
|
@@ -68,23 +69,24 @@
|
|
|
68
69
|
},
|
|
69
70
|
"devDependencies": {
|
|
70
71
|
"@babel/core": "^7.23.2",
|
|
71
|
-
"@
|
|
72
|
-
"@
|
|
72
|
+
"@eslint/js": "^10.0.0",
|
|
73
|
+
"@trustify-da/trustify-da-api-model": "^2.0.12",
|
|
74
|
+
"@types/node": "^25.9.1",
|
|
73
75
|
"@types/which": "^3.0.4",
|
|
74
76
|
"babel-plugin-rewire": "^1.2.0",
|
|
75
77
|
"c8": "^11.0.0",
|
|
76
|
-
"chai": "^
|
|
77
|
-
"eslint": "^
|
|
78
|
+
"chai": "^6.2.2",
|
|
79
|
+
"eslint": "^10.4.1",
|
|
78
80
|
"eslint-import-resolver-typescript": "^4.4.4",
|
|
79
|
-
"eslint-plugin-
|
|
80
|
-
"eslint-plugin-import": "^2.29.1",
|
|
81
|
+
"eslint-plugin-import-x": "^4.16.2",
|
|
81
82
|
"esmock": "^2.6.2",
|
|
82
|
-
"
|
|
83
|
+
"globals": "^17.6.0",
|
|
84
|
+
"mocha": "^11.7.6",
|
|
83
85
|
"msw": "^2.12.7",
|
|
84
|
-
"sinon": "^
|
|
85
|
-
"sinon-chai": "^
|
|
86
|
-
"typescript": "^
|
|
87
|
-
"which": "^
|
|
86
|
+
"sinon": "^22.0.0",
|
|
87
|
+
"sinon-chai": "^4.0.1",
|
|
88
|
+
"typescript": "^6.0.3",
|
|
89
|
+
"which": "^7.0.0"
|
|
88
90
|
},
|
|
89
91
|
"mocha": {
|
|
90
92
|
"check-leaks": false,
|
|
@@ -112,12 +114,13 @@
|
|
|
112
114
|
"reporter": [
|
|
113
115
|
"html",
|
|
114
116
|
"json",
|
|
117
|
+
"lcov",
|
|
115
118
|
"text"
|
|
116
119
|
]
|
|
117
120
|
},
|
|
118
|
-
"
|
|
119
|
-
"
|
|
120
|
-
|
|
121
|
+
"overrides": {
|
|
122
|
+
"tree-sitter": "0.22.4"
|
|
123
|
+
},
|
|
121
124
|
"resolutions": {
|
|
122
125
|
"@hapi/joi": "17.1.1"
|
|
123
126
|
}
|
package/dist/src/analysis.d.ts
CHANGED
|
@@ -6,6 +6,7 @@ declare namespace _default {
|
|
|
6
6
|
export { requestStackBatch };
|
|
7
7
|
export { requestImages };
|
|
8
8
|
export { validateToken };
|
|
9
|
+
export { appendAnalysisQueryParams };
|
|
9
10
|
}
|
|
10
11
|
export default _default;
|
|
11
12
|
/**
|
|
@@ -16,7 +17,7 @@ export default _default;
|
|
|
16
17
|
* @param {import("index.js").Options} [opts={}] - optional various options to pass along the application
|
|
17
18
|
* @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
|
|
18
19
|
*/
|
|
19
|
-
declare function requestComponent(provider:
|
|
20
|
+
declare function requestComponent(provider: any, manifest: string, url: string, opts?: any): Promise<any>;
|
|
20
21
|
/**
|
|
21
22
|
* Send a stack analysis request and get the report as 'text/html' or 'application/json'.
|
|
22
23
|
* @param {import('./provider').Provider} provider - the provided data for constructing the request
|
|
@@ -26,7 +27,7 @@ declare function requestComponent(provider: import("./provider").Provider, manif
|
|
|
26
27
|
* @param {import("index.js").Options} [opts={}] - optional various options to pass along the application
|
|
27
28
|
* @returns {Promise<string|import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
|
|
28
29
|
*/
|
|
29
|
-
declare function requestStack(provider:
|
|
30
|
+
declare function requestStack(provider: any, manifest: string, url: string, html?: boolean, opts?: any): Promise<string | any>;
|
|
30
31
|
/**
|
|
31
32
|
* Send a batch stack analysis request for multiple manifests (SBOMs keyed by purl).
|
|
32
33
|
* @param {Object.<string, object>} sbomByPurl - Map of root purl to CycloneDX SBOM object
|
|
@@ -36,9 +37,9 @@ declare function requestStack(provider: import("./provider").Provider, manifest:
|
|
|
36
37
|
* @returns {Promise<string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
|
|
37
38
|
*/
|
|
38
39
|
declare function requestStackBatch(sbomByPurl: {
|
|
40
|
+
[x: string]: object;
|
|
41
|
+
}, url: string, html?: boolean, opts?: any): Promise<string | {
|
|
39
42
|
[x: string]: any;
|
|
40
|
-
}, url: string, html?: boolean, opts?: import("index.js").Options): Promise<string | {
|
|
41
|
-
[x: string]: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport").AnalysisReport;
|
|
42
43
|
}>;
|
|
43
44
|
/**
|
|
44
45
|
*
|
|
@@ -47,8 +48,8 @@ declare function requestStackBatch(sbomByPurl: {
|
|
|
47
48
|
* @param {import("index.js").Options} [opts={}] - optional various options to pass along the application
|
|
48
49
|
* @returns {Promise<string|Object.<string, import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>>}
|
|
49
50
|
*/
|
|
50
|
-
declare function requestImages(imageRefs: Array<string>, url: string, html?: boolean, opts?:
|
|
51
|
-
[x: string]:
|
|
51
|
+
declare function requestImages(imageRefs: Array<string>, url: string, html?: boolean, opts?: any): Promise<string | {
|
|
52
|
+
[x: string]: any;
|
|
52
53
|
}>;
|
|
53
54
|
/**
|
|
54
55
|
*
|
|
@@ -56,4 +57,10 @@ declare function requestImages(imageRefs: Array<string>, url: string, html?: boo
|
|
|
56
57
|
* @param {import("index.js").Options} [opts={}] - optional various options to pass headers for t he validateToken Request
|
|
57
58
|
* @return {Promise<number>} return the HTTP status Code of the response from the validate token request.
|
|
58
59
|
*/
|
|
59
|
-
declare function validateToken(url: any, opts?:
|
|
60
|
+
declare function validateToken(url: any, opts?: any): Promise<number>;
|
|
61
|
+
/**
|
|
62
|
+
* Append common analysis query parameters (recommend, providers, sources) to a URL.
|
|
63
|
+
* @param {URL} url - the URL object to append query parameters to
|
|
64
|
+
* @param {import("index.js").Options} [opts={}] - options containing parameter overrides
|
|
65
|
+
*/
|
|
66
|
+
declare function appendAnalysisQueryParams(url: URL, opts?: any): void;
|
package/dist/src/analysis.js
CHANGED
|
@@ -6,7 +6,7 @@ import { generateImageSBOM, parseImageRef } from "./oci_image/utils.js";
|
|
|
6
6
|
import { addProxyAgent, getCustom, getTokenHeaders, TRUSTIFY_DA_OPERATION_TYPE_HEADER, TRUSTIFY_DA_PACKAGE_MANAGER_HEADER } from "./tools.js";
|
|
7
7
|
/** Media type for CycloneDX JSON batch payloads (batch-analysis API). */
|
|
8
8
|
export const CYCLONEDX_JSON_MEDIA_TYPE = 'application/vnd.cyclonedx+json';
|
|
9
|
-
export default { requestComponent, requestStack, requestStackBatch, requestImages, validateToken };
|
|
9
|
+
export default { requestComponent, requestStack, requestStackBatch, requestImages, validateToken, appendAnalysisQueryParams };
|
|
10
10
|
/**
|
|
11
11
|
* Send a stack analysis request and get the report as 'text/html' or 'application/json'.
|
|
12
12
|
* @param {import('./provider').Provider} provider - the provided data for constructing the request
|
|
@@ -20,6 +20,9 @@ async function requestStack(provider, manifest, url, html = false, opts = {}) {
|
|
|
20
20
|
opts["source-manifest"] = Buffer.from(fs.readFileSync(manifest).toString()).toString('base64');
|
|
21
21
|
opts["manifest-type"] = path.parse(manifest).base;
|
|
22
22
|
let provided = await provider.provideStack(manifest, opts); // throws error if content providing failed
|
|
23
|
+
if (provided.batch) {
|
|
24
|
+
return requestStackBatch(JSON.parse(provided.content), url, html, opts);
|
|
25
|
+
}
|
|
23
26
|
opts["source-manifest"] = "";
|
|
24
27
|
opts[TRUSTIFY_DA_OPERATION_TYPE_HEADER.toUpperCase().replaceAll("-", "_")] = "stack-analysis";
|
|
25
28
|
let startTime = new Date();
|
|
@@ -38,9 +41,7 @@ async function requestStack(provider, manifest, url, html = false, opts = {}) {
|
|
|
38
41
|
body: provided.content
|
|
39
42
|
}, opts);
|
|
40
43
|
const finalUrl = new URL(`${url}/api/v5/analysis`);
|
|
41
|
-
|
|
42
|
-
finalUrl.searchParams.append('recommend', 'false');
|
|
43
|
-
}
|
|
44
|
+
appendAnalysisQueryParams(finalUrl, opts);
|
|
44
45
|
let resp = await fetch(finalUrl, fetchOptions);
|
|
45
46
|
let result;
|
|
46
47
|
if (resp.status === 200) {
|
|
@@ -79,6 +80,9 @@ async function requestStack(provider, manifest, url, html = false, opts = {}) {
|
|
|
79
80
|
async function requestComponent(provider, manifest, url, opts = {}) {
|
|
80
81
|
opts["source-manifest"] = Buffer.from(fs.readFileSync(manifest).toString()).toString('base64');
|
|
81
82
|
let provided = await provider.provideComponent(manifest, opts); // throws error if content providing failed
|
|
83
|
+
if (provided.batch) {
|
|
84
|
+
return requestStackBatch(JSON.parse(provided.content), url, false, opts);
|
|
85
|
+
}
|
|
82
86
|
opts["source-manifest"] = "";
|
|
83
87
|
opts[TRUSTIFY_DA_OPERATION_TYPE_HEADER.toUpperCase().replaceAll("-", "_")] = "component-analysis";
|
|
84
88
|
if (process.env["TRUSTIFY_DA_DEBUG"] === "true") {
|
|
@@ -95,9 +99,7 @@ async function requestComponent(provider, manifest, url, opts = {}) {
|
|
|
95
99
|
body: provided.content
|
|
96
100
|
}, opts);
|
|
97
101
|
const finalUrl = new URL(`${url}/api/v5/analysis`);
|
|
98
|
-
|
|
99
|
-
finalUrl.searchParams.append('recommend', 'false');
|
|
100
|
-
}
|
|
102
|
+
appendAnalysisQueryParams(finalUrl, opts);
|
|
101
103
|
let resp = await fetch(finalUrl, fetchOptions);
|
|
102
104
|
let result;
|
|
103
105
|
if (resp.status === 200) {
|
|
@@ -136,9 +138,7 @@ async function requestComponent(provider, manifest, url, opts = {}) {
|
|
|
136
138
|
*/
|
|
137
139
|
async function requestStackBatch(sbomByPurl, url, html = false, opts = {}) {
|
|
138
140
|
const finalUrl = new URL(`${url}/api/v5/batch-analysis`);
|
|
139
|
-
|
|
140
|
-
finalUrl.searchParams.append('recommend', 'false');
|
|
141
|
-
}
|
|
141
|
+
appendAnalysisQueryParams(finalUrl, opts);
|
|
142
142
|
const fetchOptions = addProxyAgent({
|
|
143
143
|
method: 'POST',
|
|
144
144
|
headers: {
|
|
@@ -186,9 +186,7 @@ async function requestImages(imageRefs, url, html = false, opts = {}) {
|
|
|
186
186
|
imageSboms[parsedImageRef.getPackageURL().toString()] = generateImageSBOM(parsedImageRef, opts);
|
|
187
187
|
}
|
|
188
188
|
const finalUrl = new URL(`${url}/api/v5/batch-analysis`);
|
|
189
|
-
|
|
190
|
-
finalUrl.searchParams.append('recommend', 'false');
|
|
191
|
-
}
|
|
189
|
+
appendAnalysisQueryParams(finalUrl, opts);
|
|
192
190
|
const fetchOptions = addProxyAgent({
|
|
193
191
|
method: 'POST',
|
|
194
192
|
headers: {
|
|
@@ -222,6 +220,24 @@ async function requestImages(imageRefs, url, html = false, opts = {}) {
|
|
|
222
220
|
throw new Error(`Got error response from Trustify DA backend - http return code : ${resp.status}, ex-request-id: ${resp.headers.get("ex-request-id")} error message => ${await resp.text()}`);
|
|
223
221
|
}
|
|
224
222
|
}
|
|
223
|
+
/**
|
|
224
|
+
* Append common analysis query parameters (recommend, providers, sources) to a URL.
|
|
225
|
+
* @param {URL} url - the URL object to append query parameters to
|
|
226
|
+
* @param {import("index.js").Options} [opts={}] - options containing parameter overrides
|
|
227
|
+
*/
|
|
228
|
+
function appendAnalysisQueryParams(url, opts = {}) {
|
|
229
|
+
if (getCustom('TRUSTIFY_DA_RECOMMEND', 'true', opts) === 'false') {
|
|
230
|
+
url.searchParams.append('recommend', 'false');
|
|
231
|
+
}
|
|
232
|
+
const providers = getCustom('TRUSTIFY_DA_PROVIDERS', null, opts);
|
|
233
|
+
if (providers) {
|
|
234
|
+
url.searchParams.append('providers', providers);
|
|
235
|
+
}
|
|
236
|
+
const sources = getCustom('TRUSTIFY_DA_SOURCES', null, opts);
|
|
237
|
+
if (sources) {
|
|
238
|
+
url.searchParams.append('sources', sources);
|
|
239
|
+
}
|
|
240
|
+
}
|
|
225
241
|
/**
|
|
226
242
|
*
|
|
227
243
|
* @param url the backend url to send the request to
|
package/dist/src/cli.js
CHANGED
|
@@ -4,6 +4,7 @@ import * as path from "path";
|
|
|
4
4
|
import yargs from 'yargs';
|
|
5
5
|
import { hideBin } from 'yargs/helpers';
|
|
6
6
|
import { getProjectLicense, getLicenseDetails } from './license/index.js';
|
|
7
|
+
import { runRemediation } from './remediate.js';
|
|
7
8
|
import client, { selectTrustifyDABackend, generateSbom } from './index.js';
|
|
8
9
|
// command for component analysis take manifest type and content
|
|
9
10
|
const component = {
|
|
@@ -19,11 +20,25 @@ const component = {
|
|
|
19
20
|
desc: 'Workspace root directory (for monorepos; lock file is expected here)',
|
|
20
21
|
type: 'string',
|
|
21
22
|
normalize: true,
|
|
23
|
+
},
|
|
24
|
+
providers: {
|
|
25
|
+
desc: 'Comma-separated list of vulnerability providers (env: TRUSTIFY_DA_PROVIDERS)',
|
|
26
|
+
type: 'string',
|
|
27
|
+
},
|
|
28
|
+
sources: {
|
|
29
|
+
desc: 'Comma-separated list of vulnerability sources (env: TRUSTIFY_DA_SOURCES)',
|
|
30
|
+
type: 'string',
|
|
22
31
|
}
|
|
23
32
|
}),
|
|
24
33
|
handler: async (args) => {
|
|
25
34
|
let manifestName = args['/path/to/manifest'];
|
|
26
35
|
const opts = args.workspaceDir ? { TRUSTIFY_DA_WORKSPACE_DIR: args.workspaceDir } : {};
|
|
36
|
+
if (args.providers) {
|
|
37
|
+
opts.TRUSTIFY_DA_PROVIDERS = args.providers;
|
|
38
|
+
}
|
|
39
|
+
if (args.sources) {
|
|
40
|
+
opts.TRUSTIFY_DA_SOURCES = args.sources;
|
|
41
|
+
}
|
|
27
42
|
let res = await client.componentAnalysis(manifestName, opts);
|
|
28
43
|
console.log(JSON.stringify(res, null, 2));
|
|
29
44
|
}
|
|
@@ -72,6 +87,14 @@ const image = {
|
|
|
72
87
|
desc: 'For JSON report, get only the \'summary\'',
|
|
73
88
|
type: 'boolean',
|
|
74
89
|
conflicts: 'html'
|
|
90
|
+
},
|
|
91
|
+
providers: {
|
|
92
|
+
desc: 'Comma-separated list of vulnerability providers (env: TRUSTIFY_DA_PROVIDERS)',
|
|
93
|
+
type: 'string',
|
|
94
|
+
},
|
|
95
|
+
sources: {
|
|
96
|
+
desc: 'Comma-separated list of vulnerability sources (env: TRUSTIFY_DA_SOURCES)',
|
|
97
|
+
type: 'string',
|
|
75
98
|
}
|
|
76
99
|
}),
|
|
77
100
|
handler: async (args) => {
|
|
@@ -81,7 +104,14 @@ const image = {
|
|
|
81
104
|
}
|
|
82
105
|
let html = args['html'];
|
|
83
106
|
let summary = args['summary'];
|
|
84
|
-
|
|
107
|
+
const opts = {};
|
|
108
|
+
if (args.providers) {
|
|
109
|
+
opts.TRUSTIFY_DA_PROVIDERS = args.providers;
|
|
110
|
+
}
|
|
111
|
+
if (args.sources) {
|
|
112
|
+
opts.TRUSTIFY_DA_SOURCES = args.sources;
|
|
113
|
+
}
|
|
114
|
+
let res = await client.imageAnalysis(imageRefs, html, opts);
|
|
85
115
|
if (summary && !html) {
|
|
86
116
|
let summaries = {};
|
|
87
117
|
for (let [imageRef, report] of Object.entries(res)) {
|
|
@@ -132,6 +162,14 @@ const stack = {
|
|
|
132
162
|
desc: 'Workspace root directory (for monorepos; lock file is expected here)',
|
|
133
163
|
type: 'string',
|
|
134
164
|
normalize: true,
|
|
165
|
+
},
|
|
166
|
+
providers: {
|
|
167
|
+
desc: 'Comma-separated list of vulnerability providers (env: TRUSTIFY_DA_PROVIDERS)',
|
|
168
|
+
type: 'string',
|
|
169
|
+
},
|
|
170
|
+
sources: {
|
|
171
|
+
desc: 'Comma-separated list of vulnerability sources (env: TRUSTIFY_DA_SOURCES)',
|
|
172
|
+
type: 'string',
|
|
135
173
|
}
|
|
136
174
|
}),
|
|
137
175
|
handler: async (args) => {
|
|
@@ -139,6 +177,12 @@ const stack = {
|
|
|
139
177
|
let html = args['html'];
|
|
140
178
|
let summary = args['summary'];
|
|
141
179
|
const opts = args.workspaceDir ? { TRUSTIFY_DA_WORKSPACE_DIR: args.workspaceDir } : {};
|
|
180
|
+
if (args.providers) {
|
|
181
|
+
opts.TRUSTIFY_DA_PROVIDERS = args.providers;
|
|
182
|
+
}
|
|
183
|
+
if (args.sources) {
|
|
184
|
+
opts.TRUSTIFY_DA_SOURCES = args.sources;
|
|
185
|
+
}
|
|
142
186
|
let theProvidersSummary = new Map();
|
|
143
187
|
let theProvidersObject = {};
|
|
144
188
|
let res = await client.stackAnalysis(manifest, html, opts);
|
|
@@ -201,6 +245,14 @@ const stackBatch = {
|
|
|
201
245
|
desc: 'Stop on first invalid package.json or SBOM error (env: TRUSTIFY_DA_CONTINUE_ON_ERROR=false)',
|
|
202
246
|
type: 'boolean',
|
|
203
247
|
default: false,
|
|
248
|
+
},
|
|
249
|
+
providers: {
|
|
250
|
+
desc: 'Comma-separated list of vulnerability providers (env: TRUSTIFY_DA_PROVIDERS)',
|
|
251
|
+
type: 'string',
|
|
252
|
+
},
|
|
253
|
+
sources: {
|
|
254
|
+
desc: 'Comma-separated list of vulnerability sources (env: TRUSTIFY_DA_SOURCES)',
|
|
255
|
+
type: 'string',
|
|
204
256
|
}
|
|
205
257
|
}),
|
|
206
258
|
handler: async (args) => {
|
|
@@ -221,6 +273,12 @@ const stackBatch = {
|
|
|
221
273
|
if (args.failFast) {
|
|
222
274
|
opts.continueOnError = false;
|
|
223
275
|
}
|
|
276
|
+
if (args.providers) {
|
|
277
|
+
opts.TRUSTIFY_DA_PROVIDERS = args.providers;
|
|
278
|
+
}
|
|
279
|
+
if (args.sources) {
|
|
280
|
+
opts.TRUSTIFY_DA_SOURCES = args.sources;
|
|
281
|
+
}
|
|
224
282
|
let res = await client.stackAnalysisBatch(workspaceRoot, html, opts);
|
|
225
283
|
const batchAnalysis = res && typeof res === 'object' && res != null && 'analysis' in res ? res.analysis : res;
|
|
226
284
|
if (summary && !html && typeof batchAnalysis === 'object') {
|
|
@@ -373,9 +431,54 @@ const sbom = {
|
|
|
373
431
|
}
|
|
374
432
|
}
|
|
375
433
|
};
|
|
434
|
+
const remediate = {
|
|
435
|
+
command: 'remediate <path>',
|
|
436
|
+
desc: 'Scan and apply vulnerability remediations to manifest files',
|
|
437
|
+
builder: yargs => yargs.positional('path', {
|
|
438
|
+
desc: 'Path to manifest file or directory',
|
|
439
|
+
type: 'string',
|
|
440
|
+
normalize: true,
|
|
441
|
+
}).options({
|
|
442
|
+
'dry-run': {
|
|
443
|
+
alias: 'd',
|
|
444
|
+
type: 'boolean',
|
|
445
|
+
desc: 'Preview changes without modifying files',
|
|
446
|
+
},
|
|
447
|
+
providers: {
|
|
448
|
+
desc: 'Comma-separated list of vulnerability providers (env: TRUSTIFY_DA_PROVIDERS)',
|
|
449
|
+
type: 'string',
|
|
450
|
+
},
|
|
451
|
+
sources: {
|
|
452
|
+
desc: 'Comma-separated list of vulnerability sources (env: TRUSTIFY_DA_SOURCES)',
|
|
453
|
+
type: 'string',
|
|
454
|
+
},
|
|
455
|
+
'group-by': {
|
|
456
|
+
type: 'string',
|
|
457
|
+
choices: ['dependency', 'bundle'],
|
|
458
|
+
default: 'dependency',
|
|
459
|
+
desc: 'Report grouping strategy',
|
|
460
|
+
},
|
|
461
|
+
}),
|
|
462
|
+
handler: async (args) => {
|
|
463
|
+
try {
|
|
464
|
+
const result = await runRemediation(args.path, {
|
|
465
|
+
dryRun: args['dry-run'],
|
|
466
|
+
providers: args.providers,
|
|
467
|
+
sources: args.sources,
|
|
468
|
+
groupBy: args['group-by'],
|
|
469
|
+
});
|
|
470
|
+
console.log(result.output);
|
|
471
|
+
process.exit(result.exitCode);
|
|
472
|
+
}
|
|
473
|
+
catch (err) {
|
|
474
|
+
console.error(err.message);
|
|
475
|
+
process.exit(1);
|
|
476
|
+
}
|
|
477
|
+
}
|
|
478
|
+
};
|
|
376
479
|
// parse and invoke the command
|
|
377
480
|
yargs(hideBin(process.argv))
|
|
378
|
-
.usage(`Usage: ${process.argv[0].includes("node") ? path.parse(process.argv[1]).base : path.parse(process.argv[0]).base} {component|stack|stack-batch|image|validate-token|license|sbom}`)
|
|
481
|
+
.usage(`Usage: ${process.argv[0].includes("node") ? path.parse(process.argv[1]).base : path.parse(process.argv[0]).base} {component|stack|stack-batch|image|validate-token|license|sbom|remediate}`)
|
|
379
482
|
.command(stack)
|
|
380
483
|
.command(stackBatch)
|
|
381
484
|
.command(component)
|
|
@@ -383,6 +486,7 @@ yargs(hideBin(process.argv))
|
|
|
383
486
|
.command(validateToken)
|
|
384
487
|
.command(license)
|
|
385
488
|
.command(sbom)
|
|
489
|
+
.command(remediate)
|
|
386
490
|
.scriptName('')
|
|
387
491
|
.version(false)
|
|
388
492
|
.demandCommand(1)
|
|
@@ -41,12 +41,20 @@ function getComponent(component, type, scope, licenses, hashes) {
|
|
|
41
41
|
// Add licenses if provided (CycloneDX format). Callers must provide valid SPDX identifiers.
|
|
42
42
|
if (licenses) {
|
|
43
43
|
const licenseArray = Array.isArray(licenses) ? licenses : [licenses];
|
|
44
|
-
|
|
44
|
+
const validLicenses = licenseArray
|
|
45
|
+
.map(lic => {
|
|
45
46
|
if (typeof lic === 'string') {
|
|
46
47
|
return { license: { id: lic } };
|
|
47
48
|
}
|
|
48
|
-
|
|
49
|
-
|
|
49
|
+
if (typeof lic === 'object' && lic !== null && ('license' in lic || 'expression' in lic)) {
|
|
50
|
+
return lic;
|
|
51
|
+
}
|
|
52
|
+
return null;
|
|
53
|
+
})
|
|
54
|
+
.filter(Boolean);
|
|
55
|
+
if (validLicenses.length > 0) {
|
|
56
|
+
componentObject.licenses = validLicenses;
|
|
57
|
+
}
|
|
50
58
|
}
|
|
51
59
|
// Add hashes if provided (CycloneDX 1.4 format).
|
|
52
60
|
if (hashes && hashes.length > 0) {
|
package/dist/src/index.d.ts
CHANGED
|
@@ -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
|
-
|
|
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;
|
|
@@ -80,7 +83,7 @@ export type Options = {
|
|
|
80
83
|
};
|
|
81
84
|
export type BatchAnalysisMetadata = {
|
|
82
85
|
workspaceRoot: string;
|
|
83
|
-
ecosystem: "javascript" | "cargo" | "unknown";
|
|
86
|
+
ecosystem: "javascript" | "cargo" | "pyproject" | "unknown";
|
|
84
87
|
total: number;
|
|
85
88
|
successful: number;
|
|
86
89
|
failed: number;
|
|
@@ -106,7 +109,7 @@ export type SbomResult = {
|
|
|
106
109
|
* @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
|
|
107
110
|
* @throws {Error} if no matching provider, failed to get create content, or backend request failed
|
|
108
111
|
*/
|
|
109
|
-
declare function componentAnalysis(manifest: string, opts?: Options): Promise<
|
|
112
|
+
declare function componentAnalysis(manifest: string, opts?: Options): Promise<any>;
|
|
110
113
|
/**
|
|
111
114
|
* @overload
|
|
112
115
|
* @param {string} manifest
|
|
@@ -124,7 +127,7 @@ declare function stackAnalysis(manifest: string, html: true, opts?: Options | un
|
|
|
124
127
|
* @returns {Promise<import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport').AnalysisReport>}
|
|
125
128
|
* @throws {Error}
|
|
126
129
|
*/
|
|
127
|
-
declare function stackAnalysis(manifest: string, html: false, opts?: Options | undefined): Promise<
|
|
130
|
+
declare function stackAnalysis(manifest: string, html: false, opts?: Options | undefined): Promise<any>;
|
|
128
131
|
/**
|
|
129
132
|
* Get stack analysis report for a manifest file.
|
|
130
133
|
* @overload
|
|
@@ -135,7 +138,7 @@ declare function stackAnalysis(manifest: string, html: false, opts?: Options | u
|
|
|
135
138
|
* @throws {Error} if manifest inaccessible, no matching provider, failed to get create content,
|
|
136
139
|
* or backend request failed
|
|
137
140
|
*/
|
|
138
|
-
declare function stackAnalysis(manifest: string, html?: boolean | undefined, opts?: Options | undefined): Promise<string |
|
|
141
|
+
declare function stackAnalysis(manifest: string, html?: boolean | undefined, opts?: Options | undefined): Promise<string | any>;
|
|
139
142
|
/**
|
|
140
143
|
* @overload
|
|
141
144
|
* @param {string} workspaceRoot
|
|
@@ -173,7 +176,7 @@ declare function stackAnalysisBatch(workspaceRoot: string, html: false, opts: Op
|
|
|
173
176
|
batchMetadata: true;
|
|
174
177
|
}): Promise<{
|
|
175
178
|
analysis: {
|
|
176
|
-
[x: string]:
|
|
179
|
+
[x: string]: any;
|
|
177
180
|
};
|
|
178
181
|
metadata: BatchAnalysisMetadata;
|
|
179
182
|
}>;
|
|
@@ -188,7 +191,7 @@ declare function stackAnalysisBatch(workspaceRoot: string, html: false, opts: Op
|
|
|
188
191
|
declare function stackAnalysisBatch(workspaceRoot: string, html: false, opts?: (Options & {
|
|
189
192
|
batchMetadata?: false;
|
|
190
193
|
}) | undefined): Promise<{
|
|
191
|
-
[x: string]:
|
|
194
|
+
[x: string]: any;
|
|
192
195
|
}>;
|
|
193
196
|
/**
|
|
194
197
|
* Get stack analysis for all workspace packages/crates (batch).
|
|
@@ -204,10 +207,10 @@ declare function stackAnalysisBatch(workspaceRoot: string, html: false, opts?: (
|
|
|
204
207
|
* @throws {Error} if workspace root invalid, no manifests found, no packages pass validation, no SBOMs produced, or backend request failed. When `opts.batchMetadata` is set, `error.batchMetadata` may be set on thrown errors.
|
|
205
208
|
*/
|
|
206
209
|
declare function stackAnalysisBatch(workspaceRoot: string, html?: boolean | undefined, opts?: Options | undefined): Promise<string | {
|
|
207
|
-
[x: string]:
|
|
210
|
+
[x: string]: any;
|
|
208
211
|
} | {
|
|
209
212
|
analysis: string | {
|
|
210
|
-
[x: string]:
|
|
213
|
+
[x: string]: any;
|
|
211
214
|
};
|
|
212
215
|
metadata: BatchAnalysisMetadata;
|
|
213
216
|
}>;
|
|
@@ -229,7 +232,7 @@ declare function imageAnalysis(imageRefs: Array<string>, html: true, opts?: Opti
|
|
|
229
232
|
* @throws {Error}
|
|
230
233
|
*/
|
|
231
234
|
declare function imageAnalysis(imageRefs: Array<string>, html: false, opts?: Options | undefined): Promise<{
|
|
232
|
-
[x: string]:
|
|
235
|
+
[x: string]: any;
|
|
233
236
|
}>;
|
|
234
237
|
/**
|
|
235
238
|
* Get image analysis report for a set of OCI image references.
|
|
@@ -242,7 +245,7 @@ declare function imageAnalysis(imageRefs: Array<string>, html: false, opts?: Opt
|
|
|
242
245
|
* or backend request failed
|
|
243
246
|
*/
|
|
244
247
|
declare function imageAnalysis(imageRefs: Array<string>, html?: boolean | undefined, opts?: Options | undefined): Promise<string | {
|
|
245
|
-
[x: string]:
|
|
248
|
+
[x: string]: any;
|
|
246
249
|
}>;
|
|
247
250
|
/**
|
|
248
251
|
* Validates the Exhort token.
|
|
@@ -254,6 +257,7 @@ declare function validateToken(opts?: Options): Promise<object>;
|
|
|
254
257
|
import { discoverMavenModules } from './providers/java_maven.js';
|
|
255
258
|
import { discoverGradleSubprojects } from './providers/java_gradle.js';
|
|
256
259
|
import { discoverGoWorkspaceModules } from './providers/golang_gomodules.js';
|
|
260
|
+
import { discoverUvWorkspaceMembers } from './providers/python_uv.js';
|
|
257
261
|
import { discoverWorkspacePackages } from './workspace.js';
|
|
258
262
|
import { discoverWorkspaceCrates } from './workspace.js';
|
|
259
263
|
import { validatePackageJson } from './workspace.js';
|
|
@@ -261,5 +265,6 @@ import { resolveWorkspaceDiscoveryIgnore } from './workspace.js';
|
|
|
261
265
|
import { filterManifestPathsByDiscoveryIgnore } from './workspace.js';
|
|
262
266
|
import { resolveContinueOnError } from './batch_opts.js';
|
|
263
267
|
import { resolveBatchMetadata } from './batch_opts.js';
|
|
264
|
-
export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceModules, discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata };
|
|
268
|
+
export { discoverMavenModules, discoverGradleSubprojects, discoverGoWorkspaceModules, discoverUvWorkspaceMembers, discoverWorkspacePackages, discoverWorkspaceCrates, validatePackageJson, resolveWorkspaceDiscoveryIgnore, filterManifestPathsByDiscoveryIgnore, resolveContinueOnError, resolveBatchMetadata };
|
|
265
269
|
export { getProjectLicense, findLicenseFilePath, identifyLicense, getLicenseDetails, licensesFromReport, normalizeLicensesResponse, runLicenseCheck, getCompatibility } from "./license/index.js";
|
|
270
|
+
export { generateReport, generateDeduplicationKey } from "./remediation_report.js";
|