Package com.vrondakis.zap

Class ZapDriverImpl

java.lang.Object

com.vrondakis.zap.ZapDriverImpl

All Implemented Interfaces:

ZapDriver

public class ZapDriverImpl
extends Object
implements ZapDriver

Field Summary

Fields inherited from interface com.vrondakis.zap.ZapDriver

COMPLETED_PERCENTAGE, ZAP_INITIALIZE_TIMEOUT, ZAP_INITIALIZE_WAIT, ZAP_SCAN_SLEEP, ZAP_SCAN_STATUS_PRINT_INTERVAL

Constructor Summary

Constructors

Constructor	Description
ZapDriverImpl()

Method Summary

Modifier and Type	Method	Description
void	disablePassiveScanners(List<Integer> ids)
void	enablePassiveScanners(List<Integer> ids)
List<String>	getAdditionalConfigurations()
List<String>	getAllowedHosts()
HashMap<Integer,Integer>	getFailBuild()
FilePath	getZapDir()
String	getZapHost()
int	getZapPort()
String	getZapReport()
String	getZapReportXML()
String	getZapRootCaFile()
int	getZapTimeout()
void	importUrls(String path)	Imports URLs from a text file
void	loadPolicy(String policy)	Loads a ZAP policy from a file path
void	loadSession(String sessionPath)	Verifies ZAP session
void	setAdditionalConfigurations(List<String> additionalConfigurations)
void	setAllowedHosts(List<String> allowedHosts)
void	setFailBuild(int all, int high, int med, int low)
void	setLogger(PrintStream logger)	Sets the current logger.
void	setZapDir(FilePath dir)
void	setZapHost(String zapHost)
void	setZapMode(String mode)
void	setZapPort(int zapPort)
void	setZapRootCaFile(String rootCaFile)
void	setZapTimeout(int timeout)
void	shutdownZap()
void	startZapCrawler(RunZapCrawlerParameters zcp)	Starts the ZAP crawler on a specified URL
void	startZapProcess(String zapHome, FilePath ws, Launcher launcher)	Starts the ZAP process
void	zapAliveCheck()
boolean	zapAttack(RunZapAttackStepParameters zsp)	Starts the ZAP attack.
List<PluginProgress>	zapAttackProgress()	Gets the current progress of the 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)
void	zapCrawlerSuccess()
int	zapRecordsToScan()	Gets the number of records the passive scanner still has to scan

Methods inherited from class java.lang.Object

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

Constructor Detail

ZapDriverImpl

public ZapDriverImpl()

Method Detail

setLogger

public void setLogger(PrintStream logger)

Sets the current logger.

Specified by:

setLogger in interface ZapDriver

Parameters:

logger -

shutdownZap

public void shutdownZap()
                 throws ZapExecutionException

Specified by:

shutdownZap in interface ZapDriver

Throws:

ZapExecutionException

setZapMode

public void setZapMode(String mode)
                throws ZapExecutionException

Specified by:

setZapMode in interface ZapDriver

Throws:

ZapExecutionException

startZapCrawler

public void startZapCrawler(RunZapCrawlerParameters zcp)
                     throws ZapExecutionException

Starts the ZAP crawler on a specified URL

Specified by:

startZapCrawler in interface ZapDriver

Parameters:

zcp - The Zap Crawler Parameters to run with

Throws:

ZapExecutionException

zapCrawlerStatus

public int zapCrawlerStatus()

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

Specified by:

zapCrawlerStatus in interface ZapDriver

Returns:

The % complete

zapCrawlerSuccess

public void zapCrawlerSuccess()
                       throws InterruptedException,
                              ZapExecutionException

Specified by:

zapCrawlerSuccess in interface ZapDriver

Throws:

InterruptedException

ZapExecutionException

importUrls

public void importUrls(String path)
                throws ZapExecutionException

Imports URLs from a text file

Specified by:

importUrls in interface ZapDriver

Parameters:

path - - The path to load from

Throws:

ZapExecutionException

loadSession

public void loadSession(String sessionPath)
                 throws ZapExecutionException

Verifies ZAP session

Specified by:

loadSession in interface ZapDriver

Parameters:

sessionPath - - The path of the .session file

Throws:

ZapExecutionException

loadPolicy

public void loadPolicy(String policy)
                throws ZapExecutionException

Loads a ZAP policy from a file path

Specified by:

loadPolicy in interface ZapDriver

Parameters:

