crates/hub/src/config.rs at de505df5cf8d · andymccall/oxygenhub

# de505df5cf8d oxygenhub / crates / hub / src / config.rs

8.9 KiB · Rust · last changed Milestone 0.2: accounts and access 1 month ago source blame history raw

//! Configuration (hub spec §17.1): `hub.toml` in the data directory, every
//! key overridable by `OXYHUB_<SECTION>_<KEY>`.

use serde::Deserialize;
use std::net::SocketAddr;
use std::path::{Path, PathBuf};

#[derive(Clone, Debug, Deserialize)]
#[serde(default, deny_unknown_fields)]
pub struct Config {
    /// Set from the command line, never from the file.
    #[serde(skip)]
    pub data: PathBuf,
    pub site: Site,
    pub server: Server,
    pub tls: Tls,
    pub auth: Auth,
    pub registration: Registration,
    pub limits: Limits,
    pub retention: Retention,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(default, deny_unknown_fields)]
pub struct Registration {
    /// `open`, `invite` or `closed`; the admin page can override it.
    pub mode: String,
}

impl Default for Registration {
    fn default() -> Self {
        Registration { mode: "invite".into() }
    }
}

#[derive(Clone, Debug, Deserialize)]
#[serde(default, deny_unknown_fields)]
pub struct Site {
    pub name: String,
    pub description: String,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(default, deny_unknown_fields)]
pub struct Server {
    /// Plain HTTP; empty disables it.
    pub bind: String,
    /// HTTPS; empty disables it. Needs `tls`.
    pub tls_bind: String,
    /// What links and clone URLs start with.
    pub base_url: String,
    /// Trust `X-Forwarded-*` from a terminating proxy.
    pub behind_proxy: bool,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(default, deny_unknown_fields)]
pub struct Tls {
    /// Generate a certificate at `init` (developer edition).
    pub self_signed: bool,
    /// PEM files; relative paths are under the data directory.
    pub cert: String,
    pub key: String,
}

#[derive(Clone, Debug, Default, Deserialize)]
#[serde(default, deny_unknown_fields)]
pub struct Auth {
    /// Bearer tokens allowed to push until accounts exist (hub 0.2). Empty
    /// means every push is accepted, as `oxy serve` does.
    pub push_tokens: Vec<String>,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(default, deny_unknown_fields)]
pub struct Limits {
    /// Largest file rendered in the browser, e.g. `2MiB`.
    pub render_limit: ByteSize,
    pub asset_limit: ByteSize,
    pub push_body_limit: ByteSize,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(default, deny_unknown_fields)]
pub struct Retention {
    pub trash_days: u32,
    pub webhook_log_days: u32,
}

/// A byte count written as `512`, `2MiB`, `4GiB`, `100kB`.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct ByteSize(pub u64);

impl ByteSize {
    pub fn parse(s: &str) -> Option<ByteSize> {
        let s = s.trim();
        let digits: String = s.chars().take_while(|c| c.is_ascii_digit()).collect();
        let unit = s[digits.len()..].trim();
        let n: u64 = digits.parse().ok()?;
        let mult = match unit {
            "" | "B" => 1,
            "k" | "kB" | "KB" => 1000,
            "KiB" | "K" => 1 << 10,
            "M" | "MB" => 1_000_000,
            "MiB" => 1 << 20,
            "G" | "GB" => 1_000_000_000,
            "GiB" => 1 << 30,
            _ => return None,
        };
        Some(ByteSize(n.checked_mul(mult)?))
    }
}

impl<'de> Deserialize<'de> for ByteSize {
    fn deserialize<D: serde::Deserializer<'de>>(d: D) -> Result<ByteSize, D::Error> {
        #[derive(Deserialize)]
        #[serde(untagged)]
        enum Raw {
            Number(u64),
            Text(String),
        }
        match Raw::deserialize(d)? {
            Raw::Number(n) => Ok(ByteSize(n)),
            Raw::Text(t) => ByteSize::parse(&t).ok_or_else(|| serde::de::Error::custom(format!("not a byte size: {t:?}"))),
        }
    }
}

impl Default for Site {
    fn default() -> Self {
        Site { name: "Oxygenhub".into(), description: "Repositories, proposals and issues for Oxygen".into() }
    }
}

impl Default for Server {
    fn default() -> Self {
        Server { bind: "127.0.0.1:7300".into(), tls_bind: String::new(), base_url: "http://127.0.0.1:7300".into(), behind_proxy: false }
    }
}

