ff62fec956
When account id supplied via claim, we should handle change of the domain classification. If category of domain change to private, we should re-evaluate the private account |
||
---|---|---|
.github/workflows | ||
client | ||
docs | ||
encryption | ||
iface | ||
infrastructure_files | ||
management | ||
release_files | ||
signal | ||
util | ||
.gitignore | ||
.goreleaser.yaml | ||
AUTHORS | ||
CODE_OF_CONDUCT.md | ||
go.mod | ||
go.sum | ||
LICENSE | ||
README.md |
Start using Wiretrustee at app.wiretrustee.com
See Documentation
Join our Slack channel
Wiretrustee is an open-source VPN platform built on top of WireGuard® making it easy to create secure private networks for your organization or home.
It requires zero configuration effort leaving behind the hassle of opening ports, complex firewall rules, VPN gateways, and so forth.
Wiretrustee automates Wireguard-based networks, offering a management layer with:
- Centralized Peer IP management with a UI dashboard.
- Encrypted peer-to-peer connections without a centralized VPN gateway.
- Automatic Peer discovery and configuration.
- UDP hole punching to establish peer-to-peer connections behind NAT, firewall, and without a public static IP.
- Connection relay fallback in case a peer-to-peer connection is not possible.
- Multitenancy (coming soon).
- Client application SSO with MFA (coming soon).
- Access Controls (coming soon).
- Activity Monitoring (coming soon).
- Private DNS (coming soon)
Secure peer-to-peer VPN in minutes
Note: The main
branch may be in an unstable or even broken state during development. For stable versions, see releases.
Hosted version: https://app.wiretrustee.com/.
A bit on Wiretrustee internals
- Wiretrustee features a Management Service that offers peer IP management and network updates distribution (e.g. when a new peer joins the network).
- Wiretrustee uses WebRTC ICE implemented in pion/ice library to discover connection candidates when establishing a peer-to-peer connection between devices.
- Peers negotiate connection through Signal Service.
- Signal Service uses public Wireguard keys to route messages between peers. Contents of the messages sent between peers through the signaling server are encrypted with Wireguard keys, making it impossible to inspect them.
- Occasionally, the NAT traversal is unsuccessful due to strict NATs (e.g. mobile carrier-grade NAT). When this occurs the system falls back to the relay server (TURN), and a secure Wireguard tunnel is established via the TURN server. Coturn is the one that has been successfully used for STUN and TURN in Wiretrustee setups.
Product Roadmap
Client Installation
Linux
APT/Debian
- Add the repository:
sudo apt-get update sudo apt-get install ca-certificates curl gnupg -y curl -L https://pkgs.wiretrustee.com/debian/public.key | sudo apt-key add - echo 'deb https://pkgs.wiretrustee.com/debian stable main' | sudo tee /etc/apt/sources.list.d/wiretrustee.list
- Install the package
sudo apt-get update sudo apt-get install wiretrustee
RPM/Red hat
- Add the repository:
cat <<EOF | sudo tee /etc/yum.repos.d/wiretrustee.repo [Wiretrustee] name=Wiretrustee baseurl=https://pkgs.wiretrustee.com/yum/ enabled=1 gpgcheck=0 gpgkey=https://pkgs.wiretrustee.com/yum/repodata/repomd.xml.key repo_gpgcheck=1 EOF
- Install the package
sudo yum install wiretrustee
MACOS
Brew install
- Download and install Brew at https://brew.sh/
- Install the client
brew install wiretrustee/client/wiretrustee
Installation from binary
- Checkout Wiretrustee releases
- Download the latest release (Switch VERSION to the latest):
curl -o ./wiretrustee_<VERSION>_darwin_amd64.tar.gz https://github.com/wiretrustee/wiretrustee/releases/download/v<VERSION>/wiretrustee_<VERSION>_darwin_amd64.tar.gz
- Decompress
tar xcf ./wiretrustee_<VERSION>_darwin_amd64.tar.gz
sudo mv wiretrusee /usr/local/bin/wiretrustee
chmod +x /usr/local/bin/wiretrustee
After that you may need to add /usr/local/bin in your MAC's PATH environment variable:
export PATH=$PATH:/usr/local/bin
Windows
- Checkout Wiretrustee releases
- Download the latest Windows release installer
wiretrustee_installer_<VERSION>_windows_amd64.exe
(Switch VERSION to the latest): - Proceed with installation steps
- This will install the client in the C:\Program Files\Wiretrustee and add the client service
- After installing, you can follow the Client Configuration steps.
To uninstall the client and service, you can use Add/Remove programs
Client Configuration
- Login to the Management Service. You need to have a
setup key
in hand (see ).
For Unix systems:
sudo wiretrustee up --setup-key <SETUP KEY>
For Windows systems, start powershell as administrator and:
wiretrustee up --setup-key <SETUP KEY>
For Docker, you can run with the following command:
docker run --network host --privileged --rm -d -e WT_SETUP_KEY=<SETUP KEY> -v wiretrustee-client:/etc/wiretrustee wiretrustee/wiretrustee:<TAG>
TAG > 0.3.0 version
Alternatively, if you are hosting your own Management Service provide --management-url
property pointing to your Management Service:
sudo wiretrustee up --setup-key <SETUP KEY> --management-url https://localhost:33073
You could also omit the
--setup-key
property. In this case, the tool will prompt for the key.
- Check your IP: For MACOS you will just start the service:
sudo ipconfig getifaddr utun100
For Linux systems:
ip addr show wt0
For Windows systems:
netsh interface ip show config name="wt0"
- Repeat on other machines.
Running Dashboard, Management, Signal and Coturn
Legal
WireGuard is a registered trademark of Jason A. Donenfeld.