policy - - The path to load from

Throws:

ZapExecutionException

zapAttack

public boolean zapAttack(RunZapAttackStepParameters zsp)
                  throws ZapExecutionException,
                         URISyntaxException

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

Specified by:

zapAttack in interface ZapDriver

Parameters:

zsp - The parameters from the groovy step

Returns:

Success

Throws:

ZapExecutionException

URISyntaxException

zapAttackStatus

public int zapAttackStatus()

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

Specified by:

zapAttackStatus in interface ZapDriver

Returns:

The % complete

zapAttackProgress

public List<PluginProgress> zapAttackProgress()

Gets the current progress of the attack

Specified by:

zapAttackProgress in interface ZapDriver

startZapProcess

public void startZapProcess(String zapHome,
                            FilePath ws,
                            Launcher launcher)
                     throws IOException

Starts the ZAP process

Specified by:

startZapProcess in interface ZapDriver

Parameters:

zapHome - - The location of the zap.sh file

ws - - Passed by step

launcher - - Passed by step

Throws:

IOException

enablePassiveScanners

public void enablePassiveScanners(List<Integer> ids)
                           throws ZapExecutionException

Specified by:

enablePassiveScanners in interface ZapDriver

Throws:

ZapExecutionException

disablePassiveScanners

public void disablePassiveScanners(List<Integer> ids)
                            throws ZapExecutionException

Specified by:

disablePassiveScanners in interface ZapDriver

Throws:

ZapExecutionException

zapAliveCheck

public void zapAliveCheck()
                   throws ZapExecutionException

Specified by:

zapAliveCheck in interface ZapDriver

Throws:

ZapExecutionException

getZapReport

public String getZapReport()
                    throws IOException,
                           com.mashape.unirest.http.exceptions.UnirestException,
                           URISyntaxException

Specified by:

getZapReport in interface ZapDriver

Throws:

IOException

com.mashape.unirest.http.exceptions.UnirestException

URISyntaxException

getZapReportXML

public String getZapReportXML()
                       throws IOException,
                              com.mashape.unirest.http.exceptions.UnirestException,
                              URISyntaxException

Specified by:

getZapReportXML in interface ZapDriver

Throws:

IOException

com.mashape.unirest.http.exceptions.UnirestException

URISyntaxException

setZapHost

public void setZapHost(String zapHost)

Specified by:

setZapHost in interface ZapDriver

setZapPort

public void setZapPort(int zapPort)

Specified by:

setZapPort in interface ZapDriver

setZapDir

public void setZapDir(FilePath dir)

Specified by:

setZapDir in interface ZapDriver

setFailBuild

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

Specified by:

setFailBuild in interface ZapDriver

setZapTimeout

public void setZapTimeout(int timeout)

Specified by:

setZapTimeout in interface ZapDriver

setAllowedHosts

public void setAllowedHosts(List<String> allowedHosts)

Specified by:

setAllowedHosts in interface ZapDriver

getZapTimeout

public int getZapTimeout()

Specified by:

getZapTimeout in interface ZapDriver

getZapPort

public int getZapPort()

Specified by:

getZapPort in interface ZapDriver

getZapDir

public FilePath getZapDir()

Specified by:

getZapDir in interface ZapDriver

getFailBuild

public HashMap<Integer,Integer> getFailBuild()

Specified by:

getFailBuild in interface ZapDriver

getZapHost

public String getZapHost()

Specified by:

getZapHost in interface ZapDriver

getAllowedHosts

public List<String> getAllowedHosts()

Specified by:

getAllowedHosts in interface ZapDriver

zapRecordsToScan

public int zapRecordsToScan()
                     throws ZapExecutionException

Gets the number of records the passive scanner still has to scan

Specified by:

zapRecordsToScan in interface ZapDriver

Returns:

The number of records the passive scanner still has so scan

Throws:

ZapExecutionException

setZapRootCaFile

public void setZapRootCaFile(String rootCaFile)

Specified by:

setZapRootCaFile in interface ZapDriver

getZapRootCaFile

public String getZapRootCaFile()

Specified by:

getZapRootCaFile in interface ZapDriver

setAdditionalConfigurations

public void setAdditionalConfigurations(List<String> additionalConfigurations)

Specified by:

setAdditionalConfigurations in interface ZapDriver

getAdditionalConfigurations

public List<String> getAdditionalConfigurations()

Specified by:

getAdditionalConfigurations in interface ZapDriver