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 type SectionMap = HashMap<String, Option<String>>;
  61
  62 pub struct Config {
  63   opts: Opts,
  64 }
  65
  66 static OUTSIDE_SECTION: &str = "[";
  67
  68 #[derive(Default,Debug)]
  69 struct Aggregate {
  70   sections: HashMap<String, SectionMap>,
  71 }
  72
  73 type OkAnyway<'f,A> = &'f dyn Fn(ErrorKind) -> Option<A>;
  74 #[ext]
  75 impl<'f,A> OkAnyway<'f,A> {
  76   fn ok<T>(self, r: &Result<T, io::Error>) -> Option<A> {
  77     let e = r.as_ref().err()?;
  78     let k = e.kind();
  79     let a = self(k)?;
  80     Some(a)
  81   }
  82 }
  83
  84 impl Aggregate {
  85   #[throws(AE)] // AE does not include path
  86   fn read_file<A>(&mut self, path: &Path, anyway: OkAnyway<A>) -> Option<A>
  87   {
  88     let f = fs::File::open(path);
  89     if let Some(anyway) = anyway.ok(&f) { return Some(anyway) }
  90     let mut f = f.context("open")?;
  91
  92     let mut s = String::new();
  93     f.read_to_string(&mut s).context("read")?;
  94
  95     let mut ini = Ini::new_cs();
  96     ini.set_default_section(OUTSIDE_SECTION);
  97     ini.read(s).map_err(|e| anyhow!("{}", e)).context("parse as INI")?;
  98     let mut map = mem::take(ini.get_mut_map());
  99     if map.get(OUTSIDE_SECTION).is_some() {
 100       throw!(anyhow!("INI file contains settings outside a section"));
 101     }
 102
 103     // xxx parse section names here
 104     // xxx save Arc<PathBuf> where we found each item
 105
 106     self.sections.extend(map.drain());
 107     None
 108   }
 109
 110   #[throws(AE)] // AE includes path
 111   fn read_dir_d<A>(&mut self, path: &Path, anyway: OkAnyway<A>) -> Option<A>
 112   {
 113     let dir = fs::read_dir(path);
 114     if let Some(anyway) = anyway.ok(&dir) { return Some(anyway) }
 115     let dir = dir.context("open directory").dcontext(path)?;
 116     for ent in dir {
 117       let ent = ent.context("read directory").dcontext(path)?;
 118       let leaf = ent.file_name();
 119       let leaf = leaf.to_str();
 120       let leaf = if let Some(leaf) = leaf { leaf } else { continue }; //utf8?
 121       if leaf.len() == 0 { continue }
 122       if ! leaf.chars().all(
 123         |c| c=='-' || c=='_' || c.is_ascii_alphanumeric()
 124       ) { continue }
 125
 126       // OK we want this one
 127       let ent = ent.path();
 128       self.read_file(&ent, &|_| None::<Void>).dcontext(&ent)?;
 129     }
 130     None
 131   }
 132
 133   #[throws(AE)] // AE includes everything
 134   fn read_toplevel(&mut self, toplevel: &Path) {
 135     enum Anyway { None, Dir }
 136     match self.read_file(toplevel, &|k| match k {
 137       EK::NotFound => Some(Anyway::None),
 138       EK::IsADirectory => Some(Anyway::Dir),
 139       _ => None,
 140     })
 141       .dcontext(toplevel).context("top-level config directory (or file)")?
 142     {
 143       None | Some(Anyway::None) => { },
 144
 145       Some(Anyway::Dir) => {
 146         struct AnywayNone;
 147         let anyway_none = |k| match k {
 148           EK::NotFound => Some(AnywayNone),
 149           _ => None,
 150         };
 151
 152         let mk = |leaf: &str| {
 153           [ toplevel, &PathBuf::from(leaf) ]
 154             .iter().collect::<PathBuf>()
 155         };
 156
 157         for &(try_main, desc) in &[
 158           ("main.cfg", "main config file"),
 159           ("master.cfg", "obsolete-named main config file"),
 160         ] {
 161           let main = mk(try_main);
 162
 163           match self.read_file(&main, &anyway_none)
 164             .dcontext(main).context(desc)?
 165           {
 166             None => break,
 167             Some(AnywayNone) => { },
 168           }
 169         }
 170
 171         for &(try_dir, desc) in &[
 172           ("config.d", "per-link config directory"),
 173           ("secrets.d", "per-link secrets directory"),
 174         ] {
 175           let dir = mk(try_dir);
 176           match self.read_dir_d(&dir, &anyway_none).context(desc)? {
 177             None => { },
 178             Some(AnywayNone) => { },
 179           }
 180         }
 181       }
 182     }
 183   }
 184
 185   #[throws(AE)] // AE includes extra, but does that this is extra
 186   fn read_extra(&mut self, extra: &Path) {
 187     struct AnywayDir;
 188
 189     match self.read_file(extra, &|k| match k {
 190       EK::IsADirectory => Some(AnywayDir),
 191       _ => None,
 192     })
 193       .dcontext(extra)?
 194     {
 195       None => return,
 196       Some(AnywayDir) => {
 197         self.read_dir_d(extra, &|_| None::<Void>)?;
 198       }
 199     }
 200
 201   }
 202 }
 203
 204
 205 #[throws(AE)]
 206 pub fn read() {
 207   let opts = config::Opts::from_args();
 208
 209   (||{
 210     let mut agg = Aggregate::default();
 211
 212     agg.read_toplevel(&opts.config)?;
 213     for extra in &opts.extra_config {
 214       agg.read_extra(extra).context("extra config")?;
 215     }
 216
 217     eprintln!("GOT {:?}", agg);
 218
 219     Ok::<_,AE>(())
 220   })().context("read configuration")?;
 221 }