impl Default for Tls {
    fn default() -> Self {
        Tls { self_signed: false, cert: "keys/tls.crt".into(), key: "keys/tls.key".into() }
    }
}

impl Default for Limits {
    fn default() -> Self {
        Limits { render_limit: ByteSize(2 << 20), asset_limit: ByteSize(512 << 20), push_body_limit: ByteSize(4 << 30) }
    }
}

impl Default for Retention {
    fn default() -> Self {
        Retention { trash_days: 30, webhook_log_days: 30 }
    }
}

impl Default for Config {
    fn default() -> Self {
        Config {
            data: PathBuf::from("data"),
            site: Site::default(),
            server: Server::default(),
            tls: Tls::default(),
            auth: Auth::default(),
            registration: Registration::default(),
            limits: Limits::default(),
            retention: Retention::default(),
        }
    }
}

impl Config {
    /// Read `<data>/hub.toml` if present, then apply environment overrides.
    pub fn load(data: &Path) -> anyhow::Result<Config> {
        let path = data.join("hub.toml");
        let mut cfg = match std::fs::read_to_string(&path) {
            Ok(text) => Config::parse(&text)?,
            Err(e) if e.kind() == std::io::ErrorKind::NotFound => Config::default(),
            Err(e) => return Err(anyhow::anyhow!("reading {}: {e}", path.display())),
        };
        cfg.data = data.to_path_buf();
        cfg.apply_env(|k| std::env::var(k).ok());
        Ok(cfg)
    }

    pub fn parse(text: &str) -> anyhow::Result<Config> {
        Ok(toml::from_str(text)?)
    }

    /// `OXYHUB_SERVER_BIND`, `OXYHUB_SITE_NAME`, … override the file.
    pub fn apply_env(&mut self, get: impl Fn(&str) -> Option<String>) {
        if let Some(v) = get("OXYHUB_SITE_NAME") {
            self.site.name = v;
        }
        if let Some(v) = get("OXYHUB_SITE_DESCRIPTION") {
            self.site.description = v;
        }
        if let Some(v) = get("OXYHUB_SERVER_BIND") {
            self.server.bind = v;
        }
        if let Some(v) = get("OXYHUB_SERVER_TLS_BIND") {
            self.server.tls_bind = v;
        }
        if let Some(v) = get("OXYHUB_SERVER_BASE_URL") {
            self.server.base_url = v;
        }
        if let Some(v) = get("OXYHUB_SERVER_BEHIND_PROXY") {
            self.server.behind_proxy = matches!(v.as_str(), "1" | "true" | "yes");
        }
        if let Some(v) = get("OXYHUB_TLS_SELF_SIGNED") {
            self.tls.self_signed = matches!(v.as_str(), "1" | "true" | "yes");
        }
        if let Some(v) = get("OXYHUB_REGISTRATION_MODE") {
            self.registration.mode = v;
        }
        if let Some(v) = get("OXYHUB_AUTH_PUSH_TOKENS") {
            self.auth.push_tokens = v.split(',').map(str::trim).filter(|s| !s.is_empty()).map(String::from).collect();
        }
        if let Some(v) = get("OXYHUB_LIMITS_RENDER_LIMIT").and_then(|v| ByteSize::parse(&v)) {
            self.limits.render_limit = v;
        }
    }

    pub fn bind_addr(&self) -> anyhow::Result<Option<SocketAddr>> {
        parse_addr(&self.server.bind)
    }

    pub fn tls_bind_addr(&self) -> anyhow::Result<Option<SocketAddr>> {
        parse_addr(&self.server.tls_bind)
    }

    pub fn tls_cert(&self) -> PathBuf {
        self.data.join(&self.tls.cert)
    }

    pub fn tls_key(&self) -> PathBuf {
        self.data.join(&self.tls.key)
    }

    pub fn repos_dir(&self) -> PathBuf {
        self.data.join("repos")
    }

    pub fn keys_dir(&self) -> PathBuf {
        self.data.join("keys")
    }

    pub fn db_path(&self) -> PathBuf {
        self.data.join("hub.db")
    }

    /// The base URL without a trailing slash.
    pub fn base_url(&self) -> &str {
        self.server.base_url.trim_end_matches('/')
    }
}

