Package burp.api.montoya.intruder

Interface PayloadProcessingResult

public interface PayloadProcessingResult

An instance of this interface should be returned by PayloadProcessor.processPayload(burp.api.montoya.intruder.PayloadData) if a custom PayloadProcessor was registered with Intruder.

Method Summary

Modifier and Type	Method	Description
PayloadProcessingAction	action()	Invoked by Burp to see what action it should perform with the payload.
static PayloadProcessingResult	payloadProcessingResult(ByteArray processedPayload, PayloadProcessingAction action)
ByteArray	processedPayload()
static PayloadProcessingResult	skipPayload()	Create a new instance of PayloadProcessingResult with a PayloadProcessingAction.SKIP_PAYLOAD action.
static PayloadProcessingResult	usePayload(ByteArray processedPayload)	Create a new instance of PayloadProcessingResult with a PayloadProcessingAction.USE_PAYLOAD action.

Method Details

processedPayload

ByteArray processedPayload()

Returns:

The current value of the processed payload.

action

PayloadProcessingAction action()

Invoked by Burp to see what action it should perform with the payload. If the value is PayloadProcessingAction.USE_PAYLOAD, Burp will use the payload in the attack or skip it if the value is PayloadProcessingAction.SKIP_PAYLOAD.

Returns:

Action to perform with the payload.

usePayload

static PayloadProcessingResult usePayload(ByteArray processedPayload)

Create a new instance of PayloadProcessingResult with a PayloadProcessingAction.USE_PAYLOAD action.

Parameters:

processedPayload - Processed payload value

Returns:

A new PayloadProcessingResult instance.

skipPayload

static PayloadProcessingResult skipPayload()

Create a new instance of PayloadProcessingResult with a PayloadProcessingAction.SKIP_PAYLOAD action.

Returns:

A new PayloadProcessingResult instance.

payloadProcessingResult

static PayloadProcessingResult payloadProcessingResult(ByteArray processedPayload,
 PayloadProcessingAction action)