Triage Engine on DefectDojo Documentation

Triage Engine について

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

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

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

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

ルールの作成

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

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

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

エディター

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

ノードリファレンス

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

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

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

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

トリガー

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

検出事項イベント時

trigger.finding

検出事項が作成、更新、クローズ、または再オープンされたときに実行されます。

設定	デフォルト	備考
Event	`created`	このルールを起動させる検出事項の変更種別: `created`、`updated`、`closed`、`reopened`、またはこの4つすべてを対象とする `any`。
Scope	空	このルールが対象とする検出事項。空の場合は、ルールの所有者が閲覧できるすべての検出事項が対象になります。

イベントによって指定された検出事項は、グラフに入る前にスコープと照合されます。つまりイベントがいつを決定し、スコープがどれを決定します。

実行

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

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

**実行（run）**とは、1つのルールの1回分の実行のことです。成功したか失敗したかにかかわらず、すべての実行が記録され、その内部の各ノードも痕跡を残します。Triage Engine > 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

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

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

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

配信が記録する項目

フィールド	意味
Run と Node	どの実行(Run)とどの送信ノード(Node)がこれを生成したか。
Finding	検出事項単位の送信の場合、対象となる検出事項。バッチ送信の場合はグループを記録します。
Channel	送信の種類。
Target	解決済みの送信先: JIRAプロジェクトキー、チャネル、URL、アドレスなど。
Title	送信内容の一行説明。
Payload	送信される(または送信された)内容そのもの。
Mode	`simulate` または `live`。
Status	配信がどこまで到達したか。
Attempts	これまでに試行された送信回数と、許容される最大回数。
Last error	直前の試行が失敗した理由、または配信がスキップされた理由。
Response	送信先から返された応答。
External reference と URL	送信先が返したチケットキー、メッセージID、ファイルパスと、存在する場合はそこへのリンク。

チャネル

チャネル	生成元
JIRA	JIRA課題を作成
Downstream connector	ダウンストリームチケットを作成
Slack	Slackメッセージを送信、およびSlackへ送信されるレポート通知
Microsoft Teams	Microsoft Teamsメッセージを送信
Email	メールを送信、およびメールで送信されるレポート通知
Webhook	Webhookを呼び出す
Report	レポートを生成
In-app alert	アプリ内アラートを発行

ステータス

ステータス	意味
`simulated`	ルールが Simulate モードだったことを示します。何も送信されておらず、今後も送信されません。
`skipped`	既に何かがこの送信をカバーしていたか、ゲーティングによって拒否されたことを示します。理由は last error フィールドに記載されます。
`pending`	Live モードで記録され、配信タスクの実行を待っている状態です。
`dispatched`	統合サービスに引き渡され、確認を待っている状態です。
`sent`	配信が確認された状態です。
`failed`	4xxエラーやベンダー側のエラーなど、恒久的に拒否された状態です。再送可能です。
`dead`	再試行が尽きたか、確認が一度も届かなかった状態です。再送可能です。

skipped については詳しく説明する価値があります。スキップは黙って無視されるのではなく記録されます。なぜなら「ルールは何もしなかった」ことと「この検出事項には既にチケットがあったためルールは何もしなかった」ことは異なる答えであり、そのうち一方だけが問題だからです。

Rules Engine からの移行

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

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

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

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

設定

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

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

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

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