pscan: passiveScan-config yaml and help consistency

Signed-off-by: kingthorin <[email protected]>

Author: kingthorin

addOns/pscan/CHANGELOG.md

@@ -6,6 +6,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Changed
+- Updated Automation Framework template plans and help content for passiveScan-* jobs to be more consistent.
 
 ## [0.4.0] - 2025-09-02
 ### Added

addOns/pscan/src/main/javahelp/org/zaproxy/addon/pscan/help/contents/job-pscanconf.html

@@ -21,11 +21,11 @@ <H2>YAML</H2>
 <pre>
   - type: passiveScan-config           # Passive scan configuration
     parameters:
-      maxAlertsPerRule: 10             # Int: Maximum number of alerts to raise per rule
-      scanOnlyInScope: true            # Bool: Only scan URLs in scope (recommended)
+      maxAlertsPerRule:                # Int: Maximum number of alerts to raise per rule, default: 0 unlimited
+      scanOnlyInScope:                 # Bool: Only scan URLs in scope (recommended), default: true
       maxBodySizeInBytesToScan:        # Int: Maximum body size to scan, default: 0 - will scan all messages
-      enableTags: false                # Bool: Enable passive scan tags, default: false - enabling them can impact performance
-      disableAllRules: false           # Bool: If true then will disable all rules before applying the settings in the rules section
+      enableTags:                      # Bool: Enable passive scan tags, default: false - enabling them can impact performance
+      disableAllRules:                 # Bool: If true then will disable all rules before applying the settings in the rules section, default: false
     rules:                             # A list of one or more passive scan rules and associated settings which override the defaults
     - id:                              # Int: The rule id as per https://www.zaproxy.org/docs/alerts/
       name:                            # String: The name of the rule for documentation purposes - this is not required or actually used

addOns/pscan/src/main/javahelp/org/zaproxy/addon/pscan/help/contents/job-pscanwait.html

@@ -20,7 +20,7 @@ <H2>YAML</H2>
 <pre>
   - type: passiveScan-wait             # Passive scan wait for the passive scanner to finish
     parameters:
-      maxDuration: 5                   # Int: The max time in minutes to wait for the passive scanner, default: 0 unlimited
+      maxDuration:                     # Int: The max time in minutes to wait for the passive scanner, default: 0 unlimited
 </pre>
 
 <H2>Job Data</H2>

addOns/pscan/src/main/resources/org/zaproxy/addon/pscan/automation/jobs/passiveScan-config-max.yaml

@@ -1,10 +1,10 @@
   - type: passiveScan-config           # Passive scan configuration
     parameters:
-      maxAlertsPerRule: 10             # Int: Maximum number of alerts to raise per rule
-      scanOnlyInScope: true            # Bool: Only scan URLs in scope (recommended)
+      maxAlertsPerRule:                # Int: Maximum number of alerts to raise per rule, default: 0 unlimited
+      scanOnlyInScope:                 # Bool: Only scan URLs in scope (recommended), default: true
       maxBodySizeInBytesToScan:        # Int: Maximum body size to scan, default: 0 - will scan all messages
-      enableTags: false                # Bool: Enable passive scan tags, default: false - enabling them can impact performance
-      disableAllRules: false           # Bool: If true then will disable all rules before applying the settings in the rules section
+      enableTags:                      # Bool: Enable passive scan tags, default: false - enabling them can impact performance
+      disableAllRules:                 # Bool: If true then will disable all rules before applying the settings in the rules section, default: false
     rules:                             # A list of one or more passive scan rules and associated settings which override the defaults
     - id:                              # Int: The rule id as per https://www.zaproxy.org/docs/alerts/
       name:                            # String: The name of the rule for documentation purposes - this is not required or actually used

addOns/pscan/src/main/resources/org/zaproxy/addon/pscan/automation/jobs/passiveScan-config-min.yaml

@@ -1,5 +1,5 @@
   - type: passiveScan-config           # Passive scan configuration
     parameters:
-      maxAlertsPerRule: 10             # Int: Maximum number of alerts to raise per rule
-      scanOnlyInScope: true            # Bool: Only scan URLs in scope (recommended)
+      maxAlertsPerRule:                # Int: Maximum number of alerts to raise per rule, default: 0 unlimited
+	  scanOnlyInScope:                 # Bool: Only scan URLs in scope (recommended), default: true
       maxBodySizeInBytesToScan:        # Int: Maximum body size to scan, default: 0 - will scan all messages

