Documentation
¶
Overview ¶
Package wgctrl enables control of WireGuard devices on multiple platforms.
For more information on WireGuard, please see https://www.wireguard.com/.
go get github.com/bi-zone/ruwireguard-go/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: https://github.com/WireGuard/wgctrl-go/issues/new.
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.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
A Client provides access to WireGuard device information.
func (*Client) ConfigureDevice ¶
ConfigureDevice configures a WireGuard device by its interface name.
Because the zero value of some Go types may be significant to WireGuard for Config fields, only fields which are not nil will be applied when configuring a device.
If the device specified by name does not exist or is not a WireGuard device, an error is returned which can be checked using os.IsNotExist.
Directories
¶
Path | Synopsis |
---|---|
internal
|
|
wginternal
Package wginternal contains shared internal types for wgctrl.
|
Package wginternal contains shared internal types for wgctrl. |
wgtest
Package wgtest contains shared testing utilities for package wgctrl.
|
Package wgtest contains shared testing utilities for package wgctrl. |
wguser
Package wguser provides internal access to the userspace WireGuard configuration protocol interface.
|
Package wguser provides internal access to the userspace WireGuard configuration protocol interface. |
Package wgtypes provides shared types for the wgctrl family of packages.
|
Package wgtypes provides shared types for the wgctrl family of packages. |