nmaping 2.0__tar.gz → 2.2__tar.gz

nmaping-2.2/PKG-INFO

@@ -0,0 +1,284 @@
+Metadata-Version: 2.4
+Name: nmaping
+Version: 2.2
+Summary: An automation and network scanning utility tool.
+Author-email: "Mr. Tan" <mrtanvai@gmail.com>
+License: Custom License
+Project-URL: Homepage, https://github.com/Mr74nX/nmaping
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: POSIX :: Linux
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: requests
+
+# 🚀 nmaping
+
+**nmaping** is a simple, colorful, menu-based tool that helps you run Nmap scans without remembering any commands. Pick a scan from the menu, enter a target, and get your results. Everything is saved automatically.
+
+Made by **Mr Tan**.
+
+---
+
+## 📖 What Does It Do?
+
+Nmap is a powerful network scanner, but its commands are long and hard to remember. nmaping does the hard part for you:
+
+- Shows all scan types in a clean numbered menu
+- Asks for your target (IP address, website, or a whole network range)
+- Lets you choose how fast or how quiet the scan should be
+- Runs the scan and shows the result on screen
+- Saves the result to a file and keeps a history of everything you scanned
+
+---
+
+## ✅ Before You Start
+
+You need two things on your computer:
+
+1. **Python 3.8 or newer**
+2. **Nmap**
+
+**Install Nmap:**
+
+| System | Command |
+|--------|---------|
+| Kali / Ubuntu / Debian | `sudo apt update && sudo apt install -y nmap` |
+| Fedora | `sudo dnf install nmap` |
+| Arch | `sudo pacman -S nmap` |
+| Windows | Download from https://nmap.org/download.html and tick **"Add to PATH"** during setup |
+
+---
+
+## 📦 How to Install
+
+### Linux (recommended: pipx)
+
+```bash
+sudo apt install -y pipx
+pipx ensurepath
+```
+
+Close and reopen your terminal, then:
+
+```bash
+pipx install nmaping
+```
+
+### Linux / Mac (using pip)
+
+New Linux versions don't allow plain `pip install`, so create a small environment first:
+
+```bash
+python3 -m venv ~/.nmaping-venv
+source ~/.nmaping-venv/bin/activate
+pip install nmaping
+```
+
+> Every time you want to use it later, run `source ~/.nmaping-venv/bin/activate` first.
+
+### Windows
+
+Open PowerShell and run:
+
+```powershell
+python -m pip install --user pipx
+python -m pipx ensurepath
+```
+
+Close and reopen PowerShell, then:
+
+```powershell
+pipx install nmaping
+```
+
+---
+
+## ▶️ How to Run
+
+Just type:
+
+```bash
+nmaping
+```
+
+---
+
+## 🧭 How to Use (Step by Step)
+
+1. Run `nmaping`. The main menu appears with the logo and a live clock.
+2. Type the **number** of the scan you want and press Enter.
+3. Enter your **target**, for example:
+   - `192.168.1.1` (one device)
+   - `example.com` (a website)
+   - `192.168.1.0/24` (a whole network)
+4. Confirm that you have **permission** to scan the target (type `y`).
+5. Choose a **speed** from 0 to 5 (just press Enter for the default).
+6. Wait for the scan to finish. The result is shown and saved automatically.
+7. Press Enter to return to the menu.
+
+In the main menu:
+- Type **H** to see your scan history
+- Type **0** to exit
+
+---
+
+## 🔍 Scan Types Explained
+
+| No. | Scan | What it does |
+|-----|------|--------------|
+| 1 | SYN Scan | Fast, quiet scan for open ports |
+| 2 | Version Detection | Finds which software and version runs on each open port |
+| 3 | Vulnerability Scan | Checks for known security weaknesses |
+| 4 | OS Detection | Guesses the operating system of the target |
+| 5 | Host Discovery | Checks which devices are online, no port scan |
+| 6 | Specific Port | Scans only the port(s) you choose (e.g. `80,443`) |
+| 7 | Top 1000 Ports | Scans the 1000 most common ports |
+| 8 | UDP Scan | Scans UDP ports (slower) |
+| 9 | Aggressive Scan | OS, version, scripts and traceroute in one go |
+| 10 | Firewall / ACK Scan | Helps find out if a firewall is filtering ports |
+| 11 | Default Script Scan | Runs Nmap's standard safe scripts |
+| 12 | Traceroute | Shows the path your traffic takes to the target |
+| 13 | All Ports | Scans all 65,535 ports (slow) |
+| 14 | Ping Scan | Checks if the target responds to ping |
+| 15 | No Ping Scan | Scans even if the target ignores ping |
+| 16 | TCP Connect | Normal connection scan, works without root |
+| 17 | Xmas Scan | Special stealth scan |
+| 18 | FIN Scan | Special stealth scan |
+| 19 | Null Scan | Special stealth scan |
+| 20 | Custom | Type your own Nmap options |
+| 21 | Full Deep Scan | Everything combined (very slow) |
+
+---
+
+## ⏱️ Speed Levels
+
+| Level | Name | Best for |
+|-------|------|----------|
+| 0 | Paranoid | Maximum stealth, extremely slow |
+| 1 | Sneaky | Very slow, hard to detect |
+| 2 | Polite | Gentle on the network |
+| 3 | Normal | Default, good for most cases |
+| 4 | Aggressive | Fast, recommended on good networks |
+| 5 | Insane | Fastest, use only in your own lab |
+
+---
+
+## ⌨️ Quick Commands (Without the Menu)
+
+If you already know what you want, skip the menu:
+
+```bash
+nmaping -t 192.168.1.1 -s 2 -T 4
+```
+
+Meaning: scan `192.168.1.1`, scan type `2` (Version Detection), speed `4`.
+
+| Option | Meaning |
+|--------|---------|
+| `-t` | Target |
+| `-s` | Scan number (1 to 21) |
+| `-T` | Speed (0 to 5) |
+| `-p` | Port(s), used with scan 6 |
+| `--no-save` | Don't save the result file |
+| `--list` | Show all scan types |
+| `-y` | Skip the permission question |
+
+More examples:
+
+```bash
+nmaping -t example.com -s 6 -p 80,443
+nmaping -t 192.168.1.0/24 -s 5
+nmaping --list
+```
+
+---
+
+## 🔑 Scans That Need Root (Linux)
+
+Scans 1, 4, 8, 17, 18, 19 (and some others) need administrator rights. Run:
+
+```bash
+sudo "$(which nmaping)"
+```
+
+When run with `sudo`, files are saved in `/root/.nmaping/` instead of your own folder.
+
+---
+
+## 🔄 How to Update to a New Version
+
+When a new version is released, update with one command.
+
+**If you installed with pipx:**
+
+```bash
+pipx upgrade nmaping
+```
+
+If it says nothing changed, force the update:
+
+```bash
+pipx install --force nmaping
+```
+
+**If you installed with pip:**
+
+```bash
+pip install --upgrade --force-reinstall nmaping
+```
+
+(Activate your environment first if you used one: `source ~/.nmaping-venv/bin/activate`)
+
+The logo shows your current version (`v=1.0`). Check the GitHub page to see if a newer one is available.
+
+---
+
+## 🗑️ How to Uninstall
+
+```bash
+pipx uninstall nmaping
+```
+
+or, if you used pip:
+
+```bash
+pip uninstall nmaping
+```
+
+Your saved results stay in `~/.nmaping/`. Delete that folder if you want to remove them too.
+
+---
+
+## 📁 Where Are My Results?
+
+| What | Location |
+|------|----------|
+| Scan results | `~/.nmaping/results/` |
+| Scan history | `~/.nmaping/history.log` |
+
+Each result file is named with the target, scan type, and date/time.
+
+---
+
+## 🛠️ Problems and Fixes
+
+| Problem | Fix |
+|---------|-----|
+| `nmaping: command not found` | Run `pipx ensurepath`, then close and reopen the terminal |
+| `externally-managed-environment` | Use pipx, or the pip method with a virtual environment |
+| `nmap not found` | Install Nmap (see "Before You Start") |
+| `requires root privileges` | Run with `sudo "$(which nmaping)"` |
+| Strange boxes instead of the logo on Windows | Use Windows Terminal, or run `chcp 65001` first |
+| Clock not beside the logo | Make your terminal window taller or maximize it |
+
+---
+
+## ⚠️ Legal Notice
+
+Use this tool **only on systems you own or have written permission to test**. Scanning other people's networks without permission can be illegal and may lead to serious consequences. nmaping asks you to confirm permission before every scan, but **you are fully responsible** for how you use it.
+
+---
+
+## 📜 License
+
+For educational and ethical use only. See `LICENSE` for details.

