Deuxfleurs/wgautomesh
16
1
Fork 1
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity
A simple utility to help connect wireguard nodes together in a full mesh topology
24 commits 1 branch 1 tag 82 KiB
Nix 72.5%
Rust 27.4%
Find a file
Alex Auvolat 65e979de80 reannounce persisted data
2023-03-09 16:58:43 +01:00
src reannounce persisted data 2023-03-09 16:58:43 +01:00
.gitignore fail with error message instead of panic 2023-03-09 11:08:05 +01:00
Cargo.lock gossip encryption (fix #4) 2023-03-09 14:23:40 +01:00
Cargo.nix update cargo.nix 2023-03-09 14:23:59 +01:00
Cargo.toml gossip encryption (fix #4) 2023-03-09 14:23:40 +01:00
config.toml first commit 2023-03-09 10:42:11 +01:00
default.nix add default.nix 2023-03-09 11:12:03 +01:00
flake.lock fail with error message instead of panic 2023-03-09 11:08:05 +01:00
flake.nix add nixfiles 2023-03-09 11:05:25 +01:00
Makefile first commit 2023-03-09 10:42:11 +01:00
README.md add README 2023-03-09 14:53:29 +01:00

README.md

wgautomesh

wgautomesh is a simple utility to help configure a full-mesh wireguard network. It does not assume that all nodes have a publicly reachable address. It uses a gossip protocol to broadcast the endpoint addresses nodes use to talk to one another. This way, even if nodes A and B are not able to communicate directly initially (both behind NAT), if they can both communicate with node C then they will indirectly be able to know each other's NAT-ed address and port. They will then try to connect to one another using those addresses, which should allow NAT hole punching.

Features:

  • does not assume all nodes are publicly reachable
  • configuration very similar to wg-quick: each node needs a list of the credentials of all other nodes in the mesh
  • wgautomesh does not create a wireguard interface, it assumes it exists and merely configures the peers attached to it
  • ultra simple encrypted gossip protocol over UDP (bincode encoding + xsalsa20poly1305 symmetric encryption)
  • automatic discovery of nodes in a same LAN using UDP broadcast (if enabled, nodes will prefer connecting to one another using their LAN IP addresses when available)
  • can automatically open ports in your router using IGD/UPnP

wgautomesh only tries to establish connectivity to the peers specified in its config file, it does not provide facilities for dynamically adding more peers like many wireguard configuration tools do.