org.zaproxy.zap.extension.spider

Class SpiderScan

java.lang.Object

org.zaproxy.zap.extension.spider.SpiderScan

All Implemented Interfaces:

Runnable, GenericScanner2, ScanListenner, SpiderListener

public class SpiderScan
extends Object
implements ScanListenner, SpiderListener, GenericScanner2

Constructor Summary

Constructors

Constructor and Description
SpiderScan(ExtensionSpider extension, SpiderParam spiderParams, Target target, org.apache.commons.httpclient.URI spiderURI, User scanUser, int scanId) Deprecated. (2.6.0) Use SpiderScan(ExtensionSpider, SpiderParam, Target, URI, User, int, String) instead.
SpiderScan(ExtensionSpider extension, SpiderParam spiderParams, Target target, org.apache.commons.httpclient.URI spiderURI, User scanUser, int scanId, String name) Constructs a SpiderScan with the given data.

Method Summary

Modifier and Type	Method and Description
void	foundURI(String uri, String method, FetchFilter.FetchStatus status) Event triggered when a new uri was found.
SpiderPanelTableModel	getAddedNodesTableModel()
String	getDisplayName()
int	getMaximum()
int	getNumberOfNodesAdded()
int	getNumberOfURIsFound() Gets the number of URIs, in and out of scope, found during the scan.
int	getProgress() Returns the progress of the scan, an integer between 0 and 100.
List<SpiderResource>	getResourcesFound() Returns the resources found during the scan.
List<SpiderResource>	getResourcesIoErrors() Returns the resources found during the scan that were not successfully obtained because of I/O errors.
Set<String>	getResults() Returns the URLs found during the scan.
Set<String>	getResultsOutOfScope() Returns the URLs, out of scope, found during the scan.
TableModel	getResultsTableModel()
int	getScanId() Returns the ID of the scan.
String	getState() Returns the String representation of the scan state (not started, running, paused or finished).
boolean	isPaused()
boolean	isRunning()
boolean	isStopped()
void	notifySpiderTaskResult(SpiderTaskResult spiderTaskResult) Notifies that a new SpiderTask's result is available.
void	pauseScan() Pauses the scan.
void	resumeScan() Resumes the scan.
void	run()
void	scanFinshed(String host)
void	scanProgress(String host, int progress, int maximum)
void	setCustomFetchFilters(List<FetchFilter> customFetchFilters)
void	setCustomParseFilters(List<ParseFilter> customParseFilters)
void	setCustomSpiderParsers(List<SpiderParser> customSpiderParsers)
void	setDisplayName(String name)
void	setListener(ScanListenner2 listener)
void	setScanId(int id)
void	spiderComplete(boolean successful) Event triggered when the spider is finished.
void	spiderProgress(int percentageComplete, int numberCrawled, int numberToCrawl) Event triggered when the Spider progress has changed.
void	start() Starts the scan.
void	stopScan() Stops the scan.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpiderScan

@Deprecated
public SpiderScan(ExtensionSpider extension,
                              SpiderParam spiderParams,
                              Target target,
                              org.apache.commons.httpclient.URI spiderURI,
                              User scanUser,
                              int scanId)

Deprecated. (2.6.0) Use SpiderScan(ExtensionSpider, SpiderParam, Target, URI, User, int, String) instead.

Constructs a SpiderScan with the given data.

Parameters:

extension - the extension to obtain configurations and notify the view

spiderParams - the spider options

target - the spider target

spiderURI - the starting URI, may be null.

scanUser - the user to be used in the scan, may be null.

scanId - the ID of the scan

SpiderScan

public SpiderScan(ExtensionSpider extension,
                  SpiderParam spiderParams,
                  Target target,
                  org.apache.commons.httpclient.URI spiderURI,
                  User scanUser,
                  int scanId,
                  String name)

Constructs a SpiderScan with the given data.

Parameters:

extension - the extension to obtain configurations and notify the view

spiderParams - the spider options

target - the spider target

spiderURI - the starting URI, may be null.

scanUser - the user to be used in the scan, may be null.

scanId - the ID of the scan

name - the name that identifies the target

Since:

2.6.0

Method Detail

getScanId

public int getScanId()

Returns the ID of the scan.

Specified by:

getScanId in interface GenericScanner2

Returns:

the ID of the scan

getState

public String getState()

Returns the String representation of the scan state (not started, running, paused or finished).

Returns:

the String representation of the scan state.

getProgress

public int getProgress()

Returns the progress of the scan, an integer between 0 and 100.

Specified by:

getProgress in interface GenericScanner2

Returns:

the progress of the scan.

start

public void start()

Starts the scan.

The call to this method has no effect if the scan was already started.

pauseScan

public void pauseScan()

Pauses the scan.

The call to this method has no effect if the scan is not running.

Specified by:

pauseScan in interface GenericScanner2

