红队基础设施建设与改造（三）——武装你的Burpsuite（中）

Modifier and Type

Method and Description

java.util.List<IBurpCollaboratorInteraction>

fetchAllCollaboratorInteractions()

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

java.util.List<IBurpCollaboratorInteraction>

fetchAllInfiltratorInteractions()

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

java.util.List<IBurpCollaboratorInteraction>

fetchCollaboratorInteractionsFor(java.lang.String payload)

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

java.util.List<IBurpCollaboratorInteraction>

fetchInfiltratorInteractionsFor(java.lang.String payload)

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

java.lang.String

generatePayload(boolean includeCollaboratorServerLocation)

This method is used to generate new Burp Collaborator payloads.

java.lang.String

getCollaboratorServerLocation()

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

Modifier and Type

Method and Description

java.util.Map<java.lang.String,java.lang.String>

getProperties()

This method is used to retrieve a map containing all properties of the interaction.

java.lang.String

getProperty(java.lang.String name)

This method is used to retrieve a property of the interaction.

Modifier and Type

Method and Description

void

registerExtenderCallbacks(IBurpExtenderCallbacks callbacks)

This method is invoked when the extension is loaded.

Modifier and Type

Method and Description

void

addScanIssue(IScanIssue issue)

This method is used to register a new Scanner issue.

void

addSuiteTab(ITab tab)

This method is used to add a custom tab to the main Burp Suite window.

void

addToSiteMap(IHttpRequestResponse item)

This method can be used to add an item to Burp's site map with the specified request/response details.

IHttpRequestResponseWithMarkers

applyMarkers(IHttpRequestResponse httpRequestResponse, java.util.List<int[]> requestMarkers, java.util.List<int[]> responseMarkers)

This method is used to apply markers to an HTTP request or response, at offsets into the message that are relevant for some particular purpose.

IBurpCollaboratorClientContext

createBurpCollaboratorClientContext()

This method is used to create a new Burp Collaborator client context, which can be used to generate Burp Collaborator payloads and poll the Collaborator server for any network interactions that result from using those payloads.

IMessageEditor

createMessageEditor(IMessageEditorController controller, boolean editable)

This method is used to create a new instance of Burp's HTTP message editor, for the extension to use in its own UI.

ITextEditor

createTextEditor()

This method is used to create a new instance of Burp's plain text editor, for the extension to use in its own UI.

void

customizeUiComponent(java.awt.Component component)

This method is used to customize UI components in line with Burp's UI style, including font size, colors, table line spacing, etc.

IScanQueueItem

doActiveScan(java.lang.String host, int port, boolean useHttps, byte[] request)

This method can be used to send an HTTP request to the Burp Scanner tool to perform an active vulnerability scan.

IScanQueueItem

doActiveScan(java.lang.String host, int port, boolean useHttps, byte[] request, java.util.List<int[]> insertionPointOffsets)

This method can be used to send an HTTP request to the Burp Scanner tool to perform an active vulnerability scan, based on a custom list of insertion points that are to be scanned.

void

doPassiveScan(java.lang.String host, int port, boolean useHttps, byte[] request, byte[] response)

This method can be used to send an HTTP request to the Burp Scanner tool to perform a passive vulnerability scan.

void

excludeFromScope(java.net.URL url)

This method can be used to exclude the specified URL from the Suite-wide scope.

void

exitSuite(boolean promptUser)

This method can be used to shut down Burp programmatically, with an optional prompt to the user.

void

generateScanReport(java.lang.String format, IScanIssue[] issues, java.io.File file)

This method is used to generate a report for the specified Scanner issues.

java.lang.String[]

getBurpVersion()

This method retrieves information about the version of Burp in which the extension is running.

java.lang.String[]

getCommandLineArguments()

This method returns the command line arguments that were passed to Burp on startup.

java.util.List<IContextMenuFactory>

getContextMenuFactories()

This method is used to retrieve the context menu factories that are registered by the extension.

java.util.List<ICookie>

getCookieJarContents()

This method is used to retrieve the contents of Burp's session handling cookie jar.

java.lang.String

getExtensionFilename()

This method retrieves the absolute path name of the file from which the current extension was loaded.

java.util.List<IExtensionStateListener>

getExtensionStateListeners()

This method is used to retrieve the extension state listeners that are registered by the extension.

java.lang.String[]

getHeaders(byte[] message)

Deprecated.

Use IExtensionHelpers.analyzeRequest() or IExtensionHelpers.analyzeResponse() instead.

