Package burp.api.montoya.scanner.audit.insertionpoint

Interface AuditInsertionPoint

All Superinterfaces:

ExtensionGeneratedAuditInsertionPoint

public interface AuditInsertionPoint
extends ExtensionGeneratedAuditInsertionPoint

This interface is used to define an insertion point for use by active Scan checks. Extensions can obtain instances of this interface by registering an ScanCheck, or can create instances for use by Burp's own scan checks by registering an AuditInsertionPointProvider.

Method Summary

Modifier and Type	Method	Description
static AuditInsertionPoint	auditInsertionPoint(java.lang.String name, HttpRequest baseRequest, int startIndexInclusive, int endIndexExclusive)	This method can be used to create an audit insertion point based on offsets.
AuditInsertionPointType	type()	This method returns the type of this insertion point.

Methods inherited from interface burp.api.montoya.scanner.audit.insertionpoint.ExtensionGeneratedAuditInsertionPoint

baseValue, buildHttpMessageWithPayload, issueHighlights, name

Method Detail

auditInsertionPoint

static AuditInsertionPoint auditInsertionPoint(java.lang.String name,
                                               HttpRequest baseRequest,
                                               int startIndexInclusive,
                                               int endIndexExclusive)

This method can be used to create an audit insertion point based on offsets.

Parameters:

name - The name of the audit insertion point.

baseRequest - The base HttpRequest.

startIndexInclusive - The start index inclusive.

endIndexExclusive - The end index exclusive.

Returns:

The AuditInsertionPoint based on offsets.

type

AuditInsertionPointType type()

This method returns the type of this insertion point.

Returns:

The AuditInsertionPointType for this insertion point.