The idea behind this script is to find out all the devices connected to your network and alert you of the untrusted ones. It could help you find out if your neighbors are connecting to your network. Its takes a few seconds to run, you could run it every 5 minutes, if desired.
This script will scan the network of your choice and will alert you of any devices not present in the whitelist. The whitelist is a list of MAC address that YOU trust. The first time you run the script, the whitelist will be empty, it's up to up to add your trusted devices to the whitelist.
See the whitelist section for more information
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Software package: python3 and nmap
Ubuntu / Debian
sudo apt install python3 nmap
Arch/Manjaro/Antergos
sudo pacman -S nmap python3
CentOS 7/ Redhat 7
sudo yum install python3 nmap
Fedora
sudo dnf install python3 nmap
Every time you run the detection script, a list of all detected devices will be written in the file 'devices.mac'.
If you trust all these devices, you can import them with the following command:
sudo ./trust-devices.py data.db devices.mac
If you don't trust all of them, you can erase the one that you don't want and still import the file.
The following command will flush the current whitelist and import the entries in devices.mac
sudo ./trust-devices.py data.db devices.mac
Download and unzip, and make sure you have installed the Prerequisites
Things to do:
- The folder should be writable because a devices.mac is generated every time you launch the detect.py script
- Don't forget to mark the python scripts as 'executables'
sudo chmod +x *.py
The database filename can be anything, it will be created if absent. The network must be specified in the network/mask notation.
example of valid networks:
- 192.168.0.0/24
- 192.168.1.0/24
- 192.168.2.0/24
you should launch both programs with sudo:
- detect.py : nmon requires root privileges to get the MAC addresses
- trust-devices.py : requires root privileges because the database will be created with root. If you modify the database so that it's writable for someone else, you won't need sudo anymore.
Syntax:
sudo ./detect.py network_range database
example:
sudo ./detect.py 192.168.2.0/24 data.db
on the first run, all devices should be listed as untrusted, read the whitelist section. You need to run other script to import your trusted devices list.
- Visual studio code - Editor
- Manjaro - Manjaro
- Luc Raymond - Initial work - My Github profile
This project is licensed under the MIT License - see the LICENSE.md file for details
- feel free to drop me an email if you find it useful (french,english)