Skip to content

Latest commit

 

History

History
168 lines (119 loc) · 6.72 KB

README.md

File metadata and controls

168 lines (119 loc) · 6.72 KB
Raw

burp-rest-api

Overview

A REST/JSON API to the Burp Suite security tool.

Upon successfully building the project, an executable JAR file is created with the Burp Suite Professional JAR bundled in it. When the JAR is launched, it provides a REST/JSON endpoint to access the Scanner, Spider, Proxy and other features of the Burp Suite Professional security tool.

Try it out

Prerequisites

Build & Run

  1. Download the Professional edition of Burp Suite. You may use Free edition but capabilities are limited.
  2. Create a lib folder under the project directory and place the Burp Suite JAR file into it and rename it to "burpsuite_pro.jar".
  3. The project can be run either by running the Gradle Spring bootRun command or by directly launching the JAR created from building the project:
    gradlew bootRun # for pro edition, or
    gradlew bootRun "-Dburp.edition=free" # for free edition

or

    # build the jar (note that testing phase will fail if you provide free edition jar in ./lib)
    gradlew clean build
    # and run it
    java -jar build/libs/burp-rest-api-1.0.2.jar # for pro edition, or
    java -jar build/libs/burp-rest-api-1.0.2.jar --burp.edition=free # for free edition

The version number of the JAR should match the version number from build.gradle while generating the JAR.

Documentation

Configuration

By default, Burp is launched in headless mode with the Proxy running on port 8080/tcp and the REST endpoint running on 8090/tcp.

To run Burp in UI mode from the command line, use one of the following commands:

With the bootRun command:

    gradlew bootRun -Djava.awt.headless=false

or

    gradlew bootRun -Dheadless.mode=false

With the executable JAR:

    java -jar burp-rest-api-1.0.2.jar -Djava.awt.headless=false

or

    java -jar burp-rest-api-1.0.2.jar --headless.mode=false

To modify the server port on which the API is accessible, use one of the following commands:

With the bootRun command:

    gradlew bootRun -Dserver.port=8081

or

    gradlew bootRun -Dport=8081

With the executable JAR:

    java -jar burp-rest-api-1.0.2.jar --server.port=8081

or

    java -jar burp-rest-api-1.0.2.jar --port=8081

Command Line Arguments

The following command line arguments are used only by the extension to configure the run mode and port number.

--server.port=<port_number> : The REST API endpoint is available at the given port number. --port=<port_number> works as short hand argument.

--headless.mode=<true/false> : When set to false, runs Burp Suite in UI mode. Otherwise runs Burp Suite in headless mode. Default value: System Property (java.awt.headless)

Command line arguments passed to the executable burp-rest-api JAR are forwarded to the Burp Suite JAR. Hence, one may pass the following Burp Suite JAR command line arguments to the burp-rest-api JAR for the same functionality as if passing to the Burp Suite JAR directly.

--project-file=<filename> : Opens the specified project file. The file will be created as a new project if it doesn't exist already.

--config-file=<filename> : Opens the project using the options contained in the selected project configuration file. To load multiple project configurations, this argument can be passed more than once with different values.

--user-config-file=<filename> : Opens the project using the options contained in the selected user configuration file. To load multiple user configurations, this argument can be passed more than once with different values.

For more information on Projects, refer to the Burp Suite documentation here.

Default Burp Configuration

If the burp-rest-api JAR is launched without the --project-file, --config-file or --user-config-file arguments, then Burp Suite is launched with a temporary project file and some default configuration. The temporary project file gets created upon launch of Burp Suite, and gets deleted at the end of the run.

For the default configuration used to launch Burp Suite, refer to the files burp-default-project-options.json and burp-default-user-options.json inside the JAR under the static folder.

HTTP API

Swagger is used to define API documentation. Once the JAR is launched, access the following resources for API docs and Swagger UI. Port 8090 is the default server port.

API Docs: http://localhost:8090/v2/api-docs

Swagger UI: http://localhost:8090/swagger-ui.html#/

Client

This project also comes with a client (BurpClient.java) written in Java for use in other projects. Refer to the Integration Test file BurpClientIT.java for the usage of BurpClient.java.

Credits

This project is originally inspired from Resty-Burp.

Contributing

The burp-rest-api project team welcomes contributions from the community. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will update the issue when you open a Pull Request. For any questions about the CLA process, please refer to our FAQ. For more detailed information, refer to CONTRIBUTING.md.

License

Copyright (c) 2016 VMware, Inc. All Rights Reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.