TravisCI-org.com is being deprecated and is causing CI to fail. We use GitHub actions and do not need TravisCI.

.github/workflows/basic.yml

@@ -13,9 +13,9 @@ jobs:
           profile: minimal
           toolchain: stable
           override: true
-      # - uses: actions-rs/cargo@v1
-        # with:
-          # command: check
+      - uses: actions-rs/cargo@v1
+        with:
+          command: check
 
   test:
     name: Test Suite
@@ -46,3 +46,25 @@ jobs:
         with:
           command: fmt
           args: --all -- --check
+
+  clippy:
+    name: Clippy linting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+            toolchain: stable
+            components: clippy
+            override: true
+      - uses: actions-rs/clippy-check@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          args: --all-features
+
+  links:
+        name: markdown-link-check
+        runs-on: ubuntu-latest
+        steps:
+        - uses: actions/checkout@master
+        - uses: gaurav-nelson/github-action-markdown-link-check@v1

.travis.yml

@@ -1,38 +0,0 @@
-language: rust
-os:
-- linux
-- osx
-arch:
-- amd64
-- arm64
-services:
-- docker
-before_install:
-- rustup component add rustfmt
-rust:
-- stable
-- beta
-jobs:
-  fast_finish: true
-script:
-- cargo build
-- cargo test
-- "ulimit -n 5000; cargo test timelimits:: -- --ignored --test-threads=1 --show-output"
-- cargo fmt -- --check
-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
-env:
-  global:
-    secure: Gf24LG7Hr3Q0drWyPrvISTL35Z57DxdS/wIOo7v+ZdauzY3Qjvv3Lh4TY//C4sdN0g1CLj4yjg7LQOqF4XRdh2Qah7JZPv/i2B5uz9nwjTsoRzmmMWML9VtfT1u53nSFqsNeXbvpmoNG9rfMXcoiyd+Lv+EgniHphDEBlXvS9n9KMcpOi1F2x7bsH0EK37wQYKMTpCCd5TPUPdZou7BJNiZS3ikRLpTRFF7uIN4gYtRH9kU5uBSphWgnJ6eBm2ItzZcUPOgrjAoF4RkmZAzGG4idDh1Qkf3No3nZwT3U5NSk8h7owtJ4oADlRgYqYKCB4YcC9cAKCJgDsyMlKKMkEyagvw1seFnBLCY3ljsW4EklpVEZ0rVqZOx4pTkIaxIxytLTC9pHmdDSnhdhFknOcVAQQWjg+nAZfD07QUeAqUdr0i/vxQoZitvbNY0znzEarycE1waKvwlkiB4gt385U1CBfYldydnOnRKkdtLNrCLClu13HU0djmSXMhojQJhTuNxTHtZAf5fKcWIWwkVbNZ5MNKYjQh4rKufqW3o1iHphB8dfAGsDEPv0RQMtVbu6H4+clCouLkFlxHOIrrOJ5SXQ8cIATPhnJR7y4cSDdRaN0DRLRjeLAIKlbOGBtNuFC+BftocaTY5qN42aKAMqQcT30ycfiLuRVJNiQJ5pkto=

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "rustscan"
-version = "2.1.1"
-authors = ["Autumn <autum[email protected]>"]
+version = "2.0.0"
+authors = ["Bee <brando[email protected]>"]
 edition = "2018"
 description = "Faster Nmap Scanning with Rust"
 homepage = "https://github.com/rustscan/rustscan"
@@ -21,7 +21,7 @@ colored = "2.0.0"
 structopt = "0.3.20"
 async-std = "1.7.0"
 futures = "0.3"
-rlimit = "0.8.3"
+rlimit = "0.5.4"
 shell-words = "1.0.0"
 log = "0.4.0"
 env_logger = "0.8.2"

README.md

