A GitHub Action for running the OWASP ZAP API scan to perform
Dynamic Application Security Testing (DAST).
WARNING this action will perform attacks on the target API.
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.
Optional The format of the defintion, openapi, soap, or graphql. Default is openapi.
docker_name
Optional The name of the Docker image 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.
10011IGNORE(Cookie Without Secure Flag)10015IGNORE(Incomplete or No Cache-control and Pragma HTTP Header Set)
cmd_options
Optional Additional command lines options for the 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 api 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,
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.
请发表评论