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 #[derive(StructOpt,Debug)]
  10 pub struct Opts {
  11   /// Top-level config file or directory
  12   ///
  13   /// Look for `main.cfg`, `config.d` and `secrets.d` here.
  14   ///
  15   /// Or if this is a file, just read that file.
  16   #[structopt(long, default_value="/etc/hippotat")]
  17   pub config: PathBuf,
  18
  19   /// Additional config files or dirs, which can override the others
  20   #[structopt(long, multiple=true, number_of_values=1)]
  21   pub extra_config: Vec<PathBuf>,
  22 }
  23
  24 pub struct CidrString(pub String);
  25
  26 pub struct InstanceConfig {
  27   // Exceptional settings
  28   pub server:                       String,
  29   pub secret:                       String,
  30   pub ipif:                         String,
  31
  32   // Capped settings:
  33   pub max_batch_down:               u32,
  34   pub max_queue_time:               Duration,
  35   pub http_timeout:                 Duration,
  36
  37   // Ordinary settings:
  38   pub target_requests_outstanding:  u32,
  39   pub addrs:                        Vec<IpAddr>,
  40   pub vnetwork:                     Vec<CidrString>,
  41   pub vaddr:                        Vec<IpAddr>,
  42   pub vrelay:                       IpAddr,
  43   pub port:                         u16,
  44   pub mtu:                          u32,
  45   pub ifname_server:                String,
  46   pub ifname_client:                String,
  47
  48   // Ordinary settings, used by server only:
  49   pub max_clock_skew:               Duration,
  50
  51   // Ordinary settings, used by client only:
  52   pub http_timeout_grace:           Duration,
  53   pub max_requests_outstanding:     u32,
  54   pub max_batch_up:                 u32,
  55   pub http_retry:                   Duration,
  56   pub url:                          Uri,
  57   pub vroutes:                      Vec<CidrString>,
  58 }
  59
  60 #[derive(Debug,Clone,Hash,Eq,PartialEq)]
  61 pub enum SectionName {
  62   Link { server: ServerName, client: ClientName },
  63   Client(ClientName),
  64   Server(ServerName), // includes SERVER, which is slightly special
  65   Common,
  66   Default,
  67 }
  68 pub use SectionName as SN;
  69
  70 type SectionMap = HashMap<String, Option<String>>;
  71
  72 pub struct Config {
  73   opts: Opts,
  74 }
  75
  76 static OUTSIDE_SECTION: &str = "[";
  77
  78 #[derive(Default,Debug)]
  79 struct Aggregate {
  80   sections: HashMap<SectionName, SectionMap>,
  81 }
  82
  83 type OkAnyway<'f,A> = &'f dyn Fn(ErrorKind) -> Option<A>;
  84 #[ext]
  85 impl<'f,A> OkAnyway<'f,A> {
  86   fn ok<T>(self, r: &Result<T, io::Error>) -> Option<A> {
  87     let e = r.as_ref().err()?;
  88     let k = e.kind();
  89     let a = self(k)?;
  90     Some(a)
  91   }
  92 }
  93
  94 impl FromStr for SectionName {
  95   type Err = AE;
  96   #[throws(AE)]
  97   fn from_str(s: &str) -> Self {
  98     match s {
  99       "COMMON" => return SN::Common,
 100       "DEFAULT" => return SN::Default,
 101       _ => { }
 102     };
 103     if let Ok(n@ ServerName(_)) = s.parse() { return SN::Server(n) }
 104     if let Ok(n@ ClientName(_)) = s.parse() { return SN::Client(n) }
 105     let (server, client) = s.split_ascii_whitespace().collect_tuple()
 106       .ok_or_else(|| anyhow!(
 107         "bad section name {:?} \
 108          (must be COMMON, DEFAULT, <server>, <client>, or <server> <client>",
 109         s
 110       ))?;
 111     let server = server.parse().context("server name in link section name")?;
 112     let client = client.parse().context("client name in link section name")?;
 113     SN::Link { server, client }
 114   }
 115 }
 116
 117 impl Aggregate {
 118   #[throws(AE)] // AE does not include path
 119   fn read_file<A>(&mut self, path: &Path, anyway: OkAnyway<A>) -> Option<A>
 120   {
 121     let f = fs::File::open(path);
 122     if let Some(anyway) = anyway.ok(&f) { return Some(anyway) }
 123     let mut f = f.context("open")?;
 124
 125     let mut s = String::new();
 126     let y = f.read_to_string(&mut s);
 127     if let Some(anyway) = anyway.ok(&y) { return Some(anyway) }
 128     y.context("read")?;
 129
 130     let mut ini = Ini::new_cs();
 131     ini.set_default_section(OUTSIDE_SECTION);
 132     ini.read(s).map_err(|e| anyhow!("{}", e)).context("parse as INI")?;
 133     let mut map = mem::take(ini.get_mut_map());
 134     if map.get(OUTSIDE_SECTION).is_some() {
 135       throw!(anyhow!("INI file contains settings outside a section"));
 136     }
 137
 138     // xxx parse section names here
 139     // xxx save Arc<PathBuf> where we found each item
 140
 141     for (sn, vars) in map.drain() {
 142       let sn = sn.parse().dcontext(&sn)?;
 143       Extend::extend(
 144       self.sections.entry(sn)
 145         .or_default(),
 146         vars);
 147     }
 148     None
 149   }
 150
 151   #[throws(AE)] // AE includes path
 152   fn read_dir_d<A>(&mut self, path: &Path, anyway: OkAnyway<A>) -> Option<A>
 153   {
 154     let dir = fs::read_dir(path);
 155     if let Some(anyway) = anyway.ok(&dir) { return Some(anyway) }
 156     let dir = dir.context("open directory").dcontext(path)?;
 157     for ent in dir {
 158       let ent = ent.context("read directory").dcontext(path)?;
 159       let leaf = ent.file_name();
 160       let leaf = leaf.to_str();
 161       let leaf = if let Some(leaf) = leaf { leaf } else { continue }; //utf8?
 162       if leaf.len() == 0 { continue }
 163       if ! leaf.chars().all(
 164         |c| c=='-' || c=='_' || c.is_ascii_alphanumeric()
 165       ) { continue }
 166
 167       // OK we want this one
 168       let ent = ent.path();
 169       self.read_file(&ent, &|_| None::<Void>).dcontext(&ent)?;
 170     }
 171     None
 172   }
 173
 174   #[throws(AE)] // AE includes everything
 175   fn read_toplevel(&mut self, toplevel: &Path) {
 176     enum Anyway { None, Dir }
 177     match self.read_file(toplevel, &|k| match k {
 178       EK::NotFound => Some(Anyway::None),
 179       EK::IsADirectory => Some(Anyway::Dir),
 180       _ => None,
 181     })
 182       .dcontext(toplevel).context("top-level config directory (or file)")?
 183     {
 184       None | Some(Anyway::None) => { },
 185
 186       Some(Anyway::Dir) => {
 187         struct AnywayNone;
 188         let anyway_none = |k| match k {
 189           EK::NotFound => Some(AnywayNone),
 190           _ => None,
 191         };
 192
 193         let mk = |leaf: &str| {
 194           [ toplevel, &PathBuf::from(leaf) ]
 195             .iter().collect::<PathBuf>()
 196         };
 197
 198         for &(try_main, desc) in &[
 199           ("main.cfg", "main config file"),
 200           ("master.cfg", "obsolete-named main config file"),
 201         ] {
 202           let main = mk(try_main);
 203
 204           match self.read_file(&main, &anyway_none)
 205             .dcontext(main).context(desc)?
 206           {
 207             None => break,
 208             Some(AnywayNone) => { },
 209           }
 210         }
 211
 212         for &(try_dir, desc) in &[
 213           ("config.d", "per-link config directory"),
 214           ("secrets.d", "per-link secrets directory"),
 215         ] {
 216           let dir = mk(try_dir);
 217           match self.read_dir_d(&dir, &anyway_none).context(desc)? {
 218             None => { },
 219             Some(AnywayNone) => { },
 220           }
 221         }
 222       }
 223     }
 224   }
 225
 226   #[throws(AE)] // AE includes extra, but does that this is extra
 227   fn read_extra(&mut self, extra: &Path) {
 228     struct AnywayDir;
 229
 230     match self.read_file(extra, &|k| match k {
 231       EK::IsADirectory => Some(AnywayDir),
 232       _ => None,
 233     })
 234       .dcontext(extra)?
 235     {
 236       None => return,
 237       Some(AnywayDir) => {
 238         self.read_dir_d(extra, &|_| None::<Void>)?;
 239       }
 240     }
 241
 242   }
 243 }
 244
 245
 246 #[throws(AE)]
 247 pub fn read() {
 248   let opts = config::Opts::from_args();
 249
 250   (||{
 251     let mut agg = Aggregate::default();
 252
 253     agg.read_toplevel(&opts.config)?;
 254     for extra in &opts.extra_config {
 255       agg.read_extra(extra).context("extra config")?;
 256     }
 257
 258     eprintln!("GOT {:#?}", agg);
 259
 260     Ok::<_,AE>(())
 261   })().context("read configuration")?;
 262 }