Skip to main content

datumesh_http/
config.rs

1//! The mesh's configuration: [`Config`], from code or from the environment
2//! ([`Config::from_env`]).
3//!
4//! Secrets never come from here directly: the signing key and the API keys are read from
5//! files that must have mode 0600 ([`read_secret_file`]).
6
7use std::collections::BTreeMap;
8use std::fmt;
9use std::path::Path;
10use std::time::Duration;
11
12use datumesh_core::json::{self, Value};
13use datumesh_core::lexical;
14
15use crate::apikeys::ApiKeys;
16
17/// The default wall-clock budget of a request before it is answered `pending` (SPEC 5.5).
18pub const DEFAULT_BUDGET: Duration = Duration::from_secs(1);
19/// The default size of the blocking pool, which is the concurrency limit of evaluation and
20/// store access (see the crate documentation for why).
21pub const DEFAULT_POOL_SIZE: usize = 32;
22/// The default bound on a `POST /cells` batch.
23pub const DEFAULT_BATCH_MAX: usize = 1000;
24/// The default number of members in one JSON page of `GET /slice`.
25pub const DEFAULT_SLICE_PAGE: usize = 1000;
26/// The bound on a JSON page of `GET /slice` (`limit=`).
27pub const MAX_SLICE_PAGE: usize = 10_000;
28/// The bound on the members of a slice served (SPEC 10.1: a manifest has at most 1,048,576).
29pub const MAX_SLICE_MEMBERS: usize = 1_048_576;
30
31/// Rate limits (token buckets), per minute. Refused requests are answered `rate_limited`
32/// with `retry_after_seconds` and `Retry-After`; nothing is ever queued.
33#[non_exhaustive]
34#[derive(Clone, Debug, PartialEq, Eq)]
35pub struct RateLimits {
36    /// Whether limits apply at all (default true).
37    pub enabled: bool,
38    /// Requests per minute per client IP without an API key (default 60).
39    pub per_ip: u32,
40    /// The burst per IP: the bucket's capacity (default 120).
41    pub ip_burst: u32,
42    /// Requests per minute per API key, unless the key's own line says otherwise (default
43    /// 600; the burst is the same number).
44    pub per_key: u32,
45    /// `POST /verify` per minute per IP, with or without a key (default 60; burst the same).
46    pub verify_per_ip: u32,
47    /// Cells per request token in a `POST /cells` batch (default 50: a batch of 1,000 cells
48    /// counts as 20 requests).
49    pub batch_cells_per_token: u32,
50}
51
52impl Default for RateLimits {
53    fn default() -> Self {
54        RateLimits {
55            enabled: true,
56            per_ip: 60,
57            ip_burst: 120,
58            per_key: 600,
59            verify_per_ip: 60,
60            batch_cells_per_token: 50,
61        }
62    }
63}
64
65/// Cache lifetimes. Content-addressed objects (descriptors, receipts, manifests, blobs) never
66/// expire: their bytes are fixed by their hash.
67#[non_exhaustive]
68#[derive(Clone, Debug, PartialEq, Eq)]
69pub struct Ttls {
70    /// A foreign host's key document (default 300 s). A receipt signed with a key id the
71    /// cached document lacks refetches it at once (at most every `key_refetch`).
72    pub key_doc: Duration,
73    /// The shortest interval between two fetches of one host's key document (default 10 s).
74    pub key_refetch: Duration,
75    /// A foreign host's mesh document (default 300 s).
76    pub mesh_doc: Duration,
77    /// How long a foreign name's binding, confirmed with its mesh, stands for requests
78    /// without an asof or with a later one (default 60 s).
79    pub binding: Duration,
80    /// How long a foreign cell's latest version, confirmed with its mesh, stands for requests
81    /// without an asof or with a later one (default 60 s).
82    pub current: Duration,
83    /// `max-age` of answers to requests without an asof (default 10 s).
84    pub latest_max_age: Duration,
85    /// How long a completed job's result is kept after it is first served, and after it
86    /// completes when it is never served, while the mesh runs (default and minimum 300 s, SPEC 5.5).
87    pub job: Duration,
88}
89
90impl Default for Ttls {
91    fn default() -> Self {
92        Ttls {
93            key_doc: Duration::from_secs(300),
94            key_refetch: Duration::from_secs(10),
95            mesh_doc: Duration::from_secs(300),
96            binding: Duration::from_secs(60),
97            current: Duration::from_secs(60),
98            latest_max_age: Duration::from_secs(10),
99            job: Duration::from_secs(300),
100        }
101    }
102}
103
104/// What a function's cells need (the licence and payment stubs of step 1.4).
105#[non_exhaustive]
106#[derive(Clone, Debug, PartialEq, Eq)]
107pub enum Rule {
108    /// Only these principals (API key owners) may receive the function's cells; anyone
109    /// else is answered `unlicensed`.
110    Principals(Vec<String>),
111    /// The function's cells are sold: `payment_required` with this quote (a stub until
112    /// prepaid balances, 3.3).
113    Price {
114        /// The amount (SPEC 3.1, greater than zero).
115        amount: String,
116        /// A currency code of `units.md`.
117        currency: String,
118    },
119}
120
121/// Per-function rules, by fully qualified function name. Functions without one are free.
122#[non_exhaustive]
123#[derive(Clone, Debug, Default, PartialEq, Eq)]
124pub struct Policy {
125    /// The rules.
126    pub rules: BTreeMap<String, Rule>,
127}
128
129impl Policy {
130    /// The rule of a function, if any.
131    pub fn rule(&self, fn_name: &str) -> Option<&Rule> {
132        self.rules.get(fn_name)
133    }
134
135    /// From JSON: `{"<function>": {"principals": ["..."]} | {"price": {"amount", "currency"}}}`.
136    pub fn from_json(bytes: &[u8]) -> Result<Policy, ConfigError> {
137        let v = json::parse(bytes).map_err(|e| ConfigError::new("policy", e.to_string()))?;
138        let mut rules = BTreeMap::new();
139        for (name, r) in v.as_object().ok_or_else(|| ConfigError::new("policy", "not an object"))? {
140            lexical::check_function_name(name, "$").map_err(|e| ConfigError::new("policy", e.to_string()))?;
141            let rule = if let Some(Value::Array(ps)) = r.get("principals") {
142                Rule::Principals(
143                    ps.iter()
144                        .map(|p| p.as_str().map(str::to_string).ok_or_else(|| ConfigError::new("policy", "principal")))
145                        .collect::<Result<_, _>>()?,
146                )
147            } else if let Some(p) = r.get("price") {
148                let amount =
149                    p.get("amount").and_then(Value::as_str).ok_or_else(|| ConfigError::new("policy", "amount"))?;
150                let currency =
151                    p.get("currency").and_then(Value::as_str).ok_or_else(|| ConfigError::new("policy", "currency"))?;
152                lexical::check_number(amount, "$").map_err(|e| ConfigError::new("policy", e.to_string()))?;
153                if amount.starts_with('-') || amount == "0" || !lexical::is_currency(currency) {
154                    return Err(ConfigError::new("policy", format!("price of {name}")));
155                }
156                Rule::Price { amount: amount.to_string(), currency: currency.to_string() }
157            } else {
158                return Err(ConfigError::new("policy", format!("rule of {name}")));
159            };
160            rules.insert(name.clone(), rule);
161        }
162        Ok(Policy { rules })
163    }
164}
165
166/// The mesh's configuration.
167#[non_exhaustive]
168#[derive(Clone, Debug)]
169pub struct Config {
170    /// The DNS name the mesh signs as (`computed_by`) and serves on: `https://<host>/...`
171    /// (e.g. `mesh-test.datumesh.com`), unless [`Config::base_url`] says otherwise.
172    pub host: String,
173    /// Where the mesh is served when not at `https://<host>`, e.g. `http://127.0.0.1:8787`
174    /// for a mesh on this machine (default: none): the base of every URL in the mesh
175    /// document (`bindings` and the endpoints, [`crate::Mesh::mesh_document`]). `https://`
176    /// with any host; `http://` only when the mesh's `host` is unrooted (its last label is
177    /// `invalid`, SPEC 2.5, e.g. `local.invalid`) and only with `127.0.0.1`, `[::1]` or
178    /// `localhost`; an optional port; no path, query, fragment or trailing slash
179    /// ([`check_base_url`]; [`crate::MeshBuilder::build`] refuses another with
180    /// [`crate::BuildError::BaseUrl`]).
181    ///
182    /// An `http://` mesh document is for local use only: it is not valid under spec-0.4.3
183    /// (9.6 wants `https://` URLs on the host), and core 0.3.6's `resolve_mesh` refuses it.
184    /// spec-0.4.4 will allow exactly this: for an unrooted host, mesh-document URLs and
185    /// `poll` may be `http://` on a loopback address only (`127.0.0.1`, `[::1]`,
186    /// `localhost`); rooted hosts stay `https://`-only. datumesh-core 0.3.8 will accept it.
187    /// The key document and `host` do not change, nor do the URLs in envelopes and headers
188    /// (a `pending` envelope's `poll`, a page's `next`, the `canonical` link), which stay
189    /// [`Config::origin`]: SPEC 5.5 makes `poll` an `https://` URL, and a client maps
190    /// `https://<host>/` onto where it reaches the mesh (its peers).
191    pub base_url: Option<String>,
192    /// The hosts whose names this mesh owns (default: `host`). A name under any other host
193    /// is resolved across meshes.
194    pub namespaces: Vec<String>,
195    /// The wall-clock budget of a request before it is answered `pending` (default 1 s).
196    pub budget: Duration,
197    /// The blocking pool's size: the concurrency limit (default 32).
198    pub pool_size: usize,
199    /// The most cells in one `POST /cells` (default 1,000).
200    pub batch_max: usize,
201    /// Whether each held test is a computed cell `<host>/test_case(function_hash, case)` (E5:
202    /// `DATUMESH_TEST_CELLS=1`, mesh-test). Off on production: no test cells until named.
203    pub test_cells: bool,
204    /// The default JSON page of `GET /slice` (default 1,000; at most 10,000 with `limit=`).
205    pub slice_page: usize,
206    /// The most members one slice read serves (default 1,048,576).
207    pub slice_max: usize,
208    /// The depth of `GET /explain` by default (default 4; at most 16 with `depth=`).
209    pub explain_depth: usize,
210    /// The most jobs held at once, running or done (default 10,000).
211    pub max_jobs: usize,
212    /// Rate limits.
213    pub rate: RateLimits,
214    /// Cache lifetimes.
215    pub ttl: Ttls,
216    /// Take the client IP from the last `X-Forwarded-For` entry (behind Caddy) instead of
217    /// the peer address (default false).
218    pub trust_proxy: bool,
219    /// Resolve names under hosts this mesh does not own (default true).
220    pub cross_mesh: bool,
221    /// When set, the only other hosts whose names are resolved across meshes; names under
222    /// any other host are not served (`not_covered`). Default: every host.
223    pub cross_mesh_hosts: Option<Vec<String>>,
224    /// Origins to use instead of `https://<host>` for some hosts, e.g. `mesh-b.example` ->
225    /// `http://127.0.0.1:8081` (tests and private networks only; the default is none).
226    pub peers: BTreeMap<String, String>,
227    /// The time limit of one request to another mesh (default 10 s; SPEC 9.3's bound).
228    pub peer_timeout: Duration,
229    /// Short names of the call syntax: `@alias` -> fully qualified name.
230    pub aliases: BTreeMap<String, String>,
231    /// Licence and payment rules.
232    pub policy: Policy,
233    /// Descriptions of the functions `GET /find` searches (name -> description).
234    pub catalog: BTreeMap<String, String>,
235    /// The embedding service's base URL (`DATUMESH_EMBED_URL`, e.g. `http://embed:8080`): vector
236    /// `find` is on when it is set and the store has vectors (default none). Since 0.4.0.
237    pub embed_url: Option<String>,
238    /// API keys (`Authorization: Bearer dm_...`).
239    pub api_keys: ApiKeys,
240}
241
242impl Config {
243    /// The defaults for a mesh signing as `host`.
244    pub fn new(host: impl Into<String>) -> Config {
245        let host = host.into();
246        Config {
247            namespaces: vec![host.clone()],
248            host,
249            base_url: None,
250            budget: DEFAULT_BUDGET,
251            pool_size: DEFAULT_POOL_SIZE,
252            batch_max: DEFAULT_BATCH_MAX,
253            test_cells: false,
254            slice_page: DEFAULT_SLICE_PAGE,
255            slice_max: MAX_SLICE_MEMBERS,
256            explain_depth: 4,
257            max_jobs: 10_000,
258            rate: RateLimits::default(),
259            ttl: Ttls::default(),
260            trust_proxy: false,
261            cross_mesh: true,
262            cross_mesh_hosts: None,
263            peers: BTreeMap::new(),
264            peer_timeout: Duration::from_secs(10),
265            aliases: BTreeMap::new(),
266            policy: Policy::default(),
267            catalog: BTreeMap::new(),
268            embed_url: None,
269            api_keys: ApiKeys::default(),
270        }
271    }
272
273    /// The configuration with this base URL ([`Config::base_url`]); it is checked when the
274    /// mesh is built.
275    pub fn with_base_url(mut self, url: impl Into<String>) -> Config {
276        self.base_url = Some(url.into());
277        self
278    }
279
280    /// The configuration from the environment (`DATUMESH_*`; the README lists them). The
281    /// files named (`DATUMESH_API_KEYS_FILE`, and the others) are read here; the API keys
282    /// file must have mode 0600.
283    pub fn from_env() -> Result<Config, ConfigError> {
284        Config::from_vars(|k| std::env::var(k).ok())
285    }
286
287    /// The configuration from variables `get` answers, as [`Config::from_env`] reads them.
288    pub fn from_vars(get: impl Fn(&str) -> Option<String>) -> Result<Config, ConfigError> {
289        let host = get("DATUMESH_HOST").ok_or_else(|| ConfigError::new("DATUMESH_HOST", "not set"))?;
290        let mut c = Config::new(host);
291        if let Some(v) = get("DATUMESH_BASE_URL").filter(|v| !v.is_empty()) {
292            c.base_url = Some(v);
293        }
294        if let Some(v) = get("DATUMESH_NAMESPACES") {
295            c.namespaces = v.split(',').map(|s| s.trim().to_string()).filter(|s| !s.is_empty()).collect();
296        }
297        let ms = |k: &str, d: Duration| -> Result<Duration, ConfigError> {
298            match get(k) {
299                Some(v) => v.parse::<u64>().map(Duration::from_millis).map_err(|e| ConfigError::new(k, e.to_string())),
300                None => Ok(d),
301            }
302        };
303        let secs = |k: &str, d: Duration| -> Result<Duration, ConfigError> {
304            match get(k) {
305                Some(v) => v.parse::<u64>().map(Duration::from_secs).map_err(|e| ConfigError::new(k, e.to_string())),
306                None => Ok(d),
307            }
308        };
309        let num = |k: &str, d: usize| -> Result<usize, ConfigError> {
310            match get(k) {
311                Some(v) => v.parse::<usize>().map_err(|e| ConfigError::new(k, e.to_string())),
312                None => Ok(d),
313            }
314        };
315        let flag = |k: &str, d: bool| -> Result<bool, ConfigError> {
316            match get(k).as_deref() {
317                None => Ok(d),
318                Some("1" | "true" | "yes") => Ok(true),
319                Some("0" | "false" | "no") => Ok(false),
320                Some(v) => Err(ConfigError::new(k, format!("not a boolean: {v}"))),
321            }
322        };
323        c.budget = ms("DATUMESH_BUDGET_MS", c.budget)?;
324        c.pool_size = num("DATUMESH_POOL_SIZE", c.pool_size)?;
325        c.batch_max = num("DATUMESH_BATCH_MAX", c.batch_max)?;
326        c.test_cells = flag("DATUMESH_TEST_CELLS", c.test_cells)?;
327        c.slice_page = num("DATUMESH_SLICE_PAGE", c.slice_page)?;
328        c.slice_max = num("DATUMESH_SLICE_MAX", c.slice_max)?;
329        c.explain_depth = num("DATUMESH_EXPLAIN_DEPTH", c.explain_depth)?;
330        c.max_jobs = num("DATUMESH_MAX_JOBS", c.max_jobs)?;
331        c.trust_proxy = flag("DATUMESH_TRUST_PROXY", c.trust_proxy)?;
332        c.cross_mesh = flag("DATUMESH_CROSS_MESH", c.cross_mesh)?;
333        c.rate.enabled = flag("DATUMESH_RATE_LIMITS", c.rate.enabled)?;
334        c.rate.per_ip = num("DATUMESH_RATE_PER_IP", c.rate.per_ip as usize)? as u32;
335        c.rate.ip_burst = num("DATUMESH_RATE_IP_BURST", c.rate.ip_burst as usize)? as u32;
336        c.rate.per_key = num("DATUMESH_RATE_PER_KEY", c.rate.per_key as usize)? as u32;
337        c.rate.verify_per_ip = num("DATUMESH_RATE_VERIFY_PER_IP", c.rate.verify_per_ip as usize)? as u32;
338        c.ttl.key_doc = secs("DATUMESH_TTL_KEY_DOC", c.ttl.key_doc)?;
339        c.ttl.mesh_doc = secs("DATUMESH_TTL_MESH_DOC", c.ttl.mesh_doc)?;
340        c.ttl.binding = secs("DATUMESH_TTL_BINDING", c.ttl.binding)?;
341        c.ttl.current = secs("DATUMESH_TTL_CURRENT", c.ttl.current)?;
342        c.ttl.latest_max_age = secs("DATUMESH_LATEST_MAX_AGE", c.ttl.latest_max_age)?;
343        c.ttl.job = secs("DATUMESH_JOB_TTL", c.ttl.job)?;
344        c.peer_timeout = ms("DATUMESH_PEER_TIMEOUT_MS", c.peer_timeout)?;
345        if let Some(v) = get("DATUMESH_CROSS_MESH_HOSTS") {
346            c.cross_mesh_hosts = Some(v.split(',').map(|s| s.trim().to_string()).filter(|s| !s.is_empty()).collect());
347        }
348        if let Some(v) = get("DATUMESH_PEERS") {
349            for pair in v.split(',').map(str::trim).filter(|s| !s.is_empty()) {
350                let (h, o) =
351                    pair.split_once('=').ok_or_else(|| ConfigError::new("DATUMESH_PEERS", "host=origin pairs"))?;
352                c.peers.insert(h.trim().to_string(), o.trim().trim_end_matches('/').to_string());
353            }
354        }
355        if let Some(p) = get("DATUMESH_ALIASES_FILE") {
356            c.aliases = string_map(&read_file(&p)?, "DATUMESH_ALIASES_FILE")?;
357        }
358        if let Some(p) = get("DATUMESH_CATALOG_FILE") {
359            c.catalog = string_map(&read_file(&p)?, "DATUMESH_CATALOG_FILE")?;
360        }
361        if let Some(v) = get("DATUMESH_EMBED_URL").filter(|v| !v.trim().is_empty()) {
362            c.embed_url = Some(v.trim().trim_end_matches('/').to_string());
363        }
364        if let Some(p) = get("DATUMESH_POLICY_FILE") {
365            c.policy = Policy::from_json(&read_file(&p)?)?;
366        }
367        if let Some(p) = get("DATUMESH_API_KEYS_FILE") {
368            c.api_keys = ApiKeys::parse(&read_secret_file(Path::new(&p))?)?;
369        }
370        c.check()?;
371        Ok(c)
372    }
373
374    /// Checks the configuration: names are DNS names and function names, the base URL is
375    /// one ([`check_base_url`]), numbers in range.
376    pub fn check(&self) -> Result<(), ConfigError> {
377        lexical::check_dns_name(&self.host, "$").map_err(|e| ConfigError::new("host", e.to_string()))?;
378        if let Some(u) = &self.base_url {
379            check_base_url(&self.host, u).map_err(|e| ConfigError::new("base URL", format!("{u}: {e}")))?;
380        }
381        for h in &self.namespaces {
382            lexical::check_dns_name(h, "$").map_err(|e| ConfigError::new("namespaces", e.to_string()))?;
383        }
384        for (h, o) in &self.peers {
385            lexical::check_dns_name(h, "$").map_err(|e| ConfigError::new("peers", e.to_string()))?;
386            if !(o.starts_with("http://") || o.starts_with("https://")) {
387                return Err(ConfigError::new("peers", format!("{o}: not an http(s) origin")));
388            }
389        }
390        for (a, n) in &self.aliases {
391            lexical::check_function_name(n, "$").map_err(|e| ConfigError::new("aliases", format!("{a}: {e}")))?;
392        }
393        if self.pool_size == 0 || self.batch_max == 0 || self.slice_page == 0 || self.slice_max == 0 {
394            return Err(ConfigError::new("sizes", "the pool, batch and slice bounds must be positive"));
395        }
396        if self.ttl.job < Duration::from_secs(300) {
397            return Err(ConfigError::new("job TTL", "at least 300 s (SPEC 5.5)"));
398        }
399        if self.budget.is_zero() {
400            return Err(ConfigError::new("budget", "must be positive"));
401        }
402        Ok(())
403    }
404
405    /// Whether this mesh owns the names under `host`.
406    pub fn owns(&self, host: &str) -> bool {
407        self.namespaces.iter().any(|h| h == host)
408    }
409
410    /// `https://<host>`: where this mesh is served, the base of the URLs in its envelopes.
411    pub fn origin(&self) -> String {
412        format!("https://{}", self.host)
413    }
414
415    /// The base of the URLs in the mesh document: the base URL when set, else
416    /// [`Config::origin`].
417    pub fn mesh_document_base(&self) -> String {
418        self.base_url.clone().unwrap_or_else(|| self.origin())
419    }
420}
421
422/// Why a base URL ([`Config::base_url`]) is refused.
423#[non_exhaustive]
424#[derive(Clone, Copy, Debug, PartialEq, Eq)]
425pub enum BaseUrlError {
426    /// Neither `https://` nor `http://` (lower case).
427    Scheme,
428    /// `http://` for a mesh whose host is rooted (not under `.invalid`, SPEC 2.5): rooted
429    /// hosts are served over `https://` only, whatever the base URL's host.
430    HttpRootedHost,
431    /// `http://` (for an unrooted host) with a host other than `127.0.0.1`, `[::1]` and
432    /// `localhost`.
433    HttpNotLoopback,
434    /// No host, userinfo, or a host that is neither a DNS name (lower case), an IPv4 address
435    /// nor an IPv6 address in brackets.
436    Host,
437    /// A port that is not a decimal number from 1 to 65535 (`:` with nothing after it too).
438    Port,
439    /// A path after the host and port.
440    Path,
441    /// A slash alone after the host and port.
442    TrailingSlash,
443    /// A query.
444    Query,
445    /// A fragment.
446    Fragment,
447}
448
449impl fmt::Display for BaseUrlError {
450    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
451        f.write_str(match self {
452            BaseUrlError::Scheme => "not an https:// or http:// URL",
453            BaseUrlError::HttpRootedHost => "http:// is for an unrooted host (under .invalid) only",
454            BaseUrlError::HttpNotLoopback => "http:// is for 127.0.0.1, [::1] and localhost only",
455            BaseUrlError::Host => "not a host name, IPv4 address or bracketed IPv6 address",
456            BaseUrlError::Port => "not a port from 1 to 65535",
457            BaseUrlError::Path => "a path (the base URL is a scheme, a host and a port)",
458            BaseUrlError::TrailingSlash => "a trailing slash",
459            BaseUrlError::Query => "a query",
460            BaseUrlError::Fragment => "a fragment",
461        })
462    }
463}
464
465impl std::error::Error for BaseUrlError {}
466
467/// Checks a base URL ([`Config::base_url`]) for a mesh signing as `host`: `https://` with any
468/// host, or, when `host` is unrooted ([`is_unrooted`]), `http://` with `127.0.0.1`, `[::1]`
469/// or `localhost`; then an optional `:<port>` (1 to 65535) and nothing else: no path, query,
470/// fragment, trailing slash or userinfo. The form is checked first, then the scheme's rule:
471/// `http://` for a rooted host is [`BaseUrlError::HttpRootedHost`] before anything about the
472/// URL's host.
473pub fn check_base_url(host: &str, url: &str) -> Result<(), BaseUrlError> {
474    let mesh_host = host;
475    let (http, rest) = if let Some(r) = url.strip_prefix("https://") {
476        (false, r)
477    } else if let Some(r) = url.strip_prefix("http://") {
478        (true, r)
479    } else {
480        return Err(BaseUrlError::Scheme);
481    };
482    if rest.contains('#') {
483        return Err(BaseUrlError::Fragment);
484    }
485    if rest.contains('?') {
486        return Err(BaseUrlError::Query);
487    }
488    let (authority, path) = rest.split_at(rest.find('/').unwrap_or(rest.len()));
489    match path {
490        "" => {}
491        "/" => return Err(BaseUrlError::TrailingSlash),
492        _ => return Err(BaseUrlError::Path),
493    }
494    if authority.contains('@') {
495        return Err(BaseUrlError::Host);
496    }
497    let (host, port) = if let Some(r) = authority.strip_prefix('[') {
498        let (inside, after) = r.split_once(']').ok_or(BaseUrlError::Host)?;
499        inside.parse::<std::net::Ipv6Addr>().map_err(|_| BaseUrlError::Host)?;
500        let port = match after {
501            "" => None,
502            p => Some(p.strip_prefix(':').ok_or(BaseUrlError::Host)?),
503        };
504        (&authority[..inside.len() + 2], port)
505    } else {
506        let (host, port) = match authority.split_once(':') {
507            Some((h, p)) => (h, Some(p)),
508            None => (authority, None),
509        };
510        if host.parse::<std::net::Ipv4Addr>().is_err() && !is_dns_name(host) {
511            return Err(BaseUrlError::Host);
512        }
513        (host, port)
514    };
515    if let Some(p) = port {
516        let ok = !p.is_empty() && p.len() <= 5 && p.bytes().all(|b| b.is_ascii_digit());
517        if !ok || !(1..=65535).contains(&p.parse::<u32>().unwrap_or(0)) {
518            return Err(BaseUrlError::Port);
519        }
520    }
521    if http && !is_unrooted(mesh_host) {
522        return Err(BaseUrlError::HttpRootedHost);
523    }
524    if http && !matches!(host, "127.0.0.1" | "[::1]" | "localhost") {
525        return Err(BaseUrlError::HttpNotLoopback);
526    }
527    Ok(())
528}
529
530/// Whether a host is unrooted (SPEC 2.5, spec-0.4.3): its last label is `invalid`
531/// (`local.invalid`, `agent-7.local.invalid`). Every other host is rooted.
532pub fn is_unrooted(host: &str) -> bool {
533    host.rsplit('.').next() == Some("invalid")
534}
535
536/// A DNS name in lower case: labels of 1 to 63 of `a-z`, `0-9` and `-`, not starting or
537/// ending with `-`, at most 253 characters.
538fn is_dns_name(h: &str) -> bool {
539    !h.is_empty()
540        && h.len() <= 253
541        && h.split('.').all(|l| {
542            !l.is_empty()
543                && l.len() <= 63
544                && !l.starts_with('-')
545                && !l.ends_with('-')
546                && l.bytes().all(|b| b.is_ascii_lowercase() || b.is_ascii_digit() || b == b'-')
547        })
548}
549
550fn string_map(bytes: &[u8], what: &str) -> Result<BTreeMap<String, String>, ConfigError> {
551    let v = json::parse(bytes).map_err(|e| ConfigError::new(what, e.to_string()))?;
552    let mut out = BTreeMap::new();
553    for (k, x) in v.as_object().ok_or_else(|| ConfigError::new(what, "not an object"))? {
554        let s = x.as_str().ok_or_else(|| ConfigError::new(what, format!("{k}: not a string")))?;
555        out.insert(k.clone(), s.to_string());
556    }
557    Ok(out)
558}
559
560fn read_file(path: &str) -> Result<Vec<u8>, ConfigError> {
561    std::fs::read(path).map_err(|e| ConfigError::new(path, e.to_string()))
562}
563
564/// Reads a file holding a secret, refusing it unless only its owner may read or write it
565/// (mode 0600 or stricter, on Unix).
566pub fn read_secret_file(path: &Path) -> Result<Vec<u8>, ConfigError> {
567    let what = path.display().to_string();
568    let meta = std::fs::metadata(path).map_err(|e| ConfigError::new(&what, e.to_string()))?;
569    #[cfg(unix)]
570    {
571        use std::os::unix::fs::PermissionsExt;
572        let mode = meta.permissions().mode() & 0o777;
573        if mode & 0o077 != 0 {
574            return Err(ConfigError::new(&what, format!("mode {mode:o}: a secret file must be 0600")));
575        }
576    }
577    #[cfg(not(unix))]
578    let _ = meta;
579    std::fs::read(path).map_err(|e| ConfigError::new(&what, e.to_string()))
580}
581
582/// A configuration error: what and why.
583#[derive(Clone, Debug, PartialEq, Eq)]
584pub struct ConfigError {
585    what: String,
586    detail: String,
587}
588
589impl ConfigError {
590    pub(crate) fn new(what: &str, detail: impl Into<String>) -> ConfigError {
591        ConfigError { what: what.to_string(), detail: detail.into() }
592    }
593}
594
595impl fmt::Display for ConfigError {
596    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
597        write!(f, "configuration: {}: {}", self.what, self.detail)
598    }
599}
600
601impl std::error::Error for ConfigError {}