Package burp.api.montoya.scanner

Interface Scanner

public interface Scanner

This interface provides access to the functionality of the Scanner tool.

Method Summary

Modifier and Type	Method	Description
Scan	createScan()	This method can be used to create a scan that can be configured before being sent to the Burp Scanner tool.
void	generateReport(java.util.List<AuditIssue> issues, ReportFormat format, java.nio.file.Path path)	This method is used to generate a report for the specified Scanner issues.
Registration	registerAuditIssueHandler(AuditIssueHandler auditIssueHandler)	This method is used to register a handler which will be notified of new audit issues that are reported by the Scanner tool.
Registration	registerInsertionPointProvider(AuditInsertionPointProvider insertionPointProvider)	This method is used to register a provider of Scanner insertion points.
Registration	registerScanCheck(ScanCheck scanCheck)	This method is used to register a custom Scanner check.

Method Detail

registerAuditIssueHandler

Registration registerAuditIssueHandler(AuditIssueHandler auditIssueHandler)

This method is used to register a handler which will be notified of new audit issues that are reported by the Scanner tool. Extensions can perform custom analysis or logging of audit issues by registering an audit issue handler.

Parameters:

auditIssueHandler - An object created by the extension that implements the AuditIssueHandler interface.

Returns:

The Registration for the handler.

registerScanCheck

Registration registerScanCheck(ScanCheck scanCheck)

This method is used to register a custom Scanner check. When performing scanning, Burp will ask the check to perform active or passive scanning on the base request, and report any Scanner issues that are identified.

Parameters:

scanCheck - An object created by the extension that implements the ScanCheck interface.

Returns:

The Registration for the check.

registerInsertionPointProvider

Registration registerInsertionPointProvider(AuditInsertionPointProvider insertionPointProvider)

This method is used to register a provider of Scanner insertion points. For each base request that is actively scanned, Burp will ask the provider to provide any custom Scanner insertion points that are appropriate for the request.

Parameters:

insertionPointProvider - An object created by the extension that implements the AuditInsertionPointProvider interface.

Returns:

The Registration for the provider.

createScan

Scan createScan()

This method can be used to create a scan that can be configured before being sent to the Burp Scanner tool.

Returns:

The Scan that can be configured.

generateReport

void generateReport(java.util.List<AuditIssue> issues,
                    ReportFormat format,
                    java.nio.file.Path path)

This method is used to generate a report for the specified Scanner issues. The report format can be specified. For all other reporting options, the default settings that appear in the reporting UI wizard are used.

Parameters:

issues - The AuditIssues issues to be reported.

format - The ReportFormat to be used in the report.

path - The Path to the file that will be saved.