RustScan
➡️
Discord |
Installation Guide |
Usage Guide
⬅️
The Modern Port Scanner.
Fast, smart, effective.
| <p align="center">🐋 Docker (Recommended) </p> | <p align="center">👩💻 Kali / Debian </p> | <p align="center">🏗️ Arch </p> | <p align="center">🔧 Homebrew </p> |
|---|---|---|---|
<p align="center"> </p> |
<p align="center"> </p> |
<p align="center"> </p> |
<p align="center"> </p> |
docker pull rustscan/rustscan:2.0.0 <p>Usage |
Read the install guide | yay -S rustscan |
brew install rustscan |
🤔 What is this?
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
- 📖 Installation Guide
- 🐋 Docker Usage
- 🦜 Discord
- 🤸 Usage
- 🎪 Community
🔭 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
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.
⚙️ Extensible
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.
🌊 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
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.
🤸 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 ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!