diff --git a/addOns/alertFilters/CHANGELOG.md b/addOns/alertFilters/CHANGELOG.md index 53ee1b537f..0d81309cbb 100644 --- a/addOns/alertFilters/CHANGELOG.md +++ b/addOns/alertFilters/CHANGELOG.md @@ -4,7 +4,8 @@ All notable changes to this add-on will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). ## Unreleased - +### Changed +- Update the automation framework template and help to include missing fields (`ruleName` and `methods`). ## [25] - 2025-11-04 ### Changed diff --git a/addOns/alertFilters/src/main/javahelp/org/zaproxy/zap/extension/alertFilters/resources/help/contents/automation.html b/addOns/alertFilters/src/main/javahelp/org/zaproxy/zap/extension/alertFilters/resources/help/contents/automation.html index 9750a19a8f..5dc3d1b3c7 100644 --- a/addOns/alertFilters/src/main/javahelp/org/zaproxy/zap/extension/alertFilters/resources/help/contents/automation.html +++ b/addOns/alertFilters/src/main/javahelp/org/zaproxy/zap/extension/alertFilters/resources/help/contents/automation.html @@ -20,6 +20,7 @@

Job: alertFilter

deleteGlobalAlerts: true # Boolean, if true then will delete all existing global alerts, default false alertFilters: # A list of alertFilters to be applied - ruleId: # Int/String: Mandatory, the scan rule ID or the alert reference + ruleName: # String: Optional, the name of the rule newRisk: # String: Mandatory new risk level, one of 'False Positive', 'Info', 'Low', 'Medium', 'High' context: # String: Optional context name, if empty then a global alert filter will be created url: # String: Optional string to match against the alert, supports environment vars @@ -30,6 +31,7 @@

Job: alertFilter

