fr.novia.zaproxyplugin

Class ZAProxy

java.lang.Object

hudson.model.AbstractDescribableImpl<ZAProxy>

fr.novia.zaproxyplugin.ZAProxy

All Implemented Interfaces:

hudson.model.Describable<ZAProxy>, Serializable

public class ZAProxy
extends hudson.model.AbstractDescribableImpl<ZAProxy>
implements Serializable

Contains methods to start and execute ZAProxy. Members variables are bind to the config.jelly placed to fr/novia/zaproxyplugin/ZAProxy

Author:

ludovic.roucoux

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZAProxy.ZAProxyDescriptorImpl Descriptor for ZAProxy.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CMD_LINE_DAEMON
static String	CMD_LINE_DIR
static String	CMD_LINE_HOST
static String	CMD_LINE_PORT
static String	FILE_POLICY_EXTENSION
static String	FILE_SESSION_EXTENSION
static String	NAME_POLICIES_DIR_ZAP

Constructor Summary

Constructors

Constructor and Description
ZAProxy(boolean autoInstall, String toolUsed, String zapHome, int timeoutInSec, String filenameLoadSession, String targetURL, boolean spiderURL, boolean scanURL, boolean scanURLAsUser, boolean saveReports, List<String> chosenFormats, String filenameReports, boolean saveSession, String filenameSaveSession, String zapDefaultDir, String chosenPolicy, List<ZAPcmdLine> cmdLinesZAP, String jdk) Deprecated. Old constructor
ZAProxy(boolean autoInstall, String toolUsed, String zapHome, int timeoutInSec, String filenameLoadSession, String targetURL, String excludedUrl, String scanMode, boolean spiderURL, boolean spiderAsUser, boolean ajaxSpiderURL, boolean ajaxSpiderURLAsUser, boolean scanURL, boolean scanURLAsUser, boolean saveReports, List<String> chosenFormats, String filenameReports, boolean saveSession, String filenameSaveSession, String zapDefaultDir, String chosenPolicy, List<ZAPcmdLine> cmdLinesZAP, String jdk, String username, String password, String usernameParameter, String passwordParameter, String extraPostData, String loginUrl, String loggedInIndicator)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	executeZAP(hudson.FilePath workspace, hudson.model.BuildListener listener) Execute ZAProxy method following build's setup and stop ZAP at the end.
boolean	getAjaxSpiderURL()
boolean	getAjaxSpiderURLAsUser()
boolean	getAutoInstall()
List<String>	getChosenFormats()
String	getChosenPolicy()
List<ZAPcmdLine>	getCmdLinesZAP()
ZAProxy.ZAProxyDescriptorImpl	getDescriptor()
String	getExcludedUrl()
String	getExtraPostData()
String	getFilenameLoadSession()
String	getFilenameReports()
String	getFilenameSaveSession()
String	getJdk()
hudson.model.JDK	getJDK() Gets the JDK that this Sonar builder is configured with, or null.
String	getLoggedInIndicator()
String	getLoginUrl()
String	getpassword()
String	getpasswordParameter()
boolean	getSaveReports()
boolean	getSaveSession()
String	getScanMode()
boolean	getScanURL()
boolean	getScanURLAsUser()
boolean	getSpiderAsUser()
boolean	getSpiderURL()
String	getTargetURL()
int	getTimeoutInSec()
String	getToolUsed()
String	getusername()
String	getUsernameParameter()
String	getZapDefaultDir()
String	getZapHome()
String	isScanMode(String testTypeName) Test if the test type names match (for marking the radio button).
void	setFilenameReports(String filenameReports)
void	setZapProxyHost(String zapProxyHost)
void	setZapProxyPort(int zapProxyPort)
void	startZAP(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener, hudson.Launcher launcher) Start ZAProxy using command line.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

FILE_POLICY_EXTENSION

public static final String FILE_POLICY_EXTENSION

See Also:

Constant Field Values

FILE_SESSION_EXTENSION

public static final String FILE_SESSION_EXTENSION

See Also:

Constant Field Values

NAME_POLICIES_DIR_ZAP

public static final String NAME_POLICIES_DIR_ZAP

See Also:

Constant Field Values

CMD_LINE_DIR

public static final String CMD_LINE_DIR

See Also:

Constant Field Values

CMD_LINE_HOST

public static final String CMD_LINE_HOST

See Also:

Constant Field Values

CMD_LINE_PORT

public static final String CMD_LINE_PORT

See Also:

Constant Field Values

CMD_LINE_DAEMON

public static final String CMD_LINE_DAEMON

See Also:

Constant Field Values

Constructor Detail

ZAProxy

