A B C D E F G H I J K L M N O P Q R S T U V W X Y 
All Classes All Packages

A

A - burp.api.montoya.collaborator.DnsQueryType
 
AAAA - burp.api.montoya.collaborator.DnsQueryType
 
action() - Method in interface burp.api.montoya.intruder.PayloadProcessingResult
This method is called by Burp to see what action it should perform with the payload.
action() - Method in interface burp.api.montoya.proxy.ProxyWebSocketFinalInterceptBinaryMessage
 
action() - Method in interface burp.api.montoya.proxy.ProxyWebSocketFinalInterceptTextMessage
 
action() - Method in interface burp.api.montoya.proxy.ProxyWebSocketInitialInterceptBinaryMessage
 
action() - Method in interface burp.api.montoya.proxy.ProxyWebSocketInitialInterceptTextMessage
 
action() - Method in interface burp.api.montoya.proxy.RequestFinalInterceptResult
This method retrieves the current final intercept action.
action() - Method in interface burp.api.montoya.proxy.RequestInitialInterceptResult
This method retrieves the current initial intercept action.
action() - Method in interface burp.api.montoya.proxy.ResponseFinalInterceptResult
This method retrieves the current final intercept action.
action() - Method in interface burp.api.montoya.proxy.ResponseInitialInterceptResult
This method retrieves the current initial intercept action.
action() - Method in interface burp.api.montoya.websocket.WebSocketBinaryMessage
 
action() - Method in interface burp.api.montoya.websocket.WebSocketTextMessage
 
ACTIVE_AUDIT_CHECKS - burp.api.montoya.scanner.BuiltInScanConfiguration
 
activeAudit(HttpRequestResponse, AuditInsertionPoint) - Method in interface burp.api.montoya.scanner.ScanCheck
The Scanner invokes this method for each insertion point that is actively audited.
add(HttpRequestResponse) - Method in interface burp.api.montoya.sitemap.SiteMap
This method can be used to add an HttpRequestResponse item to Burp's site map with the specified request/response details.
add(AuditIssue) - Method in interface burp.api.montoya.sitemap.SiteMap
This method is used to register a new Audit issue.
addConfiguration(BuiltInScanConfiguration) - Method in interface burp.api.montoya.scanner.Scan
This method can be used to add a built-in configuration to this scan.
addHeader(HttpHeader) - Method in interface burp.api.montoya.http.message.requests.HttpRequest
Adds an HTTP header to the current request.
addHeader(HttpHeader) - Method in interface burp.api.montoya.http.message.responses.HttpResponse
Adds an HTTP header to the response.
addHeader(String, String) - Method in interface burp.api.montoya.http.message.requests.HttpRequest
Adds an HTTP header to the current request.
addHeader(String, String) - Method in interface burp.api.montoya.http.message.responses.HttpResponse
Adds an HTTP header to the response.
addRequest(HttpRequest) - Method in interface burp.api.montoya.scanner.Scan
This method can be used to add an HTTP request to this scan.
addRequest(HttpRequest, List<Range>) - Method in interface burp.api.montoya.scanner.Scan
This method can be used to add an HTTP request to this scan.
addRequestResponse(HttpRequestResponse) - Method in interface burp.api.montoya.scanner.Scan
This method can be used to add an HTTP request and response to this scan.
address() - Method in interface burp.api.montoya.collaborator.CollaboratorServer
Returns the address of the Collaborator server.
addUrl(String) - Method in interface burp.api.montoya.scanner.Scan
This method can be used to add a URL to this scan.
ALL - burp.api.montoya.collaborator.DnsQueryType
 
ALL_CHARACTERS - burp.api.montoya.utilities.HtmlEncoding
Encode HTML special characters as per STANDARD, encode all other characters as decimal entities.
ALL_CHARACTERS_DECIMAL - burp.api.montoya.utilities.HtmlEncoding
Encode all characters as decimal entities.
ALL_CHARACTERS_HEX - burp.api.montoya.utilities.HtmlEncoding
Encode all characters as hex entities.
AMBIGUOUS - burp.api.montoya.http.MimeType
 
AMF - burp.api.montoya.http.ContentType
 
ANCHOR_LABELS - burp.api.montoya.http.message.responses.analysis.AttributeType
 
annotations() - Static method in interface burp.api.montoya.core.Annotations
This method is used to construct empty annotations.
annotations() - Method in interface burp.api.montoya.http.RequestResult
 
annotations() - Method in interface burp.api.montoya.http.ResponseResult
 
annotations() - Method in interface burp.api.montoya.proxy.RequestFinalInterceptResult
This method retrieves the annotations for the current request after any modifications by the extension.
annotations() - Method in interface burp.api.montoya.proxy.RequestInitialInterceptResult
This method retrieves the annotations for the current request after any modifications by the extension.
annotations() - Method in interface burp.api.montoya.proxy.ResponseFinalInterceptResult
This method retrieves the annotations for the current response after any modifications by the extension.
annotations() - Method in interface burp.api.montoya.proxy.ResponseInitialInterceptResult
This method retrieves the annotations for the current response after any modifications by the extension.
annotations(HighlightColor) - Static method in interface burp.api.montoya.core.Annotations
This method is used to construct a annotations from a highlight color.
annotations(String) - Static method in interface burp.api.montoya.core.Annotations
This method is used to construct annotations from a comment.
annotations(String, HighlightColor) - Static method in interface burp.api.montoya.core.Annotations
This method is used to construct a annotations from a comment and a highlight color.
annotations(String, HighlightColor) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
Annotations - Interface in burp.api.montoya.core
This interface represents annotations that can be applied to a message.
append(byte) - Method in interface burp.api.montoya.core.ByteArray
This method appends the provided byte.
append(byte[]) - Method in interface burp.api.montoya.core.ByteArray
This method appends the provided bytes.
append(ByteArray) - Method in interface burp.api.montoya.core.ByteArray
This method appends the provided bytes.
append(String) - Method in interface burp.api.montoya.core.ByteArray
This method appends the provided text as UTF-8 encoded bytes.
APPLICATION_FLASH - burp.api.montoya.http.MimeType
 
APPLICATION_UNKNOWN - burp.api.montoya.http.MimeType
 
applyThemeToComponent(Component) - Method in interface burp.api.montoya.ui.UserInterface
This method is used to customize UI components in line with Burp's UI style, including font size, colors, table line spacing, etc.
asBytes() - Method in interface burp.api.montoya.http.message.HttpMessage
This method is used to get the message as a byte array.
ASCII_LETTERS - burp.api.montoya.utilities.RandomUtils.CharacterSet
 
ASCII_LOWERCASE - burp.api.montoya.utilities.RandomUtils.CharacterSet
 
ASCII_UPPERCASE - burp.api.montoya.utilities.RandomUtils.CharacterSet
 
AttackConfiguration - Interface in burp.api.montoya.intruder
This interface is used to represent an Intruder attack configuration.
Attribute - Interface in burp.api.montoya.http.message.responses.analysis
This interface is used to hold details about HTTP response attributes.
attributes(AttributeType...) - Method in interface burp.api.montoya.http.message.responses.HttpResponse
This method is used to retrieve the values of response attributes.
AttributeType - Enum in burp.api.montoya.http.message.responses.analysis
This enum defines various options that Burp can use to query attributes of HTTP responses.
Audit - Interface in burp.api.montoya.scanner.audit
This interface represents an instance of an audit in the Burp Scanner tool.
auditInsertionPoint(String, HttpRequest, int, int) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
auditInsertionPoint(String, HttpRequest, int, int) - Static method in interface burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPoint
This method can be used to create an audit insertion point based on offsets.
AuditInsertionPoint - Interface in burp.api.montoya.scanner.audit.insertionpoint
This interface is used to define an insertion point for use by active Scan checks.
AuditInsertionPointProvider - Interface in burp.api.montoya.scanner.audit.insertionpoint
Extensions can implement this interface and then call Scanner.registerInsertionPointProvider(AuditInsertionPointProvider) to register a provider for custom audit insertion points.
AuditInsertionPointType - Enum in burp.api.montoya.scanner.audit.insertionpoint
This enum represents the audit insertion point type.
auditIssue(String, String, String, String, AuditIssueSeverity, AuditIssueConfidence, String, String, AuditIssueSeverity, MarkedHttpRequestResponse...) - Static method in interface burp.api.montoya.scanner.audit.issues.AuditIssue
This method can be used to create a default implementation of an audit issue for a URL.
auditIssue(String, String, String, String, AuditIssueSeverity, AuditIssueConfidence, String, String, AuditIssueSeverity, List<MarkedHttpRequestResponse>) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
auditIssue(String, String, String, String, AuditIssueSeverity, AuditIssueConfidence, String, String, AuditIssueSeverity, List<MarkedHttpRequestResponse>) - Static method in interface burp.api.montoya.scanner.audit.issues.AuditIssue
This method can be used to create a default implementation of an audit issue for a URL.
AuditIssue - Interface in burp.api.montoya.scanner.audit.issues
This interface is used to retrieve details of audit issues.
AuditIssueConfidence - Enum in burp.api.montoya.scanner.audit.issues
This enum represents the confidence level of an audit issue.
auditIssueDefinition(String, String, String, AuditIssueSeverity) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
auditIssueDefinition(String, String, String, AuditIssueSeverity) - Static method in interface burp.api.montoya.scanner.audit.issues.AuditIssueDefinition
This method can be used to create a default implementation of an audit issue definition.
AuditIssueDefinition - Interface in burp.api.montoya.scanner.audit.issues
This interface is used to retrieve background information about audit issues.
AuditIssueHandler - Interface in burp.api.montoya.scanner.audit
Extensions can implement this interface and then call Scanner.registerAuditIssueHandler(AuditIssueHandler) to register an audit issue handler.
AuditIssueSeverity - Enum in burp.api.montoya.scanner.audit.issues
This enum represents the severity level of an audit issue.
AUTO - burp.api.montoya.http.HttpMode
 

B

background() - Method in interface burp.api.montoya.scanner.audit.issues.AuditIssueDefinition
This method returns a background description for this issue type.
base64Utils() - Method in interface burp.api.montoya.utilities.Utilities
 
Base64Utils - Interface in burp.api.montoya.utilities
This interface contains various methods that give you access to base64 encoding and decoding features.
baseUrl() - Method in interface burp.api.montoya.scanner.audit.issues.AuditIssue
This method returns the base URL for which this issue was generated.
baseValue() - Method in interface burp.api.montoya.scanner.audit.insertionpoint.ExtensionGeneratedAuditInsertionPoint
This method returns the base value for this insertion point.
BLAKE2B_160 - burp.api.montoya.utilities.DigestAlgorithm
 
BLAKE2B_256 - burp.api.montoya.utilities.DigestAlgorithm
 
BLAKE2B_384 - burp.api.montoya.utilities.DigestAlgorithm
 
BLAKE2B_512 - burp.api.montoya.utilities.DigestAlgorithm
 
BLAKE2S_128 - burp.api.montoya.utilities.DigestAlgorithm
 
BLAKE2S_160 - burp.api.montoya.utilities.DigestAlgorithm
 
BLAKE2S_224 - burp.api.montoya.utilities.DigestAlgorithm
 
BLAKE2S_256 - burp.api.montoya.utilities.DigestAlgorithm
 
BLAKE3_256 - burp.api.montoya.utilities.DigestAlgorithm
 
BLUE - burp.api.montoya.core.HighlightColor
 
body() - Method in interface burp.api.montoya.http.message.HttpMessage
This method is used to get the body of a message as a byte array.
BODY - burp.api.montoya.http.message.params.HttpParameterType
 
BODY_CONTENT - burp.api.montoya.http.message.responses.analysis.AttributeType
 
