From eb2eaf31f8597cef91cb14096ff06f026fc7cf6a Mon Sep 17 00:00:00 2001 From: thc202 Date: Mon, 25 Nov 2024 06:03:32 +0000 Subject: [PATCH] Remove/update passive scanner help Remove passive scanner related pages that no longer need to be in core. Update the features passive scanner page to link to the add-on. Remove note that's no longer relevant. Part of zaproxy/zaproxy#7959. Signed-off-by: thc202 --- .../contents/start/features/pscan.html | 44 +---------- .../contents/ui/dialogs/options/options.html | 3 - .../contents/ui/dialogs/options/pscan.html | 48 ------------ .../contents/ui/dialogs/options/pscanner.html | 78 ------------------- .../ui/dialogs/options/pscanrules.html | 31 -------- .../contents/ui/dialogs/scanpolicy.html | 4 - commonFiles/src/main/resources/map.jhm | 3 - 7 files changed, 2 insertions(+), 209 deletions(-) delete mode 100644 addOns/help/src/main/javahelp/contents/ui/dialogs/options/pscan.html delete mode 100644 addOns/help/src/main/javahelp/contents/ui/dialogs/options/pscanner.html delete mode 100644 addOns/help/src/main/javahelp/contents/ui/dialogs/options/pscanrules.html diff --git a/addOns/help/src/main/javahelp/contents/start/features/pscan.html b/addOns/help/src/main/javahelp/contents/start/features/pscan.html index 6e8f18911..315185e33 100644 --- a/addOns/help/src/main/javahelp/contents/start/features/pscan.html +++ b/addOns/help/src/main/javahelp/contents/start/features/pscan.html @@ -9,48 +9,8 @@

Passive Scan

-ZAP by default passively scans all HTTP messages (requests and responses) sent to the web application being tested.
-Passive scanning does not change the requests nor the responses in any way and is therefore safe to use.
-Scanning is performed in a background thread to ensure that it does not slow down the exploration -of an application. -

-

-The (main) behaviour of the passive scanner can be configured using the -Options Passive Scanner Screen. -

-

-Passive scanning can also be used for automatically adding tags -and raising alerts for potential issues.
-A set of rules for automatic tagging are provided by default. These can be changed, deleted or -added to via the Options Passive Scan Tags screen. -

- -

-The alerts raised by passive scan rules can be configured using the -Options Passive Scan Rules screen.
-

- -

See also

- - - - - -
     -UI Overviewfor an overview of the user interface
     -Featuresprovided by ZAP
     -Active scanning
     -Scanner Rulessupported by default
- -

Official Videos

- - - - - - - -
    ZAP In Ten: Passive Scanning (10:27)
    ZAP In Ten: Passive Scan Scripts (11:53)
    Deep Dive: Passive Scanning (27:35)
+The passive scanner is provided by the Passive Scanner add-on, +which allows to passively scan messages (e.g. HTTP, WebSocket) proxied/sent through/by ZAP. diff --git a/addOns/help/src/main/javahelp/contents/ui/dialogs/options/options.html b/addOns/help/src/main/javahelp/contents/ui/dialogs/options/options.html index b7fcd7e36..6bf31134e 100644 --- a/addOns/help/src/main/javahelp/contents/ui/dialogs/options/options.html +++ b/addOns/help/src/main/javahelp/contents/ui/dialogs/options/options.html @@ -25,9 +25,6 @@

Options dialog

    JVM     Keyboard     Language -    Passive Scan Rules -    Passive Scan Tags -    Passive Scanner     Rule Configuration     Scripts     Search diff --git a/addOns/help/src/main/javahelp/contents/ui/dialogs/options/pscan.html b/addOns/help/src/main/javahelp/contents/ui/dialogs/options/pscan.html deleted file mode 100644 index 1c5db9056..000000000 --- a/addOns/help/src/main/javahelp/contents/ui/dialogs/options/pscan.html +++ /dev/null @@ -1,48 +0,0 @@ - - - - - -Options Passive Scan Tags screen - - - -

Options Passive Scan Tags screen

-

-This screen allows you to configure the tags -that are added by the passive scanner. -

-You can add, modify and remove the tags via the appropriate buttons. - -

Tag Interpolation

-In order to allow some flexibility in Tag creation and content it is possible for the user to specify a regular expression with capturing groups -which will be used to replace the group identifiers (ex: $1) in the resulting tag. -

