GenerateReport

說明

從評量建立報告。

語法

ounceauto GenerateReport
-assessment <assessment path>
-type <report type>
-output <output format>
-file <output location>
[-caller <caller>]
[-classificationDefinitive]
[-classificationSuspect] 
[-classificationCoverage]
[-includeHowToFix]
[-includeSrcBefore <n>]
[-includeSrcAfter <n>]
[-includeTraceDefinitive]
[-includeTraceSuspect]
[-includeTraceCoverage]
[-severityHigh]
[-severityMedium] 
[-severityLow] 
[-severityInfo] 
  • -assessment <assessment path>:您要產生報告之評量檔的路徑。
  • -type "<report type>":報告類型的名稱(以雙引號括住)。報告類型是由發現項目報告、AppScan® Source 報告及自訂報告所組成。

    AppScan® Source報告類型包括:

    • 發現項目報告:
      • 發現項目
      • 依修正群組分類的發現項目
      • 發現項目(依類型)
      • 發現項目(依分類)
      • 發現項目(依檔案)
      • 發現項目(依 API)
      • 發現項目(依組合)
      • 依 CWE 分類的發現項目
    • AppScan® Source 報告:
      • 2024 CWE 前 25 大最危險的軟體弱點
      • 2025 CWE 前 25 大最危險的軟體弱點
      • DISA Application Security and Development STIG V5R3
      • DISA Application Security and Development STIG V6R3
      • OWASP API 安全性十大 2023
      • OWASP 前 10 大 API 安全性 2019
      • OWASP Mobile Top 10
      • 2021 年 OWASP 前 10 位
      • OWASP 2025 年前十大
      • PCI Data Security Standard V4.0
      • 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 日誌檔。
  • -classificationDefinitive:選用。篩選確定的發現項目。
  • -classificationSuspect:選用。篩選可疑的發現項目。
  • -classificationCoverage:選用。篩選掃描涵蓋範圍的發現項目。
  • -includeHowToFix:選用。包括有關如何處理和更正發現項目的諮詢資訊。
  • -includeSrcBefore <n>:選用。要包括在每一個發現項目之前的原始碼行數。
  • -includeSrcAfter <n>:選用。要包括在每一個發現項目之後的原始碼行數。
  • -includeTraceDefinitive:選用。在明確發現項目的報告中併入追蹤資訊(請參閱 分類 以瞭解發現項目分類)。
  • -includeTraceSuspect:選用。在可疑發現項目的報告中併入追蹤資訊。
  • -includeTraceCoverage:選用。在掃描涵蓋面發現項目的報告中併入追蹤資訊。
  • -severityHigh:選用。篩選高嚴重性的發現項目。
  • -severityMedium:選用。篩選中嚴重性的發現項目。
  • -severityLow:選用。篩選低嚴重性的發現項目。
  • -severityInfo:選用。篩選參考資訊嚴重性的發現項目。

返回值

如果成功,則為要求 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