burp

Interface IBurpCollaboratorClientContext

public interface IBurpCollaboratorClientContext

This interface represents an instance of a Burp Collaborator client context, which 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 IBurpExtenderCallbacks.createBurpCollaboratorClientContext(). Note that each Burp Collaborator client context is tied to the Collaborator server configuration that was in place at the time the context was created.

Method Summary

Modifier and Type	Method and Description
java.util.List<IBurpCollaboratorInteraction>	fetchAllCollaboratorInteractions() This method is used to retrieve all interactions received by the Collaborator server resulting from payloads that were generated for this context.
java.util.List<IBurpCollaboratorInteraction>	fetchAllInfiltratorInteractions() This method is used to retrieve all interactions made by Burp Infiltrator instrumentation resulting from payloads that were generated for this context.
java.util.List<IBurpCollaboratorInteraction>	fetchCollaboratorInteractionsFor(java.lang.String payload) This method is used to retrieve interactions received by the Collaborator server resulting from a single payload that was generated for this context.
java.util.List<IBurpCollaboratorInteraction>	fetchInfiltratorInteractionsFor(java.lang.String payload) This method is used to retrieve interactions made by Burp Infiltrator instrumentation resulting from a single payload that was generated for this context.
java.lang.String	generatePayload(boolean includeCollaboratorServerLocation) This method is used to generate new Burp Collaborator payloads.
java.lang.String	getCollaboratorServerLocation() This method is used to retrieve the network location of the Collaborator server.

Method Detail

generatePayload

java.lang.String generatePayload(boolean includeCollaboratorServerLocation)

This method is used to generate new Burp Collaborator payloads.

Parameters:

includeCollaboratorServerLocation - Specifies whether to include the Collaborator server location in the generated payload.

Returns:

The payload that was generated.

Throws:

java.lang.IllegalStateException - if Burp Collaborator is disabled

fetchAllCollaboratorInteractions

java.util.List<IBurpCollaboratorInteraction> fetchAllCollaboratorInteractions()

This method is used to retrieve all interactions received by the Collaborator server resulting from payloads that were generated for this context.

Returns:

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

Throws:

java.lang.IllegalStateException - if Burp Collaborator is disabled

fetchCollaboratorInteractionsFor

java.util.List<IBurpCollaboratorInteraction> fetchCollaboratorInteractionsFor(java.lang.String payload)

This method is used to retrieve interactions received by the Collaborator server resulting from a single payload that was generated for this context.

Parameters:

payload - The payload for which interactions will be retrieved.

Returns:

The Collaborator interactions that have occurred resulting from the given payload.

Throws:

java.lang.IllegalStateException - if Burp Collaborator is disabled

fetchAllInfiltratorInteractions

java.util.List<IBurpCollaboratorInteraction> fetchAllInfiltratorInteractions()

This method is used to retrieve all interactions made by Burp Infiltrator instrumentation resulting from payloads that were generated for this context.

Returns:

The interactions triggered by the Burp Infiltrator instrumentation that have occurred resulting from payloads that were generated for this context.

Throws:

java.lang.IllegalStateException - if Burp Collaborator is disabled

fetchInfiltratorInteractionsFor

java.util.List<IBurpCollaboratorInteraction> fetchInfiltratorInteractionsFor(java.lang.String payload)

This method is used to retrieve interactions made by Burp Infiltrator instrumentation resulting from a single payload that was generated for this context.

Parameters:

payload - The payload for which interactions will be retrieved.

Returns:

The interactions triggered by the Burp Infiltrator instrumentation that have occurred resulting from the given payload.

Throws:

java.lang.IllegalStateException - if Burp Collaborator is disabled

getCollaboratorServerLocation

java.lang.String getCollaboratorServerLocation()

This method is used to retrieve the network location of the Collaborator server.

Returns:

The hostname or IP address of the Collaborator server.

Throws:

java.lang.IllegalStateException - if Burp Collaborator is disabled