-For example, a tag could be defined as follows: - - - - - - - - - - - - - -
FieldValueNote
Name:Test 
Tag:$1-SOMETAG 
Response Body Regex:(\d{3})Find strings of 3 numbers, using a capturing group (round brackets).
-Result: When 3 digit strings are passively identified in response body content (the regex matches) the messages will be -tagged such as "123-SOMETAG", "345-SOMETAG", etc. - -

See also

- - - -
     -UI Overviewfor an overview of the user interface
     -Options dialogsfor details of the other Options dialog screens
- - - diff --git a/addOns/help/src/main/javahelp/contents/ui/dialogs/options/pscanner.html b/addOns/help/src/main/javahelp/contents/ui/dialogs/options/pscanner.html deleted file mode 100644 index 2e8a0c5ee..000000000 --- a/addOns/help/src/main/javahelp/contents/ui/dialogs/options/pscanner.html +++ /dev/null @@ -1,78 +0,0 @@ - - - - -Options Passive Scanner Screen - - -

Options Passive Scanner screen

-

- This screen allows you to configure the passive - scanner. -

Configuration Options

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDetailsDefaultConfig File
Only scan messages in scopeSets whether or not the passive scan should be performed only on messages that - are in scope. - DeselectedKey: pscans.scanOnlyInScope
Values: true or false
Include traffic from the Fuzzer when passive scanningSets whether or not the passive scanning should be performed on messages generated by the Fuzzer.DeselectedKey: pscans.scanFuzzerMessages
Values: true or false
Max alerts any rule can raiseSets the maximum number of alerts a passive scan rule should raise. This may be slightly exceeded due to threading. - This setting is typically only useful for automated scanning. Scan rules that exceed this value will be disabled - and will need to be manually enabled if a new session is started. - 0 (unset)Key: pscans.maxAlertsPerRule
Values: 0: unset or the maximum number of alerts
Max body size in bytes to scanSets the maximum size request or response body size in bytes that the passive scanner will scan. - This can be used if passive scan rules take too long scanning very large requests or responses. - If set the number of ignored requests and responses are recorded in the stats using the keys - stats.pscan.reqBodyTooBig and stats.pscan.respBodyTooBig respectively. - 0 (unset)Key: pscans.maxBodySizeInBytes
Values: 0: unset or the maximum body size in bytes
Clear QueueEmpties the passive scan queue without passively scanning the messages. - Currently running rules will run to completion but new rules will only be run when new messages are added to the queue. -
- -

See also

- - - - - - - - - - - -
    UI Overviewfor an overview of the user interface
    Options dialogsfor details of the other Options dialog screens
- - - diff --git a/addOns/help/src/main/javahelp/contents/ui/dialogs/options/pscanrules.html b/addOns/help/src/main/javahelp/contents/ui/dialogs/options/pscanrules.html deleted file mode 100644 index 333e6eda3..000000000 --- a/addOns/help/src/main/javahelp/contents/ui/dialogs/options/pscanrules.html +++ /dev/null @@ -1,31 +0,0 @@ - - - - - -Options Passive Scan Rules Screen - - - -

Options Passive Scan Rules Screen

-

-This screen allows you to configure the passive scan rules.
-

-

Threshold

-This controls how likely ZAP is to report potential vulnerabilities.
- - -

See also

- - - -
     -UI Overviewfor an overview of the user interface
     -Options dialogsfor details of the other Options dialog screens
- - - diff --git a/addOns/help/src/main/javahelp/contents/ui/dialogs/scanpolicy.html b/addOns/help/src/main/javahelp/contents/ui/dialogs/scanpolicy.html index 5382e99e8..72d21a871 100644 --- a/addOns/help/src/main/javahelp/contents/ui/dialogs/scanpolicy.html +++ b/addOns/help/src/main/javahelp/contents/ui/dialogs/scanpolicy.html @@ -13,10 +13,6 @@

Scan Policy Dialog

The first screen allows you to define the default levels as well as the levels for all of the rules in a specific category.

The category screens allow you to define the levels for every individual rule.
-
-
-Note that passive scan rules are no longer managed via this dialog but are instead -managed via the Options Passive Scan Rules.

Threshold

diff --git a/commonFiles/src/main/resources/map.jhm b/commonFiles/src/main/resources/map.jhm index fa08f274f..6ae904ee8 100644 --- a/commonFiles/src/main/resources/map.jhm +++ b/commonFiles/src/main/resources/map.jhm @@ -134,9 +134,6 @@ - - -