com.vrondakis.zap

Class ZapDriver

java.lang.Object

com.vrondakis.zap.ZapDriver

public class ZapDriver
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMPLETED_PERCENTAGE
static int	ZAP_INITIALIZE_TIMEOUT
static int	ZAP_INITIALIZE_WAIT
static long	ZAP_SCAN_SLEEP

Constructor Summary

Constructors

Constructor and Description
ZapDriver()

Method Summary

Modifier and Type	Method and Description
List<String>	getAllowedHosts()
HashMap<Integer,Integer>	getFailBuild()
String	getZapHost()
int	getZapPort()
int	getZapTimeout()
boolean	importUrls(String path) Imports URLs from a text file
boolean	loadPolicy(String policy) Loads a ZAP policy from a file path
boolean	loadSession(String sessionPath) Loads a ZAP session
void	setAllowedHosts(List<String> allowedHosts)
void	setFailBuild(int all, int high, int med, int low)
void	setZapHost(String zapHost)
boolean	setZapMode(String mode)
void	setZapPort(int zapPort)
void	setZapTimeout(int timeout)
boolean	shutdownZap()
boolean	startZapCrawler(String host) Starts the ZAP crawler on a specified URL
boolean	startZapProcess(String zapHome, hudson.FilePath ws, hudson.Launcher launcher) Starts the ZAP process
boolean	zapAttack(RunZapAttackStepParameters zsp) Starts the ZAP attack.
int	zapAttackStatus() Gets the current status of the started attacks (average of all)
int	zapCrawlerStatus() Gets the current status of the started attacks (average of all)

Methods inherited from class java.lang.Object

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

Field Detail

COMPLETED_PERCENTAGE

public static final int COMPLETED_PERCENTAGE

See Also:

Constant Field Values

ZAP_SCAN_SLEEP

public static final long ZAP_SCAN_SLEEP

See Also:

Constant Field Values

ZAP_INITIALIZE_TIMEOUT

public static final int ZAP_INITIALIZE_TIMEOUT

See Also:

Constant Field Values

ZAP_INITIALIZE_WAIT

public static final int ZAP_INITIALIZE_WAIT

See Also:

Constant Field Values

Constructor Detail

ZapDriver

public ZapDriver()

Method Detail

shutdownZap

public boolean shutdownZap()

setZapMode

public boolean setZapMode(String mode)

startZapCrawler

public boolean startZapCrawler(String host)

Starts the ZAP crawler on a specified URL

Parameters:

host - The host to attack

Returns:

Success

zapCrawlerStatus

public int zapCrawlerStatus()

Gets the current status of the started attacks (average of all)

Returns:

The % complete

importUrls

public boolean importUrls(String path)

Imports URLs from a text file

Parameters:

path - - The path to load from

Returns:

Success

loadSession

public boolean loadSession(String sessionPath)

Loads a ZAP session

Parameters:

sessionPath - - The path of the .session file

Returns:

Success

loadPolicy

public boolean loadPolicy(String policy)

Loads a ZAP policy from a file path

Parameters:

policy - - The path to load from

Returns:

Success

zapAttack

public boolean zapAttack(RunZapAttackStepParameters zsp)

Starts the ZAP attack. If allowedHosts is not provided in jenkinsfile, it will scan only hosts that are local

Parameters:

zsp - The parameters from the groovy step

Returns:

Success

zapAttackStatus

public int zapAttackStatus()

Gets the current status of the started attacks (average of all)

Returns:

The % complete

startZapProcess

public boolean startZapProcess(String zapHome,
                               hudson.FilePath ws,
                               hudson.Launcher launcher)

Starts the ZAP process

Parameters:

zapHome - - The location of the zap.sh file

ws - - Passed by step

launcher - - Passed by step

Returns:

Success

setZapHost

public void setZapHost(String zapHost)

setZapPort

public void setZapPort(int zapPort)

setFailBuild

public void setFailBuild(int all,
                         int high,
                         int med,
                         int low)

setZapTimeout

public void setZapTimeout(int timeout)

setAllowedHosts

public void setAllowedHosts(List<String> allowedHosts)

getZapTimeout

public int getZapTimeout()

getZapPort

public int getZapPort()

getFailBuild

public HashMap<Integer,Integer> getFailBuild()

getZapHost

public String getZapHost()

getAllowedHosts

public List<String> getAllowedHosts()