bodyAsString() - Method in interface burp.api.montoya.http.message.HttpMessage
This method is used to get the body of a message as a String.
bodyOffset() - Method in interface burp.api.montoya.http.message.HttpMessage
This method is used to obtain the offset within the message where the message body begins.
bodyParameter(String, String) - Static method in interface burp.api.montoya.http.message.params.HttpParameter
Create a new Instance of HttpParameter with HttpParameterType.BODY type.
build() - Method in interface burp.api.montoya.core.Version
This method returns the build number (e.g.
buildHttpMessageWithPayload(ByteArray) - Method in interface burp.api.montoya.scanner.audit.insertionpoint.ExtensionGeneratedAuditInsertionPoint
This method is used to build a request with the specified payload placed into the insertion point.
BuiltInScanConfiguration - Enum in burp.api.montoya.scanner
This enum represents built in configurations for the Burp Scanner tool.
burp.api.montoya - package burp.api.montoya
 
burp.api.montoya.burpsuite - package burp.api.montoya.burpsuite
 
burp.api.montoya.collaborator - package burp.api.montoya.collaborator
 
burp.api.montoya.comparer - package burp.api.montoya.comparer
 
burp.api.montoya.core - package burp.api.montoya.core
 
burp.api.montoya.decoder - package burp.api.montoya.decoder
 
burp.api.montoya.extension - package burp.api.montoya.extension
 
burp.api.montoya.http - package burp.api.montoya.http
 
burp.api.montoya.http.message - package burp.api.montoya.http.message
 
burp.api.montoya.http.message.cookies - package burp.api.montoya.http.message.cookies
 
burp.api.montoya.http.message.headers - package burp.api.montoya.http.message.headers
 
burp.api.montoya.http.message.params - package burp.api.montoya.http.message.params
 
burp.api.montoya.http.message.requests - package burp.api.montoya.http.message.requests
 
burp.api.montoya.http.message.responses - package burp.api.montoya.http.message.responses
 
burp.api.montoya.http.message.responses.analysis - package burp.api.montoya.http.message.responses.analysis
 
burp.api.montoya.http.sessions - package burp.api.montoya.http.sessions
 
burp.api.montoya.internal - package burp.api.montoya.internal
 
burp.api.montoya.intruder - package burp.api.montoya.intruder
 
burp.api.montoya.logging - package burp.api.montoya.logging
 
burp.api.montoya.persistence - package burp.api.montoya.persistence
 
burp.api.montoya.persistence.support - package burp.api.montoya.persistence.support
 
burp.api.montoya.proxy - package burp.api.montoya.proxy
 
burp.api.montoya.repeater - package burp.api.montoya.repeater
 
burp.api.montoya.scanner - package burp.api.montoya.scanner
 
burp.api.montoya.scanner.audit - package burp.api.montoya.scanner.audit
 
burp.api.montoya.scanner.audit.insertionpoint - package burp.api.montoya.scanner.audit.insertionpoint
 
burp.api.montoya.scanner.audit.issues - package burp.api.montoya.scanner.audit.issues
 
burp.api.montoya.scope - package burp.api.montoya.scope
 
burp.api.montoya.sitemap - package burp.api.montoya.sitemap
 
burp.api.montoya.ui - package burp.api.montoya.ui
 
burp.api.montoya.ui.contextmenu - package burp.api.montoya.ui.contextmenu
 
burp.api.montoya.ui.editor - package burp.api.montoya.ui.editor
 
burp.api.montoya.ui.editor.extension - package burp.api.montoya.ui.editor.extension
 
burp.api.montoya.ui.swing - package burp.api.montoya.ui.swing
 
burp.api.montoya.utilities - package burp.api.montoya.utilities
 
burp.api.montoya.websocket - package burp.api.montoya.websocket
 
BurpExtension - Interface in burp.api.montoya
All extensions must implement this interface.
burpSuite() - Method in interface burp.api.montoya.MontoyaApi
This method is used to access functionality related to the Burp Suite application.
BurpSuite - Interface in burp.api.montoya.burpsuite
This interface provides access to functionality related to the Burp Suite application.
BurpSuiteEdition - Enum in burp.api.montoya.core
 
BUTTON_SUBMIT_LABELS - burp.api.montoya.http.message.responses.analysis.AttributeType
 
byteArray() - Static method in interface burp.api.montoya.core.ByteArray
Create a new ByteArray
byteArray() - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
byteArray(byte[]) - Static method in interface burp.api.montoya.core.ByteArray
Create a new ByteArray that wraps the provided byte array
byteArray(byte[]) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
byteArray(ByteArray) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
byteArray(String) - Static method in interface burp.api.montoya.core.ByteArray
Create a new ByteArray from the provided UTF-8 encoded text.
byteArray(String) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
ByteArray - Interface in burp.api.montoya.core
This interface provides access to various methods for querying and manipulating byte arrays.
ByteArraySupport - Interface in burp.api.montoya.persistence.support
 
byteUtils() - Method in interface burp.api.montoya.utilities.Utilities
 
ByteUtils - Interface in burp.api.montoya.utilities
This interface gives you access to various methods for querying and manipulating byte arrays.

C

CAA - burp.api.montoya.collaborator.DnsQueryType
 
CANONICAL_LINK - burp.api.montoya.http.message.responses.analysis.AttributeType
 
caption() - Method in interface burp.api.montoya.ui.editor.extension.ExtensionHttpMessageEditor
 
caretPosition() - Method in interface burp.api.montoya.ui.contextmenu.MessageEditorHttpRequestResponse
 
caretPosition() - Method in interface burp.api.montoya.ui.editor.Editor
 
CERTAIN - burp.api.montoya.scanner.audit.issues.AuditIssueConfidence
 
characters - Variable in enum burp.api.montoya.utilities.RandomUtils.CharacterSet
 
childNode(String) - Method in interface burp.api.montoya.persistence.Node
Returns the a Node to which the specified key is mapped.
CLIENT_TO_SERVER - burp.api.montoya.websocket.Direction
 
clientIp() - Method in interface burp.api.montoya.collaborator.Interaction
Returns the client IP address.
close() - Method in interface burp.api.montoya.proxy.ProxyWebSocket
This method will close the WebSocket.
close() - Method in interface burp.api.montoya.websocket.WebSocket
This method will close the WebSocket.
CNAME - burp.api.montoya.collaborator.DnsQueryType
 
collaborator() - Method in interface burp.api.montoya.MontoyaApi
This method is used to access the functionality of the Collaborator.
Collaborator - Interface in burp.api.montoya.collaborator
This interface provides access to the facilities of Burp Collaborator.
CollaboratorClient - Interface in burp.api.montoya.collaborator
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 - Interface in burp.api.montoya.collaborator
This interface represents a Burp Collaborator payload.
CollaboratorServer - Interface in burp.api.montoya.collaborator
This interface provides details of the Collaborator server associated with this client.
commandLineArguments() - Method in interface burp.api.montoya.burpsuite.BurpSuite
This method returns the command line arguments that were passed to Burp on startup.
comment() - Method in interface burp.api.montoya.core.Annotations
 
COMMENTS - burp.api.montoya.http.message.responses.analysis.AttributeType
 
COMMUNITY_EDITION - burp.api.montoya.core.BurpSuiteEdition
 
comparer() - Method in interface burp.api.montoya.MontoyaApi
This method is used to access the functionality of the Comparer.
Comparer - Interface in burp.api.montoya.comparer
This interface provides access to the functionality of the Comparer tool.
COMPARER - burp.api.montoya.core.ToolType
 
ComponentEvent - Interface in burp.api.montoya.ui.contextmenu
This interface describes an action or event that has occurred with a user interface component.
compress(ByteArray, CompressionType) - Method in interface burp.api.montoya.utilities.CompressionUtils
Compress data using the specified compression type.
CompressionType - Enum in burp.api.montoya.utilities
This enum defines available compression types.
compressionUtils() - Method in interface burp.api.montoya.utilities.Utilities
 
CompressionUtils - Interface in burp.api.montoya.utilities
This interface gives you access to data compression features.
confidence() - Method in interface burp.api.montoya.scanner.audit.issues.AuditIssue
This method returns the issue confidence level.
consolidateIssues(AuditIssue, AuditIssue) - Method in interface burp.api.montoya.scanner.ScanCheck
The Scanner invokes this method when the custom Scan check has reported multiple issues for the same URL path.
ConsolidationAction - Enum in burp.api.montoya.scanner
This enum represents the action to be taken when duplicate audit issues are found.
containsHttpMessage() - Method in enum burp.api.montoya.ui.contextmenu.InvocationType
 
containsHttpRequestResponses() - Method in enum burp.api.montoya.ui.contextmenu.InvocationType
 
containsScanIssues() - Method in enum burp.api.montoya.ui.contextmenu.InvocationType
 
content() - Method in interface burp.api.montoya.intruder.HttpRequestTemplate
 
content() - Method in interface burp.api.montoya.intruder.IntruderInsertionPoint
 
CONTENT_LENGTH - burp.api.montoya.http.message.responses.analysis.AttributeType
 
CONTENT_LOCATION - burp.api.montoya.http.message.responses.analysis.AttributeType
 
CONTENT_TYPE - burp.api.montoya.http.message.responses.analysis.AttributeType
 
contents() - Method in interface burp.api.montoya.ui.Selection
 
contentType() - Method in interface burp.api.montoya.http.message.requests.HttpRequest
 
ContentType - Enum in burp.api.montoya.http
This enum defines content types recognised by Burp.
ContextMenuEvent - Interface in burp.api.montoya.ui.contextmenu
This interface provides useful information when generating context menu items from a ContextMenuItemsProvider.
ContextMenuItemsProvider - Interface in burp.api.montoya.ui.contextmenu
This interface allows extensions to implement and register a provider for custom context menu items.
CONTINUE - burp.api.montoya.proxy.FinalInterceptAction
Causes Burp Proxy to forward the message.
CONTINUE - burp.api.montoya.websocket.WebSocketMessageAction
 
continueWith(HttpRequest) - Static method in interface burp.api.montoya.proxy.RequestFinalInterceptResult
This method can be used to create a result that causes Burp Proxy to forward the request.
continueWith(HttpRequest, Annotations) - Static method in interface burp.api.montoya.proxy.RequestFinalInterceptResult
This method can be used to create a result that causes Burp Proxy to forward the request.
continueWith(HttpResponse) - Static method in interface burp.api.montoya.proxy.ResponseFinalInterceptResult
This method can be used to create a result that causes Burp Proxy to forward the response.
continueWith(HttpResponse, Annotations) - Static method in interface burp.api.montoya.proxy.ResponseFinalInterceptResult
This method can be used to create a result that causes Burp Proxy to forward the response.
continueWithBinaryMessage(ByteArray) - Static method in interface burp.api.montoya.proxy.ProxyWebSocketFinalInterceptBinaryMessage
This is a helper method to build a binary WebSocket message to continue through Burp.
continueWithBinaryMessage(ByteArray) - Static method in interface burp.api.montoya.websocket.WebSocketBinaryMessage
This is a helper method to build a binary WebSocket message to be processed.
continueWithTextMessage(String) - Static method in interface burp.api.montoya.proxy.ProxyWebSocketFinalInterceptTextMessage
This is a helper method to build a text WebSocket message to continue through Burp.
continueWithTextMessage(String) - Static method in interface burp.api.montoya.websocket.WebSocketTextMessage
This is a helper method to build a text WebSocket message to be processed.
conversation() - Method in interface burp.api.montoya.collaborator.SmtpDetails
Returns the SMTP conversation.
convertAsciiToHexString(String) - Method in interface burp.api.montoya.utilities.StringUtils
Convert a string to the hex values of its ASCII characters.
convertBinary(String, int) - Method in interface burp.api.montoya.utilities.NumberUtils
 
convertBinaryToDecimal(String) - Method in interface burp.api.montoya.utilities.NumberUtils
 
convertBinaryToHex(String) - Method in interface burp.api.montoya.utilities.NumberUtils
 
convertBinaryToOctal(String) - Method in interface burp.api.montoya.utilities.NumberUtils
 
convertDecimal(String, int) - Method in interface burp.api.montoya.utilities.NumberUtils
 
convertDecimalToBinary(String) - Method in interface burp.api.montoya.utilities.NumberUtils
 
convertDecimalToHex(String) - Method in interface burp.api.montoya.utilities.NumberUtils
 
convertDecimalToOctal(String) - Method in interface burp.api.montoya.utilities.NumberUtils
 
convertFromString(String) - Method in interface burp.api.montoya.utilities.ByteUtils
This method can be used to convert data from String form into an array of bytes.
convertHex(String, int) - Method in interface burp.api.montoya.utilities.NumberUtils
 
convertHexStringToAscii(String) - Method in interface burp.api.montoya.utilities.StringUtils
Convert a string of hex values to a string of ASCII characters.
convertHexToBinary(String) - Method in interface burp.api.montoya.utilities.NumberUtils
 
convertHexToDecimal(String) - Method in interface burp.api.montoya.utilities.NumberUtils
 
convertHexToOctal(String) - Method in interface burp.api.montoya.utilities.NumberUtils
 
convertOctal(String, int) - Method in interface burp.api.montoya.utilities.NumberUtils
 
convertOctalToBinary(String) - Method in interface burp.api.montoya.utilities.NumberUtils
 
convertOctalToDecimal(String) - Method in interface burp.api.montoya.utilities.NumberUtils
 
convertOctalToHex(String) - Method in interface burp.api.montoya.utilities.NumberUtils
 
convertToString(byte[]) - Method in interface burp.api.montoya.utilities.ByteUtils
This method can be used to convert data from an array of bytes into String form.
Cookie - Interface in burp.api.montoya.http.message.cookies
This interface is used to hold details about an HTTP cookie.
COOKIE - burp.api.montoya.http.message.params.HttpParameterType
 
COOKIE_NAMES - burp.api.montoya.http.message.responses.analysis.AttributeType
 
cookieJar() - Method in interface burp.api.montoya.http.Http
This method is used to access the Cookie Jar.
CookieJar - Interface in burp.api.montoya.http.sessions
This interface is used to access Burp's Cookie Jar functionality.
cookieParameter(String, String) - Static method in interface burp.api.montoya.http.message.params.HttpParameter
Create a new Instance of HttpParameter with HttpParameterType.COOKIE type.
cookies() - Method in interface burp.api.montoya.http.message.responses.HttpResponse
This method is used to obtain details of the HTTP cookies set in the response.
cookies() - Method in interface burp.api.montoya.http.sessions.CookieJar
 
copy() - Method in interface burp.api.montoya.core.ByteArray
Create a deep copy of the ByteArray
count() - Method in interface burp.api.montoya.http.message.responses.analysis.KeywordCount
 
countMatches(byte[]) - Method in interface burp.api.montoya.core.ByteArray
This method searches the data in the ByteArray and counts all matches for a specified term.
countMatches(byte[], boolean) - Method in interface burp.api.montoya.core.ByteArray
This method searches the data in the ByteArray and counts all matches for a specified term.
countMatches(byte[], boolean, int, int) - Method in interface burp.api.montoya.core.ByteArray
This method searches the data in the ByteArray and counts all matches for a specified term.
countMatches(byte[], byte[]) - Method in interface burp.api.montoya.utilities.ByteUtils
This method searches a piece of data and counts all matches for a specified pattern.
countMatches(byte[], byte[], boolean) - Method in interface burp.api.montoya.utilities.ByteUtils
This method searches a piece of data and counts all matches for a specified pattern.
countMatches(byte[], byte[], boolean, int, int) - Method in interface burp.api.montoya.utilities.ByteUtils
This method searches a piece of data and counts all matches for a specified pattern.
countMatches(String) - Method in interface burp.api.montoya.core.ByteArray
This method searches the data in the ByteArray and counts all matches for a specified term.
countMatches(String, boolean) - Method in interface burp.api.montoya.core.ByteArray
This method searches the data in the ByteArray and counts all matches for a specified term.
countMatches(String, boolean, int, int) - Method in interface burp.api.montoya.core.ByteArray
This method searches the data in the ByteArray and counts all matches for a specified term.
Crawl - Interface in burp.api.montoya.scanner
This interface represents an instance of a crawl in the Burp Scanner tool.
CrawlAndAudit - Interface in burp.api.montoya.scanner
This interface represents an instance of a crawl and audit in the Burp Scanner tool.
createClient() - Method in interface burp.api.montoya.collaborator.Collaborator
This method is used to 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.
createHttpRequestEditor(EditorOptions...) - Method in interface burp.api.montoya.ui.UserInterface
This method is used to create a new instance of Burp's HTTP request editor, for the extension to use in its own UI.
createHttpResponseEditor(EditorOptions...) - Method in interface burp.api.montoya.ui.UserInterface
This method is used to create a new instance of Burp's HTTP response editor, for the extension to use in its own UI.
createRawEditor(EditorOptions...) - Method in interface burp.api.montoya.ui.UserInterface
This method is used to create a new instance of Burp's plain text editor, for the extension to use in its own UI.
createResponseKeywordsAnalyzer(List<String>) - Method in interface burp.api.montoya.http.Http
This method is used to create a new response keyword analyzer.
createResponseVariationsAnalyzer() - Method in interface burp.api.montoya.http.Http
This method is used to create a new response variations analyzer.
createScan() - Method in interface burp.api.montoya.scanner.Scanner
This method can be used to create a scan that can be configured before being sent to the Burp Scanner tool.
cryptoUtils() - Method in interface burp.api.montoya.utilities.Utilities
 
CryptoUtils - Interface in burp.api.montoya.utilities
This interface gives you access to cryptographic features.
CSS - burp.api.montoya.http.MimeType
 
CSS_CLASSES - burp.api.montoya.http.message.responses.analysis.AttributeType
 
currentTheme() - Method in interface burp.api.montoya.ui.UserInterface
This method is used to identify the theme currently being used.
customData() - Method in interface burp.api.montoya.collaborator.CollaboratorPayload
Return custom data from the payload.
customData() - Method in interface burp.api.montoya.collaborator.Interaction
Return custom data from the payload.
CYAN - burp.api.montoya.core.HighlightColor
 

D

DARK - burp.api.montoya.ui.Theme
 
decode(String) - Method in interface burp.api.montoya.utilities.HtmlUtils
Decode encoded HTML text.
decode(String) - Method in interface burp.api.montoya.utilities.URLUtils
UTF-8 charset is assumed.
decoder() - Method in interface burp.api.montoya.MontoyaApi
This method is used to access the functionality of the Decoder.
Decoder - Interface in burp.api.montoya.decoder
This interface provides access to the functionality of the Decoder tool.
DECODER - burp.api.montoya.core.ToolType
 
decompress(ByteArray, CompressionType) - Method in interface burp.api.montoya.utilities.CompressionUtils
Decompress data compressed using the specified compression type.
DEFAULT - burp.api.montoya.ui.editor.extension.EditorMode
 
definition() - Method in interface burp.api.montoya.scanner.audit.issues.AuditIssue
This method returns the definition for this issue.
delete() - Method in interface burp.api.montoya.core.Task
This method is used to delete the task.
delete(String) - Method in interface burp.api.montoya.persistence.support.DeleteSupport
This method is used to remove a value from the map.
DeleteSupport - Interface in burp.api.montoya.persistence.support
 
deregister() - Method in interface burp.api.montoya.core.Registration
This method is used to remove the object registered by the extension.
description() - Method in enum burp.api.montoya.http.MimeType
 
destinationIpAddress() - Method in interface burp.api.montoya.proxy.InterceptedMessage
This method retrieves the IP address for the destination of the intercepted message.
detail() - Method in interface burp.api.montoya.scanner.audit.issues.AuditIssue
This method returns detailed information about this specific instance of the issue.
DigestAlgorithm - Enum in burp.api.montoya.utilities
Enum of available message digest algorithms.
DIGITS - burp.api.montoya.utilities.RandomUtils.CharacterSet
 
Direction - Enum in burp.api.montoya.websocket
This enum is used to indicate the direction of the WebSocket message.
disableIntercept() - Method in interface burp.api.montoya.proxy.Proxy
This method disables the master interception for Burp Proxy.
displayName() - Method in interface burp.api.montoya.intruder.PayloadGeneratorProvider
This method returns the name Burp will use when displaying the payload generator in a dropdown list in the UI.
displayName() - Method in interface burp.api.montoya.intruder.PayloadProcessor
This method returns the name Burp will use when displaying the payload processor in a dropdown list in the UI.
DIV_IDS - burp.api.montoya.http.message.responses.analysis.AttributeType
 
DNS - burp.api.montoya.collaborator.InteractionType
 
dnsDetails() - Method in interface burp.api.montoya.collaborator.Interaction
Returns the DNS interaction details.
DnsDetails - Interface in burp.api.montoya.collaborator
This interface provides information about a DNS interaction detected by Burp Collaborator.
DNSKEY - burp.api.montoya.collaborator.DnsQueryType
 
DnsQueryType - Enum in burp.api.montoya.collaborator
This enum represents Domain Name System (DNS) query types.
DO_NOT_INTERCEPT - burp.api.montoya.proxy.InitialInterceptAction
Causes Burp Proxy to forward the message without presenting it to the user.
domain() - Method in interface burp.api.montoya.http.message.cookies.Cookie
This method is used to retrieve the domain for which the cookie is in scope.
doNotIntercept(HttpRequest) - Static method in interface burp.api.montoya.proxy.RequestInitialInterceptResult
This method can be used to create a result that causes Burp Proxy to forward the request without presenting it to the user.
doNotIntercept(HttpRequest, Annotations) - Static method in interface burp.api.montoya.proxy.RequestInitialInterceptResult
This method can be used to create a result that causes Burp Proxy to forward the request without presenting it to the user.
doNotIntercept(HttpResponse) - Static method in interface burp.api.montoya.proxy.ResponseInitialInterceptResult
This method can be used to create a result that causes Burp Proxy to forward the response without presenting it to the user.
doNotIntercept(HttpResponse, Annotations) - Static method in interface burp.api.montoya.proxy.ResponseInitialInterceptResult
This method can be used to create a result that causes Burp Proxy to forward the response without presenting it to the user.
doNotInterceptBinaryMessage(ByteArray) - Static method in interface burp.api.montoya.proxy.ProxyWebSocketInitialInterceptBinaryMessage
This is a helper method to build a binary WebSocket message to continue within the Proxy without interception.
doNotInterceptTextMessage(String) - Static method in interface burp.api.montoya.proxy.ProxyWebSocketInitialInterceptTextMessage
This is a helper method to build a text WebSocket message to continue within the Proxy without interception.
drop() - Static method in interface burp.api.montoya.proxy.RequestFinalInterceptResult
This method can be used to create a result that causes Burp Proxy to drop the request.
drop() - Static method in interface burp.api.montoya.proxy.RequestInitialInterceptResult
This method can be used to create a result that causes Burp Proxy to drop the request.
drop() - Static method in interface burp.api.montoya.proxy.ResponseFinalInterceptResult
This method can be used to create a result that causes Burp Proxy to drop the response.
drop() - Static method in interface burp.api.montoya.proxy.ResponseInitialInterceptResult
This method can be used to create a result that causes Burp Proxy to drop the response.
DROP - burp.api.montoya.proxy.FinalInterceptAction
Causes Burp Proxy to drop the message.
DROP - burp.api.montoya.proxy.InitialInterceptAction
Causes Burp Proxy to drop the message.
DROP - burp.api.montoya.websocket.WebSocketMessageAction
 
dropBinaryMessage() - Static method in interface burp.api.montoya.proxy.ProxyWebSocketFinalInterceptBinaryMessage
This is a helper method to build a binary WebSocket message to be dropped.
dropBinaryMessage() - Static method in interface burp.api.montoya.proxy.ProxyWebSocketInitialInterceptBinaryMessage
This is a helper method to build a binary WebSocket message to be dropped.
dropBinaryMessage() - Static method in interface burp.api.montoya.websocket.WebSocketBinaryMessage
This is a helper method to build a binary WebSocket message to be dropped.
dropTextMessage() - Static method in interface burp.api.montoya.proxy.ProxyWebSocketFinalInterceptTextMessage
This is a helper method to build a text WebSocket message to be dropped.
dropTextMessage() - Static method in interface burp.api.montoya.proxy.ProxyWebSocketInitialInterceptTextMessage
This is a helper method to build a text WebSocket message to be dropped.
dropTextMessage() - Static method in interface burp.api.montoya.websocket.WebSocketTextMessage
This is a helper method to build a text WebSocket message to be dropped.
DS - burp.api.montoya.collaborator.DnsQueryType
 
DSTU7564_256 - burp.api.montoya.utilities.DigestAlgorithm
 
DSTU7564_384 - burp.api.montoya.utilities.DigestAlgorithm
 
DSTU7564_512 - burp.api.montoya.utilities.DigestAlgorithm
 

E

edition() - Method in interface burp.api.montoya.core.Version
This method returns the edition of Burp Suite
Editor - Interface in burp.api.montoya.ui.editor
This interface provides the shared behaviour between the different editor types available from the Extensions API.
EditorMode - Enum in burp.api.montoya.ui.editor.extension
An enum to describe the different modes of Burp Suites message editor.
EditorOptions - Enum in burp.api.montoya.ui.editor
These options allow you to configure additional behaviour to Editor implementations.
enableIntercept() - Method in interface burp.api.montoya.proxy.Proxy
This method enables the master interception for Burp Proxy.
encode(String) - Method in interface burp.api.montoya.utilities.HtmlUtils
Encode HTML text using HtmlEncoding.STANDARD encoding.
encode(String) - Method in interface burp.api.montoya.utilities.URLUtils
UTF-8 charset is assumed.
encode(String, HtmlEncoding) - Method in interface burp.api.montoya.utilities.HtmlUtils
Encode HTML text.
END - Static variable in interface burp.api.montoya.intruder.Payload
A null payload.
endIndexExclusive() - Method in interface burp.api.montoya.core.Range
 
ENTERPRISE_EDITION - burp.api.montoya.core.BurpSuiteEdition
 
ENTIRE_BODY - burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPointType
 
error() - Method in interface burp.api.montoya.logging.Logging
This method is used to obtain the current extension's standard error stream.
errorCount() - Method in interface burp.api.montoya.scanner.ScanTask
This method returns the number of network errors that have occurred for the scan task.
ETAG_HEADER - burp.api.montoya.http.message.responses.analysis.AttributeType
 
excludeFromScope(String) - Method in interface burp.api.montoya.scope.Scope
This method can be used to exclude the specified URL from the Suite-wide target scope.
expiration() - Method in interface burp.api.montoya.http.message.cookies.Cookie
This method is used to retrieve the expiration time for the cookie if available.
exportProjectOptionsAsJson(String...) - Method in interface burp.api.montoya.burpsuite.BurpSuite
This method causes Burp to save its current project-level configuration in JSON format.
extension() - Method in interface burp.api.montoya.MontoyaApi
This method is used to access functionality related to your extension.
Extension - Interface in burp.api.montoya.extension
This interface provides access to functionality related to your Extension.
EXTENSION_PROVIDED - burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPointType
 
ExtensionGeneratedAuditInsertionPoint - Interface in burp.api.montoya.scanner.audit.insertionpoint
This interface is used to define an insertion point for use by Scan checks.
ExtensionHttpMessageEditor - Interface in burp.api.montoya.ui.editor.extension
This interface provides shared information for the ExtensionHttpRequestEditor and ExtensionHttpResponseEditor interfaces
ExtensionHttpRequestEditor - Interface in burp.api.montoya.ui.editor.extension
Extensions that register an ExtensionHttpRequestEditorProvider must return an instance of this interface.
ExtensionHttpRequestEditorProvider - Interface in burp.api.montoya.ui.editor.extension
Extensions can register an instance of this interface to provide custom HTTP request editors within Burp's user interface.
ExtensionHttpResponseEditor - Interface in burp.api.montoya.ui.editor.extension
Extensions that register an ExtensionHttpResponseEditorProvider must return an instance of this interface.
ExtensionHttpResponseEditorProvider - Interface in burp.api.montoya.ui.editor.extension
Extensions can register an instance of this interface to provide custom HTTP response editors within Burp's user interface.
EXTENSIONS - burp.api.montoya.core.ToolType
 
extensionUnloaded() - Method in interface burp.api.montoya.extension.ExtensionUnloadingHandler
This method is called when the extension is unloaded.
ExtensionUnloadingHandler - Interface in burp.api.montoya.extension
Extensions can implement this interface and then call Extension.registerUnloadingHandler(ExtensionUnloadingHandler) (ExtensionUnloadingHandler)} to register an extension unload handler.

