Package burp.api.montoya.collaborator

Interface CollaboratorClient

  • public interface CollaboratorClient
    This interface represents an instance of a 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 Detail

      • generatePayload

        CollaboratorPayload generatePayload​(PayloadOption... options)
        This method is used to 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.
        Parameters:
        options - The optional payload options to apply
        Returns:
        The generated payload.
        Throws:
        java.lang.IllegalStateException - if Burp Collaborator is disabled

      • generatePayload

        CollaboratorPayload generatePayload​(java.lang.String customData,
                                    PayloadOption... options)
        This method is used to 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:
        java.lang.IllegalStateException - if Burp Collaborator is disabled

      • getAllInteractions

        java.util.List<Interaction> getAllInteractions()
        This method is used to 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:
        java.lang.IllegalStateException - if Burp Collaborator is disabled

      • getInteractions

        java.util.List<Interaction> getInteractions​(InteractionFilter filter)
        This method is used to 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:
        java.lang.IllegalStateException - if Burp Collaborator is disabled

      • server

        CollaboratorServer server()
        This method is used to retrieve the details of the Collaborator server associated with this client.
        Returns:
        The Collaborator server details.
        Throws:
        java.lang.IllegalStateException - if Burp Collaborator is disabled

      • getSecretKey

        SecretKey getSecretKey()
        This provides the 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.