nmaprs 0.1.0

High-performance parallel network scanner with nmap-compatible CLI surface
Documentation
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
//! nmap-compatible CLI surface. Parsing accepts the union of `nmap --help` and Nmap’s `long_options`
//! table (`nmap.cc`); behavior parity is documented in README.

use clap::CommandFactory;
use clap::FromArgMatches;
use clap::Parser;
use std::path::PathBuf;

/// Parallel network scanner — nmap-compatible CLI (see README for parity).
#[derive(Parser, Debug)]
#[command(
    name = "nmaprs",
    version,
    author = "MenkeTechnologies",
    about = "NMAPRS // GRID SCANNER — rust-native parallel port probe",
    long_about = "TCP connect, UDP probes, ICMP ping scan (-sn), IPv6 (-6), -iL/-iR, resume, SYN (-sS) via raw IPv4 (privileged), `-A` (like Nmap: -O, -sV, default scripts, --traceroute), `-O` / `-sV` with optional `nmap-os-db` / `nmap-service-probes` under `--datadir`, and built-in scripts (not full Nmap NSE/Lua).",
    disable_help_flag = true,
    disable_version_flag = true,
    next_line_help = false
)]
pub struct Args {
    /// Print help (-h / --help).
    #[arg(short = 'h', long, global = true, action = clap::ArgAction::Help)]
    pub help: Option<bool>,

    /// Print version (-V).
    #[arg(short = 'V', long = "version", action = clap::ArgAction::Version)]
    pub version_req: Option<bool>,

    // --- Target specification ---
    #[arg(long = "iL", value_name = "FILE")]
    pub input_list: Option<PathBuf>,

    #[arg(long = "iR", value_name = "NUM")]
    pub random_targets: Option<u64>,

    #[arg(long = "exclude", value_name = "TARGETS")]
    pub exclude: Option<String>,

    #[arg(long = "excludefile", value_name = "FILE")]
    pub exclude_file: Option<PathBuf>,

    // --- Host discovery ---
    #[arg(long = "sL")]
    pub list_scan: bool,

    #[arg(long = "sn")]
    pub ping_only: bool,

    #[arg(long = "no-ping")]
    pub no_ping: bool,

    #[arg(long = "ping-S", num_args = 0..=1, value_name = "PORTLIST")]
    pub ping_syn: Option<Option<String>>,

    #[arg(long = "ping-A", num_args = 0..=1, value_name = "PORTLIST")]
    pub ping_ack: Option<Option<String>>,

    #[arg(long = "ping-U", num_args = 0..=1, value_name = "PORTLIST")]
    pub ping_udp: Option<Option<String>>,

    #[arg(long = "ping-Y", num_args = 0..=1, value_name = "PORTLIST")]
    pub ping_sctp: Option<Option<String>>,

    #[arg(long = "ping-E", action = clap::ArgAction::SetTrue)]
    pub ping_echo: bool,

    #[arg(long = "ping-P", action = clap::ArgAction::SetTrue)]
    pub ping_timestamp: bool,

    #[arg(long = "ping-M", action = clap::ArgAction::SetTrue)]
    pub ping_mask: bool,

    #[arg(long = "ping-ip-proto", num_args = 0..=1, value_name = "PROTOS")]
    pub ping_ip_proto: Option<Option<String>>,

    #[arg(short = 'n')]
    pub no_dns: bool,

    #[arg(short = 'R')]
    pub always_resolve: bool,

    #[arg(long = "dns-servers", value_name = "SERVERS")]
    pub dns_servers: Option<String>,

    #[arg(long = "system-dns")]
    pub system_dns: bool,

    #[arg(long = "traceroute")]
    pub traceroute: bool,

    // --- Scan techniques ---
    #[arg(long = "scan-type", value_name = "CHAR")]
    pub scan_type: Option<char>,

    #[arg(long = "scanflags", value_name = "FLAGS")]
    pub scanflags: Option<String>,

    #[arg(long = "sI", value_name = "ZOMBIE")]
    pub idle_scan: Option<String>,

