Package org.parosproxy.paros.core.scanner

Class Scanner

java.lang.Object

org.parosproxy.paros.core.scanner.Scanner

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

ActiveScan

public class Scanner
extends java.lang.Object
implements java.lang.Runnable

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ALERTS_POSTFIX
static java.lang.String	ASCAN_RULE_PREFIX
static java.lang.String	ASCAN_SCAN_STARTED_STATS
static java.lang.String	ASCAN_SCAN_STOPPED_STATS
static java.lang.String	ASCAN_SCAN_TIME_STATS
static java.lang.String	ASCAN_URLS_STATS
static java.lang.String	SKIPPED_POSTFIX
static java.lang.String	STARTED_POSTFIX
static java.lang.String	TIME_POSTFIX
static java.lang.String	URLS_POSTFIX

Constructor Summary

Constructors

Constructor	Description
Scanner(ScannerParam scannerParam, ConnectionParam param, ScanPolicy scanPolicy)	Deprecated. Use Scanner(ScannerParam, ScanPolicy, RuleConfigParam) instead.
Scanner(ScannerParam scannerParam, ConnectionParam param, ScanPolicy scanPolicy, RuleConfigParam ruleConfigParam)	Deprecated. (2.12.0) Use Scanner(ScannerParam, ScanPolicy, RuleConfigParam) instead.
Scanner(ScannerParam scannerParam, ScanPolicy scanPolicy, RuleConfigParam ruleConfigParam)	Constructs a Scanner.

Method Summary

Modifier and Type	Method	Description
void	addScanFilter(ScanFilter scanFilter)
void	addScannerHook(ScannerHook scannerHook)
void	addScannerListener(ScannerListener listener)
void	addScriptCollection(ScriptCollection sc)
java.util.List<HostProcess>	getHostProcesses()
int	getId()
boolean	getJustScanInScope()
protected java.util.Vector<ScannerHook>	getScannerHooks()
java.util.Set<ScriptCollection>	getScriptCollections()
SiteNode	getStartNode()
TechSet	getTechSet()	Gets the technologies used in the scan.
boolean	isInScope(java.lang.String nodeName)
boolean	isPaused()
boolean	isStop()
void	notifyNewMessage(HttpMessage msg)
void	pause()
void	removerScannerHook(ScannerHook scannerHook)
void	removeScannerListener(ScannerListener listener)
void	resume()
void	run()
void	scan(Target target)
boolean	scanChildren()
void	setExcludeList(java.util.List<java.lang.String> urls)
void	setId(int id)
void	setJustScanInScope(boolean scanInScope)
void	setScanChildren(boolean scanChildren)
void	setScannerParam(ScannerParam scannerParam)
void	setScanPolicy(ScanPolicy scanPolicy)
void	setStartNode(SiteNode startNode)
void	setTechSet(TechSet techSet)	Sets the technologies to be used in the scan.
void	setUser(User user)	Set the user to scan as.
void	start(SiteNode startNode)
void	start(Target target)
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

ASCAN_SCAN_STARTED_STATS

public static final java.lang.String ASCAN_SCAN_STARTED_STATS

See Also:

Constant Field Values

ASCAN_SCAN_STOPPED_STATS

public static final java.lang.String ASCAN_SCAN_STOPPED_STATS

See Also:

Constant Field Values

ASCAN_SCAN_TIME_STATS

public static final java.lang.String ASCAN_SCAN_TIME_STATS

See Also:

Constant Field Values

ASCAN_URLS_STATS

public static final java.lang.String ASCAN_URLS_STATS

See Also:

Constant Field Values

ASCAN_RULE_PREFIX

public static final java.lang.String ASCAN_RULE_PREFIX

See Also:

Constant Field Values

ALERTS_POSTFIX

public static final java.lang.String ALERTS_POSTFIX

See Also:

Constant Field Values

SKIPPED_POSTFIX

public static final java.lang.String SKIPPED_POSTFIX

See Also:

Constant Field Values

