initial changes

added release drafter
Merge pull request #200 from RustScan/ba-add-cidr-support
2026-11-07 09:46:04 -10:00 · 2020-09-12 01:49:16 +01:00 · 2020-09-11 00:59:55 +01:00 · 2020-09-10 00:46:19 +01:00 · 2020-09-09 19:21:43 -04:00 · 2020-09-07 23:00:14 +01:00
19 changed files with 2024 additions and 490 deletions
@@ -86,6 +86,15 @@
        "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",
@@ -95,6 +104,84 @@
        "doc",
        "code"
      ]
+    },
+    {
+      "login": "cmnatic",
+      "name": "Ben (CMNatic)",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/4163116?v=4",
+      "profile": "https://cmnatic.co.uk",
+      "contributions": [
+        "code",
+        "doc",
+        "design"
+      ]
+    },
+    {
+      "login": "Ferryistaken",
+      "name": "Alessandro Ferrari",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/47927670?v=4",
+      "profile": "https://github.com/Ferryistaken",
+      "contributions": [
+        "content"
+      ]
+    },
+    {
+      "login": "Phenomite",
+      "name": "Phenomite",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/8285537?v=4",
+      "profile": "https://github.com/Phenomite",
+      "contributions": [
+        "content"
+      ]
+    },
+    {
+      "login": "SuperSandro2000",
+      "name": "Sandro",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/7258858?v=4",
+      "profile": "https://supersandro.de/",
+      "contributions": [
+        "content",
+        "bug",
+        "code"
+      ]
+    },
+    {
+      "login": "caass",
+      "name": "Cass",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/25358963?v=4",
+      "profile": "https://swag.lgbt",
+      "contributions": [
+        "platform",
+        "code",
+        "bug"
+      ]
+    },
+    {
+      "login": "niklasmohrin",
+      "name": "Niklas Mohrin",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/47574893?v=4",
+      "profile": "https://github.com/niklasmohrin",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "tim77",
+      "name": "Artem Polishchuk",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/5614476?v=4",
+      "profile": "https://liberapay.com/Artem4/",
+      "contributions": [
+        "platform"
+      ]
+    },
+    {
+      "login": "buermarc",
+      "name": "buermarc",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/44375277?v=4",
+      "profile": "https://github.com/buermarc",
+      "contributions": [
+        "code"
+      ]
    }
  ],
  "contributorsPerLine": 7,
@@ -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,4 @@
+template: |
+  ## What’s Changed
+
+  $CHANGES
@@ -0,0 +1,3 @@
+[submodule "src/rustscan_scripting_engine"]
+	path = src/rustscan_scripting_engine
+	url = https://github.com/RustScan/rustscan_scripting_engine
@@ -1,56 +1,37 @@
 language: rust
-
 os:
-  - linux
-  - osx
-  # - windows
-
+- linux
+- osx
 arch:
-  - amd64
-  - arm64
-
+- amd64
+- arm64
 services:
-  - docker  
-
+- docker
 before_install:
 - rustup component add rustfmt
-
-# cargo test
 rust:
-  - stable
-  - beta
+- stable
+- beta
 jobs:
  fast_finish: true
-
-# Cargo fmt
 script:
 - cargo build
 - cargo test
 - cargo fmt -- --check
-
-# automatic deployment to cargo on release
-# deploy:
-
-#   provider: releases
-#   api_key: "GITHUB OAUTH TOKEN"
-#   file: "FILE TO UPLOAD"
-#   skip_cleanup: true
-#   on:
-#     tags: true
-
-# after_success:
-#   - wget https://raw.githubusercontent.com/DiscordHooks/travis-ci-discord-webhook/master/send.sh
-#   - chmod +x send.sh
-#   - ./send.sh success $WEBHOOK_URL
-
-        # only deploy on master branch
-        # on:
-                # branch: master
-        # provider: cargo
-        # token: $crates 
-
-
 after_failure:
-  - wget https://raw.githubusercontent.com/DiscordHooks/travis-ci-discord-webhook/master/send.sh
-  - chmod +x send.sh
-  - ./send.sh failure $WEBHOOK_URL
+- wget https://raw.githubusercontent.com/DiscordHooks/travis-ci-discord-webhook/master/send.sh
+- chmod +x send.sh
+- "./send.sh failure $WEBHOOK_URL"
+after_success: |
+  if [ -n "${GITHUB_TOKEN}" ]; then
+    [ "${TRAVIS_BRANCH} " = master ] &&
+    [ "${TRAVIS_PULL_REQUEST}" = false ] &&
+    cargo doc &&
+    echo "<meta http-equiv=refresh content=0;url=rustscan/index.html>" > target/doc/index.html &&
+    sudo pip install ghp-import &&
+    ghp-import -n target/doc &&
+    git push -fq https://${GITHUB_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git gh-pages
+  fi
+env:
+  global:
+    secure: Gf24LG7Hr3Q0drWyPrvISTL35Z57DxdS/wIOo7v+ZdauzY3Qjvv3Lh4TY//C4sdN0g1CLj4yjg7LQOqF4XRdh2Qah7JZPv/i2B5uz9nwjTsoRzmmMWML9VtfT1u53nSFqsNeXbvpmoNG9rfMXcoiyd+Lv+EgniHphDEBlXvS9n9KMcpOi1F2x7bsH0EK37wQYKMTpCCd5TPUPdZou7BJNiZS3ikRLpTRFF7uIN4gYtRH9kU5uBSphWgnJ6eBm2ItzZcUPOgrjAoF4RkmZAzGG4idDh1Qkf3No3nZwT3U5NSk8h7owtJ4oADlRgYqYKCB4YcC9cAKCJgDsyMlKKMkEyagvw1seFnBLCY3ljsW4EklpVEZ0rVqZOx4pTkIaxIxytLTC9pHmdDSnhdhFknOcVAQQWjg+nAZfD07QUeAqUdr0i/vxQoZitvbNY0znzEarycE1waKvwlkiB4gt385U1CBfYldydnOnRKkdtLNrCLClu13HU0djmSXMhojQJhTuNxTHtZAf5fKcWIWwkVbNZ5MNKYjQh4rKufqW3o1iHphB8dfAGsDEPv0RQMtVbu6H4+clCouLkFlxHOIrrOJ5SXQ8cIATPhnJR7y4cSDdRaN0DRLRjeLAIKlbOGBtNuFC+BftocaTY5qN42aKAMqQcT30ycfiLuRVJNiQJ5pkto=
@@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation.
 Examples of behavior that contributes to creating a positive environment
 include:

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

 Examples of unacceptable behavior by participants include:

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

 ## Our Responsibilities

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

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

 ## Attribution

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

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

 For answers to common questions about this code of conduct, see
 https://www.contributor-covenant.org/faq
@@ -51,16 +51,63 @@ dependencies = [
 ]

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

