initial changes

added release drafter
Merge pull request #200 from RustScan/ba-add-cidr-support
2026-11-07 17:02:04 -10:00 · 2020-09-12 01:49:16 +01:00 · 2020-09-11 00:59:55 +01:00 · 2020-09-10 00:46:19 +01:00 · 2020-09-09 19:21:43 -04:00 · 2020-09-07 23:00:14 +01:00
29 changed files with 3209 additions and 641 deletions
@@ -66,11 +66,127 @@
        "bug",
        "maintenance"
      ]
+    },
+    {
+      "login": "royharoush",
+      "name": "royharoush",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/8113056?v=4",
+      "profile": "https://github.com/royharoush",
+      "contributions": [
+        "ideas",
+        "design"
+      ]
+    },
+    {
+      "login": "Atul9",
+      "name": "Atul Bhosale",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/3390330?v=4",
+      "profile": "https://github.com/Atul9",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "TGotwig",
+      "name": "Thomas Gotwig",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/30773779?v=4",
+      "profile": "https://tgotwig.me",
+      "contributions": [
+        "platform"
+      ]
+    },
+    {
+      "login": "remigourdon",
+      "name": "Rémi Gourdon",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/2874133?v=4",
+      "profile": "https://github.com/remigourdon",
+      "contributions": [
+        "doc",
+        "code"
+      ]
+    },
+    {
+      "login": "cmnatic",
+      "name": "Ben (CMNatic)",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/4163116?v=4",
+      "profile": "https://cmnatic.co.uk",
+      "contributions": [
+        "code",
+        "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",
+        "bug",
+        "code"
+      ]
+    },
+    {
+      "login": "caass",
+      "name": "Cass",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/25358963?v=4",
+      "profile": "https://swag.lgbt",
+      "contributions": [
+        "platform",
+        "code",
+        "bug"
+      ]
+    },
+    {
+      "login": "niklasmohrin",
+      "name": "Niklas Mohrin",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/47574893?v=4",
+      "profile": "https://github.com/niklasmohrin",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "tim77",
+      "name": "Artem Polishchuk",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/5614476?v=4",
+      "profile": "https://liberapay.com/Artem4/",
+      "contributions": [
+        "platform"
+      ]
+    },
+    {
+      "login": "buermarc",
+      "name": "buermarc",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/44375277?v=4",
+      "profile": "https://github.com/buermarc",
+      "contributions": [
+        "code"
+      ]
    }
  ],
  "contributorsPerLine": 7,
  "projectName": "RustScan",
-  "projectOwner": "brandonskerritt",
+  "projectOwner": "RustScan",
  "repoType": "github",
  "repoHost": "https://github.com",
  "skipCi": true
@@ -0,0 +1,2 @@
+.git
+Dockerfile
@@ -1,4 +1,4 @@
-github: brandonskerritt
+github: bee-san
 patreon: brandonskerritt
 ko_fi: hacker
 custom: ["https://monzo.me/bee", "https://paypal.me/brandonskerritt"]
@@ -1,2 +1,2 @@
 todo:
-  keyword: "TODO"
+  keyword: "// TODO"
@@ -0,0 +1,4 @@
+template: |
+  ## What’s Changed
+
+  $CHANGES
@@ -0,0 +1,10 @@
+name: Check Markdown links
+
+on: push
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: gaurav-nelson/github-action-markdown-link-check@v1
@@ -45,4 +45,11 @@ jobs:
      - uses: actions-rs/cargo@v1
        with:
          command: fmt
-          args: --all -- --check
+          args: --all -- --check
+
+  links:
+        name: markdown-link-check
+        runs-on: ubuntu-latest
+        steps:
+        - uses: actions/checkout@master
+        - uses: gaurav-nelson/github-action-markdown-link-check@v1
@@ -0,0 +1,18 @@
+name: Check Markdown links
+
+on: 
+  push:
+    branches:
+    - master
+  schedule:
+  # Run everyday at 9:00 AM (See https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07)
+  - cron: "0 9 * * *"
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: gaurav-nelson/github-action-markdown-link-check@v1
+      with:
+        use-quiet-mode: 'yes'
@@ -0,0 +1,3 @@
+[submodule "src/rustscan_scripting_engine"]
+	path = src/rustscan_scripting_engine
+	url = https://github.com/RustScan/rustscan_scripting_engine
@@ -0,0 +1,37 @@
+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
+- 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=
@@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation.
 Examples of behavior that contributes to creating a positive environment
 include:

-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members

 Examples of unacceptable behavior by participants include:

-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
- professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting

 ## Our Responsibilities

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement

 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at brandon@skerritt.blog. All
+reported by contacting the project team at our discord via a private message to any of the owners. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.
@@ -67,10 +67,10 @@ members of the project's leadership.

 ## Attribution

-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+This Code of Conduct is adapted from the Contributor Covenant homepage, version 1.4,
 available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

-[homepage]: https://www.contributor-covenant.org
+homepage: https://www.contributor-covenant.org

 For answers to common questions about this code of conduct, see
 https://www.contributor-covenant.org/faq
@@ -1,5 +1,14 @@
 # This file is automatically @generated by Cargo.
 # It is not intended for manual editing.
+[[package]]
+name = "aho-corasick"
+version = "0.7.13"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "043164d8ba5c4c3035fec9bbee8647c0261d788f3474306f93bb65901cae0e86"
+dependencies = [
+ "memchr",
+]
+
 [[package]]
 name = "ansi_term"
 version = "0.11.0"
@@ -10,10 +19,31 @@ dependencies = [
 ]

 [[package]]
