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>":報告類型的名稱(以雙引號括住)。報告類型是由發現項目報告、AppScan® Source 報告及自訂報告所組成。

    AppScan® Source 報告類型包括:

    • 發現項目報告:
      • 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 ClassificationSoftware 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:選用。在掃描涵蓋面發現項目的報告中併入追蹤資訊。

回覆值

要求 ID(如果成功)或 -1(如果要求提交不成功)。

範例

  • 以 HTML 檔格式產生發現項目(依 API)報告。在報告中,併入明確發現項目的追蹤資訊:
    ounceauto generatereport -assessment C:\Ounce\Data\Webgoat.ozasmt
    -type "Findings by API" -output html
    -file C:\reports\Webgoat_Findings.html
    -includeTraceDefinitive
  • 如果要以 PDF 格式產生 OWASP Top 10 2013 AppScan® Source 報告:
    ounceauto generatereport -assessment C:\Ounce\Data\Webgoat.ozasmt
    -type "OWASP Top 10 2013" -output pdf-annotated
    -file C:\Reports\Webgoat_OWASP.pdf