snyk 1.1131.0 → 1.1133.0
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/help/cli-commands/README.md +4 -0
- package/help/cli-commands/sbom.md +29 -24
- package/help/cli-commands/test.md +1 -1
- package/package.json +1 -1
- package/src/generated/sha256sums.txt +10 -10
- package/src/generated/version +1 -1
- package/wrapper_dist/generated/sha256sums.txt +10 -10
- package/wrapper_dist/generated/version +1 -1
|
@@ -44,6 +44,10 @@ Commands to find and manage security issues in Infrastructure as Code files.
|
|
|
44
44
|
|
|
45
45
|
Find security issues using static code analysis.
|
|
46
46
|
|
|
47
|
+
### [`snyk sbom`](sbom.md) <a href="#snyk-sbom" id="snyk-sbom"></a>
|
|
48
|
+
|
|
49
|
+
Produce an SBOM for a local software project in an ecosystem supported by Snyk.
|
|
50
|
+
|
|
47
51
|
### [`snyk log4shell`](log4shell.md)
|
|
48
52
|
|
|
49
53
|
Find Log4Shell vulnerability.
|
|
@@ -1,10 +1,12 @@
|
|
|
1
|
-
# SBOM
|
|
1
|
+
# SBOM
|
|
2
2
|
|
|
3
3
|
## Usage
|
|
4
4
|
|
|
5
|
-
**
|
|
5
|
+
**Feature availability:** This feature is available to customers on Snyk Enterprise plans.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
**Note:** In order to run the SBOM generation feature, you must use a minimum of CLI version 1.1071.0.
|
|
8
|
+
|
|
9
|
+
`$ snyk sbom --format=<cyclonedx1.4+json|spdx2.3+json|cyclonedx1.4+xml> [--file=<file>] [--unmanaged] [--org=<ORG_ID>] [<TARGET_DIRECTORY>]`
|
|
8
10
|
|
|
9
11
|
## Description
|
|
10
12
|
|
|
@@ -15,8 +17,7 @@ The `snyk sbom` command enables you to produce an SBOM for a local software proj
|
|
|
15
17
|
Possible exit codes and their meaning:
|
|
16
18
|
|
|
17
19
|
**0**: success (process completed), SBOM created successfully\
|
|
18
|
-
**2**: failure, try to re-run command
|
|
19
|
-
**3**: failure, no supported projects detected
|
|
20
|
+
**2**: failure, try to re-run command
|
|
20
21
|
|
|
21
22
|
## Debug
|
|
22
23
|
|
|
@@ -24,44 +25,48 @@ Use the `-d` option to output the debug logs.
|
|
|
24
25
|
|
|
25
26
|
## Options
|
|
26
27
|
|
|
27
|
-
### `--
|
|
28
|
+
### `--format=<cyclonedx1.4+json|cyclonedx1.4+xml|spdx2.3+json>`
|
|
28
29
|
|
|
29
|
-
Specify
|
|
30
|
+
Specify the output format for the SBOM to be produced.
|
|
31
|
+
|
|
32
|
+
The supported formats are CycloneDX 1.4 JSON or XML and SPDX 2.3 JSON.
|
|
30
33
|
|
|
31
34
|
### `[--file=<file>]`
|
|
32
35
|
|
|
33
36
|
Optional. Select the package manager manifest file to use as the basis for the SBOM to be produced.
|
|
34
37
|
|
|
35
|
-
###
|
|
38
|
+
### `[--unmanaged]`
|
|
36
39
|
|
|
37
|
-
|
|
40
|
+
Optional. Instruct the CLI to build an SBOM based on the unmanaged C/C++ source libraries that are locally available.
|
|
38
41
|
|
|
39
|
-
|
|
42
|
+
### `[--org=<ORG_ID>]`
|
|
40
43
|
|
|
41
|
-
|
|
44
|
+
Optional. Specify the `<ORG_ID>` to run Snyk commands tied to a specific organization. The `<ORG_ID>` influences some features availability and private test limits.
|
|
42
45
|
|
|
43
|
-
|
|
46
|
+
If you have multiple organizations, you can set a default from the CLI using:
|
|
44
47
|
|
|
45
|
-
|
|
48
|
+
`$ snyk config set org=<ORG_ID>`
|
|
46
49
|
|
|
47
|
-
|
|
50
|
+
Set a default to ensure all newly tested projects are tested under your default organization. If you need to override the default, use the `--org=<ORG_ID>` option.
|
|
48
51
|
|
|
49
|
-
|
|
52
|
+
Default: `<ORG_ID>` that is the current preferred organization in your [Account settings](https://app.snyk.io/account)
|
|
50
53
|
|
|
51
|
-
|
|
54
|
+
**Note:** You can also use `--org=<orgslugname>.` The `ORG_ID` works in both the CLI and the API. The organization slug name works in the CLI, but not in the API.
|
|
52
55
|
|
|
53
|
-
|
|
56
|
+
For more information see the article [How to select the organization to use in the CLI](https://support.snyk.io/hc/en-us/articles/360000920738-How-to-select-the-organization-to-use-in-the-CLI)
|
|
54
57
|
|
|
55
|
-
|
|
58
|
+
### `[<TARGET_DIRECTORY>]`
|
|
56
59
|
|
|
57
|
-
|
|
60
|
+
Optional. Instruct the CLI to autodetect a package manager manifest file to use within the specified directory. If `--file` is set, this option will be ignored.
|
|
58
61
|
|
|
59
|
-
`
|
|
62
|
+
**Note:** Support for the `--all-projects` option is planned for later versions.
|
|
60
63
|
|
|
61
|
-
##
|
|
64
|
+
## Examples for the snyk sbom command
|
|
65
|
+
|
|
66
|
+
Generate an SBOM and display it in the local console.
|
|
62
67
|
|
|
63
|
-
|
|
68
|
+
`$ snyk sbom --format=cyclonedx1.4+json`
|
|
64
69
|
|
|
65
|
-
|
|
70
|
+
Generate an SBOM and write it to a local file.
|
|
66
71
|
|
|
67
|
-
|
|
72
|
+
`$ snyk sbom --format=cyclonedx1.4+json > mySBOM.json`
|
|
@@ -155,7 +155,7 @@ Specify a custom Snyk project name.
|
|
|
155
155
|
|
|
156
156
|
### `--target-reference=<TARGET_REFERENCE>`
|
|
157
157
|
|
|
158
|
-
Specify a reference which differentiates this project, for example, a branch name or version. Projects having the same reference can be grouped based on that reference. Supported for Snyk Open Source
|
|
158
|
+
Specify a reference which differentiates this project, for example, a branch name or version. Projects having the same reference can be grouped based on that reference. Supported for Snyk Open Source except for use with `--unmanaged`.
|
|
159
159
|
|
|
160
160
|
For more information see [Separating projects by branch or version](https://docs.snyk.io/snyk-cli/secure-your-projects-in-the-long-term/grouping-projects-by-branch-or-version)
|
|
161
161
|
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
1
|
+
824a442db195323788b0fee3583267bb320a91e802aca419bec7c15406433c74 docker-mac-signed-bundle.tar.gz
|
|
2
|
+
421fb9b38ac3fe7bd3f42b9fc553b6c1b1b1ad8e456d2e2a0de47625d769a72b snyk-alpine
|
|
3
|
+
f449b19a9609349589aa1498ee8de501a6cb4d010aa19b04b4e254ade0a5354e snyk-fix.tgz
|
|
4
|
+
2993d43f60490214006f8fed912dd6ec54e6cee47451108857b3f4ad3867d17d snyk-for-docker-desktop-darwin-arm64.tar.gz
|
|
5
|
+
0d796536ad103e34321d3076ef47bd14f21a463574648bd295fec14020ed126f snyk-for-docker-desktop-darwin-x64.tar.gz
|
|
6
|
+
84eacc1683a2ab58fa26ef0c220046973ebe0d91607135c71a9081aec0d2fc43 snyk-linux-arm64
|
|
7
|
+
122ce2311fdfca341d86143ae6081f10ac97e5458b3f4e7eb116b5c8e9b245bf snyk-linux
|
|
8
|
+
0d23c75960caf6b58a0ba6eaaa8dbd83ecad9d13d6ec83f38f27bf26993588de snyk-macos
|
|
9
|
+
efece23bb9bfd9026db90a341de24f5a27f07f8be01a05c961ed5093d2d73b94 snyk-protect.tgz
|
|
10
|
+
465033bd4781b28a61cdce5fca186184f84ae83ff16def23c15a648386986a96 snyk-win.exe
|
package/src/generated/version
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.1133.0
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
1
|
+
824a442db195323788b0fee3583267bb320a91e802aca419bec7c15406433c74 docker-mac-signed-bundle.tar.gz
|
|
2
|
+
421fb9b38ac3fe7bd3f42b9fc553b6c1b1b1ad8e456d2e2a0de47625d769a72b snyk-alpine
|
|
3
|
+
f449b19a9609349589aa1498ee8de501a6cb4d010aa19b04b4e254ade0a5354e snyk-fix.tgz
|
|
4
|
+
2993d43f60490214006f8fed912dd6ec54e6cee47451108857b3f4ad3867d17d snyk-for-docker-desktop-darwin-arm64.tar.gz
|
|
5
|
+
0d796536ad103e34321d3076ef47bd14f21a463574648bd295fec14020ed126f snyk-for-docker-desktop-darwin-x64.tar.gz
|
|
6
|
+
84eacc1683a2ab58fa26ef0c220046973ebe0d91607135c71a9081aec0d2fc43 snyk-linux-arm64
|
|
7
|
+
122ce2311fdfca341d86143ae6081f10ac97e5458b3f4e7eb116b5c8e9b245bf snyk-linux
|
|
8
|
+
0d23c75960caf6b58a0ba6eaaa8dbd83ecad9d13d6ec83f38f27bf26993588de snyk-macos
|
|
9
|
+
efece23bb9bfd9026db90a341de24f5a27f07f8be01a05c961ed5093d2d73b94 snyk-protect.tgz
|
|
10
|
+
465033bd4781b28a61cdce5fca186184f84ae83ff16def23c15a648386986a96 snyk-win.exe
|
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.1133.0
|