Package burp.api.montoya

Interface MontoyaApi

public interface MontoyaApi

This interface is used by Burp Suite to pass a set of methods to extensions that can be used to perform various actions within Burp. When an extension is loaded, Burp invokes its BurpExtension.initialize(MontoyaApi) method and passes an instance of the MontoyaApi interface. The extension may then invoke the methods of this interface as required in order to extend Burp's functionality.

Method Summary

Modifier and Type	Method	Description
BurpSuite	burpSuite()	Access functionality related to the Burp Suite application.
Collaborator	collaborator()	[Professional only] Access the functionality of the Collaborator.
Comparer	comparer()	Access the functionality of the Comparer.
Decoder	decoder()	Access the functionality of the Decoder.
Extension	extension()	Access functionality related to your extension.
Http	http()	Access the functionality related to HTTP requests and responses.
Intruder	intruder()	Access the functionality of the Intruder.
Logging	logging()	Access the functionality related to logging and events.
Organizer	organizer()	Access the functionality of the Organizer.
Persistence	persistence()	Access the functionality related to persistence.
Project	project()	Access functionality related to the project.
Proxy	proxy()	Access the functionality of the Proxy.
Repeater	repeater()	Access the functionality of the Repeater.
Scanner	scanner()	[Professional only] Access the functionality of the Scanner.
Scope	scope()	Access the functionality related to Burp's suite-wide target scope.
SiteMap	siteMap()	Access the functionality of the Site Map.
UserInterface	userInterface()	Access the functionality related to the user interface.
Utilities	utilities()	Access additional utilities.
WebSockets	websockets()	Access the functionality related to WebSockets and messages.

Method Details

burpSuite

BurpSuite burpSuite()

Access functionality related to the Burp Suite application.

Returns:

An implementation of the BurpSuite interface which exposes application-level functionality.

collaborator

Collaborator collaborator()

[Professional only] Access the functionality of the Collaborator.

Returns:

An implementation of the Collaborator interface which exposes Collaborator functionality.

comparer

Comparer comparer()

Access the functionality of the Comparer.

Returns:

An implementation of the Comparer interface which exposes Comparer functionality.

decoder

Decoder decoder()

Access the functionality of the Decoder.

Returns:

An implementation of the Decoder interface which exposes Decoder functionality.

extension

Extension extension()

Access functionality related to your extension.

Returns:

An implementation of the Extension interface which exposes extension functionality.

http

Http http()

Access the functionality related to HTTP requests and responses.

Returns:

An implementation of the Http interface which exposes http functionality.

intruder

Intruder intruder()

Access the functionality of the Intruder.

Returns:

An implementation of the Comparer interface which exposes Comparer functionality.

logging

Logging logging()

Access the functionality related to logging and events.

Returns:

An implementation of the Logging interface which exposes logging functionality.

organizer

Organizer organizer()

Access the functionality of the Organizer.

Returns:

An implementation of the Organizer interface which exposes Organizer functionality.

persistence

Persistence persistence()

Access the functionality related to persistence.

Returns:

An implementation of the Persistence interface which exposes persistence functionality.

project

Project project()

Access functionality related to the project.

Returns:

An implementation of the Project interface which exposes project functionality.

proxy

Proxy proxy()

Access the functionality of the Proxy.

Returns:

An implementation of the Proxy interface which exposes Proxy functionality.

repeater

Repeater repeater()

Access the functionality of the Repeater.

Returns:

An implementation of the Repeater interface which exposes Repeater functionality.

scanner

Scanner scanner()

[Professional only] Access the functionality of the Scanner.

Returns:

An implementation of the Scanner interface which exposes Scanner functionality.

scope

Scope scope()

Access the functionality related to Burp's suite-wide target scope.

Returns:

An implementation of the Scope interface which exposes scope functionality.

siteMap

SiteMap siteMap()

Access the functionality of the Site Map.

Returns:

An implementation of the SiteMap interface which exposes sitemap functionality.

userInterface

UserInterface userInterface()

Access the functionality related to the user interface.

Returns:

An implementation of the UserInterface interface which exposes user interface functionality.

utilities

Utilities utilities()

Access additional utilities.

Returns:

An implementation of the Utilities interface which exposes additional utilities.

websockets

WebSockets websockets()

Access the functionality related to WebSockets and messages.

Returns:

An implementation of the WebSockets interface which exposes WebSocket functionality.