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
- type Conn
- func (c *Conn) Bind() conn.Bind
- func (c *Conn) Close() error
- func (c *Conn) DERPs() int
- func (c *Conn) DiscoPublicKey() tailcfg.DiscoKey
- func (c *Conn) LastRecvActivityOfDisco(dk tailcfg.DiscoKey) time.Time
- func (c *Conn) LocalPort() uint16
- func (c *Conn) ParseEndpoint(endpointStr string) (conn.Endpoint, error)
- func (c *Conn) PeerHasDiscoKey(k tailcfg.NodeKey) bool
- func (c *Conn) Ping(peer *tailcfg.Node, res *ipnstate.PingResult, cb func(*ipnstate.PingResult))
- func (c *Conn) ReSTUN(why string)
- func (c *Conn) Rebind()
- func (c *Conn) Send(b []byte, ep conn.Endpoint) error
- func (c *Conn) SetDERPMap(dm *tailcfg.DERPMap)
- func (c *Conn) SetNetInfoCallback(fn func(*tailcfg.NetInfo))
- func (c *Conn) SetNetworkMap(nm *netmap.NetworkMap)
- func (c *Conn) SetNetworkUp(up bool)
- func (c *Conn) SetPreferredPort(port uint16)
- func (c *Conn) SetPrivateKey(privateKey wgkey.Private) 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) ReadFromNetaddr(b []byte) (n int, ipp netaddr.IPPort, err error)
- func (c *RebindingUDPConn) WriteTo(b []byte, addr net.Addr) (int, error)
Constants ¶
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 ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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 ¶ added in v0.98.1
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 ¶
Close closes the connection.
Only the first close does anything. Any later closes return nil.
func (*Conn) DiscoPublicKey ¶ added in v1.0.0
DiscoPublicKey returns the discovery public key.
func (*Conn) LastRecvActivityOfDisco ¶ added in v1.4.0
LastRecvActivityOfDisco returns the time we last got traffic from this endpoint (updated every ~10 seconds).
func (*Conn) ParseEndpoint ¶ added in v1.8.0
ParseEndpoint is called by WireGuard to connect to an endpoint. endpointStr is a json-serialized wgcfg.Endpoints struct. If those Endpoints contain an active discovery key, ParseEndpoint returns a discoEndpoint. Otherwise it returns a legacy endpoint.
func (*Conn) PeerHasDiscoKey ¶ added in v1.0.0
PeerHasDiscoKey reports whether peer k supports discovery keys (client version 0.100.0+).
func (*Conn) Ping ¶ added in v1.2.0
func (c *Conn) Ping(peer *tailcfg.Node, res *ipnstate.PingResult, cb func(*ipnstate.PingResult))
Ping handles a "tailscale ping" CLI query.
func (*Conn) ReSTUN ¶
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 and resets the DERP connection. It should be followed by a call to ReSTUN.
func (*Conn) SetDERPMap ¶ added in v0.98.1
SetDERPMap controls which (if any) DERP servers are used. A nil value means to disable DERP; it's disabled by default.
func (*Conn) SetNetInfoCallback ¶
func (*Conn) SetNetworkMap ¶ added in v0.100.0
func (c *Conn) SetNetworkMap(nm *netmap.NetworkMap)
SetNetworkMap is called when the control client gets a new network map from the control server. It must always be non-nil.
It should not use the DERPMap field of NetworkMap; that's conditionally sent to SetDERPMap instead.
func (*Conn) SetNetworkUp ¶ added in v1.2.0
func (*Conn) SetPreferredPort ¶ added in v1.10.0
SetPreferredPort sets the connection's preferred local port.
func (*Conn) SetPrivateKey ¶
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) UpdatePeers ¶ added in v0.98.0
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 ¶ added in v0.98.0
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([]tailcfg.Endpoint)
// DERPActiveFunc optionally provides a func to be called when
// a connection is made to a DERP server.
DERPActiveFunc func()
// IdleFunc optionally provides a func to return how long
// it's been since a TUN packet was sent or received.
IdleFunc func() time.Duration
// PacketListener optionally specifies how to create PacketConns.
// It's meant for testing.
PacketListener nettype.PacketListener
// NoteRecvActivity, if provided, is a func for magicsock to
// call whenever it receives a packet from a a
// discovery-capable peer if it's been more than ~10 seconds
// since the last one. (10 seconds is somewhat arbitrary; the
// sole user just doesn't need or want it called on every
// packet, just every minute or two for Wireguard timeouts,
// and 10 seconds seems like a good trade-off between often
// enough and not too often.) The provided func is called
// while holding userspaceEngine.wgLock and likely calls
// Conn.ParseEndpoint, which acquires Conn.mu. As such, you
// should not hold Conn.mu while calling it.
NoteRecvActivity func(tailcfg.DiscoKey)
// SimulatedNetwork can be set true in tests to signal that
// the network is simulated and thus it's okay to bind on the
// unspecified address (which we'd normally avoid to avoid
// triggering macOS and Windows firwall dialog boxes during
// "go test").
SimulatedNetwork bool
// DisableLegacyNetworking disables legacy peer handling. When
// enabled, only active discovery-aware nodes will be able to
// communicate with Conn.
DisableLegacyNetworking bool
// LinkMonitor is the link monitor to use.
// With one, the portmapper won't be used.
LinkMonitor *monitor.Mon
}
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 ¶
ReadFrom reads a packet from c into b. It returns the number of bytes copied and the source address.
func (*RebindingUDPConn) ReadFromNetaddr ¶ added in v1.6.0
ReadFromNetaddr reads a packet from c into b. It returns the number of bytes copied and the return address. It is identical to c.ReadFrom, except that it returns a netaddr.IPPort instead of a net.Addr. ReadFromNetaddr is designed to work with specific underlying connection types. If c's underlying connection returns a non-*net.UPDAddr return address, ReadFromNetaddr will return an error. ReadFromNetaddr exists because it removes an allocation per read, when c's underlying connection is a net.UDPConn.
Source Files