Merge branch 'master' into ba-add-host-resolution

Merge pull request #155 from CMNatic/master
Updated README to use the rustscan dockerhub alpine image
2026-11-07 17:02:04 -10:00 · 2020-08-16 18:11:27 -04:00 · 2020-08-16 22:39:10 +01:00 · 2020-08-16 22:37:51 +01:00 · 2020-08-16 22:28:57 +01:00 · 2020-08-16 11:52:11 -04:00
9 changed files with 320 additions and 76 deletions
@@ -68,12 +68,6 @@
      ]
    },
    {
-      "login": "Atul9",
-      "name": "Atul Bhosale",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/3390330?v=4",
-      "profile": "https://github.com/Atul9",
-      "contributions": [
-        "doc"
      "login": "royharoush",
      "name": "royharoush",
      "avatar_url": "https://avatars3.githubusercontent.com/u/8113056?v=4",
@@ -82,6 +76,45 @@
        "ideas",
        "design"
      ]
+    },
+    {
+      "login": "Atul9",
+      "name": "Atul Bhosale",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/3390330?v=4",
+      "profile": "https://github.com/Atul9",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "TGotwig",
+      "name": "Thomas Gotwig",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/30773779?v=4",
+      "profile": "https://tgotwig.me",
+      "contributions": [
+        "platform"
+      ]
+    },
+    {
+      "login": "remigourdon",
+      "name": "Rémi Gourdon",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/2874133?v=4",
+      "profile": "https://github.com/remigourdon",
+      "contributions": [
+        "doc",
+        "code"
+      ]
+    },
+    {
+      "login": "cmnatic",
+      "name": "Ben (CMNatic)",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/4163116?v=4",
+      "profile": "https://cmnatic.co.uk",
+      "contributions": [
+        "code",
+        "doc",
+        "design"
+      ]
    }
  ],
  "contributorsPerLine": 7,
@@ -51,16 +51,63 @@ dependencies = [
 ]

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

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

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

@@ -324,7 +369,7 @@ dependencies = [
 "futures-core",
 "futures-io",
 "memchr",
- "parking",
+ "parking 1.0.6",
 "pin-project-lite",
 "waker-fn",
 ]
@@ -465,6 +510,17 @@ version = "2.3.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "3728d817d99e5ac407411fa471ff9800a778d88a24685968b36824eaf4bee400"

+[[package]]
+name = "multitask"
+version = "0.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c09c35271e7dcdb5f709779111f2c8e8ab8e06c1b587c1c6a9e179d865aaa5b4"
+dependencies = [
+ "async-task",
+ "concurrent-queue",
+ "fastrand",
+]
+
 [[package]]
 name = "num_cpus"
 version = "1.13.0"
@@ -487,6 +543,12 @@ version = "1.0.6"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "6cb300f271742d4a2a66c01b6b2fa0c83dfebd2e0bf11addb879a3547b4ed87c"

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

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

 [[package]]
 name = "rlimit"
