https://github.com/cyberroute/phantom
Phanton: A lightweight ARP scanner for quick discovery of IoT devices on local networks.
https://github.com/cyberroute/phantom
arpscanner iot pyside6 python3
Last synced: 21 days ago
JSON representation
Phanton: A lightweight ARP scanner for quick discovery of IoT devices on local networks.
- Host: GitHub
- URL: https://github.com/cyberroute/phantom
- Owner: CyberRoute
- License: gpl-3.0
- Created: 2024-02-06T12:42:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-20T20:05:23.000Z (over 1 year ago)
- Last Synced: 2025-02-20T21:22:19.063Z (over 1 year ago)
- Topics: arpscanner, iot, pyside6, python3
- Language: Python
- Homepage:
- Size: 1000 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
---
# Phantom
## Overview
Phantom is an **ARP Scanner** mostly designed to detect directly connected IoT devices. The tool provides details like IP addresses, MAC addresses, hostnames, and the manufacturers of the devices based on their MAC addresses.
The tool features a graphical user interface (GUI) built with **PySide6** (Qt framework) and utilizes **scapy** for ARP scanning.
---
## Features
- **Network Scanning**: Identifies devices on the network via ARP requests.
- **Device Details**: Displays IP address, MAC address, hostname, and vendor information.
- **Graphical User Interface**: Easy-to-use UI to display the scanned devices and packet information.
- **Multithreading**: Ensures non-blocking scans using Python's `QThread`.
- **C extension**: for MacOSX there is a C extension that allows slow sequential but very accurate arp scanning
---
## Prerequisites
Ensure the following dependencies are installed:
1. **Python 3.12 or higher**
2. **scapy**: Used for ARP scanning.
3. **PySide6**: For building the GUI.
4. **netifaces**: To retrieve network interface details.
## Requirements
- **Python 3.12+**
- **scapy**: For ARP scanning and packet manipulation.
- **PySide6**: For building the graphical user interface.
- **netifaces**: To retrieve network interface details.
---
## Installation
1. **Clone the repository**:
Clone the repository to your local machine:
```bash
git clone https://github.com/CyberRoute/phantom.git
cd phantom
```
2. **Install the dependencies with Pipenv**:
Install `pip` if it's not already installed:
```bash
virtualenv env
source env/bin/activate
pip install -r requirements.txt
```
3. **Run the application**:
Run the ARP Scanner using the following command. You need to provide the network interface (like `eth0`, `wlan0`, or `wlp0s20f3`) for your system:
```bash
sudo `which python3` main.py --interface
```
On Ubuntu in case you run into this error:
```
(env) alessandro@alessandro-XPS-9315:~/Development/phantom$ sudo /home/alessandro/Development/phantom/env/bin/python3 main.py --interface wlp0s20f3
qt.qpa.plugin: From 6.5.0, xcb-cursor0 or libxcb-cursor0 is needed to load the Qt xcb platform plugin.
qt.qpa.plugin: Could not load the Qt platform plugin "xcb" in "" even though it was found.
This application failed to start because no Qt platform plugin could be initialized. Reinstalling the application may fix this problem.
Available platform plugins are: eglfs, minimal, wayland, vkkhrdisplay, offscreen, linuxfb, xcb, wayland-egl, minimalegl, vnc.
```
Solution:
```
sudo apt install libxcb-cursor0
```
On Macos there is a C extension that allows accurate but slow arpscan. To build and install the extension:
```
pip install setuptools
cd c_extension
python setup.py build
python setup.py install
```
## Usage Instructions
1. **Start the Application**:
After running the application with the correct interface, the GUI will launch.
2. **Scanning the Network**:
- Click on the **"Scan"** button in the UI to initiate a network scan.
- The tool will display a list of all detected devices in the network, including their IP addresses, MAC addresses, hostnames, and vendors.
3. **Device Details**:
- Click on any device in the list to open a detailed window that shows more information about that particular device.
4. **Stopping the Scan**:
- Press the **"Quit"** button to stop the ARP scan and close the application.
## Contribute
Fork the repo and send PRs if you like :)