IExtensionHelpers

```
public interface IExtensionHelpers
```
Buurp拡張で起こるさまざまな一般的なタスクの支援に便利な、数々のヘルパーメソッドが含あります。拡張からIBurpExtenderCallbacks.getHelpersを呼び出すと、このインタフェースのインスタンスを取得できます。

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド
修飾子と型	メソッドと説明
`byte[]`	`addParameter(byte[] request, IParameter parameter)` HTTPリクエストに新しいパラメータを追加し、必要に応じてContent-Lengthヘッダを更新します。
`IRequestInfo`	`analyzeRequest(byte[] request)` HTTPリクエストを分析し、それについて各種のキーの詳細を取得します。
`IRequestInfo`	`analyzeRequest(IHttpRequestResponse request)` HTTPリクエストを分析し、それについて各種のキーの詳細を取得します。
`IRequestInfo`	`analyzeRequest(IHttpService httpService, byte[] request)` HTTPリクエストを分析し、それについて各種のキーの詳細を取得します。
`IResponseInfo`	`analyzeResponse(byte[] response)` HTTPレスポンスを分析し、それについて各種のキーの詳細を取得します。
`IResponseKeywords`	`analyzeResponseKeywords(java.util.List<java.lang.String> keywords, byte[]... responses)` 1つ以上のレスポンスを分析して指定したキーワードの出現回数を調べ、各キーワードの出現回数の詳細を取得できる`IResponseKeywords`オブジェクトを返します。
`IResponseVariations`	`analyzeResponseVariations(byte[]... responses)` 1つ以上のレスポンスを分析して属性の種類数を調べ、その種類の出現回数を取得できる`IResponseVariations`オブジェクトを返します。
`byte[]`	`base64Decode(byte[] data)` 指定されたデータをBase64デコードします。
`byte[]`	`base64Decode(java.lang.String data)` 指定されたデータをBase64デコードします。
`java.lang.String`	`base64Encode(byte[] data)` 指定されたデータをBase64エンコードします。
`java.lang.String`	`base64Encode(java.lang.String data)` 指定されたデータをBase64エンコードします。
`IHttpHeader`	`buildHeader(java.lang.String name, java.lang.String value)` 指定された詳細情報に基づいて`IHttpHeader`オブジェクトを構築します。
`byte[]`	`buildHttpMessage(java.util.List<java.lang.String> headers, byte[] body)` 指定されたヘッダとメッセージ本文を含むHTTPメッセージを構築します。
`byte[]`	`buildHttpRequest(java.net.URL url)` 指定されたURLへの GET リクエストを作成します。
`IHttpService`	`buildHttpService(java.lang.String host, int port, boolean useHttps)` 指定された詳細情報に基づいて`IHttpService`オブジェクトを構築します。
`IHttpService`	`buildHttpService(java.lang.String host, int port, java.lang.String protocol)` 指定された詳細情報に基づいて`IHttpService`オブジェクトを構築します。
`IParameter`	`buildParameter(java.lang.String name, java.lang.String value, byte type)` 指定された詳細情報に基づいて`IParameter`オブジェクトを構築します。
`java.lang.String`	`bytesToString(byte[] data)` バイト配列から文字列形式にデータを変換します。
`IParameter`	`getRequestParameter(byte[] request, java.lang.String parameterName)` HTTPリクエスト内の指定したパラメータの詳細を取得します。
`int`	`indexOf(byte[] data, byte[] pattern, boolean caseSensitive, int from, int to)` 指定したパターンがデータ内で最初に出現する部分を検索します。
`IScannerInsertionPoint`	`makeScannerInsertionPoint(java.lang.String insertionPointName, byte[] baseRequest, int from, int to)` 指定された詳細に基づいて`IScannerInsertionPoint`オブジェクトを構築します。
`byte[]`	`removeParameter(byte[] request, IParameter parameter)` HTTPリクエストからパラメータを削除し、必要に応じてContent-Lengthヘッダを更新します。
`byte[]`	`stringToBytes(java.lang.String data)` データを文字列からバイト配列に変換します。
`byte[]`	`toggleRequestMethod(byte[] request)` リクエストのメソッドのGETとPOSTを切り替えます。
`byte[]`	`updateParameter(byte[] request, IParameter parameter)` HTTPリクエスト内のパラメータ値を更新し、必要に応じてContent-Lengthヘッダを更新します。
`byte[]`	`urlDecode(byte[] data)` 指定したデータをURLデコードします。
`java.lang.String`	`urlDecode(java.lang.String data)` 指定したデータをURLデコードします。
`byte[]`	`urlEncode(byte[] data)` 指定したデータをURLエンコードします。
`java.lang.String`	`urlEncode(java.lang.String data)` 指定したデータをURLエンコードします。