F

FACTORY - Static variable in class burp.api.montoya.internal.ObjectFactoryLocator
This is initialized when your extension is loaded.
FALSE_POSITIVE - burp.api.montoya.scanner.audit.issues.AuditIssueSeverity
 
filename() - Method in interface burp.api.montoya.extension.Extension
This method retrieves the absolute path name of the file from which the current extension was loaded.
FinalInterceptAction - Enum in burp.api.montoya.proxy
This enum represents the final action to be taken when intercepting HTTP and WebSocket messages in the Proxy.
finalInterceptResult(HttpRequest, Annotations, FinalInterceptAction) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
finalInterceptResult(HttpRequest, Annotations, FinalInterceptAction) - Static method in interface burp.api.montoya.proxy.RequestFinalInterceptResult
This method can be used to create a default implementation of a final intercept result for an HTTP request.
finalInterceptResult(HttpResponse, Annotations, FinalInterceptAction) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
finalInterceptResult(HttpResponse, Annotations, FinalInterceptAction) - Static method in interface burp.api.montoya.proxy.ResponseFinalInterceptResult
This method can be used to create a default implementation of a final intercept result for an HTTP response.
finalRequest() - Method in interface burp.api.montoya.proxy.ProxyRequestResponse
This method retrieves the HTTP request that was issued by Burp Proxy.
FIRM - burp.api.montoya.scanner.audit.issues.AuditIssueConfidence
 
FIRST_HEADER_TAG - burp.api.montoya.http.message.responses.analysis.AttributeType
 
FOLLOW_USER_RULES - burp.api.montoya.proxy.InitialInterceptAction
Causes Burp Proxy to follow the current interception rules to determine the appropriate action to take for the message.
followUserRules(HttpRequest) - Static method in interface burp.api.montoya.proxy.RequestInitialInterceptResult
This method can be used to create a result that causes Burp Proxy to follow the current interception rules to determine the appropriate action to take for the request.
followUserRules(HttpRequest, Annotations) - Static method in interface burp.api.montoya.proxy.RequestInitialInterceptResult
This method can be used to create a result that causes Burp Proxy to follow the current interception rules to determine the appropriate action to take for the request.
followUserRules(HttpResponse) - Static method in interface burp.api.montoya.proxy.ResponseInitialInterceptResult
This method can be used to create a result that causes Burp Proxy to follow the current interception rules to determine the appropriate action to take for the response.
followUserRules(HttpResponse, Annotations) - Static method in interface burp.api.montoya.proxy.ResponseInitialInterceptResult
This method can be used to create a result that causes Burp Proxy to follow the current interception rules to determine the appropriate action to take for the response.
from(ByteArray) - Static method in interface burp.api.montoya.intruder.Payload
This method is a helper method to create a new Payload instance from a byte array payload value.
from(String) - Static method in interface burp.api.montoya.intruder.Payload
This is a helper method to create a new Payload instance from a String payload value.

G

generateDigest(ByteArray, DigestAlgorithm) - Method in interface burp.api.montoya.utilities.CryptoUtils
Generate a message digest for the supplied data using the specified algorithm
generatePayload(PayloadOption...) - Method in interface burp.api.montoya.collaborator.CollaboratorClient
This method is used to generate new Burp Collaborator payloads.
generatePayload(String, PayloadOption...) - Method in interface burp.api.montoya.collaborator.CollaboratorClient
This method is used to generate new Burp Collaborator payloads with custom data.
generatePayloadFor(IntruderInsertionPoint) - Method in interface burp.api.montoya.intruder.PayloadGenerator
This method is used by Burp to obtain the value of the next payload.
generateReport(List<AuditIssue>, ReportFormat, Path) - Method in interface burp.api.montoya.scanner.Scanner
This method is used to generate a report for the specified Scanner issues.
getAllInteractions() - Method in interface burp.api.montoya.collaborator.CollaboratorClient
This method is used to retrieve all Collaborator server interactions resulting from payloads that were generated for this client.
getBoolean(String) - Method in interface burp.api.montoya.persistence.support.PrimitivesSupport
Returns the Boolean to which the specified key is mapped, or null if this map contains no mapping for the key.
getBooleanList(String) - Method in interface burp.api.montoya.persistence.support.PrimitiveListSupport
Returns the List of Boolean to which the specified key is mapped.
getByte(int) - Method in interface burp.api.montoya.core.ByteArray
This method returns a byte stored at the provided index.
getByte(String) - Method in interface burp.api.montoya.persistence.support.PrimitivesSupport
Returns the Byte to which the specified key is mapped, or null if this map contains no mapping for the key.
getByteArray(String) - Method in interface burp.api.montoya.persistence.support.ByteArraySupport
Returns the ByteArray to which the specified key is mapped, or null if this map contains no mapping for the key.
getByteArrayList(String) - Method in interface burp.api.montoya.persistence.support.ByteArraySupport
Returns the List of ByteArray to which the specified key is mapped, or null if this map contains no mapping for the key
getBytes() - Method in interface burp.api.montoya.core.ByteArray
This method returns all bytes.
getBytes(int, int) - Method in interface burp.api.montoya.core.ByteArray
This method returns all bytes between the start index (inclusive) and the end index (exclusive).
getBytes(Range) - Method in interface burp.api.montoya.core.ByteArray
This method returns all bytes in the specified range.
getContents() - Method in interface burp.api.montoya.ui.editor.RawEditor
 
getDecoder() - Method in interface burp.api.montoya.utilities.Base64Utils
 
getEncoder() - Method in interface burp.api.montoya.utilities.Base64Utils
 
getHttpRequest() - Method in interface burp.api.montoya.ui.editor.extension.ExtensionHttpRequestEditor
 
getHttpRequest(String) - Method in interface burp.api.montoya.persistence.support.RequestResponseSupport
Returns the HttpRequest to which the specified key is mapped, or null if this map contains no mapping for the key.
getHttpRequestList(String) - Method in interface burp.api.montoya.persistence.support.RequestResponseSupport
Returns the List of HttpRequest to which the specified key is mapped, or null if this map contains no mapping for the key
getHttpRequestResponse(String) - Method in interface burp.api.montoya.persistence.support.RequestResponseSupport
Returns the HttpRequestResponse to which the specified key is mapped, or null if this map contains no mapping for the key.
getHttpRequestResponseList(String) - Method in interface burp.api.montoya.persistence.support.RequestResponseSupport
Returns the List of HttpRequestResponse to which the specified key is mapped, or null if this map contains no mapping for the key
getHttpResponse() - Method in interface burp.api.montoya.ui.editor.extension.ExtensionHttpResponseEditor
 
getHttpResponse(String) - Method in interface burp.api.montoya.persistence.support.RequestResponseSupport
Returns the HttpResponse to which the specified key is mapped, or null if this map contains no mapping for the key.
getHttpResponseList(String) - Method in interface burp.api.montoya.persistence.support.RequestResponseSupport
Returns the List of HttpResponse to which the specified key is mapped, or null if this map contains no mapping for the key
getInteger(String) - Method in interface burp.api.montoya.persistence.support.PrimitivesSupport
Returns the Integer to which the specified key is mapped, or null if this map contains no mapping for the key.
getIntegerList(String) - Method in interface burp.api.montoya.persistence.support.PrimitiveListSupport
Returns the List of Integer to which the specified key is mapped.
getInteractions(InteractionFilter) - Method in interface burp.api.montoya.collaborator.CollaboratorClient
This method is used to retrieve filtered Collaborator server interactions resulting from payloads that were generated for this client.
getLong(String) - Method in interface burp.api.montoya.persistence.support.PrimitivesSupport
Returns the Long to which the specified key is mapped, or null if this map contains no mapping for the key.
getLongList(String) - Method in interface burp.api.montoya.persistence.support.PrimitiveListSupport
Returns the List of Long to which the specified key is mapped.
getMimeDecoder() - Method in interface burp.api.montoya.utilities.Base64Utils
 
getMimeEncoder() - Method in interface burp.api.montoya.utilities.Base64Utils
 
getMimeEncoder(int, String) - Method in interface burp.api.montoya.utilities.Base64Utils
 
getRequest() - Method in interface burp.api.montoya.ui.editor.HttpRequestEditor
 
getRequestResponse() - Method in interface burp.api.montoya.ui.contextmenu.MessageEditorHttpRequestResponse
 
getResponse() - Method in interface burp.api.montoya.ui.editor.HttpResponseEditor
 
getSecretKey() - Method in interface burp.api.montoya.collaborator.CollaboratorClient
This provides the secret key that is associated with this client context.
getShort(String) - Method in interface burp.api.montoya.persistence.support.PrimitivesSupport
Returns the Short to which the specified key is mapped, or null if this map contains no mapping for the key.
getShortList(String) - Method in interface burp.api.montoya.persistence.support.PrimitiveListSupport
Returns the List of Short to which the specified key is mapped.
getString(String) - Method in interface burp.api.montoya.persistence.support.PrimitivesSupport
Returns the String to which the specified key is mapped, or null if this map contains no mapping for the key.
getStringList(String) - Method in interface burp.api.montoya.persistence.support.PrimitiveListSupport
Returns the List of String to which the specified key is mapped or null if this map contains no mapping for the key
getUrlDecoder() - Method in interface burp.api.montoya.utilities.Base64Utils
 
getUrlEncoder() - Method in interface burp.api.montoya.utilities.Base64Utils
 
GOST3411 - burp.api.montoya.utilities.DigestAlgorithm
 
GOST3411_2012_256 - burp.api.montoya.utilities.DigestAlgorithm
 
GOST3411_2012_512 - burp.api.montoya.utilities.DigestAlgorithm
 
GRAY - burp.api.montoya.core.HighlightColor
 
GREEN - burp.api.montoya.core.HighlightColor
 
GZIP - burp.api.montoya.utilities.CompressionType
 

H

