Package burp.api.montoya.collaborator

Interface CollaboratorClient

All Superinterfaces:

CollaboratorPayloadGenerator

public interface CollaboratorClient
extends CollaboratorPayloadGenerator

Burp Collaborator client that can be used to generate Burp Collaborator payloads and poll the Collaborator server for any network interactions that result from using those payloads. Extensions can obtain new instances of this class by calling Collaborator.createClient().

Note that each Burp Collaborator client is tied to the Collaborator server configuration that was in place at the time the client was created.

Method Summary

Modifier and Type	Method	Description
CollaboratorPayload	generatePayload(PayloadOption... options)	Generate new Burp Collaborator payloads.
CollaboratorPayload	generatePayload(String customData, PayloadOption... options)	Generate new Burp Collaborator payloads with custom data.
List<Interaction>	getAllInteractions()	Retrieve all Collaborator server interactions resulting from payloads that were generated for this client.
List<Interaction>	getInteractions(InteractionFilter filter)	Retrieve filtered Collaborator server interactions resulting from payloads that were generated for this client.
SecretKey	getSecretKey()	Secret key that is associated with this client context.
CollaboratorServer	server()	Retrieve the details of the Collaborator server associated with this client.

Method Details

generatePayload

CollaboratorPayload generatePayload(PayloadOption... options)

Generate new Burp Collaborator payloads. Options can be specified to alter the way the payloads are generated. If no options are specified, generated payloads will include the server location.

Specified by:

generatePayload in interface CollaboratorPayloadGenerator

Parameters:

options - The optional payload options to apply

Returns:

The generated payload.

Throws:

IllegalStateException - if Burp Collaborator is disabled

generatePayload

CollaboratorPayload generatePayload(String customData,
 PayloadOption... options)

Generate new Burp Collaborator payloads with custom data. The custom data can be retrieved from any Interaction triggered. Options can be specified to alter the way the payloads are generated. If no options are specified, generated payloads will include the server location.

Parameters:

customData - The custom data to add to the payload. Maximum size is 16 characters. Must be alphanumeric.

options - The optional payload options to apply

Returns:

The generated payload.

Throws:

IllegalStateException - if Burp Collaborator is disabled

getAllInteractions

List<Interaction> getAllInteractions()

Retrieve all Collaborator server interactions resulting from payloads that were generated for this client.

Returns:

The Collaborator interactions that have occurred resulting from payloads that were generated for this client.

Throws:

IllegalStateException - if Burp Collaborator is disabled

getInteractions

List<Interaction> getInteractions(InteractionFilter filter)

Retrieve filtered Collaborator server interactions resulting from payloads that were generated for this client. Only interactions matching the supplied filter will be returned.

Parameters:

filter - The filter that will be applied to each interaction.

Returns:

The filtered Collaborator interactions resulting from payloads that were generated for this client.

Throws:

IllegalStateException - if Burp Collaborator is disabled

server

CollaboratorServer server()

Retrieve the details of the Collaborator server associated with this client.

Returns:

The Collaborator server details.

Throws:

IllegalStateException - if Burp Collaborator is disabled

getSecretKey

SecretKey getSecretKey()

Secret key that is associated with this client context. The key can be used to re-create this client again with the interaction data if required.

Returns:

The SecretKey that is associated with this Collaborator client.