Merge branch 'master' of github.com:brandonskerritt/RustScan into master

README.md tweaks

.all-contributorsrc

@@ -140,7 +140,9 @@
       "avatar_url": "https://avatars2.githubusercontent.com/u/7258858?v=4",
       "profile": "https://supersandro.de/",
       "contributions": [
-        "content"
+        "content",
+        "bug",
+        "code"
       ]
     },
     {
@@ -153,6 +155,15 @@
         "code",
         "bug"
       ]
+    },
+    {
+      "login": "niklasmohrin",
+      "name": "Niklas Mohrin",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/47574893?v=4",
+      "profile": "https://github.com/niklasmohrin",
+      "contributions": [
+        "doc"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.dockerignore

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

.travis.yml

@@ -1,60 +1,27 @@
 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 ] &&
@@ -65,3 +32,6 @@ after_success: |
     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=

Cargo.lock

@@ -759,7 +759,7 @@ dependencies = [
 
 [[package]]
 name = "rustscan"
-version = "1.7.1"
+version = "1.8.0"
 dependencies = [
  "ansi_term 0.12.1",
  "async-std",

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rustscan"
-version = "1.7.1"
+version = "1.8.0"
 authors = ["Bee <[email protected]>"]
 edition = "2018"
 description = "Faster Nmap Scanning with Rust"

Dockerfile

@@ -1,22 +1,16 @@
 FROM rust:alpine as builder
-RUN apk update && \
-    apk add build-base && \
-    rm -rf /var/cache/apk/*
+RUN apk add --no-cache build-base
 
 WORKDIR /usr/src/rustscan
 COPY . .
 RUN cargo install --path .
 
-FROM alpine
+FROM alpine:3.12
 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
+    adduser -S -G rustscan rustscan && \
+    ulimit -n 100000 && \
+    apk add --no-cache nmap nmap-scripts wget
+COPY --from=builder /usr/local/cargo/bin/rustscan /usr/local/bin/rustscan
 USER rustscan
-ENTRYPOINT ["/usr/local/bin/rustscan"]
+ENTRYPOINT [ "/usr/local/bin/rustscan" ]

README.md

@@ -5,7 +5,7 @@
  <a href="https://github.com/RustScan/RustScan#-usage">Usage Guide</a>
  ⬅️
 <br>
-<img src="https://github.com/RustScan/RustScan/blob/master/pictures/rustscan.png?raw=true">
+<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.
@@ -34,27 +34,7 @@
 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="https://github.com/RustScan/RustScan/blob/master/pictures/with_rustscan.gif?raw=true" alt="The guy she tells you not to worry about"></td>
-    <td><img src="https://github.com/RustScan/RustScan/blob/master/pictures/without_rustscan.gif?raw=true" alt="You"></td>
-  </tr>
-  <tr>
-  <th>Time</th>
-    <td><b>39 seconds</b></td>
-    <td><b>17 minutes and 41 seconds</b></td>
-  </tr>
-</table>
 
-<sub><b>Note</b> This is an older gif. RustScan's current top speed is 3 seconds for all 65k ports. This gif is 26 seconds.</sub><br>
-
-RustScans **only** job is to reduce the friction between finding open ports and inputting them into nmap.
 
 # ✨ Features
 * Scans all 65k ports in **8 seconds** (on 10k batch size).
@@ -136,7 +116,7 @@ We strongly recommend using the `alpine` tag, as this is the latest major - stab
 
 Simply run this command against the IP you want to target:
 
-```
+```bash
 docker run -it --rm --name rustscan rustscan/rustscan:alpine <rustscan arguments here> <ip address to scan>
 ```
 
@@ -146,30 +126,30 @@ Once done, you will no longer need to re-download the image (except when RustSca
 
 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 rustscan/rustscan:alpine <rustscan arguments here> <ip address to scan>'
+```bash
+alias rustscan='docker run -it --rm --name rustscan rustscan/rustscan:alpine'
 ```
 
 Then we can:
 
-```
+```bash
 rustscan 127.0.0.1 -t 500 -b 1500 -- -A
 ```
 
 #### To build your own image:
 
 Download the repo:
-```
+```bash
 git clone https://github.com/RustScan/RustScan.git
 ```
 
 Ensure you navigate to the download location of the repo:
-```
+```bash
 cd /path/to/download/RustScan
 ```
 
 Build away!
-```
+```bash
 docker build -t <yourimagename> .
 ```
 
@@ -179,13 +159,13 @@ docker build -t <yourimagename> .
 
 Tap the brew:
 
-```
+```bash
 brew tap brandonskerritt/rustscan
 ```
 
 Install it:
 
-```
+```bash
 brew install rustscan
 ```
 
@@ -208,11 +188,9 @@ If you maintain a community distribution and want it listed here, leave an issue
 
 # 🤸 Usage
 
-```
-rustscan -h
-```
+```console
+$ rustscan -h
 
-```
 Fast Port Scanner built in Rust. WARNING Do not use this program against sensitive infrastructure since the specified
 server may not be able to handle this many socket connections at once. - Discord https://discord.gg/GFrQsGy - GitHub
 https://github.com/RustScan/RustScan
@@ -287,7 +265,7 @@ Decreasing batch size slows down the program, so as long as it isn't too drastic
 
 Run these 3 commands:
 
-```
+```bash
 ulimit -a
 ulimit -Hn
 ulimit -Sn
@@ -301,7 +279,7 @@ Increasing the open file limit increases speed, but poses danger. Although, **op
 
 To open more, set the ulimit to a higher number:
 
-```
+```bash
 ulimit -n 5000
 ```
 
@@ -381,7 +359,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-15-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-16-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)):
@@ -406,10 +384,11 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <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></td>
+    <td align="center"><a href="https://supersandro.de/"><img src="https://avatars2.githubusercontent.com/u/7258858?v=4" width="100px;" alt=""/><br /><sub><b>Sandro</b></sub></a><br /><a href="#content-SuperSandro2000" title="Content">🖋</a> <a href="https://github.com/RustScan/RustScan/issues?q=author%3ASuperSandro2000" title="Bug reports">🐛</a> <a href="https://github.com/RustScan/RustScan/commits?author=SuperSandro2000" title="Code">💻</a></td>
   </tr>
   <tr>
     <td align="center"><a href="https://swag.lgbt"><img src="https://avatars2.githubusercontent.com/u/25358963?v=4" width="100px;" alt=""/><br /><sub><b>Cass</b></sub></a><br /><a href="#platform-caass" title="Packaging/porting to new platform">📦</a> <a href="https://github.com/RustScan/RustScan/commits?author=caass" title="Code">💻</a> <a href="https://github.com/RustScan/RustScan/issues?q=author%3Acaass" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://github.com/niklasmohrin"><img src="https://avatars0.githubusercontent.com/u/47574893?v=4" width="100px;" alt=""/><br /><sub><b>Niklas Mohrin</b></sub></a><br /><a href="https://github.com/RustScan/RustScan/commits?author=niklasmohrin" title="Documentation">📖</a></td>
   </tr>
 </table>