Welcome to the Rustsploit documentation hub. Use the links below to navigate to the relevant guide.
⚠️ Rustsploit is intended for authorized security testing and research only. Always obtain explicit written permission before targeting any system you do not own.
| Document | Description |
|---|---|
| Getting Started | Installation, build, quick-start, Docker deployment |
| Interactive Shell | Shell walkthrough, command palette, chaining, shortcuts |
| CLI Reference | Command-line flags, non-shell usage, output formats |
| API Server | WebSocket API, PQ encryption, endpoints, rate limiting |
| API Usage Examples | Practical curl workflows, request/response samples |
| Module Catalog | All 240 modules by category — 183 exploits, 27 scanners, 29 creds, 1 plugin |
| Module Development | How to author new modules, lifecycle, dispatcher |
| Security & Validation | Input validation constants, security patterns, honeypot detection |
| Credential Modules Guide | Best practices for 29 cred modules — mass scan, cfg_prompt_*, concurrency |
| Exploit Modules Guide | Best practices for 183 exploit modules — multi-target, cfg_prompt_*, validation |
| Utilities & Helpers | utils.rs public API, target normalization, honeypot check |
| Testing & QA | Build checks (0 errors, 0 warnings), smoke tests, wordlist validation |
| Changelog | Release notes and version history (current: v0.4.8) |
| Contributing | Fork guide, PR checklist, code style |
| Credits | Authors, acknowledgements, legal notice |
| Future Features | Roadmap and completed features (plugins, metadata, global options, etc.) |
| About Me | Information about the author |
| Donation | Ways to support the project |
- New user? → Start with Getting Started
- Writing a module? → See Module Development
- Using the API? → See API Server + API Usage Examples
- Running from CLI? → See CLI Reference