Working file input

switching branches
Merge pull request #226 from RustScan/dependabot/cargo/async-std-1.6.4
2026-11-07 09:46:04 -10:00 · 2020-09-22 02:41:14 +01:00 · 2020-09-20 01:22:07 +01:00 · 2020-09-18 15:38:36 +01:00 · 2020-09-18 15:38:29 +01:00 · 2020-09-18 15:38:04 +01:00
42 changed files with 4655 additions and 294 deletions
@@ -16,11 +16,188 @@
        "code",
        "design"
      ]
+    },
+    {
+      "login": "SakiiR",
+      "name": "SakiiR",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/9950578?v=4",
+      "profile": "https://sakiir.ovh",
+      "contributions": [
+        "code",
+        "bug"
+      ]
+    },
+    {
+      "login": "smackhack",
+      "name": "smackhack",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/48143394?v=4",
+      "profile": "https://github.com/smackhack",
+      "contributions": [
+        "ideas",
+        "example"
+      ]
+    },
+    {
+      "login": "bernardoamc",
+      "name": "Bernardo Araujo",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/428984?v=4",
+      "profile": "http://bernardoamc.github.io/",
+      "contributions": [
+        "code",
+        "bug",
+        "design"
+      ]
+    },
+    {
+      "login": "Isona",
+      "name": "Izzy Whistlecroft",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/11759523?v=4",
+      "profile": "https://github.com/Isona",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "imlonghao",
+      "name": "imlonghao",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/4951333?v=4",
+      "profile": "https://imlonghao.com",
+      "contributions": [
+        "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"
+      ]
+    },
+    {
+      "login": "bergabman",
+      "name": "bergabman",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/44554109?v=4",
+      "profile": "https://github.com/bergabman",
+      "contributions": [
+        "code",
+        "bug",
+        "design"
+      ]
    }
  ],
  "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"]
@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
@@ -0,0 +1,2 @@
+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
@@ -0,0 +1,55 @@
+on: [push, pull_request]
+
+name: Continuous integration
+
+jobs:
+  check:
+    name: Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+      - uses: actions-rs/cargo@v1
+        with:
+          command: check
+
+  test:
+    name: Test Suite
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+      - uses: actions-rs/cargo@v1
+        with:
+          command: test
+
+  fmt:
+    name: Rustfmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+      - run: rustup component add rustfmt
+      - uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          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'
@@ -4,7 +4,6 @@

 # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
 # More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
-Cargo.lock

 # These are backup files generated by rustfmt
 **/*.rs.bk
@@ -30,7 +29,6 @@ Cargo.lock
 *.sig

 pkg/
-src/

 ### Rust ###
 # Generated by Cargo
@@ -39,9 +37,87 @@ src/

 # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
 # More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
-Cargo.lock

 # These are backup files generated by rustfmt
 **/*.rs.bk

 # End of https://www.toptal.com/developers/gitignore/api/rust,archlinuxpackages
