nscan 0.10.1

Cross-platform network scan tool for host and service discovery
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

[crates-badge]: https://img.shields.io/crates/v/nscan.svg
[crates-url]: https://crates.io/crates/nscan
[license-badge]: https://img.shields.io/crates/l/nscan.svg
[netscan-url]: https://github.com/shellrow/netscan

# nscan [![Crates.io][crates-badge]][crates-url] ![License][license-badge]
Cross-platform network scan tool for host and service discovery.   
Aim to be simple and fast.  

## Features
- Port Scan
- Host Scan
- Async Port Scan 
- Async Host Scan 
- Service detection
- OS detection

## Installation
### Cargo Install
```
cargo install nscan
```

## Basic Usage
```
USAGE:
    nscan [OPTIONS]

OPTIONS:
    -p, --port <target>          Scan ports of the specified host.
                                 Use default port list if port range omitted.
                                 Examples:
                                 --port 192.168.1.8 -S -O
                                 --port 192.168.1.8:1-1000
                                 --port 192.168.1.8:22,80,8080
                                 --port 192.168.1.8 -l custom-list.txt
    -n, --host <target>          Scan hosts in specified network or host-list.
                                 Examples:
                                 --host 192.168.1.0
                                 --host 192.168.1.0/24
                                 --host custom-list.txt
                                 --host 192.168.1.10,192.168.1.20,192.168.1.30
    -i, --interface <name>       Specify the network interface
    -s, --source <ip_addr>       Specify the source IP address
    -P, --protocol <protocol>    Specify the protocol
    -m, --maxhop <maxhop>        Set max hop(TTL) for ping or traceroute
    -T, --scantype <scantype>    Specify the scan-type
    -t, --timeout <duration>     Set timeout in ms - Example: -t 10000
    -w, --waittime <duration>    Set wait-time in ms (default:100ms) - Example: -w 200
    -r, --rate <duration>        Set send-rate in ms - Example: -r 1
    -c, --count <count>          Set number of requests or pings to be sent
    -S, --service                Enable service detection
    -O, --os                     Enable OS detection
    -A, --async                  Perform asynchronous scan
    -l, --list <file_path>       Use list - Example: -l custom-list.txt
    -W, --wellknown              Use well-known ports
    -o, --save <file_path>       Save scan result in json format - Example: -o result.json
        --acceptinvalidcerts     Accept invalid certs (This introduces significant vulnerabilities)
    -h, --help                   Print help information
    -V, --version                Print version information
```

## Supported platforms
- Linux
- macOS
- Windows

## Privileges
`nscan` uses a raw socket which require elevated privileges. Execute with administrator privileges.

## My related projects
This tool also serves as a test for my following projects.  
- [default-net](https://github.com/shellrow/default-net) Cross-platform library for network interface and gateway 
- [netscan](https://github.com/shellrow/netscan) Cross-platform network scan library 

## Additional Notes
Support for VM environments is in progress. Results may not be correct.