From 97a56f2e68d12225d37f616096e5173eece73a3b Mon Sep 17 00:00:00 2001 From: aaaa-j Date: Tue, 8 Nov 2022 17:22:30 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E5=BF=AB=E6=89=AB=E6=A8=A1?= =?UTF-8?q?=E5=BC=8F=E5=B8=AE=E5=8A=A9=E6=96=87=E6=A1=A3,=E4=B8=BB?= =?UTF-8?q?=E8=A6=81=E8=A1=A5=E5=85=85=E5=86=85=E7=BD=AE=E6=96=B9=E6=A1=88?= =?UTF-8?q?=E4=BD=BF=E7=94=A8=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...53\346\217\217\346\250\241\345\274\217.md" | 49 +++++++++++++++++-- 1 file changed, 46 insertions(+), 3 deletions(-) diff --git "a/doc/zh/guide/\345\256\242\346\210\267\347\253\257/\345\277\253\351\200\237\346\211\253\346\217\217\346\250\241\345\274\217.md" "b/doc/zh/guide/\345\256\242\346\210\267\347\253\257/\345\277\253\351\200\237\346\211\253\346\217\217\346\250\241\345\274\217.md" index eae3dc94c..c3e41230f 100644 --- "a/doc/zh/guide/\345\256\242\346\210\267\347\253\257/\345\277\253\351\200\237\346\211\253\346\217\217\346\250\241\345\274\217.md" +++ "b/doc/zh/guide/\345\256\242\346\210\267\347\253\257/\345\277\253\351\200\237\346\211\253\346\217\217\346\250\241\345\274\217.md" @@ -8,7 +8,46 @@ ## 使用步骤 -### 1. 在页面上创建分析方案模板 +### 使用内置默认方案快速扫描 +:::tip +客户端快扫模式已内置`open_source_check`（开源）、`safety`（基础安全）、`sensitive`（敏感信息）三种常用分析方案，快速启动内置方案： +::: + +#### 1. 初始化扫描需要的工具 +- 进入到客户端`client`目录下，运行codepuppy.py或codepuppy二进制，使用`quickinit`命令拉取指定分析方案模板所需要的分析工具： +```commandline +python3 codepuppy.py quickinit -l LABEL_NAME + +# 如使用codepuppy二进制，可执行：./codepuppy quickinit -l LABEL_NAME +``` + +- 参数说明： + - `LABEL_NAME`: 必选，内置分析方案标签名，从`open_source_check`、`safety`、`sensitive`三者中选一。 + + +### 2. 执行快速扫描 + +- 进入到客户端`client`目录下，执行命令： + +```commandline +python3 codepuppy.py quickscan -l LABEL_NAME -s SOURCE_DIR --file FILE + +# 如使用codepuppy二进制，可执行：./codepuppy quickscan -l LABEL_NAME -s SOURCE_DIR --file FILE +``` +- 参数说明： + - `LABEL_NAME`: 必选，内置分析方案标签名，从`open_source_check`、`safety`、`sensitive`三者中选一。 + - `SOURCE_DIR`: 必选，需要扫描的代码目录路径 + - `FILE`: 可选，指定文件扫描，格式为基于SOURCE_DIR的相对路径，多个文件用英文逗号(,)分隔。不指定文件，默认扫描整个代码目录。 + - 其他参数说明参考`quickinit`命令。 + +- 扫描完成后，结果会默认输出到客户端`client`目录下的`tca_quick_scan_report.json`文件中。结果只保存在本地，不会上报到服务端展示。 + +- 如需自行创建分析方案，参考以下步骤： + + +### 使用自定义的分析方案快速扫描 + +#### 1. 在页面上创建分析方案模板 - 由于该模式不与scm代码仓库绑定，因此不能直接使用分析方案（分析方案上归属于某个代码仓库下的），需要使用分析方案模板的配置来扫描。 @@ -16,18 +55,20 @@ - 配置好方案模板后，从页面URL中获取到分析方案模板ID，分析方案模板页面URL格式：`http://{域名}/t/{org_sid}/p/{team_name}/template/{分析方案模板ID}`，`template`后面的数字即分析方案模板ID。 -### 2. 初始化扫描需要的工具 +#### 2. 初始化扫描需要的工具 - 进入到客户端`client`目录下，使用`quickinit`命令拉取指定分析方案模板所需要的分析工具： ```commandline python3 codepuppy.py quickinit -t TOKEN --scheme-template-id SCHEME_TEMPLATE_ID --org-sid ORG_SID + +# 如使用codepuppy二进制，可执行：./codepuppy quickinit -t TOKEN --scheme-template-id SCHEME_TEMPLATE_ID --org-sid ORG_SID ``` - 参数说明： - `TOKEN`: 必选，从TCA平台页面获取，前往`[个人中心]`-`[个人令牌]`-复制Token - `SCHEME_TEMPLATE_ID`: 必选，分析方案模板ID，从步骤1中获取 - - `ORG_SID`: 必选，团队编号，从TCA平台团队概览URL中获取，项目概览URL格式：`http://{域名}/t/{org_sid}/profile` + - `ORG_SID`: 必选，团队编号，从TCA平台团队概览中获取“团队唯一标识” ### 3. 执行快速扫描 @@ -35,6 +76,8 @@ python3 codepuppy.py quickinit -t TOKEN --scheme-template-id SCHEME_TEMPLATE_ID ```commandline python3 codepuppy.py quickscan -t TOKEN --scheme-template-id SCHEME_TEMPLATE_ID --org-sid ORG_SID -s SOURCE_DIR --file FILE + +# 如使用codepuppy二进制，可执行：./codepuppy quickscan -t TOKEN --scheme-template-id SCHEME_TEMPLATE_ID --org-sid ORG_SID -s SOURCE_DIR --file FILE ``` - 参数说明：