mirror of
https://github.com/s-b-repo/rustsploit
synced 2026-06-27 09:54:12 +00:00
S.B
8a8b7e8e5f
Modules: - Refactor wpair (WhisperPair / CVE-2025-36911) into a module directory (crypto/db/gatt/protocol + model_ids.csv), replacing the single wpair.rs - Add h3c_bmc suite (firewall/ipmi-hash/kvm-probe/redfish dumps), fortinet SSLVPN/magic-token, sharepoint_doc_harvest, m365_activesync_spray, ldap_anon_spray, php/git/tapestry webapp modules, h3c_cloudos_api_enum, etc. Framework hardening / feature fixes: - Background jobs capture module output (drainer) + wire progress counters (ScanCounters); tenant jobs record terminal status on their own JobManager - SSRF: ssrf_gate distinguishes SSRF_BLOCKED vs TARGET_ERROR; fail-closed REST/WS/MCP dispatch; tenant-tagged PQ lifecycle events - Scheduler: exclusions + service-port precheck on CIDR/file fan-out; accurate considered/skipped counters; cancellation-safe permit acquisition - Mass scan works via shell/CLI/API/MCP (added MCP run_module background-job option so long scans don't hit the tool-call timeout) - Bruteforce workers re-scope OUTPUT_BUFFER; cross-product combo default - Stores: cred dedup/cap/scrub, loot scrub, workspace protocol scrub, spool explicit-owner + write_raw (no-newline spooling) - Error handling: removed let _/discarded-error patterns; failures are distinguishable from negatives - Removed dead check/CheckResult subsystem, OutputAccumulator, and the no-op --output-format flag; CredEntry.valid wired (creds invalidate/validate); typed HostUp/ServiceDetected events - Add .gitignore (build artifacts, local config, engagement data) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
43 lines
3.0 KiB
Markdown
43 lines
3.0 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 (current: v0.5.0) |
|
|
| [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)
|