From d03d93f8b6d0f4b8e1c258743377d2d5811c9762 Mon Sep 17 00:00:00 2001 From: halil ibrahim deniz <62566319+HalilDeniz@users.noreply.github.com> Date: Thu, 9 Nov 2023 12:52:12 +0300 Subject: [PATCH] Update README.md --- README.md | 104 ++++++++++++++++++++++++++++++++---------------------- 1 file changed, 62 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 450a981..dfcee8d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # NetProbe: Network Probe -This program is a tool you can use to scan for devices on your network. The program sends ARP requests to any IP address on your network and lists the IP addresses, MAC addresses, manufacturers, and device models of the responding devices. +**NetProbe** is a tool you can use to scan for devices on your network. The program sends ARP requests to any IP address on your network and lists the IP addresses, MAC addresses, manufacturers, and device models of the responding devices. ## Features @@ -8,13 +8,15 @@ This program is a tool you can use to scan for devices on your network. The prog - Display the IP address, MAC address, manufacturer, and device model of discovered devices - Live tracking of devices (optional) - Save scan results to a file (optional) - +- Filter by manufacturer (e.g., 'Apple') (optional) +- Filter by IP range (e.g., '192.168.1.0/24') (optional) +- Scan rate in seconds (default: 5) (optional) ## Download You can download the program from the GitHub page. ```bash -git clone https://github.com/HalilDeniz/NetProbe.git +$ git clone https://github.com/HalilDeniz/NetProbe.git ``` ## Installation @@ -22,7 +24,7 @@ git clone https://github.com/HalilDeniz/NetProbe.git To install the required libraries, run the following command: ```bash -pip install -r requirements.txt +$ pip install -r requirements.txt ``` ## Usage @@ -30,79 +32,97 @@ pip install -r requirements.txt To run the program, use the following command: ```bash -python3 netprobe.py -t [target] -i [interface] -o [output_file] -l +$ python3 netprobe.py [-h] -t [...] -i [...] [-l] [-o] [-m] [-r] [-s] ``` -- `[target]`: Target IP address or subnet (default: 192.168.1.0/24) -- `[interface]`: Interface to use (default: None) -- `[output_file]`: Output file to save the results (optional) -- `-l` or `--live`: Enable live tracking of devices +- `-h`,`--help`: show this help message and exit +- `-t`,`--target`: Target IP address or subnet (default: 192.168.1.0/24) +- `-i`,`--interface`: Interface to use (default: None) +- `-l`,`--live`: Enable live tracking of devices +- `-o`,`--output`: Output file to save the results +- `-m`,`--manufacturer`: Filter by manufacturer (e.g., 'Apple') +- `-r`,`--ip-range`: Filter by IP range (e.g., '192.168.1.0/24') +- `-s`,`--scan-rate`: Scan rate in seconds (default: 5) ## Example: -```bash -python3 netrobe.py -t 192.168.1.0/24 -i eth0 -o results.txt -l +```shell +$ python3 netprobe.py -t 192.168.1.0/24 -i eth0 -o results.txt -l ``` ## Help Menu -``` -python3 network_scanner.py --help -usage: network_scanner.py [-h] [-t] [-i] [-l] [-o] +```shell +$ python3 netprobe.py --help +usage: netprobe.py [-h] -t [...] -i [...] [-l] [-o] [-m] [-r] [-s] -Network Scanner Tool +NetProbe: Network Scanner Tool options: - -h, --help show this help message and exit - -t , --target Target IP address or subnet (default: 192.168.1.0/24) - -i , --interface Interface to use (default: None) - -l, --live Enable live tracking of devices - -o , --output Output file to save the results + -h, --help show this help message and exit + -t [ ...], --target [ ...] + Target IP address or subnet (default: 192.168.1.0/24) + -i [ ...], --interface [ ...] + Interface to use (default: None) + -l, --live Enable live tracking of devices + -o , --output Output file to save the results + -m , --manufacturer Filter by manufacturer (e.g., 'Apple') + -r , --ip-range Filter by IP range (e.g., '192.168.1.0/24') + -s , --scan-rate Scan rate in seconds (default: 5) + ``` ## Default Scan ```bash -python3 netprobe.py +$ python3 netprobe.py ``` ## Live Tracking You can enable live tracking of devices on your network by using the `-l` or `--live` flag. This will continuously update the device list every 5 seconds. -``` -python3 network-scanner.py -t 192.168.1.0/24 -i eth0 -l +```shell +$ python3 netprobe.py -t 192.168.1.0/24 -i eth0 -l ``` ## Save Results You can save the scan results to a file by using the `-o` or `--output` flag followed by the desired output file name. ``` -python3 netprobe.py -t 192.168.1.0/24 -i eth0 -o results.txt +$ python3 netprobe.py -t 192.168.1.0/24 -i eth0 -l -o results.txt ``` - - -``` -┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━┓ -┃ IP Address ┃ MAC Address ┃ Manufacturer ┃ -┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━┩ -│ 192.168.1.1 │ b0:**:bf:**:32:** │ ASUSTek COMPUTER INC. │ -│ 192.168.1.25 │ **:49:**:00:**:38 │ OPPO Digital, Inc. │ -│ 192.168.1.98 │ d4:**:64:**:5c:** │ ASUSTek COMPUTER INC. │ -│ 192.168.1.4 │ **:02:**:5b:**:65 │ LG Innotek │ -└──────────────┴───────────────────┴───────────────────────┘ +```shell +┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ IP Address ┃ MAC Address ┃ Packet Size ┃ Manufacturer ┃ +┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ +│ 192.168.1.1 │ **:6e:**:97:**:28 │ 102 │ ASUSTek COMPUTER INC. │ +│ 192.168.1.3 │ 00:**:22:**:12:** │ 102 │ InPro Comm │ +│ 192.168.1.2 │ **:32:**:bf:**:00 │ 102 │ Xiaomi Communications Co Ltd │ +│ 192.168.1.98 │ d4:**:64:**:5c:** │ 102 │ ASUSTek COMPUTER INC. │ +│ 192.168.1.25 │ **:49:**:00:**:38 │ 102 │ Unknown │ +└──────────────┴───────────────────┴─────────────┴──────────────────────────────┘ ``` ## Contact If you have any questions, suggestions, or feedback about the program, please feel free to reach out to me through any of the following platforms: -- Linktr [halildeniz](https://linktr.ee/halildeniz) -- DenizHalil [DenizHalil](https://denizhalil.com) -- LinkedIn: [Halil Ibrahim Deniz](https://www.linkedin.com/in/halil-ibrahim-deniz/) -- TryHackMe: [Halilovic](https://tryhackme.com/p/halilovic) -- Instagram: [deniz.halil333](https://www.instagram.com/deniz.halil333/) -- YouTube: [Halil Deniz](https://www.youtube.com/c/HalilDeniz) + + + +- Mywebsite: [Denizhalil](https://denizhalil.com) +- LinkedIn: [LinkedIn](https://www.linkedin.com/in/halil-ibrahim-deniz/) +- TryHackMe: [TryHackMe](https://tryhackme.com/p/halilovic) +- Instagram: [Instagram](https://www.instagram.com/deniz.halil333/) +- YouTube: [YouTube](https://www.youtube.com/c/HalilDeniz) - Email: halildeniz313@gmail.com ## License -This program is released under the MIT License. See LICENSE for more information. +This program is released under the MIT [LICENSE](LICENSE). See LICENSE for more information. + +## 💰 You can help me by Donating +Thank you for considering supporting me! Your support enables me to dedicate more time and effort to creating useful tools like DNSWatch and developing new projects. By contributing, you're not only helping me improve existing tools but also inspiring new ideas and innovations. Your support plays a vital role in the growth of this project and future endeavors. Together, let's continue building and learning. Thank you!" +[![BuyMeACoffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black)](https://buymeacoffee.com/halildeniz) +[![Patreon](https://img.shields.io/badge/Patreon-F96854?style=for-the-badge&logo=patreon&logoColor=white)](https://patreon.com/denizhalil) + +