https://github.com/wallarm/fast-example-java-moon
https://github.com/wallarm/fast-example-java-moon
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/wallarm/fast-example-java-moon
- Owner: wallarm
- License: mit
- Created: 2021-06-07T16:04:09.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-06-09T09:03:34.000Z (over 4 years ago)
- Last Synced: 2024-03-26T19:07:44.802Z (almost 2 years ago)
- Language: Java
- Size: 15.6 KB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fast-example-java-moon
### Prerequisites
1. Java version: 8+ (tested on "OpenJDK 64-Bit Server VM (build 14.0.2+12-Ubuntu-120.04, mixed mode, sharing)")
2. Apache Maven (tested on "Apache Maven 3.6.3")
3. Docker engine for deploying DVWA (tested on "Client/Server: Docker Engine - Community 20.10.6")
You also need those 3 things (their underlying machines) to have network access to each other:
1. the tests from this repo should have access to the Moon cluster,
2. the Moon cluster should have access to the FAST docker container,
3. the FAST docker container should have access to the test app "DVWA" (see below).
### Quick start (run FAST as a Forward Proxy)
#### Deploy the app under test "DVWA"
Here we use this docker image with the app: https://hub.docker.com/r/vulnerables/web-dvwa/
**Warning**: do not deploy it to any public servers.
1. Run docker container with the test vulnerable app 'DVWA': `docker run --name web-dvwa --rm -it -p 80:80 vulnerables/web-dvwa`
2. Open the deployed DVWA "Database Setup" page in a browser
3. Setup DVWA app by clicking on the "Create / Reset database" button.
You can also use image https://hub.docker.com/r/wallarm/fast-example-dvwa-base based on the one mentioned above,
but it is immediately ready for use without preliminary database setup.
#### Deploy FAST in the Forward Proxy mode
1. Create env file 'fast.env' with the content bellow:
```
#REVERSE_PROXY=false
#WALLARM_API_HOST=us1.api.wallarm.com ## default: us1.api.wallarm.com
#BACKEND=http://$DVWA_HOST
WALLARM_API_TOKEN=$WALLARM_API_TOKEN
```
2. Replace $WALLARM_API_TOKEN with the actual FAST node token (see how to get it: https://docs.fast.wallarm.com/en/operations/create-node.html)
3. Create a Test Run as described in https://docs.fast.wallarm.com/en/operations/create-testrun.html (select or create your Fast node and mark the "Skip following files extensions" checkbox)
5. Run FAST docker container: `docker run --rm --name fast-test-dvwa --env-file=$(pwd)/fast.env -p 8080:8080 wallarm/fast:latest`
#### Deploy Moon to Minikube
You can omit this if you already have a Moon cluster.
1. Install minikube for deploying the Moon (if you don't already have minikube) as described in https://minikube.sigs.k8s.io/docs/start/
2. Deploy the Moon to minikube as describe here: https://aerokube.com/moon/latest/#install-minikube
3. Run `minikube ip` to know its IP address.
4. Optionally for convenience you can add minikube IP address to the file `/etc/hosts` with an arbitrary domain name like this: `192.168.49.2 minikube`, then you can open Moon Web UI in a browser on http://minikube:8080
#### Setup and run tests
1. Clone this repo
2. Copy file `config.properties.example` to `config.properties` in the repository root
3. Edit `config.properties`: modify values with actual addresses of deployed fast_proxy and minikube.
4. Check the value of the property `fast_proxy.mode.is_reverse`: it should be `false`.
Generally, it should be equal to the value of the parameter `REVERSE_PROXY` in the FAST proxy config file 'fast.env'.
5. Run the tests: `mvn clean test`.
You can also set up and run the tests in an IDE as a TestNG Suite `src/test/resources/testng.xml` or directly the test class
`src/test/java/net/dvwa/tests/DvwaTest.java`.
An IDE can run these tests also as a Maven target, provide the command line arguments: `clean test`.
#### See the results of the FAST Test Run
1. During or after the tests running and passing you can see the FAST Test Run progress and results as described in https://docs.fast.wallarm.com/en/operations/check-testrun-status.html
### Run the FAST as a Reverse Proxy
Assume you have deployed and configured all the entities described in the Quick Start section above:
the app under test, FAST proxy, Moon in Minikube and this repo with tests ready to run.
#### Deploy FAST in the Reverse Proxy mode
1. Create or modify env file 'fast.env' with the content bellow:
```
REVERSE_PROXY=true
#WALLARM_API_HOST=us1.api.wallarm.com ## default: us1.api.wallarm.com
BACKEND=http://$DVWA_HOST
WALLARM_API_TOKEN=$WALLARM_API_TOKEN
```
2. Replace $DVWA_HOST with the actual domain name or IP address (and add a port if you changed it from 80 when running the DVWA docker container)
3. Replace $WALLARM_API_TOKEN with the actual FAST node token (see how to get it: https://docs.fast.wallarm.com/en/operations/create-node.html)
4. Create a Test Run as described in https://docs.fast.wallarm.com/en/operations/create-testrun.html (select or create your Fast node and mark the "Skip following files extensions" checkbox)
5. Run FAST docker container: `docker run --rm --name fast-test-dvwa --env-file=$(pwd)/fast.env -p 8080:8080 wallarm/fast:latest`
#### Setup and run tests
1. Edit `config.properties`: set the value of the property `fast_proxy.mode.is_reverse` to `true`: it should be equal to the value of the parameter
`REVERSE_PROXY` in the FAST proxy config file 'fast.env'.
5. Run the tests: `mvn clean test` (also, you can open the project in any IDE and run the tests in it)