This repository includes a set of scripts to install a Burp Collaborator Server in a docker environment, using a LetsEncrypt wildcard certificate. The objective is to simplify as much as possible the process of setting up and maintaining the server.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
burp
certbot
dnsmasq
README.md
init.sh

README.md

Burp Collaborator Server docker container with LetsEncrypt certificate

This repository includes a set of scripts to install a Burp Collaborator Server in a docker environment, using a LetsEncrypt wildcard certificate. The objective is to simplify as much as possible the process of setting up and maintaining the server.

Setup your domain

Delegate a subdomain to your soon to be burp collaborator server IP address. At the minimum you'll need a NS record for the subdomain to be used (e.g. burp.example.com) pointing to your new server's A record:

burp.example.com IN NS burpserver.example.com

burpserver.example.com IN A 1.2.3.4

Check https://portswigger.net/burp/help/collaborator_deploying#dns for further info.

Requirements

  • Internet accessible server
  • bash
  • docker
  • bc
  • openssl
  • Burp Suite Professional

Setup the environment

  • Clone or download the repository to the server (tested on ubuntu 16.04) to a directory of your choice.
  • Put the Burp Suite JAR file in ./burp/pkg/burp.jar (make sure the name is exactly burp.jar, and it is the actual file not a link)
  • Make sure you have 2 shells opened on the server, as root.
  • Run init.sh in the first shell with your subdomain and server public IP address as argument:

./init.sh burp.example.com 1.2.3.4

This will start the environment for the subdomain burp.example.com, creating a wildcard certificate as *.burp.example.com.

At some point you'll be asked to deploy a DNS TXT record, similar to the following:

Obtaining a new certificate Performing the following challenges: dns-01 challenge for burp.example.com dns-01 challenge for burp.example.com

Please deploy a DNS TXT record under the name _acme-challenge.burp.example.com with the following value:

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Before continuing, verify the record is deployed.

Press Enter to Continue

The "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" will be acme challenge 1. You'll need it. Press Enter.

You see a new record:

Please deploy a DNS TXT record under the name _acme-challenge.burp.example.com with the following value:

YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY

Before continuing, verify the record is deployed.

Press Enter to Continue

DON'T PRESS ENTER YET

This is acme challenge 2. Copy it and run in the second shell (replacing with your subdomain and your challenges, obviously):

./dnsmasq/run.sh burp.example.com XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY

Press "Enter" in the first shell.

If everything is OK, burp will start with the following message:

Burp is now running with the letsencrypt certificate for domain *.burp.example.com

You can check by running docker ps, and going to burp, and pointing the collaborator configuration to your new server. Keep it mind that this configuration configures the polling server on port 9443.

The init.sh script will be renamed and disabled, so no accidents may happen.

Certificate renewal

  • Edit the file ./certbot/certificaterenewal.sh and configure the "BASEDIR" variable to the correct path of the main directory (where the init.sh script resides).
  • Optionally, edit the RENEWDAYS variable if you wish to. By default it will renew the certificate every 45 days. If you want to force the renewal to check if everything is working, just set it to 89 days, and run it manually. Remember to set it back to 45 afterwards.
  • Set your crontab to run this script once a day.

Updating Burp Suite

  • Download it and make sure you put it in ./burp/pkg/burp.jar
  • Restart the container with docker restart burp

Author: Bruno Morisson

Thanks to Fábio Pires (check his burp collaborator w/letsencrypt tutorial) and Herman Duarte (for betatesting and fixes)