func DefaultRouteInterface() (string,error)

func ForeachInterface(fn func(Interface, []netip.Prefix))error

func ForeachInterfaceAddress(fn func(Interface,netip.Prefix))error

func HTTPOfListener(lnnet.Listener)string

func InterfaceDebugExtras(ifIndexint) (string,error)

func LikelyHomeRouterIP() (gateway, myIPnetip.Addr, okbool)

func LinkChangeLogLimiter(ctxcontext.Context, logflogger.Logf, nm *Monitor)logger.Logf

func LocalAddresses() (regular, loopback []netip.Addr, errerror)

func RegisterInterfaceGetter(getInterfaces func() ([]Interface,error))

type ChangeDelta struct {// Old is the old interface state, if known.// It's nil if the old state is unknown.// Do not mutate it.Old *State// New is the new network state.// It is always non-nil.// Do not mutate it.New *State// Major is our legacy boolean of whether the network changed in some major// way.//// Deprecated: do not remove. As of 2023-08-23 we're in a renewed effort to// remove it and ask specific qustions of ChangeDelta instead. Look at Old// and New (or add methods to ChangeDelta) instead of using Major.Majorbool// TimeJumped is whether there was a big jump in wall time since the last// time we checked. This is a hint that a mobile sleeping device might have// come out of sleep.TimeJumpedbool}

type ChangeFunc func(*ChangeDelta)

type DefaultRouteDetails struct {// InterfaceName is the interface name. It must always be populated.// It's like "eth0" (Linux), "Ethernet 2" (Windows), "en0" (macOS).InterfaceNamestring// InterfaceDesc is populated on Windows at least. It's a// longer description, like "Red Hat VirtIO Ethernet Adapter".InterfaceDescstring// InterfaceIndex is like net.Interface.Index.// Zero means not populated.InterfaceIndexint}

funcDefaultRoute¶added inv1.66.0

func DefaultRoute() (DefaultRouteDetails,error)

DefaultRoute returns details of the network interface that ownsthe default route, not including any tailscale interfaces.

type Interface struct {*net.InterfaceAltAddrs []net.Addr// if non-nil, returned by AddrsDescstring// extra description (used on Windows)}

func (Interface)Addrs¶added inv1.66.0

func (iInterface) Addrs() ([]net.Addr,error)

func (Interface)Equal¶added inv1.66.0

func (aInterface) Equal(bInterface)bool

func (Interface)IsLoopback¶added inv1.66.0

func (iInterface) IsLoopback()bool

func (Interface)IsUp¶added inv1.66.0

func (iInterface) IsUp()bool

type InterfaceList []Interface

funcGetInterfaceList¶added inv1.66.0

func GetInterfaceList() (InterfaceList,error)

GetInterfaceList returns the list of interfaces on the machine.

func (InterfaceList)ForeachInterface¶added inv1.66.0

func (ifacesInterfaceList) ForeachInterface(fn func(Interface, []netip.Prefix))error

ForeachInterface calls fn for each interface in ifaces, withall its addresses. The IPPrefix's IP is the IP address assigned tothe interface, and Bits are the subnet mask.

func (InterfaceList)ForeachInterfaceAddress¶added inv1.66.0

func (ifacesInterfaceList) ForeachInterfaceAddress(fn func(Interface,netip.Prefix))error

ForeachInterfaceAddress calls fn for each interface in ifaces, withall its addresses. The IPPrefix's IP is the IP address assigned tothe interface, and Bits are the subnet mask.

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

funcNew¶

func New(bus *eventbus.Bus, logflogger.Logf) (*Monitor,error)

New instantiates and starts a monitoring instance.The returned monitor is inactive until it's started by the Start method.Use RegisterChangeCallback to get notified of network changes.

funcNewStatic¶added inv1.66.0

func NewStatic() *Monitor

NewStatic returns a Monitor that's a one-time snapshot of the network statebut doesn't actually monitor for changes. It should only be used in testsand situations like cleanups or short-lived CLI programs.

func (*Monitor)Close¶

func (m *Monitor) Close()error

Close closes the monitor.

func (*Monitor)GatewayAndSelfIP¶

func (m *Monitor) GatewayAndSelfIP() (gw, myIPnetip.Addr, okbool)

GatewayAndSelfIP returns the current network's default gateway, andthe machine's default IP for that gateway.

It's the same as interfaces.LikelyHomeRouterIP, but it caches theresult until the monitor detects a network change.

func (*Monitor)HasCGNATInterface¶added inv1.82.0

func (m *Monitor) HasCGNATInterface() (bool,error)

HasCGNATInterface reports whether there are any non-Tailscale interfaces thatuse a CGNAT IP range.

func (*Monitor)InjectEvent¶

func (m *Monitor) InjectEvent()

InjectEvent forces the monitor to pretend there was a networkchange and re-check the state of the network. Any registeredChangeFunc callbacks will be called within the event coalescingperiod (under a fraction of a second).

func (*Monitor)InterfaceState¶

func (m *Monitor) InterfaceState() *State

InterfaceState returns the latest snapshot of the machine's networkinterfaces.

The returned value is owned by Mon; it must not be modified.

func (*Monitor)IsMajorChangeFrom¶added inv1.50.0

func (m *Monitor) IsMajorChangeFrom(s1, s2 *State)bool

IsMajorChangeFrom reports whether the transition from s1 to s2 isa "major" change, where major roughly means it's worth tearing downa bunch of connections and rebinding.

TODO(bradiftz): tigten this definition.

func (*Monitor)Poll¶added inv1.50.0

func (m *Monitor) Poll()

Poll forces the monitor to pretend there was a networkchange and re-check the state of the network.

This is like InjectEvent but only fires ChangeFunc callbacksif the network state differed at all.

func (*Monitor)RegisterChangeCallback¶

func (m *Monitor) RegisterChangeCallback(callbackChangeFunc) (unregister func())

RegisterChangeCallback adds callback to the set of parties to benotified (in their own goroutine) when the network state changes.To remove this callback, call unregister (or close the monitor).

func (*Monitor)SetTailscaleInterfaceName¶added inv1.50.0

func (m *Monitor) SetTailscaleInterfaceName(ifNamestring)

SetTailscaleInterfaceName sets the name of the Tailscale interface. Forexample, "tailscale0", "tun0", "utun3", etc.

This must be called only early in tailscaled startup before the monitor isused.

func (*Monitor)Start¶

func (m *Monitor) Start()

Start starts the monitor.A monitor can only be started & closed once.

type RuleDeleted struct {// Table is the table number that the deleted rule referenced.Tableuint8// Priority is the lookup priority of the deleted rule.Priorityuint32}

type State struct {// InterfaceIPs maps from an interface name to the IP addresses// configured on that interface. Each address is represented as an// IPPrefix, where the IP is the interface IP address and Bits is// the subnet mask.InterfaceIPs map[string][]netip.PrefixInterface    map[string]Interface// HaveV6 is whether this machine has an IPv6 Global or Unique Local Address// which might provide connectivity on a non-Tailscale interface that's up.HaveV6bool// HaveV4 is whether the machine has some non-localhost,// non-link-local IPv4 address on a non-Tailscale interface that's up.HaveV4bool// IsExpensive is whether the current network interface is// considered "expensive", which currently means LTE/etc// instead of Wifi. This field is not populated by GetState.IsExpensivebool// DefaultRouteInterface is the interface name for the// machine's default route.//// It is not yet populated on all OSes.//// When non-empty, its value is the map key into Interface and// InterfaceIPs.DefaultRouteInterfacestring// HTTPProxy is the HTTP proxy to use, if any.HTTPProxystring// PAC is the URL to the Proxy Autoconfig URL, if applicable.PACstring}

func (*State)AnyInterfaceUp¶added inv1.66.0

func (s *State) AnyInterfaceUp()bool

AnyInterfaceUp reports whether any interface seems like it has Internet access.

func (*State)Equal¶added inv1.66.0

func (s *State) Equal(s2 *State)bool

Equal reports whether s and s2 are exactly equal.

func (*State)HasIP¶added inv1.66.0

func (s *State) HasIP(ipnetip.Addr)bool

HasIP reports whether any interface has the provided IP address.

func (*State)HasPAC¶added inv1.66.0

func (s *State) HasPAC()bool

func (*State)String¶added inv1.66.0

func (s *State) String()string