iface

Documentation

Index

• Constants
• func Exists(iface string) (*bool, error)
• func WireguardModExists() bool
• type NativeLink
• type NetInterface
• type WGAddress
• type WGIface
  • func NewWGIface(iface string, address string, mtu int) (WGIface, error)
  • func (w *WGIface) Close() error
  • func (w *WGIface) Configure(privateKey string, port int) error
  • func (w *WGIface) Create() error
  • func (w *WGIface) CreateWithKernel() error
  • func (w *WGIface) CreateWithUserspace() error
  • func (w *WGIface) GetListenPort() (*int, error)
  • func (w *WGIface) RemovePeer(peerKey string) error
  • func (w *WGIface) UpdatePeer(peerKey string, allowedIps string, keepAlive time.Duration, ...) error

Constants

const (
	DefaultMTU    = 1280
	DefaultWgPort = 51820
)

const WgInterfaceDefault = "wt0"

WgInterfaceDefault is a default interface name of Wiretrustee

Functions

func Exists

func Exists(iface string) (*bool, error)

Exists checks whether specified Wireguard device exists or not

func WireguardModExists

func WireguardModExists() bool

Types

type NativeLink

type NativeLink struct {
	Link *netlink.Link
}

type NetInterface

type NetInterface interface {
	Close() error
}

NetInterface represents a generic network tunnel interface

type WGAddress

type WGAddress struct {
	IP      net.IP
	Network *net.IPNet
}

WGAddress Wireguard parsed address

type WGIface

type WGIface struct {
	Name      string
	Port      int
	MTU       int
	Address   WGAddress
	Interface NetInterface
}

WGIface represents a interface instance

func NewWGIface

func NewWGIface(iface string, address string, mtu int) (WGIface, error)

NewWGIface Creates a new Wireguard interface instance

func (*WGIface) Close

func (w *WGIface) Close() error

Closes the tunnel interface

func (*WGIface) Configure

func (w *WGIface) Configure(privateKey string, port int) error

Configure configures a Wireguard interface The interface must exist before calling this method (e.g. call interface.Create() before)

func (*WGIface) Create

func (w *WGIface) Create() error

Create Creates a new Wireguard interface, sets a given IP and brings it up. Will reuse an existing one.

func (*WGIface) CreateWithKernel

func (w *WGIface) CreateWithKernel() error

CreateWithKernel Creates a new Wireguard interface using kernel Wireguard module. Works for Linux and offers much better network performance

func (*WGIface) CreateWithUserspace

func (w *WGIface) CreateWithUserspace() error

CreateWithUserspace Creates a new Wireguard interface, using wireguard-go userspace implementation

func (*WGIface) GetListenPort

func (w *WGIface) GetListenPort() (*int, error)

GetListenPort returns the listening port of the Wireguard endpoint

func (*WGIface) RemovePeer

func (w *WGIface) RemovePeer(peerKey string) error

RemovePeer removes a Wireguard Peer from the interface iface

func (*WGIface) UpdatePeer

func (w *WGIface) UpdatePeer(peerKey string, allowedIps string, keepAlive time.Duration, endpoint *net.UDPAddr, preSharedKey *wgtypes.Key) error

UpdatePeer updates existing Wireguard Peer or creates a new one if doesn't exist Endpoint is optional