README
¶
wgctrl 
Package wgctrl enables control of WireGuard devices on multiple platforms.
For more information on WireGuard, please see https://www.wireguard.com/.
MIT Licensed.
Overview
wgctrl can control multiple types of WireGuard devices, including:
- Kernel module devices
- Linux: via generic netlink
- FreeBSD: via ioctl interface
- OpenBSD: via ioctl interface (read-only)
- Windows: via ioctl interface
- Userspace devices via the userspace configuration protocol
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.
Documentation
¶
Overview ¶
Package wgctrl enables control of WireGuard devices on multiple platforms.
For more information on WireGuard, please see https://www.wireguard.com/.
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 `errors.Is(err, os.ErrNotExist)`.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
wgctrl
Command wgctrl is a testing utility for interacting with WireGuard via package wgctrl.
|
Command wgctrl is a testing utility for interacting with WireGuard via package wgctrl. |
|
internal
|
|
|
wgfreebsd
Package wgfreebsd provides internal access to FreeBSD's WireGuard ioctl interface.
|
Package wgfreebsd provides internal access to FreeBSD's WireGuard ioctl interface. |
|
wgfreebsd/internal/nv
Package nv marshals and unmarshals Go maps to/from FreeBSDs nv(9) name/value lists See: https://www.freebsd.org/cgi/man.cgi?query=nv&sektion=9
|
Package nv marshals and unmarshals Go maps to/from FreeBSDs nv(9) name/value lists See: https://www.freebsd.org/cgi/man.cgi?query=nv&sektion=9 |
|
wgfreebsd/internal/wgh
Package wgh is an auto-generated package which contains constants and types used to access WireGuard information using ioctl calls.
|
Package wgh is an auto-generated package which contains constants and types used to access WireGuard information using ioctl calls. |
|
wginternal
Package wginternal contains shared internal types for wgctrl.
|
Package wginternal contains shared internal types for wgctrl. |
|
wglinux
Package wglinux provides internal access to Linux's WireGuard generic netlink interface.
|
Package wglinux provides internal access to Linux's WireGuard generic netlink interface. |
|
wgopenbsd
Package wgopenbsd provides internal access to OpenBSD's WireGuard ioctl interface.
|
Package wgopenbsd provides internal access to OpenBSD's WireGuard ioctl interface. |
|
wgopenbsd/internal/wgh
Package wgh is an auto-generated package which contains constants and types used to access WireGuard information using ioctl calls.
|
Package wgh is an auto-generated package which contains constants and types used to access WireGuard information using ioctl calls. |
|
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. |