15 stable releases

2.0.0 Nov 5, 2020
1.10.0 Sep 28, 2020
1.8.0 Aug 27, 2020
1.4.0 Jul 31, 2020

#282 in Command line utilities

Download history 54/week @ 2021-08-14 44/week @ 2021-08-21 53/week @ 2021-08-28 50/week @ 2021-09-04 50/week @ 2021-09-11 43/week @ 2021-09-18 41/week @ 2021-09-25 62/week @ 2021-10-02 70/week @ 2021-10-09 66/week @ 2021-10-16 58/week @ 2021-10-23 40/week @ 2021-10-30 60/week @ 2021-11-06 58/week @ 2021-11-13 75/week @ 2021-11-20 48/week @ 2021-11-27

246 downloads per month

MIT license

94KB
1.5K SLoC

➡️ Discord | Installation Guide | Usage Guide ⬅️

The Modern Port Scanner.
Fast, smart, effective.

AUR version GitHub All Releases Crates.io Discord Actions


🐋 Docker (Recommended)

👩‍💻 Kali / Debian

🏗️ Arch

🔧 Homebrew

docker pull rustscan/rustscan:2.0.0

Usage

Read the install guide yay -S rustscan brew install rustscan

🤔 What is this?

fast

The Modern Port Scanner. Find ports quickly (3 seconds at its fastest). Run scripts through our scripting engine (Python, Lua, Shell supported).

✨ 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
📖 Installation Guide 📚 Documentation 🦜 Discord

🙋 Table of Contents

🔭 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 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 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 1 person, but more often than not 2 people review it. We test it manually and make sure the code doesn't affect performance negatively.

Read more here.

⚙️ Extensible

scripts

RustScan piping results into the custom Python script

RustScan has a new scripting engine which allows anyone to write scripts in most languages. Python, Lua, 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.

🌊 Adaptive

adaptive

RustScan automatically fine-tuning 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.

This is an umbrella term we use for any feature that fits this criteria. The list is constantly changing, so check out our wiki for more information.

👩‍🦯 Accessible

fast

RustScan is one of the first penetration testing tools that aims to be entirely accessible.

Most penetration testing tools are not accessible, which negatively affects the whole industry.

RustScan has continuous integration testing that aims to make sure it is accessible, and we are constantly working on ways to improve our accessibility and make sure everyone can use RustScan.

📖 Full Installation Guide

You can find our guide here.

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

Packaging status

🤸 Usage

We have 2 usage guides. Basic Usage and Things you may want to do.

We also have documentation about our config file here.

🎪 Community

Read this to learn how to contribute.

Contributors ✨

All Contributors

Thanks goes to these wonderful people (emoji key):


Brandon

🚇 ⚠️ 💻 🎨

SakiiR

💻 🐛

smackhack

🤔 💡

Bernardo Araujo

💻 🐛 🎨

Izzy Whistlecroft

🐛

imlonghao

🐛 🚧

royharoush

🤔 🎨

Atul Bhosale

💻

Thomas Gotwig

📦

Rémi Gourdon

📖 💻

Ben (CMNatic)

💻 📖 🎨

Alessandro Ferrari

🖋

Phenomite

🖋

Sandro

🖋 🐛 💻

Cass

📦 💻 🐛

Niklas Mohrin

📖 💻 🐛

Artem Polishchuk

📦

buermarc

💻

bergabman

💻 🐛 🎨

Dmitry Savintsev

💻

Sebastian Andersson

💻

Matt Corbin

💻

RootSploit

📝

eiffel-fl

💻

Y.Horie

💻

Oskar

💻 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!

Dependencies

~23MB
~508K SLoC