Package burp.api.montoya.burpsuite

Interface BurpSuite

public interface BurpSuite

Provides access to functionality related to the Burp Suite application.

Method Summary

Modifier and Type	Method	Description
List<String>	commandLineArguments()	Command line arguments that were passed to Burp on startup.
String	exportProjectOptionsAsJson(String... paths)	Export current project-level configuration in JSON format.
String	exportUserOptionsAsJson(String... paths)	Export current user-level configuration in JSON format.
void	importProjectOptionsFromJson(String json)	Import a new project-level configuration from the JSON String provided.
void	importUserOptionsFromJson(String json)	Import a new user-level configuration from the JSON String provided.
void	shutdown(ShutdownOptions... options)	Shut down Burp programmatically.
TaskExecutionEngine	taskExecutionEngine()	Access the functionality of the task execution engine.
Version	version()	Retrieve information about the version of Burp in which the extension is running.

Method Details

version

Version version()

Retrieve information about the version of Burp in which the extension is running. It can be used by extensions to dynamically adjust their behavior depending on the functionality and APIs supported by the current version.

Returns:

The Burp Version.

exportProjectOptionsAsJson

String exportProjectOptionsAsJson(String... paths)

Export current project-level configuration in JSON format. This is the same format that can be saved and loaded via the Burp user interface. To include only certain sections of the configuration, you can optionally supply the path to each section that should be included, for example: "project_options.connections". If no paths are provided, then the entire configuration will be saved.

Parameters:

paths - A list of Strings representing the path to each configuration section that should be included.

Returns:

A String representing the current configuration in JSON format.

importProjectOptionsFromJson

void importProjectOptionsFromJson(String json)

Import a new project-level configuration from the JSON String provided. This is the same format that can be saved and loaded via the Burp user interface. Partial configurations are acceptable, and any settings not specified will be left unmodified.

Any user-level configuration options contained in the input will be ignored.

Parameters:

json - A JSON String containing the new configuration.

exportUserOptionsAsJson

String exportUserOptionsAsJson(String... paths)

Export current user-level configuration in JSON format. This is the same format that can be saved and loaded via the Burp user interface. To include only certain sections of the configuration, you can optionally supply the path to each section that should be included, for example: "user_options.connections". If no paths are provided, then the entire configuration will be saved.

Parameters:

paths - A list of Strings representing the path to each configuration section that should be included.

Returns:

A String representing the current configuration in JSON format.

importUserOptionsFromJson

void importUserOptionsFromJson(String json)

Import a new user-level configuration from the JSON String provided. This is the same format that can be saved and loaded via the Burp user interface. Partial configurations are acceptable, and any settings not specified will be left unmodified.

Any project-level configuration options contained in the input will be ignored.

Parameters:

json - A JSON String containing the new configuration.

commandLineArguments

List<String> commandLineArguments()

Command line arguments that were passed to Burp on startup.

Returns:

The command line arguments that were passed to Burp on startup.

shutdown

void shutdown(ShutdownOptions... options)

Shut down Burp programmatically.

Parameters:

options - The shutdown options for shutting down Burp programmatically. For example ShutdownOptions.PROMPT_USER will display a dialog to the user allowing them to confirm or cancel the shutdown.

taskExecutionEngine

TaskExecutionEngine taskExecutionEngine()

Access the functionality of the task execution engine.

Returns:

An implementation of the TaskExecutionEngine interface which exposes task execution engine functionality.