burp

インタフェース IScannerCheck

public interface IScannerCheck

拡張はこのインタフェースを実装して、IBurpExtenderCallbacks.registerScannerCheck()を呼び出すと、カスタムScannerチェックを登録できます。スキャンの際、Burpはベースリクエストにアクティブまたはパッシブスキャンを実行するよう依頼し、Scannerが検出した問題を報告します。

メソッドのサマリー

修飾子と型	メソッドと説明
int	consolidateDuplicateIssues(IScanIssue existingIssue, IScanIssue newIssue) Scannerは、カスタムスキャンチェックが同じURLパスで複数の問題を報告したとき、このメソッドを呼び出します。
java.util.List<IScanIssue>	doActiveScan(IHttpRequestResponse baseRequestResponse, IScannerInsertionPoint insertionPoint) Scannerは、アクティブスキャンの際、挿入ポイントごとにこのメソッドを呼び出します。
java.util.List<IScanIssue>	doPassiveScan(IHttpRequestResponse baseRequestResponse) Scannerはパッシブスキャンの際、ベースリクエスト/レスポンスごとにこのメソッドを呼び出します。

メソッドの詳細

doPassiveScan

java.util.List<IScanIssue> doPassiveScan(IHttpRequestResponse baseRequestResponse)

Scannerはパッシブスキャンの際、ベースリクエスト/レスポンスごとにこのメソッドを呼び出します。注: 拡張はパッシブスキャン中に提供されたHTTPメッセージのみを分析すべきで、また独自の新たなHTTPリクエストを生成するべきではありません。

パラメータ:

baseRequestResponse - パッシブスキャンされるベースHTTPリクエスト/レスポンス

戻り値:

IScanIssueオブジェクトのリスト、または問題が見つからない場合はnull。

doActiveScan

java.util.List<IScanIssue> doActiveScan(IHttpRequestResponse baseRequestResponse,
                                        IScannerInsertionPoint insertionPoint)

Scannerは、アクティブスキャンの際、挿入ポイントごとにこのメソッドを呼び出します。拡張はおそらくアクティブスキャンの実行に必要なHTTPリクエストを発行し、特定のペイロードのスキャンリクエストを構築するため提供されるIScannerInsertionPointオブジェクトを使うでしょう。注: スキャンチェックは、エンコードされていない生のペイロードを挿入ポイントに指定する必要があり、挿入ポイントはその性質と場所に応じた適切なエンコードをすべてのデータに対して行う責任があります。

パラメータ:

baseRequestResponse - アクティブスキャンされるベースHTTPリクエスト/レスポンス

insertionPoint - テストされる挿入ポイントの詳細を取得でき、特定のペイロードのスキャンリクエストを構築するために使われるIScannerInsertionPointオブジェクト

戻り値:

IScanIssueオブジェクトのリスト、または問題が見つからない場合はnull。

consolidateDuplicateIssues

int consolidateDuplicateIssues(IScanIssue existingIssue,
                               IScanIssue newIssue)

Scannerは、カスタムスキャンチェックが同じURLパスで複数の問題を報告したとき、このメソッドを呼び出します。これは、個別の脆弱性が複数あるか、または同じ(または類似した)リクエストが複数回スキャンされた場合に発生します。カスタムチェックでは、重複した問題かどうか判断すべきです。ほとんどの場合、それぞれの問題の問題名や説明について、2つの問題で比較して統合するだけの簡単な処理でしょう。

パラメータ:

existingIssue - Scannerが以前報告している問題

newIssue - Scannerが同じURLで新たに報告してきた問題

戻り値:

メインのScanner結果に報告すべきかどうかの指示。既存の問題のみを報告すべき場合は-1、両方とも報告すべき場合は0、新たな問題のみ報告すべき場合は1を返します。