fn parse_addr(s: &str) -> anyhow::Result<Option<SocketAddr>> {
    if s.trim().is_empty() {
        return Ok(None);
    }
    Ok(Some(s.parse().map_err(|e| anyhow::anyhow!("bind address {s:?}: {e}"))?))
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn byte_sizes() {
        assert_eq!(ByteSize::parse("2MiB"), Some(ByteSize(2 << 20)));
        assert_eq!(ByteSize::parse("512"), Some(ByteSize(512)));
        assert_eq!(ByteSize::parse("4 GiB"), Some(ByteSize(4 << 30)));
        assert_eq!(ByteSize::parse("100kB"), Some(ByteSize(100_000)));
        assert_eq!(ByteSize::parse("lots"), None);
    }

    #[test]
    fn file_then_environment() {
        let mut cfg = Config::parse("[server]\nbind = \"0.0.0.0:7300\"\n[limits]\nrender_limit = \"1MiB\"\n").unwrap();
        assert_eq!(cfg.server.bind, "0.0.0.0:7300");
        assert_eq!(cfg.limits.render_limit, ByteSize(1 << 20));
        assert_eq!(cfg.site.name, "Oxygenhub");
        cfg.apply_env(|k| match k {
            "OXYHUB_SITE_NAME" => Some("Earth".into()),
            "OXYHUB_AUTH_PUSH_TOKENS" => Some("a, b".into()),
            _ => None,
        });
        assert_eq!(cfg.site.name, "Earth");
        assert_eq!(cfg.auth.push_tokens, ["a", "b"]);
        assert!(Config::parse("[nope]\nx = 1\n").is_err(), "unknown sections are errors, not silence");
    }
}

`/`	Search
`g` `c`	Code
`g` `h`	History
`g` `b`	Bookmarks
`g` `t`	Trust
`y`	Permalink to this state (files and trees)
`?`	This sheet

