test: remove network scans and external script execution

Fixes a typo in the Scriptfile parser comment (Sriptfile → Scriptfile) and improves the wording for clarity.

.SRCINFO

@@ -2,7 +2,7 @@ pkgbase = rustscan-bin
 	pkgdesc = Faster Nmap Scanning with Rust
 	pkgver = 1.1.0
 	pkgrel = 1
-	url = https://github.com/brandonskerritt/rustscan
+	url = https://github.com/rustscan/rustscan
 	arch = x86_64
 	license = MIT
 	depends = rustup

.all-contributorsrc

@@ -115,6 +115,150 @@
         "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",
+        "code",
+        "bug"
+      ]
+    },
+    {
+      "login": "tim77",
+      "name": "Artem Polishchuk",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/5614476?v=4",
+      "profile": "https://liberapay.com/Artem4/",
+      "contributions": [
+        "platform"
+      ]
+    },
+    {
+      "login": "buermarc",
+      "name": "buermarc",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/44375277?v=4",
+      "profile": "https://github.com/buermarc",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "bergabman",
+      "name": "bergabman",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/44554109?v=4",
+      "profile": "https://github.com/bergabman",
+      "contributions": [
+        "code",
+        "bug",
+        "design"
+      ]
+    },
+    {
+      "login": "dmitris",
+      "name": "Dmitry Savintsev",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/31205?v=4",
+      "profile": "https://github.com/dmitris",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "bofh69",
+      "name": "Sebastian Andersson",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/1444315?v=4",
+      "profile": "https://github.com/bofh69",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "mattcorbin",
+      "name": "Matt Corbin",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/6537765?v=4",
+      "profile": "https://github.com/mattcorbin",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "rootsploit",
+      "name": "RootSploit",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/67270834?v=4",
+      "profile": "http://rootsploit.com",
+      "contributions": [
+        "blog"
+      ]
+    },
+    {
+      "login": "eiffel-fl",
+      "name": "eiffel-fl",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/12171754?v=4",
+      "profile": "https://github.com/eiffel-fl",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "u5surf",
+      "name": "Y.Horie",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/14180225?v=4",
+      "profile": "https://github.com/u5surf",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "okrplay",
+      "name": "Oskar",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/32576280?v=4",
+      "profile": "https://github.com/okrplay",
+      "contributions": [
+        "code",
+        "test"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.dockerignore

@@ -0,0 +1,2 @@
+.git
+Dockerfile

.github/FUNDING.yml

@@ -1,4 +1 @@
-github: brandonskerritt
-patreon: brandonskerritt
-ko_fi: hacker
-custom: ["https://monzo.me/bee", "https://paypal.me/brandonskerritt"]
+github: bee-san

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,6 +7,10 @@ assignees: ''
 
 ---
 
+IMPORTANT: If you do not fill this out, your issue will be automatically closed.
+
+As of November 2024, RustScan no longer offiically supports any packages other than `cargo`. If you have an issue with Docker or a `.deb`, please bring it up with whoever created it :)
+
 **Describe the bug**
 A clear and concise description of what the bug is.
 

.github/dependabot.yml

@@ -0,0 +1,29 @@
+version: 2
+updates:
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+    interval: "daily"
+- package-ecosystem: "docker"
+  directory: "/"
+  schedule:
+    interval: "daily"
+- package-ecosystem: cargo
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: anyhow
+    versions:
+    - 1.0.38
+    - 1.0.39
+  - dependency-name: serde
+    versions:
+    - 1.0.123
+  - dependency-name: futures
+    versions:
+    - 0.3.12
+  - dependency-name: rlimit
+    versions:
+    - 0.5.3

.github/release-drafter.yml

@@ -0,0 +1,4 @@
+template: |
+  ## What’s Changed
+
+  $CHANGES

.github/workflows/action.yml

@@ -1,10 +0,0 @@
-name: Check Markdown links
-
-on: push
-
-jobs:
-  markdown-link-check:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@master
-    - uses: gaurav-nelson/github-action-markdown-link-check@v1

.github/workflows/basic.yml

@@ -1,55 +0,0 @@
-on: [push, pull_request]
-
-name: Continuous integration
-
-jobs:
-  check:
-    name: Check
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: stable
-          override: true
-      - uses: actions-rs/cargo@v1
-        with:
-          command: check
-
-  test:
-    name: Test Suite
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: stable
-          override: true
-      - uses: actions-rs/cargo@v1
-        with:
-          command: test
-
-  fmt:
-    name: Rustfmt
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: stable
-          override: true
-      - run: rustup component add rustfmt
-      - uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: --all -- --check
-
-  links:
-        name: markdown-link-check
-        runs-on: ubuntu-latest
-        steps:
-        - uses: actions/checkout@master
-        - uses: gaurav-nelson/github-action-markdown-link-check@v1

.github/workflows/build.yml

@@ -0,0 +1,179 @@
+name: CD Pipeline
+
+on: [push]
+
+jobs:
+  build-nix:
+    env:
+      IN_PIPELINE: true
+    runs-on: ${{ matrix.os }}
+    if: github.ref == 'refs/heads/master'
+    strategy:
+      matrix:
+        type: [ubuntu-x64, ubuntu-x86, armv7, aarch64]
+        include:
+          - type: ubuntu-x64
+            os: ubuntu-latest
+            target: x86_64-unknown-linux-musl
+            name: x86_64-linux-rustscan
+            path: target/x86_64-unknown-linux-musl/release/rustscan
+            pkg_config_path: /usr/lib/x86_64-linux-gnu/pkgconfig
+          - type: ubuntu-x86
+            os: ubuntu-latest
+            target: i686-unknown-linux-musl
+            name: x86-linux-rustscan
+            path: target/i686-unknown-linux-musl/release/rustscan
+            pkg_config_path: /usr/lib/i686-linux-gnu/pkgconfig
+          - type: armv7
+            os: ubuntu-latest
+            target: armv7-unknown-linux-gnueabihf
+            name: armv7-linux-rustscan
+            path: target/armv7-unknown-linux-gnueabihf/release/rustscan
+            pkg_config_path: /usr/lib/x86_64-linux-gnu/pkgconfig
+          - type: aarch64
+            os: ubuntu-latest
+            target: aarch64-unknown-linux-gnu
+            name: aarch64-linux-rustscan
+            path: target/aarch64-unknown-linux-gnu/release/rustscan
+            pkg_config_path: /usr/lib/x86_64-linux-gnu/pkgconfig
+    steps:
+      - uses: actions/checkout@v7
+      - name: Cache cargo & target directories
+        uses: Swatinem/rust-cache@v2
+      - name: Build binary
+        uses: houseabsolute/actions-rust-cross@v1
+        with:
+          command: build
+          target: ${{ matrix.target }}
+          args: "--locked --release"
+          strip: true
+          toolchain: stable
+      - name: Build tar.gz for homebrew installs
+        if: matrix.type == 'ubuntu-x64'
+        run: |
+          tar czf ${{ matrix.name }}.tar.gz -C target/x86_64-unknown-linux-musl/release rustscan
+      - uses: actions/upload-artifact@v7
+        with:
+          name: ${{ matrix.name }}
+          path: ${{ matrix.path }}
+      - uses: actions/upload-artifact@v7
+        if: matrix.type == 'ubuntu-x64'
+        with:
+          name: ${{ matrix.name }}.tar.gz
+          path: ${{ matrix.name }}.tar.gz
+  build-deb:
+    needs: [build-nix]
+    runs-on: ubuntu-latest
+    env:
+      IN_PIPELINE: true
+    steps:
+      - uses: actions/checkout@v7
+      - name: Install cargo-deb
+        run: cargo install -f cargo-deb
+      - uses: awalsh128/cache-apt-pkgs-action@v1
+        with:
+          packages: musl-tools # provides musl-gcc
+          version: 1.0
+      - name: Install musl toolchain
+        run: rustup target add x86_64-unknown-linux-musl
+      - name: Deb Build
+        run: cargo deb --target=x86_64-unknown-linux-musl
+      - name: Upload Deb Artifact
+        uses: actions/upload-artifact@v7
+        with:
+          name: rustscan.deb
+          path: ./target/x86_64-unknown-linux-musl/debian/*
+
+  build-macos:
+    env:
+      IN_PIPELINE: true
+    runs-on: macos-latest
+    if: github.ref == 'refs/heads/master'
+    steps:
+      - uses: actions/checkout@v7
+      - name: Cache cargo & target directories
+        uses: Swatinem/rust-cache@v2
+      - name: Build binary
+        uses: houseabsolute/actions-rust-cross@v1
+        with:
+          command: build
+          target: x86_64-apple-darwin
+          args: "--locked --release"
+          strip: true
+          toolchain: stable
+      - name: Build tar.gz for homebrew installs
+        run: |
+          tar czf x86_64-macos-rustscan.tar.gz -C target/x86_64-apple-darwin/release rustscan
+      - uses: actions/upload-artifact@v7
+        with:
+          name: x86_64-macos-rustscan
+          path: target/x86_64-apple-darwin/release/rustscan
+      - uses: actions/upload-artifact@v7
+        with:
+          name: x86_64-macos-rustscan.tar.gz
+          path: x86_64-macos-rustscan.tar.gz
+  
+  build-macos-aarch64:
+    env:
+      IN_PIPELINE: true
+    runs-on: macos-latest
+    if: github.ref == 'refs/heads/master'
+    steps:
+      - uses: actions/checkout@v7
+      - name: Cache cargo & target directories
+        uses: Swatinem/rust-cache@v2
+      - name: Build binary
+        uses: houseabsolute/actions-rust-cross@v1
+        with:
+          command: build
+          target: aarch64-apple-darwin
+          args: "--locked --release"
+          strip: true
+          toolchain: stable
+      - name: Build tar.gz for homebrew installs
+        run: |
+          tar czf aarch64-macos-rustscan.tar.gz -C target/aarch64-apple-darwin/release rustscan
+      - uses: actions/upload-artifact@v7
+        with:
+          name: aarch64-macos-rustscan
+          path: target/aarch64-apple-darwin/release/rustscan
+      - uses: actions/upload-artifact@v7
+        with:
+          name: aarch64-macos-rustscan.tar.gz
+          path: aarch64-macos-rustscan.tar.gz
+
+  build-windows:
+    env:
+      IN_PIPELINE: true
+    runs-on: ${{ matrix.os }}
+    if: github.ref == 'refs/heads/master'
+    strategy:
+      matrix:
+        type: [windows-x64, windows-x86]
+        include:
+          - type: windows-x64
+            os: windows-latest
+            target: x86_64-pc-windows-msvc
+            name: x86_64-windows-rustscan.exe
+            path: target\x86_64-pc-windows-msvc\release\rustscan.exe
+          - type: windows-x86
+            os: windows-latest
+            target: i686-pc-windows-msvc
+            name: x86-windows-rustscan.exe
+            path: target\i686-pc-windows-msvc\release\rustscan.exe
+    steps:
+      - uses: actions/checkout@v7
+      - name: Cache cargo & target directories
+        uses: Swatinem/rust-cache@v2
+      - name: Build binary
+        uses: houseabsolute/actions-rust-cross@v1
+        with:
+          command: build
+          target:  ${{ matrix.target }}
+          args: "--locked --release"
+          strip: true
+          toolchain: stable
+      - uses: actions/upload-artifact@v7
+        with:
+          name: ${{ matrix.name }}
+          path: ${{ matrix.path }}

.github/workflows/dependabot.yml

@@ -0,0 +1,14 @@
+name: Dependabot Auto-Merge
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Enable auto-merge for Dependabot PRs
+        run: |
+          gh pr review --approve "$PR_URL"
+          gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/markdown_link_check_9am_daily.yml

@@ -1,18 +0,0 @@
-name: Check Markdown links
-
-on: 
-  push:
-    branches:
-    - master
-  schedule:
-  # Run everyday at 9:00 AM (See https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07)
-  - cron: "0 9 * * *"
-
-jobs:
-  markdown-link-check:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@master
-    - uses: gaurav-nelson/github-action-markdown-link-check@v1
-      with:
-        use-quiet-mode: 'yes'

.github/workflows/mlc_config.json

@@ -0,0 +1,14 @@
+{
+    "_comment": "Config for markdown-link-check. Resolves issue #540.",
+    "ignorePatterns": [
+      {
+        "pattern": "^https://github.com/RustScan/RustScan/workflows/Continuous%20integration/badge.svg"
+      },
+      {
+        "pattern": "^https://crates.io/crates/rustscan/"
+      },
+      {
+        "pattern": "^https://bees.substack.com/p/making-hacking-accessible"
+      }
+    ]
+  }

.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: Test
+on:
+  pull_request:
+    branches: [master]
+  push:
+    branches:
+      - master
+jobs:
+  test:
+    name: Test Suite
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        rust: [stable]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v7
+
+      - name: Install stable toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: ${{ matrix.rust }}
+          override: true
+
+      - uses: taiki-e/install-action@nextest
+      - uses: Swatinem/rust-cache@v2
+
+      - name: Install Just
+        uses: extractions/setup-just@v4
+
+      - name: Run just
+        run: just test

.gitignore

@@ -1,6 +1,8 @@
 # Generated by Cargo
 # will have compiled files and executables
 /target/
+# generated file by build.rs for mapping nmap-payloads to rust
+src/generated.rs
 
 # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
 # More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
@@ -43,3 +45,82 @@ pkg/
 
 # End of https://www.toptal.com/developers/gitignore/api/rust,archlinuxpackages
 *.deb
+
+
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+.idea/*
+.idea
+.idea*
+
+settings.json

.gitmodules

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

.travis.yml

@@ -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=

CODE_OF_CONDUCT.md

@@ -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

Cargo.toml

@@ -1,33 +1,66 @@
 [package]
 name = "rustscan"
-version = "1.7.1"
-authors = ["Bee <brando[email protected]>"]
+version = "2.4.1"
+authors = ["Autumn <autum[email protected]>"]
 edition = "2018"
 description = "Faster Nmap Scanning with Rust"
 homepage = "https://github.com/rustscan/rustscan"
 repository = "https://github.com/rustscan/rustscan"
-license = "MIT"
+license = "GPL-3.0-only"
 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
+readme = "README.md"
+exclude = [
+    ".github/*",
+    "pictures/*",
+    "rustscan-debbuilder/*",
+]
 
 [dependencies]
-colored = "2.0.0"
-structopt = "0.3.16"
-async-std = "1.6.2"
+clap = { version = "4.6.1", features = ["derive", "wrap_help"] }
+colored = "3.1.1"
+async-std = "1.13.2"
 futures = "0.3"
-rlimit = "0.4.0"
-shell-words = "1.0.0"
-log = "0.4.0"
-env_logger = "0.7.1"
-dirs = "3.0.1"
+rlimit = "0.11.0"
+log = "0.4.32"
+env_logger = "0.11.10"
+anstream = "=1.0.0"
+dirs = "7.0.0"
 gcd = "2.0.1"
-rand = "0.7.3"
-colorful = "0.2.1"
+rand = "0.10.1"
+colorful = "0.3.2"
 ansi_term = "0.12.1"
+toml = "1.1.2"
+serde = "1.0.124"
+serde_derive = "1.0.116"
+cidr-utils = "0.7.1"
+itertools = "0.15.0"
+hickory-resolver = { version = "0.24.3", features = ["dns-over-rustls"] }
+anyhow = "1.0.40"
+text_placeholder = { version = "0.5", features = ["struct_context"] }
+once_cell = "1.21.4"
+
+[dev-dependencies]
+parameterized = "2.0.0"
+criterion = { version = "0.8", features = ["html_reports"] }
 
 [package.metadata.deb]
 depends = "$auto, nmap"
 section = "rust"
+
+[profile.release]
+lto = true
+panic = 'abort'
+strip = true
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[[bin]]
+name = "rustscan"
+path = "src/main.rs"
+
+[lints.rust]
+unexpected_cfgs = { level = "warn", check-cfg = ["cfg(tarpaulin_include)"] }
+
+[[bench]]
+name = "benchmark_helpers"
+harness = false

Dockerfile

@@ -1,22 +0,0 @@
-FROM rust:alpine as builder
-RUN apk update && \
-    apk add build-base && \
-    rm -rf /var/cache/apk/*
-
-WORKDIR /usr/src/rustscan
-COPY . .
-RUN cargo install --path .
-
-FROM alpine
-LABEL author="Hydragyrum <https://github.com/Hydragyrum>"
-RUN ulimit -n 100000 && \
-    apk update && \
-    apk add \
-    nmap nmap-scripts wget \
-    && \
-    rm -rf /var/cache/apk/*
-COPY --from=builder /usr/local/cargo/bin/rustscan /usr/local/bin/rustscan
-RUN addgroup -S rustscan && \
-    adduser -S -G rustscan rustscan
-USER rustscan
-ENTRYPOINT ["/usr/local/bin/rustscan"]

Makefile

@@ -10,12 +10,12 @@ build:
 build-linux:
 	@echo 'Building for Linux... 🐧'
 	cross build --release --target=x86_64-unknown-linux-musl
-	mkdir -p target/release-archives && tar -czf target/release-archives/rustscan-linux.tar.gz target/x86_64-unknown-linux-musl/release/rustscan 
+	mkdir -p target/release-archives && tar -C target/x86_64-unknown-linux-musl/release -czf target/release-archives/rustscan-linux.tar.gz rustscan
 
 build-mac:
 	@echo 'Building for MacOS... 🍏'
 	cross build --release --target=x86_64-apple-darwin
-	mkdir -p target/release-archives && tar -czf target/release-archives/rustscan-mac.tar.gz target/x86_64-apple-darwin/release/rustscan
+	mkdir -p target/release-archives && tar -C target/x86_64-apple-darwin/release -czf target/release-archives/rustscan-mac.tar.gz rustscan
 
 shasum:
 	shasum -a 256 target/release-archives/rustscan-*.tar.gz

README.md

@@ -1,371 +1,141 @@
-<p align="center">
-➡️
-<a href="https://discord.gg/GFrQsGy">Discord</a> |
- <a href="https://github.com/RustScan/RustScan#-full-installation-guide">Installation Guide</a> |
- <a href="https://github.com/RustScan/RustScan#-usage">Usage Guide</a>
- ⬅️
-<br>
-<img src="pictures/rustscan.png">
-</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.
-</p>
-<p align="center">
-<img alt="AUR version" src="https://img.shields.io/aur/version/rustscan-bin">
-<img src="https://img.shields.io/badge/Built%20with-Rust-Purple">
-<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/w/brandonskerritt/rustscan">
-<img alt="GitHub All Releases" src="https://img.shields.io/github/downloads/rustscan/rustscan/total?label=GitHub%20Downloads">
-<img alt="Crates.io" src="https://img.shields.io/crates/d/rustscan?label=Cargo%20Downloads">
-<img alt="Discord" src="https://img.shields.io/discord/736614461313515576">
-<img alt="Actions" src="https://github.com/RustScan/RustScan/workflows/Continuous%20integration/badge.svg?branch=master">
-</p>
-<hr>
+<div align="center" markdown="1">
 
-| <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`
+➡️ [Discord][discord] | [Installation Guide][toc-install] | [Usage Guide][usage-guide] ⬅️
 
-<hr>
+<img src="pictures/rustscan.png" height=400px width=400px>
+
+<!--<u>**The Modern Port Scanner.**</u>-->
+**Fast, smart, effective.**
+
+![Arch Linux package][badge-1] ![Built with Rust][badge-2] ![GitHub All Releases][badge-3] ![Crates.io][badge-4] ![Discord][badge-5] ![Actions][badge-6]
+
+</div>
 
 # 🤔 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>
+![fast][speed-1]
 
-<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>
+The Modern Port Scanner. **Find ports quickly (3 seconds at its fastest)**. Run scripts through our scripting engine (Python, Lua, Shell supported).
 
-RustScans **only** job is to reduce the friction between finding open ports and inputting them into nmap.
+# 🛠️ Installation
 
-# ✨ 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
+You can install RustScan's binary from our [releases page](https://github.com/RustScan/RustScan/releases).
 
-## ‼️ Important Links
+We would prefer you to install with a package manager so it is tested and works for your system.
 
-| 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)
-
-## 🙋 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 running in 8 seconds and finding all open ports out of 65k.**
-
-## 📊 RustScan vs Nmap vs MassScan
-
-| **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, you can either build your own image using the `Dockerfile` (alpine) provided in the repo, or alternatively, use the published Docker image like below (most convenient)**
-
-Simply 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.
-
-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
-```
-
-#### To build your own image:
-
-Download the repo:
-```
-git clone https://github.com/RustScan/RustScan.git
-```
-
-Build away!
-```
-docker build -t <yourimagename> .
-```
-
-## 🍺 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)
+RustScan is in many repositories already. Install it with whatever tools you wish:
 
 [![Packaging status](https://repology.org/badge/vertical-allrepos/rustscan.svg)](https://repology.org/project/rustscan/versions)
 
+RustScan only officially supports Cargo installations, if you want to use that please install Rust and then `cargo install rustscan`
+
+Example installations include:
+
+MacOS:
+
+```
+  brew install rustscan
+```
+
+Arch:
+
+```
+  pacman -S rustscan
+```
+
+# ✨ Features
+
+- Scans all 65k ports in **3 seconds**.
+- Full scripting engine support. Automatically pipe results into Nmap, or use our scripts (or write your own) to do whatever you want.
+- Adaptive learning. RustScan improves the more you use it. No bloated machine learning here, just basic maths.
+- The usuals you would expect. IPv6, CIDR, file input and more.
+- Automatically pipes ports into Nmap.
+
+## ‼️ Important Links
+
+|         <!--Installation Guide-->          |          <!--Documentation-->          |       <!--Discord-->        |
+| :----------------------------------------: | :------------------------------------: | :-------------------------: |
+| :book: [Installation Guide][toc-install] | :books: [Documentation][links-table-2] | :parrot: [Discord][discord] |
+
+## 🙋 Table of Contents
+
+- 📖 [Installation Guide][toc-install]
+- 🐋 [Docker Usage][toc-docker-usage]
+- 🦜 [Discord][discord]
+- 🤸 [Usage][usage-1]
+
+# 🔭 Why RustScan?
+
+RustScan is a modern take on the port scanner. Sleek & fast. All while providing extensive extendability to you.
+
+Not to mention RustScan uses Adaptive Learning to improve itself over time, making it the best port scanner for **you**.
+
+## 🧋 Speed
+
+![fast][speed-1]
+
+Speed is guaranteed via RustScan. However, if you want to run a slow scan due to stealth, that is possible too.
+
+Firstly, let's talk code.
+
+We have tests that check to see if RustScan is significantly slower than the previous version. If it is, the continuous integration fails, and we can't commit code to master unless we make it faster.
+
+[HyperFine][speed-2] is used to monitor RustScan's performance over time to answer the question, "Are we getting faster? Are we getting slower?".
+
+Every pull request is reviewed by **one** person, but more often than not, **two** people review it. We test it manually and ensure the code doesn't negatively affect performance.
+
+[Read more here][speed-3].
+
+## ⚙️ Extensible
+
+![scripts][extensible-1]
+
+### _RustScan piping results into the custom Python script_
+
+RustScan has a new scripting engine that allows anyone to write scripts in most languages. Python, Lua, and Shell are all supported.
+
+Want to take your found ports and pipe them into Nmap for further analysis? That's possible. Want to run `smb-enum` if SMB is found open? Possible.
+
+The possibilities are endless -- and you can write scripts in whatever language you feel comfortable with.
+
+[Read more here][extensible-2].
+
+## 🌊 Adaptive
+
+![adaptive][adaptive-1]
+
+### _RustScan automatically fine-tunes itself to match the host OS_
+
+RustScan has a cool set of features called "Adaptive Learning". These features "learn" about the environment you are scanning and how _you_ use RustScan to **improve itself over time**.
+
+We use this umbrella term for any feature that fits this criterion. The list constantly changes, so [check out our wiki for more information][adaptive-learning].
+
+## 👩‍🦯 Accessible
+
+![fast][accessible-1]
+
+RustScan is one of the first penetration testing tools that aims to be entirely accessible.
+
+[Most penetration testing tools are not accessible][accessible-2], which negatively affects the whole industry.
+
+RustScan has continuous integration testing that aims to ensure it is accessible, and we are constantly working on ways to improve our accessibility and ensure _everyone_ can use RustScan.
+
 # 🤸 Usage
 
-```
-rustscan -h
-```
+We have 2 usage guides. [Basic Usage][usage-1] and [Things you may want to do][usage-2].
 
-```
-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.
+We also have documentation about our config file [here][config-file-here].
 
 # 🎪 Community
 
-Howdy Space Cow-Person 🤠🌌
-
-RustScan is always looking for contributors. Whether that's spelling mistakes or major changes, your help is **wanted** and welcomed here.
-
-Before contributing, read our [code of conduct](https://github.com/RustScan/RustScan/blob/master/CODE_OF_CONDUCT.md).
-
-TL;DR if you abuse members of our community you will be **perma-banned** 🤗
-
-RustScan has 2 major labels for GitHub issues you should look at:
-* Good First issue
-These are issues for newcomers to open source!
-[https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22](https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
-* Help wanted
-These are issues that aren't really for newcomers, but we could still do wiht help!
-[https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+label%3A%22help+wanted%22](https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+label%3A%22help+wanted%22)
-
-If you want to, solve the issue or comment on the issue for help.
-
-The flow for contributing to open source software is:
-* Fork the repo
-* Make changes
-* Pull request to the repo
-
-And then comment on the issue that you've done.
-
-RustScan also has some `// TODO`'s in the codebase, which are meant more for the core team but we wouldn't say no to help with these issues.
-
-If you have any feature suggestions or bugs, leave a GitHub issue. We welcome any and all support :D
-
-We communicate over Discord. [Click here](https://discord.gg/GFrQsGy) to join our Discord community!
-
-## Rewarding you
-I cannot pay you :-( But, I can place your GitHub profile on the README under `#Contributors` as a thank you! :)
-
-
-Please read the [contributing.md file](contributing.md)
+[Contributing][community-1] Read this to learn how.
 
 ## Contributors ✨
+
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-11-orange.svg?style=flat-square)](#contributors-)
+
+[![All Contributors](https://img.shields.io/badge/all_contributors-26-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)):
@@ -375,7 +145,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- markdownlint-disable -->
 <table>
   <tr>
-    <td align="center"><a href="https://skerritt.blog"><img src="https://avatars3.githubusercontent.com/u/10378052?v=4" width="100px;" alt=""/><br /><sub><b>Brandon</b></sub></a><br /><a href="#infra-brandonskerritt" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/RustScan/RustScan/commits?author=brandonskerritt" title="Tests">⚠️</a> <a href="https://github.com/RustScan/RustScan/commits?author=brandonskerritt" title="Code">💻</a> <a href="#design-brandonskerritt" title="Design">🎨</a></td>
+    <td align="center"><a href="https://skerritt.blog"><img src="https://avatars3.githubusercontent.com/u/10378052?v=4" width="100px;" alt=""/><br /><sub><b>Bee</b></sub></a><br /><a href="#infra-beeskerritt" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/RustScan/RustScan/commits?author=beeskerritt" title="Tests">⚠️</a> <a href="https://github.com/RustScan/RustScan/commits?author=beesan" title="Code">💻</a> <a href="#design-beeskerritt" title="Design">🎨</a></td>
     <td align="center"><a href="https://sakiir.ovh"><img src="https://avatars1.githubusercontent.com/u/9950578?v=4" width="100px;" alt=""/><br /><sub><b>SakiiR</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=SakiiR" title="Code">💻</a> <a href="https://github.com/RustScan/RustScan/issues?q=author%3ASakiiR" title="Bug reports">🐛</a></td>
     <td align="center"><a href="https://github.com/smackhack"><img src="https://avatars2.githubusercontent.com/u/48143394?v=4" width="100px;" alt=""/><br /><sub><b>smackhack</b></sub></a><br /><a href="#ideas-smackhack" title="Ideas, Planning, & Feedback">🤔</a> <a href="#example-smackhack" title="Examples">💡</a></td>
     <td align="center"><a href="http://bernardoamc.github.io/"><img src="https://avatars0.githubusercontent.com/u/428984?v=4" width="100px;" alt=""/><br /><sub><b>Bernardo Araujo</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=bernardoamc" title="Code">💻</a> <a href="https://github.com/RustScan/RustScan/issues?q=author%3Abernardoamc" title="Bug reports">🐛</a> <a href="#design-bernardoamc" title="Design">🎨</a></td>
@@ -385,14 +155,81 @@ 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://tgotwig.dev"><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> <a href="https://github.com/RustScan/RustScan/commits?author=niklasmohrin" title="Code">💻</a> <a href="https://github.com/RustScan/RustScan/issues?q=author%3Aniklasmohrin" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://liberapay.com/Artem4/"><img src="https://avatars0.githubusercontent.com/u/5614476?v=4" width="100px;" alt=""/><br /><sub><b>Artem Polishchuk</b></sub></a><br /><a href="#platform-tim77" title="Packaging/porting to new platform">📦</a></td>
+    <td align="center"><a href="https://github.com/buermarc"><img src="https://avatars2.githubusercontent.com/u/44375277?v=4" width="100px;" alt=""/><br /><sub><b>buermarc</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=buermarc" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/bergabman"><img src="https://avatars1.githubusercontent.com/u/44554109?v=4" width="100px;" alt=""/><br /><sub><b>bergabman</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=bergabman" title="Code">💻</a> <a href="https://github.com/RustScan/RustScan/issues?q=author%3Abergabman" title="Bug reports">🐛</a> <a href="#design-bergabman" title="Design">🎨</a></td>
+    <td align="center"><a href="https://github.com/dmitris"><img src="https://avatars0.githubusercontent.com/u/31205?v=4" width="100px;" alt=""/><br /><sub><b>Dmitry Savintsev</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=dmitris" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/bofh69"><img src="https://avatars3.githubusercontent.com/u/1444315?v=4" width="100px;" alt=""/><br /><sub><b>Sebastian Andersson</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=bofh69" title="Code">💻</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/mattcorbin"><img src="https://avatars3.githubusercontent.com/u/6537765?v=4" width="100px;" alt=""/><br /><sub><b>Matt Corbin</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=mattcorbin" title="Code">💻</a></td>
+    <td align="center"><a href="http://rootsploit.com"><img src="https://avatars2.githubusercontent.com/u/67270834?v=4" width="100px;" alt=""/><br /><sub><b>RootSploit</b></sub></a><br /><a href="#blog-rootsploit" title="Blogposts">📝</a></td>
+    <td align="center"><a href="https://github.com/eiffel-fl"><img src="https://avatars2.githubusercontent.com/u/12171754?v=4" width="100px;" alt=""/><br /><sub><b>eiffel-fl</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=eiffel-fl" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/u5surf"><img src="https://avatars1.githubusercontent.com/u/14180225?v=4" width="100px;" alt=""/><br /><sub><b>Y.Horie</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=u5surf" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/okrplay"><img src="https://avatars3.githubusercontent.com/u/32576280?v=4" width="100px;" alt=""/><br /><sub><b>Oskar</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=okrplay" title="Code">💻</a> <a href="https://github.com/RustScan/RustScan/commits?author=okrplay" title="Tests">⚠️</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!
+
+<!--Links-->
+
+[Docker]: https://hub.docker.com/r/cmnatic/rustscan "This is the recommended distribution of rustscan"
+[kali]: https://github.com/RustScan/RustScan/wiki/Installation-Guide#%EF%B8%8F-debian--kali "Read the install guide"
+[Kali/Debian]: https://github.com/RustScan/RustScan/releases "Kali Debian"
+[Arch-Linux]: https://archlinux.org/packages/extra/x86_64/rustscan/ "Arch Linux installation of Rustscan"
+[Homebrew]: https://formulae.brew.sh/formula/rustscan "Homebrew install of Rustscan"
+[usage-1]: https://github.com/RustScan/RustScan/wiki/Usage "Basic Usage of Rustscan"
+[usage-0]: https://github.com/RustScan/RustScan/wiki/Installation-Guide#docker-whale "Use Docker Rustscan"
+[config-file-here]: https://github.com/RustScan/RustScan/wiki/Config-File "RustScan Configuration File"
+[usage-2]: https://github.com/RustScan/RustScan/wiki/Things-you-may-want-to-do-with-RustScan-but-don't-understand-how "Things you may want to do with rustscan but don't know how"
+[community-1]: https://github.com/RustScan/RustScan/wiki/Contributing "Learn how to contribute"
+[distributions-1]: https://software.opensuse.org/package/rustscan?search_term=rustscan "Open Suse rustscan distribution"
+[distributions-2]: https://copr.fedorainfracloud.org/coprs/atim/rustscan/ "Rustscan in Fedora"
+[repology-1]: https://repology.org/project/rustscan/versions "Packaging Status"
+[install-1]: https://github.com/RustScan/RustScan/wiki/Installation-Guide "Installation guide"
+[accessible-2]: https://bees.substack.com/p/making-hacking-accessible "Making Hacking Accessible"
+[extensible-2]: https://github.com/RustScan/RustScan/wiki/RustScan-Scripting-Engine "Scripting Engine"
+[speed-2]: https://github.com/sharkdp/hyperfine "Hyperfine"
+[speed-3]: https://github.com/RustScan/RustScan/wiki/Increasing-Speed-&-Accuracy "Increasing Speed & Accuracy"
+[toc-community]: https://github.com/RustScan/RustScan#-community "Community"
+[links-table-1]: https://github.com/RustScan/RustScan#-full-installation-guide "Full installation guide"
+[links-table-2]: https://github.com/bee-san/RustScan/wiki "Rustscan"
+[discord]: http://discord.skerritt.blog "Discord blog"
+[toc-install]: https://github.com/RustScan/RustScan/wiki/Installation-Guide "Installation Guide Wiki"
+[toc-docker-usage]: https://github.com/RustScan/RustScan/wiki/Installation-Guide#docker- "Docker Installation Guide Wiki"
+[usage-guide]: https://github.com/RustScan/RustScan#-usage
+[adaptive-learning]: https://github.com/RustScan/RustScan/wiki/Adaptive-Learning "Adaptive Learning"
+
+<!--Pictures-->
+
+[DockerPic]: https://github.com/RustScan/RustScan/blob/master/pictures/docker.png?raw=true "Docker install"
+[Kali1]: https://github.com/RustScan/RustScan/blob/master/pictures/kali.png?raw=true "Kali Picture"
+[Arch]: https://github.com/RustScan/RustScan/blob/master/pictures/arch.png?raw=true "Arch Linux"
+[Apple]: https://raw.githubusercontent.com/RustScan/RustScan/master/pictures/apple.png?size "Apple"
+[rustscan-svg]: https://repology.org/badge/vertical-allrepos/rustscan.svg "Picture of rustscan repology"
+[accessible-1]: pictures/accessible.gif "Fast"
+[adaptive-1]: pictures/adaptive.gif "Adaptive"
+[extensible-1]: pictures/scripts.gif "Scripts"
+[speed-1]: pictures/fast.gif "Speed"
+[badge-1]: https://img.shields.io/archlinux/v/extra/x86_64/rustscan?style=plastic&logo=archlinux&link=https%3A%2F%2Farchlinux.org%2Fpackages%2Fextra%2Fx86_64%2Frustscan%2F
+[badge-2]: https://img.shields.io/badge/Built%20with-Rust-Purple
+[badge-3]: https://img.shields.io/github/downloads/rustscan/rustscan/total?label=GitHub%20Downloads
+[badge-4]: https://img.shields.io/crates/d/rustscan?label=Cargo%20Downloads
+[badge-5]: https://img.shields.io/discord/754001738184392704
+[badge-6]: https://github.com/RustScan/RustScan/actions/workflows/build.yml/badge.svg?branch=master

benches/benchmark_helpers.rs

@@ -0,0 +1,52 @@
+use criterion::{criterion_group, criterion_main, Criterion};
+use rustscan::input::{Opts, PortRange, ScanOrder};
+use rustscan::port_strategy::PortStrategy;
+use std::net::IpAddr;
+use std::time::Duration;
+
+fn bench_address() {
+    let _addrs = ["127.0.0.1".parse::<IpAddr>().unwrap()];
+}
+
+fn bench_port_strategy() {
+    let range = PortRange {
+        start: 1,
+        end: 1_000,
+    };
+    let _strategy = PortStrategy::pick(&Some(range.clone()), None, ScanOrder::Serial);
+}
+
+fn bench_address_parsing() {
+    let opts = Opts {
+        addresses: vec![
+            "127.0.0.1".to_owned(),
+            "10.2.0.1".to_owned(),
+            "192.168.0.0/24".to_owned(),
+        ],
+        exclude_addresses: Some(vec![
+            "10.0.0.0/8".to_owned(),
+            "172.16.0.0/12".to_owned(),
+            "192.168.0.0/16".to_owned(),
+            "172.16.0.1".to_owned(),
+        ]),
+        ..Default::default()
+    };
+    let _ips = rustscan::address::parse_addresses(&opts);
+}
+
+fn criterion_benchmark(c: &mut Criterion) {
+    // Benching helper functions
+    c.bench_function("parse address", |b| b.iter(bench_address));
+
+    c.bench_function("port strategy", |b| b.iter(bench_port_strategy));
+
+    let mut address_group = c.benchmark_group("address parsing");
+    address_group.measurement_time(Duration::from_secs(10));
+    address_group.bench_function("parse addresses with exclusions", |b| {
+        b.iter(bench_address_parsing)
+    });
+    address_group.finish();
+}
+
+criterion_group!(benches, criterion_benchmark);
+criterion_main!(benches);

build.rs

@@ -0,0 +1,234 @@
+use std::collections::BTreeMap;
+use std::fs::{self, File};
+
+use std::env;
+use std::io::{BufReader, Read};
+use std::path::PathBuf;
+use std::process::Command;
+
+// Reads in a file with payloads based on port
+pub fn main() {
+    let mut file_path = env::current_dir().expect("cant find curr dir");
+    file_path.push("./nmap-payloads");
+
+    let mut data = String::new();
+    let file = File::open(&file_path).expect("File not found.");
+    let mut file_buf = BufReader::new(file);
+    file_buf
+        .read_to_string(&mut data)
+        .expect("unable to read file");
+
+    let mut fp_map: BTreeMap<i32, String> = BTreeMap::new();
+
+    let mut count = 0;
+    let mut capturing = false;
+    let mut curr = String::new();
+
+    for line in data.trim().split('\n') {
+        if line.contains('#') || line.is_empty() {
+            continue;
+        }
+
+        if line.starts_with("udp") {
+            if !curr.is_empty() {
+                fp_map.insert(count, curr);
+                curr = String::new();
+            }
+            capturing = true;
+            count += 1;
+        }
+
+        if capturing {
+            if !curr.is_empty() {
+                curr.push(' ');
+            }
+            curr.push_str(line);
+        }
+    }
+
+    let pb_linenr = ports_v(&fp_map);
+    let payb_linenr = payloads_v(&fp_map);
+    let map = port_payload_map(pb_linenr, payb_linenr);
+
+    generate_code(map);
+}
+
+/// Generates a file called Generated.rs and calls cargo fmt from the command line
+///
+/// # Arguments
+///
+/// * `port_payload_map` - A BTreeMap mapping port numbers to payload data
+fn generate_code(port_payload_map: BTreeMap<Vec<u16>, Vec<u8>>) {
+    let dest_path = PathBuf::from("src/generated.rs");
+
+    let mut generated_code = String::new();
+    generated_code.push_str("use std::collections::BTreeMap;\n");
+    generated_code.push_str("use once_cell::sync::Lazy;\n\n");
+
+    generated_code.push_str("fn generated_data() -> BTreeMap<Vec<u16>, Vec<u8>> {\n");
+    generated_code.push_str("    let mut map = BTreeMap::new();\n");
+
+    for (ports, payloads) in port_payload_map {
+        generated_code.push_str("    map.insert(vec![");
+        generated_code.push_str(
+            &ports
+                .iter()
+                .map(|&p| p.to_string())
+                .collect::<Vec<_>>()
+                .join(","),
+        );
+        generated_code.push_str("], vec![");
+        generated_code.push_str(
+            &payloads
+                .iter()
+                .map(|&p| p.to_string())
+                .collect::<Vec<_>>()
+                .join(","),
+        );
+        generated_code.push_str("]);\n");
+    }
+
+    generated_code.push_str("    map\n");
+    generated_code.push_str("}\n\n");
+
+    generated_code.push_str(
+        "static PARSED_DATA: Lazy<BTreeMap<Vec<u16>, Vec<u8>>> = Lazy::new(generated_data);\n",
+    );
+    generated_code.push_str("pub fn get_parsed_data() -> &'static BTreeMap<Vec<u16>, Vec<u8>> {\n");
+    generated_code.push_str("    &PARSED_DATA\n");
+    generated_code.push_str("}\n");
+
+    fs::write(dest_path, generated_code).unwrap();
+
+    // format the generated code
+    Command::new("cargo")
+        .arg("fmt")
+        .arg("--all")
+        .output()
+        .expect("Failed to execute cargo fmt");
+}
+
+/// Creates a BTreeMap of line numbers mapped to a Vec<u16> of ports
+///
+/// # Arguments
+///
+/// * `fp_map` - A BTreeMap containing the parsed file data
+///
+/// # Returns
+///
+/// A BTreeMap where keys are line numbers and values are vectors of ports
+fn ports_v(fp_map: &BTreeMap<i32, String>) -> BTreeMap<i32, Vec<u16>> {
+    let mut pb_linenr: BTreeMap<i32, Vec<u16>> = BTreeMap::new();
+    let mut port_list: Vec<u16> = Vec::new();
+
+    for (&line_nr, ports) in fp_map {
+        if ports.contains("udp ") {
+            let remain = &ports[4..];
+            let mut start = remain.split(' ');
+
+            let ports = start.next().unwrap();
+            let port_segments: Vec<&str> = ports.split(',').collect();
+
+            for segment in port_segments {
+                if segment.contains('-') {
+                    let range: Vec<&str> = segment.trim().split('-').collect();
+                    let start = range[0].parse::<u16>().unwrap();
+                    let end = range[1].parse::<u16>().unwrap();
+
+                    for port in start..end {
+                        port_list.push(port);
+                    }
+                } else if !segment.is_empty() {
+                    match segment.parse::<u16>() {
+                        Ok(port) => port_list.push(port),
+                        Err(_) => println!("Error parsing port: {segment}"),
+                    }
+                }
+            }
+        }
+
+        pb_linenr.insert(line_nr, port_list.clone());
+        port_list.clear();
+    }
+
+    pb_linenr
+}
+
+/// Parses out the Payloads into a BTreeMap of line numbers mapped to vectors of payload bytes
+///
+/// # Arguments
+///
+/// * `fp_map` - A BTreeMap containing the parsed file data
+///
+/// # Returns
+///
+/// A BTreeMap where keys are line numbers and values are vectors of payload bytes
+fn payloads_v(fp_map: &BTreeMap<i32, String>) -> BTreeMap<i32, Vec<u8>> {
+    let mut payb_linenr: BTreeMap<i32, Vec<u8>> = BTreeMap::new();
+
+    for (&line_nr, data) in fp_map {
+        if data.contains('\"') {
+            let start = data.find('\"').expect("payload opening \" not found");
+            let payloads = &data[start + 1..];
+            payb_linenr.insert(line_nr, parser(payloads.trim()));
+        }
+    }
+
+    payb_linenr
+}
+
+/// Converts a hexadecimal string to a Vec<u8>
+///
+/// # Arguments
+///
+/// * `payload` - A string slice containing the hexadecimal payload
+///
+/// # Returns
+///
+/// A vector of bytes representing the decoded payload
+fn parser(payload: &str) -> Vec<u8> {
+    let payload = payload.trim_matches('"');
+    let mut tmp_str = String::new();
+    let mut bytes: Vec<u8> = Vec::new();
+
+    for (idx, char) in payload.chars().enumerate() {
+        if char == '\\' && payload.chars().nth(idx + 1) == Some('x') {
+            continue;
+        } else if char.is_ascii_hexdigit() {
+            tmp_str.push(char);
+            if tmp_str.len() == 2 {
+                bytes.push(u8::from_str_radix(&tmp_str, 16).unwrap());
+                tmp_str.clear();
+            }
+        }
+    }
+
+    bytes
+}
+
+/// Combines the ports BTreeMap and the Payloads BTreeMap
+///
+/// # Arguments
+///
+/// * `pb_linenr` - A BTreeMap mapping line numbers to vectors of ports
+/// * `payb_linenr` - A BTreeMap mapping line numbers to vectors of payload bytes
+///
+/// # Returns
+///
+/// A BTreeMap mapping vectors of ports to vectors of payload bytes
+fn port_payload_map(
+    pb_linenr: BTreeMap<i32, Vec<u16>>,
+    payb_linenr: BTreeMap<i32, Vec<u8>>,
+) -> BTreeMap<Vec<u16>, Vec<u8>> {
+    let mut ppm_fin: BTreeMap<Vec<u16>, Vec<u8>> = BTreeMap::new();
+
+    for (port_linenr, ports) in pb_linenr {
+        for (pay_linenr, payloads) in &payb_linenr {
+            if pay_linenr == &port_linenr {
+                ppm_fin.insert(ports.to_vec(), payloads.to_vec());
+            }
+        }
+    }
+
+    ppm_fin
+}

contributing.Dockerfile

@@ -0,0 +1,7 @@
+# Dockerfile for RustScan development environment
+# Provides a containerized setup with Rust, nmap, and development tools
+FROM rust
+# Install nmap first.
+RUN apt-get update -qy && apt-get install -qy nmap
+# Then install rustfmt for code formatting and clippy for linting.
+RUN rustup component add rustfmt clippy

contributing.md

@@ -7,19 +7,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** with no chance to get unbanned. No warnings either. 🤗
 
 RustScan has 2 major labels for GitHub issues you should look at:
-* Good First issue
-These are issues for newcomers to open source! 
-[https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22](https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
-* Help wanted
-These are issues that aren't really for newcomers, but we could still do wiht help!
-[https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+label%3A%22help+wanted%22](https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+label%3A%22help+wanted%22)
+
+- Good First issue
+  These are issues for newcomers to open source!
+  [https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22](https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
+- Help wanted
+  These are issues that aren't really for newcomers, but we could still do with help!
+  [https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+label%3A%22help+wanted%22](https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+label%3A%22help+wanted%22)
 
 If you want to, solve the issue or comment on the issue for help.
 
 The flow for contributing to open source software is:
-* Fork the repo
-* Make changes
-* Pull request to the repo
+
+- Fork the repo
+- Make changes
+- Pull request to the repo
 
 And then comment on the issue that you've done.
 
@@ -28,4 +30,45 @@ RustScan also has some `// TODO`'s in the codebase, which are meant more for the
 If you have any feature suggestions or bugs, leave a GitHub issue. We welcome any and all support :D
 
 ## Rewarding you
+
 I cannot pay you :-( But, I can place your GitHub profile on the README under `#Contributors` as a thank you! :)
+
+## Contributing development environment
+
+To ease contribution to RustScan, you can use the `contributing.Dockerfile` to create a Docker image ready to build and play with RustScan.
+To build it you just need to run:
+
+```bash
+you@home:~/RustScan$ docker build -t rustscan_contributing -f contributing.Dockerfile
+```
+
+Then you need to run the container with a volume so it can access, _with read and write permissions_, to RustScan files:
+
+```bash
+you@home:~/RustScan$ docker run -ti --rm -v "$PWD":/rustscan -w /rustscan rustscan_contributing bash
+```
+
+You can now modify RustScan files with your favorite editor, once you want to compile and test your modifications, type the following in the container prompt:
+
+```bash
+root@container:/rustscan# cargo build
+```
+
+You are now ready to use RustScan:
+
+```bash
+root@container:/rustscan# cargo run -- -b 2000 -t 5000 -a 127.0.0.1
+```
+
+You can also format, lint with `clippy` and test the code with the following commands:
+
+```bash
+root@container:/rustscan# cargo fmt
+root@container:/rustscan# cargo clippy
+root@container:/rustscan# cargo test
+```
+
+Automated tests and benchmarks must run without network traffic or external script
+execution. Keep coverage focused on parsing, configuration, port ordering, socket
+address iteration, and timing helpers. Do not add tests that run TCP/UDP scans
+(including localhost), resolve hostnames, or launch Nmap or other scripts.

fixtures/.rustscan_scripts.toml

@@ -0,0 +1,4 @@
+tags = ["core_approved", "example"]
+ports = ["80", "443", "8080"]
+developer = ["example", "https://example.org"]
+directory = "fixtures/.rustscan_scripts" 

fixtures/.rustscan_scripts/test_script.pl

@@ -0,0 +1,23 @@
+#!/usr/bin/perl
+#tags = ["core_approved", "example",]
+#developer = [ "example", "https://example.org" ]
+#ports_separator = ","
+#call_format = "perl {{script}} {{ip}} {{port}}"
+
+# The Scriptfile parser stops parsing at the first blank line.
+# This script will run itself as an argument with the system installed perl interpreter, ports will be concatenated with "," .
+# Unused field: trigger_port = "80"
+# get total arg passed to this script
+my $total = $#ARGV + 1;
+my $counter = 1;
+ 
+# get script name
+my $scriptname = $0;
+ 
+print "Total args passed to $scriptname : $total\n";
+ 
+# Use loop to print all args stored in an array called @ARGV
+foreach my $a(@ARGV) {
+	print "Arg # $counter : $a\n";
+	$counter++;
+}

fixtures/.rustscan_scripts/test_script.py

@@ -0,0 +1,13 @@
+#!/usr/bin/python3
+#tags = ["core_approved", "example",]
+#developer = [ "example", "https://example.org" ]
+#trigger_port = "80"
+#call_format = "python3 {{script}} {{ip}} {{port}}"
+
+# The Scriptfile parser stops parsing at the first blank line.
+# This script will run itself as an argument with the system installed python interpreter, only scanning port 80.
+# Unused filed: ports_separator = ","
+
+import sys
+
+print('Python script ran with arguments', str(sys.argv))

fixtures/.rustscan_scripts/test_script.sh

@@ -0,0 +1,12 @@
+#!/bin/bash 
+#tags = ["core_approved", "example",]
+#developer = [ "example", "https://example.org" ]
+#ports_separator = ","
+#call_format = "bash {{script}} {{ip}} {{port}}"
+
+# The Scriptfile parser stops parsing at the first blank line.
+# This script will run itself as an argument with the system installed bash interpreter, scanning all ports concatenated with "," .
+# Unused filed: trigger_port = "80"
+
+# print all arguments passed to the script
+echo $@

fixtures/.rustscan_scripts/test_script.txt

@@ -0,0 +1,9 @@
+#!intentional_blank_line
+#tags = ["core_approved", "example"]
+#developer = [ "example", "https://example.org" ]
+#ports_separator = ","
+#call_format = "nmap -vvv -p {{port}} {{ip}}"
+
+# The Scriptfile parser stops parsing at the first blank line.
+# This script will run the system installed nmap, ports will be concatenated with "," .
+# Unused field: trigger_port = "80"

fixtures/.rustscan_scripts/test_script_invalid_headers.txt

@@ -0,0 +1,7 @@
+#!intentional_blank_line
+#tags = "core_approved"
+#developer = [ "example", "https://example.org" ]
+#ports_separator = ","
+#call_format = "nmap -vvv -p {{port}} {{ip}}"
+
+# tags has to be an array, thus this file won't be parsed

fixtures/hosts.txt

@@ -0,0 +1,6 @@
+127.0.0.1
+google.com
+example.com
+66666666666666.666666666666666666.66666666666666666.6666666666
+....
+e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.radiatorFixtures

fixtures/naughty_strings.txt

@@ -0,0 +1,42 @@
+# https://github.com/minimaxir/big-list-of-naughty-strings
+
+
+­؀؁؂؃؄؅؜۝܏᠎​‌‍‎‏‪‫‬‭‮⁠⁡⁢⁣⁤⁦⁧⁨⁩𑂽𛲠𛲡𛲢𛲣𝅳𝅴𝅵𝅶𝅷𝅸𝅹𝅺󠀁󠀠󠀡󠀢󠀣󠀤󠀥󠀦󠀧󠀨󠀩󠀪󠀫󠀬󠀭󠀮󠀯󠀰󠀱󠀲󠀳󠀴󠀵󠀶󠀷󠀸󠀹󠀺󠀻󠀼󠀽󠀾󠀿󠁀󠁁󠁂󠁃󠁄󠁅󠁆󠁇󠁈󠁉󠁊󠁋󠁌󠁍󠁎󠁏󠁐󠁑󠁒󠁓󠁔󠁕󠁖󠁗󠁘󠁙󠁚󠁛󠁜󠁝󠁞󠁟󠁠󠁡󠁢󠁣󠁤󠁥󠁦󠁧󠁨󠁩󠁪󠁫󠁬󠁭󠁮󠁯󠁰󠁱󠁲󠁳󠁴󠁵󠁶󠁷󠁸󠁹󠁺󠁻󠁼󠁽󠁾󠁿
+
+Ω≈ç√∫˜µ≤≥÷
+åß∂ƒ©˙∆˚¬…æ
+œ∑´®†¥¨ˆøπ“‘
+¡™£¢∞§¶•ªº–≠
+¸˛Ç◊ı˜Â¯˘¿
+ÅÍÎÏ˝ÓÔÒÚÆ☃
+Œ„´‰ˇÁ¨ˆØ∏”’
+`⁄€‹›fifl‡°·‚—±
+⅛⅜⅝⅞
+ЁЂЃЄЅІЇЈЉЊЋЌЍЎЏАБВГДЕЖЗИЙКЛМНОПРСТУФХЦЧШЩЪЫЬЭЮЯабвгдежзийклмнопрстуфхцчшщъыьэюя
+٠١٢٣٤٥٦٧٨٩
+
+
+
+⁰⁴⁵
+₀₁₂
+⁰⁴⁵₀₁₂
+ด้้้้้็็็็็้้้้้็็็็็้้้้้้้้็็็็็้้้้้็็็็็้้้้้้้้็็็็็้้้้้็็็็็้้้้้้้้็็็็็้้้้้็็็็ ด้้้้้็็็็็้้้้้็็็็็้้้้้้้้็็็็็้้้้้็็็็็้้้้้้้้็็็็็้้้้้็็็็็้้้้้้้้็็็็็้้้้้็็็็ ด้้้้้็็็็็้้้้้็็็็็้้้้้้้้็็็็็้้้้้็็็็็้้้้้้้้็็็็็้้้้้็็็็็้้้้้้้้็็็็็้้้้้็็็็
+
+田中さんにあげて下さい
+パーティーへ行かないか
+和製漢語
+部落格
+사회과학원 어학연구소
+찦차를 타고 온 펲시맨과 쑛다리 똠방각하
+社會科學院語學研究所
+울란바토르
+𠜎𠜱𠝹𠱓𠱸𠲖𠳏
+𝐓𝐡𝐞 𝐪𝐮𝐢𝐜𝐤 𝐛𝐫𝐨𝐰𝐧 𝐟𝐨𝐱 𝐣𝐮𝐦𝐩𝐬 𝐨𝐯𝐞𝐫 𝐭𝐡𝐞 𝐥𝐚𝐳𝐲 𝐝𝐨𝐠
+𝕿𝖍𝖊 𝖖𝖚𝖎𝖈𝖐 𝖇𝖗𝖔𝖜𝖓 𝖋𝖔𝖝 𝖏𝖚𝖒𝖕𝖘 𝖔𝖛𝖊𝖗 𝖙𝖍𝖊 𝖑𝖆𝖟𝖞 𝖉𝖔𝖌
+𝑻𝒉𝒆 𝒒𝒖𝒊𝒄𝒌 𝒃𝒓𝒐𝒘𝒏 𝒇𝒐𝒙 𝒋𝒖𝒎𝒑𝒔 𝒐𝒗𝒆𝒓 𝒕𝒉𝒆 𝒍𝒂𝒛𝒚 𝒅𝒐𝒈
+𝓣𝓱𝓮 𝓺𝓾𝓲𝓬𝓴 𝓫𝓻𝓸𝔀𝓷 𝓯𝓸𝔁 𝓳𝓾𝓶𝓹𝓼 𝓸𝓿𝓮𝓻 𝓽𝓱𝓮 𝓵𝓪𝔃𝔂 𝓭𝓸𝓰
+𝕋𝕙𝕖 𝕢𝕦𝕚𝕔𝕜 𝕓𝕣𝕠𝕨𝕟 𝕗𝕠𝕩 𝕛𝕦𝕞𝕡𝕤 𝕠𝕧𝕖𝕣 𝕥𝕙𝕖 𝕝𝕒𝕫𝕪 𝕕𝕠𝕘
+𝚃𝚑𝚎 𝚚𝚞𝚒𝚌𝚔 𝚋𝚛𝚘𝚠𝚗 𝚏𝚘𝚡 𝚓𝚞𝚖𝚙𝚜 𝚘𝚟𝚎𝚛 𝚝𝚑𝚎 𝚕𝚊𝚣𝚢 𝚍𝚘𝚐
+⒯⒣⒠ ⒬⒰⒤⒞⒦ ⒝⒭⒪⒲⒩ ⒡⒪⒳ ⒥⒰⒨⒫⒮ ⒪⒱⒠⒭ ⒯⒣⒠ ⒧⒜⒵⒴ ⒟⒪⒢
+
+ثم نفس سقطت وبالتحديد،, جزيرتي باستخدام أن دنو. إذ هنا؟ الستار وتنصيب كان. أهّل ايطاليا، بريطانيا-فرنسا قد أخذ. سليمان، إتفاقية بين ما, يذكر الحدود أي بعد, معاملة بولندا، الإطلاق عل إيو.

fixtures/test_rustscan_scripts.toml

@@ -0,0 +1,14 @@
+# Test/Example ScriptConfig file
+
+# Tags to filter on scripts. Only scripts containing all these tags will run.
+tags = ["core_approved", "example"]
+
+# If it's present then only those scripts will run which has a tag ports = "80". Not yet implemented.
+#
+# ex.:
+# ports = ["80"]
+# ports = ["80","81","8080"]
+ports = ["80"]
+
+# Only this developer(s) scripts to run. Not yet implemented.
+developer = ["example"]

justfile

@@ -0,0 +1,18 @@
+test:
+    cargo test
+    cargo clippy -- --deny warnings
+    cargo clippy --tests -- --deny warnings
+    cargo fmt --check
+    cargo doc --workspace --all-features --no-deps --document-private-items
+
+fix:
+    cargo fmt
+    cargo clippy --fix
+
+# release only runs if test runs
+release: test
+    git checkout master
+    git pull
+    cargo generate-lockfile
+    cargo publish 
+    git push

nmap-payloads

@@ -0,0 +1,500 @@
+# Nmap nmap payload database -*- mode: fundamental; -*-
+# $Id$
+#
+# These payloads are sent with every host discovery or port scan probe
+# by default. This database should only include payloads that are
+# unlikely to crash services, trip IDS alerts, or change state on the
+# server. The idea behind these is to evoke a response using a payload.
+# Some of them are taken from nmap-service-probes.
+#
+# This collection of data is (C) 1996-2022 by Nmap Software LLC.  It
+# is distributed under the Nmap Public Source license as provided in
+# the LICENSE file of the source distribution or at
+# https://nmap.org/npsl/.  Note that this free license does not allow
+# incorporation of Nmap or its data files within proprietary
+# software. We sell a separate Nmap OEM for that as described
+# (including pricing) at https://nmap.org/npsl/.
+#
+# Each entry begins with a protocol (only "udp" is supported) followed
+# by a comma-separated list of ports, followed by one or more quoted
+# strings containing the payload. These elements may be broken across
+# several lines. For future expansion, additional keywords may follow
+# the payload data. Any data following one of these keywords must be on
+# the same line as the keyword so that unknown keywords can be ignored
+# by the parser. Currently this file contains some entries with the
+# "source" keyword to specify a desired source port, but it is not
+# honored by Nmap.
+#
+# Multiple payloads may be defined for a single protocol and port, in
+# which case they will be all be sent concurrently. There is a limit
+# of 255 payloads per port.
+#
+# Lines longer than 1024 characters will be ignored.
+#
+# Example:
+# udp 1234 "payloaddatapayloaddata"
+#   "payloaddatapayloaddata"
+# source 5678
+
+# GenericLines. Use for the echo service.
+udp 7 "\x0D\x0A\x0D\x0A"
+# DNSStatusRequest
+# Sent for TFTP (69) as well due to its ability to provoke an error response
+udp 53,69,5353,26198 "\x00\x00\x10\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+# DNS VER
+udp 53,5353,26198
+  "\x77\x77\x01\x00\x00"
+  "\x01\x00\x00\x00\x00\x00\x00\x07version\x04bind\x00\x00\x10\x00\x03"
+
+# DHCP INFORM
+udp 67
+  "\x01\x01\x06\x00"
+  "\x01\x23\x45\x67\x00\x00\x00\x00\xff\xff\xff\xff\x00\x00\x00\x00\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x0e\x35\xd4\xd8\x51\x00\x00\x00\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x63\x82\x53\x63\x35\x01"
+  "\x08\xff"
+
+# TFTP GET
+udp 69 "\x00\x01r7tftp.txt\x00octet\x00"
+
+# QUIC packet with unsupported version Q999
+# Also found on 443, but need to check whether DTLS or QUIC is more prevalent
+udp 80 "\r12345678Q999\x00"
+# RPCCheck
+udp 111
+  "\x72\xFE\x1D\x13\x00\x00\x00\x00\x00\x00\x00\x02\x00\x01\x86\xA0"
+  "\x00\x01\x97\x7C\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\x00"
+# ONCRPC CALL
+udp 111,2049,4045,32768-65535
+  "\x3e\xec\xe3\xca\x00\x00\x00\x00\x00\x00\x00\x02\x00"
+  "\xbc\x61\x4e\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+# NTPRequest
+udp 123
+  "\xE3\x00\x04\xFA\x00\x01\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\x00\xC5\x4F\x23\x4B\x71\xB1\x52\xF3"
+# NTP REQ
+udp 123
+  "\xd9\x00\x0a\xfa\x00\x00\x00"
+  "\x00\x00\x01\x04\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xc6"
+  "\xf1\x5e\xdb\x78\x00\x00\x00"
+# DCERPC CALL
+udp 135,1025-1199
+  "\x05\x00\x0b\x03\x10\x00\x00\x00\x48\x00"
+  "\x00\x00\x01\x00\x00\x00\xb8\x10\xb8\x10\x00\x00\x00\x00\x01\x00\x00"
+  "\x00\x00\x00\x01\x00\x01\x23\x45\x67\x89\xab\xcd\xef\x01\x23\x45\x67"
+  "\x89\xab\xcd\xef\xe7\x03\x00\x00\xfe\xdc\xba\x98\x76\x54\x32\x10\x01"
+  "\x23\x45\x67\x89\xab\xcd\xef\xe7\x03\x00\x00"
+# NBTStat
+udp 137
+  "\x80\xF0\x00\x10\x00\x01\x00\x00\x00\x00\x00\x00"
+  "\x20CKAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\x00\x00\x21\x00\x01"
+# CIFS NS NAME QUERY UC
+udp 137
+  "\x01\x91\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00"
+  "\x20CKAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\x00\x00\x21\x00\x01"
+# CIFS NS NAME QUERY BC
+udp 137
+  "\x01\x91\x00\x10\x00\x01\x00\x00\x00\x00\x00\x00"
+  "\x20CKAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\x00\x00\x21\x00\x01"
+# SNMPv3GetRequest
+udp 161,260,3401
+  "\x30\x3A\x02\x01\x03\x30\x0F\x02\x02\x4A\x69\x02\x03\x00\xFF\xE3"
+  "\x04\x01\x04\x02\x01\x03\x04\x10\x30\x0E\x04\x00\x02\x01\x00\x02"
+  "\x01\x00\x04\x00\x04\x00\x04\x00\x30\x12\x04\x00\x04\x00\xA0\x0C"
+  "\x02\x02\x37\xF0\x02\x01\x00\x02\x01\x00\x30\x00"
+# SNMP PUBLIC WALK
+udp 161,260,3401
+  "\x30\x1f\x02\x01\x00\x04\x06public\xa1\x12\x02\x01\x00\x02"
+  "\x01\x00\x02\x01\x00\x30\x07\x30\x05\x06\x01\x00\x05\x00"
+
+# Sqlping - disabled because it trips a Snort rule with SID 2049
+# ("MS-SQL ping attempt").
+# udp 1434 "\x02"
+
+# xdmcp - X Display Manager Control Protocol. Version 1, packet type
+# Query (2), no authorization names. We expect a Willing or Unwilling
+# packet in reply.
+# http://cgit.freedesktop.org/xorg/doc/xorg-docs/plain/hardcopy/XDMCP/xdmcp.PS.gz
+udp 177 "\x00\x01\x00\x02\x00\x01\x00"
+
+# Connectionless LDAP - used by Microsoft Active Directory
+udp 389
+  "\x30\x84\x00\x00\x00\x2d\x02\x01\x07\x63\x84\x00\x00\x00\x24\x04\x00"
+  "\x0a\x01\x00\x0a\x01\x00\x02\x01\x00\x02\x01\x64\x01\x01\x00\x87\x0b"
+  "objectClass0\x84\x00\x00\x00\x00"
+
+
+# svrloc
+udp 427
+  "\x02\x01\x00\x006 \x00\x00\x00\x00\x00\x01\x00\x02en\x00\x00\x00\x15"
+  "service:service-agent\x00\x07default\x00\x00\x00\x00"
+
+# DTLS
+udp 443,853,3391,4433,4740,5349,5684,5868,6514,6636,8232,10161,10162,12346,12446,12546,12646,12746,12846,12946,13046
+  # DTLS 1.0, length 52
+  "\x16\xfe\xff\x00\x00\x00\x00\x00\x00\x00\x00\x00\x36"
+  # ClientHello, length 40, sequence 0, offset 0
+  "\x01\x00\x00\x2a\x00\x00\x00\x00\x00\x00\x00\x2a"
+  # DTLS 1.2
+  "\xfe\xfd"
+  # Random
+  "\x00\x00\x00\x00\x7c\x77\x40\x1e\x8a\xc8\x22\xa0\xa0\x18\xff\x93"
+  "\x08\xca\xac\x0a\x64\x2f\xc9\x22\x64\xbc\x08\xa8\x16\x89\x19\x3f"
+  # Session id length 0, cookie length 0
+  "\x00\x00"
+  # Cipher suites, mandatory TLS_RSA_WITH_AES_128_CBC_SHA
+  "\x00\x02\x00\x2f"
+  # Compressors (NULL)
+  "\x01\x00"
+
+# Internet Key Exchange version 1, phase 1 Main Mode. We offer every
+# combination of (DES, 3DES) and (MD5, SHA) in the hope that one of them will
+# be acceptable. Because we use a fixed cookie, we set the association lifetime
+# to 1 second to reduce the chance that repeated probes will look like
+# retransmissions (and therefore not get a response). This payload comes from
+#   ike-scan --lifetime 1 --cookie 0011223344556677 --trans=5,2,1,2 --trans=5,1,1,2 --trans=1,2,1,2 --trans=1,1,1,2
+# We expect another phase 1 message in response. This payload works better with
+# a source port of 500 or a randomized initiator cookie.
+udp 500
+  # Initiator cookie 0x0011223344556677, responder cookie 0x0000000000000000.
+  "\x00\x11\x22\x33\x44\x55\x66\x77\x00\x00\x00\x00\x00\x00\x00\x00"
+  # Version 1, Main Mode, flags 0x00, message ID 0x00000000, length 192.
+  "\x01\x10\x02\x00\x00\x00\x00\x00\x00\x00\x00\xC0"
+  # Security Association payload, length 164, IPSEC, IDENTITY.
+  "\x00\x00\x00\xA4\x00\x00\x00\x01\x00\x00\x00\x01"
+  # Proposal 1, length 152, ISAKMP, 4 transforms.
+  "\x00\x00\x00\x98\x01\x01\x00\x04"
+  # Transform 1, 3DES-CBC, SHA, PSK, group 2.
+  "\x03\x00\x00\x24\x01\x01\x00\x00\x80\x01\x00\x05\x80\x02\x00\x02"
+  "\x80\x03\x00\x01\x80\x04\x00\x02"
+  "\x80\x0B\x00\x01\x00\x0C\x00\x04\x00\x00\x00\x01"
+  # Transform 2, 3DES-CBC, MD5, PSK, group 2.
+  "\x03\x00\x00\x24\x02\x01\x00\x00\x80\x01\x00\x05\x80\x02\x00\x01"
+  "\x80\x03\x00\x01\x80\x04\x00\x02"
+  "\x80\x0B\x00\x01\x00\x0C\x00\x04\x00\x00\x00\x01"
+  # Transform 3, DES-CBC, SHA, PSK, group 2.
+  "\x03\x00\x00\x24\x03\x01\x00\x00\x80\x01\x00\x01\x80\x02\x00\x02"
+  "\x80\x03\x00\x01\x80\x04\x00\x02"
+  "\x80\x0B\x00\x01\x00\x0C\x00\x04\x00\x00\x00\x01"
+  # Transform 4, DES-CBC, MD5, PSK, group 2.
+  "\x00\x00\x00\x24\x04\x01\x00\x00\x80\x01\x00\x01\x80\x02\x00\x01"
+  "\x80\x03\x00\x01\x80\x04\x00\x02"
+  "\x80\x0B\x00\x01\x00\x0C\x00\x04\x00\x00\x00\x01"
+# IPSEC START
+udp 500,4500
+  "\x31\x27\xfc"
+  "\xb0\x38\x10\x9e\x89\x00\x00\x00\x00\x00\x00\x00\x00\x01\x10\x02\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\xcc\x0d\x00\x00\x5c\x00\x00\x00\x01\x00"
+  "\x00\x00\x01\x00\x00\x00\x50\x01\x01\x00\x02\x03\x00\x00\x24\x01\x01"
+  "\x00\x00\x80\x01\x00\x05\x80\x02\x00\x02\x80\x04\x00\x02\x80\x03\x00"
+  "\x03\x80\x0b\x00\x01\x00\x0c\x00\x04\x00\x00\x0e\x10\x00\x00\x00\x24"
+  "\x02\x01\x00\x00\x80\x01\x00\x05\x80\x02\x00\x01\x80\x04\x00\x02\x80"
+  "\x03\x00\x03\x80\x0b\x00\x01\x00\x0c\x00\x04\x00\x00\x0e\x10\x0d\x00"
+  "\x00\x18\x1e\x2b\x51\x69\x05\x99\x1c\x7d\x7c\x96\xfc\xbf\xb5\x87\xe4"
+  "\x61\x00\x00\x00\x04\x0d\x00\x00\x14\x40\x48\xb7\xd5\x6e\xbc\xe8\x85"
+  "\x25\xe7\xde\x7f\x00\xd6\xc2\xd3\x0d\x00\x00\x14\x90\xcb\x80\x91\x3e"
+  "\xbb\x69\x6e\x08\x63\x81\xb5\xec\x42\x7b\x1f\x00\x00\x00\x14\x26\x24"
+  "\x4d\x38\xed\xdb\x61\xb3\x17\x2a\x36\xe3\xd0\xcf\xb8\x19"
+
+# Routing Information Protocol version 1. Special-case request for the entire
+# routing table (address family 0, address 0.0.0.0, metric 16). RFC 1058,
+# section 3.4.1.
+udp 520
+  "\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\x10"
+
+# RMCP ASF ping
+udp 623
+  "\x06\x00\xff\x06" # RMCP version 6, sequence 0xff, normal RMCP class ASF
+  "\x00\x00\x11\xbe" # IAN ASF code 4542
+  "\x80\x00\x00\x00" # payload-less ASF presence ping
+
+# IPMI
+# RMCP Get Channel Auth Capabilities
+udp 623
+  "\x06\x00\xff\x07\x00\x00\x00\x00\x00\x00\x00\x00\x00\x09\x20\x18"
+  "\xc8\x81\x00\x38\x8e\x04\xb5"
+
+# serialnumberd. This service runs on Mac OS X Server. This probe
+# requests the serial number of another server. In response we expect a
+# packet starting with "SNRESPS:", followed by some data whose purpose
+# is not known.
+udp 626 "SNQUERY: 127.0.0.1:AAAAAA:xsvr"
+
+# OpenVPN P_CONTROL_HARD_RESET_CLIENT_V2
+# Byte 0; 0x38 opcode
+# Byte 1-8: Session ID, random
+# Byte 9: Message packet-id array length (0)
+# Byte 10-13: Message packet-id (0)
+udp 1194 "8d\xc1x\x01\xb8\x9b\xcb\x8f\0\0\0\0\0"
+# OpenVPN when in PKI mode and without the "HMAC Firewall" setting enabled
+# (tls-auth) should respond to the following probe, which is
+# 0x38<8 random bytes><4 null bytes>
+udp 1194
+  "\x38\x01\x02\x03\x04\x05\x06\x07\x08\x00\x00\x00\x00"
+
+# Citrix MetaFrame application browser service
+# Original idea from http://sh0dan.org/oldfiles/hackingcitrix.html
+# Payload contents copied from Wireshark capture of Citrix Program
+# Neighborhood client application.  The application uses this payload to
+# locate Citrix servers on the local network.  Response to this probe is
+# a 48 byte UDP payload as shown here:
+#
+# 0000   30 00 02 31 02 fd a8 e3 02 00 06 44 c0 a8 80 55
+# 0010   00 00 00 00 00 00 00 00 00 00 00 00 02 00 06 44
+# 0020   c0 a8 80 56 00 00 00 00 00 00 00 00 00 00 00 00
+#
+# The first 12 bytes appear to be the same in all responses.
+#
+# Bytes 0x00 appears to be a packet length field
+# Bytes 0x0C - 0x0F are the IP address of the server
+# Bytes 0x10 - 0x13 may vary, 0x14 - 0x1F do not appear to
+# Bytes 0x20 - 0x23 are the IP address of the primary system in a server farm
+#                   configuration
+# Bytes 0x24 - 0x27 can vary, 0x28 - 0x2F do not appear to
+udp 1604
+  "\x1e\x00\x01\x30\x02\xfd\xa8\xe3\x00\x00\x00\x00\x00\x00\x00\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+
+# RADIUS Access-Request. This is a degenerate packet with no username or
+# password; we expect an Access-Reject in response. The Identifier and Request
+# Authenticator are both 0. It was generated by running
+#   echo 'User-Password = ""' | radclient <ip> auth ""
+# and then manually stripping out the password.
+#
+# Section 2 of the RFC says "A request from a client for which the
+# RADIUS server does not have a shared secret MUST be silently
+# discarded." So this payload only works when the server is configured
+# (or misconfigured) to know the scanning machine as a client.
+#
+# RFC 2865: "The early deployment of RADIUS was done using UDP port
+# number 1645, which conflicts with the "datametrics" service. The
+# officially assigned port number for RADIUS is 1812.
+udp 1645,1812
+  "\x01\x00\x00\x14"
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+
+# L2TP ICRQ
+udp 1701
+  "\xc8\x02"
+  "\x00\x3c\x00\x00\x00\x00\x00\x00\x00\x00\x80\x08\x00\x00\x00\x00\x00"
+  "\x01\x80\x08\x00\x00\x00\x02\x01\x00\x80\x0e\x00\x00\x00\x07"
+  "nxp-scan\x80\x0a\x00\x00\x00\x03\x00\x00\x00\x03\x80"
+  "\x08\x00\x00\x00\x09\x00\x00"
+
+# UPNP MSEARCH
+udp 1900
+  "M-SEARCH * HTTP/1.1\r\nHost: 239.255.255.250:1900\r\n"
+  "Man: \"ssdp:discover\"\r\nMX: 5\r\nST: ssdp:all\r\n\r\n"
+
+# NFS version 2, RFC 1831. XID 0x00000000, program 100003 (NFS), procedure
+# NFSPROC_NULL (does nothing, see section 2.2.1), null authentication (see
+# section 9.1).
+udp 2049
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x01\x86\xA3"
+  "\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+  "\x00\x00\x00\x00\x00\x00\x00\x00"
+
+# GPRS Tunneling Protocol (GTP)
+udp 2123,2152
+# GTPv1, protocol 1
+"\x32"
+# EchoRequest
+"\x01"
+# message length
+"\x00\x04"
+# Tunnel endpoint identifier
+"\x00\x00\x42\x00"
+# sequence number
+"\x13\x37"
+# N-PDU number
+"\x00"
+# next extension header type
+"\x00"
+
+# GPRS Tunneling Protocol (GTP) "prime" v2
+# This same packet can be used for GTP v2 on ports 2123 and 2152 if you change
+# the first byte from \x4e to \x40
+udp 3386
+# GTP'v2
+"\x4e"
+# EchoRequest
+"\x01"
+# message length
+"\x00\x04"
+# sequence number
+"\xde\xfe\xc8\x00"
+
+# Freelancer game server status query
+# http://sourceforge.net/projects/gameq/
+# (relevant files: games.ini, packets.ini, freelancer.php)
+udp 2302 "\x00\x02\xf1\x26\x01\x26\xf0\x90\xa6\xf0\x26\x57\x4e\xac\xa0\xec\xf8\x68\xe4\x8d\x21"
+
+# Apple Remote Desktop (ARD)
+udp 3283 "\0\x14\0\x01\x03"
+
+# STUN Binding request, see RFC 5389 Section 6
+# message type = 0x001, Binding (see Section 18.1)
+# message length = 0
+# magic cookie = 0x2112a442
+# transaction ID = "\x00"*12
+udp 3478 "\x00\x01\x00\x00\x21\x12\xa4\x42\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+
+# Sun Service Tag Discovery protocol (stdiscover)
+# http://arc.opensolaris.org/caselog/PSARC/2006/638/stdiscover_protocolv2.pdf
+# Would work better with a varying cookie; the second and later sends of this
+# probe will be interpreted as resends by the server and will be ignored.
+udp 6481 "[PROBE] 0000"
+
+# NAT-PMP external IP address request. See section 3.2 of
+# http://files.dns-sd.org/draft-cheshire-nat-pmp.txt.
+udp 5351 "\x00\x00"
+
+# DNS Service Discovery (DNS-SD) service query, as used in Zeroconf.
+# Transaction ID 0x0000, flags 0x0000, 1 question: PTR query for
+# _services._dns-sd._udp.local. If the remote host supports DNS-SD it will send
+# back a list of all its services. This is the same as a packet capture of
+#   dns-sd -B _services._dns-sd._udp .
+# See section 9 of
+# http://files.dns-sd.org/draft-cheshire-dnsext-dns-sd.txt.
+# This first probe is a QU probe, meaning a unicast response is desired
+udp 5353
+  "\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00"
+  "\x09_services\x07_dns-sd\x04_udp\x05local\x00\x00\x0C\x80\x01"
+# This second probe is a QM probe, meaning a unicast response is desired
+udp 5353
+  "\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00"
+  "\x09_services\x07_dns-sd\x04_udp\x05local\x00\x00\x0C\x00\x01"
+
+# PCANY STATUS
+udp 5632 "ST"
+
+# CoAP GET .well-known/core
+udp 5683 "@\x01\x01\xce\xbb.well-known\x04core"
+
+# UT2K PING
+udp 7777 "None\x00"
+
+# Ubiquiti Discovery Service - v1
+udp 10001 "\x01\x00\x00\x00"
+
+# Amanda backup service noop request. I think that this does nothing on the
+# server but only asks it to send back its feature list. In reply we expect an
+# ACK or (more likely) an ERROR. I couldn't find good online documentation of
+# the Amanda network protocol. There is parsing code in the Amanda source at
+# common-src/security-util.c. This is based on a packet capture of
+#   amcheck <config> <host>
+udp 10080
+  "Amanda 2.6 REQ HANDLE 000-00000000 SEQ 0\n"
+  "SERVICE noop\n"
+
+# VxWorks Wind River Debugger
+udp 17185
+# Random XID
+"\x00\x00\x00\x00"
+# RPC version 2 procedure call
+"\x00\x00\x00\x00\x00\x00\x00\x02"
+# WDB version 1
+"\x55\x55\x55\x55\x00\x00\x00\x01"
+# WDB_TARGET_PING
+"\x00\x00\x00\x00"
+# RPC Auth NULL
+"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+# Checksum
+"\xff\xff\x55\x13"
+# WDB wrapper (length and sequence number)
+"\x00\x00\x00\x30\x00\x00\x00\x01"
+# Empty data?
+"\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00\x00"
+# VXWORKS DEBUG (alternative?)
+udp 17185
+  "\x72\x37\x72\x37\x00\x00\x00"
+  "\x00\x00\x00\x00\x02\x55\x55\x55\x55\x00\x00\x00\x01\x00\x00\x00\x01"
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xff"
+  "\xff\x55\x10\x00\x00\x00\x3c\x00\x00\x00\x03\x00\x00\x00\x02\x00\x00"
+  "\x00\x00\x00\x00\x00\x00"
+
+# Quake 2 and Quake 3 game servers (and servers of derived games like Nexuiz).
+# Gets game information from the server (see probe responses in
+# nmap-service-probes). These services typically run on a base port or a
+# few numbers higher.
+# Quake 2. Typical ports: 27910-27914.
+udp 27910-27914 "\xff\xff\xff\xffstatus"
+# Quake 3. Typical ports:
+# 26000-26004: Nexuiz
+# 27960-27964: Various games
+# 30720-30724: Tremulous
+# 44400: Warsow
+udp 26000-26004,27960-27964,30720-30724,44400 "\xff\xff\xff\xffgetstatus"
+
+# Murmur 1.2.X (Mumble server)
+# UDP ping. "abcdefgh" is an identifier. See
+# http://mumble.sourceforge.net/Protocol.
+udp 64738 "\x00\x00\x00\x00abcdefgh"
+
+# Ventrilo 2.1.2+
+# UDP general status request (encrypted).
+# See http://aluigi.altervista.org/papers.htm#ventrilo
+udp 3784
+"\x01\xe7\xe5\x75\x31\xa3\x17\x0b\x21\xcf\xbf\x2b\x99\x4e\xdd\x19\xac\xde\x08\x5f\x8b\x24\x0a\x11\x19\xb6\x73\x6f\xad\x28\x13\xd2\x0a\xb9\x12\x75"
+
+# Kademlia (kad) as used by various P2P applications.  Send a Kademlia ping
+# 4665, 4666, 4672, 6429: eDonkey/eMule and variants
+udp 4665,4666,4672,6429 "\xE4\x60"
+
+# TeamSpeak 2
+# UDP login request
+# See http://wiki.wireshark.org/TeamSpeak2
+udp 8767
+"\xf4\xbe\x03\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x002x\xba\x85\tTeamSpeak\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\nWindows XP\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x00\x00 \x00<\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08nickname\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+
+# TS3INIT1
+udp 9987
+"TS3INIT1\x00\x65\x00\x00\x88\x0a\x39\x7b\x0f\x00\x5b\x55\x72\xef\xdc\x78\x32\x6b\x00\x00\x00\x00\x00\x00\x00\x00"
+
+# TeamSpeak 3
+# UDP login request (encrypted)
+# http://seclists.org/nmap-dev/2013/q3/72
+udp 9987
+"\x05\xca\x7f\x16\x9c\x11\xf9\x89\x00\x00\x00\x00\x02\x9d\x74\x8b\x45\xaa\x7b\xef\xb9\x9e\xfe\xad\x08\x19\xba\xcf\x41\xe0\x16\xa2\x32\x6c\xf3\xcf\xf4\x8e\x3c\x44\x83\xc8\x8d\x51\x45\x6f\x90\x95\x23\x3e\x00\x97\x2b\x1c\x71\xb2\x4e\xc0\x61\xf1\xd7\x6f\xc5\x7e\xf6\x48\x52\xbf\x82\x6a\xa2\x3b\x65\xaa\x18\x7a\x17\x38\xc3\x81\x27\xc3\x47\xfc\xa7\x35\xba\xfc\x0f\x9d\x9d\x72\x24\x9d\xfc\x02\x17\x6d\x6b\xb1\x2d\x72\xc6\xe3\x17\x1c\x95\xd9\x69\x99\x57\xce\xdd\xdf\x05\xdc\x03\x94\x56\x04\x3a\x14\xe5\xad\x9a\x2b\x14\x30\x3a\x23\xa3\x25\xad\xe8\xe6\x39\x8a\x85\x2a\xc6\xdf\xe5\x5d\x2d\xa0\x2f\x5d\x9c\xd7\x2b\x24\xfb\xb0\x9c\xc2\xba\x89\xb4\x1b\x17\xa2\xb6"
+
+# Memcached
+# version request (shorter response than stats)
+# https://github.com/memcached/memcached/blob/master/doc/protocol.txt
+udp 11211
+"\0\x01\0\0\0\x01\0\0version\r\n"
+
+# Steam, typically using a port in 27015-27030.  Send a "Source Engine query"
+udp 27015-27030
+  "\xff\xff\xff\xffTSource Engine Query\x00"
+
+# TRIN00 UNIX PING
+udp 27444 "png l44adsl"
+
+# BO PING
+udp 31337
+  "\xce\x63\xd1\xd2\x16\xe7\x13\xcf\x38"
+  "\xa5\xa5\x86\xb2\x75\x4b\x99\xaa\x32\x58"
+
+# TRIN00 WIN PING
+udp 34555 "png []..Ks"
+
+# Beckhoff ADS discovery request
+# https://github.com/ONE75/adsclient/blob/master/src/AdsClient.Finder/DeviceFinder.cs#L49-L64
+udp 48899
+"\x03\x66\x14\x71\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x01\x01\x10\x27\x00\x00\x00\x00"

pictures/accessible.yml

@@ -0,0 +1,131 @@
+# The configurations that used for the recording, feel free to edit them
+config:
+
+  # Specify a command to be executed
+  # like `/bin/bash -l`, `ls`, or any other commands
+  # the default is bash for Linux
+  # or powershell.exe for Windows
+  command: zsh
+  
+  # Specify the current working directory path
+  # the default is the current working directory path
+  cwd: /home/bee/Documents/RustScan
+  
+  # Export additional ENV variables
+  env:
+    recording: true
+  
+  # Explicitly set the number of columns
+  # or use `auto` to take the current
+  # number of columns of your shell
+  cols: 107
+  
+  # Explicitly set the number of rows
+  # or use `auto` to take the current
+  # number of rows of your shell
+  rows: 43
+  
+  # Amount of times to repeat GIF
+  # If value is -1, play once
+  # If value is 0, loop indefinitely
+  # If value is a positive number, loop n times
+  repeat: 0
+  
+  # Quality
+  # 1 - 100
+  quality: 100
+  
+  # Delay between frames in ms
+  # If the value is `auto` use the actual recording delays
+  frameDelay: auto
+  
+  # Maximum delay between frames in ms
+  # Ignored if the `frameDelay` isn't set to `auto`
+  # Set to `auto` to prevent limiting the max idle time
+  maxIdleTime: 2000
+  
+  # The surrounding frame box
+  # The `type` can be null, window, floating, or solid`
+  # To hide the title use the value null
+  # Don't forget to add a backgroundColor style with a null as type
+  frameBox:
+    type: floating
+    title: Terminalizer
+    style:
+      border: 0px black solid
+      # boxShadow: none
+      # margin: 0px
+  
+  # Add a watermark image to the rendered gif
+  # You need to specify an absolute path for
+  # the image on your machine or a URL, and you can also
+  # add your own CSS styles
+  watermark:
+    imagePath: null
+    style:
+      position: absolute
+      right: 15px
+      bottom: 15px
+      width: 100px
+      opacity: 0.9
+  
+  # Cursor style can be one of
+  # `block`, `underline`, or `bar`
+  cursorStyle: block
+  
+  # Font family
+  # You can use any font that is installed on your machine
+  # in CSS-like syntax
+  fontFamily: "Monaco, Lucida Console, Ubuntu Mono, Monospace"
+  
+  # The size of the font
+  fontSize: 12
+  
+  # The height of lines
+  lineHeight: 1
+  
+  # The spacing between letters
+  letterSpacing: 0
+  
+  # Theme
+  theme:
+    background: "transparent"
+    foreground: "#afafaf"
+    cursor: "#c7c7c7"
+    black: "#232628"
+    red: "#fc4384"
+    green: "#b3e33b"
+    yellow: "#ffa727"
+    blue: "#75dff2"
+    magenta: "#ae89fe"
+    cyan: "#708387"
+    white: "#d5d5d0"
+    brightBlack: "#626566"
+    brightRed: "#ff7fac"
+    brightGreen: "#c8ed71"
+    brightYellow: "#ebdf86"
+    brightBlue: "#75dff2"
+    brightMagenta: "#ae89fe"
+    brightCyan: "#b1c6ca"
+    brightWhite: "#f9f9f4"
+  
+# Records, feel free to edit them
+records:
+  - delay: 436
+    content: "\e[1m\e[7m%\e[27m\e[1m\e[0m                                                                                                          \r \r\e]2;bee@beehive:~/Documents/RustScan\a\e]1;..ents/RustScan\a"
+  - delay: 162
+    content: "\r\e[0m\e[27m\e[24m\e[J\r\n\e[1m\e[0m\e[1m\e[36mRustScan\e[0m\e[36m\e[39m\e[1m \e[0m\e[1mon \e[0m\e[1m\e[37m\e[1m\e[37m\e[0m\e[37m\e[1m\e[37m\e[35m master\e[0m\e[35m\e[39m\e[1m\e[0m\e[1m\e[0m\e[1m\e[31m [?]\e[0m\e[31m\e[39m\e[1m\e[0m\e[0m\e[39m\e[1m \e[0m\e[1mis \e[0m\e[1m\e[31m\U0001F4E6 vrustscan:1.10.0\e[0m\e[31m\e[39m\e[1m \e[0m\e[1mvia \e[0m\e[1m\e[31m\U0001D5E5 v1.46.0\e[0m\e[31m\e[39m\e[1m \e[0m\r\n\e[1m\e[0m\e[1m\e[32m➜ \e[0m\e[32m\e[39m\e[1m\e[0m\e[K\e[?1h\e=\e[?2004h"
+  - delay: 471
+    content: "r\brustscan 127.0.0.1 --accessible --no-nmap --ulimit 5000\e[55D\e[7mr\e[7mu\e[7ms\e[7mt\e[7ms\e[7mc\e[7ma\e[7mn\e[7m \e[7m1\e[7m2\e[7m7\e[7m.\e[7m0\e[7m.\e[7m0\e[7m.\e[7m1\e[7m \e[7m-\e[7m-\e[7ma\e[7mc\e[7mc\e[7me\e[7ms\e[7ms\e[7mi\e[7mb\e[7ml\e[7me\e[7m \e[7m-\e[7m-\e[7mn\e[7mo\e[7m-\e[7mn\e[7mm\e[7ma\e[7mp\e[7m \e[7m-\e[7m-\e[7mu\e[7ml\e[7mi\e[7mm\e[7mi\e[7mt\e[7m \e[7m5\e[7m0\e[7m0\e[7m0\e[27m"
+  - delay: 269
+    content: "\e[55D\e[27mr\e[27mu\e[27ms\e[27mt\e[27ms\e[27mc\e[27ma\e[27mn\e[27m \e[27m1\e[27m2\e[27m7\e[27m.\e[27m0\e[27m.\e[27m0\e[27m.\e[27m1\e[27m \e[27m-\e[27m-\e[27ma\e[27mc\e[27mc\e[27me\e[27ms\e[27ms\e[27mi\e[27mb\e[27ml\e[27me\e[27m \e[27m-\e[27m-\e[27mn\e[27mo\e[27m-\e[27mn\e[27mm\e[27ma\e[27mp\e[27m \e[27m-\e[27m-\e[27mu\e[27ml\e[27mi\e[27mm\e[27mi\e[27mt\e[27m \e[27m5\e[27m0\e[27m0\e[27m0\e[?1l\e>\e[?2004l\r\r\n\e]2;rustscan 127.0.0.1 --accessible --no-nmap --ulimit 5000\a\e]1;rustscan\aAutomatically increasing ulimit value to 5000.\r\n"
+  - delay: 1536
+    content: "Open 127.0.0.1:38602\r\n"
+  - delay: 395
+    content: "Open 127.0.0.1:50078\r\n"
+  - delay: 450
+    content: "127.0.0.1 -> [38602,50078]\r\n\e[1m\e[7m%\e[27m\e[1m\e[0m                                                                                                          \r \r\e]2;bee@beehive:~/Documents/RustScan\a\e]1;..ents/RustScan\a"
+  - delay: 143
+    content: "\r\e[0m\e[27m\e[24m\e[J\r\n\e[1m\e[0m\e[1m\e[36mRustScan\e[0m\e[36m\e[39m\e[1m \e[0m\e[1mon \e[0m\e[1m\e[37m\e[1m\e[37m\e[0m\e[37m\e[1m\e[37m\e[35m master\e[0m\e[35m\e[39m\e[1m\e[0m\e[1m\e[0m\e[1m\e[31m [?]\e[0m\e[31m\e[39m\e[1m\e[0m\e[0m\e[39m\e[1m \e[0m\e[1mis \e[0m\e[1m\e[31m\U0001F4E6 vrustscan:1.10.0\e[0m\e[31m\e[39m\e[1m \e[0m\e[1mvia \e[0m\e[1m\e[31m\U0001D5E5 v1.46.0\e[0m\e[31m\e[39m\e[1m \e[0m\e[1mtook \e[0m\e[1m\e[33m2s\e[0m\e[33m\e[39m\e[1m \e[0m\r\n\e[1m\e[0m\e[1m\e[32m➜ \e[0m\e[32m\e[39m\e[1m\e[0m\e[K\e[?1h\e=\e[?2004h"
+  - delay: 563
+    content: "\e[?2004l\r\r\n"

release.sh

@@ -0,0 +1 @@
+cargo publish && cargo build --release && git add Cargo.lock && git commit -m 'Updating lock file' && gpsup

rustscan-debbuilder/Dockerfile

@@ -1,20 +0,0 @@
-FROM rust:latest
-
-RUN git clone https://github.com/brandonskerritt/RustScan
-WORKDIR "/RustScan"
-RUN git pull --force
-RUN cargo install cargo-deb
-
-RUN apt update -y && apt upgrade -y
-RUN apt install libc6-dev-i386 -y
-RUN git clone --depth=1 https://github.com/raspberrypi/tools /raspberrypi-tools
-ENV PATH=/raspberrypi-tools/arm-bcm2708/gcc-linaro-arm-linux-gnueabihf-raspbian-x64/bin/:$PATH
-ENV CARGO_TARGET_ARM_UNKNOWN_LINUX_GNUEABIHF_LINKER=arm-linux-gnueabihf-gcc
-RUN mkdir /root/.cargo
-RUN echo "[target.arm-unknown-linux-gnueabihf]" >> /root/.cargo/config
-RUN echo "strip = { path = \"arm-linux-gnueabihf-strip\" }" >> /root/.cargo/config
-RUN echo "objcopy = { path = \"arm-linux-gnueabihf-objcopy\" }" >> /root/.cargo/config
-
-COPY ./entrypoint.sh /entrypoint.sh
-RUN chmod +x /entrypoint.sh
-ENTRYPOINT ["/entrypoint.sh"]

rustscan-debbuilder/entrypoint.sh

@@ -1,17 +0,0 @@
-#!/bin/bash
-
-cd /RustScan
-git pull --force
-
-#amd64
-cargo deb
-
-#arm64
-rustup target add arm-unknown-linux-gnueabihf
-cargo deb --target=arm-unknown-linux-gnueabihf
-
-#i386
-rustup target add i686-unknown-linux-gnu
-cargo deb --target=i686-unknown-linux-gnu
-
-find target/ -name \*.deb -exec cp {} /debs \;

rustscan-debbuilder/run.sh

@@ -1,8 +0,0 @@
-#!/bin/bash
-docker build -t rustscan-builder . || exit
-
-# This creates a volume which binds your currentdirectory/debs to 
-# the location where the deb files get spat out in the container.
-# You don't need to worry about it. Just chmod +x run.sh && ./run.sh and
-# you'll get yer .deb file in a few minutes. It runs faster after you've used it the first time.
-docker run -v "$(pwd)/debs:/debs" rustscan-builder

src/address.rs

@@ -0,0 +1,345 @@
+//! Provides functions to parse input IP addresses, CIDRs or files.
+use std::collections::BTreeSet;
+use std::fs::{self, File};
+use std::io::{prelude::*, BufReader};
+use std::net::{IpAddr, SocketAddr, ToSocketAddrs};
+use std::path::Path;
+use std::str::FromStr;
+
+use cidr_utils::cidr::{IpCidr, IpInet};
+use hickory_resolver::{
+    config::{NameServerConfig, Protocol, ResolverConfig, ResolverOpts},
+    Resolver,
+};
+use log::debug;
+
+use crate::input::Opts;
+use crate::warning;
+
+/// Parses the string(s) into IP addresses.
+///
+/// Goes through all possible IP inputs (files or via argparsing).
+///
+/// ```rust
+/// # use rustscan::input::Opts;
+/// # use rustscan::address::parse_addresses;
+/// let mut opts = Opts::default();
+/// opts.addresses = vec!["192.168.0.0/30".to_owned()];
+///
+/// let ips = parse_addresses(&opts);
+/// ```
+///
+/// Finally, any duplicates are removed to avoid excessive scans.
+pub fn parse_addresses(input: &Opts) -> Vec<IpAddr> {
+    let mut ips: Vec<IpAddr> = Vec::new();
+    let mut unresolved_addresses: Vec<&str> = Vec::new();
+    let backup_resolver = get_resolver(&input.resolver);
+
+    for address in &input.addresses {
+        let parsed_ips = parse_address(address, &backup_resolver);
+        if !parsed_ips.is_empty() {
+            ips.extend(parsed_ips);
+        } else {
+            unresolved_addresses.push(address);
+        }
+    }
+
+    // If we got to this point this can only be a file path or the wrong input.
+    for file_path in unresolved_addresses {
+        let file_path = Path::new(file_path);
+
+        if !file_path.is_file() {
+            warning!(
+                format!("Host {file_path:?} could not be resolved."),
+                input.greppable,
+                input.accessible
+            );
+
+            continue;
+        }
+
+        if let Ok(x) = read_ips_from_file(file_path, &backup_resolver) {
+            ips.extend(x);
+        } else {
+            warning!(
+                format!("Host {file_path:?} could not be resolved."),
+                input.greppable,
+                input.accessible
+            );
+        }
+    }
+
+    let excluded_cidrs = parse_excluded_networks(&input.exclude_addresses, &backup_resolver);
+
+    // Remove duplicated/excluded IPs.
+    let mut seen = BTreeSet::new();
+    ips.retain(|ip| seen.insert(*ip) && !excluded_cidrs.iter().any(|cidr| cidr.contains(ip)));
+
+    ips
+}
+
+/// Given a string, parse it as a host, IP address, or CIDR.
+///
+/// This allows us to pass files as hosts or cidr or IPs easily
+/// Call this every time you have a possible IP-or-host.
+///
+/// If the address is a domain, we can self-resolve the domain locally
+/// or resolve it by dns resolver list.
+///
+/// ```rust
+/// # use rustscan::address::parse_address;
+/// # use hickory_resolver::Resolver;
+/// let ips = parse_address("127.0.0.1", &Resolver::default().unwrap());
+/// ```
+pub fn parse_address(address: &str, resolver: &Resolver) -> Vec<IpAddr> {
+    if let Ok(addr) = IpAddr::from_str(address) {
+        // `address` is an IP string
+        vec![addr]
+    } else if let Ok(net_addr) = IpInet::from_str(address) {
+        // `address` is a CIDR string
+        net_addr.network().into_iter().addresses().collect()
+    } else {
+        // `address` is a hostname or DNS name
+        // attempt default DNS lookup
+        match format!("{address}:80").to_socket_addrs() {
+            Ok(mut iter) => vec![iter.next().unwrap().ip()],
+            // default lookup didn't work, so try again with the dedicated resolver
+            Err(_) => resolve_ips_from_host(address, resolver),
+        }
+    }
+}
+
+/// Uses DNS to get the IPS associated with host
+fn resolve_ips_from_host(source: &str, backup_resolver: &Resolver) -> Vec<IpAddr> {
+    let mut ips: Vec<IpAddr> = Vec::new();
+
+    if let Ok(addrs) = source.to_socket_addrs() {
+        for ip in addrs {
+            ips.push(ip.ip());
+        }
+    } else if let Ok(addrs) = backup_resolver.lookup_ip(source) {
+        ips.extend(addrs.iter());
+    }
+
+    ips
+}
+
+/// Parses excluded networks from a list of addresses.
+///
+/// This function handles three types of inputs:
+/// 1. CIDR notation (e.g. "192.168.0.0/24")
+/// 2. Single IP addresses (e.g. "192.168.0.1")
+/// 3. Hostnames that need to be resolved (e.g. "example.com")
+///
+/// ```rust
+/// # use rustscan::address::parse_excluded_networks;
+/// # use hickory_resolver::Resolver;
+/// let resolver = Resolver::default().unwrap();
+/// let excluded = parse_excluded_networks(&Some(vec!["192.168.0.0/24".to_owned()]), &resolver);
+/// ```
+pub fn parse_excluded_networks(
+    exclude_addresses: &Option<Vec<String>>,
+    resolver: &Resolver,
+) -> Vec<IpCidr> {
+    exclude_addresses
+        .iter()
+        .flatten()
+        .flat_map(|addr| parse_single_excluded_address(addr, resolver))
+        .collect()
+}
+
+/// Parses a single address into an IpCidr, handling CIDR notation, IP addresses, and hostnames.
+fn parse_single_excluded_address(addr: &str, resolver: &Resolver) -> Vec<IpCidr> {
+    if let Ok(cidr) = IpCidr::from_str(addr) {
+        return vec![cidr];
+    }
+
+    if let Ok(ip) = IpAddr::from_str(addr) {
+        return vec![IpCidr::new_host(ip)];
+    }
+
+    resolve_ips_from_host(addr, resolver)
+        .into_iter()
+        .map(IpCidr::new_host)
+        .collect()
+}
+
+/// Derive a DNS resolver.
+///
+/// 1. if the `resolver` parameter has been set:
+///     1. assume the parameter is a path and attempt to read IPs.
+///     2. parse the input as a comma-separated list of IPs.
+/// 2. if `resolver` is not set:
+///    1. attempt to derive a resolver from the system config. (e.g.
+///       `/etc/resolv.conf` on *nix).
+///    2. finally, build a CloudFlare-based resolver (default
+///       behaviour).
+fn get_resolver(resolver: &Option<String>) -> Resolver {
+    match resolver {
+        Some(r) => {
+            let mut config = ResolverConfig::new();
+            let resolver_ips = match read_resolver_from_file(r) {
+                Ok(ips) => ips,
+                Err(_) => r
+                    .split(',')
+                    .filter_map(|r| IpAddr::from_str(r).ok())
+                    .collect::<Vec<_>>(),
+            };
+            for ip in resolver_ips {
+                config.add_name_server(NameServerConfig::new(
+                    SocketAddr::new(ip, 53),
+                    Protocol::Udp,
+                ));
+            }
+            Resolver::new(config, ResolverOpts::default()).unwrap()
+        }
+        None => match Resolver::from_system_conf() {
+            Ok(resolver) => resolver,
+            Err(_) => {
+                Resolver::new(ResolverConfig::cloudflare_tls(), ResolverOpts::default()).unwrap()
+            }
+        },
+    }
+}
+
+/// Parses and input file of IPs for use in DNS resolution.
+fn read_resolver_from_file(path: &str) -> Result<Vec<IpAddr>, std::io::Error> {
+    let ips = fs::read_to_string(path)?
+        .lines()
+        .filter_map(|line| IpAddr::from_str(line.trim()).ok())
+        .collect();
+
+    Ok(ips)
+}
+
+#[cfg(not(tarpaulin_include))]
+/// Parses an input file of IPs and uses those
+fn read_ips_from_file(
+    ips: &std::path::Path,
+    backup_resolver: &Resolver,
+) -> Result<Vec<IpAddr>, std::io::Error> {
+    let file = File::open(ips)?;
+    let reader = BufReader::new(file);
+
+    let mut ips: Vec<IpAddr> = Vec::new();
+
+    for address_line in reader.lines() {
+        if let Ok(address) = address_line {
+            ips.extend(parse_address(&address, backup_resolver));
+        } else {
+            debug!("Line in file is not valid");
+        }
+    }
+
+    Ok(ips)
+}
+
+#[cfg(test)]
+mod tests {
+    use super::{parse_addresses, Opts};
+    use std::net::Ipv4Addr;
+
+    #[test]
+    fn parse_correct_addresses() {
+        let opts = Opts {
+            addresses: vec!["127.0.0.1".to_owned(), "192.168.0.0/30".to_owned()],
+            ..Default::default()
+        };
+
+        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_addresses_with_address_exclusions() {
+        let opts = Opts {
+            addresses: vec!["192.168.0.0/30".to_owned()],
+            exclude_addresses: Some(vec!["192.168.0.1".to_owned()]),
+            ..Default::default()
+        };
+        let ips = parse_addresses(&opts);
+
+        assert_eq!(
+            ips,
+            [
+                Ipv4Addr::new(192, 168, 0, 0),
+                Ipv4Addr::new(192, 168, 0, 2),
+                Ipv4Addr::new(192, 168, 0, 3)
+            ]
+        );
+    }
+
+    #[test]
+    fn parse_addresses_with_cidr_exclusions() {
+        let opts = Opts {
+            addresses: vec!["192.168.0.0/29".to_owned()],
+            exclude_addresses: Some(vec!["192.168.0.0/30".to_owned()]),
+            ..Default::default()
+        };
+        let ips = parse_addresses(&opts);
+
+        assert_eq!(
+            ips,
+            [
+                Ipv4Addr::new(192, 168, 0, 4),
+                Ipv4Addr::new(192, 168, 0, 5),
+                Ipv4Addr::new(192, 168, 0, 6),
+                Ipv4Addr::new(192, 168, 0, 7),
+            ]
+        );
+    }
+
+    #[test]
+    fn parse_addresses_with_incorrect_address_exclusions() {
+        let opts = Opts {
+            addresses: vec!["192.168.0.0/30".to_owned()],
+            exclude_addresses: Some(vec!["192.168.0.1".to_owned()]),
+            ..Default::default()
+        };
+        let ips = parse_addresses(&opts);
+
+        assert_eq!(
+            ips,
+            [
+                Ipv4Addr::new(192, 168, 0, 0),
+                Ipv4Addr::new(192, 168, 0, 2),
+                Ipv4Addr::new(192, 168, 0, 3)
+            ]
+        );
+    }
+
+    #[test]
+    fn parse_duplicate_cidrs() {
+        let opts = Opts {
+            addresses: vec!["79.98.104.0/21".to_owned(), "79.98.104.0/24".to_owned()],
+            ..Default::default()
+        };
+
+        let ips = parse_addresses(&opts);
+
+        assert_eq!(ips.len(), 2_048);
+    }
+
+    #[test]
+    fn parse_overspecific_cidr() {
+        // a canonical CIDR string has 0 in all host bits, but we want to treat any CIDR-like string as CIDR
+        let opts = Opts {
+            addresses: vec!["192.128.1.1/24".to_owned()],
+            ..Default::default()
+        };
+
+        let ips = parse_addresses(&opts);
+
+        assert_eq!(ips.len(), 256);
+    }
+}

src/benchmark/mod.rs

@@ -0,0 +1,92 @@
+//! Provides functionality to capture timing information for scans.
+//!
+//! # Usage
+//!
+//! ```rust
+//! // Initiate Benchmark vector
+//! # use rustscan::benchmark::{Benchmark, NamedTimer};
+//! # use log::info;
+//! let mut bm = Benchmark::init();
+//! // Start named timer with name
+//! let mut example_bench = NamedTimer::start("Example Bench");
+//! // Stop named timer
+//! example_bench.end();
+//! // Add named timer to Benchmarks
+//! bm.push(example_bench);
+//! // Print Benchmark Summary
+//! info!("{}", bm.summary());
+//! ```
+use std::time::Instant;
+
+/// A Benchmark struct to hold NamedTimers with name, start and end Instants,
+#[derive(Debug)]
+pub struct Benchmark {
+    named_timers: Vec<NamedTimer>,
+}
+
+impl Benchmark {
+    pub fn init() -> Self {
+        Self {
+            named_timers: Vec::new(),
+        }
+    }
+    pub fn push(&mut self, timer: NamedTimer) {
+        self.named_timers.push(timer);
+    }
+
+    /// Summary of the benchmarks will destruct the vector,
+    /// formats every element the same way and return
+    /// a single String with all the available information
+    /// for easy printing
+    pub fn summary(&self) -> String {
+        let mut summary = String::from("\nRustScan Benchmark Summary");
+
+        for timer in &self.named_timers {
+            if let Some(start) = timer.start {
+                if let Some(end) = timer.end {
+                    let runtime_secs = end.saturating_duration_since(start).as_secs_f32();
+                    summary.push_str(&format!("\n{0: <10} | {1: <10}s", timer.name, runtime_secs));
+                }
+            }
+        }
+        summary
+    }
+}
+
+/// The purpose of NamedTimer is to hold a name,
+/// start Instant and end Instant for a specific timer.
+/// The given name will be presented in the benchmark summary,
+/// start and end Instants will be used for calculating runtime.
+#[derive(Debug)]
+pub struct NamedTimer {
+    name: &'static str,
+    start: Option<Instant>,
+    end: Option<Instant>,
+}
+
+impl NamedTimer {
+    pub fn start(name: &'static str) -> Self {
+        Self {
+            name,
+            start: Some(Instant::now()),
+            end: None,
+        }
+    }
+    pub fn end(&mut self) {
+        self.end = Some(Instant::now());
+    }
+}
+
+#[test]
+fn benchmark() {
+    let mut benchmarks = Benchmark::init();
+    let mut test_timer = NamedTimer::start("test");
+    std::thread::sleep(std::time::Duration::from_millis(100));
+    test_timer.end();
+    benchmarks.push(test_timer);
+    benchmarks.push(NamedTimer::start("only_start"));
+    assert!(benchmarks
+        .summary()
+        .contains("\nRustScan Benchmark Summary\ntest       | 0."));
+    assert!(!benchmarks.summary().contains("only_start"));
+}

src/input.rs

@@ -0,0 +1,446 @@
+//! Provides a means to read, parse and hold configuration options for scans.
+use clap::{Parser, ValueEnum};
+use serde_derive::Deserialize;
+use std::fs;
+use std::path::PathBuf;
+
+const LOWEST_PORT_NUMBER: u16 = 1;
+const TOP_PORT_NUMBER: u16 = 65535;
+
+/// 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, ValueEnum, Clone, Copy, PartialEq, Eq)]
+pub enum ScanOrder {
+    Serial,
+    Random,
+}
+
+/// Represents the scripts variant.
+///   - none will avoid running any script, only portscan results will be shown.
+///   - default will run the default embedded nmap script, that's part of RustScan since the beginning.
+///   - custom will read the ScriptConfig file and the available scripts in the predefined folders
+#[derive(Deserialize, Debug, ValueEnum, Clone, PartialEq, Eq, Copy)]
+pub enum ScriptsRequired {
+    None,
+    Default,
+    Custom,
+}
+
+/// Represents the range of ports to be scanned.
+#[derive(Deserialize, Debug, Clone, PartialEq, Eq)]
+pub struct PortRange {
+    pub start: u16,
+    pub end: u16,
+}
+
+#[cfg(not(tarpaulin_include))]
+fn parse_range(input: &str) -> Result<PortRange, String> {
+    let range = input
+        .split('-')
+        .map(str::parse)
+        .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(Parser, Debug, Clone)]
+#[command(
+    name = "rustscan",
+    version = env!("CARGO_PKG_VERSION"),
+    max_term_width = 120,
+    help_template = "{bin} {version}\n{about}\n\nUSAGE:\n    {usage}\n\nOPTIONS:\n{options}",
+)]
+#[allow(clippy::struct_excessive_bools)]
+/// 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  <http://discord.skerritt.blog>
+/// - GitHub <https://github.com/RustScan/RustScan>
+pub struct Opts {
+    /// A comma-delimited list or newline-delimited file of separated CIDRs, IPs, or hosts to be scanned.
+    #[arg(short, long, value_delimiter = ',')]
+    pub addresses: Vec<String>,
+
+    /// A list of comma separated ports to be scanned. Example: 80,443,8080.
+    #[arg(short, long, value_delimiter = ',')]
+    pub ports: Option<Vec<u16>>,
+
+    /// A range of ports with format start-end. Example: 1-1000.
+    #[arg(short, long, conflicts_with = "ports", value_parser = parse_range)]
+    pub range: Option<PortRange>,
+
+    /// Whether to ignore the configuration file or not.
+    #[arg(short, long)]
+    pub no_config: bool,
+
+    /// Hide the banner
+    #[arg(long)]
+    pub no_banner: bool,
+
+    /// Custom path to config file
+    #[arg(short, long, value_parser)]
+    pub config_path: Option<PathBuf>,
+
+    /// Greppable mode. Only output the ports. No Nmap. Useful for grep or outputting to a file.
+    #[arg(short, long)]
+    pub greppable: bool,
+
+    /// Accessible mode. Turns off features which negatively affect screen readers.
+    #[arg(long)]
+    pub accessible: bool,
+
+    /// A comma-delimited list or file of DNS resolvers.
+    #[arg(long)]
+    pub resolver: Option<String>,
+
+    /// 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.
+    #[arg(short, long, default_value = "4500")]
+    pub batch_size: usize,
+
+    /// The timeout in milliseconds before a port is assumed to be closed.
+    #[arg(short, long, default_value = "1500")]
+    pub timeout: u32,
+
+    /// The number of tries before a port is assumed to be closed.
+    /// If set to 0, rustscan will correct it to 1.
+    #[arg(long, default_value = "1")]
+    pub tries: u8,
+
+    /// Automatically ups the ULIMIT with the value you provided.
+    #[arg(short, long)]
+    pub ulimit: Option<usize>,
+
+    /// The order of scanning to be performed. The "serial" option will
+    /// scan ports in ascending order while the "random" option will scan
+    /// ports randomly.
+    #[arg(long, value_enum, ignore_case = true, default_value = "serial")]
+    pub scan_order: ScanOrder,
+
+    /// Level of scripting required for the run.
+    #[arg(long, value_enum, ignore_case = true, default_value = "default")]
+    pub scripts: ScriptsRequired,
+
+    /// Use the top 1000 ports.
+    #[arg(long)]
+    pub top: bool,
+
+    /// The Script arguments to run.
+    /// To use the argument -A, end RustScan's args with '-- -A'.
+    /// Example: 'rustscan -t 1500 -a 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)'\"
+    #[arg(last = true)]
+    pub command: Vec<String>,
+
+    /// A list of comma separated ports to be excluded from scanning. Example: 80,443,8080.
+    #[arg(short, long, value_delimiter = ',')]
+    pub exclude_ports: Option<Vec<u16>>,
+
+    /// A list of comma separated CIDRs, IPs, or hosts to be excluded from scanning.
+    #[arg(short = 'x', long = "exclude-addresses", value_delimiter = ',')]
+    pub exclude_addresses: Option<Vec<String>>,
+
+    /// UDP scanning mode, finds UDP ports that send back responses
+    #[arg(long)]
+    pub udp: bool,
+}
+
+#[cfg(not(tarpaulin_include))]
+impl Opts {
+    pub fn read() -> Self {
+        let mut opts = Opts::parse();
+
+        if opts.ports.is_none() && opts.range.is_none() {
+            opts.range = Some(PortRange {
+                start: LOWEST_PORT_NUMBER,
+                end: TOP_PORT_NUMBER,
+            });
+        }
+
+        opts
+    }
+
+    /// Reads the command line arguments into an Opts struct and merge
+    /// values found within the user configuration file.
+    pub fn merge(&mut self, config: &Config) {
+        if !self.no_config {
+            self.merge_required(config);
+            self.merge_optional(config);
+        }
+    }
+
+    fn merge_required(&mut self, config: &Config) {
+        macro_rules! merge_required {
+            ($($field: ident),+) => {
+                $(
+                    if let Some(e) = &config.$field {
+                        self.$field = e.clone();
+                    }
+                )+
+            }
+        }
+
+        merge_required!(
+            addresses, greppable, accessible, batch_size, timeout, tries, scan_order, scripts,
+            command, udp, no_banner
+        );
+    }
+
+    fn merge_optional(&mut self, config: &Config) {
+        macro_rules! merge_optional {
+            ($($field: ident),+) => {
+                $(
+                    if config.$field.is_some() {
+                        self.$field = config.$field.clone();
+                    }
+                )+
+            }
+        }
+
+        // Only use top ports when the user asks for them
+        if self.top && config.ports.is_some() {
+            self.ports = config.ports.clone();
+        }
+
+        merge_optional!(range, resolver, ulimit, exclude_ports, exclude_addresses);
+    }
+}
+
+impl Default for Opts {
+    fn default() -> Self {
+        Self {
+            addresses: vec![],
+            ports: None,
+            range: None,
+            greppable: true,
+            batch_size: 0,
+            timeout: 0,
+            tries: 0,
+            ulimit: None,
+            command: vec![],
+            accessible: false,
+            resolver: None,
+            scan_order: ScanOrder::Serial,
+            no_config: true,
+            no_banner: false,
+            top: false,
+            scripts: ScriptsRequired::Default,
+            config_path: None,
+            exclude_ports: None,
+            exclude_addresses: None,
+            udp: false,
+        }
+    }
+}
+
+/// Struct used to deserialize the options specified within our config file.
+/// These will be further merged with our command line arguments in order to
+/// generate the final Opts struct.
+#[cfg(not(tarpaulin_include))]
+#[derive(Debug, Deserialize)]
+pub struct Config {
+    addresses: Option<Vec<String>>,
+    ports: Option<Vec<u16>>,
+    range: Option<PortRange>,
+    greppable: Option<bool>,
+    accessible: Option<bool>,
+    batch_size: Option<usize>,
+    timeout: Option<u32>,
+    tries: Option<u8>,
+    ulimit: Option<usize>,
+    resolver: Option<String>,
+    scan_order: Option<ScanOrder>,
+    command: Option<Vec<String>>,
+    scripts: Option<ScriptsRequired>,
+    exclude_ports: Option<Vec<u16>>,
+    exclude_addresses: Option<Vec<String>>,
+    udp: Option<bool>,
+    no_banner: Option<bool>,
+}
+
+#[cfg(not(tarpaulin_include))]
+#[allow(clippy::doc_link_with_quotes)]
+#[allow(clippy::manual_unwrap_or_default)]
+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]
+    /// greppable = true
+    /// scan_order = "Serial"
+    /// exclude_ports = [8080, 9090, 80]
+    /// udp = false
+    ///
+    pub fn read(custom_config_path: Option<PathBuf>) -> Self {
+        let mut content = String::new();
+        let config_path = custom_config_path.unwrap_or_else(|| {
+            let path = default_config_path();
+            match path.exists() {
+                true => path,
+                false => old_default_config_path(),
+            }
+        });
+
+        if config_path.exists() {
+            content = match fs::read_to_string(config_path) {
+                Ok(content) => content,
+                Err(_) => String::new(),
+            }
+        }
+
+        let config: Config = match toml::from_str(&content) {
+            Ok(config) => config,
+            Err(e) => {
+                println!("Found {e} in configuration file.\nAborting scan.\n");
+                std::process::exit(1);
+            }
+        };
+
+        config
+    }
+}
+
+/// Constructs default path to config toml
+pub fn default_config_path() -> PathBuf {
+    let Some(mut config_path) = dirs::config_dir() else {
+        panic!("Could not infer config file path.");
+    };
+    config_path.push(".rustscan.toml");
+    config_path
+}
+
+/// Returns the deprecated home directory config path used for backwards compatibility.
+pub fn old_default_config_path() -> PathBuf {
+    let Some(mut config_path) = dirs::home_dir() else {
+        panic!("Could not infer config file path.");
+    };
+    config_path.push(".rustscan.toml");
+    config_path
+}
+
+#[cfg(test)]
+mod tests {
+    use clap::{CommandFactory, Parser};
+    use parameterized::parameterized;
+
+    use super::{Config, Opts, PortRange, ScanOrder, ScriptsRequired};
+
+    impl Config {
+        fn default() -> Self {
+            Self {
+                addresses: Some(vec!["127.0.0.1".to_owned()]),
+                ports: None,
+                range: None,
+                greppable: Some(true),
+                batch_size: Some(25_000),
+                timeout: Some(1_000),
+                tries: Some(1),
+                ulimit: None,
+                command: Some(vec!["-A".to_owned()]),
+                accessible: Some(true),
+                resolver: None,
+                scan_order: Some(ScanOrder::Random),
+                scripts: None,
+                exclude_ports: None,
+                exclude_addresses: None,
+                udp: Some(false),
+                no_banner: None,
+            }
+        }
+    }
+
+    #[test]
+    fn verify_cli() {
+        Opts::command().debug_assert();
+    }
+
+    #[parameterized(input = {
+        vec!["rustscan", "--addresses", "127.0.0.1"],
+        vec!["rustscan", "--addresses", "127.0.0.1", "--", "-sCV"],
+        vec!["rustscan", "--addresses", "127.0.0.1", "--", "-A"],
+        vec!["rustscan", "-t", "1500", "-a", "127.0.0.1", "--", "-A", "-sC"],
+        vec!["rustscan", "--addresses", "127.0.0.1", "--", "--script", r#""'(safe and vuln)'""#],
+    }, command = {
+        vec![],
+        vec!["-sCV".to_owned()],
+        vec!["-A".to_owned()],
+        vec!["-A".to_owned(), "-sC".to_owned()],
+        vec!["--script".to_owned(), "\"'(safe and vuln)'\"".to_owned()],
+    })]
+    fn parse_trailing_command(input: Vec<&str>, command: Vec<String>) {
+        let opts = Opts::parse_from(input);
+
+        assert_eq!(vec!["127.0.0.1".to_owned()], opts.addresses);
+        assert_eq!(command, opts.command);
+    }
+
+    #[test]
+    fn opts_no_merge_when_config_is_ignored() {
+        let mut opts = Opts::default();
+        let config = Config::default();
+
+        opts.merge(&config);
+
+        assert_eq!(opts.addresses, vec![] as Vec<String>);
+        assert!(opts.greppable);
+        assert!(!opts.accessible);
+        assert_eq!(opts.timeout, 0);
+        assert_eq!(opts.command, vec![] as Vec<String>);
+        assert_eq!(opts.scan_order, ScanOrder::Serial);
+    }
+
+    #[test]
+    fn opts_merge_required_arguments() {
+        let mut opts = Opts::default();
+        let config = Config::default();
+
+        opts.merge_required(&config);
+
+        assert_eq!(opts.addresses, config.addresses.unwrap());
+        assert_eq!(opts.greppable, config.greppable.unwrap());
+        assert_eq!(opts.timeout, config.timeout.unwrap());
+        assert_eq!(opts.command, config.command.unwrap());
+        assert_eq!(opts.accessible, config.accessible.unwrap());
+        assert_eq!(opts.scan_order, config.scan_order.unwrap());
+        assert_eq!(opts.scripts, ScriptsRequired::Default);
+    }
+
+    #[test]
+    fn opts_merge_optional_arguments() {
+        let mut opts = Opts::default();
+        let mut config = Config::default();
+        config.range = Some(PortRange {
+            start: 1,
+            end: 1_000,
+        });
+        config.ulimit = Some(1_000);
+        config.resolver = Some("1.1.1.1".to_owned());
+
+        opts.merge_optional(&config);
+
+        assert_eq!(opts.range, config.range);
+        assert_eq!(opts.ulimit, config.ulimit);
+        assert_eq!(opts.resolver, config.resolver);
+    }
+}

src/lib.rs

@@ -0,0 +1,60 @@
+//! This crate exposes the internal functionality of the
+//! [RustScan](https://rustscan.github.io/RustScan) port scanner.
+//!
+//! ## Example: perform a scan against localhost
+//!
+//! The core scanning behaviour is managed by
+//! [`Scanner`](crate::scanner::Scanner) which in turn requires a
+//! [`PortStrategy`](crate::port_strategy::PortStrategy):
+//!
+//! This example is compiled but never executed by the test suite.
+//!
+//! ```no_run
+//! use async_std::task::block_on;
+//! use std::{net::IpAddr, time::Duration};
+//!
+//! use rustscan::input::{PortRange, ScanOrder};
+//! use rustscan::port_strategy::PortStrategy;
+//! use rustscan::scanner::Scanner;
+//!
+//! fn main() {
+//!     let addrs = vec!["127.0.0.1".parse::<IpAddr>().unwrap()];
+//!     let range = PortRange {
+//!         start: 1,
+//!         end: 1_000,
+//!     };
+//!     let strategy = PortStrategy::pick(&Some(range), None, ScanOrder::Random); // can be serial, random or manual https://github.com/RustScan/RustScan/blob/master/src/port_strategy/mod.rs
+//!     let scanner = Scanner::new(
+//!         &addrs, // the addresses to scan
+//!         10, // batch_size is how many ports at a time should be scanned
+//!         Duration::from_millis(100), //T imeout is the time RustScan should wait before declaring a port closed. As datatype Duration.
+//!         1, // Tries, how many retries should RustScan do?
+//!         true, // greppable is whether or not RustScan should print things, or wait until the end to print only the ip
+//!         strategy, // the port strategy used
+//!         true, // accessible, should the output be A11Y compliant?
+//!         vec![9000], // What ports should RustScan exclude?
+//!         false, // is this a UDP scan?
+//!     );
+//!
+//!     let scan_result = block_on(scanner.run());
+//!
+//!     println!("{:?}", scan_result);
+//! }
+//! ```
+#![allow(clippy::needless_doctest_main)]
+
+pub mod tui;
+
+pub mod input;
+
+pub mod scanner;
+
+pub mod port_strategy;
+
+pub mod benchmark;
+
+pub mod scripts;
+
+pub mod address;
+
+pub mod generated;

src/main.rs

@@ -1,120 +1,106 @@
-extern crate shell_words;
+#![deny(clippy::all)]
+#![warn(clippy::pedantic)]
+#![allow(clippy::doc_markdown, clippy::if_not_else, clippy::non_ascii_literal)]
 
-mod tui;
+use rustscan::benchmark::{Benchmark, NamedTimer};
+use rustscan::input::{self, Config, Opts, ScriptsRequired};
+use rustscan::port_strategy::PortStrategy;
+use rustscan::scanner::Scanner;
+use rustscan::scripts::{init_scripts, Script, ScriptFile};
+use rustscan::{detail, funny_opening, output, warning};
 
-mod scanner;
-use scanner::Scanner;
-
-mod port_strategy;
-use port_strategy::PortStrategy;
-
-use colorful::Color;
-use colorful::Colorful;
+use colorful::{Color, Colorful};
 use futures::executor::block_on;
-use rlimit::Resource;
-use rlimit::{getrlimit, setrlimit};
 use std::collections::HashMap;
-use std::process::Command;
-use std::{net::IpAddr, time::Duration};
-use structopt::{clap::arg_enum, StructOpt};
+use std::net::IpAddr;
+use std::string::ToString;
+use std::time::Duration;
+
+use rustscan::address::parse_addresses;
 
 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;
+#[cfg(unix)]
+const DEFAULT_FILE_DESCRIPTORS_LIMIT: usize = 8000;
 // Safest batch size based on experimentation
-const AVERAGE_BATCH_SIZE: rlimit::rlim = 3000;
+const AVERAGE_BATCH_SIZE: usize = 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))]
+#[allow(clippy::too_many_lines)]
 /// Faster Nmap scanning with Rust
 /// If you're looking for the actual scanning, check out the module Scanner
 fn main() {
+    #[cfg(not(unix))]
+    let _ = ansi_term::enable_ansi_support();
+
     env_logger::init();
+    let mut benchmarks = Benchmark::init();
+    let mut rustscan_bench = NamedTimer::start("RustScan");
 
-    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.config_path.clone());
+    opts.merge(&config);
 
-    if !opts.quiet && !opts.accessible {
-        print_opening();
+    debug!("Main() `opts` arguments are {opts:?}");
+
+    let scripts_to_run: Vec<ScriptFile> = match init_scripts(&opts.scripts) {
+        Ok(scripts_to_run) => scripts_to_run,
+        Err(e) => {
+            warning!(
+                format!("Initiating scripts failed!\n{e}"),
+                opts.greppable,
+                opts.accessible
+            );
+            std::process::exit(1);
+        }
+    };
+
+    debug!("Scripts initialized {scripts_to_run:?}");
+
+    if !opts.greppable && !opts.accessible && !opts.no_banner {
+        print_opening(&opts);
     }
 
-    let ulimit: rlimit::rlim = adjust_ulimit_size(&opts);
-    let batch_size: u16 = infer_batch_size(&opts, ulimit);
+    let ips: Vec<IpAddr> = parse_addresses(&opts);
+
+    if ips.is_empty() {
+        warning!(
+            "No IPs could be resolved, aborting scan.",
+            opts.greppable,
+            opts.accessible
+        );
+        std::process::exit(1);
+    }
+
+    #[cfg(unix)]
+    let batch_size: usize = infer_batch_size(&opts, adjust_ulimit_size(&opts));
+
+    #[cfg(not(unix))]
+    let batch_size: usize = AVERAGE_BATCH_SIZE;
 
     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),
+        opts.tries,
+        opts.greppable,
+        PortStrategy::pick(&opts.range, opts.ports, opts.scan_order),
+        opts.accessible,
+        opts.exclude_ports.unwrap_or_default(),
+        opts.udp,
     );
+    debug!("Scanner finished building: {scanner:?}");
 
+    let mut portscan_bench = NamedTimer::start("Portscan");
     let scan_result = block_on(scanner.run());
+    portscan_bench.end();
+    benchmarks.push(portscan_bench);
+
     let mut ports_per_ip = HashMap::new();
 
     for socket in scan_result {
@@ -124,7 +110,7 @@ fn main() {
             .push(socket.port());
     }
 
-    for ip in opts.ips {
+    for ip in ips {
         if ports_per_ip.contains_key(&ip) {
             continue;
         }
@@ -132,130 +118,154 @@ fn main() {
         // If we got here it means the IP was not found within the HashMap, this
         // means the scan couldn't find any open ports for it.
 
-        let x = format!("{} Looks like I didn't find any open ports for {:?}. This is usually caused by a high batch size.
-        \n*I used {} batch size, consider lowering to {} with {} or a comfortable number for your system.
-        \n Alternatively, increase the timeout if your ping is high. Rustscan -t 2000 for 2000 second timeout.\n",
-        "ERROR",
+        let x = format!("Looks like I didn't find any open ports for {:?}. This is usually caused by a high batch size.
+        \n*I used {} batch size, consider lowering it with {} or a comfortable number for your system.
+        \n Alternatively, increase the timeout if your ping is high. Rustscan -t 2000 for 2000 milliseconds (2s) timeout.\n",
         ip,
         opts.batch_size,
-        (opts.batch_size / 2).to_string(),
-        "'rustscan -b <batch_size> <ip address>'");
-        warning!(x, opts.quiet);
+        "'rustscan -b <batch_size> -a <ip address>'");
+        warning!(x, opts.greppable, opts.accessible);
     }
 
-    for (ip, ports) in ports_per_ip.iter_mut() {
-        let nmap_str_ports: Vec<String> = ports.into_iter().map(|port| port.to_string()).collect();
-
-        detail!("Starting Nmap", opts.quiet);
+    let mut script_bench = NamedTimer::start("Scripts");
+    for (ip, ports) in &ports_per_ip {
+        let vec_str_ports: Vec<String> = ports.iter().map(ToString::to_string).collect();
 
         // nmap port style is 80,443. Comma separated with no spaces.
-        let ports_str = nmap_str_ports.join(",");
+        let ports_str = vec_str_ports.join(",");
 
-        // if quiet mode is on nmap should not be spawned
-        if opts.quiet {
-            println!("{}", ports_str);
+        // if option scripts is none, no script will be spawned
+        if opts.greppable || opts.scripts == ScriptsRequired::None {
+            println!("{ip} -> [{ports_str}]");
             continue;
         }
+        detail!("Starting Script(s)", opts.greppable, opts.accessible);
 
-        let addr = ip.to_string();
-        let user_nmap_args =
-            shell_words::split(&opts.command.join(" ")).expect("failed to parse nmap arguments");
-        let nmap_args = build_nmap_arguments(&addr, &ports_str, &user_nmap_args, ip.is_ipv6());
+        // Run all the scripts we found and parsed based on the script config file tags field.
+        for mut script_f in scripts_to_run.clone() {
+            // This part allows us to add commandline arguments to the Script call_format, appending them to the end of the command.
+            if !opts.command.is_empty() {
+                let user_extra_args = &opts.command.join(" ");
+                debug!("Extra args vec {user_extra_args:?}");
+                if script_f.call_format.is_some() {
+                    let mut call_f = script_f.call_format.unwrap();
+                    call_f.push(' ');
+                    call_f.push_str(user_extra_args);
+                    output!(
+                        format!("Running script {:?} on ip {}\nDepending on the complexity of the script, results may take some time to appear.", call_f, &ip),
+                        opts.greppable,
+                        opts.accessible
+                    );
+                    debug!("Call format {call_f}");
+                    script_f.call_format = Some(call_f);
+                }
+            }
 
-        output!(format!(
-            "The Nmap command to be run is nmap {}\n",
-            &nmap_args.join(" ")
-        ));
-
-        // Runs the nmap command and spawns it as a process.
-        let mut child = Command::new("nmap")
-            .args(&nmap_args)
-            .spawn()
-            .expect("failed to execute nmap process");
-
-        child.wait().expect("failed to wait on nmap process");
+            // Building the script with the arguments from the ScriptFile, and ip-ports.
+            let script = Script::build(
+                script_f.path,
+                *ip,
+                ports.clone(),
+                script_f.port,
+                script_f.ports_separator,
+                script_f.tags,
+                script_f.call_format,
+            );
+            match script.run() {
+                Ok(script_result) => {
+                    detail!(script_result.clone(), opts.greppable, opts.accessible);
+                }
+                Err(e) => {
+                    warning!(&format!("Error {e}"), opts.greppable, opts.accessible);
+                }
+            }
+        }
     }
+
+    // To use the runtime benchmark, run the process as: RUST_LOG=info ./rustscan
+    script_bench.end();
+    benchmarks.push(script_bench);
+    rustscan_bench.end();
+    benchmarks.push(rustscan_bench);
+    debug!("Benchmarks raw {benchmarks:?}");
+    info!("{}", benchmarks.summary());
 }
 
 /// Prints the opening title of RustScan
-fn print_opening() {
-    info!("Printing opening");
+#[allow(clippy::items_after_statements, clippy::needless_raw_string_hashes)]
+fn print_opening(opts: &Opts) {
+    debug!("Printing opening");
     let s = r#".----. .-. .-. .----..---.  .----. .---.   .--.  .-. .-.
 | {}  }| { } |{ {__ {_   _}{ {__  /  ___} / {} \ |  `| |
 | .-. \| {_} |.-._} } | |  .-._} }\     }/  /\  \| |\  |
 `-' `-'`-----'`----'  `-'  `----'  `---' `-'  `-'`-' `-'
-Faster Nmap scanning with Rust."#;
+The Modern Day Port Scanner."#;
+
     println!("{}", s.gradient(Color::Green).bold());
     let info = r#"________________________________________
-: https://discord.gg/GFrQsGy           :
+: http://discord.skerritt.blog         :
 : https://github.com/RustScan/RustScan :
  --------------------------------------"#;
     println!("{}", info.gradient(Color::Yellow).bold());
     funny_opening!();
 
-    let config_path = match dirs::config_dir() {
-        Some(mut path) => {
-            path.push("rustscan");
-            path.push("config.toml");
-            path
-        }
-        None => panic!("Couldn't find config dir."),
-    };
+    let config_path = opts
+        .config_path
+        .clone()
+        .unwrap_or_else(input::default_config_path);
 
-    detail!(format!(
-        "{} {:?}",
-        "The config file is expected to be at", config_path
-    ));
-}
-#[cfg(not(tarpaulin_include))]
-fn build_nmap_arguments<'a>(
-    addr: &'a str,
-    ports: &'a str,
-    user_args: &'a Vec<String>,
-    is_ipv6: bool,
-) -> Vec<&'a str> {
-    let mut arguments: Vec<&str> = user_args.iter().map(AsRef::as_ref).collect();
-    arguments.push("-A");
-    arguments.push("-vvv");
+    detail!(
+        format!("The config file is expected to be at {config_path:?}"),
+        opts.greppable,
+        opts.accessible
+    );
 
-    if is_ipv6 {
-        arguments.push("-6");
+    if opts.config_path.is_none() {
+        let old_config_path = input::old_default_config_path();
+        detail!(
+            format!(
+                "For backwards compatibility, the config file may also be at {old_config_path:?}"
+            ),
+            opts.greppable,
+            opts.accessible
+        );
     }
-
-    arguments.push("-p");
-    arguments.push(ports);
-    arguments.push(addr);
-
-    arguments
 }
 
-fn adjust_ulimit_size(opts: &Opts) -> rlimit::rlim {
-    if opts.ulimit.is_some() {
-        let limit: rlimit::rlim = opts.ulimit.unwrap();
+#[cfg(unix)]
+fn adjust_ulimit_size(opts: &Opts) -> usize {
+    use rlimit::Resource;
+    use std::convert::TryInto;
 
-        match setrlimit(Resource::NOFILE, limit, limit) {
-            Ok(_) => {
-                detail!(
-                    format!("Automatically increasing ulimit value to {}.", limit),
-                    opts.quiet
-                );
-            }
-            Err(_) => println!("{}", "ERROR. Failed to set ulimit value."),
+    if let Some(limit) = opts.ulimit {
+        let limit = limit as u64;
+        if Resource::NOFILE.set(limit, limit).is_ok() {
+            detail!(
+                format!("Automatically increasing ulimit value to {limit}."),
+                opts.greppable,
+                opts.accessible
+            );
+        } else {
+            warning!(
+                "ERROR. Failed to set ulimit value.",
+                opts.greppable,
+                opts.accessible
+            );
         }
     }
 
-    let (rlim, _) = getrlimit(Resource::NOFILE).unwrap();
-
-    rlim
+    let (soft, _) = Resource::NOFILE.get().unwrap();
+    soft.try_into().unwrap_or(usize::MAX)
 }
 
-fn infer_batch_size(opts: &Opts, ulimit: rlimit::rlim) -> u16 {
-    let mut batch_size: rlimit::rlim = opts.batch_size.into();
+#[cfg(unix)]
+fn infer_batch_size(opts: &Opts, ulimit: usize) -> usize {
+    let mut batch_size = opts.batch_size;
 
     // 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",
-            opts.quiet
+        warning!("File limit is lower than default batch size. Consider upping with --ulimit. May cause harm to sensitive servers",
+            opts.greppable, opts.accessible
         );
 
         // When the OS supports high file limits like 8000, but the user
@@ -265,122 +275,103 @@ fn infer_batch_size(opts: &Opts, ulimit: rlimit::rlim) -> u16 {
             // ulimit is smaller than aveage batch size
             // user must have very small ulimit
             // decrease batch size to half of ulimit
-            warning!("Your file limit is very small, which negatively impacts RustScan's speed. Use the Docker image, or up the Ulimit with '--ulimit 5000'. ");
+            warning!("Your file limit is very small, which negatively impacts RustScan's speed. Use the Docker image, or up the Ulimit with '--ulimit 5000'. ", opts.greppable, opts.accessible);
             info!("Halving batch_size because ulimit is smaller than average batch size");
-            batch_size = ulimit / 2
+            batch_size = ulimit / 2;
         } else if ulimit > DEFAULT_FILE_DESCRIPTORS_LIMIT {
             info!("Batch size is now average batch size");
-            batch_size = AVERAGE_BATCH_SIZE
+            batch_size = AVERAGE_BATCH_SIZE;
         } else {
-            batch_size = ulimit - 100
+            batch_size = ulimit - 100;
         }
     }
     // When the ulimit is higher than the batch size let the user know that the
     // batch size can be increased unless they specified the ulimit themselves.
     else if ulimit + 2 > batch_size && (opts.ulimit.is_none()) {
-        detail!(format!(
-                "File limit higher than batch size. Can increase speed by increasing batch size '-b {}'.",
-                ulimit - 100
-            ), opts.quiet);
+        detail!(format!("File limit higher than batch size. Can increase speed by increasing batch size '-b {}'.", ulimit - 100),
+        opts.greppable, opts.accessible);
     }
 
-    batch_size as u16
+    batch_size
 }
 
 #[cfg(test)]
 mod tests {
-    use crate::{adjust_ulimit_size, infer_batch_size, print_opening, Opts, ScanOrder};
-    use std::{net::IpAddr, str::FromStr};
+    #[cfg(unix)]
+    use super::{adjust_ulimit_size, infer_batch_size};
+    use super::{print_opening, Opts};
 
     #[test]
+    #[cfg(unix)]
     fn batch_size_lowered() {
         let opts = Opts {
-            ips: vec![IpAddr::from_str("127.0.0.1").unwrap()],
-            quiet: true,
             batch_size: 50_000,
-            timeout: 1_000,
-            ulimit: Some(2_000),
-            command: Vec::new(),
-            accessible: false,
-            scan_order: ScanOrder::Serial,
+            ..Default::default()
         };
         let batch_size = infer_batch_size(&opts, 120);
 
-        assert!(batch_size < 50_000);
+        assert!(batch_size < opts.batch_size);
     }
 
     #[test]
+    #[cfg(unix)]
     fn batch_size_lowered_average_size() {
         let opts = Opts {
-            ips: vec![IpAddr::from_str("127.0.0.1").unwrap()],
-            quiet: true,
             batch_size: 50_000,
-            timeout: 1_000,
-            ulimit: Some(2_000),
-            command: Vec::new(),
-            accessible: false,
-            scan_order: ScanOrder::Serial,
+            ..Default::default()
         };
         let batch_size = infer_batch_size(&opts, 9_000);
 
-        assert!(batch_size == 3_000);
+        assert_eq!(batch_size, 3_000);
     }
     #[test]
+    #[cfg(unix)]
     fn batch_size_equals_ulimit_lowered() {
         // 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()],
-            quiet: true,
             batch_size: 50_000,
-            timeout: 1_000,
-            ulimit: Some(2_000),
-            command: Vec::new(),
-            accessible: false,
-            scan_order: ScanOrder::Serial,
+            ..Default::default()
         };
         let batch_size = infer_batch_size(&opts, 5_000);
 
-        assert!(batch_size == 4_900);
+        assert_eq!(batch_size, 4_900);
     }
     #[test]
+    #[cfg(unix)]
     fn batch_size_adjusted_2000() {
         // ulimit == batch_size
         let opts = Opts {
-            ips: vec![IpAddr::from_str("127.0.0.1").unwrap()],
-            quiet: true,
             batch_size: 50_000,
-            timeout: 1_000,
             ulimit: Some(2_000),
-            command: Vec::new(),
-            accessible: false,
-            scan_order: ScanOrder::Serial,
+            ..Default::default()
         };
         let batch_size = adjust_ulimit_size(&opts);
 
-        assert!(batch_size == 2_000);
+        assert_eq!(batch_size, 2_000);
     }
+
     #[test]
-    fn test_print_opening_no_panic() {
-        // print opening should not panic
-        print_opening();
-        assert!(1 == 1);
-    }
-    #[test]
-    fn test_high_ulimit_no_quiet_mode() {
+    #[cfg(unix)]
+    fn test_high_ulimit_no_greppable_mode() {
         let opts = Opts {
-            ips: vec![IpAddr::from_str("127.0.0.1").unwrap()],
-            quiet: false,
             batch_size: 10,
-            timeout: 1_000,
-            ulimit: None,
-            command: Vec::new(),
-            accessible: true,
-            scan_order: ScanOrder::Serial,
+            greppable: false,
+            ..Default::default()
         };
 
-        infer_batch_size(&opts, 1_000_000);
+        let batch_size = infer_batch_size(&opts, 1_000_000);
 
-        assert!(1 == 1);
+        assert_eq!(batch_size, opts.batch_size);
+    }
+
+    #[test]
+    fn test_print_opening_no_panic() {
+        let opts = Opts {
+            ulimit: Some(2_000),
+            ..Default::default()
+        };
+        // print opening should not panic
+        print_opening(&opts);
     }
 }

src/port_strategy/mod.rs

@@ -1,26 +1,51 @@
+//! Provides a means to hold configuration options specifically for port scanning.
 mod range_iterator;
-use super::ScanOrder;
+use crate::input::{PortRange, ScanOrder};
+use rand::rng;
+use rand::seq::SliceRandom;
 use range_iterator::RangeIterator;
 
 /// Represents options of port scanning.
 ///
 /// Right now all these options involve ranges, but in the future
 /// it will also contain custom lists of ports.
+#[derive(Debug)]
 pub enum PortStrategy {
+    Manual(Vec<u16>),
     Serial(SerialRange),
     Random(RandomRange),
 }
 
 impl PortStrategy {
-    pub fn pick(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 = 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.clone(),
             PortStrategy::Serial(range) => range.generate(),
             PortStrategy::Random(range) => range.generate(),
         }
@@ -35,6 +60,7 @@ trait RangeOrder {
 
 /// As the name implies SerialRange will always generate a vector in
 /// ascending order.
+#[derive(Debug)]
 pub struct SerialRange {
     start: u16,
     end: u16,
@@ -42,12 +68,13 @@ pub struct SerialRange {
 
 impl RangeOrder for SerialRange {
     fn generate(&self) -> Vec<u16> {
-        (self.start..self.end).collect()
+        (self.start..=self.end).collect()
     }
 }
 
 /// As the name implies RandomRange will always generate a vector with
 /// a random order. This vector is built following the LCG algorithm.
+#[derive(Debug)]
 pub struct RandomRange {
     start: u16,
     end: u16,
@@ -71,23 +98,43 @@ impl RangeOrder for RandomRange {
 #[cfg(test)]
 mod tests {
     use super::PortStrategy;
-    use crate::ScanOrder;
+    use crate::input::{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>>();
+        let expected_range = (1..=100).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>>();
+        let expected_range = (1..=100).collect::<Vec<u16>>();
         assert_ne!(expected_range, result);
 
-        result.sort();
+        result.sort_unstable();
+        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).collect::<Vec<u16>>();
+        assert_ne!(expected_range, result);
+
+        result.sort_unstable();
         assert_eq!(expected_range, result);
     }
 }

src/port_strategy/range_iterator.rs

@@ -1,5 +1,6 @@
 use gcd::Gcd;
-use rand::Rng;
+use rand::RngExt;
+use std::convert::TryInto;
 
 pub struct RangeIterator {
     active: bool,
@@ -12,22 +13,22 @@ pub struct RangeIterator {
 
 /// An iterator that follows the `Linear Congruential Generator` algorithm.
 ///
-/// For more information: https://en.wikipedia.org/wiki/Linear_congruential_generator
+/// For more information: <https://en.wikipedia.org/wiki/Linear_congruential_generator>
 impl RangeIterator {
-    /// Receives the the start and end of a range and normalize
+    /// Receives the start and end of a range and normalize
     /// these values before selecting a coprime for the end of the range
     /// which will server as the step for the algorithm.
     ///
     /// For example, the range `1000-2500` will be normalized to `0-1500`
     /// before going through the algorithm.
     pub fn new(start: u32, end: u32) -> Self {
-        let normalized_end = end - start;
+        let normalized_end = end - start + 1;
         let step = pick_random_coprime(normalized_end);
 
         // Randomly choose a number within the range to be the first
         // and assign it as a pick.
-        let mut rng = rand::thread_rng();
-        let normalized_first_pick = rng.gen_range(0, normalized_end);
+        let mut rng = rand::rng();
+        let normalized_first_pick = rng.random_range(0..normalized_end);
 
         Self {
             active: true,
@@ -60,7 +61,11 @@ impl Iterator for RangeIterator {
         }
 
         self.normalized_pick = next_pick;
-        Some((self.actual_start + current_pick) as u16)
+        Some(
+            (self.actual_start + current_pick)
+                .try_into()
+                .expect("Could not convert u32 to u16"),
+        )
     }
 }
 
@@ -78,15 +83,14 @@ fn pick_random_coprime(end: u32) -> u32 {
     let range_boundary = end / 4;
     let lower_range = range_boundary;
     let upper_range = end - range_boundary;
-    let mut rng = rand::thread_rng();
-    let mut candidate = rng.gen_range(lower_range, upper_range);
+    let mut rng = rand::rng();
+    let mut candidate = rng.random_range(lower_range..upper_range);
 
     for _ in 0..10 {
         if end.gcd(candidate) == 1 {
             return candidate;
-        } else {
-            candidate = rng.gen_range(lower_range, upper_range);
         }
+        candidate = rng.random_range(lower_range..upper_range);
     }
 
     end - 1
@@ -99,30 +103,30 @@ mod tests {
     #[test]
     fn range_iterator_iterates_through_the_entire_range() {
         let result = generate_sorted_range(1, 10);
-        let expected_range = (1..10).into_iter().collect::<Vec<u16>>();
+        let expected_range = (1..=10).collect::<Vec<u16>>();
         assert_eq!(expected_range, result);
 
         let result = generate_sorted_range(1, 100);
-        let expected_range = (1..100).into_iter().collect::<Vec<u16>>();
+        let expected_range = (1..=100).collect::<Vec<u16>>();
         assert_eq!(expected_range, result);
 
         let result = generate_sorted_range(1, 1000);
-        let expected_range = (1..1000).into_iter().collect::<Vec<u16>>();
+        let expected_range = (1..=1000).collect::<Vec<u16>>();
         assert_eq!(expected_range, result);
 
         let result = generate_sorted_range(1, 65_535);
-        let expected_range = (1..65_535).into_iter().collect::<Vec<u16>>();
+        let expected_range = (1..=65_535).collect::<Vec<u16>>();
         assert_eq!(expected_range, result);
 
         let result = generate_sorted_range(1000, 2000);
-        let expected_range = (1000..2000).into_iter().collect::<Vec<u16>>();
+        let expected_range = (1000..=2000).collect::<Vec<u16>>();
         assert_eq!(expected_range, result);
     }
 
     fn generate_sorted_range(start: u32, end: u32) -> Vec<u16> {
         let range = RangeIterator::new(start, end);
         let mut result = range.into_iter().collect::<Vec<u16>>();
-        result.sort();
+        result.sort_unstable();
 
         result
     }

src/scanner/mod.rs

@@ -1,130 +1,213 @@
-use super::PortStrategy;
+//! Core functionality for actual scanning behaviour.
+use crate::generated::get_parsed_data;
+use crate::port_strategy::PortStrategy;
+use log::debug;
+
+mod socket_iterator;
+use socket_iterator::SocketIterator;
 
-use async_std::io;
 use async_std::net::TcpStream;
 use async_std::prelude::*;
-use colored::*;
+use async_std::{io, net::UdpSocket};
+use colored::Colorize;
 use futures::stream::FuturesUnordered;
-use std::time::Duration;
+use std::collections::BTreeMap;
 use std::{
-    io::ErrorKind,
+    collections::HashSet,
     net::{IpAddr, Shutdown, SocketAddr},
+    num::NonZeroU8,
+    time::Duration,
 };
 
 /// 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.
+/// greppable is whether or not RustScan should print things, or wait until the end to print only the ip and open ports.
 #[cfg(not(tarpaulin_include))]
+#[derive(Debug)]
 pub struct Scanner {
-    hosts: Vec<IpAddr>,
-    batch_size: u16,
+    ips: Vec<IpAddr>,
+    batch_size: usize,
     timeout: Duration,
-    quiet: bool,
+    tries: NonZeroU8,
+    greppable: bool,
     port_strategy: PortStrategy,
+    accessible: bool,
+    exclude_ports: Vec<u16>,
+    udp: bool,
 }
 
+// Allowing too many arguments for clippy.
+#[allow(clippy::too_many_arguments)]
 impl Scanner {
     pub fn new(
-        hosts: &[IpAddr],
-        batch_size: u16,
+        ips: &[IpAddr],
+        batch_size: usize,
         timeout: Duration,
-        quiet: bool,
+        tries: u8,
+        greppable: bool,
         port_strategy: PortStrategy,
+        accessible: bool,
+        exclude_ports: Vec<u16>,
+        udp: bool,
     ) -> Self {
         Self {
             batch_size,
             timeout,
-            quiet,
+            tries: NonZeroU8::new(std::cmp::max(tries, 1)).unwrap(),
+            greppable,
             port_strategy,
-            hosts: hosts.iter().map(|host| host.to_owned()).collect(),
+            ips: ips.iter().map(ToOwned::to_owned).collect(),
+            accessible,
+            exclude_ports,
+            udp,
         }
     }
 
     /// Runs scan_range with chunk sizes
     /// If you want to run RustScan normally, this is the entry point used
-    /// Returns all open ports as Vec<u16>
+    /// 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 ports: Vec<u16> = self
+            .port_strategy
+            .order()
+            .iter()
+            .filter(|&port| !self.exclude_ports.contains(port))
+            .copied()
+            .collect();
+        let mut socket_iterator: SocketIterator = SocketIterator::new(&self.ips, &ports);
         let mut open_sockets: Vec<SocketAddr> = Vec::new();
-
-        for batch in ports.chunks(batch_per_host) {
-            let mut sockets = self.scan_ports(batch).await;
-            open_sockets.append(&mut sockets);
-        }
-
-        open_sockets
-    }
-
-    /// Given a slice of sockets, scan them all.
-    /// Returns a vector of open sockets.
-    async fn scan_ports(&self, ports: &[u16]) -> Vec<SocketAddr> {
         let mut ftrs = FuturesUnordered::new();
-        for port in ports {
-            for host in &self.hosts {
-                ftrs.push(self.scan_socket(SocketAddr::new(*host, *port)));
+        let mut errors: HashSet<String> = HashSet::new();
+        let udp_map = get_parsed_data();
+
+        for _ in 0..self.batch_size {
+            if let Some(socket) = socket_iterator.next() {
+                ftrs.push(self.scan_socket(socket, udp_map.clone()));
+            } else {
+                break;
             }
         }
 
-        let mut open_sockets: Vec<SocketAddr> = Vec::new();
+        debug!("Start scanning sockets. \nBatch size {}\nNumber of ip-s {}\nNumber of ports {}\nTargets all together {} ",
+            self.batch_size,
+            self.ips.len(),
+            ports.len(),
+            (self.ips.len() * ports.len()));
+
         while let Some(result) = ftrs.next().await {
+            if let Some(socket) = socket_iterator.next() {
+                ftrs.push(self.scan_socket(socket, udp_map.clone()));
+            }
+
             match result {
                 Ok(socket) => open_sockets.push(socket),
-                _ => {}
+                Err(e) => {
+                    let error_string = e.to_string();
+                    if errors.len() < self.ips.len() * 1000 {
+                        errors.insert(error_string);
+                    }
+                }
             }
         }
-
+        debug!("Typical socket connection errors {errors:?}");
+        debug!("Open Sockets found: {:?}", open_sockets);
         open_sockets
     }
 
-    /// Given a port, scan it.
+    /// Given a socket, scan it self.tries times.
     /// Turns the address into a SocketAddr
-    /// Deals with the <result> type
+    /// Deals with the `<result>` type
     /// If it experiences error ErrorKind::Other then too many files are open and it Panics!
-    /// ese any other error, it returns the error in Result as a string
-    /// If no  errors occur, it returns the port number in Result to signify the port is open.
+    /// Else any other error, it returns the error in Result as a string
+    /// If no errors occur, it returns the port number in Result to signify the port is open.
     /// This function mainly deals with the logic of Results handling.
     /// # Example
     ///
-    ///     self.scan_port(10:u16)
+    /// ```compile_fail
+    /// scanner.scan_socket(socket)
+    /// ```
     ///
-    /// Note: `self` must contain `self.host`.
-    async fn scan_socket(&self, socket: SocketAddr) -> io::Result<SocketAddr> {
-        match self.connect(socket).await {
-            Ok(x) => {
-                // match stream_result.shutdown(Shutdown::Both)
-                info!("Shutting down stream");
-                match x.shutdown(Shutdown::Both) {
-                    _ => {}
-                }
-                if !self.quiet {
-                    println!("Open {}", socket.to_string().purple());
-                }
-
-                Ok(socket)
-            }
-            Err(e) => match e.kind() {
-                ErrorKind::Other => {
-                    panic!("Too many open files. Please reduce batch size. The default is 5000. Try -b 2500.");
-                }
-                _ => Err(io::Error::new(io::ErrorKind::Other, e.to_string())),
-            },
+    /// Note: `self` must contain `self.ip`.
+    async fn scan_socket(
+        &self,
+        socket: SocketAddr,
+        udp_map: BTreeMap<Vec<u16>, Vec<u8>>,
+    ) -> io::Result<SocketAddr> {
+        if self.udp {
+            return self.scan_udp_socket(socket, udp_map).await;
         }
+
+        let tries = self.tries.get();
+        for nr_try in 1..=tries {
+            match self.connect(socket).await {
+                Ok(tcp_stream) => {
+                    debug!("Connection was successful, shutting down stream {}", socket);
+                    if let Err(e) = tcp_stream.shutdown(Shutdown::Both) {
+                        debug!("Shutdown stream error {}", e);
+                    }
+                    self.fmt_ports(socket);
+
+                    debug!("Return Ok after {nr_try} tries");
+                    return Ok(socket);
+                }
+                Err(e) => {
+                    let mut error_string = e.to_string();
+
+                    assert!(!error_string.to_lowercase().contains("too many open files"), "Too many open files. Please reduce batch size. The default is 5000. Try -b 2500.");
+
+                    if nr_try == tries {
+                        error_string.push(' ');
+                        error_string.push_str(&socket.ip().to_string());
+                        return Err(io::Error::other(error_string));
+                    }
+                }
+            };
+        }
+        unreachable!();
+    }
+
+    async fn scan_udp_socket(
+        &self,
+        socket: SocketAddr,
+        udp_map: BTreeMap<Vec<u16>, Vec<u8>>,
+    ) -> io::Result<SocketAddr> {
+        let mut payload: Vec<u8> = Vec::new();
+        for (key, value) in udp_map {
+            if key.contains(&socket.port()) {
+                payload = value;
+            }
+        }
+
+        let tries = self.tries.get();
+        for _ in 1..=tries {
+            match self.udp_scan(socket, &payload, self.timeout).await {
+                Ok(true) => return Ok(socket),
+                Ok(false) => continue,
+                Err(e) => return Err(e),
+            }
+        }
+
+        Err(io::Error::other(format!(
+            "UDP scan timed-out for all tries on socket {socket}"
+        )))
     }
 
     /// Performs the connection to the socket with timeout
     /// # 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);
-    ///     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
+    /// ```compile_fail
+    /// # use std::net::{IpAddr, Ipv6Addr, SocketAddr};
+    /// let port: u16 = 80;
+    /// // ip is an IpAddr type
+    /// let ip = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
+    /// let socket = SocketAddr::new(ip, port);
+    /// scanner.connect(socket);
+    /// // returns Result which is either Ok(stream) for port is open, or Er for port is closed.
+    /// // Timeout occurs after self.timeout seconds
+    /// ```
     ///
     async fn connect(&self, socket: SocketAddr) -> io::Result<TcpStream> {
         let stream = io::timeout(
@@ -134,60 +217,88 @@ impl Scanner {
         .await?;
         Ok(stream)
     }
-}
 
-#[cfg(test)]
-mod tests {
-    use super::*;
-    use crate::ScanOrder;
-    use async_std::task::block_on;
-    use std::{net::IpAddr, time::Duration};
+    /// Binds to a UDP socket so we can send and receive packets
+    /// # Example
+    ///
+    /// ```compile_fail
+    /// # use std::net::{IpAddr, Ipv6Addr, SocketAddr};
+    /// let port: u16 = 80;
+    /// // ip is an IpAddr type
+    /// let ip = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
+    /// let socket = SocketAddr::new(ip, port);
+    /// scanner.udp_bind(socket);
+    /// // returns Result which is either Ok(stream) for port is open, or Err for port is closed.
+    /// // Timeout occurs after self.timeout seconds
+    /// ```
+    ///
+    async fn udp_bind(&self, socket: SocketAddr) -> io::Result<UdpSocket> {
+        let local_addr = match socket {
+            SocketAddr::V4(_) => "0.0.0.0:0".parse::<SocketAddr>().unwrap(),
+            SocketAddr::V6(_) => "[::]:0".parse::<SocketAddr>().unwrap(),
+        };
 
-    #[test]
-    fn scanner_runs() {
-        // Makes sure the program still runs and doesn't panic
-        let addrs = vec!["127.0.0.1".parse::<IpAddr>().unwrap()];
-        let strategy = PortStrategy::pick(1, 1_000, ScanOrder::Random);
-        let scanner = Scanner::new(&addrs, 10, Duration::from_millis(100), true, strategy);
-        block_on(scanner.run());
-        // if the scan fails, it wouldn't be able to assert_eq! as it panicked!
-        assert_eq!(1, 1);
+        UdpSocket::bind(local_addr).await
     }
-    #[test]
-    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 scanner = Scanner::new(&addrs, 10, Duration::from_millis(100), true, strategy);
-        block_on(scanner.run());
-        // if the scan fails, it wouldn't be able to assert_eq! as it panicked!
-        assert_eq!(1, 1);
-    }
-    #[test]
-    fn quad_zero_scanner_runs() {
-        let addrs = vec!["0.0.0.0".parse::<IpAddr>().unwrap()];
-        let strategy = PortStrategy::pick(1, 1_000, ScanOrder::Random);
-        let scanner = Scanner::new(&addrs, 10, Duration::from_millis(100), true, strategy);
-        block_on(scanner.run());
-        assert_eq!(1, 1);
-    }
-    #[test]
-    fn google_dns_runs() {
-        let addrs = vec!["8.8.8.8".parse::<IpAddr>().unwrap()];
-        let strategy = PortStrategy::pick(400, 445, ScanOrder::Random);
-        let scanner = Scanner::new(&addrs, 10, Duration::from_millis(100), true, strategy);
-        block_on(scanner.run());
-        assert_eq!(1, 1);
-    }
-    #[test]
-    fn infer_ulimit_lowering_no_panic() {
-        // Test behaviour on MacOS where ulimit is not automatically lowered
-        let addrs = vec!["8.8.8.8".parse::<IpAddr>().unwrap()];
 
-        // mac should have this automatically scaled down
-        let strategy = PortStrategy::pick(400, 600, ScanOrder::Random);
-        let scanner = Scanner::new(&addrs, 10, Duration::from_millis(100), true, strategy);
-        block_on(scanner.run());
-        assert_eq!(1, 1);
+    /// Performs a UDP scan on the specified socket with a payload and wait duration
+    /// # Example
+    ///
+    /// ```compile_fail
+    /// # use std::net::{IpAddr, Ipv6Addr, SocketAddr};
+    /// # use std::time::Duration;
+    /// let port: u16 = 123;
+    /// // 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);
+    /// let payload = vec![0, 1, 2, 3];
+    /// let wait = Duration::from_secs(1);
+    /// let result = scanner.udp_scan(socket, payload, wait).await;
+    /// // returns Result which is either Ok(true) if response received, or Ok(false) if timed out.
+    /// // Err is returned for other I/O errors.
+    async fn udp_scan(
+        &self,
+        socket: SocketAddr,
+        payload: &[u8],
+        wait: Duration,
+    ) -> io::Result<bool> {
+        match self.udp_bind(socket).await {
+            Ok(udp_socket) => {
+                let mut buf = [0u8; 1024];
+
+                udp_socket.connect(socket).await?;
+                udp_socket.send(payload).await?;
+
+                match io::timeout(wait, udp_socket.recv(&mut buf)).await {
+                    Ok(size) => {
+                        debug!("Received {size} bytes");
+                        self.fmt_ports(socket);
+                        Ok(true)
+                    }
+                    Err(e) => {
+                        if e.kind() == io::ErrorKind::TimedOut {
+                            Ok(false)
+                        } else {
+                            Err(e)
+                        }
+                    }
+                }
+            }
+            Err(e) => {
+                println!("Err E binding sock {e:?}");
+                Err(e)
+            }
+        }
+    }
+
+    /// Formats and prints the port status
+    fn fmt_ports(&self, socket: SocketAddr) {
+        if !self.greppable {
+            if self.accessible {
+                println!("Open {socket}");
+            } else {
+                println!("Open {}", socket.to_string().purple());
+            }
+        }
     }
 }

src/scanner/socket_iterator.rs

@@ -0,0 +1,75 @@
+use itertools::{iproduct, Product};
+use std::net::{IpAddr, SocketAddr};
+
+pub struct SocketIterator<'s> {
+    // product_it is a cartesian product iterator over
+    // the slices of ports and IP addresses.
+    //
+    // The IP/port order is intentionally reversed here since we want
+    // the itertools::iproduct! macro below to generate the pairs with
+    // all the IPs for one port before moving on to the next one
+    // ("hold the port, go through all the IPs, then advance the port...").
+    // See also the comments in the iterator implementation for an example.
+    product_it:
+        Product<Box<std::slice::Iter<'s, u16>>, Box<std::slice::Iter<'s, std::net::IpAddr>>>,
+}
+
+/// An iterator that receives a slice of IPs and ports and returns a Socket
+/// for each IP and port pair until all of these combinations are exhausted.
+/// The goal of this iterator is to go over every IP and port combination
+/// without generating a big memory footprint. The alternative would be
+/// generating a vector containing all these combinations.
+impl<'s> SocketIterator<'s> {
+    pub fn new(ips: &'s [IpAddr], ports: &'s [u16]) -> Self {
+        let ports_it = Box::new(ports.iter());
+        let ips_it = Box::new(ips.iter());
+        Self {
+            product_it: iproduct!(ports_it, ips_it),
+        }
+    }
+}
+
+#[allow(clippy::doc_link_with_quotes)]
+impl Iterator for SocketIterator<'_> {
+    type Item = SocketAddr;
+
+    /// Returns a socket based on the combination of one of the provided
+    /// IPs and ports or None when these combinations are exhausted. Every
+    /// IP will have the same port until a port is incremented.
+    ///
+    /// let it = SocketIterator::new(&["127.0.0.1", "192.168.0.1"], &[80, 443]);
+    /// it.next(); // 127.0.0.1:80
+    /// it.next(); // 192.168.0.1:80
+    /// it.next(); // 127.0.0.1:443
+    /// it.next(); // 192.168.0.1:443
+    /// it.next(); // None
+    fn next(&mut self) -> Option<Self::Item> {
+        self.product_it
+            .next()
+            .map(|(port, ip)| SocketAddr::new(*ip, *port))
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::SocketIterator;
+    use std::net::{IpAddr, SocketAddr};
+
+    #[test]
+    fn goes_through_every_ip_port_combination() {
+        let addrs = vec![
+            "127.0.0.1".parse::<IpAddr>().unwrap(),
+            "192.168.0.1".parse::<IpAddr>().unwrap(),
+        ];
+        let ports: Vec<u16> = vec![22, 80, 443];
+        let mut it = SocketIterator::new(&addrs, &ports);
+
+        assert_eq!(Some(SocketAddr::new(addrs[0], ports[0])), it.next());
+        assert_eq!(Some(SocketAddr::new(addrs[1], ports[0])), it.next());
+        assert_eq!(Some(SocketAddr::new(addrs[0], ports[1])), it.next());
+        assert_eq!(Some(SocketAddr::new(addrs[1], ports[1])), it.next());
+        assert_eq!(Some(SocketAddr::new(addrs[0], ports[2])), it.next());
+        assert_eq!(Some(SocketAddr::new(addrs[1], ports[2])), it.next());
+        assert_eq!(None, it.next());
+    }
+}

src/scripts/mod.rs

@@ -0,0 +1,501 @@
+//! Scripting Engine to run scripts based on tags.
+//!
+//! This module serves to filter and run the scripts selected by the user.
+//!
+//! A new commandline and configuration file option was added.
+//!
+//! ## `--scripts`
+//!
+//! ### `default`
+//!
+//! This is the default behavior, like as it was from the beginning of RustScan.
+//!
+//! The user do not have to chose anything for this. This is the only script
+//! embedded in RustScan running as default.
+//!
+//! ### `none`
+//!
+//! The user have to use the `--scripts none` commandline argument or `scripts =
+//! "none"` in the config file.
+//!
+//! None of the scripts will run, this replaces the removed `--no-nmap` option.
+//!
+//! ### `custom`
+//!
+//! The user have to use the `--scripts custom` commandline argument or
+//! `scripts = "custom"` in the config file.
+//!
+//! RustScan will look for the script configuration file in the user's home
+//! dir: `home_dir/.rustscan_scripts.toml`
+//!
+//! The config file have 3 optional fields: `tag`, `developer` and `port`. Just
+//! the `tag` field will be used forther in the process.
+//!
+//! RustScan will also look for available scripts in the user's home dir:
+//! `home_dir/.rustscan_scripts` and will try to read all the files, and parse
+//! them into a vector of [`ScriptFile`].
+//!
+//! Filtering on tags means the tags found in the `rustscan_scripts.toml` file
+//! will also have to be present in the [`ScriptFile`], otherwise the script
+//! will not be selected.
+//!
+//! All of the `rustscan_script.toml` tags have to be present at minimum in a
+//! [`ScriptFile`] to get selected, but can be also more.
+//!
+//! Config file example:
+//!
+//! - `fixtures/test_rustscan_scripts.toml`
+//!
+//! Script file examples:
+//!
+//! - `fixtures/test_script.py`
+//! - `fixtures/test_script.pl`
+//! - `fixtures/test_script.sh`
+//! - `fixtures/test_script.txt`
+//!
+//! `call_format` in script files can be of 2 variants:
+//!
+//! One is where all of the possible tags `{{script}}`, `{{ip}}` and `{{port}}`
+//! are there.
+//!
+//! - The `{{script}}` part will be replaced with the scriptfile full path
+//!   gathered while parsing available scripts.
+//! - The `{{ip}}` part will be replaced with the ip we got from the scan.
+//! - The `{{port}}` part will be reaplced with the ports separated with the
+//!   `ports_separator` found in the script file
+//!
+//! And when there is only `{{ip}}` and `{{port}}` is in the format, only those
+//! will be replaced with the arguments from the scan.
+//!
+//! This makes it easy to run a system installed command like `nmap`, and give
+//! any kind of arguments to it.
+//!
+//! If the format is different, the script will be silently discarded and will
+//! not run. With the `Debug` option it's possible to see where it goes wrong.
+
+#![allow(clippy::module_name_repetitions)]
+
+use crate::input::ScriptsRequired;
+use anyhow::{anyhow, Result};
+use log::debug;
+use serde_derive::{Deserialize, Serialize};
+use std::fs::{self, File};
+use std::io::{self, prelude::*};
+use std::net::IpAddr;
+use std::path::PathBuf;
+use std::process::{Command, Stdio};
+use std::string::ToString;
+use text_placeholder::Template;
+
+#[cfg(unix)]
+use std::os::unix::process::ExitStatusExt;
+
+static DEFAULT: &str = r#"tags = ["core_approved", "RustScan", "default"]
+developer = [ "RustScan", "https://github.com/RustScan" ]
+ports_separator = ","
+call_format = "nmap -vvv -p {{port}} -{{ipversion}} {{ip}}"
+"#;
+
+#[cfg(not(tarpaulin_include))]
+pub fn init_scripts(scripts: &ScriptsRequired) -> Result<Vec<ScriptFile>> {
+    let mut scripts_to_run: Vec<ScriptFile> = Vec::new();
+
+    match scripts {
+        ScriptsRequired::None => {}
+        ScriptsRequired::Default => {
+            let default_script =
+                toml::from_str::<ScriptFile>(DEFAULT).expect("Failed to parse Script file.");
+            scripts_to_run.push(default_script);
+        }
+        ScriptsRequired::Custom => {
+            let script_config = ScriptConfig::read_config()?;
+            debug!("Script config \n{script_config:?}");
+
+            let script_dir_base = if let Some(config_directory) = &script_config.directory {
+                PathBuf::from(config_directory)
+            } else {
+                dirs::home_dir().ok_or_else(|| anyhow!("Could not infer scripts path."))?
+            };
+
+            let script_paths = find_scripts(script_dir_base)?;
+            debug!("Scripts paths \n{script_paths:?}");
+
+            let parsed_scripts = parse_scripts(script_paths);
+            debug!("Scripts parsed \n{parsed_scripts:?}");
+
+            // Only Scripts that contain all the tags found in ScriptConfig will be selected.
+            if let Some(config_hashset) = script_config.tags {
+                for script in parsed_scripts {
+                    if let Some(script_hashset) = &script.tags {
+                        if script_hashset
+                            .iter()
+                            .all(|tag| config_hashset.contains(tag))
+                        {
+                            scripts_to_run.push(script);
+                        } else {
+                            debug!(
+                                "\nScript tags does not match config tags {:?} {}",
+                                script_hashset,
+                                script.path.unwrap().display()
+                            );
+                        }
+                    }
+                }
+            }
+            debug!("\nScript(s) to run {scripts_to_run:?}");
+        }
+    }
+
+    Ok(scripts_to_run)
+}
+
+pub fn parse_scripts(scripts: Vec<PathBuf>) -> Vec<ScriptFile> {
+    let mut parsed_scripts: Vec<ScriptFile> = Vec::with_capacity(scripts.len());
+    for script in scripts {
+        debug!("Parsing script {}", script.display());
+        if let Some(script_file) = ScriptFile::new(script) {
+            parsed_scripts.push(script_file);
+        }
+    }
+    parsed_scripts
+}
+
+#[derive(Clone, Debug)]
+#[allow(dead_code)]
+pub struct Script {
+    // Path to the script itself.
+    path: Option<PathBuf>,
+
+    // Ip got from scanner.
+    ip: IpAddr,
+
+    // Ports found with portscan.
+    open_ports: Vec<u16>,
+
+    // Port found in ScriptFile, if defined only this will run with the ip.
+    trigger_port: Option<String>,
+
+    // Character to join ports in case we want to use a string format of them, for example nmap -p.
+    ports_separator: Option<String>,
+
+    // Tags found in ScriptFile.
+    tags: Option<Vec<String>>,
+
+    // The format how we want the script to run.
+    call_format: Option<String>,
+}
+
+#[derive(Serialize)]
+struct ExecPartsScript {
+    script: String,
+    ip: String,
+    port: String,
+    ipversion: String,
+}
+
+#[derive(Serialize)]
+struct ExecParts {
+    ip: String,
+    port: String,
+    ipversion: String,
+}
+
+impl Script {
+    pub fn build(
+        path: Option<PathBuf>,
+        ip: IpAddr,
+        open_ports: Vec<u16>,
+        trigger_port: Option<String>,
+        ports_separator: Option<String>,
+        tags: Option<Vec<String>>,
+        call_format: Option<String>,
+    ) -> Self {
+        Self {
+            path,
+            ip,
+            open_ports,
+            trigger_port,
+            ports_separator,
+            tags,
+            call_format,
+        }
+    }
+
+    // Some variables get changed before read, and compiler throws warning on warn(unused_assignments)
+    #[allow(unused_assignments)]
+    pub fn run(self) -> Result<String> {
+        debug!("run self {:?}", self);
+
+        let separator = self.ports_separator.unwrap_or_else(|| ",".into());
+
+        let mut ports_str = self
+            .open_ports
+            .iter()
+            .map(ToString::to_string)
+            .collect::<Vec<String>>()
+            .join(&separator);
+        if let Some(port) = self.trigger_port {
+            ports_str = port;
+        }
+
+        let mut final_call_format = String::new();
+        if let Some(call_format) = self.call_format {
+            final_call_format = call_format;
+        } else {
+            return Err(anyhow!("Failed to parse execution format."));
+        }
+        let default_template: Template = Template::new(&final_call_format);
+        let mut to_run = String::new();
+
+        if final_call_format.contains("{{script}}") {
+            let exec_parts_script: ExecPartsScript = ExecPartsScript {
+                script: self.path.unwrap().to_str().unwrap().to_string(),
+                ip: self.ip.to_string(),
+                port: ports_str,
+                ipversion: match &self.ip {
+                    IpAddr::V4(_) => String::from("4"),
+                    IpAddr::V6(_) => String::from("6"),
+                },
+            };
+            to_run = default_template.fill_with_struct(&exec_parts_script)?;
+        } else {
+            let exec_parts: ExecParts = ExecParts {
+                ip: self.ip.to_string(),
+                port: ports_str,
+                ipversion: match &self.ip {
+                    IpAddr::V4(_) => String::from("4"),
+                    IpAddr::V6(_) => String::from("6"),
+                },
+            };
+            to_run = default_template.fill_with_struct(&exec_parts)?;
+        }
+        debug!("\nScript format to run {to_run}");
+        execute_script(&to_run)
+    }
+}
+
+#[cfg(not(tarpaulin_include))]
+fn execute_script(script: &str) -> Result<String> {
+    debug!("\nScript arguments {script}");
+
+    let (cmd, arg) = if cfg!(unix) {
+        ("sh", "-c")
+    } else {
+        ("cmd.exe", "/c")
+    };
+
+    match Command::new(cmd)
+        .args([arg, script])
+        .stdin(Stdio::piped())
+        .stderr(Stdio::piped())
+        .output()
+    {
+        Ok(output) => {
+            let status = output.status;
+
+            let es = match status.code() {
+                Some(code) => code,
+                _ => {
+                    #[cfg(unix)]
+                    {
+                        status.signal().unwrap()
+                    }
+
+                    #[cfg(windows)]
+                    {
+                        return Err(anyhow!("Unknown exit status"));
+                    }
+                }
+            };
+
+            if es != 0 {
+                return Err(anyhow!("Exit code = {}", es));
+            }
+            Ok(String::from_utf8_lossy(&output.stdout).into_owned())
+        }
+        Err(error) => {
+            debug!("Command error {error}",);
+            Err(anyhow!(error.to_string()))
+        }
+    }
+}
+
+pub fn find_scripts(path: PathBuf) -> Result<Vec<PathBuf>> {
+    if path.is_dir() {
+        debug!("Scripts folder found {}", path.display());
+        let mut files_vec: Vec<PathBuf> = Vec::new();
+        for entry in fs::read_dir(path)? {
+            let entry = entry?;
+            files_vec.push(entry.path());
+        }
+        Ok(files_vec)
+    } else {
+        Err(anyhow!("Can't find scripts folder {}", path.display()))
+    }
+}
+
+#[derive(Debug, Clone, Deserialize)]
+pub struct ScriptFile {
+    pub path: Option<PathBuf>,
+    pub tags: Option<Vec<String>>,
+    pub developer: Option<Vec<String>>,
+    pub port: Option<String>,
+    pub ports_separator: Option<String>,
+    pub call_format: Option<String>,
+}
+
+impl ScriptFile {
+    fn new(script: PathBuf) -> Option<ScriptFile> {
+        let real_path = script.clone();
+        let mut lines_buf = String::new();
+        if let Ok(file) = File::open(script) {
+            for mut line in io::BufReader::new(file).lines().skip(1).flatten() {
+                if line.starts_with('#') {
+                    line.retain(|c| c != '#');
+                    line = line.trim().to_string();
+                    line.push('\n');
+                    lines_buf.push_str(&line);
+                } else {
+                    break;
+                }
+            }
+        } else {
+            debug!("Failed to read file: {}", real_path.display());
+            return None;
+        }
+        debug!("ScriptFile {} lines\n{}", real_path.display(), lines_buf);
+
+        match toml::from_str::<ScriptFile>(&lines_buf) {
+            Ok(mut parsed) => {
+                debug!("Parsed ScriptFile{} \n{:?}", real_path.display(), parsed);
+                parsed.path = Some(real_path);
+                // parsed_scripts.push(parsed);
+                Some(parsed)
+            }
+            Err(e) => {
+                debug!("Failed to parse ScriptFile headers {e}");
+                None
+            }
+        }
+    }
+}
+
+#[derive(Debug, Deserialize, Clone)]
+pub struct ScriptConfig {
+    pub tags: Option<Vec<String>>,
+    pub ports: Option<Vec<String>>,
+    pub developer: Option<Vec<String>>,
+    pub directory: Option<String>,
+}
+
+#[cfg(not(tarpaulin_include))]
+impl ScriptConfig {
+    pub fn read_config() -> Result<ScriptConfig> {
+        let Some(mut home_dir) = dirs::home_dir() else {
+            return Err(anyhow!("Could not infer ScriptConfig path."));
+        };
+        home_dir.push(".rustscan_scripts.toml");
+
+        let content = fs::read_to_string(home_dir)?;
+        let config = toml::from_str::<ScriptConfig>(&content)?;
+        Ok(config)
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn find_and_parse_scripts() {
+        let scripts = find_scripts("fixtures/.rustscan_scripts".into()).unwrap();
+        let scripts = parse_scripts(scripts);
+        assert_eq!(scripts.len(), 4);
+    }
+
+    #[test]
+    #[should_panic]
+    fn find_invalid_folder() {
+        let _scripts = find_scripts("Cargo.toml".into()).unwrap();
+    }
+
+    #[test]
+    #[should_panic]
+    fn open_script_file_invalid_headers() {
+        ScriptFile::new("fixtures/.rustscan_scripts/test_script_invalid_headers.txt".into())
+            .unwrap();
+    }
+
+    #[test]
+    #[should_panic]
+    fn open_nonexisting_script_file() {
+        ScriptFile::new("qwertyuiop.txt".into()).unwrap();
+    }
+
+    #[test]
+    fn parse_txt_script() {
+        let script_f =
+            ScriptFile::new("fixtures/.rustscan_scripts/test_script.txt".into()).unwrap();
+        assert_eq!(
+            script_f.tags,
+            Some(vec!["core_approved".to_string(), "example".to_string()])
+        );
+        assert_eq!(
+            script_f.developer,
+            Some(vec![
+                "example".to_string(),
+                "https://example.org".to_string()
+            ])
+        );
+        assert_eq!(script_f.ports_separator, Some(",".to_string()));
+        assert_eq!(
+            script_f.call_format,
+            Some("nmap -vvv -p {{port}} {{ip}}".to_string())
+        );
+    }
+
+    #[test]
+    fn test_custom_directory_config() {
+        // Create test config
+        let config_str = r#"
+            tags = ["core_approved", "example"]
+            directory = "fixtures/.rustscan_scripts"
+        "#;
+
+        let config: ScriptConfig = toml::from_str(config_str).unwrap();
+        assert_eq!(
+            config.directory,
+            Some("fixtures/.rustscan_scripts".to_string())
+        );
+
+        // Test that the directory is actually used
+        let script_dir_base = PathBuf::from(config.directory.unwrap());
+        let scripts = find_scripts(script_dir_base).unwrap();
+
+        // Verify we found the test script
+        assert!(scripts.iter().any(|p| p
+            .file_name()
+            .and_then(|f| f.to_str())
+            .map(|s| s == "test_script.txt")
+            .unwrap_or(false)));
+    }
+
+    #[test]
+    fn test_default_directory_fallback() {
+        let config_str = r#"
+            tags = ["core_approved", "example"]
+        "#;
+
+        let config: ScriptConfig = toml::from_str(config_str).unwrap();
+        assert_eq!(config.directory, None);
+
+        // Test fallback to home directory
+        let script_dir_base = if let Some(config_directory) = &config.directory {
+            PathBuf::from(config_directory)
+        } else {
+            dirs::home_dir().unwrap()
+        };
+
+        assert_eq!(script_dir_base, dirs::home_dir().unwrap());
+    }
+}

src/tui.rs

@@ -1,17 +1,21 @@
+//! Utilities for terminal output during scanning.
+
 /// Terminal User Interface Module for RustScan
 /// Defines macros to use
-
 #[macro_export]
 macro_rules! warning {
     ($name:expr) => {
-        use ansi_term::Colour::Red;
-        println!("{} {}", Red.bold().paint("[!]"), $name);
+        println!("{} {}", ansi_term::Colour::Red.bold().paint("[!]"), $name);
     };
-    // quiet mode
-    ($name:expr, $quiet:expr) => {
-        use ansi_term::Colour::Red;
-        if !$quiet {
-            println!("{} {}", Red.bold().paint("[!]"), $name);
+    ($name:expr, $greppable:expr, $accessible:expr) => {
+        // if not greppable then print, otherwise no else statement so do not print.
+        if !$greppable {
+            if $accessible {
+                // Don't print the ascii art
+                println!("{}", $name);
+            } else {
+                println!("{} {}", ansi_term::Colour::Red.bold().paint("[!]"), $name);
+            }
         }
     };
 }
@@ -19,28 +23,44 @@ macro_rules! warning {
 #[macro_export]
 macro_rules! detail {
     ($name:expr) => {
-        use ansi_term::Colour::Blue;
-        println!("{} {}", Blue.bold().paint("[~]"), $name);
+        println!("{} {}", ansi_term::Colour::Blue.bold().paint("[~]"), $name);
     };
-    ($name:expr, $quiet:expr) => {
-        use ansi_term::Colour::Blue;
-        if !$quiet {
-            println!("{} {}", Blue.bold().paint("[~]"), $name);
+    ($name:expr, $greppable:expr, $accessible:expr) => {
+        // if not greppable then print, otherwise no else statement so do not print.
+        if !$greppable {
+            if $accessible {
+                // Don't print the ascii art
+                println!("{}", $name);
+            } else {
+                println!("{} {}", ansi_term::Colour::Blue.bold().paint("[~]"), $name);
+            }
         }
     };
 }
 
 #[macro_export]
 macro_rules! output {
-    ($name:expr, $quiet:expr) => {
-        use ansi_term::Colour::RGB;
-        if !$quiet {
-            println!("{} {}", RGB(0, 255, 9).bold().paint("[>]"), $name);
-        }
-    };
     ($name:expr) => {
-        use ansi_term::Colour::RGB;
-        println!("{} {}", RGB(0, 255, 9).bold().paint("[>]"), $name);
+        println!(
+            "{} {}",
+            ansi_term::Colour::RGB(0, 255, 9).bold().paint("[>]"),
+            $name
+        );
+    };
+    ($name:expr, $greppable:expr, $accessible:expr) => {
+        // if not greppable then print, otherwise no else statement so do not print.
+        if !$greppable {
+            if $accessible {
+                // Don't print the ascii art
+                println!("{}", $name);
+            } else {
+                println!(
+                    "{} {}",
+                    ansi_term::Colour::RGB(0, 255, 9).bold().paint("[>]"),
+                    $name
+                );
+            }
+        }
     };
 }
 
@@ -48,17 +68,39 @@ macro_rules! output {
 macro_rules! funny_opening {
     // prints a funny quote / opening
     () => {
-        use rand::seq::SliceRandom;
+        use rand::seq::IndexedRandom;
         let quotes = vec![
             "Nmap? More like slowmap.🐢",
             "🌍HACK THE PLANET🌍",
             "Real hackers hack time ⌛",
             "Please contribute more quotes to our GitHub https://github.com/rustscan/rustscan",
             "😵 https://admin.tryhackme.com",
+            "0day was here ♥",
+            "I don't always scan ports, but when I do, I prefer RustScan.",
+            "RustScan: Where scanning meets swagging. 😎",
+            "To scan or not to scan? That is the question.",
+            "RustScan: Because guessing isn't hacking.",
+            "Scanning ports like it's my full-time job. Wait, it is.",
+            "Open ports, closed hearts.",
+            "I scanned my computer so many times, it thinks we're dating.",
+            "Port scanning: Making networking exciting since... whenever.",
+            "You miss 100% of the ports you don't scan. - RustScan",
+            "Breaking and entering... into the world of open ports.",
+            "TCP handshake? More like a friendly high-five!",
+            "Scanning ports: The virtual equivalent of knocking on doors.",
+            "RustScan: Making sure 'closed' isn't just a state of mind.",
+            "RustScan: allowing you to send UDP packets into the void 1200x faster than NMAP",
+            "Port scanning: Because every port has a story to tell.",
+            "I scanned ports so fast, even my computer was surprised.",
+            "Scanning ports faster than you can say 'SYN ACK'",
+            "RustScan: Where '404 Not Found' meets '200 OK'.",
+            "RustScan: Exploring the digital landscape, one IP at a time.",
+            "TreadStone was here 🚀",
+            "With RustScan, I scan ports so fast, even my firewall gets whiplash 💨",
+            "Scanning ports so fast, even the internet got a speeding ticket!",
         ];
-        let random_quote = quotes.choose(&mut rand::thread_rng()).unwrap();
+        let random_quote = quotes.choose(&mut rand::rng()).unwrap();
 
         println!("{}\n", random_quote);
-        // println!("{} {}", RGB(0, 255, 9).bold().paint("[>]"), $name);
     };
 }