Package com.vrondakis.zap.workflow

Class StartZapStep

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

com.vrondakis.zap.workflow.StartZapStep

All Implemented Interfaces:

ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>

public class StartZapStep
extends org.jenkinsci.plugins.workflow.steps.Step

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StartZapStep.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
StartZapStep(String host, int port, int timeout, String zapHome, List<String> allowedHosts, String sessionPath, boolean externalZap, String rootCaFile, List<String> additionalConfigurations)	Called with startZap() in jenkinsfile

Method Summary

Modifier and Type	Method	Description
org.jenkinsci.plugins.workflow.steps.StepExecution	start(org.jenkinsci.plugins.workflow.steps.StepContext context)

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

StartZapStep

@DataBoundConstructor
public StartZapStep(@CheckForNull
                    String host,
                    int port,
                    int timeout,
                    String zapHome,
                    List<String> allowedHosts,
                    String sessionPath,
                    boolean externalZap,
                    String rootCaFile,
                    List<String> additionalConfigurations)

Called with startZap() in jenkinsfile

Parameters:

host - The host to run ZAP on - default localhost

port - The port to run ZAP on - default 9092

timeout - The amount of seconds to let the ZAP attack run for before it quits - default 1000

zapHome - Where the zap process is located - this must be set if you are not using an external managed ZAP application.

allowedHosts - The hosts to allow scans to begin on, if none are specified then it will run the attack locally only

sessionPath - Optional path to the session file

externalZap - Set to true, ZAP application is externally managed.

rootCaFile - the root CA file that can be exported using 'zap.sh -daemon -certfulldump cert.pem

additionalConfigurations - configurations to add to ZAP startup, in the form of key=value pairs. If empty, only default configurations are added

Method Detail

start

public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context)

Specified by:

start in class org.jenkinsci.plugins.workflow.steps.Step