IExtensionHelpers

getHelpers()

This method is used to obtain an IExtensionHelpers object, which can be used by the extension to perform numerous useful tasks.

java.util.List<IHttpListener>

getHttpListeners()

This method is used to retrieve the HTTP listeners that are registered by the extension.

java.util.List<IIntruderPayloadGeneratorFactory>

getIntruderPayloadGeneratorFactories()

This method is used to retrieve the Intruder payload generator factories that are registered by the extension.

java.util.List<IIntruderPayloadProcessor>

getIntruderPayloadProcessors()

This method is used to retrieve the Intruder payload processors that are registered by the extension.

java.util.List<IMessageEditorTabFactory>

getMessageEditorTabFactories()

This method is used to retrieve the message editor tab factories that are registered by the extension.

java.lang.String[][]

getParameters(byte[] request)

Deprecated.

Use IExtensionHelpers.analyzeRequest() instead.

IHttpRequestResponse[]

getProxyHistory()

This method returns details of all items in the Proxy history.

java.util.List<IProxyListener>

getProxyListeners()

This method is used to retrieve the Proxy listeners that are registered by the extension.

IScanIssue[]

getScanIssues(java.lang.String urlPrefix)

This method returns all of the current scan issues for URLs matching the specified literal prefix.

java.util.List<IScannerCheck>

getScannerChecks()

This method is used to retrieve the Scanner checks that are registered by the extension.

java.util.List<IScannerInsertionPointProvider>

getScannerInsertionPointProviders()

This method is used to retrieve the Scanner insertion point providers that are registered by the extension.

java.util.List<IScannerListener>

getScannerListeners()

This method is used to retrieve the Scanner listeners that are registered by the extension.

java.util.List<IScopeChangeListener>

getScopeChangeListeners()

This method is used to retrieve the scope change listeners that are registered by the extension.

java.util.List<ISessionHandlingAction>

getSessionHandlingActions()

This method is used to retrieve the session handling actions that are registered by the extension.

IHttpRequestResponse[]

getSiteMap(java.lang.String urlPrefix)

This method returns details of items in the site map.

java.io.OutputStream

getStderr()

This method is used to obtain the current extension's standard error stream.

java.io.OutputStream

getStdout()

This method is used to obtain the current extension's standard output stream.

java.lang.String

getToolName(int toolFlag)

This method is used to obtain the descriptive name for the Burp tool identified by the tool flag provided.

void

includeInScope(java.net.URL url)

This method can be used to include the specified URL in the Suite-wide scope.

boolean

isExtensionBapp()

This method determines whether the current extension was loaded as a BApp (a Burp App from the BApp Store).

boolean

isInScope(java.net.URL url)

This method can be used to query whether a specified URL is within the current Suite-wide scope.

void

issueAlert(java.lang.String message)

This method can be used to display a specified message in the Burp Suite alerts tab.

void

loadConfig(java.util.Map<java.lang.String,java.lang.String> config)

Deprecated.

Use loadConfigFromJson() instead.

void

loadConfigFromJson(java.lang.String config)

This method causes Burp to load a new project-level configuration from the JSON String provided.

java.lang.String

loadExtensionSetting(java.lang.String name)

This method is used to load configuration settings for the extension that were saved using the method saveExtensionSetting().

IHttpRequestResponse

makeHttpRequest(IHttpService httpService, byte[] request)

This method can be used to issue HTTP requests and retrieve their responses.

byte[]

makeHttpRequest(java.lang.String host, int port, boolean useHttps, byte[] request)

This method can be used to issue HTTP requests and retrieve their responses.

void

printError(java.lang.String error)

This method prints a line of output to the current extension's standard error stream.

void

printOutput(java.lang.String output)

This method prints a line of output to the current extension's standard output stream.

void

registerContextMenuFactory(IContextMenuFactory factory)

This method is used to register a factory for custom context menu items.

void

registerExtensionStateListener(IExtensionStateListener listener)

This method is used to register a listener which will be notified of changes to the extension's state.

void

registerHttpListener(IHttpListener listener)

This method is used to register a listener which will be notified of requests and responses made by any Burp tool.

void

registerIntruderPayloadGeneratorFactory(IIntruderPayloadGeneratorFactory factory)

This method is used to register a factory for Intruder payloads.

void

registerIntruderPayloadProcessor(IIntruderPayloadProcessor processor)

This method is used to register a custom Intruder payload processor.