    #[arg(long = "sO")]
    pub ip_proto_scan: bool,

    #[arg(short = 'b', value_name = "FTP")]
    pub ftp_bounce: Option<String>,

    // --- Version / script / OS ---
    #[arg(long = "version-scan")]
    pub version_scan: bool,

    #[arg(long = "script-default")]
    pub script_default: bool,

    #[arg(long = "script", value_name = "EXPR")]
    pub script: Option<String>,

    #[arg(long = "script-args", value_name = "ARGS")]
    pub script_args: Option<String>,

    #[arg(long = "script-args-file", value_name = "FILE")]
    pub script_args_file: Option<PathBuf>,

    #[arg(long = "script-trace")]
    pub script_trace: bool,

    #[arg(long = "script-updatedb")]
    pub script_updatedb: bool,

    #[arg(long = "script-help", value_name = "EXPR")]
    pub script_help: Option<String>,

    #[arg(long = "version-intensity", value_name = "0-9")]
    pub version_intensity: Option<u8>,

    #[arg(long = "version-light")]
    pub version_light: bool,

    #[arg(long = "version-all")]
    pub version_all: bool,

    #[arg(long = "version-trace")]
    pub version_trace: bool,

    #[arg(short = 'O')]
    pub os_detect: bool,

    #[arg(long = "osscan-limit")]
    pub osscan_limit: bool,

    #[arg(long = "osscan-guess")]
    pub osscan_guess: bool,

    // --- Ports ---
    #[arg(short = 'p', value_name = "PORTS")]
    pub ports: Option<String>,

    #[arg(long = "exclude-ports", value_name = "PORTS")]
    pub exclude_ports: Option<String>,

    #[arg(short = 'F')]
    pub fast: bool,

    #[arg(short = 'r')]
    pub sequential_ports: bool,

    #[arg(long = "top-ports", value_name = "N")]
    pub top_ports: Option<u16>,

    #[arg(long = "port-ratio", value_name = "RATIO")]
    pub port_ratio: Option<f64>,

    // --- Timing ---
    #[arg(long = "timing", value_name = "0-5")]
    pub timing: Option<u8>,

    #[arg(long = "min-hostgroup", value_name = "N")]
    pub min_hostgroup: Option<u32>,

    #[arg(long = "max-hostgroup", value_name = "N")]
    pub max_hostgroup: Option<u32>,

    #[arg(long = "min-parallelism", value_name = "N")]
    pub min_parallelism: Option<u32>,

    #[arg(short = 'M', long = "max-parallelism", value_name = "N")]
    pub max_parallelism: Option<u32>,

    #[arg(long = "min-rtt-timeout", value_name = "TIME")]
    pub min_rtt_timeout: Option<String>,

    #[arg(long = "max-rtt-timeout", value_name = "TIME")]
    pub max_rtt_timeout: Option<String>,

    #[arg(long = "initial-rtt-timeout", value_name = "TIME")]
    pub initial_rtt_timeout: Option<String>,

    #[arg(long = "max-retries", value_name = "N")]
    pub max_retries: Option<u32>,

    #[arg(long = "host-timeout", value_name = "TIME")]
    pub host_timeout: Option<String>,

    #[arg(long = "scan-delay", value_name = "TIME")]
    pub scan_delay: Option<String>,

    #[arg(long = "max-scan-delay", value_name = "TIME")]
    pub max_scan_delay: Option<String>,

    #[arg(long = "min-rate", value_name = "RATE")]
    pub min_rate: Option<u64>,

    #[arg(long = "max-rate", value_name = "RATE")]
    pub max_rate: Option<u64>,

    // --- Evasion / spoofing ---
    #[arg(short = 'f')]
    pub fragment: bool,

    #[arg(long = "mtu", value_name = "VAL")]
    pub mtu: Option<u16>,

    #[arg(short = 'D', value_name = "DECOYS")]
    pub decoys: Option<String>,

    #[arg(short = 'S', value_name = "ADDR")]
    pub spoof_source: Option<String>,

