burp.api.montoya.proxy.http.ProxyRequestReceivedAction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of montoya-api Show documentation
There is a newer version: 2024.12
/*
 * Copyright (c) 2022-2023. PortSwigger Ltd. All rights reserved.
 *
 * This code may be used to extend the functionality of Burp Suite Community Edition
 * and Burp Suite Professional, provided that this usage does not violate the
 * license terms for those products.
 */

package burp.api.montoya.proxy.http;

import burp.api.montoya.core.Annotations;
import burp.api.montoya.http.message.requests.HttpRequest;
import burp.api.montoya.proxy.MessageReceivedAction;

import static burp.api.montoya.internal.ObjectFactoryLocator.FACTORY;

/**
 * Extensions can implement this interface when returning a result from
 * {@link ProxyRequestHandler#handleRequestReceived(InterceptedRequest)}.
 */
public interface ProxyRequestReceivedAction
{
    /**
     * This method retrieves the current initial intercept action.
     *
     * @return The {@link MessageReceivedAction}.
     */
    MessageReceivedAction action();

    /**
     * This method retrieves the current HTTP request to forward after any
     * modifications by the extension.
     *
     * @return The {@link HttpRequest} to forward after any modifications by
     * the extension.
     */
    HttpRequest request();

    /**
     * This method retrieves the annotations for the current request after any
     * modifications by the extension.
     *
     * @return The {@link Annotations} for the intercepted HTTP request.
     */
    Annotations annotations();

    /**
     * This method can be used to create a result that causes Burp Proxy to
     * follow the current interception rules to determine the appropriate
     * action to take for the request.

     * Annotations are not modified.
     *
     * @param request The {@link HttpRequest} received after any modifications
     *                by the extension.
     *
     * @return The {@link ProxyRequestReceivedAction} that allows user rules to be
     * followed.
     */
    static ProxyRequestReceivedAction continueWith(HttpRequest request)
    {
        return FACTORY.requestInitialInterceptResultFollowUserRules(request);
    }

    /**
     * This method can be used to create a result that causes Burp Proxy to
     * follow the current interception rules to determine the appropriate
     * action to take for the request.
     *
     * @param request     The {@link HttpRequest} received after any modifications
     *                    by the extension.
     * @param annotations The {@link Annotations} for the intercepted
     *                    HTTP request.
     *
     * @return The {@link ProxyRequestReceivedAction} that causes Burp Proxy
     * to follow the current interception rules to determine the appropriate
     * action to take for the request.
     */
    static ProxyRequestReceivedAction continueWith(HttpRequest request, Annotations annotations)
    {
        return FACTORY.requestInitialInterceptResultFollowUserRules(request, annotations);
    }

    /**
     * This method can be used to create a result that causes Burp Proxy to
     * present the request to the user for manual review or modification.

     * Annotations are not modified.
     *
     * @param request The {@link HttpRequest} received after any modifications
     *                by the extension.
     *
     * @return The {@link ProxyRequestReceivedAction} that causes Burp Proxy
     * to present the request to the user for manual review or modification.
     */
    static ProxyRequestReceivedAction intercept(HttpRequest request)
    {
        return FACTORY.requestInitialInterceptResultIntercept(request);
    }

    /**
     * This method can be used to create a result that causes Burp Proxy to
     * present the request to the user for manual review or modification.
     *
     * @param request     The {@link HttpRequest} received after any modifications
     *                    by the extension.
     * @param annotations The {@link Annotations} for the intercepted
     *                    HTTP request.
     *
     * @return The {@link ProxyRequestReceivedAction} that causes Burp Proxy
     * to present the request to the user for manual review or modification.
     */
    static ProxyRequestReceivedAction intercept(HttpRequest request, Annotations annotations)
    {
        return FACTORY.requestInitialInterceptResultIntercept(request, annotations);
    }

    /**
     * This method can be used to create a result that causes Burp Proxy to
     * forward the request without presenting it to the user. 

     * Annotations are not modified.
     *
     * @param request The {@link HttpRequest} received after any modifications
     *                by the extension.
     *
     * @return The {@link ProxyRequestReceivedAction} that causes Burp Proxy
     * to forward the request without presenting it to the user.
     */
    static ProxyRequestReceivedAction doNotIntercept(HttpRequest request)
    {
        return FACTORY.requestInitialInterceptResultDoNotIntercept(request);
    }

    /**
     * This method can be used to create a result that causes Burp Proxy to
     * forward the request without presenting it to the user.
     *
     * @param request     The {@link HttpRequest} received after any modifications
     *                    by the extension.
     * @param annotations The {@link Annotations} for the intercepted
     *                    HTTP request.
     *
     * @return The {@link ProxyRequestReceivedAction} that causes Burp Proxy
     * to forward the request without presenting it to the user.
     */
    static ProxyRequestReceivedAction doNotIntercept(HttpRequest request, Annotations annotations)
    {
        return FACTORY.requestInitialInterceptResultDoNotIntercept(request, annotations);
    }

    /**
     * This method can be used to create a result that causes Burp Proxy to
     * drop the request.
     *
     * @return The {@link ProxyRequestReceivedAction} that causes Burp Proxy
     * to drop the request.
     */
    static ProxyRequestReceivedAction drop()
    {
        return FACTORY.requestInitialInterceptResultDrop();
    }

    /**
     * This method can be used to create a default implementation of an initial
     * intercept result for an HTTP request.
     *
     * @param request     The {@link HttpRequest} received after any modifications by the extension.
     * @param annotations The {@link Annotations} for the intercepted HTTP request. {@code null} value will leave the annotations unmodified.
     * @param action      The {@link MessageReceivedAction} for the HTTP request.
     *
     * @return The {@link ProxyRequestReceivedAction} including the HTTP
     * request, annotations and initial intercept action.
     */
    static ProxyRequestReceivedAction proxyRequestReceivedAction(HttpRequest request, Annotations annotations, MessageReceivedAction action)
    {
        return FACTORY.proxyRequestReceivedAction(request, annotations, action);
    }
}