Package burp.api.montoya.collaborator

Interface Collaborator

public interface Collaborator

[Professional only] Provides access to the facilities of Burp Collaborator.

Method Summary

Modifier and Type	Method	Description
CollaboratorClient	createClient()	Create a new 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.
CollaboratorPayloadGenerator	defaultPayloadGenerator()	Obtain Burp's default Collaborator payload generator.
CollaboratorClient	restoreClient(SecretKey secretKey)	Restore a CollaboratorClient from a previous session.

Method Details

createClient

CollaboratorClient createClient()

Create a new 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.

Returns:

A new instance of CollaboratorClient that can be used to generate Collaborator payloads and retrieve interactions.

restoreClient

CollaboratorClient restoreClient(SecretKey secretKey)

Restore a CollaboratorClient from a previous session. This allows you to retrieve the interactions that were identified from a specific payloads.

Parameters:

secretKey - The key to restore the CollaboratorClient from the previous session.

Returns:

A new instance of CollaboratorClient that can be used to generate Collaborator payloads and retrieve interactions.

defaultPayloadGenerator

CollaboratorPayloadGenerator defaultPayloadGenerator()

Obtain Burp's default Collaborator payload generator. This enables you to generate Collaborator payloads that are linked to the Collaborator tab. Any interactions are shown in the Collaborator results tab that was open when the payload was generated.

Returns:

The current instance of Burp's default CollaboratorPayloadGenerator.