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.
43 lines
3.1 KiB
Markdown
43 lines
3.1 KiB
Markdown
# 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](Getting-Started.md) | Installation, build, quick-start, Docker deployment |
|
|
| [Interactive Shell](Interactive-Shell.md) | Shell walkthrough, command palette, chaining, shortcuts |
|
|
| [CLI Reference](CLI-Reference.md) | Command-line flags, non-shell usage, output formats |
|
|
| [API Server](API-Server.md) | WebSocket API, PQ encryption, endpoints, rate limiting |
|
|
| [API Usage Examples](API-Usage-Examples.md) | Practical curl workflows, request/response samples |
|
|
| [Module Catalog](Module-Catalog.md) | Live registry export — auto-generated by `rustsploit --gen-module-catalog` from the inventory |
|
|
| [Module Development](Module-Development.md) | How to author new modules — `Module` trait, lifecycle hooks, scheduler, rate limiter |
|
|
| [Legacy / Migration Status](Legacy.md) | Pre-v0.5.0 code paths kept on purpose, in-flight migrations, audit findings ledger |
|
|
| [Security & Validation](Security-Validation.md) | Input validation constants, security patterns, honeypot detection |
|
|
| [Credential Modules Guide](Credential-Modules-Guide.md) | Best practices for credential modules — creds_helper, source port, timeout passthrough |
|
|
| [Exploit Modules Guide](Exploit-Modules-Guide.md) | Best practices for exploit modules — mass scan compat, batch guards, target-specific files |
|
|
| [Fast Pair / WhisperPair Guide](Fast-Pair-WhisperPair-Guide.md) | Bluetooth Fast Pair exploitation (CVE-2025-36911) — ECDH Key-Based Pairing, anti-spoofing key sourcing, conformance tests, hardware runbook |
|
|
| [Utilities & Helpers](Utilities-Helpers.md) | Network wrappers, creds_helper, exploit_helper, source port binding, cfg_prompt_* |
|
|
| [Bad Patterns](BAD_PATTERNS.md) | Banned code patterns — 95+ regex checks for panics, error swallowing, network bypasses |
|
|
| [Testing & QA](Testing-QA.md) | Build checks (0 errors, 0 warnings), smoke tests, wordlist validation |
|
|
| [Changelog](Changelog.md) | Release notes and version history (latest: 2026-06-13 — rmcp / Recog / JARM / SecLists ports, mass-scan fixes, per-run auto-save) |
|
|
| [Contributing](Contributing.md) | Fork guide, PR checklist, code style |
|
|
| [Credits](Credits.md) | Authors, acknowledgements, legal notice |
|
|
| [Future Features](Future-Features.md) | Roadmap and completed features (plugins, metadata, global options, etc.) |
|
|
| [About Me](About-Me.md) | Information about the author |
|
|
| [Donation](Donation.md) | Ways to support the project |
|
|
|
|
---
|
|
|
|
## Quick Navigation
|
|
|
|
- **New user?** → Start with [Getting Started](Getting-Started.md)
|
|
- **Writing a module?** → See [Module Development](Module-Development.md)
|
|
- **Using the API?** → See [API Server](API-Server.md) + [API Usage Examples](API-Usage-Examples.md)
|
|
- **Running from CLI?** → See [CLI Reference](CLI-Reference.md)
|