addOns/pscan/src/main/resources/org/zaproxy/addon/pscan/automation/jobs/passiveScan-wait-max.yaml

@@ -1,18 +1,18 @@
   - type: passiveScan-wait             # Passive scan wait for the passive scanner to finish
     parameters:
-      maxDuration: 5                   # Int: The max time in minutes to wait for the passive scanner, default: 0 unlimited
+      maxDuration:                     # Int: The max time in minutes to wait for the passive scanner, default: 0 unlimited
     tests:
-      - name: 'test one'                       # Name of the test, optional
-        type: alert                            # Specifies that the test is of type 'alert'
-        action: passIfPresent/passIfAbsent     # String: The condition (presence/absence) of the alert, default: passIfAbsent  
+      - name:                                  # Name of the test, optional
+        type:                                  # String: Specifies the type of test (in this job only 'alert' is supported)
+        action:                                # String: The condition (presence/absence) of the alert, default: passIfAbsent  
         scanRuleId:                            # Integer: The id of the scanRule which generates the alert, mandatory  
         alertName:                             # String: The name of the alert generated, optional
-        url: http://www.example.com/path       # String: The url of the request corresponding to the alert generated, optional
+        url:                                   # String: The url of the request corresponding to the alert generated, optional
         method:                                # String: The method of the request corresponding to the alert generated, optional
         attack:                                # String: The actual attack which generated the alert, optional
         param:                                 # String: The parameter which was modified to generate the alert, optional
         evidence:                              # String: The evidence corresponding to the alert generated, optional
         confidence:                            # String: The confidence of the alert, one of 'False Positive', 'Low', 'Medium', 'High', 'Confirmed', optional
         risk:                                  # String: The risk of the alert, one of 'Informational', 'Low', 'Medium', 'High', optional
         otherInfo:                             # String: Addional information corresponding to the alert, optional
-        onFail: 'info'                         # String: One of 'warn', 'error', 'info', mandatory
+        onFail:                                # String: One of 'warn', 'error', 'info', mandatory

addOns/pscan/src/main/resources/org/zaproxy/addon/pscan/automation/jobs/passiveScan-wait-min.yaml

@@ -1,18 +1,18 @@
   - type: passiveScan-wait             # Passive scan wait for the passive scanner to finish
     parameters:
-      maxDuration: 5                   # Int: The max time in minutes to wait for the passive scanner, default: 0 unlimited
+      maxDuration:                     # Int: The max time in minutes to wait for the passive scanner, default: 0 unlimited
     tests:
-      - name: 'test one'                       # Name of the test, optional
-        type: alert                            # Specifies that the test is of type 'alert'
-        action: passIfPresent/passIfAbsent     # String: The condition (presence/absence) of the alert, default: passIfAbsent  
+      - name:                                  # Name of the test, optional
+	  type:                                    # String: Specifies the type of test (in this job only 'alert' is supported)
+        action:                                # String: The condition (presence/absence) of the alert, default: passIfAbsent  
         scanRuleId:                            # Integer: The id of the scanRule which generates the alert, mandatory  
         alertName:                             # String: The name of the alert generated, optional
-        url: http://www.example.com/path       # String: The url of the request corresponding to the alert generated, optional
+        url:                                   # String: The url of the request corresponding to the alert generated, optional
         method:                                # String: The method of the request corresponding to the alert generated, optional
         attack:                                # String: The actual attack which generated the alert, optional
         param:                                 # String: The parameter which was modified to generate the alert, optional
         evidence:                              # String: The evidence corresponding to the alert generated, optional
         confidence:                            # String: The confidence of the alert, one of 'False Positive', 'Low', 'Medium', 'High', 'Confirmed', optional
         risk:                                  # String: The risk of the alert, one of 'Informational', 'Low', 'Medium', 'High', optional
         otherInfo:                             # String: Addional information corresponding to the alert, optional
-        onFail: 'info'                         # String: One of 'warn', 'error', 'info', mandatory
+        onFail:                                # String: One of 'warn', 'error', 'info', mandatory