top of page

トップ / コラム / Burp Suite の拡張機能を作ってみた — API ドキュメントの読み方から Montoya API で動かすまで

Column

コラム

対策・診断ガイド公開日 2024.09.16 更新日 2026.10.06

Burp Suite の拡張機能を作ってみた — API ドキュメントの読み方から Montoya API で動かすまで

Burp Suite ペネトレーションテスト ツール開発

目次

  1. 参考にした資料と想定読者

  2. 開発環境の準備

  3. プロジェクトの作成

  4. 拡張機能のコードを書く

  5. テスト

  6. おわりに

この記事では、プログラミングを本業としない筆者が、Burp Suite の拡張機能を作るために API ドキュメントと格闘した手順を紹介します。ペネトレーションテスターや脆弱性診断士として、プログラミング言語はある程度わかるけれども、API のドキュメントを見てもどう使えばいいのかさっぱりわからない、という方の参考になれば幸いです。

題材として、「自分が登録したパスワードが HTTP レスポンスの中に現れたら知らせる」という拡張機能を作ります。拡張機能の作り方や API の仕様は、2026年10月時点の PortSwigger 公式ドキュメントと Montoya API の Javadoc にもとづいて確認しています。

参考にした資料と想定読者

筆者は主に次の2つを参考にして拡張機能を書き始めました。

  1. The Cyber Mentors「Burp Extension Development Part 1: Setup & Basics」(YouTube):拡張機能開発の入門動画で、とてもわかりやすい内容です。

  2. Montoya API の Javadoc:Burp Suite の拡張機能向け API(Montoya API)のリファレンスです。

筆者は、仕事の効率化のために見よう見まねでプログラムを書くことはあっても、API のドキュメントを読むことはほとんどありませんでした。1の動画は問題なく理解できるものの、自分がやりたいことのために2をどう使えばいいのかがわからない、という状態でした。この記事も、同じような状況の方を想定しています。

開発環境の準備

開発環境の準備は、参考資料1や PortSwigger の公式ドキュメントに詳しく書かれています。大まかな流れは次のとおりです。

  1. Java の JDK をインストールする。Burp が対応しているのは Java 21 以下で書かれた拡張機能なので、JDK 21 を使います(例:sudo apt install openjdk-21-jdk)。

  2. Java の統合開発環境をインストールする。PortSwigger は無料で使える IntelliJ IDEA を推奨しています(2025.3 以降、Community Edition は単独では配布されず、統合版の IntelliJ IDEA で、これまでの Community Edition の機能をサブスクリプションなしで無料で使えます)。

なお、Burp Suite 本体のバージョンが古いと、新しい API を使った拡張機能が正しく動かない場合があります。Burp Suite も適宜アップデートしておきましょう。

PortSwigger は、依存関係などを設定済みのスタータープロジェクト(Gradle)も用意しています。手早く始めたい場合はこちらを使うのも手です。この記事では、参考資料1にならって Maven のプロジェクトを手作業で作ります。

プロジェクトの作成

IntelliJ IDEA で新しいプロジェクトを作ります。ここでは Language を Java、Build system を Maven、JDK を 21 にしました。

IntelliJ IDEA の New Project 画面。Language に Java、Build system に Maven、JDK に 21 を選んでいる
IntelliJ IDEA の新規プロジェクト作成画面

次に、pom.xml の <dependencies> に Montoya API を追加します。これで、プロジェクトから Montoya API を通じて Burp Suite の機能を使えるようになります。

<dependencies>
  <dependency>
    <groupId>net.portswigger.burp.extensions</groupId>
    <artifactId>montoya-api</artifactId>
    <version>LATEST-VERSION</version>
  </dependency>
</dependencies>

LATEST-VERSION の部分は、Montoya API の GitHub のリリースページで最新のバージョン番号を確かめて書き換えます。依存関係を追記すると、エディタの右上に Maven の再読み込みボタン(青地の m に更新マーク)が表示されるので、クリックして反映します。

拡張機能のコードを書く

いよいよ拡張機能の中身を書いていきます。参考資料1をベースにしつつ、API のドキュメントを手がかりに、やりたいことをどう実現したかを中心に説明します。

API オブジェクトを保持するクラス

まず、src/main/java を右クリックし、New → Java Class から MAPI というクラスを作ります。このクラスは、拡張機能の起動時に Burp から受け取る MontoyaApi オブジェクトを1つだけ保持しておく役割を持ちます(シングルトン)。詳しくは参考資料1をご覧ください。

import burp.api.montoya.MontoyaApi;

public class MAPI {
    private static MontoyaApi INSTANCE;

    private MAPI() {}

    public static void initialize(MontoyaApi api) {
        if (INSTANCE == null) {
            INSTANCE = api;
        }
    }

    public static MontoyaApi getAPI() {
        return INSTANCE;
    }
}

