tailscale.com – tailscale.com/types/netmap Index | Files

package netmap

import "tailscale.com/types/netmap"

Package netmap contains the netmap.NetworkMap type.

Index

Functions

func MagicDNSSuffixOfNodeName 

func MagicDNSSuffixOfNodeName(nodeName string) string

MagicDNSSuffix returns the domain's MagicDNS suffix (even if MagicDNS isn't necessarily in use) of the provided Node.Name value.

It will neither start nor end with a period.

Types

type IPServiceMappings 

type IPServiceMappings map[netip.Addr]tailcfg.ServiceName

IPServiceMappings maps IP addresses to service names. This is the inverse of tailcfg.ServiceIPMappings, and is used to inform track which service a VIP is associated with. This is set to b.ipVIPServiceMap every time the netmap is updated. This is used to reduce the cost for looking up the service name for the dst IP address in the netStack packet processing workflow.

This is of the form: 

{
  "100.65.32.1": "svc:samba",
  "fd7a:115c:a1e0::1234": "svc:samba",
  "100.102.42.3": "svc:web",
  "fd7a:115c:a1e0::abcd": "svc:web",
}

type NetworkMap 

type NetworkMap struct {
	SelfNode   tailcfg.NodeView
	AllCaps    set.Set[tailcfg.NodeCapability] // set version of SelfNode.Capabilities + SelfNode.CapMap
	NodeKey    key.NodePublic
	PrivateKey key.NodePrivate
	Expiry     time.Time
	// Name is the DNS name assigned to this node.
	// It is the MapResponse.Node.Name value and ends with a period.
	Name string

	MachineKey key.MachinePublic

	Peers []tailcfg.NodeView // sorted by Node.ID
	DNS   tailcfg.DNSConfig

	PacketFilter      []filtertype.Match
	PacketFilterRules views.Slice[tailcfg.FilterRule]
	SSHPolicy         *tailcfg.SSHPolicy // or nil, if not enabled/allowed

	// CollectServices reports whether this node's Tailnet has
	// requested that info about services be included in HostInfo.
	// If set, Hostinfo.ShieldsUp blocks services collection; that
	// takes precedence over this field.
	CollectServices bool

	// DERPMap is the last DERP server map received. It's reused
	// between updates and should not be modified.
	DERPMap *tailcfg.DERPMap

	// ControlHealth are the list of health check problems for this
	// node from the perspective of the control plane.
	// If empty, there are no known problems from the control plane's
	// point of view, but the node might know about its own health
	// check problems.
	ControlHealth []string

	// TKAEnabled indicates whether the tailnet key authority should be
	// enabled, from the perspective of the control plane.
	TKAEnabled bool
	// TKAHead indicates the control plane's understanding of 'head' (the
	// hash of the latest update message to tick through TKA).
	TKAHead tka.AUMHash

	// Domain is the current Tailnet name.
	Domain string

	// DomainAuditLogID is an audit log ID provided by control and
	// only populated if the domain opts into data-plane audit logging.
	// If this is empty, then data-plane audit logging is disabled.
	DomainAuditLogID string

	// UserProfiles contains the profile information of UserIDs referenced
	// in SelfNode and Peers.
	UserProfiles map[tailcfg.UserID]tailcfg.UserProfileView
}

NetworkMap is the current state of the world.

The fields should all be considered read-only. They might alias parts of previous NetworkMap values.

func (*NetworkMap) AnyPeersAdvertiseRoutes 

func (nm *NetworkMap) AnyPeersAdvertiseRoutes() bool

AnyPeersAdvertiseRoutes reports whether any peer is advertising non-exit node routes.

func (*NetworkMap) Concise 

func (nm *NetworkMap) Concise() string

func (*NetworkMap) ConciseDiffFrom 

func (b *NetworkMap) ConciseDiffFrom(a *NetworkMap) string

func (*NetworkMap) DomainName 

func (nm *NetworkMap) DomainName() string

DomainName returns the name of the NetworkMap's current tailnet. If the map is nil, it returns an empty string.

func (*NetworkMap) GetAddresses 

func (nm *NetworkMap) GetAddresses() views.Slice[netip.Prefix]

GetAddresses returns the self node's addresses, or the zero value if SelfNode is invalid.

func (*NetworkMap) GetIPVIPServiceMap 

func (nm *NetworkMap) GetIPVIPServiceMap() IPServiceMappings

GetIPVIPServiceMap returns a map of VIP addresses to the service names that has the VIP address. The service names are with the prefix "svc:".

func (*NetworkMap) GetMachineStatus 

func (nm *NetworkMap) GetMachineStatus() tailcfg.MachineStatus

GetMachineStatus returns the MachineStatus of the local node.

func (*NetworkMap) GetVIPServiceIPMap 

func (nm *NetworkMap) GetVIPServiceIPMap() tailcfg.ServiceIPMappings

GetVIPServiceIPMap returns a map of service names to the slice of VIP addresses that correspond to the service. The service names are with the prefix "svc:".

