Nmap GUI Documentation

Overview

The Nmap GUI is a graphical user interface built using the Tkinter library in Python. It provides a user-friendly interface to interact with the Nmap network scanning tool. With this GUI, users can specify target hosts and customize scanning options easily.

Features

• Input field for specifying the target host.
• Checkboxes to enable/disable various Nmap scan options.
• Start and Stop buttons to initiate and halt the scan process.
• Progress bar to indicate the progress of the scan.
• Text area to display the scan results.

Usage

1. Target Entry: Enter the target host IP address or hostname in the input field provided.

2. Scan Options:

   • Ping Scan (-Pn): Enable/disable ping scan.
   • OS Detection (-O): Enable/disable operating system detection.
   • Service Version Detection (-sV): Enable/disable service version detection.
   • Script Scan (-sC): Enable/disable script scanning.
   • Start Scan: Click this button to start the Nmap scan with the specified options and target host.

3. Stop Scan: Click this button to stop the currently running scan process. This button is enabled only during an active scan.

4. Progress Bar: Displays the progress of the scan process. It moves from left to right as the scan progresses.

5. Scan Results: Displays the output of the Nmap scan. This area is updated in real-time as the scan progresses.

Dependencies

• Python 3.x
• Tkinter (Standard Python library for GUI development)
• Nmap (Network scanning tool)

Installation

1. Install Python from the official website: Python Downloads
2. Install Nmap using package managers like apt, yum, or by downloading from the official website: Nmap Download

How to Run

1. Clone the repository or download the GUI.py file.
2. Open a terminal or command prompt.
3. Navigate to the directory containing GUI.py.
4. Run the following command:

python GUI.py

5. The Nmap GUI window should appear, allowing you to perform network scans using the graphical interface.

Contributing

Contributions to this project are welcome! If you encounter any bugs, have suggestions for improvements, or want to add new features, please feel free to open an issue or submit a pull request on GitHub.

Screen shots while developing

License

This project is licensed under the MIT License.

Copyright (c) 2024 Kanchana Samarakoon

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.