report (rpt)

説明

Report は、検出結果レポートや AppScan® Source レポートなど、指定したタイプの AppScan® Source レポートを生成します。このコマンドを使用するには、有効な AppScan® Source for Automation のライセンスが必要です。

使用可能なレポート出力形式は、HTML、PDF、および zip です。

構文

report "<report type>" <output format> <output location>
[<assessment id>] [-includeHowToFix] [-includeSrcBefore:<n>] [-includeSrcAfter:<n>]
[-includeTrace:<definitive|suspect|coverage>]
  • report type: 生成するレポートの名前 (二重引用符で囲む)。以下のいずれかのレポートを指定します。
    • 検出結果レポート:
      • Findings
      • Findings by Fix Group
      • Findings by Type
      • Findings by Classification
      • Findings by File
      • Findings by API
      • Findings by Bundle
      • Findings by CWE
    • AppScan® Source レポート:
      • 2024 CWE Top 25 Most Dangerous Software Weaknesses
      • 2021 CWE Top 25 Most Dangerous Software Weaknesses
      • DISA Application Security and Development STIG V5R3
      • DISA Application Security and Development STIG V6R3
      • 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 V4.0
      • Software Security Profile
    • カスタム・レポート (使用可能な場合)。

    二重引用符で囲んでレポート・タイプを入力する場合、前記リストで指定したとおり正確に入力してください。例えば、Findings by Classification、または Software Security Profile です。

  • output format: このレポートに対して、以下のいずれかの形式を指定します。
    • html: レポートを HTML として生成し、オンラインで表示します。
    • zip: すべての HTML レポート・コンポーネントを含む ZIP ファイルを作成します。
    • PDF 形式のレポートの場合は、以下の詳細レベルを指定できます。
      • pdf-summary: カスタム・レポート・グループごとの件数を含めます。
      • pdf-detailed: 脆弱性プロパティーごとに、各 API の件数を含めます。
      • pdf-comprehensive: API ごとに、すべての検出結果で構成される表を含めます。
      • pdf-annotated: すべての検出結果、検出結果に付属する注、および指定されたコード・スニペットを含めます。
      • output location: レポートを書き込むファイル・パス。
  • output location: レポートの保存先の絶対パスおよびファイル名を指定します。
  • assessment id: オプション。listassess (la) コマンドにより取得する評価 ID。評価 ID を省略すると、レポートは最新のスキャンから生成されます。
  • -includeHowToFix: オプション。結果の対処方法と修正方法に関するアドバイザリー情報を含めます。
  • -includeSrcBefore:<n>: オプション。レポートの各検出結果の前に組み込むソース・コードの行数。
  • -includeSrcAfter:<n>: オプション。レポートの各検出結果の後に組み込むソース・コードの行数。
  • -includeTrace:<definitive|suspect|coverage>: オプション。確定、要確認、またはスキャン範囲の検出結果のレポートにトレース情報を含める (検出結果の分類について詳しくは「分類」を参照してください)。検出結果の複数の分類に関するトレース情報を含めるには、このオプションを複数回指定します。例えば、確定と要確認の検出結果にトレース情報を含めるには、-includeTrace:definitive -includeTrace:suspect と指定します。

例

  • HTML に書き込む Findings by API レポートを要求します。レポートで、確定の検出結果にトレース情報を含めるには以下のようにします。
    AllApplications>> report "Findings by API" html 
C:\reports\findings.html -includeTrace:definitive
  • 既存の評価 542 を使用して広範な詳細情報を PDF に書き込む OWASP Top 10 AppScan® Source レポートを要求する場合の例を以下に示します。
    AllApplications>> report "OWASP Top 10 2021" pdf-comprehensive
/reports/webgoat_OWASP_21_comp.pdf 542