wgcfg

Documentation

Overview

Package wgcfg has types and a parser for representing WireGuard config.

Index

• func NewDevice(tunDev tun.Device, bind conn.Bind, logger *device.Logger) *device.Device
• func ReconfigDevice(d *device.Device, cfg *Config, logf logger.Logf) (err error)
• type Config
  • func DeviceConfig(d *device.Device) (*Config, error)
  • func FromUAPI(r io.Reader) (*Config, error)
  • func (src *Config) Clone() *Config
  • func (config Config) PeerWithKey(k key.NodePublic) (Peer, bool)
  • func (cfg *Config) ToUAPI(logf logger.Logf, w io.Writer, prev *Config) error
• type ParseError
  • func (e *ParseError) Error() string
• type Peer
  • func (src *Peer) Clone() *Peer

Functions

func NewDevice

func NewDevice(tunDev tun.Device, bind conn.Bind, logger *device.Logger) *device.Device

NewDevice returns a wireguard-go Device configured for Tailscale use.

func ReconfigDevice

func ReconfigDevice(d *device.Device, cfg *Config, logf logger.Logf) (err error)

ReconfigDevice replaces the existing device configuration with cfg.

Types

type Config

type Config struct {
	Name       string
	NodeID     tailcfg.StableNodeID
	PrivateKey key.NodePrivate
	Addresses  []netip.Prefix
	MTU        uint16
	DNS        []netip.Addr
	Peers      []Peer

	// NetworkLogging enables network logging.
	// It is disabled if either ID is the zero value.
	NetworkLogging struct {
		NodeID   logid.PrivateID
		DomainID logid.PrivateID
	}
}

Config is a WireGuard configuration. It only supports the set of things Tailscale uses.

func DeviceConfig

func DeviceConfig(d *device.Device) (*Config, error)

func FromUAPI

func FromUAPI(r io.Reader) (*Config, error)

FromUAPI generates a Config from r. r should be generated by calling device.IpcGetOperation; it is not compatible with other uapi streams.

func (*Config) Clone

func (src *Config) Clone() *Config

Clone makes a deep copy of Config. The result aliases no memory with the original.

func (Config) PeerWithKey

func (config Config) PeerWithKey(k key.NodePublic) (Peer, bool)

PeerWithKey returns the Peer with key k and reports whether it was found.

func (*Config) ToUAPI

func (cfg *Config) ToUAPI(logf logger.Logf, w io.Writer, prev *Config) error

ToUAPI writes cfg in UAPI format to w. Prev is the previous device Config.

Prev is required so that we can remove now-defunct peers without having to remove and re-add all peers, and so that we can avoid writing information about peers that have not changed since the previous time we wrote our Config.

type ParseError

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

func (*ParseError) Error

func (e *ParseError) Error() string

type Peer

type Peer struct {
	PublicKey           key.NodePublic
	DiscoKey            key.DiscoPublic // present only so we can handle restarts within wgengine, not passed to WireGuard
	AllowedIPs          []netip.Prefix
	V4MasqAddr          *netip.Addr // if non-nil, masquerade IPv4 traffic to this peer using this address
	V6MasqAddr          *netip.Addr // if non-nil, masquerade IPv6 traffic to this peer using this address
	PersistentKeepalive uint16      // in seconds between keep-alives; 0 to disable
	// wireguard-go's endpoint for this peer. It should always equal Peer.PublicKey.
	// We represent it explicitly so that we can detect if they diverge and recover.
	// There is no need to set WGEndpoint explicitly when constructing a Peer by hand.
	// It is only populated when reading Peers from wireguard-go.
	WGEndpoint key.NodePublic
}

func (*Peer) Clone

func (src *Peer) Clone() *Peer

Clone makes a deep copy of Peer. The result aliases no memory with the original.