Merge pull request #174 from caass/patch-1

Allow compilation on windows (#171)

.all-contributorsrc

@@ -115,44 +115,6 @@
         "doc",
         "design"
       ]
-    },
-    {
-      "login": "Ferryistaken",
-      "name": "Alessandro Ferrari",
-      "avatar_url": "https://avatars3.githubusercontent.com/u/47927670?v=4",
-      "profile": "https://github.com/Ferryistaken",
-      "contributions": [
-        "content"
-      ]
-    },
-    {
-      "login": "Phenomite",
-      "name": "Phenomite",
-      "avatar_url": "https://avatars2.githubusercontent.com/u/8285537?v=4",
-      "profile": "https://github.com/Phenomite",
-      "contributions": [
-        "content"
-      ]
-    },
-    {
-      "login": "SuperSandro2000",
-      "name": "Sandro",
-      "avatar_url": "https://avatars2.githubusercontent.com/u/7258858?v=4",
-      "profile": "https://supersandro.de/",
-      "contributions": [
-        "content"
-      ]
-    },
-    {
-      "login": "caass",
-      "name": "Cass",
-      "avatar_url": "https://avatars2.githubusercontent.com/u/25358963?v=4",
-      "profile": "https://swag.lgbt",
-      "contributions": [
-        "platform",
-        "code",
-        "bug"
-      ]
     }
   ],
   "contributorsPerLine": 7,

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "src/rustscan_scripting_engine"]
-	path = src/rustscan_scripting_engine
-	url = https://github.com/RustScan/rustscan_scripting_engine

.travis.yml

@@ -3,7 +3,7 @@ language: rust
 os:
   - linux
   - osx
-  # - windows
+  - windows
 
 arch:
   - amd64
@@ -54,14 +54,3 @@ after_failure:
   - wget https://raw.githubusercontent.com/DiscordHooks/travis-ci-discord-webhook/master/send.sh
   - chmod +x send.sh
   - ./send.sh failure $WEBHOOK_URL
-
-after_success: |
-  if [ -n "${GITHUB_TOKEN}" ]; then
-    [ "${TRAVIS_BRANCH} " = master ] &&
-    [ "${TRAVIS_PULL_REQUEST}" = false ] &&
-    cargo doc &&
-    echo "<meta http-equiv=refresh content=0;url=rustscan/index.html>" > target/doc/index.html &&
-    sudo pip install ghp-import &&
-    ghp-import -n target/doc &&
-    git push -fq https://${GITHUB_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git gh-pages
-  fi

Cargo.lock

@@ -814,9 +814,9 @@ checksum = "8ea5119cdb4c55b55d432abb513a0429384878c15dde60cc77b1c99de1a95a6a"
 
 [[package]]
 name = "structopt"
