wgcfg

Documentation

Overview

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

Index

• 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 wgkey.Key) (Peer, bool)
  • func (cfg *Config) ToUAPI(w io.Writer, prev *Config) error
• type Endpoints
  • func (src *Endpoints) Clone() *Endpoints
  • func (e Endpoints) Equal(f Endpoints) bool
• type IPPortSet
  • func NewIPPortSet(ipps ...netaddr.IPPort) IPPortSet
  • func (src *IPPortSet) Clone() *IPPortSet
  • func (s IPPortSet) EqualUnordered(t IPPortSet) bool
  • func (s IPPortSet) IPPorts() []netaddr.IPPort
  • func (s IPPortSet) MarshalJSON() ([]byte, error)
  • func (s IPPortSet) String() string
  • func (s *IPPortSet) UnmarshalJSON(b []byte) error
• type ParseError
  • func (e *ParseError) Error() string
• type Peer
  • func (src *Peer) Clone() *Peer

Functions

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
	PrivateKey wgkey.Private
	Addresses  []netaddr.IPPrefix
	MTU        uint16
	DNS        []netaddr.IP
	Peers      []Peer
}

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 wgkey.Key) (Peer, bool)

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

func (*Config) ToUAPI

func (cfg *Config) ToUAPI(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.

type Endpoints

type Endpoints struct {
	// PublicKey is the public key for the remote node.
	PublicKey wgkey.Key `json:"pk"`
	// DiscoKey is the disco key associated with the remote node.
	DiscoKey tailcfg.DiscoKey `json:"dk,omitempty"`
	// IPPorts is a set of possible ip+ports the remote node can be reached at.
	// This is used only for legacy connections to pre-disco (pre-0.100) peers.
	IPPorts IPPortSet `json:"ipp,omitempty"`
}

Endpoints represents the routes to reach a remote node. It is serialized and provided to wireguard-go as a conn.Endpoint.

func (*Endpoints) Clone

func (src *Endpoints) Clone() *Endpoints

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

func (Endpoints) Equal

func (e Endpoints) Equal(f Endpoints) bool

type IPPortSet

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

IPPortSet is an immutable slice of netaddr.IPPorts.

func NewIPPortSet

func NewIPPortSet(ipps ...netaddr.IPPort) IPPortSet

NewIPPortSet returns an IPPortSet containing the ports in ipp.

func (*IPPortSet) Clone

func (src *IPPortSet) Clone() *IPPortSet

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

func (IPPortSet) EqualUnordered

func (s IPPortSet) EqualUnordered(t IPPortSet) bool

EqualUnordered reports whether s and t contain the same IPPorts, regardless of order.

func (IPPortSet) IPPorts

func (s IPPortSet) IPPorts() []netaddr.IPPort

IPPorts returns a slice of netaddr.IPPorts containing the IPPorts in s.

func (IPPortSet) MarshalJSON

func (s IPPortSet) MarshalJSON() ([]byte, error)

MarshalJSON marshals s into JSON. It is necessary so that IPPortSet's fields can be unexported, to guarantee immutability.

func (IPPortSet) String

func (s IPPortSet) String() string

String returns a comma-separated list of all IPPorts in s.

func (*IPPortSet) UnmarshalJSON

func (s *IPPortSet) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals s from JSON. It is necessary so that IPPortSet's fields can be unexported, to guarantee immutability.

type ParseError

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

func (*ParseError) Error

func (e *ParseError) Error() string

type Peer

type Peer struct {
	PublicKey           wgkey.Key
	AllowedIPs          []netaddr.IPPrefix
	Endpoints           Endpoints
	PersistentKeepalive uint16
}

func (*Peer) Clone

func (src *Peer) Clone() *Peer

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