mirror of
https://github.com/s-b-repo/rustsploit
synced 2026-06-27 09:54:12 +00:00
s-b-repo
94899781d3
Hardening (non-module framework files):
- Retry-then-continue: bounded per-host retry on transient failures across all 4
mass-scan fan-outs; '10 errors -> abort sweep' softened to warn-and-continue
- Crash fixes: shell completer char-boundary guard; unreachable! -> bail!
- WS oversize-frame desync fixed (was bricking the PQ AEAD ratchet); MCP tenant
job list/kill, out-of-range port, non-string option now correct/errored
- No silent error swallowing: swept framework files, every dropped error now
bound + surfaced (warn for logged-only/data-loss, debug for already-propagated
or aggregated per-host); removed _ => {} and Err(_)/|_| discards
Docs + release: README + docs/ updated for the release; RELEASE_NOTES.txt
section 6d added; new RELEASE_GITHUB.txt (GitHub release body).
Build: 0 errors, 0 warnings, 40/40 targeted tests green.
3.1 KiB
3.1 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 | WebSocket API, PQ encryption, endpoints, rate limiting |
| API Usage Examples | Practical curl workflows, request/response samples |
| Module Catalog | Live registry export — auto-generated by rustsploit --gen-module-catalog from the inventory |
| Module Development | How to author new modules — Module trait, lifecycle hooks, scheduler, rate limiter |
| Legacy / Migration Status | Pre-v0.5.0 code paths kept on purpose, in-flight migrations, audit findings ledger |
| Security & Validation | Input validation constants, security patterns, honeypot detection |
| Credential Modules Guide | Best practices for credential modules — creds_helper, source port, timeout passthrough |
| Exploit Modules Guide | Best practices for exploit modules — mass scan compat, batch guards, target-specific files |
| Fast Pair / WhisperPair Guide | Bluetooth Fast Pair exploitation (CVE-2025-36911) — ECDH Key-Based Pairing, anti-spoofing key sourcing, conformance tests, hardware runbook |
| Utilities & Helpers | Network wrappers, creds_helper, exploit_helper, source port binding, cfg_prompt_* |
| Bad Patterns | Banned code patterns — 95+ regex checks for panics, error swallowing, network bypasses |
| Testing & QA | Build checks (0 errors, 0 warnings), smoke tests, wordlist validation |
| Changelog | Release notes and version history (latest: 2026-06-13 — rmcp / Recog / JARM / SecLists ports, mass-scan fixes, per-run auto-save) |
| 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 |
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