UDP Hole Punching Example in Go

This is a very simple repo to help demonstrate how UDP hole punching works in Go. It includes the signal server and a client.

Usage

1. Set up signal server on a publicly accessible server.

./hp s :9595

2. Run client from a machine behind a firewall:

./hp c ip-address-of-signal:9595 :4545

3. Run client from a different machine behind a different firewall:

./hp c ip-address-of-signal:9595 :4545

After doing this the two machines behind firewalls should start sending Hello! back and forth to each other via UDP. You can shut off the signal server and they will still be able to communicate peer to peer.

API

For both the server and the client you can specify the local address and port. You may exclude the local address and specify just the port. This is what most use cases would do. Leaving this off entirely will use :9595 which is to say any local address on port :9595.

Server

./hp s [local-address:port]

Client

./hp c [signal-host:port] [local-address:port]

You may exclude the local address and specify just the port. This is what most use cases would do. Leaving this off entirely will use :9595

Notes

https://en.wikipedia.org/wiki/UDP_hole_punching

Peer-to-Peer Communication Across Network Address Translators