Package burp.api.montoya.proxy

Interface RequestInitialInterceptResult

public interface RequestInitialInterceptResult

Extensions can implement this interface when returning a result from ProxyHttpRequestHandler.handleReceivedRequest(InterceptedHttpRequest, Annotations).

Method Summary

Modifier and Type	Method	Description
InitialInterceptAction	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 RequestInitialInterceptResult	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 RequestInitialInterceptResult	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 RequestInitialInterceptResult	drop()	This method can be used to create a result that causes Burp Proxy to drop the request.
static RequestInitialInterceptResult	followUserRules(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.
static RequestInitialInterceptResult	followUserRules(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 RequestInitialInterceptResult	initialInterceptResult(HttpRequest request, Annotations annotations, InitialInterceptAction action)	This method can be used to create a default implementation of an initial intercept result for an HTTP request.
static RequestInitialInterceptResult	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.
static RequestInitialInterceptResult	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.
HttpRequest	request()	This method retrieves the current HTTP request to forward after any modifications by the extension.

Method Detail

intercept

static RequestInitialInterceptResult 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.

Parameters:

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

Returns:

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

intercept

static RequestInitialInterceptResult 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 RequestInitialInterceptResult that causes Burp Proxy to present the request to the user for manual review or modification.

doNotIntercept

static RequestInitialInterceptResult 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.

Parameters:

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

Returns:

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

doNotIntercept

static RequestInitialInterceptResult 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 RequestInitialInterceptResult that causes Burp Proxy to forward the request without presenting it to the user.

followUserRules

static RequestInitialInterceptResult followUserRules(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.

Parameters:

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

Returns:

The RequestInitialInterceptResult that allows user rules to be followed.

followUserRules

static RequestInitialInterceptResult followUserRules(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 RequestInitialInterceptResult that causes Burp Proxy to follow the current interception rules to determine the appropriate action to take for the request.

drop

static RequestInitialInterceptResult drop()

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

Returns:

The RequestInitialInterceptResult that causes Burp Proxy to drop the request.

initialInterceptResult

static RequestInitialInterceptResult initialInterceptResult(HttpRequest request,
                                                            Annotations annotations,
                                                            InitialInterceptAction 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.

action - The InitialInterceptAction for the HTTP request.

Returns:

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

action

InitialInterceptAction action()

This method retrieves the current initial intercept action.

Returns:

The InitialInterceptAction.

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.