配置指令 (Windows)

使用配置指令來準備檔案以進行掃描。

appscan prepare

語法:

appscan prepare -c <configuration_file> -d <save_path> -jdk <jdk_path> -l <log_path> -n <file_name> -oso,--openSourceOnly 

說明:

產生 IRX 檔案。

註: 掃描程式碼或產生 IRX 檔案時,您可能會接收到關於更新至最新 IRX 的訊息。請參閱指令行公用程式 (CLI) 支援

可選旗標/設定:

  • -c:此選項用於配置掃描。
  • -d:指定 -d <save_path>,其中 <save_path> 是您想要儲存 IRX 檔案的目錄。
  • -dr, --dryrun:指定-dr or --dryrun 以探索和驗證掃描目標,但是不產生 .irx 檔案。
  • -jdk:指定 -jdk <jdk_path> 以指出要用來代替預設 JDK 17 的 JDK 安裝的路徑。如果使用配置檔 (-c <configuration_file>),且使用 jdk_path 屬性,則會優先使用配置檔中指定的值。
  • -l:指定 -l <log_path>,其中 <log_path> 是您想要儲存日誌檔案的目錄。
  • -n:指定 -n <file_name>,其中 <file_name>IRX 檔名。指定檔名時不一定要有 .irx 副檔名。如果您指定的檔案名稱沒有副檔名,系統會在產生檔案時自動為您新增副檔名。
  • -oso, -openSourceOnly:指定 -oso-openSourceOnly,在 SCA 套件中尋找已知漏洞。指定 -oso-openSourceOnly時,則AppScan on Cloud不會在套件上執行靜態分析。
    註: 當使用者具有「開放程式碼」授權時,「SCA」分析預設是靜態掃描的一部分。這個選項會限制對於「SCA」漏洞的分析。使用者必須具有「開放程式碼」授權,才能利用僅限「SCA」的分析。
提示: 針對所有指令,可以依任意順序使用選項。

範例:

若要產生使用此配置檔的 IRX 檔案,c:\my_config_files\my_config.xml - 並將 IRX 檔案儲存至 c:\my_irx_files\my_scan.irx,請發出下列指令:

appscan prepare -c c:\my_config_files\my_config.xml -d c:\my_irx_files -n my_scan.irx

appscan prepare_sca

語法:

appscan prepare_sca -d <save_path> -l <log_path> -n <file_name> -X, -debug -container <container> -image <image>

說明:

針對 Docker 影像產生 IRX 檔案,以執行軟體組成分析 (SCA)。若在沒有參數的情況下執行,此指令相當於執行 appscan prepare -oso
重要: 必須在系統上安裝及配置 Docker CLI 工具,才能掃描 Docker 儲存器和影像。

可選旗標/設定:

  • -d:指定 -d <save_path>,其中 <save_path> 是您想要儲存 IRX 檔案的目錄。
  • -l:指定 -l <log_path>,其中 <log_path> 是您想要儲存日誌檔案的目錄。
  • -n:指定 -n <file_name>,其中 <file_name>IRX 檔名。指定檔名時不一定要有 .irx 副檔名。如果您指定的檔案名稱沒有副檔名,系統會在產生檔案時自動為您新增副檔名。
  • -X,--debug:指定 -X--debug,以除錯模式執行整個指令。在除錯模式下執行時,會產生較多日誌檔以便進行疑難排解。
  • -container:指定 -container <container>,其中 <container> 是要分析的 Docker 容器。該值可以為儲存器名稱、儲存器摘要或本端保存的路徑。
  • -image:指定 -image <image>,其中 <image> 是要分析的 Docker 影像。該值可以為影像名稱、影像摘要或本端保存的路徑。
提示: 針對所有指令,可以依任意順序使用選項。

appscan get_pubkey

語法:

appscan get_pubkey -d <save_path>

說明:

下載公開加密金鑰以便用於未連接網際網路的電腦。

如果您要從連接網際網路的電腦產生 IRX 檔案,則不需要這個指令,因為在您發出 prepare 指令時會自動下載加密金鑰。如果電腦上已有加密金鑰,當您發出 prepare 指令時,系統會視需要將其更新。

然而,如果您要從未連接網際網路的電腦產生 IRX 檔案,則您可以使用這個指令下載加密金鑰。接著您可以將加密金鑰複製到未連接網際網路的電腦,以便用於產生 IRX 檔案。若要在該電腦上使用加密金鑰,您必須保留 rsa.pub 檔名,並將檔案放在解壓縮之 SAClientUtil_<version>_<os>.zip 檔案的 config 目錄中(其中 <version> 是「SAClientUtil_<version>_<os>.zip」的現行版本)。

註: 必須使用最新的加密金鑰。如果使用過時的加密金鑰產生 IRX 檔案,則在上傳 IRX 檔案時會遭到拒絕。如果您的電腦已連接網際網路,請重新發出 prepare 指令,以便自動更新加密金鑰。如果您的電腦未連接網際網路,則需要使用 get_pubkey 指令。

可選旗標/設定:

  • -d:指定 -d <save_path>,其中 <save_path> 是您想要儲存加密金鑰的目錄。如果未指定這個選項,金鑰將會儲存到解壓縮 SAClientUtil_<version>_<os>.zip 檔案的 config 目錄。