Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
0c34 committed Nov 19, 2020
1 parent fbebf91 commit 544b631
Showing 1 changed file with 39 additions and 1 deletion.
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,28 @@
#### GoVWA
---
<<<<<<< HEAD
GoVWA (Go Vulnerable Web Application) is a golang web application which contain vulnerability based on OWASP top 10. This application simulate how vulnerability occure and help developer or security engineer to learn security on golang application.
=======
GoVWA (Go Vulnerable Web Application) is a web application developed to help the pentester and programmers to learn the vulnerabilities that often occur in web applications which are developed using golang. Vulnerabilities that exist in GoVWA are the most common vulnerabilities found in web applications today. So it will help programmers recognize vulnerabilities before they happen to their application. Govwa can also be an additional application of your pentest lab for learning and teaching.

>>>>>>> Update README.md
#### WARNING!
---
GoVWA is a vulnerable web application, **run the application on your local or testing environment only**

#### Installation
---
<<<<<<< HEAD
#### Install golang
Install golang on you host
=======
#### Installing golang
If you didn't have golang installed on your system. First, install it using automation script from https://github.com/canha/golang-tools-install-script.

Follow the instruction which is provided by the author and install golang depending on your Operating System Architecture.

If successfully installed you would have a directory 'go' in your home directory. The go directory has three subdirectories (bin, pgk, src). Switch to src directory then clone govwa repository.
>>>>>>> Update README.md
#### Setup from source
```
Expand All @@ -17,14 +31,24 @@ git clone https://github.com/0c34/govwa.git
git pull (to update)
```
<<<<<<< HEAD
Install dependency packages
=======
we have to install several golang packages that required by govwa

Execute those command in your terminal
>>>>>>> Update README.md
```
go mod download
```

#### GoVWA config
---
<<<<<<< HEAD
Modified the config.json file for database configuration
=======
Open the file config.json which is located in the config directory. Change the configuration according to your needs.
>>>>>>> Update README.md
```
{
Expand Down Expand Up @@ -54,11 +78,16 @@ go run app.go
°°ÛÛÛ °°ÛÛÛ °ÛÛÛ °ÛÛÛ °°°ÛÛÛÛÛ° °°°ÛÛÛÛÛ°ÛÛÛÛÛ° °ÛÛÛ °ÛÛÛ
°°ÛÛÛÛÛÛÛÛÛ °°ÛÛÛÛÛÛ °°ÛÛÛ °°ÛÛÛ °°ÛÛÛ ÛÛÛÛÛ ÛÛÛÛÛ
°°°°°°°°° °°°°°° °°° °°° °°° °°°°° °°°°°
<<<<<<< HEAD
Server running at port :888
Open this url http://localhost:8888/ on your browser to access GoVWA
=======
Server running at port :8082
Open this URL http://192.168.56.101:8082/ on your browser to access GoVWA
>>>>>>> Update README.md
```
Open the url to access GoVWA and follow the setup instruction to create database and tables
Open the URL to access GoVWA and follow the setup instruction to create database and tables

#### Setup from docker
```
Expand Down Expand Up @@ -88,10 +117,19 @@ Explore the vulnerability.

#### To Do

<<<<<<< HEAD
* add more vulnerabilities

Powered by [NemoSecurity](https://nemosecurity.com)




=======
* ~~XXE Vulnerability~~
* NoSQLInjection
* JSON Web API (unprotected API)
* Build Simple Android APP

warm regards [NemoSecurity](https://nemosecurity.com)
>>>>>>> Update README.md

0 comments on commit 544b631

Please sign in to comment.