Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/heiher/natmap
TCP/UDP port mapping for full cone NAT
https://github.com/heiher/natmap
bsd linux macos nat1 port-mapping tcp udp
Last synced: 26 days ago
JSON representation
TCP/UDP port mapping for full cone NAT
- Host: GitHub
- URL: https://github.com/heiher/natmap
- Owner: heiher
- License: mit
- Created: 2022-10-01T14:16:59.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-19T12:22:19.000Z (6 months ago)
- Last Synced: 2024-05-19T16:23:38.495Z (6 months ago)
- Topics: bsd, linux, macos, nat1, port-mapping, tcp, udp
- Language: C
- Homepage:
- Size: 149 KB
- Stars: 1,072
- Watchers: 15
- Forks: 79
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: License
Awesome Lists containing this project
README
# NATMap
[](https://github.com/heiher/natmap)
[](https://t.me/hellonatter)
This project is used to establish a TCP/UDP port mapping from an ISP NAT public
address to local private address. If all layers of NAT are full cones (NAT-1),
any host can access internal services through the mapped public address. In bind
mode, all traffic does not go through this program.
[中文文档](https://github.com/heiher/natmap/wiki)
## How to Build
```bash
git clone --recursive https://github.com/heiher/natmap.git
cd natmap
make
# statically link
make ENABLE_STATIC=1
# cross compile
make CROSS_PREFIX=${cross-toolchain}/bin/x86_64-unknown-linux-
# android
mkdir natmap
cd natmap
git clone --recursive https://github.com/heiher/natmap.git jni
ndk-build
```
## How to Use
### Usage
```
Usage:
natmap [options]
Options:
-4 use IPv4
-6 use IPv6
-u UDP mode
-d run as daemon
-i network interface or IP address
-k seconds between each keep-alive
-s [:port] domain name or address of STUN server
-h [:port] domain name or address of HTTP server
-e script path for notify mapped address
-f fwmark value (hex: 0x1, dec: 1, oct: 01)
Bind options:
-b [-port] port number range for binding
- <0>: random allocation
- : specified
- -: sequential allocation within the range
Forward options:
-T port forwarding timeout in seconds
-t
domain name or address of forward target
-p port number of forward target (0: use public port)
```
### Bind mode
```bash
# TCP
natmap -s turn.cloudflare.com -h example.com -b 80
# UDP
natmap -u -s turn.cloudflare.com -b 443
```
In TCP mode, this program will establishs a TCP port mapping in two steps:
1. Establish a connection with the HTTP server from the specified bind port and
keep it alive.
2. Establish a connection with the STUN server from the same port and obtain the
public address.
This program will then call the script specified by the argument to inform the
public address after the port mapping is established. The script can update
the DNS record for external access.
Please note that you need to open the firewall to allow access to the bind port.
#### OpenWrt
Goto Network -> Firewall -> Traffic Rules
Add a traffic rule:
* Protocol: TCP/UDP
* Source zone: wan
* Destination zone: Device (input)
* Destination port: [bind port]
* Action: accept
* Others: keep default values
If the port binding fails because it is already in use, this program will try
to find out which local service process occupies the port and enable port reuse
remotely. This works in Linux kernel 5.6 and later, and needs to run as root.
### Forward mode
```bash
# TCP
natmap -s turn.cloudflare.com -h example.com -b 80 -t 10.0.0.2 -p 80
# UDP
natmap -u -s turn.cloudflare.com -b 443 -t 10.0.0.2 -p 443
```
Similar to bind mode, this program will listen on bound port, accepts incoming
connections, and forward them to target address.
Another way is to use firewall's DNAT to forward, and this way should uses bind
mode.
#### OpenWrt
Goto Network -> Firewall -> Port Forwards
Add a port forward rule:
* Protocol: TCP/UDP
* Source zone: wan
* External port: [bind port]
* Destination zone: lan
* Internal IP address: 10.0.0.2
* Internal port: 80
* Others: keep default values
### Script arguments
```
{public-addr} {public-port} {ip4p} {private-port} {protocol} {private-addr}
```
* argv[0]: Script path
* argv[1]: Public address (IPv4/IPv6)
* argv[2]: Public port
* argv[3]: IP4P
* argv[4]: Bind port (private port)
* argv[5]: Protocol (TCP/UDP)
* argv[6]: Private address (IPv4/IPv6)
### IP4P address
The IP4P address format uses IPv6 special addresses to encode IPv4 addresses and
ports for easy distribution through DNS AAAA records.
```
2001::{port}:{ipv4-hi16}:{ipv4-lo16}
```
## Contributors
* **abgelehnt** - https://github.com/abgelehnt
* **hev** - https://hev.cc
* **mike wang** - https://github.com/mikewang000000
* **muink** - https://github.com/muink
* **tianling shen** - https://github.com/1715173329
* **xhe** - https://github.com/xhebox
## License
MIT