GenerateReport

描述

从评估创建报告。

语法

ounceauto GenerateReport
-assessment <assessment path>
-type <report type>
-output <output format>
-file <output location>
[-caller <caller>]
[-includeHowToFix]
[-includeSrcBefore <n>]
[-includeSrcAfter <n>]
[-includeTraceDefinitive]
[-includeTraceSuspect]
[-includeTraceCoverage]
  • -assessment <assessment path>：要为其生成报告的评估文件的路径。
  • -type "<report type>"：添加了双引号的报告类型名称。报告类型包含 Findings 报告、AppScan® Source 报告和定制报告。

    AppScan® Source 报告类型包括：

    • Findings 报告：
      • Findings
      • Findings by Fix Group
      • Findings by Type
      • Findings by Classification
      • Findings by File
      • Findings by API
      • Findings by Bundle
      • Findings by CWE
      • DTS Activity
    • AppScan® Source 报告：
      • 2021 CWE Top 25 Most Dangerous Software Weaknesses
      • DISA Application Security and Development STIG V5R1
      • DISA Application Security and Development STIG V5R3
      • OWASP API Security Top 10 2023
      • OWASP API Security Top 10 2019
      • OWASP Mobile Top 10
      • OWASP Top 10 2017
      • OWASP Top 10 2021
      • PCI Data Security Standard V3.2
      • Software Security Profile
    • 定制报告（如果可用）。

    在输入添加了双引号的报告类型时，请完全按照以上列表中所指定进行输入。例如 Findings by Classification 或 Software Security Profile。

  • -output <output format> ：为此报告指定以下格式之一，
    • html：将报告生成为 HTML 并将其在线显示。
    • zip：创建包含所有 HTML 报告组件的 ZIP 文件。
    • 对于 PDF 格式的报告，可以指定详细级别：
      • pdf-summary：包含每个定制报告组的计数
      • pdf-detailed：包含对各漏洞属性的每个 API 的计数
      • pdf-comprehensive：包含由各 API 的每个结果组成的表
      • pdf-annotated：包含所有结果、结果附带的任何说明以及指定的代码片段
      • output location：用于编写报告的文件路径。
  • -file <output location>：指定要将报告保存到的路径和文件名。
  • -caller <caller>：可选。为报告生成操作指定调用者。调用者可以是实际用户的名称，但不要求如此。调用者名称将写入 ounceauto 日志文件。
  • -includeHowToFix：可选。包含有关如何处理和更正发现结果的建议信息。
  • -includeSrcBefore <n>：可选。要包含在每个结果之前的源代码的行数。
  • -includeSrcAfter <n>：可选。要包含在每个结果之后的源代码的行数。
  • -includeTraceDefinitive：可选。在明确结果的报告中包含跟踪信息（请参阅分类以了解关于结果分类的信息）。
  • -includeTraceSuspect：可选。在可疑结果的报告中包含跟踪信息。
  • -includeTraceCoverage：可选。在扫描覆盖范围结果的报告中包含跟踪信息。

返回值

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

示例

  • 将 Findings by API 报告生成为 HTML 文件。在报告中，包含明确结果的跟踪信息：
    ounceauto generatereport -assessment C:\Ounce\Data\Webgoat.ozasmt
-type "Findings by API" -output html
-file C:\reports\Webgoat_Findings.html
-includeTraceDefinitive
  • 要将 OWASP Top 10 2013 AppScan® Source 报告生成为 PDF：
    ounceauto generatereport -assessment C:\Ounce\Data\Webgoat.ozasmt
-type "OWASP Top 10 2013" -output pdf-annotated
-file C:\Reports\Webgoat_OWASP.pdf