wireguard

Documentation

Overview

Package wireguard manages user-space Wireguard interface.

Index

• Constants
• func NetworkPrefix(installationID string) netaddr.IPPrefix
• func UAPIOpen(interfaceName string) (net.Listener, error)
• type Device
  • func NewDevice(address netaddr.IPPrefix, privateKey wgtypes.Key, listenPort uint16) (*Device, error)
  • func (dev *Device) Close() error
  • func (dev *Device) Peers() ([]wgtypes.Peer, error)
  • func (dev *Device) Run(ctx context.Context, logger *zap.Logger, peers PeerSource) error
• type PeerEvent
• type PeerSource

Constants

const PeerDownInterval = (180 + 5 + 90) * time.Second

PeerDownInterval is the time since last handshake when established peer is considered to be down.

WG whitepaper defines a downed peer as being: Handshake Timeout (180s) + Rekey Timeout (5s) + Rekey Attempt Timeout (90s)

This interval is applied when the link is already established.

Functions

func NetworkPrefix

func NetworkPrefix(installationID string) netaddr.IPPrefix

NetworkPrefix returns IPv6 prefix for the SideroLink.

Server is using the first address in the block. Nodes are using random addresses from the /64 space.

func UAPIOpen

func UAPIOpen(interfaceName string) (net.Listener, error)

UAPIOpen opens a UAPI socket.

Types

type Device

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

Device manages Wireguard link.

func NewDevice

func NewDevice(address netaddr.IPPrefix, privateKey wgtypes.Key, listenPort uint16) (*Device, error)

NewDevice creates a new device with settings.

func (*Device) Close

func (dev *Device) Close() error

Close the device.

func (*Device) Peers

func (dev *Device) Peers() ([]wgtypes.Peer, error)

Peers returns underlying peer states from the underlying wireguard device.

func (*Device) Run

func (dev *Device) Run(ctx context.Context, logger *zap.Logger, peers PeerSource) error

Run the device.

type PeerEvent

type PeerEvent struct {
	PubKey wgtypes.Key

	Remove   bool
	Endpoint string

	Address netaddr.IP
}

PeerEvent is the event about peer state change.

type PeerSource

type PeerSource interface {
	EventCh() <-chan PeerEvent
}

PeerSource is the interface of the "database" providing SideroLink peer information.