|
| 1 | +package burp; |
| 2 | + |
| 3 | +/* |
| 4 | + * @(#)IBurpCollaboratorClientContext.java |
| 5 | + * |
| 6 | + * Copyright PortSwigger Ltd. All rights reserved. |
| 7 | + * |
| 8 | + * This code may be used to extend the functionality of Burp Suite Community Edition |
| 9 | + * and Burp Suite Professional, provided that this usage does not violate the |
| 10 | + * license terms for those products. |
| 11 | + */ |
| 12 | +import java.util.List; |
| 13 | + |
| 14 | +/** |
| 15 | + * This interface represents an instance of a Burp Collaborator client context, |
| 16 | + * which can be used to generate Burp Collaborator payloads and poll the |
| 17 | + * Collaborator server for any network interactions that result from using those |
| 18 | + * payloads. Extensions can obtain new instances of this class by calling |
| 19 | + * <code>IBurpExtenderCallbacks.createBurpCollaboratorClientContext()</code>. |
| 20 | + * Note that each Burp Collaborator client context is tied to the Collaborator |
| 21 | + * server configuration that was in place at the time the context was created. |
| 22 | + */ |
| 23 | +public interface IBurpCollaboratorClientContext |
| 24 | +{ |
| 25 | + |
| 26 | + /** |
| 27 | + * This method is used to generate new Burp Collaborator payloads. |
| 28 | + * |
| 29 | + * @param includeCollaboratorServerLocation Specifies whether to include the |
| 30 | + * Collaborator server location in the generated payload. |
| 31 | + * @return The payload that was generated. |
| 32 | + * |
| 33 | + * @throws IllegalStateException if Burp Collaborator is disabled |
| 34 | + */ |
| 35 | + String generatePayload(boolean includeCollaboratorServerLocation); |
| 36 | + |
| 37 | + /** |
| 38 | + * This method is used to retrieve all interactions received by the |
| 39 | + * Collaborator server resulting from payloads that were generated for this |
| 40 | + * context. |
| 41 | + * |
| 42 | + * @return The Collaborator interactions that have occurred resulting from |
| 43 | + * payloads that were generated for this context. |
| 44 | + * |
| 45 | + * @throws IllegalStateException if Burp Collaborator is disabled |
| 46 | + */ |
| 47 | + List<IBurpCollaboratorInteraction> fetchAllCollaboratorInteractions(); |
| 48 | + |
| 49 | + /** |
| 50 | + * This method is used to retrieve interactions received by the Collaborator |
| 51 | + * server resulting from a single payload that was generated for this |
| 52 | + * context. |
| 53 | + * |
| 54 | + * @param payload The payload for which interactions will be retrieved. |
| 55 | + * @return The Collaborator interactions that have occurred resulting from |
| 56 | + * the given payload. |
| 57 | + * |
| 58 | + * @throws IllegalStateException if Burp Collaborator is disabled |
| 59 | + */ |
| 60 | + List<IBurpCollaboratorInteraction> fetchCollaboratorInteractionsFor(String payload); |
| 61 | + |
| 62 | + /** |
| 63 | + * This method is used to retrieve all interactions made by Burp Infiltrator |
| 64 | + * instrumentation resulting from payloads that were generated for this |
| 65 | + * context. |
| 66 | + * |
| 67 | + * @return The interactions triggered by the Burp Infiltrator |
| 68 | + * instrumentation that have occurred resulting from payloads that were |
| 69 | + * generated for this context. |
| 70 | + * |
| 71 | + * @throws IllegalStateException if Burp Collaborator is disabled |
| 72 | + */ |
| 73 | + List<IBurpCollaboratorInteraction> fetchAllInfiltratorInteractions(); |
| 74 | + |
| 75 | + /** |
| 76 | + * This method is used to retrieve interactions made by Burp Infiltrator |
| 77 | + * instrumentation resulting from a single payload that was generated for |
| 78 | + * this context. |
| 79 | + * |
| 80 | + * @param payload The payload for which interactions will be retrieved. |
| 81 | + * @return The interactions triggered by the Burp Infiltrator |
| 82 | + * instrumentation that have occurred resulting from the given payload. |
| 83 | + * |
| 84 | + * @throws IllegalStateException if Burp Collaborator is disabled |
| 85 | + */ |
| 86 | + List<IBurpCollaboratorInteraction> fetchInfiltratorInteractionsFor(String payload); |
| 87 | + |
| 88 | + /** |
| 89 | + * This method is used to retrieve the network location of the Collaborator |
| 90 | + * server. |
| 91 | + * |
| 92 | + * @return The hostname or IP address of the Collaborator server. |
| 93 | + * |
| 94 | + * @throws IllegalStateException if Burp Collaborator is disabled |
| 95 | + */ |
| 96 | + String getCollaboratorServerLocation(); |
| 97 | +} |
0 commit comments