Package org.zaproxy.zap.extension.ascan

Class ActiveScan

java.lang.Object

org.parosproxy.paros.core.scanner.Scanner

org.zaproxy.zap.extension.ascan.ActiveScan

All Implemented Interfaces:

java.lang.Runnable, ScannerListener, GenericScanner2

Direct Known Subclasses:

AttackScan

public class ActiveScan
extends Scanner
implements GenericScanner2, ScannerListener

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ActiveScan.State

Field Summary

Fields inherited from class org.parosproxy.paros.core.scanner.Scanner

ALERTS_POSTFIX, ASCAN_RULE_PREFIX, ASCAN_SCAN_STARTED_STATS, ASCAN_SCAN_STOPPED_STATS, ASCAN_SCAN_TIME_STATS, ASCAN_URLS_STATS, SKIPPED_POSTFIX, STARTED_POSTFIX, TIME_POSTFIX, URLS_POSTFIX

Constructor Summary

Constructors

Constructor	Description
ActiveScan(java.lang.String displayName, ScannerParam scannerParam, ConnectionParam param, ScanPolicy scanPolicy)	Deprecated.
ActiveScan(java.lang.String displayName, ScannerParam scannerParam, ConnectionParam param, ScanPolicy scanPolicy, RuleConfigParam ruleConfigParam)	Deprecated. (2.12.0) Use ActiveScan(String, ScannerParam, ScanPolicy, RuleConfigParam) instead.
ActiveScan(java.lang.String displayName, ScannerParam scannerParam, ScanPolicy scanPolicy, RuleConfigParam ruleConfigParam)

Method Summary

Modifier and Type	Method	Description
void	alertFound(Alert alert)
void	filteredMessage(HttpMessage msg, java.lang.String reason)	Added to notify reason for filtering message from scanning.
java.util.List<java.lang.Integer>	getAlertsIds()	Returns the IDs of all alerts raised during the scan.
java.lang.String	getDisplayName()
javax.swing.DefaultListModel<HistoryReference>	getList()
int	getMaximum()
java.util.List<java.lang.Integer>	getMessagesIds()	Returns the IDs of all messages sent/created during the scan.
ActiveScanTableModel	getMessagesTableModel()
int	getProgress()
ResponseCountSnapshot	getRequestHistory()
int	getScanId()
SiteNode	getStartNode()
ActiveScan.State	getState()
java.util.Date	getTimeFinished()
java.util.Date	getTimeStarted()
int	getTotalNewAlerts()
int	getTotalRequests()
void	hostComplete(int id, java.lang.String hostAndPort)
void	hostNewScan(int id, java.lang.String hostAndPort, HostProcess hostThread)
void	hostProgress(int id, java.lang.String hostAndPort, java.lang.String msg, int percentage)
boolean	isRunning()
boolean	isStopped()
void	notifyNewMessage(HttpMessage msg)
void	pauseScan()
void	reset()
void	resumeScan()
void	scannerComplete(int id)
void	setDisplayName(java.lang.String name)
void	setScanId(int id)
void	setStartNode(SiteNode startNode)
void	start(Target target)
void	stopScan()

Methods inherited from class org.parosproxy.paros.core.scanner.Scanner

addScanFilter, addScannerHook, addScannerListener, addScriptCollection, getHostProcesses, getId, getJustScanInScope, getScannerHooks, getScriptCollections, getTechSet, isInScope, isPaused, isStop, pause, removerScannerHook, removeScannerListener, resume, run, scan, scanChildren, setExcludeList, setId, setJustScanInScope, setScanChildren, setScannerParam, setScanPolicy, setTechSet, setUser, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.zaproxy.zap.model.GenericScanner2

isPaused

Methods inherited from interface java.lang.Runnable

run

Constructor Detail

ActiveScan

@Deprecated
public ActiveScan(java.lang.String displayName,
                  ScannerParam scannerParam,
                  ConnectionParam param,
                  ScanPolicy scanPolicy)

Deprecated.

ActiveScan

