mirror of
https://github.com/k4m4/kickthemout.git
synced 2024-11-30 00:44:25 +01:00
148 lines
4.5 KiB
Markdown
148 lines
4.5 KiB
Markdown
|
||
|
||
# KickThemOut
|
||
|
||
> [KickThemOut](https://nikolaskama.me/kickthemoutproject) - **Kick Devices Off Your Network**
|
||
|
||
A tool to kick devices out of your network and enjoy all the bandwidth for yourself.
|
||
It allows you to select specific or all devices and ARP spoofs them off your local area network.
|
||
|
||
- Compatible with Python **3+** 🎉.
|
||
|
||
- *Not* compatible with Windows.
|
||
|
||
Authors: [Nikolaos Kamarinakis](mailto:nikolaskam@gmail.com) & [David Schütz](mailto:xdavid@protonmail.com).
|
||
|
||
[](https://travis-ci.org/k4m4/kickthemout)
|
||
[](https://github.com/k4m4/kickthemout/blob/master/LICENSE)
|
||
[](https://github.com/k4m4/kickthemout)
|
||
[](https://github.com/k4m4/kickthemout/stargazers)
|
||
|
||
---
|
||
|
||
<p align="center">✨Read my latest post: <a href="https://nikolaskama.me/kickthemout-v2-0/"><i>KickThemout v2.0! 🎉</i></a></p>
|
||
|
||
-------------
|
||
|
||
# Installation
|
||
|
||
## Debian Installation
|
||
|
||
You can download KickThemOut by cloning the [Git Repo](https://github.com/k4m4/kickthemout) and simply installing its requirements:
|
||
|
||
```
|
||
~ ❯❯❯ sudo apt-get update && sudo apt-get install nmap
|
||
|
||
~ ❯❯❯ git clone https://github.com/k4m4/kickthemout.git
|
||
|
||
~ ❯❯❯ cd kickthemout/
|
||
|
||
~/kickthemout ❯❯❯ sudo -H pip3 install -r requirements.txt
|
||
|
||
~/kickthemout ❯❯❯ sudo python3 kickthemout.py
|
||
```
|
||
|
||
|
||
## MacOS Installation
|
||
|
||
If you would like to install KickThemOut on a Mac, please run the following:
|
||
|
||
```
|
||
~ ❯❯❯ brew install libdnet nmap
|
||
|
||
~ ❯❯❯ git clone https://github.com/k4m4/kickthemout.git
|
||
|
||
~ ❯❯❯ cd kickthemout/
|
||
|
||
~/kickthemout ❯❯❯ sudo -H pip3 install -r requirements.txt
|
||
|
||
~/kickthemout ❯❯❯ sudo python3 kickthemout.py
|
||
```
|
||
|
||
**NOTE**: You need to have [Homebrew](http://brew.sh/) installed before running the Mac OS installation.
|
||
|
||
Also, **keep in mind** that you might be asked to run some extra commands after executing the pip requirement installation.
|
||
|
||
|
||
## ArchLinux Installation
|
||
|
||
You can download KickThemOut on an Arch based system by executing the following:
|
||
|
||
```
|
||
~ ❯❯❯ git clone https://github.com/k4m4/kickthemout.git
|
||
|
||
~ ❯❯❯ cd kickthemout/
|
||
|
||
~/kickthemout ❯❯❯ sudo -H pip3 install -r requirements.txt
|
||
|
||
~/kickthemout ❯❯❯ sudo python3 kickthemout.py
|
||
```
|
||
|
||
<br/>
|
||
|
||
# Usage
|
||
|
||
```
|
||
Usage: sudo python3 kickthemout.py [options]
|
||
|
||
Options:
|
||
--version show program's version number and exit
|
||
-h, --help show this help message and exit
|
||
-p PACKETS, --packets=PACKETS
|
||
number of packets broadcasted per minute (default: 6)
|
||
-s, --scan perform a quick network scan and exit
|
||
-t TARGETS, --target=TARGETS
|
||
specify target IP address(es) and perform attack
|
||
|
||
Examples:
|
||
sudo python3 kickthemout.py --target 192.168.1.10
|
||
sudo python3 kickthemout.py -t 192.168.1.5,192.168.1.10 -p 30
|
||
sudo python3 kickthemout.py (interactive mode)
|
||
```
|
||
|
||
To view all available options run:
|
||
|
||
```
|
||
~/kickthemout ❯❯❯ sudo python3 kickthemout.py -h
|
||
```
|
||
|
||
|
||
<br/>
|
||
|
||
# Demo
|
||
|
||
Here's a short demo:
|
||
|
||
[](https://asciinema.org/a/98200?autoplay=1&loop=1)
|
||
|
||
(For more demos click [here](https://asciinema.org/~k4m4))
|
||
|
||
|
||
<br/>
|
||
|
||
# Developers
|
||
|
||
* Nikolaos Kamarinakis - [@nikolaskama](https://twitter.com/nikolaskama)
|
||
* David Schütz - [@xdavidhu](https://twitter.com/xdavidhu)
|
||
|
||
|
||
<br/>
|
||
|
||
# Disclaimer
|
||
|
||
KickThemOut is provided as is under the MIT Licence (as stated below).
|
||
It is built for educational purposes *only*. If you choose to use it otherwise, the developers will not be held responsible. Please, do not use it with evil intent.
|
||
|
||
|
||
<br/>
|
||
|
||
# License
|
||
|
||
Copyright (c) 2017-18 by [Nikolaos Kamarinakis](mailto:nikolaskam@gmail.com) & [David Schütz](mailto:xdavid@protonmail.com). Some rights reserved.
|
||
|
||
KickThemOut is under the terms of the [MIT License](https://www.tldrlegal.com/l/mit), following all clarifications stated in the [license file](https://raw.githubusercontent.com/k4m4/kickthemout/master/LICENSE).
|
||
|
||
|
||
For more information head over to the [official project page](https://nikolaskama.me/kickthemoutproject).
|
||
You can also go ahead and email me anytime at **nikolaskam{at}gmail{dot}com** or David at **xdavid{at}protonmail{dot}com**.
|