Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

Windows

Download from the latest GitHub release:

FileWhat it is
NetworkScope-<version>-setup.exeInno Setup installer
network-scope-<version>-windows-x64.zipPortable binaries
SHA256SUMSSHA-256 checksums of all release files

Verify a download in PowerShell:

Get-FileHash .\network-scope-0.5.1-windows-x64.zip -Algorithm SHA256

and compare the hash with the line in SHA256SUMS.

Installer

The installer installs per user by default (no administrator rights needed; the setup dialog lets you choose an all-users install). Optional tasks: a desktop shortcut and adding the install folder to your user PATH so network-scope-cli works from any shell. It installs network-scope.exe, network-scope-cli.exe, the README, third-party notices, the example scripts and the lab files.

The installer and binaries are not code-signed; Windows SmartScreen will warn. The installer script has not been compiled with iscc yet; the first release build is its first compile.

Portable

Unzip anywhere and run network-scope.exe (GUI) or network-scope-cli.exe (CLI).

Two executables

  • network-scope-cli.exe is a console-subsystem build: cmd.exe and PowerShell wait for it, and %ERRORLEVEL% / $LASTEXITCODE reflect the run (1 on error). Use it for scripting.
  • network-scope.exe is a GUI-subsystem program for double-click use. Started from a shell with arguments it attaches to the console and runs the command, but the shell does not wait for it and its exit code is not seen (workaround: Start-Process -Wait -NoNewWindow or | Out-Host). Redirected stdout/stderr stay redirected.

Without arguments both binaries open the desktop. On Linux and macOS both binaries are built and behave identically.

Preferences and the default SQLite database live in %LOCALAPPDATA%\NetworkScope.

Privileges

Most features need no administrator rights and no driver: TCP connect scanning, service, TLS and SMB detection, ICMP and ARP lookups through Windows APIs, UDP probes, inventory, reports, monitoring and pcap file analysis.

FeatureNeeds
SYN scan (--fast --syn)Npcap/libpcap, capture rights, --interface, --source-ip, --source-mac
ARP sweep (--fast --arp-sweep)Npcap/libpcap, capture rights, interface and source addresses
TCP traceroute (--trace-method tcp)Npcap/libpcap, capture rights, --fast
UDP traceroute (--trace-method udp)Administrator / root (raw ICMP socket), --fast
ICMPv6 traceroute on Linux/macOSroot (raw ICMPv6 socket)
Passive capture (listen, ot-listen --interface)Npcap/libpcap, capture rights
Profinet DCP Identify (dcp)Npcap/libpcap, capture rights, --source-mac

Npcap (Windows)

Install Npcap separately; it is under its own license and not bundled. Network Scope never installs drivers or requests elevation. If Npcap was installed with “Restrict Npcap driver’s access to Administrators only”, run Network Scope as administrator for capture features. Npcap’s dependent DLLs are loaded from the driver’s directory and Windows default trusted locations.

network-scope-cli interfaces lists the capture interfaces and their IDs. Source IPv4 and MAC values must match that interface.

If the driver or configuration is missing, a SYN scan falls back to TCP connect with the host note “SYN unavailable; TCP connect fallback: …”; the ARP sweep falls back to per-host lookups.

Linux and macOS

libpcap is loaded at run time from libpcap.A.dylib/libpcap.dylib (macOS) or libpcap.so.1/libpcap.so/libpcap.so.0.8 (Linux). ICMP uses an unprivileged datagram socket when the OS allows it and falls back to a raw socket (root). Run capture features as root; granting cap_net_raw,cap_net_admin with setcap should also work on Linux but is untested.

Linux and macOS binaries

Release archives network-scope-<version>-linux-x86_64.tar.gz and network-scope-<version>-macos-arm64.tar.gz contain network-scope and network-scope-cli. The Linux and macOS platform glue (routes, neighbor states, raw sockets) is not compiled on the development machine; CI is its first compile, and it has not been exercised on a real network.

Container image

Each release tag publishes the CLI as ghcr.io/sparkz400/network-scope:<version> and :latest (linux/amd64 only):

docker run --rm ghcr.io/sparkz400/network-scope:latest scan 192.168.1.0/24 --tcp-only
  • The entrypoint is network-scope-cli; without arguments the image prints the help.
  • The image runs as an unprivileged user (scanner, UID 10001). TCP connect scanning, service and TLS detection and UDP probes need nothing more.
  • Raw sockets, ICMP fallbacks, ARP and capture features (SYN, ARP sweep, listen, dcp, TCP/UDP traceroute) need --user root --cap-add NET_RAW (capture may additionally need --cap-add NET_ADMIN). A capability granted with --cap-add reaches a process running as root in the container; the unprivileged default user does not receive it. This combination has not been tested yet.
  • Use --network host (Linux) to see the local LAN directly; on the default bridge network ARP, neighbor discovery and capture only see the container’s own network.
  • Safe Mode is on by default inside the container as well.
  • The inventory database defaults to /data/NetworkScope/inventory.sqlite; mount a volume to keep it: -v network-scope:/data.
  • The runtime image contains libpcap (libpcap0.8t64) for capture features and CA certificates for HTTPS webhooks; the GUI libraries are not included and the desktop app does not run in the container.

Build the image yourself with docker build -t network-scope . from the repository root.

Verifying downloads and the image

Every release has three independent proofs of origin (details in SECURITY.md):

# GitHub artifact attestation (Sigstore-signed SLSA build provenance) for a release file
gh attestation verify network-scope-0.5.1-linux-x86_64.tar.gz --repo Sparkz400/network-scope

# SLSA level 3 provenance from slsa-github-generator (network-scope-<version>.intoto.jsonl)
slsa-verifier verify-artifact network-scope-0.5.1-linux-x86_64.tar.gz \
  --provenance-path network-scope-0.5.1.intoto.jsonl \
  --source-uri github.com/Sparkz400/network-scope --source-tag v0.5.1

# Container image
gh attestation verify oci://ghcr.io/sparkz400/network-scope:0.5.1 --owner Sparkz400

Build from source

Requires a current stable Rust toolchain (rustup).

git clone https://github.com/Sparkz400/network-scope
cd network-scope
cargo build --release --locked

The binaries are target/release/network-scope and target/release/network-scope-cli (.exe on Windows). cargo run --release starts the GUI; cargo run --release --bin network-scope-cli -- scan … runs the CLI.

Linux GUI build dependencies (Debian/Ubuntu):

sudo apt-get install libxkbcommon-dev libwayland-dev libx11-dev libgl1-mesa-dev \
  libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev

Windows installer from source

With Inno Setup 6:

cargo build --release --locked
iscc /DAppVersion=0.5.1 installer\network-scope.iss

writes dist\NetworkScope-0.5.1-setup.exe. Pass /DExePath=… and /DCliExePath=… for other build directories.

Shell completions

network-scope-cli completions powershell | Out-String | Invoke-Expression
source <(network-scope completions bash)

The scripts cover both binary names.