diff --git a/README.md b/README.md index f997cf7..b04837f 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A Rust-based modular exploitation framework inspired by RouterSploit. This tool ![Screenshot](https://github.com/s-b-repo/rustsploit/raw/main/preview.png) -๐Ÿ“š **Developer Documentation**: + **Developer Documentation**: โ†’ [Full Dev Guide (modules, proxy logic, shell flow, dispatch system)](https://github.com/s-b-repo/rustsploit/blob/main/docs/readme.md) --- @@ -64,27 +64,27 @@ added rtsp_bruteforce module dynamic modules listing and colored listing ``` ---- + + +## Building & Running +## requirements ``` -## ๐Ÿš€ Building & Running -## ๐Ÿ“ฆ๐Ÿ› ๏ธ requirements -` sudo apt update sudo apt install freerdp2-x11 - +``` for rdp bruteforce modudle -``` -``` -### ๐Ÿ“ฆ Clone the Repository + + +### Clone the Repository ``` git clone https://github.com/s-b-repo/rustsploit.git cd rustsploit ``` -### ๐Ÿ› ๏ธ Build the Project +### Build the Project ``` cargo build @@ -100,9 +100,9 @@ To install: cargo install ``` ---- -### ๐Ÿ–ฅ๏ธ Run in Interactive Shell Mode + +### Run in Interactive Shell Mode Launch the interactive RSF shell: @@ -112,7 +112,7 @@ cargo run Once inside the shell: -```text +``` rsf> help rsf> modules rsf> show_proxies @@ -124,30 +124,30 @@ rsf> set target 192.168.1.1 rsf> run ``` -๐ŸŒ€ Supports retrying proxies until one works (if proxy_on is enabled). +Supports retrying proxies until one works (if proxy_on is enabled). ---- -### ๐Ÿ”ง Run in CLI Mode + +### Run in CLI Mode #### โ–ถ Exploit ``` cargo run -- --command exploit --module heartbleed --target 192.168.1.1 ``` -#### ๐Ÿงช Scanner +#### Scanner ``` cargo run -- --command scanner --module port_scanner --target 192.168.1.1 ``` -#### ๐Ÿ” Credentials +#### Credentials ``` cargo run -- --command creds --module ssh_brute --target 192.168.1.1 ``` --- -## ๐ŸŒ Proxy Retry Logic (Shell Mode) +## Proxy Retry Logic (Shell Mode) - If proxies are loaded and `proxy_on` is active: - Random proxy is used from list @@ -156,7 +156,7 @@ cargo run -- --command creds --module ssh_brute --target 192.168.1.1 --- -## ๐Ÿ“‚ Module System +## Module System Modules are automatically detected using `build.rs` and registered as: - Short: `port_scanner` @@ -174,7 +174,7 @@ pub async fn run_interactive(target: &str) -> Result<()> --- -## ๐Ÿงผ Shell State +## Shell State The shell keeps: - Current module @@ -185,27 +185,25 @@ No session state is saved โ€” everything resets on restart. --- -## ๐Ÿ’ก Want to Add a Module? +## Want to Add a Module? See the full [Developer Guide](https://github.com/s-b-repo/rustsploit/blob/main/docs/readme.md) Includes: -- โœ… How to write modules -- ๐Ÿง  Auto-dispatch system explained -- ๐Ÿ“ฆ Module placement -- ๐ŸŒ Proxy logic details -- ๐Ÿ” Scanner vs Exploit vs Credential paths +- How to write modules +- Auto-dispatch system explained +- Module placement +- Proxy logic details +- Scanner vs Exploit vs Credential paths --- -## ๐Ÿ‘ฅ Contributors +## Contributors - **Main Developer**: me. - **Language**: 100% Rust. - **Inspired by**: RouterSploit, Metasploit, pwntools -## ๐Ÿ‘ฅ Credits +## Credits - **wordlists*: seclists & me - ----