magicsock

Documentation

Overview

Package magicsock implements a socket that can change its communication path while in use, actively searching for the best way to communicate.

Index

• Constants
• Variables
• type AddrSet
  • func (a *AddrSet) Addrs() []wgcfg.Endpoint
  • func (a *AddrSet) ClearSrc()
  • func (a *AddrSet) DstIP() net.IP
  • func (a *AddrSet) DstToBytes() []byte
  • func (a *AddrSet) DstToString() string
  • func (a *AddrSet) SrcIP() net.IP
  • func (a *AddrSet) SrcToString() string
  • func (a *AddrSet) String() string
  • func (a *AddrSet) UpdateDst(new *net.UDPAddr) error
• type Conn
  • func NewConn(opts Options) (*Conn, error)
  • func (c *Conn) Close() error
  • func (c *Conn) CreateBind(uint16) (conn.Bind, uint16, error)
  • func (c *Conn) CreateEndpoint(pubKey [32]byte, addrs string) (conn.Endpoint, error)
  • func (c *Conn) DERPs() int
  • func (c *Conn) LastMark() uint32
  • func (c *Conn) LocalPort() uint16
  • func (c *Conn) ReSTUN(why string)
  • func (c *Conn) Rebind()
  • func (c *Conn) ReceiveIPv4(b []byte) (n int, ep conn.Endpoint, addr *net.UDPAddr, err error)
  • func (c *Conn) ReceiveIPv6(b []byte) (int, conn.Endpoint, *net.UDPAddr, error)
  • func (c *Conn) Send(b []byte, ep conn.Endpoint) error
  • func (c *Conn) SetDERPMap(dm *tailcfg.DERPMap)
  • func (c *Conn) SetMark(value uint32) error
  • func (c *Conn) SetNetInfoCallback(fn func(*tailcfg.NetInfo))
  • func (c *Conn) SetPrivateKey(privateKey wgcfg.PrivateKey) error
  • func (c *Conn) Start()
  • func (c *Conn) UpdatePeers(newPeers map[key.Public]struct{})
  • func (c *Conn) UpdateStatus(sb *ipnstate.StatusBuilder)
• type Options
• type RebindingUDPConn
  • func (c *RebindingUDPConn) Close() error
  • func (c *RebindingUDPConn) LocalAddr() *net.UDPAddr
  • func (c *RebindingUDPConn) ReadFrom(b []byte) (int, net.Addr, error)
  • func (c *RebindingUDPConn) Reset(pconn *net.UDPConn)
  • func (c *RebindingUDPConn) SetReadDeadline(t time.Time)
  • func (c *RebindingUDPConn) WriteTo(b []byte, addr net.Addr) (int, error)
  • func (c *RebindingUDPConn) WriteToUDP(b []byte, addr *net.UDPAddr) (int, error)

Constants

const DefaultPort = 0

DefaultPort is the default port to listen on. The current default (zero) means to auto-select a random free port.

const DerpMagicIP = "127.3.3.40"

DerpMagicIP is a fake WireGuard endpoint IP address that means to use DERP. When used, the port number of the WireGuard endpoint is the DERP server number to use.

Mnemonic: 3.3.40 are numbers above the keys D, E, R, P.

Variables

var DisableSTUNForTesting bool

Types

type AddrSet

type AddrSet struct {
	Logf logger.Logf // must not be nil
	// contains filtered or unexported fields
}

AddrSet is a set of UDP addresses that implements wireguard/conn.Endpoint.

func (*AddrSet) Addrs

func (a *AddrSet) Addrs() []wgcfg.Endpoint

func (*AddrSet) ClearSrc

func (a *AddrSet) ClearSrc()

func (*AddrSet) DstIP

func (a *AddrSet) DstIP() net.IP

func (*AddrSet) DstToBytes

func (a *AddrSet) DstToBytes() []byte

func (*AddrSet) DstToString

func (a *AddrSet) DstToString() string

func (*AddrSet) SrcIP

func (a *AddrSet) SrcIP() net.IP

func (*AddrSet) SrcToString

func (a *AddrSet) SrcToString() string

func (*AddrSet) String

func (a *AddrSet) String() string

func (*AddrSet) UpdateDst

func (a *AddrSet) UpdateDst(new *net.UDPAddr) error

type Conn

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

A Conn routes UDP packets and actively manages a list of its endpoints. It implements wireguard/conn.Bind.

func NewConn

func NewConn(opts Options) (*Conn, error)

