Skip to content

Commit ac189e9

Browse files
committed
fixup! Document web application vulnerability scanning procedure (#7021)
1 parent e18a304 commit ac189e9

File tree

1 file changed

+31
-7
lines changed

1 file changed

+31
-7
lines changed

OPERATOR.rst

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -685,7 +685,9 @@ ZAP Setup
685685

686686
- -> ``Network`` -> ``Rate Limit``, add and enable a 3 request per second rule
687687
for the match string ``anvilprod.org``, and another rule for the match
688-
string ``humancellatlas.org``
688+
string ``humancellatlas.org``. This is required to prevent the scans from
689+
exceeding the WAF rate limits for the Azul APIs, and being temporarily
690+
blocked by the wAF.
689691

690692
- -> ``Check for Updates``:
691693

@@ -697,7 +699,8 @@ Running an authenticated scan
697699
"""""""""""""""""""""""""""""
698700

699701
The process for running an authenticated scan is to first obtain an Azul
700-
authentication token, and then pass this to ZAP via an environment variable. See
702+
authentication token, and launch the ZAP application with the token set as
703+
an environment variable. See
701704
https://www.zaproxy.org/docs/getting-further/authentication/handling-auth-yourself/
702705
for more information.
703706

@@ -719,7 +722,20 @@ for more information.
719722

720723
- ``/Applications/ZAP.app/Contents/MacOS/ZAP.sh``
721724

722-
- Continue with the desired scan
725+
- After the ZAP application has opened, follow the steps below to create a new
726+
session and run a scan. The authorization token you provided will
727+
automatically be used to authenticate requests made during the scan.
728+
729+
ZAP Sessions
730+
""""""""""""
731+
732+
With the ZAP application open, you must start a new session prior to running a
733+
new scan. Failure to do so can pollute the scan results with the findings from
734+
the previous scan.
735+
736+
If you are promopted to with options to persist the ZAP session, select ``No, I
737+
do not want to persist this session`` and click ``Start``. You may now continue
738+
with the scan of your choice.
723739

724740
Running a Portal / Browser scan
725741
"""""""""""""""""""""""""""""""
@@ -736,7 +752,11 @@ Running a Portal / Browser scan
736752

737753
- Click ``Attack``
738754

739-
- Wait until all scans have completed, note ``Current Status`` in the ZAP footer
755+
- Wait until all the scans (Ajax spider, passive scans, etc.) have completed. In
756+
practice, this can take up to four hours depending on the target URL. Note
757+
that you will not recieve a notification when the scans have completed,
758+
however you can see the ``Current Status`` in the ZAP window footer, and
759+
proceed when all scan counts report ``0``.
740760

741761
- Generate a report (see section below)
742762

@@ -751,13 +771,17 @@ In order to run an API scan you must first import the OpenAPI definition.
751771

752772
- Click "Import"
753773

754-
You may now continue with an ``Automated Scan`` as detailed above. For the URL
755-
to attack, enter the base URL of the Azul indexer or service with no additional
756-
path (e.g. https://service.explore.anvilproject.org/).
774+
After importing the OpenAPI definitions, you may now follow the instructions
775+
above for running an ``Automated Scan``. When entering the URL to attack, use
776+
the base URL of the Azul indexer or service with no additional path components
777+
(e.g. https://service.explore.anvilproject.org/).
757778

758779
Generating a ZAP Report
759780
"""""""""""""""""""""""
760781

782+
After a scan has completed, you can save a PDF export of the scan results with
783+
the ``Generate Report`` action.
784+
761785
- From the menu, select ``Report`` -> ``Generate Report``
762786

763787
- Template: Traditional PDF Report

0 commit comments

Comments
 (0)