snyk 1.1131.0 → 1.1132.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
|
+
91f24cc80119b4f84dcc105fdb38a5c745f2e8697ae6b71f2543a881a2210289 docker-mac-signed-bundle.tar.gz
|
|
2
|
+
a59a6015e0ee46e75dbfa8fc8946b516ba2b1dba498522231657eec0407b09ec snyk-alpine
|
|
3
|
+
195ff83cc9531abc632ac3eef3004f539f87ec01cf6ad6c51ea52ee6e04757d6 snyk-fix.tgz
|
|
4
|
+
18806310d1b0a1069d38e25e25f9914af006d712c2aa91203187791163585570 snyk-for-docker-desktop-darwin-arm64.tar.gz
|
|
5
|
+
f1be7b5467d900f5b1ea947b24ccf72addbe0fcbd24bc5e6a2ead7d95026cefb snyk-for-docker-desktop-darwin-x64.tar.gz
|
|
6
|
+
7c434d04c0f119c7a26f424518d06a678892a39af9253c4ce1d3d562e33e1ce5 snyk-linux-arm64
|
|
7
|
+
16ecdb4b17a128a034f5e9b02e5a8832a75f59c56f89ee48429cdead81670a4c snyk-linux
|
|
8
|
+
d0ad451c8bfae898d612407d6482265aadbd6921d5e399499909c3aca590a274 snyk-macos
|
|
9
|
+
bff6bc551c50a88463fb7db8133217a60cf4679341b72f792b733d26b16a7441 snyk-protect.tgz
|
|
10
|
+
87739c3ea74f34cc70b931744ba0bfb347d58924615ba849309f6492cbecf6fa snyk-win.exe
|
package/src/generated/version
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.1132.0
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
1
|
+
91f24cc80119b4f84dcc105fdb38a5c745f2e8697ae6b71f2543a881a2210289 docker-mac-signed-bundle.tar.gz
|
|
2
|
+
a59a6015e0ee46e75dbfa8fc8946b516ba2b1dba498522231657eec0407b09ec snyk-alpine
|
|
3
|
+
195ff83cc9531abc632ac3eef3004f539f87ec01cf6ad6c51ea52ee6e04757d6 snyk-fix.tgz
|
|
4
|
+
18806310d1b0a1069d38e25e25f9914af006d712c2aa91203187791163585570 snyk-for-docker-desktop-darwin-arm64.tar.gz
|
|
5
|
+
f1be7b5467d900f5b1ea947b24ccf72addbe0fcbd24bc5e6a2ead7d95026cefb snyk-for-docker-desktop-darwin-x64.tar.gz
|
|
6
|
+
7c434d04c0f119c7a26f424518d06a678892a39af9253c4ce1d3d562e33e1ce5 snyk-linux-arm64
|
|
7
|
+
16ecdb4b17a128a034f5e9b02e5a8832a75f59c56f89ee48429cdead81670a4c snyk-linux
|
|
8
|
+
d0ad451c8bfae898d612407d6482265aadbd6921d5e399499909c3aca590a274 snyk-macos
|
|
9
|
+
bff6bc551c50a88463fb7db8133217a60cf4679341b72f792b733d26b16a7441 snyk-protect.tgz
|
|
10
|
+
87739c3ea74f34cc70b931744ba0bfb347d58924615ba849309f6492cbecf6fa snyk-win.exe
|
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.1132.0
|