-
Notifications
You must be signed in to change notification settings - Fork 0
Add a .zap/rules.tsv example so the ZAP scan can be tuned #5
Copy link
Copy link
Open
Labels
beginner friendlyNo prior DevOps experience needed; guidance providedNo prior DevOps experience needed; guidance provideddocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomersworkflow: securityRelates to the security scanning workflowRelates to the security scanning workflow
Description
Activity
Metadata
Metadata
Assignees
Labels
beginner friendlyNo prior DevOps experience needed; guidance providedNo prior DevOps experience needed; guidance provideddocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomersworkflow: securityRelates to the security scanning workflowRelates to the security scanning workflow
The gap
examples/zap-baseline-scan.ymlpassesrules_file_name: ".zap/rules.tsv", but that file does not exist anywhere in this repo. Anyone copying the example has no idea what the file should contain.Why it matters
A baseline ZAP scan reports findings that are often already accepted risks for a given app (a missing header on an internal-only endpoint, for example). Without a rules file, every run fails on the same known findings, and people respond by deleting the scan entirely. A rules file is how you say "we know, and we have decided" without turning the check off.
What to do
examples/.zap/rules.tsvIGNORE/WARN/FAIL), and a URL regexexamples/README.mdFormat reference
Tab-separated:
<rule-id>\t<action>\t<url-regex>. See the ZAP action docs.How to check your work
There is nothing to run here — it is a documentation file. Just make sure the tabs are real tabs, not spaces, because ZAP will not parse spaces.
New to this? Say so in a comment and you will get help.