ScanFolder

描述

扫描指定文件夹并执行与扫描相关的其他操作。

语法

ounceauto ScanFolder
-folder_path <path to folder>
[-name <assessment name>]
[-scanconfig <scan_configuration_name>]
[-waitforlicense <wait_time>]
[-save <filename>]
[-caller <caller>]
[-publish]
[-clearcache]
[-report <report type> <output format> <output location>]
[-export <export type> <output location>]
[-includeSrcBefore <n>]
[-includeSrcAfter <n>]
[-includeTraceDefinitive]
[-includeTraceSuspect]
[-includeTraceCoverage]
[-includeHowToFix]
[-enablesecrets <true/false>]
[-secretsonly <true/false>]
[-sourcecodeonly <true/false>]

• -folder_path <path to folder>：必需。要扫描的现有文件夹的路径。
• -name <assessment name>：可选。评估的名称。
• -scanconfig <scan_configuration_name>：可选。指定要用于扫描的扫描配置的名称。如果未指定扫描配置，那么缺省扫描配置将用于扫描。
• -waitforlicense <wait_time>：可选。指定当 AppScan® Source for Automation 许可证不可用时扫描将等待的等待时间（以分钟为单位）。如果未使用 -waitforlicense 指示等待时间，则会从 CLI.ozsettings 中提取缺省值。可以通过将值设置为 0 来禁用等待时间。
• -save <filename>：可选。将评估结果保存到此文件。
• -caller <caller>：可选。生成操作指定调用者。调用者可以是实际用户的名称，但不要求如此。调用者名称写入到 ounceauto 日志文件。
• -publish：可选。扫描后发布评估。
• -clearcache：可选。在扫描之前除去漏洞分析高速缓存和定制规则签名数据。
• -report：可选。扫描后生成报告。
  • 必需 -report 命令选项：
    • <report type>：报告的类型。报告类型包括 Findings 报告、AppScan® Source 报告和定制报告。请参阅生成报告中的选项。
    • <output format>：指定报告格式。请参阅生成报告中的选项。
    • <output location>：用以保存报告的位置。
  • 可选 -report 命令选项：
    • -includeSrcBefore <n>：要包含在每个结果之前的源代码的行数。
    • -includeSrcAfter <n>：要包含在每个结果之后的源代码的行数。
    • -includeTraceDefinitive：在明确结果的报告中包含跟踪信息（请参阅分类以了解关于结果分类的信息）。
    • -includeTraceSuspect：在可疑结果的报告中包含跟踪信息。
    • -includeTraceCoverage：在扫描覆盖范围结果的报告中包含跟踪信息。

• -export：可选。将扫描结果导出为 CSV 或 SARIF 文件。如果使用，则需要以下命令选项。
  • <export type>：导出报告的格式（CSV 或 SARIF）。
  • <output location>：保存报告的路径和文件名。

• -includeHowToFix：可选。包含有关如何处理和更正发现结果的建议信息。
• -enablesecrets <true/false>：可选。指定可使用密钥扫描程序（除了其他相关扫描程序外）扫描源文件。有效值为 true 和 false。
• -secretsonly <true/false>：可选。指定可仅使用密钥扫描程序扫描源文件。有效值为 true 和 false。
• -sourcecodeonly <true/false>：可选。指定仅扫描源文件，而忽略其他支持的文件类型（.dll、.exe）。有效值为 true 和 false

注：-enablesecrets 和 -secretsonly 相互排斥。和 不能同时安装。

返回值

如果成功，那么返回请求标识；如果请求提交不成功，那么返回 -1。

示例

• 扫描 WebGoat 文件夹：

  ounceauto scanfolder -folder_path "C:\WebGoat"

• 扫描 WebGoat 文件夹并在 C:\WebGoat directory 中创建 Findings 报告。在报告中，包含明确结果的跟踪信息：

  ounceauto scanfolder -folder_path "C:\WebGoat" -report Findings html "C:\WebGoat\MyReport.html" -includeTraceDefinitive