Package burp.api.montoya.http

Interface Http

  • public interface Http
    This interface is used to access HTTP related functionality of Burp.

    • Method Detail

      • registerHttpHandler

        Registration registerHttpHandler​(HttpHandler handler)
        This method is used to register a handler which will perform an action when a request is about to be issued or a response was received by any Burp tool.
        Parameters:
        handler - An object created by the extension that implements HttpHandler interface.
        Returns:
        The Registration for the handler.

      • registerSessionHandlingAction

        Registration registerSessionHandlingAction​(SessionHandlingAction action)
        This method is used to register a custom session handling action. Each registered action will be available within the session handling rule UI for the user to select as a rule action. Users can choose to invoke an action directly in its own right, or following execution of a macro.
        Parameters:
        action - An object created by the extension that implements SessionHandlingAction interface.
        Returns:
        The Registration for the handler.

      • issueRequest

        default HttpRequestResponse issueRequest​(HttpRequest request)
        This method can be used to issue HTTP requests and retrieve their responses.
        Parameters:
        request - The full HTTP request.
        Returns:
        An object that implements the HttpRequestResponse interface, and which the extension can query to obtain the details of the response.

      • issueRequest

        default HttpRequestResponse issueRequest​(HttpRequest request,
                                         HttpMode httpMode)
        This method can be used to issue HTTP requests and retrieve their responses.
        Parameters:
        request - The full HTTP request.
        httpMode - An HttpMode enum value which indicates how a request should be sent.
        Returns:
        An object that implements the HttpRequestResponse interface, and which the extension can query to obtain the details of the response.

      • issueRequest

        HttpRequestResponse issueRequest​(HttpRequest request,
                                 HttpMode httpMode,
                                 java.lang.String connectionId)
        This method can be used to issue HTTP requests and retrieve their responses.
        Parameters:
        request - The full HTTP request.
        httpMode - An HttpMode enum value which indicates how a request should be sent.
        connectionId - The identifier for the connection you want to use.
        Returns:
        An object that implements the HttpRequestResponse interface, and which the extension can query to obtain the details of the response.

      • createResponseKeywordsAnalyzer

        ResponseKeywordsAnalyzer createResponseKeywordsAnalyzer​(java.util.List<java.lang.String> keywords)
        This method is used to create a new response keyword analyzer.
        Parameters:
        keywords - A list of keywords the analyzer will look for.
        Returns:
        A new ResponseKeywordsAnalyzer instance.

      • cookieJar

        CookieJar cookieJar()
        This method is used to access the Cookie Jar.
        Returns:
        The CookieJar instance.