-name = "async-channel"
-version = "1.1.1"
+name = "ansi_term"
+version = "0.12.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ee81ba99bee79f3c8ae114ae4baa7eaa326f63447cf2ec65e4393618b63f8770"
+checksum = "d52a9bb7ec0cf484c551830a7ce27bd20d67eac647e1befb56b0be4ee39a55d2"
+dependencies = [
+ "winapi",
+]
+
+[[package]]
+name = "arrayref"
+version = "0.3.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a4c527152e37cf757a3f78aae5a06fbeefdb07ccc535c980a3208ee3060dd544"
+
+[[package]]
+name = "arrayvec"
+version = "0.5.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cff77d8686867eceff3105329d4698d96c2391c176d5d03adc90c7389162b5b8"
+
+[[package]]
+name = "async-channel"
+version = "1.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "43de69555a39d52918e2bc33a408d3c0a86c829b212d898f4ca25d21a6387478"
 dependencies = [
 "concurrent-queue",
 "event-listener",
@@ -21,16 +51,63 @@ dependencies = [
 ]

 [[package]]
-name = "async-std"
-version = "1.6.2"
+name = "async-executor"
+version = "0.1.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "00d68a33ebc8b57800847d00787307f84a562224a14db069b0acefe4c2abbf5d"
+checksum = "90f47c78ea98277cb1f5e6f60ba4fc762f5eafe9f6511bc2f7dfd8b75c225650"
 dependencies = [
+ "async-io",
+ "futures-lite",
+ "multitask",
+ "parking 1.0.6",
+ "scoped-tls",
+ "waker-fn",
+]
+
+[[package]]
+name = "async-io"
+version = "0.1.11"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3ae22a338d28c75b53702b66f77979062cb29675db376d99e451af4fa79dedb3"
+dependencies = [
+ "cfg-if",
+ "concurrent-queue",
+ "futures-lite",
+ "libc",
+ "once_cell",
+ "parking 2.0.0",
+ "polling",
+ "socket2",
+ "vec-arena",
+ "wepoll-sys-stjepang",
+ "winapi",
+]
+
+[[package]]
+name = "async-mutex"
+version = "1.1.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "20e85981fc34e84cdff3fc2c9219189752633fdc538a06df8b5ac45b68a4f3a9"
+dependencies = [
+ "event-listener",
+]
+
+[[package]]
+name = "async-std"
+version = "1.6.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "46c8da367da62b8ff2313c406c9ac091c1b31d67a165becdd2de380d846260f7"
+dependencies = [
+ "async-executor",
+ "async-io",
+ "async-mutex",
 "async-task",
+ "blocking",
 "crossbeam-utils",
 "futures-channel",
 "futures-core",
 "futures-io",
+ "futures-lite",
 "kv-log-macro",
 "log",
 "memchr",
@@ -39,7 +116,6 @@ dependencies = [
 "pin-project-lite",
 "pin-utils",
 "slab",
- "smol",
 "wasm-bindgen-futures",
 ]

@@ -72,6 +148,12 @@ version = "1.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "f8aac770f1885fd7e387acedd76065302551364496e46b3dd00860b2f8359b9d"

+[[package]]
+name = "base64"
+version = "0.11.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b41b7ea54a0c9d92199de89e20e58d49f02f8e699814ef3fdf266f6f748d15c7"
+
 [[package]]
 name = "bitflags"
 version = "1.2.1"
@@ -79,16 +161,26 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "cf1de2fe8c75bc145a2f577add951f8134889b4795d47466a54a5c846d691693"

 [[package]]
-name = "blocking"
-version = "0.4.7"
+name = "blake2b_simd"
+version = "0.5.10"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d2468ff7bf85066b4a3678fede6fe66db31846d753ff0adfbfab2c6a6e81612b"
+checksum = "d8fb2d74254a3a0b5cac33ac9f8ed0e44aa50378d9dbb2e5d83bd21ed1dc2c8a"
+dependencies = [
+ "arrayref",
+ "arrayvec",
+ "constant_time_eq",
+]
+
+[[package]]
+name = "blocking"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "76e94bf99b692f54c9d05f97454d3faf11134523fe5b180564a3fb6ed63bcc0a"
 dependencies = [
 "async-channel",
 "atomic-waker",
 "futures-lite",
 "once_cell",
- "parking",
 "waker-fn",
 ]

@@ -117,12 +209,25 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "4785bdd1c96b2a846b2bd7cc02e86b6b3dbf14e7e53446c4f54c92a361040822"

 [[package]]
-name = "clap"
-version = "2.33.1"
+name = "cidr-utils"
+version = "0.5.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bdfa80d47f954d53a35a64987ca1422f495b8d6483c0fe9f7117b36c2a792129"
+checksum = "89f7b6372f3c783f6d44c0da283d3694af4104967bf2371cb3bdc9d09e1cfe00"
 dependencies = [
- "ansi_term",
+ "debug-helper",
+ "num-bigint",
+ "num-traits",
+ "once_cell",
+ "regex",
+]
+
+[[package]]
+name = "clap"
+version = "2.33.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "10040cdf04294b565d9e0319955430099ec3813a64c952b86a41200ad714ae48"
+dependencies = [
+ "ansi_term 0.11.0",
 "atty",
 "bitflags",
 "strsim",
@@ -133,9 +238,9 @@ dependencies = [

 [[package]]
 name = "colored"
-version = "1.9.3"
+version = "2.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f4ffc801dacf156c5854b9df4f425a626539c3a6ef7893cc0c5084a23f0b6c59"
+checksum = "b3616f750b84d8f0de8a58bda93e08e2a81ad3f523089b05f1dffecab48c6cbd"
 dependencies = [
 "atty",
 "lazy_static",
@@ -143,14 +248,26 @@ dependencies = [
 ]

 [[package]]
-name = "concurrent-queue"
-version = "1.1.2"
+name = "colorful"
+version = "0.2.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1582139bb74d97ef232c30bc236646017db06f13ee7cc01fa24c9e55640f86d4"
+checksum = "0bca1619ff57dd7a56b58a8e25ef4199f123e78e503fe1653410350a1b98ae65"
+
+[[package]]
+name = "concurrent-queue"
+version = "1.2.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "30ed07550be01594c6026cff2a1d7fe9c8f683caa798e12b68694ac9e88286a3"
 dependencies = [
 "cache-padded",
 ]

+[[package]]
+name = "constant_time_eq"
+version = "0.1.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "245097e9a4535ee1e3e3931fcfcd55a796a44c643e8596ff6566d68f09b87bbc"
+
 [[package]]
 name = "crossbeam-utils"
 version = "0.7.2"
@@ -163,10 +280,49 @@ dependencies = [
 ]

 [[package]]
-name = "event-listener"
-version = "2.2.1"
+name = "debug-helper"
+version = "0.3.10"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "829694371bd7bbc6aee17c4ff624aad8bf9f4dc06c6f9f6071eaa08c89530d10"
+checksum = "9a8a5bb894f24f42c247f19b25928a88e31867c0f84552c05df41a9dd527435e"
+
+[[package]]
+name = "dirs"
+version = "3.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "142995ed02755914747cc6ca76fc7e4583cd18578746716d0508ea6ed558b9ff"
+dependencies = [
+ "dirs-sys",
+]
+
+[[package]]
+name = "dirs-sys"
+version = "0.3.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8e93d7f5705de3e49895a2b5e0b8855a1c27f080192ae9c32a6432d50741a57a"
+dependencies = [
+ "libc",
+ "redox_users",
+ "winapi",
+]
+
+[[package]]
+name = "env_logger"
+version = "0.7.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "44533bbbb3bb3c1fa17d9f2e4e38bbbaf8396ba82193c4cb1b6445d711445d36"
+dependencies = [
+ "atty",
+ "humantime",
+ "log",
+ "regex",
+ "termcolor",
+]
+
+[[package]]
+name = "event-listener"
+version = "2.3.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "68082183f458867ce7cddea16d4df4443c1537112c0c09c450dedc09daf5c719"

 [[package]]
 name = "fastrand"
@@ -224,15 +380,15 @@ checksum = "de27142b013a8e869c14957e6d2edeef89e97c289e69d042ee3a49acd8b51789"

 [[package]]
 name = "futures-lite"
-version = "0.1.9"
+version = "0.1.10"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8cc8771bd1bb4c7be3c5f072a1d5e18086ef220f100a0a4efece41076e87b9f2"
+checksum = "bbe71459749b2e8e66fb95df721b22fa08661ad384a0c5b519e11d3893b4692a"
 dependencies = [
 "fastrand",
 "futures-core",
 "futures-io",
 "memchr",
- "parking",
+ "parking 1.0.6",
 "pin-project-lite",
 "waker-fn",
 ]
@@ -284,6 +440,23 @@ dependencies = [
 "slab",
 ]

+[[package]]
+name = "gcd"
+version = "2.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1c7cd301bf2ab11ae4e5bdfd79c221d97a25e46c089144a62ee9d09cb32d2b92"
+
+[[package]]
+name = "getrandom"
+version = "0.1.14"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7abc8dd8451921606d809ba32e95b6111925cd2906060d2dcc29c070220503eb"
+dependencies = [
+ "cfg-if",
+ "libc",
+ "wasi",
+]
+
 [[package]]
 name = "heck"
 version = "0.3.1"
@@ -303,10 +476,19 @@ dependencies = [
 ]

 [[package]]
-name = "js-sys"
-version = "0.3.42"
+name = "humantime"
+version = "1.3.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "52732a3d3ad72c58ad2dc70624f9c17b46ecd0943b9a4f1ee37c4c18c5d983e2"
+checksum = "df004cfca50ef23c36850aaaa59ad52cc70d0e90243c3c7737a4dd32dc7a3c4f"
+dependencies = [
+ "quick-error",
+]
+
+[[package]]
+name = "js-sys"
+version = "0.3.44"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "85a7e2c92a4804dd459b86c339278d0fe87cf93757fae222c3fa3ae75458bc73"
 dependencies = [
 "wasm-bindgen",
 ]
@@ -328,9 +510,9 @@ checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646"

 [[package]]
 name = "libc"
-version = "0.2.73"
+version = "0.2.74"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bd7d4bd64732af4bf3a67f367c27df8520ad7e230c5817b8ff485864d80242b9"
+checksum = "a2f02823cf78b754822df5f7f268fb59822e7296276d3e069d8e8cb26a14bd10"

 [[package]]
 name = "log"
@@ -347,6 +529,47 @@ version = "2.3.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "3728d817d99e5ac407411fa471ff9800a778d88a24685968b36824eaf4bee400"

+[[package]]
+name = "multitask"
+version = "0.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c09c35271e7dcdb5f709779111f2c8e8ab8e06c1b587c1c6a9e179d865aaa5b4"
+dependencies = [
+ "async-task",
+ "concurrent-queue",
+ "fastrand",
+]
+
+[[package]]
+name = "num-bigint"
+version = "0.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b7f3fc75e3697059fb1bc465e3d8cca6cf92f56854f201158b3f9c77d5a3cfa0"
+dependencies = [
+ "autocfg",
+ "num-integer",
+ "num-traits",
+]
+
+[[package]]
+name = "num-integer"
+version = "0.1.43"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8d59457e662d541ba17869cf51cf177c0b5f0cbf476c66bdc90bf1edac4f875b"
+dependencies = [
+ "autocfg",
+ "num-traits",
+]
+
+[[package]]
+name = "num-traits"
+version = "0.2.12"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ac267bcc07f48ee5f8935ab0d24f316fb722d7a1292e2913f0cc196b29ffd611"
+dependencies = [
+ "autocfg",
+]
+
 [[package]]
 name = "num_cpus"
 version = "1.13.0"
@@ -370,19 +593,25 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "6cb300f271742d4a2a66c01b6b2fa0c83dfebd2e0bf11addb879a3547b4ed87c"

 [[package]]
-name = "pin-project"
-version = "0.4.22"
+name = "parking"
+version = "2.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "12e3a6cdbfe94a5e4572812a0201f8c0ed98c1c452c7b8563ce2276988ef9c17"
+checksum = "427c3892f9e783d91cc128285287e70a59e206ca452770ece88a76f7a3eddd72"
+
+[[package]]
+name = "pin-project"
+version = "0.4.23"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ca4433fff2ae79342e497d9f8ee990d174071408f28f726d6d83af93e58e48aa"
 dependencies = [
 "pin-project-internal",
 ]

 [[package]]
 name = "pin-project-internal"
-version = "0.4.22"
+version = "0.4.23"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6a0ffd45cf79d88737d7cc85bfd5d2894bee1139b356e616fe85dc389c61aaf7"
+checksum = "2c0e815c3ee9a031fdf5af21c10aa17c573c9c6a566328d99e3936c34e36461f"
 dependencies = [
 "proc-macro2",
 "quote",
@@ -402,10 +631,28 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "8b870d8c151b6f2fb93e84a13146138f05d02ed11c7e7c54f8826aaaf7c9f184"

 [[package]]
-name = "proc-macro-error"
-version = "1.0.3"
+name = "polling"
+version = "0.1.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "fc175e9777c3116627248584e8f8b3e2987405cabe1c0adf7d1dd28f09dc7880"
+checksum = "b6d83023eb990619815bb41b45625b02da62b00d0f24b0a08aae37697b3f6c94"
+dependencies = [
+ "cfg-if",
+ "libc",
+ "wepoll-sys-stjepang",
+ "winapi",
+]
+
+[[package]]
+name = "ppv-lite86"
+version = "0.2.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "237a5ed80e274dbc66f86bd59c1e25edc039660be53194b5fe0a482e0f2612ea"
+
+[[package]]
+name = "proc-macro-error"
+version = "1.0.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "da25490ff9892aab3fcf7c36f08cfb902dd3e71ca0f9f9517bea02a73a5ce38c"
 dependencies = [
 "proc-macro-error-attr",
 "proc-macro2",
@@ -416,22 +663,20 @@ dependencies = [

 [[package]]
 name = "proc-macro-error-attr"
-version = "1.0.3"
+version = "1.0.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3cc9795ca17eb581285ec44936da7fc2335a3f34f2ddd13118b6f4d515435c50"
+checksum = "a1be40180e52ecc98ad80b184934baf3d0d29f979574e439af5a55274b35f869"
 dependencies = [
 "proc-macro2",
 "quote",
- "syn",
- "syn-mid",
 "version_check",
 ]

 [[package]]
 name = "proc-macro-hack"
-version = "0.5.16"
+version = "0.5.18"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7e0456befd48169b9f13ef0f0ad46d492cf9d2dbb918bcf38e01eed4ce3ec5e4"
+checksum = "99c605b9a0adc77b7211c6b1f722dcb613d68d66859a44f3d485a6da332b0598"

 [[package]]
 name = "proc-macro-nested"
@@ -448,6 +693,12 @@ dependencies = [
 "unicode-xid",
 ]

+[[package]]
+name = "quick-error"
+version = "1.2.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a1d01941d82fa2ab50be1e79e6714289dd7cde78eba4c074bc5a4374f650dfe0"
+
 [[package]]
 name = "quote"
 version = "1.0.7"
@@ -457,6 +708,47 @@ dependencies = [
 "proc-macro2",
 ]

+[[package]]
+name = "rand"
+version = "0.7.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6a6b1679d49b24bbfe0c803429aa1874472f50d9b363131f0e89fc356b544d03"
+dependencies = [
+ "getrandom",
+ "libc",
+ "rand_chacha",
+ "rand_core",
+ "rand_hc",
+]
+
+[[package]]
+name = "rand_chacha"
+version = "0.2.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f4c8ed856279c9737206bf725bf36935d8666ead7aa69b52be55af369d193402"
+dependencies = [
+ "ppv-lite86",
+ "rand_core",
+]
+
+[[package]]
+name = "rand_core"
+version = "0.5.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "90bde5296fc891b0cef12a6d03ddccc162ce7b2aff54160af9338f8d40df6d19"
+dependencies = [
+ "getrandom",
+]
+
+[[package]]
+name = "rand_hc"
+version = "0.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ca3129af7b92a17112d59ad498c6f81eaf463253766b90396d39ea7a39d6613c"
+dependencies = [
+ "rand_core",
+]
+
 [[package]]
 name = "redox_syscall"
 version = "0.1.57"
@@ -464,25 +756,77 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "41cc0f7e4d5d4544e8861606a285bb08d3e70712ccc7d2b84d7c0ccfaf4b05ce"

 [[package]]
-name = "rlimit"
-version = "0.3.0"
+name = "redox_users"
+version = "0.3.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e6d26e65e82a1e2628c5f209ec12f4508fa50e644bd2f264138e60129d61eae8"
+checksum = "09b23093265f8d200fa7b4c2c76297f47e681c655f6f1285a8780d6a022f7431"
+dependencies = [
+ "getrandom",
+ "redox_syscall",
+ "rust-argon2",
+]
+
+[[package]]
+name = "regex"
+version = "1.3.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9c3780fcf44b193bc4d09f36d2a3c87b251da4a046c87795a0d35f4f927ad8e6"
+dependencies = [
+ "aho-corasick",
+ "memchr",
+ "regex-syntax",
+ "thread_local",
+]
+
+[[package]]
+name = "regex-syntax"
+version = "0.6.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "26412eb97c6b088a6997e05f69403a802a92d520de2f8e63c2b65f9e0f47c4e8"
+
+[[package]]
+name = "rlimit"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "49b02d62c38353a6fce45c25ca19783e25dd5f495ca681c674a4ee15aa4c1536"
 dependencies = [
 "cfg-if",
 "libc",
 ]

 [[package]]
-name = "rustscan"
-version = "1.3.0"
+name = "rust-argon2"
+version = "0.7.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2bc8af4bda8e1ff4932523b94d3dd20ee30a87232323eda55903ffd71d2fb017"
 dependencies = [
+ "base64",
+ "blake2b_simd",
+ "constant_time_eq",
+ "crossbeam-utils",
+]
+
+[[package]]
+name = "rustscan"
+version = "1.8.0"
+dependencies = [
+ "ansi_term 0.12.1",
 "async-std",
+ "cidr-utils",
 "colored",
+ "colorful",
+ "dirs",
+ "env_logger",
 "futures",
+ "gcd",
+ "log",
+ "rand",
 "rlimit",
+ "serde",
+ "serde_derive",
 "shell-words",
 "structopt",
+ "toml",
 ]

 [[package]]
@@ -491,6 +835,23 @@ version = "1.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "ea6a9290e3c9cf0f18145ef7ffa62d68ee0bf5fcd651017e586dc7fd5da448c2"

+[[package]]
+name = "serde"
+version = "1.0.115"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e54c9a88f2da7238af84b5101443f0c0d0a3bbdc455e34a5c9497b1903ed55d5"
+
+[[package]]
+name = "serde_derive"
+version = "1.0.115"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "609feed1d0a73cc36a0182a840a9b37b4a82f0b1150369f0536a9e3f2a31dc48"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
 [[package]]
 name = "shell-words"
 version = "1.0.0"
@@ -503,27 +864,6 @@ version = "0.4.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "c111b5bd5695e56cffe5129854aa230b39c93a305372fdbb2668ca2394eea9f8"

-[[package]]
-name = "smol"
-version = "0.1.18"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "620cbb3c6e34da57d3a248cda0cd01cd5848164dc062e764e65d06fe3ea7aed5"
-dependencies = [
- "async-task",
- "blocking",
- "concurrent-queue",
- "fastrand",
- "futures-io",
- "futures-util",
- "libc",
- "once_cell",
- "scoped-tls",
- "slab",
- "socket2",
- "wepoll-sys-stjepang",
- "winapi",
-]
-
 [[package]]
 name = "socket2"
 version = "0.3.12"
@@ -544,9 +884,9 @@ checksum = "8ea5119cdb4c55b55d432abb513a0429384878c15dde60cc77b1c99de1a95a6a"

 [[package]]
 name = "structopt"
-version = "0.3.15"
+version = "0.3.17"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "de2f5e239ee807089b62adce73e48c625e0ed80df02c7ab3f068f5db5281065c"
+checksum = "6cc388d94ffabf39b5ed5fadddc40147cb21e605f53db6f8f36a625d27489ac5"
 dependencies = [
 "clap",
 "lazy_static",
@@ -555,9 +895,9 @@ dependencies = [

 [[package]]
 name = "structopt-derive"
-version = "0.4.8"
+version = "0.4.10"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "510413f9de616762a4fbeab62509bf15c729603b72d7cd71280fbca431b1c118"
+checksum = "5e2513111825077552a6751dfad9e11ce0fba07d7276a3943a037d7e93e64c5f"
 dependencies = [
 "heck",
 "proc-macro-error",
@@ -568,9 +908,9 @@ dependencies = [

 [[package]]
 name = "syn"
-version = "1.0.35"
+version = "1.0.38"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "fb7f4c519df8c117855e19dd8cc851e89eb746fe7a73f0157e0d95fdec5369b0"
+checksum = "e69abc24912995b3038597a7a593be5053eb0fb44f3cc5beec0deb421790c1f4"
 dependencies = [
 "proc-macro2",
 "quote",
@@ -578,14 +918,12 @@ dependencies = [
 ]

 [[package]]
-name = "syn-mid"
-version = "0.5.0"
+name = "termcolor"
+version = "1.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7be3539f6c128a931cf19dcee741c1af532c7fd387baa739c03dd2e96479338a"
+checksum = "bb6bfa289a4d7c5766392812c0a1f4c1ba45afa1ad47803c11e1f407d846d75f"
 dependencies = [
- "proc-macro2",
- "quote",
- "syn",
+ "winapi-util",
 ]

 [[package]]
@@ -597,6 +935,24 @@ dependencies = [
 "unicode-width",
 ]

+[[package]]
+name = "thread_local"
+version = "1.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d40c6d1b69745a6ec6fb1ca717914848da4b44ae29d9b3080cbee91d72a69b14"
+dependencies = [
+ "lazy_static",
+]
+
+[[package]]
+name = "toml"
+version = "0.5.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ffc92d160b1eef40665be3a05630d003936a3bc7da7421277846c2613e92c71a"
+dependencies = [
+ "serde",
+]
+
 [[package]]
 name = "unicode-segmentation"
 version = "1.6.0"
@@ -615,6 +971,12 @@ version = "0.2.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "f7fe0bb3479651439c9112f72b6c505038574c9fbb575ed1bf3b797fa39dd564"

+[[package]]
+name = "vec-arena"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "17dfb54bf57c9043f4616cb03dab30eff012cc26631b797d8354b916708db919"
+
 [[package]]
 name = "vec_map"
 version = "0.8.2"
@@ -634,10 +996,16 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "9571542c2ce85ce642e6b58b3364da2fb53526360dfb7c211add4f5c23105ff7"

 [[package]]
-name = "wasm-bindgen"
-version = "0.2.65"
+name = "wasi"
+version = "0.9.0+wasi-snapshot-preview1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f3edbcc9536ab7eababcc6d2374a0b7bfe13a2b6d562c5e07f370456b1a8f33d"
+checksum = "cccddf32554fecc6acb585f82a32a72e28b48f8c4c1883ddfeeeaa96f7d8e519"
+
+[[package]]
+name = "wasm-bindgen"
+version = "0.2.67"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f0563a9a4b071746dd5aedbc3a28c6fe9be4586fb3fbadb67c400d4f53c6b16c"
 dependencies = [
 "cfg-if",
 "wasm-bindgen-macro",
@@ -645,9 +1013,9 @@ dependencies = [

 [[package]]
 name = "wasm-bindgen-backend"
-version = "0.2.65"
+version = "0.2.67"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "89ed2fb8c84bfad20ea66b26a3743f3e7ba8735a69fe7d95118c33ec8fc1244d"
+checksum = "bc71e4c5efa60fb9e74160e89b93353bc24059999c0ae0fb03affc39770310b0"
 dependencies = [
 "bumpalo",
 "lazy_static",
@@ -660,9 +1028,9 @@ dependencies = [

 [[package]]
 name = "wasm-bindgen-futures"
-version = "0.4.15"
+version = "0.4.17"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "41ad6e4e8b2b7f8c90b6e09a9b590ea15cb0d1dbe28502b5a405cd95d1981671"
+checksum = "95f8d235a77f880bcef268d379810ea6c0af2eacfa90b1ad5af731776e0c4699"
 dependencies = [
 "cfg-if",
 "js-sys",
@@ -672,9 +1040,9 @@ dependencies = [

 [[package]]
 name = "wasm-bindgen-macro"
-version = "0.2.65"
+version = "0.2.67"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "eb071268b031a64d92fc6cf691715ca5a40950694d8f683c5bb43db7c730929e"
+checksum = "97c57cefa5fa80e2ba15641578b44d36e7a64279bc5ed43c6dbaf329457a2ed2"
 dependencies = [
 "quote",
 "wasm-bindgen-macro-support",
@@ -682,9 +1050,9 @@ dependencies = [

 [[package]]
 name = "wasm-bindgen-macro-support"
-version = "0.2.65"
+version = "0.2.67"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cf592c807080719d1ff2f245a687cbadb3ed28b2077ed7084b47aba8b691f2c6"
+checksum = "841a6d1c35c6f596ccea1f82504a192a60378f64b3bb0261904ad8f2f5657556"
 dependencies = [
 "proc-macro2",
 "quote",
@@ -695,15 +1063,15 @@ dependencies = [

 [[package]]
 name = "wasm-bindgen-shared"
-version = "0.2.65"
+version = "0.2.67"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "72b6c0220ded549d63860c78c38f3bcc558d1ca3f4efa74942c536ddbbb55e87"
+checksum = "93b162580e34310e5931c4b792560108b10fd14d64915d7fff8ff00180e70092"

 [[package]]
 name = "web-sys"
-version = "0.3.42"
+version = "0.3.44"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8be2398f326b7ba09815d0b403095f34dd708579220d099caae89be0b32137b2"
+checksum = "dda38f4e5ca63eda02c059d243aa25b5f35ab98451e518c51612cd0f1bd19a47"
 dependencies = [
 "js-sys",
 "wasm-bindgen",
@@ -734,6 +1102,15 @@ version = "0.4.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"

+[[package]]
+name = "winapi-util"
+version = "0.1.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "70ec6ce85bb158151cae5e5c87f95a8e97d2c0c4b001223f33a334e3ce5de178"
+dependencies = [
+ "winapi",
+]
+
 [[package]]
 name = "winapi-x86_64-pc-windows-gnu"
 version = "0.4.0"
@@ -1,26 +1,44 @@
 [package]
 name = "rustscan"
-version = "1.3.0"
+version = "1.8.0"
 authors = ["Bee <[email protected]>"]
 edition = "2018"
 description = "Faster Nmap Scanning with Rust"
-homepage = "https://github.com/brandonskerritt/rustscan"
-repository = "https://github.com/brandonskerritt/rustscan"
+homepage = "https://github.com/rustscan/rustscan"
+repository = "https://github.com/rustscan/rustscan"
 license = "MIT"
 keywords = ["port", "scanning", "nmap"]
 categories = ["command-line-utilities"]
 readme="README.md"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+exclude = [
+    ".github/*",
+    "pictures/*",
+    "rustscan-debbuilder/*",
+]

 [dependencies]
-colored = "1.9.3"
-structopt = "0.3.15"
-async-std = "1.6.2"
+colored = "2.0.0"
+structopt = "0.3.17"
+async-std = "1.6.3"
 futures = "0.3"
-rlimit = "0.3.0"
+rlimit = "0.4.0"
 shell-words = "1.0.0"
+log = "0.4.0"
+env_logger = "0.7.1"
+dirs = "3.0.1"
+gcd = "2.0.1"
+rand = "0.7.3"
+colorful = "0.2.1"
+ansi_term = "0.12.1"
+toml = "0.5.6"
+serde = "1.0.115"
+serde_derive = "1.0.115"
+cidr-utils = "0.5.0"

 [package.metadata.deb]
 depends = "$auto, nmap"
+section = "rust"

+[profile.release]
+lto = true
+panic = 'abort'
@@ -0,0 +1,16 @@
+FROM rust:alpine as builder
+RUN apk add --no-cache build-base
+
+WORKDIR /usr/src/rustscan
+COPY . .
+RUN cargo install --path .
+
+FROM alpine:3.12
+LABEL author="Hydragyrum <https://github.com/Hydragyrum>"
+RUN addgroup -S rustscan && \
+    adduser -S -G rustscan rustscan && \
+    ulimit -n 100000 && \
+    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" ]
@@ -0,0 +1,21 @@
+install:
+	cargo install cross
+
+build:
+	make build-linux
+	make build-mac
+
+	make shasum
+
+build-linux:
+	@echo 'Building for Linux... 🐧'
+	cross build --release --target=x86_64-unknown-linux-musl
+	mkdir -p target/release-archives && tar -czf target/release-archives/rustscan-linux.tar.gz target/x86_64-unknown-linux-musl/release/rustscan 
+
+build-mac:
+	@echo 'Building for MacOS... 🍏'
+	cross build --release --target=x86_64-apple-darwin
+	mkdir -p target/release-archives && tar -czf target/release-archives/rustscan-mac.tar.gz target/x86_64-apple-darwin/release/rustscan
+
+shasum:
+	shasum -a 256 target/release-archives/rustscan-*.tar.gz
@@ -1,292 +1,116 @@
 <p align="center">
-➡️ 
-<a href="https://discord.gg/r38pna">Discord</a> |
+➡️
+<a href="https://discord.gg/GFrQsGy">Discord</a> |
 <a href="https://github.com/RustScan/RustScan#-full-installation-guide">Installation Guide</a> |
 <a href="https://github.com/RustScan/RustScan#-usage">Usage Guide</a>
 ⬅️
 <br>
-<img src="pictures/rustscan.png">
+<img src="pictures/rustscan.png" height=400px width=400px>
 </p>
 <p align="center">
-<u><b> Turns a 17 minutes Nmap scan into 19 seconds. </b></u><br> Find all open ports <b>fast</b> with RustScan, automatically pipe them into Nmap. 
+<u><b> 👽 The Modern Day Port Scanner 👽
 </p>
 <p align="center">
-<img alt="AUR version" src="https://img.shields.io/aur/version/rustscan-bin">
+<img alt="AUR version" src="https://img.shields.io/aur/version/rustscan">
 <img src="https://img.shields.io/badge/Built%20with-Rust-Purple">
-<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/w/brandonskerritt/rustscan">
 <img alt="GitHub All Releases" src="https://img.shields.io/github/downloads/rustscan/rustscan/total?label=GitHub%20Downloads">
 <img alt="Crates.io" src="https://img.shields.io/crates/d/rustscan?label=Cargo%20Downloads">
 <img alt="Discord" src="https://img.shields.io/discord/736614461313515576">
-<img alt="Actions" src="https://github.com/RustScan/RustScan/workflows/Continuous%20integration/badge.svg">
+<img alt="Actions" src="https://github.com/RustScan/RustScan/workflows/Continuous%20integration/badge.svg?branch=master">
 </p>
 <hr>

-
-| <p align="center"><a href="https://crates.io/crates/rustscan">🔧 Cargo (Universal) </a></p> | <p align="center"><a href="https://crates.io/crates/rust_scan"> Arch </a></p> | <p align="center"><a href="https://crates.io/crates/rust_scan"> HomeBrew </a></p> | <p align="center"><a href="https://crates.io/crates/rust_scan"> Kali / Debian </p> |
-| ---- | ---- | ---- | --- |
-| <p align="center"><img src="pictures/rust.png" /></p>  | <p align="center"><img src="pictures/arch.png" /></p> | <p align="center"><img src="pictures/apple.png" /></p> | <p align="center"><img src="pictures/kali.png" /></p> |
-| `cargo install rustscan` | `yay -S rustscan` | `brew tap brandonskerritt/rustscan && brew install rustscan` | [Read the install guide](https://github.com/brandonskerritt/RustScan/blob/master/README.md#%EF%B8%8F-debian--kali) |
+| <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">🔧 Cargo (Universal) </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://github.com/RustScan/RustScan/blob/master/pictures/rust.png?raw=true" /></p> |
+| `docker pull rustscan/rustscan:alpine` <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`                                                                                               | `cargo install rustscan`                                                                                        |

 <hr>

 # 🤔 What is this?
-1. Find ports quickly using Rustscan (**8 seconds at its fastest**).
-2. Automatically runs `nmap` on those ports.
-3. ???
-4. Profit!

-<table>
-  <tr>
-  <th>Name</th>
-    <th>⚡ Nmap <b>with RustScan</b> ⚡ </th>
-    <th>🐢 Nmap 🐢</th>
-  </tr>
-  <tr>
-  <th>Gif</th>
-    <td><img src="pictures/with_rustscan.gif" alt="The guy she tells you not to worry about"></td>
-    <td><img src="pictures/without_rustscan.gif" alt="You"></td>
-  </tr>
-  <tr>
-  <th>Time</th>
-    <td><b>39 seconds</b></td>
-    <td><b>17 minutes and 41 seconds</b></td>
-  </tr>
-</table>
+RustScan is the port scanner for the modern world. Built with speed & you in mind.

-<sub><b>Note</b> This is an older gif. RustScan's current top speed is 8 seconds for all 65k ports. This gif is 26 seconds.</sub><br>
+![pictures](pictures/with_rustscan.gif)

-RustScans **only** job is to reduce the friction between finding open ports and inputting them into nmap.

 # ✨ Features
-* Scans all 65k ports in **8 seconds** (on 10k batch size).
-* Saves you time by automatically piping it into Nmap. No more manual copying and pasting!
-* Does one thing and does it well. **Only** purpose is to improve Nmap, not replace it!
-* Let's you choose what Nmap commands to run, or uses the default.
+
+- Scans all 65k ports in **3 seconds** (max speed) **or as slow as you'd like**
+- Saves you time by automatically piping it into Nmap. No more manual copying and pasting!
+- Adaptive Learning System. The scanner learns how _you_ use it and improves itself over time.
+- Intuitive Scripting Engine support. Write scripts in Python!
+- IPv6, CIDR, top ports, multiple IP scanning, host resolution, and more!
+
+## ‼️ Important Links
+
+| 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) |
+

 # 🔭 Why RustScan?
-Why spend time running fast scans and manually copying the ports, or waiting for a 20 minute scan to finish when you can just do all 65k ports in less than a minute?

-![gif](pictures/8seconds.gif)
+RustScan is a port scanner built for the modern day world. Initially created to aid in CTFs, but now expanded to real world usage. 
+
+One of RustScan's most popular features is the Nmap extension. Quickly scan ports with RustScan, run Nmap on the found ports.

 **RustScan running in 8 seconds and finding all open ports out of 65k.**

-## 📊 RustScan vs Nmap vs MassScan
+![gif](https://github.com/RustScan/RustScan/blob/master/pictures/8seconds.gif?raw=true)

-| **Name**                                                                                   | RustScan | Nmap | Masscan |
-| ------------------------------------------------------------------------------------------ | -------- | ---- | ------- |
-| Fast                                                                                       | ✅        | ❌    | ✅       |
-| Actually useful                                                                            | ❌        | ✅    | ❌       |
-| Realises it's not useful, and pipes the only useful data into the only useful port scanner | ✅        | ❌    | ❌       |
+# Packages

+[![Packaging status](https://repology.org/badge/vertical-allrepos/rustscan.svg)](https://repology.org/project/rustscan/versions)

-## 🙋 FAQ
-> I think this would be a great port scanner on its own without Nmap!

-No. If you want a fast port scanner, use Masscan.
-> I have this great idea for a script to get information on ports / hosts
+# 🎪 Community

-Great. Contribute it to Nmap! :D
-> Not everyone has nmap installed....
+Howdy Space Cow-Person 🤠🌌

-If you're a pentester, then yes, you have Nmap installed. 
+RustScan is always looking for contributors. Whether that's spelling mistakes or major changes, your help is **wanted** and welcomed here.

-> I want to contribute!
+Before contributing, read our [code of conduct](https://github.com/RustScan/RustScan/blob/master/CODE_OF_CONDUCT.md).

-Great! I'd love some help with this. Read the [contributing.md file](contributing.md) file for more information!
+TL;DR if you abuse members of our community you will be **perma-banned** 🤗

-# 📖 Full Installation Guide
-**You need Nmap**. If you have Kali Linux or Parrot OS installed, you already have Nmap. If not, [follow the nmap install guide](https://nmap.org/download.html).
+RustScan has 2 major labels for GitHub issues you should look at:

-The easiest way to install RustScan is to use one of the packages provided for your system, such as HomeBrew or Yay for Arch Linux.
+- 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 wiht 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)

-The most universal way is to use `cargo`, Rust's built in package manager (think Pip but for Rust). [Follow this guide to installing Rust & Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html).
+If you want to, solve the issue or comment on the issue for help.

-If you face any issues at all, please leave a GitHub issue. I have only tested this on Linux, so there may be issues for Mac OS or Windows. 
+The flow for contributing to open source software is:

-Note: sometimes Rust doesn't add Cargo to the path. Please see [this issue](https://github.com/rust-lang/rustup/issues/2436) for how to fix that.
+- Fork the repo
+- Make changes
+- Pull request to the repo

-## 🖥️ Debian / Kali
+And then comment on the issue that you've done.

-Download the .deb file from the releases page:
+RustScan also has some `// TODO`'s in the codebase, which are meant more for the core team but we wouldn't say no to help with these issues.

-[https://github.com/brandonskerritt/RustScan/releases](https://github.com/brandonskerritt/RustScan/releases)
+If you have any feature suggestions or bugs, leave a GitHub issue. We welcome any and all support :D

-Run the commpand `dpkg -i` on the file. 
+We communicate over Discord. [Click here](https://discord.gg/GFrQsGy) to join our Discord community!

-Note: sometimes you can double click the file to achieve the same result.
+## Rewarding you

-### 🥧 .deb file not working?
-The .deb file only works on AMD64 CPUs. If yours is different (such as a Raspberry Pi) or the .deb file doesn't work, it is easy to build the .deb file yourself.
-**Note**: It is easier to install Rust and install via Cargo, then it is to build the .deb file. But this is just in case!
+I cannot pay you :-( But, I can place your GitHub profile on the README under `#Contributors` as a thank you! :)

-1. Install Rust You can do this with `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh` which I took from the Rust website https://www.rust-lang.org/tools/install
-2. `cargo install rustscan` if you want the easiest method possible. Otherwise, to build the .deb file `cargo install cargo-deb`
-3. Git clone this repo `git clone https://github.com/brandonskerritt/RustScan`
-4. cd RustScan (into the git cloned repo) `cd RustScan`
-5. Run `cargo deb`
-6. Your .deb file is now located in `target/releases/Debian/`
-
-## 🍺 HomeBrew
-
-Tap the brew:
-
-```
-brew tap brandonskerritt/rustscan
-```
-
-Install it:
-
-```
-brew install rustscan
-```
-
-## 🔧 Building it yourself
-
-1. Git clone the repo.
-2. Install Rust. You can do this with `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh` which I took from the Rust website https://www.rust-lang.org/tools/install
-3. cd into the Git repo, and run `cargo build --release`
-4. The binary is located at `target/release/rustscan`
-5. Symlink to the binary or something. Whatever you want!
-
-# 🤸 Usage
-
-```
-rustscan -h
-```
-
-```
-RustScan 1.2.0
-Bee https://github.com/brandonskerritt
-Fast Port Scanner built in Rust
-WARNING Do not use this program against sensitive infrastructure. The specified server may not be able to handle this
-many socket connections at once.
-
-USAGE:
-    rustscan [FLAGS] [OPTIONS] <ip> [command]...
-
-FLAGS:
-    -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:
-    -T, --timeout <T>    The timeout before a port is assumed to be close. In MS. [default: 1500]
-    -b, --batch <b>      Increases speed of scanning. The batch size for port scanning. Depends on your open file limit
-                         of OS. If you do 65535 it will do every port at the same time. Although, your OS may not
-                         support this. [default: 4500]
-    -u, --ulimit <u>     Automatically ups the ULIMIT with the value you provided.
-
-ARGS:
-    <ip>            The IP address to scan
-    <command>...    The Nmap arguments to run. To use the argument -A, end RustScan's args with '-- -A'. To run
-                    EXAMPLE: 'rustscan -T 1500 127.0.0.1 -- -A -sC'. This argument auto runs nmap {your commands}
-                    -vvv -p $PORTS 
-```
-
-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.
-
-The batch size determines how fast RustScan is. Set it to 65k, and it will scan all 65k ports at the same time. This means at at 65k batch size, RustScan will take TIMEOUT long to scan all ports. Essentially, if timeout is 1000ms, **RustScan can scan in 1 second**. 
-
-Your operating system may not support this, but it is worth it to play around and see where your open file limit is. Shortly I will be releasing a dockerised version with a much larger open file limit, so this will be possible.
-
-## ⚠️ WARNING
-
-This program, by default, scans 5000 ports at a time (5000 per second). 
-
-This may cause damage to a server, or may make it incredibly obvious you are scanning the server.
-
-There are 2 ways to deal with this;
-1. Decrease batch size
-`rustscan -b 10` will run 10 port scans for 1 second, and then another 10 for 1 second and so on.
-2. Increase timeout
-`rustscan -T 5000` will mean RustScan waits 5 seconds until it scans the next ports.
-
-You can also use both of these at the same time, to make it as slow or as fast as you want. A fun favourite is 65535 batch size with 1 second timeout. Theoretically, this scans all 65535 ports in 1 second.
-
-**Please** do not use this tool against sensitive servers. It is designed mainly for Capture the Flag events, not real world servers with sensitive data.
-
-## 🚨 Thread Paniced at Main: Too Many Open Files
-This is the most common error found in RustScan.
-
-The open file limit is how many open sockets you can have at any given time.
-
-This limit changes from OS to OS.
-
-RustScan does not automatically create defaults (other than 5000) like Nmap does with their -T1, -T2 system.
-
-By figuring out for yourself the optimal batch size, you will know that RustScan is the most optimised port scanner for your system. 
-
-There are 2 things you can do:
-1. Decrease batch size
-2. Increase open file limit
-
-Decreasing batch size slows down the program, so as long as it isn't too drastic, this is a good option.
-
-Run these 3 commands:
-
-```
-ulimit -a
-ulimit -Hn
-ulimit -Sn
-```
-
-They will give you an idea on the open file limit of your OS.
-
-If it says "250", run `rustscan -b 240` for a batch size of 240.
-
-Increasing the open file limit increases speed, but poses danger. Although, **opening more file sockets on the specified IP address may damage it**.
-
-To open more, set the ulimit to a higher number:
-
-```
-ulimit -n 5000
-```
-
-**Mac OS**
-Mac OS has, from what I can tell, a naturally very low open file descriptor limit. The limit for Ubuntu is 8800. The limit for Mac OS is 255! 
-
-In this case, I would say it is safe to increase the open file limit. As most Linux based OS' have limits in the thousands. 
-
-Although, if this breaks anything, please don't blame me. 
-
-**Windows Subsystem for Linux**
-Windows Subsystem for Linux does not support ulimt (see issue #39). 
-
-The best way is to use it on a host computer, in Docker, or in a VM that isn't WSL. 
-
-**Automatic Ulimit updating**
-We are currently working on automatic Ulimit updating. If it is too high, it will lower itself. If it is too low, it will suggest a higher Ulimit. Watch [this issue](https://github.com/brandonskerritt/RustScan/issues/25) for more.
-
-## 🔌 Nmap Custom Flags
-To run your own nmap commands, end the RustScan command with `-- -A` where `--` indicates "end of RustScan flags, please do not parse anything further" and any flags after that will be entered into nmap.
-
-RustScan automatically runs `nmap -vvv -p $PORTS $IP`. To make it run `-A`, execute the command `rustscan 127.0.0.1 -- -A`. 
-
-If you want to run commands such as `--script (vuln and safe)`, you will need to enclose it in quotations like so `--script '"(vuln and safe) or default"'`.
-
-## 🎯 Increasing speed / accuracy
-* Batch size
-
-This increases speed, by allowing us to process more at once. Something experimental I am working on is changing the open file limit. You can do this manually with `ulimit -n 70000` and then running rustscan with `-b 65535`. This _should_ scan all 65535 ports at the exact same time. But this is extremely experimental.
-
-For non-experimental speed increases, slowly increase the batch size until it no longer gets open ports, or it breaks.
-
-* Accuracy (and some speed)
-
-To increase accuracy, the easiest way is to increase the timeout. The default is 1.5 seconds, by setting it to 4 seconds (4000) we are telling RustScan "if we do not hear back from a port in 4 seconds, assume it is closed".
-
-Decreasing accuracy gives some speed bonus, but my testing found that batch size dramatically changed the speed whereas timeout did, but not so much.
-
-# 🎪 Contributing
 Please read the [contributing.md file](contributing.md)

-# 💻 Other Hacking Projects By This Author
-## 🧮 Ciphey
-Ciphey is an automated decryption tool using artifical intelligence & natural language processing.
-[Check it out here!](https://github.com/ciphey/ciphey)
 ## Contributors ✨
+
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-)
+
+[![All Contributors](https://img.shields.io/badge/all_contributors-18-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)):
@@ -296,17 +120,34 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- markdownlint-disable -->
 <table>
  <tr>
-    <td align="center"><a href="https://skerritt.blog"><img src="https://avatars3.githubusercontent.com/u/10378052?v=4" width="100px;" alt=""/><br /><sub><b>Brandon</b></sub></a><br /><a href="#infra-brandonskerritt" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/brandonskerritt/RustScan/commits?author=brandonskerritt" title="Tests">⚠️</a> <a href="https://github.com/brandonskerritt/RustScan/commits?author=brandonskerritt" title="Code">💻</a> <a href="#design-brandonskerritt" title="Design">🎨</a></td>
-    <td align="center"><a href="https://sakiir.ovh"><img src="https://avatars1.githubusercontent.com/u/9950578?v=4" width="100px;" alt=""/><br /><sub><b>SakiiR</b></sub></a><br /><a href="https://github.com/brandonskerritt/RustScan/commits?author=SakiiR" title="Code">💻</a> <a href="https://github.com/brandonskerritt/RustScan/issues?q=author%3ASakiiR" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://skerritt.blog"><img src="https://avatars3.githubusercontent.com/u/10378052?v=4" width="100px;" alt=""/><br /><sub><b>Brandon</b></sub></a><br /><a href="#infra-brandonskerritt" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/RustScan/RustScan/commits?author=brandonskerritt" title="Tests">⚠️</a> <a href="https://github.com/RustScan/RustScan/commits?author=brandonskerritt" title="Code">💻</a> <a href="#design-brandonskerritt" title="Design">🎨</a></td>
+    <td align="center"><a href="https://sakiir.ovh"><img src="https://avatars1.githubusercontent.com/u/9950578?v=4" width="100px;" alt=""/><br /><sub><b>SakiiR</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=SakiiR" title="Code">💻</a> <a href="https://github.com/RustScan/RustScan/issues?q=author%3ASakiiR" title="Bug reports">🐛</a></td>
    <td align="center"><a href="https://github.com/smackhack"><img src="https://avatars2.githubusercontent.com/u/48143394?v=4" width="100px;" alt=""/><br /><sub><b>smackhack</b></sub></a><br /><a href="#ideas-smackhack" title="Ideas, Planning, & Feedback">🤔</a> <a href="#example-smackhack" title="Examples">💡</a></td>
-    <td align="center"><a href="http://bernardoamc.github.io/"><img src="https://avatars0.githubusercontent.com/u/428984?v=4" width="100px;" alt=""/><br /><sub><b>Bernardo Araujo</b></sub></a><br /><a href="https://github.com/brandonskerritt/RustScan/commits?author=bernardoamc" title="Code">💻</a> <a href="https://github.com/brandonskerritt/RustScan/issues?q=author%3Abernardoamc" title="Bug reports">🐛</a> <a href="#design-bernardoamc" title="Design">🎨</a></td>
-    <td align="center"><a href="https://github.com/Isona"><img src="https://avatars2.githubusercontent.com/u/11759523?v=4" width="100px;" alt=""/><br /><sub><b>Izzy Whistlecroft</b></sub></a><br /><a href="https://github.com/brandonskerritt/RustScan/issues?q=author%3AIsona" title="Bug reports">🐛</a></td>
-    <td align="center"><a href="https://imlonghao.com"><img src="https://avatars1.githubusercontent.com/u/4951333?v=4" width="100px;" alt=""/><br /><sub><b>imlonghao</b></sub></a><br /><a href="https://github.com/brandonskerritt/RustScan/issues?q=author%3Aimlonghao" title="Bug reports">🐛</a> <a href="#maintenance-imlonghao" title="Maintenance">🚧</a></td>
+    <td align="center"><a href="http://bernardoamc.github.io/"><img src="https://avatars0.githubusercontent.com/u/428984?v=4" width="100px;" alt=""/><br /><sub><b>Bernardo Araujo</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=bernardoamc" title="Code">💻</a> <a href="https://github.com/RustScan/RustScan/issues?q=author%3Abernardoamc" title="Bug reports">🐛</a> <a href="#design-bernardoamc" title="Design">🎨</a></td>
+    <td align="center"><a href="https://github.com/Isona"><img src="https://avatars2.githubusercontent.com/u/11759523?v=4" width="100px;" alt=""/><br /><sub><b>Izzy Whistlecroft</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/issues?q=author%3AIsona" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://imlonghao.com"><img src="https://avatars1.githubusercontent.com/u/4951333?v=4" width="100px;" alt=""/><br /><sub><b>imlonghao</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/issues?q=author%3Aimlonghao" title="Bug reports">🐛</a> <a href="#maintenance-imlonghao" title="Maintenance">🚧</a></td>
+    <td align="center"><a href="https://github.com/royharoush"><img src="https://avatars3.githubusercontent.com/u/8113056?v=4" width="100px;" alt=""/><br /><sub><b>royharoush</b></sub></a><br /><a href="#ideas-royharoush" title="Ideas, Planning, & Feedback">🤔</a> <a href="#design-royharoush" title="Design">🎨</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/Atul9"><img src="https://avatars1.githubusercontent.com/u/3390330?v=4" width="100px;" alt=""/><br /><sub><b>Atul Bhosale</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=Atul9" title="Code">💻</a></td>
+    <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> <a href="https://github.com/RustScan/RustScan/issues?q=author%3ASuperSandro2000" title="Bug reports">🐛</a> <a href="https://github.com/RustScan/RustScan/commits?author=SuperSandro2000" title="Code">💻</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>
+    <td align="center"><a href="https://github.com/niklasmohrin"><img src="https://avatars0.githubusercontent.com/u/47574893?v=4" width="100px;" alt=""/><br /><sub><b>Niklas Mohrin</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=niklasmohrin" title="Documentation">📖</a></td>
+    <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>
  </tr>
 </table>

 <!-- markdownlint-enable -->
 <!-- prettier-ignore-end -->
+
 <!-- ALL-CONTRIBUTORS-LIST:END -->

 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
@@ -1,6 +1,31 @@
-This is my first Rust project! As such, I expect there are many, many bugs involved or things that can be sped up.
+Howdy Space Cow-Person 🤠🌌

-If you're looking to get involved, we make use of Good First Issues / Help Wanted tags. Click this link to see all the issues we could use help with!
-[https://github.com/brandonskerritt/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22](https://github.com/brandonskerritt/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
+RustScan is always looking for contributors. Whether that's spelling mistakes or major changes, your help is **wanted** and welcomed here.

-Please leave issues / pull requests, I'd love to learn more about this amazing language :) 
+Before contributing, read our [code of conduct](https://github.com/RustScan/RustScan/blob/master/CODE_OF_CONDUCT.md).
+
+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 wiht 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](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.
+
+RustScan also has some `// TODO`'s in the codebase, which are meant more for the core team but we wouldn't say no to help with these issues.
+
+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! :)
@@ -18,4 +18,3 @@ RUN echo "objcopy = { path = \"arm-linux-gnueabihf-objcopy\" }" >> /root/.cargo/
 COPY ./entrypoint.sh /entrypoint.sh
 RUN chmod +x /entrypoint.sh
 ENTRYPOINT ["/entrypoint.sh"]
-1
@@ -0,0 +1,368 @@
+use serde_derive::Deserialize;
+use std::fs;
+use structopt::{clap::arg_enum, StructOpt};
+
+const LOWEST_PORT_NUMBER: u16 = 1;
+const TOP_PORT_NUMBER: u16 = 65535;
+
+arg_enum! {
+    /// Represents the strategy in which the port scanning will run.
+    ///   - Serial will run from start to end, for example 1 to 1_000.
+    ///   - Random will randomize the order in which ports will be scanned.
+    #[derive(Deserialize, Debug, StructOpt, Clone, PartialEq)]
+    pub enum ScanOrder {
+        Serial,
+        Random,
+    }
+}
+
+/// Represents the range of ports to be scanned.
+#[derive(Deserialize, Debug, Clone, PartialEq)]
+pub struct PortRange {
+    pub start: u16,
+    pub end: u16,
+}
+
+fn parse_range(input: &str) -> Result<PortRange, String> {
+    let range = input
+        .split("-")
+        .map(|x| x.parse::<u16>())
+        .collect::<Result<Vec<u16>, std::num::ParseIntError>>();
+
+    if range.is_err() {
+        return Err(String::from(
+            "the range format must be 'start-end'. Example: 1-1000.",
+        ));
+    }
+
+    match range.unwrap().as_slice() {
+        [start, end] => Ok(PortRange {
+            start: *start,
+            end: *end,
+        }),
+        _ => Err(String::from(
+            "the range format must be 'start-end'. Example: 1-1000.",
+        )),
+    }
+}
+
+#[derive(StructOpt, Debug)]
+#[structopt(name = "rustscan", setting = structopt::clap::AppSettings::TrailingVarArg)]
+/// 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
+pub struct Opts {
+    /// A list of comma separated CIDRs, IPs, or hosts to be scanned.
+    #[structopt(use_delimiter = true)]
+    pub addresses: Vec<String>,
+
+    /// A list of comma separed ports to be scanned. Example: 80,443,8080.
+    #[structopt(short, long, use_delimiter = true)]
+    pub ports: Option<Vec<u16>>,
+
+    /// A range of ports with format start-end. Example: 1-1000.
+    #[structopt(short, long, conflicts_with = "ports", parse(try_from_str = parse_range))]
+    pub range: Option<PortRange>,
+
+    /// Whether to ignore the configuration file or not.
+    #[structopt(short, long)]
+    pub no_config: bool,
+
+    /// Quiet mode. Only output the ports. No Nmap. Useful for grep or outputting to a file.
+    #[structopt(short, long)]
+    pub quiet: bool,
+
+    /// Accessible mode. Turns off features which negatively affect screen readers.
+    #[structopt(long)]
+    pub accessible: bool,
+
+    /// Turns off Nmap.
+    #[structopt(long)]
+    pub no_nmap: bool,
+
+    /// 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.
+    #[structopt(short, long, default_value = "4500")]
+    pub batch_size: u16,
+
+    /// The timeout in milliseconds before a port is assumed to be closed.
+    #[structopt(short, long, default_value = "1500")]
+    pub timeout: u32,
+
+    /// Automatically ups the ULIMIT with the value you provided.
+    #[structopt(short, long)]
+    pub ulimit: Option<rlimit::rlim>,
+
+    /// The order of scanning to be performed. The "serial" option will
+    /// scan ports in ascending order while the "random" option will scan
+    /// ports randomly.
+    #[structopt(long, possible_values = &ScanOrder::variants(), case_insensitive = true, default_value = "serial")]
+    pub scan_order: ScanOrder,
+
+    /// 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)'\"")
+    #[structopt(last = true)]
+    pub command: Vec<String>,
+}
+
+impl Opts {
+    pub fn read() -> Self {
+        let mut opts = Opts::from_args();
+
+        if opts.ports.is_none() && opts.range.is_none() {
+            opts.range = Some(PortRange {
+                start: LOWEST_PORT_NUMBER,
+                end: TOP_PORT_NUMBER,
+            });
+        }
+
+        opts
+    }
+
+    /// Reads the command line arguments into an Opts struct and merge
+    /// values found within the user configuration file.
+    pub fn merge(&mut self, config: &Config) {
+        if !self.no_config {
+            self.merge_required(&config);
+            self.merge_optional(&config);
+        }
+    }
+
+    fn merge_required(&mut self, config: &Config) {
+        macro_rules! merge_required {
+            ($($field: ident),+) => {
+                $(
+                    if let Some(e) = &config.$field {
+                        self.$field = e.clone();
+                    }
+                )+
+            }
+        }
+
+        merge_required!(addresses, quiet, accessible, batch_size, timeout, scan_order, command);
+    }
+
+    fn merge_optional(&mut self, config: &Config) {
+        macro_rules! merge_optional {
+            ($($field: ident),+) => {
+                $(
+                    if config.$field.is_some() {
+                        self.$field = config.$field.clone();
+                    }
+                )+
+            }
+        }
+
+        merge_optional!(ports, range, ulimit);
+    }
+}
+
+/// Struct used to deserialize the options specified within our config file.
+/// These will be further merged with our command line arguments in order to
+/// generate the final Opts struct.
+#[derive(Debug, Deserialize)]
+pub struct Config {
+    addresses: Option<Vec<String>>,
+    ports: Option<Vec<u16>>,
+    range: Option<PortRange>,
+    quiet: Option<bool>,
+    accessible: Option<bool>,
+    batch_size: Option<u16>,
+    timeout: Option<u32>,
+    no_nmap: Option<bool>,
+    ulimit: Option<rlimit::rlim>,
+    scan_order: Option<ScanOrder>,
+    command: Option<Vec<String>>,
+}
+
+impl Config {
+    /// Reads the configuration file with TOML format and parses it into a
+    /// Config struct.
+    ///
+    /// # Format
+    ///
+    /// addresses = ["127.0.0.1", "127.0.0.1"]
+    /// ports = [80, 443, 8080]
+    /// quiet = true
+    /// scan_order: "Serial"
+    ///
+    pub fn read() -> Self {
+        let mut paths = Vec::new();
+        paths.push(match dirs::home_dir() {
+            Some(mut path) => {
+                path.push(".rustscan.toml");
+                path
+            }
+            None => panic!("Could not infer config file path."),
+        });
+
+        paths.push(match dirs::config_dir() {
+            Some(mut path) => {
+                path.push("rustscan");
+                path.push("config.toml");
+                path
+            }
+            None => panic!("Could not infer config file path."),
+        });
+
+        let mut contents: Option<String> = None;
+        for path in paths.iter().rev() {
+            contents = match fs::read_to_string(path) {
+                Ok(content) => {
+                    contents = Some(content);
+                    break;
+                }
+                Err(_) => None,
+            };
+        }
+
+        if contents.is_none() {
+            contents = Some(String::new());
+        }
+
+        let config: Config = match toml::from_str(&contents.unwrap()) {
+            Ok(config) => config,
+            Err(e) => {
+                println!("Found {} in configuration file.\nAborting scan.\n", e);
+                std::process::exit(1);
+            }
+        };
+
+        config
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::{Config, Opts, PortRange, ScanOrder};
+
+    #[test]
+    fn opts_no_merge_when_config_is_ignored() {
+        let mut opts = Opts {
+            addresses: vec![],
+            ports: None,
+            range: None,
+            quiet: false,
+            batch_size: 0,
+            timeout: 0,
+            ulimit: None,
+            command: vec![],
+            accessible: false,
+            no_nmap: false,
+            scan_order: ScanOrder::Serial,
+            no_config: true,
+        };
+
+        let config = Config {
+            addresses: Some(vec!["127.0.0.1".to_owned()]),
+            ports: None,
+            range: None,
+            quiet: Some(true),
+            batch_size: Some(25_000),
+            timeout: Some(1_000),
+            ulimit: None,
+            no_nmap: Some(false),
+            command: Some(vec!["-A".to_owned()]),
+            accessible: Some(true),
+            scan_order: Some(ScanOrder::Random),
+        };
+
+        opts.merge(&config);
+
+        assert_eq!(opts.addresses, vec![] as Vec<String>);
+        assert_eq!(opts.quiet, false);
+        assert_eq!(opts.accessible, false);
+        assert_eq!(opts.timeout, 0);
+        assert_eq!(opts.command, vec![] as Vec<String>);
+        assert_eq!(opts.scan_order, ScanOrder::Serial);
+    }
+
+    #[test]
+    fn opts_merge_required_arguments() {
+        let mut opts = Opts {
+            addresses: vec![],
+            ports: None,
+            range: None,
+            quiet: false,
+            batch_size: 0,
+            timeout: 0,
+            ulimit: None,
+            command: vec![],
+            accessible: false,
+            scan_order: ScanOrder::Serial,
+            no_nmap: false,
+            no_config: false,
+        };
+
+        let config = Config {
+            addresses: Some(vec!["127.0.0.1".to_owned()]),
+            ports: None,
+            no_nmap: Some(false),
+            range: None,
+            quiet: Some(true),
+            batch_size: Some(25_000),
+            timeout: Some(1_000),
+            ulimit: None,
+            command: Some(vec!["-A".to_owned()]),
+            accessible: Some(true),
+            scan_order: Some(ScanOrder::Random),
+        };
+
+        opts.merge_required(&config);
+
+        assert_eq!(opts.addresses, config.addresses.unwrap());
+        assert_eq!(opts.quiet, config.quiet.unwrap());
+        assert_eq!(opts.timeout, config.timeout.unwrap());
+        assert_eq!(opts.command, config.command.unwrap());
+        assert_eq!(opts.accessible, config.accessible.unwrap());
+        assert_eq!(opts.scan_order, config.scan_order.unwrap());
+    }
+
+    #[test]
+    fn opts_merge_optional_arguments() {
+        let mut opts = Opts {
+            addresses: vec![],
+            ports: None,
+            range: None,
+            quiet: false,
+            batch_size: 0,
+            timeout: 0,
+            ulimit: None,
+            command: vec![],
+            accessible: false,
+            scan_order: ScanOrder::Serial,
+            no_nmap: false,
+            no_config: false,
+        };
+
+        let config = Config {
+            addresses: None,
+            ports: Some(vec![80, 403]),
+            range: Some(PortRange {
+                start: 1,
+                end: 1_000,
+            }),
+            quiet: None,
+            batch_size: None,
+            timeout: None,
+            no_nmap: Some(false),
+            ulimit: Some(1_000),
+            command: None,
+            accessible: None,
+            scan_order: None,
+        };
+
+        opts.merge_optional(&config);
+
+        assert_eq!(opts.ports, config.ports);
+        assert_eq!(opts.range, config.range);
+        assert_eq!(opts.ulimit, config.ulimit);
+    }
+}
@@ -1,200 +1,473 @@
 extern crate shell_words;

+mod tui;
+
+mod input;
+use input::{Config, Opts, PortRange, ScanOrder};
+
 mod scanner;
 use scanner::Scanner;

-use colored::*;
+mod port_strategy;
+use port_strategy::PortStrategy;
+
+use cidr_utils::cidr::IpCidr;
+use colorful::Color;
+use colorful::Colorful;
 use futures::executor::block_on;
 use rlimit::Resource;
 use rlimit::{getrlimit, setrlimit};
-use std::process::{exit, Command};
-use std::time::Duration;
-use structopt::StructOpt;
+use std::collections::HashMap;
+use std::net::ToSocketAddrs;
+use std::process::Command;
+use std::{net::IpAddr, time::Duration};

-#[derive(StructOpt, Debug)]
-#[structopt(name = "rustscan", setting = structopt::clap::AppSettings::TrailingVarArg)]
-/// 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.
-struct Opts {
-    /// The IP address to scan
-    ip: String,
+extern crate colorful;
+extern crate dirs;

-    ///Quiet mode. Only output the ports. No Nmap. Useful for grep or outputting to a file.
-    #[structopt(short, long)]
-    quiet: bool,
+// Average value for Ubuntu
+const DEFAULT_FILE_DESCRIPTORS_LIMIT: rlimit::rlim = 8000;
+// Safest batch size based on experimentation
+const AVERAGE_BATCH_SIZE: rlimit::rlim = 3000;

-    /// 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.
-    #[structopt(short, long, default_value = "4500")]
-    batch_size: u64,
-
-    /// The timeout in milliseconds before a port is assumed to be closed.
-    #[structopt(short, long, default_value = "1500")]
-    timeout: u64,
-
-    /// Automatically ups the ULIMIT with the value you provided.
-    #[structopt(short, long)]
-    ulimit: Option<u64>,
-
-    /// 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)'\"")
-    command: Vec<String>,
-}
+#[macro_use]
+extern crate log;

+#[cfg(not(tarpaulin_include))]
 /// Faster Nmap scanning with Rust
+/// If you're looking for the actual scanning, check out the module Scanner
 fn main() {
-    let mut opts = Opts::from_args();
+    env_logger::init();

-    let user_nmap_options = if opts.command.is_empty() {
-        "-A -vvv".to_string()
-    } else {
-        opts.command.join(" ")
-    };
+    let mut opts: Opts = Opts::read();
+    let config = Config::read();
+    opts.merge(&config);
+    dbg!(&opts);

-    if !opts.quiet {
+    info!("Main() `opts` arguments are {:?}", opts);
+
+    if !opts.quiet && !opts.accessible {
        print_opening();
    }

-    // Updates ulimit when the argument is set
-    if opts.ulimit.is_some() {
-        let limit = opts.ulimit.unwrap();
+    let ips: Vec<IpAddr> = parse_addresses(&opts);

-        if !opts.quiet {
-            println!("Automatically upping ulimit to {}", limit);
-        }
-
-        match setrlimit(Resource::NOFILE, limit, limit) {
-            Ok(_) => {}
-            Err(_) => println!("ERROR.  Failed to set Ulimit."),
-        }
+    if ips.is_empty() {
+        warning!("No IPs could be resolved, aborting scan.", false);
+        std::process::exit(1);
    }

-    let (x, _) = getrlimit(Resource::NOFILE).unwrap();
+    let ulimit: rlimit::rlim = adjust_ulimit_size(&opts);
+    let batch_size: u16 = infer_batch_size(&opts, ulimit);

-    // if maximum limit is lower than batch size
-    // automatically re-adjust the batch size
-    if x < opts.batch_size {
-        if !opts.quiet {
-            println!("{}", "WARNING: Your file description limit is lower than selected batch size. Please considering upping this (how to is on the README). NOTE: this may be dangerous and may cause harm to sensitive servers. Automatically reducing Batch Size to match your limit, this process isn't harmful but reduces speed.".red());
-        }
-
-        // TODO this is a joke please fix
-
-        // if the OS supports high file limits like 8000
-        // but the user selected a batch size higher than this
-        // reduce to a lower number
-        // basically, ubuntu is 8000
-        // but i can only get it to work on < 5k in testing
-        // 5k is default, so 3000 seems safe
-        if x > 8000 {
-            opts.batch_size = 3000
-        } else {
-            opts.batch_size = x - 100u64;
-        }
-    }
-    // else if the ulimit is higher than batch size
-    // tell the user they can increase batch size
-    // if the user set ulimit arg they probably know what they are doing so don't print this
-    else if x + 2 > opts.batch_size && (opts.ulimit.is_none()) {
-        if !opts.quiet {
-            println!(
-                "Your file description limit is higher than the batch size. You can potentially increase the speed by increasing the batch size, but this may cause harm to sensitive servers. Your limit is {}, try batch size {}.",
-                x,
-                x - 1u64
-            );
-        }
-    }
-    // the user has asked to automatically up the ulimit
-
-    // 65535 + 1 because of 0 indexing
    let scanner = Scanner::new(
-        &opts.ip,
-        1,
-        65536,
-        opts.batch_size,
-        Duration::from_millis(opts.timeout),
+        &ips,
+        batch_size,
+        Duration::from_millis(opts.timeout.into()),
        opts.quiet,
+        PortStrategy::pick(opts.range, opts.ports, opts.scan_order),
    );
+
    let scan_result = block_on(scanner.run());
+    let mut ports_per_ip = HashMap::new();

-    // prints ports and places them into nmap string
-    let nmap_str_ports: Vec<String> = scan_result
-        .into_iter()
-        .map(|port| port.to_string())
-        .collect();
+    for socket in scan_result {
+        ports_per_ip
+            .entry(socket.ip())
+            .or_insert_with(Vec::new)
+            .push(socket.port());
+    }

-    // if no ports are found, suggest running with less
-    if nmap_str_ports.is_empty() {
-        panic!("{} Looks like I didn't find any open ports. This is usually caused by a high batch size.
-        \n*I used {} threads, consider lowering to {} with {} or a comfortable number lfor your system.
-        \n Alternatively, increase the timeout if your ping is high. Rustscan -T 2000 for 2000 second timeout.", "ERROR".red(),
+    for ip in ips {
+        if ports_per_ip.contains_key(&ip) {
+            continue;
+        }
+
+        // If we got here it means the IP was not found within the HashMap, this
+        // means the scan couldn't find any open ports for it.
+
+        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",
+        "ERROR",
+        ip,
        opts.batch_size,
-        (opts.batch_size / 2).to_string().green(),
-        "'rustscan -b <batch_size> <ip address>'".green());
+        (opts.batch_size / 2).to_string(),
+        "'rustscan -b <batch_size> <ip address>'");
+        warning!(x, opts.quiet);
    }

-    // Tells the user we are now switching to Nmap
-    if !opts.quiet {
-        println!("{}", "Starting nmap.".blue(),);
+    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);
+
+        // 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 {
+            println!("{}", ports_str);
+            continue;
+        }
+
+        let addr = ip.to_string();
+        let user_nmap_args =
+            shell_words::split(&opts.command.join(" ")).expect("failed to parse nmap arguments");
+        let nmap_args = build_nmap_arguments(&addr, &ports_str, &user_nmap_args, ip.is_ipv6());
+
+        output!(format!(
+            "The Nmap command to be run is nmap {}\n",
+            &nmap_args.join(" ")
+        ));
+
+        // Runs the nmap command and spawns it as a process.
+        let mut child = Command::new("nmap")
+            .args(&nmap_args)
+            .spawn()
+            .expect("failed to execute nmap process");
+
+        child.wait().expect("failed to wait on nmap process");
    }
-
-    // nmap port style is 80,443. Comma seperated with no spaces.
-    let ports_str = nmap_str_ports.join(",");
-
-    // if quiet mode is on, return ports and exit
-    if opts.quiet {
-        println!("{}", ports_str);
-        exit(1);
-    }
-
-    let nmap_args = format!(
-        "{} {} {} {} {} {}",
-        &user_nmap_options, "-vvv", "-Pn", "-p", &ports_str, opts.ip
-    );
-    if !opts.quiet {
-        println!("The Nmap command to be run is {}", &nmap_args);
-    }
-    let nmap_args = shell_words::split(&nmap_args).expect("failed to parse nmap arguments");
-
-    // Runs the nmap command and spawns it as a process.
-    let mut child = Command::new("nmap")
-        .args(&nmap_args)
-        .spawn()
-        .expect("failed to execute nmap process");
-
-    child.wait().expect("failed to wait on nmap process");
 }

+/// Prints the opening title of RustScan
 fn print_opening() {
-    let s = "
-     _____           _    _____
-    |  __ \\         | |  / ____|
-    | |__) |   _ ___| |_| (___   ___ __ _ _ __
-    |  _  / | | / __| __|\\___ \\ / __/ _` | '_ \\
-    | | \\ \\ |_| \\__ \\ |_ ____) | (_| (_| | | | |
-    |_|  \\_\\__,_|___/\\__|_____/ \\___\\__,_|_| |_|
-    Faster nmap scanning with rust.";
-    println!("{}\n", s.green());
+    info!("Printing opening");
+    let s = r#".----. .-. .-. .----..---.  .----. .---.   .--.  .-. .-.
+| {}  }| { } |{ {__ {_   _}{ {__  /  ___} / {} \ |  `| |
+| .-. \| {_} |.-._} } | |  .-._} }\     }/  /\  \| |\  |
+`-' `-'`-----'`----'  `-'  `----'  `---' `-'  `-'`-' `-'
+Faster Nmap scanning with Rust."#;
+    println!("{}", s.gradient(Color::Green).bold());
+    let info = r#"________________________________________
+: https://discord.gg/GFrQsGy           :
+: https://github.com/RustScan/RustScan :
+ --------------------------------------"#;
+    println!("{}", info.gradient(Color::Yellow).bold());
+    funny_opening!();
+
+    let config_path = match dirs::config_dir() {
+        Some(mut path) => {
+            path.push("rustscan");
+            path.push("config.toml");
+            path
+        }
+        None => panic!("Couldn't find config dir."),
+    };
+
+    detail!(format!(
+        "{} {:?}",
+        "The config file is expected to be at", config_path
+    ));
+}
+#[cfg(not(tarpaulin_include))]
+fn build_nmap_arguments<'a>(
+    addr: &'a str,
+    ports: &'a str,
+    user_args: &'a Vec<String>,
+    is_ipv6: bool,
+) -> Vec<&'a str> {
+    let mut arguments: Vec<&str> = user_args.iter().map(AsRef::as_ref).collect();
+    arguments.push("-vvv");
+
+    if is_ipv6 {
+        arguments.push("-6");
+    }
+
+    arguments.push("-p");
+    arguments.push(ports);
+    arguments.push(addr);
+
+    arguments
+}
+
+fn parse_addresses(opts: &Opts) -> Vec<IpAddr> {
+    let mut ips: Vec<IpAddr> = Vec::new();
+
+    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()),
+                _ => {
+                    let failed_to_resolve = format!("Host {:?} could not be resolved.", ip_or_host);
+                    warning!(failed_to_resolve, opts.quiet);
+                }
+            },
+        }
+    }
+
+    ips
+}
+
+fn adjust_ulimit_size(opts: &Opts) -> rlimit::rlim {
+    if opts.ulimit.is_some() {
+        let limit: rlimit::rlim = opts.ulimit.unwrap();
+
+        match setrlimit(Resource::NOFILE, limit, limit) {
+            Ok(_) => {
+                detail!(
+                    format!("Automatically increasing ulimit value to {}.", limit),
+                    opts.quiet
+                );
+            }
+            Err(_) => println!("{}", "ERROR. Failed to set ulimit value."),
+        }
+    }
+
+    let (rlim, _) = getrlimit(Resource::NOFILE).unwrap();
+
+    rlim
+}
+
+fn infer_batch_size(opts: &Opts, ulimit: rlimit::rlim) -> u16 {
+    let mut batch_size: rlimit::rlim = 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",
+            opts.quiet
+        );
+
+        // 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 {
+            // 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'. ");
+            info!("Halving batch_size because ulimit is smaller than average batch size");
+            batch_size = ulimit / 2
+        } else if ulimit > DEFAULT_FILE_DESCRIPTORS_LIMIT {
+            info!("Batch size is now average batch size");
+            batch_size = AVERAGE_BATCH_SIZE
+        } else {
+            batch_size = ulimit - 100
+        }
+    }
+    // When the ulimit is higher than the batch size let the user know that the
+    // batch size can be increased unless they specified the ulimit themselves.
+    else if ulimit + 2 > batch_size && (opts.ulimit.is_none()) {
+        detail!(format!(
+                "File limit higher than batch size. Can increase speed by increasing batch size '-b {}'.",
+                ulimit - 100
+            ), opts.quiet);
+    }
+
+    batch_size as u16
 }

 #[cfg(test)]
 mod tests {
-    use super::Scanner;
-    use async_std::task::block_on;
-    use std::time::Duration;
+    use crate::{
+        adjust_ulimit_size, infer_batch_size, parse_addresses, print_opening, Opts, ScanOrder,
+    };
+    use std::net::Ipv4Addr;

    #[test]
-    fn does_it_run() {
-        // Makes sure te program still runs and doesn't panic
-        let scanner = Scanner::new("127.0.0.1", 1, 65536, 1000, Duration::from_millis(10), true);
-        let scan_result = block_on(scanner.run());
-        // if the scan fails, it wouldn't be able to assert_eq! as it panicked!
-        assert_eq!(1, 1);
+    fn batch_size_lowered() {
+        let opts = Opts {
+            addresses: vec!["127.0.0.1".to_owned()],
+            ports: None,
+            range: None,
+            quiet: 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,
+        };
+        let batch_size = infer_batch_size(&opts, 120);
+
+        assert!(batch_size < 50_000);
+    }
+
+    #[test]
+    fn batch_size_lowered_average_size() {
+        let opts = Opts {
+            addresses: vec!["127.0.0.1".to_owned()],
+            ports: None,
+            range: None,
+            quiet: 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,
+        };
+        let batch_size = infer_batch_size(&opts, 9_000);
+
+        assert!(batch_size == 3_000);
+    }
+    #[test]
+    fn batch_size_equals_ulimit_lowered() {
+        // because ulimit and batch size are same size, batch size is lowered
+        // to ULIMIT - 100
+        let opts = Opts {
+            addresses: vec!["127.0.0.1".to_owned()],
+            ports: None,
+            range: None,
+            quiet: 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,
+        };
+        let batch_size = infer_batch_size(&opts, 5_000);
+
+        assert!(batch_size == 4_900);
+    }
+    #[test]
+    fn batch_size_adjusted_2000() {
+        // ulimit == batch_size
+        let opts = Opts {
+            addresses: vec!["127.0.0.1".to_owned()],
+            ports: None,
+            range: None,
+            quiet: 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,
+        };
+        let batch_size = adjust_ulimit_size(&opts);
+
+        assert!(batch_size == 2_000);
+    }
+    #[test]
+    fn test_print_opening_no_panic() {
+        // print opening should not panic
+        print_opening();
+        assert!(1 == 1);
+    }
+    #[test]
+    fn test_high_ulimit_no_quiet_mode() {
+        let opts = Opts {
+            addresses: vec!["127.0.0.1".to_owned()],
+            ports: None,
+            range: None,
+            quiet: false,
+            batch_size: 10,
+            timeout: 1_000,
+            ulimit: None,
+            command: Vec::new(),
+            accessible: true,
+            scan_order: ScanOrder::Serial,
+            no_config: false,
+            no_nmap: false,
+        };
+
+        infer_batch_size(&opts, 1_000_000);
+
+        assert!(1 == 1);
+    }
+
+    #[test]
+    fn parse_correct_addresses() {
+        let opts = Opts {
+            addresses: vec!["127.0.0.1".to_owned(), "192.168.0.0/30".to_owned()],
+            ports: None,
+            range: None,
+            quiet: true,
+            batch_size: 10,
+            timeout: 1_000,
+            ulimit: Some(2_000),
+            command: Vec::new(),
+            accessible: false,
+            scan_order: ScanOrder::Serial,
+            no_config: false,
+            no_nmap: false,
+        };
+        let ips = parse_addresses(&opts);
+
+        assert_eq!(
+            ips,
+            [
+                Ipv4Addr::new(127, 0, 0, 1),
+                Ipv4Addr::new(192, 168, 0, 0),
+                Ipv4Addr::new(192, 168, 0, 1),
+                Ipv4Addr::new(192, 168, 0, 2),
+                Ipv4Addr::new(192, 168, 0, 3)
+            ]
+        );
+    }
+
+    #[test]
+    fn parse_correct_host_addresses() {
+        let opts = Opts {
+            addresses: vec!["google.com".to_owned()],
+            ports: None,
+            range: None,
+            quiet: true,
+            batch_size: 10,
+            timeout: 1_000,
+            ulimit: Some(2_000),
+            command: Vec::new(),
+            accessible: false,
+            scan_order: ScanOrder::Serial,
+            no_config: false,
+            no_nmap: false,
+        };
+        let ips = parse_addresses(&opts);
+
+        assert_eq!(ips.len(), 1);
+    }
+
+    #[test]
+    fn parse_correct_and_incorrect_addresses() {
+        let opts = Opts {
+            addresses: vec!["127.0.0.1".to_owned(), "im_wrong".to_owned()],
+            ports: None,
+            range: None,
+            quiet: true,
+            batch_size: 10,
+            timeout: 1_000,
+            ulimit: Some(2_000),
+            command: Vec::new(),
+            accessible: false,
+            scan_order: ScanOrder::Serial,
+            no_config: false,
+            no_nmap: false,
+        };
+        let ips = parse_addresses(&opts);
+
+        assert_eq!(ips, [Ipv4Addr::new(127, 0, 0, 1),]);
+    }
+
+    #[test]
+    fn parse_incorrect_addresses() {
+        let opts = Opts {
+            addresses: vec!["im_wrong".to_owned(), "300.10.1.1".to_owned()],
+            ports: None,
+            range: None,
+            quiet: true,
+            batch_size: 10,
+            timeout: 1_000,
+            ulimit: Some(2_000),
+            command: Vec::new(),
+            accessible: false,
+            scan_order: ScanOrder::Serial,
+            no_config: false,
+            no_nmap: false,
+        };
+        let ips = parse_addresses(&opts);
+
+        assert_eq!(ips.is_empty(), true);
    }
 }
@@ -0,0 +1,136 @@
+mod range_iterator;
+use super::{PortRange, ScanOrder};
+use rand::seq::SliceRandom;
+use rand::thread_rng;
+use range_iterator::RangeIterator;
+
+/// Represents options of port scanning.
+///
+/// Right now all these options involve ranges, but in the future
+/// it will also contain custom lists of ports.
+pub enum PortStrategy {
+    Manual(Vec<u16>),
+    Serial(SerialRange),
+    Random(RandomRange),
+}
+
+impl PortStrategy {
+    pub fn pick(range: Option<PortRange>, ports: Option<Vec<u16>>, order: ScanOrder) -> Self {
+        match order {
+            ScanOrder::Serial if ports.is_none() => {
+                let range = range.as_ref().unwrap();
+                PortStrategy::Serial(SerialRange {
+                    start: range.start,
+                    end: range.end,
+                })
+            }
+            ScanOrder::Random if ports.is_none() => {
+                let range = range.as_ref().unwrap();
+                PortStrategy::Random(RandomRange {
+                    start: range.start,
+                    end: range.end,
+                })
+            }
+            ScanOrder::Serial => PortStrategy::Manual(ports.unwrap()),
+            ScanOrder::Random => {
+                let mut rng = thread_rng();
+                let mut ports = ports.unwrap();
+                ports.shuffle(&mut rng);
+                PortStrategy::Manual(ports)
+            }
+        }
+    }
+
+    pub fn order(&self) -> Vec<u16> {
+        match self {
+            PortStrategy::Manual(ports) => ports.to_vec(),
+            PortStrategy::Serial(range) => range.generate(),
+            PortStrategy::Random(range) => range.generate(),
+        }
+    }
+}
+
+/// Trait associated with a port strategy. Each PortStrategy must be able
+/// to generate an order for future port scanning.
+trait RangeOrder {
+    fn generate(&self) -> Vec<u16>;
+}
+
+/// As the name implies SerialRange will always generate a vector in
+/// ascending order.
+pub struct SerialRange {
+    start: u16,
+    end: u16,
+}
+
+impl RangeOrder for SerialRange {
+    fn generate(&self) -> Vec<u16> {
+        (self.start..self.end).collect()
+    }
+}
+
+/// As the name implies RandomRange will always generate a vector with
+/// a random order. This vector is built following the LCG algorithm.
+pub struct RandomRange {
+    start: u16,
+    end: u16,
+}
+
+impl RangeOrder for RandomRange {
+    // Right now using RangeIterator and generating a range + shuffling the
+    // vector is pretty much the same. The advantages of it will come once
+    // we have to generate different ranges for different IPs without storing
+    // actual vectors.
+    //
+    // Another benefit of RangeIterator is that it always generate a range with
+    // a certain distance between the items in the Array. The chances of having
+    // port numbers close to each other are pretty slim due to the way the
+    // algorithm works.
+    fn generate(&self) -> Vec<u16> {
+        RangeIterator::new(self.start.into(), self.end.into()).collect()
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::PortStrategy;
+    use crate::{PortRange, ScanOrder};
+
+    #[test]
+    fn serial_strategy_with_range() {
+        let range = PortRange { start: 1, end: 100 };
+        let strategy = PortStrategy::pick(Some(range), None, ScanOrder::Serial);
+        let result = strategy.order();
+        let expected_range = (1..100).into_iter().collect::<Vec<u16>>();
+        assert_eq!(expected_range, result);
+    }
+    #[test]
+    fn random_strategy_with_range() {
+        let range = PortRange { start: 1, end: 100 };
+        let strategy = PortStrategy::pick(Some(range), None, ScanOrder::Random);
+        let mut result = strategy.order();
+        let expected_range = (1..100).into_iter().collect::<Vec<u16>>();
+        assert_ne!(expected_range, result);
+
+        result.sort();
+        assert_eq!(expected_range, result);
+    }
+
+    #[test]
+    fn serial_strategy_with_ports() {
+        let strategy = PortStrategy::pick(None, Some(vec![80, 443]), ScanOrder::Serial);
+        let result = strategy.order();
+        assert_eq!(vec![80, 443], result);
+    }
+
+    #[test]
+    fn random_strategy_with_ports() {
+        let strategy = PortStrategy::pick(None, Some((1..10).collect()), ScanOrder::Random);
+        let mut result = strategy.order();
+        let expected_range = (1..10).into_iter().collect::<Vec<u16>>();
+        assert_ne!(expected_range, result);
+
+        result.sort();
+        assert_eq!(expected_range, result);
+    }
+}
@@ -0,0 +1,129 @@
+use gcd::Gcd;
+use rand::Rng;
+
+pub struct RangeIterator {
+    active: bool,
+    normalized_end: u32,
+    normalized_first_pick: u32,
+    normalized_pick: u32,
+    actual_start: u32,
+    step: u32,
+}
+
+/// An iterator that follows the `Linear Congruential Generator` algorithm.
+///
+/// For more information: https://en.wikipedia.org/wiki/Linear_congruential_generator
+impl RangeIterator {
+    /// Receives the the start and end of a range and normalize
+    /// these values before selecting a coprime for the end of the range
+    /// which will server as the step for the algorithm.
+    ///
+    /// For example, the range `1000-2500` will be normalized to `0-1500`
+    /// before going through the algorithm.
+    pub fn new(start: u32, end: u32) -> Self {
+        let normalized_end = end - start;
+        let step = pick_random_coprime(normalized_end);
+
+        // Randomly choose a number within the range to be the first
+        // and assign it as a pick.
+        let mut rng = rand::thread_rng();
+        let normalized_first_pick = rng.gen_range(0, normalized_end);
+
+        Self {
+            active: true,
+            normalized_end,
+            step,
+            normalized_first_pick,
+            normalized_pick: normalized_first_pick,
+            actual_start: start,
+        }
+    }
+}
+
+impl Iterator for RangeIterator {
+    type Item = u16;
+
+    // The next step is always bound by the formula: N+1 = (N + STEP) % TOP_OF_THE_RANGE
+    // It will only stop once we generate a number equal to the first generated number.
+    fn next(&mut self) -> Option<Self::Item> {
+        if !self.active {
+            return None;
+        }
+
+        let current_pick = self.normalized_pick;
+        let next_pick = (current_pick + self.step) % self.normalized_end;
+
+        // If the next pick is equal to the first pick this means that
+        // we have iterated through the entire range.
+        if next_pick == self.normalized_first_pick {
+            self.active = false;
+        }
+
+        self.normalized_pick = next_pick;
+        Some((self.actual_start + current_pick) as u16)
+    }
+}
+
+/// The probability that two random integers are coprime to one another
+/// works out to be around 61%, given that we can safely pick a random
+/// number and test it. Just in case we are having a bad day and we cannot
+/// pick a coprime number after 10 tries we just return "end - 1" which
+/// is guaranteed to be a coprime, but won't provide ideal randomization.
+///
+/// We pick between "lower_range" and "upper_range" since values too close to
+/// the boundaries, which in these case are the "start" and "end" arguments
+/// would also provide non-ideal randomization as discussed on the paragraph
+/// above.
+fn pick_random_coprime(end: u32) -> u32 {
+    let range_boundary = end / 4;
+    let lower_range = range_boundary;
+    let upper_range = end - range_boundary;
+    let mut rng = rand::thread_rng();
+    let mut candidate = rng.gen_range(lower_range, upper_range);
+
+    for _ in 0..10 {
+        if end.gcd(candidate) == 1 {
+            return candidate;
+        } else {
+            candidate = rng.gen_range(lower_range, upper_range);
+        }
+    }
+
+    end - 1
+}
+
+#[cfg(test)]
+mod tests {
+    use super::RangeIterator;
+
+    #[test]
+    fn range_iterator_iterates_through_the_entire_range() {
+        let result = generate_sorted_range(1, 10);
+        let expected_range = (1..10).into_iter().collect::<Vec<u16>>();
+        assert_eq!(expected_range, result);
+
+        let result = generate_sorted_range(1, 100);
+        let expected_range = (1..100).into_iter().collect::<Vec<u16>>();
+        assert_eq!(expected_range, result);
+
+        let result = generate_sorted_range(1, 1000);
+        let expected_range = (1..1000).into_iter().collect::<Vec<u16>>();
+        assert_eq!(expected_range, result);
+
+        let result = generate_sorted_range(1, 65_535);
+        let expected_range = (1..65_535).into_iter().collect::<Vec<u16>>();
+        assert_eq!(expected_range, result);
+
+        let result = generate_sorted_range(1000, 2000);
+        let expected_range = (1000..2000).into_iter().collect::<Vec<u16>>();
+        assert_eq!(expected_range, result);
+    }
+
+    fn generate_sorted_range(start: u32, end: u32) -> Vec<u16> {
+        let range = RangeIterator::new(start, end);
+        let mut result = range.into_iter().collect::<Vec<u16>>();
+        result.sort();
+
+        result
+    }
+}
@@ -1,114 +0,0 @@
-use async_std::io;
-use async_std::net::TcpStream;
-use async_std::prelude::*;
-use colored::*;
-use futures::stream::FuturesUnordered;
-use std::time::Duration;
-use std::{
-    io::ErrorKind,
-    net::{Shutdown, SocketAddr},
-};
-
-pub struct Scanner {
-    host: String,
-    start: u64,
-    end: u64,
-    batch_size: u64,
-    timeout: Duration,
-    quiet: bool,
-}
-
-impl Scanner {
-    pub fn new(
-        host: &str,
-        start: u64,
-        end: u64,
-        batch_size: u64,
-        timeout: Duration,
-        quiet: bool,
-    ) -> Self {
-        Self {
-            host: host.to_owned(),
-            start,
-            end,
-            batch_size,
-            timeout,
-            quiet,
-        }
-    }
-
-    pub async fn run(&self) -> Vec<u64> {
-        let ports: Vec<u64> = (self.start..self.end).collect();
-        let mut open_ports: std::vec::Vec<u64> = Vec::new();
-
-        for range in ports.chunks(self.batch_size as usize) {
-            let mut ports = self.scan_range(range).await;
-            open_ports.append(&mut ports);
-        }
-
-        open_ports
-    }
-
-    async fn scan_range(&self, range: &[u64]) -> Vec<u64> {
-        let mut ftrs = FuturesUnordered::new();
-
-        for port in range {
-            ftrs.push(self.scan_port(port));
-        }
-
-        let mut open_ports: Vec<u64> = Vec::new();
-        while let Some(result) = ftrs.next().await {
-            match result {
-                Ok(port) => open_ports.push(port),
-                _ => {}
-            }
-        }
-
-        open_ports
-    }
-
-    async fn scan_port(&self, port: &u64) -> io::Result<u64> {
-        let addr = format!("{}:{}", self.host, port);
-
-        match addr.parse() {
-            Ok(sock_addr) => match self.connect(sock_addr).await {
-                Ok(stream_result) => {
-                    match stream_result.shutdown(Shutdown::Both) {
-                        _ => {}
-                    }
-                    if !self.quiet {
-                        println!("Open {}", port.to_string().purple());
-                    }
-
-                    Ok(*port)
-                }
-                Err(e) => match e.kind() {
-                    ErrorKind::Other => {
-                        eprintln!("{:?}", e); // in case we get too many open files
-                        panic!("Too many open files. Please reduce batch size. The default is 5000. Try -b 2500.");
-                    }
-                    _ => Err(io::Error::new(io::ErrorKind::Other, e.to_string())),
-                },
-            },
-            Err(e) => {
-                eprintln!("Unable to convert to socket address {:?}", e);
-                panic!("Unable to convert to socket address");
-            }
-        }
-    }
-
-    async fn connect(&self, addr: SocketAddr) -> io::Result<TcpStream> {
-        let stream =
-            io::timeout(self.timeout, async move { TcpStream::connect(addr).await }).await?;
-        Ok(stream)
-    }
-}
-
-#[cfg(test)]
-mod tests {
-    #[test]
-    fn does_it_run() {
-        // TODO run functions here
-        assert_eq!(1, 1);
-    }
-}
@@ -0,0 +1,213 @@
+use super::PortStrategy;
+
+use async_std::io;
+use async_std::net::TcpStream;
+use async_std::prelude::*;
+use colored::*;
+use futures::stream::FuturesUnordered;
+use std::time::Duration;
+use std::{
+    io::ErrorKind,
+    net::{IpAddr, Shutdown, SocketAddr},
+};
+
+/// The class for the scanner
+/// IP is data type IpAddr and is the IP address
+/// start & end is where the port scan starts and ends
+/// batch_size is how many ports at a time should be scanned
+/// Timeout is the time RustScan should wait before declaring a port closed. As datatype Duration.
+/// Quiet is whether or not RustScan should print things, or wait until the end to print only open ports.
+#[cfg(not(tarpaulin_include))]
+pub struct Scanner {
+    ips: Vec<IpAddr>,
+    batch_size: u16,
+    timeout: Duration,
+    quiet: bool,
+    port_strategy: PortStrategy,
+}
+
+impl Scanner {
+    pub fn new(
+        ips: &[IpAddr],
+        batch_size: u16,
+        timeout: Duration,
+        quiet: bool,
+        port_strategy: PortStrategy,
+    ) -> Self {
+        Self {
+            batch_size,
+            timeout,
+            quiet,
+            port_strategy,
+            ips: ips.iter().map(|ip| ip.to_owned()).collect(),
+        }
+    }
+
+    /// Runs scan_range with chunk sizes
+    /// If you want to run RustScan normally, this is the entry point used
+    /// Returns all open ports as Vec<u16>
+    pub async fn run(&self) -> Vec<SocketAddr> {
+        let ports: Vec<u16> = self.port_strategy.order();
+        let batch_per_ip: usize = self.batch_size as usize / self.ips.len();
+        let mut open_sockets: Vec<SocketAddr> = Vec::new();
+
+        for batch in ports.chunks(batch_per_ip) {
+            let mut sockets = self.scan_ports(batch).await;
+            open_sockets.append(&mut sockets);
+        }
+
+        open_sockets
+    }
+
+    /// Given a slice of sockets, scan them all.
+    /// Returns a vector of open sockets.
+    async fn scan_ports(&self, ports: &[u16]) -> Vec<SocketAddr> {
+        let mut ftrs = FuturesUnordered::new();
+        for port in ports {
+            for ip in &self.ips {
+                ftrs.push(self.scan_socket(SocketAddr::new(*ip, *port)));
+            }
+        }
+
+        let mut open_sockets: Vec<SocketAddr> = Vec::new();
+        while let Some(result) = ftrs.next().await {
+            match result {
+                Ok(socket) => open_sockets.push(socket),
+                _ => {}
+            }
+        }
+
+        open_sockets
+    }
+
+    /// Given a port, scan it.
+    /// Turns the address into a SocketAddr
+    /// Deals with the <result> type
+    /// If it experiences error ErrorKind::Other then too many files are open and it Panics!
+    /// ese any other error, it returns the error in Result as a string
+    /// If no  errors occur, it returns the port number in Result to signify the port is open.
+    /// This function mainly deals with the logic of Results handling.
+    /// # Example
+    ///
+    ///     self.scan_port(10:u16)
+    ///
+    /// Note: `self` must contain `self.ip`.
+    async fn scan_socket(&self, socket: SocketAddr) -> io::Result<SocketAddr> {
+        match self.connect(socket).await {
+            Ok(x) => {
+                // match stream_result.shutdown(Shutdown::Both)
+                info!("Shutting down stream");
+                match x.shutdown(Shutdown::Both) {
+                    _ => {}
+                }
+                if !self.quiet {
+                    println!("Open {}", socket.to_string().purple());
+                }
+
+                Ok(socket)
+            }
+            Err(e) => match e.kind() {
+                ErrorKind::Other => {
+                    panic!("Too many open files. Please reduce batch size. The default is 5000. Try -b 2500.");
+                }
+                _ => Err(io::Error::new(io::ErrorKind::Other, e.to_string())),
+            },
+        }
+    }
+
+    /// Performs the connection to the socket with timeout
+    /// # Example
+    ///
+    ///     let port: u16 = 80
+    ///     // ip is an IpAddr type
+    ///     let ip = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
+    ///     let socket = SocketAddr::new(ip, port);
+    ///     self.connect(socket)
+    ///     // returns Result which is either Ok(stream) for port is open, or Er for port is closed.
+    ///     // Timeout occurs after self.timeout seconds
+    ///
+    async fn connect(&self, socket: SocketAddr) -> io::Result<TcpStream> {
+        let stream = io::timeout(
+            self.timeout,
+            async move { TcpStream::connect(socket).await },
+        )
+        .await?;
+        Ok(stream)
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use crate::{PortRange, ScanOrder};
+    use async_std::task::block_on;
+    use std::{net::IpAddr, time::Duration};
+
+    #[test]
+    fn scanner_runs() {
+        // Makes sure the program still runs and doesn't panic
+        let addrs = vec!["127.0.0.1".parse::<IpAddr>().unwrap()];
+        let range = PortRange {
+            start: 1,
+            end: 1_000,
+        };
+        let strategy = PortStrategy::pick(Some(range), None, ScanOrder::Random);
+        let scanner = Scanner::new(&addrs, 10, Duration::from_millis(100), true, strategy);
+        block_on(scanner.run());
+        // if the scan fails, it wouldn't be able to assert_eq! as it panicked!
+        assert_eq!(1, 1);
+    }
+    #[test]
+    fn ipv6_scanner_runs() {
+        // Makes sure the program still runs and doesn't panic
+        let addrs = vec!["::1".parse::<IpAddr>().unwrap()];
+        let range = PortRange {
+            start: 1,
+            end: 1_000,
+        };
+        let strategy = PortStrategy::pick(Some(range), None, ScanOrder::Random);
+        let scanner = Scanner::new(&addrs, 10, Duration::from_millis(100), true, strategy);
+        block_on(scanner.run());
+        // if the scan fails, it wouldn't be able to assert_eq! as it panicked!
+        assert_eq!(1, 1);
+    }
+    #[test]
+    fn quad_zero_scanner_runs() {
+        let addrs = vec!["0.0.0.0".parse::<IpAddr>().unwrap()];
+        let range = PortRange {
+            start: 1,
+            end: 1_000,
+        };
+        let strategy = PortStrategy::pick(Some(range), None, ScanOrder::Random);
+        let scanner = Scanner::new(&addrs, 10, Duration::from_millis(100), true, strategy);
+        block_on(scanner.run());
+        assert_eq!(1, 1);
+    }
+    #[test]
+    fn google_dns_runs() {
+        let addrs = vec!["8.8.8.8".parse::<IpAddr>().unwrap()];
+        let range = PortRange {
+            start: 400,
+            end: 445,
+        };
+        let strategy = PortStrategy::pick(Some(range), None, ScanOrder::Random);
+        let scanner = Scanner::new(&addrs, 10, Duration::from_millis(100), true, strategy);
+        block_on(scanner.run());
+        assert_eq!(1, 1);
+    }
+    #[test]
+    fn infer_ulimit_lowering_no_panic() {
+        // Test behaviour on MacOS where ulimit is not automatically lowered
+        let addrs = vec!["8.8.8.8".parse::<IpAddr>().unwrap()];
+
+        // mac should have this automatically scaled down
+        let range = PortRange {
+            start: 400,
+            end: 600,
+        };
+        let strategy = PortStrategy::pick(Some(range), None, ScanOrder::Random);
+        let scanner = Scanner::new(&addrs, 10, Duration::from_millis(100), true, strategy);
+        block_on(scanner.run());
+        assert_eq!(1, 1);
+    }
+}
@@ -0,0 +1,64 @@
+/// Terminal User Interface Module for RustScan
+/// Defines macros to use
+
+#[macro_export]
+macro_rules! warning {
+    ($name:expr) => {
+        use ansi_term::Colour::Red;
+        println!("{} {}", Red.bold().paint("[!]"), $name);
+    };
+    // quiet mode
+    ($name:expr, $quiet:expr) => {
+        use ansi_term::Colour::Red;
+        if !$quiet {
+            println!("{} {}", Red.bold().paint("[!]"), $name);
+        }
+    };
+}
+
+#[macro_export]
+macro_rules! detail {
+    ($name:expr) => {
+        use ansi_term::Colour::Blue;
+        println!("{} {}", Blue.bold().paint("[~]"), $name);
+    };
+    ($name:expr, $quiet:expr) => {
+        use ansi_term::Colour::Blue;
+        if !$quiet {
+            println!("{} {}", Blue.bold().paint("[~]"), $name);
+        }
+    };
+}
+
+#[macro_export]
+macro_rules! output {
+    ($name:expr, $quiet:expr) => {
+        use ansi_term::Colour::RGB;
+        if !$quiet {
+            println!("{} {}", RGB(0, 255, 9).bold().paint("[>]"), $name);
+        }
+    };
+    ($name:expr) => {
+        use ansi_term::Colour::RGB;
+        println!("{} {}", RGB(0, 255, 9).bold().paint("[>]"), $name);
+    };
+}
+
+#[macro_export]
+macro_rules! funny_opening {
+    // prints a funny quote / opening
+    () => {
+        use rand::seq::SliceRandom;
+        let quotes = vec![
+            "Nmap? More like slowmap.🐢",
+            "🌍HACK THE PLANET🌍",
+            "Real hackers hack time ⌛",
+            "Please contribute more quotes to our GitHub https://github.com/rustscan/rustscan",
+            "😵 https://admin.tryhackme.com",
+        ];
+        let random_quote = quotes.choose(&mut rand::thread_rng()).unwrap();
+
+        println!("{}\n", random_quote);
+        // println!("{} {}", RGB(0, 255, 9).bold().paint("[>]"), $name);
+    };
+}