➡️
Discord |
Installation Guide |
Usage Guide
⬅️
👽 The Modern Day Port Scanner 👽
|
|
|
|
docker pull rustscan/rustscan:alpine |
Read the install guide | yay -S rustscan |
cargo install rustscan |
🤔 What is this?
RustScan is the port scanner for the modern world. Built with speed & you in mind.
✨ Features
- Scans all 65k ports in 3 seconds (max speed) or as slow as you'd like
- Saves you time by automatically piping it into Nmap. No more manual copying and pasting!
- Adaptive Learning System. The scanner learns how you use it and improves itself over time.
- Intuitive Scripting Engine support. Write scripts in Python!
- IPv6, CIDR, top ports, multiple IP scanning, host resolution, and more!
‼️ Important Links
| Installation Guide | Documentation | Discord |
|---|---|---|
| 📖 Installation Guide | 📚 Documentation | 🦜 Discord |
🔭 Why RustScan?
RustScan is a port scanner built for the modern day world. Initially created to aid in CTFs, but now expanded to real world usage.
One of RustScan's most popular features is the Nmap extension. Quickly scan ports with RustScan, run Nmap on the found ports.
RustScan running in 8 seconds and finding all open ports out of 65k.
Packages
🎪 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.
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
- 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
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 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
Contributors ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!