burp

Interface IIntruderPayloadGenerator

public interface IIntruderPayloadGenerator

This interface is used for custom Intruder payload generators. Extensions that have registered an IIntruderPayloadGeneratorFactory must return a new instance of this interface when required as part of a new Intruder attack.

Method Summary

Modifier and Type	Method and Description
byte[]	getNextPayload(byte[] baseValue) This method is used by Burp to obtain the value of the next payload.
boolean	hasMorePayloads() This method is used by Burp to determine whether the payload generator is able to provide any further payloads.
void	reset() This method is used by Burp to reset the state of the payload generator so that the next call to getNextPayload() returns the first payload again.

Method Detail

hasMorePayloads

boolean hasMorePayloads()

This method is used by Burp to determine whether the payload generator is able to provide any further payloads.

Returns:

Extensions should return false when all the available payloads have been used up, otherwise true.

getNextPayload

byte[] getNextPayload(byte[] baseValue)

This method is used by Burp to obtain the value of the next payload.

Parameters:

baseValue - The base value of the current payload position. This value may be null if the concept of a base value is not applicable (e.g. in a battering ram attack).

Returns:

The next payload to use in the attack.

reset

void reset()

This method is used by Burp to reset the state of the payload generator so that the next call to getNextPayload() returns the first payload again. This method will be invoked when an attack uses the same payload generator for more than one payload position, for example in a sniper attack.