Package com.vrondakis.zap.workflow

Class RunZapAttackStep

java.lang.Object

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

org.jenkinsci.plugins.workflow.steps.Step

com.vrondakis.zap.workflow.RunZapAttackStep

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RunZapAttackStep.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
RunZapAttackStep(String scanPolicyName, int userId, int contextId, boolean recurse, boolean inScopeOnly, String method, String postData)	For zapAttack() function 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

RunZapAttackStep

@DataBoundConstructor
public RunZapAttackStep(String scanPolicyName,
                        int userId,
                        int contextId,
                        boolean recurse,
                        boolean inScopeOnly,
                        String method,
                        String postData)

For zapAttack() function in Jenkinsfile

Parameters:

scanPolicyName - The scan policy name to use when attacking (optional). Make sure to load the policy from a file first using loadScanPolicy()

userId - The ZAP user ID to run the attack with, loaded from the context (optional)

contextId - The ZAP context ID to run the attack with (optional)

recurse - Scans URLS under those captured by the proxy (optional).

inScopeOnly - Used to constrain the scan to URLs that are in scope (ignored if a Context or User is specified) (optional).

method - Restrict the scan to the provided method (optional).

postData - Restrict the scan to the provided postData (optional).

Method Detail

start

public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context)
                                                         throws IOException,
                                                                InterruptedException

Specified by:

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

Throws:

IOException

InterruptedException