Field Detail

• protected java.lang.Process zapProc

  ZAP process started by the ZapStart task. May not be populated if the #proxyPort points to an already running ZAP.

Property Detail

• final org.gradle.api.provider.Property<java.lang.String> activeScanTimeout

  The timeout, in seconds, to wait for the active scan or spidering to complete. The timeout applies to each spider and scan task, it's not cumulative. A value of 0 will not timeout.

• final org.gradle.api.provider.Property<java.lang.String> apiKey

  The API key for authenticating to ZAP. Defaults to a random value and is automatically used in tasks and when calling the #api() and #api(Closure) methods. This is required when using an already running ZAP.

• final org.gradle.api.provider.Property<java.lang.String> applicationUrl

  The base application URL for spidering.

• org.gradle.api.provider.Property<java.util.List<java.lang.String>> parameters

  Extra parameters to pass on the ZAP command line. Some interesting parameters (list all with zap.sh -help). -config Overrides the specified key=value pair in the configuration file -configfile Overrides the key=value pairs with those in the specified properties file -dir

  Uses the specified directory instead of the default one -newsession Creates a new session at the given location -session Opens the given session after starting ZAP -addoninstall Install the specified add-on from the ZAP Marketplace -addoninstallall Install all available add-ons from the ZAP Marketplace -addonuninstall Uninstall the specified add-on -addonupdate Update all changed add-ons from the ZAP Marketplace -addonlist List all of the installed add-ons

• final org.gradle.api.provider.Property<java.lang.String> proxyPort

  The proxy port on which ZAP is listening. When empty, a random port will be chosen. If a port is specified and there is a ZAP process listening on the port, the plugin will use the running instance. In this case, #apiKey will also need to be set.

• final org.gradle.api.provider.Property<java.lang.String> reportFormat

  Comma and/or space separated list: json, html, xml, md or leave empty for all.

• final org.gradle.api.provider.Property<java.lang.String> reportOutputPath

  The name of report files, without extension. The reports will be put into the project buildDir.

• final org.gradle.api.provider.Property<java.lang.String> version

  The version of ZAP to download, if zapInstallDir is not defined.

• final org.gradle.api.provider.Provider<java.lang.String> zapDir

  The working directory for ZAP.

• final org.gradle.api.provider.Property<java.lang.String> zapInstallDir

  The directory where ZAP is installed. The directory must contains zap.sh or zap.bat. If not defined, ZAP will be downloaded into the ~/.gradle directory.

Constructor Detail

• @javax.inject.Inject ZapPluginExtension(org.gradle.api.invocation.Gradle gradle, org.gradle.api.model.ObjectFactory objects)

Method Detail

• org.zaproxy.clientapi.core.ClientApi api()

  Get an instance of ClienApi with the host, port and API key set.

• void api(groovy.lang.Closure closure)

  Call a closure with a ClientApi instance as the delegate. This allows things like: zapConfig.api { spider.setOptionAcceptCookies(true) ascan.setOptionHandleAntiCSRFTokens(true) }