Package burp.api.montoya.http

Interface Http

public interface Http
Provides access HTTP related functionality of Burp.

  • Method Details

    • registerHttpHandler

      Registration registerHttpHandler(HttpHandler handler)
      Register a handler which will perform an action when a request is about to be sent 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 sessionHandlingAction)
      Register a custom session handler. Each registered handler will be available within the session handling rule UI for the user to select as a rule action. Users can choose to invoke a handler directly in its own right, or following execution of a macro.
      Parameters:
      sessionHandlingAction - An object created by the extension that implements SessionHandlingAction interface.
      Returns:
      The Registration for the handler.

    • sendRequest

      HttpRequestResponse sendRequest(HttpRequest request)
      Send 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.

    • sendRequest

      HttpRequestResponse sendRequest(HttpRequest request, HttpMode httpMode)
      Send 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.

    • sendRequest

      HttpRequestResponse sendRequest(HttpRequest request, HttpMode httpMode, String connectionId)
      Send 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.

    • sendRequest

      HttpRequestResponse sendRequest(HttpRequest request, RequestOptions requestOptions)
      Send HTTP request with specific request options and retrieve its response.
      Parameters:
      request - The full HTTP request.
      requestOptions - A RequestOptions 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.

    • sendRequests

      List<HttpRequestResponse> sendRequests(List<HttpRequest> requests)
      Send HTTP requests in parallel and retrieve their responses.
      Parameters:
      requests - The list of full HTTP requests.
      Returns:
      A list of objects that implement the HttpRequestResponse interface, and which the extension can query to obtain the details of the responses.

    • sendRequests

      List<HttpRequestResponse> sendRequests(List<HttpRequest> requests, HttpMode httpMode)
      Send HTTP requests in parallel and retrieve their responses.
      Parameters:
      requests - The list of full HTTP requests.
      httpMode - An HttpMode enum value which indicates how a request should be sent.
      Returns:
      A list of objects that implement the HttpRequestResponse interface, and which the extension can query to obtain the details of the responses.

    • createResponseKeywordsAnalyzer

      ResponseKeywordsAnalyzer createResponseKeywordsAnalyzer(List<String> keywords)
      Create a new response keyword analyzer.
      Parameters:
      keywords - A list of keywords the analyzer will look for.
      Returns:
      A new ResponseKeywordsAnalyzer instance.

    • createResponseVariationsAnalyzer

      ResponseVariationsAnalyzer createResponseVariationsAnalyzer()
      Create a new response variations analyzer.
      Returns:
      A new ResponseKeywordsAnalyzer instance.

    • cookieJar

      CookieJar cookieJar()
      Access the Cookie Jar.
      Returns:
      The CookieJar instance.