Package burp.api.montoya.proxy.http

Interface ProxyRequestHandler

public interface ProxyRequestHandler
Extensions can implement this interface and then call Proxy.registerRequestHandler(ProxyRequestHandler) to register a Proxy request handler. The handler 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.

  • Method Summary

    Modifier and Type
    Method
    Description
    ProxyRequestReceivedAction
    handleRequestReceived(InterceptedRequest interceptedRequest)
    This method is invoked before an HTTP request is received by the Proxy.
    Can modify the request.
    Can modify the annotations.
    Can control whether the request should be intercepted and displayed to the user for manual review or modification.
    Can drop the request.
    ProxyRequestToBeSentAction
    handleRequestToBeSent(InterceptedRequest interceptedRequest)
    This method is invoked after an HTTP request has been processed by the Proxy before it is sent.
    Can modify the request.
    Can modify the annotations.
    Can control whether the request is sent or dropped.

  • Method Details

    • handleRequestReceived

      ProxyRequestReceivedAction handleRequestReceived(InterceptedRequest interceptedRequest)
      This method is invoked before an HTTP request is received by the Proxy.
      Can modify the request.
      Can modify the annotations.
      Can control whether the request should be intercepted and displayed to the user for manual review or modification.
      Can drop the request.
      Parameters:
      interceptedRequest - An InterceptedRequest object that extensions can use to query and update details of the request.
      Returns:
      The ProxyRequestReceivedAction containing the required action, annotations and HTTP request to be passed through the proxy.

    • handleRequestToBeSent

      ProxyRequestToBeSentAction handleRequestToBeSent(InterceptedRequest interceptedRequest)
      This method is invoked after an HTTP request has been processed by the Proxy before it is sent.
      Can modify the request.
      Can modify the annotations.
      Can control whether the request is sent or dropped.
      Parameters:
      interceptedRequest - An InterceptedRequest object that extensions can use to query and update details of the intercepted request.
      Returns:
      The ProxyRequestToBeSentAction containing the required action, annotations and HTTP request to be sent from the proxy.