Skip to content

Commit 32e7de3

Browse files
cyberchen1995cyberchen1995
committed
chore: Update SBOM and Reports doc
1 parent affde33 commit 32e7de3

File tree

3 files changed

+147
-1
lines changed

3 files changed

+147
-1
lines changed

‎docs/User_Guide/Generating_Reports/Reports-zh_CN.md‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
11
[返回目录](/docs/README-zh-CN.md) / [English](./Reports.md)
22

3+
- [生成报告](#生成报告)
4+
- [使用 OpenSCA-cli 生成报告](#使用-opensca-cli-生成报告)
5+
- [基本命令](#基本命令)
6+
- [示例](#示例)
7+
- [使用 json2excel 脚本生成 Excel 格式报告](#使用-json2excel-脚本生成-excel-格式报告)
8+
- [需求](#需求)
9+
- [安装脚本](#安装脚本)
10+
- [使用方法](#使用方法)
11+
312
# 生成报告
413

514
OpenSCA 支持生成多种格式的报告, 包括 JSON(`.json`), XML(`.xml`), HTML(`.html`), SQLite(`.sqlite`), CSV(`.csv`), SARIF(`.sarif`)
615

7-
> CSV 格式报告仅包含依赖关系, 不包含漏洞信息. 若需要包含漏洞信息的 Excel 格式报告, 我们提供了 [json2excel](https://github.com/XmirrorSecurity/OpenSCA-cli/blob/master/scripts/json2excel.py) 脚本, 可以将 JSON 格式报告转换为 Excel 格式报告.
16+
> CSV 格式报告仅包含依赖关系, 不包含漏洞信息. 若需要包含漏洞信息的 Excel 格式报告, 可通过 [json2excel](https://github.com/XmirrorSecurity/OpenSCA-cli/blob/master/scripts/json2excel.py) 脚本, 将 JSON 格式报告转换为 Excel 格式报告.
817
918
此外, OpenSCA 提供 SaaS 服务, 同步扫描结果后, 可以在 [OpenSCA SaaS Console](https://opensca.xmirror.cn/console) 查看和下载报告.
1019

@@ -18,6 +27,12 @@ OpenSCA-cli 使用 `-out` 参数指定报告输出路径, 使用后缀名指定
1827
opensca-cli -path {项目路径} -out {报告路径}.{报告格式}
1928
```
2029

30+
`-out` 参数支持指定多个报告路径, 使用半角逗号(`,`)分隔.
31+
32+
```shell
33+
opensca-cli -path {项目路径} -out {报告路径1}.{报告格式1},{报告路径2}.{报告格式2}
34+
```
35+
2136
## 示例
2237

2338
<table>

‎docs/User_Guide/Generating_Reports/SBOM-zh_CN.md‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,131 @@
11
[返回目录](/docs/README-zh-CN.md) / [English](./SBOM.md)
2+
3+
- [SBOM 清单](#sbom-清单)
4+
- [生成 SBOM 清单](#生成-sbom-清单)
5+
- [基本命令](#基本命令)
6+
- [示例](#示例)
7+
- [转换 SBOM 清单](#转换-sbom-清单)
8+
- [基本命令](#基本命令-1)
9+
- [示例](#示例-1)
10+
11+
12+
# SBOM 清单
13+
14+
OpenSCA 支持生成多种格式的 SBOM 清单, 包括 [DSDX](https://opensca.xmirror.cn/resources/particulars?id=133), [SPDX](https://spdx.dev/), [CycloneDX](https://cyclonedx.org/) 和 [SWID](https://csrc.nist.gov/projects/Software-Identification-SWID).
15+
16+
除了生成 SBOM, OpenSCA 还支持将 SBOM 作为输入, 生成漏洞报告或转换为其他格式的 SBOM 清单.
17+
18+
支持的 SBOM 格式:
19+
20+
| SBOM 清单 | 文件后缀 |
21+
| ----------- | -------------------------------- |
22+
| `DSDX` | `.dsdx` `.dsdx.json` `.dsdx.xml` |
23+
| `SPDX` | `.spdx` `.spdx.json` `.spdx.xml` |
24+
| `CycloneDX` | `.cdx.json` `.cdx.xml` |
25+
| `SWID` | `.swid.json` `.swid.xml` |
26+
27+
# 生成 SBOM 清单
28+
29+
## 基本命令
30+
31+
OpenSCA-cli 使用 `-out` 参数指定 SBOM 清单输出路径, 使用后缀名指定 SBOM 清单格式.
32+
33+
```shell
34+
opensca-cli -path {项目路径} -out {SBOM路径}.{SBOM格式}
35+
```
36+
37+
`-out` 参数支持指定多个 SBOM 路径, 使用半角逗号(`,`)分隔.
38+
39+
```shell
40+
opensca-cli -path {项目路径} -out {SBOM路径1}.{SBOM格式1},{SBOM路径2}.{SBOM格式2}
41+
```
42+
43+
也可以同时生成 SBOM 清单和漏洞报告.
44+
45+
```shell
46+
opensca-cli -path {项目路径} -out {SBOM路径}.{SBOM格式},{报告路径}.{报告格式}
47+
```
48+
49+
## 示例
50+
51+
<table>
52+
<tr>
53+
<th align="center">生成 JSON 格式 DSDX 清单</th>
54+
<th align="center">生成 JSON 格式 SPDX 清单</th>
55+
<th align="center">生成 JSON 格式 CycloneDX 清单</th>
56+
<th align="center">生成 JSON 格式 SWID 清单</th>
57+
</tr>
58+
<tr>
59+
<td>
60+
61+
```shell
62+
opensca-cli -path ~/workscapce/myproject -out ~/workscapce/myproject/sbom.dsdx.json
63+
```
64+
65+
</td>
66+
<td>
67+
68+
```shell
69+
opensca-cli -path ~/workscapce/myproject -out ~/workscapce/myproject/sbom.spdx.json
70+
```
71+
72+
</td>
73+
<td>
74+
75+
```shell
76+
opensca-cli -path ~/workscapce/myproject -out ~/workscapce/myproject/sbom.cdx.json
77+
```
78+
79+
</td>
80+
<td>
81+
82+
```shell
83+
opensca-cli -path ~/workscapce/myproject -out ~/workscapce/myproject/sbom.swid.json
84+
```
85+
86+
</td>
87+
</tr>
88+
</table>
89+
90+
# 转换 SBOM 清单
91+
92+
## 基本命令
93+
94+
```shell
95+
opensca-cli -path {SBOM路径}.{SBOM格式} -out {SBOM路径}.{SBOM格式}
96+
```
97+
98+
> 注意: SPDX 和 SWID 格式的 SBOM 清单不包含组件语言信息或包管理器坐标, 在转换时可能会丢失部分信息.
99+
100+
## 示例
101+
102+
<table>
103+
<tr>
104+
<th align="center">DSDX 转 SPDX</th>
105+
<th align="center">DSDX 转 CycloneDX</th>
106+
<th align="center">DSDX 转 SWID</th>
107+
</tr>
108+
<tr>
109+
<td>
110+
111+
```shell
112+
opensca-cli -path ~/workscapce/myproject/sbom.dsdx.json -out ~/workscapce/myproject/sbom.spdx.json
113+
```
114+
115+
</td>
116+
<td>
117+
118+
```shell
119+
opensca-cli -path ~/workscapce/myproject/sbom.dsdx.json -out ~/workscapce/myproject/sbom.cdx.json
120+
```
121+
122+
</td>
123+
<td>
124+
125+
```shell
126+
opensca-cli -path ~/workscapce/myproject/sbom.dsdx.json -out ~/workscapce/myproject/sbom.swid.json
127+
```
128+
129+
</td>
130+
</tr>
131+
</table>

‎docs/User_Guide/Generating_Reports/SBOM.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[Go Back](/docs/README.md) | [简体中文](./SBOM-zh_CN.md)

0 commit comments

Comments
 (0)