1	//! Configuration (hub spec §17.1): `hub.toml` in the data directory, every
2	//! key overridable by `OXYHUB_<SECTION>_<KEY>`.
3
4	use serde::Deserialize;
5	use std::net::SocketAddr;
6	use std::path::{Path, PathBuf};
7
8	#[derive(Clone, Debug, Deserialize)]
9	#[serde(default, deny_unknown_fields)]
10	pub struct Config {
11	/// Set from the command line, never from the file.
12	#[serde(skip)]
13	pub data: PathBuf,
14	pub site: Site,
15	pub server: Server,
16	pub tls: Tls,
17	pub auth: Auth,
18	pub registration: Registration,
19	pub limits: Limits,
20	pub retention: Retention,
21	}
22
23	#[derive(Clone, Debug, Deserialize)]
24	#[serde(default, deny_unknown_fields)]
25	pub struct Registration {
26	/// `open`, `invite` or `closed`; the admin page can override it.
27	pub mode: String,
28	}
29
30	impl Default for Registration {
31	fn default() -> Self {
32	Registration { mode: "invite".into() }
33	}
34	}
35
36	#[derive(Clone, Debug, Deserialize)]
37	#[serde(default, deny_unknown_fields)]
38	pub struct Site {
39	pub name: String,
40	pub description: String,
41	}
42
43	#[derive(Clone, Debug, Deserialize)]
44	#[serde(default, deny_unknown_fields)]
45	pub struct Server {
46	/// Plain HTTP; empty disables it.
47	pub bind: String,
48	/// HTTPS; empty disables it. Needs `tls`.
49	pub tls_bind: String,
50	/// What links and clone URLs start with.
51	pub base_url: String,
52	/// Trust `X-Forwarded-*` from a terminating proxy.
53	pub behind_proxy: bool,
54	}
55
56	#[derive(Clone, Debug, Deserialize)]
57	#[serde(default, deny_unknown_fields)]
58	pub struct Tls {
59	/// Generate a certificate at `init` (developer edition).
60	pub self_signed: bool,
61	/// PEM files; relative paths are under the data directory.
62	pub cert: String,
63	pub key: String,
64	}
65
66	#[derive(Clone, Debug, Default, Deserialize)]
67	#[serde(default, deny_unknown_fields)]
68	pub struct Auth {
69	/// Bearer tokens allowed to push until accounts exist (hub 0.2). Empty
70	/// means every push is accepted, as `oxy serve` does.
71	pub push_tokens: Vec<String>,
72	}
73
74	#[derive(Clone, Debug, Deserialize)]
75	#[serde(default, deny_unknown_fields)]
76	pub struct Limits {
77	/// Largest file rendered in the browser, e.g. `2MiB`.
78	pub render_limit: ByteSize,
79	pub asset_limit: ByteSize,
80	pub push_body_limit: ByteSize,
81	}
82
83	#[derive(Clone, Debug, Deserialize)]
84	#[serde(default, deny_unknown_fields)]
85	pub struct Retention {
86	pub trash_days: u32,
87	pub webhook_log_days: u32,
88	}
89
90	/// A byte count written as `512`, `2MiB`, `4GiB`, `100kB`.
91	#[derive(Clone, Copy, Debug, PartialEq, Eq)]
92	pub struct ByteSize(pub u64);
93
94	impl ByteSize {
95	pub fn parse(s: &str) -> Option<ByteSize> {
96	let s = s.trim();
97	let digits: String = s.chars().take_while(\|c\| c.is_ascii_digit()).collect();
98	let unit = s[digits.len()..].trim();
99	let n: u64 = digits.parse().ok()?;
100	let mult = match unit {
101	"" \| "B" => 1,
102	"k" \| "kB" \| "KB" => 1000,
103	"KiB" \| "K" => 1 << 10,
104	"M" \| "MB" => 1_000_000,
105	"MiB" => 1 << 20,
106	"G" \| "GB" => 1_000_000_000,
107	"GiB" => 1 << 30,
108	_ => return None,
109	};
110	Some(ByteSize(n.checked_mul(mult)?))
111	}
112	}
113
114	impl<'de> Deserialize<'de> for ByteSize {
115	fn deserialize<D: serde::Deserializer<'de>>(d: D) -> Result<ByteSize, D::Error> {
116	#[derive(Deserialize)]
117	#[serde(untagged)]
118	enum Raw {
119	Number(u64),
120	Text(String),
121	}
122	match Raw::deserialize(d)? {
123	Raw::Number(n) => Ok(ByteSize(n)),
124	Raw::Text(t) => ByteSize::parse(&t).ok_or_else(\|\| serde::de::Error::custom(format!("not a byte size: {t:?}"))),
125	}
126	}
127	}
128
129	impl Default for Site {
130	fn default() -> Self {
131	Site { name: "Oxygenhub".into(), description: "Repositories, proposals and issues for Oxygen".into() }
132	}
133	}
134
135	impl Default for Server {
136	fn default() -> Self {
137	Server { bind: "127.0.0.1:7300".into(), tls_bind: String::new(), base_url: "http://127.0.0.1:7300".into(), behind_proxy: false }
138	}
139	}
140
141	impl Default for Tls {
142	fn default() -> Self {
143	Tls { self_signed: false, cert: "keys/tls.crt".into(), key: "keys/tls.key".into() }
144	}
145	}
146
147	impl Default for Limits {
148	fn default() -> Self {
149	Limits { render_limit: ByteSize(2 << 20), asset_limit: ByteSize(512 << 20), push_body_limit: ByteSize(4 << 30) }
150	}
151	}
152
153	impl Default for Retention {
154	fn default() -> Self {
155	Retention { trash_days: 30, webhook_log_days: 30 }
156	}
157	}
158
159	impl Default for Config {
160	fn default() -> Self {
161	Config {
162	data: PathBuf::from("data"),
163	site: Site::default(),
164	server: Server::default(),
165	tls: Tls::default(),
166	auth: Auth::default(),
167	registration: Registration::default(),
168	limits: Limits::default(),
169	retention: Retention::default(),
170	}
171	}
172	}
173
174	impl Config {
175	/// Read `<data>/hub.toml` if present, then apply environment overrides.
176	pub fn load(data: &Path) -> anyhow::Result<Config> {
177	let path = data.join("hub.toml");
178	let mut cfg = match std::fs::read_to_string(&path) {
179	Ok(text) => Config::parse(&text)?,
180	Err(e) if e.kind() == std::io::ErrorKind::NotFound => Config::default(),
181	Err(e) => return Err(anyhow::anyhow!("reading {}: {e}", path.display())),
182	};
183	cfg.data = data.to_path_buf();
184	cfg.apply_env(\|k\| std::env::var(k).ok());
185	Ok(cfg)
186	}
187
188	pub fn parse(text: &str) -> anyhow::Result<Config> {
189	Ok(toml::from_str(text)?)
190	}
191
192	/// `OXYHUB_SERVER_BIND`, `OXYHUB_SITE_NAME`, … override the file.
193	pub fn apply_env(&mut self, get: impl Fn(&str) -> Option<String>) {
194	if let Some(v) = get("OXYHUB_SITE_NAME") {
195	self.site.name = v;
196	}
197	if let Some(v) = get("OXYHUB_SITE_DESCRIPTION") {
198	self.site.description = v;
199	}
200	if let Some(v) = get("OXYHUB_SERVER_BIND") {
201	self.server.bind = v;
202	}
203	if let Some(v) = get("OXYHUB_SERVER_TLS_BIND") {
204	self.server.tls_bind = v;
205	}
206	if let Some(v) = get("OXYHUB_SERVER_BASE_URL") {
207	self.server.base_url = v;
208	}
209	if let Some(v) = get("OXYHUB_SERVER_BEHIND_PROXY") {
210	self.server.behind_proxy = matches!(v.as_str(), "1" \| "true" \| "yes");
211	}
212	if let Some(v) = get("OXYHUB_TLS_SELF_SIGNED") {
213	self.tls.self_signed = matches!(v.as_str(), "1" \| "true" \| "yes");
214	}
215	if let Some(v) = get("OXYHUB_REGISTRATION_MODE") {
216	self.registration.mode = v;
217	}
218	if let Some(v) = get("OXYHUB_AUTH_PUSH_TOKENS") {
219	self.auth.push_tokens = v.split(',').map(str::trim).filter(\|s\| !s.is_empty()).map(String::from).collect();
220	}
221	if let Some(v) = get("OXYHUB_LIMITS_RENDER_LIMIT").and_then(\|v\| ByteSize::parse(&v)) {
222	self.limits.render_limit = v;
223	}
224	}
225
226	pub fn bind_addr(&self) -> anyhow::Result<Option<SocketAddr>> {
227	parse_addr(&self.server.bind)
228	}
229
230	pub fn tls_bind_addr(&self) -> anyhow::Result<Option<SocketAddr>> {
231	parse_addr(&self.server.tls_bind)
232	}
233
234	pub fn tls_cert(&self) -> PathBuf {
235	self.data.join(&self.tls.cert)
236	}
237
238	pub fn tls_key(&self) -> PathBuf {
239	self.data.join(&self.tls.key)
240	}
241
242	pub fn repos_dir(&self) -> PathBuf {
243	self.data.join("repos")
244	}
245
246	pub fn keys_dir(&self) -> PathBuf {
247	self.data.join("keys")
248	}
249
250	pub fn db_path(&self) -> PathBuf {
251	self.data.join("hub.db")
252	}
253
254	/// The base URL without a trailing slash.
255	pub fn base_url(&self) -> &str {
256	self.server.base_url.trim_end_matches('/')
257	}
258	}
259
260	fn parse_addr(s: &str) -> anyhow::Result<Option<SocketAddr>> {
261	if s.trim().is_empty() {
262	return Ok(None);
263	}
264	Ok(Some(s.parse().map_err(\|e\| anyhow::anyhow!("bind address {s:?}: {e}"))?))
265	}
266
267	#[cfg(test)]
268	mod tests {
269	use super::*;
270
271	#[test]
272	fn byte_sizes() {
273	assert_eq!(ByteSize::parse("2MiB"), Some(ByteSize(2 << 20)));
274	assert_eq!(ByteSize::parse("512"), Some(ByteSize(512)));
275	assert_eq!(ByteSize::parse("4 GiB"), Some(ByteSize(4 << 30)));
276	assert_eq!(ByteSize::parse("100kB"), Some(ByteSize(100_000)));
277	assert_eq!(ByteSize::parse("lots"), None);
278	}
279
280	#[test]
281	fn file_then_environment() {
282	let mut cfg = Config::parse("[server]\nbind = \"0.0.0.0:7300\"\n[limits]\nrender_limit = \"1MiB\"\n").unwrap();
283	assert_eq!(cfg.server.bind, "0.0.0.0:7300");
284	assert_eq!(cfg.limits.render_limit, ByteSize(1 << 20));
285	assert_eq!(cfg.site.name, "Oxygenhub");
286	cfg.apply_env(\|k\| match k {
287	"OXYHUB_SITE_NAME" => Some("Earth".into()),
288	"OXYHUB_AUTH_PUSH_TOKENS" => Some("a, b".into()),
289	_ => None,
290	});
291	assert_eq!(cfg.site.name, "Earth");
292	assert_eq!(cfg.auth.push_tokens, ["a", "b"]);
293	assert!(Config::parse("[nope]\nx = 1\n").is_err(), "unknown sections are errors, not silence");
294	}
295	}

Keyboard