Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zaproxy/action-full-scan
A GitHub Action for running the ZAP Full scan
https://github.com/zaproxy/action-full-scan
actions dast devsecops github-actions security
Last synced: 4 months ago
JSON representation
A GitHub Action for running the ZAP Full scan
- Host: GitHub
- URL: https://github.com/zaproxy/action-full-scan
- Owner: zaproxy
- License: apache-2.0
- Created: 2020-04-09T15:33:58.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-24T04:04:51.000Z (8 months ago)
- Last Synced: 2024-05-22T04:41:14.429Z (7 months ago)
- Topics: actions, dast, devsecops, github-actions, security
- Language: JavaScript
- Homepage:
- Size: 1.6 MB
- Stars: 257
- Watchers: 12
- Forks: 47
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ZAP Action Full Scan
A GitHub Action for running the ZAP [Full Scan](https://www.zaproxy.org/docs/docker/full-scan/) to perform
Dynamic Application Security Testing (DAST).
The ZAP full scan action runs the ZAP spider against the specified target (by default with no time limit) followed by an
optional ajax spider scan and then a full active scan before reporting the results. The alerts will be maintained as a
GitHub issue in the corresponding repository.
**WARNING** this action will perform attacks on the target website.
You should only scan targets that you have permission to test.
You should also check with your hosting company and any other services such as CDNs that may be affected before running this action.
ZAP will also submit forms which could result in a [large number of messages](https://www.zaproxy.org/faq/how-can-i-prevent-zap-from-sending-me-1000s-of-emails-via-a-contact-us-form/) via, for example, 'Contact us' or 'comment' forms.
## Inputs
### `target`
**Required** The URL of the web application to be scanned. This can be either a publicly available web application or a locally
accessible URL.
### `docker_name`
**Optional** The name of the docker file to be executed. By default the action runs the stable version of ZAP. But you can
configure the parameter to use the weekly builds.
### `rules_file_name`
**Optional** You can also specify a relative path to the rules file to ignore any alerts from the ZAP scan. Make sure to create
the rules file inside the relevant repository. The following shows a sample rules file configuration.
Make sure to checkout the repository (actions/checkout@v2) to provide the ZAP rules to the scan action.
```tsv
10011 IGNORE (Cookie Without Secure Flag)
10015 IGNORE (Incomplete or No Cache-control and Pragma HTTP Header Set)
```
### `cmd_options`
**Optional** Additional command lines options for the full scan script
### `allow_issue_writing`
**Optional** By default the action will file the report to the GitHub issue using the `issue_title` input.
Set this to false if you don't want the issue to be created or updated.
### `issue_title`
**Optional** The title for the GitHub issue to be created.
### `token`
**Optional** ZAP action uses the default action token provided by GitHub to create and update the issue for the full scan.
You do not have to create a dedicated token. Make sure to use the GitHub's default action token when running the action(`secrets.GITHUB_TOKEN`).
### `fail_action`
**Optional** By default ZAP Docker container will fail with an [exit code](https://github.com/zaproxy/zaproxy/blob/efb404d38280dc9ecf8f88c9b0c658385861bdcf/docker/zap-full-scan.py#L31),
if it identifies any alerts. Set this option to `true` if you want to fail the status of the GitHub Scan if ZAP identifies any alerts during the scan.
### `artifact_name`
**Optional** By default the full scan action will attach the report to the build with the name `zap_scan`. Set this to a different string to name it something else. Consult [GitHub's documentation](https://github.com/actions/toolkit/blob/main/packages/artifact/docs/additional-information.md#non-supported-characters) for which artifact names are allowed.
## Environment variables
If set, the following [ZAP authentication environment variables](https://www.zaproxy.org/docs/authentication/handling-auth-yourself/#authentication-env-vars)
will be copied into the docker container:
- `ZAP_AUTH_HEADER_VALUE`
- `ZAP_AUTH_HEADER`
- `ZAP_AUTH_HEADER_SITE`
## Example usage
** Basic **
```
steps:
- name: ZAP Scan
uses: zaproxy/[email protected]
with:
target: 'https://www.zaproxy.org/'
```
** Advanced **
```
on: [push]
jobs:
zap_scan:
runs-on: ubuntu-latest
name: Scan the webapplication
steps:
- name: Checkout
uses: actions/checkout@v2
with:
ref: master
- name: ZAP Scan
uses: zaproxy/[email protected]
with:
token: ${{ secrets.GITHUB_TOKEN }}
docker_name: 'ghcr.io/zaproxy/zaproxy:stable'
target: 'https://www.zaproxy.org/'
rules_file_name: '.zap/rules.tsv'
cmd_options: '-a'
```
## Localised Alert Details
ZAP is internationalised and alert information is available in many languages.
You can change the language used by this action by changing the locale via the `cmd_options` e.g.: `-z "-config view.locale=fr_FR"`
See [https://github.com/zaproxy/zaproxy/tree/develop/zap/src/main/dist/lang](https://github.com/zaproxy/zaproxy/tree/develop/zap/src/main/dist/lang) for the full set of locales currently supported.
You can help improve ZAP translations via [https://crowdin.com/project/zaproxy](https://crowdin.com/project/zaproxy).