src/config.rs

   1 // Copyright 2021 Ian Jackson and contributors to Hippotat
   2 // SPDX-License-Identifier: AGPL-3.0-or-later
   3 // There is NO WARRANTY.
   4
   5 use crate::prelude::*;
   6
   7 use configparser::ini::Ini;
   8
   9 static DEFAULT_CONFIG: &str = r#"
  10 [COMMON]
  11 max_batch_down = 65536
  12 max_queue_time = 10
  13 target_requests_outstanding = 3
  14 http_timeout = 30
  15 http_timeout_grace = 5
  16 max_requests_outstanding = 6
  17 max_batch_up = 4000
  18 http_retry = 5
  19 port = 80
  20 vroutes = ''
  21 ifname_client = hippo%%d
  22 ifname_server = shippo%%d
  23 max_clock_skew = 300
  24
  25 ipif = userv root ipif %(local)s,%(peer)s,%(mtu)s,slip,%(ifname)s %(rnets)s
  26
  27 mtu = 1500
  28
  29 vvnetwork = 172.24.230.192
  30
  31 [LIMIT]
  32 max_batch_down = 262144
  33 max_queue_time = 121
  34 http_timeout = 121
  35 target_requests_outstanding = 10
  36 "#;
  37
  38 #[derive(StructOpt,Debug)]
  39 pub struct Opts {
  40   /// Top-level config file or directory
  41   ///
  42   /// Look for `main.cfg`, `config.d` and `secrets.d` here.
  43   ///
  44   /// Or if this is a file, just read that file.
  45   #[structopt(long, default_value="/etc/hippotat")]
  46   pub config: PathBuf,
  47
  48   /// Additional config files or dirs, which can override the others
  49   #[structopt(long, multiple=true, number_of_values=1)]
  50   pub extra_config: Vec<PathBuf>,
  51 }
  52
  53 #[ext]
  54 impl<'s> Option<&'s str> {
  55   #[throws(AE)]
  56   fn value(self) -> &'s str {
  57     self.ok_or_else(|| anyhow!("value needed"))?
  58   }
  59 }
  60
  61 #[derive(Clone)]
  62 pub struct Secret(pub String);
  63 impl Parseable for Secret {
  64   #[throws(AE)]
  65   fn parse(s: Option<&str>) -> Self {
  66     let s = s.value()?;
  67     if s.is_empty() { throw!(anyhow!("secret value cannot be empty")) }
  68     Secret(s.into())
  69   }
  70   #[throws(AE)]
  71   fn default() -> Self { Secret(default()) }
  72 }
  73 impl Debug for Secret {
  74   #[throws(fmt::Error)]
  75   fn fmt(&self, f: &mut fmt::Formatter) { write!(f, "Secret(***)")? }
  76 }
  77
  78 #[derive(hippotat_macros::ResolveConfig)]
  79 #[derive(Debug,Clone)]
  80 pub struct InstanceConfig {
  81   // Exceptional settings
  82   #[special(special_server, SKL::ServerName)] pub server: ServerName,
  83   pub                                             secret: Secret,
  84   #[special(special_ipif, SKL::Ordinary)]     pub ipif:   String,
  85
  86   // Capped settings:
  87   #[limited]    pub max_batch_down:               u32,
  88   #[limited]    pub max_queue_time:               Duration,
  89   #[limited]    pub http_timeout:                 Duration,
  90   #[limited]    pub target_requests_outstanding:  u32,
  91
  92   // Ordinary settings:
  93   pub addrs:                        Vec<IpAddr>,
  94   pub vnetwork:                     Vec<IpNet>,
  95   pub vaddr:                        Vec<IpAddr>,
  96   pub vrelay:                       IpAddr,
  97   pub port:                         u16,
  98   pub mtu:                          u32,
  99   pub ifname_server:                String,
 100   pub ifname_client:                String,
 101
 102   // Ordinary settings, used by server only:
 103   #[server]  pub max_clock_skew:               Duration,
 104
 105   // Ordinary settings, used by client only:
 106   #[client]  pub http_timeout_grace:           Duration,
 107   #[client]  pub max_requests_outstanding:     u32,
 108   #[client]  pub max_batch_up:                 u32,
 109   #[client]  pub http_retry:                   Duration,
 110   #[client]  pub url:                          Uri,
 111   #[client]  pub vroutes:                      Vec<IpNet>,
 112 }
 113
 114 #[derive(Debug,Clone,Hash,Eq,PartialEq)]
 115 pub enum SectionName {
 116   Link(LinkName),
 117   Client(ClientName),
 118   Server(ServerName), // includes SERVER, which is slightly special
 119   ServerLimit(ServerName),
 120   GlobalLimit,
 121   Common,
 122 }
 123 pub use SectionName as SN;
 124
 125 #[derive(Debug,Clone)]
 126 struct RawVal { raw: Option<String>, loc: Arc<PathBuf> }
 127 type SectionMap = HashMap<String, RawVal>;
 128
 129 struct RawValRef<'v,'l,'s> {
 130   raw: Option<&'v str>,
 131   key: &'static str,
 132   loc: &'l Path,
 133   section: &'s SectionName,
 134 }
 135
 136 impl<'v> RawValRef<'v,'_,'_> {
 137   #[throws(AE)]
 138   fn try_map<F,T>(&self, f: F) -> T
 139   where F: FnOnce(Option<&'v str>) -> Result<T, AE> {
 140     f(self.raw)
 141       .with_context(|| format!(r#"file {:?}, section "{:?}", key "{}"#,
 142                                self.loc, self.section, self.key))?
 143   }
 144 }
 145
 146 pub struct Config {
 147   opts: Opts,
 148 }
 149
 150 static OUTSIDE_SECTION: &str = "[";
 151 static SPECIAL_SERVER_SECTION: &str = "SERVER";
 152
 153 #[derive(Default,Debug)]
 154 struct Aggregate {
 155   sections: HashMap<SectionName, SectionMap>,
 156 }
 157
 158 type OkAnyway<'f,A> = &'f dyn Fn(ErrorKind) -> Option<A>;
 159 #[ext]
 160 impl<'f,A> OkAnyway<'f,A> {
 161   fn ok<T>(self, r: &Result<T, io::Error>) -> Option<A> {
 162     let e = r.as_ref().err()?;
 163     let k = e.kind();
 164     let a = self(k)?;
 165     Some(a)
 166   }
 167 }
 168
 169 impl FromStr for SectionName {
 170   type Err = AE;
 171   #[throws(AE)]
 172   fn from_str(s: &str) -> Self {
 173     match s {
 174       "COMMON" => return SN::Common,
 175       "LIMIT" => return SN::GlobalLimit,
 176       _ => { }
 177     };
 178     if let Ok(n@ ServerName(_)) = s.parse() { return SN::Server(n) }
 179     if let Ok(n@ ClientName(_)) = s.parse() { return SN::Client(n) }
 180     let (server, client) = s.split_ascii_whitespace().collect_tuple()
 181       .ok_or_else(|| anyhow!(
 182         "bad section name {:?} \
 183          (must be COMMON, DEFAULT, <server>, <client>, or <server> <client>",
 184         s
 185       ))?;
 186     let server = server.parse().context("server name in link section name")?;
 187     if client == "LIMIT" { return SN::ServerLimit(server) }
 188     let client = client.parse().context("client name in link section name")?;
 189     SN::Link(LinkName { server, client })
 190   }
 191 }
 192
 193 impl Aggregate {
 194   #[throws(AE)] // AE does not include path
 195   fn read_file<A>(&mut self, path: &Path, anyway: OkAnyway<A>) -> Option<A>
 196   {
 197     let f = fs::File::open(path);
 198     if let Some(anyway) = anyway.ok(&f) { return Some(anyway) }
 199     let mut f = f.context("open")?;
 200
 201     let mut s = String::new();
 202     let y = f.read_to_string(&mut s);
 203     if let Some(anyway) = anyway.ok(&y) { return Some(anyway) }
 204     y.context("read")?;
 205
 206     self.read_string(s, path)?;
 207     None
 208   }
 209
 210   #[throws(AE)] // AE does not include path
 211   fn read_string(&mut self, s: String, path_for_loc: &Path) {
 212     let mut ini = Ini::new_cs();
 213     ini.set_default_section(OUTSIDE_SECTION);
 214     ini.read(s).map_err(|e| anyhow!("{}", e)).context("parse as INI")?;
 215     let map = mem::take(ini.get_mut_map());
 216     if map.get(OUTSIDE_SECTION).is_some() {
 217       throw!(anyhow!("INI file contains settings outside a section"));
 218     }
 219
 220     let loc = Arc::new(path_for_loc.to_owned());
 221
 222     for (sn, vars) in map {
 223       //dbg!( InstanceConfig::FIELDS );// check xxx vars are in fields
 224
 225       let sn = sn.parse().dcontext(&sn)?;
 226         self.sections.entry(sn)
 227         .or_default()
 228         .extend(
 229           vars.into_iter()
 230             .map(|(k,raw)| {
 231               (k.replace('-',"_"),
 232                RawVal { raw, loc: loc.clone() })
 233             })
 234         );
 235     }
 236
 237   }
 238
 239   #[throws(AE)] // AE includes path
 240   fn read_dir_d<A>(&mut self, path: &Path, anyway: OkAnyway<A>) -> Option<A>
 241   {
 242     let dir = fs::read_dir(path);
 243     if let Some(anyway) = anyway.ok(&dir) { return Some(anyway) }
 244     let dir = dir.context("open directory").dcontext(path)?;
 245     for ent in dir {
 246       let ent = ent.context("read directory").dcontext(path)?;
 247       let leaf = ent.file_name();
 248       let leaf = leaf.to_str();
 249       let leaf = if let Some(leaf) = leaf { leaf } else { continue }; //utf8?
 250       if leaf.len() == 0 { continue }
 251       if ! leaf.chars().all(
 252         |c| c=='-' || c=='_' || c.is_ascii_alphanumeric()
 253       ) { continue }
 254
 255       // OK we want this one
 256       let ent = ent.path();
 257       self.read_file(&ent, &|_| None::<Void>).dcontext(&ent)?;
 258     }
 259     None
 260   }
 261
 262   #[throws(AE)] // AE includes everything
 263   fn read_toplevel(&mut self, toplevel: &Path) {
 264     enum Anyway { None, Dir }
 265     match self.read_file(toplevel, &|k| match k {
 266       EK::NotFound => Some(Anyway::None),
 267       EK::IsADirectory => Some(Anyway::Dir),
 268       _ => None,
 269     })
 270       .dcontext(toplevel).context("top-level config directory (or file)")?
 271     {
 272       None | Some(Anyway::None) => { },
 273
 274       Some(Anyway::Dir) => {
 275         struct AnywayNone;
 276         let anyway_none = |k| match k {
 277           EK::NotFound => Some(AnywayNone),
 278           _ => None,
 279         };
 280
 281         let mk = |leaf: &str| {
 282           [ toplevel, &PathBuf::from(leaf) ]
 283             .iter().collect::<PathBuf>()
 284         };
 285
 286         for &(try_main, desc) in &[
 287           ("main.cfg", "main config file"),
 288           ("master.cfg", "obsolete-named main config file"),
 289         ] {
 290           let main = mk(try_main);
 291
 292           match self.read_file(&main, &anyway_none)
 293             .dcontext(main).context(desc)?
 294           {
 295             None => break,
 296             Some(AnywayNone) => { },
 297           }
 298         }
 299
 300         for &(try_dir, desc) in &[
 301           ("config.d", "per-link config directory"),
 302           ("secrets.d", "per-link secrets directory"),
 303         ] {
 304           let dir = mk(try_dir);
 305           match self.read_dir_d(&dir, &anyway_none).context(desc)? {
 306             None => { },
 307             Some(AnywayNone) => { },
 308           }
 309         }
 310       }
 311     }
 312   }
 313
 314   #[throws(AE)] // AE includes extra, but does that this is extra
 315   fn read_extra(&mut self, extra: &Path) {
 316     struct AnywayDir;
 317
 318     match self.read_file(extra, &|k| match k {
 319       EK::IsADirectory => Some(AnywayDir),
 320       _ => None,
 321     })
 322       .dcontext(extra)?
 323     {
 324       None => return,
 325       Some(AnywayDir) => {
 326         self.read_dir_d(extra, &|_| None::<Void>)?;
 327       }
 328     }
 329
 330   }
 331 }
 332
 333 impl Aggregate {
 334   fn instances(&self, only_server: Option<&ServerName>) -> BTreeSet<LinkName> {
 335     let mut links:              BTreeSet<LinkName> = default();
 336
 337     let mut secrets_anyserver:  BTreeSet<&ClientName> = default();
 338     let mut secrets_anyclient:  BTreeSet<&ServerName> = default();
 339     let mut secret_global       = false;
 340
 341     let mut putative_servers   = BTreeSet::new();
 342     let mut putative_clients   = BTreeSet::new();
 343
 344     let mut note_server = |s| {
 345       if let Some(only) = only_server { if s != only { return false } }
 346       putative_servers.insert(s);
 347       true
 348     };
 349     let mut note_client = |c| {
 350       putative_clients.insert(c);
 351     };
 352
 353     for (section, vars) in &self.sections {
 354       let has_secret = || vars.contains_key("secret");
 355
 356       match section {
 357         SN::Link(l) => {
 358           if ! note_server(&l.server) { continue }
 359           note_client(&l.client);
 360           if has_secret() { links.insert(l.clone()); }
 361         },
 362         SN::Server(ref s) => {
 363           if ! note_server(s) { continue }
 364           if has_secret() { secrets_anyclient.insert(s); }
 365         },
 366         SN::Client(ref c) => {
 367           note_client(c);
 368           if has_secret() { secrets_anyserver.insert(c); }
 369         },
 370         SN::Common => {
 371           if has_secret() { secret_global = true; }
 372         },
 373         _ => { },
 374       }
 375     }
 376
 377     // Add links which are justified by blanket secrets
 378     for (client, server) in iproduct!(
 379       putative_clients.into_iter().filter(
 380         |c| secret_global || secrets_anyserver.contains(c)
 381       ),
 382       putative_servers.iter().cloned().filter(
 383         |s| secret_global || secrets_anyclient.contains(s)
 384       )
 385     ) {
 386       links.insert(LinkName {
 387         client: client.clone(),
 388         server: server.clone(),
 389       });
 390     }
 391
 392     links
 393   }
 394 }
 395
 396 struct ResolveContext<'c> {
 397   agg: &'c Aggregate,
 398   link: &'c LinkName,
 399   end: LinkEnd,
 400   all_sections: Vec<SectionName>,
 401 }
 402
 403 trait Parseable: Sized {
 404   fn parse(s: Option<&str>) -> Result<Self, AE>;
 405   fn default() -> Result<Self, AE> {
 406     Err(anyhow!("setting must be specified"))
 407   }
 408   #[throws(AE)]
 409   fn default_for_key(key: &str) -> Self {
 410     Self::default().with_context(|| key.to_string())?
 411   }
 412 }
 413
 414 impl Parseable for Duration {
 415   #[throws(AE)]
 416   fn parse(s: Option<&str>) -> Duration {
 417     // todo: would be nice to parse with humantime maybe
 418     Duration::from_secs( s.value()?.parse()? )
 419   }
 420 }
 421 macro_rules! parseable_from_str { ($t:ty $(, $def:expr)? ) => {
 422   impl Parseable for $t {
 423     #[throws(AE)]
 424     fn parse(s: Option<&str>) -> $t { s.value()?.parse()? }
 425     $( #[throws(AE)] fn default() -> Self { $def } )?
 426   }
 427 } }
 428 parseable_from_str!{u16, default() }
 429 parseable_from_str!{u32, default() }
 430 parseable_from_str!{String, default() }
 431 parseable_from_str!{IpNet, default() }
 432 parseable_from_str!{IpAddr, Ipv4Addr::UNSPECIFIED.into() }
 433 parseable_from_str!{Uri, default() }
 434
 435 impl<T:Parseable> Parseable for Vec<T> {
 436   #[throws(AE)]
 437   fn parse(s: Option<&str>) -> Vec<T> {
 438     s.value()?
 439       .split_ascii_whitespace()
 440       .map(|s| Parseable::parse(Some(s)))
 441       .collect::<Result<Vec<_>,_>>()?
 442   }
 443   #[throws(AE)]
 444   fn default() -> Self { default() }
 445 }
 446
 447
 448 #[derive(Debug,Copy,Clone)]
 449 enum SectionKindList {
 450   Ordinary,
 451   Limited,
 452   Limits,
 453   ClientAgnostic,
 454   ServerName,
 455 }
 456 use SectionKindList as SKL;
 457
 458 impl SectionName {
 459   fn special_server_section() -> Self { SN::Server(ServerName(
 460     SPECIAL_SERVER_SECTION.into()
 461   )) }
 462 }
 463
 464 impl SectionKindList {
 465   fn contains(self, s: &SectionName) -> bool {
 466     match self {
 467       SKL::Ordinary       => matches!(s, SN::Link(_)
 468                                        | SN::Client(_)
 469                                        | SN::Server(_)
 470                                        | SN::Common),
 471
 472       SKL::Limits         => matches!(s, SN::ServerLimit(_)
 473                                        | SN::GlobalLimit),
 474
 475       SKL::ClientAgnostic => matches!(s, SN::Common
 476                                        | SN::Server(_)),
 477
 478       SKL::Limited        => SKL::Ordinary.contains(s)
 479                            | SKL::Limits  .contains(s),
 480
 481       SKL::ServerName     => matches!(s, SN::Common)
 482                            | matches!(s, SN::Server(ServerName(name))
 483                                          if name == SPECIAL_SERVER_SECTION),
 484     }
 485   }
 486 }
 487
 488 impl Aggregate {
 489   fn lookup_raw<'a,'s,S>(&'a self, key: &'static str, sections: S)
 490                        -> Option<RawValRef<'a,'a,'s>>
 491   where S: Iterator<Item=&'s SectionName>
 492   {
 493     for section in sections {
 494       if let Some(raw) = self.sections
 495         .get(section)
 496         .and_then(|vars: &SectionMap| vars.get(key))
 497       {
 498         return Some(RawValRef {
 499           raw: raw.raw.as_deref(),
 500           loc: &raw.loc,
 501           section, key,
 502         })
 503       }
 504     }
 505     None
 506   }
 507
 508   #[throws(AE)]
 509   pub fn establish_server_name(&self) -> ServerName {
 510     let key = "server";
 511     let raw = match self.lookup_raw(
 512       key,
 513       [ &SectionName::Common, &SN::special_server_section() ].iter().cloned()
 514     ) {
 515       Some(raw) => raw.try_map(|os| os.value())?,
 516       None => SPECIAL_SERVER_SECTION,
 517     };
 518     ServerName(raw.into())
 519   }
 520 }
 521
 522 impl<'c> ResolveContext<'c> {
 523   fn first_of_raw(&'c self, key: &'static str, sections: SectionKindList)
 524                   -> Option<RawValRef<'c,'c,'c>> {
 525     self.agg.lookup_raw(
 526       key,
 527       self.all_sections.iter()
 528         .filter(|s| sections.contains(s))
 529     )
 530   }
 531
 532   #[throws(AE)]
 533   fn first_of<T>(&self, key: &'static str, sections: SectionKindList)
 534                  -> Option<T>
 535   where T: Parseable
 536   {
 537     match self.first_of_raw(key, sections) {
 538       None => None,
 539       Some(raw) => Some(raw.try_map(Parseable::parse)?),
 540     }
 541   }
 542
 543   #[throws(AE)]
 544   pub fn ordinary<T>(&self, key: &'static str) -> T
 545   where T: Parseable
 546   {
 547     match self.first_of(key, SKL::Ordinary)? {
 548       Some(y) => y,
 549       None => Parseable::default_for_key(key)?,
 550     }
 551   }
 552
 553   #[throws(AE)]
 554   pub fn limited<T>(&self, key: &'static str) -> T
 555   where T: Parseable + Ord
 556   {
 557     let val = self.ordinary(key)?;
 558     if let Some(limit) = self.first_of(key, SKL::Limits)? {
 559       min(val, limit)
 560     } else {
 561       val
 562     }
 563   }
 564
 565   #[throws(AE)]
 566   pub fn client<T>(&self, key: &'static str) -> T
 567   where T: Parseable {
 568     match self.end {
 569       LinkEnd::Client => self.ordinary(key)?,
 570       LinkEnd::Server => Parseable::default_for_key(key)?,
 571     }
 572   }
 573   #[throws(AE)]
 574   pub fn server<T>(&self, key: &'static str) -> T
 575   where T: Parseable {
 576     match self.end {
 577       LinkEnd::Server => self.ordinary(key)?,
 578       LinkEnd::Client => Parseable::default_for_key(key)?,
 579     }
 580   }
 581
 582   #[throws(AE)]
 583   pub fn special_ipif(&self, key: &'static str) -> String {
 584     match self.end {
 585       LinkEnd::Client => self.ordinary(key)?,
 586       LinkEnd::Server => {
 587         self.first_of(key, SKL::ClientAgnostic)?
 588           .unwrap_or_default()
 589       },
 590     }
 591   }
 592
 593   #[throws(AE)]
 594   pub fn special_server(&self, key: &'static str) -> ServerName {
 595     self.link.server.clone()
 596   }
 597 }
 598
 599 #[throws(AE)]
 600 pub fn read(end: LinkEnd) -> Vec<InstanceConfig> {
 601   let opts = config::Opts::from_args();
 602
 603   let agg = (||{
 604     let mut agg = Aggregate::default();
 605
 606     agg.read_string(DEFAULT_CONFIG.into(),
 607                     "<build-in defaults>".as_ref()).unwrap();
 608
 609     agg.read_toplevel(&opts.config)?;
 610     for extra in &opts.extra_config {
 611       agg.read_extra(extra).context("extra config")?;
 612     }
 613
 614     eprintln!("GOT {:#?}", agg);
 615
 616     Ok::<_,AE>(agg)
 617   })().context("read configuration")?;
 618
 619   let server_name = match end {
 620     LinkEnd::Server => Some(agg.establish_server_name()?),
 621     LinkEnd::Client => None,
 622   };
 623
 624   let instances = agg.instances(server_name.as_ref());
 625   let mut ics = vec![];
 626
 627   for link in instances {
 628     let rctx = ResolveContext {
 629       agg: &agg,
 630       link: &link,
 631       end,
 632       all_sections: vec![
 633         SN::Link(link.clone()),
 634         SN::Client(link.client.clone()),
 635         SN::Server(link.server.clone()),
 636         SN::Common,
 637         SN::ServerLimit(link.server.clone()),
 638         SN::GlobalLimit,
 639       ],
 640     };
 641
 642     let ic = InstanceConfig::resolve_instance(&rctx)
 643       .with_context(|| format!(r#"resolve config for "{:?}""#, &link))?;
 644
 645     ics.push(ic);
 646   }
 647
 648   ics
 649 }