Skip to content

Commit e70a921

Browse files
committed
Updated isntructions and tested with latest zaproxy 2.12
1 parent 7695866 commit e70a921

File tree

2 files changed

+57
-15
lines changed

2 files changed

+57
-15
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.vscode/
2+

README.md

+55-15
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# ZAProxy Automated Security Tests Collection
2+
23
This repository contains a collection of scripts to automate ZAP Security Tests.
34

45
## Getting Started
@@ -7,41 +8,80 @@ To get started simply clone this repository, then browse each sub-directory for
78

89
Tools on the project root are usable directly.
910

10-
You can use this repo in conjunction with the Vagrant Kali-Linux base-box you'll find here:
11-
https://app.vagrantup.com/zfpsystems/boxes/kali-base-x86_64
12-
13-
to have a full automated build environment and deploy of your testing VM.
11+
If you have an x86_64 system, then you can use this repo in conjunction with my Vagrant Kali-Linux base-box you'll find [here](https://app.vagrantup.com/zfpsystems/boxes/kali-base-x86_64) (there are other images for other architectures too), to have a full automated build environment and deploy of your testing VM.
1412

1513
### Prerequisites
1614

17-
- You need git to clone this repository, obviously. You can get git from
18-
http://git-scm.com/
15+
- You need git to clone this repository, obviously. You can get git from [here](http://git-scm.com/).
1916

2017
- Scripts are mostly Python scripts so you'll need a Python interpreter installed and fully working.
2118

22-
- You'll need ZAProxy installed, you can find the latest release here:
23-
https://github.com/zaproxy/zaproxy
19+
- You'll need ZAProxy installed, you can find the latest release [here](https://github.com/zaproxy/zaproxy).
2420

2521
- You'll need Java VM installed.
2622

27-
### Install
28-
To install the automation tools just clone this repo inside your Kali Linux (or the system you want to use to run ZAProxy):
23+
- Some of the tools require zaproxy installed in a docker container, you can find the docker image [here](https://hub.docker.com/r/owasp/zap2docker-stable/).
24+
25+
You can install docker on your system following the instructions [here](https://docs.docker.com/install/).
26+
27+
You can install docker-compose on your system following the instructions [here](https://docs.docker.com/compose/install/).
28+
29+
You can install docker-machine on your system following the instructions [here](https://docs.docker.com/machine/install-machine/).
30+
31+
On Kali Linux you can quickly install docker with:
32+
33+
```bash
34+
sudo apt-get install docker docker.io
35+
```
36+
37+
And then pull OWASP latest zap docker image with:
38+
39+
```bash
40+
sudo docker pull owasp/zap2docker-stable
2941
```
42+
43+
### Installation
44+
45+
To install the automation tools just clone this repo inside your Kali Linux (or the system you want to use to run ZAProxy):
46+
47+
```bash
3048
git clone https://github.com/zfpsystems/zaproxy-automation
3149
```
3250

33-
I usually test these tools from /opt/zfpsystems/zaproxy-automaion, but you can use whatever path you prefer.
51+
I usually test these tools from `/opt/zfpsystems/zaproxy-automation/`, but you can use whatever path you prefer.
52+
53+
Once you have cloned the repo, go to the directory where you have cloned it and run the following command to install all the required Python dependencies:
54+
55+
```bash
56+
cd /opt/zfpsystems/zaproxy-automation/
57+
sudo pip install -r requirements.txt
58+
```
59+
60+
If everything goes well, you should be able to run the tools.
61+
62+
Tools come with different licenses so please check each tool sub-directory for licenses.
63+
64+
### Usage
3465

35-
Tools come with different licenses so please check sub-directory for licenses.
66+
To use the tools you need to have ZAProxy installed and reachable (aka in your default path on Linux for example).
67+
68+
Then you can run the tools from the command line, for example:
69+
70+
```bash
71+
cd /opt/zfpsystems/zaproxy-automation/
72+
sudo python zap-baseline.py -t https://www.example.com
73+
```
74+
75+
### Recommendations (yeah read them!)
3676

37-
### Reccommendations (yeah read them!)
3877
- DO NOT USE ZAProxy or this ZAProxy automation tools collection to hack web sites and web applications you don't own or you don't have a written permission to pen-test.
3978

40-
- I do not assume any responsabilities for your actions, nor for the content of this repository.
79+
- I do not assume any responsibilities for your actions, nor for the content of this repository.
4180

4281
- This automation tools collection sole purpose is to help people (especially the ones who can't afford expensive security solutions) to test security of their web applications and web sites to improve the quality and security of this world and not to make it worst!
4382

4483
### How to help this project
84+
4585
If you have ZAProxy automation scripts you want to include in this collection please feel free, here is how to:
4686

4787
- Create a public github.com repository of your tool, for example JohnWayne-zap-automation
@@ -51,4 +91,4 @@ If you have ZAProxy automation scripts you want to include in this collection pl
5191
- Please note: This is a public and open source repository, so do not add copyrighted stuff that won't allow me to publish your automation tools.
5292

5393
Thanks!
54-
94+
[Paolo](https://github.com/pzaino)

0 commit comments

Comments
 (0)