The new Automation Framework will in time replace the Command Line and Packaged Scan options. It allows you to control ZAP via one YAML file and provides more flexibility while not being tied to any specific container technology.
The Automation Framework in included with ZAP 2.11.0 as well as the stable docker image. The framework is plugable and many of the existing add-ons have been enhanced to support it.
Important: if you run the framework from the command line you should not use the -addonupdate option or
the addOns updateAddOns option - this has been found to cause
problems when updating add-ons which are defined in the current plan.
The recommended approach is to run ZAP inline once to update all of the add-ons and then again to run the plan, e.g.:
./zap.sh -cmd -addonupdate
./zap.sh -cmd -autorun zap.yaml <any other ZAP options>
A longer term solution is being worked on.
For details of how to get started with the framework see the main framework help page.
The full set of jobs currently supported by the framework are:
- activeScan - runs the active scanner
- addOns - add-on management
- alertFilter - alert filter configuration, provided with the Alert Filters add-on
- graphql - GraphQL schema import, provided with the GraphQL add-on
- openapi - OpenAPI definition import, provided with the OpenAPI add-on
- passiveScan-config - passive scan configuration
- passiveScan-wait - waits for the passive scanner to finish processing the current queue
- report - report generation, provided with the Report Generation add-on
- requestor - send specific requests to targets
- soap - SOAP WSDL import, provided with the SOAP add-on
- spider - runs the traditional spider
- spiderAjax - runs the ajax spider, provided with the Ajax Spider add-on
For details of future changes planned see the tracker issue.