拡張機能の入り口になるクラス

次に、BurpExtension インターフェースを実装した ClearTextPasswdFinder クラスを作ります。Burp Suite で拡張機能を読み込むと、この initialize メソッドが実行されます。拡張機能の名前の設定やログの出力など、基本的な処理をここに書きます。ここまでは、拡張機能を作るときのお決まりの部分です。

import burp.api.montoya.BurpExtension;
import burp.api.montoya.MontoyaApi;

public class ClearTextPasswdFinder implements BurpExtension {
    @Override
    public void initialize(MontoyaApi montoyaApi) {
        MAPI.initialize(montoyaApi);
        MAPI.getAPI().extension().setName("Cleartext Password Finder");

        // 学習用のため直書きしている。実際の利用では避けること
        String password = "c56kpyvMs!";
        MAPI.getAPI().logging().logToOutput("[*] Looking for password \"" + password + "\" in HTTP responses.");

        HttpAnalyzer handler = new HttpAnalyzer();
        MAPI.getAPI().http().registerHttpHandler(handler);
    }
}

レスポンスの中身を調べるには、参考資料1によると、HTTP ハンドラ(HttpHandler)を作って API に登録すればよいようです。そこで、上のように HttpAnalyzer という仮の名前のクラスを登録する2行を書いてみました。検索するパスワードもここで変数に入れています。パスワードをコードに直書きすることになるので、学習用以外では避けたほうが賢明です。

IDE のエラーを手がかりにクラスを作る

この時点では、HttpAnalyzer の部分が赤く表示されます。カーソルを合わせると、当然ながら「シンボル HttpAnalyzer を解決できません(クラスが見つかりません)」というエラーが出ます。そこで Alt+Enter を押すと解決策がいくつか表示されるので、HttpAnalyzer クラスの作成を選びます。

クラスができると、今度は registerHttpHandler(handler) の handler に赤い波線が付きます。エラーの内容を見ると、HttpHandler を受け取るはずのところに HttpAnalyzer を渡していることが原因だとわかります。もう一度 Alt+Enter を押すと「HttpAnalyzer に HttpHandler を実装させる」という選択肢が出るので、そのまま実行します。

すると、HttpAnalyzer に2つのメソッドが追加されます。メソッド名から、それぞれリクエストとレスポンスに対する処理を定義するものだと推測できます。

import burp.api.montoya.http.handler.*;

public class HttpAnalyzer implements HttpHandler {
    @Override
    public RequestToBeSentAction handleHttpRequestToBeSent(HttpRequestToBeSent httpRequestToBeSent) {
        return null;
    }

    @Override
    public ResponseReceivedAction handleHttpResponseReceived(HttpResponseReceived httpResponseReceived) {
        return null;
    }
}

Javadoc を見ると、handleHttpRequestToBeSent はリクエストが送信される直前に、handleHttpResponseReceived はレスポンスを受信したときに、Burp から呼び出されるメソッドです。どちらも戻り値として「このあとどうするか」を表すオブジェクト(RequestToBeSentAction や ResponseReceivedAction)を返すことになっています。自動生成された return null; のままにせず、後で直します。

Javadoc をたどってレスポンスを調べる

今回はレスポンスを調べたいので、handleHttpResponseReceived を編集します。HttpHandler の Javadoc を読んでも、どうすればレスポンスを調べられるのかはわかりません。そこで、引数の型である HttpResponseReceived を見てみると、cookies() や body() などのメソッドが用意されており、これがレスポンスを表すオブジェクトだとわかります。

まず、Burp の Target タブで設定したスコープ(診断対象の範囲)に含まれる通信だけを調べるようにしたいので、レスポンスに対応するリクエストの送り先を知る方法を探します。HttpResponseReceived 自体にはスコープに関係しそうなメソッドは見当たりません。しかし説明の冒頭に、「レスポンスのきっかけになった HttpRequest や、Annotations、ToolSource を取得するメソッドを追加した HttpResponse」とあります。実際にメソッドの一覧(Method Summary)を見ていくと、initiatingRequest() というメソッドで、レスポンスの元になった HttpRequest を取得できることがわかります。

そこで次に HttpRequest の Javadoc を見ると、真偽値を返す isInScope() というメソッドがあります。つまり、レスポンスに対応するリクエストを取得し、そのリクエストの isInScope() を呼び出せば、スコープ内の通信かどうかを判断できます。

if (httpResponseReceived.initiatingRequest().isInScope()) {
    // スコープ内の通信だけを調べる
}

パスワードを受け取るコンストラクタ

レスポンスにパスワードが含まれているかを調べるには、そもそも探すパスワードを HttpAnalyzer が知っている必要があります。そこで、コンストラクタでパスワードを受け取って保管するようにします。IntelliJ IDEA では、クラスの中で Alt+Insert を押して Generate メニューを開き、Constructor を選ぶとコンストラクタを自動で作れます。