attackRegex: # Boolean: Optional, if true then the attack is a regex evidence: # String: Optional string to match against the alert evidence field evidenceRegex: # Boolean: Optional, if true then the evidence is a regex + methods: # List: Optional, the HTTP methods diff --git a/addOns/alertFilters/src/main/resources/org/zaproxy/zap/extension/alertFilters/resources/alertFilter-max.yaml b/addOns/alertFilters/src/main/resources/org/zaproxy/zap/extension/alertFilters/resources/alertFilter-max.yaml index 60eee62ed8..5725b8acbf 100644 --- a/addOns/alertFilters/src/main/resources/org/zaproxy/zap/extension/alertFilters/resources/alertFilter-max.yaml +++ b/addOns/alertFilters/src/main/resources/org/zaproxy/zap/extension/alertFilters/resources/alertFilter-max.yaml @@ -2,7 +2,8 @@ parameters: deleteGlobalAlerts: true # Boolean, if true then will delete all existing global alerts, default false alertFilters: # A list of alertFilters to be applied - - ruleId: # Int: Mandatory, the scan rule ID or the alert reference + - ruleId: # Int/String: Mandatory, the scan rule ID or the alert reference + ruleName: # String: Optional, the name of the rule newRisk: # String: Mandatory new risk level, one of 'False Positive', 'Info', 'Low', 'Medium', 'High' context: # String: Optional context name, if empty then a global alert filter will be created url: # String: Optional string to match against the alert, supports environment vars diff --git a/addOns/client/CHANGELOG.md b/addOns/client/CHANGELOG.md index 383508d558..3d735dec19 100644 --- a/addOns/client/CHANGELOG.md +++ b/addOns/client/CHANGELOG.md @@ -4,7 +4,8 @@ All notable changes to this add-on will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). ## Unreleased - +### Changed +- Update the automation framework template to include missing field (`scopeCheck`). ## [0.19.0] - 2025-12-03 ### Changed diff --git a/addOns/client/src/main/resources/org/zaproxy/addon/client/resources/spiderClient-max.yaml b/addOns/client/src/main/resources/org/zaproxy/addon/client/resources/spiderClient-max.yaml index deb5c63a3d..44becc966a 100644 --- a/addOns/client/src/main/resources/org/zaproxy/addon/client/resources/spiderClient-max.yaml +++ b/addOns/client/src/main/resources/org/zaproxy/addon/client/resources/spiderClient-max.yaml @@ -10,4 +10,5 @@ browserId: # String: Browser ID to use, default: firefox-headless initialLoadTime: # Int: The time in seconds to wait after the initial URL is loaded, default: 5 pageLoadTime: # Int: The time in seconds to wait after a new URL is loaded, default: 1 - shutdownTime: # Int: The time in seconds to wait after no activity before shutting down, default: 5 \ No newline at end of file + shutdownTime: # Int: The time in seconds to wait after no activity before shutting down, default: 5 + scopeCheck: # String: The scope check, either Flexible or Strict, default: Flexible \ No newline at end of file diff --git a/addOns/reports/CHANGELOG.md b/addOns/reports/CHANGELOG.md index eea2b904be..d112950b5d 100644 --- a/addOns/reports/CHANGELOG.md +++ b/addOns/reports/CHANGELOG.md @@ -7,6 +7,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). ### Added - Insights to the reports. +### Changed +- Update the automation framework `outputSummary` template to include missing field (`rules`). + ## [0.42.0] - 2025-11-07 ### Changed - Update dependencies. diff --git a/addOns/reports/src/main/resources/org/zaproxy/addon/reports/resources/outputSummary-max.yaml b/addOns/reports/src/main/resources/org/zaproxy/addon/reports/resources/outputSummary-max.yaml index 4d55bd133b..8868e87c7d 100644 --- a/addOns/reports/src/main/resources/org/zaproxy/addon/reports/resources/outputSummary-max.yaml +++ b/addOns/reports/src/main/resources/org/zaproxy/addon/reports/resources/outputSummary-max.yaml @@ -1,4 +1,8 @@ - type: outputSummary # Print summary to stdout, primarily to mimic the behaviour of the packaged scans parameters: format: None # String: The format of the output, one of None, Short, Long, default: None - summaryFile: # String: The full path of a file into which will be written a JSON summary of the scan, default empty \ No newline at end of file + summaryFile: # String: The full path of a file into which will be written a JSON summary of the scan, default empty + rules: # A list of rules for which the actions are to be overridden + - id: # Int: The rule id as per https://www.zaproxy.org/docs/alerts/ + action: # String: The action to take for this rule, one of IGNORE, INFO, FAIL, default: WARN + customMessage: # String: A custom message which will be displayed with this rule \ No newline at end of file diff --git a/addOns/scripts/CHANGELOG.md b/addOns/scripts/CHANGELOG.md index 517709e2ea..e0c1554dc8 100644 --- a/addOns/scripts/CHANGELOG.md +++ b/addOns/scripts/CHANGELOG.md @@ -12,6 +12,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). ### Changed - Update dependency. +- Update the automation framework template to include missing field (`inline`). ## [45.15.0] - 2025-11-04 ### Added diff --git a/addOns/scripts/src/main/javahelp/org/zaproxy/zap/extension/scripts/resources/help/contents/automation.html b/addOns/scripts/src/main/javahelp/org/zaproxy/zap/extension/scripts/resources/help/contents/automation.html index 5e79df123b..39ae635167 100644 --- a/addOns/scripts/src/main/javahelp/org/zaproxy/zap/extension/scripts/resources/help/contents/automation.html +++ b/addOns/scripts/src/main/javahelp/org/zaproxy/zap/extension/scripts/resources/help/contents/automation.html @@ -84,7 +84,7 @@

YAML definition