- メソッドの詳細
  - analyzeRequest
```
IRequestInfo analyzeRequest(IHttpRequestResponse request)
```
    HTTPリクエストを分析し、それについて各種のキーの詳細を取得します。
    
    パラメータ:
    
    request - 分析するリクエストを含んだIHttpRequestResponseオブジェクト。
    
    戻り値:
    
    リクエストの詳細を取得できるIRequestInfoオブジェクト。
  - analyzeRequest
```
IRequestInfo analyzeRequest(IHttpService httpService,
                            byte[] request)
```
    HTTPリクエストを分析し、それについて各種のキーの詳細を取得します。
    
    パラメータ:
    
    httpService - リクエストに関連付けられたHTTPサービス。これはオプションで、nullの場合はIRequestInfoオブジェクトは完全なリクエストURLを持ちません。
    
    request - 分析するリクエスト。
    
    戻り値:
    
    リクエストの詳細を取得できるIRequestInfoオブジェクト。
  - analyzeRequest
```
IRequestInfo analyzeRequest(byte[] request)
```
    HTTPリクエストを分析し、それについて各種のキーの詳細を取得します。結果のIRequestInfoオブジェクトは、完全なURLを持ちません。完全なURLを取得するには、analyzeRequest()をオーバーロードした他のメソッドを使用してください。
    
    パラメータ:
    
    request - 分析するリクエスト。
    
    戻り値:
    
    リクエストの詳細を取得できるIRequestInfoオブジェクト。
  - analyzeResponse
```
IResponseInfo analyzeResponse(byte[] response)
```
    HTTPレスポンスを分析し、それについて各種のキーの詳細を取得します。
    
    パラメータ:
    
    response - 分析するレスポンス。
    
    戻り値:
    
    レスポンスの詳細を取得できるIResponseInfoオブジェクト。
  - getRequestParameter
```
IParameter getRequestParameter(byte[] request,
                               java.lang.String parameterName)
```
    HTTPリクエスト内の指定したパラメータの詳細を取得します。注: リクエスト内の全パラメータの詳細を取得するには、analyzeRequest()を使用してください。
    
    パラメータ:
    
    request - 指定したパラメータを検査するリクエスト。
    
    parameterName - 取得するパラメータの名前。
    
    戻り値:
    
    パラメータの詳細を取得できるIParameterオブジェクト、またはパラメータが存在しない場合はnull。
  - urlDecode
```
java.lang.String urlDecode(java.lang.String data)
```
    指定したデータをURLデコードします。
    
    パラメータ:
    
    data - デコードするデータ。
    
    戻り値:
    
    デコードされたデータ。
  - urlEncode
```
java.lang.String urlEncode(java.lang.String data)
```
    指定したデータをURLエンコードします。HTTPリクエスト内でエンコードする必要がない文字は、エンコードされません。
    
    パラメータ:
    
    data - エンコードするデータ。
    
    戻り値:
    
    エンコードされたデータ。
  - urlDecode
```
byte[] urlDecode(byte[] data)
```
    指定したデータをURLデコードします。
    
    パラメータ:
    
    data - デコードするデータ。
    
    戻り値:
    
    デコードされたデータ。
  - urlEncode
```
byte[] urlEncode(byte[] data)
```
    指定したデータをURLエンコードします。HTTPリクエスト内でエンコードする必要がない文字は、エンコードされません。
    
    パラメータ:
    
    data - エンコードするデータ。
    
    戻り値:
    
    エンコードされたデータ。
  - base64Decode
```
byte[] base64Decode(java.lang.String data)
```
    指定されたデータをBase64デコードします。
    
    パラメータ:
    
    data - デコードするデータ。
    
    戻り値:
    
    デコードされたデータ。
  - base64Decode
```
byte[] base64Decode(byte[] data)
```
    指定されたデータをBase64デコードします。
    
    パラメータ:
    
    data - デコードするデータ。
    
    戻り値:
    
    デコードされたデータ。
  - base64Encode
```
java.lang.String base64Encode(java.lang.String data)
```
    指定されたデータをBase64エンコードします。
    
    パラメータ:
    
    data - エンコードするデータ。
    
    戻り値:
    
    エンコードされたデータ。
  - base64Encode
```
java.lang.String base64Encode(byte[] data)
```
    指定されたデータをBase64エンコードします。
    
    パラメータ:
    
    data - エンコードするデータ。
    
    戻り値:
    
    エンコードされたデータ。
  - stringToBytes