NewConn creates a magic Conn listening on opts.Port. As the set of possible endpoints for a Conn changes, the callback opts.EndpointsFunc is called.

It doesn't start doing anything until Start is called.

func (*Conn) Close

func (c *Conn) Close() error

Close closes the connection.

Only the first close does anything. Any later closes return nil.

func (*Conn) CreateBind

func (c *Conn) CreateBind(uint16) (conn.Bind, uint16, error)

CreateBind is called by WireGuard to create a UDP binding.

func (*Conn) CreateEndpoint

func (c *Conn) CreateEndpoint(pubKey [32]byte, addrs string) (conn.Endpoint, error)

CreateEndpoint is called by WireGuard to connect to an endpoint. The key is the public key of the peer and addrs is a comma-separated list of UDP ip:ports.

func (*Conn) DERPs

func (c *Conn) DERPs() int

DERPs reports the number of active DERP connections.

func (*Conn) LastMark

func (c *Conn) LastMark() uint32

func (*Conn) LocalPort

func (c *Conn) LocalPort() uint16

func (*Conn) ReSTUN

func (c *Conn) ReSTUN(why string)

ReSTUN triggers an address discovery. The provided why string is for debug logging only.

func (*Conn) Rebind

func (c *Conn) Rebind()

Rebind closes and re-binds the UDP sockets. It should be followed by a call to ReSTUN.

func (*Conn) ReceiveIPv4

func (c *Conn) ReceiveIPv4(b []byte) (n int, ep conn.Endpoint, addr *net.UDPAddr, err error)

func (*Conn) ReceiveIPv6

func (c *Conn) ReceiveIPv6(b []byte) (int, conn.Endpoint, *net.UDPAddr, error)

func (*Conn) Send

func (c *Conn) Send(b []byte, ep conn.Endpoint) error

func (*Conn) SetDERPMap

func (c *Conn) SetDERPMap(dm *tailcfg.DERPMap)

SetDERPMap controls which (if any) DERP servers are used. A nil value means to disable DERP; it's disabled by default.

func (*Conn) SetMark

func (c *Conn) SetMark(value uint32) error

func (*Conn) SetNetInfoCallback

func (c *Conn) SetNetInfoCallback(fn func(*tailcfg.NetInfo))

func (*Conn) SetPrivateKey

func (c *Conn) SetPrivateKey(privateKey wgcfg.PrivateKey) error

SetPrivateKey sets the connection's private key.

This is only used to be able prove our identity when connecting to DERP servers.

If the private key changes, any DERP connections are torn down & recreated when needed.

func (*Conn) Start

func (c *Conn) Start()

func (*Conn) UpdatePeers

func (c *Conn) UpdatePeers(newPeers map[key.Public]struct{})

UpdatePeers is called when the set of WireGuard peers changes. It then removes any state for old peers.

The caller passes ownership of newPeers map to UpdatePeers.

func (*Conn) UpdateStatus

func (c *Conn) UpdateStatus(sb *ipnstate.StatusBuilder)

type Options

type Options struct {
	// Logf optionally provides a log function to use.
	// Must not be nil.
	Logf logger.Logf

	// Port is the port to listen on.
	// Zero means to pick one automatically.
	Port uint16

	// EndpointsFunc optionally provides a func to be called when
	// endpoints change. The called func does not own the slice.
	EndpointsFunc func(endpoint []string)
}

Options contains options for Listen.

type RebindingUDPConn

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

RebindingUDPConn is a UDP socket that can be re-bound. Unix has no notion of re-binding a socket, so we swap it out for a new one.

func (*RebindingUDPConn) Close

func (c *RebindingUDPConn) Close() error

func (*RebindingUDPConn) LocalAddr

func (c *RebindingUDPConn) LocalAddr() *net.UDPAddr

func (*RebindingUDPConn) ReadFrom

func (c *RebindingUDPConn) ReadFrom(b []byte) (int, net.Addr, error)

func (*RebindingUDPConn) Reset

func (c *RebindingUDPConn) Reset(pconn *net.UDPConn)

func (*RebindingUDPConn) SetReadDeadline

func (c *RebindingUDPConn) SetReadDeadline(t time.Time)

func (*RebindingUDPConn) WriteTo

func (c *RebindingUDPConn) WriteTo(b []byte, addr net.Addr) (int, error)

func (*RebindingUDPConn) WriteToUDP

func (c *RebindingUDPConn) WriteToUDP(b []byte, addr *net.UDPAddr) (int, error)