Package burp

Interface IInterceptedProxyMessage

  • public interface IInterceptedProxyMessage
    This interface is used to represent an HTTP message that has been intercepted by Burp Proxy. Extensions can register an IProxyListener to receive details of proxy messages using this interface. *

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ACTION_DO_INTERCEPT
      This action causes Burp Proxy to present the message to the user for manual review or modification.
      static int ACTION_DO_INTERCEPT_AND_REHOOK
      This action causes Burp Proxy to present the message to the user for manual review or modification, and then make a second call to processProxyMessage.
      static int ACTION_DONT_INTERCEPT
      This action causes Burp Proxy to forward the message to the remote server or client, without presenting it to the user.
      static int ACTION_DONT_INTERCEPT_AND_REHOOK
      This action causes Burp Proxy to skip user interception, and then make a second call to processProxyMessage.
      static int ACTION_DROP
      This action causes Burp Proxy to drop the message.
      static int ACTION_FOLLOW_RULES
      This action causes Burp Proxy to follow the current interception rules to determine the appropriate action to take for the message.
      static int ACTION_FOLLOW_RULES_AND_REHOOK
      This action causes Burp Proxy to follow the current interception rules to determine the appropriate action to take for the message, and then make a second call to processProxyMessage.

    • Field Detail

      • ACTION_FOLLOW_RULES

        static final int ACTION_FOLLOW_RULES
        This action causes Burp Proxy to follow the current interception rules to determine the appropriate action to take for the message.
        See Also:
        Constant Field Values

      • ACTION_DO_INTERCEPT

        static final int ACTION_DO_INTERCEPT
        This action causes Burp Proxy to present the message to the user for manual review or modification.
        See Also:
        Constant Field Values

      • ACTION_DONT_INTERCEPT

        static final int ACTION_DONT_INTERCEPT
        This action causes Burp Proxy to forward the message to the remote server or client, without presenting it to the user.
        See Also:
        Constant Field Values

      • ACTION_DROP

        static final int ACTION_DROP
        This action causes Burp Proxy to drop the message.
        See Also:
        Constant Field Values

      • ACTION_FOLLOW_RULES_AND_REHOOK

        static final int ACTION_FOLLOW_RULES_AND_REHOOK
        This action causes Burp Proxy to follow the current interception rules to determine the appropriate action to take for the message, and then make a second call to processProxyMessage.
        See Also:
        Constant Field Values

      • ACTION_DO_INTERCEPT_AND_REHOOK

        static final int ACTION_DO_INTERCEPT_AND_REHOOK
        This action causes Burp Proxy to present the message to the user for manual review or modification, and then make a second call to processProxyMessage.
        See Also:
        Constant Field Values

      • ACTION_DONT_INTERCEPT_AND_REHOOK

        static final int ACTION_DONT_INTERCEPT_AND_REHOOK
        This action causes Burp Proxy to skip user interception, and then make a second call to processProxyMessage.
        See Also:
        Constant Field Values

    • Method Detail

      • getMessageReference

        int getMessageReference()
        This method retrieves a unique reference number for this request/response.
        Returns:
        An identifier that is unique to a single request/response pair. Extensions can use this to correlate details of requests and responses and perform processing on the response message accordingly.

      • getMessageInfo

        IHttpRequestResponse getMessageInfo()
        This method retrieves details of the intercepted message.
        Returns:
        An IHttpRequestResponse object containing details of the intercepted message.

      • getInterceptAction

        int getInterceptAction()
        This method retrieves the currently defined interception action. The default action is ACTION_FOLLOW_RULES. If multiple proxy listeners are registered, then other listeners may already have modified the interception action before it reaches the current listener. This method can be used to determine whether this has occurred.
        Returns:
        The currently defined interception action. Possible values are defined within this interface.

      • setInterceptAction

        void setInterceptAction​(int interceptAction)
        This method is used to update the interception action.
        Parameters:
        interceptAction - The new interception action. Possible values are defined within this interface.

      • getListenerInterface

        java.lang.String getListenerInterface()
        This method retrieves the name of the Burp Proxy listener that is processing the intercepted message.
        Returns:
        The name of the Burp Proxy listener that is processing the intercepted message. The format is the same as that shown in the Proxy Listeners UI - for example, "127.0.0.1:8080".

      • getClientIpAddress

        java.net.InetAddress getClientIpAddress()
        This method retrieves the client IP address from which the request for the intercepted message was received.
        Returns:
        The client IP address from which the request for the intercepted message was received.