At April 2nd 2024, this repository was marked as "WILL BE ARCHIVED". At May 13th 2024 it was actually archived. It will not be maintained anymore.
The purpose of this project was to add the option for authenticated scans mainly (and also to add Blind XSS payloads as a bonus). Meanwhile, ZAP supports this out-of-the-box. Besides that, ZAP is (in the process of) being updated to use Automation Framework all tasks which changes the way scans are performed.
If you are still using zap2docker-weekly in your pipeline, it's advisable to plan a migration. It's advisable to use ZAP's Automation Framework in the latest version of ZAP to create an Automation Plan and test and use this plan both manually as well as in your CI/CD pipeline. You can follow the steps below.
- Familiarize yourself with the ZAP Automation Framework. A good starting point for this is https://www.zaproxy.org/docs/desktop/addons/automation-framework/. YouTube also has some very valuable videos about all aspects of the Automation Framework (https://www.youtube.com/@psiinon).
- Download and get used to the ZAP desktop application.
- Create a new Automation Plan using the ZAP desktop application.
- Analyze your current zap2docker-weekly usage. Identify the specific command parameters and configurations you need to replicate in your automation plan.
- Build your Automation Plan step-by-step to mirror your existing workflow. Pay close attention to spidering, active scanning, and report generation. Also, don't forget any custom scripts or exceptions built in for already managed false positives. This step is highly dependent on the project's specifics and the frameworks used.
- Test all steps individually and verify the report is as expected.
- Save your Automation Plan (as a YAML file) and add it to version control.
- Replace the current dependency step in your pipeline configuration (with something like "zap-cli -autorun plan.yaml"). If needed, the parameterization used can be transformed to be used by the Automation Plan.
- Run the full pipeline and thoroughly review the results. Verify that everything is working as expected.
- Set up periodic reviews of your Automation Plan (e.g., monthly or quarterly). Keep the ZAP software and any associated plugins up-to-date. As your application evolves, revisit and update your Automation Plan to ensure it remains effective.
If you need more help, please feel free to contact us (see "Get in touch" below). We can also provide a short demontration of the ZAP desktop application to get you up to speed.
Probably, you will not notice on short term. But it's very important to note that the base image where zap2docker-weekly is based on will NOT be maintained anymore since March 2024. So the reports being generated by zap2docker-weekly might not be accurate since that date and future changes to the way ZAP works (and vulnerabilities are being scanned an reported) might be missed. It's also possible that the original image will be removed so the existing pipeline will break. So it's NOT advisable to skip migrating.
The remainder of this README is preserved for archival purposes.
This project adds support to perform authenticated scans using the OWASP ZAP Docker scanscripts. These main features are available:
- Automatically or manually filling and completing loginforms.
- Records the sessiontoken (a cookie or Authorization header) and adds it to all spider and scanning requests.
- Exclude URL's to prevent termination of the session (such as /logout).
- Include additional URL's such as api.web.com which will also be spidered and scanned with the recorded sessiontoken.
You can find the Docker image on ictu/zap2docker-weekly
- Running a passive scan while limiting the memory the container uses to 8 GB. This option can be useful if memory issues occur.
docker run --rm --memory=8gb -v $(pwd):/zap/wrk/:rw -t ictu/zap2docker-weekly zap-full-scan.py -I -j -m 10 -T 60 \
-t https://demo.website.net \
-r testreport.html
- Running a passive scan with automatic authentication.
docker run --rm -v $(pwd):/zap/wrk/:rw -t ictu/zap2docker-weekly zap-baseline.py -I -j \
-t https://demo.website.net \
-r testreport.html \
--hook=/zap/auth_hook.py \
-z "auth.loginurl=https://demo.website.net/login/index.php \
auth.username="admin" \
auth.password="sandbox""
- Running an API scan with a provided Bearer token.
# First retrieve a token, for example using Curl and pass it to ZAP.
docker run --rm -v $(pwd):/zap/wrk/:rw -t ictu/zap2docker-weekly zap-api-scan.py -I \
-t https://demo.website.net/api/docs/openapidocs.json \
-f openapi \
-r testreport.html \
--hook=/zap/auth_hook.py \
-z "auth.bearer_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
- Running a full scan (max 10 mins spider and max 60 min scanning) with manual authentication and including an additional URL in the scope.
docker run --rm -v $(pwd):/zap/wrk/:rw -t ictu/zap2docker-weekly zap-full-scan.py -I -j -m 10 -T 60 \
-t https://demo.website.net \
-r testreport.html \
--hook=/zap/auth_hook.py \
-z "auth.loginurl=https://demo.website.net/login/index.php \
auth.username="admin" \
auth.password="sandbox" \
auth.username_field="j_username" \
auth.password_field="j_password" \
auth.submit_field="submit" \
auth.exclude=".*logout.*,http://url.com/somepath.*" \
auth.include="https://api.website.net.*"
Note: exclude and include URL's are comma separated regular expressions. Examples:
.*logout.*,http://url.com/logout.*
Note:
-j enable the AJAX spider (in addition to the default spider)
-m 60 limits the spider to 60 minutes.
-T 60 limits the scanner to 60 minutes.
-I do not return an errorcode as exitcode if there are issues found.
For more info on the different scantypes and parameters take a look at: https://www.zaproxy.org/docs/docker/
auth.loginurl The URL to the login page. Required.
auth.username A valid username. Required.
auth.password A valid password. Required.
auth.otpsecret The OTP secret.
auth.bearer_token A Bearer token to use in the authorization header for each request.
auth.username_field The HTML name or id attribute of the username field.
auth.password_field The HTML name or id attribute of the password field.
auth.submit_field The HTML name or id attribute of the submit field.
auth.otp_field The HTML name or id attribute of the OTP field.
auth.first_submit_field The HTML name or id attribute of the first submit field (in case of username -> next page -> password -> submit).
auth.submitaction "Click" or "Submit" to click the login button or submit the form.
auth.display True or False, indicate if the the webdriver should run in Headless mode.
auth.exclude Comma separated list of excluded URL's (regex). Default: (logout|uitloggen|afmelden|signout)
auth.include Comma separated list of included URL's (regex). Default: only the target URL and everything below it.
auth.check_delay How long to wait after submitting the form.
auth.check_element Element to look for to verify login completed.
auth.api_key API key to use in the request
This hook supports injecting Blind XSS payloads. You need to provide your callback URL which the XSS payload should trigger. This hook will automatically inject your payload in all possible locations like input fields, headers and cookies. (thanks to @greckko)
The below example uses XSSHunter as a callback:
docker run --rm -v $(pwd):/zap/wrk/:rw -t ictu/zap2docker-weekly zap-full-scan.py -I -j -m 10 -T 60 \
-t https://demo.website.net \
-r testreport.html \
--hook=/zap/auth_hook.py \
-z "xss.collector=xsshunter.xss.ht"
- Since this authentication solution uses a webdriver a custom image is needed to meet these requirements.
- Cookies that are automatically set by this script will not add flags like HttpOnly, Secure and SameSite. ZAP does not support setting these cookies using the API. This will result in false-positives in the report regarding these flags.
Point of contact for this repository is Team ICTU/security, who can be reached by opening a new issue in this repository's issue tracker.