Skip to content

Commit

Permalink
feat: more README improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
joshuavanderpoll committed Sep 20, 2024
1 parent eb33508 commit ed18eb7
Showing 1 changed file with 23 additions and 4 deletions.
27 changes: 23 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
<h1 align="center">Remote Code Execution: Laravel (CVE-2021-3129)</h1>

<p align="center">
<a href="https://visitorbadge.io/status?path=https%3A%2F%2Fgithub.com%2Fl0n3m4n%2FCVE-2024-22274-RCE">
<img src="https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Fjoshuavanderpoll%2FCVE-2021-3129&label=Views&countColor=%2337d67a" />
</a>
<img src="https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Fjoshuavanderpoll%2FCVE-2021-3129&label=Views&countColor=%2337d67a" />
<a href="https://www.python.org/">
<img src="https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54" alt="Python">
</a>
Expand All @@ -19,12 +17,15 @@ This script is designed to exploit the Remote Code Execution (RCE) vulnerability
- 🐋 [Docker POC](#-docker-poc)
- 💻 [Example](#-example)
- 🩹 [Patch options](#-patch-options)
- 💡 [Contributing to the project](#-contributing-to-the-project)
- 🕵🏼 [References](#-references)
- 📢 [Disclaimer](#-disclaimer)

## 🛠️ Installation
> [!NOTE]
> To ensure a clean and isolated environment for the project dependencies, it's recommended to use Python's venv module.
> To ensure a clean and isolated environment for the project dependencies, it's recommended to use Python's `venv` module.
### iOS/Linux
```bash
$ git clone https://github.com/joshuavanderpoll/CVE-2021-3129.git
$ cd CVE-2021-3129
Expand All @@ -33,6 +34,15 @@ $ source .venv/bin/activate
$ pip3 install -r requirements.txt
```

### Windows
```bash
$ git clone https://github.com/joshuavanderpoll/CVE-2021-3129.git
$ cd CVE-2021-3129
$ python -m venv .venv
$ .venv\Scripts\activate
$ pip3 install -r requirements.txt
```

## ⚙️ Usage
![Usage](/assets/usage.jpg)

Expand All @@ -50,6 +60,15 @@ $ docker run -p 8000:8000 laravel_vulnerable
- ``index`` (Injects code into index.php which prevents access to "/_ignition/execute-solution")
- ``private`` (Same as the index option, but allows specific header to access "_ignition/execute-solution")

## 💡 Contributing to the project
To contribute, first fork this repository, and `clone` it. Make your changes, whether you're fixing bugs, adding features, or improving translations. When done, `commit` your changes, `push` them, and submit a `pull request` for review to this repostiroy.

### Issues
If you're reporting an issue, make sure to include your `Python version` (python --version), your `PHP version` (php --version), and any relevant command input, and output.

### Translations
For translation contributions, take a look at the `lang/` folder to add or update translations for different languages.

## 🕵🏼 References
- https://github.com/ambionics/phpggc

Expand Down

0 comments on commit ed18eb7

Please sign in to comment.