@@ -678,13 +678,13 @@ ZAP Setup
678
678
- From the popup, select the *No, I do not want to persis this session at this
679
679
moment in time * option and click *Start *
680
680
681
- - From the menu, select *Edit * -> *ZAP Mode * -> *Standard Mode * (This should be
681
+ - From the menu, select *Edit * – *ZAP Mode * – *Standard Mode * (This should be
682
682
the default option)
683
683
684
- - From the menu, select *Tools * -> *Options *:
684
+ - From the menu, select *Tools * – *Options *:
685
685
686
- - *Network * -> *Rate Limit *, add and enable a 3 request per second rule for
687
- the match string ``anvilprod.org ``, and another rule for the match string
686
+ - *Network * – *Rate Limit *, add and enable a 3 request per second rule for the
687
+ match string ``anvilprod.org ``, and another rule for the match string
688
688
``humancellatlas.org ``. This is required to prevent the scans from exceeding
689
689
the WAF rate limits for the Azul APIs, and being temporarily blocked by the
690
690
WAF.
@@ -695,36 +695,42 @@ ZAP Setup
695
695
696
696
- Check the *Check for updates to the add-ons you have installed * option
697
697
698
+ - You may now close the ZAP application. The next time you open the application,
699
+ the settings you set above will be used.
700
+
698
701
Running an authenticated scan
699
702
"""""""""""""""""""""""""""""
700
703
701
- The process for running an authenticated scan is to first obtain an Azul
702
- authentication token, and launch the ZAP application with the token set as an
703
- environment variable. See the `ZAP documentation
704
- <https://www.zaproxy.org/docs/getting-further/authentication/handling-auth-yourself/> `_
705
- for more information.
704
+ The scans you run need be run with authenticated requests. The process for
705
+ running an authenticated scan is to first obtain an Azul authentication token,
706
+ and then launch the ZAP application with the token set as an environment
707
+ variable. The token will then automatically be added as a header to all requests
708
+ made during the scan. See the `ZAP documentation `_ for more information.
709
+
710
+ .. _`ZAP documentation` : https://www.zaproxy.org/docs/getting-further/authentication/handling-auth-yourself/
706
711
707
712
- To get an authorization token from Azul:
708
713
709
714
- Open the Swagger UI for the appropriate (HCA or AnVIL) Azul service
710
715
711
716
- Click *Authorize * and complete the authorization
712
717
713
- - Using the Swagger UI, excecute an enpoint such as ``/index/catalogs ``
718
+ - Using the Swagger UI, execute an endpoint such as ``/index/catalogs ``
714
719
715
720
- Note the example ``curl `` command, and copy the token from the
716
- ``Authorization `` header option (e.g. " Bearer ya29.a0…" )
721
+ ``Authorization `` header option (e.g. `` Bearer ya29.a0… `` )
717
722
718
- - To set the envinroment variable and launch ZAP from the command line, open a
723
+ - To set the environment variable and launch ZAP from the command line, open a
719
724
terminal and run:
720
725
721
726
- ``export ZAP_AUTH_HEADER_VALUE="<TOKEN-VALUE-HERE>" ``
722
727
723
728
- ``/Applications/ZAP.app/Contents/MacOS/ZAP.sh ``
724
729
725
730
- 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.
731
+ session and run a scan. After your scan has completed and you have generated
732
+ a report, close the ZAP application, and repeat the steps above with a new
733
+ authentication token for each additional scan you wish to run.
728
734
729
735
ZAP Sessions
730
736
""""""""""""
@@ -733,7 +739,7 @@ With the ZAP application open, you must start a new session prior to running a
733
739
new scan. Failure to do so can pollute the scan results with the findings from
734
740
the previous scan.
735
741
736
- If you are promopted with options to persist the ZAP session, select the *No, I
742
+ If you are prompted with options to persist the ZAP session, select the *No, I
737
743
do not want to persis this session at this moment in time * option and click
738
744
*Start *. You may now continue with the scan of your choice.
739
745
@@ -755,7 +761,7 @@ Running a Portal / Browser scan
755
761
756
762
- Wait until all the scans (Ajax spider, passive scans, etc.) have completed. In
757
763
practice, this can take up to four hours depending on the target URL. Note
758
- that you will not recieve a notification when the scans have completed,
764
+ that you will not receive a notification when the scans have completed,
759
765
instead, take note of the *Current Status * values in the ZAP window footer.
760
766
Proceed when all scan counts show ``0 ``.
761
767
@@ -766,7 +772,7 @@ Running an Azul Indexer / Service API scan
766
772
767
773
In order to run an API scan you must first import the OpenAPI definition.
768
774
769
- - From the menu, select *Import * -> *Import an OpenAPI Definition *
775
+ - From the menu, select *Import * – *Import an OpenAPI Definition *
770
776
771
777
- Enter the URL of the OpenAPI definition (e.g.
772
778
https://service.explore.anvilproject.org/openapi.json) in the *URL * field
@@ -784,7 +790,7 @@ Generating a ZAP Report
784
790
After a scan has completed, use the following steps to save a PDF export of the
785
791
scan results.
786
792
787
- - From the menu, select *Report * -> *Generate Report *
793
+ - From the menu, select *Report * – *Generate Report *
788
794
789
795
- Select *Traditional PDF Report * from the *Template * option
790
796
0 commit comments