wgserver

Documentation

Index

• type WGClient
• type WGServer
  • func NewWGServer() (WGServer, error)
  • func (wgs WGServer) Close() error
  • func (wgs WGServer) ConfigureDevice(name string, cfg *pb.Config) error
  • func (wgs WGServer) Device(name string) (*pb.Device, error)
  • func (wgs WGServer) Devices() ([]*pb.Device, error)

Types

type WGClient

type WGClient interface {
	io.Closer
	ConfigureDevice(string, wgtypes.Config) error
	Device(string) (*wgtypes.Device, error)
	Devices() ([]*wgtypes.Device, error)
}

WGClient represents the wireguard client

type WGServer

type WGServer struct {
	// contains filtered or unexported fields
}

WGServer keeps data about wireguard server

func NewWGServer

func NewWGServer() (WGServer, error)

NewWGServer creates a new instance of WGServer

func (WGServer) Close

func (wgs WGServer) Close() error

Close releases resources used by a WGServer.

func (WGServer) ConfigureDevice

func (wgs WGServer) ConfigureDevice(name string, cfg *pb.Config) error

ConfigureDevice configures 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 `errors.Is(err, os.ErrNotExist)` os.ErrInvalid is returned on invalid input.

func (WGServer) Device

func (wgs WGServer) Device(name string) (*pb.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 `errors.Is(err, os.ErrNotExist)`.

func (WGServer) Devices

func (wgs WGServer) Devices() ([]*pb.Device, error)

Devices retrieves all WireGuard devices on this system.