Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/b3ta-blocker/automate-network-scanning
A Python tool that automates network discovery and port scanning to identifying devices and open ports.
https://github.com/b3ta-blocker/automate-network-scanning
automation cyber-security netdiscover network-scanning network-tools nmap port-scanning python security
Last synced: 12 days ago
JSON representation
A Python tool that automates network discovery and port scanning to identifying devices and open ports.
- Host: GitHub
- URL: https://github.com/b3ta-blocker/automate-network-scanning
- Owner: B3TA-BLOCKER
- License: mit
- Created: 2024-06-17T16:46:56.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-08-18T18:01:39.000Z (5 months ago)
- Last Synced: 2024-08-18T20:23:58.623Z (5 months ago)
- Topics: automation, cyber-security, netdiscover, network-scanning, network-tools, nmap, port-scanning, python, security
- Language: Python
- Homepage:
- Size: 44.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Automate Network Scanning 🚀
A powerful Python tool designed to streamline the process of network discovery and port scanning. This tool automates the tedious tasks of discovering devices on your network and performing comprehensive port scans to identify open ports.
## Features 🌟
- **Automatic Network Discovery**: Identifies all active network interfaces and discovers devices on your local subnet.
- **Port Scanning**: Performs a detailed scan of all TCP ports on discovered devices to find open ports.
- **Intense Nmap Scan**: Runs an intensive Nmap scan on detected open ports and logs results.
- **User-Friendly Interface**: Interactive command-line interface to guide you through the scanning process.
## Project Structure 📂
```
Automate-network-scanning
├── LICENSE
├── README.md
├── docs
│ ├── index.md
│ ├── installation.md
│ └── usage.md
├── examples
│ └── example_usage.py
├── network_scanner
│ ├── __init__.py
│ ├── main.py
│ ├── scanner.py
│ └── utils.py
├── requirements.txt
├── setup.py
└── tests
├── test_import.py
├── test_main.py
├── test_scanner.py
└── test_utils.py
```
- **`LICENSE`**: License file for the project.
- **`README.md`**: This file containing an overview and instructions.
- **`docs/`**: Documentation files, including installation and usage guides.
- **`examples/`**: Example scripts demonstrating how to use the tool.
- **`network_scanner/`**: Core package of the project containing the main functionality.
- **`__init__.py`**: Initializes the package.
- **`main.py`**: Contains primary functions for network scanning.
- **`scanner.py`**: Additional scanning-related functions.
- **`utils.py`**: Utility functions used across the package.
- **`requirements.txt`**: Lists Python dependencies.
- **`setup.py`**: Setup script for installing the package.
- **`tests/`**: Unit tests for various components of the project.
## Documentation 📚
For detailed information on installation, usage, and configuration, please refer to the documentation:
- [Introduction](docs/index.md)
- [Installation Guide](docs/installation.md)
- [Usage Instructions](docs/usage.md)
## Example Usage 💡
Here's a brief example of how you might use the tool in a script:
```python
from network_scanner.main import network_interface_info, get_local_network_info, nmap_scan
def example_usage():
interfaces = network_interface_info()
if not interfaces:
print("No network interfaces found!")
return
interface = interfaces[0] # Example usage with the first interface
subnet = get_local_network_info(interface)
print(f"Scanning subnet: {subnet}")
ips = nmap_scan(subnet)
print("Discovered IPs:")
for ip in ips:
print(ip)
if __name__ == "__main__":
example_usage()
```
## Contributing 🤝
I welcome contributions to improve this tool. If you'd like to contribute, please:
1. Fork the repository.
2. Create a feature branch (`git checkout -b feature/YourFeature`).
3. Commit your changes (`git commit -am 'Add new feature'`).
4. Push to the branch (`git push origin feature/YourFeature`).
5. Create a new Pull Request.
## License 📜
This project is licensed under the MIT License – see the [LICENSE](LICENSE) file for details.
## Contact 📫
For any questions or feedback, please reach out to [B3TA-BLOCKER](https://github.com/B3TA-BLOCKER).