+*.deb
+
+
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+.idea/*
+.idea*
+.idea
+
@@ -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=
@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+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
+
+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
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+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 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.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+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
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
@@ -1,24 +1,45 @@
 [package]
 name = "rustscan"
-version = "1.1.0"
+version = "1.9.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"
-clap = "2.33.0"
-rayon = "1.3.1"
-async-std = "1.6.2"
+colored = "2.0.0"
+structopt = "0.3.17"
+async-std = "1.6.4"
 futures = "0.3"
+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.116"
+serde_derive = "1.0.116"
+cidr-utils = "0.5.0"
+itertools = "0.9.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,14 +0,0 @@
-# Maintainer: Bee <[email protected]>
-pkgname=rustscan-bin
-pkgver=1.1.0
-pkgrel=1
-pkgdesc="Faster Nmap Scanning with Rust"
-url="https://github.com/brandonskerritt/rustscan"
-license=("MIT")
-arch=("x86_64")
-provides=("rustscan")
-depends=('rustup')
-
-package() {
-	rustup toolchain install stable && cargo install rustscan
-}
@@ -1,29 +1,39 @@
 <p align="center">
-<img src="pictures/rustscan.png"><br>
-<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. 
+➡️
+<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" height=400px width=400px>
 </p>
 <p align="center">
-<img alt="Crates.io" src="https://img.shields.io/crates/d/rust_scan">
-<img alt="AUR version" src="https://img.shields.io/aur/version/rustscan-bin">
+<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.
+</p>
+<p align="center">
+<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 commit activity" src="https://img.shields.io/github/commit-activity/w/Rustscan/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?branch=master">
 </p>
 <hr>

+| <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:v1.9.0` <p>[Usage](https://github.com/RustScan/RustScan#docker-whale)              | [Read the install guide](https://github.com/Rustscan/RustScan/blob/master/README.md#%EF%B8%8F-debian--kali)     | `yay -S rustscan`                                                                                               | `cargo install rustscan`                                                                                        |

-| <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> |
-| **Version 1.1.0** | Version 1.0.0 | Version 1.0.0 | Version 1.0.0 |
-| `cargo install rustscan` | `yay 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) |
-
-**Note**: You must have Nmap installed.
 <hr>

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

 <table>
  <tr>
@@ -33,8 +43,8 @@
  </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>
+    <td><img src="https://github.com/RustScan/RustScan/blob/master/pictures/with_rustscan.gif?raw=true" alt="The guy she tells you not to worry about"></td>
+    <td><img src="https://github.com/RustScan/RustScan/blob/master/pictures/without_rustscan.gif?raw=true" alt="You"></td>
  </tr>
  <tr>
  <th>Time</th>
@@ -43,20 +53,37 @@
  </tr>
 </table>

-<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>
+<sub><b>Note</b> This is an older gif. RustScan's current top speed is 3 seconds for all 65k ports. This gif is 26 seconds.</sub><br>

 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 **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.
+- IPv6 Support
+
+## ‼️ 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) |
+
+## 🙋 Table of Contents
+
+- 📖 [Installation Guide](https://github.com/RustScan/RustScan#-full-installation-guide)
+- 🐋 [Docker Usage](https://github.com/RustScan/RustScan#docker-whale)
+- 🦜 [Discord](https://discord.gg/GFrQsGy)
+- 🤸 [Usage](https://github.com/RustScan/RustScan#-usage)
+- 🎪 [Community](https://github.com/RustScan/RustScan#-community)

 # 🔭 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)
+![gif](https://github.com/RustScan/RustScan/blob/master/pictures/8seconds.gif?raw=true)

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

@@ -64,93 +91,343 @@ Why spend time running fast scans and manually copying the ports, or waiting for

 | **Name**                                                                                   | RustScan | Nmap | Masscan |
 | ------------------------------------------------------------------------------------------ | -------- | ---- | ------- |
-| Fast                                                                                       | ✅        | ❌    | ✅       |
-| Actually useful                                                                            | ❌        | ✅    | ❌       |
-| Realises it's not useful, and pipes the only useful data into the only useful port scanner | ✅        | ❌    | ❌       |
-
-
-## 🙋 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
-
-Great. Contribute it to Nmap! :D
-> Not everyone has nmap installed....
-
-If you're a pentester, then yes, you have Nmap installed. 
-
-> I want to contribute!
-
-Great! I'd love some help with this. Read the [contributing.md file](contributing.md) file for more information!
+| Fast                                                                                       | ✅       | ❌   | ✅      |
+| Actually useful                                                                            | ❌       | ✅   | ❌      |
+| Realises it's not useful, and pipes the only useful data into the only useful port scanner | ✅       | ❌   | ❌      |

 # 📖 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).

 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.

 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 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. 
+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.
+
+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.

 ## 🖥️ Debian / Kali

 Download the .deb file from the releases page:
-[https://github.com/brandonskerritt/RustScan/releases/tag/1.0.1](https://github.com/brandonskerritt/RustScan/releases/tag/1.0.1)
-Run the commpand `dpkg -i` on the file. Note: sometimes you can double click the file to achieve the same result.
+
+[https://github.com/RustScan/RustScan/releases](https://github.com/RustScan/RustScan/releases)
+
+Run the command `dpkg -i` on the file.
+
+Note: sometimes you can double click the file to achieve the same result.
+
+## Docker :whale:
+
+Docker is the recommended way of installing RustScan. This is because:
+
+- It has a high open file descriptor limit, which is one of the [main problems](https://github.com/RustScan/RustScan/issues/40) with RustScan. Now you don't have to fiddle around trying to understand your OS.
+- It works on all systems, regardless of OS. Even Windows, which we don't officially support.
+- The Docker image uses the latest build from Cargo, our main source-of-truth package. This means that you will always be using the latest version.
+- No need to install Rust, Cargo, or Nmap.
+
+To install Docker, [follow their guide](https://docs.docker.com/engine/install/).
+
+**Once Docker is installed, you can either build your own image using the `Dockerfile` (alpine) provided in the repo, or alternatively, use the published Docker image like below (most convenient)**
+
+Please see our [DockerHub](https://hub.docker.com/repository/docker/rustscan/rustscan) for further our published versions. However, we recommend using our latest release [v1.9.0](https://github.com/RustScan/RustScan/releases/tag/1.9.0)
+
+```
+Stable and supported: rustscan/rustscan:v1.9.0
+
+Bleeding edge (run at your own risk!): rustscan/rustscan:latest
+```
+
+We strongly recommend using the `v1.9.0` tag, as this is the latest major - stable - release of RustScan. This README uses the `v1.9.0` image by default, however, note that the `latest` image is considered experimental.
+
+#### To get started:
+
+Simply run this command against the IP you want to target:
+
+```bash
+docker run -it --rm --name rustscan rustscan/rustscan:v1.9.0 <rustscan arguments here> <ip address to scan>
+```
+
+Note: this will scan the Docker's localhost, not your own.
+
+Once done, you will no longer need to re-download the image (except when RustScan updates) and can use RustScan like a normal application.
+
+You will have to run this command every time, so we suggest aliasing it to something memorable.
+
+```bash
+alias rustscan='docker run -it --rm --name rustscan rustscan/rustscan:v1.9.0'
+```
+
+Then we can scan:
+
+```bash
+rustscan 192.168.1.0/24 -t 500 -b 1500 -- -A
+```
+
+#### To build your own image:
+
+Download the repo:
+
+```bash
+git clone https://github.com/RustScan/RustScan.git
+```
+
+Ensure you navigate to the download location of the repo:
+
+```bash
+cd /path/to/download/RustScan
+```
+
+Build away!
+
+```bash
+docker build -t <yourimagename> .
+```

 ## 🍺 HomeBrew

-Tap the brew:
-
-```
-brew tap brandonskerritt/rustscan
-```
-
-Install it:
+**Note for Mac users** Mac OS has a very, very small ulimit size. This will negatively impact RustScan by a significant amount. Please use the Docker container, or tell RustScan to up the ulimit size on every run.

 ```
 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!
+
+## 🦊 Community Distributions
+
+Here are all of RustScan's community distributions.
+
+If you maintain a community distribution and want it listed here, leave an issue / pull request / Discord message or however you want to let us know.
+
+- [OpenSuse](https://software.opensuse.org/package/rustscan?search_term=rustscan)
+- [Fedora/CentOS](https://copr.fedorainfracloud.org/coprs/atim/rustscan/)
+
+[![Packaging status](https://repology.org/badge/vertical-allrepos/rustscan.svg)](https://repology.org/project/rustscan/versions)
+
 # 🤸 Usage

-```
-rustscan -h
+```console
+$ rustscan -h
+
+Fast Port Scanner built in Rust. WARNING Do not use this program against sensitive infrastructure since the specified
+server may not be able to handle this many socket connections at once. - Discord https://discord.gg/GFrQsGy - GitHub
+https://github.com/RustScan/RustScan
+
+USAGE:
+    rustscan [FLAGS] [OPTIONS] [addresses]... [-- <command>...]
+
+FLAGS:
+        --accessible    Accessible mode. Turns off features which negatively affect screen readers
+    -h, --help          Prints help information
+    -n, --no-config     Whether to ignore the configuration file or not
+        --no-nmap       Turns off Nmap
+    -q, --quiet         Quiet mode. Only output the ports. No Nmap. Useful for grep or outputting to a file
+    -V, --version       Prints version information
+
+OPTIONS:
+    -b, --batch-size <batch-size>    The batch size for port scanning, it increases or slows the speed of scanning.
+                                     Depends on the open file limit of your OS.  If you do 65535 it will do every port
+                                     at the same time. Although, your OS may not support this [default: 4500]
+    -p, --ports <ports>...           A list of comma separed ports to be scanned. Example: 80,443,8080
+    -r, --range <range>              A range of ports with format start-end. Example: 1-1000
+        --scan-order <scan-order>    The order of scanning to be performed. The "serial" option will scan ports in
+                                     ascending order while the "random" option will scan ports randomly [default:
+                                     serial]  [possible values: Serial, Random]
+    -t, --timeout <timeout>          The timeout in milliseconds before a port is assumed to be closed [default: 1500]
+    -u, --ulimit <ulimit>            Automatically ups the ULIMIT with the value you provided
+
+ARGS:
+    <addresses>...    A list of comma separated CIDRs, IPs, or hosts to be scanned
+    <command>...      The Nmap arguments to run. To use the argument -A, end RustScan's args with '-- -A'. Example:
+                      'rustscan -t 1500 127.0.0.1 -- -A -sC'. This command adds -Pn -vvv -p $PORTS automatically to
+                      nmap. For things like --script '(safe and vuln)' enclose it in quotations marks \"'(safe and
+                      vuln)'\"")
 ```

-The format is `rustcan -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 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**. 
+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.
-## 🔌 Nmap
+
+## Configuration file
+
+This binary accepts a configuration file that is read from the home directory of the user. It follows the TOML format
+and accepts the following fields:
+
+- `addresses`
+- `ports`
+- `range`
+- `scan_order`
+- `command`
+- `accessible`
+- `quiet`
+- `batch-size`
+- `timeout`
+- `ulimit`
+
+### Format example
+
+```toml
+addresses = ["127.0.0.1", "192.168.0.0/30", "www.google.com"]
+command = ["-A"]
+ports = [80, 443, 8080]
+range = { start = 1, end = 10 }
+quiet = false
+accessible = true
+scan_order = "Serial"
+batch_size = 1000
+timeout = 1000
+ulimit = 1000
+```
+
+## ⚠️ 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.
+
+Servers as well as individual services can block your IP completely after a huge amount of simultaneous connections/tries, Possibly causing you to see false positives. False positives are open ports at the initial scanning process later found closed when you want to do further scanning, or connect to it.
+
+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 Panicked 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:
+
+```bash
+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:
+
+```bash
+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 ulimit (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/RustScan/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`. 
+RustScan automatically runs `nmap -vvv -p $PORTS $IP`. To make it run `-A`, execute the command `rustscan 127.0.0.1 -- -A`.

-**Note**: due to how Nmap behaves, sometimes you cannot SIGINT ctrl+c to end the scan and it acts like it is running in the background, but printing to STD::OUT. There is nothing I can do about this, unless I create a TTY shell for the sole purpose of running Nmap. Sorry 😓 I'll try to fix in an upcoming release. If any Rust experts want to help, please do!
+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.
+
+- 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)
+
+- 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
+# 🎪 Community
+
+Howdy Space Cow-Person 🤠🌌
+
+RustScan is always looking for contributors. Whether that's spelling mistakes or major changes, your help is **wanted** and welcomed here.
+
+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** 🤗
+
+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 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
+
+We communicate over Discord. [Click here](https://discord.gg/GFrQsGy) to join our Discord community!
+
+## Rewarding you
+
+I cannot pay you :-( But, I can place your GitHub profile on the README under `#Contributors` as a thank you! :)
+
 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-1-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-19-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)):
@@ -160,7 +437,29 @@ 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://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/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>
+    <td align="center"><a href="https://github.com/bergabman"><img src="https://avatars1.githubusercontent.com/u/44554109?v=4" width="100px;" alt=""/><br /><sub><b>bergabman</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=bergabman" title="Code">💻</a> <a href="https://github.com/RustScan/RustScan/issues?q=author%3Abergabman" title="Bug reports">🐛</a> <a href="#design-bergabman" title="Design">🎨</a></td>
  </tr>
 </table>

@@ -169,10 +468,3 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- ALL-CONTRIBUTORS-LIST:END -->

 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
-
-RustScan has 2 major updates:
-```diff
-* 8 seconds for full port scan, theoretical 1 second full port scan (but you gotta have a BEAST of a PC)
-* Custom Nmap flags
-```
-https://github.com/brandonskerritt/RustScan
@@ -1,9 +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 🤠🌌

-In particular, here is my roadmap:
-* Tokio async
-* Better UX
-* Optimised code
+RustScan is always looking for contributors. Whether that's spelling mistakes or major changes, your help is **wanted** and welcomed here.

+Before contributing, read our [code of conduct](https://github.com/RustScan/RustScan/blob/master/CODE_OF_CONDUCT.md).

-Please leave issues / pull requests, I'd love to learn more about this amazing language :) 
+TL;DR if you abuse members of our community you will be **perma-banned** with no chance to get unbanned. No warnings either. 🤗
+
+RustScan has 2 major labels for GitHub issues you should look at:
+* Good First issue
+These are issues for newcomers to open source!
+[https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22](https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
+* Help wanted
+These are issues that aren't really for newcomers, but we could still do with help!
+[https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+label%3A%22help+wanted%22](https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+label%3A%22help+wanted%22)
+
+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! :)
@@ -0,0 +1,20 @@
+FROM rust:latest
+
+RUN git clone https://github.com/brandonskerritt/RustScan
+WORKDIR "/RustScan"
+RUN git pull --force
+RUN cargo install cargo-deb
+
+RUN apt update -y && apt upgrade -y
+RUN apt install libc6-dev-i386 -y
+RUN git clone --depth=1 https://github.com/raspberrypi/tools /raspberrypi-tools
+ENV PATH=/raspberrypi-tools/arm-bcm2708/gcc-linaro-arm-linux-gnueabihf-raspbian-x64/bin/:$PATH
+ENV CARGO_TARGET_ARM_UNKNOWN_LINUX_GNUEABIHF_LINKER=arm-linux-gnueabihf-gcc
+RUN mkdir /root/.cargo
+RUN echo "[target.arm-unknown-linux-gnueabihf]" >> /root/.cargo/config
+RUN echo "strip = { path = \"arm-linux-gnueabihf-strip\" }" >> /root/.cargo/config
+RUN echo "objcopy = { path = \"arm-linux-gnueabihf-objcopy\" }" >> /root/.cargo/config
+
+COPY ./entrypoint.sh /entrypoint.sh
+RUN chmod +x /entrypoint.sh
+ENTRYPOINT ["/entrypoint.sh"]
@@ -0,0 +1,17 @@
+#!/bin/bash
+
+cd /RustScan
+git pull --force
+
+#amd64
+cargo deb
+
+#arm64
+rustup target add arm-unknown-linux-gnueabihf
+cargo deb --target=arm-unknown-linux-gnueabihf
+
+#i386
+rustup target add i686-unknown-linux-gnu
+cargo deb --target=i686-unknown-linux-gnu
+
+find target/ -name \*.deb -exec cp {} /debs \;
@@ -0,0 +1,8 @@
+#!/bin/bash
+docker build -t rustscan-builder . || exit
+
+# This creates a volume which binds your currentdirectory/debs to 
+# the location where the deb files get spat out in the container.
+# You don't need to worry about it. Just chmod +x run.sh && ./run.sh and
+# you'll get yer .deb file in a few minutes. It runs faster after you've used it the first time.
+docker run -v "$(pwd)/debs:/debs" rustscan-builder
@@ -0,0 +1,89 @@
+//! # Usage
+//! ```
+//! // Initiate Benchmark vector
+//! let mut bm = Benchmark::init();
+//! // Start named timer with name
+//! let mut example_bench = NamedTimer::start("Example Bench");
+//! // Stop named timer
+//! example_bench.stop();
+//! // Add named timer to Benchmarks
+//! bm.push(example_bench);
+//! // Print Benchmark Summary
+//! info!({}, bm.summary());
+//! ```
+use std::time::Instant;
+
+/// A Benchmark struct to hold NamedTimers with name, start and end Instants,
+#[derive(Debug)]
+pub struct Benchmark {
+    named_timers: Vec<NamedTimer>,
+}
+
+impl Benchmark {
+    pub fn init() -> Self {
+        Self {
+            named_timers: Vec::new(),
+        }
+    }
+    pub fn push(&mut self, timer: NamedTimer) {
+        self.named_timers.push(timer);
+    }
+
+    /// Summary of the benchmarks will destruct the vector,
+    /// formats every element the same way and return
+    /// a single String with all the available information
+    /// for easy printing
+    pub fn summary(&self) -> String {
+        let mut summary = String::from("\nRustScan Benchmark Summary");
+
+        for timer in &self.named_timers {
+            if timer.start.is_some() && timer.end.is_some() {
+                let runtime_secs = timer
+                    .end
+                    .unwrap()
+                    .saturating_duration_since(timer.start.unwrap())
+                    .as_secs_f32();
+                summary.push_str(&format!("\n{0: <10} | {1: <10}s", timer.name, runtime_secs))
+            }
+        }
+        summary
+    }
+}
+
+/// The purpose of NamedTimer is to hold a name,
+/// start Instant and end Instant for a specific timer.
+/// The given name will be presented in the benchmark summary,
+/// start and end Instants will be used for calculating runtime.
+#[derive(Debug)]
+pub struct NamedTimer {
+    name: &'static str,
+    start: Option<Instant>,
+    end: Option<Instant>,
+}
+
+impl NamedTimer {
+    pub fn start(name: &'static str) -> Self {
+        Self {
+            name: name,
+            start: Some(Instant::now()),
+            end: None,
+        }
+    }
+    pub fn end(&mut self) {
+        self.end = Some(Instant::now());
+    }
+}
+
+#[test]
+fn benchmark() {
+    let mut benchmarks = Benchmark::init();
+    let mut test_timer = NamedTimer::start("test");
+    std::thread::sleep(std::time::Duration::from_millis(100));
+    test_timer.end();
+    benchmarks.push(test_timer);
+    benchmarks.push(NamedTimer::start("only_start"));
+    assert!(benchmarks
+        .summary()
+        .contains("\nRustScan Benchmark Summary\ntest       | 0."));
+    assert_ne!(benchmarks.summary().contains("only_start"), true);
+}
@@ -0,0 +1,335 @@
+use serde_derive::Deserialize;
+use std::collections::HashMap;
+use std::fs;
+use std::path::PathBuf;
+use structopt::{clap::arg_enum, StructOpt};
+
+const LOWEST_PORT_NUMBER: u16 = 1;
+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,
+}
+
+#[cfg(not(tarpaulin_include))]
+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,
+
+    /// Greppable mode. Only output the ports. No Nmap. Useful for grep or outputting to a file.
+    #[structopt(short, long)]
+    pub greppable: 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,
+
+    /// Input file containing IP addresses delimited by new lines
+    #[structopt(short, long)]
+    pub input: Option<PathBuf>,
+
+    /// The Nmap arguments to run.
+    /// To use the argument -A, end RustScan's args with '-- -A'.
+    /// Example: 'rustscan -T 1500 127.0.0.1 -- -A -sC'.
+    /// 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>,
+
+    /// Use the top 1000 ports.
+    #[structopt(long)]
+    pub top: bool,
+}
+
+#[cfg(not(tarpaulin_include))]
+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, greppable, 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();
+                    }
+                )+
+            }
+        }
+
+        // Only use top ports when the user asks for them
+        if self.top {
+            if config.ports.is_some() {
+                let mut ports: Vec<u16> = Vec::with_capacity(config.ports.clone().unwrap().len());
+                for entry in config.ports.clone().unwrap().keys() {
+                    ports.push(entry.parse().unwrap())
+                }
+                self.ports = Some(ports);
+            }
+        }
+
+        merge_optional!(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.
+#[cfg(not(tarpaulin_include))]
+#[derive(Debug, Deserialize)]
+pub struct Config {
+    addresses: Option<Vec<String>>,
+    ports: Option<HashMap<String, u16>>,
+    range: Option<PortRange>,
+    greppable: Option<bool>,
+    accessible: Option<bool>,
+    batch_size: Option<u16>,
+    timeout: Option<u32>,
+    no_nmap: Option<bool>,
+    ulimit: Option<rlimit::rlim>,
+    scan_order: Option<ScanOrder>,
+    input: Option<PathBuf>,
+    command: Option<Vec<String>>,
+}
+
+#[cfg(not(tarpaulin_include))]
+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 home_dir = match dirs::home_dir() {
+            Some(dir) => dir,
+            None => panic!("Could not infer config file path."),
+        };
+        home_dir.push(".rustscan.toml");
+
+        let mut content = String::new();
+        if home_dir.exists() {
+            content = match fs::read_to_string(home_dir) {
+                Ok(content) => content,
+                Err(_) => String::new(),
+            }
+        }
+
+        let config: Config = match toml::from_str(&content) {
+            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};
+    impl Config {
+        fn default() -> Self {
+            Self {
+                addresses: Some(vec!["127.0.0.1".to_owned()]),
+                ports: None,
+                range: None,
+                greppable: 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),
+            }
+        }
+    }
+
+    impl Opts {
+        pub fn default() -> Self {
+            Self {
+                addresses: vec![],
+                ports: None,
+                range: None,
+                greppable: true,
+                batch_size: 0,
+                timeout: 0,
+                ulimit: None,
+                command: vec![],
+                accessible: false,
+                no_nmap: false,
+                scan_order: ScanOrder::Serial,
+                no_config: true,
+                top: false,
+            }
+        }
+    }
+
+    #[test]
+    fn opts_no_merge_when_config_is_ignored() {
+        let mut opts = Opts::default();
+        let config = Config::default();
+
+        opts.merge(&config);
+
+        assert_eq!(opts.addresses, vec![] as Vec<String>);
+        assert_eq!(opts.greppable, true);
+        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::default();
+        let config = Config::default();
+
+        opts.merge_required(&config);
+
+        assert_eq!(opts.addresses, config.addresses.unwrap());
+        assert_eq!(opts.greppable, config.greppable.unwrap());
+        assert_eq!(opts.timeout, config.timeout.unwrap());
+        assert_eq!(opts.command, config.command.unwrap());
+        assert_eq!(opts.accessible, config.accessible.unwrap());
+        assert_eq!(opts.scan_order, config.scan_order.unwrap());
+    }
+
+    #[test]
+    fn opts_merge_optional_arguments() {
+        let mut opts = Opts::default();
+        let mut config = Config::default();
+        config.range = Some(PortRange {
+            start: 1,
+            end: 1_000,
+        });
+        config.ulimit = Some(1_000);
+
+        opts.merge_optional(&config);
+
+        assert_eq!(opts.range, config.range);
+        assert_eq!(opts.ulimit, config.ulimit);
+    }
+}
@@ -1,213 +1,423 @@
-#!/bin/sh
-//usr/bin/env rustc $0 -o a.out && ./a.out && rm ./a.out ; exit
-use async_std::io;
-use async_std::net::TcpStream;
-use clap::{App, Arg, AppSettings};
-use colored::*;
-use std::process::{exit, Command};
-use std::time::Duration;
-use std::{
-    net::{SocketAddr, Shutdown},
-    io::ErrorKind,
-};
-use async_std::prelude::*;
-use futures::stream::FuturesUnordered;
+extern crate shell_words;
+
+mod tui;
+
+mod input;
+use input::{Config, Opts, PortRange, ScanOrder};
+
+mod scanner;
+use scanner::Scanner;
+
+mod port_strategy;
+use port_strategy::PortStrategy;
+
+mod benchmark;
+use benchmark::{Benchmark, NamedTimer};
+
+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::collections::HashMap;
+use std::fs::File;
+use std::io::prelude::*;
+use std::io::BufReader;
+use std::net::ToSocketAddrs;
+use std::process::Command;
+use std::str::FromStr;
+use std::{net::IpAddr, time::Duration};
+
+extern crate colorful;
+extern crate dirs;
+
+// 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;
+
+#[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 matches = App::new("RustScan")
-        .author("Bee https://github.com/brandonskerritt")
-        .about("Fast Port Scanner built in Rust")
-        .version("1.2.0")
-        .setting(AppSettings::TrailingVarArg)
-        
-        // IP address is a required argument
-        .arg(Arg::with_name("ip")
-            .required(true)
-            .index(1)
-            .long("ip-address")
-            .help("The IP address to scan"))
-        .arg(Arg::with_name("b")
-            .short("b")
-            .long("batch")
-            .takes_value(true)
-            .default_value("4500")
-            .help("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."))
-        .arg(Arg::with_name("T")
-            .short("T")
-            .long("timeout")
-            .takes_value(true)
-            .default_value("1500")
-            .help("The timeout before a port is assumed to be close. In MS."))
-        .arg(
-            Arg::with_name("command")
-                .help("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 ")
-                .takes_value(true)
-                .multiple(true),
-        )
-        .get_matches();
+    env_logger::init();
+    let mut benchmarks = Benchmark::init();
+    let mut rustscan_bench = NamedTimer::start("RustScan");

-    print_opening();
+    let mut opts: Opts = Opts::read();
+    let config = Config::read();
+    opts.merge(&config);

-    let ip = matches.value_of("ip").unwrap_or("None");
-    let command_matches= matches.values_of("command");
-    let command_run: String = match command_matches {
-        // We use the user supplied args
-        Some(x) => {
-            // TODO x is the same as below, use that instead
-            matches.values_of("command").unwrap().collect::<Vec<_>>().join(" ")
+    debug!("Main() `opts` arguments are {:?}", opts);
+
+    if !opts.greppable && !opts.accessible {
+        print_opening(&opts);
+    }
+
+    let ips: Vec<IpAddr> = parse_addresses(&opts);
+
+    if ips.is_empty() {
+        warning!(
+            "No IPs could be resolved, aborting scan.",
+            opts.greppable,
+            opts.accessible
+        );
+        std::process::exit(1);
+    }
+
+    let ulimit: rlimit::rlim = adjust_ulimit_size(&opts);
+    let batch_size: u16 = infer_batch_size(&opts, ulimit);
+
+    let scanner = Scanner::new(
+        &ips,
+        batch_size,
+        Duration::from_millis(opts.timeout.into()),
+        opts.greppable,
+        PortStrategy::pick(opts.range, opts.ports, opts.scan_order),
+        opts.accessible,
+    );
+    debug!("Scanner finished building: {:?}", scanner);
+
+    let mut portscan_bench = NamedTimer::start("Portscan");
+    let scan_result = block_on(scanner.run());
+    portscan_bench.end();
+    benchmarks.push(portscan_bench);
+
+    let mut ports_per_ip = HashMap::new();
+
+    for socket in scan_result {
+        ports_per_ip
+            .entry(socket.ip())
+            .or_insert_with(Vec::new)
+            .push(socket.port());
+    }
+
+    for ip in ips {
+        if ports_per_ip.contains_key(&ip) {
+            continue;
        }
-        // we default
-        None    => "-A -vvv".to_string()

+        // 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 it 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",
+        ip,
+        opts.batch_size,
+        "'rustscan -b <batch_size> <ip address>'");
+        warning!(x, opts.greppable, opts.accessible);
+    }
+
+    let mut nmap_bench = NamedTimer::start("Nmap");
+    for (ip, ports) in ports_per_ip.iter_mut() {
+        let nmap_str_ports: Vec<String> = ports.into_iter().map(|port| port.to_string()).collect();
+
+        // 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.greppable || opts.no_nmap {
+            println!("{} -> [{}]", &ip, ports_str);
+            continue;
+        }
+        detail!("Starting Nmap", opts.greppable, opts.accessible);
+
+        let addr = ip.to_string();
+        let user_nmap_args =
+            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(" ")
+            ),
+            opts.greppable.clone(),
+            opts.accessible.clone()
+        );
+
+        // 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");
+    }
+
+    // To use the runtime benchmark, run the process as: RUST_LOG=info ./rustscan
+    nmap_bench.end();
+    benchmarks.push(nmap_bench);
+    rustscan_bench.end();
+    benchmarks.push(rustscan_bench);
+    debug!("Benchmarks raw {:?}", benchmarks);
+    info!("{}", benchmarks.summary());
+}
+
+/// Prints the opening title of RustScan
+fn print_opening(opts: &Opts) {
+    debug!("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 mut home_dir = match dirs::home_dir() {
+        Some(dir) => dir,
+        None => panic!("Could not infer config file path."),
    };
+    home_dir.push(".rustscan.toml");

-    let batch_size: u32 = matches
-                        .value_of("b")
-                        .unwrap_or("None")
-                        .parse::<u32>()
-                        .unwrap();
-                            
-    // gets timeout
-    let duration_timeout =
-        matches
-            .value_of("T")
-            .unwrap_or("None")
-            .parse::<u64>()
-            .unwrap();
-
-
-    // 65535 + 1 because of 0 indexing
-    let test = run_batched(ip.to_string(), 1, 65536, Duration::from_millis(duration_timeout),  batch_size);
-    let reports_fullsult = block_on(test);
-
-
-    // prints ports and places them into nmap string
-    let mut nmap_str_ports: Vec<String> = Vec::new();
-
-    // makes vector of open ports
-    for i in reports_fullsult.iter() {
-            // appends it to port
-            nmap_str_ports.push(i.to_string());
-    }
-
-    // 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(), batch_size, (batch_size / 2).to_string().green(), "'rustscan -b <batch_size> <ip address>'".green());
-    }
-
-    // Tells the user we are now switching to Nmap
-    println!(
-        "{}",
-        "Starting nmap.".blue(),
+    detail!(
+        format!("The config file is expected to be at {:?}", home_dir),
+        opts.greppable,
+        opts.accessible
    );
-
-    // nmap port style is 80,443. Comma seperated with no spaces.
-    let ports_str = nmap_str_ports.join(",");
-    let string_format = format!("{} {} {} {} {}", command_run, "-vvv", "-p", &ports_str, ip);
-    let command_list = string_format.split_whitespace();
-    let vec = command_list.collect::<Vec<&str>>();
-
-    // Runs the nmap command and spawns it as a process.
-    Command::new("nmap")
-        .args(&vec)
-        .spawn()
-        .expect("failed to execute process");
 }
+#[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");

-pub async fn run_batched(
-    host: String,
-    port_start: u32,
-    port_end: u32,
-    timeout: Duration,
-    batch: u32,
-) -> Vec<u32> {
-    // run the scans in batches
-    let mut begin = port_start;
-    let mut end = begin + batch;
-    let mut all_addrs: std::vec::Vec<u32> = Vec::new();
-
-    while end <= port_end {
-        let mut batch_addrs = execute(host.clone(), begin, end, timeout).await;
-        all_addrs.append(&mut batch_addrs);
-        begin = end+1;
-        end += batch;
-    }
-    all_addrs
-}
-async fn execute(
-    host: String,
-    port_start: u32,
-    port_end: u32,
-    timeout: Duration,
-) -> Vec<u32> {
-    // runs a scan against a range of ports
-    let mut ftrs = FuturesUnordered::new();
-    // TODO can I make this async?
-    for port in port_start..port_end {
-        ftrs.push(try_connect(host.clone(), port, timeout));
+    if is_ipv6 {
+        arguments.push("-6");
    }

-    let mut open_addrs: Vec<u32> = Vec::new();
-    // TODO can I make this async?
-    while let Some(result) = ftrs.next().await {
-        match result {
-            Ok(addr) => open_addrs.push(addr),
-            Err(_) => {}
+    arguments.push("-p");
+    arguments.push(ports);
+    arguments.push(addr);
+
+    arguments
+}
+
+#[cfg(not(tarpaulin_include))]
+/// Parses an input file of IPs and uses those
+fn read_ips_from_file(ips: String) -> Result<Vec<std::net::IpAddr>, std::io::Error> {
+    // if we cannot open it as a file, it is not a file so move on
+    let file = File::open(ips)?;
+    let reader = BufReader::new(file);
+
+    let mut ips: Vec<std::net::IpAddr> = Vec::new();
+
+    for str_ip in reader.lines() {
+        match IpAddr::from_str(&str_ip.unwrap()) {
+            Ok(x) => ips.push(x),
+            Err(y) => panic!("File does not contain valid IP address. Error at {}", y),
        }
    }
-    open_addrs
+    Ok(ips)
 }

-async fn try_connect(host: String, port: u32, timeout: Duration) -> io::Result<u32> {
-    let addr = host.to_string() + ":" + &port.to_string();
-    match addr.parse() {
-        Ok(sock_addr) => match connect(sock_addr, timeout).await {
-            Ok(stream_result) => {
-                match stream_result.shutdown(Shutdown::Both) {
-                    _ => {}
+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()),
+                _ => {
+                    warning!(
+                        format!("Host {:?} could not be resolved.", ip_or_host),
+                        opts.greppable,
+                        opts.accessible
+                    );
                }
-                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(e)
-                }
-                _ => 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");
-            Err(io::Error::new(io::ErrorKind::Other, e.to_string()))
+        }
+        match read_ips_from_file(ip_or_host.to_owned()) {
+            Ok(x) => ips.extend(x),
+            _ => (),
        }
    }
+
+    ips
 }

+fn adjust_ulimit_size(opts: &Opts) -> rlimit::rlim {
+    if opts.ulimit.is_some() {
+        let limit: rlimit::rlim = opts.ulimit.unwrap();

-async fn connect(addr: SocketAddr, timeout: Duration) -> io::Result<TcpStream> {
-    let stream = io::timeout(timeout, async move { TcpStream::connect(addr).await }).await?;
-    Ok(stream)
+        match setrlimit(Resource::NOFILE, limit, limit) {
+            Ok(_) => {
+                detail!(
+                    format!("Automatically increasing ulimit value to {}.", limit),
+                    opts.greppable,
+                    opts.accessible
+                );
+            }
+            Err(_) => {
+                warning!(
+                    "ERROR. Failed to set ulimit value.",
+                    opts.greppable,
+                    opts.accessible
+                );
+            }
+        }
+    }
+
+    let (rlim, _) = getrlimit(Resource::NOFILE).unwrap();
+
+    rlim
 }

-fn print_opening() {
-    let s = "
-     _____           _    _____                 
-    |  __ \\         | |  / ____|                
-    | |__) |   _ ___| |_| (___   ___ __ _ _ __  
-    |  _  / | | / __| __|\\___ \\ / __/ _` | '_ \\ 
-    | | \\ \\ |_| \\__ \\ |_ ____) | (_| (_| | | | |
-    |_|  \\_\\__,_|___/\\__|_____/ \\___\\__,_|_| |_|
-    Faster nmap scanning with rust.";
-    println!(
-        "{} \n {} \n {}",
-        s.green(),
-        "Automated Decryption Tool - https://github.com/ciphey/ciphey".red(),
-        "Creator https://github.com/brandonskerritt".green()
-    );
+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.greppable, opts.accessible
+        );
+
+        // 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'. ", opts.greppable, opts.accessible);
+            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.greppable, opts.accessible);
+    }
+
+    batch_size as u16
+}
+
+#[cfg(test)]
+mod tests {
+    use crate::{adjust_ulimit_size, infer_batch_size, parse_addresses, print_opening, Opts};
+    use std::net::Ipv4Addr;
+
+    #[test]
+    fn batch_size_lowered() {
+        let mut opts = Opts::default();
+        opts.batch_size = 50_000;
+        let batch_size = infer_batch_size(&opts, 120);
+
+        assert!(batch_size < opts.batch_size);
+    }
+
+    #[test]
+    fn batch_size_lowered_average_size() {
+        let mut opts = Opts::default();
+        opts.batch_size = 50_000;
+        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 mut opts = Opts::default();
+        opts.batch_size = 50_000;
+        let batch_size = infer_batch_size(&opts, 5_000);
+
+        assert!(batch_size == 4_900);
+    }
+    #[test]
+    fn batch_size_adjusted_2000() {
+        // ulimit == batch_size
+        let mut opts = Opts::default();
+        opts.batch_size = 50_000;
+        opts.ulimit = Some(2_000);
+        let batch_size = adjust_ulimit_size(&opts);
+
+        assert!(batch_size == 2_000);
+    }
+    #[test]
+    fn test_print_opening_no_panic() {
+        let mut opts = Opts::default();
+        opts.ulimit = Some(2_000);
+        // print opening should not panic
+        print_opening(&opts);
+        assert!(1 == 1);
+    }
+    #[test]
+    fn test_high_ulimit_no_greppable_mode() {
+        let mut opts = Opts::default();
+        opts.batch_size = 10;
+        opts.greppable = false;
+
+        let batch_size = infer_batch_size(&opts, 1_000_000);
+
+        assert!(batch_size == opts.batch_size);
+    }
+
+    #[test]
+    fn parse_correct_addresses() {
+        let mut opts = Opts::default();
+        opts.addresses = vec!["127.0.0.1".to_owned(), "192.168.0.0/30".to_owned()];
+        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 mut opts = Opts::default();
+        opts.addresses = vec!["google.com".to_owned()];
+        let ips = parse_addresses(&opts);
+
+        assert_eq!(ips.len(), 1);
+    }
+
+    #[test]
+    fn parse_correct_and_incorrect_addresses() {
+        let mut opts = Opts::default();
+        opts.addresses = vec!["127.0.0.1".to_owned(), "im_wrong".to_owned()];
+        let ips = parse_addresses(&opts);
+
+        assert_eq!(ips, [Ipv4Addr::new(127, 0, 0, 1),]);
+    }
+
+    #[test]
+    fn parse_incorrect_addresses() {
+        let mut opts = Opts::default();
+        opts.addresses = vec!["im_wrong".to_owned(), "300.10.1.1".to_owned()];
+        let ips = parse_addresses(&opts);
+
+        assert_eq!(ips.is_empty(), true);
+    }
 }
@@ -0,0 +1,139 @@
+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.
+#[derive(Debug)]
+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.
+#[derive(Debug)]
+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.
+#[derive(Debug)]
+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
+    }
+}
@@ -0,0 +1,235 @@
+use super::PortStrategy;
+
+mod socket_iterator;
+use socket_iterator::SocketIterator;
+
+use async_std::io;
+use async_std::net::TcpStream;
+use async_std::prelude::*;
+use colored::*;
+use futures::stream::FuturesUnordered;
+use std::{
+    io::ErrorKind,
+    net::{IpAddr, Shutdown, SocketAddr},
+    time::Duration,
+};
+
+/// 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))]
+#[derive(Debug)]
+pub struct Scanner {
+    ips: Vec<IpAddr>,
+    batch_size: u16,
+    timeout: Duration,
+    greppable: bool,
+    port_strategy: PortStrategy,
+    accessible: bool,
+}
+
+impl Scanner {
+    pub fn new(
+        ips: &[IpAddr],
+        batch_size: u16,
+        timeout: Duration,
+        greppable: bool,
+        port_strategy: PortStrategy,
+        accessible: bool,
+    ) -> Self {
+        Self {
+            batch_size,
+            timeout,
+            greppable,
+            port_strategy,
+            ips: ips.iter().map(|ip| ip.to_owned()).collect(),
+            accessible,
+        }
+    }
+
+    /// 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 mut socket_iterator: SocketIterator = SocketIterator::new(&self.ips, &ports);
+        let mut open_sockets: Vec<SocketAddr> = Vec::new();
+        let mut ftrs = FuturesUnordered::new();
+
+        for _ in 0..self.batch_size {
+            if let Some(socket) = socket_iterator.next() {
+                ftrs.push(self.scan_socket(socket));
+            } else {
+                break;
+            }
+        }
+
+        debug!("Start scanning sockets. \nBatch size {}\nNumber of ip-s {}\nNumber of ports {}\nTargets all together {} ", 
+            self.batch_size,
+            self.ips.len(),
+            &ports.len(),
+            (self.ips.len() * &ports.len()));
+
+        while let Some(result) = ftrs.next().await {
+            if let Some(socket) = socket_iterator.next() {
+                ftrs.push(self.scan_socket(socket));
+            }
+
+            match result {
+                Ok(socket) => open_sockets.push(socket),
+                _ => {}
+            }
+        }
+        debug!("Open Sockets found: {:?}", &open_sockets);
+        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) => {
+                debug!(
+                    "Connection was successful, shutting down stream {}",
+                    &socket
+                );
+                match x.shutdown(Shutdown::Both) {
+                    Err(e) => debug!("Shutdown stream error {}", &e),
+                    _ => {}
+                }
+                if !self.greppable {
+                    if self.accessible {
+                        println!("Open {}", socket.to_string());
+                    } else {
+                        println!("Open {}", socket.to_string().purple());
+                    }
+                }
+
+                Ok(socket)
+            }
+            Err(e) => match e.kind() {
+                ErrorKind::Other => {
+                    if e.to_string().contains("No route to host")
+                        || e.to_string().contains("Network is unreachable")
+                    {
+                        debug!("Socket connect error: {} {}", &e.to_string(), &socket);
+                        Err(io::Error::new(io::ErrorKind::Other, e.to_string()))
+                    } else {
+                        debug!("Socket connect error: {} {}", &e.to_string(), &socket);
+                        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, true);
+        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, true);
+        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, true);
+        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, true);
+        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, true);
+        block_on(scanner.run());
+        assert_eq!(1, 1);
+    }
+}
@@ -0,0 +1,75 @@
+use itertools::{iproduct, Product};
+use std::net::{IpAddr, SocketAddr};
+
+pub struct SocketIterator<'s> {
+    // product_it is a cartesian product iterator over
+    // the slices of ports and IP addresses.
+    //
+    // The IP/port order is intentionally reversed here since we want
+    // the itertools::iproduct! macro below to generate the pairs with
+    // all the IPs for one port before moving on to the next one
+    // ("hold the port, go through all the IPs, then advance the port...").
+    // See also the comments in the iterator implementation for an example.
+    product_it:
+        Product<Box<std::slice::Iter<'s, u16>>, Box<std::slice::Iter<'s, std::net::IpAddr>>>,
+}
+
+/// An iterator that receives a slice of IPs and ports and returns a Socket
+/// for each IP and port pair until all of these combinations are exhausted.
+/// The goal of this iterator is to go over every IP and port combination
+/// wihout generating a big memory footprint. The alternative would be
+/// generating a vector containing all these combinations.
+impl<'s> SocketIterator<'s> {
+    pub fn new(ips: &'s [IpAddr], ports: &'s [u16]) -> Self {
+        let ports_it = Box::new(ports.into_iter());
+        let ips_it = Box::new(ips.into_iter());
+        Self {
+            product_it: iproduct!(ports_it, ips_it),
+        }
+    }
+}
+
+impl<'s> Iterator for SocketIterator<'s> {
+    type Item = SocketAddr;
+
+    /// Returns a socket based on the combination of one of the provided
+    /// IPs and ports or None when these combinations are exhausted. Every
+    /// IP will have the same port until a port is incremented.
+    ///
+    /// let it = SocketIterator::new(&["127.0.0.1", "192.168.0.1"], &[80, 443]);
+    /// it.next(); // 127.0.0.1:80
+    /// it.next(); // 192.168.0.1:80
+    /// it.next(); // 127.0.0.1:443
+    /// it.next(); // 192.168.0.1:443
+    /// it.next(); // None
+    fn next(&mut self) -> Option<Self::Item> {
+        match self.product_it.next() {
+            None => None,
+            Some((port, ip)) => Some(SocketAddr::new(*ip, *port)),
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::SocketIterator;
+    use std::net::{IpAddr, SocketAddr};
+
+    #[test]
+    fn goes_through_every_ip_port_combination() {
+        let addrs = vec![
+            "127.0.0.1".parse::<IpAddr>().unwrap(),
+            "192.168.0.1".parse::<IpAddr>().unwrap(),
+        ];
+        let ports: Vec<u16> = vec![22, 80, 443];
+        let mut it = SocketIterator::new(&addrs, &ports);
+
+        assert_eq!(Some(SocketAddr::new(addrs[0], ports[0])), it.next());
+        assert_eq!(Some(SocketAddr::new(addrs[1], ports[0])), it.next());
+        assert_eq!(Some(SocketAddr::new(addrs[0], ports[1])), it.next());
+        assert_eq!(Some(SocketAddr::new(addrs[1], ports[1])), it.next());
+        assert_eq!(Some(SocketAddr::new(addrs[0], ports[2])), it.next());
+        assert_eq!(Some(SocketAddr::new(addrs[1], ports[2])), it.next());
+        assert_eq!(None, it.next());
+    }
+}
@@ -0,0 +1,81 @@
+/// 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);
+    };
+    ($name:expr, $greppable:expr, $accessible:expr) => {
+        use ansi_term::Colour::Red;
+        // if not greppable then print, otherwise no else statement so do not print.
+        if !$greppable {
+            if $accessible {
+                // Don't print the ascii art
+                println!("{}", $name);
+            } else {
+                println!("{} {}", Red.bold().paint("[!]"), $name);
+            }
+        }
+    };
+}
+
+#[macro_export]
+macro_rules! detail {
+    ($name:expr) => {
+        use ansi_term::Colour::Blue;
+        println!("{} {}", Blue.bold().paint("[~]"), $name);
+    };
+    ($name:expr, $greppable:expr, $accessible:expr) => {
+        use ansi_term::Colour::Blue;
+        // if not greppable then print, otherwise no else statement so do not print.
+        if !$greppable {
+            if $accessible {
+                // Don't print the ascii art
+                println!("{}", $name);
+            } else {
+                println!("{} {}", Blue.bold().paint("[~]"), $name);
+            }
+        }
+    };
+}
+
+#[macro_export]
+macro_rules! output {
+    ($name:expr) => {
+        use ansi_term::Colour::RGB;
+        println!("{} {}", RGB(0, 255, 9).bold().paint("[>]"), $name);
+    };
+    ($name:expr, $greppable:expr, $accessible:expr) => {
+        use ansi_term::Colour::RGB;
+        // if not greppable then print, otherwise no else statement so do not print.
+        if !$greppable {
+            if $accessible {
+                // Don't print the ascii art
+                println!("{}", $name);
+            } else {
+                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);
+    };
+}