TODO(tailscale/corp##25997): cache the result of decoding the capmap so that we don't have to decode it multiple times after each netmap update.

func (*NetworkMap) HasCap 

func (nm *NetworkMap) HasCap(c tailcfg.NodeCapability) bool

HasCap reports whether nm is non-nil and nm.AllCaps contains c.

func (*NetworkMap) HasSelfCapability 

func (nm *NetworkMap) HasSelfCapability(c tailcfg.NodeCapability) bool

HasSelfCapability reports whether nm.SelfNode contains capability c.

It exists to satisify an unused (as of 2025-01-04) interface in the logknob package.

func (*NetworkMap) JSON 

func (nm *NetworkMap) JSON() string

func (*NetworkMap) MagicDNSSuffix 

func (nm *NetworkMap) MagicDNSSuffix() string

MagicDNSSuffix returns the domain's MagicDNS suffix (even if MagicDNS isn't necessarily in use).

It will neither start nor end with a period.

func (*NetworkMap) PeerByTailscaleIP 

func (nm *NetworkMap) PeerByTailscaleIP(ip netip.Addr) (peer tailcfg.NodeView, ok bool)

PeerByTailscaleIP returns a peer's Node based on its Tailscale IP.

If nm is nil or no peer is found, ok is false.

func (*NetworkMap) PeerIndexByNodeID 

func (nm *NetworkMap) PeerIndexByNodeID(nodeID tailcfg.NodeID) int

PeerIndexByNodeID returns the index of the peer with the given nodeID in nm.Peers, or -1 if nm is nil or not found.

It assumes nm.Peers is sorted by Node.ID.

func (*NetworkMap) PeerWithStableID 

func (nm *NetworkMap) PeerWithStableID(pid tailcfg.StableNodeID) (_ tailcfg.NodeView, ok bool)

PeerWithStableID finds and returns the peer associated to the inputted StableNodeID.

func (*NetworkMap) SelfNodeOrZero 

func (nm *NetworkMap) SelfNodeOrZero() tailcfg.NodeView

SelfNodeOrZero returns the self node, or a zero value if nm is nil.

func (*NetworkMap) String 

func (nm *NetworkMap) String() string

func (*NetworkMap) User 

func (nm *NetworkMap) User() tailcfg.UserID

User returns nm.SelfNode.User if nm.SelfNode is non-nil, otherwise it returns 0.

func (*NetworkMap) VeryConcise 

func (nm *NetworkMap) VeryConcise() string

type NodeMutation 

type NodeMutation interface {
	NodeIDBeingMutated() tailcfg.NodeID
	Apply(*tailcfg.Node)
}

NodeMutation is the common interface for types that describe the change of a node's state.

func MutationsFromMapResponse 

func MutationsFromMapResponse(res *tailcfg.MapResponse, now time.Time) (ret []NodeMutation, ok bool)

MutationsFromMapResponse returns all the discrete node mutations described by res. It returns ok=false if res contains any non-patch field as defined by mapResponseContainsNonPatchFields.

func NodeMutationsFromPatch 

func NodeMutationsFromPatch(p *tailcfg.PeerChange) (_ []NodeMutation, ok bool)

NodeMutationsFromPatch returns the NodeMutations that p describes. If p describes something not yet supported by a specific NodeMutation type, it returns (nil, false).

type NodeMutationDERPHome 

type NodeMutationDERPHome struct {
	DERPRegion int
	// contains filtered or unexported fields
}

NodeMutationDERPHome is a NodeMutation that says a node has changed its DERP home region.

func (NodeMutationDERPHome) Apply 

func (m NodeMutationDERPHome) Apply(n *tailcfg.Node)

func (NodeMutationDERPHome) NodeIDBeingMutated 

func (m NodeMutationDERPHome) NodeIDBeingMutated() tailcfg.NodeID

type NodeMutationEndpoints 

type NodeMutationEndpoints struct {
	Endpoints []netip.AddrPort
	// contains filtered or unexported fields
}

NodeMutation is a NodeMutation that says a node's endpoints have changed.

func (NodeMutationEndpoints) Apply 

func (m NodeMutationEndpoints) Apply(n *tailcfg.Node)

func (NodeMutationEndpoints) NodeIDBeingMutated 

func (m NodeMutationEndpoints) NodeIDBeingMutated() tailcfg.NodeID

type NodeMutationLastSeen 

type NodeMutationLastSeen struct {
	LastSeen time.Time
	// contains filtered or unexported fields
}

NodeMutationLastSeen is a NodeMutation that says a node's LastSeen value should be set to the current time.

func (NodeMutationLastSeen) Apply 

func (m NodeMutationLastSeen) Apply(n *tailcfg.Node)

func (NodeMutationLastSeen) NodeIDBeingMutated 

func (m NodeMutationLastSeen) NodeIDBeingMutated() tailcfg.NodeID

type NodeMutationOnline 

type NodeMutationOnline struct {
	Online bool
	// contains filtered or unexported fields
}

NodeMutationOnline is a NodeMutation that says a node is now online or offline.

func (NodeMutationOnline) Apply 

func (m NodeMutationOnline) Apply(n *tailcfg.Node)

func (NodeMutationOnline) NodeIDBeingMutated 

func (m NodeMutationOnline) NodeIDBeingMutated() tailcfg.NodeID

type WGConfigFlags 

type WGConfigFlags int

WGConfigFlags is a bitmask of flags to control the behavior of the wireguard configuration generation done by NetMap.WGCfg. 

const (
	AllowSubnetRoutes WGConfigFlags
)

Source Files

netmap.go nodemut.go

Version
v1.84.3 (latest)
Published
Jun 26, 2025
Platform
linux/amd64
Imports
17 packages
Last checked
7 hours ago –

Tools for package owners.