tailscale/lib.rs
1//! A work-in-progress [Tailscale](https://tailscale.com/blog/how-tailscale-works) library.
2//!
3//! `tailscale` allows Rust programs to connect to a tailnet and exchange traffic with peers over
4//! TCP and UDP. It can communicate with other `tailscale`-based peers, `tailscaled` (the Tailscale
5//! Go client), `tsnet`, and `libtailscale` via public DERP servers.
6//!
7//! <div class="warning">
8//! `tailscale` is unstable and insecure.
9//!
10//! We welcome enthusiasm and interest, but please **do not** build production software using these
11//! libraries or rely on it for data privacy until we have a chance to batten down some hatches and
12//! complete a third-party audit.
13//!
14//! See the [Caveats section](#caveats) for more details.
15//! </div>
16//!
17//! For language bindings, see the following crates:
18//!
19//! - C: [ts_ffi](https://docs.rs/ts_ffi)
20//! - Python: [ts_python](https://docs.rs/ts_python)
21//! - Elixir: [ts_elixir](https://docs.rs/ts_elixir)
22//!
23//! For instructions on how to run tests, lints, etc., see [CONTRIBUTING.md]. For the high-level
24//! architecture and repository layout, see [ARCHITECTURE.md].
25//!
26//! ## Code Sample
27//!
28//! A simple UDP client that periodically sends messages to a tailnet peer at `100.64.0.1:5678`:
29//!
30//! ```no_run
31//! # use std::{
32//! # time::Duration,
33//! # net::Ipv4Addr,
34//! # error::Error,
35//! # };
36//! #
37//! # #[tokio::main]
38//! # async fn main() -> Result<(), Box<dyn Error>> {
39//! // Open a new connection to the tailnet
40//! let dev = tailscale::Device::new(
41//! &tailscale::Config::default_with_key_file("tsrs_keys.json").await?,
42//! Some("YOUR_AUTH_KEY_HERE".to_owned()),
43//! ).await?;
44//!
45//! // Bind a UDP socket on our tailnet IP, port 1234
46//! let sock = dev.udp_bind((dev.ipv4_addr().await?, 1234).into()).await?;
47//!
48//! // Send a packet containing "hello, world!" to 100.64.0.1:5678 once per second
49//! loop {
50//! sock.send_to((Ipv4Addr::new(100, 64, 0, 1), 5678).into(), b"hello, world!").await?;
51//! tokio::time::sleep(Duration::from_secs(1)).await;
52//! }
53//! # }
54//! ```
55//!
56//! Additional examples of using the `tailscale` crate can be found in the [`examples/`] directory.
57//!
58//! ## Using `tailscale`
59//!
60//! To use this crate or the language bindings, you will need to set the `TS_RS_EXPERIMENT` env var
61//! to `this_is_unstable_software`. We'll remove this requirement after a third-party code/cryptography
62//! audit and any necessary fixes.
63//!
64//! Under the hood, we use Tokio for our async runtime. You must also use Tokio, any kind and most
65//! configurations of Tokio runtimes should work, but there must be one available when you call any
66//! async API functions. The easiest way to do this is to use `#[tokio::main]`, see the
67//! [Tokio docs](https://docs.rs/tokio) for more information. In the future, we would like to limit
68//! our reliance on Tokio so that there are alternatives for users of other async runtimes.
69//!
70//! ## Caveats
71//!
72//! This software is still a work-in-progress! We are providing it in the open at this stage out of
73//! a belief in open-source and to see where the community runs with it, but please be aware of a
74//! few important considerations:
75//!
76//! - This implementation contains unaudited cryptography and hasn't undergone a comprehensive
77//! security analysis. Conservatively, assume there could be a critical security hole meaning
78//! anything you send or receive could be in the clear on the public Internet.
79//! - There are no compatibility guarantees at the moment. This is early-days software - we may
80//! break dependent code in order to get things right.
81//! - Direct peer-to-peer connections via NAT traversal are implemented (STUN-discovered endpoints
82//! and Disco, with `CallMeMaybe` hole-punching over DERP), with DERP relays as the fallback when
83//! no direct path is available. Hard/symmetric NATs get the same single fixed-local-port candidate
84//! (`EndpointSTUN4LocalPort`) Go Tailscale uses; behind a NAT with no static port mapping a flow
85//! may still stay relayed through DERP, which caps its throughput. (Upstream Go does **not** do a
86//! "256-port birthday-paradox spray" — that is a common misconception; the single-candidate guess
87//! is the actual behavior, and this fork matches it.)
88//!
89//! ## Feature Flags
90//!
91//! - `axum`: enables the `axum` module, which enables you to run an `axum` HTTP server on top
92//! of a [`netstack::TcpListener`].
93//!
94//! ## Platform Support
95//!
96//! `tailscale` currently supports the following platforms:
97//!
98//! - Linux (x86_64 and ARM64)
99//! - macOS (ARM64)
100//!
101//! ## Component crates
102//!
103//! The following crates are part of the tailscale-rs project and are dependencies of this one. For
104//! many tasks, just this crate should be sufficient and these other crates are an implementation detail.
105//! There are other crates too, see [ARCHITECTURE.md]
106//! or the [GitHub repo](https://github.com/tailscale/tailscale-rs).
107//!
108//! - [ts_runtime](https://docs.rs/ts_runtime): for each API-level `Device`, the runtime uses an actor
109//! architecture to manage the lifecycle of the control client, data plane components, netstack, etc.
110//! A message bus passes updates and communications between these top-level actors.
111//! - [ts_netcheck](https://docs.rs/ts_netcheck): checks network availability and reports latency to
112//! DERP servers in different regions.
113//! - [ts_netstack_smoltcp](https://docs.rs/ts_netstack_smoltcp): a [smoltcp](https://docs.rs/smoltcp)-based
114//! network stack that processes Layer 3+ packets to/from the overlay network.
115//! - [ts_control](https://docs.rs/ts_control): control plane client that handles registration,
116//! authorization/authentication, configuration, and streaming updates.
117//! - [ts_dataplane](https://docs.rs/ts_dataplane): wires all the individual data plane functions together,
118//! flowing inbound and outbound packets through the components in the correct order.
119//! - [ts_tunnel](https://docs.rs/ts_tunnel): a partial implementation of the WireGuard specification
120//! that protects all data plane traffic, and is interoperable with other WireGuard clients, including Tailscale clients.
121//! - [ts_cli_util](https://docs.rs/ts_cli_util): helpers for writing command line tools and initializing
122//! logging, used in examples.
123//! - [ts_disco_protocol](https://docs.rs/ts_disco_protocol): incomplete implementation of Tailscale's
124//! discovery protocol (disco).
125//!
126//! [ARCHITECTURE.md]: https://github.com/tailscale/tailscale-rs/blob/main/ARCHITECTURE.md
127//! [CONTRIBUTING.md]: https://github.com/tailscale/tailscale-rs/blob/main/CONTRIBUTING.md
128//! [`examples/`]: https://github.com/tailscale/tailscale-rs/blob/main/examples/README.md
129//! [open an issue]: https://github.com/tailscale/tailscale-rs/issues
130//! [`axum` HTTP server]: https://docs.rs/axum/latest/axum/
131
132use std::{
133 net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr},
134 time::Duration,
135};
136
137#[doc(inline)]
138pub use config::Config;
139#[doc(inline)]
140pub use error::{Error, InternalErrorKind};
141// Re-exported so a downstream crate depending only on `tailscale` can name the auth-key secret type
142// for [`Device::new_with_secret`] without taking a separate, version-pinned dependency on `secrecy`
143// (which would risk a `SecretString`-type mismatch if the two `secrecy` majors diverged). Callers
144// pass `tailscale::SecretString`; `secrecy` is a pure-Rust wrapper (no aws-lc/openssl/ring).
145pub use secrecy::SecretString;
146#[doc(inline)]
147pub use ts_control::ExitNodeSelector;
148#[doc(inline)]
149pub use ts_control::Node as NodeInfo;
150#[doc(inline)]
151pub use ts_control::tls::{CertifiedKey, TlsAcceptor, TlsStream};
152#[doc(inline)]
153pub use ts_control::{CertError, MISSING_CERT_RPC, ServeConfig, ServeState, ServeTarget};
154/// The netmap DNS configuration returned by [`Device::dns_config`] (Go `netmap.NetworkMap.DNS`).
155#[doc(inline)]
156pub use ts_control::{DnsConfig, DnsResolver, ExtraRecord};
157#[doc(inline)]
158pub use ts_control::{ExitProxyConfig, ExitProxyScheme};
159pub use ts_control::{
160 IdTokenError, LogoutError, ServiceError, ServiceMode, SetDnsError, SetDnsInternalErrorKind,
161 SshAccept, SshAction, SshConnIdentity, SshDecision, SshDenyReason, SshPolicy, SshPrincipal,
162 SshRule, StableNodeId,
163};
164// Re-exported so the application data-path transport can be selected through the `tailscale`
165// facade alone: `Config::transport_mode` is `TransportMode` (default `Netstack`; `Tun(TunConfig {
166// name, mtu })` for a real kernel TUN interface). Both are `pub` in `ts_control` but were not
167// reachable through this facade, forcing downstream crates to depend on `ts_control` directly just
168// to name them.
169pub use ts_control::{TransportMode, TunConfig};
170#[doc(inline)]
171pub use ts_netstack_smoltcp::PingError;
172use ts_netstack_smoltcp::{CreateSocket, netcore::Channel};
173#[doc(inline)]
174pub use ts_runtime::fallback_tcp::{
175 FallbackConnFuture, FallbackConnHandler, FallbackDecision, FallbackTcpHandle,
176};
177#[doc(inline)]
178pub use ts_runtime::taildrop::WaitingFile;
179#[doc(inline)]
180pub use ts_runtime::{
181 DeviceState, DnsQueryResult, ExitNodeSuggestion, FileTarget, IpnBusWatcher, NetcheckReport,
182 Notify, NotifyWatchOpt, RegionLatency, RegistrationError, Status, StatusNode, TkaLogEntry,
183 WhoIs,
184};
185/// The interactive-login URL type returned by [`Device::pop_browser_url`].
186#[doc(inline)]
187pub use url::Url;
188
189#[cfg(feature = "axum")]
190pub mod axum;
191pub mod config;
192mod dial;
193mod error;
194#[cfg(feature = "hyper")]
195pub mod http;
196mod loopback;
197#[cfg(feature = "ssh")]
198pub mod ssh;
199
200#[doc(inline)]
201pub use dial::{ConnectedUdpSocket, DialConn};
202#[doc(inline)]
203pub use loopback::LoopbackHandle;
204
205/// How a program connects to a tailnet and communicates with peers.
206///
207/// The `Device` connects to the control plane, registers itself with the tailnet, and communicates
208/// with tailnet peers. Its tailnet identity is determined by the key state provided at
209/// construction-time.
210pub struct Device {
211 runtime: ts_runtime::Runtime,
212 /// Command channel to the application netstack. `None` in TUN transport mode, where there is
213 /// no userspace application netstack; the channel-driven socket APIs ([`Device::udp_bind`],
214 /// [`Device::tcp_listen`], [`Device::tcp_connect`], [`Device::ping`]) are unsupported there.
215 channel: Option<Channel>,
216 /// Whether IPv6 is enabled on the tailnet overlay (the `Config::enable_ipv6` gate, default
217 /// `false`). Captured at construction; used by [`Device::listen_service`] to decide whether an
218 /// IPv6 VIP-service address is bindable (the netstack only accepts IPv6 overlay addresses when
219 /// this is set).
220 enable_ipv6: bool,
221 /// The stored Serve config + its live per-port accept loops (`tsnet`'s `Get/SetServeConfig` +
222 /// serving runtime). Built lazily on the first [`Device::set_serve_config`] (it needs this
223 /// node's overlay IPv4, only known after registration). Held here so its accept loops abort when
224 /// the `Device` drops; `None` (empty config) until the first `set`.
225 serve: std::sync::Mutex<Option<ts_runtime::serve::ServeManager>>,
226 /// The live Funnel ingress manager (`tsnet`'s `ListenFunnel` data path), built on
227 /// [`Device::listen_funnel`](crate::Device::listen_funnel). Held here so its TLS-termination pump and the installed peerAPI
228 /// ingress sink stay alive for the device's life (and tear down when a new `listen_funnel`
229 /// replaces it, or the `Device` drops). `None` until the first `listen_funnel`.
230 funnel: std::sync::Mutex<Option<ts_runtime::funnel::FunnelManager>>,
231}
232
233/// Map a [`ts_runtime::taildrop::TaildropError`] to the device-facing [`Error`]. `Error` is a
234/// `Copy` enum with no payload, so the I/O detail string is dropped, but the *kind* is preserved so
235/// a caller can still distinguish the actionable cases: an invalid name →
236/// [`InternalErrorKind::BadRequest`], an in-progress conflict → [`InternalErrorKind::AlreadyExists`],
237/// a missing file → [`InternalErrorKind::NotFound`], and any other filesystem failure →
238/// [`InternalErrorKind::Io`].
239fn taildrop_err(e: ts_runtime::taildrop::TaildropError) -> Error {
240 use ts_runtime::taildrop::TaildropError;
241 match e {
242 TaildropError::InvalidFileName => Error::Internal(InternalErrorKind::BadRequest),
243 TaildropError::FileExists => Error::Internal(InternalErrorKind::AlreadyExists),
244 TaildropError::Io(io) if io.kind() == std::io::ErrorKind::NotFound => {
245 Error::Internal(InternalErrorKind::NotFound)
246 }
247 TaildropError::Io(_) => Error::Internal(InternalErrorKind::Io),
248 }
249}
250
251/// Map a [`ts_runtime::taildrop_send::TaildropSendError`] (the Taildrop *sender*) to the
252/// device-facing [`Error`]. The send-side conflict/forbidden/unexpected-status cases all reduce to
253/// `BadRequest` (the peer refused the transfer for a request-level reason), a dial failure or
254/// timeout to `Timeout`, an invalid name to `BadRequest`, and any stream I/O failure to `Io`.
255fn taildrop_send_err(e: ts_runtime::taildrop_send::TaildropSendError) -> Error {
256 use ts_runtime::taildrop_send::TaildropSendError;
257 match e {
258 TaildropSendError::Connect | TaildropSendError::Timeout => Error::Timeout,
259 TaildropSendError::InvalidName
260 | TaildropSendError::Forbidden
261 | TaildropSendError::Conflict
262 | TaildropSendError::UnexpectedStatus(_) => Error::Internal(InternalErrorKind::BadRequest),
263 TaildropSendError::Io => Error::Internal(InternalErrorKind::Io),
264 }
265}
266
267/// Resolve the effective registration auth key from `auth_key` plus the config's
268/// workload-identity-federation (WIF) / OAuth-client fields.
269///
270/// With the `identity-federation` feature enabled, an OAuth client secret (`tskey-client-…`) or a
271/// `client_id` + (`id_token` | `audience`) is exchanged for a Tailscale auth key against the SaaS
272/// admin API before registration (Go `tsnet.Server`'s `resolveAuthKey`). Without the feature this is
273/// a pure pass-through: `auth_key` is returned unchanged and the WIF config fields are ignored, so
274/// the default build is byte-identical to before.
275#[cfg(feature = "identity-federation")]
276async fn resolve_auth_key(
277 config: &Config,
278 auth_key: Option<String>,
279) -> Result<Option<String>, Error> {
280 let wif = ts_control::WifConfig {
281 auth_key,
282 client_id: config.client_id.clone(),
283 client_secret: config.client_secret.clone(),
284 id_token: config.id_token.clone(),
285 audience: config.audience.clone(),
286 tags: config.requested_tags.clone(),
287 };
288 ts_control::resolve_auth_key(&wif, &config.control_server_url)
289 .await
290 .map_err(|e| {
291 tracing::error!(error = %e, "resolving auth key via workload-identity federation");
292 Error::Internal(InternalErrorKind::BadRequest)
293 })
294}
295
296/// Pass-through when the `identity-federation` feature is disabled: the auth key is used as-is and
297/// the WIF config fields have no effect (matching Go, where the federation path is compiled out
298/// unless its optional feature is linked).
299#[cfg(not(feature = "identity-federation"))]
300async fn resolve_auth_key(
301 _config: &Config,
302 auth_key: Option<String>,
303) -> Result<Option<String>, Error> {
304 Ok(auth_key)
305}
306
307impl Device {
308 /// Create a device from the given [`Config`] and auth key.
309 ///
310 /// Internally, this will spawn multiple asynchronous actors onto a Tokio runtime.
311 ///
312 /// # Example
313 ///
314 /// ```rust,no_run
315 /// # #[tokio::main]
316 /// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
317 /// # use tailscale::*;
318 /// let dev = Device::new(
319 /// &Config::default_with_key_file("tsrs_keys.json").await?,
320 /// Some("MY_AUTH_KEY".to_string()),
321 /// ).await?;
322 /// # Ok(()) }
323 /// ```
324 pub async fn new(config: &Config, auth_key: Option<String>) -> Result<Self, Error> {
325 check_magic_env()?;
326
327 // Resolve the effective registration auth key. The explicit `auth_key` argument wins; if it
328 // is `None`, fall back to `config.auth_key` (Go `tsnet.Server.AuthKey`). When the
329 // `identity-federation` feature is enabled, the resolved key is further passed through the
330 // WIF / OAuth-client bootstrap, which exchanges an OAuth client secret (`tskey-client-…`) or
331 // an IdP-issued OIDC token for a Tailscale auth key before registration (SaaS-only).
332 let auth_key = auth_key.or_else(|| config.auth_key.clone());
333 let auth_key = resolve_auth_key(config, auth_key).await?;
334
335 let rt =
336 ts_runtime::Runtime::spawn(config.into(), auth_key, (&config.key_state).into()).await?;
337 // In TUN transport mode there is no application netstack, so the runtime has no command
338 // channel: that surfaces as `UnsupportedInTunMode`, which we map to a `None` channel rather
339 // than an error (the device is still usable for control-plane and peer-lookup APIs).
340 let channel = match rt.channel().await {
341 Ok(c) => Some(c),
342 Err(e) if e.kind == ts_runtime::ErrorKind::UnsupportedInTunMode => None,
343 Err(e) => return Err(e.into()),
344 };
345
346 Ok(Self {
347 runtime: rt,
348 channel,
349 enable_ipv6: config.enable_ipv6,
350 serve: std::sync::Mutex::new(None),
351 funnel: std::sync::Mutex::new(None),
352 })
353 }
354
355 /// Create a device from the given [`Config`] and a [`SecretString`] auth key.
356 ///
357 /// This is a back-compat-preserving convenience over [`new`](Self::new) for callers that already
358 /// hold the registration auth key as a [`secrecy::SecretString`] (e.g. a daemon that keeps the
359 /// pre-auth key wrapped end-to-end). It lets the caller avoid materializing a plain `String` at
360 /// the engine boundary: the secret is exposed only on the last inch, immediately before being
361 /// handed to [`new`](Self::new).
362 ///
363 /// # Honesty about the plaintext window
364 ///
365 /// This closes the *caller's* boundary, **not** the engine's internal handling. The engine still
366 /// resolves the auth key to a plain `String` internally for registration (the plaintext `String`
367 /// window inside the engine is identical to calling [`new`](Self::new) directly) — this method
368 /// does not make the engine itself secret-clean. If you call [`new`](Self::new) you create that
369 /// `String` yourself; if you call this you do not, but the engine creates one either way.
370 ///
371 /// Passing `None` is equivalent to `new(config, None)` (falls back to `config.auth_key`).
372 ///
373 /// # Example
374 ///
375 /// ```rust,no_run
376 /// # #[tokio::main]
377 /// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
378 /// # use tailscale::*;
379 /// let dev = Device::new_with_secret(
380 /// &Config::default_with_key_file("tsrs_keys.json").await?,
381 /// Some(SecretString::from("MY_AUTH_KEY")),
382 /// ).await?;
383 /// # Ok(()) }
384 /// ```
385 pub async fn new_with_secret(
386 config: &Config,
387 auth_key: Option<SecretString>,
388 ) -> Result<Self, Error> {
389 use secrecy::ExposeSecret as _;
390
391 // Expose the secret on the last inch and delegate to `new`, so the spawn/registration path
392 // is shared verbatim (no duplicated runtime-spawn logic) and the engine-internal plaintext
393 // window is byte-for-byte identical to a direct `new` call.
394 let plain = auth_key.map(|s| s.expose_secret().to_string());
395 Self::new(config, plain).await
396 }
397
398 /// The application netstack command channel, or an error in TUN transport mode (no application
399 /// netstack exists).
400 fn channel(&self) -> Result<&Channel, Error> {
401 self.channel
402 .as_ref()
403 .ok_or(Error::Internal(InternalErrorKind::UnsupportedInTunMode))
404 }
405
406 /// Get this [`Device`]'s IPv4 tailnet address.
407 pub async fn ipv4_addr(&self) -> Result<Ipv4Addr, Error> {
408 self.runtime
409 .control
410 .ask(ts_runtime::control_runner::Ipv4)
411 .await
412 .map_err(ts_runtime::Error::from)?
413 .ok_or(Error::Internal(InternalErrorKind::Actor))
414 }
415
416 /// Get this [`Device`]'s IPv6 tailnet address.
417 pub async fn ipv6_addr(&self) -> Result<Ipv6Addr, Error> {
418 self.runtime
419 .control
420 .ask(ts_runtime::control_runner::Ipv6)
421 .await
422 .map_err(ts_runtime::Error::from)?
423 .ok_or(Error::Internal(InternalErrorKind::Actor))
424 }
425
426 /// This node's tailnet IPv4 and (when provisioned) IPv6 addresses as a pair — the Rust analog of
427 /// Go `tsnet.Server.TailscaleIPs() (ip4, ip6 netip.Addr)`.
428 ///
429 /// Reads the self node's assigned addresses (the same source Go splits by family). The tailnet
430 /// is IPv4-only unless [`Config::enable_ipv6`](crate::config::Config) is set, so the IPv6 half is
431 /// `None` when no v6 address is assigned — the Rust shape for Go returning the zero `netip.Addr`
432 /// in that case (Go's IPv6-absent sentinel). Errors until the first netmap is received (no self
433 /// node yet), matching Go returning invalid addresses before the node has joined.
434 pub async fn tailscale_ips(&self) -> Result<(Ipv4Addr, Option<Ipv6Addr>), Error> {
435 let me = self.self_node().await?;
436 let v4 = me.tailnet_address.ipv4.addr();
437 let v6 = me.tailnet_address.ipv6.addr();
438 // The decoder synthesizes the unspecified `::` placeholder on an IPv4-only tailnet; surface
439 // a real v6 only when IPv6 is enabled AND a non-placeholder address was assigned.
440 let v6 = (self.enable_ipv6 && !v6.is_unspecified()).then_some(v6);
441 Ok((v4, v6))
442 }
443
444 /// Bind a UDP socket to the specified [`SocketAddr`].
445 ///
446 /// Returns an error in TUN transport mode (there is no application netstack to bind on).
447 pub async fn udp_bind(&self, socket_addr: SocketAddr) -> Result<netstack::UdpSocket, Error> {
448 self.channel()?
449 .udp_bind(socket_addr)
450 .await
451 .map_err(Into::into)
452 }
453
454 /// Bind a TCP listener to the specified [`SocketAddr`].
455 ///
456 /// Returns an error in TUN transport mode (there is no application netstack to listen on).
457 pub async fn tcp_listen(
458 &self,
459 socket_addr: SocketAddr,
460 ) -> Result<netstack::TcpListener, Error> {
461 self.channel()?
462 .tcp_listen(socket_addr)
463 .await
464 .map_err(Into::into)
465 }
466
467 /// Register a fallback TCP handler (like `tsnet`'s `RegisterFallbackTCPHandler`).
468 ///
469 /// The callback is consulted for every inbound TCP flow that matches **no** explicit
470 /// [`Device::tcp_listen`] listener, with the flow's `(src, dst)` addresses. It returns
471 /// `(handler, intercept)`:
472 /// - `(_, false)` — decline; the next registered callback is tried.
473 /// - `(Some(h), true)` — claim the flow; `h` is handed the accepted [`netstack::TcpStream`].
474 /// - `(None, true)` — claim and reject the flow (the connection is closed).
475 ///
476 /// Multiple handlers may be registered; they are consulted in registration order and the first
477 /// to intercept wins. The returned [`FallbackTcpHandle`] deregisters the handler when dropped.
478 ///
479 /// Handlers serve flows over the overlay netstack only — never a host socket — and a flow no
480 /// handler claims is closed (fail-closed), never direct-dialed.
481 ///
482 /// Returns an error in TUN transport mode (there is no application netstack to attach to).
483 pub fn register_fallback_tcp_handler<F>(&self, cb: F) -> Result<FallbackTcpHandle, Error>
484 where
485 F: Fn(SocketAddr, SocketAddr) -> FallbackDecision + Send + Sync + 'static,
486 {
487 self.runtime
488 .register_fallback_tcp_handler(std::sync::Arc::new(cb))
489 .map_err(Into::into)
490 }
491
492 /// Resolve a tailnet peer (or this node) by MagicDNS name to its tailnet IPv4 address.
493 ///
494 /// This is an in-process lookup against the netmap we already hold — like `tsnet`'s in-memory
495 /// `dnsMap`, it does not query any DNS server (there is no `100.100.100.100` resolver). The
496 /// `name` may be a bare hostname or a fully-qualified MagicDNS name, with or without a trailing
497 /// dot, in any case (matching is case-insensitive). Returns `Ok(None)` if no tailnet node has
498 /// that name.
499 ///
500 /// Only MagicDNS names are resolved; names outside the tailnet are not looked up here, so the
501 /// caller's system resolver remains responsible for them. IPv6 is intentionally not resolved —
502 /// this fork operates IPv4-only on the tailnet.
503 pub async fn resolve(&self, name: &str) -> Result<Option<Ipv4Addr>, Error> {
504 if let Some(peer) = self.peer_by_name(name).await? {
505 return Ok(Some(peer.tailnet_address.ipv4.addr()));
506 }
507
508 // tsnet's dnsMap also resolves our own name; fall back to self when no peer matches.
509 let me = self.self_node().await?;
510 if me.matches_name(name) {
511 return Ok(Some(me.tailnet_address.ipv4.addr()));
512 }
513
514 Ok(None)
515 }
516
517 /// Run a real DNS query through the tailnet's MagicDNS responder (the `100.100.100.100`
518 /// forward path), returning the raw response, RCODE, and resolver(s) consulted — the analogue of
519 /// Go `LocalClient.QueryDNS`.
520 ///
521 /// Unlike [`resolve`](Self::resolve) (an in-memory netmap lookup that answers only MagicDNS
522 /// A-records), this issues an actual query of any `qtype` and runs it through the live
523 /// responder: an authoritative tailnet name is answered locally, anything else is forwarded to
524 /// the configured split-DNS / recursive upstreams (or delegated to the active exit node's DoH).
525 /// The response is returned as raw bytes (matching Go's `QueryDNS`), since this fork's DNS wire
526 /// codec has no answer-record decoder; the caller parses records itself if needed.
527 ///
528 /// `qtype` is the raw RFC 1035 TYPE value (`1`=A, `28`=AAAA, `12`=PTR, `16`=TXT, `33`=SRV,
529 /// `65`=HTTPS/SVCB, …). Anti-leak is inherited from the responder: a tailnet-suffix name never
530 /// egresses, recursive forwards delegate to the exit node when one is active, and only IPv4
531 /// upstreams are dialed.
532 ///
533 /// Returns an [`Error::Internal`] with `InternalErrorKind::UnsupportedInTunMode` in TUN
534 /// transport mode (MagicDNS there is an in-packet intercept, not a queryable responder).
535 pub async fn query_dns(&self, name: &str, qtype: u16) -> Result<DnsQueryResult, Error> {
536 self.runtime
537 .query_dns(name, qtype)
538 .await
539 .map_err(Into::into)
540 }
541
542 /// Connect to a tailnet peer by MagicDNS name and port over TCP.
543 ///
544 /// Resolves `name` via [`Device::resolve`] (an in-process netmap lookup, no DNS server), then
545 /// dials the resulting tailnet IPv4 address. Returns [`InternalErrorKind::BadRequest`] if the
546 /// name does not resolve to a tailnet node.
547 pub async fn connect_by_name(
548 &self,
549 name: &str,
550 port: u16,
551 ) -> Result<netstack::TcpStream, Error> {
552 let addr = self
553 .resolve(name)
554 .await?
555 .ok_or(Error::Internal(InternalErrorKind::BadRequest))?;
556
557 self.tcp_connect((addr, port).into()).await
558 }
559
560 /// Resolve a `host:port` string to a tailnet [`SocketAddr`], honoring the family forced by a
561 /// `network` suffix. The host may be an IP literal (parsed directly) or a MagicDNS name
562 /// (resolved via [`Device::resolve`], which yields a tailnet IPv4). Shared by [`Device::dial`]
563 /// and [`Device::dial_tcp`]. The IPv4-only invariant is enforced here: a `…6` network, or any v6
564 /// destination, requires `Config::enable_ipv6` and otherwise returns
565 /// [`InternalErrorKind::BadRequest`] (a clean typed error rather than a downstream actor error).
566 async fn resolve_dial_addr(
567 &self,
568 network: dial::Network,
569 addr: &str,
570 ) -> Result<SocketAddr, Error> {
571 let (host, port) = dial::split_host_port(addr)?;
572
573 // An IP literal is used directly; otherwise resolve the MagicDNS name (IPv4 only).
574 let ip: IpAddr = if let Ok(ip) = host.parse::<IpAddr>() {
575 ip
576 } else {
577 self.resolve(host)
578 .await?
579 .ok_or(Error::Internal(InternalErrorKind::BadRequest))?
580 .into()
581 };
582
583 dial::check_family(network.family, ip)?;
584
585 // IPv4-only invariant: a v6 destination is only reachable when IPv6 is provisioned.
586 if ip.is_ipv6() && !self.enable_ipv6 {
587 return Err(Error::Internal(InternalErrorKind::BadRequest));
588 }
589
590 Ok((ip, port).into())
591 }
592
593 /// Connect to a tailnet address over TCP or UDP, the Rust analog of Go
594 /// `tsnet.Server.Dial(ctx, network, address)`.
595 ///
596 /// `network` is one of `"tcp"`, `"tcp4"`, `"tcp6"`, `"udp"`, `"udp4"`, `"udp6"`; `addr` is a
597 /// `host:port` string where `host` is a MagicDNS name, an IPv4 literal, or a bracketed IPv6
598 /// literal (`[2001:db8::1]:443`). The host is resolved in-process via [`Device::resolve`] (no DNS
599 /// server). Returns a [`DialConn`] whose arm matches the transport — use [`Device::dial_tcp`]
600 /// when you want the TCP stream directly.
601 ///
602 /// Differences from Go (documented for parity): ports must be **numeric** (Go's `LookupPort`
603 /// also resolves named ports like `"http"`; this fork avoids a services-file dependency), and
604 /// `…6`/v6 destinations require `Config::enable_ipv6` (the tailnet is IPv4-only by default).
605 ///
606 /// # Errors
607 /// [`InternalErrorKind::BadRequest`] for an unsupported `network`, a malformed/portless `addr`,
608 /// an unresolvable name, or a v6 destination while IPv6 is disabled; otherwise the transport's
609 /// own connect error.
610 pub async fn dial(&self, network: &str, addr: &str) -> Result<DialConn, Error> {
611 let net = dial::parse_network(network)?;
612 let remote = self.resolve_dial_addr(net, addr).await?;
613
614 match net.transport {
615 dial::Transport::Tcp => Ok(DialConn::Tcp(self.tcp_connect(remote).await?)),
616 dial::Transport::Udp => {
617 // Bind an ephemeral local UDP socket on this node's tailnet address of the SAME
618 // family as the remote, then connect it (Go's `Dial("udp", …)` returns a connected
619 // UDP `net.Conn`, with the local source picked by `IfElse(dst.Is6(), v6, v4)`). A v4
620 // local socket cannot send to a v6 peer, so the family must match `remote`. (TCP gets
621 // this for free: `tcp_connect` already picks the source family from `remote`.)
622 let local_ip: IpAddr = if remote.is_ipv6() {
623 self.ipv6_addr().await?.into()
624 } else {
625 self.ipv4_addr().await?.into()
626 };
627 let sock = self.udp_bind((local_ip, 0).into()).await?;
628 Ok(DialConn::Udp(ConnectedUdpSocket::new(sock, remote)))
629 }
630 }
631 }
632
633 /// Connect to a tailnet address over TCP, returning the stream directly — the common case of
634 /// [`Device::dial`] for `"tcp"`. `addr` is a `host:port` string (MagicDNS name or IP literal).
635 /// This is the building block for HTTP-over-tailnet: an embedder's `hyper`/`reqwest` client can
636 /// route requests by calling `dial_tcp(&format!("{host}:{port}"))` from its connector, mirroring
637 /// how Go `tsnet.Server.HTTPClient` sets `http.Transport.DialContext = Server.Dial`.
638 ///
639 /// # Errors
640 /// As [`Device::dial`] for the `"tcp"` network.
641 pub async fn dial_tcp(&self, addr: &str) -> Result<netstack::TcpStream, Error> {
642 let remote = self
643 .resolve_dial_addr(
644 dial::Network {
645 transport: dial::Transport::Tcp,
646 family: dial::Family::Any,
647 },
648 addr,
649 )
650 .await?;
651 self.tcp_connect(remote).await
652 }
653
654 /// Connect to a tailnet address over UDP, returning a connected socket directly — the `"udp"`
655 /// sibling of [`dial_tcp`](Device::dial_tcp) and the common case of [`Device::dial`] for
656 /// `"udp"`. `addr` is a `host:port` string (MagicDNS name or IP literal).
657 ///
658 /// Returns a [`ConnectedUdpSocket`] (`send`/`recv` against a fixed peer), the connected
659 /// UDP-`net.Conn` shape Go's `tsnet.Server.Dial("udp", …)` returns — as opposed to
660 /// [`listen_packet`](Device::listen_packet), which yields an unconnected `net.PacketConn`. An
661 /// ephemeral local UDP socket is bound on this node's tailnet address of the same family as the
662 /// resolved remote (a v4 local socket cannot send to a v6 peer).
663 ///
664 /// # Errors
665 /// As [`Device::dial`] for the `"udp"` network (name resolution, the IPv4-only / `enable_ipv6`
666 /// family invariant, or TUN transport mode having no application netstack to bind on).
667 pub async fn dial_udp(&self, addr: &str) -> Result<ConnectedUdpSocket, Error> {
668 let remote = self
669 .resolve_dial_addr(
670 dial::Network {
671 transport: dial::Transport::Udp,
672 family: dial::Family::Any,
673 },
674 addr,
675 )
676 .await?;
677 let local_ip: IpAddr = if remote.is_ipv6() {
678 self.ipv6_addr().await?.into()
679 } else {
680 self.ipv4_addr().await?.into()
681 };
682 let sock = self.udp_bind((local_ip, 0).into()).await?;
683 Ok(ConnectedUdpSocket::new(sock, remote))
684 }
685
686 /// Bind a UDP socket from a `host:port` string, the Rust analog of Go
687 /// `tsnet.Server.ListenPacket(network, addr)`.
688 ///
689 /// `network` is one of `"udp"`, `"udp4"`, `"udp6"`; `addr` must be a **valid IP literal**
690 /// `host:port` (Go's `ListenPacket` rejects a name or empty host — unlike `Listen`). An
691 /// unspecified host (`0.0.0.0`/`[::]`) binds on this node's tailnet address. Returns the
692 /// unconnected [`netstack::UdpSocket`] (a `net.PacketConn`).
693 ///
694 /// # Errors
695 /// [`InternalErrorKind::BadRequest`] for a non-UDP/unsupported `network`, a malformed addr, a
696 /// non-IP host, a family mismatch, or a v6 bind while IPv6 is disabled.
697 pub async fn listen_packet(
698 &self,
699 network: &str,
700 addr: &str,
701 ) -> Result<netstack::UdpSocket, Error> {
702 let net = dial::parse_network(network)?;
703 if net.transport != dial::Transport::Udp {
704 return Err(Error::Internal(InternalErrorKind::BadRequest));
705 }
706 let (host, port) = dial::split_host_port(addr)?;
707
708 // ListenPacket requires a valid IP host (Go rejects a name here).
709 let ip: IpAddr = host
710 .parse()
711 .map_err(|_| Error::Internal(InternalErrorKind::BadRequest))?;
712 dial::check_family(net.family, ip)?;
713
714 // A v6 bind (whether an explicit literal or an unspecified `[::]`) requires IPv6 to be
715 // provisioned — enforce the gate for BOTH cases (the unspecified `[::]` path used to skip it).
716 if ip.is_ipv6() && !self.enable_ipv6 {
717 return Err(Error::Internal(InternalErrorKind::BadRequest));
718 }
719
720 // An unspecified bind host (`0.0.0.0` / `[::]`) means "this node's tailnet address" — of the
721 // SAME family as the requested address, so a `udp6` `[::]:0` binds a v6 socket (it used to
722 // fall through to the v4 address regardless, silently yielding an IPv4 socket for a v6 listen).
723 let bind_ip: IpAddr = if ip.is_unspecified() {
724 if ip.is_ipv6() {
725 self.ipv6_addr().await?.into()
726 } else {
727 self.ipv4_addr().await?.into()
728 }
729 } else {
730 ip
731 };
732
733 self.udp_bind((bind_ip, port).into()).await
734 }
735
736 /// Connect to a TCP socket at the remote address.
737 ///
738 /// Returns an error in TUN transport mode (there is no application netstack to dial from).
739 pub async fn tcp_connect(&self, remote: SocketAddr) -> Result<netstack::TcpStream, Error> {
740 let channel = self.channel()?;
741
742 let ip: IpAddr = match remote.is_ipv4() {
743 true => self.ipv4_addr().await?.into(),
744 false => self.ipv6_addr().await?.into(),
745 };
746
747 // TODO(npry): collision checking
748 let ephemeral_port = rand::random_range(49152..=u16::MAX);
749
750 channel
751 .tcp_connect((ip, ephemeral_port).into(), remote)
752 .await
753 .map_err(Into::into)
754 }
755
756 /// Start a SOCKS5 proxy on a host loopback address that dials into the tailnet (Go
757 /// `tsnet.Server.Loopback`, SOCKS5 half).
758 ///
759 /// Binds a TCP listener on `127.0.0.1:0` (host loopback only — never an external interface) and
760 /// serves SOCKS5 (RFC 1928) with required username/password auth (RFC 1929): username `tsnet`,
761 /// password = the returned `proxy_cred`. Each `CONNECT` is dialed INTO the overlay via
762 /// [`Device::connect_by_name`] / [`Device::tcp_connect`] and spliced to the accepted host socket, so
763 /// a non-Rust host process can reach tailnet peers through the proxy. Returns the bound address, the
764 /// proxy credential, and a [`LoopbackHandle`] whose drop stops the listener.
765 ///
766 /// Anti-leak: the listener is loopback-only and every connection egresses over the overlay, never a
767 /// host socket — the host's real origin IP is never used to reach the destination. Unlike Go, the
768 /// LocalAPI HTTP surface is not served (this fork exposes status/whois/id-token natively on
769 /// `Device`); only the SOCKS5 proxy is provided.
770 ///
771 /// Returns an error in TUN transport mode (no application netstack to dial from).
772 pub async fn loopback(&self) -> Result<(std::net::SocketAddr, String, LoopbackHandle), Error> {
773 loopback::start(self.overlay_dialer().await?).await
774 }
775
776 /// Build an [`OverlayDialer`](loopback::OverlayDialer): the cloneable, `&Device`-free dialer that
777 /// resolves a MagicDNS name (or takes an IPv4 literal) and `tcp_connect`s it into the overlay,
778 /// reused by [`Device::loopback`] (SOCKS5) and the `hyper` [`http_connector`](Device::http_connector).
779 ///
780 /// Captures only cloneable pieces — never `&self` — so the dialer (and anything built on it, like a
781 /// spawned accept loop or an HTTP connector) carries no borrow of the `Device`: a clone of the
782 /// netstack command channel, this device's own overlay IPv4 (fetched once), and a boxed resolver
783 /// closure over clones of the control + peer-tracker actor refs. The resolver replicates
784 /// [`Device::resolve`] (peer-by-name, falling back to this node's own name).
785 async fn overlay_dialer(&self) -> Result<loopback::OverlayDialer, Error> {
786 let channel = self.channel()?.clone();
787 let self_ipv4 = self.ipv4_addr().await?;
788
789 let control = self.runtime.control.clone();
790 let peer_tracker = self.runtime.peer_tracker.clone();
791 let resolve: loopback::Resolver = std::sync::Arc::new(move |name: String| {
792 let control = control.clone();
793 let peer_tracker = peer_tracker.clone();
794 Box::pin(async move {
795 let pt = peer_tracker
796 .upgrade()
797 .ok_or(Error::Internal(InternalErrorKind::Actor))?;
798 let peer = pt
799 .ask(ts_runtime::peer_tracker::PeerByName { name: name.clone() })
800 .await
801 .map_err(ts_runtime::Error::from)?;
802 if let Some(peer) = peer {
803 return Ok(Some(peer.tailnet_address.ipv4.addr()));
804 }
805 // tsnet's dnsMap also resolves our own name; fall back to self.
806 let me = control
807 .ask(ts_runtime::control_runner::SelfNode)
808 .await
809 .map_err(ts_runtime::Error::from)?
810 .ok_or(Error::Internal(InternalErrorKind::Actor))?;
811 if me.matches_name(&name) {
812 Ok(Some(me.tailnet_address.ipv4.addr()))
813 } else {
814 Ok(None)
815 }
816 }) as std::pin::Pin<Box<dyn std::future::Future<Output = _> + Send>>
817 });
818
819 Ok(loopback::OverlayDialer::new(channel, self_ipv4, resolve))
820 }
821
822 /// Build a [`hyper`-compatible connector](crate::http::TailnetConnector) that routes outbound HTTP
823 /// requests over the tailnet — the analog of Go `tsnet.Server.HTTPClient`, whose mechanism is
824 /// simply `http.Transport{DialContext: s.Dial}`.
825 ///
826 /// Hand the returned connector to `hyper_util::client::legacy::Client::builder(...).build(conn)`;
827 /// each request's `Uri` host is resolved as a MagicDNS name (or IPv4 literal) and dialed into the
828 /// overlay (default port 80 for `http`, 443 for `https`), so the request egresses over the tailnet
829 /// rather than the host's network. TLS, redirects, and pooling are the hyper client's concern — the
830 /// connector only supplies the transport, exactly like Go's bare `DialContext` injection.
831 ///
832 /// Available only with the **`hyper`** crate feature.
833 ///
834 /// # Errors
835 /// Fails for the same reasons as [`Device::loopback`]'s setup: TUN transport mode (no application
836 /// netstack) or the node not yet having an overlay IPv4.
837 #[cfg(feature = "hyper")]
838 pub async fn http_connector(&self) -> Result<crate::http::TailnetConnector, Error> {
839 Ok(crate::http::TailnetConnector::new(
840 self.overlay_dialer().await?,
841 ))
842 }
843
844 /// Get our node info.
845 pub async fn self_node(&self) -> Result<NodeInfo, Error> {
846 self.runtime
847 .control
848 .ask(ts_runtime::control_runner::SelfNode)
849 .await
850 .map_err(ts_runtime::Error::from)?
851 .ok_or(Error::Internal(InternalErrorKind::Actor))
852 }
853
854 /// The DNS names this node can obtain TLS certificates for — Go `tsnet.Server.CertDomains()`.
855 ///
856 /// These are the `CertDomains` control pushed in the netmap DNS config: the names a TLS-serving
857 /// consumer (e.g. a `ListenTLS`/`GetCertificate`-style caller) should request a cert for. Returns
858 /// an empty `Vec` before the first netmap, or when control granted none — mirroring Go returning a
859 /// clone of `nm.DNS.CertDomains` (empty/`nil` when absent).
860 pub async fn cert_domains(&self) -> Result<Vec<String>, Error> {
861 self.runtime
862 .control
863 .ask(ts_runtime::control_runner::CertDomains)
864 .await
865 .map_err(ts_runtime::Error::from)
866 .map_err(Into::into)
867 }
868
869 /// The DNS configuration control pushed in the latest netmap — Go `tsnet`'s view of
870 /// `netmap.NetworkMap.DNS` (what `tailscale dns status` reports).
871 ///
872 /// Returns the full [`DnsConfig`] — MagicDNS on/off, search domains, global + fallback resolvers,
873 /// split-DNS routes, extra records, cert domains — or `None` before the first netmap / when
874 /// control has sent no DNS config. A superset of [`cert_domains`](Device::cert_domains), which
875 /// remains a separate narrower accessor for the TLS-cert use. Mirrors Go reading a clone of
876 /// `nm.DNS` (absent ⇒ `None`).
877 pub async fn dns_config(&self) -> Result<Option<DnsConfig>, Error> {
878 self.runtime
879 .control
880 .ask(ts_runtime::control_runner::DnsConfig)
881 .await
882 .map_err(ts_runtime::Error::from)
883 .map_err(Into::into)
884 }
885
886 /// The URL control last asked this node to open in a browser (`MapResponse.PopBrowserURL`), or
887 /// `None` if control has never sent one.
888 ///
889 /// This is the interactive-login / consent URL an embedder driving a non-authkey (interactive)
890 /// login must surface to the user — the Rust analog of Go `ipn` delivering `BrowseToURL` through
891 /// the notification bus. A daemon polls this after starting an interactive login to obtain the
892 /// auth URL to present.
893 ///
894 /// **Sticky semantics** (Go `controlclient`'s `sess.lastPopBrowserURL`): once control sends a
895 /// URL it remains the returned value until control sends a *different* non-empty one — it is
896 /// **never cleared back to `None`** (control sends `PopBrowserURL` empty on nearly every netmap
897 /// tick; those empty updates are ignored, not treated as "clear"). So a non-`None` result does
898 /// **not** signal "control is asking *right now*" vs. "already handled" — it is the last URL
899 /// seen this session. A consumer that acts on it should de-duplicate on the URL value rather than
900 /// re-acting on every poll. For a push stream of *new* consent URLs (rather than polling this
901 /// sticky value), subscribe to [`watch_ipn_bus`](Self::watch_ipn_bus) and react to
902 /// [`Notify::browse_to_url`](crate::Notify::browse_to_url).
903 pub async fn pop_browser_url(&self) -> Result<Option<Url>, Error> {
904 self.runtime
905 .control
906 .ask(ts_runtime::control_runner::PopBrowserUrl)
907 .await
908 .map_err(ts_runtime::Error::from)
909 .map_err(Into::into)
910 }
911
912 /// This node's latest network-conditions report — the Rust analog of Go's `netcheck.Report` as
913 /// `tailscale netcheck` surfaces it.
914 ///
915 /// Returns the [`NetcheckReport`]: the preferred (lowest-latency) DERP region and the per-region
916 /// latency map this node last measured. Empty (default) before the first measurement. This fork's
917 /// net-report path measures only DERP-region latency, so the report carries that subset rather
918 /// than fabricating the UDP/port-mapping fields Go also reports (see [`NetcheckReport`]).
919 pub async fn netcheck(&self) -> Result<NetcheckReport, Error> {
920 self.runtime
921 .control
922 .ask(ts_runtime::control_runner::Netcheck)
923 .await
924 .map_err(ts_runtime::Error::from)
925 .map_err(Into::into)
926 }
927
928 /// Suggest a reasonably good exit node to use, based on this node's current netmap and latest
929 /// network-conditions report — Go `tailscale exit-node suggest` / `LocalBackend.SuggestExitNode`.
930 ///
931 /// Returns the suggested exit node's stable id + name as an [`ExitNodeSuggestion`]; engage it by
932 /// passing the id to [`Config::exit_node`](crate::config::Config) /
933 /// [`Device::set_exit_node`](crate::Device::set_exit_node) as a stable-id selector. The
934 /// suggestion uses the classic DERP-region-latency algorithm: among peers control marked
935 /// suggestable (the `suggest-exit-node` capability) that advertise an exit route and are online,
936 /// it prefers the one whose home DERP region this node measured as lowest-latency, and is
937 /// **sticky** — a prior suggestion that is still a good candidate is kept across calls, so
938 /// repeated calls don't flap between equally-good options.
939 ///
940 /// Outcomes (mirroring Go):
941 /// - `Ok(Some(suggestion))` — a node was suggested.
942 /// - `Ok(None)` — no eligible candidate (no suggestion); **not** an error.
943 /// - `Err(`[`Error::NoPreferredDerp`]`)` — no netcheck has completed yet, so no preferred DERP
944 /// region is known; retry once connectivity has been measured.
945 ///
946 /// ## Scope (Phase 1)
947 /// This ports Go's classic DERP path only. The traffic-steering path and the Mullvad
948 /// geographic-distance ranking (for exit nodes with no DERP home) are not yet implemented, and
949 /// the suggestion does not carry a `Location` (Go's `omitempty` field) — this fork's peer model
950 /// has none yet. The candidate exit-route check accepts a peer advertising `0.0.0.0/0` (this
951 /// fork is IPv4-only), rather than Go's both-`0.0.0.0/0`-and-`::/0` requirement.
952 pub async fn suggest_exit_node(&self) -> Result<Option<ExitNodeSuggestion>, Error> {
953 // The runtime returns the actor-gather outcome (outer) wrapping the algorithm outcome
954 // (inner: `Ok(None)` empty, or the `NoPreferredDerp` domain error). Flatten both into the
955 // device-facing `Error`.
956 self.runtime.suggest_exit_node().await?.map_err(Into::into)
957 }
958
959 /// This node's key-expiry instant as Unix seconds (`Node.KeyExpiry` in Go), or `Ok(None)` if
960 /// the key never expires.
961 ///
962 /// Like Go, this fork is **reactive** about key expiry — it reports it rather than rotating the
963 /// node key in the background. A caller can schedule re-authentication around this time; on
964 /// expiry, re-create the [`Device`] (which re-registers), supplying a fresh node key + the prior
965 /// `old_node_key` to rotate, or the same key to refresh.
966 pub async fn self_key_expiry_unix(&self) -> Result<Option<i64>, Error> {
967 Ok(self.self_node().await?.key_expiry_unix())
968 }
969
970 /// Whether this node's key has expired as of now (`!KeyExpiry.IsZero() && KeyExpiry.Before(now)`
971 /// in Go). A key with no expiry is never expired. See [`Device::self_key_expiry_unix`] for the
972 /// reactive-rotation note.
973 pub async fn self_key_expired(&self) -> Result<bool, Error> {
974 let now = std::time::SystemTime::now()
975 .duration_since(std::time::UNIX_EPOCH)
976 .map(|d| d.as_secs() as i64)
977 // An unreadable clock (pre-epoch) is treated as the far future so a time-limited key
978 // looks expired — fail-safe toward prompting re-auth rather than trusting a stale key.
979 .unwrap_or(i64::MAX);
980 Ok(self.self_node().await?.key_expired_at_unix(now))
981 }
982
983 /// Fetch the current Tailscale SSH policy pushed by control, if any.
984 ///
985 /// Returns `Ok(None)` when control has not sent an SSH policy. The SSH server treats an absent
986 /// or empty policy as **deny-all** (fail-closed). Used by the SSH auth path
987 /// ([`SshPolicy::evaluate`][ts_control::SshPolicy::evaluate]) to authorize incoming
988 /// connections.
989 pub async fn ssh_policy(&self) -> Result<Option<ts_control::SshPolicy>, Error> {
990 self.runtime
991 .control
992 .ask(ts_runtime::control_runner::CurrentSshPolicy)
993 .await
994 .map_err(ts_runtime::Error::from)
995 .map_err(Into::into)
996 }
997
998 /// Look up a peer by name.
999 pub async fn peer_by_name(&self, name: &str) -> Result<Option<NodeInfo>, Error> {
1000 let pt = self
1001 .runtime
1002 .peer_tracker
1003 .upgrade()
1004 .ok_or(Error::Internal(InternalErrorKind::Actor))?;
1005
1006 pt.ask(ts_runtime::peer_tracker::PeerByName {
1007 name: name.to_string(),
1008 })
1009 .await
1010 .map_err(ts_runtime::Error::from)
1011 .map_err(Into::into)
1012 }
1013
1014 /// Look up a peer by ip.
1015 pub async fn peer_by_tailnet_ip(&self, ip: IpAddr) -> Result<Option<NodeInfo>, Error> {
1016 let pt = self
1017 .runtime
1018 .peer_tracker
1019 .upgrade()
1020 .ok_or(Error::Internal(InternalErrorKind::Actor))?;
1021
1022 pt.ask(ts_runtime::peer_tracker::PeerByTailnetIp { ip })
1023 .await
1024 .map_err(ts_runtime::Error::from)
1025 .map_err(Into::into)
1026 }
1027
1028 /// Look up the peer(s) with the most-specific route matches for `ip`.
1029 ///
1030 /// This reports which peers *advertise* a route covering `ip`, independent of this device's
1031 /// `accept_routes` setting — analogous to the Go client's informational `PrimaryRoutes`. It is
1032 /// not a reachability oracle: with `accept_routes` off, the dataplane will not actually route
1033 /// to (or accept return traffic from) advertised subnet routes even if this returns a peer.
1034 pub async fn peers_with_route(&self, ip: IpAddr) -> Result<Vec<NodeInfo>, Error> {
1035 let pt = self
1036 .runtime
1037 .peer_tracker
1038 .upgrade()
1039 .ok_or(Error::Internal(InternalErrorKind::Actor))?;
1040
1041 pt.ask(ts_runtime::peer_tracker::PeerByAcceptedRoute { ip })
1042 .await
1043 .map_err(ts_runtime::Error::from)
1044 .map_err(Into::into)
1045 }
1046
1047 /// List the Taildrop files this device has fully received and not yet consumed (Go LocalAPI
1048 /// `WaitingFiles`).
1049 ///
1050 /// Returns the files waiting under the configured `taildrop_dir`, sorted by name. Returns an
1051 /// empty list when Taildrop is disabled (`Config::taildrop_dir` unset) — fail-closed, never an
1052 /// error for the disabled case. A filesystem error while listing surfaces as
1053 /// [`InternalErrorKind::Actor`].
1054 pub fn taildrop_waiting_files(&self) -> Result<Vec<WaitingFile>, Error> {
1055 let Some(store) = self.runtime.taildrop_store() else {
1056 return Ok(Vec::new());
1057 };
1058 store
1059 .waiting_files()
1060 .map_err(|_| Error::Internal(InternalErrorKind::Actor))
1061 }
1062
1063 /// Open a received Taildrop file by name for reading, returning the handle and its size (Go
1064 /// LocalAPI `OpenFile`).
1065 ///
1066 /// The `name` is validated (path-traversal-safe) inside the store before any path is built.
1067 /// Returns [`InternalErrorKind::BadRequest`] when Taildrop is disabled or the name is invalid,
1068 /// and [`InternalErrorKind::Actor`] for a filesystem error (e.g. the file does not exist).
1069 pub fn taildrop_open_file(&self, name: &str) -> Result<(std::fs::File, u64), Error> {
1070 let store = self
1071 .runtime
1072 .taildrop_store()
1073 .ok_or(Error::Internal(InternalErrorKind::BadRequest))?;
1074 store.open_file(name).map_err(taildrop_err)
1075 }
1076
1077 /// Delete a received Taildrop file by name (Go LocalAPI `DeleteFile`).
1078 ///
1079 /// The `name` is validated (path-traversal-safe) inside the store before any path is built.
1080 /// Returns [`InternalErrorKind::BadRequest`] when Taildrop is disabled or the name is invalid,
1081 /// and [`InternalErrorKind::Actor`] for a filesystem error (e.g. the file does not exist).
1082 pub fn taildrop_delete_file(&self, name: &str) -> Result<(), Error> {
1083 let store = self
1084 .runtime
1085 .taildrop_store()
1086 .ok_or(Error::Internal(InternalErrorKind::BadRequest))?;
1087 store.delete_file(name).map_err(taildrop_err)
1088 }
1089
1090 /// Send a local file to a tailnet `peer` via Taildrop (Go `PushFile` / `tailscale file cp`).
1091 ///
1092 /// Pushes `content_length` bytes from `reader` to the peer's peerAPI as
1093 /// `PUT /v0/put/<name>` over the overlay netstack — the sending counterpart to the receive store
1094 /// surfaced by [`Device::taildrop_waiting_files`]. The transfer rides the encrypted WireGuard
1095 /// overlay, never a host socket. The body is streamed from offset 0 (no resume).
1096 ///
1097 /// The destination is derived **solely from `peer`'s own node record**
1098 /// ([`NodeInfo::peerapi_addr`][ts_control::Node::peerapi_addr]): its advertised tailnet IPv4 and
1099 /// `peerapi4` port. The caller obtains `peer` from [`Device::peer_by_name`] /
1100 /// [`Device::peer_by_tailnet_ip`], so it is always a current netmap peer — a raw control-supplied
1101 /// or attacker-chosen address can never be targeted. As defense in depth, the resolved address is
1102 /// additionally asserted to be a Tailscale CGNAT IP before dialing.
1103 ///
1104 /// Returns [`InternalErrorKind::BadRequest`] when the peer advertises no IPv4 peerAPI (so it
1105 /// cannot receive files), when the name is invalid, or when the peer refuses the transfer
1106 /// (`403`/`409`/unexpected status); [`Error::Timeout`] on a dial failure or timeout; and
1107 /// [`InternalErrorKind::Io`] on a mid-transfer stream error.
1108 pub async fn send_file<R>(
1109 &self,
1110 peer: &NodeInfo,
1111 name: &str,
1112 content_length: u64,
1113 reader: R,
1114 ) -> Result<(), Error>
1115 where
1116 R: tokio::io::AsyncRead + Unpin,
1117 {
1118 let channel = self.channel()?;
1119
1120 // Destination comes only from the peer's own node record — never an arbitrary address.
1121 let dst = peer
1122 .peerapi_addr()
1123 .ok_or(Error::Internal(InternalErrorKind::BadRequest))?;
1124 // Defense in depth: refuse to dial anything outside the Tailscale CGNAT range, so a
1125 // malformed node record can't steer the PUT at a non-tailnet host.
1126 if !ts_control::is_tailscale_ip(dst.ip()) {
1127 return Err(Error::Internal(InternalErrorKind::BadRequest));
1128 }
1129
1130 let self_ipv4 = self.ipv4_addr().await?;
1131
1132 ts_runtime::taildrop_send::send_file(channel, self_ipv4, dst, name, content_length, reader)
1133 .await
1134 .map_err(taildrop_send_err)
1135 }
1136
1137 /// List the tailnet peers this node can Taildrop a file *to* — the Rust analog of Go's LocalAPI
1138 /// `FileTargets`.
1139 ///
1140 /// Each [`FileTarget`] pairs a peer's node record with the `http://ip:port` base of its peerAPI;
1141 /// pass `target.node` straight to [`Device::send_file`]. A peer qualifies when it advertises a
1142 /// reachable IPv4 peerAPI **and** is either owned by the same user as this node **or** explicitly
1143 /// granted the file-sharing-target capability — mirroring upstream's send-path filter. The list is
1144 /// gated on this node holding the file-sharing capability (control grants it when the admin
1145 /// enables Taildrop); absent that, the result is empty (fail-closed, not an error). Sorted by the
1146 /// peer's MagicDNS name. Targets are listed regardless of online state (matching upstream — an
1147 /// offline target's [`send_file`](Device::send_file) simply times out). Empty before the first
1148 /// netmap.
1149 pub async fn file_targets(&self) -> Result<Vec<FileTarget>, Error> {
1150 self.runtime.file_targets().await.map_err(Into::into)
1151 }
1152
1153 /// Begin a debug packet capture, streaming a pcap of every packet crossing the dataplane to
1154 /// `writer` (Go `tsnet.Server.CapturePcap`).
1155 ///
1156 /// Installs a capture hook on the running dataplane: from now until [`Device::stop_capture`] is
1157 /// called (or another capture replaces this one), a copy of every plaintext IP packet on the
1158 /// datapath — outbound (pre-encrypt) and inbound (post-decrypt) — is framed and written to
1159 /// `writer`. The 24-byte pcap global header is written immediately on success.
1160 ///
1161 /// The format is byte-faithful classic pcap with Tailscale's `LINKTYPE_USER0` + 4-byte path
1162 /// preamble per record (see [`ts_runtime::capture`]); a resulting file opens in Wireshark, and
1163 /// with Tailscale's `ts-dissector.lua` the direction/path of each packet decodes.
1164 ///
1165 /// The hook runs **inline on the single-threaded dataplane step**, so `writer` must not block for
1166 /// long — a slow writer back-pressures the datapath. Records are **not** flushed per packet (that
1167 /// would be a syscall on every packet on the dataplane thread); buffered bytes are flushed when
1168 /// the writer is dropped on [`Device::stop_capture`]. Wrap `writer` in a [`std::io::BufWriter`] if
1169 /// you want buffering. A write error is swallowed per-packet (the capture silently drops that
1170 /// record) rather than tearing down the datapath; call [`Device::stop_capture`] to end it. Returns
1171 /// an error only if the dataplane actor is unreachable or the initial global-header write fails.
1172 pub async fn capture_pcap<W>(&self, writer: W) -> Result<(), Error>
1173 where
1174 W: std::io::Write + Send + 'static,
1175 {
1176 let sink = std::sync::Arc::new(std::sync::Mutex::new(
1177 ts_runtime::capture::PcapSink::new(writer)
1178 .map_err(|_| Error::Internal(InternalErrorKind::Io))?,
1179 ));
1180 let hook: ts_runtime::CaptureHook = std::sync::Arc::new(move |path, pkt: &[u8]| {
1181 if let Ok(mut sink) = sink.lock() {
1182 // A per-packet write failure (e.g. a closed pipe) silently drops that record rather
1183 // than tearing down the datapath; the caller ends capture via `stop_capture`.
1184 drop(sink.log_packet(path.code(), pkt));
1185 }
1186 });
1187 self.runtime.install_capture(Some(hook)).await?;
1188 Ok(())
1189 }
1190
1191 /// Stop a debug packet capture started by [`Device::capture_pcap`] (Go `ClearCaptureSink`).
1192 ///
1193 /// Clears the dataplane capture hook; the writer is dropped (its remaining buffered bytes are
1194 /// flushed by its own `Drop`). Idempotent — clearing when no capture is installed is a no-op.
1195 /// Returns an error only if the dataplane actor is unreachable.
1196 pub async fn stop_capture(&self) -> Result<(), Error> {
1197 self.runtime.install_capture(None).await?;
1198 Ok(())
1199 }
1200
1201 /// Snapshot of this device and its tailnet peers (like `tailscale status`).
1202 ///
1203 /// Combines this node's self info with the current peer set: each [`StatusNode`] reports the
1204 /// stable id, display name, tailnet IPs, advertised routes, and exit-node flag. (Per-peer
1205 /// `online`/user/capabilities are honestly `None`/empty in this fork — the domain node model
1206 /// does not yet carry the wire-level liveness/login fields; see `ts_runtime::status` docs.)
1207 pub async fn status(&self) -> Result<Status, Error> {
1208 self.runtime.status().await.map_err(Into::into)
1209 }
1210
1211 /// Fetch the current Tailnet Lock (TKA) status pushed by control, if any.
1212 ///
1213 /// Returns `Ok(None)` when control has sent no `TKAInfo` (tailnet lock not in use, or no change
1214 /// observed yet). The returned [`TkaStatus`][ts_control::TkaStatus] carries the authority head
1215 /// (a base32 `AUMHash`, decode with [`tka::AumHash::from_base32`][ts_tka::AumHash::from_base32])
1216 /// and the disablement signal. Signature verification of a peer's node-key signature against the
1217 /// authority is performed with the [`tka`] module's [`tka::Authority`].
1218 pub async fn tka_status(&self) -> Result<Option<ts_control::TkaStatus>, Error> {
1219 self.runtime
1220 .control
1221 .ask(ts_runtime::control_runner::CurrentTkaStatus)
1222 .await
1223 .map_err(ts_runtime::Error::from)
1224 .map_err(Into::into)
1225 }
1226
1227 /// Read the Tailnet Lock update-chain history — the Rust analog of Go
1228 /// `LocalClient.NetworkLockLog`.
1229 ///
1230 /// Returns up to `limit` [`TkaLogEntry`] rows of the AUM chain **head-first** (newest first,
1231 /// walking back toward the genesis), read **locally** from this node's synced + verified chain —
1232 /// a pure read with no control round-trip. The list is empty when no lock is synced (lock not in
1233 /// use, or control hasn't pushed a chain yet). Each entry carries the AUM's chain-link hash, its
1234 /// change kind (`"add-key"` / `"remove-key"` / `"checkpoint"` / …), the ids of the keys that
1235 /// signed it, and the raw CBOR (Go `NetworkLockUpdate.Raw`) for a faithful full decode.
1236 pub async fn tka_log(&self, limit: usize) -> Result<Vec<TkaLogEntry>, Error> {
1237 self.runtime.tka_log(limit).await.map_err(Into::into)
1238 }
1239
1240 /// Sign a peer's `node_key` with this node's network-lock key and submit the signature to
1241 /// control — the Rust analog of Go `LocalClient.NetworkLockSign` for the Direct case.
1242 ///
1243 /// Builds a `Direct` [`NodeKeySignature`][ts_tka::NodeKeySignature] authorizing `node_key`, signed
1244 /// by this node's network-lock private key, and POSTs it to `/machine/tka/sign`. The signing node
1245 /// must itself be trusted under the current authority for control to accept the signature.
1246 ///
1247 /// **This only *submits* the signature; it does not mutate this node's local
1248 /// [`Authority`][ts_tka::Authority].** The local trusted-key state advances solely through the
1249 /// verified netmap-driven sync path (every applied AUM passes
1250 /// [`VerifiedAumChain::verify`][ts_tka::VerifiedAumChain::verify]), so a successful `tka_sign` is
1251 /// reflected locally on the next sync — the active fail-closed enforcement posture is unchanged.
1252 ///
1253 /// # Errors
1254 /// [`ts_control::TkaSyncError::Unsupported`] if control has no TKA endpoint (no lock / control too
1255 /// old), [`ts_control::TkaSyncError::NetworkError`] on a transient failure, or a coarse
1256 /// `Internal` for other RPC failures.
1257 pub async fn tka_sign(
1258 &self,
1259 node_key: &ts_keys::NodePublicKey,
1260 ) -> Result<(), ts_control::TkaSyncError> {
1261 self.runtime.tka_sign(node_key.to_bytes()).await
1262 }
1263
1264 /// Disable Tailnet Lock by presenting the `disablement_secret` to control — the Rust analog of
1265 /// Go `LocalClient.NetworkLockDisable`.
1266 ///
1267 /// Targets this node's current authority head (from the cached [`tka_status`](Device::tka_status));
1268 /// the `disablement_secret` is the operator-held capability (one of the lock's
1269 /// `DisablementValues`) that authorizes turning the lock off. Control verifies the secret against
1270 /// the authority's disablement set and, if valid, disables the lock for the tailnet.
1271 ///
1272 /// **Submit-only:** this POSTs the disablement; it does not mutate this node's local
1273 /// [`Authority`][ts_tka::Authority]. The disablement is reflected locally through the existing
1274 /// verified netmap-driven sync — which then clears enforcement to admit-all. The active
1275 /// fail-closed enforcement posture (until that sync lands) is unchanged.
1276 ///
1277 /// # Errors
1278 /// [`ts_control::TkaSyncError::Unsupported`] when there is no known TKA head to disable (lock not
1279 /// in use / control hasn't pushed a status) or control has no TKA endpoint;
1280 /// [`ts_control::TkaSyncError::NetworkError`] on a transient failure; a coarse `Internal` for
1281 /// other RPC failures (incl. control rejecting an invalid secret).
1282 pub async fn tka_disable(
1283 &self,
1284 disablement_secret: Vec<u8>,
1285 ) -> Result<(), ts_control::TkaSyncError> {
1286 self.runtime.tka_disable(disablement_secret).await
1287 }
1288
1289 /// Initialize Tailnet Lock for this tailnet with this node as the sole initial trusted key — the
1290 /// Rust analog of Go `LocalClient.NetworkLockInit` for the single-node "lock yourself in" case.
1291 ///
1292 /// Builds and signs a genesis Checkpoint AUM trusting only this node's network-lock key and
1293 /// gated by `disablement_secret` (stored as its Argon2i [`disablement_value`][ts_tka::disablement_value]
1294 /// in the lock; the raw secret is the operator-held capability that later disables it via
1295 /// [`tka_disable`](Device::tka_disable)), then drives control's two-phase
1296 /// `/machine/tka/init/{begin,finish}`.
1297 ///
1298 /// **Single-node only (for now):** if control reports that other nodes must be (re)signed under
1299 /// the new lock (a multi-node tailnet), this returns [`ts_control::TkaSyncError::Unsupported`] —
1300 /// the multi-node init (re-signing each node, incl. rotation keys) is a deferred follow-up.
1301 ///
1302 /// **Submit-only:** this creates the lock at control and does not seed this node's local
1303 /// [`Authority`][ts_tka::Authority]; the lock is reflected locally through the verified
1304 /// netmap-driven sync (every applied AUM passes
1305 /// [`VerifiedAumChain::verify`][ts_tka::VerifiedAumChain::verify]). Verify-and-log posture is
1306 /// unchanged.
1307 ///
1308 /// # Errors
1309 /// [`ts_control::TkaSyncError::Unsupported`] if control has no TKA endpoint or requires re-signing
1310 /// other nodes; [`ts_control::TkaSyncError::NetworkError`] on a transient failure; a coarse
1311 /// `Internal` for a malformed genesis or other RPC failure (incl. control rejecting the init,
1312 /// e.g. a lock already exists).
1313 pub async fn tka_init(
1314 &self,
1315 disablement_secret: Vec<u8>,
1316 ) -> Result<(), ts_control::TkaSyncError> {
1317 self.runtime.tka_init(disablement_secret).await
1318 }
1319
1320 /// Request an OIDC **ID token** from control for this node, scoped to `audience` (workload-
1321 /// identity federation, like `tailscale`'s `id-token` LocalAPI).
1322 ///
1323 /// Returns a signed JWT whose `sub` claim is this node's MagicDNS name and whose `aud` claim is
1324 /// `audience`, suitable for presenting to a third-party relying party (e.g. AWS/GCP
1325 /// workload-identity federation). The node is the token *subject*, not the authenticator — this
1326 /// is token issuance over the Noise transport (`POST /machine/id-token`), not a login path.
1327 /// Requires the control plane to support capability version ≥ 30.
1328 pub async fn fetch_id_token(&self, audience: &str) -> Result<String, ts_control::IdTokenError> {
1329 self.runtime.fetch_id_token(audience.to_string()).await
1330 }
1331
1332 /// Publish a `TXT` DNS record for this node into the tailnet's `ts.net` zone via control's
1333 /// `/machine/set-dns` RPC — the Rust analog of Go `tailscale.com/client/tailscale`'s
1334 /// `LocalClient.SetDNS(ctx, name, value)`.
1335 ///
1336 /// `name` is the full record name (e.g. `_acme-challenge.host.tailnet.ts.net`) and `value` is
1337 /// the record value (e.g. the base64url DNS-01 digest). Like Go's `SetDNS`, this publishes a
1338 /// `TXT` record specifically — its canonical use is satisfying an ACME DNS-01 challenge so a CA
1339 /// can verify control of a `*.ts.net` name. Issuance over the Noise transport (`POST
1340 /// /machine/set-dns`), not a login path.
1341 pub async fn set_dns(&self, name: &str, value: &str) -> Result<(), ts_control::SetDnsError> {
1342 self.runtime
1343 .set_dns(name.to_string(), value.to_string())
1344 .await
1345 }
1346
1347 /// Log this node out of the tailnet — deregister it from the control plane (the equivalent of
1348 /// Go `tsnet`'s `LocalClient.Logout`).
1349 ///
1350 /// Re-`POST`s `/machine/register` with this node's current node key and a past expiry, which the
1351 /// control plane honors by **expiring the node now**: it drops out of every peer's netmap and
1352 /// must re-register (re-authenticate) to rejoin.
1353 ///
1354 /// This is primarily for **non-ephemeral** nodes. An ephemeral node is garbage-collected by
1355 /// control shortly after it disconnects, but a persistent node lingers in the tailnet
1356 /// (visible to peers, counting against the machine limit) for up to ~24h after the process exits
1357 /// unless explicitly logged out. Call this before [`shutdown`](Self::shutdown) to deregister
1358 /// immediately. Calling it on an ephemeral node simply brings the GC forward; it is idempotent,
1359 /// so logging out an already-gone node is not an error.
1360 ///
1361 /// This is a **control-plane state change only**: it does not tear down the local datapath (do
1362 /// that via [`shutdown`](Self::shutdown)), and it does not delete or rotate the on-disk node key
1363 /// — re-registering with the same key (a fresh [`Device::new`]) is the re-login path.
1364 pub async fn logout(&self) -> Result<(), ts_control::LogoutError> {
1365 self.runtime.logout().await
1366 }
1367
1368 /// Snapshot this node's client metrics in Prometheus text exposition format.
1369 ///
1370 /// Mirrors Go Tailscale's `clientmetric` registry: process-global counters/gauges incremented
1371 /// on the datapath hot loops (e.g. `magicsock_send_udp`, `magicsock_recv_data_bytes_udp`),
1372 /// rendered as `# TYPE <name> <kind>\n<name> <value>\n` per metric, sorted by name. (Go `tsnet`
1373 /// exposes no metrics method of its own, so this is the fork's clean public surface.) The
1374 /// registry is process-global, so the output covers every `Device` in the process.
1375 pub fn metrics(&self) -> String {
1376 ts_metrics::write_prometheus()
1377 }
1378
1379 /// Map a tailnet source `addr` to the node that owns its IP (like `tsnet`'s `WhoIs`).
1380 ///
1381 /// Only the IP of `addr` is used; the port is ignored. Returns `Ok(None)` if no tailnet node
1382 /// owns that address.
1383 pub async fn whois(&self, addr: SocketAddr) -> Result<Option<WhoIs>, Error> {
1384 self.runtime.whois(addr).await.map_err(Into::into)
1385 }
1386
1387 /// Change the selected exit node at runtime, without recreating the [`Device`] — the equivalent
1388 /// of Go `tsnet`'s `LocalClient.EditPrefs(ExitNodeID/ExitNodeIP)`.
1389 ///
1390 /// The peer may be named by stable node ID, tailnet IP, or MagicDNS name via
1391 /// [`ExitNodeSelector`] (a bare IP or name parses with `selector.parse()`); this is the same
1392 /// selector type as [`Config::exit_node`](crate::Config::exit_node), so the construction-time
1393 /// and runtime paths are identical. Passing `None` clears the exit node — internet-bound traffic
1394 /// is then dropped (fail-closed) unless this node egresses directly.
1395 ///
1396 /// The change is applied immediately: the new selector is re-resolved against the live peer set
1397 /// and the outbound route + inbound source filter are recomputed at once. A selector for a peer
1398 /// not yet in the netmap simply takes effect once that peer appears.
1399 ///
1400 /// Only NEW flows use the changed exit; in-flight connections are not torn down and continue
1401 /// egressing via the previously-selected exit until they close.
1402 pub async fn set_exit_node(&self, exit_node: Option<ExitNodeSelector>) -> Result<(), Error> {
1403 self.runtime
1404 .set_exit_node(exit_node)
1405 .await
1406 .map_err(Into::into)
1407 }
1408
1409 /// The currently-selected exit node, or `None` if none is selected.
1410 pub fn exit_node(&self) -> Option<ExitNodeSelector> {
1411 self.runtime.exit_node()
1412 }
1413
1414 /// Toggle whether this node accepts peer-advertised subnet routes at runtime, without recreating
1415 /// the [`Device`] — the equivalent of Go `tsnet`'s `LocalClient.EditPrefs(RouteAll)` /
1416 /// `tailscale set --accept-routes`.
1417 ///
1418 /// This is a purely **local** preference: unlike [`set_advertise_routes`](Self::set_advertise_routes)
1419 /// it is never reported to control, so it only changes which peer-advertised subnet routes *this*
1420 /// node installs. The change is applied immediately — the outbound route table and the inbound
1421 /// source filter are recomputed together against the live peer set, so turning it on installs (and
1422 /// accepts traffic from) newly-accepted subnets and turning it off removes them from both in
1423 /// lock-step. A peer's own tailnet address is always reachable regardless; the exit-node default
1424 /// route is governed by [`set_exit_node`](Self::set_exit_node), not this flag.
1425 ///
1426 /// Only NEW flows are affected; in-flight connections are not torn down. In TUN transport mode the
1427 /// netstack data path honors the toggle immediately, but the host routing table is not re-steered
1428 /// until the device is rebuilt.
1429 pub async fn set_accept_routes(&self, accept: bool) -> Result<(), Error> {
1430 self.runtime
1431 .set_accept_routes(accept)
1432 .await
1433 .map_err(Into::into)
1434 }
1435
1436 /// Whether this node currently accepts peer-advertised subnet routes (`--accept-routes`).
1437 pub fn accept_routes(&self) -> bool {
1438 self.runtime.accept_routes()
1439 }
1440
1441 /// Toggle whether this node accepts the tailnet's DNS configuration at runtime, without
1442 /// recreating the [`Device`] — the equivalent of Go `tsnet`'s `LocalClient.EditPrefs(CorpDNS)` /
1443 /// `tailscale set --accept-dns`.
1444 ///
1445 /// Like [`set_accept_routes`](Self::set_accept_routes) this is a purely **local** preference,
1446 /// never reported to control. When `false`, the MagicDNS responder ignores the control-pushed DNS
1447 /// configuration and answers every query `REFUSED` (mirroring Go applying an empty `dns.Config`
1448 /// when `CorpDNS` is off), so the node can join the tailnet for connectivity without taking over
1449 /// its DNS. The change is applied immediately to the netstack responder and the peerAPI DoH server
1450 /// that shares its view; flipping it back to `true` restores serving from the still-current config
1451 /// (the config is only gated at the read site, never destroyed), so the OFF→ON restore is
1452 /// automatic.
1453 ///
1454 /// In TUN transport mode the in-datapath responder honors the toggle immediately, but the host
1455 /// resolver/route programming (which points the host at `100.100.100.100`) is applied once at
1456 /// device build and is not re-steered until the device is rebuilt.
1457 pub async fn set_accept_dns(&self, accept: bool) -> Result<(), Error> {
1458 self.runtime
1459 .set_accept_dns(accept)
1460 .await
1461 .map_err(Into::into)
1462 }
1463
1464 /// Whether this node currently accepts the tailnet's DNS configuration (`--accept-dns` / `CorpDNS`).
1465 pub fn accept_dns(&self) -> bool {
1466 self.runtime.accept_dns()
1467 }
1468
1469 /// Change the subnet routes this node advertises at runtime — Go `tailscale set
1470 /// --advertise-routes`. This is the runtime equivalent of
1471 /// [`Config::advertise_routes`](crate::Config::advertise_routes): the node re-advertises the
1472 /// prefixes to control (so it is granted the subnet-router role for them) AND starts forwarding
1473 /// them on the data path, applied together so the two never disagree.
1474 ///
1475 /// `routes` is filtered to the IPv4-only, deduplicated set this fork honors (IPv6 prefixes are
1476 /// dropped under the IPv6-off posture). This sets the explicit subnet prefixes only; it does not
1477 /// affect the exit-node `0.0.0.0/0` advertisement. Only NEW forwarded flows use the changed set;
1478 /// in-flight flows keep their existing routing until they close.
1479 pub async fn set_advertise_routes(&self, routes: Vec<ipnet::IpNet>) -> Result<(), Error> {
1480 self.runtime
1481 .set_advertise_routes(routes)
1482 .await
1483 .map_err(Into::into)
1484 }
1485
1486 /// Advertise (or stop advertising) this node as an **exit node** at runtime — Go `tailscale set
1487 /// --advertise-exit-node`. The runtime equivalent of
1488 /// [`Config::advertise_exit_node`](crate::Config::advertise_exit_node): when `enable` it adds the
1489 /// `0.0.0.0/0` default route to what this node advertises (and forwards), when `false` it removes
1490 /// it.
1491 ///
1492 /// Composes with [`set_advertise_routes`](Device::set_advertise_routes): the explicit subnet
1493 /// routes and the exit-node advertisement are independent — toggling one preserves the other.
1494 /// Advertising an exit node only makes this node *eligible*; control + the peer still decide
1495 /// whether to route through it. Only NEW forwarded flows see the change; in-flight flows keep
1496 /// their routing.
1497 pub async fn set_advertise_exit_node(&self, enable: bool) -> Result<(), Error> {
1498 self.runtime
1499 .set_advertise_exit_node(enable)
1500 .await
1501 .map_err(Into::into)
1502 }
1503
1504 /// Change this node's hostname at runtime — Go `tailscale set --hostname`. Re-reports
1505 /// `Hostinfo.Hostname` to control on the live connection (no rebuild, no reconnect); control
1506 /// reflects the new name in the netmap (it drives the node's MagicDNS name / `tailscale status`
1507 /// display). Hostname is display metadata, so there is no data-path effect. The new value also
1508 /// persists across a later re-registration.
1509 pub async fn set_hostname(&self, hostname: String) -> Result<(), Error> {
1510 self.runtime
1511 .set_hostname(hostname)
1512 .await
1513 .map_err(Into::into)
1514 }
1515
1516 /// Re-bind the underlay UDP socket after a **network/link change** — Wi-Fi switch, sleep/wake,
1517 /// or any event that invalidates the device's local address/NAT mapping. This is the Rust
1518 /// analog of Go magicsock's `Conn.Rebind()`.
1519 ///
1520 /// The embedder owns deciding *when* to call this (it watches the OS for link changes — there is
1521 /// no built-in network monitor); `rebind` is the engine half that does the socket work:
1522 /// - Re-binds the underlay UDP socket, preferring the same local port (so the advertised
1523 /// endpoint stays stable) and falling back to an ephemeral port. The IPv4-only-by-default
1524 /// invariant is preserved.
1525 /// - Invalidates the now-stale local mapping: learned reflexive (STUN) addresses and every
1526 /// peer's *confirmed* direct path are cleared, while candidate endpoints are kept — so peers
1527 /// are re-probed over the new socket and **relay over DERP (never a direct host dial) until a
1528 /// path re-confirms**. Endpoint discovery re-runs on its normal cadence.
1529 /// - Leaves peers, control, the netmap, disco keys, and DERP connections untouched; existing
1530 /// WireGuard sessions survive (they ride whatever underlay carries them).
1531 ///
1532 /// A no-op if the underlay socket failed to bind at startup (the device is DERP-only). Existing
1533 /// connectivity is preserved on a re-bind error (the old socket is kept; the error is returned).
1534 pub async fn rebind(&self) -> Result<(), Error> {
1535 self.runtime.rebind().await.map_err(Into::into)
1536 }
1537
1538 /// Force an immediate STUN re-probe / endpoint re-derivation **without** rebinding the underlay
1539 /// socket — the Rust analog of Go magicsock's `Conn.ReSTUN("debug")` (what `tailscale debug
1540 /// restun` triggers).
1541 ///
1542 /// Unlike [`rebind`](Self::rebind), this does **not** swap the socket or disturb any learned
1543 /// path: it keeps the existing UDP socket and its NAT mapping and only re-runs the STUN sweep
1544 /// now (re-learning this node's reflexive/public address) instead of waiting out the periodic
1545 /// (~23s, jittered) prober. Use it when this node's public endpoint may have changed (e.g. a NAT
1546 /// rebinding) but the socket itself is still fine — it is strictly lighter than a rebind.
1547 ///
1548 /// Peers, control, the netmap, disco keys, and DERP are untouched, and there is **no control
1549 /// round-trip**. A no-op if the underlay socket failed to bind at startup (the device is
1550 /// DERP-only) or while no peer is configured (matching the periodic prober's gate).
1551 pub async fn re_stun(&self) -> Result<(), Error> {
1552 self.runtime.re_stun().await.map_err(Into::into)
1553 }
1554
1555 /// The stable id of the exit node traffic is **currently** egressing through, or `None` if none
1556 /// is engaged (the equivalent of Go `tsnet`'s `Status.ExitNodeStatus.ID`).
1557 ///
1558 /// This differs from [`exit_node`](Self::exit_node), which returns the *configured* selector:
1559 /// the active exit node is the route updater's resolved, fail-closed answer. It is `None` when
1560 /// no exit node is configured, the configured selector matches no current peer, or the matched
1561 /// peer no longer advertises a default route (egress is then dropped, fail-closed). Match the id
1562 /// against [`Status::peers`](crate::Status::peers) (via [`status`](Self::status)) for details.
1563 pub fn active_exit_node(&self) -> Option<ts_control::StableNodeId> {
1564 self.runtime.active_exit_node()
1565 }
1566
1567 /// Watch for netmap changes: the returned receiver's value is the current set of peer
1568 /// [`StatusNode`]s and updates on every netmap change. This is the narrow peer-only view; for
1569 /// the unified Go-`WatchIPNBus` feed (peers + device-state + login URL in one stream) use
1570 /// [`watch_ipn_bus`](Self::watch_ipn_bus).
1571 pub async fn watch_netmap(
1572 &self,
1573 ) -> Result<tokio::sync::watch::Receiver<Vec<StatusNode>>, Error> {
1574 self.runtime.watch_netmap().await.map_err(Into::into)
1575 }
1576
1577 /// The current device connection-[`DeviceState`] (`Connecting` / `Running` / `NeedsLogin` /
1578 /// `Expired` / `Failed`).
1579 pub fn device_state(&self) -> DeviceState {
1580 self.runtime.device_state()
1581 }
1582
1583 /// Watch the device connection-[`DeviceState`], reacting push-style to control connection
1584 /// transitions instead of polling [`status`](Self::status).
1585 ///
1586 /// Returns a [`tokio::sync::watch::Receiver`]; await its
1587 /// [`changed`](tokio::sync::watch::Receiver::changed) to be woken on each transition. The
1588 /// initial value is the current state.
1589 pub fn watch_state(&self) -> tokio::sync::watch::Receiver<DeviceState> {
1590 self.runtime.watch_state()
1591 }
1592
1593 /// Subscribe to the unified IPN notification bus (Go `ipn`'s `WatchIPNBus`).
1594 ///
1595 /// Returns an [`IpnBusWatcher`]; await [`next`](IpnBusWatcher::next) to receive [`Notify`]
1596 /// events that merge device-[`DeviceState`] transitions (with the interactive-login URL surfaced
1597 /// as [`Notify::browse_to_url`]) and netmap peer-set changes into one feed — the single stream a
1598 /// consumer porting from Go's `WatchNotifications` expects, instead of composing
1599 /// [`watch_state`](Self::watch_state) and [`watch_netmap`](Self::watch_netmap) by hand. `mask`
1600 /// ([`NotifyWatchOpt`]) front-loads the current state as an initial snapshot on subscribe
1601 /// (`INITIAL_STATE` / `INITIAL_NETMAP`), mirroring Go's `NotifyInitialState` /
1602 /// `NotifyInitialNetMap`. Delivery is best-effort (a slow consumer drops notifications rather
1603 /// than stalling the runtime); the stream ends when the device shuts down.
1604 pub async fn watch_ipn_bus(&self, mask: NotifyWatchOpt) -> Result<IpnBusWatcher, Error> {
1605 self.runtime.watch_ipn_bus(mask).await.map_err(Into::into)
1606 }
1607
1608 /// Wait until the device finishes registering, returning a typed outcome — the clean
1609 /// replacement for polling [`ipv4_addr`](Self::ipv4_addr) in a loop.
1610 ///
1611 /// Resolves `Ok(())` once the device is [`DeviceState::Running`]. On a non-running outcome it
1612 /// returns a typed [`RegistrationError`]:
1613 /// - [`AuthRejected`](RegistrationError::AuthRejected) — bad/expired/unknown auth key;
1614 /// **permanent** (re-pair).
1615 /// - [`NeedsLogin`](RegistrationError::NeedsLogin) — interactive authorization required;
1616 /// **not permanent** (the runtime keeps retrying and reaches `Running` once the user
1617 /// authorizes). Auth-key callers treat this as failure; interactive callers should ignore it
1618 /// and drive the flow via [`watch_state`](Self::watch_state).
1619 /// - [`NetworkUnreachable`](RegistrationError::NetworkUnreachable) — **transient** (retry).
1620 /// - [`Timeout`](RegistrationError::Timeout) — no settled state within `timeout` (`None` waits
1621 /// indefinitely).
1622 ///
1623 /// [`KeyExpired`](RegistrationError::KeyExpired) is not produced here (a key expires only after
1624 /// the node is up); observe it via [`watch_state`](Self::watch_state). Use
1625 /// [`RegistrationError::is_permanent`] to branch "re-pair" vs. "retry / drive login".
1626 pub async fn wait_until_running(
1627 &self,
1628 timeout: Option<Duration>,
1629 ) -> Result<(), RegistrationError> {
1630 self.runtime.wait_until_running(timeout).await
1631 }
1632
1633 /// Ping a tailnet peer over the overlay with an ICMPv4 echo, returning the round-trip time
1634 /// (like `tailscale ping`).
1635 ///
1636 /// The echo is sent from this device's own tailnet IPv4 over the overlay netstack — never a
1637 /// host socket. IPv6 destinations return [`PingError::Ipv6Unsupported`] (this fork is
1638 /// IPv4-only on the tailnet). A peer answers from its own OS stack; this netstack does not
1639 /// auto-reply to echo requests.
1640 ///
1641 /// In TUN transport mode there is no application netstack to ping from; this surfaces as
1642 /// [`PingError::Timeout`] (the same error this method already uses for an unavailable source
1643 /// address — `PingError` carries no dedicated "unsupported" variant).
1644 pub async fn ping(&self, dst: IpAddr, timeout: Duration) -> Result<Duration, PingError> {
1645 let channel = self.channel().map_err(|_| PingError::Timeout)?;
1646 let src = self.ipv4_addr().await.map_err(|_| PingError::Timeout)?;
1647 ts_netstack_smoltcp::ping(channel, src, dst, timeout).await
1648 }
1649
1650 /// The current **direct path** to the peer at tailnet IP `dst`: its confirmed direct UDP
1651 /// endpoint and that path's last-measured round-trip latency, or `None` when traffic to the peer
1652 /// is **relayed via DERP** (no trusted direct path right now), the peer is unknown, or it has no
1653 /// disco key.
1654 ///
1655 /// This is the direct-path analog of Go's `tailscale ping`/`PeerStatus` connectivity: a present
1656 /// result means packets reach the peer directly at the returned address, with roughly the
1657 /// returned RTT. The latency is a live snapshot taken from the most recent disco ping/pong that
1658 /// confirmed the path (up to one probe interval stale) — not a fresh on-demand round-trip. Unlike
1659 /// [`ping`](Device::ping) (an ICMP echo over the netstack), this reports the *underlay* path the
1660 /// data plane actually uses, distinguishing a direct connection from a DERP-relayed one.
1661 pub async fn direct_path(&self, dst: IpAddr) -> Result<Option<(SocketAddr, Duration)>, Error> {
1662 self.runtime.direct_path(dst).await.map_err(Into::into)
1663 }
1664
1665 /// Send a disco ping to the peer at tailnet IP `dst` **now** and await the pong — a fresh,
1666 /// on-demand round-trip measurement (Go's `tailscale ping`, `PingType::Disco`). Returns the
1667 /// endpoint that answered and the measured RTT, or `None` if no pong arrives within `timeout`
1668 /// (or the peer is unknown / has no candidate direct path).
1669 ///
1670 /// Unlike [`direct_path`](Device::direct_path) — which reports the *last periodic probe's* RTT
1671 /// from cache — this actively sends a ping and waits for the reply, so the latency is current. A
1672 /// `None` here means "no direct path confirmed within the timeout" (the peer may still be
1673 /// reachable via DERP). Unlike [`ping`](Device::ping) (an ICMP echo over the netstack), this
1674 /// measures the disco/underlay path the data plane uses for direct connections.
1675 pub async fn ping_disco(
1676 &self,
1677 dst: IpAddr,
1678 timeout: Duration,
1679 ) -> Result<Option<(SocketAddr, Duration)>, Error> {
1680 self.runtime
1681 .ping_disco(dst, timeout)
1682 .await
1683 .map_err(Into::into)
1684 }
1685
1686 /// Obtain a TLS certificate for a node's MagicDNS `name` (like `tsnet`'s `GetCertificate`).
1687 ///
1688 /// **Fail-closed without the `acme` feature.** By default this fork has no client-side ACME
1689 /// engine wired in, so this returns [`ts_control::CertError::Unimplemented`] (after a
1690 /// tailnet-name check) — it NEVER self-signs and NEVER returns a placeholder certificate
1691 /// ([`ts_control::MISSING_CERT_RPC`] names what is missing).
1692 ///
1693 /// **With the `acme` feature** this instead drives the client-side ACME DNS-01 engine to issue a
1694 /// real Let's Encrypt certificate for `name`, publishing the challenge TXT via the node's
1695 /// `POST /machine/set-dns` RPC (routed through the control runner). SaaS-only: a self-hosted
1696 /// control plane may 501 on set-dns, surfaced as [`ts_control::CertError::Acme`].
1697 #[cfg(not(feature = "acme"))]
1698 pub async fn get_certificate(&self, name: &str) -> Result<CertifiedKey, ts_control::CertError> {
1699 ts_control::get_certificate(name).await
1700 }
1701
1702 /// See the no-`acme` variant for the contract; with `acme` this issues a real cert via the
1703 /// runtime's ACME engine (`Device → Runtime → ControlRunner → issue_certificate_via_setdns`).
1704 #[cfg(feature = "acme")]
1705 pub async fn get_certificate(&self, name: &str) -> Result<CertifiedKey, ts_control::CertError> {
1706 self.runtime.get_certificate(name.to_string()).await
1707 }
1708
1709 /// Issue a real Let's Encrypt certificate for a node's MagicDNS `name` and return the **PEM
1710 /// pair** `(cert_chain_pem, key_pem)` — the analog of Go's `LocalClient.CertPairWithValidity`,
1711 /// for writing the daemon's on-disk `.crt` + `.key` (`tnet cert`). **`acme` feature only.**
1712 ///
1713 /// This drives the same client-side ACME DNS-01 issuance as [`Device::get_certificate`] (one
1714 /// order, the challenge TXT published via the node's `POST /machine/set-dns` RPC, routed through
1715 /// the runtime → control runner); it differs only in returning the raw leaf+chain PEM and the
1716 /// leaf private-key PEM instead of the opaque [`CertifiedKey`]. The second tuple element is
1717 /// **secret key material**: it is never logged anywhere on this path — persist it to a `0600`
1718 /// file and never trace it.
1719 ///
1720 /// **`min_validity` (honest "always fresh").** Go's `CertPairWithValidity` reuses a cached cert
1721 /// when it has at least `min_validity` of its lifetime remaining, re-issuing otherwise. This
1722 /// fork keeps **no cert cache** — every call issues fresh — so `min_validity` is accepted for
1723 /// signature compatibility but does not alter behavior: a freshly issued (full-lifetime) cert
1724 /// satisfies any `min_validity`. A reuse cache is separate future work; this does NOT fake one.
1725 ///
1726 /// Fail-closed: returns a [`ts_control::CertError`] (never a self-signed or partial pair) on any
1727 /// ACME/HTTP failure. SaaS-only: a self-hosted control plane may 501 on set-dns, surfaced as
1728 /// [`ts_control::CertError::Acme`].
1729 #[cfg(feature = "acme")]
1730 pub async fn cert_pair(
1731 &self,
1732 name: &str,
1733 min_validity: Option<Duration>,
1734 ) -> Result<(String, String), ts_control::CertError> {
1735 self.runtime.cert_pair(name.to_string(), min_validity).await
1736 }
1737
1738 /// Build a [`TlsAcceptor`] terminating TLS for `cfg.name` on the overlay (like `tsnet`'s
1739 /// `ListenTLS`).
1740 ///
1741 /// Obtains the certificate via [`Device::get_certificate`] — so with the `acme` feature this
1742 /// issues a real Let's Encrypt cert (when the control plane answers `set-dns`), and without it
1743 /// (or when issuance is unavailable) it surfaces the same fail-closed
1744 /// [`ts_control::CertError`] rather than ever serving a self-signed cert or downgrading to
1745 /// plaintext. Terminate accepted overlay streams with [`ts_control::accept_tls`].
1746 pub async fn listen_tls(
1747 &self,
1748 cfg: &ts_control::ServeConfig,
1749 ) -> Result<TlsAcceptor, ts_control::CertError> {
1750 // Route through Device::get_certificate (the acme-aware issuance path) rather than
1751 // ts_control::listen_tls, which only knows the non-acme stub. Validate the serve config
1752 // first (same fail-closed checks ts_control::listen_tls applies), then assemble the acceptor.
1753 cfg.validate()?;
1754 let cert = self.get_certificate(&cfg.name).await?;
1755 ts_control::tls_acceptor(cert)
1756 }
1757
1758 /// The currently-stored Serve config (like `tsnet`'s `GetServeConfig`).
1759 ///
1760 /// Returns the config last passed to [`Device::set_serve_config`], or an empty
1761 /// [`ts_control::ServeState`] (no ports) if none was ever set. Pure read — does not touch the
1762 /// network.
1763 pub fn get_serve_config(&self) -> ts_control::ServeState {
1764 match &*self.serve.lock().unwrap_or_else(|e| e.into_inner()) {
1765 Some(mgr) => mgr.get(),
1766 None => ts_control::ServeState::default(),
1767 }
1768 }
1769
1770 /// Replace this node's Serve config and (re)bind its tailnet ports (like `tsnet`'s
1771 /// `SetServeConfig`, REPLACE semantics).
1772 ///
1773 /// `state` becomes the **whole** config (full-replace reconcile: every previously-bound serve
1774 /// port's accept loop is torn down and the new config's ports are bound from scratch). For each
1775 /// configured port the manager binds an overlay listener on this node's tailnet IPv4 and
1776 /// dispatches per [`ts_control::ServeTarget`]:
1777 /// - [`Accept`](ts_control::ServeTarget::Accept) — the TLS-terminated stream is handed back over
1778 /// the returned [`ServeAcceptedReceiver`](ts_runtime::serve::ServeAcceptedReceiver) (the
1779 /// in-process stand-in for `ListenTLS`'s `net.Listener`).
1780 /// - [`Proxy`](ts_control::ServeTarget::Proxy) — reverse-proxy the decrypted stream to a local
1781 /// host backend.
1782 /// - [`Text`](ts_control::ServeTarget::Text) — write a fixed body and close.
1783 /// - [`TcpForward`](ts_control::ServeTarget::TcpForward) — forward the **raw** (non-TLS) stream
1784 /// to a local host backend.
1785 ///
1786 /// **Fail-closed.** `state.validate()` runs first. Every TLS-terminating port's acceptor is
1787 /// obtained up-front via [`Device::listen_tls`] (the ACME-aware cert path); if any cert cannot be
1788 /// issued the whole call fails with that [`ts_control::CertError`] and **nothing is bound** — a
1789 /// TLS port never downgrades to plaintext.
1790 ///
1791 /// **Anti-leak.** Listeners bind the overlay netstack only (never a host socket). The
1792 /// `Proxy`/`TcpForward` backend dial is a local host socket to the embedder's own backend (like
1793 /// Go's reverse-proxy to `127.0.0.1`), intentionally NOT routed through the exit-egress
1794 /// forwarder. A backend dial failure drops that connection; it never falls back.
1795 ///
1796 /// Returns an error in TUN transport mode (there is no application netstack to bind on). The
1797 /// previous config's accept loops (and any earlier `ServeAcceptedReceiver`) stop when this
1798 /// returns; the new receiver delivers every `Accept`-port connection.
1799 pub async fn set_serve_config(
1800 &self,
1801 state: ts_control::ServeState,
1802 ) -> Result<ts_runtime::serve::ServeAcceptedReceiver, Error> {
1803 state
1804 .validate()
1805 .map_err(|_| Error::Internal(InternalErrorKind::BadRequest))?;
1806
1807 // Fail-closed: build every TLS-terminating port's acceptor up-front via the ACME-aware cert
1808 // path. If any cert can't be issued, return before binding anything (no plaintext downgrade).
1809 let mut resolved = std::collections::BTreeMap::new();
1810 for (port, target) in &state.ports {
1811 let acceptor = if target.terminates_tls() {
1812 let cfg = ts_control::ServeConfig {
1813 name: state.name.clone(),
1814 port: *port,
1815 target: target.clone(),
1816 };
1817 Some(self.listen_tls(&cfg).await.map_err(|_| {
1818 // Cert issuance is fail-closed in this fork; surface as a request error rather
1819 // than ever binding a plaintext TLS port.
1820 Error::Internal(InternalErrorKind::BadRequest)
1821 })?)
1822 } else {
1823 None
1824 };
1825 resolved.insert(
1826 *port,
1827 ts_runtime::serve::ResolvedPort {
1828 target: target.clone(),
1829 acceptor,
1830 },
1831 );
1832 }
1833
1834 // The manager binds the OVERLAY netstack on this node's own tailnet IPv4.
1835 let self_ipv4 = self.ipv4_addr().await?;
1836 let channel = self.channel()?.clone();
1837
1838 let mut slot = self.serve.lock().unwrap_or_else(|e| e.into_inner());
1839 let mgr =
1840 slot.get_or_insert_with(|| ts_runtime::serve::ServeManager::new(channel, self_ipv4));
1841 Ok(mgr.set(state, resolved))
1842 }
1843
1844 /// Expose a tailnet TLS service to the public internet via Tailscale Funnel (like `tsnet`'s
1845 /// `ListenFunnel`), returning a [`FunnelAcceptedReceiver`](ts_runtime::funnel::FunnelAcceptedReceiver)
1846 /// that delivers each TLS-terminated public connection.
1847 ///
1848 /// **Two fail-closed gates, then the live ingress listener.** First the node-attribute gate is
1849 /// fully enforced from this node's own capability map (mirroring Go `ipn.NodeCanFunnel` +
1850 /// `ipn.CheckFunnelPort`): the tailnet admin must have enabled HTTPS and granted the `funnel`
1851 /// node attribute, and `cfg.port` must be in the set the `funnel-ports` capability allows —
1852 /// otherwise this returns [`ts_control::FunnelError::NotAllowed`] /
1853 /// [`ts_control::FunnelError::PortNotAllowed`] before touching any cert or network. Then the
1854 /// node's `*.ts.net` certificate is obtained via the ACME-aware [`Device::get_certificate`] (the
1855 /// Funnel hostname *is* the node's MagicDNS name, so its DNS-01 cert matches); fail-closed on
1856 /// [`ts_control::FunnelError::Cert`] — no self-signed or plaintext fallback.
1857 ///
1858 /// On success a [`FunnelManager`](ts_runtime::funnel::FunnelManager) is registered: its ingress
1859 /// sink is installed into the runtime's peerAPI `/v0/ingress` slot (making that route live without
1860 /// restarting the peerAPI server), and the `HostInfo.IngressEnabled` map-request signal is set so
1861 /// control routes Funnel traffic to this node. Public Funnel bytes arrive as a relay POST to
1862 /// `/v0/ingress`, are membership-gated + `101`-hijacked into a raw stream, TLS-terminated by the
1863 /// manager, and delivered over the returned receiver.
1864 ///
1865 /// **Where the relay comes from.** The public ingress **relay + DNS mapping** that feed
1866 /// `/v0/ingress` are Tailscale infrastructure ([`ts_control::MISSING_FUNNEL_RELAY`]), provisioned
1867 /// automatically against real Tailscale SaaS with a Funnel-enabled ACL; against a self-hosted
1868 /// control plane no relay exists, so the listener is correct but never fed.
1869 ///
1870 /// Anti-leak: Funnel TLS terminates only on the overlay netstack (the hijacked ingress stream
1871 /// arrives on the overlay peerAPI listener), never a host socket; there is no self-signed or
1872 /// plaintext fallback. A new `listen_funnel` replaces the previous manager (its pump + sink tear
1873 /// down); dropping the `Device` tears it down too.
1874 pub async fn listen_funnel(
1875 &self,
1876 cfg: &ts_control::ServeConfig,
1877 opts: ts_control::FunnelOptions,
1878 ) -> Result<ts_runtime::funnel::FunnelAcceptedReceiver, ts_control::FunnelError> {
1879 // Gate 1 (fail-closed, no network): node-attribute + funnel-port access from our cap map.
1880 let me = self
1881 .self_node()
1882 .await
1883 .map_err(|_| ts_control::FunnelError::NotAllowed)?;
1884 cfg.validate()?;
1885 ts_control::funnel_access(&me, cfg.port)?;
1886
1887 // Gate 2 (fail-closed): obtain the node's `*.ts.net` cert via the ACME-aware path and build
1888 // the TLS acceptor. A cert failure surfaces as FunnelError::Cert — never a plaintext listener.
1889 let cert = self
1890 .get_certificate(&cfg.name)
1891 .await
1892 .map_err(ts_control::FunnelError::Cert)?;
1893 let acceptor = ts_control::tls_acceptor(cert).map_err(ts_control::FunnelError::Cert)?;
1894
1895 // `opts.funnel_only` (reject tailnet-internal connections) is accepted for surface stability;
1896 // the ingress data path only ever carries relay-delivered public traffic, so there is no
1897 // tailnet-internal leg on this listener to reject. Documented as a no-op here for now.
1898 let _ = opts;
1899
1900 // Build the funnel manager + its ingress sink + the hand-back receiver, install the sink into
1901 // the runtime's shared peerAPI `/v0/ingress` slot (making the route live), and flip the
1902 // IngressEnabled map signal. Hold the manager on the device so its pump/sink live as long as
1903 // the listener; replacing a prior manager tears the old one down on drop at end of scope.
1904 let (manager, sink, receiver) = ts_runtime::funnel::FunnelManager::new(acceptor);
1905 {
1906 let slot = self.runtime.funnel_ingress_slot();
1907 *slot.lock().unwrap_or_else(|e| e.into_inner()) = Some(sink);
1908 }
1909 self.runtime
1910 .ingress_active_flag()
1911 .store(true, std::sync::atomic::Ordering::Relaxed);
1912
1913 let old = {
1914 let mut held = self.funnel.lock().unwrap_or_else(|e| e.into_inner());
1915 held.replace(manager)
1916 };
1917 drop(old);
1918
1919 Ok(receiver)
1920 }
1921
1922 /// Host a Tailscale **VIP service** (`svc:<label>`) by binding an overlay listener on the
1923 /// service's control-assigned virtual IP (like `tsnet`'s `ListenService`).
1924 ///
1925 /// **Fail-closed.** Mirrors Go `tsnet.Server.ListenService`'s preconditions, enforced from this
1926 /// node's own netmap state ([`ts_control::resolve_service_listen`]): the `name` must be a valid
1927 /// `svc:<dns-label>`, this node must be **tagged** (Go `ErrUntaggedServiceHost`), and control
1928 /// must have assigned the service a VIP address on this node (delivered via the `service-host`
1929 /// node-capability — see [`ts_control::Node::service_addresses`]). Any unmet precondition
1930 /// returns a typed [`ts_control::ServiceError`] before binding anything.
1931 ///
1932 /// When all hold, this binds a [`tcp_listen`][Device::tcp_listen] on the service VIP and the
1933 /// configured `mode` port over the **overlay netstack** (never a host socket) and returns the
1934 /// listener. The netstack already accepts packets for control-assigned VIPs (they are injected
1935 /// alongside the node's own tailnet address), so the listener is reachable by tailnet peers.
1936 ///
1937 /// The `Tun`/L3 service mode is unsupported (a TODO in upstream tsnet); only TCP/HTTP modes
1938 /// (which bind the same VIP:port at the listen layer) are offered. Returns an error in TUN
1939 /// transport mode (there is no application netstack to bind on).
1940 pub async fn listen_service(
1941 &self,
1942 name: &str,
1943 mode: ts_control::ServiceMode,
1944 ) -> Result<netstack::TcpListener, ts_control::ServiceError> {
1945 let me = self
1946 .self_node()
1947 .await
1948 .map_err(|e| ts_control::ServiceError::Listen(e.to_string()))?;
1949 let listen_addr = ts_control::resolve_service_listen(&me, name, mode, self.enable_ipv6)?;
1950 self.tcp_listen(listen_addr)
1951 .await
1952 .map_err(|e| ts_control::ServiceError::Listen(e.to_string()))
1953 }
1954
1955 /// Attempt to gracefully shut down this device's runtime.
1956 ///
1957 /// Reports whether the device was fully shut down before the timeout. It is still shut
1958 /// down if it timed out, just more violently and with potential resource leaks.
1959 ///
1960 /// If `timeout` is `None`, then shutdown will never time-out.
1961 pub async fn shutdown(self, timeout: Option<Duration>) -> bool {
1962 self.runtime.graceful_shutdown(timeout).await
1963 }
1964}
1965
1966/// Command-channel-driven userspace network stack.
1967///
1968/// This is an opinionated wrapper around [smoltcp](https://docs.rs/smoltcp) that provides an
1969/// easier-to-integrate, more-portable API.
1970pub mod netstack {
1971 #[doc(inline)]
1972 pub use ts_netstack_smoltcp::netcore::Error;
1973 #[doc(inline)]
1974 pub use ts_netstack_smoltcp::netcore::InternalErrorKind;
1975 #[doc(inline)]
1976 pub use ts_netstack_smoltcp::netsock::{TcpListener, TcpStream, UdpSocket};
1977}
1978
1979/// Geneve (RFC 8926) framing for Tailscale **peer-relay** traffic. A peer that advertises
1980/// [`NodeInfo::is_peer_relay`] runs a UDP relay server; relayed disco + WireGuard frames are
1981/// Geneve-encapsulated with a VNI. This module exposes the header codec so the framing is
1982/// recognizable. NOTE: the active relay *data path* (the relay-allocation handshake +
1983/// magicsock integration) is **not yet implemented** in this fork — this is the wire-aware slice.
1984pub mod geneve {
1985 #[doc(inline)]
1986 pub use ts_packet::geneve::{
1987 GENEVE_FIXED_HEADER_LEN, GENEVE_PROTOCOL_DISCO, GENEVE_PROTOCOL_WIREGUARD, GeneveError,
1988 GeneveHeader,
1989 };
1990}
1991
1992/// Tailnet Lock (TKA) verification: the [`tka::Authority`] checks a peer's node-key signature
1993/// against the trusted-key state, mirroring Go's `tka` package. Pair with [`Device::tka_status`]
1994/// (the control-pushed head/disablement signal).
1995pub mod tka {
1996 #[doc(inline)]
1997 pub use ts_tka::{
1998 AumHash, AumKind, Authority, Key, KeyKind, NodeKeySignature, SigKind, State, TkaError,
1999 aum_hash,
2000 };
2001}
2002
2003/// Tailscale cryptographic key types.
2004pub mod keys {
2005 #[doc(inline)]
2006 pub use ts_keys::{
2007 DiscoKeyPair, DiscoPrivateKey, DiscoPublicKey, MachineKeyPair, MachinePrivateKey,
2008 MachinePublicKey, NetworkLockKeyPair, NetworkLockPrivateKey, NetworkLockPublicKey,
2009 NodeKeyPair, NodePrivateKey, NodePublicKey, NodeState, PersistState,
2010 };
2011}
2012
2013const ENV_MAGIC_VAR: &str = "TS_RS_EXPERIMENT";
2014const ENV_MAGIC_VALUE: &str = "this_is_unstable_software";
2015
2016fn check_magic_env() -> Result<(), Error> {
2017 if std::env::var(ENV_MAGIC_VAR).as_deref() != Ok(ENV_MAGIC_VALUE) {
2018 let warning = format!(
2019 "
2020check failed: set {ENV_MAGIC_VAR}={ENV_MAGIC_VALUE} to acknowledge that tailscale-rs is early-days
2021experimental software containing bugs, unvalidated cryptography, and no stability or compatibility
2022guarantees.
2023 "
2024 );
2025
2026 eprintln!("{}", warning.trim());
2027
2028 return Err(Error::UnstableEnvVar);
2029 };
2030
2031 Ok(())
2032}
2033
2034#[cfg(test)]
2035mod tests {
2036 use secrecy::ExposeSecret as _;
2037
2038 use super::*;
2039
2040 // `Device::new`/`new_with_secret` cannot be unit-tested end-to-end without a live control
2041 // server (registration). The only behavioral difference `new_with_secret` introduces over `new`
2042 // is exposing the `SecretString` to a plain `String` on the last inch; everything after is the
2043 // shared `new` path. So we assert that equivalence at the auth-key-resolution level: the secret
2044 // path must resolve to the exact same key the plain path feeds into `resolve_auth_key`.
2045 const SAMPLE_KEY: &str = "tskey-auth-koCgSLP5R811CNTRL-EXAMPLEEXAMPLEEXAMPLEEXAMPLE";
2046
2047 // The mapping `new_with_secret` applies (`Option<SecretString>` -> `Option<String>`) must be a
2048 // byte-for-byte round-trip, so the spawn arg is identical to a direct `new(config, Some(..))`.
2049 #[test]
2050 fn secret_exposes_to_identical_string() {
2051 let plain = Some(SAMPLE_KEY.to_string());
2052 let from_secret =
2053 Some(SecretString::from(SAMPLE_KEY)).map(|s| s.expose_secret().to_string());
2054 assert_eq!(from_secret, plain);
2055
2056 // `None` must pass through unchanged (so it falls back to `config.auth_key` exactly as `new`).
2057 let none_secret: Option<SecretString> = None;
2058 assert_eq!(
2059 none_secret.map(|s| s.expose_secret().to_string()),
2060 None::<String>
2061 );
2062 }
2063
2064 // End-to-end equivalence at the resolve layer: feeding the exposed secret through
2065 // `resolve_auth_key` yields the same `Option<String>` as feeding the plain string — i.e. both
2066 // constructors reach the same spawn argument, without registering against a control server.
2067 #[tokio::test]
2068 async fn new_with_secret_resolves_same_as_new() {
2069 let config = Config::default();
2070
2071 let via_plain = resolve_auth_key(&config, Some(SAMPLE_KEY.to_string()))
2072 .await
2073 .expect("plain auth key resolves");
2074
2075 let exposed = Some(SecretString::from(SAMPLE_KEY)).map(|s| s.expose_secret().to_string());
2076 let via_secret = resolve_auth_key(&config, exposed)
2077 .await
2078 .expect("secret-derived auth key resolves");
2079
2080 assert_eq!(via_plain, via_secret);
2081 // Without the `identity-federation` feature `resolve_auth_key` is a pass-through, so the
2082 // resolved key is the input verbatim; assert that too to pin the default-build behavior.
2083 #[cfg(not(feature = "identity-federation"))]
2084 assert_eq!(via_secret, Some(SAMPLE_KEY.to_string()));
2085 }
2086}