Package burp.api.montoya.proxy.http

Interface ProxyResponseReceivedAction

public interface ProxyResponseReceivedAction
Extensions can implement this interface when returning a result from ProxyResponseHandler.handleResponseReceived(InterceptedResponse).

  • Method Details

    • action

      MessageReceivedAction action()
      This method retrieves the current initial intercept action.
      Returns:
      The MessageReceivedAction.

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

    • continueWith

      static ProxyResponseReceivedAction continueWith(HttpResponse response)
      This method can be used to create an action that causes Burp Proxy to follow the current interception rules to determine the appropriate action to take for the response.
      Annotations are not modified.
      Parameters:
      response - The HttpResponse received after any modifications by the extension.
      Returns:
      The ProxyResponseReceivedAction that causes Burp Proxy to follow the current interception rules to determine the appropriate action to take for the response.

    • continueWith

      static ProxyResponseReceivedAction continueWith(HttpResponse response, Annotations annotations)
      This method can be used to create an action 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 ProxyResponseReceivedAction that causes Burp Proxy to follow the current interception rules to determine the appropriate action to take for the response.

    • intercept

      static ProxyResponseReceivedAction intercept(HttpResponse response)
      This method can be used to create an action that causes Burp Proxy to present the response to the user for manual review or modification.
      Annotations are not modified.
      Parameters:
      response - The HttpResponse received after any modifications by the extension.
      Returns:
      The ProxyResponseReceivedAction that causes Burp Proxy to present the response to the user for manual review or modification.

    • intercept

      static ProxyResponseReceivedAction intercept(HttpResponse response, Annotations annotations)
      This method can be used to create an action 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 ProxyResponseReceivedAction that causes Burp Proxy to present the response to the user for manual review or modification.

    • doNotIntercept

      static ProxyResponseReceivedAction doNotIntercept(HttpResponse response)
      This method can be used to create an action that causes Burp Proxy to forward the response without presenting it to the user.
      Annotations are not modified.
      Parameters:
      response - The HttpResponse received after any modifications by the extension.
      Returns:
      The ProxyResponseReceivedAction that causes Burp Proxy to forward the response without presenting it to the user.

    • doNotIntercept

      static ProxyResponseReceivedAction doNotIntercept(HttpResponse response, Annotations annotations)
      This method can be used to create an action 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 ProxyResponseReceivedAction that causes Burp Proxy to forward the response without presenting it to the user.

    • drop

      static ProxyResponseReceivedAction drop()
      This method can be used to create an action that causes Burp Proxy to drop the response.
      Returns:
      The ProxyResponseReceivedAction that causes Burp Proxy to drop the response.

    • proxyResponseReceivedAction

      static ProxyResponseReceivedAction proxyResponseReceivedAction(HttpResponse response, Annotations annotations, MessageReceivedAction action)
      This method can be used to create a default implementation of a ProxyResponseReceivedAction for an HTTP response.
      Parameters:
      response - The HttpResponse received after any modifications by the extension.
      annotations - The Annotations for the intercepted HTTP response. null value will leave the annotations unmodified.
      action - The MessageReceivedAction for the HTTP response.
      Returns:
      The ProxyResponseReceivedAction including the HTTP response, annotations and intercept action.