vmware-archive/burp-rest-apiBurp Suite セキュリティツール用の REST/JSON API。
⚠️ 警告: このプロジェクトはもはや積極的にメンテナンスされていません。
リポジトリは参照用として利用可能ですが、今後のアップデート、バグ修正、サポートは提供されません。
Burp SuiteセキュリティツールのREST/JSON APIです。
2016年の最初のコミット以来、burp-rest-apiはBurp Suiteを利用したWebスキャン自動化のデフォルトツールとなっています。多くのセキュリティ専門家や組織が、Burp SpiderおよびScannerの作業をオーケストレートするためにこの拡張機能を利用してきました。
burp-rest-api-2.3.2.jar）をリリースページからダウンロードします。burpsuite_pro.jarを使用しないでください。On Linux, Mac:
java --add-opens=java.desktop/javax.swing=ALL-UNNAMED --add-opens=java.base/java.lang=ALL-UNNAMED -cp "burpsuite_pro.jar:burp-rest-api-2.3.2.jar" org.springframework.boot.loader.launch.JarLauncher
On Windows:
java --add-opens=java.desktop/javax.swing=ALL-UNNAMED --add-opens=java.base/java.lang=ALL-UNNAMED -cp "burpsuite_pro.jar;burp-rest-api-2.3.2.jar" org.springframework.boot.loader.launch.JarLauncher
重要!!!
burp-rest-apiは、レガシーなBurp Suite Professional v1.7と新しいBurp Suite Professional v2025.xの両方をサポートしています。このプロジェクトはBurp Extender APIに依存しているため、一部の機能の動作はBurpのバージョンによって若干異なる場合があります。例えば、v2025.xのBurp Suite Scanner設定はカスタマイズできなくなりました。
デフォルトでは、Burpはヘッドレスモードで起動され、プロキシはポート8080/tcp（localhostのみ）で動作し、RESTエンドポイントはポート8090/tcp（localhostのみ）で動作します。
コマンドラインからBurpをUIモードで実行するには、次の引数を追加します。
--headless.mode=false
APIにアクセスするサーバーポートを変更するには、次の引数を追加します。
--server.port=8081
または
--port=8081
また、サーバーアドレス（ネットワークアドレスバインディング用）を変更することもできます。
--server.address=192.168.1.2
または
--address=192.168.1.2
次のコマンドライン引数は、拡張機能が実行モードとポート番号を設定するためにのみ使用されます。
--burp.jar=<filename.jar> : Burp jarを動的にロードし、REST APIを通じて公開します。このフラグはJava <= 1.8でのみ動作します！新しいJavaバージョンではburp-rest-api.{sh,bat}スクリプトを使用してください。
--burp.ext=<filename.{jar,rb,py}> : アプリケーション起動時に指定されたBurp拡張機能をロードします。このフラグは繰り返し指定できます。
--server.port=<port_number> : REST APIエンドポイントは指定されたポート番号で利用可能になります。--port=<port_number>も短縮形として使用できます。
--server.address=<network address> : REST APIエンドポイントがバインドするネットワークアドレス。--address=<address_ip>も短縮形として使用できます。
--apikey=<customApiKey> : /burp/*のAPIを保護するためのAPIキー認証を有効にします。引数として渡されたcustomApiKeyは、すべてのHTTPリクエストに追加のヘッダーとして含める必要があります："API-KEY: <customApiKey>"。
--headless.mode=<true/false> : falseに設定するとBurp SuiteをUIモードで実行します。それ以外の場合はヘッドレスモードで実行します。デフォルト値: システムプロパティ (java.awt.headless)
実行可能なburp-rest-api JARに渡されたコマンドライン引数は、Burp Suite JARに転送されます。したがって、以下のBurp Suite JARのコマンドライン引数をburp-rest-api JARに渡すことで、Burp Suite JARに直接渡すのと同じ機能を実現できます。
--project-file=<filename> : ツールの状態を保持するための指定されたデータプロジェクトファイルを開きます。ファイルが存在しない場合は、新しいプロジェクトとして作成されます。
--config-file=<filename> : 選択したプロジェクト設定ファイルに含まれるオプションを使用してプロジェクトを開きます。複数のプロジェクト設定をロードするには、この引数を異なる値で複数回渡すことができます。
--user-config-file=<filename> : 選択したユーザー設定ファイルに含まれるオプションを使用してプロジェクトを開きます。複数のユーザー設定をロードするには、この引数を異なる値で複数回渡すことができます。
※プロジェクトの詳細については、Burp Suiteのドキュメントこちらおよびこちらを参照してください。スキャナー設定については、「Burp Suiteのサポートと制限」セクションを参照してください。
burp-rest-api JARを--project-file、--config-file、または--user-config-file引数なしで起動すると、Burp Suiteは一時的なプロジェクトファイルといくつかのデフォルト設定で起動されます。一時プロジェクトファイルはBurp Suiteの起動時に作成され、実行終了時に削除されます。
Burp Suiteの起動に使用されるデフォルト設定については、JAR内の_static_フォルダにある_burp-default-project-options.json_および_burp-default-user-options.json_ファイルを参照してください。
Swaggerを使用してAPIドキュメントを定義します。JARを起動したら、以下のリソースにアクセスしてAPIドキュメントとSwagger UIを確認してください。ポート8090がデフォルトのサーバーポートです。
APIドキュメント: http://localhost:8090/v3/api-docs
Swagger UI: http://localhost:8090/swagger-ui/index.html#
このプロジェクトには、他のプロジェクトで使用するためにJavaで書かれたクライアント（BurpClient.java）も付属しています。_BurpClient.java_の使用法については、統合テストファイル_BurpClientIT.java_を参照してください。
このプロジェクトは元々Resty-Burpに触発され、Doyensec LLCとのパートナーシップで開発されました。 
burp-rest-apiプロジェクトチームはコミュニティからの貢献を歓迎します。コードを提供したいが、コントリビューターライセンス契約（CLA）に署名していない場合、プルリクエストを開くとボットが自動的にIssueを更新します。CLAプロセスに関する質問は、CLA FAQを参照してください。詳細については、CONTRIBUTING.mdおよびFAQ.mdを参照してください。
次のセクションには、拡張機能の開発を始めるのに役立つ情報が含まれています。
libフォルダを作成し、Burp Suite JARファイルをその中に配置し、統合テストを実行するために"burpsuite_pro.jar"に名前を変更します。 # build the jar
./gradlew clean build
最近のJVM（JRE > 9）バージョンで拡張機能を実行したい場合は、スクリプトと同じディレクトリにburpsuite_pro.jarとburp-rest-api.jarをコピーした後、burp-rest-api-devel.{sh,bat}起動スクリプトを使用してください。
# On Unix (Linux, macOS)
./burp-rest-api-devel.sh
# On Windows
./burp-rest-api-devel.bat
Copyright (c) 2016 VMware, Inc. All Rights Reserved. Copyright (c) 2025 Doyensec LLC. All Rights Reserved.
ソースコードおよびバイナリ形式での再配布と使用は、修正の有無にかかわらず、以下の条件が満たされる場合に許可されます：ソースコードの再配布は、上記の著作権表示、この条件リスト、および以下の免責事項を保持しなければなりません。バイナリ形式での再配布は、上記の著作権表示、この条件リスト、および以下の免責事項を、配布物に付属する文書および/またはその他の資料に複製しなければなりません。
本ソフトウェアは、著作権者および貢献者によって「現状のまま」提供され、明示的または黙示的な一切の保証（商品性および特定目的への適合性に関する黙示の保証を含むがこれに限定されない）を否認します。いかなる場合においても、著作権者または貢献者は、いかなる直接、間接、偶発的、特別、懲罰的、または結果的損害（代替品またはサービスの調達、使用、データ、または利益の損失、または事業の中断を含むがこれに限定されない）についても、その原因が契約、厳格責任、不法行為（過失を含む）のいずれに基づくかに関わらず、たとえそのような損害の可能性が知らされていたとしても、一切の責任を負いません。