```
byte[] stringToBytes(java.lang.String data)
```
    データを文字列からバイト配列に変換します。特定の文字セットは変換に反映されず、16進数で0xWXYZの文字は常に0xYZを表すバイトに変換されます。bytesToString()メソッドとは反対の変換を行い、この二つのメソッドを使い文字列に変換したバイトベースのデータとそれを戻したデータは、完全性の維持が保証されます(ただし指定された文字セットを反映する変換では当てはまりません)。
    
    パラメータ:
    
    data - 変換するデータ。
    
    戻り値:
    
    変換されたデータ。
  - bytesToString
```
java.lang.String bytesToString(byte[] data)
```
    バイト配列から文字列形式にデータを変換します。特定の文字セットは変換に反映されず、16進数で0xYZの文字は常に0x00YZを表すバイトに変換されます。stringToBytes()メソッドとは反対の変換を行い、この二つのメソッドを使い文字列に変換したバイトベースのデータとそれを戻したデータは、完全性の維持が保証されます(ただし指定された文字セットを反映する変換では当てはまりません)。
    
    パラメータ:
    
    data - 変換するデータ。
    
    戻り値:
    
    変換されたデータ。
  - indexOf
```
int indexOf(byte[] data,
            byte[] pattern,
            boolean caseSensitive,
            int from,
            int to)
```
    指定したパターンがデータ内で最初に出現する部分を検索します。文字列ベースのデータに対して動作するJavaのネイティブメソッド String.indexOf()と同じように、バイトベースのデータで動作します。
    
    パラメータ:
    
    data - 検索するデータ。
    
    pattern - 検索するパターン。
    
    caseSensitive - 検索で大文字小文字を区別するかどうかのフラグ。
    
    from - 検索を開始するdataのオフセット。
    
    to - 検索を終了するdataのオフセット。
    
    戻り値:
    
    指定された範囲で最初にパターンが出現したオフセット、または見つからない場合は-1。
  - buildHttpMessage
```
byte[] buildHttpMessage(java.util.List<java.lang.String> headers,
                        byte[] body)
```
    指定されたヘッダとメッセージ本文を含むHTTPメッセージを構築します。必要に応じて、ボディの長さに基づいてContent-Lengthヘッダが追加または更新されます。
    
    パラメータ:
    
    headers - メッセージに含めるヘッダのリスト。
    
    body - メッセージのボディ、ない場合はnull。
    
    戻り値:
    
    結果として得られる完全なHTTPメッセージ。
  - buildHttpRequest
```
byte[] buildHttpRequest(java.net.URL url)
```
    指定されたURLへの GET リクエストを作成します。リクエストで使用されるヘッダは、Burp Spiderのオプションのリクエストヘッダ設定の定義を使用します。
    
    パラメータ:
    
    url - リクエストを作成するURL。
    
    戻り値:
    
    指定したURLへのリクエスト。
  - addParameter
```
byte[] addParameter(byte[] request,
                    IParameter parameter)
```
    HTTPリクエストに新しいパラメータを追加し、必要に応じてContent-Lengthヘッダを更新します。
    
    パラメータ:
    
    request - パラメータを追加するリクエスト。
    
    parameter - 追加するパラメータの詳細を含んだIParameterオブジェクト。サポートしているパラメータ形式は次の通りです: PARAM_URL、PARAM_BODY、PARAM_COOKIE。
    
    戻り値:
    
    新しいパラメータが追加された新規HTTPリクエスト。
  - removeParameter
```
byte[] removeParameter(byte[] request,
                       IParameter parameter)
```
    HTTPリクエストからパラメータを削除し、必要に応じてContent-Lengthヘッダを更新します。
    
    パラメータ:
    
    request - パラメータを削除するリクエスト。
    
    parameter - 削除するパラメータの詳細を含んだIParameterオブジェクト。サポートしているパラメータ形式は次の通りです: PARAM_URL、PARAM_BODY、PARAM_COOKIE。
    
    戻り値:
    
    パラメータが削除された新規HTTPリクエスト。
  - updateParameter
```
byte[] updateParameter(byte[] request,
                       IParameter parameter)
```
    HTTPリクエスト内のパラメータ値を更新し、必要に応じてContent-Lengthヘッダを更新します。注: このメソッドは、指定されたタイプのパラメータが存在する場合のみ使用できます。既存のパラメータのタイプを変更する必要がある場合は、まずremoveParameter()を呼び出して古いタイプのパラメータを削除し、その後addParameter()を呼び出して新しいタイプのパラメータを追加してください。
    
    パラメータ:
    
    request - 更新するパラメータを含んだリクエスト。
    
    parameter - 更新するパラメータの詳細を含んだIParameter オブジェクト。サポートしているパラメータ形式は次の通りです: PARAM_URL、PARAM_BODY、PARAM_COOKIE。
    
    戻り値:
    
    パラメータが更新された新規HTTPリクエスト。
  - toggleRequestMethod
