ts_control/
lib.rs

1#![doc = include_str!("../README.md")]
2
3extern crate alloc;
4
5/// Package version of `ts_control` as reported by cargo.
6// TODO(npry): this is used to populate Hostinfo.ipn_version, which requests "long format":
7//  attach build info and whatever else that entails
8const PKG_VERSION: &str = if let Some(version) = option_env!("CARGO_PKG_VERSION") {
9    version
10} else {
11    ""
12};
13
14/// Maximum size of a control-plane RPC response body read into memory.
15///
16/// The control server is the identity trust root, but a buggy/compromised/MITM'd-past-Noise server
17/// must not be able to OOM the client by answering a small request with an unbounded streamed body.
18/// Every control RPC response (register, key-fetch, id-token, set-dns, logout, WIF) carries a small
19/// JSON payload, so 1 MiB is comfortably generous; reads use
20/// [`ResponseExt::collect_bytes_limited`](ts_http_util::ResponseExt::collect_bytes_limited) with this
21/// cap so the allocation is bounded *during* the read. (TKA-sync keeps its own larger 10 MiB bound;
22/// ACME its own 256 KiB bound — those payloads are differently sized.)
23pub(crate) const MAX_CONTROL_RESPONSE: usize = 1024 * 1024;
24
25/// Client-side ACME (Let's Encrypt) DNS-01 cert issuance engine (`acme` feature, SaaS-only).
26#[cfg(feature = "acme")]
27pub mod acme;
28#[cfg(feature = "async_tokio")]
29mod cert;
30mod config;
31mod control_dialer;
32mod derp;
33mod dial_plan;
34mod dns;
35mod hostinfo;
36#[cfg_attr(not(feature = "async_tokio"), expect(dead_code))]
37mod map_request_builder;
38mod node;
39#[cfg(feature = "async_tokio")]
40mod serve;
41mod service;
42mod ssh_policy;
43mod tka;
44#[cfg(feature = "async_tokio")]
45mod tokio;
46#[cfg(feature = "identity-federation")]
47pub mod wif;
48
49use std::fmt;
50
51#[cfg(feature = "async_tokio")]
52pub use cert::{
53    CertError, MISSING_CERT_RPC, certified_key_from_pem, get_certificate, is_tailnet_name,
54};
55#[cfg(feature = "acme")]
56pub use cert::{
57    PublishTxt, SetDnsPublisher, issue_cert_pair_via_setdns, issue_certificate_via_setdns,
58};
59#[doc(inline)]
60pub use config::{
61    Config, DEFAULT_CONTROL_SERVER, DEFAULT_PERSISTENT_KEEPALIVE, ExitProxyConfig, ExitProxyScheme,
62    TransportMode, TunConfig, services_hash,
63};
64pub use control_dialer::{ControlDialer, TcpDialer, complete_connection};
65pub use derp::{Map as DerpMap, Region as DerpRegion, convert_derp_map};
66pub use dial_plan::{DialCandidate, DialMode, DialPlan};
67pub use dns::{DnsConfig, ExtraRecord, Resolver as DnsResolver, ResolverTransport};
68pub use node::{
69    ExitNodeSelector, Id as NodeId, Node, NodeCapMap, PeerChange, StableId as StableNodeId,
70    TailnetAddress, UserProfile, is_tailscale_ip, validate_service_name,
71};
72#[cfg(feature = "async_tokio")]
73pub use serve::{
74    FunnelError, FunnelOptions, MISSING_FUNNEL_RELAY, ServeConfig, ServeState, ServeTarget,
75    accept_tls, funnel_access, listen_funnel, listen_tls, tls_acceptor,
76};
77pub use service::{ServiceError, ServiceMode, resolve_service_listen};
78pub use ssh_policy::{
79    SshAccept, SshAction, SshConnIdentity, SshDecision, SshDenyReason, SshPolicy, SshPrincipal,
80    SshRule,
81};
82pub use tka::TkaStatus;
83pub use ts_control_serde::{
84    Endpoint, EndpointType, NODE_ATTR_SUGGEST_EXIT_NODE, TkaBootstrapRequest, TkaBootstrapResponse,
85    TkaDisableRequest, TkaDisableResponse, TkaInitBeginRequest, TkaInitBeginResponse,
86    TkaInitFinishRequest, TkaInitFinishResponse, TkaSignInfo, TkaSubmitSignatureRequest,
87    TkaSubmitSignatureResponse, TkaSyncOfferRequest, TkaSyncOfferResponse, TkaSyncSendRequest,
88    TkaSyncSendResponse, UserId,
89};
90#[cfg(feature = "identity-federation")]
91pub use wif::{WifConfig, WifError, resolve_auth_key};
92
93/// Re-exported TLS types from the `tokio-rustls`/`ring` stack used by `cert`/`serve`, so
94/// embedders can name [`get_certificate`]/[`listen_tls`] return types without taking their own
95/// direct `tokio-rustls` dependency (and risking a second, mismatched crypto provider).
96#[cfg(feature = "async_tokio")]
97pub mod tls {
98    pub use tokio_rustls::{TlsAcceptor, rustls::sign::CertifiedKey, server::TlsStream};
99}
100
101#[cfg(feature = "async_tokio")]
102pub use crate::tokio::{
103    AsyncControlClient, FilterUpdate, IdTokenError, LogoutError, LogoutInternalErrorKind,
104    PeerUpdate, SetDnsError, SetDnsInternalErrorKind, StateUpdate, TkaSyncError,
105    TkaSyncInternalErrorKind, fetch_id_token, logout, set_dns, tka_bootstrap, tka_disable,
106    tka_init_begin, tka_init_finish, tka_submit_signature, tka_sync_offer, tka_sync_send,
107};
108
109/// An error which occurred while connecting to the control server or control plane.
110#[derive(Debug, thiserror::Error, Clone, Eq, PartialEq)]
111pub enum Error {
112    /// A machine was not authorized by control to join tailnet; authorize via the supplied URL.
113    #[error("machine was not authorized by control to join tailnet, authorize at {0}")]
114    MachineNotAuthorized(url::Url),
115
116    /// A machine is not yet authorized and control offered **no** interactive auth URL — it is
117    /// awaiting admin approval on an approval-gated tailnet. **Transient and recoverable**: the node
118    /// holds a valid key and must poll-and-retry registration until an admin approves, then it comes
119    /// up with no re-registration (Go's `ipn.State::NeedsMachineAuth` → `Starting` auto-transition).
120    /// Distinct from [`Internal`](Self::Internal)`(MachineAuthorization, _)` so the control runner can
121    /// tell "awaiting approval" (poll) apart from a hard internal failure (stop), and from
122    /// [`MachineNotAuthorized`](Self::MachineNotAuthorized) which carries a URL for interactive login.
123    #[error("machine awaiting admin approval to join tailnet (no interactive auth URL)")]
124    NeedsMachineAuth,
125
126    /// The user supplied an invalid URL.
127    #[error("invalid URL: {0}")]
128    InvalidUrl(url::Url),
129
130    /// Control rejected registration with a specific reason (e.g. a bad/expired/unknown auth key).
131    /// The string is control's verbatim `RegisterResponse.Error` message.
132    #[error("control rejected registration: {0}")]
133    Registration(String),
134
135    /// Control rate-limited us (HTTP 429). The [`Duration`](core::time::Duration) is the
136    /// server-requested cooldown (from `Retry-After`); the retry loop waits exactly this before the
137    /// next attempt rather than its own backoff, so we never re-hit control inside the cooldown.
138    #[error("control rate limited the request; retry after {0:?}")]
139    RateLimited(core::time::Duration),
140
141    /// Some kind of networking error.
142    ///
143    /// These might be addressed by retrying, or might be an unresolvable error.
144    ///
145    /// [`Operation`] is intended to be informational, rather then inspected during handling.
146    #[error("a networking error occurred in {0}")]
147    NetworkError(Operation),
148
149    /// An internal error that users of the library are not expected to handle.
150    ///
151    /// [`InternalErrorKind`] and [`Operation`] are intended to be informational, rather then
152    /// inspected during handling.
153    #[error("{0} error in {1}")]
154    Internal(InternalErrorKind, Operation),
155}
156
157impl Error {
158    fn io_error(err: std::io::Error, op: Operation) -> Self {
159        if crate::is_network_error(&err) {
160            Error::NetworkError(op)
161        } else {
162            Error::Internal(InternalErrorKind::Io, op)
163        }
164    }
165}
166
167/// What kind of internal error has occurred.
168///
169/// This is intended to be useful for reporting a crash to an end user, rather than being handled.
170#[non_exhaustive]
171#[derive(Debug, Clone, Copy, Eq, PartialEq)]
172pub enum InternalErrorKind {
173    /// An error in URL parsing.
174    Url,
175    /// An unsuccessful HTTP request or upgrade.
176    Http,
177    /// An error in serialization or deserialization.
178    SerDe,
179    /// An error in I/O.
180    Io,
181    /// An invalid message format.
182    MessageFormat,
183    /// An error parsing a string as UTF8.
184    Utf8,
185    /// Noise framework handshake.
186    NoiseHandshake,
187    /// Tailscale challenge packet.
188    Challenge,
189    /// The user's machine was not authorized to register with a Tailnet and there is no URL for
190    /// the user to authorize at.
191    MachineAuthorization,
192}
193
194impl fmt::Display for InternalErrorKind {
195    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
196        match self {
197            InternalErrorKind::Url => write!(f, "URL parsing error"),
198            InternalErrorKind::Http => write!(f, "unsuccessful HTTP request or upgrade"),
199            InternalErrorKind::SerDe => write!(f, "serialization/deserialization error"),
200            InternalErrorKind::Io => write!(f, "I/O error"),
201            InternalErrorKind::MessageFormat => write!(f, "message format error"),
202            InternalErrorKind::Utf8 => write!(f, "invalid UTF8"),
203            InternalErrorKind::NoiseHandshake => write!(f, "error in Noise handshake"),
204            InternalErrorKind::Challenge => write!(f, "error with Tailscale challenge packet"),
205            InternalErrorKind::MachineAuthorization => {
206                write!(f, "machine not authorized to register with Tailnet")
207            }
208        }
209    }
210}
211
212/// The phase of connecting the control plane to a Tailnet in which an error occurs.
213#[derive(Debug, Clone, Copy, Eq, PartialEq)]
214pub enum Operation {
215    /// Requesting a net map.
216    MapRequest,
217    /// Connecting to a control server.
218    ConnectToControlServer,
219    /// Registering the user's device with a Tailnet.
220    Registration,
221}
222
223impl fmt::Display for Operation {
224    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
225        match self {
226            Operation::MapRequest => write!(f, "net map request"),
227            Operation::ConnectToControlServer => write!(f, "connection to control server"),
228            Operation::Registration => write!(f, "registration"),
229        }
230    }
231}
232
233impl From<ts_http_util::Error> for Error {
234    fn from(error: ts_http_util::Error) -> Self {
235        tracing::error!(%error, "http error");
236
237        if http_error_is_recoverable(error) {
238            Error::NetworkError(Operation::ConnectToControlServer)
239        } else {
240            Error::Internal(InternalErrorKind::Http, Operation::ConnectToControlServer)
241        }
242    }
243}
244
245/// Returns true if the input io error should be classed as a network error.
246fn is_network_error(err: &std::io::Error) -> bool {
247    use std::io::ErrorKind::*;
248    matches!(
249        err.kind(),
250        ConnectionRefused
251            | ConnectionReset
252            | HostUnreachable
253            | NetworkUnreachable
254            | ConnectionAborted
255            | NotConnected
256            | TimedOut
257            | AddrNotAvailable
258            | Interrupted
259            | NetworkDown
260    )
261}
262
263/// Returns true if the error is likely to be a transient network error.
264fn http_error_is_recoverable(error: ts_http_util::Error) -> bool {
265    match error {
266        ts_http_util::Error::Io => true,
267        ts_http_util::Error::InvalidInput
268        // A TCP timeout (recoverable) should get classed as an IO error, so any other kind of
269        // timeout is probably not.
270        | ts_http_util::Error::Timeout
271        | ts_http_util::Error::InvalidResponse
272        // A peer that streamed an over-cap body is an attack/misconfig signal, not a transient
273        // blip — terminal, do not retry.
274        | ts_http_util::Error::BodyTooLarge => false,
275        // In the future, this might be recoverable with a reset.
276        ts_http_util::Error::ConnectionClosed => false,
277    }
278}
ts_control/lib.rs

ts_control/
lib.rs
