mirror of
https://github.com/s-b-repo/rustsploit
synced 2026-06-27 09:54:12 +00:00
S.B
f51d7c111b
adding unify support for api and prompt usage and improving. also adding some preformance improvements new documentations and improvement
2.3 KiB
2.3 KiB
Rustsploit Wiki
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.
📖 Documentation Index
| 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 | REST API startup, endpoints, auth, rate limiting, hardening |
| API Usage Examples | Practical curl workflows, request/response samples |
| Module Catalog | All modules by category — exploits, scanners, creds |
| Module Development | How to author new modules, lifecycle, dispatcher |
| Security & Validation | Input validation constants, security patterns, honeypot detection |
| Credential Modules Guide | Best practices for brute-force / cred modules |
| Exploit Modules Guide | Best practices for exploit modules |
| Utilities & Helpers | utils.rs public API, target normalization, honeypot check |
| Testing & QA | Build checks, smoke tests, wordlist validation |
| Changelog | Release notes and version history |
| Contributing | Fork guide, PR checklist, code style |
| Credits | Authors, acknowledgements, legal notice |
| Future Features | Roadmap: Plugins, Config Loading, Source Port modifications |
| About Me | Information about the author |
| Donation | Ways to support the project |
Quick Navigation
- 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