-version = "0.3.0"
+version = "0.4.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e6d26e65e82a1e2628c5f209ec12f4508fa50e644bd2f264138e60129d61eae8"
+checksum = "49b02d62c38353a6fce45c25ca19783e25dd5f495ca681c674a4ee15aa4c1536"
 dependencies = [
 "cfg-if",
 "libc",
@@ -720,27 +794,6 @@ version = "0.4.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "c111b5bd5695e56cffe5129854aa230b39c93a305372fdbb2668ca2394eea9f8"

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

+[[package]]
+name = "vec-arena"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "17dfb54bf57c9043f4616cb03dab30eff012cc26631b797d8354b916708db919"
+
 [[package]]
 name = "vec_map"
 version = "0.8.2"
@@ -16,9 +16,9 @@ readme="README.md"
 [dependencies]
 colored = "2.0.0"
 structopt = "0.3.16"
-async-std = "1.6.2"
+async-std = "1.6.3"
 futures = "0.3"
-rlimit = "0.3.0"
+rlimit = "0.4.0"
 shell-words = "1.0.0"
 log = "0.4.0"
 env_logger = "0.7.1"
@@ -0,0 +1,22 @@
+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"]
@@ -0,0 +1,21 @@
+install:
+	cargo install cross
+
+build:
+	make build-linux
+	make build-mac
+
+	make shasum
+
+build-linux:
+	@echo 'Building for Linux... 🐧'
+	cross build --release --target=x86_64-unknown-linux-musl
+	mkdir -p target/release-archives && tar -czf target/release-archives/rustscan-linux.tar.gz target/x86_64-unknown-linux-musl/release/rustscan 
+
+build-mac:
+	@echo 'Building for MacOS... 🍏'
+	cross build --release --target=x86_64-apple-darwin
+	mkdir -p target/release-archives && tar -czf target/release-archives/rustscan-mac.tar.gz target/x86_64-apple-darwin/release/rustscan
+
+shasum:
+	shasum -a 256 target/release-archives/rustscan-*.tar.gz
@@ -24,7 +24,7 @@
 | <p align="center"><a href="https://hub.docker.com/r/cmnatic/rustscan">🐋 Docker (Recommended) </a></p> | <p align="center"><a href="https://github.com/RustScan/RustScan/releases">👩‍💻 Kali / Debian </p> | <p align="center"><a href="https://aur.archlinux.org/packages/rustscan/">🏗️ Arch </a></p> | <p align="center"><a href="https://crates.io/crates/rustscan">🔧 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`
+| `docker pull rustscan/rustscan:alpine` <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`

 <hr>

@@ -122,22 +122,32 @@ Docker is the recommended way of installing RustScan. This is because:

 To install Docker, [follow their guide](https://docs.docker.com/engine/install/).

-**Once Docker is installed, run this command against the IP you want to target.**
+**Once Docker is installed, you can either build your own image using the `Dockerfile` (alpine) provided in the repo, or alternatively, use the published Docker image like below (most convenient)**
+
+Please see our [DockerHub](https://hub.docker.com/repository/docker/rustscan/rustscan) for further info, however, note that we have two Docker images:
+```
+rustscan/rustscan:alpine
+
+rustscan/rustscan:latest
+```
+We strongly recommend using the `alpine` tag, as this is the latest major - stable - release of RustScan. This READMDE uses the `alpine` image by default, however, note that the`latest` image is considered experimental.
+
+#### To get started:
+
+Simply run this command against the IP you want to target:

 ```
-docker run -it --rm --name rustscan cmnatic/rustscan:debian-buster rustscan 127.0.0.1
+docker run -it --rm --name rustscan rustscan/rustscan:alpine <rustscan arguments here> <ip address to scan>
 ```

 Note: this will scan the Docker's localhost, not your own.

-This will download the Docker image.
-
 Once done, you will no longer need to re-download the image (except when RustScan updates) and can use RustScan like a normal application.

 You will have to run this command every time, so we suggest aliasing it to something memorable.

 ```
-alias rustscan='docker run -it --rm --name rustscan cmnatic/rustscan:debian-buster rustscan'
+alias rustscan='docker run -it --rm --name rustscan rustscan/rustscan:alpine <rustscan arguments here> <ip address to scan>'
 ```

 Then we can:
@@ -146,6 +156,23 @@ 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
+```
+
+Ensure you navigate to the download location of the repo:
+```
+cd /path/to/download/RustScan
+```
+
+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.
@@ -240,7 +267,7 @@ You can also use both of these at the same time, to make it as slow or as fast a

 **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
+## 🚨 Thread Panicked at Main: Too Many Open Files
 This is the most common error found in RustScan.

 The open file limit is how many open sockets you can have at any given time.
@@ -353,7 +380,7 @@ Please read the [contributing.md file](contributing.md)

 ## Contributors ✨
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-11-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)):
@@ -369,9 +396,14 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
    <td align="center"><a href="http://bernardoamc.github.io/"><img src="https://avatars0.githubusercontent.com/u/428984?v=4" width="100px;" alt=""/><br /><sub><b>Bernardo Araujo</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=bernardoamc" title="Code">💻</a> <a href="https://github.com/RustScan/RustScan/issues?q=author%3Abernardoamc" title="Bug reports">🐛</a> <a href="#design-bernardoamc" title="Design">🎨</a></td>
    <td align="center"><a href="https://github.com/Isona"><img src="https://avatars2.githubusercontent.com/u/11759523?v=4" width="100px;" alt=""/><br /><sub><b>Izzy Whistlecroft</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/issues?q=author%3AIsona" title="Bug reports">🐛</a></td>
    <td align="center"><a href="https://imlonghao.com"><img src="https://avatars1.githubusercontent.com/u/4951333?v=4" width="100px;" alt=""/><br /><sub><b>imlonghao</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/issues?q=author%3Aimlonghao" title="Bug reports">🐛</a> <a href="#maintenance-imlonghao" title="Maintenance">🚧</a></td>
-    <td align="center"><a href="https://github.com/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="Documentation">📖</a></td>
    <td align="center"><a href="https://github.com/royharoush"><img src="https://avatars3.githubusercontent.com/u/8113056?v=4" width="100px;" alt=""/><br /><sub><b>royharoush</b></sub></a><br /><a href="#ideas-royharoush" title="Ideas, Planning, & Feedback">🤔</a> <a href="#design-royharoush" title="Design">🎨</a></td>
  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/Atul9"><img src="https://avatars1.githubusercontent.com/u/3390330?v=4" width="100px;" alt=""/><br /><sub><b>Atul Bhosale</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=Atul9" title="Code">💻</a></td>
+    <td align="center"><a href="https://tgotwig.me"><img src="https://avatars0.githubusercontent.com/u/30773779?v=4" width="100px;" alt=""/><br /><sub><b>Thomas Gotwig</b></sub></a><br /><a href="#platform-TGotwig" title="Packaging/porting to new platform">📦</a></td>
+    <td align="center"><a href="https://github.com/remigourdon"><img src="https://avatars3.githubusercontent.com/u/2874133?v=4" width="100px;" alt=""/><br /><sub><b>Rémi Gourdon</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=remigourdon" title="Documentation">📖</a> <a href="https://github.com/RustScan/RustScan/commits?author=remigourdon" title="Code">💻</a></td>
+    <td align="center"><a href="https://cmnatic.co.uk"><img src="https://avatars3.githubusercontent.com/u/4163116?v=4" width="100px;" alt=""/><br /><sub><b>Ben (CMNatic)</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=cmnatic" title="Code">💻</a> <a href="https://github.com/RustScan/RustScan/commits?author=cmnatic" title="Documentation">📖</a> <a href="#design-cmnatic" title="Design">🎨</a></td>
+  </tr>
 </table>

 <!-- markdownlint-enable -->
@@ -8,7 +8,7 @@ TL;DR if you abuse members of our community you will be **perma-banned** with no

 RustScan has 2 major labels for GitHub issues you should look at:
 * Good First issue
-These are issues for newcomers to open source! 
+These are issues for newcomers to open source!
 [https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22](https://github.com/RustScan/RustScan/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
 * Help wanted
 These are issues that aren't really for newcomers, but we could still do wiht help!
@@ -16,7 +16,7 @@ These are issues that aren't really for newcomers, but we could still do wiht he

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

-The flow for contributing to open source software is:
+The [flow for contributing](https://guides.github.com/introduction/flow/) to open source software is:
 * Fork the repo
 * Make changes
 * Pull request to the repo
@@ -15,7 +15,8 @@ use rlimit::Resource;
 use rlimit::{getrlimit, setrlimit};
 use std::collections::HashMap;
 use std::process::Command;
-use std::{net::IpAddr, time::Duration};
+use std::str::FromStr;
+use std::{net::IpAddr, net::ToSocketAddrs, time::Duration};
 use structopt::{clap::arg_enum, StructOpt};

 extern crate colorful;
@@ -47,9 +48,9 @@ arg_enum! {
 /// - 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>,
+    /// A list of comma separated IP addresses or hosts to be scanned.
+    #[structopt(use_delimiter = true, required = true)]
+    ips_or_hosts: Vec<String>,

    ///Quiet mode. Only output the ports. No Nmap. Useful for grep or outputting to a file.
    #[structopt(short, long)]
@@ -103,11 +104,18 @@ fn main() {
        print_opening();
    }

+    let ips: Vec<IpAddr> = parse_ips(&opts);
+
+    if ips.is_empty() {
+        warning!("No IPs could be resolved, aborting scan.", false);
+        std::process::exit(1);
+    }
+
    let ulimit: rlimit::rlim = adjust_ulimit_size(&opts);
    let batch_size: u16 = infer_batch_size(&opts, ulimit);

    let scanner = Scanner::new(
-        &opts.ips,
+        &ips,
        batch_size,
        Duration::from_millis(opts.timeout.into()),
        opts.quiet,
@@ -124,7 +132,7 @@ fn main() {
            .push(socket.port());
    }

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

        let x = format!("{} Looks like I didn't find any open ports for {:?}. This is usually caused by a high batch size.
        \n*I used {} batch size, consider lowering to {} with {} or a comfortable number for your system.
-        \n Alternatively, increase the timeout if your ping is high. Rustscan -T 2000 for 2000 second timeout.\n",
+        \n Alternatively, increase the timeout if your ping is high. Rustscan -t 2000 for 2000 second timeout.\n",
        "ERROR",
        ip,
        opts.batch_size,
@@ -229,6 +237,25 @@ fn build_nmap_arguments<'a>(
    arguments
 }

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

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

    #[test]
    fn batch_size_lowered() {
        let opts = Opts {
-            ips: vec![IpAddr::from_str("127.0.0.1").unwrap()],
+            ips_or_hosts: vec!["127.0.0.1".to_owned()],
            quiet: true,
            batch_size: 50_000,
            timeout: 1_000,
@@ -312,7 +338,7 @@ mod tests {
    #[test]
    fn batch_size_lowered_average_size() {
        let opts = Opts {
-            ips: vec![IpAddr::from_str("127.0.0.1").unwrap()],
+            ips_or_hosts: vec!["127.0.0.1".to_owned()],
            quiet: true,
            batch_size: 50_000,
            timeout: 1_000,
@@ -330,7 +356,7 @@ mod tests {
        // because ulimit and batch size are same size, batch size is lowered
        // to ULIMIT - 100
        let opts = Opts {
-            ips: vec![IpAddr::from_str("127.0.0.1").unwrap()],
+            ips_or_hosts: vec!["127.0.0.1".to_owned()],
            quiet: true,
            batch_size: 50_000,
            timeout: 1_000,
@@ -347,7 +373,7 @@ mod tests {
    fn batch_size_adjusted_2000() {
        // ulimit == batch_size
        let opts = Opts {
-            ips: vec![IpAddr::from_str("127.0.0.1").unwrap()],
+            ips_or_hosts: vec!["127.0.0.1".to_owned()],
            quiet: true,
            batch_size: 50_000,
            timeout: 1_000,
@@ -369,7 +395,7 @@ mod tests {
    #[test]
    fn test_high_ulimit_no_quiet_mode() {
        let opts = Opts {
-            ips: vec![IpAddr::from_str("127.0.0.1").unwrap()],
+            ips_or_hosts: vec!["127.0.0.1".to_owned()],
            quiet: false,
            batch_size: 10,
            timeout: 1_000,
@@ -383,4 +409,55 @@ mod tests {

        assert!(1 == 1);
    }
+
+    #[test]
+    fn parse_correct_ips_or_hosts() {
+        let opts = Opts {
+            ips_or_hosts: vec!["127.0.0.1".to_owned(), "google.com".to_owned()],
+            quiet: true,
+            batch_size: 10,
+            timeout: 1_000,
+            ulimit: Some(2_000),
+            command: Vec::new(),
+            accessible: false,
+            scan_order: ScanOrder::Serial,
+        };
+        let ips = parse_ips(&opts);
+
+        assert_eq!(2, ips.len());
+    }
+
+    #[test]
+    fn parse_correct_and_incorrect_ips_or_hosts() {
+        let opts = Opts {
+            ips_or_hosts: vec!["127.0.0.1".to_owned(), "im_wrong".to_owned()],
+            quiet: true,
+            batch_size: 10,
+            timeout: 1_000,
+            ulimit: Some(2_000),
+            command: Vec::new(),
+            accessible: false,
+            scan_order: ScanOrder::Serial,
+        };
+        let ips = parse_ips(&opts);
+
+        assert_eq!(1, ips.len());
+    }
+
+    #[test]
+    fn parse_incorrect_ips_or_hosts() {
+        let opts = Opts {
+            ips_or_hosts: vec!["im_wrong".to_owned(), "300.10.1.1".to_owned()],
+            quiet: true,
+            batch_size: 10,
+            timeout: 1_000,
+            ulimit: Some(2_000),
+            command: Vec::new(),
+            accessible: false,
+            scan_order: ScanOrder::Serial,
+        };
+        let ips = parse_ips(&opts);
+
+        assert_eq!(0, ips.len());
+    }
 }
@@ -12,14 +12,14 @@ use std::{
 };

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

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

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

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

@@ -91,7 +91,7 @@ impl Scanner {
    ///
    ///     self.scan_port(10:u16)
    ///
-    /// Note: `self` must contain `self.host`.
+    /// Note: `self` must contain `self.ip`.
    async fn scan_socket(&self, socket: SocketAddr) -> io::Result<SocketAddr> {
        match self.connect(socket).await {
            Ok(x) => {
@@ -119,9 +119,9 @@ impl Scanner {
    /// # Example
    ///
    ///     let port: u16 = 80
-    ///     // Host is an IpAddr type
-    ///     let host = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
-    ///     let socket = SocketAddr::new(host, port);
+    ///     // ip is an IpAddr type
+    ///     let ip = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
+    ///     let socket = SocketAddr::new(ip, port);
    ///     self.connect(socket)
    ///     // returns Result which is either Ok(stream) for port is open, or Er for port is closed.
    ///     // Timeout occurs after self.timeout seconds
Author	SHA1	Message	Date
Bernardo Araujo	9fbf39f0cc	Merge branch 'master' into ba-add-host-resolution	2020-08-16 18:11:27 -04:00
Ben (CMNatic)	14b6ea928d	Merge pull request #155 from CMNatic/master Updated README to use the rustscan dockerhub alpine image	2020-08-16 22:39:10 +01:00
Ben (CMNatic)	9452b1f922	Update README to add a disclaimer about the DockerHub Images + Instruct user to use the `alpine` image as it's considered the latest major release as per the release page + Formatting instructions	2020-08-16 22:37:51 +01:00
Ben (CMNatic)	ed12888e81	Updated README to use the rustscan dockerhub alpine image + Added another step to clarify process for Docker as the build will fail if the user is not in the downloaded repo + DockerHub has CI with master branch and two images tags `latest` and `alpine` where `alpine` is tagged on feature releases (currently 1.7.1)	2020-08-16 22:28:57 +01:00
Bernardo Chaves	f68abcb955	Add host resolution For now if we can establish a socket on port 80 we can infer the IP of the host. This might change in the future if we start considering other ports like 443.	2020-08-16 11:52:11 -04:00
Brandon	4c91e8fb40	Merge pull request #153 from andy5995/docs docs: fix typo in README.md, link to GitHub flow in contributing doc	2020-08-15 11:08:03 +01:00
andy5995	1d3e831066	docs: fix typo in README.md, link to GitHub flow in contributing doc	2020-08-15 02:05:20 -05:00
dependabot-preview[bot]	ff6b1c40db	Merge pull request #151 from RustScan/dependabot/cargo/async-std-1.6.3	2020-08-15 00:58:44 +00:00
dependabot-preview[bot]	5573d91a7b	Bump async-std from 1.6.2 to 1.6.3 Bumps [async-std](https://github.com/async-rs/async-std) from 1.6.2 to 1.6.3. - [Release notes](https://github.com/async-rs/async-std/releases) - [Changelog](https://github.com/async-rs/async-std/blob/master/CHANGELOG.md) - [Commits](https://github.com/async-rs/async-std/commits/v1.6.3) Signed-off-by: dependabot-preview[bot] <[email protected]>	2020-08-14 08:38:10 +00:00
Brandon	a8e56eec4b	Merge pull request #149 from RustScan/all-contributors/add-cmnatic docs: add cmnatic as a contributor	2020-08-13 22:56:14 +01:00
Brandon	fb75c9d332	Merge branch 'master' into all-contributors/add-cmnatic	2020-08-13 22:43:56 +01:00
Ben (CMNatic)	581ec27cb5	Merge pull request #148 from CMNatic/master Updated README to include instructions on building the new Dockerfile	2020-08-13 20:25:05 +01:00
allcontributors[bot]	9673c8807d	docs: update .all-contributorsrc [skip ci]	2020-08-13 19:24:12 +00:00
allcontributors[bot]	78818d6bc7	docs: update README.md [skip ci]	2020-08-13 19:24:11 +00:00
Ben (CMNatic)	d0ff597be6	Updated README to include instructions on building the new Dockerfile	2020-08-13 20:11:58 +01:00
Ben (CMNatic)	516ebe367a	Merge pull request #118 from Hydragyrum/feature/create-alpine-based-dockerfile Feature/create alpine based dockerfile	2020-08-13 19:41:52 +01:00
Ben (CMNatic)	1e9660e4ff	Merge branch 'master' into feature/create-alpine-based-dockerfile	2020-08-13 19:32:13 +01:00
Brandon	7b4dda5a19	Merge pull request #147 from RustScan/dependabot/cargo/rlimit-0.4.0 Bump rlimit from 0.3.0 to 0.4.0	2020-08-13 11:40:23 +01:00
dependabot-preview[bot]	a20b71191d	Bump rlimit from 0.3.0 to 0.4.0 Bumps [rlimit](https://github.com/Nugine/rlimit) from 0.3.0 to 0.4.0. - [Release notes](https://github.com/Nugine/rlimit/releases) - [Commits](https://github.com/Nugine/rlimit/compare/v0.3.0...v0.4.0) Signed-off-by: dependabot-preview[bot] <[email protected]>	2020-08-13 08:36:23 +00:00
Brandon	18c5dd69e5	Merge pull request #145 from RustScan/all-contributors/add-TGotwig docs: add TGotwig as a contributor	2020-08-11 19:45:15 +01:00
Brandon	090264ac26	Merge branch 'master' into all-contributors/add-TGotwig	2020-08-11 19:32:11 +01:00
Bernardo Araujo	702681606f	Merge pull request #146 from RustScan/bee-fix-spelling fixed spelling mistake	2020-08-10 20:59:20 -04:00
Brandon	c58ac613c9	fixed spelling mistake	2020-08-11 01:47:25 +01:00
Brandon	44b53fb877	Merge pull request #143 from RustScan/all-contributors/add-remigourdon docs: add remigourdon as a contributor	2020-08-10 21:47:24 +01:00
Brandon	99e72e4a16	Merge branch 'master' into all-contributors/add-remigourdon	2020-08-10 21:12:53 +01:00
Brandon	e02073bd97	Merge pull request #144 from TGotwig/master Add Makefile for cross-compiling to Linux & Mac 👷‍♂️	2020-08-10 21:12:34 +01:00
allcontributors[bot]	59bb72426d	docs: update .all-contributorsrc [skip ci]	2020-08-10 19:57:32 +00:00
allcontributors[bot]	f48590c238	docs: update README.md [skip ci]	2020-08-10 19:57:31 +00:00
tgotwig	a3eb548ae9	Add Makefile for cross-compiling to Linux & Mac 👷‍♂️	2020-08-10 15:04:06 +02:00
allcontributors[bot]	050a8baf48	docs: update .all-contributorsrc [skip ci]	2020-08-10 12:39:34 +00:00
allcontributors[bot]	9b893dbf71	docs: update README.md [skip ci]	2020-08-10 12:39:33 +00:00
Brandon	8245ccf31e	Fixing all contributors	2020-08-10 13:38:53 +01:00
Brandon	301a656006	Merge pull request #138 from RustScan/ba-update-readme-instructions Update documentation	2020-08-10 13:02:21 +01:00
Adam Bertrand	8b363571f1	Merge branch 'master' into feature/create-alpine-based-dockerfile	2020-08-05 21:52:34 +02:00
Hydragyrum	0fa11f6e51	Add a non-privileged user to run rustscan	2020-08-05 18:53:06 +02:00
Adam Bertrand	d423f34e7a	Merge branch 'master' into feature/create-alpine-based-dockerfile	2020-08-05 18:25:54 +02:00
Hydragyrum	e17f9d0bb1	Add newline to dockerfile	2020-08-04 23:18:12 +02:00
Hydragyrum	3329428766	Create a basic Alpine-Based Dockerfile	2020-08-04 23:17:30 +02:00