[crates-badge]: https://img.shields.io/crates/v/nrev.svg
[crates-url]: https://crates.io/crates/nrev
# nrev [![Crates.io][crates-badge]][crates-url]
Cross-platform Network Mapper.
Designed to be used in network scan, mapping and probes.
## Features
- Port Scan
- Host Scan
- Ping
- Traceroute
- Neighbor Discovery
- Subdomain scan
## Supported platforms
- Linux
- macOS
- Windows
## Installation
### Install prebuilt binaries via shell script
```sh
### Install prebuilt binaries via powershell script
```sh
### From Releases
You can download archives of precompiled binaries from the [releases](https://github.com/shellrow/nrev/releases) .
### Cargo
If you have Rust and the Cargo package manager installed on your system, you can install (download and build) `nrev` with the following command:
```
cargo install nrev
```
Or you can use [binstall](https://github.com/cargo-bins/cargo-binstall) for install nrev from github release.
```
cargo binstall nrev
```
## Basic Usage
### Port Scan Example
To scan the default 1000 ports on a target, simply specify the target (-s for service detection, -o for OS detection)
```
nrev port yourcorpone.com -s -o
nrev port 192.168.1.10 -s -o
```
### Sub-commands and Options
```
Usage: nrev [OPTIONS] <COMMAND>
Commands:
port Scan ports on the target(s) (TCP/QUIC)
host Discover alive hosts (ICMP/UDP/TCP etc.)
ping Simple ping (ICMP/UDP/TCP)
trace Traceroute (UDP)
nei Neighbor discovery (ARP/NDP)
domain Subdomain enumeration
interface Show network interface(s)
help Print this message or the help of the given subcommand(s)
Options:
--log-level <LOG_LEVEL> Global log level [default: info] [possible values: error, warn, info, debug, trace]
--log-file Log to file (in addition to stdout)
--log-file-path <FILE> Log file path (default: ~/.nrev/logs/nrev.log)
--quiet Suppress all log output (only errors are shown)
-o, --output <FILE> Save output to file (JSON format)
--no-stdout Suppress stdout console output (only save to file if -o is set)
-h, --help Print help
-V, --version Print version
```
See `nrev <sub-command> -h` for more detail.
## Examples
### Port scan
Scan default 1000 ports and enable service and OS detection for open ports
```
nrev port yourcorpone.com -s -o
```
Specify the ports
```
nrev port yourcorpone.com --ports 22,80,443,5000,8080
```
Specify the range
```
nrev port yourcorpone.com --ports 20-100
```
#### Settings
By default, nrev determines the connection timeout or waiting time until packet reception (before concluding the scan task) based on the results of the initial PING.
The initial PING is executed in the order of ICMP Ping, UDP Ping, TCP Ping, and if successful, proceeds to the next scan task.
If all PING attempts fail, nrev exits before executing the scan. This step can be skipped by setting the `--noping` flag.
For other settings, please refer to `nrev port -h` for details.
### Host scan
ICMP Host scan
```
nrev host 192.168.1.0/24
```
```
nrev host /path/to/list/hostlist.txt
```
TCP Host scan
```
nrev host 192.168.1.0/24 --proto tcp --ports 80
```
### Ping
Default ICMP Ping
```
nrev ping 1.1.1.1 -c 4
```
UDP Ping
```
nrev ping 1.1.1.1 --proto udp
```
TCP Ping
```
nrev ping 1.1.1.1 --proto tcp --port 80
```
### Traceroute
UDP Trace
```
nrev trace 8.8.8.8
```
You can specify the interval in milliseconds for faster trace.
```
nrev trace 8.8.8.8 --interval-ms 500
```
### Subdomain scan
```
nrev subdomain yourcorpone.com --wordlist /path/to/wordlist/top-1000.txt
```
### Neighbor (ARP/NDP)
```
nrev nei 192.168.1.1
```
### Specify the network interface
```
nrev port 10.10.11.14 --interface tun0
```
## Privileges
`nrev` uses a raw socket which require elevated privileges. Execute with administrator privileges.
### Note for Linux Users
`nrev` requires elevated privileges to send/receive raw-packet. On Linux, you can configure these privileges using two main methods:
#### 1. Using `setcap`
Granting capabilities to the `nrev` binary allows it to operate with the necessary privileges without requiring `sudo` for each execution.
This method is recommended for single-user machines or in environments where all users are trusted.
Assign necessary capabilities to the nrev binary
```sh
sudo setcap 'cap_sys_ptrace,cap_dac_read_search,cap_net_raw,cap_net_admin+ep' $(command -v nrev)
```
Run nrev as an unprivileged user:
```sh
nrev
```
#### Capabilities Explained:
- `cap_sys_ptrace,cap_dac_read_search`: Allows `nrev` to access `/proc/<pid>/fd/` to identify which open port belongs to which process.
- `cap_net_raw,cap_net_admin`: Enables packet capturing capabilities.
#### 2. Using `sudo` (for multi-user environments)
For environments with multiple users, requiring privilege escalation each time nrev is run can enhance security.
```
sudo nrev
```
### Note for macOS Users
On macOS, managing access to the Berkeley Packet Filter (BPF) devices is necessary for `nrev` to send/receive raw-packet
Alternatively, of course, you can also use `sudo` to temporarily grant the necessary permissions.
#### Install `chmod-bpf` to automatically manage permissions for BPF devices:
Install prebuilt binaries via shell script
```
Install prebuilt binaries via Homebrew
```sh
brew install shellrow/tap-chmod-bpf/chmod-bpf
```
#### Check BPF device permissions
```
chmod-bpf check
```
#### Install the chmod-bpf daemon to automatically manage BPF device permissions
```
sudo chmod-bpf install
```
### Note for Windows Users
- Ensure that you have [Npcap](https://npcap.com/#download) installed, which is necessary for `nrev` to send/receive raw-packet on Windows
- Download and install Npcap from [Npcap](https://npcap.com/#download). Choose the "Install Npcap in WinPcap API-compatible Mode" during installation.
- Build Dependencies:
- Place the Packet.lib file from the [Npcap SDK](https://npcap.com/#download) or WinPcap Developers pack in a directory named lib at the root of this repository.
- You can use any of the locations listed in the %LIB% or $Env:LIB environment variables.
- For the 64-bit toolchain, the Packet.lib is located in <SDK>/Lib/x64/Packet.lib.
- For the 32-bit toolchain, the Packet.lib is located in <SDK>/Lib/Packet.lib.