resumeScan

public void resumeScan()

Resumes the scan.

The call to this method has no effect if the scan is not paused.

Specified by:

resumeScan in interface GenericScanner2

stopScan

public void stopScan()

Stops the scan.

The call to this method has no effect if the scan was not yet started or has already finished.

Specified by:

stopScan in interface GenericScanner2

getResults

public Set<String> getResults()

Returns the URLs found during the scan.

Note: Iterations must be synchronized on returned object. Failing to do so might result in ConcurrentModificationException.

Returns:

the URLs found during the scan

See Also:

ConcurrentModificationException

getResourcesFound

public List<SpiderResource> getResourcesFound()

Returns the resources found during the scan.

Note: Iterations must be synchronized on returned object. Failing to do so might result in ConcurrentModificationException.

Returns:

the resources found during the scan

See Also:

ConcurrentModificationException

getResourcesIoErrors

public List<SpiderResource> getResourcesIoErrors()

Returns the resources found during the scan that were not successfully obtained because of I/O errors.

Note: Iterations must be synchronized on returned object. Failing to do so might result in ConcurrentModificationException.

Returns:

the resources found during the scan that were not successfully obtained

Since:

2.6.0

getResultsOutOfScope

public Set<String> getResultsOutOfScope()

Returns the URLs, out of scope, found during the scan.

Note: Iterations must be synchronized on returned object. Failing to do so might result in ConcurrentModificationException.

Returns:

the URLs, out of scope, found during the scan

See Also:

ConcurrentModificationException

notifySpiderTaskResult

public void notifySpiderTaskResult(SpiderTaskResult spiderTaskResult)

Description copied from interface: SpiderListener

Notifies that a new SpiderTask's result is available.

Specified by:

notifySpiderTaskResult in interface SpiderListener

Parameters:

spiderTaskResult - the result of the spider task.

spiderComplete

public void spiderComplete(boolean successful)

Description copied from interface: SpiderListener

Event triggered when the spider is finished. This event is triggered either when the spider has completed scanning a website, in which case the parameter successful is true , either when it was stopped by an user in which case the successful parameter is false.

Specified by:

spiderComplete in interface SpiderListener

Parameters:

successful -

• true - when the spider has scanned a website completely and finished by its own
• false - when the spider was stopped by the user

spiderProgress

public void spiderProgress(int percentageComplete,
                           int numberCrawled,
                           int numberToCrawl)

Description copied from interface: SpiderListener

Event triggered when the Spider progress has changed.

Specified by:

spiderProgress in interface SpiderListener

Parameters:

percentageComplete - the percentage complete

numberCrawled - the number of pages crawled

numberToCrawl - the number of pages left to crawl

foundURI

public void foundURI(String uri,
                     String method,
                     FetchFilter.FetchStatus status)

Description copied from interface: SpiderListener

Event triggered when a new uri was found. The status parameter says if the URI was skipped according to any skip rule or it was processed.

Specified by:

foundURI in interface SpiderListener

Parameters:

uri - the uri

method - the method used for accessing the uri

status - the FetchFilter.FetchStatus stating if this uri will be processed, and, if not, stating the reason of the filtering

run

public void run()

Specified by:

run in interface Runnable

setScanId

public void setScanId(int id)

Specified by:

setScanId in interface GenericScanner2

setDisplayName

public void setDisplayName(String name)

Specified by:

setDisplayName in interface GenericScanner2

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface GenericScanner2

isStopped

public boolean isStopped()

Specified by:

isStopped in interface GenericScanner2

getMaximum

public int getMaximum()

Specified by:

getMaximum in interface GenericScanner2

getNumberOfURIsFound

public int getNumberOfURIsFound()

Gets the number of URIs, in and out of scope, found during the scan.

Returns:

the number of URIs found during the scan

Since:

2.4.3

getNumberOfNodesAdded

public int getNumberOfNodesAdded()

isPaused

public boolean isPaused()

Specified by:

isPaused in interface GenericScanner2

isRunning

public boolean isRunning()

Specified by:

isRunning in interface GenericScanner2

scanFinshed

public void scanFinshed(String host)

Specified by:

scanFinshed in interface ScanListenner

scanProgress

public void scanProgress(String host,
                         int progress,
                         int maximum)

Specified by:

scanProgress in interface ScanListenner

getResultsTableModel

public TableModel getResultsTableModel()

getAddedNodesTableModel

public SpiderPanelTableModel getAddedNodesTableModel()

setListener

public void setListener(ScanListenner2 listener)

setCustomSpiderParsers

public void setCustomSpiderParsers(List<SpiderParser> customSpiderParsers)

setCustomFetchFilters

public void setCustomFetchFilters(List<FetchFilter> customFetchFilters)

setCustomParseFilters

public void setCustomParseFilters(List<ParseFilter> customParseFilters)