@@ -127,15 +173,14 @@ dependencies = [

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

@@ -163,6 +208,19 @@ version = "0.1.10"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "4785bdd1c96b2a846b2bd7cc02e86b6b3dbf14e7e53446c4f54c92a361040822"

+[[package]]
+name = "cidr-utils"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "89f7b6372f3c783f6d44c0da283d3694af4104967bf2371cb3bdc9d09e1cfe00"
+dependencies = [
+ "debug-helper",
+ "num-bigint",
+ "num-traits",
+ "once_cell",
+ "regex",
+]
+
 [[package]]
 name = "clap"
 version = "2.33.2"
@@ -221,6 +279,12 @@ dependencies = [
 "lazy_static",
 ]

+[[package]]
+name = "debug-helper"
+version = "0.3.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9a8a5bb894f24f42c247f19b25928a88e31867c0f84552c05df41a9dd527435e"
+
 [[package]]
 name = "dirs"
 version = "3.0.1"
@@ -324,7 +388,7 @@ dependencies = [
 "futures-core",
 "futures-io",
 "memchr",
- "parking",
+ "parking 1.0.6",
 "pin-project-lite",
 "waker-fn",
 ]
@@ -465,6 +529,47 @@ version = "2.3.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "3728d817d99e5ac407411fa471ff9800a778d88a24685968b36824eaf4bee400"

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

+[[package]]
+name = "parking"
+version = "2.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "427c3892f9e783d91cc128285287e70a59e206ca452770ece88a76f7a3eddd72"
+
 [[package]]
 name = "pin-project"
 version = "0.4.23"
@@ -519,6 +630,18 @@ version = "0.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "8b870d8c151b6f2fb93e84a13146138f05d02ed11c7e7c54f8826aaaf7c9f184"

+[[package]]
+name = "polling"
+version = "0.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b6d83023eb990619815bb41b45625b02da62b00d0f24b0a08aae37697b3f6c94"
+dependencies = [
+ "cfg-if",
+ "libc",
+ "wepoll-sys-stjepang",
+ "winapi",
+]
+
 [[package]]
 name = "ppv-lite86"
 version = "0.2.8"
@@ -663,9 +786,9 @@ checksum = "26412eb97c6b088a6997e05f69403a802a92d520de2f8e63c2b65f9e0f47c4e8"

 [[package]]
 name = "rlimit"
-version = "0.3.0"
+version = "0.4.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e6d26e65e82a1e2628c5f209ec12f4508fa50e644bd2f264138e60129d61eae8"
+checksum = "49b02d62c38353a6fce45c25ca19783e25dd5f495ca681c674a4ee15aa4c1536"
 dependencies = [
 "cfg-if",
 "libc",
@@ -685,10 +808,11 @@ dependencies = [

 [[package]]
 name = "rustscan"
-version = "1.7.1"
+version = "1.8.0"
 dependencies = [
 "ansi_term 0.12.1",
 "async-std",
+ "cidr-utils",
 "colored",
 "colorful",
 "dirs",
@@ -698,8 +822,11 @@ dependencies = [
 "log",
 "rand",
 "rlimit",
+ "serde",
+ "serde_derive",
 "shell-words",
 "structopt",
+ "toml",
 ]

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

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

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

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

 [[package]]
 name = "structopt-derive"
-version = "0.4.9"
+version = "0.4.10"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1e0eb37335aeeebe51be42e2dc07f031163fbabfa6ac67d7ea68b5c2f68d5f99"
+checksum = "5e2513111825077552a6751dfad9e11ce0fba07d7276a3943a037d7e93e64c5f"
 dependencies = [
 "heck",
 "proc-macro-error",
@@ -821,6 +944,15 @@ dependencies = [
 "lazy_static",
 ]

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

+[[package]]
+name = "vec-arena"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "17dfb54bf57c9043f4616cb03dab30eff012cc26631b797d8354b916708db919"
+
 [[package]]
 name = "vec_map"
 version = "0.8.2"
@@ -1,6 +1,6 @@
 [package]
 name = "rustscan"
-version = "1.7.1"
+version = "1.8.0"
 authors = ["Bee <[email protected]>"]
 edition = "2018"
 description = "Faster Nmap Scanning with Rust"
@@ -10,15 +10,18 @@ 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 = "2.0.0"
-structopt = "0.3.16"
-async-std = "1.6.2"
+structopt = "0.3.17"
+async-std = "1.6.3"
 futures = "0.3"
-rlimit = "0.3.0"
+rlimit = "0.4.0"
 shell-words = "1.0.0"
 log = "0.4.0"
 env_logger = "0.7.1"
@@ -27,7 +30,15 @@ gcd = "2.0.1"
 rand = "0.7.3"
 colorful = "0.2.1"
 ansi_term = "0.12.1"
+toml = "0.5.6"
+serde = "1.0.115"
+serde_derive = "1.0.115"
+cidr-utils = "0.5.0"

 [package.metadata.deb]
 depends = "$auto, nmap"
 section = "rust"
+
+[profile.release]
+lto = true
+panic = 'abort'
@@ -0,0 +1,16 @@
+FROM rust:alpine as builder
+RUN apk add --no-cache build-base
+
+WORKDIR /usr/src/rustscan
+COPY . .
+RUN cargo install --path .
+
+FROM alpine:3.12
+LABEL author="Hydragyrum <https://github.com/Hydragyrum>"
+RUN addgroup -S rustscan && \
+    adduser -S -G rustscan rustscan && \
+    ulimit -n 100000 && \
+    apk add --no-cache nmap nmap-scripts wget
+COPY --from=builder /usr/local/cargo/bin/rustscan /usr/local/bin/rustscan
+USER rustscan
+ENTRYPOINT [ "/usr/local/bin/rustscan" ]
@@ -5,15 +5,14 @@
 <a href="https://github.com/RustScan/RustScan#-usage">Usage Guide</a>
 ⬅️
 <br>
-<img src="pictures/rustscan.png">
+<img src="pictures/rustscan.png" height=400px width=400px>
 </p>
 <p align="center">
-<u><b> Turns a 17 minutes Nmap scan into 19 seconds. </b></u><br> Find all open ports <b>fast</b> with RustScan, automatically pipe them into Nmap.
+<u><b> 👽 The Modern Day Port Scanner 👽
 </p>
 <p align="center">
-<img alt="AUR version" src="https://img.shields.io/aur/version/rustscan-bin">
+<img alt="AUR version" src="https://img.shields.io/aur/version/rustscan">
 <img src="https://img.shields.io/badge/Built%20with-Rust-Purple">
-<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/w/brandonskerritt/rustscan">
 <img alt="GitHub All Releases" src="https://img.shields.io/github/downloads/rustscan/rustscan/total?label=GitHub%20Downloads">
 <img alt="Crates.io" src="https://img.shields.io/crates/d/rustscan?label=Cargo%20Downloads">
 <img alt="Discord" src="https://img.shields.io/discord/736614461313515576">
@@ -21,296 +20,49 @@
 </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="pictures/docker.png" /></p> | <p align="center"><img src="pictures/kali.png" /></p> | <p align="center"><img src="pictures/arch.png" /></p> | <p align="center"><img src="pictures/rust.png" /></p>
-| `docker pull cmnatic/rustscan:debian-buster` <p>[Usage](https://github.com/RustScan/RustScan#docker-whale) | [Read the install guide](https://github.com/brandonskerritt/RustScan/blob/master/README.md#%EF%B8%8F-debian--kali) | `yay -S rustscan` | `cargo install rustscan`
+| <p align="center"><a href="https://hub.docker.com/r/cmnatic/rustscan">🐋 Docker (Recommended) </a></p>            | <p align="center"><a href="https://github.com/RustScan/RustScan/releases">👩‍💻 Kali / Debian </p>                 | <p align="center"><a href="https://aur.archlinux.org/packages/rustscan/">🏗️ Arch </a></p>                       | <p align="center"><a href="https://crates.io/crates/rustscan">🔧 Cargo (Universal) </a></p>                     |
+| ----------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
+| <p align="center"><img src="https://github.com/RustScan/RustScan/blob/master/pictures/docker.png?raw=true" /></p> | <p align="center"><img src="https://github.com/RustScan/RustScan/blob/master/pictures/kali.png?raw=true" /></p> | <p align="center"><img src="https://github.com/RustScan/RustScan/blob/master/pictures/arch.png?raw=true" /></p> | <p align="center"><img src="https://github.com/RustScan/RustScan/blob/master/pictures/rust.png?raw=true" /></p> |
+| `docker pull rustscan/rustscan:alpine` <p>[Usage](https://github.com/RustScan/RustScan#docker-whale)              | [Read the install guide](https://github.com/Rustscan/RustScan/blob/master/README.md#%EF%B8%8F-debian--kali)     | `yay -S rustscan`                                                                                               | `cargo install rustscan`                                                                                        |

 <hr>

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

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

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

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

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

 ## ‼️ Important Links

-| Installation Guide | Documentation | Discord |
-| ------------------ | ------------- | ------- |
-| 📖 [Installation Guide](https://github.com/RustScan/RustScan#-full-installation-guide) | 📚 [Documentation](https://github.com/RustScan/RustScan/issues/89) | 🦜 [Discord](https://discord.gg/GFrQsGy)
+| 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)
+RustScan is a port scanner built for the modern day world. Initially created to aid in CTFs, but now expanded to real world usage. 
+
+One of RustScan's most popular features is the Nmap extension. Quickly scan ports with RustScan, run Nmap on the found ports.

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

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

-| **Name**                                                                                   | RustScan | Nmap | Masscan |
-| ------------------------------------------------------------------------------------------ | -------- | ---- | ------- |
-| Fast                                                                                       | ✅        | ❌    | ✅       |
-| Actually useful                                                                            | ❌        | ✅    | ❌       |
-| Realises it's not useful, and pipes the only useful data into the only useful port scanner | ✅        | ❌    | ❌       |
-
-# 📖 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.
-
-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](https://github.com/brandonskerritt/RustScan/releases)
-
-Run the commpand `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, run this command against the IP you want to target.**
-
-```
-docker run -it --rm --name rustscan cmnatic/rustscan:debian-buster rustscan 127.0.0.1
-```
-
-Note: this will scan the Docker's localhost, not your own.
-
-This will download the Docker image.
-
-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.
-
-```
-alias rustscan='docker run -it --rm --name rustscan cmnatic/rustscan:debian-buster rustscan'
-```
-
-Then we can:
-
-```
-rustscan 127.0.0.1 -t 500 -b 1500 -- -A
-```
-
-## 🍺 HomeBrew
-
-**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.
-
-Tap the brew:
-
-```
-brew tap brandonskerritt/rustscan
-```
-
-Install it:
-
-```
-brew install rustscan
-```
-
-## 🔧 Building it yourself
-
-1. Git clone the repo.
-2. Install Rust. You can do this with `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh` which I took from the Rust website https://www.rust-lang.org/tools/install
-3. cd into the Git repo, and run `cargo build --release`
-4. The binary is located at `target/release/rustscan`
-5. Symlink to the binary or something. Whatever you want!
-
-## 🦊 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)
+# Packages

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

-# 🤸 Usage
-
-```
-rustscan -h
-```
-
-```
-rustscan 1.7.1
-Fast Port Scanner built in Rust. WARNING Do not use this program against sensitive infrastructure since the specified
-server may not be able to handle this many socket connections at once. - Discord https://discord.gg/GFrQsGy - GitHub
-https://github.com/RustScan/RustScan
-
-USAGE:
-    rustscan [FLAGS] [OPTIONS] <ips>... [-- <command>...]
-
-FLAGS:
-    -a, --accessible
-    -h, --help          Prints help information
-    -q, --quiet         Quiet mode. Only output the ports. No Nmap. Useful for grep or outputting to a file
-    -V, --version       Prints version information
-
-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]
-        --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:
-    <ips>...        A list of comma separated IP addresses to be scanned
-    <command>...    The Nmap arguments to run. To use the argument -A, end RustScan's args with '-- -A'. Example:
-                    'rustscan -T 1500 127.0.0.1 -- -A -sC'. This command adds -Pn -vvv -p $PORTS automatically to
-                    nmap. For things like --script '(safe and vuln)' enclose it in quotations marks \"'(safe and
-                    vuln)'\"")
-```
-
-The format is `rustscan -b 500 -T 1500 192.168.0.1` to scan 192.168.0.1 with 500 batch size with a timeout of 1500ms. The timeout is how long RustScan waits for a response until it assumes the port is closed.
-
-The batch size determines how fast RustScan is. Set it to 65k, and it will scan all 65k ports at the same time. This means at at 65k batch size, RustScan will take TIMEOUT long to scan all ports. Essentially, if timeout is 1000ms, **RustScan can scan in 1 second**.
-
-Your operating system may not support this, but it is worth it to play around and see where your open file limit is. Shortly I will be releasing a dockerised version with a much larger open file limit, so this will be possible.
-
-## ⚠️ WARNING
-
-This program, by default, scans 5000 ports at a time (5000 per second).
-
-This may cause damage to a server, or may make it incredibly obvious you are scanning the server.
-
-There are 2 ways to deal with this;
-1. Decrease batch size
-`rustscan -b 10` will run 10 port scans for 1 second, and then another 10 for 1 second and so on.
-2. Increase timeout
-`rustscan -T 5000` will mean RustScan waits 5 seconds until it scans the next ports.
-
-You can also use both of these at the same time, to make it as slow or as fast as you want. A fun favourite is 65535 batch size with 1 second timeout. Theoretically, this scans all 65535 ports in 1 second.
-
-**Please** do not use this tool against sensitive servers. It is designed mainly for Capture the Flag events, not real world servers with sensitive data.
-
-## 🚨 Thread Paniced at Main: Too Many Open Files
-This is the most common error found in RustScan.
-
-The open file limit is how many open sockets you can have at any given time.
-
-This limit changes from OS to OS.
-
-RustScan does not automatically create defaults (other than 5000) like Nmap does with their -T1, -T2 system.
-
-By figuring out for yourself the optimal batch size, you will know that RustScan is the most optimised port scanner for your system.
-
-There are 2 things you can do:
-1. Decrease batch size
-2. Increase open file limit
-
-Decreasing batch size slows down the program, so as long as it isn't too drastic, this is a good option.
-
-Run these 3 commands:
-
-```
-ulimit -a
-ulimit -Hn
-ulimit -Sn
-```
-
-They will give you an idea on the open file limit of your OS.
-
-If it says "250", run `rustscan -b 240` for a batch size of 240.
-
-Increasing the open file limit increases speed, but poses danger. Although, **opening more file sockets on the specified IP address may damage it**.
-
-To open more, set the ulimit to a higher number:
-
-```
-ulimit -n 5000
-```
-
-**Mac OS**
-Mac OS has, from what I can tell, a naturally very low open file descriptor limit. The limit for Ubuntu is 8800. The limit for Mac OS is 255!
-
-In this case, I would say it is safe to increase the open file limit. As most Linux based OS' have limits in the thousands.
-
-Although, if this breaks anything, please don't blame me.
-
-**Windows Subsystem for Linux**
-Windows Subsystem for Linux does not support 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/brandonskerritt/RustScan/issues/25) for more.
-
-## 🔌 Nmap Custom Flags
-To run your own nmap commands, end the RustScan command with `-- -A` where `--` indicates "end of RustScan flags, please do not parse anything further" and any flags after that will be entered into nmap.
-
-RustScan automatically runs `nmap -vvv -p $PORTS $IP`. To make it run `-A`, execute the command `rustscan 127.0.0.1 -- -A`.
-
-If you want to run commands such as `--script (vuln and safe)`, you will need to enclose it in quotations like so `--script '"(vuln and safe) or default"'`.
-
-## 🎯 Increasing speed / accuracy
-* Batch size
-
-This increases speed, by allowing us to process more at once. Something experimental I am working on is changing the open file limit. You can do this manually with `ulimit -n 70000` and then running rustscan with `-b 65535`. This _should_ scan all 65535 ports at the exact same time. But this is extremely experimental.
-
-For non-experimental speed increases, slowly increase the batch size until it no longer gets open ports, or it breaks.
-
-* Accuracy (and some speed)
-
-To increase accuracy, the easiest way is to increase the timeout. The default is 1.5 seconds, by setting it to 4 seconds (4000) we are telling RustScan "if we do not hear back from a port in 4 seconds, assume it is closed".
-
-Decreasing accuracy gives some speed bonus, but my testing found that batch size dramatically changed the speed whereas timeout did, but not so much.

 # 🎪 Community

@@ -323,19 +75,21 @@ Before contributing, read our [code of conduct](https://github.com/RustScan/Rust
 TL;DR if you abuse members of our community you will be **perma-banned** 🤗

 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)
+
+- 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
+
+- Fork the repo
+- Make changes
+- Pull request to the repo

 And then comment on the issue that you've done.

@@ -346,14 +100,17 @@ If you have any feature suggestions or bugs, leave a GitHub issue. We welcome an
 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! :)

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

 ## Contributors ✨
+
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-9-orange.svg?style=flat-square)](#contributors-)
+
+[![All Contributors](https://img.shields.io/badge/all_contributors-18-orange.svg?style=flat-square)](#contributors-)
+
 <!-- ALL-CONTRIBUTORS-BADGE:END -->

 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
@@ -373,12 +130,24 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
  </tr>
  <tr>
    <td align="center"><a href="https://github.com/Atul9"><img src="https://avatars1.githubusercontent.com/u/3390330?v=4" width="100px;" alt=""/><br /><sub><b>Atul Bhosale</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=Atul9" title="Code">💻</a></td>
+    <td align="center"><a href="https://tgotwig.me"><img src="https://avatars0.githubusercontent.com/u/30773779?v=4" width="100px;" alt=""/><br /><sub><b>Thomas Gotwig</b></sub></a><br /><a href="#platform-TGotwig" title="Packaging/porting to new platform">📦</a></td>
    <td align="center"><a href="https://github.com/remigourdon"><img src="https://avatars3.githubusercontent.com/u/2874133?v=4" width="100px;" alt=""/><br /><sub><b>Rémi Gourdon</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=remigourdon" title="Documentation">📖</a> <a href="https://github.com/RustScan/RustScan/commits?author=remigourdon" title="Code">💻</a></td>
+    <td align="center"><a href="https://cmnatic.co.uk"><img src="https://avatars3.githubusercontent.com/u/4163116?v=4" width="100px;" alt=""/><br /><sub><b>Ben (CMNatic)</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=cmnatic" title="Code">💻</a> <a href="https://github.com/RustScan/RustScan/commits?author=cmnatic" title="Documentation">📖</a> <a href="#design-cmnatic" title="Design">🎨</a></td>
+    <td align="center"><a href="https://github.com/Ferryistaken"><img src="https://avatars3.githubusercontent.com/u/47927670?v=4" width="100px;" alt=""/><br /><sub><b>Alessandro Ferrari</b></sub></a><br /><a href="#content-Ferryistaken" title="Content">🖋</a></td>
+    <td align="center"><a href="https://github.com/Phenomite"><img src="https://avatars2.githubusercontent.com/u/8285537?v=4" width="100px;" alt=""/><br /><sub><b>Phenomite</b></sub></a><br /><a href="#content-Phenomite" title="Content">🖋</a></td>
+    <td align="center"><a href="https://supersandro.de/"><img src="https://avatars2.githubusercontent.com/u/7258858?v=4" width="100px;" alt=""/><br /><sub><b>Sandro</b></sub></a><br /><a href="#content-SuperSandro2000" title="Content">🖋</a> <a href="https://github.com/RustScan/RustScan/issues?q=author%3ASuperSandro2000" title="Bug reports">🐛</a> <a href="https://github.com/RustScan/RustScan/commits?author=SuperSandro2000" title="Code">💻</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://swag.lgbt"><img src="https://avatars2.githubusercontent.com/u/25358963?v=4" width="100px;" alt=""/><br /><sub><b>Cass</b></sub></a><br /><a href="#platform-caass" title="Packaging/porting to new platform">📦</a> <a href="https://github.com/RustScan/RustScan/commits?author=caass" title="Code">💻</a> <a href="https://github.com/RustScan/RustScan/issues?q=author%3Acaass" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://github.com/niklasmohrin"><img src="https://avatars0.githubusercontent.com/u/47574893?v=4" width="100px;" alt=""/><br /><sub><b>Niklas Mohrin</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=niklasmohrin" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://liberapay.com/Artem4/"><img src="https://avatars0.githubusercontent.com/u/5614476?v=4" width="100px;" alt=""/><br /><sub><b>Artem Polishchuk</b></sub></a><br /><a href="#platform-tim77" title="Packaging/porting to new platform">📦</a></td>
+    <td align="center"><a href="https://github.com/buermarc"><img src="https://avatars2.githubusercontent.com/u/44375277?v=4" width="100px;" alt=""/><br /><sub><b>buermarc</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=buermarc" title="Code">💻</a></td>
  </tr>
 </table>

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

 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
@@ -8,7 +8,7 @@ TL;DR if you abuse members of our community you will be **perma-banned** with no

 RustScan has 2 major labels for GitHub issues you should look at:
 * Good First issue
-These are issues for newcomers to open source! 
+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!
@@ -16,7 +16,7 @@ These are issues that aren't really for newcomers, but we could still do wiht he

 If you want to, solve the issue or comment on the issue for help.

-The flow for contributing to open source software is:
+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
@@ -0,0 +1,368 @@
+use serde_derive::Deserialize;
+use std::fs;
+use structopt::{clap::arg_enum, StructOpt};
+
+const LOWEST_PORT_NUMBER: u16 = 1;
+const TOP_PORT_NUMBER: u16 = 65535;
+
+arg_enum! {
+    /// Represents the strategy in which the port scanning will run.
+    ///   - Serial will run from start to end, for example 1 to 1_000.
+    ///   - Random will randomize the order in which ports will be scanned.
+    #[derive(Deserialize, Debug, StructOpt, Clone, PartialEq)]
+    pub enum ScanOrder {
+        Serial,
+        Random,
+    }
+}
+
+/// Represents the range of ports to be scanned.
+#[derive(Deserialize, Debug, Clone, PartialEq)]
+pub struct PortRange {
+    pub start: u16,
+    pub end: u16,
+}
+
+fn parse_range(input: &str) -> Result<PortRange, String> {
+    let range = input
+        .split("-")
+        .map(|x| x.parse::<u16>())
+        .collect::<Result<Vec<u16>, std::num::ParseIntError>>();
+
+    if range.is_err() {
+        return Err(String::from(
+            "the range format must be 'start-end'. Example: 1-1000.",
+        ));
+    }
+
+    match range.unwrap().as_slice() {
+        [start, end] => Ok(PortRange {
+            start: *start,
+            end: *end,
+        }),
+        _ => Err(String::from(
+            "the range format must be 'start-end'. Example: 1-1000.",
+        )),
+    }
+}
+
+#[derive(StructOpt, Debug)]
+#[structopt(name = "rustscan", setting = structopt::clap::AppSettings::TrailingVarArg)]
+/// Fast Port Scanner built in Rust.
+/// WARNING Do not use this program against sensitive infrastructure since the
+/// specified server may not be able to handle this many socket connections at once.
+/// - Discord https://discord.gg/GFrQsGy
+/// - GitHub https://github.com/RustScan/RustScan
+pub struct Opts {
+    /// A list of comma separated CIDRs, IPs, or hosts to be scanned.
+    #[structopt(use_delimiter = true)]
+    pub addresses: Vec<String>,
+
+    /// A list of comma separed ports to be scanned. Example: 80,443,8080.
+    #[structopt(short, long, use_delimiter = true)]
+    pub ports: Option<Vec<u16>>,
+
+    /// A range of ports with format start-end. Example: 1-1000.
+    #[structopt(short, long, conflicts_with = "ports", parse(try_from_str = parse_range))]
+    pub range: Option<PortRange>,
+
+    /// Whether to ignore the configuration file or not.
+    #[structopt(short, long)]
+    pub no_config: bool,
+
+    /// Quiet mode. Only output the ports. No Nmap. Useful for grep or outputting to a file.
+    #[structopt(short, long)]
+    pub quiet: bool,
+
+    /// Accessible mode. Turns off features which negatively affect screen readers.
+    #[structopt(long)]
+    pub accessible: bool,
+
+    /// Turns off Nmap.
+    #[structopt(long)]
+    pub no_nmap: bool,
+
+    /// The batch size for port scanning, it increases or slows the speed of
+    /// scanning. Depends on the open file limit of your OS.  If you do 65535
+    /// it will do every port at the same time. Although, your OS may not
+    /// support this.
+    #[structopt(short, long, default_value = "4500")]
+    pub batch_size: u16,
+
+    /// The timeout in milliseconds before a port is assumed to be closed.
+    #[structopt(short, long, default_value = "1500")]
+    pub timeout: u32,
+
+    /// Automatically ups the ULIMIT with the value you provided.
+    #[structopt(short, long)]
+    pub ulimit: Option<rlimit::rlim>,
+
+    /// The order of scanning to be performed. The "serial" option will
+    /// scan ports in ascending order while the "random" option will scan
+    /// ports randomly.
+    #[structopt(long, possible_values = &ScanOrder::variants(), case_insensitive = true, default_value = "serial")]
+    pub scan_order: ScanOrder,
+
+    /// The Nmap arguments to run.
+    /// To use the argument -A, end RustScan's args with '-- -A'.
+    /// Example: 'rustscan -T 1500 127.0.0.1 -- -A -sC'.
+    /// This command adds -Pn -vvv -p $PORTS automatically to nmap.
+    /// For things like --script '(safe and vuln)' enclose it in quotations marks \"'(safe and vuln)'\"")
+    #[structopt(last = true)]
+    pub command: Vec<String>,
+}
+
+impl Opts {
+    pub fn read() -> Self {
+        let mut opts = Opts::from_args();
+
+        if opts.ports.is_none() && opts.range.is_none() {
+            opts.range = Some(PortRange {
+                start: LOWEST_PORT_NUMBER,
+                end: TOP_PORT_NUMBER,
+            });
+        }
+
+        opts
+    }
+
+    /// Reads the command line arguments into an Opts struct and merge
+    /// values found within the user configuration file.
+    pub fn merge(&mut self, config: &Config) {
+        if !self.no_config {
+            self.merge_required(&config);
+            self.merge_optional(&config);
+        }
+    }
+
+    fn merge_required(&mut self, config: &Config) {
+        macro_rules! merge_required {
+            ($($field: ident),+) => {
+                $(
+                    if let Some(e) = &config.$field {
+                        self.$field = e.clone();
+                    }
+                )+
+            }
+        }
+
+        merge_required!(addresses, quiet, accessible, batch_size, timeout, scan_order, command);
+    }
+
+    fn merge_optional(&mut self, config: &Config) {
+        macro_rules! merge_optional {
+            ($($field: ident),+) => {
+                $(
+                    if config.$field.is_some() {
+                        self.$field = config.$field.clone();
+                    }
+                )+
+            }
+        }
+
+        merge_optional!(ports, range, ulimit);
+    }
+}
+
+/// Struct used to deserialize the options specified within our config file.
+/// These will be further merged with our command line arguments in order to
+/// generate the final Opts struct.
+#[derive(Debug, Deserialize)]
+pub struct Config {
+    addresses: Option<Vec<String>>,
+    ports: Option<Vec<u16>>,
+    range: Option<PortRange>,
+    quiet: Option<bool>,
+    accessible: Option<bool>,
+    batch_size: Option<u16>,
+    timeout: Option<u32>,
+    no_nmap: Option<bool>,
+    ulimit: Option<rlimit::rlim>,
+    scan_order: Option<ScanOrder>,
+    command: Option<Vec<String>>,
+}
+
+impl Config {
+    /// Reads the configuration file with TOML format and parses it into a
+    /// Config struct.
+    ///
+    /// # Format
+    ///
+    /// addresses = ["127.0.0.1", "127.0.0.1"]
+    /// ports = [80, 443, 8080]
+    /// quiet = true
+    /// scan_order: "Serial"
+    ///
+    pub fn read() -> Self {
+        let mut paths = Vec::new();
+        paths.push(match dirs::home_dir() {
+            Some(mut path) => {
+                path.push(".rustscan.toml");
+                path
+            }
+            None => panic!("Could not infer config file path."),
+        });
+
+        paths.push(match dirs::config_dir() {
+            Some(mut path) => {
+                path.push("rustscan");
+                path.push("config.toml");
+                path
+            }
+            None => panic!("Could not infer config file path."),
+        });
+
+        let mut contents: Option<String> = None;
+        for path in paths.iter().rev() {
+            contents = match fs::read_to_string(path) {
+                Ok(content) => {
+                    contents = Some(content);
+                    break;
+                }
+                Err(_) => None,
+            };
+        }
+
+        if contents.is_none() {
+            contents = Some(String::new());
+        }
+
+        let config: Config = match toml::from_str(&contents.unwrap()) {
+            Ok(config) => config,
+            Err(e) => {
+                println!("Found {} in configuration file.\nAborting scan.\n", e);
+                std::process::exit(1);
+            }
+        };
+
+        config
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::{Config, Opts, PortRange, ScanOrder};
+
+    #[test]
+    fn opts_no_merge_when_config_is_ignored() {
+        let mut opts = Opts {
+            addresses: vec![],
+            ports: None,
+            range: None,
+            quiet: false,
+            batch_size: 0,
+            timeout: 0,
+            ulimit: None,
+            command: vec![],
+            accessible: false,
+            no_nmap: false,
+            scan_order: ScanOrder::Serial,
+            no_config: true,
+        };
+
+        let config = Config {
+            addresses: Some(vec!["127.0.0.1".to_owned()]),
+            ports: None,
+            range: None,
+            quiet: Some(true),
+            batch_size: Some(25_000),
+            timeout: Some(1_000),
+            ulimit: None,
+            no_nmap: Some(false),
+            command: Some(vec!["-A".to_owned()]),
+            accessible: Some(true),
+            scan_order: Some(ScanOrder::Random),
+        };
+
+        opts.merge(&config);
+
+        assert_eq!(opts.addresses, vec![] as Vec<String>);
+        assert_eq!(opts.quiet, false);
+        assert_eq!(opts.accessible, false);
+        assert_eq!(opts.timeout, 0);
+        assert_eq!(opts.command, vec![] as Vec<String>);
+        assert_eq!(opts.scan_order, ScanOrder::Serial);
+    }
+
+    #[test]
+    fn opts_merge_required_arguments() {
+        let mut opts = Opts {
+            addresses: vec![],
+            ports: None,
+            range: None,
+            quiet: false,
+            batch_size: 0,
+            timeout: 0,
+            ulimit: None,
+            command: vec![],
+            accessible: false,
+            scan_order: ScanOrder::Serial,
+            no_nmap: false,
+            no_config: false,
+        };
+
+        let config = Config {
+            addresses: Some(vec!["127.0.0.1".to_owned()]),
+            ports: None,
+            no_nmap: Some(false),
+            range: None,
+            quiet: Some(true),
+            batch_size: Some(25_000),
+            timeout: Some(1_000),
+            ulimit: None,
+            command: Some(vec!["-A".to_owned()]),
+            accessible: Some(true),
+            scan_order: Some(ScanOrder::Random),
+        };
+
+        opts.merge_required(&config);
+
+        assert_eq!(opts.addresses, config.addresses.unwrap());
+        assert_eq!(opts.quiet, config.quiet.unwrap());
+        assert_eq!(opts.timeout, config.timeout.unwrap());
+        assert_eq!(opts.command, config.command.unwrap());
+        assert_eq!(opts.accessible, config.accessible.unwrap());
+        assert_eq!(opts.scan_order, config.scan_order.unwrap());
+    }
+
+    #[test]
+    fn opts_merge_optional_arguments() {
+        let mut opts = Opts {
+            addresses: vec![],
+            ports: None,
+            range: None,
+            quiet: false,
+            batch_size: 0,
+            timeout: 0,
+            ulimit: None,
+            command: vec![],
+            accessible: false,
+            scan_order: ScanOrder::Serial,
+            no_nmap: false,
+            no_config: false,
+        };
+
+        let config = Config {
+            addresses: None,
+            ports: Some(vec![80, 403]),
+            range: Some(PortRange {
+                start: 1,
+                end: 1_000,
+            }),
+            quiet: None,
+            batch_size: None,
+            timeout: None,
+            no_nmap: Some(false),
+            ulimit: Some(1_000),
+            command: None,
+            accessible: None,
+            scan_order: None,
+        };
+
+        opts.merge_optional(&config);
+
+        assert_eq!(opts.ports, config.ports);
+        assert_eq!(opts.range, config.range);
+        assert_eq!(opts.ulimit, config.ulimit);
+    }
+}
@@ -2,27 +2,29 @@ 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;

+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::net::ToSocketAddrs;
 use std::process::Command;
 use std::{net::IpAddr, time::Duration};
-use structopt::{clap::arg_enum, StructOpt};

 extern crate colorful;
 extern crate dirs;

-const LOWEST_PORT_NUMBER: u16 = 1;
-const TOP_PORT_NUMBER: u16 = 65535;
 // Average value for Ubuntu
 const DEFAULT_FILE_DESCRIPTORS_LIMIT: rlimit::rlim = 8000;
 // Safest batch size based on experimentation
@@ -31,87 +33,39 @@ const AVERAGE_BATCH_SIZE: rlimit::rlim = 3000;
 #[macro_use]
 extern crate log;

-arg_enum! {
-    #[derive(Debug, StructOpt)]
-    pub enum ScanOrder {
-        Serial,
-        Random,
-    }
-}
-
-#[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
-struct Opts {
-    /// A list of comma separated IP addresses to be scanned.
-    #[structopt(use_delimiter = true, parse(try_from_str), required = true)]
-    ips: Vec<IpAddr>,
-
-    ///Quiet mode. Only output the ports. No Nmap. Useful for grep or outputting to a file.
-    #[structopt(short, long)]
-    quiet: bool,
-
-    //Accessible mode. Turns off features which negatively affect screen readers.
-    #[structopt(short, long)]
-    accessible: 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")]
-    batch_size: u16,
-
-    /// The timeout in milliseconds before a port is assumed to be closed.
-    #[structopt(short, long, default_value = "1500")]
-    timeout: u32,
-
-    /// Automatically ups the ULIMIT with the value you provided.
-    #[structopt(short, long)]
-    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")]
-    scan_order: ScanOrder,
-
-    /// The Nmap arguments to run.
-    /// To use the argument -A, end RustScan's args with '-- -A'.
-    /// Example: 'rustscan -T 1500 127.0.0.1 -- -A -sC'.
-    /// This command adds -Pn -vvv -p $PORTS automatically to nmap.
-    /// For things like --script '(safe and vuln)' enclose it in quotations marks \"'(safe and vuln)'\"")
-    #[structopt(last = true)]
-    command: Vec<String>,
-}
-
 #[cfg(not(tarpaulin_include))]
 /// Faster Nmap scanning with Rust
 /// If you're looking for the actual scanning, check out the module Scanner
 fn main() {
    env_logger::init();

-    info!("Starting up");
-    let opts = Opts::from_args();
-    info!("Mains() `opts` arguments are {:?}", opts);
+    let mut opts: Opts = Opts::read();
+    let config = Config::read();
+    opts.merge(&config);
+    dbg!(&opts);
+
+    info!("Main() `opts` arguments are {:?}", opts);

    if !opts.quiet && !opts.accessible {
        print_opening();
    }

+    let ips: Vec<IpAddr> = parse_addresses(&opts);
+
+    if ips.is_empty() {
+        warning!("No IPs could be resolved, aborting scan.", false);
+        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(
-        &opts.ips,
+        &ips,
        batch_size,
        Duration::from_millis(opts.timeout.into()),
        opts.quiet,
-        PortStrategy::pick(LOWEST_PORT_NUMBER, TOP_PORT_NUMBER, opts.scan_order),
+        PortStrategy::pick(opts.range, opts.ports, opts.scan_order),
    );

    let scan_result = block_on(scanner.run());
@@ -124,7 +78,7 @@ fn main() {
            .push(socket.port());
    }

-    for ip in opts.ips {
+    for ip in ips {
        if ports_per_ip.contains_key(&ip) {
            continue;
        }
@@ -134,7 +88,7 @@ fn main() {

        let x = format!("{} Looks like I didn't find any open ports for {:?}. This is usually caused by a high batch size.
        \n*I used {} batch size, consider lowering to {} with {} or a comfortable number for your system.
-        \n Alternatively, increase the timeout if your ping is high. Rustscan -T 2000 for 2000 second timeout.\n",
+        \n Alternatively, increase the timeout if your ping is high. Rustscan -t 2000 for 2000 milliseconds (2s) timeout.\n",
        "ERROR",
        ip,
        opts.batch_size,
@@ -215,7 +169,6 @@ fn build_nmap_arguments<'a>(
    is_ipv6: bool,
 ) -> Vec<&'a str> {
    let mut arguments: Vec<&str> = user_args.iter().map(AsRef::as_ref).collect();
-    arguments.push("-A");
    arguments.push("-vvv");

    if is_ipv6 {
@@ -229,6 +182,25 @@ fn build_nmap_arguments<'a>(
    arguments
 }

+fn parse_addresses(opts: &Opts) -> Vec<IpAddr> {
+    let mut ips: Vec<IpAddr> = Vec::new();
+
+    for ip_or_host in &opts.addresses {
+        match IpCidr::from_str(ip_or_host) {
+            Ok(cidr) => cidr.iter().for_each(|ip| ips.push(ip)),
+            _ => match format!("{}:{}", &ip_or_host, 80).to_socket_addrs() {
+                Ok(mut iter) => ips.push(iter.nth(0).unwrap().ip()),
+                _ => {
+                    let failed_to_resolve = format!("Host {:?} could not be resolved.", ip_or_host);
+                    warning!(failed_to_resolve, opts.quiet);
+                }
+            },
+        }
+    }
+
+    ips
+}
+
 fn adjust_ulimit_size(opts: &Opts) -> rlimit::rlim {
    if opts.ulimit.is_some() {
        let limit: rlimit::rlim = opts.ulimit.unwrap();
@@ -254,7 +226,7 @@ fn infer_batch_size(opts: &Opts, ulimit: rlimit::rlim) -> u16 {

    // 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 --ulimt. May cause harm to sensitive servers",
+        warning!("File limit is lower than default batch size. Consider upping with --ulimit. May cause harm to sensitive servers",
            opts.quiet
        );

@@ -289,13 +261,17 @@ fn infer_batch_size(opts: &Opts, ulimit: rlimit::rlim) -> u16 {

 #[cfg(test)]
 mod tests {
-    use crate::{adjust_ulimit_size, infer_batch_size, print_opening, Opts, ScanOrder};
-    use std::{net::IpAddr, str::FromStr};
+    use crate::{
+        adjust_ulimit_size, infer_batch_size, parse_addresses, print_opening, Opts, ScanOrder,
+    };
+    use std::net::Ipv4Addr;

    #[test]
    fn batch_size_lowered() {
        let opts = Opts {
-            ips: vec![IpAddr::from_str("127.0.0.1").unwrap()],
+            addresses: vec!["127.0.0.1".to_owned()],
+            ports: None,
+            range: None,
            quiet: true,
            batch_size: 50_000,
            timeout: 1_000,
@@ -303,6 +279,8 @@ mod tests {
            command: Vec::new(),
            accessible: false,
            scan_order: ScanOrder::Serial,
+            no_config: false,
+            no_nmap: false,
        };
        let batch_size = infer_batch_size(&opts, 120);

@@ -312,7 +290,9 @@ mod tests {
    #[test]
    fn batch_size_lowered_average_size() {
        let opts = Opts {
-            ips: vec![IpAddr::from_str("127.0.0.1").unwrap()],
+            addresses: vec!["127.0.0.1".to_owned()],
+            ports: None,
+            range: None,
            quiet: true,
            batch_size: 50_000,
            timeout: 1_000,
@@ -320,6 +300,8 @@ mod tests {
            command: Vec::new(),
            accessible: false,
            scan_order: ScanOrder::Serial,
+            no_config: false,
+            no_nmap: false,
        };
        let batch_size = infer_batch_size(&opts, 9_000);

@@ -330,7 +312,9 @@ mod tests {
        // because ulimit and batch size are same size, batch size is lowered
        // to ULIMIT - 100
        let opts = Opts {
-            ips: vec![IpAddr::from_str("127.0.0.1").unwrap()],
+            addresses: vec!["127.0.0.1".to_owned()],
+            ports: None,
+            range: None,
            quiet: true,
            batch_size: 50_000,
            timeout: 1_000,
@@ -338,6 +322,8 @@ mod tests {
            command: Vec::new(),
            accessible: false,
            scan_order: ScanOrder::Serial,
+            no_config: false,
+            no_nmap: false,
        };
        let batch_size = infer_batch_size(&opts, 5_000);

@@ -347,7 +333,9 @@ mod tests {
    fn batch_size_adjusted_2000() {
        // ulimit == batch_size
        let opts = Opts {
-            ips: vec![IpAddr::from_str("127.0.0.1").unwrap()],
+            addresses: vec!["127.0.0.1".to_owned()],
+            ports: None,
+            range: None,
            quiet: true,
            batch_size: 50_000,
            timeout: 1_000,
@@ -355,6 +343,8 @@ mod tests {
            command: Vec::new(),
            accessible: false,
            scan_order: ScanOrder::Serial,
+            no_config: false,
+            no_nmap: false,
        };
        let batch_size = adjust_ulimit_size(&opts);

@@ -369,7 +359,9 @@ mod tests {
    #[test]
    fn test_high_ulimit_no_quiet_mode() {
        let opts = Opts {
-            ips: vec![IpAddr::from_str("127.0.0.1").unwrap()],
+            addresses: vec!["127.0.0.1".to_owned()],
+            ports: None,
+            range: None,
            quiet: false,
            batch_size: 10,
            timeout: 1_000,
@@ -377,10 +369,105 @@ mod tests {
            command: Vec::new(),
            accessible: true,
            scan_order: ScanOrder::Serial,
+            no_config: false,
+            no_nmap: false,
        };

        infer_batch_size(&opts, 1_000_000);

        assert!(1 == 1);
    }
+
+    #[test]
+    fn parse_correct_addresses() {
+        let opts = Opts {
+            addresses: vec!["127.0.0.1".to_owned(), "192.168.0.0/30".to_owned()],
+            ports: None,
+            range: None,
+            quiet: true,
+            batch_size: 10,
+            timeout: 1_000,
+            ulimit: Some(2_000),
+            command: Vec::new(),
+            accessible: false,
+            scan_order: ScanOrder::Serial,
+            no_config: false,
+            no_nmap: false,
+        };
+        let ips = parse_addresses(&opts);
+
+        assert_eq!(
+            ips,
+            [
+                Ipv4Addr::new(127, 0, 0, 1),
+                Ipv4Addr::new(192, 168, 0, 0),
+                Ipv4Addr::new(192, 168, 0, 1),
+                Ipv4Addr::new(192, 168, 0, 2),
+                Ipv4Addr::new(192, 168, 0, 3)
+            ]
+        );
+    }
+
+    #[test]
+    fn parse_correct_host_addresses() {
+        let opts = Opts {
+            addresses: vec!["google.com".to_owned()],
+            ports: None,
+            range: None,
+            quiet: true,
+            batch_size: 10,
+            timeout: 1_000,
+            ulimit: Some(2_000),
+            command: Vec::new(),
+            accessible: false,
+            scan_order: ScanOrder::Serial,
+            no_config: false,
+            no_nmap: false,
+        };
+        let ips = parse_addresses(&opts);
+
+        assert_eq!(ips.len(), 1);
+    }
+
+    #[test]
+    fn parse_correct_and_incorrect_addresses() {
+        let opts = Opts {
+            addresses: vec!["127.0.0.1".to_owned(), "im_wrong".to_owned()],
+            ports: None,
+            range: None,
+            quiet: true,
+            batch_size: 10,
+            timeout: 1_000,
+            ulimit: Some(2_000),
+            command: Vec::new(),
+            accessible: false,
+            scan_order: ScanOrder::Serial,
+            no_config: false,
+            no_nmap: false,
+        };
+        let ips = parse_addresses(&opts);
+
+        assert_eq!(ips, [Ipv4Addr::new(127, 0, 0, 1),]);
+    }
+
+    #[test]
+    fn parse_incorrect_addresses() {
+        let opts = Opts {
+            addresses: vec!["im_wrong".to_owned(), "300.10.1.1".to_owned()],
+            ports: None,
+            range: None,
+            quiet: true,
+            batch_size: 10,
+            timeout: 1_000,
+            ulimit: Some(2_000),
+            command: Vec::new(),
+            accessible: false,
+            scan_order: ScanOrder::Serial,
+            no_config: false,
+            no_nmap: false,
+        };
+        let ips = parse_addresses(&opts);
+
+        assert_eq!(ips.is_empty(), true);
+    }
 }
@@ -1,5 +1,7 @@
 mod range_iterator;
-use super::ScanOrder;
+use super::{PortRange, ScanOrder};
+use rand::seq::SliceRandom;
+use rand::thread_rng;
 use range_iterator::RangeIterator;

 /// Represents options of port scanning.
@@ -7,20 +9,41 @@ use range_iterator::RangeIterator;
 /// Right now all these options involve ranges, but in the future
 /// it will also contain custom lists of ports.
 pub enum PortStrategy {
+    Manual(Vec<u16>),
    Serial(SerialRange),
    Random(RandomRange),
 }

 impl PortStrategy {
-    pub fn pick(start: u16, end: u16, scan_type: ScanOrder) -> Self {
-        match scan_type {
-            ScanOrder::Serial => PortStrategy::Serial(SerialRange { start, end }),
-            ScanOrder::Random => PortStrategy::Random(RandomRange { start, end }),
+    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(),
        }
@@ -71,18 +94,20 @@ impl RangeOrder for RandomRange {
 #[cfg(test)]
 mod tests {
    use super::PortStrategy;
-    use crate::ScanOrder;
+    use crate::{PortRange, ScanOrder};

    #[test]
-    fn serial_strategy() {
-        let strategy = PortStrategy::pick(1, 100, ScanOrder::Serial);
+    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() {
-        let strategy = PortStrategy::pick(1, 100, ScanOrder::Random);
+    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);
@@ -90,4 +115,22 @@ mod tests {
        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);
+    }
 }
@@ -12,14 +12,14 @@ use std::{
 };

 /// The class for the scanner
-/// Host is data type IpAddr and is the host address
+/// IP is data type IpAddr and is the IP address
 /// start & end is where the port scan starts and ends
 /// batch_size is how many ports at a time should be scanned
 /// Timeout is the time RustScan should wait before declaring a port closed. As datatype Duration.
 /// Quiet is whether or not RustScan should print things, or wait until the end to print only open ports.
 #[cfg(not(tarpaulin_include))]
 pub struct Scanner {
-    hosts: Vec<IpAddr>,
+    ips: Vec<IpAddr>,
    batch_size: u16,
    timeout: Duration,
    quiet: bool,
@@ -28,7 +28,7 @@ pub struct Scanner {

 impl Scanner {
    pub fn new(
-        hosts: &[IpAddr],
+        ips: &[IpAddr],
        batch_size: u16,
        timeout: Duration,
        quiet: bool,
@@ -39,7 +39,7 @@ impl Scanner {
            timeout,
            quiet,
            port_strategy,
-            hosts: hosts.iter().map(|host| host.to_owned()).collect(),
+            ips: ips.iter().map(|ip| ip.to_owned()).collect(),
        }
    }

@@ -48,10 +48,10 @@ impl Scanner {
    /// Returns all open ports as Vec<u16>
    pub async fn run(&self) -> Vec<SocketAddr> {
        let ports: Vec<u16> = self.port_strategy.order();
-        let batch_per_host: usize = self.batch_size as usize / self.hosts.len();
+        let batch_per_ip: usize = self.batch_size as usize / self.ips.len();
        let mut open_sockets: Vec<SocketAddr> = Vec::new();

-        for batch in ports.chunks(batch_per_host) {
+        for batch in ports.chunks(batch_per_ip) {
            let mut sockets = self.scan_ports(batch).await;
            open_sockets.append(&mut sockets);
        }
@@ -64,8 +64,8 @@ impl Scanner {
    async fn scan_ports(&self, ports: &[u16]) -> Vec<SocketAddr> {
        let mut ftrs = FuturesUnordered::new();
        for port in ports {
-            for host in &self.hosts {
-                ftrs.push(self.scan_socket(SocketAddr::new(*host, *port)));
+            for ip in &self.ips {
+                ftrs.push(self.scan_socket(SocketAddr::new(*ip, *port)));
            }
        }

@@ -91,7 +91,7 @@ impl Scanner {
    ///
    ///     self.scan_port(10:u16)
    ///
-    /// Note: `self` must contain `self.host`.
+    /// Note: `self` must contain `self.ip`.
    async fn scan_socket(&self, socket: SocketAddr) -> io::Result<SocketAddr> {
        match self.connect(socket).await {
            Ok(x) => {
@@ -119,9 +119,9 @@ impl Scanner {
    /// # Example
    ///
    ///     let port: u16 = 80
-    ///     // Host is an IpAddr type
-    ///     let host = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
-    ///     let socket = SocketAddr::new(host, port);
+    ///     // 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
@@ -139,7 +139,7 @@ impl Scanner {
 #[cfg(test)]
 mod tests {
    use super::*;
-    use crate::ScanOrder;
+    use crate::{PortRange, ScanOrder};
    use async_std::task::block_on;
    use std::{net::IpAddr, time::Duration};

@@ -147,7 +147,11 @@ mod tests {
    fn scanner_runs() {
        // Makes sure the program still runs and doesn't panic
        let addrs = vec!["127.0.0.1".parse::<IpAddr>().unwrap()];
-        let strategy = PortStrategy::pick(1, 1_000, ScanOrder::Random);
+        let range = PortRange {
+            start: 1,
+            end: 1_000,
+        };
+        let strategy = PortStrategy::pick(Some(range), None, ScanOrder::Random);
        let scanner = Scanner::new(&addrs, 10, Duration::from_millis(100), true, strategy);
        block_on(scanner.run());
        // if the scan fails, it wouldn't be able to assert_eq! as it panicked!
@@ -157,7 +161,11 @@ mod tests {
    fn ipv6_scanner_runs() {
        // Makes sure the program still runs and doesn't panic
        let addrs = vec!["::1".parse::<IpAddr>().unwrap()];
-        let strategy = PortStrategy::pick(1, 1_000, ScanOrder::Random);
+        let range = PortRange {
+            start: 1,
+            end: 1_000,
+        };
+        let strategy = PortStrategy::pick(Some(range), None, ScanOrder::Random);
        let scanner = Scanner::new(&addrs, 10, Duration::from_millis(100), true, strategy);
        block_on(scanner.run());
        // if the scan fails, it wouldn't be able to assert_eq! as it panicked!
@@ -166,7 +174,11 @@ mod tests {
    #[test]
    fn quad_zero_scanner_runs() {
        let addrs = vec!["0.0.0.0".parse::<IpAddr>().unwrap()];
-        let strategy = PortStrategy::pick(1, 1_000, ScanOrder::Random);
+        let range = PortRange {
+            start: 1,
+            end: 1_000,
+        };
+        let strategy = PortStrategy::pick(Some(range), None, ScanOrder::Random);
        let scanner = Scanner::new(&addrs, 10, Duration::from_millis(100), true, strategy);
        block_on(scanner.run());
        assert_eq!(1, 1);
@@ -174,7 +186,11 @@ mod tests {
    #[test]
    fn google_dns_runs() {
        let addrs = vec!["8.8.8.8".parse::<IpAddr>().unwrap()];
-        let strategy = PortStrategy::pick(400, 445, ScanOrder::Random);
+        let range = PortRange {
+            start: 400,
+            end: 445,
+        };
+        let strategy = PortStrategy::pick(Some(range), None, ScanOrder::Random);
        let scanner = Scanner::new(&addrs, 10, Duration::from_millis(100), true, strategy);
        block_on(scanner.run());
        assert_eq!(1, 1);
@@ -185,7 +201,11 @@ mod tests {
        let addrs = vec!["8.8.8.8".parse::<IpAddr>().unwrap()];

        // mac should have this automatically scaled down
-        let strategy = PortStrategy::pick(400, 600, ScanOrder::Random);
+        let range = PortRange {
+            start: 400,
+            end: 600,
+        };
+        let strategy = PortStrategy::pick(Some(range), None, ScanOrder::Random);
        let scanner = Scanner::new(&addrs, 10, Duration::from_millis(100), true, strategy);
        block_on(scanner.run());
        assert_eq!(1, 1);
Author	SHA1	Message	Date
Brandon	08904c0bf2	initial changes	2020-09-12 01:49:16 +01:00
Brandon	bc5b2eea7e	added release drafter	2020-09-11 00:59:55 +01:00
Bee	bda392c9a7	Merge pull request #200 from RustScan/ba-add-cidr-support Add CIDR support	2020-09-10 00:46:19 +01:00
Bernardo Chaves	3836480486	Add CIDR support Add CIDR support for ips_or_hosts argument. This will allow our users to specify multiple IPs within a network at once which is pretty convenient.	2020-09-09 19:21:43 -04:00
Bee	2291ba73d2	Update FUNDING.yml	2020-09-07 23:00:14 +01:00
Bee	e0af8a306a	Merge pull request #198 from RustScan/all-contributors/add-buermarc docs: add buermarc as a contributor	2020-09-07 22:22:52 +01:00
Bee	cb0f4f7a92	Merge branch 'master' into all-contributors/add-buermarc	2020-09-07 22:17:59 +01:00
Bee	402bea4b06	Merge pull request #195 from buermarc/master Check '.config/rustscan/config.toml' for config	2020-09-07 22:15:47 +01:00
allcontributors[bot]	f44dda0360	docs: update .all-contributorsrc [skip ci]	2020-09-07 21:15:35 +00:00
allcontributors[bot]	965a173032	docs: update README.md [skip ci]	2020-09-07 21:15:34 +00:00
Bee	d95cae6677	Merge branch 'master' into master	2020-09-07 21:41:27 +01:00
Bee	2f92d5583a	Merge pull request #197 from RustScan/ba-no-nmap-option Introduce the -no-nmap option	2020-09-07 21:41:09 +01:00
Bee	8d8da79640	Merge branch 'master' into ba-no-nmap-option	2020-09-07 21:29:23 +01:00
Bee	e5b4a2f443	Merge branch 'master' into master	2020-09-07 21:23:18 +01:00
Bernardo Araujo	a0b877729e	Merge pull request #194 from usrGabriel/patch-1 Update README.md	2020-09-07 11:20:25 -04:00
Bernardo Chaves	743fa1cad6	Introduce the -no-nmap option As the name implies this will allow RustScan to to run the scan without starting an nmap scan with ports that are found.	2020-09-06 22:22:17 -04:00
mulc	a0561d4728	Check '.config/rustscan/config.toml' for config When reading the config file '$CONFIG_DIR/.config/rustscan/config.toml' should also be checked. If both '~/.rustscan.toml' and '$CONFIG_DIR/.config/rustscan/config.toml' exist, then later will be used.	2020-09-05 18:32:08 +02:00
Gabriel	b2a1bd2e7a	Update README.md Typo fix in the Debian / Kali install section.	2020-09-05 12:23:18 -04:00
Brandon	87de96c3c4	Merge pull request #185 from RustScan/ba-add-config-file Add configuration file	2020-08-30 14:00:07 +01:00
Bernardo Chaves	8e21f3bf8c	Add configuration file This configuration file will be read from the home directory of the user. Options set within this file will have priority over arguments from the command line unless the `--no-config` option is passed to the program.	2020-08-29 18:01:44 -04:00
Brandon	4019d1ff3a	Merge pull request #182 from RustScan/all-contributors/add-tim77 docs: add tim77 as a contributor	2020-08-29 12:15:07 +01:00
Brandon	c004bd0527	Merge pull request #181 from tim77/tim77-patch-1 Add Fedora/CentOS installation instructions	2020-08-29 11:53:44 +01:00
allcontributors[bot]	cdc5bbd924	docs: update .all-contributorsrc [skip ci]	2020-08-29 10:53:35 +00:00
allcontributors[bot]	f41213047a	docs: update README.md [skip ci]	2020-08-29 10:53:34 +00:00
Artem Polishchuk	2315ef2417	Add Fedora/CentOS installation instructions	2020-08-28 23:33:42 +03:00
Brandon	cb87d5b9ce	Update README.md	2020-08-28 16:14:10 +01:00
Brandon	92800678cd	Merge branch 'master' of github.com:brandonskerritt/RustScan into master	2020-08-28 15:59:05 +01:00
Brandon	8e76a71a4c	updated logo	2020-08-28 15:58:42 +01:00
Brandon	07fdea8471	Merge pull request #176 from niklasmohrin/improve-readme README.md tweaks	2020-08-28 13:50:38 +01:00
Niklas Mohrin	8670bcc35f	Move "rustscan -h" and output together	2020-08-28 14:43:50 +02:00
Niklas Mohrin	fbba9d16ca	Mark code blocks as bash commands in README	2020-08-28 14:43:50 +02:00
Niklas Mohrin	309d1ad660	Remove argument placeholders in docker alias	2020-08-28 14:43:47 +02:00
Brandon	ed48161bea	added travis token	2020-08-28 11:22:23 +01:00
Brandon	f0d1aa2b9a	Merge pull request #180 from RustScan/all-contributors/add-SuperSandro2000 docs: add SuperSandro2000 as a contributor	2020-08-28 11:12:35 +01:00
Brandon	ac93feddb5	Merge pull request #178 from SuperSandro2000/optimize-docker Optimize Dockerfile	2020-08-28 11:12:17 +01:00
allcontributors[bot]	1280fa1b47	docs: update .all-contributorsrc [skip ci]	2020-08-28 10:12:08 +00:00
Brandon	6e731aaf93	Merge branch 'master' into optimize-docker	2020-08-28 11:12:08 +01:00
allcontributors[bot]	9230165f8f	docs: update README.md [skip ci]	2020-08-28 10:12:07 +00:00
Brandon	818c80041b	Merge pull request #177 from RustScan/all-contributors/add-niklasmohrin docs: add niklasmohrin as a contributor	2020-08-28 11:11:38 +01:00
allcontributors[bot]	bce955212a	docs: update .all-contributorsrc [skip ci]	2020-08-28 10:11:34 +00:00
allcontributors[bot]	41e0e8905f	docs: update README.md [skip ci]	2020-08-28 10:11:33 +00:00
Sandro Jäckel	85f1699724	Prevent cache bustages	2020-08-28 01:31:54 +02:00
Sandro Jäckel	bafd0141df	Pin Alpine 3.12 to prevent breakages in the future	2020-08-28 01:31:26 +02:00
Sandro Jäckel	aba0f3c38c	Cleanup Dockerfile	2020-08-28 01:31:08 +02:00
allcontributors[bot]	9e161d4f79	docs: update .all-contributorsrc [skip ci]	2020-08-27 23:12:10 +00:00
allcontributors[bot]	731b4079cf	docs: update README.md [skip ci]	2020-08-27 23:12:09 +00:00
Brandon	b4edc6cca6	1.8.0 publish	2020-08-28 00:03:02 +01:00
Brandon	4a7cbd701b	Merge pull request #175 from RustScan/all-contributors/add-caass docs: add caass as a contributor	2020-08-27 20:39:46 +01:00
allcontributors[bot]	f34ee8f5ef	docs: update .all-contributorsrc [skip ci]	2020-08-27 19:36:22 +00:00
allcontributors[bot]	89c763789f	docs: update README.md [skip ci]	2020-08-27 19:36:21 +00:00
Brandon	5c48f1173a	Merge pull request #140 from remigourdon/docs-pages Add Travis configuration to publish doc to GitHub pages	2020-08-27 14:02:46 +01:00
Brandon	8d8ca1d4a0	Merge branch 'master' into docs-pages	2020-08-27 14:01:29 +01:00
Brandon	8d8acd61e8	Merge pull request #173 from RustScan/bee-add-submodule added submodule	2020-08-27 13:33:16 +01:00
Brandon	0ab3e53034	Merge branch 'master' into bee-add-submodule	2020-08-27 13:05:19 +01:00
Brandon	56493859cb	added submodule	2020-08-27 12:36:56 +01:00
Brandon	2ef723ed96	Merge branch 'master' into docs-pages	2020-08-27 12:30:33 +01:00
Brandon	e9288302ba	Merge pull request #172 from RustScan/all-contributors/add-caass docs: add caass as a contributor	2020-08-27 11:39:35 +01:00
remigourdon	8179511527	Add Travis configuration to publish doc to GitHub pages	2020-08-26 23:22:13 -04:00
allcontributors[bot]	fbab4a4020	docs: update .all-contributorsrc [skip ci]	2020-08-26 23:22:13 -04:00
allcontributors[bot]	b425d15a98	docs: update README.md [skip ci]	2020-08-26 23:22:13 -04:00
allcontributors[bot]	fddda34465	docs: update .all-contributorsrc [skip ci]	2020-08-26 23:39:11 +00:00
allcontributors[bot]	125df4a2ed	docs: update README.md [skip ci]	2020-08-26 23:39:10 +00:00
Brandon	e670d11223	Merge pull request #170 from RustScan/all-contributors/add-SuperSandro2000 docs: add SuperSandro2000 as a contributor	2020-08-27 00:36:42 +01:00
Brandon	8453320586	Merge pull request #169 from SuperSandro2000/fix-timeout-arg Convert -T to -t	2020-08-26 17:27:15 +01:00
allcontributors[bot]	99e9c834a9	docs: update .all-contributorsrc [skip ci]	2020-08-26 15:54:45 +00:00
allcontributors[bot]	dfbce6a636	docs: update README.md [skip ci]	2020-08-26 15:54:44 +00:00
Sandro Jäckel	916be1e4a2	Convert -T to -t	2020-08-26 17:38:58 +02:00
Brandon	90b4328fb6	Merge pull request #167 from RustScan/all-contributors/add-Phenomite docs: add Phenomite as a contributor	2020-08-26 16:08:25 +01:00
Brandon	76035d3379	Merge branch 'master' into all-contributors/add-Phenomite	2020-08-26 15:50:08 +01:00
Brandon	4de31ecede	Merge pull request #163 from Phenomite/patch-1 2000 milliseconds not seconds	2020-08-26 15:47:50 +01:00
allcontributors[bot]	ce9befaa1a	docs: update .all-contributorsrc [skip ci]	2020-08-26 14:47:28 +00:00
Brandon	5f6457ed7e	Merge branch 'master' into patch-1	2020-08-26 15:47:27 +01:00
allcontributors[bot]	12d3c91983	docs: update README.md [skip ci]	2020-08-26 14:47:27 +00:00
Brandon	e0fd7a39dc	Merge pull request #164 from RustScan/dependabot/cargo/structopt-0.3.17 Bump structopt from 0.3.16 to 0.3.17	2020-08-26 14:59:31 +01:00
Brandon	ff0787e332	Merge branch 'master' into dependabot/cargo/structopt-0.3.17	2020-08-26 14:02:08 +01:00
Brandon	6ce6c0ce9e	Merge pull request #166 from RustScan/all-contributors/add-Ferryistaken docs: add Ferryistaken as a contributor	2020-08-26 14:01:48 +01:00
Brandon	edf989ad5d	Merge branch 'master' into all-contributors/add-Ferryistaken	2020-08-26 13:35:08 +01:00
Brandon	3fede4c6db	Merge pull request #165 from Ferryistaken/fix-message Fixed small typo in a warning message	2020-08-26 13:34:46 +01:00
allcontributors[bot]	75b310f227	docs: update .all-contributorsrc [skip ci]	2020-08-26 12:34:40 +00:00
allcontributors[bot]	72c6ef1f1d	docs: update README.md [skip ci]	2020-08-26 12:34:39 +00:00
Ferry	83b23da32b	Fixed small typo in a warning message	2020-08-26 11:00:54 +02:00
dependabot-preview[bot]	3886a07775	Bump structopt from 0.3.16 to 0.3.17 Bumps [structopt](https://github.com/TeXitoi/structopt) from 0.3.16 to 0.3.17. - [Release notes](https://github.com/TeXitoi/structopt/releases) - [Changelog](https://github.com/TeXitoi/structopt/blob/master/CHANGELOG.md) - [Commits](https://github.com/TeXitoi/structopt/compare/v0.3.16...v0.3.17) Signed-off-by: dependabot-preview[bot] <[email protected]>	2020-08-26 06:52:53 +00:00
Phenomite	f5064d3d5c	2000 milliseconds not seconds	2020-08-25 18:42:59 -04:00
Brandon	22cbfc5826	Merge pull request #159 from RustScan/bee-add-nmap-ports updated config file to feature nmap top 1k ports	2020-08-24 16:49:13 +01:00
Brandon	a9d729300c	Merge branch 'master' into bee-add-nmap-ports	2020-08-24 13:49:10 +01:00
Brandon	4f5dd20e85	Merge pull request #162 from RustScan/ba-reduce-binary-size Reduce binary size from 2.4MB to 1.9MB	2020-08-24 12:48:45 +01:00
Bernardo Chaves	499ff66f36	Reduce binary size from 2.4MB to 1.9MB By default, Cargo instructs compilation units to be compiled and optimized in isolation. LTO instructs the linker to optimize at the link stage. This can, for example, remove dead code and often times reduces binary size. By default, when Rust code encounters a situation when it must call panic!(), it unwinds the stack and produces a helpful backtrace. The unwinding code, however, does require extra binary size. rustc can be instructed to abort immediately rather than unwind, which removes the need for this extra unwinding code. For more information see: https://github.com/johnthagen/min-sized-rust	2020-08-23 18:10:53 -04:00
Brandon	61b87243d9	Merge pull request #161 from RustScan/ba-refactor-port-strategy Allow randomized order for manual ports	2020-08-22 22:27:37 +01:00
Bernardo Chaves	e069991c8d	Allow randomized order for manual ports Before this change we would always scan manually specified ports in sequential way, this is not the case anymore. This is an important change since we are planning to introduce a config file with the top 1K ports and we would like to scan those in a randomized way.	2020-08-21 13:09:41 -04:00
Brandon	85c1cbf445	Merge pull request #160 from RustScan/bee-remove-A removed -A from nmap	2020-08-20 22:58:39 +01:00
Brandon	5551e64166	updated AUR package in readme	2020-08-20 00:40:41 +01:00
Brandon	e0aa1423ad	removed -A from nmap	2020-08-20 00:32:37 +01:00
Brandon	e609b3617c	updated config file to feature nmap top 1k ports	2020-08-20 00:05:45 +01:00
Brandon	d0d8380296	Merge pull request #158 from RustScan/ba-add-port-and-range-options Add --port and --range options	2020-08-19 16:26:39 +01:00
Brandon	d66ad34f8c	Merge branch 'master' into ba-add-port-and-range-options	2020-08-19 16:02:49 +01:00
Brandon	2670ec43df	Merge pull request #156 from spenserblack/exclude-files Exclude files	2020-08-19 00:05:59 +01:00
Bernardo Chaves	90d0b03ba7	Add --port and --range options These options are mutually exclusive, this means that when a user selects manual ports we will ignore ranges and vice-versa. Manually specifying ports won't allow scan randomization for now.	2020-08-17 20:43:44 -04:00
Spenser Black	57eb3627b3	Use absolute image URLs instead of relative	2020-08-17 10:03:04 -04:00
Spenser Black	7e675b7557	Reduce crate size	2020-08-17 09:30:07 -04:00
Bernardo Araujo	fdeaa05f23	Merge pull request #152 from RustScan/ba-add-host-resolution Add host resolution	2020-08-16 18:35:40 -04:00
Bernardo Araujo	9fbf39f0cc	Merge branch 'master' into ba-add-host-resolution	2020-08-16 18:11:27 -04:00
Ben (CMNatic)	14b6ea928d	Merge pull request #155 from CMNatic/master Updated README to use the rustscan dockerhub alpine image	2020-08-16 22:39:10 +01:00
Ben (CMNatic)	9452b1f922	Update README to add a disclaimer about the DockerHub Images + Instruct user to use the `alpine` image as it's considered the latest major release as per the release page + Formatting instructions	2020-08-16 22:37:51 +01:00
Ben (CMNatic)	ed12888e81	Updated README to use the rustscan dockerhub alpine image + Added another step to clarify process for Docker as the build will fail if the user is not in the downloaded repo + DockerHub has CI with master branch and two images tags `latest` and `alpine` where `alpine` is tagged on feature releases (currently 1.7.1)	2020-08-16 22:28:57 +01:00
Bernardo Chaves	f68abcb955	Add host resolution For now if we can establish a socket on port 80 we can infer the IP of the host. This might change in the future if we start considering other ports like 443.	2020-08-16 11:52:11 -04:00
Brandon	4c91e8fb40	Merge pull request #153 from andy5995/docs docs: fix typo in README.md, link to GitHub flow in contributing doc	2020-08-15 11:08:03 +01:00
andy5995	1d3e831066	docs: fix typo in README.md, link to GitHub flow in contributing doc	2020-08-15 02:05:20 -05:00
dependabot-preview[bot]	ff6b1c40db	Merge pull request #151 from RustScan/dependabot/cargo/async-std-1.6.3	2020-08-15 00:58:44 +00:00
dependabot-preview[bot]	5573d91a7b	Bump async-std from 1.6.2 to 1.6.3 Bumps [async-std](https://github.com/async-rs/async-std) from 1.6.2 to 1.6.3. - [Release notes](https://github.com/async-rs/async-std/releases) - [Changelog](https://github.com/async-rs/async-std/blob/master/CHANGELOG.md) - [Commits](https://github.com/async-rs/async-std/commits/v1.6.3) Signed-off-by: dependabot-preview[bot] <[email protected]>	2020-08-14 08:38:10 +00:00
Brandon	a8e56eec4b	Merge pull request #149 from RustScan/all-contributors/add-cmnatic docs: add cmnatic as a contributor	2020-08-13 22:56:14 +01:00
Brandon	fb75c9d332	Merge branch 'master' into all-contributors/add-cmnatic	2020-08-13 22:43:56 +01:00
Ben (CMNatic)	581ec27cb5	Merge pull request #148 from CMNatic/master Updated README to include instructions on building the new Dockerfile	2020-08-13 20:25:05 +01:00
allcontributors[bot]	9673c8807d	docs: update .all-contributorsrc [skip ci]	2020-08-13 19:24:12 +00:00
allcontributors[bot]	78818d6bc7	docs: update README.md [skip ci]	2020-08-13 19:24:11 +00:00
Ben (CMNatic)	d0ff597be6	Updated README to include instructions on building the new Dockerfile	2020-08-13 20:11:58 +01:00
Ben (CMNatic)	516ebe367a	Merge pull request #118 from Hydragyrum/feature/create-alpine-based-dockerfile Feature/create alpine based dockerfile	2020-08-13 19:41:52 +01:00
Ben (CMNatic)	1e9660e4ff	Merge branch 'master' into feature/create-alpine-based-dockerfile	2020-08-13 19:32:13 +01:00
Brandon	7b4dda5a19	Merge pull request #147 from RustScan/dependabot/cargo/rlimit-0.4.0 Bump rlimit from 0.3.0 to 0.4.0	2020-08-13 11:40:23 +01:00
dependabot-preview[bot]	a20b71191d	Bump rlimit from 0.3.0 to 0.4.0 Bumps [rlimit](https://github.com/Nugine/rlimit) from 0.3.0 to 0.4.0. - [Release notes](https://github.com/Nugine/rlimit/releases) - [Commits](https://github.com/Nugine/rlimit/compare/v0.3.0...v0.4.0) Signed-off-by: dependabot-preview[bot] <[email protected]>	2020-08-13 08:36:23 +00:00
Brandon	18c5dd69e5	Merge pull request #145 from RustScan/all-contributors/add-TGotwig docs: add TGotwig as a contributor	2020-08-11 19:45:15 +01:00
Brandon	090264ac26	Merge branch 'master' into all-contributors/add-TGotwig	2020-08-11 19:32:11 +01:00
Bernardo Araujo	702681606f	Merge pull request #146 from RustScan/bee-fix-spelling fixed spelling mistake	2020-08-10 20:59:20 -04:00
Brandon	c58ac613c9	fixed spelling mistake	2020-08-11 01:47:25 +01:00
allcontributors[bot]	59bb72426d	docs: update .all-contributorsrc [skip ci]	2020-08-10 19:57:32 +00:00
allcontributors[bot]	f48590c238	docs: update README.md [skip ci]	2020-08-10 19:57:31 +00:00
Adam Bertrand	8b363571f1	Merge branch 'master' into feature/create-alpine-based-dockerfile	2020-08-05 21:52:34 +02:00
Hydragyrum	0fa11f6e51	Add a non-privileged user to run rustscan	2020-08-05 18:53:06 +02:00
Adam Bertrand	d423f34e7a	Merge branch 'master' into feature/create-alpine-based-dockerfile	2020-08-05 18:25:54 +02:00
Hydragyrum	e17f9d0bb1	Add newline to dockerfile	2020-08-04 23:18:12 +02:00
Hydragyrum	3329428766	Create a basic Alpine-Based Dockerfile	2020-08-04 23:17:30 +02:00