handle(HttpRequest, Annotations, List<HttpRequestResponse>) - Method in interface burp.api.montoya.http.sessions.SessionHandlingAction
This method is invoked when the session handling action should be executed.
handleBinaryMessage(ByteArray, Direction) - Method in interface burp.api.montoya.websocket.WebSocketHandler
Invoked when a binary message is sent or received from the application.
handleBinaryMessageReceived(ByteArray, Direction) - Method in interface burp.api.montoya.proxy.ProxyWebSocketHandler
Invoked when a binary message is received from either the client or server.
handleBinaryMessageToBeIssued(ByteArray, Direction) - Method in interface burp.api.montoya.proxy.ProxyWebSocketHandler
Invoked when a binary message is about to be sent to either the client or server.
handleHttpRequest(HttpRequest, Annotations, ToolSource) - Method in interface burp.api.montoya.http.HttpHandler
This method is invoked by Burp when an HTTP request is about to be issued.
handleHttpResponse(HttpResponse, HttpRequest, Annotations, ToolSource) - Method in interface burp.api.montoya.http.HttpHandler
This method is invoked by Burp when an HTTP response has been received.
handleNewAuditIssue(AuditIssue) - Method in interface burp.api.montoya.scanner.audit.AuditIssueHandler
This method is invoked when a new issue is added to Burp Scanner's results.
handleReceivedRequest(InterceptedHttpRequest, Annotations) - Method in interface burp.api.montoya.proxy.ProxyHttpRequestHandler
This method is invoked when an HTTP request is received in the Proxy.
handleReceivedResponse(InterceptedHttpResponse, HttpRequest, Annotations) - Method in interface burp.api.montoya.proxy.ProxyHttpResponseHandler
This method is invoked when an HTTP response is received in the Proxy.
handleRequestToIssue(InterceptedHttpRequest, Annotations) - Method in interface burp.api.montoya.proxy.ProxyHttpRequestHandler
This method is invoked when an HTTP request has been processed by the Proxy before it is issued.
handleResponseToReturn(InterceptedHttpResponse, HttpRequest, Annotations) - Method in interface burp.api.montoya.proxy.ProxyHttpResponseHandler
This method is invoked when an HTTP response has been processed by the Proxy before it is returned to the client.
handleTextMessage(String, Direction) - Method in interface burp.api.montoya.websocket.WebSocketHandler
Invoked when a text message is sent or received from the application.
handleTextMessageReceived(String, Direction) - Method in interface burp.api.montoya.proxy.ProxyWebSocketHandler
Invoked when a text message is received from either the client or server.
handleTextMessageToBeIssued(String, Direction) - Method in interface burp.api.montoya.proxy.ProxyWebSocketHandler
Invoked when a text message is about to be sent to either the client or server.
handleWebSocketCreated(ProxyWebSocket, HttpRequest) - Method in interface burp.api.montoya.proxy.ProxyWebSocketCreationHandler
This method is invoked by Burp when a WebSocket has been created by the Proxy tool.
handleWebSocketCreated(WebSocket, HttpRequest, ToolSource) - Method in interface burp.api.montoya.websocket.WebSocketCreationHandler
This method is invoked by Burp when a WebSocket has been created.
HARAKA_256 - burp.api.montoya.utilities.DigestAlgorithm
 
HARAKA_512 - burp.api.montoya.utilities.DigestAlgorithm
 
HEADER - burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPointType
 
HEADER_TAGS - burp.api.montoya.http.message.responses.analysis.AttributeType
 
headers() - Method in interface burp.api.montoya.http.message.HttpMessage
This method is used to obtain the HTTP headers contained in the message.
HIGH - burp.api.montoya.scanner.audit.issues.AuditIssueSeverity
 
highlightColor() - Method in interface burp.api.montoya.core.Annotations
 
HighlightColor - Enum in burp.api.montoya.core
This enum represents colors that can be used for highlights in Burp Suite.
HINFO - burp.api.montoya.collaborator.DnsQueryType
 
history() - Method in interface burp.api.montoya.proxy.Proxy
This method returns details of all items in the Proxy history.
history(ProxyHistoryFilter) - Method in interface burp.api.montoya.proxy.Proxy
This method returns details of items in the Proxy history based on the filter.
host() - Method in interface burp.api.montoya.http.HttpService
 
HTML - burp.api.montoya.http.MimeType
 
HTML - burp.api.montoya.scanner.ReportFormat
 
HtmlEncoding - Enum in burp.api.montoya.utilities
This enum defines HTML encodings.
htmlUtils() - Method in interface burp.api.montoya.utilities.Utilities
 
HtmlUtils - Interface in burp.api.montoya.utilities
This interface gives you access to HTML encoding and decoding features.
http() - Method in interface burp.api.montoya.MontoyaApi
This method is used to access the functionality related to HTTP requests and responses.
Http - Interface in burp.api.montoya.http
This interface is used to access HTTP related functionality of Burp.
HTTP - burp.api.montoya.collaborator.InteractionType
 
HTTP - burp.api.montoya.http.HttpProtocol
 
HTTP_1 - burp.api.montoya.http.HttpMode
 
HTTP_2 - burp.api.montoya.http.HttpMode
 
HTTP_2_IGNORE_ALPN - burp.api.montoya.http.HttpMode
 
httpDetails() - Method in interface burp.api.montoya.collaborator.Interaction
Returns the HTTP interaction details.
HttpDetails - Interface in burp.api.montoya.collaborator
This interface provides information about an HTTP interaction detected by Burp Collaborator.
HttpHandler - Interface in burp.api.montoya.http
Extensions can implement this interface and then call Http.registerHttpHandler(burp.api.montoya.http.HttpHandler) to register an HTTP handler.
httpHeader(String) - Static method in interface burp.api.montoya.http.message.headers.HttpHeader
Create a new instance of HttpHeader from a String header representation.
httpHeader(String) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
httpHeader(String, String) - Static method in interface burp.api.montoya.http.message.headers.HttpHeader
Create a new instance of HttpHeader from name and value.
httpHeader(String, String) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
HttpHeader - Interface in burp.api.montoya.http.message.headers
This interface is used to hold details about an HTTP/2 header.
HttpMessage - Interface in burp.api.montoya.http.message
This interface is used to retrieve common information shared by HttpRequest and HttpResponse interfaces.
HttpMode - Enum in burp.api.montoya.http
This enum defines HTTP modes.
HttpParameter - Interface in burp.api.montoya.http.message.params
This interface is used to hold details about an HTTP request parameter.
HttpParameterType - Enum in burp.api.montoya.http.message.params
An enum to define HTTP parameter types.
HttpProtocol - Enum in burp.api.montoya.http
This enum defines HTTP protocols.
httpRequest() - Method in interface burp.api.montoya.http.message.HttpRequestResponse
 
httpRequest(ByteArray) - Static method in interface burp.api.montoya.http.message.requests.HttpRequest
This is a helper method to create a new instance of HttpRequest.
httpRequest(HttpService, ByteArray) - Static method in interface burp.api.montoya.http.message.requests.HttpRequest
This is a helper method to create a new instance of HttpRequest.
httpRequest(HttpService, ByteArray) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
httpRequest(HttpService, String) - Static method in interface burp.api.montoya.http.message.requests.HttpRequest
This is a helper method to create a new instance of HttpRequest.
httpRequest(HttpService, String) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
httpRequest(HttpService, List<String>, ByteArray) - Static method in interface burp.api.montoya.http.message.requests.HttpRequest
This is a helper method to create a new instance of HttpRequest.
httpRequest(HttpService, List<String>, ByteArray) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
httpRequest(HttpService, List<String>, String) - Static method in interface burp.api.montoya.http.message.requests.HttpRequest
This is a helper method to create a new instance of HttpRequest.
httpRequest(HttpService, List<String>, String) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
httpRequest(String) - Static method in interface burp.api.montoya.http.message.requests.HttpRequest
This is a helper method to create a new instance of HttpRequest.
HttpRequest - Interface in burp.api.montoya.http.message.requests
This interface is used to retrieve key details about an HTTP request.
HttpRequestEditor - Interface in burp.api.montoya.ui.editor
This interface provides extensions with an instance of Burp Suites HTTP request editor to use in their own user interface.
httpRequestFromUrl(String) - Static method in interface burp.api.montoya.http.message.requests.HttpRequest
This is a helper method to create a new instance of HttpRequest.
httpRequestFromUrl(String) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
httpRequestResponse(HttpRequest, HttpResponse) - Static method in interface burp.api.montoya.http.message.HttpRequestResponse
This is a helper method to create a new instance of HttpRequestResponse.
httpRequestResponse(HttpRequest, HttpResponse, Annotations) - Static method in interface burp.api.montoya.http.message.HttpRequestResponse
This is a helper method to create a new instance of HttpRequestResponse.
httpRequestResponse(HttpRequest, HttpResponse, Annotations) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
HttpRequestResponse - Interface in burp.api.montoya.http.message
This interface is used to define a coupling between HttpRequest and HttpResponse interfaces.
httpRequestTemplate(ByteArray, List<Range>) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
httpRequestTemplate(ByteArray, List<Range>) - Static method in interface burp.api.montoya.intruder.HttpRequestTemplate
This method is a helper method used to generate new HttpRequestTemplate instance from an HTTP request in a byte array form and a list of insertion point offsets.
httpRequestTemplate(HttpRequest, List<Range>) - Static method in interface burp.api.montoya.intruder.HttpRequestTemplate
This method is a helper method used to generate a new HttpRequestTemplate instance from an HttpRequest object and a list of insertion point offsets.
HttpRequestTemplate - Interface in burp.api.montoya.intruder
This interface is used to represent an Intruder request template, which contains the HTTP request and insertion point offsets.
httpResponse() - Method in interface burp.api.montoya.http.message.HttpRequestResponse
 
httpResponse(ByteArray) - Static method in interface burp.api.montoya.http.message.responses.HttpResponse
This is a helper method to create a new instance of HttpResponse.
httpResponse(ByteArray) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
httpResponse(String) - Static method in interface burp.api.montoya.http.message.responses.HttpResponse
This is a helper method to create a new instance of HttpResponse.
httpResponse(String) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
httpResponse(List<String>, ByteArray) - Static method in interface burp.api.montoya.http.message.responses.HttpResponse
This is a helper method to create a new instance of HttpResponse.
httpResponse(List<String>, ByteArray) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
httpResponse(List<String>, String) - Static method in interface burp.api.montoya.http.message.responses.HttpResponse
This is a helper method to create a new instance of HttpResponse.
httpResponse(List<String>, String) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
HttpResponse - Interface in burp.api.montoya.http.message.responses
This interface is used to retrieve key details about an HTTP response.
HttpResponseEditor - Interface in burp.api.montoya.ui.editor
This interface provides extensions with an instance of Burp Suites HTTP response editor to use in their own user interface.
HTTPS - burp.api.montoya.collaborator.DnsQueryType
 
HTTPS - burp.api.montoya.http.HttpProtocol
 
httpService() - Method in interface burp.api.montoya.http.message.requests.HttpRequest
This method is used to retrieve the HTTP service for the request.
httpService() - Method in interface burp.api.montoya.intruder.AttackConfiguration
This method returns an Optional.empty() if the target template contains payload markers.
httpService() - Method in interface burp.api.montoya.scanner.audit.issues.AuditIssue
This method returns the HTTP service for which the issue was generated.
httpService(String) - Static method in interface burp.api.montoya.http.HttpService
Create a new instance of HttpService.
httpService(String) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
httpService(String, boolean) - Static method in interface burp.api.montoya.http.HttpService
Create a new instance of HttpService.
httpService(String, boolean) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
httpService(String, int, boolean) - Static method in interface burp.api.montoya.http.HttpService
Create a new instance of HttpService.
httpService(String, int, boolean) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
HttpService - Interface in burp.api.montoya.http
This interface is used to provide details about an HTTP service, to which HTTP requests can be sent.
HttpTransformation - Enum in burp.api.montoya.http
This enum defines transformations that Burp can apply to an HTTP request.
httpVerbatimRequest(HttpService, List<HttpHeader>, ByteArray) - Static method in interface burp.api.montoya.http.message.requests.HttpRequest
This is a helper method to create a new instance of HttpRequest that will only contain the data provided in the arguments.
httpVerbatimRequest(HttpService, List<HttpHeader>, ByteArray) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
httpVerbatimRequest(HttpService, List<HttpHeader>, String) - Static method in interface burp.api.montoya.http.message.requests.HttpRequest
This is a helper method to create a new instance of HttpRequest that will only contain the data provided in the arguments.
httpVerbatimRequest(HttpService, List<HttpHeader>, String) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 

I

id() - Method in interface burp.api.montoya.collaborator.CollaboratorPayload
Returns the payload's interaction id.
id() - Method in interface burp.api.montoya.collaborator.Interaction
Returns the id.
IMAGE_BMP - burp.api.montoya.http.MimeType
 
IMAGE_GIF - burp.api.montoya.http.MimeType
 
IMAGE_JPEG - burp.api.montoya.http.MimeType
 
IMAGE_PNG - burp.api.montoya.http.MimeType
 
IMAGE_SVG_XML - burp.api.montoya.http.MimeType
 
IMAGE_TIFF - burp.api.montoya.http.MimeType
 
IMAGE_UNKNOWN - burp.api.montoya.http.MimeType
 
importProjectOptionsFromJson(String) - Method in interface burp.api.montoya.burpsuite.BurpSuite
This method causes Burp to load a new project-level configuration from the JSON String provided.
includeInScope(String) - Method in interface burp.api.montoya.scope.Scope
This method can be used to include the specified URL in the Suite-wide target scope.
indexOf(byte[]) - Method in interface burp.api.montoya.core.ByteArray
This method searches the data in the ByteArray for the first occurrence of a specified term.
indexOf(byte[], boolean) - Method in interface burp.api.montoya.core.ByteArray
This method searches the data in the ByteArray for the first occurrence of a specified term.
indexOf(byte[], boolean, int, int) - Method in interface burp.api.montoya.core.ByteArray
This method searches the data in the ByteArray for the first occurrence of a specified term.
indexOf(byte[], byte[]) - Method in interface burp.api.montoya.utilities.ByteUtils
This method searches a piece of data for the first occurrence of a specified pattern.
indexOf(byte[], byte[], boolean) - Method in interface burp.api.montoya.utilities.ByteUtils
This method searches a piece of data for the first occurrence of a specified pattern.
indexOf(byte[], byte[], boolean, int, int) - Method in interface burp.api.montoya.utilities.ByteUtils
This method searches a piece of data for the first occurrence of a specified pattern.
indexOf(String) - Method in interface burp.api.montoya.core.ByteArray
This method searches the data in the ByteArray for the first occurrence of a specified term.
indexOf(String, boolean) - Method in interface burp.api.montoya.core.ByteArray
This method searches the data in the ByteArray for the first occurrence of a specified term.
indexOf(String, boolean, int, int) - Method in interface burp.api.montoya.core.ByteArray
This method searches the data in the ByteArray for the first occurrence of a specified term.
inferredMimeType() - Method in interface burp.api.montoya.http.message.responses.HttpResponse
This method is used to obtain the MIME type of the response, as inferred from the contents of the HTTP message body.
INFORMATION - burp.api.montoya.scanner.audit.issues.AuditIssueSeverity
 
INITIAL_CONTENT - burp.api.montoya.http.message.responses.analysis.AttributeType
 
InitialInterceptAction - Enum in burp.api.montoya.proxy
This enum represents the initial action to be taken when intercepting HTTP and WebSocket messages in the Proxy.
initialInterceptResult(HttpRequest, Annotations, InitialInterceptAction) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
initialInterceptResult(HttpRequest, Annotations, InitialInterceptAction) - Static method in interface burp.api.montoya.proxy.RequestInitialInterceptResult
This method can be used to create a default implementation of an initial intercept result for an HTTP request.
initialInterceptResult(HttpResponse, Annotations, InitialInterceptAction) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
initialInterceptResult(HttpResponse, Annotations, InitialInterceptAction) - Static method in interface burp.api.montoya.proxy.ResponseInitialInterceptResult
This method can be used to create a default implementation of an initial intercept result for an HTTP response.
initialize(MontoyaApi) - Method in interface burp.api.montoya.BurpExtension
This method is invoked when the extension is loaded.
INPUT_IMAGE_LABELS - burp.api.montoya.http.message.responses.analysis.AttributeType
 
INPUT_SUBMIT_LABELS - burp.api.montoya.http.message.responses.analysis.AttributeType
 
inputEvent() - Method in interface burp.api.montoya.ui.contextmenu.ComponentEvent
This method can be used to retrieve the native Java input event that was the trigger for the context menu invocation.
insertionPointCount() - Method in interface burp.api.montoya.scanner.audit.Audit
This method retrieves the number of insertion points.
insertionPointOffsets() - Method in interface burp.api.montoya.intruder.HttpRequestTemplate
This method is used to obtain insertion point offsets for an Intruder attack.
Interaction - Interface in burp.api.montoya.collaborator
This interface provides details of an interaction with the Burp Collaborator server.
InteractionFilter - Interface in burp.api.montoya.collaborator
This interface provides a filtering mechanism for use when retrieving interactions from the Burp Collaborator server.
InteractionId - Interface in burp.api.montoya.collaborator
This interface represents a Burp Collaborator interaction id.
interactionIdFilter(String) - Static method in interface burp.api.montoya.collaborator.InteractionFilter
This method constructs an InteractionFilter that matches any interaction with the specified interaction id.
interactionIdFilter(String) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
interactionPayloadFilter(String) - Static method in interface burp.api.montoya.collaborator.InteractionFilter
This method constructs an InteractionFilter that matches any interaction with the specified payload.
interactionPayloadFilter(String) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
InteractionType - Enum in burp.api.montoya.collaborator
This enum defines the possible types of interaction with Burp Collaborator.
intercept(HttpRequest) - Static method in interface burp.api.montoya.proxy.RequestInitialInterceptResult
This method can be used to create a result that causes Burp Proxy to present the request to the user for manual review or modification.
intercept(HttpRequest, Annotations) - Static method in interface burp.api.montoya.proxy.RequestInitialInterceptResult
This method can be used to create a result that causes Burp Proxy to present the request to the user for manual review or modification.
intercept(HttpResponse) - Static method in interface burp.api.montoya.proxy.ResponseInitialInterceptResult
This method can be used to create a result that causes Burp Proxy to present the response to the user for manual review or modification.
intercept(HttpResponse, Annotations) - Static method in interface burp.api.montoya.proxy.ResponseInitialInterceptResult
This method can be used to create a result that causes Burp Proxy to present the response to the user for manual review or modification.
INTERCEPT - burp.api.montoya.proxy.InitialInterceptAction
Causes Burp Proxy to present the message to the user for manual review or modification.
interceptBinaryMessage(ByteArray) - Static method in interface burp.api.montoya.proxy.ProxyWebSocketInitialInterceptBinaryMessage
This is a helper method to build a binary WebSocket message to be intercepted within the Proxy.
InterceptedHttpRequest - Interface in burp.api.montoya.proxy
This interface represents an instance of an HTTP request intercepted by Burp Proxy.
InterceptedHttpResponse - Interface in burp.api.montoya.proxy
This interface represents an instance of an HTTP response intercepted by Burp Proxy.
InterceptedMessage - Interface in burp.api.montoya.proxy
This interface represents an instance of an HTTP message intercepted by Burp Proxy.
interceptTextMessage(String) - Static method in interface burp.api.montoya.proxy.ProxyWebSocketInitialInterceptTextMessage
This is a helper method to build a text WebSocket message to be intercepted within the Proxy.
intruder() - Method in interface burp.api.montoya.MontoyaApi
This method is used to access the functionality of the Intruder.
Intruder - Interface in burp.api.montoya.intruder
This interface provides access to the functionality of the Burp Intruder tool.
INTRUDER - burp.api.montoya.core.ToolType
 