STARTED_POSTFIX

public static final java.lang.String STARTED_POSTFIX

See Also:

Constant Field Values

TIME_POSTFIX

public static final java.lang.String TIME_POSTFIX

See Also:

Constant Field Values

URLS_POSTFIX

public static final java.lang.String URLS_POSTFIX

See Also:

Constant Field Values

Constructor Detail

Scanner

@Deprecated
public Scanner(ScannerParam scannerParam,
               ConnectionParam param,
               ScanPolicy scanPolicy)

Deprecated.

Use Scanner(ScannerParam, ScanPolicy, RuleConfigParam) instead. It will be removed in a future version.

Constructs a Scanner, with no rules' configurations.

Parameters:

scannerParam - the scanner parameters

param - the connection parameters

scanPolicy - the scan policy

Scanner

@Deprecated
public Scanner(ScannerParam scannerParam,
               ConnectionParam param,
               ScanPolicy scanPolicy,
               RuleConfigParam ruleConfigParam)

Deprecated.

(2.12.0) Use Scanner(ScannerParam, ScanPolicy, RuleConfigParam) instead.

Constructs a Scanner.

Parameters:

scannerParam - the scanner parameters

param - the connection parameters

scanPolicy - the scan policy

ruleConfigParam - the rules' configurations, might be null.

Since:

2.6.0

Scanner

public Scanner(ScannerParam scannerParam,
               ScanPolicy scanPolicy,
               RuleConfigParam ruleConfigParam)

Constructs a Scanner.

Parameters:

scannerParam - the scanner parameters

scanPolicy - the scan policy

ruleConfigParam - the rules' configurations, might be null.

Since:

2.12.0

Method Detail

start

public void start(SiteNode startNode)

start

public void start(Target target)

stop

public void stop()

addScannerListener

public void addScannerListener(ScannerListener listener)

removeScannerListener

public void removeScannerListener(ScannerListener listener)

addScannerHook

public void addScannerHook(ScannerHook scannerHook)

removerScannerHook

public void removerScannerHook(ScannerHook scannerHook)

getScannerHooks

protected java.util.Vector<ScannerHook> getScannerHooks()

run

public void run()

Specified by:

run in interface java.lang.Runnable

scan

public void scan(Target target)

isStop

public boolean isStop()

pause

public void pause()

resume

public void resume()

isPaused

public boolean isPaused()

notifyNewMessage

public void notifyNewMessage(HttpMessage msg)

setExcludeList

public void setExcludeList(java.util.List<java.lang.String> urls)

isInScope

public boolean isInScope(java.lang.String nodeName)

setStartNode

public void setStartNode(SiteNode startNode)

getStartNode

public SiteNode getStartNode()

setJustScanInScope

public void setJustScanInScope(boolean scanInScope)

getJustScanInScope

public boolean getJustScanInScope()

setScanChildren

public void setScanChildren(boolean scanChildren)

scanChildren

public boolean scanChildren()

getHostProcesses

public java.util.List<HostProcess> getHostProcesses()

setScannerParam

public void setScannerParam(ScannerParam scannerParam)

setScanPolicy

public void setScanPolicy(ScanPolicy scanPolicy)

setUser

public void setUser(User user)

Set the user to scan as. If null then the current session will be used.

Parameters:

user -

getTechSet

public TechSet getTechSet()

Gets the technologies used in the scan.

Returns:

the technologies, never null (since 2.6.0)

Since:

2.4.0

setTechSet

public void setTechSet(TechSet techSet)

Sets the technologies to be used in the scan.

Parameters:

techSet - the technologies to be used during the scan

Throws:

java.lang.IllegalArgumentException - (since 2.6.0) if the given parameter is null

Since:

2.4.0

addScriptCollection

public void addScriptCollection(ScriptCollection sc)

getScriptCollections

public java.util.Set<ScriptCollection> getScriptCollections()

getId

public int getId()

setId

public void setId(int id)

addScanFilter

public void addScanFilter(ScanFilter scanFilter)