ts_control/node.rs
1//! The parsed domain [`Node`] model: a tailnet node decoded from the wire (`tailcfg.Node`).
2//!
3//! [`Node`] is the owned, validated form the rest of the fork reasons about (addresses, keys, caps,
4//! accepted routes, peerAPI/VIP services), built from the borrow-bound `ts_control_serde::Node` via
5//! the [`From`] impl. It also carries the route/exit-node/funnel predicates ([`Node::is_subnet_route`],
6//! [`Node::routes_to_install`], [`Node::can_funnel`]) and the [`ExitNodeSelector`] resolution.
7//!
8//! Fail-closed: route, funnel, and service-host gates all deny on a missing/malformed input.
9
10use core::net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr};
11use std::collections::BTreeMap;
12
13use chrono::{DateTime, Utc};
14use ts_capabilityversion::CapabilityVersion;
15use ts_keys::{DiscoPublicKey, MachinePublicKey, NodePublicKey};
16
17use crate::dns::Resolver;
18
19/// An owned node-capability map (`Node.CapMap` in Go: `map[NodeCapability][]RawMessage`).
20///
21/// Keys are capability names or URLs (e.g. `"funnel"`, `"https"`, or
22/// `"https://tailscale.com/cap/funnel-ports?ports=443,8443"`); values are the raw JSON-encoded
23/// argument blobs for that capability (often empty). Stored *owned* because the wire form
24/// ([`ts_control_serde::Node::cap_map`]) borrows from the decode buffer, whereas the domain
25/// [`Node`] outlives it. Funnel gating only inspects the keys (see [`Node::can_funnel`] and
26/// [`Node::check_funnel_port`]); the values are retained for capabilities that carry argument data.
27pub type NodeCapMap = BTreeMap<String, Vec<String>>;
28
29/// Whether `addr` falls in a range Tailscale assigns to nodes: the CGNAT range for IPv4
30/// (`100.64.0.0/10`, excluding the ChromeOS VM carve-out `100.115.92.0/23`) and the Tailscale
31/// ULA for IPv6 (`fd7a:115c:a1e0::/48`).
32///
33/// Mirrors `tsaddr.IsTailscaleIP` in the Go client. Used to tell a peer's own node addresses
34/// (always single Tailscale IPs) apart from the larger subnet routes it advertises.
35pub fn is_tailscale_ip(addr: IpAddr) -> bool {
36 match addr {
37 IpAddr::V4(v4) => {
38 let cgnat = ipnet::Ipv4Net::new(Ipv4Addr::new(100, 64, 0, 0), 10).unwrap();
39 let chromeos = ipnet::Ipv4Net::new(Ipv4Addr::new(100, 115, 92, 0), 23).unwrap();
40 cgnat.contains(&v4) && !chromeos.contains(&v4)
41 }
42 IpAddr::V6(v6) => {
43 let ula = ipnet::Ipv6Net::new(Ipv6Addr::new(0xfd7a, 0x115c, 0xa1e0, 0, 0, 0, 0, 0), 48)
44 .unwrap();
45 ula.contains(&v6)
46 }
47 }
48}
49
50/// The unique id of a node.
51pub type Id = i64;
52
53/// The stable ID of a node.
54#[derive(
55 Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord, serde::Serialize, serde::Deserialize,
56)]
57pub struct StableId(pub String);
58
59/// How this node selects which peer to use as its exit node (`--exit-node` in the Go client).
60///
61/// Mirrors the Go client's `--exit-node`, which accepts a tailnet IP, a MagicDNS name, or a stable
62/// node ID, and resolves it to a `StableNodeID` (`resolveExitNodeIPLocked`). We keep the selector
63/// *unresolved* and re-run [`ExitNodeSelector::resolve`] against the live peer set on every route
64/// rebuild, so an IP- or name-based selection follows the peer as the netmap changes (e.g. the
65/// exit node re-registers under a new stable id).
66///
67/// A selector can be parsed from a string with [`str::parse`]/[`FromStr`](core::str::FromStr),
68/// auto-detecting the variant the way the Go CLI's `--exit-node` does: a value that parses as an IP
69/// address becomes [`ExitNodeSelector::Ip`], anything else becomes [`ExitNodeSelector::Name`].
70/// Stable-id selection is available only by constructing [`ExitNodeSelector::StableId`] directly
71/// (it is not auto-detected, since a stable id is otherwise indistinguishable from a hostname).
72#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
73pub enum ExitNodeSelector {
74 /// Select the peer with this exact stable node id.
75 StableId(StableId),
76 /// Select the peer whose tailnet address is this IP.
77 Ip(IpAddr),
78 /// Select the peer matching this bare hostname or MagicDNS name (case-insensitive, optional
79 /// trailing dot), as per [`Node::matches_name`].
80 Name(String),
81}
82
83impl core::str::FromStr for ExitNodeSelector {
84 type Err = core::convert::Infallible;
85
86 /// Parse a selector from a string, auto-detecting IP vs. name (matching the Go CLI's
87 /// `--exit-node`). Parsing never fails: a non-IP string is taken as a MagicDNS name.
88 fn from_str(s: &str) -> Result<Self, Self::Err> {
89 Ok(match s.parse::<IpAddr>() {
90 Ok(ip) => ExitNodeSelector::Ip(ip),
91 Err(_) => ExitNodeSelector::Name(s.to_owned()),
92 })
93 }
94}
95
96impl ExitNodeSelector {
97 /// Resolve this selector to the stable id of the matching peer, if any, given the current set
98 /// of peers.
99 ///
100 /// Resolution is **deterministic**: if a selector somehow matches more than one peer (e.g. two
101 /// peers sharing a MagicDNS name during a transient netmap state), the peer with the smallest
102 /// [`StableId`] is chosen. This matters because both the outbound route table and the inbound
103 /// source filter resolve independently; a deterministic tiebreak guarantees they pick the
104 /// *same* peer, preserving the cryptokey-routing coupling that prevents source-spoofing.
105 ///
106 /// Returns `None` when no peer matches (a stale/typo'd selector). Callers treat `None` as
107 /// fail-closed: no peer is granted a default route, so internet-bound traffic is dropped.
108 pub fn resolve<'a>(&self, peers: impl Iterator<Item = &'a Node>) -> Option<StableId> {
109 peers
110 .filter(|node| match self {
111 ExitNodeSelector::StableId(id) => &node.stable_id == id,
112 ExitNodeSelector::Ip(ip) => node.tailnet_address.contains(*ip),
113 ExitNodeSelector::Name(name) => node.matches_name(name),
114 })
115 .map(|node| &node.stable_id)
116 .min()
117 .cloned()
118 }
119}
120
121/// A node in a tailnet.
122#[derive(Debug, Clone, PartialEq, Eq, Hash)]
123pub struct Node {
124 /// The node's id.
125 pub id: Id,
126 /// The node's stable id.
127 pub stable_id: StableId,
128
129 /// This node's hostname.
130 pub hostname: String,
131
132 /// The integer id of the user that owns this node (`Node.User` in Go). `0` when control sends
133 /// no owner (e.g. tagged/ACL nodes have no human owner). Join against the netmap's
134 /// `UserProfiles` table (accumulated by the runtime's peer tracker) to resolve a login/display
135 /// name — see the runtime `WhoIs` lookup.
136 pub user_id: ts_control_serde::UserId,
137
138 /// The tailnet this node belongs to.
139 pub tailnet: Option<String>,
140
141 /// The tags assigned to this node.
142 pub tags: Vec<String>,
143
144 /// Every prefix control assigned this node (`tailcfg.Node.Addresses`), in wire order.
145 ///
146 /// Normally one IPv4 `/32` and one IPv6 `/128`, but the wire field is a variable-length list:
147 /// an IPv6-off tailnet assigns only the v4 prefix, and nothing in the protocol stops control
148 /// assigning more than one prefix of a family.
149 ///
150 /// [`tailnet_address`](Self::tailnet_address) is the *identity* projection of this list — the
151 /// first prefix of each family — and is what the overlay, MagicDNS and exit-node selection
152 /// reason about. The whole list is retained because [`is_router`](Self::is_router) has to ask
153 /// "is this prefix one of my own?" of **all** of them, exactly as Go's `tailcfg.Node.IsRouter`
154 /// does. Keep the two consistent when building a `Node` by hand.
155 pub addresses: Vec<ipnet::IpNet>,
156
157 /// The address of the node in the tailnet: the first prefix of each family in
158 /// [`addresses`](Self::addresses), with an unspecified placeholder for a family the tailnet
159 /// does not assign.
160 pub tailnet_address: TailnetAddress,
161
162 /// The node's [`NodePublicKey`].
163 pub node_key: NodePublicKey,
164 /// The node key's expiration.
165 pub node_key_expiry: Option<DateTime<Utc>>,
166
167 /// Whether this node's key is expired (`tailcfg.Node.Expired`).
168 ///
169 /// Two writers, exactly as upstream. Control may send it on the wire, and the client sets it
170 /// itself — only ever `false` → `true` — when
171 /// [`node_key_expiry`](Self::node_key_expiry) has passed, so the decision is made against a
172 /// clock corrected for control skew rather than the raw local one. See
173 /// [`ExpiryManager::flag_expired_peer`](crate::ExpiryManager::flag_expired_peer), which is what
174 /// sets it and which also clears this node's endpoints and home DERP and breaks its
175 /// [`node_key`](Self::node_key).
176 ///
177 /// An expired peer is **kept** in the netmap, not dropped: that is what lets a caller answer
178 /// [`PEER_KEY_EXPIRED`](crate::PEER_KEY_EXPIRED) rather than "no such peer". Distinct from
179 /// [`key_expired`](Self::key_expired), which recomputes the answer from the raw local clock and
180 /// is what the **self**-node re-auth decision reads.
181 pub expired: bool,
182
183 /// Whether control reports this node currently connected to the coordination server
184 /// (`tailcfg.Node.Online`, a tri-state `*bool`). `None` = unknown / no permission to know /
185 /// never been online — **do not collapse to `false`** (that would fabricate an offline status
186 /// control never asserted). Updated by full nodes AND by the delta channels (a
187 /// [`PeerChange::online`], or the `MapResponse.online_change` map).
188 pub online: Option<bool>,
189 /// When control last saw this node online (`tailcfg.Node.LastSeen`). Per Go, only meaningful
190 /// while `online` is not `Some(true)` ("not updated when Online is true"). `None` = unknown /
191 /// never online.
192 pub last_seen: Option<DateTime<Utc>>,
193
194 /// Marshalled TKA node-key signature (`tailcfg.Node.KeySignature`); empty when control sends
195 /// none. Verified against a TKA `Authority` at the peer-trust chokepoint WHEN tailnet-lock
196 /// enforcement is active.
197 pub key_signature: Vec<u8>,
198
199 /// The node's [`MachinePublicKey`], if known.
200 pub machine_key: Option<MachinePublicKey>,
201 /// The node's [`DiscoPublicKey`], if known.
202 pub disco_key: Option<DiscoPublicKey>,
203
204 /// Whether control marked this node as peerAPI-only and outside tailnet lock's coverage
205 /// (`tailcfg.Node.UnsignedPeerAPIOnly`).
206 ///
207 /// Such a node carries no node-key signature. Upstream Go treats that as deliberate: it exempts
208 /// the node from tailnet-lock verification and, in exchange, gives it **no network access** —
209 /// only this node's peerAPI.
210 ///
211 /// **This fork does not implement that admission exemption yet.** While a tailnet-lock authority
212 /// with a **non-empty trusted-key set** is active, the runtime's peer-admission gate
213 /// (`ts_runtime`'s `PeerTracker::tka_snapshot_admits`) drops *every* peer with an empty
214 /// [`key_signature`](Self::key_signature), this flag included — so such a peer is not admitted
215 /// to the peer db at all and gets no peerAPI access either. That is stricter than Go (the safe
216 /// direction); the carve-out is tracked as a parity gap in `docs/PARITY_ROADMAP.md`.
217 ///
218 /// The trusted-key qualifier is not hypothetical hedging, it names the one case where the gate
219 /// does not enforce: an authority whose trusted-key set is *empty* admits every peer, signed or
220 /// not. A verified chain can never produce that state (genesis rejects an empty key set and the
221 /// last key cannot be removed), so it means a `ts_tka` invariant was violated — and the gate
222 /// prefers admitting everyone (logged at `error!`) over black-holing the whole netmap. In that
223 /// state this flag changes nothing either, because nothing is being enforced against.
224 ///
225 /// The *routes* half of upstream's treatment **is** implemented here. Because the node is
226 /// outside the lock, a (possibly malicious) control server must not be able to grant it
227 /// network access via advertised routes, so [`accepted_routes`](Self::accepted_routes) is
228 /// clamped to the node's own [`addresses`](Self::addresses) when this is set. See the `From`
229 /// impl on this type, which mirrors Go's `upgradeNode` in `control/controlclient/map.go`.
230 ///
231 /// The clamp is **unconditional** — it does not depend on tailnet lock being enabled locally,
232 /// because the point is that an unsigned peer is by definition outside the lock's coverage.
233 ///
234 /// The clamp alone is not enough, because it closes only one of the two doors control has.
235 /// Control can leave the node's `AllowedIPs` at its own addresses — which the clamp permits,
236 /// those *are* its addresses — and write those same addresses into the **packet filter** as an
237 /// allowed source instead. Upstream's answer is to reject the filter outright: a filter that
238 /// grants an unsigned peer network access is treated as invalid ("the server is either broken
239 /// or malicious") and ignored wholesale. That is
240 /// [`ts_packetfilter::permits_unlocked_nodes`], driven by `ts_runtime`'s packet-filter updater
241 /// on every netmap that moves either the filter or the peer set — Go's
242 /// `packetFilterPermitsUnlockedNodes` / `nodeBackend.unlockedNodesPermitted` in
243 /// `ipn/ipnlocal/local.go`.
244 ///
245 /// The **capability** half is still unported: there is no per-peer capability map in this
246 /// domain model, only the node-attribute [`cap_map`](Self::cap_map). When it is ported, note
247 /// that upstream does **not** withhold every capability. `capsAllowedForUnsignedPeer`
248 /// (`ipn/ipnlocal/node_backend.go`) keeps `tailcfg.PeerCapabilityIngress` when the peer has it
249 /// and drops the rest, on upstream's own reasoning that "Tailscale Funnel ingress nodes are
250 /// unsigned by design, and the capability only permits ingress requests over the PeerAPI, which
251 /// unsigned peers can already reach". Withholding it too would refuse Funnel ingress from real
252 /// Tailscale nodes, so the carve-out travels with the port rather than after it.
253 pub unsigned_peer_api_only: bool,
254
255 /// The routes this node accepts traffic for.
256 ///
257 /// Clamped to [`addresses`](Self::addresses) when
258 /// [`unsigned_peer_api_only`](Self::unsigned_peer_api_only) is set.
259 pub accepted_routes: Vec<ipnet::IpNet>,
260 /// The underlay addresses this node is reachable on (`Endpoints` in Go).
261 pub underlay_addresses: Vec<SocketAddr>,
262
263 /// The node's advertised SSH host public keys, in known_hosts format (Go
264 /// `tailcfg.Hostinfo.SSHHostKeys`, surfaced by tsnet as `ipnstate.PeerStatus.SSH_HostKeys`).
265 /// Used by `tailscale ssh` to pin a peer's host key (TOFU). Empty when control advertised none
266 /// (the wire `Hostinfo.sshHostKeys` was absent), never fabricated. Projected from
267 /// [`ts_control_serde::HostInfo::ssh_host_keys`].
268 pub ssh_host_keys: Vec<String>,
269
270 /// The DERP region for this node, if known.
271 pub derp_region: Option<ts_derp::RegionId>,
272
273 /// This node's advertised capability version (`Node.Cap` in Go). Old control servers may not
274 /// send it, in which case it defaults to [`CapabilityVersion::default`]. Used to gate features
275 /// that require a minimum peer capability, e.g. exit-node DNS proxying (`peerCanProxyDNS`).
276 pub cap: CapabilityVersion,
277
278 /// This node's capability map (`Node.CapMap` in Go). Keys are capability names/URLs; values are
279 /// the raw JSON argument blobs (often empty). Threaded from the wire
280 /// ([`ts_control_serde::Node::cap_map`]) as an owned copy. Used to gate node-level features such
281 /// as Funnel ingress ([`Node::can_funnel`], [`Node::check_funnel_port`]).
282 pub cap_map: NodeCapMap,
283
284 /// The peerAPI port this node advertises over IPv4 (`peerapi4` service), if any.
285 ///
286 /// Derived from `HostInfo.Services`. `None` means the peer advertises no IPv4 peerAPI, so it
287 /// cannot be reached for peerAPI DoH (DNS-over-HTTPS) exit-node delegation.
288 pub peerapi_port: Option<u16>,
289
290 /// Whether this peer advertises the `peerapi-dns-proxy` service (Go `PeerAPIDNSProxy`),
291 /// indicating it will proxy DNS lookups for other nodes when used as an exit node.
292 pub peerapi_dns_proxy: bool,
293
294 /// Whether this is a non-Tailscale WireGuard-only peer (`IsWireGuardOnly` in Go). Such peers
295 /// cannot run a peerAPI DoH server, so exit-node DNS for them comes from
296 /// [`Node::exit_node_dns_resolvers`] instead.
297 pub is_wireguard_only: bool,
298
299 /// DNS resolvers to use when this WireGuard-only peer is selected as an exit node
300 /// (`ExitNodeDNSResolvers` in Go). Only meaningful when [`Node::is_wireguard_only`] is set.
301 /// Encrypted-transport resolvers are dropped (see `Resolver::from_serde`).
302 pub exit_node_dns_resolvers: Vec<Resolver>,
303
304 /// Whether this node advertises itself as a **peer relay** (Go `Hostinfo.PeerRelay`): it runs a
305 /// UDP relay server other peers can allocate relay endpoints on. This fork is a relay client
306 /// only and never sets this for itself; it is parsed off peers so a relay candidate can be
307 /// recognized. Actually *using* a relay path (the Geneve data path + allocation handshake) is
308 /// not yet implemented — see the crate docs.
309 pub peer_relay: bool,
310
311 /// Per-service virtual IP addresses of the Tailscale VIP services this node *hosts*, keyed by
312 /// `svc:<label>` service name. Parsed from the `service-host`
313 /// ([`ts_control_serde::NODE_ATTR_SERVICE_HOST`]) node-capability value
314 /// (`tailcfg.ServiceIPMappings`). These VIPs are control-assigned and also injected into the
315 /// node's `AllowedIPs`; the application netstack must accept packets for them so a
316 /// `Device::listen_service`-bound listener can answer. Empty when the
317 /// node hosts no VIP services (the common case). Per-service IP lists are deduplicated, source
318 /// order otherwise preserved. Use [`Node::service_addresses`] for the flattened set (netstack
319 /// accept list) and [`Node::service_addresses_for`] for a specific service's VIPs.
320 pub service_vips: alloc::collections::BTreeMap<String, Vec<IpAddr>>,
321}
322
323impl Node {
324 /// The fully-qualified domain name of the node.
325 ///
326 /// This is a string of the form `$HOST.$TAILNET_DOMAIN.`. For tailnets controlled by
327 /// Tailscale's control plane, this usually means `$HOST.tail1234.ts.net.`
328 ///
329 /// The `trailing_dot` parameter specifies whether to include the trailing dot in the
330 /// fqdn. This is included by the definition of FQDN, and is the way the Go codebase
331 /// formats this field, but the parameter is included to allow turning it off for use
332 /// in contexts that expect it to be absent.
333 pub fn fqdn(&self, trailing_dot: bool) -> String {
334 let dot = if trailing_dot { "." } else { "" };
335 match &self.tailnet {
336 Some(tailnet) => format!("{}.{tailnet}{dot}", self.hostname),
337 None => format!("{}{dot}", self.hostname),
338 }
339 }
340
341 /// Whether this node's key has expired as of `now`, mirroring Go's
342 /// `netmap.NetworkMap.SelfKeyExpiry` + the `!expiry.IsZero() && expiry.Before(now)` check in
343 /// `ipnlocal`. A node with no expiry ([`Node::node_key_expiry`] is `None`, the Go "zero value =
344 /// does not expire") is never expired.
345 ///
346 /// Like Go, this fork is **reactive**: it reports expiry rather than auto-rotating in the
347 /// background (Go transitions to `NeedsLogin` on expiry and re-registers via stored auth-key or
348 /// interactive login). A caller observing `true` should re-register
349 /// (`crate::tokio::register`) — supplying `RegisterRequest::old_node_key` (the prior key) and
350 /// a fresh `node_key` when rotating the key, or the same key to merely refresh.
351 pub fn key_expired(&self, now: DateTime<Utc>) -> bool {
352 match self.node_key_expiry {
353 None => false,
354 Some(expiry) => expiry < now,
355 }
356 }
357
358 /// The instant this node's key expires (`Node.KeyExpiry` in Go), or `None` if it never expires.
359 /// A caller can schedule a re-evaluation/re-auth at this time.
360 pub fn key_expiry(&self) -> Option<DateTime<Utc>> {
361 self.node_key_expiry
362 }
363
364 /// Whether this node advertises itself as a peer relay (Go `Hostinfo.PeerRelay`): it runs a UDP
365 /// relay server other peers may allocate relay endpoints on. Recognizing a relay candidate;
366 /// actually traversing a relay path is not yet implemented in this fork.
367 pub fn is_peer_relay(&self) -> bool {
368 self.peer_relay
369 }
370
371 /// The key-expiry instant as **Unix seconds**, or `None` if the key never expires. Provided for
372 /// callers (e.g. the root crate) that don't depend on `chrono`.
373 pub fn key_expiry_unix(&self) -> Option<i64> {
374 self.node_key_expiry.map(|t| t.timestamp())
375 }
376
377 /// Whether the key has expired as of `now_unix_secs` (Unix seconds). Equivalent to
378 /// [`key_expired`](Self::key_expired) for `chrono`-free callers. A key with no expiry is never
379 /// expired.
380 pub fn key_expired_at_unix(&self, now_unix_secs: i64) -> bool {
381 match self.key_expiry_unix() {
382 None => false,
383 Some(expiry) => expiry < now_unix_secs,
384 }
385 }
386
387 /// The fully-qualified domain name of the node, only returning `Some` if the tailnet
388 /// component is present.
389 ///
390 /// See [`Node::fqdn`].
391 pub fn fqdn_opt(&self, trailing_dot: bool) -> Option<String> {
392 let dot = if trailing_dot { "." } else { "" };
393 let tailnet = self.tailnet.as_deref()?;
394
395 Some(format!("{}.{tailnet}{dot}", self.hostname))
396 }
397
398 /// Report whether this node matches the given `name`.
399 ///
400 /// `name` is checked for equality with both this node's bare hostname and its fqdn. A
401 /// trailing `.` may be present. Matching is case-insensitive (DNS names are
402 /// case-insensitive), so this agrees with the canonicalized MagicDNS-name index used for
403 /// peer lookups.
404 pub fn matches_name(&self, name: &str) -> bool {
405 // Strip an optional trailing root dot, then chop our `.tailnet` suffix off the end (if it
406 // matches, case-insensitively) and compare the remainder to our hostname. If the tailnet
407 // suffix doesn't match, the final case-insensitive compare against our bare hostname fails
408 // naturally; if `name` was just the hostname, nothing is chopped and we compare directly.
409
410 let name = name.strip_suffix('.').unwrap_or(name);
411
412 let name = if let Some(tailnet) = &self.tailnet {
413 name.get(name.len().saturating_sub(tailnet.len())..)
414 .filter(|suffix| suffix.eq_ignore_ascii_case(tailnet))
415 .and_then(|_| name.get(..name.len() - tailnet.len()))
416 .and_then(|name| name.strip_suffix('.'))
417 .unwrap_or(name)
418 } else {
419 name
420 };
421
422 name.eq_ignore_ascii_case(&self.hostname)
423 }
424
425 /// Report whether this node is a **router**: it routes addresses besides its own. An exit
426 /// node, a subnet router and an app connector are all routers.
427 ///
428 /// Mirrors Go's `tailcfg.Node.IsRouter` (`tailcfg/tailcfg.go`, added upstream in `8d830599b`),
429 /// which is `true` when any prefix in `AllowedIPs` is not also one of the node's own
430 /// `Addresses`. It is a *derived predicate*, not a wire field: control sends nothing new for
431 /// it, so there is no interop surface here and no capability version to gate on.
432 ///
433 /// Deliberately **not** [`Node::is_subnet_route`] folded over [`Node::accepted_routes`]. That
434 /// predicate also excuses any single Tailscale-range IP (`100.64.0.0/10` /
435 /// `fd7a:115c:a1e0::/48`) so route installation never mistakes another peer's address for an
436 /// advertised subnet; Go's `IsRouter` makes no such exception — a `/32` that is not *this*
437 /// node's own address still makes it a router. The two must stay separate.
438 ///
439 /// The comparison is against [`Node::addresses`] — *every* prefix control assigned this node,
440 /// as Go's `slices.Contains(n.Addresses, r)` is — and not against the first-prefix-per-family
441 /// pair in [`Node::tailnet_address`]. A node control handed two prefixes of one family would
442 /// otherwise have the second read as a routed address and be misreported as a router.
443 pub fn is_router(&self) -> bool {
444 self.accepted_routes
445 .iter()
446 .any(|route| !self.addresses.contains(route))
447 }
448
449 /// Report whether `route` is an advertised *subnet* route (as opposed to one of this node's
450 /// own tailnet addresses).
451 ///
452 /// Mirrors `cidrIsSubnet` in the Go client (`wgengine/wgcfg/nmcfg/nmcfg.go`). A route is *not*
453 /// a subnet route (i.e. it's a self-address) when it is a single host IP that is either a
454 /// Tailscale-assigned IP or exactly one of this node's [`TailnetAddress`] addresses. Everything
455 /// else — multi-IP CIDRs, and single IPs outside the Tailscale ranges — is a subnet route.
456 ///
457 /// The default route (`0.0.0.0/0` / `::/0`) is treated as a subnet route here; exit-node
458 /// handling is a separate concern.
459 pub fn is_subnet_route(&self, route: &ipnet::IpNet) -> bool {
460 let host_prefix = match route {
461 ipnet::IpNet::V4(_) => 32,
462 ipnet::IpNet::V6(_) => 128,
463 };
464
465 if route.prefix_len() != host_prefix {
466 // Any multi-IP CIDR (including the default route) is a subnet route.
467 return true;
468 }
469
470 let addr = route.addr();
471 !(is_tailscale_ip(addr) || self.tailnet_address.contains(addr))
472 }
473
474 /// The routes that should be installed for this peer, given whether this node accepts
475 /// advertised subnet routes (`--accept-routes` / `RouteAll` in the Go client) and which peer
476 /// (if any) is the selected exit node (`--exit-node` / `ExitNodeID` in the Go client).
477 ///
478 /// This node's own addresses (the peer's `/32` and `/128`) are always installed so the peer
479 /// itself stays reachable. Larger advertised subnet routes are only installed when
480 /// `accept_routes` is set; otherwise they are dropped (fail-closed). The same filtered set
481 /// governs both outbound routing to the peer and inbound source validation, exactly as
482 /// WireGuard cryptokey routing couples them in the Go client.
483 ///
484 /// The default route (`0.0.0.0/0` / `::/0`) is installed *only* for the peer whose
485 /// [`StableId`] equals `exit_node`, mirroring `nmcfg.go`'s `if allowedIP.Bits()==0 &&
486 /// peer.StableID()!=exitNode { skip }`. Exit-node use is gated behind this separate, explicit
487 /// preference (`ExitNodeID`, not `RouteAll`): conflating the two would let enabling
488 /// subnet-route acceptance silently route every packet through any peer advertising a default
489 /// route — unacceptable for a fail-closed privacy posture. When `exit_node` is `None` (the
490 /// default) no peer ever receives a `/0`, so internet-bound traffic has no overlay route and is
491 /// dropped by the userspace netstack (fail-closed, no leak). Longest-prefix-match means a peer
492 /// selected as the exit node still loses more-specific destinations to other peers; only
493 /// residual default-route traffic egresses through it.
494 pub fn routes_to_install<'a>(
495 &'a self,
496 accept_routes: bool,
497 exit_node: Option<&StableId>,
498 ) -> impl Iterator<Item = &'a ipnet::IpNet> + 'a {
499 // Computed eagerly so the returned iterator doesn't borrow `exit_node`.
500 let is_selected_exit = exit_node == Some(&self.stable_id);
501 self.accepted_routes.iter().filter(move |route| {
502 if route.prefix_len() == 0 {
503 // Default route: installed only when this peer is the selected exit node. Both the
504 // outbound route table and the inbound source filter call this, so the exit peer
505 // may legitimately source arbitrary internet IPs on return traffic — and only it.
506 return is_selected_exit;
507 }
508 accept_routes || !self.is_subnet_route(route)
509 })
510 }
511
512 /// The capability version at and above which a peer can proxy DNS for nodes using it as an exit
513 /// node (Go `tailcfg.CapabilityVersion` `peerCanProxyDNS`, introduced 2022-01-12 at V26).
514 const PEER_CAN_PROXY_DNS: CapabilityVersion = CapabilityVersion::V26;
515
516 /// The base URL of this peer's IPv4 peerAPI DoH endpoint for exit-node DNS proxying, if it can
517 /// proxy DNS. Returns e.g. `http://100.64.0.5:8080/dns-query`.
518 ///
519 /// Mirrors Go `peerAPIBase(...)+"/dns-query"` gated by `exitNodeCanProxyDNS`: a peer can proxy
520 /// DNS when it advertises an IPv4 peerAPI port **and** either advertises the explicit
521 /// `peerapi-dns-proxy` service or is new enough ([`Node::cap`] ≥ `PEER_CAN_PROXY_DNS`). A
522 /// WireGuard-only peer never runs a peerAPI, so it returns `None` here (its exit-node DNS comes
523 /// from [`Node::exit_node_dns_resolvers`] instead).
524 ///
525 /// IPv4-only by deliberate design: the tailnet dataplane in this fork binds IPv4 only, so we
526 /// never form a peerAPI URL on the peer's IPv6 address.
527 ///
528 /// `None` for an [`expired`](Self::expired) peer — see [`Node::peerapi_addr`].
529 pub fn peerapi_doh_url(&self) -> Option<String> {
530 self.peerapi_doh_addr()
531 .map(|addr| format!("http://{addr}/dns-query"))
532 }
533
534 /// The IPv4 socket address (`<tailnet-ipv4>:<peerapi-port>`) of this peer's peerAPI DoH endpoint
535 /// for exit-node DNS proxying, if it can proxy DNS. Same gate as [`Node::peerapi_doh_url`]; this
536 /// is the form the DoH *client* dials (over the overlay netstack) when delegating recursive
537 /// resolution to a selected exit node. `SocketAddr`'s `Display` is `ip:port`, so
538 /// `peerapi_doh_url` formats to `http://<ip>:<port>/dns-query` over this.
539 pub fn peerapi_doh_addr(&self) -> Option<SocketAddr> {
540 if self.is_wireguard_only || self.expired {
541 return None;
542 }
543 let port = self.peerapi_port?;
544 if !(self.peerapi_dns_proxy || self.cap >= Self::PEER_CAN_PROXY_DNS) {
545 return None;
546 }
547 Some(SocketAddr::new(
548 IpAddr::V4(self.tailnet_address.ipv4.addr()),
549 port,
550 ))
551 }
552
553 /// The IPv4 peerAPI socket address (`<tailnet-ipv4>:<peerapi4-port>`) of this node, if it
554 /// advertises an IPv4 peerAPI. Unlike [`Node::peerapi_doh_addr`], this is **not** gated on the
555 /// DNS-proxy capability: it is the general base for any peerAPI request to this node (e.g. a
556 /// Taildrop `PUT /v0/put/<name>` upload), mirroring Go's `peerAPIBase`/`peerAPIPorts`.
557 ///
558 /// IPv4-only by this fork's deliberate design (the tailnet dataplane binds IPv4 only, so we never
559 /// form a peerAPI URL on the peer's IPv6 address). Returns `None` for a WireGuard-only peer (which
560 /// runs no peerAPI) or a peer advertising no IPv4 peerAPI port.
561 ///
562 /// Also `None` for an [`expired`](Self::expired) peer: Go refuses a peerAPI dial to one with
563 /// [`PEER_KEY_EXPIRED`](crate::PEER_KEY_EXPIRED) (`LocalBackend.pingPeerAPI`), and this is the
564 /// chokepoint every peerAPI dial in this fork resolves its destination through. Callers that
565 /// want to *report* the refusal rather than silently skip the peer should test
566 /// [`expired`](Self::expired) first.
567 pub fn peerapi_addr(&self) -> Option<SocketAddr> {
568 if self.is_wireguard_only || self.expired {
569 return None;
570 }
571 let port = self.peerapi_port?;
572 Some(SocketAddr::new(
573 IpAddr::V4(self.tailnet_address.ipv4.addr()),
574 port,
575 ))
576 }
577
578 /// The node attribute granting HTTPS (TLS cert provisioning) for this node (Go
579 /// `tailcfg.CapabilityHTTPS`). One of the two caps [`Node::can_funnel`] requires.
580 const CAP_HTTPS: &'static str = "https";
581
582 /// The node attribute granting the ability to host Funnel ingress (Go `tailcfg.NodeAttrFunnel`).
583 /// The other cap [`Node::can_funnel`] requires.
584 const NODE_ATTR_FUNNEL: &'static str = "funnel";
585
586 /// The capability URL whose `?ports=` query enumerates the ports Funnel may listen on (Go
587 /// `tailcfg.CapabilityFunnelPorts`). The allowed ports live entirely in the *key's* query
588 /// string, not the cap value.
589 const CAP_FUNNEL_PORTS: &'static str = "https://tailscale.com/cap/funnel-ports";
590
591 /// Report whether the cap map contains `cap` as a key (Go `NodeCapMap.Contains` / `HasCap`).
592 pub fn has_node_attr(&self, cap: &str) -> bool {
593 self.cap_map.contains_key(cap)
594 }
595
596 /// Report whether this node is permitted to host Tailscale Funnel ingress.
597 ///
598 /// Mirrors Go `ipn.NodeCanFunnel`: the node must advertise BOTH `CapabilityHTTPS` (`"https"`)
599 /// AND `NodeAttrFunnel` (`"funnel"`) in its cap map. Fail-closed: a missing cap denies.
600 pub fn can_funnel(&self) -> bool {
601 self.has_node_attr(Self::CAP_HTTPS) && self.has_node_attr(Self::NODE_ATTR_FUNNEL)
602 }
603
604 /// The capability control grants the **self** node when Taildrop is enabled for the tailnet (Go
605 /// `tailcfg.CapabilityFileSharing`). Gates [`Node::can_share_files`].
606 const CAP_FILE_SHARING: &'static str = "https://tailscale.com/cap/file-sharing";
607
608 /// The capability marking a **peer** as an explicit Taildrop send target even across owners (Go
609 /// `tailcfg.PeerCapabilityFileSharingTarget`). Checked by [`Node::is_file_sharing_target`].
610 const CAP_FILE_SHARING_TARGET: &'static str = "tailscale.com/cap/file-sharing-target";
611
612 /// Report whether this node may send Taildrop files — i.e. the admin has enabled file sharing for
613 /// the tailnet (Go `self.CapMap().Contains(CapabilityFileSharing)`). Applied to the **self** node
614 /// as the node-level gate in `FileTargets`; fail-closed when the cap is absent.
615 pub fn can_share_files(&self) -> bool {
616 self.has_node_attr(Self::CAP_FILE_SHARING)
617 }
618
619 /// Report whether this **peer** is an explicit Taildrop send target via ACL caps (Go
620 /// `PeerHasCap(p, PeerCapabilityFileSharingTarget)`) — the cross-owner path that lets a peer owned
621 /// by a different user still be a valid target.
622 pub fn is_file_sharing_target(&self) -> bool {
623 self.has_node_attr(Self::CAP_FILE_SHARING_TARGET)
624 }
625
626 /// The node attribute control sets on a node whose **subdomains** all resolve to the node
627 /// itself (Go `tailcfg/nodecap`'s `NodeAttrDNSSubdomainResolve`). Read by
628 /// [`Node::resolves_subdomains`].
629 const NODE_ATTR_DNS_SUBDOMAIN_RESOLVE: &'static str = "dns-subdomain-resolve";
630
631 /// Report whether every subdomain of this node's MagicDNS name resolves to this node's
632 /// addresses — `foo.<node>` and `bar.foo.<node>` alike.
633 ///
634 /// Go's resolver (`net/dns/resolver/tsdns.go`) learns the same thing two ways — a
635 /// `Config.SubdomainHosts` set of FQDNs beside its `Hosts` map, and a `SubdomainHost` predicate
636 /// on its MagicDNS host index — and on a lookup miss walks the queried name's parents,
637 /// answering from the first parent either one accepts. Here the attribute on the node *is* that
638 /// predicate, read where the parent walk finds the node.
639 ///
640 /// Being a plain per-node attribute, it needs no capability version: a node control has not set
641 /// it on is unaffected, and its subdomains stay `NXDOMAIN`.
642 pub fn resolves_subdomains(&self) -> bool {
643 self.has_node_attr(Self::NODE_ATTR_DNS_SUBDOMAIN_RESOLVE)
644 }
645
646 /// The node attribute control sets to stop the DNS forwarder re-asking a truncated upstream
647 /// answer over TCP (Go `tailcfg/nodecap`'s `NodeAttrDNSForwarderDisableTCPRetries`, surfaced in
648 /// `control/controlknobs` as `Knobs.DisableDNSForwarderTCPRetries`). Read by
649 /// [`Node::disable_dns_forwarder_tcp_retries`].
650 const NODE_ATTR_DNS_FORWARDER_DISABLE_TCP_RETRIES: &'static str =
651 "dns-forwarder-disable-tcp-retries";
652
653 /// Report whether control has told this node **not** to retry a truncated forwarded DNS answer
654 /// over TCP.
655 ///
656 /// The retry is on by default and this attribute is its *off* switch — so, unlike every other
657 /// attribute here, the fail-closed reading is the one that ignores it: a node control has not
658 /// set it on keeps retrying, which is what a stub resolver on this node needs for a name whose
659 /// answer does not fit a datagram. Go reads it the same way round
660 /// (`skipTCP := skipTCPRetry() || (f.controlKnobs != nil &&
661 /// f.controlKnobs.DisableDNSForwarderTCPRetries.Load())`, net/dns/resolver/forwarder.go).
662 ///
663 /// Upstream dates a client's understanding of the attribute to capability version 75
664 /// ([`ts_capabilityversion::CapabilityVersion::V75`]), which this tree's `CURRENT` is well
665 /// above, so control will send it to this node when the tailnet sets it.
666 pub fn disable_dns_forwarder_tcp_retries(&self) -> bool {
667 self.has_node_attr(Self::NODE_ATTR_DNS_FORWARDER_DISABLE_TCP_RETRIES)
668 }
669
670 /// The node attribute by which control asks this node to keep its periodic STUN sweep running
671 /// even while the datapath is idle (Go `tailcfg/nodecap`'s `NodeAttrDebugForceBackgroundSTUN`,
672 /// surfaced in `control/controlknobs` as `Knobs.ForceBackgroundSTUN`). Read by
673 /// [`force_background_stun`](Self::force_background_stun).
674 const NODE_ATTR_DEBUG_FORCE_BACKGROUND_STUN: &'static str = "debug-always-stun";
675
676 /// Report whether control has asked this node to keep STUNning in the background regardless of
677 /// datapath activity.
678 ///
679 /// This is the single override on the idle stop condition in Go magicsock's
680 /// `shouldDoPeriodicReSTUNLocked`: once the datapath has been idle longer than the session-active
681 /// timeout the periodic sweep stops, *unless* `c.controlKnobs.ForceBackgroundSTUN` is set, in
682 /// which case it keeps running. It overrides nothing else — a node with no peers still does not
683 /// STUN, with or without the attribute, because that arm returns before the idle arm is reached.
684 ///
685 /// Read off the **self** node's cap map, like every other control knob. Absent (the normal case)
686 /// means "let the idle stop apply", which is the quiet default; the attribute is a debugging
687 /// escape hatch control sets deliberately, so there is nothing to fail closed to here.
688 pub fn force_background_stun(&self) -> bool {
689 self.has_node_attr(Self::NODE_ATTR_DEBUG_FORCE_BACKGROUND_STUN)
690 }
691
692 /// The node attribute by which control asks this node to collapse its per-peer CGNAT host
693 /// routes into the single `100.64.0.0/10` (Go `tailcfg/nodecap`'s `OneCGNATEnable`).
694 ///
695 /// Note the query string: the key is the literal `one-cgnat?v=true`, not `one-cgnat`. The
696 /// attribute is a tri-state carried as two mutually exclusive keys rather than as a key with a
697 /// value, so the lookup is on the whole literal.
698 const NODE_ATTR_ONE_CGNAT_ENABLE: &'static str = "one-cgnat?v=true";
699
700 /// The node attribute by which control asks this node NOT to force the collapsed route (Go
701 /// `tailcfg/nodecap`'s `OneCGNATDisable`): one host route per peer until the consumer's own
702 /// peer-count ceiling, which still applies. The other half of
703 /// [`NODE_ATTR_ONE_CGNAT_ENABLE`](Self::NODE_ATTR_ONE_CGNAT_ENABLE)'s tri-state.
704 ///
705 /// It declines the **forced** collapse only. It is not a licence for an unbounded host route
706 /// table: the consumer's own peer-count ceiling still applies above it — see
707 /// [`Node::one_cgnat`](Self::one_cgnat).
708 const NODE_ATTR_ONE_CGNAT_DISABLE: &'static str = "one-cgnat?v=false";
709
710 /// Control's tri-state instruction about collapsing this node's per-peer CGNAT host routes
711 /// into the single `100.64.0.0/10`, read off the **self** node's cap map.
712 ///
713 /// Mirrors Go `ipn/ipnlocal`'s read of `nodecap.OneCGNATEnable` / `nodecap.OneCGNATDisable`
714 /// into `controlknobs.Knobs.OneCGNAT`, which is an `opt.Bool` and not a `bool` precisely so the
715 /// third state exists:
716 ///
717 /// * `Some(true)` — `one-cgnat?v=true`: collapse as soon as there is more than one peer route.
718 /// * `Some(false)` — `one-cgnat?v=false`: do not force the collapse, whatever the platform
719 /// would default to. It is NOT "never collapse": the consumer's peer-count ceiling (Go
720 /// `net/routemanager`'s `cgnatThreshold`) still collapses a large enough tailnet.
721 /// * `None` — neither attribute present: control has no opinion, and the consumer's platform
722 /// default decides (Go `ipn/ipnlocal`'s `shouldUseOneCGNATRoute`), under the same ceiling.
723 ///
724 /// What the third state does NOT do is switch the consumer's peer-count ceiling off. Upstream
725 /// resolves this `opt.Bool` down to a plain `bool` before the route manager sees it, and
726 /// `RouteManager.cgnatThreshold()` then picks between `1` and `cgnatThreshold` (`10_000`) —
727 /// so a node holding `one-cgnat?v=false` still collapses once it has more CGNAT peer routes
728 /// than the ceiling. The tri-state chooses whether to collapse *early*, not whether a host
729 /// route table may grow without bound.
730 ///
731 /// A node holding BOTH attributes reads as `Some(true)`: the enabling attribute is checked
732 /// first and wins. Control setting both is a policy conflict rather than a state upstream
733 /// specifies, and collapsing is the safe way to break the tie — the `/10` is a superset of the
734 /// `/32`s it replaces, so no peer becomes unreachable, whereas honouring the disabling
735 /// attribute on a tailnet large enough for control to have set the enabling one would keep a
736 /// per-peer route table far past the point where it is worth programming.
737 pub fn one_cgnat(&self) -> Option<bool> {
738 if self.has_node_attr(Self::NODE_ATTR_ONE_CGNAT_ENABLE) {
739 Some(true)
740 } else if self.has_node_attr(Self::NODE_ATTR_ONE_CGNAT_DISABLE) {
741 Some(false)
742 } else {
743 None
744 }
745 }
746
747 /// The node attribute by which control asks this node to stop processing netmap updates through
748 /// the delta (incremental) path (Go `tailcfg/nodecap`'s `DisableDeltaUpdates`, read into
749 /// `controlknobs.Knobs.DisableDeltaUpdates`). Read off the **self** node's cap map by
750 /// [`delta_updates_disabled`](Self::delta_updates_disabled).
751 ///
752 /// Upstream documents the intent on the knob itself: the client "should not process updates via
753 /// the delta update mechanism and should instead treat all netmap changes as 'full' ones as
754 /// tailscaled did in 1.48.x and earlier". It is control's escape hatch for a delta-encoding bug
755 /// on *either* side of the map protocol — control emitting bad patches, or a client applying
756 /// them wrongly — without waiting for a client release to ship.
757 const NODE_ATTR_DISABLE_DELTA_UPDATES: &'static str = "disable-delta-updates";
758
759 /// Report whether control has asked this node to decline the incremental netmap path and treat
760 /// every netmap change as a full one.
761 ///
762 /// Mirrors the first statement of Go `control/controlclient/map.go`'s `tryHandleIncrementally`:
763 /// `if ms.controlKnobs != nil && ms.controlKnobs.DisableDeltaUpdates.Load() { return false }`.
764 /// Returning `false` there does **not** reject the response and does not drop the mutations it
765 /// carries — it declines the incremental arm so the full netmap rebuild handles the very same
766 /// response. A consumer of this method owes the same shape: fall back, never drop.
767 ///
768 /// Absent attribute ⇒ `false` ⇒ the delta path, which is the default and the overwhelmingly
769 /// common case. Being a plain per-node attribute it needs no capability version: a node control
770 /// has not set it on is unaffected.
771 pub fn delta_updates_disabled(&self) -> bool {
772 self.has_node_attr(Self::NODE_ATTR_DISABLE_DELTA_UPDATES)
773 }
774
775 /// The node attribute by which control tells this node to stop sending disco heartbeats to its
776 /// peers (Go `tailcfg/nodecap`'s `SilentDisco`, read into `controlknobs.Knobs.SilentDisco` and
777 /// handed to magicsock by `ipn/ipnlocal`'s `b.MagicConn().SetSilentDisco(...)`). Read off the
778 /// **self** node's cap map by [`silent_disco`](Self::silent_disco).
779 ///
780 /// Upstream's own summary of the attribute is one sentence — it "makes the client suppress
781 /// disco heartbeats to its peers" — and the node it is set on is the node that goes quiet, so
782 /// it is the *self* node's cap map that decides, never the peer's.
783 const NODE_ATTR_SILENT_DISCO: &'static str = "silent-disco";
784
785 /// Report whether control has asked this node to stop heartbeating its peers' confirmed direct
786 /// paths.
787 ///
788 /// Mirrors Go magicsock `Conn.debugFlagsLocked`'s `heartbeatDisabled`, which the netmap push
789 /// (`endpoint.updateFromNode`) stamps onto every endpoint. With it set, the periodic
790 /// keep-the-best-path-alive ping is not sent — and, as the compensating half, an inbound packet
791 /// from the current best address extends that path's trust directly, because with no heartbeat
792 /// there is nothing else keeping it trusted.
793 ///
794 /// Absent attribute ⇒ `false` ⇒ the existing heartbeat cadence, which is the default and the
795 /// overwhelmingly common case. Being a plain per-node attribute it needs no capability version:
796 /// a node control has not set it on is unaffected.
797 ///
798 /// Go additionally ORs in a `TS_DEBUG_ENABLE_SILENT_DISCO` envknob at the same place. This tree
799 /// has no envknob layer at all, so the control attribute is the whole input here.
800 pub fn silent_disco(&self) -> bool {
801 self.has_node_attr(Self::NODE_ATTR_SILENT_DISCO)
802 }
803
804 /// The node attribute by which control tells this node that the network it sits on tolerates
805 /// nothing but TCP on port 443 (Go `tailcfg/nodecap`'s `OnlyTCP443`, read off `nm.SelfNode` in
806 /// `ipn/ipnlocal` and handed to magicsock by `b.MagicConn().SetOnlyTCP443(...)`). Read off the
807 /// **self** node's cap map by [`only_tcp_443`](Self::only_tcp_443).
808 ///
809 /// Upstream's own words: the client "should not attempt to generate any outbound traffic that
810 /// isn't TCP on port 443", which "thus implies all traffic is over DERP". The node it is set on
811 /// is the node that goes quiet, so it is the *self* node's cap map that decides, never the
812 /// peer's.
813 const NODE_ATTR_ONLY_TCP_443: &'static str = "only-tcp-443";
814
815 /// Report whether control has told this node to emit nothing but TCP/443 — no UDP at all, so
816 /// every tailnet packet rides DERP.
817 ///
818 /// This is the single predicate behind all of upstream's TCP-443-only behaviour: magicsock's
819 /// UDP send chokepoint refuses silently, netcheck's UDP (STUN) probes refuse with
820 /// `errors.ErrUnsupported`, the portmapper is disabled and the peer-relay client is switched
821 /// off. Consumers in this tree read it here rather than each re-deriving it from the cap map.
822 ///
823 /// Absent attribute ⇒ `false` ⇒ UDP as before, which is the default and the overwhelmingly
824 /// common case. Being a plain per-node attribute it needs no capability version: a node control
825 /// has not set it on is unaffected. It is read live off each netmap, never latched at start-up,
826 /// because upstream's setter (`Conn.SetOnlyTCP443`) is live — control withdrawing the attribute
827 /// has to restore UDP without a restart.
828 pub fn only_tcp_443(&self) -> bool {
829 self.has_node_attr(Self::NODE_ATTR_ONLY_TCP_443)
830 }
831
832 /// Report whether `wanted_port` is allowed for Funnel on this node.
833 ///
834 /// Mirrors Go `ipn.CheckFunnelPort`: scan the cap-map keys for one prefixed by
835 /// `Node::CAP_FUNNEL_PORTS`, URL-parse that key, read its `ports` query parameter, and match
836 /// `wanted_port` against the comma-separated list of single ports and `first-last` ranges. The
837 /// port list lives in the *key*, never the value. Fail-closed: no matching cap, an empty or
838 /// unparseable `ports` query, or a key whose non-query part isn't exactly the funnel-ports URL
839 /// all deny.
840 pub fn check_funnel_port(&self, wanted_port: u16) -> bool {
841 // Extract the `ports=` list from the first cap-map key that is the funnel-ports URL with a
842 // non-empty `ports` query. Returns `None` (deny) if the key is unparseable, the query is
843 // missing/empty, or the URL (sans query) isn't exactly the funnel-ports cap.
844 let parse_attr = |attr: &str| -> Option<String> {
845 let mut url = url::Url::parse(attr).ok()?;
846 let ports = url
847 .query_pairs()
848 .find(|(k, _)| k == "ports")
849 .map(|(_, v)| v.into_owned())?;
850 if ports.is_empty() {
851 return None;
852 }
853 url.set_query(None);
854 // Go compares `u.String()` against the bare cap; `url`'s serializer keeps a trailing
855 // `/` only if present in the input, and the funnel-ports cap has none, so a direct
856 // string compare matches Go's behavior.
857 if url.as_str() != Self::CAP_FUNNEL_PORTS {
858 return None;
859 }
860 Some(ports)
861 };
862
863 let Some(ports_str) = self
864 .cap_map
865 .keys()
866 .filter(|attr| attr.starts_with(Self::CAP_FUNNEL_PORTS))
867 .find_map(|attr| parse_attr(attr))
868 else {
869 return false;
870 };
871
872 let wanted = wanted_port.to_string();
873 for ps in ports_str.split(',') {
874 if ps.is_empty() {
875 continue;
876 }
877 match ps.split_once('-') {
878 None => {
879 if ps == wanted {
880 return true;
881 }
882 }
883 Some((first, last)) => {
884 let (Ok(fp), Ok(lp)) = (first.parse::<u16>(), last.parse::<u16>()) else {
885 continue;
886 };
887 if fp <= wanted_port && wanted_port <= lp {
888 return true;
889 }
890 }
891 }
892 }
893 false
894 }
895
896 /// Report whether this node is permitted to host Tailscale VIP services.
897 ///
898 /// Mirrors the Go grant model: possession of the `service-host`
899 /// ([`ts_control_serde::NODE_ATTR_SERVICE_HOST`]) node-capability **and** at least one assigned
900 /// VIP address. Go additionally requires the host to be tagged
901 /// (`ErrUntaggedServiceHost`); that tag gate is enforced at
902 /// `Device::listen_service` using [`Node::tags`]. Fail-closed: no cap
903 /// or no assigned VIP denies.
904 pub fn is_service_host(&self) -> bool {
905 self.has_node_attr(ts_control_serde::NODE_ATTR_SERVICE_HOST)
906 && !self.service_vips.is_empty()
907 }
908
909 /// The control-assigned VIP addresses for one named service (`svc:<label>`), or an empty slice
910 /// if this node does not host that service. This is the exact per-service mapping (so a
911 /// multi-service co-host binds the right VIP for each service).
912 pub fn service_addresses_for(&self, service: &str) -> &[IpAddr] {
913 self.service_vips
914 .get(service)
915 .map(Vec::as_slice)
916 .unwrap_or(&[])
917 }
918
919 /// The flattened, deduplicated set of every VIP address this node hosts across all services.
920 /// Used to widen the netstack's accepted-address set so any hosted-service listener is
921 /// reachable. Per-service binding uses [`Node::service_addresses_for`] instead.
922 pub fn service_addresses(&self) -> Vec<IpAddr> {
923 let mut seen = alloc::collections::BTreeSet::new();
924 let mut out = Vec::new();
925 for addr in self.service_vips.values().flatten() {
926 if seen.insert(*addr) {
927 out.push(*addr);
928 }
929 }
930 out
931 }
932
933 /// The VIP services control has told this node it can *reach* (`tailcfg.ServiceDetails`),
934 /// parsed from every `services/<id>`
935 /// ([`ts_control_serde::NODE_ATTR_PREFIX_SERVICES`]) node-capability value, in capability-key
936 /// order.
937 ///
938 /// This is the consuming half of the VIP services model, and the counterpart to
939 /// [`Node::service_vips`], which is what this node *hosts*. Each entry carries the service's
940 /// canonical name, its VIP addresses, the ports it accepts and the client application actions
941 /// available on those ports. The capability key's suffix is an opaque server-chosen id, so the
942 /// name comes from `ServiceDetails::name` and never from the key.
943 ///
944 /// Fail-closed per value, never per netmap: a capability value that does not parse as a
945 /// `ServiceDetails` is skipped and the remaining services are still returned — the same
946 /// treatment the `service-host` parser gives a malformed `tailcfg.ServiceIPMappings` value. An
947 /// carrying a *type* this build does not know is not a parse failure: it decodes and is
948 /// returned, matching Go's rule that clients ignore actions they do not recognize. Use
949 /// `ts_control_serde::ServiceDetails::known_actions` to walk only the recognized ones.
950 pub fn visible_services(&self) -> Vec<ts_control_serde::ServiceDetails<'_>> {
951 self.cap_map
952 .iter()
953 .filter(|(key, _)| key.starts_with(ts_control_serde::NODE_ATTR_PREFIX_SERVICES))
954 .flat_map(|(_, values)| values.iter())
955 .filter_map(|raw| serde_json::from_str(raw).ok())
956 .collect()
957 }
958}
959
960/// Validate a Tailscale VIP service name (`tailcfg.ServiceName.Validate`): it must carry the
961/// `svc:` prefix ([`ts_control_serde::SERVICE_NAME_PREFIX`]) followed by a valid DNS label
962/// (1–63 chars, ASCII alphanumeric or `-`, not starting/ending with `-`). Returns the bare label on
963/// success. Fail-closed: anything malformed is rejected so a listener can never bind for a bogus
964/// service name.
965pub fn validate_service_name(name: &str) -> Option<&str> {
966 let label = name.strip_prefix(ts_control_serde::SERVICE_NAME_PREFIX)?;
967 if label.is_empty() || label.len() > 63 {
968 return None;
969 }
970 if label.starts_with('-') || label.ends_with('-') {
971 return None;
972 }
973 if label
974 .bytes()
975 .all(|b| b.is_ascii_alphanumeric() || b == b'-')
976 {
977 Some(label)
978 } else {
979 None
980 }
981}
982
983/// Parse the per-service VIP map this node hosts from the `service-host` node-capability value(s).
984/// Each value is the raw JSON text of a [`ts_control_serde::ServiceIpMappings`] object (svc-name ->
985/// VIP IPs); unparseable values are skipped (fail-closed: a malformed mapping contributes no VIPs).
986/// Per-service IP lists are deduplicated, source order otherwise preserved.
987fn service_vips_from_cap_map(
988 cap_map: &NodeCapMap,
989) -> alloc::collections::BTreeMap<String, Vec<IpAddr>> {
990 let mut out: alloc::collections::BTreeMap<String, Vec<IpAddr>> =
991 alloc::collections::BTreeMap::new();
992 let Some(values) = cap_map.get(ts_control_serde::NODE_ATTR_SERVICE_HOST) else {
993 return out;
994 };
995
996 for raw in values {
997 let Ok(mappings) = serde_json::from_str::<ts_control_serde::ServiceIpMappings>(raw) else {
998 continue;
999 };
1000 for (name, addrs) in &mappings.0 {
1001 let entry = out.entry((*name).to_string()).or_default();
1002 for addr in addrs {
1003 if !entry.contains(addr) {
1004 entry.push(*addr);
1005 }
1006 }
1007 }
1008 }
1009 out
1010}
1011
1012/// Collect a wire ([`ts_control_serde`]) node cap map into an owned [`NodeCapMap`].
1013///
1014/// Keys are copied as owned strings; each value's raw JSON text is preserved verbatim. The wire map
1015/// borrows from the decode buffer, so an owned copy is required to outlive it on the domain
1016/// [`Node`].
1017fn cap_map_from_serde(wire: &ts_nodecapability::Map<'_>) -> NodeCapMap {
1018 wire.iter()
1019 .map(|(&key, values)| {
1020 let owned_values = values.0.iter().map(|v| v.get().to_owned()).collect();
1021 (key.to_owned(), owned_values)
1022 })
1023 .collect()
1024}
1025
1026/// Extract the advertised IPv4 peerAPI port and whether the explicit `peerapi-dns-proxy` service is
1027/// advertised, from a peer's `HostInfo.Services` list.
1028fn peerapi_from_services(
1029 services: Option<&[ts_control_serde::Service<'_>]>,
1030) -> (Option<u16>, bool) {
1031 use ts_control_serde::ServiceProto;
1032
1033 let Some(services) = services else {
1034 return (None, false);
1035 };
1036 let mut port = None;
1037 let mut dns_proxy = false;
1038 for svc in services {
1039 match svc.proto {
1040 ServiceProto::PeerApi4 => port = Some(svc.port),
1041 ServiceProto::PeerApiDnsProxy => dns_proxy = true,
1042 _ => {}
1043 }
1044 }
1045 (port, dns_proxy)
1046}
1047
1048/// Addresses for a node within a tailnet.
1049#[derive(Debug, Clone, PartialEq, Eq, Hash)]
1050pub struct TailnetAddress {
1051 /// The IPv4 address of the node in the tailnet.
1052 pub ipv4: ipnet::Ipv4Net,
1053 /// The IPv6 address of the node in the tailnet.
1054 pub ipv6: ipnet::Ipv6Net,
1055}
1056
1057impl TailnetAddress {
1058 /// Report whether `addr` matches either address in this [`TailnetAddress`].
1059 pub fn contains(&self, addr: IpAddr) -> bool {
1060 match addr {
1061 IpAddr::V4(a) => self.ipv4.addr() == a,
1062 IpAddr::V6(a) => self.ipv6.addr() == a,
1063 }
1064 }
1065}
1066
1067impl From<&ts_control_serde::Node<'_>> for Node {
1068 fn from(value: &ts_control_serde::Node) -> Self {
1069 let fqdn_without_trailing_dot = value.name.strip_suffix('.').unwrap_or(&value.name);
1070
1071 let (hostname, tailnet) = match fqdn_without_trailing_dot.split_once('.') {
1072 Some((hostname, tailnet)) => (hostname, Some(tailnet.to_owned())),
1073 None => (fqdn_without_trailing_dot, None),
1074 };
1075
1076 let (peerapi_port, peerapi_dns_proxy) =
1077 peerapi_from_services(value.host_info.services.as_deref());
1078
1079 let cap_map = cap_map_from_serde(&value.cap_map);
1080 let service_vips = service_vips_from_cap_map(&cap_map);
1081
1082 // `addresses` is a variable-length `Vec<IpNet>` on the wire (Go `[]netip.Prefix`), not a
1083 // fixed (v4, v6) pair: an IPv6-off tailnet assigns only a v4 prefix. The whole list is kept
1084 // verbatim on `Node::addresses` (Go's `Node.Addresses`, which `IsRouter` tests routes
1085 // against); `tailnet_address` is the identity projection. Pick the first of each
1086 // family. The v4 prefix is the node's tailnet identity (always present on a normal node);
1087 // if somehow absent we fall back to the unspecified `0.0.0.0/32` rather than panicking.
1088 // The v6 prefix is optional — when the tailnet is IPv4-only there is none, and the overlay
1089 // never reads `ipv6` in that mode (gated on `enable_ipv6`); we synthesize the unspecified
1090 // `::/128` placeholder so the domain `TailnetAddress` stays infallible.
1091 let ipv4 = value
1092 .addresses
1093 .iter()
1094 .find_map(|p| match p {
1095 ipnet::IpNet::V4(n) => Some(*n),
1096 ipnet::IpNet::V6(_) => None,
1097 })
1098 .unwrap_or_else(|| ipnet::Ipv4Net::new(core::net::Ipv4Addr::UNSPECIFIED, 32).unwrap());
1099 let ipv6 = value
1100 .addresses
1101 .iter()
1102 .find_map(|p| match p {
1103 ipnet::IpNet::V6(n) => Some(*n),
1104 ipnet::IpNet::V4(_) => None,
1105 })
1106 .unwrap_or_else(|| ipnet::Ipv6Net::new(core::net::Ipv6Addr::UNSPECIFIED, 128).unwrap());
1107
1108 Self {
1109 id: value.id,
1110 stable_id: StableId(value.stable_id.0.to_string()),
1111
1112 hostname: hostname.to_owned(),
1113 user_id: value.user,
1114 tailnet,
1115
1116 tags: value
1117 .tags
1118 .as_ref()
1119 .map(|x| x.iter().map(|x| x.to_string()).collect())
1120 .unwrap_or_default(),
1121
1122 addresses: value.addresses.clone(),
1123 tailnet_address: TailnetAddress { ipv4, ipv6 },
1124 node_key: value.key,
1125 node_key_expiry: value.key_expiry,
1126 // Control's own verdict, carried verbatim; `ExpiryManager` only ever raises it.
1127 expired: value.expired,
1128 online: value.online,
1129 last_seen: value.last_seen,
1130 key_signature: value.key_signature.to_vec(),
1131 machine_key: value.machine,
1132 disco_key: value.disco_key,
1133
1134 unsigned_peer_api_only: value.unsigned_peer_api_only,
1135
1136 // Per capver-112, `AllowedIPs` null/absent means "same as `addresses`". Fall back to the
1137 // node's own assigned prefixes verbatim (whatever families the wire carried), not a
1138 // synthesized v4+v6 pair.
1139 //
1140 // `UnsignedPeerAPIOnly` clamps the result back to `addresses` whatever control sent,
1141 // mirroring Go's `upgradeNode` (`control/controlclient/map.go`): such a node is outside
1142 // tailnet lock's coverage, so a possibly-malicious control server must not be able to
1143 // grant it network access by handing it advertised routes (in the limit, `0.0.0.0/0`).
1144 // Unconditional, exactly as upstream — it does not depend on tailnet lock being
1145 // enabled here.
1146 accepted_routes: if value.unsigned_peer_api_only {
1147 value.addresses.clone()
1148 } else {
1149 value
1150 .allowed_ips
1151 .clone()
1152 .unwrap_or_else(|| value.addresses.clone())
1153 },
1154 underlay_addresses: value.endpoints.clone(),
1155
1156 // legacy_derp_string is still in practical use as of 3/2026
1157 #[allow(deprecated)]
1158 derp_region: value
1159 .home_derp
1160 .or(value.legacy_derp_string)
1161 .or_else(|| value.host_info.net_info.as_ref()?.preferred_derp)
1162 .map(|x| ts_derp::RegionId(x.into())),
1163
1164 cap: value.cap,
1165 cap_map,
1166 peerapi_port,
1167 peerapi_dns_proxy,
1168 is_wireguard_only: value.is_wireguard_only,
1169 exit_node_dns_resolvers: value
1170 .exit_node_dns_resolvers
1171 .iter()
1172 .filter_map(Resolver::from_serde)
1173 .collect(),
1174 peer_relay: value.host_info.peer_relay,
1175 // Project the advertised SSH host keys (Go `Hostinfo.SSHHostKeys`), mapping the
1176 // borrowed `Option<Vec<&str>>` to owned `Vec<String>`; absent ⇒ empty (never
1177 // fabricated), matching how `services`/`peer_relay` above are projected from host_info.
1178 ssh_host_keys: value
1179 .host_info
1180 .ssh_host_keys
1181 .as_ref()
1182 .map(|keys| keys.iter().map(|k| k.to_string()).collect())
1183 .unwrap_or_default(),
1184 service_vips,
1185 }
1186 }
1187}
1188
1189/// An incremental update to a single already-known peer [`Node`], carried in
1190/// [`MapResponse::peers_changed_patch`][ts_control_serde::MapResponse::peers_changed_patch].
1191///
1192/// Control sends a patch (rather than a full node in `peers_changed`) when only a peer's
1193/// reachability changes mid-session — most importantly its UDP `endpoints`
1194/// and home [`derp_region`][PeerChange::derp_region] when an idle peer re-establishes connectivity.
1195/// Every field is `Option`: a patch sets only the fields it carries and leaves the rest of the
1196/// target node unchanged (see `PeerTracker::apply_peer_update` for the merge). Owned counterpart
1197/// of the borrow-bound [`ts_control_serde::PeerChange`]; the fields that map onto a domain
1198/// [`Node`] field are retained, including control's `online`/`last_seen` liveness deltas — the
1199/// dominant channel by which peer online transitions are delivered (see [`Node::online`]).
1200#[derive(Debug, Clone, PartialEq, Eq)]
1201pub struct PeerChange {
1202 /// The [`Node::id`] of the peer being mutated. If no peer with this id is in the current
1203 /// netmap, the patch is ignored (the wire contract — a patch never creates a node).
1204 pub id: Id,
1205 /// If `Some`, the peer's new home DERP region.
1206 pub derp_region: Option<ts_derp::RegionId>,
1207 /// If `Some`, the peer's new advertised capability version.
1208 pub cap: Option<CapabilityVersion>,
1209 /// If `Some`, the peer's new capability map (replaces the prior map wholesale).
1210 pub cap_map: Option<NodeCapMap>,
1211 /// If `Some`, the peer's new UDP underlay endpoints (`Endpoints` in Go; replaces the prior
1212 /// set). This is the field that lets magicsock re-handshake a peer that moved.
1213 pub underlay_addresses: Option<Vec<SocketAddr>>,
1214 /// If `Some`, the peer's new WireGuard public key (key rotation).
1215 pub node_key: Option<NodePublicKey>,
1216 /// If `Some`, the marshalled TKA signature over the new node key. Re-verified at the
1217 /// peer-trust chokepoint when tailnet-lock enforcement is active.
1218 pub key_signature: Option<Vec<u8>>,
1219 /// If `Some`, the peer's new disco public key.
1220 pub disco_key: Option<DiscoPublicKey>,
1221 /// If `Some`, the peer's new node-key expiry (`KeyExpiry` in Go). Maps to
1222 /// [`Node::node_key_expiry`]; carried so an expiry-only patch isn't lost until the next full
1223 /// resync.
1224 pub node_key_expiry: Option<DateTime<Utc>>,
1225 /// If `Some`, the peer's new online status (`PeerChange.Online`). `None` here means "this patch
1226 /// did not touch online", **not** "offline" — the merge sets [`Node::online`] only when present.
1227 pub online: Option<bool>,
1228 /// If `Some`, the peer's new last-seen time (`PeerChange.LastSeen`). Maps to [`Node::last_seen`].
1229 pub last_seen: Option<DateTime<Utc>>,
1230}
1231
1232impl From<&ts_control_serde::PeerChange<'_>> for PeerChange {
1233 fn from(value: &ts_control_serde::PeerChange) -> Self {
1234 Self {
1235 id: value.node_id,
1236 derp_region: value.derp_region.map(|x| ts_derp::RegionId(x.into())),
1237 cap: value.cap,
1238 cap_map: value.cap_map.as_ref().map(cap_map_from_serde),
1239 underlay_addresses: value.endpoints.clone(),
1240 node_key: value.key,
1241 key_signature: value.key_signature.map(|s| s.to_vec()),
1242 disco_key: value.disco_key,
1243 node_key_expiry: value.key_expiry,
1244 online: value.online,
1245 last_seen: value.last_seen,
1246 }
1247 }
1248}
1249
1250/// Identity of the user that owns a [`Node`], resolved from the netmap's `UserProfiles` table
1251/// (Go `tailcfg.UserProfile`). Owned counterpart of the borrow-bound
1252/// [`ts_control_serde::UserProfile`]. Keyed by [`UserProfile::id`] (== [`Node::user_id`]).
1253///
1254/// Mostly display-friendly text ([`login_name`](Self::login_name),
1255/// [`display_name`](Self::display_name)), plus [`groups`](Self::groups) — the one attribute here an
1256/// embedder can *authorise* on, because it is the one a node cannot re-derive from anything else
1257/// control sends.
1258#[derive(Debug, Clone, PartialEq, Eq)]
1259pub struct UserProfile {
1260 /// The integer id of the Tailscale user this profile describes (matches [`Node::user_id`]).
1261 pub id: ts_control_serde::UserId,
1262 /// An email-ish login name for display (e.g. `alice@example.com` / `alice@github`). May be
1263 /// empty if control sent none.
1264 pub login_name: String,
1265 /// The user's display name (e.g. `Alice Smith`), if the IdP provided one.
1266 pub display_name: Option<String>,
1267 /// The groups that contain this user and that the coordination server was configured to report
1268 /// to this node (Go `tailcfg.UserProfile.Groups`): SCIM groups (e.g.
1269 /// `engineering@example.com`) or tailnet-policy group names (e.g. `group:eng`).
1270 ///
1271 /// Carried in the order control sent it (control sorts it when it loads the profile from
1272 /// storage). **Empty** when control reported no groups — including every control server older
1273 /// than the field, which omits it entirely. An empty list therefore means "control told this
1274 /// node nothing", not "this user is in no group": treat it as no grant, never as a denial you
1275 /// can act on.
1276 pub groups: Vec<String>,
1277}
1278
1279impl From<&ts_control_serde::UserProfile<'_>> for UserProfile {
1280 fn from(value: &ts_control_serde::UserProfile) -> Self {
1281 Self {
1282 id: value.id,
1283 login_name: value.login_name.to_string(),
1284 display_name: value.display_name.as_deref().map(str::to_string),
1285 groups: value.groups.iter().map(|g| g.to_string()).collect(),
1286 }
1287 }
1288}
1289
1290impl UserProfile {
1291 /// The best human-facing label for this user: the login name when present, else the display
1292 /// name, else `None`. This is what a `WhoIs` surfaces as the owning user.
1293 pub fn best_label(&self) -> Option<String> {
1294 if !self.login_name.is_empty() {
1295 Some(self.login_name.clone())
1296 } else {
1297 self.display_name.clone()
1298 }
1299 }
1300}
1301
1302#[cfg(test)]
1303pub(crate) mod tests {
1304 use super::*;
1305
1306 /// The wire `Node.User` id must be carried onto the domain `Node.user_id` by the `From` impl
1307 /// (the field the runtime joins against the netmap `UserProfiles` table for `WhoIs.user`).
1308 /// Guards against the `From` impl wiring the wrong serde field or dropping it.
1309 #[test]
1310 fn from_wire_node_carries_user_id() {
1311 let mut wire = ts_control_serde::Node {
1312 user: 4242,
1313 ..Default::default()
1314 };
1315 wire.name = "host.tail.ts.net.".into();
1316 let domain: Node = (&wire).into();
1317 assert_eq!(domain.user_id, 4242);
1318
1319 // Default (no owner / tagged node) stays 0.
1320 let tagged = ts_control_serde::Node::default();
1321 assert_eq!(Node::from(&tagged).user_id, 0);
1322 }
1323
1324 /// The wire `Hostinfo.sshHostKeys` must be projected onto the domain `Node.ssh_host_keys`
1325 /// (the field `tailscale ssh` reads via `StatusNode` to pin a peer's host key). Present →
1326 /// carried verbatim; absent → empty (never fabricated).
1327 #[test]
1328 fn from_wire_node_carries_ssh_host_keys() {
1329 let wire = ts_control_serde::Node {
1330 host_info: ts_control_serde::HostInfo {
1331 ssh_host_keys: Some(vec![
1332 "ssh-ed25519 AAAAC3Nz host",
1333 "ecdsa-sha2-nistp256 AAAAE2Vj host",
1334 ]),
1335 ..Default::default()
1336 },
1337 ..Default::default()
1338 };
1339 let domain: Node = (&wire).into();
1340 assert_eq!(
1341 domain.ssh_host_keys,
1342 vec![
1343 "ssh-ed25519 AAAAC3Nz host".to_string(),
1344 "ecdsa-sha2-nistp256 AAAAE2Vj host".to_string(),
1345 ]
1346 );
1347
1348 // Absent on the wire → empty Vec, not fabricated.
1349 let bare = ts_control_serde::Node::default();
1350 assert!(Node::from(&bare).ssh_host_keys.is_empty());
1351 }
1352
1353 /// A node from an **IPv4-only** tailnet (IPv6-off control plane / Headscale) carries a
1354 /// single-element `addresses` list. This used to fail deserialization ("invalid length 1,
1355 /// expected a tuple of size 2") when `addresses` was a fixed 2-tuple; it must now parse and
1356 /// derive the v4 identity, with the unused v6 a synthesized placeholder.
1357 #[test]
1358 fn from_wire_node_ipv4_only_addresses() {
1359 let wire = ts_control_serde::Node {
1360 addresses: vec!["100.64.0.5/32".parse().unwrap()],
1361 ..Default::default()
1362 };
1363 let domain: Node = (&wire).into();
1364 assert_eq!(
1365 domain.tailnet_address.ipv4,
1366 "100.64.0.5/32".parse().unwrap()
1367 );
1368 // No v6 on the wire → unspecified placeholder (never read in IPv4-only mode).
1369 assert_eq!(
1370 domain.tailnet_address.ipv6,
1371 ipnet::Ipv6Net::new(core::net::Ipv6Addr::UNSPECIFIED, 128).unwrap()
1372 );
1373 // AllowedIPs absent → falls back to the node's own assigned prefixes (just the v4 here).
1374 assert_eq!(
1375 domain.accepted_routes,
1376 vec!["100.64.0.5/32".parse::<ipnet::IpNet>().unwrap()]
1377 );
1378 }
1379
1380 /// A dual-stack node carries both families (any order); the domain picks the first of each.
1381 #[test]
1382 fn from_wire_node_dual_stack_addresses() {
1383 let wire = ts_control_serde::Node {
1384 addresses: vec![
1385 "100.64.0.7/32".parse().unwrap(),
1386 "fd7a:115c:a1e0::7/128".parse().unwrap(),
1387 ],
1388 ..Default::default()
1389 };
1390 let domain: Node = (&wire).into();
1391 assert_eq!(
1392 domain.tailnet_address.ipv4,
1393 "100.64.0.7/32".parse().unwrap()
1394 );
1395 assert_eq!(
1396 domain.tailnet_address.ipv6,
1397 "fd7a:115c:a1e0::7/128".parse().unwrap()
1398 );
1399 }
1400
1401 /// A wire peer that owns `100.64.0.9/32` and is handed `route` plus the default route in its
1402 /// `AllowedIPs`. `unsigned` sets `UnsignedPeerAPIOnly`; everything else is identical between
1403 /// the two, so the only variable in the test below is that flag.
1404 fn wire_peer_advertising(
1405 stable_id: &'static str,
1406 route: &str,
1407 unsigned: bool,
1408 ) -> ts_control_serde::Node<'static> {
1409 ts_control_serde::Node {
1410 stable_id: ts_control_serde::StableNodeId(stable_id),
1411 addresses: vec!["100.64.0.9/32".parse().unwrap()],
1412 allowed_ips: Some(vec![
1413 "100.64.0.9/32".parse().unwrap(),
1414 route.parse().unwrap(),
1415 "0.0.0.0/0".parse().unwrap(),
1416 ]),
1417 unsigned_peer_api_only: unsigned,
1418 ..Default::default()
1419 }
1420 }
1421
1422 /// `UnsignedPeerAPIOnly` must clamp a peer's accepted routes back to its own addresses, so a
1423 /// control server cannot grant an unsigned (lock-exempt) peer network access via advertised
1424 /// routes. Mirrors Go's `upgradeNode` in `control/controlclient/map.go`.
1425 ///
1426 /// The signed peer is the control: it advertises the **same** route and the same default route,
1427 /// and keeps both. Without it this test would still pass if the `From` impl simply dropped every
1428 /// advertised route.
1429 #[test]
1430 fn from_wire_unsigned_peer_api_only_clamps_routes_to_own_addresses() {
1431 let own: ipnet::IpNet = "100.64.0.9/32".parse().unwrap();
1432 let subnet: ipnet::IpNet = "192.0.2.0/24".parse().unwrap();
1433 let default_route: ipnet::IpNet = "0.0.0.0/0".parse().unwrap();
1434
1435 let unsigned: Node = (&wire_peer_advertising("nUnsigned", "192.0.2.0/24", true)).into();
1436 let signed: Node = (&wire_peer_advertising("nSigned", "192.0.2.0/24", false)).into();
1437
1438 // The flag is carried onto the domain node, not silently dropped.
1439 assert!(unsigned.unsigned_peer_api_only);
1440 assert!(!signed.unsigned_peer_api_only);
1441
1442 // Unsigned: clamped to its own addresses. The advertised subnet and the default route are
1443 // both gone, whatever control sent.
1444 assert_eq!(unsigned.accepted_routes, vec![own]);
1445
1446 // Signed: the identical advertisement survives verbatim.
1447 assert_eq!(
1448 signed.accepted_routes,
1449 vec![own, subnet, default_route],
1450 "the clamp must be specific to UnsignedPeerAPIOnly, not a blanket route drop"
1451 );
1452
1453 // Consequences the rest of the fork reads. `is_router` reports the unsigned peer routes
1454 // nothing but itself...
1455 assert!(!unsigned.is_router());
1456 assert!(signed.is_router());
1457
1458 // ...and no route-install policy can resurrect the advertisement: even with
1459 // `--accept-routes` on AND the peer selected as the exit node — the most permissive input
1460 // `routes_to_install` accepts — the unsigned peer yields only its own address.
1461 let installed: Vec<_> = unsigned
1462 .routes_to_install(true, Some(&unsigned.stable_id))
1463 .copied()
1464 .collect();
1465 assert_eq!(installed, vec![own]);
1466
1467 // The same permissive inputs against the signed peer do install the subnet and the /0,
1468 // proving the difference is the flag and not the policy arguments.
1469 let installed_signed: Vec<_> = signed
1470 .routes_to_install(true, Some(&signed.stable_id))
1471 .copied()
1472 .collect();
1473 assert_eq!(installed_signed, vec![own, subnet, default_route]);
1474 }
1475
1476 /// The wire default (`UnsignedPeerAPIOnly` absent) must leave `AllowedIPs` untouched, including
1477 /// the capver-112 "null AllowedIPs means the node's own addresses" fallback. Guards against the
1478 /// clamp being applied on the wrong branch.
1479 #[test]
1480 fn from_wire_default_is_not_clamped() {
1481 let wire = ts_control_serde::Node {
1482 addresses: vec!["100.64.0.9/32".parse().unwrap()],
1483 allowed_ips: Some(vec!["198.51.100.0/24".parse().unwrap()]),
1484 ..Default::default()
1485 };
1486 assert!(!wire.unsigned_peer_api_only);
1487 let domain: Node = (&wire).into();
1488 assert_eq!(
1489 domain.accepted_routes,
1490 vec!["198.51.100.0/24".parse::<ipnet::IpNet>().unwrap()]
1491 );
1492 }
1493
1494 /// An unsigned peer with **no** `AllowedIPs` on the wire still lands on its own addresses (the
1495 /// clamp and the capver-112 fallback agree), and a multi-prefix unsigned peer keeps *all* of
1496 /// its assigned prefixes — the clamp is to `Addresses`, not to the v4/v6 identity pair.
1497 #[test]
1498 fn from_wire_unsigned_peer_clamp_keeps_every_assigned_prefix() {
1499 let wire = ts_control_serde::Node {
1500 addresses: vec![
1501 "100.64.0.9/32".parse().unwrap(),
1502 "fd7a:115c:a1e0::9/128".parse().unwrap(),
1503 ],
1504 allowed_ips: None,
1505 unsigned_peer_api_only: true,
1506 ..Default::default()
1507 };
1508 let domain: Node = (&wire).into();
1509 assert_eq!(
1510 domain.accepted_routes,
1511 vec![
1512 "100.64.0.9/32".parse::<ipnet::IpNet>().unwrap(),
1513 "fd7a:115c:a1e0::9/128".parse::<ipnet::IpNet>().unwrap(),
1514 ]
1515 );
1516 assert!(!domain.is_router());
1517 }
1518
1519 /// The deserialization regression itself: a MapResponse-style Node JSON with a 1-element
1520 /// `Addresses` array must parse (this is the exact shape the dev-Headscale sends).
1521 #[test]
1522 fn deserialize_node_with_single_address() {
1523 let json = r#"{
1524 "ID": 1,
1525 "StableID": "n1",
1526 "Name": "host.tail.ts.net.",
1527 "User": 1,
1528 "Addresses": ["100.64.0.9/32"],
1529 "Key": "nodekey:0000000000000000000000000000000000000000000000000000000000000000",
1530 "Machine": null,
1531 "DiscoKey": null,
1532 "AllowedIPs": null,
1533 "Endpoints": []
1534 }"#;
1535 let wire: ts_control_serde::Node = serde_json::from_str(json).expect("1-addr node parses");
1536 assert_eq!(wire.addresses.len(), 1);
1537 let domain: Node = (&wire).into();
1538 assert_eq!(
1539 domain.tailnet_address.ipv4,
1540 "100.64.0.9/32".parse().unwrap()
1541 );
1542 }
1543
1544 /// The consume side end to end: a MapResponse-shaped wire Node carrying a
1545 /// `services/<opaque-id>` capability decodes into the domain node, and the service — including
1546 /// an action type this build has never heard of — is surfaced rather than dropping the node.
1547 #[test]
1548 fn visible_services_parse_from_the_services_cap() {
1549 let json = r#"{
1550 "ID": 1,
1551 "StableID": "n1",
1552 "Name": "host.tail.ts.net.",
1553 "User": 1,
1554 "Addresses": ["100.64.0.9/32"],
1555 "Key": "nodekey:0000000000000000000000000000000000000000000000000000000000000000",
1556 "Machine": null,
1557 "DiscoKey": null,
1558 "AllowedIPs": null,
1559 "Endpoints": [],
1560 "CapMap": {
1561 "services/01HQ": [{
1562 "Name": "svc:postgres",
1563 "DisplayName": "Analytics DB",
1564 "Addrs": ["100.65.32.7"],
1565 "Ports": ["tcp:5432", "tcp:22"],
1566 "Actions": [
1567 {
1568 "Type": "postgresql",
1569 "Port": 5432,
1570 "Attributes": {
1571 "tailscale.com/cap/resource-name": "metrics"
1572 }
1573 },
1574 { "Type": "ftp", "Port": 22 }
1575 ]
1576 }],
1577 "services/01HR": [{ "Name": "svc:web", "Ports": ["tcp:80"] }]
1578 }
1579 }"#;
1580 let wire: ts_control_serde::Node =
1581 serde_json::from_str(json).expect("a node advertising services parses");
1582 let domain: Node = (&wire).into();
1583
1584 let services = domain.visible_services();
1585 assert_eq!(services.len(), 2);
1586
1587 let pg = &services[0];
1588 assert_eq!(pg.name.0, "svc:postgres");
1589 assert_eq!(pg.display_name, "Analytics DB");
1590 assert_eq!(pg.addrs, vec!["100.65.32.7".parse::<IpAddr>().unwrap()]);
1591 assert_eq!(pg.ports.len(), 2);
1592 // Both actions survive decoding, the unrecognized slug included.
1593 assert_eq!(pg.actions.len(), 2);
1594 assert_eq!(
1595 pg.actions[0].action_type,
1596 ts_control_serde::SERVICE_ACTION_TYPE_POSTGRESQL
1597 );
1598 assert_eq!(
1599 pg.actions[0].attributes[ts_control_serde::SERVICE_ACTION_ATTRIBUTE_RESOURCE_NAME]
1600 .get(),
1601 r#""metrics""#
1602 );
1603 assert!(!pg.actions[1].action_type.is_known());
1604 // …but only the recognized one is offered to a caller about to act on it.
1605 assert_eq!(pg.known_actions().count(), 1);
1606
1607 assert_eq!(services[1].name.0, "svc:web");
1608 assert!(services[1].actions.is_empty());
1609
1610 // The services cap is a consume-side grant only: it does not make this a service host.
1611 assert!(!domain.is_service_host());
1612 }
1613
1614 /// A `services/` value that is not a `ServiceDetails` at all costs only itself: the other
1615 /// services still come back, and the node is still usable.
1616 #[test]
1617 fn visible_services_skips_an_unparseable_value() {
1618 let mut n = node("peer", Some("ts.net"));
1619 n.cap_map.insert(
1620 "services/broken".to_string(),
1621 vec!["\"not an object\"".to_string()],
1622 );
1623 n.cap_map.insert(
1624 "services/good".to_string(),
1625 vec![r#"{"Name":"svc:web","Ports":["tcp:80"]}"#.to_string()],
1626 );
1627
1628 let services = n.visible_services();
1629 assert_eq!(services.len(), 1);
1630 assert_eq!(services[0].name.0, "svc:web");
1631 }
1632
1633 /// No services cap at all is the common case and yields nothing, not an error.
1634 #[test]
1635 fn visible_services_empty_without_the_cap() {
1636 let n = node("peer", Some("ts.net"));
1637 assert!(n.visible_services().is_empty());
1638 }
1639
1640 #[test]
1641 fn key_expiry_semantics() {
1642 let now: DateTime<Utc> = "2026-06-05T00:00:00Z".parse().unwrap();
1643 let past: DateTime<Utc> = "2020-01-01T00:00:00Z".parse().unwrap();
1644 let future: DateTime<Utc> = "2099-01-01T00:00:00Z".parse().unwrap();
1645
1646 let mut n = node("h", Some("t.ts.net"));
1647
1648 // No expiry set => never expired (Go zero-value semantics).
1649 n.node_key_expiry = None;
1650 assert!(!n.key_expired(now));
1651 assert_eq!(n.key_expiry(), None);
1652
1653 // Future expiry => not yet expired.
1654 n.node_key_expiry = Some(future);
1655 assert!(!n.key_expired(now));
1656 assert_eq!(n.key_expiry(), Some(future));
1657
1658 // Past expiry => expired.
1659 n.node_key_expiry = Some(past);
1660 assert!(n.key_expired(now));
1661 }
1662
1663 #[test]
1664 fn key_expiry_unix_agrees_with_chrono() {
1665 // The chrono-free variants (`key_expired_at_unix` / `key_expiry_unix`) must agree with the
1666 // chrono variants for the same none/future/past cases (Unix seconds of the same instants).
1667 let now: DateTime<Utc> = "2026-06-05T00:00:00Z".parse().unwrap();
1668 let past: DateTime<Utc> = "2020-01-01T00:00:00Z".parse().unwrap();
1669 let future: DateTime<Utc> = "2099-01-01T00:00:00Z".parse().unwrap();
1670 let now_unix = now.timestamp();
1671
1672 let mut n = node("h", Some("t.ts.net"));
1673
1674 // No expiry => never expired; the unix accessor reports `None`.
1675 n.node_key_expiry = None;
1676 assert_eq!(n.key_expired(now), n.key_expired_at_unix(now_unix));
1677 assert!(!n.key_expired_at_unix(now_unix));
1678 assert_eq!(n.key_expiry_unix(), None);
1679
1680 // Future expiry => not yet expired; unix accessor matches the chrono timestamp.
1681 n.node_key_expiry = Some(future);
1682 assert_eq!(n.key_expired(now), n.key_expired_at_unix(now_unix));
1683 assert!(!n.key_expired_at_unix(now_unix));
1684 assert_eq!(n.key_expiry_unix(), Some(future.timestamp()));
1685
1686 // Past expiry => expired; unix accessor matches the chrono timestamp.
1687 n.node_key_expiry = Some(past);
1688 assert_eq!(n.key_expired(now), n.key_expired_at_unix(now_unix));
1689 assert!(n.key_expired_at_unix(now_unix));
1690 assert_eq!(n.key_expiry_unix(), Some(past.timestamp()));
1691 }
1692
1693 #[test]
1694 fn key_expiry_boundary_is_not_expired() {
1695 // A key whose expiry exactly equals `now` is NOT expired: the code uses strict `<`, matching
1696 // Go's `Before`. Both the chrono and chrono-free variants must agree at the boundary.
1697 let now: DateTime<Utc> = "2026-06-05T00:00:00Z".parse().unwrap();
1698 let now_unix = now.timestamp();
1699
1700 let mut n = node("h", Some("t.ts.net"));
1701 n.node_key_expiry = Some(now);
1702
1703 assert!(!n.key_expired(now));
1704 assert!(!n.key_expired_at_unix(now_unix));
1705 }
1706
1707 #[test]
1708 fn is_peer_relay_returns_field() {
1709 let mut n = node("h", Some("t.ts.net"));
1710
1711 n.peer_relay = true;
1712 assert!(n.is_peer_relay());
1713
1714 n.peer_relay = false;
1715 assert!(!n.is_peer_relay());
1716 }
1717
1718 /// A minimal well-formed peer, shared with the `expiry` module's tests so both reason about
1719 /// the same node shape.
1720 pub(crate) fn test_node() -> Node {
1721 node("h", Some("t.ts.net"))
1722 }
1723
1724 fn node(hostname: &str, tailnet: Option<&str>) -> Node {
1725 Node {
1726 id: 1,
1727 stable_id: StableId("n1".to_string()),
1728 hostname: hostname.to_string(),
1729 user_id: 0,
1730 tailnet: tailnet.map(str::to_string),
1731 tags: vec![],
1732 addresses: vec![
1733 "100.64.0.1/32".parse().unwrap(),
1734 "fd7a::1/128".parse().unwrap(),
1735 ],
1736 tailnet_address: TailnetAddress {
1737 ipv4: "100.64.0.1/32".parse().unwrap(),
1738 ipv6: "fd7a::1/128".parse().unwrap(),
1739 },
1740 node_key: [0u8; 32].into(),
1741 node_key_expiry: None,
1742 expired: false,
1743 online: None,
1744 last_seen: None,
1745 key_signature: vec![],
1746 machine_key: None,
1747 disco_key: None,
1748 accepted_routes: vec![],
1749 underlay_addresses: vec![],
1750 derp_region: None,
1751 cap: CapabilityVersion::default(),
1752 cap_map: NodeCapMap::new(),
1753 peerapi_port: None,
1754 peerapi_dns_proxy: false,
1755 is_wireguard_only: false,
1756 exit_node_dns_resolvers: vec![],
1757 peer_relay: false,
1758 ssh_host_keys: vec![],
1759 service_vips: Default::default(),
1760 unsigned_peer_api_only: false,
1761 }
1762 }
1763
1764 #[test]
1765 fn matches_name_is_case_and_trailing_dot_insensitive() {
1766 let n = node("MyHost", Some("tail-scale.ts.net"));
1767
1768 // bare hostname, any case
1769 assert!(n.matches_name("myhost"));
1770 assert!(n.matches_name("MYHOST"));
1771 assert!(n.matches_name("MyHost"));
1772
1773 // fqdn, any case, with and without trailing dot
1774 assert!(n.matches_name("myhost.tail-scale.ts.net"));
1775 assert!(n.matches_name("MYHOST.TAIL-SCALE.TS.NET"));
1776 assert!(n.matches_name("myhost.tail-scale.ts.net."));
1777 assert!(n.matches_name("MyHost.Tail-Scale.TS.NET."));
1778
1779 // wrong host / wrong tailnet must not match
1780 assert!(!n.matches_name("other"));
1781 assert!(!n.matches_name("myhost.other.ts.net"));
1782 }
1783
1784 #[test]
1785 fn matches_name_no_tailnet() {
1786 let n = node("solo", None);
1787 assert!(n.matches_name("solo"));
1788 assert!(n.matches_name("SOLO."));
1789 assert!(!n.matches_name("solo.ts.net"));
1790 }
1791
1792 #[test]
1793 fn is_tailscale_ip_ranges() {
1794 // CGNAT v4
1795 assert!(is_tailscale_ip("100.64.0.1".parse().unwrap()));
1796 assert!(is_tailscale_ip("100.127.255.254".parse().unwrap()));
1797 // ChromeOS carve-out is excluded
1798 assert!(!is_tailscale_ip("100.115.92.5".parse().unwrap()));
1799 // outside CGNAT
1800 assert!(!is_tailscale_ip("10.0.0.1".parse().unwrap()));
1801 assert!(!is_tailscale_ip("100.128.0.1".parse().unwrap()));
1802 // Tailscale ULA v6
1803 assert!(is_tailscale_ip("fd7a:115c:a1e0::1".parse().unwrap()));
1804 assert!(!is_tailscale_ip("fd00::1".parse().unwrap()));
1805 }
1806
1807 /// Taildrop SSRF guard (defense-in-depth). `Device::send_file` rejects an upload destination
1808 /// unless `is_tailscale_ip(peer.peerapi_addr().ip())` holds. `Device::send_file` itself needs a
1809 /// live runtime (it goes through `self.channel()`), so it can't be unit-tested here; instead we
1810 /// test the exact composition the guard relies on — `is_tailscale_ip ∘ peerapi_addr` — against a
1811 /// `Node` whose `tailnet_address.ipv4` has been corrupted to a non-CGNAT (public) address. A
1812 /// well-formed peer always has a CGNAT 100.64.0.0/10 address, but the guard exists to catch a
1813 /// malformed/hostile node; this proves it would reject one.
1814 #[test]
1815 fn taildrop_ssrf_guard_rejects_non_cgnat_peerapi_addr() {
1816 let mut n = node("evil", Some("ts.net"));
1817 // Corrupt the peer to a public, non-CGNAT address and advertise a peerAPI port so
1818 // `peerapi_addr` returns `Some(_)`.
1819 n.tailnet_address.ipv4 = "1.2.3.4/32".parse().unwrap();
1820 n.peerapi_port = Some(443);
1821
1822 let addr = n
1823 .peerapi_addr()
1824 .expect("peerapi_addr yields Some with a port set");
1825 assert_eq!(addr.ip(), Ipv4Addr::new(1, 2, 3, 4));
1826 // The guard `if !is_tailscale_ip(dst.ip()) { return Err(BadRequest) }` WOULD reject this.
1827 assert!(
1828 !is_tailscale_ip(addr.ip()),
1829 "SSRF guard must reject a peer whose peerAPI addr is not a Tailscale CGNAT IP"
1830 );
1831
1832 // Conversely, a well-formed CGNAT peer passes the guard.
1833 let mut good = node("friend", Some("ts.net"));
1834 good.peerapi_port = Some(443);
1835 let good_addr = good.peerapi_addr().expect("peerapi_addr yields Some");
1836 assert!(is_tailscale_ip(good_addr.ip()));
1837 }
1838
1839 /// Ported from upstream's `TestNodeIsRouter` (`tailcfg/tailcfg_test.go`, `8d830599b`): a node
1840 /// is a router exactly when its `AllowedIPs` reach past its own `Addresses`. The absent case
1841 /// (a plain node advertising only its own addresses) is asserted alongside the present one,
1842 /// since "no routes besides my own" is the answer that must not drift.
1843 #[test]
1844 fn is_router_reports_routes_beyond_own_addresses() {
1845 let v4: ipnet::Ipv4Net = "100.64.0.1/32".parse().unwrap();
1846 let v6: ipnet::Ipv6Net = "fd7a:115c:a1e0::1/128".parse().unwrap();
1847 let self4 = ipnet::IpNet::V4(v4);
1848 let self6 = ipnet::IpNet::V6(v6);
1849
1850 let cases: &[(&str, Vec<ipnet::IpNet>, bool)] = &[
1851 ("empty", vec![], false),
1852 ("plain-ipv4", vec![self4], false),
1853 ("plain-ipv6", vec![self6], false),
1854 ("plain-ipv4-ipv6", vec![self4, self6], false),
1855 ("duplicates", vec![self4, self4], false),
1856 (
1857 "exit-node-ipv4",
1858 vec![self4, "0.0.0.0/0".parse().unwrap()],
1859 true,
1860 ),
1861 ("exit-node-ipv6", vec![self6, "::/0".parse().unwrap()], true),
1862 (
1863 "exit-node-ipv4-ipv6",
1864 vec![
1865 self4,
1866 self6,
1867 "0.0.0.0/0".parse().unwrap(),
1868 "::/0".parse().unwrap(),
1869 ],
1870 true,
1871 ),
1872 (
1873 "subnet-router-ipv4",
1874 vec![self4, "192.0.2.0/24".parse().unwrap()],
1875 true,
1876 ),
1877 (
1878 "subnet-router-ipv6",
1879 vec![self6, "2001:db8::/32".parse().unwrap()],
1880 true,
1881 ),
1882 (
1883 "subnet-router-ipv4-ipv6",
1884 vec![
1885 self4,
1886 self6,
1887 "192.0.2.0/24".parse().unwrap(),
1888 "2001:db8::/32".parse().unwrap(),
1889 ],
1890 true,
1891 ),
1892 // Go's `IsRouter` has no Tailscale-range exception: another peer's /32 is still a
1893 // routed address. This is where it parts ways with `is_subnet_route`.
1894 (
1895 "other-tailnet-host",
1896 vec![self4, "100.64.5.5/32".parse().unwrap()],
1897 true,
1898 ),
1899 ];
1900
1901 for (name, allowed, want) in cases {
1902 let mut n = node("host", Some("ts.net"));
1903 n.addresses = vec![self4, self6];
1904 n.tailnet_address = TailnetAddress { ipv4: v4, ipv6: v6 };
1905 n.accepted_routes = allowed.clone();
1906 assert_eq!(n.is_router(), *want, "{name}");
1907 }
1908 }
1909
1910 /// Go's `IsRouter` tests each `AllowedIPs` prefix against the node's **whole** `Addresses`
1911 /// slice, so every prefix control assigned is "its own". The wire field is a variable-length
1912 /// list, not a v4/v6 pair, so a tailnet may hand a node more than one prefix of a family; such
1913 /// a node must not be reported as a router on account of the extra one — which comparing only
1914 /// against the first-of-family `tailnet_address` pair does. Runs through the production `From`
1915 /// impl so the retention of the full list is pinned along with the predicate.
1916 #[test]
1917 fn is_router_tests_every_assigned_address_not_only_the_first_of_each_family() {
1918 let second4: ipnet::IpNet = "100.64.0.9/32".parse().unwrap();
1919 let second6: ipnet::IpNet = "fd7a:115c:a1e0::9/128".parse().unwrap();
1920 let wire = ts_control_serde::Node {
1921 addresses: vec![
1922 "100.64.0.1/32".parse().unwrap(),
1923 second4,
1924 "fd7a:115c:a1e0::1/128".parse().unwrap(),
1925 second6,
1926 ],
1927 ..Default::default()
1928 };
1929 let domain: Node = (&wire).into();
1930
1931 // The identity projection is still the first prefix of each family...
1932 assert_eq!(
1933 domain.tailnet_address.ipv4,
1934 "100.64.0.1/32".parse().unwrap()
1935 );
1936 // ...but every assigned prefix is retained, and (AllowedIPs absent ⇒ routes are exactly
1937 // the addresses) none of them makes the node a router.
1938 assert_eq!(domain.addresses, wire.addresses);
1939 assert!(
1940 !domain.is_router(),
1941 "a node whose routes are exactly its own assigned prefixes is not a router"
1942 );
1943
1944 // Either second-of-family address on its own is still not a routed prefix.
1945 for extra in [second4, second6] {
1946 let mut n = domain.clone();
1947 n.accepted_routes = vec![extra];
1948 assert!(
1949 !n.is_router(),
1950 "{extra} is one of this node's own addresses"
1951 );
1952 }
1953
1954 // The predicate still fires for a route that does reach past every assigned address.
1955 let mut router = domain.clone();
1956 router.accepted_routes.push("192.0.2.0/24".parse().unwrap());
1957 assert!(router.is_router(), "a real subnet route makes it a router");
1958 }
1959
1960 #[test]
1961 fn is_subnet_route_distinguishes_self_from_subnet() {
1962 let n = node("host", Some("ts.net"));
1963
1964 // The node's own /32 and /128 are self-addresses, not subnet routes.
1965 assert!(!n.is_subnet_route(&"100.64.0.1/32".parse().unwrap()));
1966 assert!(!n.is_subnet_route(&"fd7a::1/128".parse().unwrap()));
1967 // A different single Tailscale IP is still a self-address (Tailscale-assigned host).
1968 assert!(!n.is_subnet_route(&"100.64.5.5/32".parse().unwrap()));
1969 // A LAN /24 the node advertises is a subnet route.
1970 assert!(n.is_subnet_route(&"192.168.1.0/24".parse().unwrap()));
1971 // A single non-Tailscale host IP counts as a subnet route.
1972 assert!(n.is_subnet_route(&"8.8.8.8/32".parse().unwrap()));
1973 // The default route is treated as a subnet route.
1974 assert!(n.is_subnet_route(&"0.0.0.0/0".parse().unwrap()));
1975 assert!(n.is_subnet_route(&"::/0".parse().unwrap()));
1976 }
1977
1978 #[test]
1979 fn routes_to_install_gates_subnets_on_accept_routes() {
1980 let mut n = node("host", Some("ts.net"));
1981 let self4: ipnet::IpNet = "100.64.0.1/32".parse().unwrap();
1982 let self6: ipnet::IpNet = "fd7a::1/128".parse().unwrap();
1983 let subnet: ipnet::IpNet = "192.168.1.0/24".parse().unwrap();
1984 n.accepted_routes = vec![self4, self6, subnet];
1985
1986 // accept_routes off: only the self addresses are installed.
1987 let off: Vec<_> = n.routes_to_install(false, None).copied().collect();
1988 assert_eq!(off, vec![self4, self6]);
1989
1990 // accept_routes on: the advertised subnet is installed too.
1991 let on: Vec<_> = n.routes_to_install(true, None).copied().collect();
1992 assert_eq!(on, vec![self4, self6, subnet]);
1993 }
1994
1995 #[test]
1996 fn routes_to_install_default_route_only_for_selected_exit_node() {
1997 let mut n = node("host", Some("ts.net"));
1998 n.stable_id = StableId("exit1".to_string());
1999 let self4: ipnet::IpNet = "100.64.0.1/32".parse().unwrap();
2000 let default4: ipnet::IpNet = "0.0.0.0/0".parse().unwrap();
2001 let default6: ipnet::IpNet = "::/0".parse().unwrap();
2002 n.accepted_routes = vec![self4, default4, default6];
2003
2004 // No exit node selected: default routes are excluded even with accept_routes on
2005 // (fail-closed — internet-bound traffic has no overlay route and is dropped).
2006 let none_off: Vec<_> = n.routes_to_install(false, None).copied().collect();
2007 assert_eq!(none_off, vec![self4]);
2008 let none_on: Vec<_> = n.routes_to_install(true, None).copied().collect();
2009 assert_eq!(none_on, vec![self4]);
2010
2011 // A *different* peer selected as exit node: this peer still gets no default route.
2012 let other = StableId("exit2".to_string());
2013 let other_sel: Vec<_> = n.routes_to_install(false, Some(&other)).copied().collect();
2014 assert_eq!(other_sel, vec![self4]);
2015
2016 // This peer selected as the exit node: its default routes are installed.
2017 let me = StableId("exit1".to_string());
2018 let sel: Vec<_> = n.routes_to_install(false, Some(&me)).copied().collect();
2019 assert_eq!(sel, vec![self4, default4, default6]);
2020 }
2021
2022 fn exit_node_with(id: &str, ipv4: &str, hostname: &str, tailnet: Option<&str>) -> Node {
2023 let mut n = node(hostname, tailnet);
2024 n.stable_id = StableId(id.to_string());
2025 n.tailnet_address.ipv4 = format!("{ipv4}/32").parse().unwrap();
2026 n
2027 }
2028
2029 #[test]
2030 fn exit_node_selector_resolves_by_id_ip_and_name() {
2031 let a = exit_node_with("nA", "100.64.0.5", "alpha", Some("ts.net"));
2032 let b = exit_node_with("nB", "100.64.0.6", "beta", Some("ts.net"));
2033 let peers = [a, b];
2034 let it = || peers.iter();
2035
2036 // By stable id.
2037 assert_eq!(
2038 ExitNodeSelector::StableId(StableId("nB".into())).resolve(it()),
2039 Some(StableId("nB".into()))
2040 );
2041 // By tailnet IP.
2042 assert_eq!(
2043 ExitNodeSelector::Ip("100.64.0.5".parse().unwrap()).resolve(it()),
2044 Some(StableId("nA".into()))
2045 );
2046 // By MagicDNS name (fqdn, case-insensitive).
2047 assert_eq!(
2048 ExitNodeSelector::Name("BETA.ts.net".into()).resolve(it()),
2049 Some(StableId("nB".into()))
2050 );
2051 // By bare hostname.
2052 assert_eq!(
2053 ExitNodeSelector::Name("alpha".into()).resolve(it()),
2054 Some(StableId("nA".into()))
2055 );
2056 // Unresolvable selector => None (fail-closed at the call site).
2057 assert_eq!(
2058 ExitNodeSelector::Ip("100.64.0.99".parse().unwrap()).resolve(it()),
2059 None
2060 );
2061 assert_eq!(ExitNodeSelector::Name("ghost".into()).resolve(it()), None);
2062 }
2063
2064 #[test]
2065 fn exit_node_selector_resolution_is_deterministic_on_ties() {
2066 // Two peers sharing a name (transient netmap state): the smallest stable id wins, so the
2067 // outbound table and inbound source filter — which resolve independently — agree.
2068 let a = exit_node_with("nZ", "100.64.0.5", "dup", Some("ts.net"));
2069 let b = exit_node_with("nA", "100.64.0.6", "dup", Some("ts.net"));
2070 let peers = [a, b];
2071
2072 assert_eq!(
2073 ExitNodeSelector::Name("dup".into()).resolve(peers.iter()),
2074 Some(StableId("nA".into())),
2075 "smallest stable id wins the tie"
2076 );
2077 // Order of iteration must not change the result.
2078 assert_eq!(
2079 ExitNodeSelector::Name("dup".into()).resolve(peers.iter().rev()),
2080 Some(StableId("nA".into()))
2081 );
2082 }
2083
2084 #[test]
2085 fn peerapi_doh_url_requires_port_and_capability() {
2086 let mut n = node("exit", Some("ts.net"));
2087 n.tailnet_address.ipv4 = "100.64.0.5/32".parse().unwrap();
2088
2089 // No peerAPI port advertised: cannot proxy DNS.
2090 n.peerapi_port = None;
2091 n.cap = CapabilityVersion::V130;
2092 assert_eq!(n.peerapi_doh_url(), None);
2093
2094 // Port advertised but capability too old and no explicit service: cannot proxy.
2095 n.peerapi_port = Some(8080);
2096 n.cap = CapabilityVersion::V25;
2097 n.peerapi_dns_proxy = false;
2098 assert_eq!(n.peerapi_doh_url(), None);
2099
2100 // Port + new-enough capability: yields the DoH URL on the IPv4 address.
2101 n.cap = CapabilityVersion::V26;
2102 assert_eq!(
2103 n.peerapi_doh_url().as_deref(),
2104 Some("http://100.64.0.5:8080/dns-query")
2105 );
2106
2107 // Port + explicit peerapi-dns-proxy service, even with an old capability.
2108 n.cap = CapabilityVersion::V25;
2109 n.peerapi_dns_proxy = true;
2110 assert_eq!(
2111 n.peerapi_doh_url().as_deref(),
2112 Some("http://100.64.0.5:8080/dns-query")
2113 );
2114
2115 // WireGuard-only peers never run a peerAPI: no DoH URL even with a port.
2116 n.is_wireguard_only = true;
2117 assert_eq!(n.peerapi_doh_url(), None);
2118 }
2119
2120 #[test]
2121 fn peerapi_doh_addr_matches_url_gate() {
2122 let mut n = node("exit", Some("ts.net"));
2123 n.tailnet_address.ipv4 = "100.64.0.5/32".parse().unwrap();
2124 n.peerapi_port = Some(8080);
2125 n.cap = CapabilityVersion::V26;
2126
2127 // The addr form the DoH client dials is the same gated endpoint as the URL.
2128 assert_eq!(
2129 n.peerapi_doh_addr(),
2130 Some("100.64.0.5:8080".parse().unwrap())
2131 );
2132 // And it composes into exactly the URL form.
2133 assert_eq!(
2134 n.peerapi_doh_url().as_deref(),
2135 Some("http://100.64.0.5:8080/dns-query")
2136 );
2137
2138 // Gated off the same way: no port => no addr.
2139 n.peerapi_port = None;
2140 assert_eq!(n.peerapi_doh_addr(), None);
2141 }
2142
2143 #[test]
2144 fn peerapi_addr_returns_addr_when_advertised() {
2145 let mut n = node("peer", Some("ts.net"));
2146 n.tailnet_address.ipv4 = "100.64.0.5/32".parse().unwrap();
2147 n.peerapi_port = Some(8089);
2148
2149 // Not gated on the DNS-proxy capability: a plain advertised peerAPI port is enough.
2150 assert_eq!(n.peerapi_addr(), Some("100.64.0.5:8089".parse().unwrap()));
2151 }
2152
2153 #[test]
2154 fn peerapi_addr_none_when_no_port() {
2155 let mut n = node("peer", Some("ts.net"));
2156 n.tailnet_address.ipv4 = "100.64.0.5/32".parse().unwrap();
2157 n.peerapi_port = None;
2158
2159 assert_eq!(n.peerapi_addr(), None);
2160 }
2161
2162 #[test]
2163 fn peerapi_addr_none_for_wireguard_only() {
2164 let mut n = node("peer", Some("ts.net"));
2165 n.tailnet_address.ipv4 = "100.64.0.5/32".parse().unwrap();
2166 n.peerapi_port = Some(8089);
2167 n.is_wireguard_only = true;
2168
2169 // WireGuard-only peers run no peerAPI, even with a port set.
2170 assert_eq!(n.peerapi_addr(), None);
2171 }
2172
2173 #[test]
2174 fn can_share_files_gated_on_self_capability() {
2175 let mut n = node("self", Some("ts.net"));
2176 assert!(
2177 !n.can_share_files(),
2178 "no cap → file sharing not enabled (fail-closed)"
2179 );
2180 n.cap_map
2181 .insert("https://tailscale.com/cap/file-sharing".to_string(), vec![]);
2182 assert!(n.can_share_files(), "the file-sharing cap enables it");
2183 }
2184
2185 #[test]
2186 fn is_file_sharing_target_gated_on_peer_capability() {
2187 let mut n = node("peer", Some("ts.net"));
2188 assert!(
2189 !n.is_file_sharing_target(),
2190 "no cap → not an explicit target"
2191 );
2192 n.cap_map
2193 .insert("tailscale.com/cap/file-sharing-target".to_string(), vec![]);
2194 assert!(
2195 n.is_file_sharing_target(),
2196 "the file-sharing-target cap marks a cross-owner target"
2197 );
2198 }
2199
2200 #[test]
2201 fn resolves_subdomains_gated_on_the_node_attribute() {
2202 let mut n = node("peer", Some("ts.net"));
2203 assert!(
2204 !n.resolves_subdomains(),
2205 "no attribute → not a subdomain host: control has to opt the node in"
2206 );
2207 n.cap_map
2208 .insert("dns-subdomain-resolve".to_string(), vec![]);
2209 assert!(
2210 n.resolves_subdomains(),
2211 "the dns-subdomain-resolve attribute makes this node a subdomain host"
2212 );
2213 }
2214
2215 /// The DNS forwarder's TCP retry is ON by default, so the attribute has to be read as the *off*
2216 /// switch it is: absent means retry. Getting the polarity backwards would silently disable the
2217 /// retry on every tailnet that never set the attribute — the failure the retry exists to remove.
2218 #[test]
2219 fn dns_forwarder_tcp_retries_disabled_only_by_the_node_attribute() {
2220 let mut n = node("peer", Some("ts.net"));
2221 assert!(
2222 !n.disable_dns_forwarder_tcp_retries(),
2223 "no attribute → the retry stays on: this is the off switch, not the on switch"
2224 );
2225 n.cap_map
2226 .insert("dns-forwarder-disable-tcp-retries".to_string(), vec![]);
2227 assert!(
2228 n.disable_dns_forwarder_tcp_retries(),
2229 "the dns-forwarder-disable-tcp-retries attribute turns the TCP retry off"
2230 );
2231 }
2232
2233 /// The debug-always-stun attribute is control's only way to keep the periodic STUN sweep running
2234 /// once the datapath has gone idle, so its key has to be the literal Go sends
2235 /// (`NodeAttrDebugForceBackgroundSTUN`). Absent is the quiet default.
2236 #[test]
2237 fn force_background_stun_gated_on_the_node_attribute() {
2238 let mut n = node("self", Some("ts.net"));
2239 assert!(
2240 !n.force_background_stun(),
2241 "no attribute → the idle stop applies, which is the quiet default"
2242 );
2243 n.cap_map.insert("debug-always-stun".to_string(), vec![]);
2244 assert!(
2245 n.force_background_stun(),
2246 "the debug-always-stun attribute keeps the background sweep running"
2247 );
2248 }
2249
2250 #[test]
2251 fn one_cgnat_is_a_tri_state_read_off_the_query_string_keys() {
2252 let mut n = node("self", Some("ts.net"));
2253 assert_eq!(
2254 n.one_cgnat(),
2255 None,
2256 "neither attribute → control has no opinion, the platform default decides"
2257 );
2258
2259 // The key carries a query string; the bare `one-cgnat` is not the attribute and must not
2260 // be mistaken for either half of the tri-state.
2261 n.cap_map.insert("one-cgnat".to_string(), vec![]);
2262 assert_eq!(
2263 n.one_cgnat(),
2264 None,
2265 "a bare `one-cgnat` key is not one of the two attributes control sets"
2266 );
2267
2268 n.cap_map.insert("one-cgnat?v=false".to_string(), vec![]);
2269 assert_eq!(
2270 n.one_cgnat(),
2271 Some(false),
2272 "`one-cgnat?v=false` declines the forced collapse"
2273 );
2274
2275 n.cap_map.insert("one-cgnat?v=true".to_string(), vec![]);
2276 assert_eq!(
2277 n.one_cgnat(),
2278 Some(true),
2279 "a node holding both attributes collapses: the enabling attribute is checked first"
2280 );
2281
2282 n.cap_map.remove("one-cgnat?v=false");
2283 assert_eq!(
2284 n.one_cgnat(),
2285 Some(true),
2286 "`one-cgnat?v=true` alone collapses"
2287 );
2288 }
2289
2290 #[test]
2291 fn delta_updates_disabled_reads_the_disable_delta_updates_attribute() {
2292 let mut n = node("self", Some("ts.net"));
2293 assert!(
2294 !n.delta_updates_disabled(),
2295 "absent attribute → the incremental path, which is the default"
2296 );
2297
2298 // The attribute is the bare key; the presence of the key is the whole signal, and its
2299 // value (control sends an empty one) is never read.
2300 n.cap_map
2301 .insert("disable-delta-updates".to_string(), vec![]);
2302 assert!(
2303 n.delta_updates_disabled(),
2304 "control granted the attribute → decline the incremental path"
2305 );
2306
2307 n.cap_map.remove("disable-delta-updates");
2308 assert!(
2309 !n.delta_updates_disabled(),
2310 "control withdrawing the attribute returns the node to the incremental path"
2311 );
2312 }
2313
2314 #[test]
2315 fn silent_disco_reads_the_silent_disco_attribute() {
2316 let mut n = node("self", Some("ts.net"));
2317 assert!(
2318 !n.silent_disco(),
2319 "absent attribute → keep heartbeating, which is the default"
2320 );
2321
2322 // The attribute is the bare key; the presence of the key is the whole signal, and its
2323 // value (control sends an empty one) is never read.
2324 n.cap_map.insert("silent-disco".to_string(), vec![]);
2325 assert!(
2326 n.silent_disco(),
2327 "control granted the attribute → stop heartbeating peers"
2328 );
2329
2330 n.cap_map.remove("silent-disco");
2331 assert!(
2332 !n.silent_disco(),
2333 "control withdrawing the attribute returns the node to the heartbeat cadence"
2334 );
2335 }
2336
2337 /// Control's `only-tcp-443` attribute is read off the self node's cap map, and — because
2338 /// upstream's `SetOnlyTCP443` is live rather than start-time — withdrawing it reads back as
2339 /// `false` on the very next netmap.
2340 #[test]
2341 fn only_tcp_443_reads_the_only_tcp_443_attribute() {
2342 let mut n = node("self", Some("ts.net"));
2343 assert!(
2344 !n.only_tcp_443(),
2345 "absent attribute → UDP as before, which is the default"
2346 );
2347
2348 // The attribute is the bare key; the presence of the key is the whole signal, and its
2349 // value (control sends an empty one) is never read.
2350 n.cap_map.insert("only-tcp-443".to_string(), vec![]);
2351 assert!(
2352 n.only_tcp_443(),
2353 "control granted the attribute → this node emits nothing but TCP/443"
2354 );
2355
2356 n.cap_map.remove("only-tcp-443");
2357 assert!(
2358 !n.only_tcp_443(),
2359 "control withdrawing the attribute must restore UDP, with no restart"
2360 );
2361 }
2362
2363 #[test]
2364 fn peerapi_from_services_extracts_v4_port_and_dns_proxy_flag() {
2365 use ts_control_serde::{Service, ServiceProto};
2366
2367 let services = [
2368 Service {
2369 proto: ServiceProto::PeerApi4,
2370 port: 8080,
2371 description: "peerapi".into(),
2372 },
2373 Service {
2374 proto: ServiceProto::PeerApi6,
2375 port: 9090,
2376 description: "peerapi6".into(),
2377 },
2378 Service {
2379 proto: ServiceProto::PeerApiDnsProxy,
2380 port: 1,
2381 description: "dns".into(),
2382 },
2383 ];
2384 let (port, dns_proxy) = peerapi_from_services(Some(&services));
2385 assert_eq!(port, Some(8080), "only the IPv4 peerAPI port is taken");
2386 assert!(dns_proxy);
2387
2388 // No services at all.
2389 assert_eq!(peerapi_from_services(None), (None, false));
2390 }
2391
2392 #[test]
2393 fn exit_node_selector_parses_ip_vs_name() {
2394 assert_eq!(
2395 "100.64.0.5".parse::<ExitNodeSelector>().unwrap(),
2396 ExitNodeSelector::Ip("100.64.0.5".parse().unwrap())
2397 );
2398 assert_eq!(
2399 "fd7a::5".parse::<ExitNodeSelector>().unwrap(),
2400 ExitNodeSelector::Ip("fd7a::5".parse().unwrap())
2401 );
2402 assert_eq!(
2403 "my-exit.ts.net".parse::<ExitNodeSelector>().unwrap(),
2404 ExitNodeSelector::Name("my-exit.ts.net".into())
2405 );
2406 }
2407}