wgctrl

package module

v0.0.0-...-7db555b Latest Latest Go to latest Published: May 17, 2020 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/k-vpn/wgctrl-go

Links

Open Source Insights

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.

go get github.com/k-vpn/wgctrl-go

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.

Documentation ¶

Rendered for

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/k-vpn/wgctrl-go

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.

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 New ¶

func New() (*Client, error)

New creates a new Client.

func (*Client) Close ¶

func (c *Client) Close() error

Close releases resources used by a Client.

func (*Client) ConfigureDevice ¶

func (c *Client) ConfigureDevice(name string, cfg wgtypes.Config) error

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.

func (*Client) Device ¶

func (c *Client) Device(name string) (*wgtypes.Device, error)

Device retrieves a WireGuard device by its interface name.

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.

func (*Client) Devices ¶

func (c *Client) Devices() ([]*wgtypes.Device, error)

Devices retrieves all WireGuard devices on this system.

Source Files ¶

View all 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
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.
wglinux/internal/wgh Package wgh is an auto-generated package which contains constants and types used to access WireGuard information using generic netlink.	Package wgh is an auto-generated package which contains constants and types used to access WireGuard information using generic netlink.
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.
wgtypes Package wgtypes provides shared types for the wgctrl family of packages.	Package wgtypes provides shared types for the wgctrl family of packages.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL