burp.api.montoya.proxy.http.ProxyResponseToBeSentAction 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.responses.HttpResponse;
import burp.api.montoya.proxy.MessageToBeSentAction;

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

/**
 * Extensions can implement this interface when returning a result from
 * {@link ProxyResponseHandler#handleResponseToBeSent(InterceptedResponse)}.
 */
public interface ProxyResponseToBeSentAction
{
    /**
     * This method retrieves the current final intercept action.
     *
     * @return The {@link MessageToBeSentAction}.
     */
    MessageToBeSentAction action();

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

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

    /**
     * This method can be used to create a result that causes Burp Proxy to
     * forward the response.

     * Annotations are not modified.
     *
     * @param response The {@link HttpResponse} to forward after any
     *                 modifications by the extension.
     *
     * @return The {@link ProxyResponseToBeSentAction} that causes Burp Proxy
     * to forward the response.
     */
    static ProxyResponseToBeSentAction continueWith(HttpResponse response)
    {
        return FACTORY.responseFinalInterceptResultContinueWith(response);
    }

    /**
     * This method can be used to create a result that causes Burp Proxy to
     * forward the response.
     *
     * @param response    The {@link HttpResponse} to forward after any modifications by the extension.
     * @param annotations The {@link Annotations} for the intercepted HTTP response.
     *
     * @return The {@link ProxyResponseToBeSentAction} that causes Burp Proxy
     * to forward the response.
     */
    static ProxyResponseToBeSentAction continueWith(HttpResponse response, Annotations annotations)
    {
        return FACTORY.responseFinalInterceptResultContinueWith(response, annotations);
    }

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

    /**
     * This method can be used to create a default implementation of a final
     * intercept result for an HTTP response.
     *
     * @param response    The {@link HttpResponse} to forward after any modifications by the extension.
     * @param annotations The {@link Annotations} for the intercepted HTTP response. {@code null} value will leave the annotations unmodified.
     * @param action      The {@link MessageToBeSentAction} for the HTTP response.
     *
     * @return The {@link ProxyResponseToBeSentAction} including the HTTP
     * response, annotations and final intercept action.
     */
    static ProxyResponseToBeSentAction proxyResponseToReturnAction(HttpResponse response, Annotations annotations, MessageToBeSentAction action)
    {
        return FACTORY.proxyResponseToReturnAction(response, annotations, action);
    }
}