Passive Scanner Add-on on ZAP

Passive Scanner API

Mon, 01 Jan 0001 00:00:00 +0000

Passive Scanner API

The following operations are added to the API:

Actions

clearQueue: Clears the passive scan queue.
disableAllScanners: Disables all passive scan rules.
disableAllTags: Disables all passive scan tags.
disableScanners (ids*): Disables passive scan rules.
- ids: A comma separated list of scan rule IDs.
enableAllScanners: Enables all passive scan rules.
enableAllTags: Enables all passive scan tags.
enableScanners (ids*): Enables passive scan rules.
- ids: A comma separated list of scan rule IDs.
setEnabled (enabled*): Sets whether or not the passive scanning is enabled (Note: the enabled state is not persisted).
- enabled: The enabled state, true or false.
setMaxAlertsPerRule (maxAlerts*): Sets the maximum number of alerts a passive scan rule can raise.
- maxAlerts: The maximum number of alerts.
setMaxBodySizeInBytes (maxSize*): Sets the maximum body size in bytes that the passive scanner will scan.
- maxSize: The maximum size in bytes, 0 to unset.
setScanOnlyInScope (onlyInScope*): Sets whether or not the passive scan should be performed only on messages that are in scope.
- onlyInScope: The scan state, true or false.
setScannerAlertThreshold (id* alertThreshold*): Sets the alert threshold of a passive scan rule.
- id: The ID of the scan rule.
- alertThreshold: The alert threshold: OFF, DEFAULT, LOW, MEDIUM and HIGH

Views

currentTasks: Shows information about the passive scan tasks currently being run (if any).
maxAlertsPerRule: Gets the maximum number of alerts a passive scan rule should raise.
maxBodySizeInBytes: Gets the maximum body size in bytes that the passive scanner will scan.
recordsToScan: The number of records the passive scanner still has to scan.
scanOnlyInScope: Tells whether or not the passive scan should be performed only on messages that are in scope.
scanners: Lists all passive scan rules with their ID, name, enabled state, and alert threshold.


	Passive Scanner	the introduction to Passive Scanner add-on

Passive Scanner Automation Framework - passiveScan-config Job

Mon, 01 Jan 0001 00:00:00 +0000

Passive Scanner Automation Framework - passiveScan-config Job

This job allows you to manage the passive scan configuration.

It is covered in the video: ZAP Chat 08 Automation Framework Part 2 - Environment.

The passive scanner runs against all requests and responses that are generated by ZAP or are proxied through it. If you want to configure the passive scan configuration then you should typically do so before running any other jobs. However you can run this job later, or multiple times, if you want different jobs to use different passive scan configurations.

Passive Scanner Automation Framework - passiveScan-wait Job

Mon, 01 Jan 0001 00:00:00 +0000

Passive Scanner Automation Framework - passiveScan-wait Job

This job waits for the passive scanner to finishing scanning the requests and responses in the current queue. You should typically run this job after the jobs that explore you application, such as the spider jobs or those that import API definitions. If any more requests are sent by ZAP or proxied through ZAP after this job has run then they will be processed by the passive scanner. You can run this job as many times as you need to.

Passive Scanner Automation Framework Support

Mon, 01 Jan 0001 00:00:00 +0000

Passive Scanner Automation Framework Support

This add-on supports the Automation Framework.

Jobs

The following automation jobs are supported by this add-on:

Passive Scanner Add-on on ZAP

Passive Scanner API

Passive Scanner API

Actions

Views

See also

Passive Scanner Automation Framework - passiveScan-config Job

Passive Scanner Automation Framework - passiveScan-config Job

Passive Scanner Automation Framework - passiveScan-wait Job

Passive Scanner Automation Framework - passiveScan-wait Job

Passive Scanner Automation Framework Support

Passive Scanner Automation Framework Support

Jobs