    #[arg(short = 'e', value_name = "IFACE")]
    pub interface: Option<String>,

    #[arg(short = 'g', long = "source-port", value_name = "PORT")]
    pub source_port: Option<u16>,

    #[arg(long = "proxies", visible_alias = "proxy", value_name = "URLS")]
    pub proxies: Option<String>,

    #[arg(long = "data", value_name = "HEX")]
    pub data_hex: Option<String>,

    #[arg(long = "data-string", value_name = "STR")]
    pub data_string: Option<String>,

    #[arg(long = "data-length", value_name = "NUM")]
    pub data_length: Option<u32>,

    #[arg(long = "ip-options", value_name = "OPTS")]
    pub ip_options: Option<String>,

    #[arg(long = "ttl", value_name = "VAL")]
    pub ttl: Option<u8>,

    #[arg(long = "spoof-mac", value_name = "MAC")]
    pub spoof_mac: Option<String>,

    #[arg(long = "badsum")]
    pub badsum: bool,

    // --- Output ---
    #[arg(long = "oN", value_name = "FILE")]
    pub output_normal: Option<PathBuf>,

    #[arg(long = "oX", value_name = "FILE")]
    pub output_xml: Option<PathBuf>,

    #[arg(long = "oS", value_name = "FILE")]
    pub output_script_kiddie: Option<PathBuf>,

    #[arg(long = "oG", value_name = "FILE")]
    pub output_grepable: Option<PathBuf>,

    #[arg(long = "oA", value_name = "BASE")]
    pub output_all: Option<PathBuf>,

    /// Machine-parseable output (Nmap `-oM`; same line family as `-oG` in nmaprs).
    #[arg(long = "oM", value_name = "FILE")]
    pub output_machine: Option<PathBuf>,

    /// Hex dump output (Nmap `-oH`; reserved — file opened when set, minimal placeholder).
    #[arg(long = "oH", value_name = "FILE")]
    pub output_hex: Option<PathBuf>,

    #[arg(long = "verbosity", value_name = "N", default_value = "0")]
    pub verbosity: u8,

    #[arg(long = "debug", value_name = "N", default_value = "0")]
    pub debug: u8,

    #[arg(long = "reason")]
    pub reason: bool,

    #[arg(long = "open")]
    pub open_only: bool,

    #[arg(long = "packet-trace")]
    pub packet_trace: bool,

    #[arg(long = "iflist")]
    pub iflist: bool,

    #[arg(long = "append-output")]
    pub append_output: bool,

    #[arg(long = "resume", value_name = "FILE")]
    pub resume: Option<PathBuf>,

    #[arg(long = "noninteractive")]
    pub noninteractive: bool,

    #[arg(long = "stylesheet", value_name = "PATH")]
    pub stylesheet: Option<String>,

    #[arg(long = "webxml")]
    pub webxml: bool,

    #[arg(long = "no-stylesheet")]
    pub no_stylesheet: bool,

    // --- Misc ---
    #[arg(short = '6')]
    pub ipv6: bool,

    /// Aggressive scan (Nmap `-A`): enables `-O`, `-sV`, default scripts (`-sC`), and `--traceroute`.
    #[arg(short = 'A')]
    pub aggressive: bool,

    #[arg(long = "datadir", value_name = "DIR")]
    pub datadir: Option<PathBuf>,

    #[arg(long = "send-eth")]
    pub send_eth: bool,

    #[arg(long = "send-ip")]
    pub send_ip: bool,

    #[arg(long = "privileged")]
    pub privileged: bool,

    #[arg(long = "unprivileged")]
    pub unprivileged: bool,

    // --- Extended options (see Nmap `nmap.cc` / man page; not all in `nmap --help`) ---
    #[arg(long = "resolve-all")]
    pub resolve_all: bool,

    #[arg(long = "max-os-tries", value_name = "N")]
    pub max_os_tries: Option<u8>,

    #[arg(long = "defeat-rst-ratelimit")]
    pub defeat_rst_ratelimit: bool,

