Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
HalilDeniz committed Jun 22, 2023
1 parent 632e0f4 commit 93f1218
Showing 1 changed file with 62 additions and 28 deletions.
90 changes: 62 additions & 28 deletions README.md
@@ -1,12 +1,18 @@
# 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, and device names of the responding devices.

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.

- Scan for devices on a specified IP address or subnet
- 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)


## Download

You can download the program from the GitHub page.

```bash
git clone https://github.com/HalilDeniz/Network-Scanner.git
git clone https://github.com/HalilDeniz/NetProbe.git
```

## Installation
Expand All @@ -22,53 +28,81 @@ pip install -r requirements.txt
To run the program, use the following command:

```bash
python3 network-scnner.py -t [target] -i [interface]
python3 netprobe.py -t [target] -i [interface] -o [output_file] -l
```

- `[target]`: IP address or subnet to scan (default: 192.168.1.0/24)
- `[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

Example:
## Example:

```bash
python3 network-scanner.py -t 192.168.1.0/24 -i eth0
python3 netrobe.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]
## Features
Network Scanner Tool
The program lists the IP addresses, MAC addresses, and device names of the devices on your network. You can get an example output like the following:
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
```


## Default Scan

```bash
python3 netprobe.py
```
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┓
┃ IP Address ┃ MAC Address ┃ Device Name ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━┩
│ 192.168.1.1 │ b0:**:bf:**:32:** │ router.****.com │
│ 192.168.1.2 │ d4:**:64:**:5c:** │ Unknown │
│ 192.168.1.6 │ **:5e:**:16:**:** │ Unknown │
│ 192.168.1.25 │ 0a:**:50:00:**:** │ Unknown │
└──────────────┴───────────────────┴─────────────────┘

## 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
```
## Contributing
Contributions are welcome! To contribute to Network-Scanner, follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your changes to your forked repository.
5. Open a pull request in the main repository.
## 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
```



```
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━┓
┃ 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 │
└──────────────┴───────────────────┴───────────────────────┘
```

## 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:


- LinkedIn: https://www.linkedin.com/in/halil-ibrahim-deniz/
- TryHackMe: https://tryhackme.com/p/halilovic
- Instagram: https://www.instagram.com/deniz.halil333/
- YouTube: 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.

0 comments on commit 93f1218

Please sign in to comment.