wireguard-go README

The project's README from github.com/WireGuard/wireguard-go. As one markdown file: README.md.

Go Implementation of WireGuard

This is an implementation of WireGuard in Go.

Usage

Most Linux kernel WireGuard users are used to adding an interface with ip link add wg0 type wireguard. With wireguard-go, instead simply run:

$ wireguard-go wg0

This will create an interface and fork into the background. To remove the interface, use the usual ip link del wg0, or if your system does not support removing interfaces directly, you may instead remove the control socket via rm -f /var/run/wireguard/wg0.sock, which will result in wireguard-go shutting down.

To run wireguard-go without forking to the background, pass -f or --foreground:

$ wireguard-go -f wg0

When an interface is running, you may use wg(8) to configure it, as well as the usual ip(8) and ifconfig(8) commands.

To run with more logging you may set the environment variable LOG_LEVEL=debug.

Platforms

Linux

This will run on Linux; however you should instead use the kernel module, which is faster and better integrated into the OS. See the installation page for instructions.

macOS

This runs on macOS using the utun driver. It does not yet support sticky sockets, and won't support fwmarks because of Darwin limitations. Since the utun driver cannot have arbitrary interface names, you must either use utun[0-9]+ for an explicit interface name or utun to have the kernel select one for you. If you choose utun as the interface name, and the environment variable WG_TUN_NAME_FILE is defined, then the actual name of the interface chosen by the kernel is written to the file specified by that variable.

Windows

This runs on Windows, but you should instead use it from the more fully featured Windows app, which uses this as a module.

FreeBSD

This will run on FreeBSD. It does not yet support sticky sockets. Fwmark is mapped to SO_USER_COOKIE.

OpenBSD

This will run on OpenBSD. It does not yet support sticky sockets. Fwmark is mapped to SO_RTABLE. Since the tun driver cannot have arbitrary interface names, you must either use tun[0-9]+ for an explicit interface name or tun to have the program select one for you. If you choose tun as the interface name, and the environment variable WG_TUN_NAME_FILE is defined, then the actual name of the interface chosen by the kernel is written to the file specified by that variable.

Building

This requires an installation of the latest version of Go.

$ git clone https://git.zx2c4.com/wireguard-go
$ cd wireguard-go
$ make

License

Copyright (C) 2017-2025 WireGuard LLC. All Rights Reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

wireguard-go (WireGuard/wireguard-go)

Searching Database…

4.5K ·GitHub
Wireguard-go
Что это такое?wireguard-go — это реализация WireGuard VPN в пространстве пользователя, написанная на Go: она работает как обычная программа, которая создаёт сетевой интерфейс WireGuard, а не находится внутри ядра ОС.
То есть это VPN-приложение, которое я устанавливаю, или что-то более низкоуровневое?Это более низкоуровневая вещь: никакого графического интерфейса здесь нет. При запуске создаётся интерфейс вроде wg0, процесс уходит в фон, а сам интерфейс вы настраиваете стандартными утилитами wg(8), ip(8) и ifconfig(8).
Как поднять с её помощью интерфейс WireGuard?Запустите 'wireguard-go wg0' — команда создаст интерфейс и уйдёт в фон (с флагом -f или --foreground процесс останется на переднем плане). Удалить интерфейс позже можно командой 'ip link del wg0' либо удалив управляющий сокет /var/run/wireguard/wg0.sock — это его выключит.
Что нужно, чтобы собрать проект?Только последняя версия Go — это единственное требование для сборки, которое упоминается в README.
Есть ли особенности, связанные с конкретными ОС, о которых стоит знать?Да. Порт для macOS использует драйвер utun, не поддерживает sticky sockets и fwmark и допускает только имена интерфейсов вроде utun0 или utun1; порты для FreeBSD и OpenBSD тоже не поддерживают sticky sockets (fwmark отображается на SO_USERCOOKIE / SO_RTABLE), а OpenBSD разрешает только имена вида tun[0-9]+.
В каких случаях мне выбрать эту версию для пространства пользователя вместо обычного WireGuard?Там, где модуль ядра недоступен — macOS и BSD, — или когда вы хотите встроить WireGuard в своё приложение: официальное приложение для Windows построено на wireguard-go как на модуле. Для Linux и Windows README направляет обычных пользователей к другим пакетам.
На каких операционных системах это работает?Поддерживаются Linux, macOS, Windows, FreeBSD и OpenBSD — правда, README советует пользователям Linux предпочесть более быстрый и лучше интегрированный модуль ядра, а пользователей Windows отправляет к полноценному приложению WireGuard, в которое встроен этот код.
Как получить более подробные логи, если туннель работает плохо?Задайте переменную окружения LOGLEVEL=debug перед запуском wireguard-go — это встроенный переключатель на более детальное логирование.
Это официальный репозиторий на GitHub?Нет — это только зеркало. Официальный репозиторий находится по адресу https://git.zx2c4.com/wireguard-go.
What are similar projects?tailscale, tailcat, Xray-core, Tailtab, openvpn, SoftEtherVPN, EasyTier, nebula
Which topics is it in?wireguard, tunnel, freebsd, vpn, encryption, bsd, networking, go, command-line-tool, privacy, security, self-hosted
Creator
WireGuard
Size
1.8 MB
Stars
4.5K
Updated
CommitOct 06
Age
8y
Commits · 90 Days