Horizontal42/netsleuth
1
0
Fork 0
mirror of https://github.com/Horizontal42/netsleuth.git synced 2026-11-10 15:42:10 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions
netsleuth/README.md

8.1 KiB
Raw Blame History

netsleuth

Русский

Cross-platform CLI for deep network diagnostics: who your ISP actually is, whether a VPN is really carrying your traffic, where the path degrades, and what your line actually delivers.

$ netsleuth --quick
netsleuth 0.1.0 · auto mode · Windows
Verdict: ok (100/100) — No problems found on this connection.
Report written to logs/report_AS64500_20260808T191200Z.md

Everything else — egress ASN, VPN verdict, latency, path, speed — lives in the report it just wrote, not on the console; the terminal only tells you the headline and where to look. By default that's a single English Markdown file; --format controls exactly which artifacts get written (see Handy things below).

Install

Requirements:

  • Python 3.10 or newer
  • Windows, Linux or macOS
  • Internet access (netsleuth is a network tool; it degrades gracefully but cannot do much offline)
  • Optional: the native Ookla speedtest binary on PATH for the best bandwidth tier
  • Optional: mtr on PATH for the best path data
git clone https://github.com/Horizontal42/netsleuth
cd netsleuth
uv sync
uv run netsleuth

Want --tcp-trace and --ndt7 too? They're optional extras, not installed by default:

uv sync --extra tcptrace --extra ndt7

Without uv:

python -m pip install -r requirements.txt
python -m pip install -e .
netsleuth

No configuration is required. Copy .env.example to .env only if you have optional API keys.

Getting the optional extras per platform

None of this is required — netsleuth degrades gracefully without any of it — but each optional tool is fetched differently depending on your OS:

  • uv itself: curl -LsSf https://astral.sh/uv/install.sh | sh on Linux/macOS; powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex" on Windows.
  • mtr (better path data): sudo apt install mtr (Debian/Ubuntu), sudo dnf install mtr (Fedora), sudo pacman -S mtr (Arch), brew install mtr (macOS). No Windows build exists — the traceroute cascade just skips this tier there and falls back to the Windows ICMP API automatically, no action needed.
  • Ookla speedtest (best bandwidth tier): install Ookla's own CLI binary from their official site or your OS package manager — not the unrelated community speedtest-cli Python package, netsleuth specifically shells out to Ookla's binary and parses its --format=json output.
  • Npcap/libpcap (only for the --tcp-trace extra): on Windows install Npcap; on Linux libpcap usually ships with the distro already, but sending raw packets as a non-root user needs sudo setcap cap_net_raw+eip $(readlink -f $(which python3)) (or just run under sudo); on macOS libpcap is built in but scapy still needs to run as root (sudo netsleuth --tcp-trace).

What it does

  • Identity — egress IPv4 and IPv6, reverse DNS, ASN, organisation, geo, and whether the address looks residential, mobile, hosting or business. Cross-checked across six independent providers so one rate limit does not blank the answer.
  • VPN / proxy assessment — a weighted verdict (none / likely / confirmed) built from tunnel interfaces, MTU anomalies, gateway-vs-egress mismatch, Cloudflare WARP flags, provider proxy/hosting flags, PeeringDB network type, timezone-vs-geo mismatch, and DNS resolver ASN mismatch.
  • DNS leak test — enumerates resolvers per network adapter, so it catches the classic case where the tunnel adapter is clean but the Wi-Fi adapter still holds the ISP resolver. Also detects EDNS Client Subnet leakage.
  • BGP intelligence — upstreams, peers, downstreams, announced prefixes, route stability, IXP presence, and CAIDA ASRank customer-cone size.
  • Reputation — locally cached FireHOL blocklists (no query leaves your machine), Shodan InternetDB exposure, and optional classic DNSBL zones.
  • Latency & path — per-host ping statistics with real jitter/loss/mdev, and a traceroute that never needs administrator rights.
  • Bandwidth — a cascading speedtest (Ookla binary → Cloudflare → fast.com → optional M-Lab NDT7) with separate download and upload bufferbloat grades.

Handy things

Flag What it does
--quick ~10 s express run: reference-host pings only, no speedtest
--full ~60–120 s: full speedtest and full MTR cycles
--target AS64500 / --target 64500 / --target 1.2.3.4 / --target example.com Investigate a specific network instead of your own connection — the AS prefix on a bare ASN is optional
--target-host <ip|domain> Add an extra host to the ping and traceroute fan-out
--speedtest-server <id|url> Pin the speedtest to a specific server
--watch Continuous monitoring with a live dashboard — for catching intermittent drops. Writes one logs/watch_*.json time series per session, not one report per tick
--compare a.json b.json Diff two earlier reports: before/after a VPN switch, before/after an ISP call. Read-only — no probing, no network calls. Reads reports produced with --format json
--dnsbl Opt in to classic DNSBL reputation zones
--ndt7 Opt in to M-Lab NDT7 (publishes your measurement, including your IP, as CC0 open data). On an interactive terminal it prints the consent notice and asks first; on a non-interactive one it proceeds without asking
--tcp-trace Opt in to a scapy TCP-SYN traceroute through ICMP-filtering middleboxes (needs the tcptrace extra plus Npcap on Windows or root on Unix). Falls through to the normal cascade when it cannot run
--format md,ru-md,json,all,none Choose which report artifacts to write (default: md). Repeatable and comma-separated (--format md,json); any use replaces the default instead of adding to it. all writes all three, none writes nothing. Ignored with --watch/--compare
--ru Shorthand for --format ru-md
--json Shorthand for --format json
--interface <name|ip> Force outbound probing (identity, BGP/reputation, latency, traceroute, speedtest) through this adapter instead of the OS default route — e.g. compare a VPN adapter against your raw connection. Accepts an adapter name or one of its IPs. Errors out immediately, listing every adapter, if the name doesn't resolve or the adapter is down; if it resolves but has no route to the internet, the run continues and reports that honestly rather than aborting. Windows' tracert has no IPv4 source-address option, so that one traceroute tier is skipped when forced (noted in the report) — every other backend, including the Windows ICMP API, honors it

Each run writes the selected artifacts into ./logs/: an English Markdown report, a full Russian translation of the same report (.ru.md, same sections, same tables, same numbers — cross-linked with the English one when both are written), and/or a JSON dump containing every raw provider response, untruncated. Default is the English Markdown report only; set output.formats in config.yaml to change the default permanently, or pass --format per run. ./logs/ is gitignored — reports contain your external IP, city, coordinates and ISP name.

netsleuth never requires administrator or root. Where privileges would give better data, it degrades to an unprivileged method and says so in the report.

For developers

Stack: Python 3.10+, Typer, Rich, httpx, pydantic-settings, dnspython, psutil, icmplib, ctypes.

uv sync --all-extras --group dev
uv run pytest -q
uv run netsleuth --quick
uv export --no-hashes --format requirements-txt -o requirements.txt   # after dependency changes

Architecture, data flow and the reasoning behind each provider choice: ARCHITECTURE.md.

Credits

netsleuth reads from RIPEstat, CAIDA ASRank, Team Cymru, PeeringDB, Cloudflare, ip-api.com, freeipapi.com, ipinfo.io, ipwho.is, Shodan InternetDB, the FireHOL blocklist project, Netflix fast.com and M-Lab. All of them are used within their free/keyless tiers.

License

PolyForm Noncommercial 1.0.0 — chosen because the default reputation sources (Shodan InternetDB, Spamhaus free mirrors) are non-commercial-use-only; this license keeps every downstream fork inside those same terms.