Connect your devices into a single secure private WireGuard®-based mesh network with SSO/MFA and simple access controls.
Go to file
2021-05-06 14:40:51 +02:00
.github/workflows project init 2021-05-01 12:45:37 +02:00
cmd chore: add a bit more logs to the init command 2021-05-05 12:15:55 +02:00
connection fix: signal message encryption 2021-05-05 10:40:53 +02:00
iface project init 2021-05-01 12:45:37 +02:00
release_files chore: use config.json in teh service definition instead of wiretrustee.json 2021-05-06 13:54:20 +02:00
signal feat: add signal Docker 2021-05-05 15:48:29 +02:00
util project init 2021-05-01 12:45:37 +02:00
.gitignore project init 2021-05-01 12:45:37 +02:00
.goreleaser.yaml project init 2021-05-01 12:45:37 +02:00
Dockerfile feat: add signal Docker 2021-05-05 15:48:29 +02:00
go.mod feat: add wiretrustee init cmd to initialize config 2021-05-01 15:47:24 +02:00
go.sum fix: go mod tidy 2021-05-05 10:59:37 +02:00
main.go project init 2021-05-01 12:45:37 +02:00
README.md docs: readme formatting 2021-05-06 14:40:51 +02:00

Wiretrustee

A WireGuard®-based mesh network that connects your devices into a single private network.

Why using Wiretrustee?

  • Connect multiple devices to each other via a secure peer-to-peer Wireguard VPN tunnel. At home, the office, or anywhere else.
  • No need to open ports and expose public IPs on the device.
  • Automatically reconnects in case of network failures or switches.
  • Automatic NAT traversal.
  • Relay server fallback in case of an unsuccessful peer-to-peer connection.
  • Private key never leaves your device.
  • Works on ARM devices (e.g. Raspberry Pi).

A bit on Wiretrustee internals

  • Wiretrustee uses WebRTC ICE implemented in pion/ice library to discover connection candidates when establishing a peer-to-peer connection between devices.
  • A connection session negotiation between peers is achieved with the Wiretrustee Signalling server signal
  • Contents of the messages sent between peers through the signalling server are encrypted with Wireguard keys, making it impossible to inspect them. The routing of the messages on a Signalling server is based on public Wireguard keys.
  • Occasionally, the NAT-traversal is unsuccessful due to strict NATs (e.g. mobile carrier grade NAT). For that matter, there is support for a relay server fallback (TURN). So in case, the (NAT-traversal is unsuccessful???), a secure Wireguard tunnel is established via TURN server. Coturn is the one that has been successfully used for STUN and TURN in Wiretrustee setups.

What Wiretrustee is not doing (yet):

  • Wireguard key management. In consequence, you need to generate peer keys and specify them on Wiretrustee initialization step. However, the support for the key management feature is on our roadmap.
  • Peer address management. You have to specify a unique peer local address (e.g. 10.30.30.1/24) when configuring Wiretrustee The peer management assignment is on our roadmap too.

Installation

  1. Checkout Wiretrustee releases
  2. Download the latest release:
wget https://github.com/wiretrustee/wiretrustee/releases/download/v0.0.4/wiretrustee_0.0.4_linux_amd64.rpm
  1. Install the package
sudo dpkg -i wiretrustee_0.0.4_linux_amd64.deb
  1. Initialize Wiretrustee:
sudo wiretrustee init \
 --stunURLs stun:stun.wiretrustee.com:3468,stun:stun.l.google.com:19302 \
 --turnURLs <TURN User>:<TURN password>@turn:stun.wiretrustee.com:3468  \
 --signalAddr signal.wiretrustee.com:10000  \
 --wgLocalAddr 10.30.30.1/24  \
 --log-level info

It is important to mention that the wgLocalAddr parameter has to be unique across your network. E.g. if you have Peer A with wgLocalAddr=10.30.30.1/24 then another Peer B can have wgLocalAddr=10.30.30.2/24

If for some reason, you already have a generated Wireguard key, you can specify it with the --wgKey parameter. If not specified, then a new one will be generated, and its corresponding public key will be output to the log. A new config will be generated and stored under /etc/wiretrustee/config.json

  1. Add a peer to connect to.
sudo wiretrustee add-peer --allowedIPs 10.30.30.2/32 --key '<REMOTE PEER WIREUARD PUBLIC KEY>'
  1. Restart Wiretrustee
sudo systemctl restart wiretrustee.service
sudo systemctl status wiretrustee.service 

Roadmap

  • Android app
  • Key and address management service with SSO