レポートビルダー on DefectDojo Documentation

レポートビルダー

Mon, 01 Jan 0001 00:00:00 +0000

注: 再利用可能なレポートビルダー（テーマ、ブロック、テンプレート、および保存された生成済みレポート）はDefectDojo Proの機能であり、現在ベータ版です。

DefectDojo Proのレポートビルダーを使用すると、再利用可能な部品から洗練されたレポートを組み立てることができるため、レポートを毎回ゼロから作り直すのではなく、一度部品を作成してあらゆる場所で再利用できます。サイドバーの**📄 レポート機能**エリアからアクセスできます。

オープンソース版との比較

オープンソース版DefectDojoでは、レポートの作成、実行、出力の取得ができますが、レポートテンプレートの保存や生成したレポートの永続化は行いません。各レポートは一回限りの作業です。

DefectDojo Proは、レポート機能を再利用可能な構成要素に変えます。組み合わせたり再利用したりできるテーマ、ブロック、テンプレートを保存でき、実行した各レポートは、後でダウンロードしたり再実行したりできる生成済みレポートとして永続化されます。また、Proはワークフロー全体を完全なREST APIとして公開しており、LLM支援による作成もサポートしているため、レポートをプログラムで作成・実行できます。

💡 Tip: オープンソース版DefectDojoを使用している場合は、代わりにオープンソース版レポートビルダーを参照してください。

主要な概念

レポートビルダーは4つの構成要素からなり、それぞれが/api/v2/配下のRESTリソースとして利用可能です: report_themes、report_blocks、report_templates、generated_reports。これらがどのように連携するかを理解することが、効率的にレポートを作成するための鍵となります。

APIによるレポートの自動化

Mon, 01 Jan 0001 00:00:00 +0000

注: Report Builder REST API(レポートテーマ、ブロック、テンプレート、生成されたレポート)はDefectDojo Proの機能であり、現在ベータ版です。

Report Builder REST APIを使うと、Report Builder UIで手作業により組み立てるのと同じテーマ、ブロック、テンプレートを自動化できます。さらに一歩進んで、テンプレートを実行し、完成したPDFまたはHTMLをダウンロードすることも可能です。このガイドでは、認証、フィールドとフィルターの語彙の把握、構成要素の作成、そしてレポートの生成と取得という一連の流れを最初から最後まで説明します。

簡易な検出事項エクスポートをお探しですか? テーマ、ブロック、テンプレートを設定せずに、検出事項の単純な一覧をJSON、HTML、CSV、Excelとして取得したいだけなら、Generating Reportsに記載されているよりシンプルな generate_report/ エンドポイントを使用してください。このページで説明するReport Builder APIは、デザインされた複数セクション構成のレポートを構築するためのものです。

LLMを使ったレポート作成

Mon, 01 Jan 0001 00:00:00 +0000

注: REST APIとLLMを使用したレポートビルダーの自動化は、DefectDojo Proの機能であり、現在ベータ版です。

DefectDojo Proのレポートビルダー(テーマ、ブロック、テンプレート)は、REST APIによって完全に駆動されます。つまり、作業全体をLLMに任せることができます。自己完結型のプロンプトを1つ、Claude、ChatGPT、その他の高性能なモデルに貼り付けるだけで、テナントのライブOpenAPIスキーマと field_options を調査し、指定した対象者向けのテーマと再利用可能なブロックライブラリおよびテンプレートを提案し、実行可能なPythonスクリプトを生成した上で、レポートを実行して完成したファイルをダウンロードしてくれます。

パターンはシンプルです。ベースURL、APIトークン、そしてレポートの対象者についての簡単な説明を用意するだけです。LLMが調査、設計、作成、検証、実行、ダウンロードを行いますが、テナントに対して何かを構築する前には、必ずあなたの承認を待って一時停止します。

本ガイドはレポートビルダーAPIガイドと対になっており、LLMが操作する生のリソースとリクエスト形式について説明しています。LLMが生成した内容を理解したり、手動で調整したりしたい場合は、このリファレンスを開いておいてください。

開始する前に

APIトークンを取得する。 DefectDojo Pro UIで、ユーザー設定 → API v2キー に移動し、トークンをコピーします。次に、生成されたスクリプトがチャットにトークンを表示させることなく読み取れるように、環境変数として設定します。

export DD_IMPORTER_DOJO_API_TOKEN=<paste-token-here>

対象者を決める。 LLMはレポートの対象者を尋ねます。一般的な選択肢は次のとおりです。

レポートビルダーの使用

Mon, 01 Jan 0001 00:00:00 +0000

DefectDojoのレポートビルダーを使用すると、一連のコンテンツウィジェットからカスタムレポートを組み立て、実行し、結果をエクスポートできます（たとえば、PDFに印刷するなど）。カスタムレポートは、社外の関係者と共有したい検出事項やエンドポイントをまとめることができ、ブランディングや定型文を含めることもできます。

Note: オープンソース版DefectDojoでは、レポートの作成、実行、出力の取得は一回限りの作業です。レポートのレイアウト（テンプレート）と生成されたレポートの出力は、オープンソース版では保存されません。レイアウトを再利用するには、レポートビルダーで再構築する必要があります。再利用可能なテーマ、ブロック、テンプレートを保存し、生成されたレポートの履歴を永続的に保持するには、DefectDojo Proのレポートビルダーを参照してください。

レポートビルダーを開く

レポートビルダーは、サイドバーの**📄 レポート**ページから開くことができます。

レポートビルダーのページは2つの列で構成されています。左側のレポート形式列でレポートを設計し、右側の利用可能なウィジェット列のウィジェットを使用します。

ステップ1: レポートオプションを設定する

レポートオプションセクションでは、次の操作を行うことができます。

レポートのレポート名を設定する
ユーザーが作成した検出事項のメモをレポートに含める
検出事項の画像をレポートに含める
レポートにヘッダー画像をアップロードする

レポートのヘッダー画像を選択する

レポートの先頭に画像を追加するには、ファイルを選択ボタンをクリックしてDefectDojoに画像をアップロードします。

画像は文書に合わせて自動的にサイズ変更され、レポート名のすぐ上に表示されます。

ステップ2: ウィジェットでコンテンツを追加する

レポートオプションを設定したら、DefectDojoのウィジェットを使用してレポートの設計を開始できます。