History

Callan Bryant ddaeb19b54 vendor + update modules		2020-11-29 21:07:40 +00:00
..
internal	vendor + update modules	2020-11-29 21:07:40 +00:00
wgtypes	vendor + update modules	2020-11-29 21:07:40 +00:00
.cibuild.sh	vendor + update modules	2020-11-29 21:07:40 +00:00
.gitignore	vendor + update modules	2020-11-29 21:07:40 +00:00
client.go	vendor + update modules	2020-11-29 21:07:40 +00:00
CONTRIBUTING.md	vendor + update modules	2020-11-29 21:07:40 +00:00
doc.go	vendor + update modules	2020-11-29 21:07:40 +00:00
go.mod	vendor + update modules	2020-11-29 21:07:40 +00:00
go.sum	vendor + update modules	2020-11-29 21:07:40 +00:00
LICENSE.md	vendor + update modules	2020-11-29 21:07:40 +00:00
os_linux.go	vendor + update modules	2020-11-29 21:07:40 +00:00
os_openbsd.go	vendor + update modules	2020-11-29 21:07:40 +00:00
os_userspace.go	vendor + update modules	2020-11-29 21:07:40 +00:00
README.md	vendor + update modules	2020-11-29 21:07:40 +00:00

README.md

wgctrl

Package wgctrl enables control of WireGuard devices on multiple platforms.

For more information on WireGuard, please see https://www.wireguard.com/.

MIT Licensed.

go get golang.zx2c4.com/wireguard/wgctrl

Overview

wgctrl can control multiple types of WireGuard devices, including:

Linux kernel module devices, via generic netlink
userspace devices (e.g. wireguard-go), via the userspace configuration protocol
- both UNIX-like and Windows operating systems are supported
Experimental: OpenBSD kernel module devices, via ioctl interface
- See https://git.zx2c4.com/wireguard-openbsd/about/ for details. Specify environment variable WGCTRL_OPENBSD_KERNEL=1 to enable this interface.

As new operating systems add support for in-kernel WireGuard implementations, this package should also be extended to support those native implementations.

If you are aware of any efforts on this front, please file an issue.

This package implements WireGuard configuration protocol operations, enabling the configuration of existing WireGuard devices. Operations such as creating WireGuard devices, or applying IP addresses to those devices, are out of scope for this package.