v1.0

Author: Ruulian

README.md

@@ -1,5 +1,5 @@
 <h1 align="center">Welcome to WConsole Extractor 👋</h1>
-<p>
+<p align="center">
   <img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" />
   <a href="https://github.com/Ruulian/wconsole_extractor/blob/main/LICENSE" target="_blank">
     <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
@@ -9,39 +9,97 @@
   </a>
 </p>
 
-> Wconsole Extractor is a library which allows to automatically exploit a flask debug mode server. You just need to write a file leak function, pass it to the class ``WConsoleExtractor`` constructor and you can access to all the elements related to the debug mode.
+> Wconsole Extractor is a library which allows to automatically exploit a flask debug mode server. You just need to write a file leak function, pass it to the class ``WConsoleExtractor`` constructor and you can access to all the elements related to the debug mode. Moreover, you can call the `shell` function to obtain an interactive shell.
 
-### 🏠 [Homepage](https://github.com/Ruulian/wconsole_extractor)
+## 🔨 Install
 
-## Install
+### From PyPi
+
+**Global installation**:
+
+```sh
+pip3 install wconsole-extractor
+```
+
+**Python virtual environment**:
+
+```sh
+python3 -m venv env
+source env/bin/activate
+pip3 install wconsole-extractor
+
+# Deactivate environment
+deactivate
+```
+
+### Installation from repository
+
+**Global installation**:
 
 ```sh
 git clone https://github.com/Ruulian/wconsole_extractor.git
 cd wconsole_extractor
 pip3 install .
 ```
 
-### Python virtual environment
+**Python virtual environment**:
 
 ```sh
 git clone https://github.com/Ruulian/wconsole_extractor.git
 cd wconsole_extractor
 python3 -m venv env
 source env/bin/activate
 pip3 install .
+
+# Deactivate environment
+deactivate
 ```
 
-## Usage
+## 📚 Documentation
 
 **Note**: The target operating system must be a Linux distribution.
 
-### Leak function
+### Prerequisites
 
 In order to use correctly the library, you need to have an arbitrary file read on the target and implement it in python.
 
 You must write a function that takes a filename as parameter and returns the content of the file on the target. If the file is not found, the function should return an **empty string**.
 
-### ✨ Demo
+### Available attributes
+
+From `WconsoleExtractor` instance, you can access mutiple attributes:
+
+```py
+# Target information
+extractor.target               # Specified target
+extractor.base_url             # Target base url
+extractor.hostname             # hostname
+
+# Versions
+extractor.python_version       # Python version
+extractor.werkzeug_version     # Werkzeug version
+
+# Probably public bits
+extractor.username             # User who launched the application
+extractor.flask_path           # Flask installation path
+extractor.modname              # Constant "flask.app"
+extractor.class_name           # Constant "Flask"
+extractor.probably_public_bits # Probably public bits [username, modname, class_name, flask_path]
+
+# Private bits
+extractor.machine_id           # Machine id
+extractor.uuidnode             # MAC address in decimal
+extractor.private_bits         # private bits
+
+# Post process information
+extractor.pin_code             # Werkzeug PIN CODE
+extractor.token                # Werkzeug console token (available in HTML source code)
+
+# Functions
+extractor.shell()              # Get interactive shell
+```
+
+### Example
 
 ```py
 from wconsole_extractor import WConsoleExtractor, info
@@ -64,6 +122,8 @@ info(f"PIN CODE: {extractor.pin_code}")
 extractor.shell()
 ```
 
+## ✨ Demo
+
 ![example_gif](.github/example.gif)
 
 ## Author

setup.py

@@ -1,6 +1,7 @@
 import setuptools
 
-long_description = "WConsole Extractor is a python library which automatically exploits a Werkzeug development server in debug mode. You just have to write a python function that leaks a file content and you have your shell :)"
+with open("README.md") as f:
+    long_description = f.read()
 
 
 with open('requirements.txt') as f:

wconsole_extractor/main.py

@@ -68,7 +68,7 @@ def __init__(self, target:str, leak_function) -> None:
         self.flask_path = self.get_flask_path(WConsoleExtractor.get_venv(environ))
 
         if not self.flask_path:
-            error("Unable to find flask package name")
+            error("Unable to find flask package name, please report it (https://github.com/Ruulian/wconsole_extractor/issues)")
 
         self.probably_public_bits = [
             self.username,