1 // Copyright 2021 Ian Jackson and contributors to Hippotat
2 // SPDX-License-Identifier: AGPL-3.0-or-later
3 // There is NO WARRANTY.
7 use configparser::ini::Ini;
9 #[derive(StructOpt,Debug)]
11 /// Top-level config file or directory
13 /// Look for `main.cfg`, `config.d` and `secrets.d` here.
15 /// Or if this is a file, just read that file.
16 #[structopt(long, default_value="/etc/hippotat")]
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>,
24 pub struct CidrString(pub String);
26 pub struct InstanceConfig {
27 // Exceptional settings
33 pub max_batch_down: u32,
34 pub max_queue_time: Duration,
35 pub http_timeout: Duration,
38 pub target_requests_outstanding: u32,
39 pub addrs: Vec<IpAddr>,
40 pub vnetwork: Vec<CidrString>,
41 pub vaddr: Vec<IpAddr>,
45 pub ifname_server: String,
46 pub ifname_client: String,
48 // Ordinary settings, used by server only:
49 pub max_clock_skew: Duration,
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,
57 pub vroutes: Vec<CidrString>,
60 #[derive(Debug,Clone,Hash,Eq,PartialEq)]
61 pub enum SectionName {
62 Link { server: ServerName, client: ClientName },
64 Server(ServerName), // includes SERVER, which is slightly special
65 ServerLimit(ServerName),
70 pub use SectionName as SN;
72 #[derive(Debug,Clone)]
73 struct RawVal { val: Option<String>, loc: Arc<PathBuf> }
74 type SectionMap = HashMap<String, RawVal>;
80 static OUTSIDE_SECTION: &str = "[";
82 #[derive(Default,Debug)]
84 sections: HashMap<SectionName, SectionMap>,
87 type OkAnyway<'f,A> = &'f dyn Fn(ErrorKind) -> Option<A>;
89 impl<'f,A> OkAnyway<'f,A> {
90 fn ok<T>(self, r: &Result<T, io::Error>) -> Option<A> {
91 let e = r.as_ref().err()?;
98 impl FromStr for SectionName {
101 fn from_str(s: &str) -> Self {
103 "COMMON" => return SN::Common,
104 "DEFAULT" => return SN::Default,
105 "LIMIT" => return SN::GlobalLimit,
108 if let Ok(n@ ServerName(_)) = s.parse() { return SN::Server(n) }
109 if let Ok(n@ ClientName(_)) = s.parse() { return SN::Client(n) }
110 let (server, client) = s.split_ascii_whitespace().collect_tuple()
111 .ok_or_else(|| anyhow!(
112 "bad section name {:?} \
113 (must be COMMON, DEFAULT, <server>, <client>, or <server> <client>",
116 let server = server.parse().context("server name in link section name")?;
117 if client == "LIMIT" { return SN::ServerLimit(server) }
118 let client = client.parse().context("client name in link section name")?;
119 SN::Link { server, client }
124 #[throws(AE)] // AE does not include path
125 fn read_file<A>(&mut self, path: &Path, anyway: OkAnyway<A>) -> Option<A>
127 let f = fs::File::open(path);
128 if let Some(anyway) = anyway.ok(&f) { return Some(anyway) }
129 let mut f = f.context("open")?;
131 let mut s = String::new();
132 let y = f.read_to_string(&mut s);
133 if let Some(anyway) = anyway.ok(&y) { return Some(anyway) }
136 let mut ini = Ini::new_cs();
137 ini.set_default_section(OUTSIDE_SECTION);
138 ini.read(s).map_err(|e| anyhow!("{}", e)).context("parse as INI")?;
139 let map = mem::take(ini.get_mut_map());
140 if map.get(OUTSIDE_SECTION).is_some() {
141 throw!(anyhow!("INI file contains settings outside a section"));
144 let loc = Arc::new(path.to_owned());
146 for (sn, vars) in map {
147 let sn = sn.parse().dcontext(&sn)?;
148 self.sections.entry(sn)
154 RawVal { val, loc: loc.clone() })
161 #[throws(AE)] // AE includes path
162 fn read_dir_d<A>(&mut self, path: &Path, anyway: OkAnyway<A>) -> Option<A>
164 let dir = fs::read_dir(path);
165 if let Some(anyway) = anyway.ok(&dir) { return Some(anyway) }
166 let dir = dir.context("open directory").dcontext(path)?;
168 let ent = ent.context("read directory").dcontext(path)?;
169 let leaf = ent.file_name();
170 let leaf = leaf.to_str();
171 let leaf = if let Some(leaf) = leaf { leaf } else { continue }; //utf8?
172 if leaf.len() == 0 { continue }
173 if ! leaf.chars().all(
174 |c| c=='-' || c=='_' || c.is_ascii_alphanumeric()
177 // OK we want this one
178 let ent = ent.path();
179 self.read_file(&ent, &|_| None::<Void>).dcontext(&ent)?;
184 #[throws(AE)] // AE includes everything
185 fn read_toplevel(&mut self, toplevel: &Path) {
186 enum Anyway { None, Dir }
187 match self.read_file(toplevel, &|k| match k {
188 EK::NotFound => Some(Anyway::None),
189 EK::IsADirectory => Some(Anyway::Dir),
192 .dcontext(toplevel).context("top-level config directory (or file)")?
194 None | Some(Anyway::None) => { },
196 Some(Anyway::Dir) => {
198 let anyway_none = |k| match k {
199 EK::NotFound => Some(AnywayNone),
203 let mk = |leaf: &str| {
204 [ toplevel, &PathBuf::from(leaf) ]
205 .iter().collect::<PathBuf>()
208 for &(try_main, desc) in &[
209 ("main.cfg", "main config file"),
210 ("master.cfg", "obsolete-named main config file"),
212 let main = mk(try_main);
214 match self.read_file(&main, &anyway_none)
215 .dcontext(main).context(desc)?
218 Some(AnywayNone) => { },
222 for &(try_dir, desc) in &[
223 ("config.d", "per-link config directory"),
224 ("secrets.d", "per-link secrets directory"),
226 let dir = mk(try_dir);
227 match self.read_dir_d(&dir, &anyway_none).context(desc)? {
229 Some(AnywayNone) => { },
236 #[throws(AE)] // AE includes extra, but does that this is extra
237 fn read_extra(&mut self, extra: &Path) {
240 match self.read_file(extra, &|k| match k {
241 EK::IsADirectory => Some(AnywayDir),
248 self.read_dir_d(extra, &|_| None::<Void>)?;
258 let opts = config::Opts::from_args();
261 let mut agg = Aggregate::default();
263 agg.read_toplevel(&opts.config)?;
264 for extra in &opts.extra_config {
265 agg.read_extra(extra).context("extra config")?;
268 eprintln!("GOT {:#?}", agg);
271 })().context("read configuration")?;