1use 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
17pub const DEFAULT_BUDGET: Duration = Duration::from_secs(1);
19pub const DEFAULT_POOL_SIZE: usize = 32;
22pub const DEFAULT_BATCH_MAX: usize = 1000;
24pub const DEFAULT_SLICE_PAGE: usize = 1000;
26pub const MAX_SLICE_PAGE: usize = 10_000;
28pub const MAX_SLICE_MEMBERS: usize = 1_048_576;
30
31#[non_exhaustive]
34#[derive(Clone, Debug, PartialEq, Eq)]
35pub struct RateLimits {
36 pub enabled: bool,
38 pub per_ip: u32,
40 pub ip_burst: u32,
42 pub per_key: u32,
45 pub verify_per_ip: u32,
47 pub calc_per_ip: u32,
50 pub batch_cells_per_token: u32,
53 pub series_per_ip: u32,
56 pub keys_per_ip: u32,
59}
60
61impl Default for RateLimits {
62 fn default() -> Self {
63 RateLimits {
64 enabled: true,
65 per_ip: 60,
66 ip_burst: 120,
67 per_key: 600,
68 verify_per_ip: 60,
69 calc_per_ip: 30,
70 batch_cells_per_token: 50,
71 series_per_ip: 30,
72 keys_per_ip: 5,
73 }
74 }
75}
76
77#[non_exhaustive]
80#[derive(Clone, Debug, PartialEq, Eq)]
81pub struct Ttls {
82 pub key_doc: Duration,
85 pub key_refetch: Duration,
87 pub mesh_doc: Duration,
89 pub binding: Duration,
92 pub current: Duration,
95 pub latest_max_age: Duration,
97 pub job: Duration,
100}
101
102impl Default for Ttls {
103 fn default() -> Self {
104 Ttls {
105 key_doc: Duration::from_secs(300),
106 key_refetch: Duration::from_secs(10),
107 mesh_doc: Duration::from_secs(300),
108 binding: Duration::from_secs(60),
109 current: Duration::from_secs(60),
110 latest_max_age: Duration::from_secs(10),
111 job: Duration::from_secs(300),
112 }
113 }
114}
115
116#[non_exhaustive]
118#[derive(Clone, Debug, PartialEq, Eq)]
119pub enum Rule {
120 Principals(Vec<String>),
123 Price {
126 amount: String,
128 currency: String,
130 },
131}
132
133#[non_exhaustive]
135#[derive(Clone, Debug, Default, PartialEq, Eq)]
136pub struct Policy {
137 pub rules: BTreeMap<String, Rule>,
139}
140
141impl Policy {
142 pub fn rule(&self, fn_name: &str) -> Option<&Rule> {
144 self.rules.get(fn_name)
145 }
146
147 pub fn from_json(bytes: &[u8]) -> Result<Policy, ConfigError> {
149 let v = json::parse(bytes).map_err(|e| ConfigError::new("policy", e.to_string()))?;
150 let mut rules = BTreeMap::new();
151 for (name, r) in v.as_object().ok_or_else(|| ConfigError::new("policy", "not an object"))? {
152 lexical::check_function_name(name, "$").map_err(|e| ConfigError::new("policy", e.to_string()))?;
153 let rule = if let Some(Value::Array(ps)) = r.get("principals") {
154 Rule::Principals(
155 ps.iter()
156 .map(|p| p.as_str().map(str::to_string).ok_or_else(|| ConfigError::new("policy", "principal")))
157 .collect::<Result<_, _>>()?,
158 )
159 } else if let Some(p) = r.get("price") {
160 let amount =
161 p.get("amount").and_then(Value::as_str).ok_or_else(|| ConfigError::new("policy", "amount"))?;
162 let currency =
163 p.get("currency").and_then(Value::as_str).ok_or_else(|| ConfigError::new("policy", "currency"))?;
164 lexical::check_number(amount, "$").map_err(|e| ConfigError::new("policy", e.to_string()))?;
165 if amount.starts_with('-') || amount == "0" || !lexical::is_currency(currency) {
166 return Err(ConfigError::new("policy", format!("price of {name}")));
167 }
168 Rule::Price { amount: amount.to_string(), currency: currency.to_string() }
169 } else {
170 return Err(ConfigError::new("policy", format!("rule of {name}")));
171 };
172 rules.insert(name.clone(), rule);
173 }
174 Ok(Policy { rules })
175 }
176}
177
178#[non_exhaustive]
180#[derive(Clone, Debug)]
181pub struct Config {
182 pub host: String,
185 pub base_url: Option<String>,
204 pub namespaces: Vec<String>,
207 pub budget: Duration,
209 pub pool_size: usize,
211 pub batch_max: usize,
213 pub test_cells: bool,
216 pub slice_page: usize,
218 pub slice_max: usize,
220 pub explain_depth: usize,
222 pub max_jobs: usize,
224 pub rate: RateLimits,
226 pub ttl: Ttls,
228 pub trust_proxy: bool,
231 pub cross_mesh: bool,
233 pub cross_mesh_hosts: Option<Vec<String>>,
236 pub peers: BTreeMap<String, String>,
239 pub peer_timeout: Duration,
241 pub aliases: BTreeMap<String, String>,
243 pub policy: Policy,
245 pub catalog: BTreeMap<String, String>,
247 pub embed_url: Option<String>,
250 pub api_keys: ApiKeys,
252 pub publish_domains: PublishDomains,
255 pub log_dir: Option<std::path::PathBuf>,
258 pub(crate) series: Vec<crate::series::SeriesPage>,
260 pub key_names: bool,
264 pub key_challenge_ttl: Duration,
266 pub contact: Option<String>,
269 pub series_first_build_delay: Duration,
272 pub series_refresh: Duration,
274}
275
276#[non_exhaustive]
280#[derive(Clone, Debug, PartialEq, Eq, Default)]
281pub enum PublishDomains {
282 #[default]
284 Own,
285 Hosts(Vec<String>),
287 Any,
289}
290
291impl PublishDomains {
292 pub fn parse(v: &str) -> Result<PublishDomains, ConfigError> {
295 let v = v.trim();
296 if v.is_empty() {
297 return Ok(PublishDomains::Own);
298 }
299 if v == "*" {
300 return Ok(PublishDomains::Any);
301 }
302 let mut hosts = Vec::new();
303 for h in v.split(',').map(str::trim).filter(|h| !h.is_empty()) {
304 lexical::check_dns_name(h, "$").map_err(|e| ConfigError::new("DATUMESH_PUBLISH_DOMAINS", e.to_string()))?;
305 hosts.push(h.to_string());
306 }
307 Ok(if hosts.is_empty() { PublishDomains::Own } else { PublishDomains::Hosts(hosts) })
308 }
309
310 pub fn allows(&self, host: &str) -> bool {
312 match self {
313 PublishDomains::Own => false,
314 PublishDomains::Hosts(h) => h.iter().any(|x| x == host),
315 PublishDomains::Any => true,
316 }
317 }
318}
319
320impl Config {
321 pub fn new(host: impl Into<String>) -> Config {
323 let host = host.into();
324 Config {
325 namespaces: vec![host.clone()],
326 host,
327 base_url: None,
328 budget: DEFAULT_BUDGET,
329 pool_size: DEFAULT_POOL_SIZE,
330 batch_max: DEFAULT_BATCH_MAX,
331 test_cells: false,
332 slice_page: DEFAULT_SLICE_PAGE,
333 slice_max: MAX_SLICE_MEMBERS,
334 explain_depth: 4,
335 max_jobs: 10_000,
336 rate: RateLimits::default(),
337 ttl: Ttls::default(),
338 trust_proxy: false,
339 cross_mesh: true,
340 cross_mesh_hosts: None,
341 peers: BTreeMap::new(),
342 peer_timeout: Duration::from_secs(10),
343 aliases: BTreeMap::new(),
344 policy: Policy::default(),
345 catalog: BTreeMap::new(),
346 embed_url: None,
347 api_keys: ApiKeys::default(),
348 publish_domains: PublishDomains::Own,
349 key_names: false,
350 key_challenge_ttl: Duration::from_secs(300),
351 contact: None,
352 series_first_build_delay: Duration::ZERO,
353 series_refresh: Duration::from_secs(300),
354 log_dir: None,
355 series: Vec::new(),
356 }
357 }
358
359 pub fn with_base_url(mut self, url: impl Into<String>) -> Config {
362 self.base_url = Some(url.into());
363 self
364 }
365
366 pub fn from_env() -> Result<Config, ConfigError> {
370 Config::from_vars(|k| std::env::var(k).ok())
371 }
372
373 pub fn from_vars(get: impl Fn(&str) -> Option<String>) -> Result<Config, ConfigError> {
375 let host = get("DATUMESH_HOST").ok_or_else(|| ConfigError::new("DATUMESH_HOST", "not set"))?;
376 let mut c = Config::new(host);
377 if let Some(v) = get("DATUMESH_BASE_URL").filter(|v| !v.is_empty()) {
378 c.base_url = Some(v);
379 }
380 if let Some(v) = get("DATUMESH_NAMESPACES") {
381 c.namespaces = v.split(',').map(|s| s.trim().to_string()).filter(|s| !s.is_empty()).collect();
382 }
383 let ms = |k: &str, d: Duration| -> Result<Duration, ConfigError> {
384 match get(k) {
385 Some(v) => v.parse::<u64>().map(Duration::from_millis).map_err(|e| ConfigError::new(k, e.to_string())),
386 None => Ok(d),
387 }
388 };
389 let secs = |k: &str, d: Duration| -> Result<Duration, ConfigError> {
390 match get(k) {
391 Some(v) => v.parse::<u64>().map(Duration::from_secs).map_err(|e| ConfigError::new(k, e.to_string())),
392 None => Ok(d),
393 }
394 };
395 let num = |k: &str, d: usize| -> Result<usize, ConfigError> {
396 match get(k) {
397 Some(v) => v.parse::<usize>().map_err(|e| ConfigError::new(k, e.to_string())),
398 None => Ok(d),
399 }
400 };
401 let flag = |k: &str, d: bool| -> Result<bool, ConfigError> {
402 match get(k).as_deref() {
403 None => Ok(d),
404 Some("1" | "true" | "yes") => Ok(true),
405 Some("0" | "false" | "no") => Ok(false),
406 Some(v) => Err(ConfigError::new(k, format!("not a boolean: {v}"))),
407 }
408 };
409 c.budget = ms("DATUMESH_BUDGET_MS", c.budget)?;
410 c.pool_size = num("DATUMESH_POOL_SIZE", c.pool_size)?;
411 c.batch_max = num("DATUMESH_BATCH_MAX", c.batch_max)?;
412 c.test_cells = flag("DATUMESH_TEST_CELLS", c.test_cells)?;
413 c.slice_page = num("DATUMESH_SLICE_PAGE", c.slice_page)?;
414 c.slice_max = num("DATUMESH_SLICE_MAX", c.slice_max)?;
415 c.explain_depth = num("DATUMESH_EXPLAIN_DEPTH", c.explain_depth)?;
416 c.max_jobs = num("DATUMESH_MAX_JOBS", c.max_jobs)?;
417 c.trust_proxy = flag("DATUMESH_TRUST_PROXY", c.trust_proxy)?;
418 c.cross_mesh = flag("DATUMESH_CROSS_MESH", c.cross_mesh)?;
419 c.rate.enabled = flag("DATUMESH_RATE_LIMITS", c.rate.enabled)?;
420 c.rate.per_ip = num("DATUMESH_RATE_PER_IP", c.rate.per_ip as usize)? as u32;
421 c.rate.ip_burst = num("DATUMESH_RATE_IP_BURST", c.rate.ip_burst as usize)? as u32;
422 c.rate.per_key = num("DATUMESH_RATE_PER_KEY", c.rate.per_key as usize)? as u32;
423 c.rate.verify_per_ip = num("DATUMESH_RATE_VERIFY_PER_IP", c.rate.verify_per_ip as usize)? as u32;
424 c.rate.series_per_ip = num("DATUMESH_RATE_SERIES_PER_IP", c.rate.series_per_ip as usize)? as u32;
425 c.rate.calc_per_ip = num("DATUMESH_RATE_CALC_PER_IP", c.rate.calc_per_ip as usize)? as u32;
426 c.rate.keys_per_ip = num("DATUMESH_RATE_KEYS_PER_IP", c.rate.keys_per_ip as usize)? as u32;
427 c.key_names = get("DATUMESH_KEY_NAMES").as_deref() == Some("1");
429 c.key_challenge_ttl = secs("DATUMESH_KEY_CHALLENGE_TTL_SECS", c.key_challenge_ttl)?;
430 c.contact = get("DATUMESH_CONTACT").map(|v| v.trim().to_string()).filter(|v| !v.is_empty());
431 c.series_first_build_delay = secs("DATUMESH_SERIES_FIRST_BUILD_DELAY_SECS", c.series_first_build_delay)?;
432 c.series_refresh = secs("DATUMESH_SERIES_REFRESH_SECS", c.series_refresh)?;
433 c.ttl.key_doc = secs("DATUMESH_TTL_KEY_DOC", c.ttl.key_doc)?;
434 c.ttl.mesh_doc = secs("DATUMESH_TTL_MESH_DOC", c.ttl.mesh_doc)?;
435 c.ttl.binding = secs("DATUMESH_TTL_BINDING", c.ttl.binding)?;
436 c.ttl.current = secs("DATUMESH_TTL_CURRENT", c.ttl.current)?;
437 c.ttl.latest_max_age = secs("DATUMESH_LATEST_MAX_AGE", c.ttl.latest_max_age)?;
438 c.ttl.job = secs("DATUMESH_JOB_TTL", c.ttl.job)?;
439 c.peer_timeout = ms("DATUMESH_PEER_TIMEOUT_MS", c.peer_timeout)?;
440 if let Some(v) = get("DATUMESH_CROSS_MESH_HOSTS") {
441 c.cross_mesh_hosts = Some(v.split(',').map(|s| s.trim().to_string()).filter(|s| !s.is_empty()).collect());
442 }
443 if let Some(v) = get("DATUMESH_PEERS") {
444 for pair in v.split(',').map(str::trim).filter(|s| !s.is_empty()) {
445 let (h, o) =
446 pair.split_once('=').ok_or_else(|| ConfigError::new("DATUMESH_PEERS", "host=origin pairs"))?;
447 c.peers.insert(h.trim().to_string(), o.trim().trim_end_matches('/').to_string());
448 }
449 }
450 if let Some(p) = get("DATUMESH_ALIASES_FILE") {
451 c.aliases = string_map(&read_file(&p)?, "DATUMESH_ALIASES_FILE")?;
452 }
453 if let Some(p) = get("DATUMESH_CATALOG_FILE") {
454 c.catalog = string_map(&read_file(&p)?, "DATUMESH_CATALOG_FILE")?;
455 }
456 if let Some(v) = get("DATUMESH_EMBED_URL").filter(|v| !v.trim().is_empty()) {
457 c.embed_url = Some(v.trim().trim_end_matches('/').to_string());
458 }
459 if let Some(p) = get("DATUMESH_POLICY_FILE") {
460 c.policy = Policy::from_json(&read_file(&p)?)?;
461 }
462 if let Some(p) = get("DATUMESH_API_KEYS_FILE") {
463 c.api_keys = ApiKeys::parse(&read_secret_file(Path::new(&p))?)?;
464 }
465 c.publish_domains = PublishDomains::parse(&get("DATUMESH_PUBLISH_DOMAINS").unwrap_or_default())?;
466 if let Some(p) = get("DATUMESH_SERIES_FILE").filter(|p| !p.trim().is_empty()) {
467 c.series = crate::series::parse(&read_file(&p)?)?;
468 }
469 if let Some(d) = get("DATUMESH_LOG_DIR").filter(|d| !d.trim().is_empty()) {
470 c.log_dir = Some(std::path::PathBuf::from(d));
471 }
472 c.check()?;
473 Ok(c)
474 }
475
476 pub fn check(&self) -> Result<(), ConfigError> {
479 lexical::check_dns_name(&self.host, "$").map_err(|e| ConfigError::new("host", e.to_string()))?;
480 if self.series_refresh < Duration::from_secs(1) {
481 return Err(ConfigError::new("DATUMESH_SERIES_REFRESH_SECS", "at least 1 second"));
482 }
483 if let Some(c) = &self.contact {
484 if c.chars().any(|ch| ch.is_whitespace() || ch.is_control()) {
485 return Err(ConfigError::new("DATUMESH_CONTACT", "an address without spaces"));
486 }
487 }
488 if let Some(u) = &self.base_url {
489 check_base_url(&self.host, u).map_err(|e| ConfigError::new("base URL", format!("{u}: {e}")))?;
490 }
491 for h in &self.namespaces {
492 lexical::check_dns_name(h, "$").map_err(|e| ConfigError::new("namespaces", e.to_string()))?;
493 }
494 for (h, o) in &self.peers {
495 lexical::check_dns_name(h, "$").map_err(|e| ConfigError::new("peers", e.to_string()))?;
496 if !(o.starts_with("http://") || o.starts_with("https://")) {
497 return Err(ConfigError::new("peers", format!("{o}: not an http(s) origin")));
498 }
499 }
500 for (a, n) in &self.aliases {
501 lexical::check_function_name(n, "$").map_err(|e| ConfigError::new("aliases", format!("{a}: {e}")))?;
502 }
503 if self.pool_size == 0 || self.batch_max == 0 || self.slice_page == 0 || self.slice_max == 0 {
504 return Err(ConfigError::new("sizes", "the pool, batch and slice bounds must be positive"));
505 }
506 if self.ttl.job < Duration::from_secs(300) {
507 return Err(ConfigError::new("job TTL", "at least 300 s (SPEC 5.5)"));
508 }
509 if self.budget.is_zero() {
510 return Err(ConfigError::new("budget", "must be positive"));
511 }
512 Ok(())
513 }
514
515 pub fn owns(&self, host: &str) -> bool {
517 self.namespaces.iter().any(|h| h == host)
518 }
519
520 pub fn origin(&self) -> String {
522 format!("https://{}", self.host)
523 }
524
525 pub fn mesh_document_base(&self) -> String {
528 self.base_url.clone().unwrap_or_else(|| self.origin())
529 }
530}
531
532#[non_exhaustive]
534#[derive(Clone, Copy, Debug, PartialEq, Eq)]
535pub enum BaseUrlError {
536 Scheme,
538 HttpRootedHost,
541 HttpNotLoopback,
544 Host,
547 Port,
549 Path,
551 TrailingSlash,
553 Query,
555 Fragment,
557}
558
559impl fmt::Display for BaseUrlError {
560 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
561 f.write_str(match self {
562 BaseUrlError::Scheme => "not an https:// or http:// URL",
563 BaseUrlError::HttpRootedHost => "http:// is for an unrooted host (under .invalid) only",
564 BaseUrlError::HttpNotLoopback => "http:// is for 127.0.0.1, [::1] and localhost only",
565 BaseUrlError::Host => "not a host name, IPv4 address or bracketed IPv6 address",
566 BaseUrlError::Port => "not a port from 1 to 65535",
567 BaseUrlError::Path => "a path (the base URL is a scheme, a host and a port)",
568 BaseUrlError::TrailingSlash => "a trailing slash",
569 BaseUrlError::Query => "a query",
570 BaseUrlError::Fragment => "a fragment",
571 })
572 }
573}
574
575impl std::error::Error for BaseUrlError {}
576
577pub fn check_base_url(host: &str, url: &str) -> Result<(), BaseUrlError> {
584 let mesh_host = host;
585 let (http, rest) = if let Some(r) = url.strip_prefix("https://") {
586 (false, r)
587 } else if let Some(r) = url.strip_prefix("http://") {
588 (true, r)
589 } else {
590 return Err(BaseUrlError::Scheme);
591 };
592 if rest.contains('#') {
593 return Err(BaseUrlError::Fragment);
594 }
595 if rest.contains('?') {
596 return Err(BaseUrlError::Query);
597 }
598 let (authority, path) = rest.split_at(rest.find('/').unwrap_or(rest.len()));
599 match path {
600 "" => {}
601 "/" => return Err(BaseUrlError::TrailingSlash),
602 _ => return Err(BaseUrlError::Path),
603 }
604 if authority.contains('@') {
605 return Err(BaseUrlError::Host);
606 }
607 let (host, port) = if let Some(r) = authority.strip_prefix('[') {
608 let (inside, after) = r.split_once(']').ok_or(BaseUrlError::Host)?;
609 inside.parse::<std::net::Ipv6Addr>().map_err(|_| BaseUrlError::Host)?;
610 let port = match after {
611 "" => None,
612 p => Some(p.strip_prefix(':').ok_or(BaseUrlError::Host)?),
613 };
614 (&authority[..inside.len() + 2], port)
615 } else {
616 let (host, port) = match authority.split_once(':') {
617 Some((h, p)) => (h, Some(p)),
618 None => (authority, None),
619 };
620 if host.parse::<std::net::Ipv4Addr>().is_err() && !is_dns_name(host) {
621 return Err(BaseUrlError::Host);
622 }
623 (host, port)
624 };
625 if let Some(p) = port {
626 let ok = !p.is_empty() && p.len() <= 5 && p.bytes().all(|b| b.is_ascii_digit());
627 if !ok || !(1..=65535).contains(&p.parse::<u32>().unwrap_or(0)) {
628 return Err(BaseUrlError::Port);
629 }
630 }
631 if http && !is_unrooted(mesh_host) {
632 return Err(BaseUrlError::HttpRootedHost);
633 }
634 if http && !matches!(host, "127.0.0.1" | "[::1]" | "localhost") {
635 return Err(BaseUrlError::HttpNotLoopback);
636 }
637 Ok(())
638}
639
640pub fn is_unrooted(host: &str) -> bool {
643 host.rsplit('.').next() == Some("invalid")
644}
645
646fn is_dns_name(h: &str) -> bool {
649 !h.is_empty()
650 && h.len() <= 253
651 && h.split('.').all(|l| {
652 !l.is_empty()
653 && l.len() <= 63
654 && !l.starts_with('-')
655 && !l.ends_with('-')
656 && l.bytes().all(|b| b.is_ascii_lowercase() || b.is_ascii_digit() || b == b'-')
657 })
658}
659
660fn string_map(bytes: &[u8], what: &str) -> Result<BTreeMap<String, String>, ConfigError> {
661 let v = json::parse(bytes).map_err(|e| ConfigError::new(what, e.to_string()))?;
662 let mut out = BTreeMap::new();
663 for (k, x) in v.as_object().ok_or_else(|| ConfigError::new(what, "not an object"))? {
664 let s = x.as_str().ok_or_else(|| ConfigError::new(what, format!("{k}: not a string")))?;
665 out.insert(k.clone(), s.to_string());
666 }
667 Ok(out)
668}
669
670fn read_file(path: &str) -> Result<Vec<u8>, ConfigError> {
671 std::fs::read(path).map_err(|e| ConfigError::new(path, e.to_string()))
672}
673
674pub fn read_secret_file(path: &Path) -> Result<Vec<u8>, ConfigError> {
677 let what = path.display().to_string();
678 let meta = std::fs::metadata(path).map_err(|e| ConfigError::new(&what, e.to_string()))?;
679 #[cfg(unix)]
680 {
681 use std::os::unix::fs::PermissionsExt;
682 let mode = meta.permissions().mode() & 0o777;
683 if mode & 0o077 != 0 {
684 return Err(ConfigError::new(&what, format!("mode {mode:o}: a secret file must be 0600")));
685 }
686 }
687 #[cfg(not(unix))]
688 let _ = meta;
689 std::fs::read(path).map_err(|e| ConfigError::new(&what, e.to_string()))
690}
691
692#[derive(Clone, Debug, PartialEq, Eq)]
694pub struct ConfigError {
695 what: String,
696 detail: String,
697}
698
699impl ConfigError {
700 pub(crate) fn new(what: &str, detail: impl Into<String>) -> ConfigError {
701 ConfigError { what: what.to_string(), detail: detail.into() }
702 }
703}
704
705impl fmt::Display for ConfigError {
706 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
707 write!(f, "configuration: {}: {}", self.what, self.detail)
708 }
709}
710
711impl std::error::Error for ConfigError {}