```
byte[] toggleRequestMethod(byte[] request)
```
    リクエストのメソッドのGETとPOSTを切り替えます。必要に応じてパラメータは、URLクエリーストリングとメッセージボディ間で再配置され、Content-Lengthヘッダは適切に作成または削除されます。
    
    パラメータ:
    
    request - メソッドを切り替えるHTTPリクエスト。
    
    戻り値:
    
    メソッドが切り替えられた新規HTTPリクエスト。
  - buildHttpService
```
IHttpService buildHttpService(java.lang.String host,
                              int port,
                              java.lang.String protocol)
```
    指定された詳細情報に基づいてIHttpServiceオブジェクトを構築します。
    
    パラメータ:
    
    host - HTTPサービスホスト。
    
    port - HTTPサービスポート。
    
    protocol - HTTPサービスプロトコル。
    
    戻り値:
    
    指定された詳細に基づくIHttpServiceオブジェクト。
  - buildHttpService
```
IHttpService buildHttpService(java.lang.String host,
                              int port,
                              boolean useHttps)
```
    指定された詳細情報に基づいてIHttpServiceオブジェクトを構築します。
    
    パラメータ:
    
    host - HTTPサービスホスト。
    
    port - HTTPサービスポート。
    
    useHttps - HTTPサービスプロトコルにHTTPSかHTTPを使用するかどうかのフラグ。
    
    戻り値:
    
    指定された詳細に基づくIHttpServiceオブジェクト。
  - buildParameter
```
IParameter buildParameter(java.lang.String name,
                          java.lang.String value,
                          byte type)
```
    指定された詳細情報に基づいてIParameterオブジェクトを構築します。
    
    パラメータ:
    
    name - パラメータ名。
    
    value - パラメータ値。
    
    type - IParameterインタフェースで定義されている、パラメータタイプ。
    
    戻り値:
    
    指定された詳細に基づくIParameterオブジェクト。
  - buildHeader
```
IHttpHeader buildHeader(java.lang.String name,
                        java.lang.String value)
```
    指定された詳細情報に基づいてIHttpHeaderオブジェクトを構築します。
    
    パラメータ:
    
    name - ヘッダ名。
    
    value - ヘッダ値。
    
    戻り値:
    
    指定された詳細に基づくIHttpHeaderオブジェクト。
  - makeScannerInsertionPoint
```
IScannerInsertionPoint makeScannerInsertionPoint(java.lang.String insertionPointName,
                                                 byte[] baseRequest,
                                                 int from,
                                                 int to)
```
    指定された詳細に基づいてIScannerInsertionPointオブジェクトを構築します。ベースリクエスト内の固定位置にペイロードを配置した単純な挿入ポイントを素早く作成する場合に使用します。
    
    パラメータ:
    
    insertionPointName - 挿入ポイントの名前。
    
    baseRequest - スキャンリクエストを作成するリクエスト。
    
    from - ペイロードポジションの開始オフセット。
    
    to - ペイロードポジションの終了オフセット。
    
    戻り値:
    
    指定した詳細に基づくIScannerInsertionPointオブジェクト。
  - analyzeResponseVariations
```
IResponseVariations analyzeResponseVariations(byte[]... responses)
```
    1つ以上のレスポンスを分析して属性の種類数を調べ、その種類の出現回数を取得できるIResponseVariationsオブジェクトを返します。
    
    パラメータ:
    
    responses - 分析するレスポンス。
    
    戻り値:
    
    レスポンスの変化を表すIResponseVariationsオブジェクト。
  - analyzeResponseKeywords
```
IResponseKeywords analyzeResponseKeywords(java.util.List<java.lang.String> keywords,
                                          byte[]... responses)
```
    1つ以上のレスポンスを分析して指定したキーワードの出現回数を調べ、各キーワードの出現回数の詳細を取得できるIResponseKeywordsオブジェクトを返します。
    
    パラメータ:
    
    keywords - 検索するキーワード。
    
    responses - 分析するレスポンス。
    
    戻り値:
    
    レスポンス内にキーワードが出現した回数を表すIResponseKeywordsオブジェクト。

インタフェース IExtensionHelpers

メソッドのサマリー

メソッドの詳細

analyzeRequest

analyzeRequest

analyzeRequest

analyzeResponse

getRequestParameter

urlDecode

urlEncode

urlDecode

urlEncode

base64Decode

base64Decode

base64Encode

base64Encode

stringToBytes

bytesToString

indexOf

buildHttpMessage

buildHttpRequest

addParameter

removeParameter

updateParameter

toggleRequestMethod

buildHttpService

buildHttpService

buildParameter

buildHeader

makeScannerInsertionPoint

analyzeResponseVariations

analyzeResponseKeywords