void

registerMenuItem(java.lang.String menuItemCaption, IMenuItemHandler menuItemHandler)

Deprecated.

Use registerContextMenuFactory() instead.

void

registerMessageEditorTabFactory(IMessageEditorTabFactory factory)

This method is used to register a factory for custom message editor tabs.

void

registerProxyListener(IProxyListener listener)

This method is used to register a listener which will be notified of requests and responses being processed by the Proxy tool.

void

registerScannerCheck(IScannerCheck check)

This method is used to register a custom Scanner check.

void

registerScannerInsertionPointProvider(IScannerInsertionPointProvider provider)

This method is used to register a provider of Scanner insertion points.

void

registerScannerListener(IScannerListener listener)

This method is used to register a listener which will be notified of new issues that are reported by the Scanner tool.

void

registerScopeChangeListener(IScopeChangeListener listener)

This method is used to register a listener which will be notified of changes to Burp's suite-wide target scope.

void

registerSessionHandlingAction(ISessionHandlingAction action)

This method is used to register a custom session handling action.

void

removeContextMenuFactory(IContextMenuFactory factory)

This method is used to remove a context menu factory that has been registered by the extension.

void

removeExtensionStateListener(IExtensionStateListener listener)

This method is used to remove an extension state listener that has been registered by the extension.

void

removeHttpListener(IHttpListener listener)

This method is used to remove an HTTP listener that has been registered by the extension.

void

removeIntruderPayloadGeneratorFactory(IIntruderPayloadGeneratorFactory factory)

This method is used to remove an Intruder payload generator factory that has been registered by the extension.

void

removeIntruderPayloadProcessor(IIntruderPayloadProcessor processor)

This method is used to remove an Intruder payload processor that has been registered by the extension.

void

removeMessageEditorTabFactory(IMessageEditorTabFactory factory)

This method is used to remove a message editor tab factory that has been registered by the extension.

void

removeProxyListener(IProxyListener listener)

This method is used to remove a Proxy listener that has been registered by the extension.

void

removeScannerCheck(IScannerCheck check)

This method is used to remove a Scanner check that has been registered by the extension.

void

removeScannerInsertionPointProvider(IScannerInsertionPointProvider provider)

This method is used to remove a Scanner insertion point provider that has been registered by the extension.

void

removeScannerListener(IScannerListener listener)

This method is used to remove a Scanner listener that has been registered by the extension.

void

removeScopeChangeListener(IScopeChangeListener listener)

This method is used to remove a scope change listener that has been registered by the extension.

void

removeSessionHandlingAction(ISessionHandlingAction action)

This method is used to remove a session handling action that has been registered by the extension.

void

removeSuiteTab(ITab tab)

This method is used to remove a previously-added tab from the main Burp Suite window.

void

restoreState(java.io.File file)

Deprecated.

State files have been replaced with Burp project files.

IHttpRequestResponsePersisted

saveBuffersToTempFiles(IHttpRequestResponse httpRequestResponse)

This method is used to save the request and response of an IHttpRequestResponse object to temporary files, so that they are no longer held in memory.

java.util.Map<java.lang.String,java.lang.String>

saveConfig()

Deprecated.

Use saveConfigAsJson() instead.

java.lang.String

saveConfigAsJson(java.lang.String... configPaths)

This method causes Burp to save its current project-level configuration in JSON format.

void

saveExtensionSetting(java.lang.String name, java.lang.String value)

This method is used to save configuration settings for the extension in a persistent way that survives reloads of the extension and of Burp Suite.

void

saveState(java.io.File file)

Deprecated.

State files have been replaced with Burp project files.

ITempFile

saveToTempFile(byte[] buffer)

This method is used to create a temporary file on disk containing the provided data.

void

sendToComparer(byte[] data)

This method can be used to send data to the Comparer tool.

void

sendToIntruder(java.lang.String host, int port, boolean useHttps, byte[] request)

This method can be used to send an HTTP request to the Burp Intruder tool.

void

sendToIntruder(java.lang.String host, int port, boolean useHttps, byte[] request, java.util.List<int[]> payloadPositionOffsets)

This method can be used to send an HTTP request to the Burp Intruder tool.

void

sendToRepeater(java.lang.String host, int port, boolean useHttps, byte[] request, java.lang.String tabCaption)

This method can be used to send an HTTP request to the Burp Repeater tool.

void

sendToSpider(java.net.URL url)