@Deprecated
public ActiveScan(java.lang.String displayName,
                  ScannerParam scannerParam,
                  ConnectionParam param,
                  ScanPolicy scanPolicy,
                  RuleConfigParam ruleConfigParam)

Deprecated.

(2.12.0) Use ActiveScan(String, ScannerParam, ScanPolicy, RuleConfigParam) instead.

ActiveScan

public ActiveScan(java.lang.String displayName,
                  ScannerParam scannerParam,
                  ScanPolicy scanPolicy,
                  RuleConfigParam ruleConfigParam)

Method Detail

getMaximum

public int getMaximum()

Specified by:

getMaximum in interface GenericScanner2

getProgress

public int getProgress()

Specified by:

getProgress in interface GenericScanner2

isRunning

public boolean isRunning()

Specified by:

isRunning in interface GenericScanner2

isStopped

public boolean isStopped()

Specified by:

isStopped in interface GenericScanner2

pauseScan

public void pauseScan()

Specified by:

pauseScan in interface GenericScanner2

getTotalRequests

public int getTotalRequests()

getTotalNewAlerts

public int getTotalNewAlerts()

getRequestHistory

public ResponseCountSnapshot getRequestHistory()

start

public void start(Target target)

Overrides:

start in class Scanner

stopScan

public void stopScan()

Specified by:

stopScan in interface GenericScanner2

resumeScan

public void resumeScan()

Specified by:

resumeScan in interface GenericScanner2

alertFound

public void alertFound(Alert alert)

Specified by:

alertFound in interface ScannerListener

hostComplete

public void hostComplete(int id,
                         java.lang.String hostAndPort)

Specified by:

hostComplete in interface ScannerListener

hostNewScan

public void hostNewScan(int id,
                        java.lang.String hostAndPort,
                        HostProcess hostThread)

Specified by:

hostNewScan in interface ScannerListener

hostProgress

public void hostProgress(int id,
                         java.lang.String hostAndPort,
                         java.lang.String msg,
                         int percentage)

Specified by:

hostProgress in interface ScannerListener

filteredMessage

public void filteredMessage(HttpMessage msg,
                            java.lang.String reason)

Description copied from interface: ScannerListener

Added to notify reason for filtering message from scanning.

Specified by:

filteredMessage in interface ScannerListener

scannerComplete

public void scannerComplete(int id)

Specified by:

scannerComplete in interface ScannerListener

getList

public javax.swing.DefaultListModel<HistoryReference> getList()

getMessagesTableModel

public ActiveScanTableModel getMessagesTableModel()

notifyNewMessage

public void notifyNewMessage(HttpMessage msg)

Specified by:

notifyNewMessage in interface ScannerListener

Overrides:

notifyNewMessage in class Scanner

getStartNode

public SiteNode getStartNode()

Overrides:

getStartNode in class Scanner

setStartNode

public void setStartNode(SiteNode startNode)

Overrides:

setStartNode in class Scanner

reset

public void reset()

getTimeStarted

public java.util.Date getTimeStarted()

getTimeFinished

public java.util.Date getTimeFinished()

getMessagesIds

public java.util.List<java.lang.Integer> getMessagesIds()

Returns the IDs of all messages sent/created during the scan. The message must be recreated with a HistoryReference.

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

Returns:

the IDs of all the messages sent/created during the scan

See Also:

HistoryReference, ConcurrentModificationException

getAlertsIds

public java.util.List<java.lang.Integer> getAlertsIds()

Returns the IDs of all alerts raised during the scan.

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

Returns:

the IDs of all the alerts raised during the scan

See Also:

ConcurrentModificationException

getState

public ActiveScan.State getState()

setDisplayName

public void setDisplayName(java.lang.String name)

Specified by:

setDisplayName in interface GenericScanner2

getDisplayName

public java.lang.String getDisplayName()

Specified by:

getDisplayName in interface GenericScanner2

setScanId

public void setScanId(int id)

Specified by:

setScanId in interface GenericScanner2

getScanId

public int getScanId()

Specified by:

getScanId in interface GenericScanner2