All Classes
-
All Classes Interface Summary Class Summary Enum Summary Exception Summary Class Description Annotations This interface represents annotations that can be applied to a message.AttackConfiguration This interface is used to represent an Intruder attack configuration.Attribute This interface is used to hold details about HTTP response attributes.AttributeType This enum defines various options that Burp can use to query attributes of HTTP responses.Audit This interface represents an instance of an audit in the Burp Scanner tool.AuditInsertionPoint This interface is used to define an insertion point for use by active Scan checks.AuditInsertionPointProvider Extensions can implement this interface and then callScanner.registerInsertionPointProvider(AuditInsertionPointProvider)to register a provider for custom audit insertion points.AuditInsertionPointType This enum represents the audit insertion point type.AuditIssue This interface is used to retrieve details of audit issues.AuditIssueConfidence This enum represents the confidence level of an audit issue.AuditIssueDefinition This interface is used to retrieve background information about audit issues.AuditIssueHandler Extensions can implement this interface and then callScanner.registerAuditIssueHandler(AuditIssueHandler)to register an audit issue handler.AuditIssueSeverity This enum represents the severity level of an audit issue.Base64Utils This interface contains various methods that give you access to base64 encoding and decoding features.BuiltInScanConfiguration This enum represents built in configurations for the Burp Scanner tool.BurpExtension All extensions must implement this interface.BurpSuite This interface provides access to functionality related to the Burp Suite application.BurpSuiteEdition ByteArray This interface provides access to various methods for querying and manipulating byte arrays.ByteArraySupport ByteUtils This interface gives you access to various methods for querying and manipulating byte arrays.Collaborator This interface provides access to the facilities of Burp Collaborator.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.CollaboratorPayload This interface represents a Burp Collaborator payload.CollaboratorServer This interface provides details of the Collaborator server associated with this client.Comparer This interface provides access to the functionality of the Comparer tool.ComponentEvent This interface describes an action or event that has occurred with a user interface component.CompressionType This enum defines available compression types.CompressionUtils This interface gives you access to data compression features.ConsolidationAction This enum represents the action to be taken when duplicate audit issues are found.ContentType This enum defines content types recognised by Burp.ContextMenuEvent This interface provides useful information when generating context menu items from aContextMenuItemsProvider.ContextMenuItemsProvider This interface allows extensions to implement and register a provider for custom context menu items.Cookie This interface is used to hold details about an HTTP cookie.CookieJar This interface is used to access Burp's Cookie Jar functionality.Crawl This interface represents an instance of a crawl in the Burp Scanner tool.CrawlAndAudit This interface represents an instance of a crawl and audit in the Burp Scanner tool.CryptoUtils This interface gives you access to cryptographic features.Decoder This interface provides access to the functionality of the Decoder tool.DeleteSupport DigestAlgorithm Enum of available message digest algorithms.Direction This enum is used to indicate the direction of the WebSocket message.DnsDetails This interface provides information about a DNS interaction detected by Burp Collaborator.DnsQueryType This enum represents Domain Name System (DNS) query types.Editor This interface provides the shared behaviour between the different editor types available from the Extensions API.EditorMode An enum to describe the different modes of Burp Suites message editor.EditorOptions These options allow you to configure additional behaviour toEditorimplementations.Extension This interface provides access to functionality related to your Extension.ExtensionGeneratedAuditInsertionPoint This interface is used to define an insertion point for use by Scan checks.ExtensionHttpMessageEditor This interface provides shared information for theExtensionHttpRequestEditorandExtensionHttpResponseEditorinterfacesExtensionHttpRequestEditor Extensions that register anExtensionHttpRequestEditorProvidermust return an instance of this interface.ExtensionHttpRequestEditorProvider Extensions can register an instance of this interface to provide custom HTTP request editors within Burp's user interface.ExtensionHttpResponseEditor Extensions that register anExtensionHttpResponseEditorProvidermust return an instance of this interface.ExtensionHttpResponseEditorProvider Extensions can register an instance of this interface to provide custom HTTP response editors within Burp's user interface.ExtensionUnloadingHandler Extensions can implement this interface and then callExtension.registerUnloadingHandler(ExtensionUnloadingHandler)(ExtensionUnloadingHandler)} to register an extension unload handler.FinalInterceptAction This enum represents the final action to be taken when intercepting HTTP and WebSocket messages in the Proxy.HighlightColor This enum represents colors that can be used for highlights in Burp Suite.HtmlEncoding This enum defines HTML encodings.HtmlUtils This interface gives you access to HTML encoding and decoding features.Http This interface is used to access HTTP related functionality of Burp.HttpDetails This interface provides information about an HTTP interaction detected by Burp Collaborator.HttpHandler Extensions can implement this interface and then callHttp.registerHttpHandler(burp.api.montoya.http.HttpHandler)to register an HTTP handler.HttpHeader This interface is used to hold details about an HTTP/2 header.HttpMessage This interface is used to retrieve common information shared byHttpRequestandHttpResponseinterfaces.HttpMode This enum defines HTTP modes.HttpParameter This interface is used to hold details about an HTTP request parameter.HttpParameterType An enum to define HTTP parameter types.HttpProtocol This enum defines HTTP protocols.HttpRequest This interface is used to retrieve key details about an HTTP request.HttpRequestEditor This interface provides extensions with an instance of Burp Suites HTTP request editor to use in their own user interface.HttpRequestResponse This interface is used to define a coupling betweenHttpRequestandHttpResponseinterfaces.HttpRequestTemplate This interface is used to represent an Intruder request template, which contains the HTTP request and insertion point offsets.HttpResponse This interface is used to retrieve key details about an HTTP response.HttpResponseEditor This interface provides extensions with an instance of Burp Suites HTTP response editor to use in their own user interface.HttpService This interface is used to provide details about an HTTP service, to which HTTP requests can be sent.HttpTransformation This enum defines transformations that Burp can apply to an HTTP request.InitialInterceptAction This enum represents the initial action to be taken when intercepting HTTP and WebSocket messages in the Proxy.Interaction This interface provides details of an interaction with the Burp Collaborator server.InteractionFilter This interface provides a filtering mechanism for use when retrieving interactions from the Burp Collaborator server.InteractionId This interface represents a Burp Collaborator interaction id.InteractionType This enum defines the possible types of interaction with Burp Collaborator.InterceptedHttpRequest This interface represents an instance of an HTTP request intercepted by Burp Proxy.InterceptedHttpResponse This interface represents an instance of an HTTP response intercepted by Burp Proxy.InterceptedMessage This interface represents an instance of an HTTP message intercepted by Burp Proxy.Intruder This interface provides access to the functionality of the Burp Intruder tool.IntruderInsertionPoint This interface is used to represent an Intruder insertion point for attack payloads.InvalidLauncherConfigurationException This exception is thrown if the configuration for aScanis invalid.InvocationSource This interface provides information about the source from which a context menu was invoked.InvocationType An enum containing different types of context menu invocations.KeySupport KeywordCount This interface is used to store the number of types a given keyword appeared in a response.Logging This interface provides access to the functionality related to logging and events.MarkedHttpRequestResponse This interface is used to extendHttpRequestResponseinterface to hold message markers data.MessageEditorHttpRequestResponse This class contains information about a user selection of a request or response within a Burp Suite message editor.MessageEditorHttpRequestResponse.SelectionContext MimeType This enum defines MIME types that are recognised by Burp.MontoyaApi This interface is used by Burp Suite to pass a set of methods to extensions that can be used to perform various actions within Burp.MontoyaObjectFactory Node This interface represents an instance of a class that allows data to be stored and accessed from the Burp project.NumberUtils This interface gives you access to number string conversion features.ObjectFactoryLocator ParsedHttpParameter This interface is used to hold additional details about an HTTP request parameter that has been parsed by Burp.Payload This interface represents an Intruder payload.PayloadGenerator This interface is used for custom Intruder payload generators.PayloadGeneratorProvider Extensions can implement this interface and then callIntruder.registerPayloadGeneratorProvider(burp.api.montoya.intruder.PayloadGeneratorProvider)to register a provider for custom Intruder payload generators.PayloadOption This enum defines options that can be specified when generating Burp Collaborator payloads.PayloadProcessingAction An enum to describe instructions that the payload processor can give Intruder for the current payload.PayloadProcessingResult An instance of this interface should be returned byPayloadProcessor.processPayload(burp.api.montoya.intruder.Payload, burp.api.montoya.intruder.Payload, burp.api.montoya.intruder.IntruderInsertionPoint)if a customPayloadProcessorwas registered with Intruder.PayloadProcessor Extensions can implement this interface and then callIntruder.registerPayloadProcessor(burp.api.montoya.intruder.PayloadProcessor)to register a custom Intruder payload processor.Persistence This interface provides access to the functionality related to persistence.Preferences This interface represents an instance of a class that allows data to be stored and accessed from the java preference store.PrimitiveListSupport PrimitivesSupport Proxy This interface provides access to the functionality of the Proxy tool.ProxyHistoryFilter Extensions can implement this interface and then callProxy.history(ProxyHistoryFilter)to get a filtered list of items in the Proxy history.ProxyHttpRequestHandler Extensions can implement this interface and then callProxy.registerRequestHandler(ProxyHttpRequestHandler)to register a Proxy request handler.ProxyHttpResponseHandler Extensions can implement this interface and then callProxy.registerResponseHandler(ProxyHttpResponseHandler)to register a Proxy response handler.ProxyRequestResponse This interface represents an instance of an HTTP request and response intercepted by the Proxy.ProxyWebSocket This interface represents a ProxyWebSocket within Burp.ProxyWebSocketCreationHandler Extensions can implement this interface and then callProxy.registerWebSocketCreationHandler(burp.api.montoya.proxy.ProxyWebSocketCreationHandler)to register a WebSocket handler.ProxyWebSocketFinalInterceptBinaryMessage Extensions can implement this interface when returning a binary message fromProxyWebSocketHandler.handleBinaryMessageToBeIssued(ByteArray, Direction).ProxyWebSocketFinalInterceptTextMessage Extensions can implement this interface when returning a text message fromProxyWebSocketHandler.handleTextMessageToBeIssued(String, Direction).ProxyWebSocketHandler This interface allows an extension to be notified when messages are sent or received via the proxy WebSocket, or it has been closed.ProxyWebSocketInitialInterceptBinaryMessage Extensions can implement this interface when returning a binary message fromProxyWebSocketHandler.handleBinaryMessageReceived(ByteArray, Direction).ProxyWebSocketInitialInterceptTextMessage Extensions can implement this interface when returning a text message fromProxyWebSocketHandler.handleTextMessageReceived(String, Direction).RandomUtils RandomUtils.CharacterSet Range This interface represents a range of integer values between two values in which the range includes the start value but excludes the end value.RawEditor This interface provides extensions with an instance of Burp Suite's HTTP text editor to use in their own user interface.Registration This interface represents an instance of a class that is returned when an object is registered by an extension in Burp Suite.Repeater This interface provides access to the functionality of the Repeater tool.ReportFormat This enum represents the formats for scan reports.RequestFinalInterceptResult Extensions can implement this interface when returning a result fromProxyHttpRequestHandler.handleRequestToIssue(InterceptedHttpRequest, Annotations).RequestInitialInterceptResult Extensions can implement this interface when returning a result fromProxyHttpRequestHandler.handleReceivedRequest(InterceptedHttpRequest, Annotations).RequestResponseSupport RequestResult An instance of this interface should be returned byHttpHandler.handleHttpRequest(burp.api.montoya.http.message.requests.HttpRequest, burp.api.montoya.core.Annotations, burp.api.montoya.core.ToolSource)if a customHttpHandlerhas been registered with Burp.ResponseFinalInterceptResult Extensions can implement this interface when returning a result fromProxyHttpResponseHandler.handleResponseToReturn(InterceptedHttpResponse, HttpRequest, Annotations).ResponseInitialInterceptResult Extensions can implement this interface when returning a result fromProxyHttpResponseHandler.handleReceivedResponse(InterceptedHttpResponse, HttpRequest, Annotations).ResponseKeywordsAnalyzer This interface is used to analyze HTTP responses and retrieve keywords.ResponseResult An instance of this interface should be returned byHttpHandler.handleHttpResponse(burp.api.montoya.http.message.responses.HttpResponse, burp.api.montoya.http.message.requests.HttpRequest, burp.api.montoya.core.Annotations, burp.api.montoya.core.ToolSource)if a customHttpHandlerhas been registered with Burp.ResponseVariationsAnalyzer This interface is used to analyze HTTP responses and find variations between them, according to various attributes.Scan This interface represents an instance of a scan that can be configured before starting a crawl, audit or crawl and audit in the Burp Scanner tool.ScanCheck Extensions can implement this interface and then callScanner.registerScanCheck(ScanCheck)to register a custom Scanner check.ScanConfiguration This interface represents configurations for the Burp Scanner tool.Scanner This interface provides access to the functionality of the Scanner tool.ScanTask This interface is used to retrieve details of tasks in the Burp Scanner.Scope This interface provides access to the functionality related to Burp's Suite-wide target scope.ScopeChange This interface represents an instance of a change to Burp's Suite-wide target scope.ScopeChangeHandler Extensions can implement this interface and then callScope.registerHandler(ScopeChangeHandler)to register a scope change handler.SecretKey This interface represents a secret key that is associated with aCollaboratorClientSelection This interface provides helpful information and functionality relating to a user's selection within the user interface.SessionHandlingAction Extensions can implement this interface and then callHttp.registerSessionHandlingAction(burp.api.montoya.http.sessions.SessionHandlingAction)to register a custom session handling action.ShutdownOptions This enum represents shutdown options that can be used when callingBurpSuite.shutdown(ShutdownOptions...).SiteMap This interface provides methods for querying and modifying Burp's site map.SiteMapFilter This interface is used to filter items when querying Burp's site map.SiteMapNode This interface is used to represent items in the Burp's site map.SmtpDetails This interface provides information about an SMTP interaction detected by Burp Collaborator.SmtpProtocol This enum represents Simple Mail Transfer Protocol (SMTP) protocols.StringUtils This interface gives you access to String manipulation features.SwingUtils This interface gives you access to swing utilities.Task This interface represents a task on the Dashboard.TemporaryFile This interface represents an instance of a class that allows data to be stored to and accessed from a temporary file.Theme This enum contains the different themes available in Burp Suites user interface.ToolSource This interface represents the tool that is the source of an object.ToolType This enum represents tools in Burp Suite.URLUtils This interface gives you access to URL encoding and decoding features.UserInterface This interface gives you access to various user interface related features.Utilities This interface gives you access to other interfaces that have various data conversion and querying features.Version This interface represents a product version.WebSocket This interface represents a WebSocket within Burp.WebSocketBinaryMessage This interface represents a binary WebSocket message.WebSocketCreationHandler Extensions can implement this interface and then callWebSockets.registerWebSocketCreationHandler(burp.api.montoya.websocket.WebSocketCreationHandler)to register a WebSocket handler.WebSocketHandler This interface allows an extension to be notified when messages are received or the WebSocket has been closed.WebSocketMessageAction This enum represents the action to be applied to aWebSocketTextMessageorWebSocketBinaryMessage.WebSockets This interface is used to access WebSocket related functionality of Burp.WebSocketTextMessage This interface represents a text WebSocket message.