NetScan is a tool for automating and monitoring your own network. It runs ARP scans, port probes and (optionally) audits with nuclei. Only use it against networks and machines you own or are explicitly authorised to test.
- By default the API listens on
127.0.0.1with no authentication: it is only reachable from the machine itself. - If you expose it beyond localhost (
api_host: 0.0.0.0or similar), always setNETSCAN_API_TOKEN. Every HTTP endpoint and the WebSocket will then require it (X-API-Keyheader orAuthorization: Bearer). - Scans through the API only accept private networks (RFC 1918, loopback and link-local): the API cannot be used as an Internet scanning oracle.
- Secrets (Proxmox/TrueNAS/AdGuard tokens) must come from environment
variables, never be committed in
netscan.yaml(which is in.gitignore).
nmap, RustScan, nuclei, etc. are installed separately and invoked as processes.
scripts/install-nuclei.ps1 checks the binary's SHA256 against
ProjectDiscovery's official checksums before installing it. Some antivirus
products flag nuclei as a false positive (it is an auditing tool); if yours
quarantines it, NetScan works without it.
Do not open a public issue. Write to the maintainer through GitHub Security Advisories with a description of the problem, steps to reproduce it and the estimated impact. Receipt is acknowledged within 7 days.
| Version | Supported |
|---|---|
| main | ✅ |
| tags | latest only |