Rules Engine 2.0 on DefectDojo Documentation

Rules Engine 2.0 について

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

注: Rules Engine 2.0 は DefectDojo Pro 専用の機能です。

Rules Engine 2.0 は、ビジュアルな自動化ビルダーです。フィルターとフラットなアクションのリストの代わりに、ルールはグラフとして構成されます。グラフは、ルールがいつ起動するかを決めるトリガーノードと、その後の処理内容を指定する任意の数のロジックノード、Finding ノード、Egress ノードが配線されたものです。

Rules Engine 2.0 には Pro UI からのみアクセスできます。

ルールの作成

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

注: Rules Engine 2.0 は DefectDojo Pro 専用の機能です。

ルールはキャンバス上で構築します。パレットからノードをドラッグして配線し、それぞれをサイドパネルで設定します。このページでは、どのノードを使う場合でも共通するプロセスの部分を扱います。ノード自体については Node Reference を参照してください。

エディター

Rules Engine 2.0 > All Rules を開き、New Rule を選択するか、既存のルールを開いて編集します。

ノードリファレンス

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

注: Rules Engine 2.0 は DefectDojo Pro 限定の機能です。

Rules Engine 2.0には、4つのカテゴリにわたって25個のノードが搭載されています。このページではそのすべてを解説します。

特に断りがない限り、ノードは1つの入力を受け取り、out と呼ばれる1つの出力を生成し、受け取ったすべてのアイテムをその出力へと渡します。これはノードを連結する際に重要です。検出事項ノードは検出事項を変更してからアイテムを次へ渡すため、連続して並んだ複数のノードがすべて適用されます。

トリガー

すべてのグラフにはトリガーがちょうど1つあり、実行を開始できるのはトリガーだけです。3種類のトリガーはすべて検出事項アイテムを生成し、いずれも生成する検出事項を絞り込むScopeを持ちます。スコープの仕組みについてはルールの作成を参照してください。

検出事項イベント時

trigger.finding

実行

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

注: Rules Engine 2.0はDefectDojo Pro限定機能です。

**実行（run）**とは、1つのルールの1回分の実行のことです。成功したか失敗したかにかかわらず、すべての実行が記録され、その内部の各ノードも痕跡を残します。Rules Engine 2.0 > Runsにその一覧が表示されます。

実行が記録する内容

Field	Meaning
Rule	実行されたルール。
Trigger	実行を開始したイベント。例えば`finding.created`、`schedule`、`manual`など。
Triggered by	実行を発生させた人物（人が関与していた場合）。Runボタンを押した人、またはトリガーとなったFindingを保存した人です。スケジュール実行の場合や、インポートやユーザーの関与しないAPI呼び出しなど誰も関与していない変更の場合は空欄になります。これはルールの所有者（実行が誰として実行されたか）とは別のものです。
Status	`Running`、`Success`、`Error`のいずれか。
Started と Finished	実行された日時。Finishedは実行中の間のみ空欄です。
Error	失敗した場合、実行を終了させたエラー。
Stats	ノードごとの合計、カスケードされたイベント、保留中の作業。
Depth	この実行が発生元のイベントから何回のカスケードホップ離れているか。
Source run	カスケードされた実行の場合、発行したイベントによってこの実行をトリガーした実行。

ノードトレース

実行内では、各ノードが自身の行を記録します。

配信

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

注: Rules Engine 2.0 は DefectDojo Pro 限定の機能です。

ルールが生成するすべての送信(アウトバウンド)側の副作用は、配信台帳の1行になります。Rules Engine 2.0 > Deliveries にその一覧が表示されます。

この行はネットワーク呼び出しが発生する前に書き込まれ、送信される(または送信された)内容を正確に保持します。これにより、送信(egress)は「誰かが保存していることを願うログ行」ではなく、監査可能なものになります。また、これが Simulate が別のコードパスではない理由でもあります。シミュレーション送信は、ディスパッチ手順が省略されただけの、同じ行なのです。

Rules Engine からの移行

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

注: Rules Engine 2.0 は DefectDojo Pro 専用の機能です。

両方のエンジンは並行して動作します。Rules Engine 2.0 を有効にしても、既存の Rules Engine のルールには何の変更もなく、それらを移行しなければならない期限もありません。

実際に移行したくなったときのために、converter(変換ツール)が用意されています。これは、Rules Engine のルール(フィルターと順序付けられたアクションのリスト)を、それと同等の Rules Engine 2.0 のグラフに変換します。

設定

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

注: Rules Engine 2.0 は DefectDojo Pro 専用の機能です。

Rules Engine 2.0 は、そのままの状態で動作します。このページの設定は、スループット、保持期間、または送信先ネットワークポリシーを調整する必要があるデプロイメント向けのものです。これらはすべて、他の DefectDojo の設定と同じ方法で適用されます(設定を参照)。

Rules Engine 2.0 は、従来の Rules Engine とは別に設定されます。両エンジンの間でチューニングは共有されないため、DD_RULES_ENGINE_* の設定は Rules Engine 2.0 に影響を与えず、DD_RULES_V2_* の設定は従来のエンジンに影響を与えません。