pingtunnel

Use the following command patterns to forward different types of traffic through the ICMP tunnel. Replace www.yourserver.com with your actual server address.

Forward SOCKS5

Use the -sock5 1 flag.

Forward TCP

Use the -t flag to specify the target destination and the -tcp 1 flag.

Forward UDP

Use the -t flag to specify the target destination.

# Forward SOCKS5
pingtunnel.exe -type client -l :4455 -s www.yourserver.com -sock5 1

# Forward tcp
pingtunnel.exe -type client -l :4455 -s www.yourserver.com -t www.yourserver.com:4455 -tcp 1

# Forward udp
pingtunnel.exe -type client -l :4455 -s www.yourserver.com -t www.yourserver.com:4455

You can run both the server and client using Docker containers. The parameters used are the same as the binary versions.

Server requirements: Must run with --privileged and --network host to handle ICMP traffic correctly.

To deploy Pingtunnel using Docker Compose, follow these steps:

1. Configure Environment: Edit the .env file in the docker-compose/ directory with your appropriate values.
2. Start the Server: Run the following command in the server directory:

   docker-compose -f server.yml up -d

3. Start the Client: Run the following command on the client machine:

   docker-compose -f client.yml up -d

Once deployed, a SOCKS5 proxy will be available on port 1080 of your client machine.

Download the appropriate installation package from releases and decompress it. Run the client with administrator privileges.

Successful connections are indicated by ping/pong logs in the output.

Note on -key parameter: If used, the -key parameter must be an integer between 0 and 2147483647.

To set up a Pingtunnel server, you need a machine with a public IP (e.g., AWS EC2).

1. Download the appropriate installation package from the releases page (e.g., pingtunnel_linux64.zip).
2. Decompress the package.
3. Execute the binary with root privileges using the -type server flag.

Note on -key parameter: If used, the -key parameter must be an integer between 0 and 2147483647.

(Optional) You can disable the system default ping response by running: echo 1 > /proc/sys/net/ipv4/icmp_echo_ignore_all

sudo wget (link of latest release)
sudo unzip pingtunnel_linux64.zip
sudo ./pingtunnel -type server

The package provides utilities to parse and build SOCKS5 UDP datagrams for UDP association support.

• parseSocks5UDPDatagram(packet []byte): Extracts the target address and the actual payload from a raw UDP packet.
• buildSocks5UDPDatagram(targetAddr string, payload []byte): Encapsulates a payload into a SOCKS5-compliant UDP datagram for a specific target address.

The Client struct provides several methods to inspect the current state and configuration of the tunnel:

• Addr(): Returns the local address string.
• IPAddr(): Returns the local UDP address.
• TargetAddr(): Returns the target destination address string.
• ICMPAddr(): Returns the ICMP address string.
• ServerIPAddr(): Returns the resolved server IP address.
• ServerAddr(): Returns the server address string.
• RTT(): Returns the current Round Trip Time.
• RecvPacket(): Returns the total number of received packets.
• SendPacket(): Returns the total number of sent packets.
• RecvPacketSize(): Returns the total bytes received.
• SendPacketSize(): Returns the total bytes sent.
• LocalIdToConnMapSize(): Returns the number of active connections tracked by ID.
• LocalAddrToConnMapSize(): Returns the number of active connections tracked by local address.

Use ParseEncryptionMode to convert a string representation into an EncryptionMode type. This is useful for processing configuration files or CLI arguments.

Supported string values:

• "" or "none" -> NoEncryption
• "aes128" -> AES128
• "aes256" -> AES256
• "chacha20" or "chacha20-poly1305" -> CHACHA20