burp

インタフェース IMessageEditorTab

public interface IMessageEditorTab

IMessageEditorTabFactoryに登録される拡張は、このインタフェースのインスタンスを返す必要があり、そのHTTPメッセージエディタにカスタムタブを生成する際にBurpが使用します。

メソッドのサマリー

修飾子と型	メソッドと説明
byte[]	getMessage() 現在表示されているメッセージを返します。
byte[]	getSelectedData() ユーザによって現在選択されているデータを取得します。
java.lang.String	getTabCaption() カスタムタブが表示された際の表示名を返します。
java.awt.Component	getUiComponent() 表示される際にカスタムタブのコンテンツとして使用されるコンポーネントを返します。
boolean	isEnabled(byte[] content, boolean isRequest) 新規HTTPメッセージを表示する前にエディタはこのメソッドを呼び出し、そのメッセージに対してカスタムタブが有効かどうか示します。
boolean	isModified() 現在表示されているメッセージがユーザによって変更されているかどうかを判断します。
void	setMessage(byte[] content, boolean isRequest) 新規メッセージを表示する際、または既存のメッセージをクリアする際に、エディタがこのメソッドを呼び出します。

メソッドの詳細

getTabCaption

java.lang.String getTabCaption()

カスタムタブが表示された際の表示名を返します。注: Burpは、タブが最初に生成されるときに一度だけこのメソッド呼び出し、タブが表示される度に同じ表示名が使われます。

戻り値:

カスタムタブが表示された際の表示名。

getUiComponent

java.awt.Component getUiComponent()

表示される際にカスタムタブのコンテンツとして使用されるコンポーネントを返します。注: Burpは、タブが最初に生成されるときに一度だけこのメソッド呼び出し、タブが表示される度に同じコンポーネントが使われます。

戻り値:

表示される際にカスタムタブのコンテンツとして使用されるコンポーネント。

isEnabled

boolean isEnabled(byte[] content,
                  boolean isRequest)

新規HTTPメッセージを表示する前にエディタはこのメソッドを呼び出し、そのメッセージに対してカスタムタブが有効かどうか示します。

パラメータ:

content - 表示しようとしているメッセージ、または既存のメッセージをクリアする場合は長さ0の配列。

isRequest - メッセージがリクエストかレスポンスかを示すフラグ。

戻り値:

カスタムタブが指定したメッセージを処理し、エディタ内で表示できる場合はtrueを返します。それ以外の場合、このメッセージが表示されている間タブは非表示になります。

setMessage

void setMessage(byte[] content,
                boolean isRequest)

新規メッセージを表示する際、または既存のメッセージをクリアする際に、エディタがこのメソッドを呼び出します。同じメッセージ詳細を指定してisEnabled()が呼び出され既にtrueが返っている場合、新しいメッセージでこのメソッドが呼び出されるだけになります。

パラメータ:

content - 表示するメッセージ、またはコンテンツをクリアして編集可能なコントロールを無効にする場合はnull。

isRequest - メッセージがリクエストかレスポンスかを示すフラグ。

getMessage

byte[] getMessage()

現在表示されているメッセージを返します。

戻り値:

現在表示されているメッセージ。

isModified

boolean isModified()

現在表示されているメッセージがユーザによって変更されているかどうかを判断します。エディタはこのメソッドを呼び出す前に常にgetMessage()を呼び出し、保留中の編集内容をgetMessage()内で完了させます。

戻り値:

最初に表示された後ユーザがこのメッセージを編集した場合はtrueを返します。

getSelectedData

byte[] getSelectedData()

ユーザによって現在選択されているデータを取得します。

戻り値:

ユーザが現在選択しているデータ。現在選択されていない場合はnullになります。