A comprehensive WiFi and MAC address scanning toolkit with vendor lookup capabilities
Project description
kbfi
A comprehensive WiFi and MAC address scanning toolkit with vendor lookup capabilities. This tool allows you to scan for WiFi networks and connected clients, with automatic vendor identification for MAC addresses.
Quick Start
pip install kbfi
kbfi-scan
Features
- Scan for WiFi networks and their details (SSID, BSSID, signal strength, encryption, etc.)
- Scan for connected clients and their MAC addresses
- Automatic vendor lookup for MAC addresses
- Support for Windows and Linux systems
- Multiple output formats (JSON, CSV, text)
- Command-line interface with various options
- Automatic wireless interface detection
- Vendor database auto-update capability
Installation
pip install kbfi
Usage
Basic Usage
# Scan both WiFi networks and connected clients
kbfi-scan
# Scan only WiFi networks
kbfi-scan --scan-type wifi
# Scan only connected clients
kbfi-scan --scan-type clients
Advanced Options
# Specify wireless interface
kbfi-scan --interface wlan0
# Output to file in JSON format
kbfi-scan --output scan_results --format json
# Update vendor database before scanning
kbfi-scan --update-vendor-db
# Set minimum signal strength
kbfi-scan --min-signal -70
Command-line Options
--interface,-i: Specify wireless interface (default: auto-detect)--scan-type,-t: Type of scan to perform (wifi/clients/both)--output,-o: Output file (default: stdout)--format,-f: Output format (json/csv/text)--update-vendor-db,-u: Update vendor database before scanning--min-signal,-s: Minimum signal strength to include (default: -100)
Requirements
- Python 3.8 or higher
- Windows or Linux operating system
- Administrative/root privileges for scanning
requestspackage for vendor database updates
Development
# Clone the repository
git clone https://github.com/itskbagain/kbfi.git
cd kbfi
# Install development dependencies
pip install -e ".[dev]"
# Run tests
pytest
# Run linting
flake8
mypy .
Troubleshooting
- Permission denied / No networks found: Ensure you are running the tool with administrative/root privileges.
- No wireless interface detected: Use
--interfaceto specify your WiFi adapter manually. - Vendor lookup fails: Use
--update-vendor-dbto refresh the vendor database. Ensure you have an internet connection. - Windows users: Run your terminal as Administrator for best results.
- Linux users: Use
sudofor scanning commands.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Security
This tool requires administrative/root privileges to perform network scanning. Use responsibly and only on networks you own or have permission to scan.
Author
Kaustubh Bhattacharyya
Email: kb01tech@gmail.com
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file kbfi-0.1.0.tar.gz.
File metadata
- Download URL: kbfi-0.1.0.tar.gz
- Upload date:
- Size: 13.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a3ffbb7c3877a7c632a2aafc392dfa8d620e92bc26bc6d96d4c4a621c9482e65
|
|
| MD5 |
d700090a9287ec283f027259e8b92e93
|
|
| BLAKE2b-256 |
bc30447f5f36f8d706dc9a6bd89f091f74d06f9c1707977c3e781dc3908923b3
|
File details
Details for the file kbfi-0.1.0-py3-none-any.whl.
File metadata
- Download URL: kbfi-0.1.0-py3-none-any.whl
- Upload date:
- Size: 10.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9d42ece598ee6e9226d52e4b05451cf0d08310858983191b1d11ef4c8de1508a
|
|
| MD5 |
f67a65c69c51b4a5f2014b20fd4e63f8
|
|
| BLAKE2b-256 |
4d99f6aa49afbb1ee7cd940ac9eb4f0d636f98c6e097051a2c379aa8392497d4
|