-version = "0.3.17"
+version = "0.3.16"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6cc388d94ffabf39b5ed5fadddc40147cb21e605f53db6f8f36a625d27489ac5"
+checksum = "de5472fb24d7e80ae84a7801b7978f95a19ec32cb1876faea59ab711eb901976"
 dependencies = [
  "clap",
  "lazy_static",
@@ -825,9 +825,9 @@ dependencies = [
 
 [[package]]
 name = "structopt-derive"
-version = "0.4.10"
+version = "0.4.9"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5e2513111825077552a6751dfad9e11ce0fba07d7276a3943a037d7e93e64c5f"
+checksum = "1e0eb37335aeeebe51be42e2dc07f031163fbabfa6ac67d7ea68b5c2f68d5f99"
 dependencies = [
  "heck",
  "proc-macro-error",

Cargo.toml

@@ -18,10 +18,9 @@ exclude = [
 
 [dependencies]
 colored = "2.0.0"
-structopt = "0.3.17"
+structopt = "0.3.16"
 async-std = "1.6.3"
 futures = "0.3"
-rlimit = "0.4.0"
 shell-words = "1.0.0"
 log = "0.4.0"
 env_logger = "0.7.1"
@@ -31,6 +30,9 @@ rand = "0.7.3"
 colorful = "0.2.1"
 ansi_term = "0.12.1"
 
+[target."cfg(not(windows))".dependencies]
+rlimit = "0.4.0"
+
 [package.metadata.deb]
 depends = "$auto, nmap"
 section = "rust"

README.md

@@ -67,7 +67,7 @@ RustScans **only** job is to reduce the friction between finding open ports and
 
 | Installation Guide | Documentation | Discord |
 | ------------------ | ------------- | ------- |
-| 📖 [Installation Guide](https://github.com/RustScan/RustScan#-full-installation-guide) | 📚 [Documentation](https://rustscan.github.io/RustScan/) | 🦜 [Discord](https://discord.gg/GFrQsGy)
+| 📖 [Installation Guide](https://github.com/RustScan/RustScan#-full-installation-guide) | 📚 [Documentation](https://github.com/RustScan/RustScan/issues/89) | 🦜 [Discord](https://discord.gg/GFrQsGy)
 
 ## 🙋 Table of Contents
 * 📖 [Installation Guide](https://github.com/RustScan/RustScan#-full-installation-guide)
@@ -213,25 +213,23 @@ rustscan -h
 ```
 
 ```
+rustscan 1.7.1
 Fast Port Scanner built in Rust. WARNING Do not use this program against sensitive infrastructure since the specified
 server may not be able to handle this many socket connections at once. - Discord https://discord.gg/GFrQsGy - GitHub
 https://github.com/RustScan/RustScan
 
 USAGE:
-    rustscan [FLAGS] [OPTIONS] <ips-or-hosts>... [-- <command>...]
+    rustscan [FLAGS] [OPTIONS] <ips>... [-- <command>...]
 
 FLAGS:
-    -a, --accessible
-    -h, --help          Prints help information
-    -q, --quiet         Quiet mode. Only output the ports. No Nmap. Useful for grep or outputting to a file
-    -V, --version       Prints version information
+    -h, --help       Prints help information
+    -q, --quiet      Quiet mode. Only output the ports. No Nmap. Useful for grep or outputting to a file
+    -V, --version    Prints version information
 
 OPTIONS:
     -b, --batch-size <batch-size>    The batch size for port scanning, it increases or slows the speed of scanning.
                                      Depends on the open file limit of your OS.  If you do 65535 it will do every port
                                      at the same time. Although, your OS may not support this [default: 4500]
-    -p, --ports <ports>...           A list of comma separed ports to be scanned. Example: 80,443,8080.
-    -r, --range <range>              A range of ports with format start-end. Example: 1-1000
         --scan-order <scan-order>    The order of scanning to be performed. The "serial" option will scan ports in
                                      ascending order while the "random" option will scan ports randomly [default:
                                      serial]  [possible values: Serial, Random]
@@ -239,11 +237,11 @@ OPTIONS:
     -u, --ulimit <ulimit>            Automatically ups the ULIMIT with the value you provided
 
 ARGS:
-    <ips-or-hosts>...    A list of comma separated IP addresses or hosts to be scanned
-    <command>...         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'. This command adds -Pn -vvv -p $PORTS
-                         automatically to nmap. For things like --script '(safe and vuln)' enclose it in quotations
-                         marks \"'(safe and vuln)'\"")
+    <ips>...        A list of comma separated IP addresses to be scanned
+    <command>...    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'. This command adds -Pn -vvv -p $PORTS automatically to
+                    nmap. For things like --script '(safe and vuln)' enclose it in quotations marks \"'(safe and
+                    vuln)'\"")
 ```
 
 The format is `rustscan -b 500 -T 1500 192.168.0.1` to scan 192.168.0.1 with 500 batch size with a timeout of 1500ms. The timeout is how long RustScan waits for a response until it assumes the port is closed.
@@ -381,7 +379,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-15-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-11-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)):
@@ -404,12 +402,6 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <td align="center"><a href="https://tgotwig.me"><img src="https://avatars0.githubusercontent.com/u/30773779?v=4" width="100px;" alt=""/><br /><sub><b>Thomas Gotwig</b></sub></a><br /><a href="#platform-TGotwig" title="Packaging/porting to new platform">📦</a></td>
     <td align="center"><a href="https://github.com/remigourdon"><img src="https://avatars3.githubusercontent.com/u/2874133?v=4" width="100px;" alt=""/><br /><sub><b>Rémi Gourdon</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=remigourdon" title="Documentation">📖</a> <a href="https://github.com/RustScan/RustScan/commits?author=remigourdon" title="Code">💻</a></td>
     <td align="center"><a href="https://cmnatic.co.uk"><img src="https://avatars3.githubusercontent.com/u/4163116?v=4" width="100px;" alt=""/><br /><sub><b>Ben (CMNatic)</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=cmnatic" title="Code">💻</a> <a href="https://github.com/RustScan/RustScan/commits?author=cmnatic" title="Documentation">📖</a> <a href="#design-cmnatic" title="Design">🎨</a></td>
-    <td align="center"><a href="https://github.com/Ferryistaken"><img src="https://avatars3.githubusercontent.com/u/47927670?v=4" width="100px;" alt=""/><br /><sub><b>Alessandro Ferrari</b></sub></a><br /><a href="#content-Ferryistaken" title="Content">🖋</a></td>
-    <td align="center"><a href="https://github.com/Phenomite"><img src="https://avatars2.githubusercontent.com/u/8285537?v=4" width="100px;" alt=""/><br /><sub><b>Phenomite</b></sub></a><br /><a href="#content-Phenomite" title="Content">🖋</a></td>
-    <td align="center"><a href="https://supersandro.de/"><img src="https://avatars2.githubusercontent.com/u/7258858?v=4" width="100px;" alt=""/><br /><sub><b>Sandro</b></sub></a><br /><a href="#content-SuperSandro2000" title="Content">🖋</a></td>
-  </tr>
-  <tr>
-    <td align="center"><a href="https://swag.lgbt"><img src="https://avatars2.githubusercontent.com/u/25358963?v=4" width="100px;" alt=""/><br /><sub><b>Cass</b></sub></a><br /><a href="#platform-caass" title="Packaging/porting to new platform">📦</a> <a href="https://github.com/RustScan/RustScan/commits?author=caass" title="Code">💻</a> <a href="https://github.com/RustScan/RustScan/issues?q=author%3Acaass" title="Bug reports">🐛</a></td>
   </tr>
 </table>
 

src/main.rs

@@ -11,9 +11,13 @@ use port_strategy::PortStrategy;
 use colorful::Color;
 use colorful::Colorful;
 use futures::executor::block_on;
-use rlimit::Resource;
-use rlimit::{getrlimit, setrlimit};
+
+#[cfg(not(target_os = "windows"))]
+use rlimit::{getrlimit, setrlimit, Resource};
+
 use std::collections::HashMap;
+#[cfg(not(target_os = "windows"))]
+use std::convert::TryInto;
 use std::process::Command;
 use std::str::FromStr;
 use std::{net::IpAddr, net::ToSocketAddrs, time::Duration};
@@ -25,9 +29,9 @@ extern crate dirs;
 const LOWEST_PORT_NUMBER: u16 = 1;
 const TOP_PORT_NUMBER: u16 = 65535;
 // Average value for Ubuntu
-const DEFAULT_FILE_DESCRIPTORS_LIMIT: rlimit::rlim = 8000;
+const DEFAULT_FILE_DESCRIPTORS_LIMIT: u32 = 8000;
 // Safest batch size based on experimentation
-const AVERAGE_BATCH_SIZE: rlimit::rlim = 3000;
+const AVERAGE_BATCH_SIZE: u32 = 3000;
 
 #[macro_use]
 extern crate log;
@@ -110,7 +114,7 @@ struct Opts {
 
     /// Automatically ups the ULIMIT with the value you provided.
     #[structopt(short, long)]
-    ulimit: Option<rlimit::rlim>,
+    ulimit: Option<u32>,
 
     /// The order of scanning to be performed. The "serial" option will
     /// scan ports in ascending order while the "random" option will scan
@@ -120,7 +124,7 @@ struct Opts {
 
     /// 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'.
+    /// Example: 'rustscan -T 1500 127.0.0.1 -- -A -sC'.
     /// This command adds -Pn -vvv -p $PORTS automatically to nmap.
     /// For things like --script '(safe and vuln)' enclose it in quotations marks \"'(safe and vuln)'\"")
     #[structopt(last = true)]
@@ -156,7 +160,8 @@ fn main() {
         std::process::exit(1);
     }
 
-    let ulimit: rlimit::rlim = adjust_ulimit_size(&opts);
+    let ulimit: u32 = adjust_ulimit_size(&opts);
+
     let batch_size: u16 = infer_batch_size(&opts, ulimit);
 
     let scanner = Scanner::new(
@@ -187,7 +192,7 @@ fn main() {
 
         let x = format!("{} Looks like I didn't find any open ports for {:?}. This is usually caused by a high batch size.
         \n*I used {} batch size, consider lowering to {} with {} or a comfortable number for your system.
-        \n Alternatively, increase the timeout if your ping is high. Rustscan -t 2000 for 2000 milliseconds (2s) timeout.\n",
+        \n Alternatively, increase the timeout if your ping is high. Rustscan -t 2000 for 2000 second timeout.\n",
         "ERROR",
         ip,
         opts.batch_size,
@@ -300,9 +305,10 @@ fn parse_ips(opts: &Opts) -> Vec<IpAddr> {
     ips
 }
 
-fn adjust_ulimit_size(opts: &Opts) -> rlimit::rlim {
+#[cfg(not(target_os = "windows"))]
+fn adjust_ulimit_size(opts: &Opts) -> u32 {
     if opts.ulimit.is_some() {
-        let limit: rlimit::rlim = opts.ulimit.unwrap();
+        let limit: rlimit::rlim = opts.ulimit.unwrap().into();
 
         match setrlimit(Resource::NOFILE, limit, limit) {
             Ok(_) => {
@@ -317,15 +323,22 @@ fn adjust_ulimit_size(opts: &Opts) -> rlimit::rlim {
 
     let (rlim, _) = getrlimit(Resource::NOFILE).unwrap();
 
-    rlim
+    rlim.try_into().unwrap()
 }
 
-fn infer_batch_size(opts: &Opts, ulimit: rlimit::rlim) -> u16 {
-    let mut batch_size: rlimit::rlim = opts.batch_size.into();
+// Rlimit does not support Windows
+// set to 1000 if Windows is used
+#[cfg(target_os = "windows")]
+fn adjust_ulimit_size(_opts: &Opts) -> u32 {
+    1000
+}
+
+fn infer_batch_size(opts: &Opts, ulimit: u32) -> u16 {
+    let mut batch_size: u32 = opts.batch_size.into();
 
     // 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",
+    if ulimit < batch_size && !(cfg!(windows)) {
+        warning!("File limit is lower than default batch size. Consider upping with --ulimt. May cause harm to sensitive servers",
             opts.quiet
         );
 
@@ -336,7 +349,11 @@ fn infer_batch_size(opts: &Opts, ulimit: rlimit::rlim) -> u16 {
             // ulimit is smaller than aveage batch size
             // user must have very small ulimit
             // decrease batch size to half of ulimit
-            warning!("Your file limit is very small, which negatively impacts RustScan's speed. Use the Docker image, or up the Ulimit with '--ulimit 5000'. ");
+            if !(cfg!(windows)) {
+                warning!("Your file limit is very small, which negatively impacts RustScan's speed. Use the Docker image, or up the Ulimit with '--ulimit 5000'. ");
+            } else {
+                warning!("Windows is known to be much slower than scanning on Unix systems. Use the Docker image if you need faster speeds.");
+            }
             info!("Halving batch_size because ulimit is smaller than average batch size");
             batch_size = ulimit / 2
         } else if ulimit > DEFAULT_FILE_DESCRIPTORS_LIMIT {
@@ -362,6 +379,7 @@ fn infer_batch_size(opts: &Opts, ulimit: rlimit::rlim) -> u16 {
 mod tests {
     use crate::{adjust_ulimit_size, infer_batch_size, parse_ips, print_opening, Opts, ScanOrder};
 
+    #[cfg(not(target_os = "windows"))]
     #[test]
     fn batch_size_lowered() {
         let opts = Opts {
@@ -381,6 +399,7 @@ mod tests {
         assert!(batch_size < 50_000);
     }
 
+    #[cfg(not(target_os = "windows"))]
     #[test]
     fn batch_size_lowered_average_size() {
         let opts = Opts {
@@ -399,6 +418,7 @@ mod tests {
 
         assert!(batch_size == 3_000);
     }
+    #[cfg(not(target_os = "windows"))]
     #[test]
     fn batch_size_equals_ulimit_lowered() {
         // because ulimit and batch size are same size, batch size is lowered
@@ -419,6 +439,7 @@ mod tests {
 
         assert!(batch_size == 4_900);
     }
+    #[cfg(not(target_os = "windows"))]
     #[test]
     fn batch_size_adjusted_2000() {
         // ulimit == batch_size