INTRUDER_ATTACK_RESULTS - burp.api.montoya.ui.contextmenu.InvocationType
 
INTRUDER_PAYLOAD_POSITIONS - burp.api.montoya.ui.contextmenu.InvocationType
 
IntruderInsertionPoint - Interface in burp.api.montoya.intruder
This interface is used to represent an Intruder insertion point for attack payloads.
InvalidLauncherConfigurationException - Exception in burp.api.montoya.scanner
This exception is thrown if the configuration for a Scan is invalid.
InvalidLauncherConfigurationException() - Constructor for exception burp.api.montoya.scanner.InvalidLauncherConfigurationException
 
InvalidLauncherConfigurationException(String) - Constructor for exception burp.api.montoya.scanner.InvalidLauncherConfigurationException
 
InvalidLauncherConfigurationException(Throwable) - Constructor for exception burp.api.montoya.scanner.InvalidLauncherConfigurationException
 
invariantAttributes() - Method in interface burp.api.montoya.http.message.responses.analysis.ResponseVariationsAnalyzer
 
invariantKeywords() - Method in interface burp.api.montoya.http.message.responses.analysis.ResponseKeywordsAnalyzer
 
InvocationSource - Interface in burp.api.montoya.ui.contextmenu
This interface provides information about the source from which a context menu was invoked.
invocationType() - Method in interface burp.api.montoya.ui.contextmenu.InvocationSource
 
InvocationType - Enum in burp.api.montoya.ui.contextmenu
An enum containing different types of context menu invocations.
isBapp() - Method in interface burp.api.montoya.extension.Extension
This method determines whether the current extension was loaded as a BApp.
isEnabledFor(HttpRequestResponse) - Method in interface burp.api.montoya.ui.editor.extension.ExtensionHttpMessageEditor
A check to determine if the HTTP message editor is enabled for a specific HttpRequestResponse
isFrom(InvocationType...) - Method in interface burp.api.montoya.ui.contextmenu.InvocationSource
A helper method to allow the extension to ask if the context is within a set of locations.
isFromTool(ToolType...) - Method in interface burp.api.montoya.core.ToolSource
This method is used to determine whether this tool source is from a specified tool.
isInScope(String) - Method in interface burp.api.montoya.scope.Scope
This method can be used to query whether a specified URL is within the current Suite-wide target scope.
isLiteralAddress() - Method in interface burp.api.montoya.collaborator.CollaboratorServer
Indicates whether the server address is an IP address.
isModified() - Method in interface burp.api.montoya.ui.editor.Editor
 
isModified() - Method in interface burp.api.montoya.ui.editor.extension.ExtensionHttpMessageEditor
 
isRegistered() - Method in interface burp.api.montoya.core.Registration
This method determines whether the object registered by the extension is currently registered.
issueHighlights(ByteArray) - Method in interface burp.api.montoya.scanner.audit.insertionpoint.ExtensionGeneratedAuditInsertionPoint
This method is used to determine the offsets of the payload value within the request, when it is placed into the insertion point.
issueRequest(HttpRequest) - Method in interface burp.api.montoya.http.Http
This method can be used to issue HTTP requests and retrieve their responses.
issueRequest(HttpRequest, HttpMode) - Method in interface burp.api.montoya.http.Http
This method can be used to issue HTTP requests and retrieve their responses.
issueRequest(HttpRequest, HttpMode, String) - Method in interface burp.api.montoya.http.Http
This method can be used to issue HTTP requests and retrieve their responses.
issues() - Method in interface burp.api.montoya.scanner.audit.Audit
This method retrieves the audit issues found by this audit.
issues() - Method in interface burp.api.montoya.sitemap.SiteMap
This method returns all the current audit issues for URLs in the site map.
issues(SiteMapFilter) - Method in interface burp.api.montoya.sitemap.SiteMap
This method returns current audit issues for URLs in the site map that are matched by the SiteMapFilter object.

J

JSON - burp.api.montoya.http.ContentType
 
JSON - burp.api.montoya.http.message.params.HttpParameterType
 
JSON - burp.api.montoya.http.MimeType
 

K

KECCAK_224 - burp.api.montoya.utilities.DigestAlgorithm
 
KECCAK_256 - burp.api.montoya.utilities.DigestAlgorithm
 
KECCAK_288 - burp.api.montoya.utilities.DigestAlgorithm
 
KECCAK_384 - burp.api.montoya.utilities.DigestAlgorithm
 
KECCAK_512 - burp.api.montoya.utilities.DigestAlgorithm
 
KEEP_BOTH - burp.api.montoya.scanner.ConsolidationAction
 
KEEP_EXISTING - burp.api.montoya.scanner.ConsolidationAction
 
KEEP_NEW - burp.api.montoya.scanner.ConsolidationAction
 
KeySupport - Interface in burp.api.montoya.persistence.support
 
keyword() - Method in interface burp.api.montoya.http.message.responses.analysis.KeywordCount
 
KeywordCount - Interface in burp.api.montoya.http.message.responses.analysis
This interface is used to store the number of types a given keyword appeared in a response.
keywordCounts(String...) - Method in interface burp.api.montoya.http.message.responses.HttpResponse
This method is used to retrieve the number of types given keywords appear in the response.

L

LAST_MODIFIED_HEADER - burp.api.montoya.http.message.responses.analysis.AttributeType
 
LEGACY_SER_AMF - burp.api.montoya.http.MimeType
 
length() - Method in interface burp.api.montoya.core.ByteArray
This method returns the number of bytes stored in the ByteArray.
LIGHT - burp.api.montoya.ui.Theme
 
LIMITED_BODY_CONTENT - burp.api.montoya.http.message.responses.analysis.AttributeType
 
LINE_COUNT - burp.api.montoya.http.message.responses.analysis.AttributeType
 
listenerInterface() - Method in interface burp.api.montoya.proxy.InterceptedMessage
This method retrieves the name of the Burp Proxy listener that is processing the intercepted message.
listKeys() - Method in interface burp.api.montoya.persistence.support.KeySupport
This method is used to list all keys currently mapped for the current persistence environment (Node, Preferences or TemporaryFile)
LOCATION - burp.api.montoya.http.message.responses.analysis.AttributeType
 
LOGGER - burp.api.montoya.core.ToolType
 
logging() - Method in interface burp.api.montoya.MontoyaApi
This method is used to access the functionality related to logging and events.
Logging - Interface in burp.api.montoya.logging
This interface provides access to the functionality related to logging and events.
logToError(String) - Method in interface burp.api.montoya.logging.Logging
This method prints a line of output to the current extension's standard error stream.
logToOutput(String) - Method in interface burp.api.montoya.logging.Logging
This method prints a line of output to the current extension's standard output stream.
LOW - burp.api.montoya.scanner.audit.issues.AuditIssueSeverity
 

M

MAGENTA - burp.api.montoya.core.HighlightColor
 
