https://github.com/koenrh/docker-burp-suite-pro
Burp Suite Professional in a Docker container.
https://github.com/koenrh/docker-burp-suite-pro
burpsuite-pro docker
Last synced: about 1 year ago
JSON representation
Burp Suite Professional in a Docker container.
- Host: GitHub
- URL: https://github.com/koenrh/docker-burp-suite-pro
- Owner: koenrh
- Created: 2018-05-10T14:23:01.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2023-10-23T20:49:29.000Z (over 2 years ago)
- Last Synced: 2025-04-03T04:33:06.827Z (about 1 year ago)
- Topics: burpsuite-pro, docker
- Language: Dockerfile
- Homepage:
- Size: 64.5 KB
- Stars: 82
- Watchers: 2
- Forks: 21
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Burp Suite Pro
This allows you to run Burp Suite Professional in a container. This guide describes
the steps to run Burp on a Mac, but steps for Linux should be fairly similar.
## Prerequisites
- You need a [Burp Suite Professional](https://portswigger.net/burp) license.
- You need to have the following installed on your host:
- [Docker](https://docs.docker.com/install/)
- [XQuartz](https://www.xquartz.org/)
- [socat](http://www.dest-unreach.org/socat/)
:warning: If you did not have installed XQuartz, make sure to reboot your Mac after
the installation so that the X11 window server is set up correctly for the current
user.
## Building the image
First, clone this GitHub repository on your host:
```bash
git clone https://github.com/koenrh/docker-burp-suite-pro.git
```
Then, build the Docker image using the following command. Provide the email address
and password (or customer number for some customers) you would normally use to login
to your PortSwigger account.
```bash
docker build -t koenrh/burp-suite-pro \
--build-arg PORTSWIGGER_EMAIL_ADDRESS="$PORTSWIGGER_EMAIL_ADDRESS" \
--build-arg PORTSWIGGER_PASSWORD="$PORTSWIGGER_PASSWORD" .
```
While building the image, the JAR (Java ARchive) of Burp Suite Pro is pulled form
the PortSwigger portal.
## Setup
1. Start the X window server by opening XQuartz (`open -a xquartz`).
1. Expose the local XQuartz socket on TCP port 6000 using `socat`:
```
socat TCP-LISTEN:6000,reuseaddr,fork UNIX-CLIENT:\"$DISPLAY\"
```
Note that you need to run this command from your host, not the XQuartz terminal.
## Usage
```bash
docker run --rm \
-v "/tmp/.X11-unix:/tmp/.X11-unix" \
-e "DISPLAY=docker.for.mac.host.internal:0" \
-v "$HOME/src/github.com/koenrh/burp/java:/home/burp/.java" \
-p 8080:8080 \
--name burp-suite-pro
koenrh/burp-suite-pro
```
You could make this command more easily accessible by putting it an executable,
and make sure that it is available in your `$PATH`. Alternative, you could create
wrapper functions for your `docker run` commands ([example](https://github.com/jessfraz/dotfiles/blob/master/.dockerfunc)).
### Burp Proxy
In order to make Burp Proxy available to the host, you need to bind on the public
interface.
1. In Burp, open the 'Proxy' tab, and then the 'Options' tab.
1. Add a new 'Proxy Listener' by clicking the 'Add' button.
1. Enter the preferred port number, and make sure that 'Bind to address' is set
to 'All interfaces'.
1. Verify that the proxy is working by running the following command on your host:
```bash
curl -x http://127.0.0.1:8080 http://example.com
```
## Notes
1. When prompted, do not updated Burp Suite through the GUI. Pull and build an
updated image instead.
1. Do not the delete the mapped `.java` directory on your host. It contains important
license activation data.