burp

Interface IScanIssue

public interface IScanIssue

This interface is used to retrieve details of Scanner issues. Extensions can obtain details of issues by registering an IScannerListener or by calling IBurpExtenderCallbacks.getScanIssues(). Extensions can also add custom Scanner issues by registering an IScannerCheck or calling IBurpExtenderCallbacks.addScanIssue(), and providing their own implementations of this interface. Note that issue descriptions and other text generated by extensions are subject to an HTML whitelist that allows only formatting tags and simple hyperlinks.

Method Summary

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.

Method Detail

getUrl

java.net.URL getUrl()

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

Returns:

The URL for which the issue was generated.

getIssueName

java.lang.String getIssueName()

This method returns the name of the issue type.

Returns:

The name of the issue type (e.g. "SQL injection").

getIssueType

int getIssueType()

This method returns a numeric identifier of the issue type. See the Burp Scanner documentation for a listing of all the issue types.

Returns:

A numeric identifier of the issue type.

getSeverity

java.lang.String getSeverity()

This method returns the issue severity level.

Returns:

The issue severity level. Expected values are "High", "Medium", "Low", "Information" or "False positive".

getConfidence

java.lang.String getConfidence()

This method returns the issue confidence level.

Returns:

The issue confidence level. Expected values are "Certain", "Firm" or "Tentative".

getIssueBackground

java.lang.String getIssueBackground()

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

Returns:

A background description for this type of issue, or null if none applies. A limited set of HTML tags may be used.

getRemediationBackground

java.lang.String getRemediationBackground()

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

Returns:

A background description of the remediation for this type of issue, or null if none applies. A limited set of HTML tags may be used.

getIssueDetail

java.lang.String getIssueDetail()

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

Returns:

Detailed information about this specific instance of the issue, or null if none applies. A limited set of HTML tags may be used.

getRemediationDetail

java.lang.String getRemediationDetail()

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

Returns:

Detailed information about the remediation for this specific instance of the issue, or null if none applies. A limited set of HTML tags may be used.

getHttpMessages

IHttpRequestResponse[] getHttpMessages()

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

Returns:

The HTTP messages on the basis of which the issue was generated. Note: The items in this array should be instances of IHttpRequestResponseWithMarkers if applicable, so that details of the relevant portions of the request and response messages are available.

getHttpService

IHttpService getHttpService()

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

Returns:

The HTTP service for which the issue was generated.