Package burp.api.montoya.proxy

Interface Proxy

public interface Proxy

Provides access to the functionality of the Proxy tool.

Method Summary

Modifier and Type	Method	Description
void	disableIntercept()	This method disables the master interception for Burp Proxy.
void	enableIntercept()	This method enables the master interception for Burp Proxy.
List<ProxyHttpRequestResponse>	history()	This method returns details of all items in the Proxy HTTP history.
List<ProxyHttpRequestResponse>	history(ProxyHistoryFilter filter)	This method returns details of items in the Proxy HTTP history based on the filter.
boolean	isInterceptEnabled()
Registration	registerRequestHandler(ProxyRequestHandler handler)	Register a handler which will be notified of requests being processed by the Proxy tool.
Registration	registerResponseHandler(ProxyResponseHandler handler)	Register a handler which will be notified of responses being processed by the Proxy tool.
Registration	registerWebSocketCreationHandler(ProxyWebSocketCreationHandler handler)	Register a handler which will be invoked whenever a WebSocket is being created by the Proxy tool.
List<ProxyWebSocketMessage>	webSocketHistory()	This method returns details of all items in the Proxy WebSockets history.
List<ProxyWebSocketMessage>	webSocketHistory(ProxyWebSocketHistoryFilter filter)	This method returns details of items in the Proxy WebSockets history based on the filter.

Method Details

enableIntercept

void enableIntercept()

This method enables the master interception for Burp Proxy.

disableIntercept

void disableIntercept()

This method disables the master interception for Burp Proxy.

isInterceptEnabled

boolean isInterceptEnabled()

Returns:

True if master interception for Burp Proxy is enabled.

history

List<ProxyHttpRequestResponse> history()

This method returns details of all items in the Proxy HTTP history.

Returns:

The list of all the ProxyHttpRequestResponse items in the Proxy HTTP history.

history

List<ProxyHttpRequestResponse> history(ProxyHistoryFilter filter)

This method returns details of items in the Proxy HTTP history based on the filter.

Parameters:

filter - An instance of ProxyHistoryFilter that can be used to filter the items in the Proxy history.

Returns:

The list of ProxyHttpRequestResponse items in the Proxy HTTP history that matched the filter.

webSocketHistory

List<ProxyWebSocketMessage> webSocketHistory()

This method returns details of all items in the Proxy WebSockets history.

Returns:

The list of all the ProxyWebSocketMessage items in the Proxy WebSockets history.

webSocketHistory

List<ProxyWebSocketMessage> webSocketHistory(ProxyWebSocketHistoryFilter filter)

This method returns details of items in the Proxy WebSockets history based on the filter.

Parameters:

filter - An instance of ProxyWebSocketHistoryFilter that can be used to filter the items in the Proxy WebSockets history.

Returns:

The list of ProxyWebSocketMessage items in the Proxy WebSockets history that matched the filter.

registerRequestHandler

Registration registerRequestHandler(ProxyRequestHandler handler)

Register a handler which will be notified of requests being processed by the Proxy tool. Extensions can perform custom analysis or modification of these messages, and control in-UI message interception.

Parameters:

handler - An object created by the extension that implements the ProxyRequestHandler interface.

Returns:

The Registration for the handler.

registerResponseHandler

Registration registerResponseHandler(ProxyResponseHandler handler)

Register a handler which will be notified of responses being processed by the Proxy tool. Extensions can perform custom analysis or modification of these messages, and control in-UI message interception.

Parameters:

handler - An object created by the extension that implements the ProxyResponseHandler interface.

Returns:

The Registration for the handler.

registerWebSocketCreationHandler

Registration registerWebSocketCreationHandler(ProxyWebSocketCreationHandler handler)

Register a handler which will be invoked whenever a WebSocket is being created by the Proxy tool.

Parameters:

handler - An object created by the extension that implements ProxyWebSocketCreationHandler interface.

Returns:

The Registration for the handler.