This method can be used to send a seed URL to the Burp Spider tool.

void

setExtensionName(java.lang.String name)

This method is used to set the display name for the current extension, which will be displayed within the user interface for the Extender tool.

void

setProxyInterceptionEnabled(boolean enabled)

This method sets the master interception mode for Burp Proxy.

void

unloadExtension()

This method is used to unload the extension from Burp Suite.

void

updateCookieJar(ICookie cookie)

This method is used to update the contents of Burp's session handling cookie jar.

Modifier and Type

Method and Description

java.util.List<javax.swing.JMenuItem>

createMenuItems(IContextMenuInvocation invocation)

This method will be called by Burp when the user invokes a context menu anywhere within Burp.

Modifier and Type

Method and Description

java.awt.event.InputEvent

getInputEvent()

This method can be used to retrieve the native Java input event that was the trigger for the context menu invocation.

byte

getInvocationContext()

This method can be used to retrieve the context within which the menu was invoked.

IScanIssue[]

getSelectedIssues()

This method can be used to retrieve details of the Scanner issues that were selected by the user when the context menu was invoked.

IHttpRequestResponse[]

getSelectedMessages()

This method can be used to retrieve details of the HTTP requests / responses that were shown or selected by the user when the context menu was invoked.

int[]

getSelectionBounds()

This method can be used to retrieve the bounds of the user's selection into the current message, if applicable.

int

getToolFlag()

This method can be used to retrieve the Burp tool within which the context menu was invoked.

Modifier and Type

Method and Description

java.lang.String

getDomain()

This method is used to retrieve the domain for which the cookie is in scope.

java.util.Date

getExpiration()

This method is used to retrieve the expiration time for the cookie.

java.lang.String

getName()

This method is used to retrieve the name of the cookie.

java.lang.String

getPath()

This method is used to retrieve the path for which the cookie is in scope.

java.lang.String

getValue()

This method is used to retrieve the value of the cookie.

Modifier and Type

Method and Description

byte[]

addParameter(byte[] request, IParameter parameter)

This method adds a new parameter to an HTTP request, and if appropriate updates the Content-Length header.

IRequestInfo

analyzeRequest(byte[] request)

This method can be used to analyze an HTTP request, and obtain various key details about it.

IResponseInfo

analyzeResponse(byte[] response)

This method can be used to analyze an HTTP response, and obtain various key details about it.

IResponseKeywords

analyzeResponseKeywords(java.util.List<java.lang.String> keywords, byte[]... responses)

This method analyzes one or more responses to identify the number of occurrences of the specified keywords and returns an IResponseKeywords object that can be queried to obtain details of the number of occurrences of each keyword.

byte[]

base64Decode(byte[] data)

This method can be used to Base64-decode the specified data.

byte[]

base64Decode(java.lang.String data)

This method can be used to Base64-decode the specified data.

java.lang.String

base64Encode(byte[] data)

This method can be used to Base64-encode the specified data.

java.lang.String

base64Encode(java.lang.String data)

This method can be used to Base64-encode the specified data.

byte[]

buildHttpMessage(java.util.List<java.lang.String> headers, byte[] body)

This method builds an HTTP message containing the specified headers and message body.

byte[]

buildHttpRequest(java.net.URL url)

This method creates a GET request to the specified URL.

IParameter

buildParameter(java.lang.String name, java.lang.String value, byte type)

This method constructs an IParameter object based on the details provided.

java.lang.String

bytesToString(byte[] data)

This method can be used to convert data from an array of bytes into String form.

byte[]

urlDecode(byte[] data)

This method can be used to URL-decode the specified data.

java.lang.String

urlDecode(java.lang.String data)

This method can be used to URL-decode the specified data.

byte[]

urlEncode(byte[] data)

This method can be used to URL-encode the specified data.

java.lang.String

urlEncode(java.lang.String data)

This method can be used to URL-encode the specified data.

Modifier and Type

Method and Description

void

extensionUnloaded()

This method is called when the extension is unloaded.

Modifier and Type

Method and Description

void

processHttpMessage(int toolFlag, boolean messageIsRequest, IHttpRequestResponse messageInfo)

This method is invoked when an HTTP request is about to be issued, and when an HTTP response has been received.

Modifier and Type

Method and Description

java.lang.String

getComment()

This method is used to retrieve the user-annotated comment for this item, if applicable.

java.lang.String

getHighlight()

This method is used to retrieve the user-annotated highlight for this item, if applicable.

