Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion addOns/alertFilters/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ <H2>Job: alertFilter</H2>
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/String: Mandatory, the scan rule ID or the alert reference
- ruleId: # Int: Mandatory, the scan rule ID or the alert reference
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The String should be restored.

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
Expand All @@ -30,6 +31,7 @@ <H2>Job: alertFilter</H2>
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
</pre>

</BODY>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
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
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
Expand Down
1 change: 1 addition & 0 deletions addOns/client/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## Unreleased
### Changed
- Updated Chrome and Firefox extensions to v0.1.7.
- Update the automation framework template to include missing field (`scopeCheck`).

## [0.18.0] - 2025-11-04
### Added
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
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
3 changes: 2 additions & 1 deletion addOns/reports/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `outputSummary` job fields.

## [0.42.0] - 2025-11-07
### Changed
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,19 @@ <H2>Job: report</H2>
the strings in the sites list is included. The sites list also supports
variables.

<H2>Job: outputSummary</H2>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not intended to be used by the user, it's an "internal" job to help the migration of the packaged scans to use the AF.

The outputSummary job allows you to generate a summary of the alerts
found.
<pre>
- 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
rules: # A list of rules for which the actions are to be overriden
- 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
</pre>

</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -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
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
1 change: 1 addition & 0 deletions addOns/scripts/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ <H2>YAML definition</H2>
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
</pre>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 3 additions & 0 deletions addOns/wappalyzer/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ 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.

### Changed
- Updated with enthec upstream icon and pattern changes.

Expand Down
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be linked from somewhere (either other/main page or the TOC).

Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
<TITLE>
Technology Detection Automation Framework Support
</TITLE>
</HEAD>
<BODY>
<H1>Technology Detection Automation Framework Support</H1>
This add-on supports the Automation Framework.
<br><br>
<H2>Job: wappalyzer</H2>
The <code>wappalyzer</code> job is a data job. It does not have any configurable parameters.
It provides technology detection data to other jobs via the <code>TechJobResultData</code> class.

<H2>YAML</H2>

<pre>
- type: wappalyzer # Passive scan wait for the passive scanner to finish
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this is modelled based on another example but it just seems awkward to me.

If there's no good description for the job I think advice would be better handled as a note below or leading in.

Or maybe make sure the comment is clear that it's a note not a description? Just start it with # Note: and include the actual psw type/name?

</pre>

<H2>Job Data</H2>
The following class will be made available to add-ons that provide access to the Job Data such as the Reporting add-on.
<ul>
<li>Key: <code>wappalyzerData</code>
<li>Class: <a href="https://github.com/zaproxy/zap-extensions/blob/main/addOns/wappalyzer/src/main/java/org/zaproxy/zap/extension/wappalyzer/automation/TechJobResultData.java">TechJobResultData</a>
</ul>

</BODY>
</HTML>