Skip to content

HOWTO.md

Latest commit

 

History

History
113 lines (93 loc) · 4.83 KB

HOWTO.md

File metadata and controls

113 lines (93 loc) · 4.83 KB

HOWTO: NETREAPER Field Guide

Table of Contents

Overview

NETREAPER is a unified offensive toolkit with 70+ tools behind one interface. Use it to scan, attack, monitor, and report without juggling individual commands.

What’s new in v5.0 (Phantom Protocol): guided scan/WiFi wizards, first-run setup, log levels with audit trails, safer confirmations, and a refreshed status/installer experience.

Logging & Verbosity

  • Levels: DEBUG, INFO, WARN, ERROR, FATAL (set via NETREAPER_LOG_LEVEL or config).
  • Audit trail: ~/.netreaper/logs/audit_*.log records installs/runs.
  • Verbose mode: -v/--verbose or config VERBOSE=true.

Configuration

  • File: ~/.netreaper/config (auto-created on first run).
  • Edit interactively: netreaper config edit.
  • Show: netreaper config show; reset: netreaper config reset.

Wizards

  • First run wizard handles legal notice, verbose preference, and optional essentials install.
  • Scan wizard: netreaper wizard scan (target selection, scan type, timing, output).
  • WiFi wizard: netreaper wizard wifi (interface selection, attack type, confirmation).

Privilege Handling

  • Many WiFi/packet actions need root. The tool prompts with sudo and checks capability.
  • require_root prompts, run_privileged wraps commands with sudo when available.

Updated Command Examples

  • netreaper scan 192.168.1.0/24 --full
  • netreaper wizard scan
  • netreaper wifi --monitor wlan0
  • netreaper status --json
  • netreaper config show

Install & Prep

  1. Clone: git clone https://github.com/Nerds489/NETREAPER.git && cd NETREAPER.
  2. Install: sudo ./install.sh (adds netreaper and netreaper-install to PATH).
  3. Verify basics: netreaper --version and netreaper status.
  4. Recommended packages (for full wireless/graphics support): sudo apt install aircrack-ng wireshark hashcat hydra if your distro does not provide them via the installer.

First Run

netreaper
  • Accept the legal disclaimer on first launch.
  • Navigate the main menu: Recon, Wireless, Exploit, Stress, Tools, Intel, Credentials, Post-Exploit.
  • Use arrow keys/number input; q or Q exits.

Install the Arsenal

Choose what to install before heavier tasks:

  • Essentials (lean): sudo netreaper-install essentials
  • Full arsenal: sudo netreaper-install all
  • By category: sudo netreaper-install recon, sudo netreaper-install wireless, sudo netreaper-install exploit, sudo netreaper-install creds
  • Check status anytime: netreaper status or sudo netreaper-install status

Common Workflows

  1. Quick Recon of a subnet
netreaper scan 192.168.1.0/24 --quick
  • Uses nmap quick profile. Add --vuln for vuln scripts or run from menu [1] Recon.
  1. Full Recon + Service/Vuln sweep
netreaper scan 10.0.0.5 --full --vuln
  • Runs a comprehensive TCP scan with version detection and common NSE vulns.
  1. Wireless handshake capture and crack
netreaper wifi --monitor wlan0
netreaper crack handshake.cap --hashcat
  • Monitor mode is started/stopped automatically; outputs go to ~/.netreaper/output/.
  1. Credential brute force (SSH/HTTP)
  • Menu: Credentials -> Hydra/Medusa. Supply target, service, user/wordlists; NETREAPER builds the command and logs output.
  1. Stress/throughput test
  • Menu: Stress -> iperf3 for bandwidth testing or HTTP Load for ab-based tests. Use the guided prompts for duration, streams, and concurrency.
  1. Session management
netreaper session start
netreaper session resume <name>
netreaper session export
  • Sessions keep targets, outputs, and state across runs.

Sessions, Config, Logs

  • Config: ~/.netreaper/config (edit via netreaper config edit; view with netreaper config show).
  • Sessions: ~/.netreaper/sessions/ with per-session metadata.
  • Logs: ~/.netreaper/logs/ (timestamped). Review after each run to see exact commands executed.
  • Loot/output: ~/.netreaper/loot/ and ~/.netreaper/output/ for captures, creds, reports.

Exporting Results

  • Use netreaper session export (or the menu export option) to bundle logs, outputs, and summaries.
  • Many modules drop Markdown/CSV/JSON next to their raw outputs for reporting.

Safety Tips

  • Run invasive modules (wireless attacks, brute force, stress) only with written authorization.
  • Review the command previews shown before execution and read the corresponding log entries when testing new options.
  • Keep tool versions updated: sudo netreaper-install all to refresh, or update the script via wget .../netreaper -O netreaper && chmod +x netreaper if prompted.
  • Always verify interfaces: ip link, rfkill list before enabling monitor mode.