Added more boundary tests for scanners mod.rs

* Added DNS lookup using Google DNS, refactored IP code

* fixed comments & cargo fmt

* Fixed code review comments, added tests, removed unwrap() panics

* Added assertion to test

.all-contributorsrc

@@ -193,6 +193,15 @@
         "bug",
         "design"
       ]
+    },
+    {
+      "login": "dmitris",
+      "name": "Dmitry Savintsev",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/31205?v=4",
+      "profile": "https://github.com/dmitris",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.gitignore

@@ -118,6 +118,5 @@ fabric.properties
 .idea/caches/build_file_checksums.ser
 
 .idea/*
-.idea*
 .idea
-
+.idea*

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rustscan"
-version = "1.9.0"
+version = "1.10.0"
 authors = ["Bee <[email protected]>"]
 edition = "2018"
 description = "Faster Nmap Scanning with Rust"
@@ -18,7 +18,7 @@ exclude = [
 
 [dependencies]
 colored = "2.0.0"
-structopt = "0.3.17"
+structopt = "0.3.18"
 async-std = "1.6.4"
 futures = "0.3"
 rlimit = "0.4.0"
@@ -35,6 +35,8 @@ serde = "1.0.116"
 serde_derive = "1.0.116"
 cidr-utils = "0.5.0"
 itertools = "0.9.0"
+trust-dns-resolver = { version = "0.19.5"}
+criterion = "0.3"
 
 [package.metadata.deb]
 depends = "$auto, nmap"
@@ -43,3 +45,7 @@ section = "rust"
 [profile.release]
 lto = true
 panic = 'abort'
+
+[[bench]]
+name = "main"
+harness = false

Dockerfile

@@ -1,8 +1,11 @@
 FROM rust:alpine as builder
+LABEL maintainer="CMNatic <https://github.com/CMNatic">
 RUN apk add --no-cache build-base
 
+# Encourage some layer caching here rather then copying entire directory that includes docs to builder container ~CMN
 WORKDIR /usr/src/rustscan
-COPY . .
+COPY Cargo.toml Cargo.lock ./
+COPY src src
 RUN cargo install --path .
 
 FROM alpine:3.12
@@ -13,4 +16,4 @@ RUN addgroup -S rustscan && \
     apk add --no-cache nmap nmap-scripts wget
 COPY --from=builder /usr/local/cargo/bin/rustscan /usr/local/bin/rustscan
 USER rustscan
-ENTRYPOINT [ "/usr/local/bin/rustscan" ]
+ENTRYPOINT [ "/usr/local/bin/rustscan" ]

README.md

@@ -427,7 +427,7 @@ Please read the [contributing.md file](contributing.md)
 ## Contributors ✨
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-19-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-20-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
@@ -460,6 +460,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <td align="center"><a href="https://liberapay.com/Artem4/"><img src="https://avatars0.githubusercontent.com/u/5614476?v=4" width="100px;" alt=""/><br /><sub><b>Artem Polishchuk</b></sub></a><br /><a href="#platform-tim77" title="Packaging/porting to new platform">📦</a></td>
     <td align="center"><a href="https://github.com/buermarc"><img src="https://avatars2.githubusercontent.com/u/44375277?v=4" width="100px;" alt=""/><br /><sub><b>buermarc</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=buermarc" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/bergabman"><img src="https://avatars1.githubusercontent.com/u/44554109?v=4" width="100px;" alt=""/><br /><sub><b>bergabman</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=bergabman" title="Code">💻</a> <a href="https://github.com/RustScan/RustScan/issues?q=author%3Abergabman" title="Bug reports">🐛</a> <a href="#design-bergabman" title="Design">🎨</a></td>
+    <td align="center"><a href="https://github.com/dmitris"><img src="https://avatars0.githubusercontent.com/u/31205?v=4" width="100px;" alt=""/><br /><sub><b>Dmitry Savintsev</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=dmitris" title="Code">💻</a></td>
   </tr>
 </table>
 

benches/main.rs

@@ -0,0 +1,9 @@
+use criterion::{black_box, criterion_group, criterion_main, Criterion};
+use rustscan::*;
+
+pub fn criterion_benchmark(c: &mut Criterion) {
+    c.bench_function("fib 20", |b| b.iter(|| fibonacci(black_box(20))));
+}
+
+criterion_group!(benches, criterion_benchmark);
+criterion_main!(benches);

fixtures/hosts.txt

@@ -0,0 +1,6 @@
+127.0.0.1
+google.com
+example.com
+66666666666666.666666666666666666.66666666666666666.6666666666
+....
+e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.radiatorFixtures

src/input.rs

@@ -1,7 +1,6 @@
 use serde_derive::Deserialize;
 use std::collections::HashMap;
 use std::fs;
-use std::path::PathBuf;
 use structopt::{clap::arg_enum, StructOpt};
 
 const LOWEST_PORT_NUMBER: u16 = 1;
@@ -106,10 +105,6 @@ pub struct Opts {
     #[structopt(long, possible_values = &ScanOrder::variants(), case_insensitive = true, default_value = "serial")]
     pub scan_order: ScanOrder,
 
-    /// Input file containing IP addresses delimited by new lines
-    #[structopt(short, long)]
-    pub input: Option<PathBuf>,
-
     /// The Nmap arguments to run.
     /// To use the argument -A, end RustScan's args with '-- -A'.
     /// Example: 'rustscan -T 1500 127.0.0.1 -- -A -sC'.
@@ -203,7 +198,6 @@ pub struct Config {
     no_nmap: Option<bool>,
     ulimit: Option<rlimit::rlim>,
     scan_order: Option<ScanOrder>,
-    input: Option<PathBuf>,
     command: Option<Vec<String>>,
 }
 

src/main.rs

@@ -26,8 +26,9 @@ use std::io::prelude::*;
 use std::io::BufReader;
 use std::net::ToSocketAddrs;
 use std::process::Command;
-use std::str::FromStr;
 use std::{net::IpAddr, time::Duration};
+use trust_dns_resolver::config::*;
+use trust_dns_resolver::Resolver;
 
 extern crate colorful;
 extern crate dirs;
@@ -208,32 +209,17 @@ fn build_nmap_arguments<'a>(
     arguments
 }
 
-#[cfg(not(tarpaulin_include))]
-/// Parses an input file of IPs and uses those
-fn read_ips_from_file(ips: String) -> Result<Vec<std::net::IpAddr>, std::io::Error> {
-    // if we cannot open it as a file, it is not a file so move on
-    let file = File::open(ips)?;
-    let reader = BufReader::new(file);
-
-    let mut ips: Vec<std::net::IpAddr> = Vec::new();
-
-    for str_ip in reader.lines() {
-        match IpAddr::from_str(&str_ip.unwrap()) {
-            Ok(x) => ips.push(x),
-            Err(y) => panic!("File does not contain valid IP address. Error at {}", y),
-        }
-    }
-    Ok(ips)
-}
-
+/// Goes through all possible IP inputs (files or via argparsing)
+/// Parses the string(s) into IPs
 fn parse_addresses(opts: &Opts) -> Vec<IpAddr> {
     let mut ips: Vec<IpAddr> = Vec::new();
+    let resolver = &Resolver::new(ResolverConfig::default(), ResolverOpts::default()).unwrap();
 
     for ip_or_host in &opts.addresses {
-        match IpCidr::from_str(ip_or_host) {
-            Ok(cidr) => cidr.iter().for_each(|ip| ips.push(ip)),
-            _ => match format!("{}:{}", &ip_or_host, 80).to_socket_addrs() {
-                Ok(mut iter) => ips.push(iter.nth(0).unwrap().ip()),
+        match read_ips_from_file(ip_or_host.to_owned(), &resolver) {
+            Ok(x) => ips.extend(x),
+            _ => match parse_to_ip(ip_or_host.to_owned(), &resolver) {
+                Ok(x) => ips.extend(x),
                 _ => {
                     warning!(
                         format!("Host {:?} could not be resolved.", ip_or_host),
@@ -243,13 +229,74 @@ fn parse_addresses(opts: &Opts) -> Vec<IpAddr> {
                 }
             },
         }
-        match read_ips_from_file(ip_or_host.to_owned()) {
-            Ok(x) => ips.extend(x),
-            _ => (),
+    }
+    ips
+}
+
+/// Uses DNS to get the IPS assiocated with host
+fn resolve_ips_from_host(
+    source: &String,
+    resolver: &Resolver,
+) -> Result<Vec<IpAddr>, std::io::Error> {
+    let mut ips: Vec<std::net::IpAddr> = Vec::new();
+
+    match resolver.lookup_ip(&source) {
+        Ok(x) => {
+            for ip in x.iter() {
+                ips.push(ip);
+            }
+        }
+        _ => (),
+    };
+    return Ok(ips);
+}
+
+#[cfg(not(tarpaulin_include))]
+/// Parses an input file of IPs and uses those
+fn read_ips_from_file(
+    ips: String,
+    resolver: &Resolver,
+) -> Result<Vec<std::net::IpAddr>, std::io::Error> {
+    // if we cannot open it as a file, it is not a file so move on
+    let file = File::open(ips)?;
+    let reader = BufReader::new(file);
+
+    let mut ips: Vec<std::net::IpAddr> = Vec::new();
+
+    for str_ip in reader.lines() {
+        match str_ip {
+            Ok(x) => match parse_to_ip(x, resolver) {
+                Ok(result) => ips.extend(result),
+                Err(e) => {
+                    debug!("{} is not a valid IP or host", e);
+                }
+            },
+            Err(_) => {
+                debug!("Line in file is not valid");
+            }
         }
     }
+    Ok(ips)
+}
 
-    ips
+/// Given a string, parse it as an host, IP address, or CIDR.
+/// This allows us to pass files as hosts or cidr or IPs easily
+/// Call this everytime you have a possible IP_or_host
+fn parse_to_ip(address: String, resolver: &Resolver) -> Result<Vec<IpAddr>, std::io::Error> {
+    let mut ips: Vec<IpAddr> = Vec::new();
+
+    match IpCidr::from_str(&address) {
+        Ok(cidr) => cidr.iter().for_each(|ip| ips.push(ip)),
+        _ => match format!("{}:{}", &address, 80).to_socket_addrs() {
+            Ok(mut iter) => ips.push(iter.nth(0).unwrap().ip()),
+            _ => match resolve_ips_from_host(&address, resolver) {
+                Ok(hosts) => ips.extend(hosts),
+                _ => (),
+            },
+        },
+    };
+
+    Ok(ips)
 }
 
 fn adjust_ulimit_size(opts: &Opts) -> rlimit::rlim {
@@ -420,4 +467,12 @@ mod tests {
 
         assert_eq!(ips.is_empty(), true);
     }
+    #[test]
+    fn parse_hosts_file_and_incorrect_hosts() {
+        // Host file contains IP, Hosts, incorrect IPs, incorrect hosts
+        let mut opts = Opts::default();
+        opts.addresses = vec!["fixtures/hosts.txt".to_owned()];
+        let ips = parse_addresses(&opts);
+        assert_eq!(ips.len(), 3);
+    }
 }

src/scanner/mod.rs

@@ -232,4 +232,49 @@ mod tests {
         block_on(scanner.run());
         assert_eq!(1, 1);
     }
+    #[test]
+    fn scanner_runs_serial() {
+        let addrs = vec!["8.8.8.8".parse::<IpAddr>().unwrap()];
+
+        let range = PortRange {
+            start: 400,
+            end: 600,
+        };
+        let strategy = PortStrategy::pick(Some(range), None, ScanOrder::Serial);
+        let scanner = Scanner::new(&addrs, 10, Duration::from_millis(100), true, strategy, true);
+        block_on(scanner.run());
+        assert_eq!(1, 1);
+    }
+    #[test]
+    fn scanner_doesnt_run_no_range() {
+        let addrs = vec!["8.8.8.8".parse::<IpAddr>().unwrap()];
+
+        let range = PortRange { start: 0, end: 0 };
+        let strategy = PortStrategy::pick(Some(range), None, ScanOrder::Serial);
+        let scanner = Scanner::new(&addrs, 10, Duration::from_millis(100), true, strategy, true);
+        block_on(scanner.run());
+        assert_eq!(1, 1);
+    }
+    #[test]
+    fn scanner_doesnt_run_high_range() {
+        let addrs = vec!["127.0.0.1".parse::<IpAddr>().unwrap()];
+
+        let range = PortRange {
+            start: 1,
+            end: 65535,
+        };
+        let strategy = PortStrategy::pick(Some(range), None, ScanOrder::Serial);
+        let scanner = Scanner::new(&addrs, 10, Duration::from_millis(100), true, strategy, true);
+        block_on(scanner.run());
+        assert_eq!(1, 1);
+    }
+    #[test]
+    fn scanner_doesnt_run_backwards_range() {
+        let addrs = vec!["127.0.0.1".parse::<IpAddr>().unwrap()];
+        let range = PortRange { start: 10, end: 1 };
+        let strategy = PortStrategy::pick(Some(range), None, ScanOrder::Serial);
+        let scanner = Scanner::new(&addrs, 10, Duration::from_millis(100), true, strategy, true);
+        block_on(scanner.run());
+        assert_eq!(1, 1);
+    }
 }