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 static DEFAULT_CONFIG: &str = r#"
11 max_batch_down = 65536
13 target_requests_outstanding = 3
15 http_timeout_grace = 5
16 max_requests_outstanding = 6
21 ifname_client = hippo%%d
22 ifname_server = shippo%%d
25 ipif = userv root ipif %(local)s,%(peer)s,%(mtu)s,slip,%(ifname)s %(rnets)s
29 vvnetwork = 172.24.230.192
32 max_batch_down = 262144
35 target_requests_outstanding = 10
38 #[derive(StructOpt,Debug)]
40 /// Top-level config file or directory
42 /// Look for `main.cfg`, `config.d` and `secrets.d` here.
44 /// Or if this is a file, just read that file.
45 #[structopt(long, default_value="/etc/hippotat")]
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>,
54 impl<'s> Option<&'s str> {
56 fn value(self) -> &'s str {
57 self.ok_or_else(|| anyhow!("value needed"))?
62 pub struct Secret(pub String);
63 impl Parseable for Secret {
65 fn parse(s: Option<&str>) -> Self {
67 if s.is_empty() { throw!(anyhow!("secret value cannot be empty")) }
71 fn default() -> Self { Secret(default()) }
73 impl Debug for Secret {
75 fn fmt(&self, f: &mut fmt::Formatter) { write!(f, "Secret(***)")? }
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,
84 #[special(special_ipif, SKL::Ordinary)] pub ipif: String,
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,
93 pub addrs: Vec<IpAddr>,
94 pub vnetwork: Vec<IpNet>,
95 pub vaddr: Vec<IpAddr>,
99 pub ifname_server: String,
100 pub ifname_client: String,
102 // Ordinary settings, used by server only:
103 #[server] pub max_clock_skew: Duration,
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>,
114 #[derive(Debug,Clone,Hash,Eq,PartialEq)]
115 pub enum SectionName {
118 Server(ServerName), // includes SERVER, which is slightly special
119 ServerLimit(ServerName),
123 pub use SectionName as SN;
125 #[derive(Debug,Clone)]
126 struct RawVal { raw: Option<String>, loc: Arc<PathBuf> }
127 type SectionMap = HashMap<String, RawVal>;
129 struct RawValRef<'v,'l,'s> {
130 raw: Option<&'v str>,
133 section: &'s SectionName,
136 impl<'v> RawValRef<'v,'_,'_> {
138 fn try_map<F,T>(&self, f: F) -> T
139 where F: FnOnce(Option<&'v str>) -> Result<T, AE> {
141 .with_context(|| format!(r#"file {:?}, section "{:?}", key "{}"#,
142 self.loc, self.section, self.key))?
150 static OUTSIDE_SECTION: &str = "[";
151 static SPECIAL_SERVER_SECTION: &str = "SERVER";
153 #[derive(Default,Debug)]
155 sections: HashMap<SectionName, SectionMap>,
158 type OkAnyway<'f,A> = &'f dyn Fn(ErrorKind) -> Option<A>;
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()?;
169 impl FromStr for SectionName {
172 fn from_str(s: &str) -> Self {
174 "COMMON" => return SN::Common,
175 "LIMIT" => return SN::GlobalLimit,
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>",
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 })
194 #[throws(AE)] // AE does not include path
195 fn read_file<A>(&mut self, path: &Path, anyway: OkAnyway<A>) -> Option<A>
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")?;
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) }
206 self.read_string(s, path)?;
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"));
220 let loc = Arc::new(path_for_loc.to_owned());
222 for (sn, vars) in map {
223 dbg!( InstanceConfig::FIELDS );// check xxx vars are in fields
225 let sn = sn.parse().dcontext(&sn)?;
226 self.sections.entry(sn)
232 RawVal { raw, loc: loc.clone() })
239 #[throws(AE)] // AE includes path
240 fn read_dir_d<A>(&mut self, path: &Path, anyway: OkAnyway<A>) -> Option<A>
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)?;
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()
255 // OK we want this one
256 let ent = ent.path();
257 self.read_file(&ent, &|_| None::<Void>).dcontext(&ent)?;
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),
270 .dcontext(toplevel).context("top-level config directory (or file)")?
272 None | Some(Anyway::None) => { },
274 Some(Anyway::Dir) => {
276 let anyway_none = |k| match k {
277 EK::NotFound => Some(AnywayNone),
281 let mk = |leaf: &str| {
282 [ toplevel, &PathBuf::from(leaf) ]
283 .iter().collect::<PathBuf>()
286 for &(try_main, desc) in &[
287 ("main.cfg", "main config file"),
288 ("master.cfg", "obsolete-named main config file"),
290 let main = mk(try_main);
292 match self.read_file(&main, &anyway_none)
293 .dcontext(main).context(desc)?
296 Some(AnywayNone) => { },
300 for &(try_dir, desc) in &[
301 ("config.d", "per-link config directory"),
302 ("secrets.d", "per-link secrets directory"),
304 let dir = mk(try_dir);
305 match self.read_dir_d(&dir, &anyway_none).context(desc)? {
307 Some(AnywayNone) => { },
314 #[throws(AE)] // AE includes extra, but does that this is extra
315 fn read_extra(&mut self, extra: &Path) {
318 match self.read_file(extra, &|k| match k {
319 EK::IsADirectory => Some(AnywayDir),
326 self.read_dir_d(extra, &|_| None::<Void>)?;
339 struct MeansForEnd<'m,U,P> {
340 us_spec: Which<&'m U>,
344 trait InstancesForEnd: Eq {
345 type Peer: Ord + Eq + Hash + Debug;
346 fn section_means<'s>(&self, s: &'s SectionName)
347 -> MeansForEnd<'s, Self, Peer>
350 impl InstanceForEnd for ServerName {
351 type Peer = ClientName;
352 fn section_means<'s>(&'_ self, s: &'s SectionName)
353 -> Option<MeansForEnd<'s>> {
355 let (us_spec, peer) = match s {
356 SN::Link(l) => (These(l.server), These(l.client)),
357 SN::Server(server) => (These( server), All),
358 SN::Client(client) => (All, These( client)),
359 SN::Common => (All, All),
362 MeansForEnd { us_spec, peer }
367 fn instances_for<N>(&self, us: N) -> Vec<LinkName>
368 where N: InstancesForEnd,
371 let mut secrets = Which::These(BTreeSet::new());
372 let mut putative_selves = BTreeSet::new();
373 let mut putative_peers = BTreeSet::new();
375 let matching_means = |section: &SectionName| {
376 let means = us.section_means(section)?;
377 if match means.us_spec {
378 These(u) => if u == us,
380 } { Some(means) } else { None }
383 for (section, vars) in &self.agg.sections {
385 if let Some(means) = matching_means(section) {
388 if ! vars.has_key("secret") { continue }
390 let tsecrets = match secrets {
391 These(ref mut s) => s,
395 if let Some(means) = matching_means(section) {
397 Which::These(ypeer) => tsecrets.insert(ypeer),
398 Which::All => secrets = Which::All,
406 for (section, vars) in &self.agg.sections {
408 if let Some(means) = matching_means(section) {
412 These(s) => s.contains(means.peer),
419 SN::Link(LinkName { ref client, ref srver })
420 if server == &server_name
421 => tclients.insert(client),
423 SN::Client(ref client)
424 => tclients.insert(client),
426 SN::Server(ref server) | SN::Common
432 let has_secret = .iter().filter_map(|section, vars| {
442 let links = self.agg.sections.iter().filter_map(|section| match section {
444 SN::Link(LinkName { ref client, .. }) |
445 SN::Client(ref client) => Some(client.clone()),
447 SN::Server(_) | SN::ServerLimit(_) |
448 SN::GlobalLimit : SN::Common => None => None,
452 self.lookup_raw("secret", SKL::Ordinary).is_some()
463 struct ResolveContext<'c> {
467 server_name: ServerName,
468 all_sections: Vec<SectionName>,
471 trait Parseable: Sized {
472 fn parse(s: Option<&str>) -> Result<Self, AE>;
473 fn default() -> Result<Self, AE> {
474 Err(anyhow!("setting must be specified"))
477 fn default_for_key(key: &str) -> Self {
478 Self::default().with_context(|| key.to_string())?
482 impl Parseable for Duration {
484 fn parse(s: Option<&str>) -> Duration {
485 // todo: would be nice to parse with humantime maybe
486 Duration::from_secs( s.value()?.parse()? )
489 macro_rules! parseable_from_str { ($t:ty $(, $def:expr)? ) => {
490 impl Parseable for $t {
492 fn parse(s: Option<&str>) -> $t { s.value()?.parse()? }
493 $( #[throws(AE)] fn default() -> Self { $def } )?
496 parseable_from_str!{u16, default() }
497 parseable_from_str!{u32, default() }
498 parseable_from_str!{String, default() }
499 parseable_from_str!{IpNet, default() }
500 parseable_from_str!{IpAddr, Ipv4Addr::UNSPECIFIED.into() }
501 parseable_from_str!{Uri, default() }
503 impl<T:Parseable> Parseable for Vec<T> {
505 fn parse(s: Option<&str>) -> Vec<T> {
507 .split_ascii_whitespace()
508 .map(|s| Parseable::parse(Some(s)))
509 .collect::<Result<Vec<_>,_>>()?
514 #[derive(Debug,Copy,Clone)]
515 enum SectionKindList {
522 use SectionKindList as SKL;
525 fn special_server_section() -> Self { SN::Server(ServerName(
526 SPECIAL_SERVER_SECTION.into()
530 impl SectionKindList {
531 fn contains(self, s: &SectionName) -> bool {
533 SKL::Ordinary => matches!(s, SN::Link(_)
538 SKL::Limits => matches!(s, SN::ServerLimit(_)
541 SKL::ClientAgnostic => matches!(s, SN::Common
544 SKL::Limited => SKL::Ordinary.contains(s)
545 | SKL::Limits .contains(s),
547 SKL::ServerName => matches!(s, SN::Common)
548 | matches!(s, SN::Server(ServerName(name))
549 if name == SPECIAL_SERVER_SECTION),
555 fn lookup_raw<'a,'s,S>(&'a self, key: &'static str, sections: S)
556 -> Option<RawValRef<'a,'a,'s>>
557 where S: Iterator<Item=&'s SectionName>
559 for section in sections {
560 if let Some(raw) = self.sections
562 .and_then(|vars: &SectionMap| vars.get(key))
564 return Some(RawValRef {
565 raw: raw.raw.as_deref(),
575 pub fn establish_server_name(&self) -> ServerName {
577 let raw = match self.lookup_raw(
579 [ &SectionName::Common, &SN::special_server_section() ].iter().cloned()
581 Some(raw) => raw.try_map(|os| os.value())?,
582 None => SPECIAL_SERVER_SECTION,
584 ServerName(raw.into())
588 impl<'c> ResolveContext<'c> {
589 fn first_of_raw(&'c self, key: &'static str, sections: SectionKindList)
590 -> Option<RawValRef<'c,'c,'c>> {
593 self.all_sections.iter()
594 .filter(|s| sections.contains(s))
599 fn first_of<T>(&self, key: &'static str, sections: SectionKindList)
603 match self.first_of_raw(key, sections) {
605 Some(raw) => Some(raw.try_map(Parseable::parse)?),
610 pub fn ordinary<T>(&self, key: &'static str) -> T
613 match self.first_of(key, SKL::Ordinary)? {
615 None => Parseable::default_for_key(key)?,
620 pub fn limited<T>(&self, key: &'static str) -> T
621 where T: Parseable + Ord
623 let val = self.ordinary(key)?;
624 if let Some(limit) = self.first_of(key, SKL::Limits)? {
632 pub fn client<T>(&self, key: &'static str) -> T
635 LinkEnd::Client => self.ordinary(key)?,
636 LinkEnd::Server => Parseable::default_for_key(key)?,
640 pub fn server<T>(&self, key: &'static str) -> T
643 LinkEnd::Server => self.ordinary(key)?,
644 LinkEnd::Client => Parseable::default_for_key(key)?,
649 pub fn special_ipif(&self, key: &'static str) -> String {
651 LinkEnd::Client => self.ordinary(key)?,
653 self.first_of(key, SKL::ClientAgnostic)?
660 pub fn special_server(&self, key: &'static str) -> ServerName {
661 self.server_name.clone()
667 let opts = config::Opts::from_args();
670 let mut agg = Aggregate::default();
672 agg.read_string(DEFAULT_CONFIG.into(),
673 "<build-in defaults>".as_ref()).unwrap();
675 agg.read_toplevel(&opts.config)?;
676 for extra in &opts.extra_config {
677 agg.read_extra(extra).context("extra config")?;
680 eprintln!("GOT {:#?}", agg);
683 })().context("read configuration")?;
685 let server_name = agg.establish_server_name()?;
687 let link = LinkName {
688 server: "fooxxx".parse().unwrap(),
689 client: "127.0.0.1".parse().unwrap(),
692 let rctx = ResolveContext {
695 end: LinkEnd::Server,
698 SN::Link(link.clone()),
699 SN::Client(link.client.clone()),
700 SN::Server(link.server.clone()),
702 SN::ServerLimit(link.server.clone()),
707 let server_name = self.establish_server_name()
708 .context("establish server name")?;
710 let ic = InstanceConfig::resolve_instance(&rctx)
711 .context("resolve config xxx for")?;
713 eprintln!("{:?}", &ic);