Refactored scanner struct for accessibility, fixed macros

Author: bergabman

src/input.rs

@@ -71,9 +71,9 @@ pub struct Opts {
     #[structopt(short, long)]
     pub no_config: bool,
 
-    /// Quiet mode. Only output the ports. No Nmap. Useful for grep or outputting to a file.
+    /// Greppable mode. Only output the ports. No Nmap. Useful for grep or outputting to a file.
     #[structopt(short, long)]
-    pub quiet: bool,
+    pub greppable: bool,
 
     /// Accessible mode. Turns off features which negatively affect screen readers.
     #[structopt(long)]
@@ -151,7 +151,7 @@ impl Opts {
             }
         }
 
-        merge_required!(addresses, quiet, accessible, batch_size, timeout, scan_order, command);
+        merge_required!(addresses, greppable, accessible, batch_size, timeout, scan_order, command);
     }
 
     fn merge_optional(&mut self, config: &Config) {
@@ -188,7 +188,7 @@ pub struct Config {
     addresses: Option<Vec<String>>,
     ports: Option<HashMap<String, u16>>,
     range: Option<PortRange>,
-    quiet: Option<bool>,
+    greppable: Option<bool>,
     accessible: Option<bool>,
     batch_size: Option<u16>,
     timeout: Option<u32>,
@@ -210,12 +210,6 @@ impl Config {
     /// scan_order: "Serial"
     ///
     pub fn read() -> Self {
-        let mut config_dir = match dirs::config_dir() {
-            Some(dir) => dir,
-            None => panic!("Could not infer config file path."),
-        };
-        config_dir.push("rustscan");
-        config_dir.push("config.toml");
 
         let mut home_dir = match dirs::home_dir() {
             Some(dir) => dir,
@@ -231,13 +225,6 @@ impl Config {
             }
         }
 
-        if config_dir.exists() && content == String::new() {
-            content = match fs::read_to_string(config_dir) {
-                Ok(content) => content,
-                Err(_) => String::new(),
-            }
-        }
-
         let config: Config = match toml::from_str(&content) {
             Ok(config) => config,
             Err(e) => {
@@ -260,7 +247,7 @@ mod tests {
             addresses: vec![],
             ports: None,
             range: None,
-            quiet: false,
+            greppable: false,
             batch_size: 0,
             timeout: 0,
             ulimit: None,
@@ -276,7 +263,7 @@ mod tests {
             addresses: Some(vec!["127.0.0.1".to_owned()]),
             ports: None,
             range: None,
-            quiet: Some(true),
+            greppable: Some(true),
             batch_size: Some(25_000),
             timeout: Some(1_000),
             ulimit: None,
@@ -289,7 +276,7 @@ mod tests {
         opts.merge(&config);
 
         assert_eq!(opts.addresses, vec![] as Vec<String>);
-        assert_eq!(opts.quiet, false);
+        assert_eq!(opts.greppable, false);
         assert_eq!(opts.accessible, false);
         assert_eq!(opts.timeout, 0);
         assert_eq!(opts.command, vec![] as Vec<String>);
@@ -302,7 +289,7 @@ mod tests {
             addresses: vec![],
             ports: None,
             range: None,
-            quiet: false,
+            greppable: false,
             batch_size: 0,
             timeout: 0,
             ulimit: None,
@@ -319,7 +306,7 @@ mod tests {
             ports: None,
             no_nmap: Some(false),
             range: None,
-            quiet: Some(true),
+            greppable: Some(true),
             batch_size: Some(25_000),
             timeout: Some(1_000),
             ulimit: None,
@@ -331,7 +318,7 @@ mod tests {
         opts.merge_required(&config);
 
         assert_eq!(opts.addresses, config.addresses.unwrap());
-        assert_eq!(opts.quiet, config.quiet.unwrap());
+        assert_eq!(opts.greppable, config.greppable.unwrap());
         assert_eq!(opts.timeout, config.timeout.unwrap());
         assert_eq!(opts.command, config.command.unwrap());
         assert_eq!(opts.accessible, config.accessible.unwrap());
@@ -344,7 +331,7 @@ mod tests {
             addresses: vec![],
             ports: None,
             range: None,
-            quiet: false,
+            greppable: false,
             batch_size: 0,
             timeout: 0,
             ulimit: None,
@@ -363,7 +350,7 @@ mod tests {
                 start: 1,
                 end: 1_000,
             }),
-            quiet: None,
+            greppable: None,
             batch_size: None,
             timeout: None,
             no_nmap: Some(false),

src/main.rs

@@ -50,14 +50,14 @@ fn main() {
 
     debug!("Main() `opts` arguments are {:?}", opts);
 
-    if !opts.quiet && !opts.accessible {
-        print_opening();
+    if !opts.greppable && !opts.accessible {
+        print_opening(&opts);
     }
 
     let ips: Vec<IpAddr> = parse_addresses(&opts);
 
     if ips.is_empty() {
-        warning!("No IPs could be resolved, aborting scan.", false);
+        warning!("No IPs could be resolved, aborting scan.", opts.greppable, opts.accessible);
         std::process::exit(1);
     }
 
@@ -68,8 +68,9 @@ fn main() {
         &ips,
         batch_size,
         Duration::from_millis(opts.timeout.into()),
-        opts.quiet,
+        opts.greppable,
         PortStrategy::pick(opts.range, opts.ports, opts.scan_order),
+        opts.accessible,
     );
     debug!("Scanner finished building: {:?}", scanner);
 
@@ -101,23 +102,22 @@ fn main() {
         ip,
         opts.batch_size,
         "'rustscan -b <batch_size> <ip address>'");
-        warning!(x, opts.quiet);
+        warning!(x, opts.greppable, opts.accessible);
     }
 
     let mut nmap_bench = NamedTimer::start("Nmap");
     for (ip, ports) in ports_per_ip.iter_mut() {
         let nmap_str_ports: Vec<String> = ports.into_iter().map(|port| port.to_string()).collect();
 
-        detail!("Starting Nmap", opts.quiet || opts.no_nmap);
-
         // nmap port style is 80,443. Comma separated with no spaces.
         let ports_str = nmap_str_ports.join(",");
 
         // if quiet mode is on nmap should not be spawned
-        if opts.quiet || opts.no_nmap {
+        if opts.greppable || opts.no_nmap {
             println!("{} -> [{}]", &ip, ports_str);
             continue;
         }
+        detail!("Starting Nmap", opts.greppable, opts.accessible);
 
         let addr = ip.to_string();
         let user_nmap_args =
@@ -127,7 +127,7 @@ fn main() {
         output!(format!(
             "The Nmap command to be run is nmap {}\n",
             &nmap_args.join(" ")
-        ));
+        ), opts.greppable.clone(), opts.accessible.clone());
 
         // Runs the nmap command and spawns it as a process.
         let mut child = Command::new("nmap")
@@ -148,7 +148,7 @@ fn main() {
 }
 
 /// Prints the opening title of RustScan
-fn print_opening() {
+fn print_opening(opts: &Opts) {
     debug!("Printing opening");
     let s = r#".----. .-. .-. .----..---.  .----. .---.   .--.  .-. .-.
 | {}  }| { } |{ {__ {_   _}{ {__  /  ___} / {} \ |  `| |
@@ -163,23 +163,16 @@ Faster Nmap scanning with Rust."#;
     println!("{}", info.gradient(Color::Yellow).bold());
     funny_opening!();
 
-    let mut config_dir = match dirs::config_dir() {
-        Some(dir) => dir,
-        None => panic!("Could not infer config file path."),
-    };
-    config_dir.push("rustscan");
-    config_dir.push("config.toml");
-
     let mut home_dir = match dirs::home_dir() {
         Some(dir) => dir,
         None => panic!("Could not infer config file path."),
     };
     home_dir.push(".rustscan.toml");
 
     detail!(format!(
-        "The config file is expected to be at {:?} or {:?}",
-        config_dir, home_dir
-    ));
+        "The config file is expected to be at {:?}",
+        home_dir
+    ), opts.greppable, opts.accessible);
 }
 #[cfg(not(tarpaulin_include))]
 fn build_nmap_arguments<'a>(
@@ -212,7 +205,7 @@ fn parse_addresses(opts: &Opts) -> Vec<IpAddr> {
                 Ok(mut iter) => ips.push(iter.nth(0).unwrap().ip()),
                 _ => {
                     let failed_to_resolve = format!("Host {:?} could not be resolved.", ip_or_host);
-                    warning!(failed_to_resolve, opts.quiet);
+                    warning!(failed_to_resolve, opts.greppable, opts.accessible);
                 }
             },
         }
@@ -229,7 +222,7 @@ fn adjust_ulimit_size(opts: &Opts) -> rlimit::rlim {
             Ok(_) => {
                 detail!(
                     format!("Automatically increasing ulimit value to {}.", limit),
-                    opts.quiet
+                    opts.greppable, opts.accessible
                 );
             }
             Err(_) => println!("{}", "ERROR. Failed to set ulimit value."),
@@ -247,7 +240,7 @@ fn infer_batch_size(opts: &Opts, ulimit: rlimit::rlim) -> u16 {
     // Adjust the batch size when the ulimit value is lower than the desired batch size
     if ulimit < batch_size {
         warning!("File limit is lower than default batch size. Consider upping with --ulimit. May cause harm to sensitive servers",
-            opts.quiet
+            opts.greppable, opts.accessible
         );
 
         // When the OS supports high file limits like 8000, but the user
@@ -273,7 +266,7 @@ fn infer_batch_size(opts: &Opts, ulimit: rlimit::rlim) -> u16 {
         detail!(format!(
                 "File limit higher than batch size. Can increase speed by increasing batch size '-b {}'.",
                 ulimit - 100
-            ), opts.quiet);
+            ), opts.greppable, opts.accessible);
     }
 
     batch_size as u16
@@ -292,7 +285,7 @@ mod tests {
             addresses: vec!["127.0.0.1".to_owned()],
             ports: None,
             range: None,
-            quiet: true,
+            greppable: true,
             batch_size: 50_000,
             timeout: 1_000,
             ulimit: Some(2_000),
@@ -314,7 +307,7 @@ mod tests {
             addresses: vec!["127.0.0.1".to_owned()],
             ports: None,
             range: None,
-            quiet: true,
+            greppable: true,
             batch_size: 50_000,
             timeout: 1_000,
             ulimit: Some(2_000),
@@ -337,7 +330,7 @@ mod tests {
             addresses: vec!["127.0.0.1".to_owned()],
             ports: None,
             range: None,
-            quiet: true,
+            greppable: true,
             batch_size: 50_000,
             timeout: 1_000,
             ulimit: Some(2_000),
@@ -359,7 +352,7 @@ mod tests {
             addresses: vec!["127.0.0.1".to_owned()],
             ports: None,
             range: None,
-            quiet: true,
+            greppable: true,
             batch_size: 50_000,
             timeout: 1_000,
             ulimit: Some(2_000),
@@ -376,8 +369,23 @@ mod tests {
     }
     #[test]
     fn test_print_opening_no_panic() {
+        let opts = Opts {
+            addresses: vec!["127.0.0.1".to_owned()],
+            ports: None,
+            range: None,
+            greppable: true,
+            batch_size: 50_000,
+            timeout: 1_000,
+            ulimit: Some(2_000),
+            command: Vec::new(),
+            accessible: false,
+            scan_order: ScanOrder::Serial,
+            no_config: false,
+            no_nmap: false,
+            top: false,
+        };
         // print opening should not panic
-        print_opening();
+        print_opening(&opts);
         assert!(1 == 1);
     }
     #[test]
@@ -386,7 +394,7 @@ mod tests {
             addresses: vec!["127.0.0.1".to_owned()],
             ports: None,
             range: None,
-            quiet: false,
+            greppable: false,
             batch_size: 10,
             timeout: 1_000,
             ulimit: None,
@@ -409,7 +417,7 @@ mod tests {
             addresses: vec!["127.0.0.1".to_owned(), "192.168.0.0/30".to_owned()],
             ports: None,
             range: None,
-            quiet: true,
+            greppable: true,
             batch_size: 10,
             timeout: 1_000,
             ulimit: Some(2_000),
@@ -440,7 +448,7 @@ mod tests {
             addresses: vec!["google.com".to_owned()],
             ports: None,
             range: None,
-            quiet: true,
+            greppable: true,
             batch_size: 10,
             timeout: 1_000,
             ulimit: Some(2_000),
@@ -462,7 +470,7 @@ mod tests {
             addresses: vec!["127.0.0.1".to_owned(), "im_wrong".to_owned()],
             ports: None,
             range: None,
-            quiet: true,
+            greppable: true,
             batch_size: 10,
             timeout: 1_000,
             ulimit: Some(2_000),
@@ -484,7 +492,7 @@ mod tests {
             addresses: vec!["im_wrong".to_owned(), "300.10.1.1".to_owned()],
             ports: None,
             range: None,
-            quiet: true,
+            greppable: true,
             batch_size: 10,
             timeout: 1_000,
             ulimit: Some(2_000),