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 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: オプション。スキャン範囲の検出結果のレポートにトレース情報を含めます。

戻り値

要求の実行依頼が正常に実行された場合は要求 ID、正常に実行されなかった場合は -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