routersploit README

The project's README from github.com/threat9/routersploit. As one markdown file: README.md.

RouterSploit - Exploitation Framework for Embedded Devices

Python 3.6 Build Status

Community

Join community on Embedded Exploitation Discord.

Description

The RouterSploit Framework is an open-source exploitation framework dedicated to embedded devices.

asciicast

It consists of various modules that aid penetration testing operations:

Installation

Requirements

Required:

Optional:

Installation on Kali Linux

apt-get install python3-pip
git clone https://www.github.com/threat9/routersploit
cd routersploit
python3 -m pip install -r requirements.txt
python3 rsf.py

Bluetooth Low Energy support:

apt-get install libglib2.0-dev
python3 -m pip install bluepy
python3 rsf.py

Installation on Ubuntu 20.04

sudo apt-get install git python3-pip
git clone https://github.com/threat9/routersploit
cd routersploit
python3 -m pip install -r requirements.txt
python3 rsf.py

Bluetooth Low Energy support:

sudo apt-get install libglib2.0-dev
python3 -m pip install bluepy
python3 rsf.py

Installation on Ubuntu 18.04 & 17.10

sudo add-apt-repository universe
sudo apt-get install git python3-pip
git clone https://www.github.com/threat9/routersploit
cd routersploit
python3 -m pip install setuptools
python3 -m pip install -r requirements.txt
python3 rsf.py

Bluetooth Low Energy support:

apt-get install libglib2.0-dev
python3 -m pip install bluepy
python3 rsf.py

Installation on OSX

git clone https://www.github.com/threat9/routersploit
cd routersploit
sudo python3 -m pip install -r requirements.txt
python3 rsf.py

Running on Docker

git clone https://www.github.com/threat9/routersploit
cd routersploit
docker compose up --build -d
docker attach routersploit

To run again without rebuild

docker start routersploit
docker attach routersploit

Update

Update RouterSploit Framework often. The project is under heavy development and new modules are shipped almost every day.

cd routersploit
git pull

Build your own

To our surprise, people started to fork routersploit not because they were interested in the security of embedded devices but simply because they want to leverage our interactive shell logic and build their tools using similar concept. All these years they must have said: "There must be a better way!" and they were completely right, the better way is called Riposte.

Riposte allows you to easily wrap your application inside a tailored interactive shell. Common chores regarding building REPLs was factored out and being taken care of so you can focus on specific domain logic of your application.

License

The RouterSploit Framework is under a BSD license. Please see LICENSE for more details.

Acknowledgments

routersploit (threat9/routersploit)

scanner
Searching Database…

What is this?RouterSploit is an open-source exploitation framework built specifically for testing the security of embedded devices like routers.
Is this a single exploit tool or a modular framework?It is a modular framework organized into module types: exploits for known vulnerabilities, creds for testing credentials, scanners for checking vulnerability, payloads for generating architecture-specific payloads, and generic attack modules.
How do I install and run RouterSploit?Follow the OS-specific steps in the README for Kali Linux, Ubuntu 20.04, Ubuntu 18.04/17.10, or OSX, or run it straight from the provided Docker image without a manual build.
What do I need installed before running it?It needs Python with the requests, paramiko, pysnmp, and pycrypto libraries; the optional bluepy package adds Bluetooth Low Energy module support.
Does it run on Windows?The README only documents installation on Kali Linux, Ubuntu, and OSX, or via Docker; there is no native Windows install path described.
Why did people fork routersploit instead of writing their own tool?Many forks were not interested in router security at all but wanted RouterSploit's interactive shell logic, which led the authors to extract that logic into a separate library.
What is Riposte?Riposte is a companion library spun out of RouterSploit that lets you wrap any application in a tailored interactive shell, handling the common REPL plumbing so you can focus on your own domain logic.
Can RouterSploit test Bluetooth Low Energy devices?Yes, installing the optional bluepy dependency enables Bluetooth Low Energy support for the relevant modules.
What are similar projects?masscan, fscan, bbot, nikto, thc-hydra, Claude-Red, evilginx2, PowerSploit
Creator
threat9
Size
1.9 MB
Stars
13.3K
Age
10y
Commits · 90 Days