@@ -23,7 +23,7 @@
 | <p align="center"><a href="https://hub.docker.com/r/cmnatic/rustscan">🐋 Docker (Recommended) </a></p>            | <p align="center"><a href="https://github.com/RustScan/RustScan/releases">👩‍💻 Kali / Debian </p>                 | <p align="center"><a href="https://aur.archlinux.org/packages/rustscan/">🏗️ Arch </a></p>                       | <p align="center"><a href="https://crates.io/crates/rustscan">🔧 Homebrew </a></p>                     |
 | ----------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
 | <p align="center"><img src="https://github.com/RustScan/RustScan/blob/master/pictures/docker.png?raw=true" /></p> | <p align="center"><img src="https://github.com/RustScan/RustScan/blob/master/pictures/kali.png?raw=true" /></p> | <p align="center"><img src="https://github.com/RustScan/RustScan/blob/master/pictures/arch.png?raw=true" /></p> | <p align="center"><img src="https://raw.githubusercontent.com/RustScan/RustScan/master/pictures/apple.png" /></p> |
-| `docker pull rustscan/rustscan:2.0.0` <p>[Usage](https://github.com/RustScan/RustScan/wiki/Installation-Guide#docker-whale)              | [Read the install guide](https://github.com/RustScan/RustScan/wiki/Installation-Guide#%EF%B8%8F-debian--kali)     | `yay -S rustscan`                                                                                               | `brew install rustscan`                                                                                        |
+| `docker pull rustscan/rustscan:2.0.0` <p>[Usage](https://github.com/RustScan/RustScan#docker-whale)              | [Read the install guide](https://github.com/Rustscan/RustScan/blob/master/README.md#%EF%B8%8F-debian--kali)     | `yay -S rustscan`                                                                                               | `brew install rustscan`                                                                                        |
 
 <hr>
 

contributing.md

@@ -7,21 +7,19 @@ Before contributing, read our [code of conduct](https://github.com/RustScan/Rust
 TL;DR if you abuse members of our community you will be **perma-banned** with no chance to get unbanned. No warnings either. 🤗
 
 RustScan has 2 major labels for GitHub issues you should look at:
-
-- Good First issue
-  These are issues for newcomers to open source!
-  [https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22](https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
-- Help wanted
-  These are issues that aren't really for newcomers, but we could still do with help!
-  [https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+label%3A%22help+wanted%22](https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+label%3A%22help+wanted%22)
+* Good First issue
+These are issues for newcomers to open source!
+[https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22](https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
+* Help wanted
+These are issues that aren't really for newcomers, but we could still do with help!
+[https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+label%3A%22help+wanted%22](https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+label%3A%22help+wanted%22)
 
 If you want to, solve the issue or comment on the issue for help.
 
-The flow for contributing to open source software is:
-
-- Fork the repo
-- Make changes
-- Pull request to the repo
+The [flow for contributing](https://guides.github.com/introduction/flow/) to open source software is:
+* Fork the repo
+* Make changes
+* Pull request to the repo
 
 And then comment on the issue that you've done.
 
@@ -30,7 +28,6 @@ RustScan also has some `// TODO`'s in the codebase, which are meant more for the
 If you have any feature suggestions or bugs, leave a GitHub issue. We welcome any and all support :D
 
 ## Rewarding you
-
 I cannot pay you :-( But, I can place your GitHub profile on the README under `#Contributors` as a thank you! :)
 
 ## Contributing development environment
@@ -42,7 +39,7 @@ To build it you just need to run:
 you@home:~/RustScan$ docker build -t rustscan_contributing -f contributing.Dockerfile
 ```
 
-Then you need to run the container with a volume so it can access, _with read and write permissions_, to RustScan files:
+Then you need to run the container with a volume so it can access, *with read and write permissions*, to RustScan files:
 
 ```bash
 you@home:~/RustScan$ docker run -ti --rm -v "$PWD":/rustscan -w /rustscan rustscan_contributing bash
@@ -66,4 +63,4 @@ You can also format, lint with `clippy` and test the code with the following com
 root@container:/rustscan# cargo fmt
 root@container:/rustscan# cargo clippy
 root@container:/rustscan# cargo test
-```
+```

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;
@@ -71,7 +70,7 @@ fn parse_range(input: &str) -> Result<PortRange, String> {
 /// - Discord https://discord.gg/GFrQsGy
 /// - GitHub https://github.com/RustScan/RustScan
 pub struct Opts {
-    /// A comma-delimited list or newline-delimited file of separated CIDRs, IPs, or hosts to be scanned.
+    /// A list of comma separated CIDRs, IPs, or hosts to be scanned.
     #[structopt(short, long, use_delimiter = true)]
     pub addresses: Vec<String>,
 
@@ -87,10 +86,6 @@ pub struct Opts {
     #[structopt(short, long)]
     pub no_config: bool,
 
-    /// Custom path to config file
-    #[structopt(short, long, parse(from_os_str))]
-    pub config_path: Option<PathBuf>,
-
     /// Greppable mode. Only output the ports. No Nmap. Useful for grep or outputting to a file.
     #[structopt(short, long)]
     pub greppable: bool,
@@ -117,7 +112,7 @@ pub struct Opts {
 
     /// Automatically ups the ULIMIT with the value you provided.
     #[structopt(short, long)]
-    pub ulimit: Option<u64>,
+    pub ulimit: Option<rlimit::RawRlim>,
 
     /// The order of scanning to be performed. The "serial" option will
     /// scan ports in ascending order while the "random" option will scan
@@ -221,7 +216,7 @@ pub struct Config {
     batch_size: Option<u16>,
     timeout: Option<u32>,
     tries: Option<u8>,
-    ulimit: Option<u64>,
+    ulimit: Option<rlimit::RawRlim>,
     scan_order: Option<ScanOrder>,
     command: Option<Vec<String>>,
     scripts: Option<ScriptsRequired>,
@@ -239,11 +234,16 @@ impl Config {
     /// greppable = true
     /// scan_order: "Serial"
     ///
-    pub fn read(custom_config_path: Option<PathBuf>) -> Self {
+    pub fn read() -> Self {
+        let mut home_dir = match dirs::home_dir() {
+            Some(dir) => dir,
+            None => panic!("Could not infer config file path."),
+        };
+        home_dir.push(".rustscan.toml");
+
         let mut content = String::new();
-        let config_path = custom_config_path.unwrap_or_else(default_config_path);
-        if config_path.exists() {
-            content = match fs::read_to_string(config_path) {
+        if home_dir.exists() {
+            content = match fs::read_to_string(home_dir) {
                 Ok(content) => content,
                 Err(_) => String::new(),
             }
@@ -261,16 +261,6 @@ impl Config {
     }
 }
 
-/// Constructs default path to config toml
-pub fn default_config_path() -> PathBuf {
-    let mut config_path = match dirs::home_dir() {
-        Some(dir) => dir,
-        None => panic!("Could not infer config file path."),
-    };
-    config_path.push(".rustscan.toml");
-    config_path
-}
-
 #[cfg(test)]
 mod tests {
     use super::{Config, Opts, PortRange, ScanOrder, ScriptsRequired};
@@ -310,7 +300,6 @@ mod tests {
                 no_config: true,
                 top: false,
                 scripts: ScriptsRequired::Default,
-                config_path: None,
             }
         }
     }

src/main.rs

@@ -24,7 +24,9 @@ use scripts::{init_scripts, Script, ScriptFile};
 use cidr_utils::cidr::IpCidr;
 use colorful::{Color, Colorful};
 use futures::executor::block_on;
+use rlimit::{getrlimit, setrlimit, RawRlim, Resource, Rlim};
 use std::collections::HashMap;
+use std::convert::TryInto;
 use std::fs::File;
 use std::io::{prelude::*, BufReader};
 use std::net::{IpAddr, ToSocketAddrs};
@@ -40,10 +42,9 @@ extern crate colorful;
 extern crate dirs;
 
 // Average value for Ubuntu
-#[cfg(unix)]
-const DEFAULT_FILE_DESCRIPTORS_LIMIT: u64 = 8000;
+const DEFAULT_FILE_DESCRIPTORS_LIMIT: RawRlim = 8000;
 // Safest batch size based on experimentation
-const AVERAGE_BATCH_SIZE: u16 = 3000;
+const AVERAGE_BATCH_SIZE: RawRlim = 3000;
 
 #[macro_use]
 extern crate log;
@@ -58,7 +59,7 @@ fn main() {
     let mut rustscan_bench = NamedTimer::start("RustScan");
 
     let mut opts: Opts = Opts::read();
-    let config = Config::read(opts.config_path.clone());
+    let config = Config::read();
     opts.merge(&config);
 
     debug!("Main() `opts` arguments are {:?}", opts);
@@ -67,7 +68,7 @@ fn main() {
         Ok(scripts_to_run) => scripts_to_run,
         Err(e) => {
             warning!(
-                format!("Initiating scripts failed!\n{}", e),
+                format!("Initiating scripts failed!\n{}", e.to_string()),
                 opts.greppable,
                 opts.accessible
             );
@@ -92,11 +93,8 @@ fn main() {
         std::process::exit(1);
     }
 
-    #[cfg(unix)]
-    let batch_size: u16 = infer_batch_size(&opts, adjust_ulimit_size(&opts));
-
-    #[cfg(not(unix))]
-    let batch_size: u16 = AVERAGE_BATCH_SIZE;
+    let ulimit: RawRlim = adjust_ulimit_size(&opts);
+    let batch_size: u16 = infer_batch_size(&opts, ulimit);
 
     let scanner = Scanner::new(
         &ips,
@@ -178,7 +176,7 @@ fn main() {
             let script = Script::build(
                 script_f.path,
                 *ip,
-                ports.clone(),
+                ports.to_vec(),
                 script_f.port,
                 script_f.ports_separator,
                 script_f.tags,
@@ -189,7 +187,11 @@ fn main() {
                     detail!(script_result.to_string(), opts.greppable, opts.accessible);
                 }
                 Err(e) => {
-                    warning!(&format!("Error {}", e), opts.greppable, opts.accessible);
+                    warning!(
+                        &format!("Error {}", e.to_string()),
+                        opts.greppable,
+                        opts.accessible
+                    );
                 }
             }
         }
@@ -207,29 +209,22 @@ fn main() {
 /// Prints the opening title of RustScan
 fn print_opening(opts: &Opts) {
     debug!("Printing opening");
-    let s = format!(
-        "{}\n{}\n{}\n{}\n{}",
-        r#".----. .-. .-. .----..---.  .----. .---.   .--.  .-. .-."#,
-        r#"| {}  }| { } |{ {__ {_   _}{ {__  /  ___} / {} \ |  `| |"#,
-        r#"| .-. \| {_} |.-._} } | |  .-._} }\     }/  /\  \| |\  |"#,
-        r#"`-' `-'`-----'`----'  `-'  `----'  `---' `-'  `-'`-' `-'"#,
-        r#"The Modern Day Port Scanner."#
-    );
+    let s = r#".----. .-. .-. .----..---.  .----. .---.   .--.  .-. .-.
+| {}  }| { } |{ {__ {_   _}{ {__  /  ___} / {} \ |  `| |
+| .-. \| {_} |.-._} } | |  .-._} }\     }/  /\  \| |\  |
+`-' `-'`-----'`----'  `-'  `----'  `---' `-'  `-'`-' `-'
+The Modern Day Port Scanner."#;
     println!("{}", s.gradient(Color::Green).bold());
-    let info = format!(
-        "{}\n{}\n{}\n{}",
-        r#"________________________________________"#,
-        r#": http://discord.skerritt.blog           :"#,
-        r#": https://github.com/RustScan/RustScan :"#,
-        r#" --------------------------------------"#
-    );
+    let info = r#"________________________________________
+: https://discord.gg/GFrQsGy           :
+: https://github.com/RustScan/RustScan :
+ --------------------------------------"#;
     println!("{}", info.gradient(Color::Yellow).bold());
     funny_opening!();
 
-    let config_path = opts
-        .config_path
-        .clone()
-        .unwrap_or_else(input::default_config_path);
+    let config_path = dirs::home_dir()
+        .expect("Could not infer config file path.")
+        .join(".rustscan.toml");
 
     detail!(
         format!("The config file is expected to be at {:?}", config_path),
@@ -307,7 +302,7 @@ fn resolve_ips_from_host(source: &str, backup_resolver: &Resolver) -> Vec<IpAddr
         for ip in addrs {
             ips.push(ip.ip());
         }
-    } else if let Ok(addrs) = backup_resolver.lookup_ip(source) {
+    } else if let Ok(addrs) = backup_resolver.lookup_ip(&source) {
         ips.extend(addrs.iter());
     }
 
@@ -336,11 +331,11 @@ fn read_ips_from_file(
     Ok(ips)
 }
 
-#[cfg(unix)]
-fn adjust_ulimit_size(opts: &Opts) -> u64 {
-    use rlimit::Resource;
-    if let Some(limit) = opts.ulimit {
-        if Resource::NOFILE.set(limit, limit).is_ok() {
+fn adjust_ulimit_size(opts: &Opts) -> RawRlim {
+    if opts.ulimit.is_some() {
+        let limit: Rlim = Rlim::from_raw(opts.ulimit.unwrap());
+
+        if setrlimit(Resource::NOFILE, limit, limit).is_ok() {
             detail!(
                 format!("Automatically increasing ulimit value to {}.", limit),
                 opts.greppable,
@@ -355,15 +350,13 @@ fn adjust_ulimit_size(opts: &Opts) -> u64 {
         }
     }
 
-    let (soft, _) = Resource::NOFILE.get().unwrap();
-    soft
+    let (rlim, _) = getrlimit(Resource::NOFILE).unwrap();
+
+    rlim.as_raw()
 }
 
-#[cfg(unix)]
-fn infer_batch_size(opts: &Opts, ulimit: u64) -> u16 {
-    use std::convert::TryInto;
-
-    let mut batch_size: u64 = opts.batch_size.into();
+fn infer_batch_size(opts: &Opts, ulimit: RawRlim) -> u16 {
+    let mut batch_size: RawRlim = opts.batch_size.into();
 
     // Adjust the batch size when the ulimit value is lower than the desired batch size
     if ulimit < batch_size {
@@ -374,18 +367,18 @@ fn infer_batch_size(opts: &Opts, ulimit: u64) -> u16 {
         // When the OS supports high file limits like 8000, but the user
         // selected a batch size higher than this we should reduce it to
         // a lower number.
-        if ulimit < AVERAGE_BATCH_SIZE.into() {
+        if ulimit < AVERAGE_BATCH_SIZE {
             // 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'. ", opts.greppable, opts.accessible);
             info!("Halving batch_size because ulimit is smaller than average batch size");
-            batch_size = ulimit / 2;
+            batch_size = ulimit / 2
         } else if ulimit > DEFAULT_FILE_DESCRIPTORS_LIMIT {
             info!("Batch size is now average batch size");
-            batch_size = AVERAGE_BATCH_SIZE.into();
+            batch_size = AVERAGE_BATCH_SIZE
         } else {
-            batch_size = ulimit - 100;
+            batch_size = ulimit - 100
         }
     }
     // When the ulimit is higher than the batch size let the user know that the

src/tui.rs

@@ -72,7 +72,6 @@ macro_rules! funny_opening {
             "Real hackers hack time ⌛",
             "Please contribute more quotes to our GitHub https://github.com/rustscan/rustscan",
             "😵 https://admin.tryhackme.com",
-            "0day was here ♥",
         ];
         let random_quote = quotes.choose(&mut rand::thread_rng()).unwrap();