nmaping-2.2/README.md

@@ -0,0 +1,271 @@
+# 🚀 nmaping
+
+**nmaping** is a simple, colorful, menu-based tool that helps you run Nmap scans without remembering any commands. Pick a scan from the menu, enter a target, and get your results. Everything is saved automatically.
+
+Made by **Mr Tan**.
+
+---
+
+## 📖 What Does It Do?
+
+Nmap is a powerful network scanner, but its commands are long and hard to remember. nmaping does the hard part for you:
+
+- Shows all scan types in a clean numbered menu
+- Asks for your target (IP address, website, or a whole network range)
+- Lets you choose how fast or how quiet the scan should be
+- Runs the scan and shows the result on screen
+- Saves the result to a file and keeps a history of everything you scanned
+
+---
+
+## ✅ Before You Start
+
+You need two things on your computer:
+
+1. **Python 3.8 or newer**
+2. **Nmap**
+
+**Install Nmap:**
+
+| System | Command |
+|--------|---------|
+| Kali / Ubuntu / Debian | `sudo apt update && sudo apt install -y nmap` |
+| Fedora | `sudo dnf install nmap` |
+| Arch | `sudo pacman -S nmap` |
+| Windows | Download from https://nmap.org/download.html and tick **"Add to PATH"** during setup |
+
+---
+
+## 📦 How to Install
+
+### Linux (recommended: pipx)
+
+```bash
+sudo apt install -y pipx
+pipx ensurepath
+```
+
+Close and reopen your terminal, then:
+
+```bash
+pipx install nmaping
+```
+
+### Linux / Mac (using pip)
+
+New Linux versions don't allow plain `pip install`, so create a small environment first:
+
+```bash
+python3 -m venv ~/.nmaping-venv
+source ~/.nmaping-venv/bin/activate
+pip install nmaping
+```
+
+> Every time you want to use it later, run `source ~/.nmaping-venv/bin/activate` first.
+
+### Windows
+
+Open PowerShell and run:
+
+```powershell
+python -m pip install --user pipx
+python -m pipx ensurepath
+```
+
+Close and reopen PowerShell, then:
+
+```powershell
+pipx install nmaping
+```
+
+---
+
+## ▶️ How to Run
+
+Just type:
+
+```bash
+nmaping
+```
+
+---
+
+## 🧭 How to Use (Step by Step)
+
+1. Run `nmaping`. The main menu appears with the logo and a live clock.
+2. Type the **number** of the scan you want and press Enter.
+3. Enter your **target**, for example:
+   - `192.168.1.1` (one device)
+   - `example.com` (a website)
+   - `192.168.1.0/24` (a whole network)
+4. Confirm that you have **permission** to scan the target (type `y`).
+5. Choose a **speed** from 0 to 5 (just press Enter for the default).
+6. Wait for the scan to finish. The result is shown and saved automatically.
+7. Press Enter to return to the menu.
+
+In the main menu:
+- Type **H** to see your scan history
+- Type **0** to exit
+
+---
+
+## 🔍 Scan Types Explained
+
+| No. | Scan | What it does |
+|-----|------|--------------|
+| 1 | SYN Scan | Fast, quiet scan for open ports |
+| 2 | Version Detection | Finds which software and version runs on each open port |
+| 3 | Vulnerability Scan | Checks for known security weaknesses |
+| 4 | OS Detection | Guesses the operating system of the target |
+| 5 | Host Discovery | Checks which devices are online, no port scan |
+| 6 | Specific Port | Scans only the port(s) you choose (e.g. `80,443`) |
+| 7 | Top 1000 Ports | Scans the 1000 most common ports |
+| 8 | UDP Scan | Scans UDP ports (slower) |
+| 9 | Aggressive Scan | OS, version, scripts and traceroute in one go |
+| 10 | Firewall / ACK Scan | Helps find out if a firewall is filtering ports |
+| 11 | Default Script Scan | Runs Nmap's standard safe scripts |
+| 12 | Traceroute | Shows the path your traffic takes to the target |
+| 13 | All Ports | Scans all 65,535 ports (slow) |
+| 14 | Ping Scan | Checks if the target responds to ping |
+| 15 | No Ping Scan | Scans even if the target ignores ping |
+| 16 | TCP Connect | Normal connection scan, works without root |
+| 17 | Xmas Scan | Special stealth scan |
+| 18 | FIN Scan | Special stealth scan |
+| 19 | Null Scan | Special stealth scan |
+| 20 | Custom | Type your own Nmap options |
+| 21 | Full Deep Scan | Everything combined (very slow) |
+
+---
+
+## ⏱️ Speed Levels
+
+| Level | Name | Best for |
+|-------|------|----------|
+| 0 | Paranoid | Maximum stealth, extremely slow |
+| 1 | Sneaky | Very slow, hard to detect |
+| 2 | Polite | Gentle on the network |
+| 3 | Normal | Default, good for most cases |
+| 4 | Aggressive | Fast, recommended on good networks |
+| 5 | Insane | Fastest, use only in your own lab |
+
+---
+
+## ⌨️ Quick Commands (Without the Menu)
+
+If you already know what you want, skip the menu:
+
+```bash
+nmaping -t 192.168.1.1 -s 2 -T 4
+```
+
+Meaning: scan `192.168.1.1`, scan type `2` (Version Detection), speed `4`.
+
+| Option | Meaning |
+|--------|---------|
+| `-t` | Target |
+| `-s` | Scan number (1 to 21) |
+| `-T` | Speed (0 to 5) |
+| `-p` | Port(s), used with scan 6 |
+| `--no-save` | Don't save the result file |
+| `--list` | Show all scan types |
+| `-y` | Skip the permission question |
+
+More examples:
+
+```bash
+nmaping -t example.com -s 6 -p 80,443
+nmaping -t 192.168.1.0/24 -s 5
+nmaping --list
+```
+
+---
+
+## 🔑 Scans That Need Root (Linux)
+
+Scans 1, 4, 8, 17, 18, 19 (and some others) need administrator rights. Run:
+
+```bash
+sudo "$(which nmaping)"
+```
+
+When run with `sudo`, files are saved in `/root/.nmaping/` instead of your own folder.
+
+---
+
+## 🔄 How to Update to a New Version
+
+When a new version is released, update with one command.
+
+**If you installed with pipx:**
+
+```bash
+pipx upgrade nmaping
+```
+
+If it says nothing changed, force the update:
+
+```bash
+pipx install --force nmaping
+```
+
+**If you installed with pip:**
+
+```bash
+pip install --upgrade --force-reinstall nmaping
+```
+
+(Activate your environment first if you used one: `source ~/.nmaping-venv/bin/activate`)
+
+The logo shows your current version (`v=1.0`). Check the GitHub page to see if a newer one is available.
+
+---
+
+## 🗑️ How to Uninstall
+
+```bash
+pipx uninstall nmaping
+```
+
+or, if you used pip:
+
+```bash
+pip uninstall nmaping
+```
+
+Your saved results stay in `~/.nmaping/`. Delete that folder if you want to remove them too.
+
+---
+
+## 📁 Where Are My Results?
+
+| What | Location |
+|------|----------|
+| Scan results | `~/.nmaping/results/` |
+| Scan history | `~/.nmaping/history.log` |
+
+Each result file is named with the target, scan type, and date/time.
+
+---
+
+## 🛠️ Problems and Fixes
+
+| Problem | Fix |
+|---------|-----|
+| `nmaping: command not found` | Run `pipx ensurepath`, then close and reopen the terminal |
+| `externally-managed-environment` | Use pipx, or the pip method with a virtual environment |
+| `nmap not found` | Install Nmap (see "Before You Start") |
+| `requires root privileges` | Run with `sudo "$(which nmaping)"` |
+| Strange boxes instead of the logo on Windows | Use Windows Terminal, or run `chcp 65001` first |
+| Clock not beside the logo | Make your terminal window taller or maximize it |
+
+---
+
+## ⚠️ Legal Notice
+
+Use this tool **only on systems you own or have written permission to test**. Scanning other people's networks without permission can be illegal and may lead to serious consequences. nmaping asks you to confirm permission before every scan, but **you are fully responsible** for how you use it.
+
+---
+
+## 📜 License
+
+For educational and ethical use only. See `LICENSE` for details.