@Deprecated
public ZAProxy(boolean autoInstall,
                  String toolUsed,
                  String zapHome,
                  int timeoutInSec,
                  String filenameLoadSession,
                  String targetURL,
                  boolean spiderURL,
                  boolean scanURL,
                  boolean scanURLAsUser,
                  boolean saveReports,
                  List<String> chosenFormats,
                  String filenameReports,
                  boolean saveSession,
                  String filenameSaveSession,
                  String zapDefaultDir,
                  String chosenPolicy,
                  List<ZAPcmdLine> cmdLinesZAP,
                  String jdk)

Deprecated. Old constructor

ZAProxy

@DataBoundConstructor
public ZAProxy(boolean autoInstall,
                            String toolUsed,
                            String zapHome,
                            int timeoutInSec,
                            String filenameLoadSession,
                            String targetURL,
                            String excludedUrl,
                            String scanMode,
                            boolean spiderURL,
                            boolean spiderAsUser,
                            boolean ajaxSpiderURL,
                            boolean ajaxSpiderURLAsUser,
                            boolean scanURL,
                            boolean scanURLAsUser,
                            boolean saveReports,
                            List<String> chosenFormats,
                            String filenameReports,
                            boolean saveSession,
                            String filenameSaveSession,
                            String zapDefaultDir,
                            String chosenPolicy,
                            List<ZAPcmdLine> cmdLinesZAP,
                            String jdk,
                            String username,
                            String password,
                            String usernameParameter,
                            String passwordParameter,
                            String extraPostData,
                            String loginUrl,
                            String loggedInIndicator)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

setFilenameReports

public void setFilenameReports(String filenameReports)

Parameters:

filenameReports - the filenameReports to set

getDescriptor

public ZAProxy.ZAProxyDescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<ZAProxy>

Overrides:

getDescriptor in class hudson.model.AbstractDescribableImpl<ZAProxy>

getAutoInstall

public boolean getAutoInstall()

getToolUsed

public String getToolUsed()

getZapHome

public String getZapHome()

getTimeoutInSec

public int getTimeoutInSec()

getFilenameLoadSession

public String getFilenameLoadSession()

getTargetURL

public String getTargetURL()

getExcludedUrl

public String getExcludedUrl()

getScanMode

public String getScanMode()

getSpiderURL

public boolean getSpiderURL()

getAjaxSpiderURL

public boolean getAjaxSpiderURL()

getAjaxSpiderURLAsUser

public boolean getAjaxSpiderURLAsUser()

getScanURL

public boolean getScanURL()

getSaveReports

public boolean getSaveReports()

getChosenFormats

public List<String> getChosenFormats()

getFilenameReports

public String getFilenameReports()

getSaveSession

public boolean getSaveSession()

getFilenameSaveSession

public String getFilenameSaveSession()

getZapDefaultDir

public String getZapDefaultDir()

getChosenPolicy

public String getChosenPolicy()

setZapProxyHost

public void setZapProxyHost(String zapProxyHost)

setZapProxyPort

public void setZapProxyPort(int zapProxyPort)

getCmdLinesZAP

public List<ZAPcmdLine> getCmdLinesZAP()

getSpiderAsUser

public boolean getSpiderAsUser()

getScanURLAsUser

public boolean getScanURLAsUser()

Returns:

the scanURLAsUser

getUsernameParameter

public String getUsernameParameter()

getpasswordParameter

public String getpasswordParameter()

getusername

public String getusername()

getpassword

public String getpassword()

getExtraPostData

public String getExtraPostData()

getLoginUrl

public String getLoginUrl()

getLoggedInIndicator

public String getLoggedInIndicator()

getJDK

public hudson.model.JDK getJDK()

Gets the JDK that this Sonar builder is configured with, or null.

getJdk

public String getJdk()

isScanMode

public String isScanMode(String testTypeName)

Test if the test type names match (for marking the radio button).

Parameters:

testTypeName - The String representation of the test type.

Returns:

Whether or not the test type string matches.

startZAP

public void startZAP(hudson.model.AbstractBuild<?,?> build,
            hudson.model.BuildListener listener,
            hudson.Launcher launcher)
              throws IllegalArgumentException,
                     IOException,
                     InterruptedException

Start ZAProxy using command line. It uses host and port configured in Jenkins admin mode and ZAProxy program is launched in daemon mode (i.e without UI). ZAProxy is started on the build's machine (so master machine ou slave machine) thanks to FilePath object and Launcher object.

Parameters:

build -

listener - the listener to display log during the job execution in jenkins

launcher - the object to launch a process locally or remotely

Throws:

InterruptedException

IOException

IllegalArgumentException

executeZAP

public boolean executeZAP(hudson.FilePath workspace,
                 hudson.model.BuildListener listener)

Execute ZAProxy method following build's setup and stop ZAP at the end.

Parameters:

workspace - a FilePath representing the build's workspace

listener - the listener to display log during the job execution in jenkins

Returns:

true is no exception is caught, false otherwise.