engine: # String: The script engine to use - can be used to override the default engine for the file extension name: # String: The name of the script, defaults to the file name source: # String: The full or relative file path, must be readable - inline: # String: The full script (may be multi-line) - supply this or 'file' not both + inline: # String: The full script (may be multi-line) - supply this or 'source' not both target: # String: The URL to be invoked for "targeted" script type diff --git a/addOns/scripts/src/main/resources/org/zaproxy/zap/extension/scripts/resources/script-max.yaml b/addOns/scripts/src/main/resources/org/zaproxy/zap/extension/scripts/resources/script-max.yaml index e377f8c412..a14570e8ac 100644 --- a/addOns/scripts/src/main/resources/org/zaproxy/zap/extension/scripts/resources/script-max.yaml +++ b/addOns/scripts/src/main/resources/org/zaproxy/zap/extension/scripts/resources/script-max.yaml @@ -5,4 +5,5 @@ engine: # String: The script engine to use - can be used to override the default engine for the file extension name: # String: The name of the script, defaults to the file name source: # String: The full or relative path, must be readable + inline: # String: The full script (may be multi-line) - supply this or 'source' not both target: # String: The URL to be invoked for "targeted" script type \ No newline at end of file diff --git a/addOns/wappalyzer/CHANGELOG.md b/addOns/wappalyzer/CHANGELOG.md index 91eac9b46b..4e2150651c 100644 --- a/addOns/wappalyzer/CHANGELOG.md +++ b/addOns/wappalyzer/CHANGELOG.md @@ -4,7 +4,8 @@ All notable changes to this add-on will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). ## Unreleased - +### Added +- A help page for the tech-detection (`wappalyzer`) automation framework job. ## [21.50.0] - 2025-12-03 ### Changed diff --git a/addOns/wappalyzer/src/main/javahelp/org/zaproxy/zap/extension/wappalyzer/resources/help/contents/automation.html b/addOns/wappalyzer/src/main/javahelp/org/zaproxy/zap/extension/wappalyzer/resources/help/contents/automation.html new file mode 100644 index 0000000000..a1c650112a --- /dev/null +++ b/addOns/wappalyzer/src/main/javahelp/org/zaproxy/zap/extension/wappalyzer/resources/help/contents/automation.html @@ -0,0 +1,31 @@ + + + + + +Technology Detection Automation Framework Support + + + +

Technology Detection Automation Framework Support

+This add-on supports the Automation Framework. +

+

Job: wappalyzer

+The wappalyzer job is a data job. It does not have any configurable parameters. +It provides technology detection data to other jobs via the TechJobResultData class. + +

YAML

+ +
+  - type: wappalyzer
+
+ +

Job Data

+The following class will be made available to add-ons that provide access to the Job Data such as the Reporting add-on. + + + + diff --git a/addOns/wappalyzer/src/main/javahelp/org/zaproxy/zap/extension/wappalyzer/resources/help/index.xml b/addOns/wappalyzer/src/main/javahelp/org/zaproxy/zap/extension/wappalyzer/resources/help/index.xml index e46c898d43..81209e629e 100644 --- a/addOns/wappalyzer/src/main/javahelp/org/zaproxy/zap/extension/wappalyzer/resources/help/index.xml +++ b/addOns/wappalyzer/src/main/javahelp/org/zaproxy/zap/extension/wappalyzer/resources/help/index.xml @@ -7,4 +7,5 @@ + diff --git a/addOns/wappalyzer/src/main/javahelp/org/zaproxy/zap/extension/wappalyzer/resources/help/map.jhm b/addOns/wappalyzer/src/main/javahelp/org/zaproxy/zap/extension/wappalyzer/resources/help/map.jhm index 255e692abd..e5d6280ee8 100644 --- a/addOns/wappalyzer/src/main/javahelp/org/zaproxy/zap/extension/wappalyzer/resources/help/map.jhm +++ b/addOns/wappalyzer/src/main/javahelp/org/zaproxy/zap/extension/wappalyzer/resources/help/map.jhm @@ -9,4 +9,5 @@ + diff --git a/addOns/wappalyzer/src/main/javahelp/org/zaproxy/zap/extension/wappalyzer/resources/help/toc.xml b/addOns/wappalyzer/src/main/javahelp/org/zaproxy/zap/extension/wappalyzer/resources/help/toc.xml index 4cad3c8a11..802b4a9ad8 100644 --- a/addOns/wappalyzer/src/main/javahelp/org/zaproxy/zap/extension/wappalyzer/resources/help/toc.xml +++ b/addOns/wappalyzer/src/main/javahelp/org/zaproxy/zap/extension/wappalyzer/resources/help/toc.xml @@ -9,6 +9,7 @@ +