A Burp Suite extension for headless, unattended scanning.
- Description
- seltzer.jar
- seltzer.sh
- BURPHOME
- Burp REST API
- Configuration Files
- Folder Structure
- Targets File
- Examples
- Installation
- Download
- Build
Seltzer parses a list of targets and sends them to the Burp Suite REST API for scanning.
It opens an instance of Burp Suite in headless mode, passing user and project options found in the Seltzer /conf directory.
The targets file is a CSV file containing a list of targets to scan and scan configuration parameters.
Targets are scanned serially, one scan starting after the previous scan has completed.
A project file, HTML report and XML export for each target is saved into the Seltzer /scans directory.
A log file is created in the Seltzer /log directory. New log files are created daily.
The two primary components of Seltzer are the seltzer.jar Burp extension and the seltzer.sh Bash shell script.
seltzer.jar is the Burp extension that handles creating the scan, monitoring its progress and exporting the results.
Burp Suite must be configured to use the seltzer.jar file included with this project.
The extension should be configured to direct all output to the console.
seltzer.jar can be found under /source/build/libs.
seltzer.sh is a Bash shell script that handles reading the targets file, starting Burp, creating the log file and exiting Burp.
setlzer.sh accepts the following options:
-t, --targets The targets file - REQUIRED.
-s, --server REST API host and port. Defaults to http://127.0.0.1:1337 - OPTIONAL.
-a, --apikey REST API key - OPTIONAL.
-h, --help Displays help and exits.
Seltzer requires a local environment variable named BURPHOME to locate your Burp Suite JAR file.
If this environment variable is not set seltzer will instruct the user to set it and exit.
Example: export BURPHOME=/home/myuser/BurpSuite.
The Burp REST API must be configured and running.
Seltzer supports the use of API keys and running the REST API on non-default interfaces and ports.
By default, seltzer uses the useroptions.json and projectoptions.json files located in the seltzer /conf directory.
These files can be modified or replaced.
In order to not use these options files, modify seltzer.sh and remove the --config-file and --user-config-file parameters passed to Burp.
Seltzer uses multiple files and folders including the following:
/bin - Contains the seltzer.sh BASH script.
/conf - Contains configuration files seltzer needs including Burp Suite user and project options files.
/doc - Contains documentation including this README.
/log - Seltzer logs all scanning activities and will save log files to this directory.
/scans - Seltzer outputs all scan reports and project files to this directory.
/source - Contains seltzer.jar, gradle components and related Java source code files.
/targets - Contains targets files.
The targets file is a list of scanning targets in CSV format.
Parameters in the targets file must be in the correct order.
The PROJECT parameter may unique or may be reused to have multiple targets in a single project file.
The REPORTNAME parameter must be unique for each target or the exported files will get overwritten.
The RESOURCE parameter is experimental and should only be used if you have created a named resource pool in an existing Burp project file that exists inside the Seltzer /scans directory. The default "Default resource pool" can be used or the entry can be left blank.
An empty field (i.e. ',,') should be used for parameters that will not be passed.
The targets file supports the following parameters in the order listed:
TARGET,REPORTNAME,USERNAME,PASSWORD,CONFIGURATION,RESOURCE
TARGET The individual target to scan - REQUIRED.
PROJECT The name of the Burp project file use - REQUIRED.
REPORTNAME The name used to create the report files - MUST BE UNIQUE PER TARGET - REQUIRED.
USERNAME The username for credentialed scans - OPTIONAL.
PASSWORD The password for credentialed scans - OPTIONAL.
CONFIGURATION The named configuration to use for the scan. Only named configurations are supported at this time - OPTIONAL.
RESOURCE The resource pool to use for the scan. Only named configurations are supported at this time - OPTIONAL.
Example targets file:
http://192.168.1.102,Project1,BurpReport2,,,Audit checks - light active,Default resource pool
http://192.168.1.102,Project2,BurpReport3,someuser,somepass,Audit checks - light active,Default resource pool
http://192.168.1.103:9090,Project2,BurpReport4,someuser,somepass,Audit checks - light active,Default resource pool
Run seltzer with only a targets file:
./seltzer.sh -t ../targets/targets.txt
Run seltzer using the REST API on a non-default port and with a targets file:
./seltzer.sh -s http://127.0.0.1:4444 -t ../targets/targets.txt
Run seltzer using the REST API on a non-default port, with an API key and with a targets file:
./seltzer.sh -s http://127.0.0.1:4444 -a PjmM7JKWPtLa4YKnI2UoR5BTaCosXdgrS -t ../targets/targets.txt
- Clone the seltzer repository from https://github.com/10goto20/seltzer.
- Configure Burp to use the seltzer.jar extension. Compile from source or use the precompiled jar here: https://github.com/10goto20/seltzer/tree/master/source/build/libs
- Configure the extension to direct all output to the console.
The most recent release can be found here: https://github.com/10goto20/seltzer
A precompiled seltzer.jar file can be found here: https://github.com/10goto20/seltzer/tree/master/source/build/libs
- git clone https://github.com/10goto20/seltzer.git
- Install gradle for your distribution (https://gradle.org/install/)
- cd seltzer
- gradle build
- Jar file will be in the build/libs directory