Skip to content

Commit d51243f

Browse files
Copilotnpv2k1
andcommitted
Add documentation for port explorer module
Co-authored-by: npv2k1 <73846954+npv2k1@users.noreply.github.com>
1 parent 0bdd839 commit d51243f

2 files changed

Lines changed: 80 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,20 @@
44

55
This template should help get you started developing with Tauri, React and Typescript in Vite.
66

7+
## Features
8+
9+
### Port Explorer
10+
A powerful port scanning module that allows you to scan ports on your local machine or remote IP addresses. Features include:
11+
- **Native TCP scanning** built with Rust
12+
- **Nmap integration** for advanced scanning (optional)
13+
- Configurable port ranges and timeout settings
14+
- Service detection for common ports
15+
- Interactive results table with filtering and sorting
16+
17+
To access: Navigate to **Tauri > PortExplorer** in the application.
18+
19+
See [Port Explorer Documentation](src/modules/tauri/components/port-explorer/README.md) for more details.
20+
721
## Recommended IDE Setup
822

923
- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Port Explorer Module
2+
3+
A powerful port scanning tool integrated into PNTools that allows you to scan ports on your local machine or remote IP addresses.
4+
5+
## Features
6+
7+
- **Native Port Scanning**: Fast TCP connection-based port scanning built with Rust
8+
- **Nmap Integration**: Optional use of nmap for more advanced scanning (when nmap is installed)
9+
- **Flexible Configuration**:
10+
- Custom host/IP address targeting
11+
- Configurable port range (1-65535)
12+
- Adjustable timeout settings
13+
- Toggle between native and nmap scanning methods
14+
- **Service Detection**: Automatically identifies common services on open ports
15+
- **Interactive Results Table**:
16+
- Sortable columns
17+
- Filterable by status (open/closed)
18+
- Shows port number, status, and associated service
19+
20+
## Usage
21+
22+
1. Navigate to `Tauri > PortExplorer` in the application menu
23+
2. Configure your scan:
24+
- **Target Host/IP**: Enter the hostname or IP address to scan (default: 127.0.0.1)
25+
- **Port Range**: Set the start and end ports to scan
26+
- **Timeout**: Adjust the connection timeout in milliseconds (default: 1000ms)
27+
- **Use nmap**: Toggle to use nmap instead of native scanning (requires nmap installation)
28+
3. Click "Start Scan" to begin
29+
4. View results in the table below, showing all scanned ports with their status
30+
31+
## Scanning Methods
32+
33+
### Native Scanning
34+
- Uses Rust's TCP connection capabilities
35+
- Fast for small port ranges
36+
- No external dependencies required
37+
- Works on all platforms
38+
39+
### Nmap Scanning
40+
- Requires nmap to be installed on your system
41+
- More accurate service detection
42+
- Better for scanning large port ranges
43+
- Advanced scanning capabilities
44+
45+
To use nmap scanning:
46+
- **Linux/macOS**: Install via package manager (`sudo apt install nmap` or `brew install nmap`)
47+
- **Windows**: Download from [nmap.org](https://nmap.org/download.html)
48+
49+
## Common Ports
50+
51+
The module recognizes common service ports including:
52+
- 21: FTP
53+
- 22: SSH
54+
- 80: HTTP
55+
- 443: HTTPS
56+
- 3306: MySQL
57+
- 5432: PostgreSQL
58+
- 6379: Redis
59+
- 8080: HTTP-Alt
60+
- 27017: MongoDB
61+
62+
And many more...
63+
64+
## Security Note
65+
66+
Port scanning should only be performed on networks and systems you own or have explicit permission to scan. Unauthorized port scanning may be illegal in some jurisdictions.

0 commit comments

Comments
 (0)