IHttpService

getHttpService()

This method is used to retrieve the HTTP service for this request / response.

byte[]

getRequest()

This method is used to retrieve the request message.

byte[]

getResponse()

This method is used to retrieve the response message.

void

setComment(java.lang.String comment)

This method is used to update the user-annotated comment for this item.

void

setHighlight(java.lang.String color)

This method is used to update the user-annotated highlight for this item.

void

setHttpService(IHttpService httpService)

This method is used to update the HTTP service for this request / response.

void

setRequest(byte[] message)

This method is used to update the request message.

void

setResponse(byte[] message)

This method is used to update the response message.

Modifier and Type

Method and Description

java.lang.String

getHost()

This method returns the hostname or IP address for the service.

int

getPort()

This method returns the port number for the service.

java.lang.String

getProtocol()

This method returns the protocol for the service.

Modifier and Type

Method and Description

IHttpService

getHttpService()

This method is used to retrieve the HTTP service for the attack.

byte[]

getRequestTemplate()

This method is used to retrieve the request template for the attack.

Modifier and Type

Method and Description

java.awt.Component

getComponent()

This method returns the UI component of the editor, for extensions to add to their own UI.

byte[]

getMessage()

This method is used to retrieve the currently displayed message, which may have been modified by the user.

byte[]

getSelectedData()

This method returns the data that is currently selected by the user.

int[]

getSelectionBounds()

This method can be used to retrieve the bounds of the user's selection into the displayed message, if applicable.

boolean

isMessageModified()

This method is used to determine whether the current message has been modified by the user.

void

setMessage(byte[] message, boolean isRequest)

This method is used to display an HTTP message in the editor.

Modifier and Type

Field and Description

static byte

PARAM_BODY

Used to indicate a parameter within the message body.

static byte

PARAM_COOKIE

Used to indicate an HTTP cookie.

static byte

PARAM_JSON

Used to indicate an item of data within a JSON structure.

static byte

PARAM_MULTIPART_ATTR

Used to indicate the value of a parameter attribute within a multi-part message body (such as the name of an uploaded file).

static byte

PARAM_URL

Used to indicate a parameter within the URL query string.

static byte

PARAM_XML

Used to indicate an item of data within an XML structure.

static byte

PARAM_XML_ATTR

Used to indicate the value of a tag attribute within an XML structure.

Modifier and Type

Method and Description

java.lang.String

getConfidence()

This method returns the issue confidence level.

IHttpRequestResponse[]

getHttpMessages()

This method returns the HTTP messages on the basis of which the issue was generated.

IHttpService

getHttpService()

This method returns the HTTP service for which the issue was generated.

java.lang.String

getIssueBackground()

This method returns a background description for this type of issue.

java.lang.String

getIssueDetail()

This method returns detailed information about this specific instance of the issue.

java.lang.String

getIssueName()

This method returns the name of the issue type.

int

getIssueType()

This method returns a numeric identifier of the issue type.

java.lang.String

getRemediationBackground()

This method returns a background description of the remediation for this type of issue.

java.lang.String

getRemediationDetail()

This method returns detailed information about the remediation for this specific instance of the issue.

java.lang.String

getSeverity()

This method returns the issue severity level.

java.net.URL

getUrl()

This method returns the URL for which the issue was generated.

Modifier and Type

Method and Description

void

scopeChanged()

This method is invoked whenever a change occurs to Burp's suite-wide target scope.

Modifier and Type

Method and Description

java.lang.String

getTabCaption()

Burp uses this method to obtain the caption that should appear on the custom tab when it is displayed.

java.awt.Component

getUiComponent()

Burp uses this method to obtain the component that should be used as the contents of the custom tab when it is displayed.

Modifier and Type

Method and Description

java.awt.Component

getComponent()

This method returns the UI component of the editor, for extensions to add to their own UI.

byte[]

getSelectedText()

This method is used to obtain the currently selected text.

int[]

getSelectionBounds()

This method can be used to retrieve the bounds of the user's selection into the displayed text, if applicable.

byte[]

getText()

This method is used to retrieve the currently displayed text.

boolean

isTextModified()

This method is used to determine whether the user has modified the contents of the editor.

void

setEditable(boolean editable)

This method is used to control whether the editor is currently editable.

void

setSearchExpression(java.lang.String expression)

This method is used to update the search expression that is shown in the search bar below the editor.

void

setText(byte[] text)

This method is used to update the currently displayed text in the editor.