配置命令 (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 分析。
提示: 对于所有命令,选项都可以按任意顺序使用。

示例:

要生成将使用此配置文件 c:\my_config_files\my_config.xml 并将 IRX 文件保存到 c:\my_irx_files\my_scan.irxIRX 文件,请发出以下命令:

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 目录。