Package burp.api.montoya.proxy

Interface ResponseInitialInterceptResult

public interface ResponseInitialInterceptResult

Extensions can implement this interface when returning a result from ProxyHttpResponseHandler.handleReceivedResponse(InterceptedHttpResponse, HttpRequest, 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 response after any modifications by the extension.
static ResponseInitialInterceptResult	doNotIntercept(HttpResponse response)	This method can be used to create a result that causes Burp Proxy to forward the response without presenting it to the user.
static ResponseInitialInterceptResult	doNotIntercept(HttpResponse response, Annotations annotations)	This method can be used to create a result that causes Burp Proxy to forward the response without presenting it to the user.
static ResponseInitialInterceptResult	drop()	This method can be used to create a result that causes Burp Proxy to drop the response.
static ResponseInitialInterceptResult	followUserRules(HttpResponse response)	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 response.
static ResponseInitialInterceptResult	followUserRules(HttpResponse response, 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 response.
static ResponseInitialInterceptResult	initialInterceptResult(HttpResponse response, Annotations annotations, InitialInterceptAction action)	This method can be used to create a default implementation of an initial intercept result for an HTTP response.
static ResponseInitialInterceptResult	intercept(HttpResponse response)	This method can be used to create a result that causes Burp Proxy to present the response to the user for manual review or modification.
static ResponseInitialInterceptResult	intercept(HttpResponse response, Annotations annotations)	This method can be used to create a result that causes Burp Proxy to present the response to the user for manual review or modification.
HttpResponse	response()	This method retrieves the current HTTP response to forward after any modifications by the extension.

Method Detail

intercept

static ResponseInitialInterceptResult intercept(HttpResponse response)

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

Parameters:

response - The HttpResponse received after any modifications by the extension.

Returns:

The ResponseInitialInterceptResult that causes Burp Proxy to present the response to the user for manual review or modification.

intercept

static ResponseInitialInterceptResult intercept(HttpResponse response,
                                                Annotations annotations)

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

Parameters:

response - The HttpResponse received after any modifications by the extension.

annotations - The Annotations for the intercepted HTTP response.

Returns:

The ResponseInitialInterceptResult that causes Burp Proxy to present the response to the user for manual review or modification.

doNotIntercept

static ResponseInitialInterceptResult doNotIntercept(HttpResponse response)

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

Parameters:

response - The HttpResponse received after any modifications by the extension.

Returns:

The ResponseInitialInterceptResult that causes Burp Proxy to forward the response without presenting it to the user.

doNotIntercept

static ResponseInitialInterceptResult doNotIntercept(HttpResponse response,
                                                     Annotations annotations)

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

Parameters:

response - The HttpResponse received after any modifications by the extension.

annotations - The Annotations for the intercepted HTTP response.

Returns:

The ResponseInitialInterceptResult that causes Burp Proxy to forward the response without presenting it to the user.

followUserRules

static ResponseInitialInterceptResult followUserRules(HttpResponse response)

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 response.

Parameters:

response - The HttpResponse received after any modifications by the extension.

Returns:

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

followUserRules

static ResponseInitialInterceptResult followUserRules(HttpResponse response,
                                                      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 response.

Parameters:

response - The HttpResponse received after any modifications by the extension.

annotations - The Annotations for the intercepted HTTP response.

Returns:

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

drop

static ResponseInitialInterceptResult drop()

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

Returns:

The ResponseInitialInterceptResult that causes Burp Proxy to drop the response.

initialInterceptResult

static ResponseInitialInterceptResult initialInterceptResult(HttpResponse response,
                                                             Annotations annotations,
                                                             InitialInterceptAction action)

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

Parameters:

response - The HttpResponse received after any modifications by the extension.

annotations - The Annotations for the intercepted HTTP response.

action - The InitialInterceptAction for the HTTP response.

Returns:

The ResponseInitialInterceptResult including the HTTP response, annotations and initial intercept action.

action

InitialInterceptAction action()

This method retrieves the current initial intercept action.

Returns:

The InitialInterceptAction.

response

HttpResponse response()

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

Returns:

The HttpResponse to forward after any modifications by the extension.

annotations

Annotations annotations()

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

Returns:

The Annotations for the intercepted HTTP response.