private final String password;

public HttpAnalyzer(String password) {
    this.password = password;
}

あわせて、ClearTextPasswdFinder の initialize でも、HttpAnalyzer のコンストラクタにパスワードを渡すように直します。

HttpAnalyzer handler = new HttpAnalyzer(password);
MAPI.getAPI().http().registerHttpHandler(handler);

パスワードを見つけたらログに出す

レスポンスの検査に戻ります。HttpResponseReceived の Javadoc を見ると、contains(String searchTerm, boolean caseSensitive) というメソッドがあります。説明には「HTTP メッセージのデータの中から、指定した検索語を探す」とあり、今回の目的に合っていそうです。

見つけたことをログに出力するために、MAPI からログの機能を呼び出します。ログにはリクエストの URL も含めたいので、先ほどの initiatingRequest() をもう一度使い、HttpRequest の url() で URL を取得します。

最後に戻り値を直します。ResponseReceivedAction の Javadoc によると、受け取ったレスポンスをそのまま次に渡すには ResponseReceivedAction.continueWith(response) を返します。リクエスト側も同様に、RequestToBeSentAction.continueWith(request) を返します。完成した HttpAnalyzer は次のとおりです。

import burp.api.montoya.http.handler.*;

public class HttpAnalyzer implements HttpHandler {
    private final String password;

    public HttpAnalyzer(String password) {
        this.password = password;
    }

    @Override
    public RequestToBeSentAction handleHttpRequestToBeSent(HttpRequestToBeSent httpRequestToBeSent) {
        // リクエストには手を加えず、そのまま送る
        return RequestToBeSentAction.continueWith(httpRequestToBeSent);
    }

    @Override
    public ResponseReceivedAction handleHttpResponseReceived(HttpResponseReceived httpResponseReceived) {
        if (httpResponseReceived.initiatingRequest().isInScope()) {
            if (httpResponseReceived.contains(password, true)) {
                MAPI.getAPI().logging().logToOutput(
                    "[!] Cleartext password detected on " + httpResponseReceived.initiatingRequest().url());
            }
        }
        // レスポンスには手を加えず、そのまま渡す
        return ResponseReceivedAction.continueWith(httpResponseReceived);
    }
}

テスト

これで「自分が登録したパスワードが HTTP レスポンスの中に現れたら知らせる」機能ができたはずなので、手元の環境でテストします。

まず、拡張機能を JAR ファイルにビルドします。公式ドキュメントでは、Maven のプロジェクトの場合、プロジェクトのルートで mvn clean package を実行すると、target フォルダに JAR ファイルが作られると説明されています。筆者は参考資料1にならい、IntelliJ IDEA の File → Project Structure → Artifacts で JAR の設定を追加し、IDE からビルドしました。

できた JAR ファイルを Burp Suite に読み込みます。Extensions → Installed で Add を選び、拡張機能の種類が Java になっていることを確かめて JAR ファイルを指定します。

次に、テスト用の Web サーバで、パスワードを HTML コメントに書いたファイルを公開しておきます。ここでは自分の端末の上で、Python の簡易 Web サーバを使いました。

$ cat test.html
<html>
Here is Nothing to SEE!
<!-- password is c56kpyvMs! -->
</html>

$ python3 -m http.server 8000

Burp の Target → Scope で http://localhost:8000 をスコープに追加し、Burp のプロキシを経由して http://localhost:8000/test.html にアクセスします。画面には「Here is Nothing to SEE!」としか表示されませんが、拡張機能の Output タブに、パスワードが見つかった旨のログが表示されれば、拡張機能は正しく動いています。

なお、テストは自分の端末や、許可を得た検証環境で行ってください。

おわりに

以上、筆者が拡張機能を作ったときの流れを大まかにまとめました。

今回の開発を通じて、API ドキュメントの読み方がわかるようになり、できることの幅が大きく広がったと感じています。はじめは難しく思えた API ドキュメントも、実際に手を動かしながら「引数の型をたどる」「メソッドの一覧を眺める」ことを繰り返すうちに、使い方がつかめてきました。読者の方の参考になれば幸いです。

脆弱性診断やペネトレーションテストで使われるツールや手法の位置づけは、脆弱性診断とペネトレーションテストの違いでも解説しています。

参考資料

新しい記事 脆弱性診断とペネトレーションテストの違いとは? 目的・やり方・選び方を解説

前の記事 AWS WAF のマネージドルールで Web ACL を作る — ルールグループの選び方と初期設定

コラム一覧へ戻る

Contact

お問い合わせ

サービスのご相談、協業のご提案、取材のご依頼など、お気軽にご連絡ください。

Recruit

採用情報

セキュリティで社会の発展を支える仲間を募集しています。まずはカジュアル面談から。

bottom of page