Official OWASP Zed Attack Proxy Jenkins Plugin
The OWASP Zed Attack Proxy (ZAP) is one of the world’s most popular free security tools and is actively maintained by hundreds of
international volunteers. It can help you automatically find security vulnerabilities in your web applications while you are developing and
testing your applications. It's also a great tool for experienced pen-testers to use for manual security testing.
- Manage Sessions (Load or Persist)
- Define Context (Name, Include URLs and Exclude URLs)
- Attack Contexts (Spider Scan, AJAX Spider, Active Scan)
You can also:
- Setup Authentication (Form Based or Script Based)
- Run as Pre-Build as part of a Selenium Build
- Generate Reports (.xhtml, .xml, .json)
View Official OWASP ZAP on the plugin site for more information.
Table of Contents
- Issue Tracking
- Security Vulnerabilities
- Building the Plugin
- Development Rules and Guidelines
- Version History
- Previous Release (Deprecated)
ZAP as a part of a CI Environment
- A Jenkins CI Build step initializes ZAP
- Traffic flows (Regression Pack) through ZAP (Web Proxy)
- ZAP modifies requests to include Vulnerability Tests
- Target Application/Server sends Response back through ZAP
- ZAP sends reporting data back to Jenkins
- Jenkins publishes and archives the report(s)
- Jenkins creates JIRA tickets for the alerts
ZAP Jenkins plugin uses a number of open source plugins to work properly:
- ZAP API – A REST API which allows you to interact with ZAP programmatically.
And of course the Official ZAP Jenkins plugin is open source with a public repository on GitHub
Please use the Google Group for any questions about using the plugin.
Include the following:
- Java version
- Jenkins version
- ZAP version
- ZAP Jenkins Plugin version
- Firefox version (if running AJAX Spider or a Selenium build)
- Selenium (if applicable)
- Upload copies of the zap.log files and a copy of the console output of the Jenkins log to pastebin.
- Jenkins is always running on a master, is ZAP running on the master as well or on a separate slave machine?
- Relevant Jenkins Job Configurations sanitized screenshots.
- Issues can be created on the Jenkins JIRA for the component zap-plugin
- Before creating an Issue please read the JIRA guidelines.
Notice: GitHub Issues have been disabled.
If you find any security vulnerabilities or exploits caused by the plugin, please send a private email to one of the maintainer(s).
Notice: These should be kept private until a fix is issued.
- ZAP Jenkins plugin requires Jenkins 1.580.1+ to run.
- Download and extract the desired war release.
Zed Attack Proxy – Documentation, how to configure ZAP can be found here
Firefox – Documentation, how to configure Firefox can be found
Detailed instructions on how to configure a Job from start to finish can be found here.
Recommended: for first time users, the plugin requires special instructions to setup for first run.
The Official OWASP ZAP Jenkins plugin is a Maven Jelly Project.
Start the local Jenkins instance:
$ mvn hpi:run
Building the Plugin
Requires: JDK 8 to compile and JDK 7+ to run on Jenkins.
- Ensure that your Maven Environment is setup and configured properly by following the Plugin tutorial.
- Ensure that your various hosting permissions are configured properly and additional project settings are configured properly by following the Hosting Plugins tutorial.
Warning: Do NOT attempt to perform a production release until you have completed the Pre-Production Release steps below.
$ mvn clean package -eto create the plugin
- copy the resulting
../target/zap.hpifile to the
$JENKINS_HOME/plugins directory. Restart Jenkins.
- or use the plugin management console
127.0.0.1:8080/pluginManager/advancedto upload the
.hpifile. Restart Jenkins.
- Validate and make sure that your ssh connection is working and configured properly with:
$ ssh -T email@example.com
- Validate and sure your Jenkins credentials are correctly recognized by Maven with:
$ mvn deploy
Warning: If there are any SSL handshake issues, please see the following document on how to resolve them.
$ mvn release:prepare release:perform
Development Rules and Guidelines
Required: Only ONE Pull Request per JIRA Issue/Ticket.
Previous Release (Deprecated)