Package burp.api.montoya.sitemap

Interface SiteMap

public interface SiteMap

Provides methods for querying and modifying Burp's site map.

Method Summary

Modifier and Type	Method	Description
void	add(HttpRequestResponse requestResponse)	This method can be used to add an HttpRequestResponse item to Burp's site map with the specified request/response details.
void	add(AuditIssue auditIssue)	Register a new Audit issue.
List<AuditIssue>	issues()	This method returns all the current audit issues for URLs in the site map.
List<AuditIssue>	issues(SiteMapFilter filter)	This method returns current audit issues for URLs in the site map that are matched by the SiteMapFilter object.
List<HttpRequestResponse>	requestResponses()	This method returns details of all items in the site map.
List<HttpRequestResponse>	requestResponses(SiteMapFilter filter)	This method filters out the site map according to the passed SiteMapFilter object and returns a list of matched HttpRequestResponse items.

Method Details

requestResponses

List<HttpRequestResponse> requestResponses(SiteMapFilter filter)

This method filters out the site map according to the passed SiteMapFilter object and returns a list of matched HttpRequestResponse items.

Parameters:

filter - This parameter can be used to specify a filter, in order to extract a specific subset of the site map.

Returns:

A list of filtered items from the site map.

requestResponses

List<HttpRequestResponse> requestResponses()

This method returns details of all items in the site map.

Returns:

A list of all items from the site map.

issues

List<AuditIssue> issues(SiteMapFilter filter)

This method returns current audit issues for URLs in the site map that are matched by the SiteMapFilter object.

Parameters:

filter - This parameter can be used to specify a filter, in order to extract issues for a specific subset of the site map.

Returns:

A filtered list of audit issues.

issues

List<AuditIssue> issues()

This method returns all the current audit issues for URLs in the site map.

Returns:

A list of audit issues.

add

void add(HttpRequestResponse requestResponse)

This method can be used to add an HttpRequestResponse item to Burp's site map with the specified request/response details. This will overwrite the details of any existing matching item in the site map.

Parameters:

requestResponse - Item to be added to the site map

add

void add(AuditIssue auditIssue)

Register a new Audit issue. Note: Wherever possible, extensions should implement custom Scanner checks using ScanCheck and report issues via those checks, to integrate with Burp's user-driven workflow, and ensure proper consolidation of duplicate reported issues. This method is only designed for tasks outside the normal testing workflow, such as porting results from other scanning tools.

Parameters:

auditIssue - An object created by the extension that implements the AuditIssue interface.