README
¶
Etherguard
A Full Mesh Layer2 VPN based on wireguard-go
OSPF can find best route based on it's cost.
But sometimes the latency are different in the packet goes and back.
I'm thinking, is it possible to find the best route based on the single-way latency?
For example, I have two routes A and B at node N1, both of them can reach my node N2. A goes fast, but B backs fast.
My VPN can automatically send packet through route A at node N1, and the packet backs from route B.
Here is the solution. This VPN Etherguard can collect all the single-way latency from all nodes, and calculate the best route using Floyd–Warshall algorithm.
Worried about the clock not match so that the measure result are not correct? It doesn't matter, here is the proof (Mandarin): https://www.kskb.eu.org/2021/08/rootless-routerpart-3-etherguard.html
Usage
Usage of ./etherguard-go:
-bind string
UDP socket bind mode. [linux|std]
You may need std mode if you want to run Etherguard under WSL. (default "linux")
-cfgmode string
Running mode for generated config. [none|super|p2p]
-config string
Config path for the interface.
-example
Print example config
-help
Show this help
-mode string
Running mode. [super|edge|solve|gencfg]
-no-uapi
Disable UAPI
With UAPI, you can check etherguard status by "wg" command
-version
Show version
Working Mode
| Mode | Description |
|---|---|
| Static Mode | No dynamic routing, no handshake server. Similar to original wireguard , all configs are static Detail |
| Super Mode | Inspired by n2n. There 2 types of node: SuperNode and EdgeNode EdgeNode must connect to SuperNode first，get connection info of other EdgeNode from the SuperNode The SuperNode runs Floyd-Warshall Algorithm，and distribute the result to all other EdgeNodes. Detail |
| P2P Mode | Inspired by tinc, There are no SuperNode. All EdgeNode will exchange information each other. EdgeNodes are keep trying to connect each other, and notify all other peers success or not. All edges runs Floyd-Warshall Algorithm locally and find the best route by it self. Not recommend to use this mode in production environment, not test yet. Detail |
Quick start
Build
No-vpp version
Build Etherguard.
Install Go 1.16
add-apt-repository ppa:longsleep/golang-backports
apt-get -y update
apt-get install -y wireguard-tools golang-go build-essential git
Build
make
VPP version
Build Etherguard with VPP integrated.
You need libmemif.so installed to run this version.
Install VPP and libmemif
echo "deb [trusted=yes] https://packagecloud.io/fdio/release/ubuntu focal main" > /etc/apt/sources.list.d/99fd.io.list
curl -L https://packagecloud.io/fdio/release/gpgkey | sudo apt-key add -
apt-get -y update
apt-get install -y vpp vpp-plugin-core python3-vpp-api vpp-dbg vpp-dev libmemif libmemif-dev
Build
make vpp
Documentation
¶
There is no documentation for this package.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package conn implements WireGuard's network connections.
|
Package conn implements WireGuard's network connections. |
|
example_config
|
|
|
winpipe
Package winpipe implements a net.Conn and net.Listener around Windows named pipes.
|
Package winpipe implements a net.Conn and net.Listener around Windows named pipes. |
|
Package daemon provides a Go implementation of the sd_notify protocol.
|
Package daemon provides a Go implementation of the sd_notify protocol. |
|
Package replay implements an efficient anti-replay algorithm as specified in RFC 6479.
|
Package replay implements an efficient anti-replay algorithm as specified in RFC 6479. |
|
Package rwcancel implements cancelable read/write operations on a file descriptor.
|
Package rwcancel implements cancelable read/write operations on a file descriptor. |