Package burp.api.montoya.proxy.http

Interface ProxyRequestReceivedAction

public interface ProxyRequestReceivedAction

Extensions can implement this interface when returning a result from ProxyRequestHandler.handleRequestReceived(InterceptedRequest).

Method Summary

Modifier and Type	Method	Description
MessageReceivedAction	action()	This method retrieves the current initial intercept action.
Annotations	annotations()	This method retrieves the annotations for the current request after any modifications by the extension.
static ProxyRequestReceivedAction	continueWith(HttpRequest request)	This method can be used to create a result that causes Burp Proxy to follow the current interception rules to determine the appropriate action to take for the request. Annotations are not modified.
static ProxyRequestReceivedAction	continueWith(HttpRequest request, Annotations annotations)	This method can be used to create a result that causes Burp Proxy to follow the current interception rules to determine the appropriate action to take for the request.
static ProxyRequestReceivedAction	doNotIntercept(HttpRequest request)	This method can be used to create a result that causes Burp Proxy to forward the request without presenting it to the user.
static ProxyRequestReceivedAction	doNotIntercept(HttpRequest request, Annotations annotations)	This method can be used to create a result that causes Burp Proxy to forward the request without presenting it to the user.
static ProxyRequestReceivedAction	drop()	This method can be used to create a result that causes Burp Proxy to drop the request.
static ProxyRequestReceivedAction	intercept(HttpRequest request)	This method can be used to create a result that causes Burp Proxy to present the request to the user for manual review or modification. Annotations are not modified.
static ProxyRequestReceivedAction	intercept(HttpRequest request, Annotations annotations)	This method can be used to create a result that causes Burp Proxy to present the request to the user for manual review or modification.
static ProxyRequestReceivedAction	proxyRequestReceivedAction(HttpRequest request, Annotations annotations, MessageReceivedAction action)	This method can be used to create a default implementation of an initial intercept result for an HTTP request.
HttpRequest	request()	This method retrieves the current HTTP request to forward after any modifications by the extension.

Method Details

action

MessageReceivedAction action()

This method retrieves the current initial intercept action.

Returns:

The MessageReceivedAction.

request

HttpRequest request()

This method retrieves the current HTTP request to forward after any modifications by the extension.

Returns:

The HttpRequest to forward after any modifications by the extension.

annotations

Annotations annotations()

This method retrieves the annotations for the current request after any modifications by the extension.

Returns:

The Annotations for the intercepted HTTP request.

continueWith

static ProxyRequestReceivedAction continueWith(HttpRequest request)

This method can be used to create a result that causes Burp Proxy to follow the current interception rules to determine the appropriate action to take for the request.
Annotations are not modified.

Parameters:

request - The HttpRequest received after any modifications by the extension.

Returns:

The ProxyRequestReceivedAction that allows user rules to be followed.

continueWith

static ProxyRequestReceivedAction continueWith(HttpRequest request,
 Annotations annotations)

This method can be used to create a result that causes Burp Proxy to follow the current interception rules to determine the appropriate action to take for the request.

Parameters:

request - The HttpRequest received after any modifications by the extension.

annotations - The Annotations for the intercepted HTTP request.

Returns:

The ProxyRequestReceivedAction that causes Burp Proxy to follow the current interception rules to determine the appropriate action to take for the request.

intercept

static ProxyRequestReceivedAction intercept(HttpRequest request)

This method can be used to create a result that causes Burp Proxy to present the request to the user for manual review or modification.
Annotations are not modified.

Parameters:

request - The HttpRequest received after any modifications by the extension.

Returns:

The ProxyRequestReceivedAction that causes Burp Proxy to present the request to the user for manual review or modification.

intercept

static ProxyRequestReceivedAction intercept(HttpRequest request,
 Annotations annotations)

This method can be used to create a result that causes Burp Proxy to present the request to the user for manual review or modification.

Parameters:

request - The HttpRequest received after any modifications by the extension.

annotations - The Annotations for the intercepted HTTP request.

Returns:

The ProxyRequestReceivedAction that causes Burp Proxy to present the request to the user for manual review or modification.

doNotIntercept

static ProxyRequestReceivedAction doNotIntercept(HttpRequest request)

This method can be used to create a result that causes Burp Proxy to forward the request without presenting it to the user.
Annotations are not modified.

Parameters:

request - The HttpRequest received after any modifications by the extension.

Returns:

The ProxyRequestReceivedAction that causes Burp Proxy to forward the request without presenting it to the user.

doNotIntercept

static ProxyRequestReceivedAction doNotIntercept(HttpRequest request,
 Annotations annotations)

This method can be used to create a result that causes Burp Proxy to forward the request without presenting it to the user.

Parameters:

request - The HttpRequest received after any modifications by the extension.

annotations - The Annotations for the intercepted HTTP request.

Returns:

The ProxyRequestReceivedAction that causes Burp Proxy to forward the request without presenting it to the user.

drop

static ProxyRequestReceivedAction drop()

This method can be used to create a result that causes Burp Proxy to drop the request.

Returns:

The ProxyRequestReceivedAction that causes Burp Proxy to drop the request.

proxyRequestReceivedAction

static ProxyRequestReceivedAction proxyRequestReceivedAction(HttpRequest request,
 Annotations annotations,
 MessageReceivedAction action)

This method can be used to create a default implementation of an initial intercept result for an HTTP request.

Parameters:

request - The HttpRequest received after any modifications by the extension.

annotations - The Annotations for the intercepted HTTP request. null value will leave the annotations unmodified.

action - The MessageReceivedAction for the HTTP request.

Returns:

The ProxyRequestReceivedAction including the HTTP request, annotations and initial intercept action.