burp.api.montoya.scanner.audit.Audit 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.scanner.audit;

import burp.api.montoya.core.Range;
import burp.api.montoya.http.message.HttpRequestResponse;
import burp.api.montoya.http.message.requests.HttpRequest;
import burp.api.montoya.scanner.ScanTask;
import burp.api.montoya.scanner.audit.issues.AuditIssue;

import java.util.List;

/**
 * Audit in the Burp Scanner tool.
 */
public interface Audit extends ScanTask
{
    /**
     * This method retrieves the number of insertion points.
     *
     * @return The number of insertion points.
     */
    int insertionPointCount();

    /**
     * This method retrieves the audit issues found by this audit.
     *
     * @return The list of {@link AuditIssue}s found by this audit.
     */
    List issues();

    /**
     * This method can be used to add an HTTP request to this audit.
     *
     * @param request The {@link HttpRequest} to add to this audit.
     */
    void addRequest(HttpRequest request);

    /**
     * This method can be used to add an HTTP request to this audit.
     *
     * @param request               The {@link HttpRequest} to add to this audit.
     * @param insertionPointOffsets The list of {@link Range}s representing the
     *                              insertion point offsets.
     */
    void addRequest(HttpRequest request, List insertionPointOffsets);

    /**
     * This method can be used to add an HTTP request and response to this
     * audit.
     *
     * @param requestResponse The {@link HttpRequestResponse} to add to this
     *                        audit.
     */
    void addRequestResponse(HttpRequestResponse requestResponse);

    /**
     * Number of requests that have been made for the
     * scan task.
     *
     * @return The number of requests that have been made for the scan task.
     */
    @Override
    int requestCount();

    /**
     * Number of network errors that have occurred for
     * the scan task.
     *
     * @return The number of network errors that have occurred for the scan
     * task.
     */
    @Override
    int errorCount();

    /**
     * Delete the task.
     */
    @Override
    void delete();

    /**
     * @return the current status message of the task
     */
    @Override
    String statusMessage();
}