    #[arg(long = "defeat-icmp-ratelimit")]
    pub defeat_icmp_ratelimit: bool,

    #[arg(long = "randomize-hosts")]
    pub randomize_hosts: bool,

    /// Alias for `--randomize-hosts` (Nmap compatibility).
    #[arg(long = "rH")]
    pub r_h: bool,

    #[arg(long = "stats-every", value_name = "TIME")]
    pub stats_every: Option<String>,

    #[arg(long = "nsock-engine", value_name = "NAME")]
    pub nsock_engine: Option<String>,

    #[arg(long = "discovery-ignore-rst")]
    pub discovery_ignore_rst: bool,

    /// Same as `--osscan-guess` (Nmap `--fuzzy`).
    #[arg(long = "fuzzy")]
    pub fuzzy: bool,

    #[arg(long = "unique")]
    pub unique: bool,

    #[arg(long = "log-errors")]
    pub log_errors: bool,

    #[arg(long = "deprecated-xml-osclass")]
    pub deprecated_xml_osclass: bool,

    #[arg(long = "adler32")]
    pub adler32: bool,

    #[arg(long = "disable-arp-ping")]
    pub disable_arp_ping: bool,

    #[arg(long = "route-dst", value_name = "HOST")]
    pub route_dst: Option<String>,

    #[arg(long = "servicedb", value_name = "FILE")]
    pub servicedb: Option<PathBuf>,

    #[arg(long = "versiondb", value_name = "FILE")]
    pub versiondb: Option<PathBuf>,

    #[arg(long = "release-memory")]
    pub release_memory: bool,

    #[arg(long = "nogcc")]
    pub nogcc: bool,

    #[arg(long = "allports")]
    pub allports: bool,

    #[arg(long = "script-timeout", value_name = "TIME")]
    pub script_timeout: Option<String>,

    #[arg(long = "thc")]
    pub thc: bool,

    /// Nmap hidden alias: extra verbosity (equivalent to `-vv` increment).
    #[arg(long = "vv")]
    pub vv: bool,

    /// Nmap hidden alias: extra debug (equivalent to `-dd` increment).
    #[arg(long = "ff")]
    pub ff: bool,

    /// Trailing targets (hostnames, IPs, CIDR, nmap-style ranges).
    #[arg(value_name = "TARGET")]
    pub targets: Vec<String>,
}

impl Args {
    pub fn parse_from_env() -> Self {
        let raw: Vec<String> = std::env::args().collect();
        let expanded = crate::argv_expand::expand_nmap_style_argv(raw);
        let bin = expanded
            .first()
            .map(|p| {
                std::path::Path::new(p)
                    .file_name()
                    .and_then(|s| s.to_str())
                    .unwrap_or("nmaprs")
            })
            .unwrap_or("nmaprs")
            .to_string();

        let mut cmd = Self::command();
        cmd = cmd.bin_name(&bin).name(&bin);

        match cmd.try_get_matches_from(expanded) {
            Ok(matches) => Self::from_arg_matches(&matches).expect("nmaprs CLI parse"),
            Err(err) => {
                use clap::error::ErrorKind;
                match err.kind() {
                    ErrorKind::DisplayHelp
                    | ErrorKind::DisplayHelpOnMissingArgumentOrSubcommand => {
                        crate::help_tp::print_help(&bin);
                        std::process::exit(0);
                    }
                    ErrorKind::DisplayVersion => {
                        crate::help_tp::print_version(&bin);
                        std::process::exit(0);
                    }
                    _ => err.exit(),
                }
            }
        }
    }

    pub fn effective_verbosity(&self) -> u8 {
        self.verbosity.saturating_add(if self.vv { 2 } else { 0 })
    }

    pub fn effective_debug(&self) -> u8 {
        self.debug.saturating_add(if self.ff { 2 } else { 0 })
    }

    pub fn effective_randomize_hosts(&self) -> bool {
        self.randomize_hosts || self.r_h
    }

    pub fn effective_osscan_guess(&self) -> bool {
        self.osscan_guess || self.fuzzy
    }
}