major() - Method in interface burp.api.montoya.core.Version
This method returns the major version (e.g.
MarkedHttpRequestResponse - Interface in burp.api.montoya.http.message
This interface is used to extend HttpRequestResponse interface to hold message markers data.
markedRequestResponse(HttpRequest, HttpResponse) - Static method in interface burp.api.montoya.http.message.MarkedHttpRequestResponse
This is a helper method to create a new instance of MarkedHttpRequestResponse.
markedRequestResponse(HttpRequest, HttpResponse, Annotations) - Static method in interface burp.api.montoya.http.message.MarkedHttpRequestResponse
This is a helper method to create a new instance of MarkedHttpRequestResponse.
markedRequestResponse(HttpRequest, HttpResponse, Annotations) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
matches(CollaboratorServer, Interaction) - Method in interface burp.api.montoya.collaborator.InteractionFilter
This method will be called for each interaction retrieved from the Collaborator server and determines whether the interaction should be included in the list of interactions returned.
matches(ProxyRequestResponse) - Method in interface burp.api.montoya.proxy.ProxyHistoryFilter
This method is invoked for every item in the Proxy history to determine whether it should be included in the filtered list of items.
matches(SiteMapNode) - Method in interface burp.api.montoya.sitemap.SiteMapFilter
This method is called by Burp to check whether a given site map node matches the filter.
MD2 - burp.api.montoya.utilities.DigestAlgorithm
 
MD4 - burp.api.montoya.utilities.DigestAlgorithm
 
MD5 - burp.api.montoya.utilities.DigestAlgorithm
 
MEDIUM - burp.api.montoya.scanner.audit.issues.AuditIssueSeverity
 
MESSAGE_EDITOR_REQUEST - burp.api.montoya.ui.contextmenu.InvocationType
 
MESSAGE_EDITOR_RESPONSE - burp.api.montoya.ui.contextmenu.InvocationType
 
MESSAGE_VIEWER_REQUEST - burp.api.montoya.ui.contextmenu.InvocationType
 
MESSAGE_VIEWER_RESPONSE - burp.api.montoya.ui.contextmenu.InvocationType
 
messageAnnotations() - Method in interface burp.api.montoya.http.message.HttpRequestResponse
 
messageAnnotations() - Method in interface burp.api.montoya.proxy.ProxyRequestResponse
This method retrieves the annotations for the request/response pair.
MessageEditorHttpRequestResponse - Interface in burp.api.montoya.ui.contextmenu
This class contains information about a user selection of a request or response within a Burp Suite message editor.
MessageEditorHttpRequestResponse.SelectionContext - Enum in burp.api.montoya.ui.contextmenu
 
messageEditorRequestResponse() - Method in interface burp.api.montoya.ui.contextmenu.ContextMenuEvent
This method can be used to retrieve details of the currently selected HTTP request/response when the context menu was invoked.
messageId() - Method in interface burp.api.montoya.proxy.InterceptedMessage
This method retrieves a unique ID for this request/response.
method() - Method in interface burp.api.montoya.http.message.requests.HttpRequest
 
MimeType - Enum in burp.api.montoya.http
This enum defines MIME types that are recognised by Burp.
minor() - Method in interface burp.api.montoya.core.Version
This method returns the minor version (e.g.
MontoyaApi - Interface in burp.api.montoya
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 - Interface in burp.api.montoya.internal
 
MULTIPART - burp.api.montoya.http.ContentType
 
MULTIPART_ATTRIBUTE - burp.api.montoya.http.message.params.HttpParameterType
 
MX - burp.api.montoya.collaborator.DnsQueryType
 

N

name - Variable in enum burp.api.montoya.core.BurpSuiteEdition
 
name - Variable in enum burp.api.montoya.utilities.DigestAlgorithm
 
name() - Method in interface burp.api.montoya.core.Version
This method returns the product name (e.g.
name() - Method in interface burp.api.montoya.http.message.cookies.Cookie
This method is used to retrieve the name of the cookie.
name() - Method in interface burp.api.montoya.http.message.headers.HttpHeader
 
name() - Method in interface burp.api.montoya.http.message.params.HttpParameter
 
name() - Method in interface burp.api.montoya.http.sessions.SessionHandlingAction
 
name() - Method in interface burp.api.montoya.scanner.audit.insertionpoint.ExtensionGeneratedAuditInsertionPoint
This method returns the name of this insertion point.
name() - Method in interface burp.api.montoya.scanner.audit.issues.AuditIssue
This method returns the name of this issue type.
name() - Method in interface burp.api.montoya.scanner.audit.issues.AuditIssueDefinition
This method returns the name of this issue type.
nameOffsets() - Method in interface burp.api.montoya.http.message.params.ParsedHttpParameter
This method is used to retrieve the offsets of the parameter name within the HTTP request.
NAPTR - burp.api.montoya.collaborator.DnsQueryType
 
Node - Interface in burp.api.montoya.persistence
This interface represents an instance of a class that allows data to be stored and accessed from the Burp project.
NON_HIDDEN_FORM_INPUT_TYPES - burp.api.montoya.http.message.responses.analysis.AttributeType
 
NONE - burp.api.montoya.core.HighlightColor
 
NONE - burp.api.montoya.http.ContentType
 
NONE - burp.api.montoya.http.MimeType
 
NS - burp.api.montoya.collaborator.DnsQueryType
 
numberUtils() - Method in interface burp.api.montoya.utilities.Utilities
 
NumberUtils - Interface in burp.api.montoya.utilities
This interface gives you access to number string conversion features.

O

ObjectFactoryLocator - Class in burp.api.montoya.internal
 
ObjectFactoryLocator() - Constructor for class burp.api.montoya.internal.ObjectFactoryLocator
 
offsets() - Method in interface burp.api.montoya.ui.Selection
 
onClose() - Method in interface burp.api.montoya.proxy.ProxyWebSocketHandler
Invoked when the WebSocket is closed.
onClose() - Method in interface burp.api.montoya.websocket.WebSocketHandler
Invoked when the WebSocket is closed.
ORANGE - burp.api.montoya.core.HighlightColor
 
originalResponse() - Method in interface burp.api.montoya.proxy.ProxyRequestResponse
This method retrieves the HTTP response that was received by Burp Proxy.
OUTBOUND_EDGE_COUNT - burp.api.montoya.http.message.responses.analysis.AttributeType
 
OUTBOUND_EDGE_TAG_NAMES - burp.api.montoya.http.message.responses.analysis.AttributeType
 
output() - Method in interface burp.api.montoya.logging.Logging
This method is used to obtain the current extension's standard output stream.

P

PAGE_TITLE - burp.api.montoya.http.message.responses.analysis.AttributeType
 
PARALLEL_HASH_128_256 - burp.api.montoya.utilities.DigestAlgorithm
 
PARALLEL_HASH_256_512 - burp.api.montoya.utilities.DigestAlgorithm
 
PARAM_AMF - burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPointType
 
PARAM_BODY - burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPointType
 
PARAM_COOKIE - burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPointType
 
PARAM_JSON - burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPointType
 
PARAM_MULTIPART_ATTR - burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPointType
 
PARAM_NAME_BODY - burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPointType
 
PARAM_NAME_URL - burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPointType
 
PARAM_URL - burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPointType
 
PARAM_XML - burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPointType
 
PARAM_XML_ATTR - burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPointType
 
parameter(String, String, HttpParameterType) - Static method in interface burp.api.montoya.http.message.params.HttpParameter
Create a new Instance of HttpParameter with the specified type.
parameter(String, String, HttpParameterType) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
parameters() - Method in interface burp.api.montoya.http.message.requests.HttpRequest
 
ParsedHttpParameter - Interface in burp.api.montoya.http.message.params
This interface is used to hold additional details about an HTTP request parameter that has been parsed by Burp.
PASSIVE_AUDIT_CHECKS - burp.api.montoya.scanner.BuiltInScanConfiguration
 
passiveAudit(HttpRequestResponse) - Method in interface burp.api.montoya.scanner.ScanCheck
The Scanner invokes this method for each base request / response that is passively audited.
path() - Method in interface burp.api.montoya.http.message.cookies.Cookie
This method is used to retrieve the path for which the cookie is in scope.
payload() - Method in interface burp.api.montoya.proxy.ProxyWebSocketFinalInterceptBinaryMessage
 
payload() - Method in interface burp.api.montoya.proxy.ProxyWebSocketFinalInterceptTextMessage
 
payload() - Method in interface burp.api.montoya.proxy.ProxyWebSocketInitialInterceptBinaryMessage
 
payload() - Method in interface burp.api.montoya.proxy.ProxyWebSocketInitialInterceptTextMessage
 
payload() - Method in interface burp.api.montoya.websocket.WebSocketBinaryMessage
 
payload() - Method in interface burp.api.montoya.websocket.WebSocketTextMessage
 
Payload - Interface in burp.api.montoya.intruder
This interface represents an Intruder payload.
PayloadGenerator - Interface in burp.api.montoya.intruder
This interface is used for custom Intruder payload generators.
PayloadGeneratorProvider - Interface in burp.api.montoya.intruder
Extensions can implement this interface and then call Intruder.registerPayloadGeneratorProvider(burp.api.montoya.intruder.PayloadGeneratorProvider) to register a provider for custom Intruder payload generators.
PayloadOption - Enum in burp.api.montoya.collaborator
This enum defines options that can be specified when generating Burp Collaborator payloads.
PayloadProcessingAction - Enum in burp.api.montoya.intruder
An enum to describe instructions that the payload processor can give Intruder for the current payload.
payloadProcessingResult(ByteArray, PayloadProcessingAction) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
PayloadProcessingResult - Interface in burp.api.montoya.intruder
PayloadProcessor - Interface in burp.api.montoya.intruder
Extensions can implement this interface and then call Intruder.registerPayloadProcessor(burp.api.montoya.intruder.PayloadProcessor) to register a custom Intruder payload processor.
persistence() - Method in interface burp.api.montoya.MontoyaApi
This method is used to access the functionality related to persistence.
Persistence - Interface in burp.api.montoya.persistence
This interface provides access to the functionality related to persistence.
PINK - burp.api.montoya.core.HighlightColor
 
PLAIN_TEXT - burp.api.montoya.http.MimeType
 
port() - Method in interface burp.api.montoya.http.HttpService
 
preferences() - Method in interface burp.api.montoya.persistence.Persistence
This method is used to access the functionality related to java preference store in a way that survives reloads of the extension and of Burp Suite.
Preferences - Interface in burp.api.montoya.persistence
This interface represents an instance of a class that allows data to be stored and accessed from the java preference store.
prefixFilter(String) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
prefixFilter(String) - Static method in interface burp.api.montoya.sitemap.SiteMapFilter
This method returns a site map filter object that matches site map nodes with URLs starting with the specified prefix.
PrimitiveListSupport - Interface in burp.api.montoya.persistence.support
 
PrimitivesSupport - Interface in burp.api.montoya.persistence.support
 
PRINTABLE - burp.api.montoya.utilities.RandomUtils.CharacterSet
 
processedPayload() - Method in interface burp.api.montoya.intruder.PayloadProcessingResult
 
processPayload(Payload, Payload, IntruderInsertionPoint) - Method in interface burp.api.montoya.intruder.PayloadProcessor
This method is invoked by Burp each time the processor should be applied to an Intruder payload.
PROFESSIONAL - burp.api.montoya.core.BurpSuiteEdition
 
PROMPT_USER - burp.api.montoya.burpsuite.ShutdownOptions
 
protocol() - Method in interface burp.api.montoya.collaborator.HttpDetails
Returns the HTTP protocol.
protocol() - Method in interface burp.api.montoya.collaborator.SmtpDetails
Returns the SMTP protocol.
provideHttpRequestEditor(HttpRequestResponse, EditorMode) - Method in interface burp.api.montoya.ui.editor.extension.ExtensionHttpRequestEditorProvider
This method is invoked by Burp when a new HTTP request editor is created.
provideHttpResponseEditor(HttpRequestResponse, EditorMode) - Method in interface burp.api.montoya.ui.editor.extension.ExtensionHttpResponseEditorProvider
This method is invoked by Burp when a new HTTP response editor is created.
provideInsertionPoints(HttpRequestResponse) - Method in interface burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPointProvider
The Scanner invokes this method when a request is actively audited.
provideMenuItems(ContextMenuEvent) - Method in interface burp.api.montoya.ui.contextmenu.ContextMenuItemsProvider
This method is invoked by Burp Suite when the user requests a context menu anywhere in the user interface.
providePayloadGenerator(AttackConfiguration) - Method in interface burp.api.montoya.intruder.PayloadGeneratorProvider
This method is called by Burp to obtain an instance of PayloadGenerator to add to Intruder.
proxy() - Method in interface burp.api.montoya.MontoyaApi
This method is used to access the functionality of the Proxy.
Proxy - Interface in burp.api.montoya.proxy
This interface provides access to the functionality of the Proxy tool.
PROXY - burp.api.montoya.core.ToolType
 
PROXY_HISTORY - burp.api.montoya.ui.contextmenu.InvocationType
 
ProxyHistoryFilter - Interface in burp.api.montoya.proxy
Extensions can implement this interface and then call Proxy.history(ProxyHistoryFilter) to get a filtered list of items in the Proxy history.
ProxyHttpRequestHandler - Interface in burp.api.montoya.proxy
Extensions can implement this interface and then call Proxy.registerRequestHandler(ProxyHttpRequestHandler) to register a Proxy request handler.
ProxyHttpResponseHandler - Interface in burp.api.montoya.proxy
Extensions can implement this interface and then call Proxy.registerResponseHandler(ProxyHttpResponseHandler) to register a Proxy response handler.
ProxyRequestResponse - Interface in burp.api.montoya.proxy
This interface represents an instance of an HTTP request and response intercepted by the Proxy.
ProxyWebSocket - Interface in burp.api.montoya.proxy
This interface represents a ProxyWebSocket within Burp.
proxyWebSocketBinaryMessage(ByteArray, FinalInterceptAction) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
proxyWebSocketBinaryMessage(ByteArray, InitialInterceptAction) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
ProxyWebSocketCreationHandler - Interface in burp.api.montoya.proxy
Extensions can implement this interface and then call Proxy.registerWebSocketCreationHandler(burp.api.montoya.proxy.ProxyWebSocketCreationHandler) to register a WebSocket handler.
ProxyWebSocketFinalInterceptBinaryMessage - Interface in burp.api.montoya.proxy
Extensions can implement this interface when returning a binary message from ProxyWebSocketHandler.handleBinaryMessageToBeIssued(ByteArray, Direction).
ProxyWebSocketFinalInterceptTextMessage - Interface in burp.api.montoya.proxy
Extensions can implement this interface when returning a text message from ProxyWebSocketHandler.handleTextMessageToBeIssued(String, Direction).
ProxyWebSocketHandler - Interface in burp.api.montoya.proxy
This interface allows an extension to be notified when messages are sent or received via the proxy WebSocket, or it has been closed.
ProxyWebSocketInitialInterceptBinaryMessage - Interface in burp.api.montoya.proxy
Extensions can implement this interface when returning a binary message from ProxyWebSocketHandler.handleBinaryMessageReceived(ByteArray, Direction).
ProxyWebSocketInitialInterceptTextMessage - Interface in burp.api.montoya.proxy
Extensions can implement this interface when returning a text message from ProxyWebSocketHandler.handleTextMessageReceived(String, Direction).
proxyWebSocketTextMessage(String, FinalInterceptAction) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
proxyWebSocketTextMessage(String, InitialInterceptAction) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
PTR - burp.api.montoya.collaborator.DnsQueryType
 
PUNCTUATION - burp.api.montoya.utilities.RandomUtils.CharacterSet
 

Q

query() - Method in interface burp.api.montoya.collaborator.DnsDetails
Returns the raw DNS query.
queryType() - Method in interface burp.api.montoya.collaborator.DnsDetails
Returns the DNS query type.

R

raiseCriticalEvent(String) - Method in interface burp.api.montoya.logging.Logging
This method can be used to display a critical event in the Burp Suite event log.
raiseDebugEvent(String) - Method in interface burp.api.montoya.logging.Logging
This method can be used to display a debug event in the Burp Suite event log.
raiseErrorEvent(String) - Method in interface burp.api.montoya.logging.Logging
This method can be used to display an error event in the Burp Suite event log.
raiseInfoEvent(String) - Method in interface burp.api.montoya.logging.Logging
This method can be used to display an informational event in the Burp Suite event log.
randomString(int) - Method in interface burp.api.montoya.utilities.RandomUtils
Generate a random string using alphanumeric characters
randomString(int, int, RandomUtils.CharacterSet...) - Method in interface burp.api.montoya.utilities.RandomUtils
Generate a random string using the supplied RandomUtils.CharacterSet
randomString(int, int, String) - Method in interface burp.api.montoya.utilities.RandomUtils
Generate a random string using the supplied characters
randomString(int, RandomUtils.CharacterSet...) - Method in interface burp.api.montoya.utilities.RandomUtils
Generate a random string using the supplied RandomUtils.CharacterSet
randomString(int, String) - Method in interface burp.api.montoya.utilities.RandomUtils
Generate a random string using the supplied characters
randomUtils() - Method in interface burp.api.montoya.utilities.Utilities
 
RandomUtils - Interface in burp.api.montoya.utilities
 
RandomUtils.CharacterSet - Enum in burp.api.montoya.utilities
 
range(int, int) - Static method in interface burp.api.montoya.core.Range
This method can be used to create a range object from two indices.
range(int, int) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
Range - Interface in burp.api.montoya.core
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 - Interface in burp.api.montoya.ui.editor
This interface provides extensions with an instance of Burp Suite's HTTP text editor to use in their own user interface.
READ_ONLY - burp.api.montoya.ui.editor.EditorOptions
 
READ_ONLY - burp.api.montoya.ui.editor.extension.EditorMode
 
RECORDED_LOGIN_REPLAYER - burp.api.montoya.core.ToolType
 
RED - burp.api.montoya.core.HighlightColor
 
registerAuditIssueHandler(AuditIssueHandler) - Method in interface burp.api.montoya.scanner.Scanner
This method is used to register a handler which will be notified of new audit issues that are reported by the Scanner tool.
registerContextMenuItemsProvider(ContextMenuItemsProvider) - Method in interface burp.api.montoya.ui.UserInterface
This method can be used to register a provider of custom context menu items.
registerHandler(ProxyWebSocketHandler) - Method in interface burp.api.montoya.proxy.ProxyWebSocket
This method is used to register a handler which will perform actions when messages are sent or received by the WebSocket.
registerHandler(ScopeChangeHandler) - Method in interface burp.api.montoya.scope.Scope
This method is used to register a handler which will be notified of changes to Burp's Suite-wide target scope.
registerHandler(WebSocketHandler) - Method in interface burp.api.montoya.websocket.WebSocket
This method is used to register a handler which will perform an action when a message is sent to or received from the application.
registerHttpHandler(HttpHandler) - Method in interface burp.api.montoya.http.Http
This method is used to register a handler which will perform an action when a request is about to be issued or a response was received by any Burp tool.
registerHttpRequestEditorProvider(ExtensionHttpRequestEditorProvider) - Method in interface burp.api.montoya.ui.UserInterface
This method can be used to register a provider of custom HTTP request editors.
registerHttpResponseEditorProvider(ExtensionHttpResponseEditorProvider) - Method in interface burp.api.montoya.ui.UserInterface
This method can be used to register a provider of custom HTTP response editors.
registerInsertionPointProvider(AuditInsertionPointProvider) - Method in interface burp.api.montoya.scanner.Scanner
This method is used to register a provider of Scanner insertion points.
registerPayloadGeneratorProvider(PayloadGeneratorProvider) - Method in interface burp.api.montoya.intruder.Intruder
This method is used to register a provider for Intruder payloads.
registerPayloadProcessor(PayloadProcessor) - Method in interface burp.api.montoya.intruder.Intruder
This method is used to register a custom Intruder payload processor.
registerRequestHandler(ProxyHttpRequestHandler) - Method in interface burp.api.montoya.proxy.Proxy
This method is used to register a handler which will be notified of requests being processed by the Proxy tool.
registerResponseHandler(ProxyHttpResponseHandler) - Method in interface burp.api.montoya.proxy.Proxy
This method is used to register a handler which will be notified of responses being processed by the Proxy tool.
registerScanCheck(ScanCheck) - Method in interface burp.api.montoya.scanner.Scanner
This method is used to register a custom Scanner check.
registerSessionHandlingAction(SessionHandlingAction) - Method in interface burp.api.montoya.http.Http
This method is used to register a custom session handling action.
registerSuiteTab(String, Component) - Method in interface burp.api.montoya.ui.UserInterface
This method is used to add a custom tab to the main Burp Suite window.
registerUnloadingHandler(ExtensionUnloadingHandler) - Method in interface burp.api.montoya.extension.Extension
This method is used to register a handler which will be notified of changes to the extension's state.
registerWebSocketCreationHandler(ProxyWebSocketCreationHandler) - Method in interface burp.api.montoya.proxy.Proxy
This method is used to register a handler which will be invoked whenever a WebSocket is created by the Proxy tool.
registerWebSocketCreationHandler(WebSocketCreationHandler) - Method in interface burp.api.montoya.websocket.WebSockets
This method is used to register a handler which will be invoked whenever a WebSocket is created by any Burp tool.
Registration - Interface in burp.api.montoya.core
This interface represents an instance of a class that is returned when an object is registered by an extension in Burp Suite.
remediation() - Method in interface burp.api.montoya.scanner.audit.issues.AuditIssue
This method returns detailed information about the remediation for this specific instance of the issue.
remediation() - Method in interface burp.api.montoya.scanner.audit.issues.AuditIssueDefinition
This method returns a background description of the remediation for this type of issue.
removeHeader(HttpHeader) - Method in interface burp.api.montoya.http.message.requests.HttpRequest
Removes an existing HTTP header from the current request.
removeHeader(HttpHeader) - Method in interface burp.api.montoya.http.message.responses.HttpResponse
Removes an existing HTTP header from the current response.
removeHeader(String) - Method in interface burp.api.montoya.http.message.requests.HttpRequest
Removes an existing HTTP header from the current request.
removeHeader(String) - Method in interface burp.api.montoya.http.message.responses.HttpResponse
Removes an existing HTTP header from the current response.
repeater() - Method in interface burp.api.montoya.MontoyaApi
This method is used to access the functionality of the Repeater.
Repeater - Interface in burp.api.montoya.repeater
This interface provides access to the functionality of the Repeater tool.
REPEATER - burp.api.montoya.core.ToolType
 
ReportFormat - Enum in burp.api.montoya.scanner
This enum represents the formats for scan reports.
request() - Method in interface burp.api.montoya.http.RequestResult
 
request() - Method in interface burp.api.montoya.proxy.RequestFinalInterceptResult
This method retrieves the current HTTP request to forward after any modifications by the extension.
request() - Method in interface burp.api.montoya.proxy.RequestInitialInterceptResult
This method retrieves the current HTTP request to forward after any modifications by the extension.
REQUEST - burp.api.montoya.ui.contextmenu.MessageEditorHttpRequestResponse.SelectionContext
 
requestCount() - Method in interface burp.api.montoya.scanner.ScanTask
This method returns the number of requests that have been made for the scan task.
RequestFinalInterceptResult - Interface in burp.api.montoya.proxy
Extensions can implement this interface when returning a result from ProxyHttpRequestHandler.handleRequestToIssue(InterceptedHttpRequest, Annotations).
RequestInitialInterceptResult - Interface in burp.api.montoya.proxy
Extensions can implement this interface when returning a result from ProxyHttpRequestHandler.handleReceivedRequest(InterceptedHttpRequest, Annotations).
requestMarkers() - Method in interface burp.api.montoya.http.message.MarkedHttpRequestResponse
 
requestResponse() - Method in interface burp.api.montoya.collaborator.HttpDetails
Returns the HTTP request and response.
requestResponses() - Method in interface burp.api.montoya.scanner.audit.issues.AuditIssue
This method returns the HTTP request/response messages that caused the issue to be generated.
requestResponses() - Method in interface burp.api.montoya.sitemap.SiteMap
This method returns details of all items in the site map.
requestResponses(SiteMapFilter) - Method in interface burp.api.montoya.sitemap.SiteMap
This method filters out the site map according to the passed SiteMapFilter object and returns a list of matched HttpRequestResponse items.
RequestResponseSupport - Interface in burp.api.montoya.persistence.support
 
requestResult(HttpRequest, Annotations) - Static method in interface burp.api.montoya.http.RequestResult
This is a helper method used to create a new instance of RequestHandlerResult.
requestResult(HttpRequest, Annotations) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
requestResult(HttpResponse, Annotations) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
RequestResult - Interface in burp.api.montoya.http
requestTemplate() - Method in interface burp.api.montoya.intruder.AttackConfiguration
This method is used to retrieve the HTTP request template and insertion point offsets in a form of an HttpRequestTemplate instance.
response() - Method in interface burp.api.montoya.http.ResponseResult
 
response() - Method in interface burp.api.montoya.proxy.ResponseFinalInterceptResult
This method retrieves the current HTTP response to forward after any modifications by the extension.
response() - Method in interface burp.api.montoya.proxy.ResponseInitialInterceptResult
This method retrieves the current HTTP response to forward after any modifications by the extension.
RESPONSE - burp.api.montoya.ui.contextmenu.MessageEditorHttpRequestResponse.SelectionContext
 
ResponseFinalInterceptResult - Interface in burp.api.montoya.proxy
Extensions can implement this interface when returning a result from ProxyHttpResponseHandler.handleResponseToReturn(InterceptedHttpResponse, HttpRequest, Annotations).
ResponseInitialInterceptResult - Interface in burp.api.montoya.proxy
Extensions can implement this interface when returning a result from ProxyHttpResponseHandler.handleReceivedResponse(InterceptedHttpResponse, HttpRequest, Annotations).
ResponseKeywordsAnalyzer - Interface in burp.api.montoya.http.message.responses.analysis
This interface is used to analyze HTTP responses and retrieve keywords.
responseMarkers() - Method in interface burp.api.montoya.http.message.MarkedHttpRequestResponse
 
responseResult(HttpResponse, Annotations) - Static method in interface burp.api.montoya.http.ResponseResult
This is a helper method used to create a new instance of ResponseHandlerResult.
ResponseResult - Interface in burp.api.montoya.http
ResponseVariationsAnalyzer - Interface in burp.api.montoya.http.message.responses.analysis
This interface is used to analyze HTTP responses and find variations between them, according to various attributes.
restoreClient(SecretKey) - Method in interface burp.api.montoya.collaborator.Collaborator
This method is used to restore a CollaboratorClient from a previous session.
RIPEMD_128 - burp.api.montoya.utilities.DigestAlgorithm
 
RIPEMD_160 - burp.api.montoya.utilities.DigestAlgorithm
 
RIPEMD_256 - burp.api.montoya.utilities.DigestAlgorithm
 
RIPEMD_320 - burp.api.montoya.utilities.DigestAlgorithm
 
RTF - burp.api.montoya.http.MimeType
 

S

Scan - Interface in burp.api.montoya.scanner
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 - Interface in burp.api.montoya.scanner
Extensions can implement this interface and then call Scanner.registerScanCheck(ScanCheck) to register a custom Scanner check.
ScanConfiguration - Interface in burp.api.montoya.scanner
This interface represents configurations for the Burp Scanner tool.
scanner() - Method in interface burp.api.montoya.MontoyaApi
This method is used to access the functionality of the Scanner.
Scanner - Interface in burp.api.montoya.scanner
This interface provides access to the functionality of the Scanner tool.
SCANNER - burp.api.montoya.core.ToolType
 
SCANNER_RESULTS - burp.api.montoya.ui.contextmenu.InvocationType
 
ScanTask - Interface in burp.api.montoya.scanner
This interface is used to retrieve details of tasks in the Burp Scanner.
scope() - Method in interface burp.api.montoya.MontoyaApi
This method is used to access the functionality related to Burp's suite-wide target scope.
Scope - Interface in burp.api.montoya.scope
This interface provides access to the functionality related to Burp's Suite-wide target scope.
ScopeChange - Interface in burp.api.montoya.scope
This interface represents an instance of a change to Burp's Suite-wide target scope.
scopeChanged(ScopeChange) - Method in interface burp.api.montoya.scope.ScopeChangeHandler
This method is invoked whenever a change occurs to Burp's Suite-wide target scope.
ScopeChangeHandler - Interface in burp.api.montoya.scope
Extensions can implement this interface and then call Scope.registerHandler(ScopeChangeHandler) to register a scope change handler.
SCRIPT - burp.api.montoya.http.MimeType
 
SEARCH_RESULTS - burp.api.montoya.ui.contextmenu.InvocationType
 
secretKey(String) - Static method in interface burp.api.montoya.collaborator.SecretKey
This method allows you to create an instance of SecretKey which you will be able to use to restore a previously created CollaboratorClient with the Collaborator.restoreClient(SecretKey) method.
secretKey(String) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
SecretKey - Interface in burp.api.montoya.collaborator
This interface represents a secret key that is associated with a CollaboratorClient
secure() - Method in interface burp.api.montoya.http.HttpService
 
selectedData() - Method in interface burp.api.montoya.ui.editor.extension.ExtensionHttpMessageEditor
The method should return null if no data has been selected.
selectedIssues() - Method in interface burp.api.montoya.ui.contextmenu.ContextMenuEvent
This method can be used to retrieve details of the Scanner issues that were selected by the user when the context menu was invoked.
selectedRequestResponses() - Method in interface burp.api.montoya.ui.contextmenu.ContextMenuEvent
This method can be used to retrieve details of the currently selected HTTP request/response pair that was selected by the user when the context menu was invoked.
selection() - Method in interface burp.api.montoya.ui.editor.Editor
This will return Optional.empty() if the user has not made a selection.
selection(int, int) - Static method in interface burp.api.montoya.ui.Selection
A helper method to create an instance of Selection without content data.
selection(ByteArray) - Static method in interface burp.api.montoya.ui.Selection
A helper method to create an instance of Selection without positional data.
selection(ByteArray, int, int) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
selection(ByteArray, int, int) - Static method in interface burp.api.montoya.ui.Selection
A helper method to create an instance of Selection.
Selection - Interface in burp.api.montoya.ui
This interface provides helpful information and functionality relating to a user's selection within the user interface.
selectionContext() - Method in interface burp.api.montoya.ui.contextmenu.MessageEditorHttpRequestResponse
 
selectionOffsets() - Method in interface burp.api.montoya.ui.contextmenu.MessageEditorHttpRequestResponse
This will return Optional.empty() if the user has not made a selection.
sendTextMessage(String) - Method in interface burp.api.montoya.websocket.WebSocket
This method allows an extension to send a text message via the WebSocket.
sendTextMessage(String, Direction) - Method in interface burp.api.montoya.proxy.ProxyWebSocket
This method allows an extension to send a text message via the WebSocket to either the client or the server.
sendToComparer(ByteArray...) - Method in interface burp.api.montoya.comparer.Comparer
This method can be used to send data to the Comparer tool.
sendToDecoder(ByteArray) - Method in interface burp.api.montoya.decoder.Decoder
This method can be used to send data to the Decoder tool.
sendToIntruder(HttpService, HttpRequestTemplate) - Method in interface burp.api.montoya.intruder.Intruder
This method can be used to send an HTTP request to the Burp Intruder tool.
sendToIntruder(HttpRequest) - Method in interface burp.api.montoya.intruder.Intruder
This method can be used to send an HTTP request to the Burp Intruder tool.
sendToRepeater(HttpRequest) - Method in interface burp.api.montoya.repeater.Repeater
This method can be used to send an HTTP request to the Burp Repeater tool.
sendToRepeater(String, HttpRequest) - Method in interface burp.api.montoya.repeater.Repeater
This method can be used to send an HTTP request to the Burp Repeater tool.
SEQUENCER - burp.api.montoya.core.ToolType
 
server() - Method in interface burp.api.montoya.collaborator.CollaboratorClient
This method is used to retrieve the details of the Collaborator server associated with this client.
server() - Method in interface burp.api.montoya.collaborator.CollaboratorPayload
Returns an optional instance of CollaboratorServer describing the server location for this payload.
SERVER_TO_CLIENT - burp.api.montoya.websocket.Direction
 
SessionHandlingAction - Interface in burp.api.montoya.http.sessions
Extensions can implement this interface and then call Http.registerSessionHandlingAction(burp.api.montoya.http.sessions.SessionHandlingAction) to register a custom session handling action.
setBoolean(String, Boolean) - Method in interface burp.api.montoya.persistence.support.PrimitivesSupport
Associates the specified Boolean with the specified key in this map (optional operation).
setBooleanList(String, List<Boolean>) - Method in interface burp.api.montoya.persistence.support.PrimitiveListSupport
Associates the specified List of Boolean with the specified key in this map.
setByte(int, byte) - Method in interface burp.api.montoya.core.ByteArray
This method sets the byte at the provided index to the provided byte.
setByte(String, byte) - Method in interface burp.api.montoya.persistence.support.PrimitivesSupport
Associates the specified Byte with the specified key in this map (optional operation).
setByteArray(String, ByteArray) - Method in interface burp.api.montoya.persistence.support.ByteArraySupport
Associates the specified ByteArray with the specified key in this map.
setByteArrayList(String, List<ByteArray>) - Method in interface burp.api.montoya.persistence.support.ByteArraySupport
Associates the specified List of ByteArray with the specified key in this map.
setBytes(int, byte[]) - Method in interface burp.api.montoya.core.ByteArray
This method sets bytes starting at the specified index to the provided bytes.
setBytes(int, ByteArray) - Method in interface burp.api.montoya.core.ByteArray
This method sets bytes starting at the specified index to the provided bytes.
setContents(ByteArray) - Method in interface burp.api.montoya.ui.editor.RawEditor
This method can be used to set content within the text editor programmatically.
setCookie(String, String, String, String, ZonedDateTime) - Method in interface burp.api.montoya.http.sessions.CookieJar
This method is used to add a new HTTP cookie to the Cookie Jar.
setEditable(boolean) - Method in interface burp.api.montoya.ui.editor.RawEditor
 
setHttpRequest(String, HttpRequest) - Method in interface burp.api.montoya.persistence.support.RequestResponseSupport
Associates the specified HttpRequest with the specified key in this map (optional operation).
setHttpRequestList(String, List<HttpRequest>) - Method in interface burp.api.montoya.persistence.support.RequestResponseSupport
Associates the specified List of HttpRequest with the specified key in this map.
setHttpRequestResponse(HttpRequestResponse) - Method in interface burp.api.montoya.ui.editor.extension.ExtensionHttpMessageEditor
Sets the provided HttpRequestResponse object within the editor component.
setHttpRequestResponse(String, HttpRequestResponse) - Method in interface burp.api.montoya.persistence.support.RequestResponseSupport
Associates the specified HttpRequestResponse with the specified key in this map (optional operation).
setHttpRequestResponseList(String, List<HttpRequestResponse>) - Method in interface burp.api.montoya.persistence.support.RequestResponseSupport
Associates the specified List of HttpRequestResponse with the specified key in this map.
setHttpResponse(String, HttpResponse) - Method in interface burp.api.montoya.persistence.support.RequestResponseSupport
Associates the specified HttpResponse with the specified key in this map (optional operation).
setHttpResponseList(String, List<HttpResponse>) - Method in interface burp.api.montoya.persistence.support.RequestResponseSupport
Associates the specified List of HttpResponse with the specified key in this map.
setInteger(String, int) - Method in interface burp.api.montoya.persistence.support.PrimitivesSupport
Associates the specified Integer with the specified key in this map (optional operation).
setIntegerList(String, List<Integer>) - Method in interface burp.api.montoya.persistence.support.PrimitiveListSupport
Associates the specified List of Integer with the specified key in this map.
setLong(String, long) - Method in interface burp.api.montoya.persistence.support.PrimitivesSupport
Associates the specified Long with the specified key in this map (optional operation).
setLongList(Long, List<Long>) - Method in interface burp.api.montoya.persistence.support.PrimitiveListSupport
Associates the specified List of Long with the specified key in this map.
setMessageAnnotations(Annotations) - Method in interface burp.api.montoya.ui.contextmenu.MessageEditorHttpRequestResponse
Update the message editor with the annotations
setName(String) - Method in interface burp.api.montoya.extension.Extension
This method is used to set the display name for the current extension, which will be displayed within the user interface for the Extensions tool.
setRequest(HttpRequest) - Method in interface burp.api.montoya.ui.contextmenu.MessageEditorHttpRequestResponse
Update the message editor with the HTTP request
setRequest(HttpRequest) - Method in interface burp.api.montoya.ui.editor.HttpRequestEditor
This method is used to display the contents of an HTTP request in the editor.
setResponse(HttpResponse) - Method in interface burp.api.montoya.ui.contextmenu.MessageEditorHttpRequestResponse
Update the message editor with the HTTP response
setResponse(HttpResponse) - Method in interface burp.api.montoya.ui.editor.HttpResponseEditor
This method is used to display the contents of an HTTP response in the editor.
setSearchExpression(String) - Method in interface burp.api.montoya.ui.editor.Editor
This method is used to update the search expression that is shown in the search bar below the editor.
setShort(String, short) - Method in interface burp.api.montoya.persistence.support.PrimitivesSupport
Associates the specified Short with the specified key in this map (optional operation).
setShortList(String, List<Short>) - Method in interface burp.api.montoya.persistence.support.PrimitiveListSupport
Associates the specified List of Short with the specified key in this map.
setString(String, String) - Method in interface burp.api.montoya.persistence.support.PrimitivesSupport
Associates the specified String with the specified key in this map (optional operation).
setStringList(String, List<String>) - Method in interface burp.api.montoya.persistence.support.PrimitiveListSupport
Associates the specified List of String with the specified key in this map.
severity() - Method in interface burp.api.montoya.scanner.audit.issues.AuditIssue
This method returns the issue severity level.
SHA_1 - burp.api.montoya.utilities.DigestAlgorithm
 
SHA_224 - burp.api.montoya.utilities.DigestAlgorithm
 
SHA_256 - burp.api.montoya.utilities.DigestAlgorithm
 
SHA_384 - burp.api.montoya.utilities.DigestAlgorithm
 
SHA_512 - burp.api.montoya.utilities.DigestAlgorithm
 
SHA_512_224 - burp.api.montoya.utilities.DigestAlgorithm
 
SHA_512_256 - burp.api.montoya.utilities.DigestAlgorithm
 
SHA3_224 - burp.api.montoya.utilities.DigestAlgorithm
 
SHA3_256 - burp.api.montoya.utilities.DigestAlgorithm
 
SHA3_384 - burp.api.montoya.utilities.DigestAlgorithm
 
SHA3_512 - burp.api.montoya.utilities.DigestAlgorithm
 
SHAKE_128_256 - burp.api.montoya.utilities.DigestAlgorithm
 
SHAKE_256_512 - burp.api.montoya.utilities.DigestAlgorithm
 
shutdown(ShutdownOptions...) - Method in interface burp.api.montoya.burpsuite.BurpSuite
This method can be used to shut down Burp programmatically.
ShutdownOptions - Enum in burp.api.montoya.burpsuite
This enum represents shutdown options that can be used when calling BurpSuite.shutdown(ShutdownOptions...).
SITE_MAP_TABLE - burp.api.montoya.ui.contextmenu.InvocationType
 
SITE_MAP_TREE - burp.api.montoya.ui.contextmenu.InvocationType
 
siteMap() - Method in interface burp.api.montoya.MontoyaApi
This method is used to access the functionality of the Site Map.
SiteMap - Interface in burp.api.montoya.sitemap
This interface provides methods for querying and modifying Burp's site map.
SiteMapFilter - Interface in burp.api.montoya.sitemap
This interface is used to filter items when querying Burp's site map.
SiteMapNode - Interface in burp.api.montoya.sitemap
This interface is used to represent items in the Burp's site map.
SKEIN_1024_1024 - burp.api.montoya.utilities.DigestAlgorithm
 
SKEIN_1024_384 - burp.api.montoya.utilities.DigestAlgorithm
 
SKEIN_1024_512 - burp.api.montoya.utilities.DigestAlgorithm
 
SKEIN_256_128 - burp.api.montoya.utilities.DigestAlgorithm
 
SKEIN_256_160 - burp.api.montoya.utilities.DigestAlgorithm
 
SKEIN_256_224 - burp.api.montoya.utilities.DigestAlgorithm
 
SKEIN_256_256 - burp.api.montoya.utilities.DigestAlgorithm
 
SKEIN_512_128 - burp.api.montoya.utilities.DigestAlgorithm
 
SKEIN_512_160 - burp.api.montoya.utilities.DigestAlgorithm
 
SKEIN_512_224 - burp.api.montoya.utilities.DigestAlgorithm
 
SKEIN_512_256 - burp.api.montoya.utilities.DigestAlgorithm
 
SKEIN_512_384 - burp.api.montoya.utilities.DigestAlgorithm
 
SKEIN_512_512 - burp.api.montoya.utilities.DigestAlgorithm
 
SKIP_PAYLOAD - burp.api.montoya.intruder.PayloadProcessingAction
 
skipPayload() - Static method in interface burp.api.montoya.intruder.PayloadProcessingResult
This method is a helper method to create a new instance of PayloadProcessingResult with a PayloadProcessingAction.SKIP_PAYLOAD action.
SM3 - burp.api.montoya.utilities.DigestAlgorithm
 
SMTP - burp.api.montoya.collaborator.InteractionType
 
SMTP - burp.api.montoya.collaborator.SmtpProtocol
 
smtpDetails() - Method in interface burp.api.montoya.collaborator.Interaction
Returns the SMTP interaction details.
SmtpDetails - Interface in burp.api.montoya.collaborator
This interface provides information about an SMTP interaction detected by Burp Collaborator.
SmtpProtocol - Enum in burp.api.montoya.collaborator
This enum represents Simple Mail Transfer Protocol (SMTP) protocols.
SMTPS - burp.api.montoya.collaborator.SmtpProtocol
 
SOA - burp.api.montoya.collaborator.DnsQueryType
 
SOUND - burp.api.montoya.http.MimeType
 
sourceIpAddress() - Method in interface burp.api.montoya.proxy.InterceptedMessage
This method retrieves the IP address for the source of the intercepted message.
SRV - burp.api.montoya.collaborator.DnsQueryType
 
STANDARD - burp.api.montoya.utilities.HtmlEncoding
Encode only HTML special characters.
startAudit() - Method in interface burp.api.montoya.scanner.Scan
This method can be used to start an audit in the Burp Scanner tool.
startCrawl() - Method in interface burp.api.montoya.scanner.Scan
This method can be used to start a crawl in the Burp Scanner tool.
startIndexInclusive() - Method in interface burp.api.montoya.core.Range
 
statedMimeType() - Method in interface burp.api.montoya.http.message.responses.HttpResponse
This method is used to obtain the MIME type of the response, as stated in the HTTP headers.
STATUS_CODE - burp.api.montoya.http.message.responses.analysis.AttributeType
 
statusCode() - Method in interface burp.api.montoya.http.message.responses.HttpResponse
This method is used to obtain the HTTP status code contained in the response.
statusMessage() - Method in interface burp.api.montoya.core.Task
 
stringUtils() - Method in interface burp.api.montoya.utilities.Utilities
 
StringUtils - Interface in burp.api.montoya.utilities
This interface gives you access to String manipulation features.
SUITE - burp.api.montoya.core.ToolType
 
suiteFrame() - Method in interface burp.api.montoya.ui.swing.SwingUtils
 
swingUtils() - Method in interface burp.api.montoya.ui.UserInterface
 
SwingUtils - Interface in burp.api.montoya.ui.swing
This interface gives you access to swing utilities.

T

TAG_IDS - burp.api.montoya.http.message.responses.analysis.AttributeType
 
TAG_NAMES - burp.api.montoya.http.message.responses.analysis.AttributeType
 
TARGET - burp.api.montoya.core.ToolType
 
Task - Interface in burp.api.montoya.core
This interface represents a task on the Dashboard.
temporaryFile() - Method in interface burp.api.montoya.persistence.Persistence
This method is used to access the functionality related to temporary files.
TemporaryFile - Interface in burp.api.montoya.persistence
This interface represents an instance of a class that allows data to be stored to and accessed from a temporary file.
TENTATIVE - burp.api.montoya.scanner.audit.issues.AuditIssueConfidence
 
Theme - Enum in burp.api.montoya.ui
This enum contains the different themes available in Burp Suites user interface.
TIGER - burp.api.montoya.utilities.DigestAlgorithm
 
timeStamp() - Method in interface burp.api.montoya.collaborator.Interaction
Returns the timestamp.
TOGGLE_METHOD - burp.api.montoya.http.HttpTransformation
 
toolName() - Method in enum burp.api.montoya.core.ToolType
 
ToolSource - Interface in burp.api.montoya.core
This interface represents the tool that is the source of an object.
toolType() - Method in interface burp.api.montoya.core.ToolSource
 
ToolType - Enum in burp.api.montoya.core
This enum represents tools in Burp Suite.
toString() - Method in interface burp.api.montoya.collaborator.CollaboratorPayload
Returns a string containing the payload.
toString() - Method in interface burp.api.montoya.collaborator.InteractionId
Returns a string containing the interaction id.
toString() - Method in interface burp.api.montoya.collaborator.SecretKey
This provides the secret key in string form.
toString() - Method in interface burp.api.montoya.core.ByteArray
This method can be used to convert the bytes of the ByteArray into UTF-8 encoded String form.
toString() - Method in enum burp.api.montoya.core.ToolType
 
toString() - Method in interface burp.api.montoya.core.Version
 
toString() - Method in interface burp.api.montoya.http.HttpService
 
toString() - Method in interface burp.api.montoya.http.message.headers.HttpHeader
 
toString() - Method in interface burp.api.montoya.http.message.HttpMessage
This method is used to get the message as a String.
TUPLEHASH_128_256 - burp.api.montoya.utilities.DigestAlgorithm
 
TUPLEHASH_256_512 - burp.api.montoya.utilities.DigestAlgorithm
 
TXT - burp.api.montoya.collaborator.DnsQueryType
 
type() - Method in interface burp.api.montoya.collaborator.Interaction
Returns the type.
type() - Method in interface burp.api.montoya.http.message.params.HttpParameter
 
type() - Method in interface burp.api.montoya.http.message.responses.analysis.Attribute
 
type() - Method in interface burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPoint
This method returns the type of this insertion point.
typeIndex() - Method in interface burp.api.montoya.scanner.audit.issues.AuditIssueDefinition
This method returns an index of the issue type.
typicalSeverity() - Method in interface burp.api.montoya.scanner.audit.issues.AuditIssueDefinition
This method returns the typical issue severity level.

U

uiComponent() - Method in interface burp.api.montoya.ui.editor.Editor
 
uiComponent() - Method in interface burp.api.montoya.ui.editor.extension.ExtensionHttpMessageEditor
 
UNKNOWN - burp.api.montoya.collaborator.DnsQueryType
 
UNKNOWN - burp.api.montoya.http.ContentType
 
UNKNOWN - burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPointType
 
unload() - Method in interface burp.api.montoya.extension.Extension
This method is used to unload the extension from Burp Suite.
UNRECOGNIZED - burp.api.montoya.http.MimeType
 
updateHeader(HttpHeader) - Method in interface burp.api.montoya.http.message.requests.HttpRequest
Updates an existing HTTP header in the request with a new value.
updateHeader(HttpHeader) - Method in interface burp.api.montoya.http.message.responses.HttpResponse
Updates an existing HTTP header in the response with a new value.
updateHeader(String, String) - Method in interface burp.api.montoya.http.message.requests.HttpRequest
Updates an existing HTTP header in the request with a new value.
updateHeader(String, String) - Method in interface burp.api.montoya.http.message.responses.HttpResponse
Updates an existing HTTP header in the response with a new value.
updateWith(HttpResponse) - Method in interface burp.api.montoya.http.message.responses.analysis.ResponseKeywordsAnalyzer
This method is used to update the analysis based on an additional response.
updateWith(HttpResponse) - Method in interface burp.api.montoya.http.message.responses.analysis.ResponseVariationsAnalyzer
This method is used to update the analysis based on an additional response.
url() - Method in interface burp.api.montoya.http.message.requests.HttpRequest
 
url() - Method in interface burp.api.montoya.sitemap.SiteMapNode
This method is used to retrieve the URL associated with the site map's node.
URL - burp.api.montoya.http.message.params.HttpParameterType
 
URL_ENCODED - burp.api.montoya.http.ContentType
 
URL_PATH_FILENAME - burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPointType
 
URL_PATH_FOLDER - burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPointType
 
urlParameter(String, String) - Static method in interface burp.api.montoya.http.message.params.HttpParameter
Create a new Instance of HttpParameter with HttpParameterType.URL type.
urlUtils() - Method in interface burp.api.montoya.utilities.Utilities
 
URLUtils - Interface in burp.api.montoya.utilities
This interface gives you access to URL encoding and decoding features.
USE_PAYLOAD - burp.api.montoya.intruder.PayloadProcessingAction
 
usePayload(ByteArray) - Static method in interface burp.api.montoya.intruder.PayloadProcessingResult
This method is a helper method to create a new instance of PayloadProcessingResult with a PayloadProcessingAction.USE_PAYLOAD action.
USER_PROVIDED - burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPointType
 
userInterface() - Method in interface burp.api.montoya.MontoyaApi
This method is used to access the functionality related to the user interface.
UserInterface - Interface in burp.api.montoya.ui
This interface gives you access to various user interface related features.
utilities() - Method in interface burp.api.montoya.MontoyaApi
This method is used to access additional utilities.
Utilities - Interface in burp.api.montoya.utilities
This interface gives you access to other interfaces that have various data conversion and querying features.

V

value() - Method in interface burp.api.montoya.http.message.cookies.Cookie
This method is used to retrieve the value of the cookie.
value() - Method in interface burp.api.montoya.http.message.headers.HttpHeader
 
value() - Method in interface burp.api.montoya.http.message.params.HttpParameter
 
value() - Method in interface burp.api.montoya.http.message.responses.analysis.Attribute
 
value() - Method in interface burp.api.montoya.intruder.Payload
 
valueOf(String) - Static method in enum burp.api.montoya.burpsuite.ShutdownOptions
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.collaborator.DnsQueryType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.collaborator.InteractionType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.collaborator.PayloadOption
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.collaborator.SmtpProtocol
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.core.BurpSuiteEdition
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.core.HighlightColor
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.core.ToolType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.http.ContentType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.http.HttpMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.http.HttpProtocol
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.http.HttpTransformation
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.http.message.params.HttpParameterType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.http.message.responses.analysis.AttributeType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.http.MimeType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.intruder.PayloadProcessingAction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.proxy.FinalInterceptAction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.proxy.InitialInterceptAction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPointType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.scanner.audit.issues.AuditIssueConfidence
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.scanner.audit.issues.AuditIssueSeverity
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.scanner.BuiltInScanConfiguration
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.scanner.ConsolidationAction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.scanner.ReportFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.ui.contextmenu.InvocationType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.ui.contextmenu.MessageEditorHttpRequestResponse.SelectionContext
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.ui.editor.EditorOptions
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.ui.editor.extension.EditorMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.ui.Theme
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.utilities.CompressionType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.utilities.DigestAlgorithm
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.utilities.HtmlEncoding
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.utilities.RandomUtils.CharacterSet
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.websocket.Direction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum burp.api.montoya.websocket.WebSocketMessageAction
Returns the enum constant of this type with the specified name.
valueOffsets() - Method in interface burp.api.montoya.http.message.params.ParsedHttpParameter
This method is used to retrieve the offsets of the parameter value within the HTTP request.
values() - Static method in enum burp.api.montoya.burpsuite.ShutdownOptions
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.collaborator.DnsQueryType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.collaborator.InteractionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.collaborator.PayloadOption
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.collaborator.SmtpProtocol
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.core.BurpSuiteEdition
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.core.HighlightColor
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.core.ToolType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.http.ContentType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.http.HttpMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.http.HttpProtocol
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.http.HttpTransformation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.http.message.params.HttpParameterType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.http.message.responses.analysis.AttributeType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.http.MimeType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.intruder.PayloadProcessingAction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.proxy.FinalInterceptAction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.proxy.InitialInterceptAction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.scanner.audit.insertionpoint.AuditInsertionPointType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.scanner.audit.issues.AuditIssueConfidence
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.scanner.audit.issues.AuditIssueSeverity
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.scanner.BuiltInScanConfiguration
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.scanner.ConsolidationAction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.scanner.ReportFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.ui.contextmenu.InvocationType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.ui.contextmenu.MessageEditorHttpRequestResponse.SelectionContext
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.ui.editor.EditorOptions
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.ui.editor.extension.EditorMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.ui.Theme
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.utilities.CompressionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.utilities.DigestAlgorithm
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.utilities.HtmlEncoding
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.utilities.RandomUtils.CharacterSet
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.websocket.Direction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum burp.api.montoya.websocket.WebSocketMessageAction
Returns an array containing the constants of this enum type, in the order they are declared.
variantAttributes() - Method in interface burp.api.montoya.http.message.responses.analysis.ResponseVariationsAnalyzer
 
variantKeywords() - Method in interface burp.api.montoya.http.message.responses.analysis.ResponseKeywordsAnalyzer
 
version() - Method in interface burp.api.montoya.burpsuite.BurpSuite
This method retrieves information about the version of Burp in which the extension is running.
Version - Interface in burp.api.montoya.core
This interface represents a product version.
VIDEO - burp.api.montoya.http.MimeType
 
VISIBLE_TEXT - burp.api.montoya.http.message.responses.analysis.AttributeType
 
VISIBLE_WORD_COUNT - burp.api.montoya.http.message.responses.analysis.AttributeType
 

W

WebSocket - Interface in burp.api.montoya.websocket
This interface represents a WebSocket within Burp.
webSocketBinaryMessage(ByteArray, WebSocketMessageAction) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
WebSocketBinaryMessage - Interface in burp.api.montoya.websocket
This interface represents a binary WebSocket message.
WebSocketCreationHandler - Interface in burp.api.montoya.websocket
Extensions can implement this interface and then call WebSockets.registerWebSocketCreationHandler(burp.api.montoya.websocket.WebSocketCreationHandler) to register a WebSocket handler.
WebSocketHandler - Interface in burp.api.montoya.websocket
This interface allows an extension to be notified when messages are received or the WebSocket has been closed.
WebSocketMessageAction - Enum in burp.api.montoya.websocket
This enum represents the action to be applied to a WebSocketTextMessage or WebSocketBinaryMessage.
websockets() - Method in interface burp.api.montoya.MontoyaApi
This method is used to access the functionality related to WebSockets and messages.
WebSockets - Interface in burp.api.montoya.websocket
This interface is used to access WebSocket related functionality of Burp.
webSocketTextMessage(String, WebSocketMessageAction) - Method in interface burp.api.montoya.internal.MontoyaObjectFactory
 
WebSocketTextMessage - Interface in burp.api.montoya.websocket
This interface represents a text WebSocket message.
WHIRLPOOL - burp.api.montoya.utilities.DigestAlgorithm
 
WHITESPACE - burp.api.montoya.utilities.RandomUtils.CharacterSet
 
windowForComponent(Component) - Method in interface burp.api.montoya.ui.swing.SwingUtils
Retrieve the top-level Window containing the supplied component.
withAddedParameters(HttpParameter...) - Method in interface burp.api.montoya.http.message.requests.HttpRequest
This is a helper method that builds a modified request with the added HTTP parameters.
withAddedParameters(List<HttpParameter>) - Method in interface burp.api.montoya.http.message.requests.HttpRequest
This is a helper method that builds a modified request with the added HTTP parameters.
withBody(ByteArray) - Method in interface burp.api.montoya.http.message.requests.HttpRequest
This is a helper method that builds a modified request with the updated body.
withBody(ByteArray) - Method in interface burp.api.montoya.http.message.responses.HttpResponse
This is a helper method that builds a modified response with the updated body.
withBody(String) - Method in interface burp.api.montoya.http.message.requests.HttpRequest
This is a helper method that builds a modified request with the updated body.
withBody(String) - Method in interface burp.api.montoya.http.message.responses.HttpResponse
This is a helper method that builds a modified response with the updated body.
withComment(String) - Method in interface burp.api.montoya.core.Annotations
This method is used to construct a copy of the annotations with a new comment.
withHighlightColor(HighlightColor) - Method in interface burp.api.montoya.core.Annotations
This method is used to construct a copy of the annotations with a new highlight color.
withMarkers(List<Range>, List<Range>) - Method in interface burp.api.montoya.http.message.HttpRequestResponse
This is a helper method used to add markers to the HttpRequestResponse instance.
withMessageAnnotations(Annotations) - Method in interface burp.api.montoya.http.message.HttpRequestResponse
This is a helper method used to add annotations to the HttpRequestResponse instance.
withMessageAnnotations(Annotations) - Method in interface burp.api.montoya.http.message.MarkedHttpRequestResponse
This is a helper method used to add annotations to the MarkedHttpRequestResponse instance.
withNoMarkers() - Method in interface burp.api.montoya.http.message.HttpRequestResponse
This is a helper method used to build a MarkedHttpRequestResponse instance with no markers.
WITHOUT_SERVER_LOCATION - burp.api.montoya.collaborator.PayloadOption
 
withPath(String) - Method in interface burp.api.montoya.http.message.requests.HttpRequest
This is a helper method that builds a modified request with the new path.
withRemovedParameters(HttpParameter...) - Method in interface burp.api.montoya.http.message.requests.HttpRequest
This is a helper method that builds a modified request with the removed HTTP parameters.
withRemovedParameters(List<HttpParameter>) - Method in interface burp.api.montoya.http.message.requests.HttpRequest
This is a helper method that builds a modified request with the removed HTTP parameters.
withRequestMarkers(Range...) - Method in interface burp.api.montoya.http.message.HttpRequestResponse
This is a helper method used to add request markers to the HttpRequestResponse instance.
withRequestMarkers(List<Range>) - Method in interface burp.api.montoya.http.message.HttpRequestResponse
This is a helper method used to add request markers to the HttpRequestResponse instance.
withResponseMarkers(Range...) - Method in interface burp.api.montoya.http.message.HttpRequestResponse
This is a helper method used to add response markers to the HttpRequestResponse instance.
withResponseMarkers(List<Range>) - Method in interface burp.api.montoya.http.message.HttpRequestResponse
This is a helper method used to add response markers to the HttpRequestResponse instance.
withService(HttpService) - Method in interface burp.api.montoya.http.message.requests.HttpRequest
This is a helper method that builds a modified request with the new service.
withTransformationApplied(HttpTransformation) - Method in interface burp.api.montoya.http.message.requests.HttpRequest
This is a helper method that builds a modified request with the transformation applied.
withUpdatedParameters(HttpParameter...) - Method in interface burp.api.montoya.http.message.requests.HttpRequest
This is a helper method that builds a modified request with the updated HTTP parameters.
withUpdatedParameters(List<HttpParameter>) - Method in interface burp.api.montoya.http.message.requests.HttpRequest
This is a helper method that builds a modified request with the updated HTTP parameters.
WORD_COUNT - burp.api.montoya.http.message.responses.analysis.AttributeType
 

X

XML - burp.api.montoya.http.ContentType
 
XML - burp.api.montoya.http.message.params.HttpParameterType
 
XML - burp.api.montoya.http.MimeType
 
XML - burp.api.montoya.scanner.ReportFormat
 
XML_ATTRIBUTE - burp.api.montoya.http.message.params.HttpParameterType
 

Y

YAML - burp.api.montoya.http.MimeType
 
YELLOW - burp.api.montoya.core.HighlightColor
 
A B C D E F G H I J K L M N O P Q R S T U V W X Y 
All Classes All Packages