//! Configuration file and settings management use lazy_static::lazy_static; use log::*; use serde::{Deserialize, Serialize}; use std::sync::RwLock; use std::time::Duration; // initialize a singleton default configuration lazy_static! { pub static ref SETTINGS: RwLock = RwLock::new(Settings::default()); } #[derive(Debug, Serialize, Deserialize, Clone)] #[allow(unused)] pub struct Info { pub relay_url: Option, pub name: Option, pub description: Option, pub pubkey: Option, pub contact: Option, } #[derive(Debug, Serialize, Deserialize)] #[allow(unused)] pub struct Database { pub data_directory: String, pub min_conn: u32, pub max_conn: u32, } #[derive(Debug, Serialize, Deserialize)] #[allow(unused)] pub struct Network { pub port: u16, pub address: String, } // #[derive(Debug, Serialize, Deserialize)] #[allow(unused)] pub struct Options { pub reject_future_seconds: Option, // if defined, reject any events with a timestamp more than X seconds in the future } #[derive(Debug, Serialize, Deserialize)] #[allow(unused)] pub struct Retention { // TODO: implement pub max_events: Option, // max events pub max_bytes: Option, // max size pub persist_days: Option, // oldest message pub whitelist_addresses: Option>, // whitelisted addresses (never delete) } #[derive(Debug, Serialize, Deserialize)] #[allow(unused)] pub struct Limits { pub messages_per_sec: Option, // Artificially slow down event writing to limit disk consumption (averaged over 1 minute) pub max_event_bytes: Option, // Maximum size of an EVENT message pub max_ws_message_bytes: Option, pub max_ws_frame_bytes: Option, pub broadcast_buffer: usize, // events to buffer for subscribers (prevents slow readers from consuming memory) pub event_persist_buffer: usize, // events to buffer for database commits (block senders if database writes are too slow) } #[derive(Debug, Serialize, Deserialize)] #[allow(unused)] pub struct Authorization { pub pubkey_whitelist: Option>, // If present, only allow these pubkeys to publish events } #[derive(Serialize, Deserialize, PartialEq, Debug, Clone)] #[serde(rename_all = "lowercase")] pub enum VerifiedUsersMode { Enabled, Passive, Disabled, } #[derive(Debug, Serialize, Deserialize)] #[allow(unused)] pub struct VerifiedUsers { pub mode: VerifiedUsersMode, // Mode of operation: "enabled" (enforce) or "passive" (check only). If none, this is simply disabled. pub domain_whitelist: Option>, // If present, only allow verified users from these domains can publish events pub domain_blacklist: Option>, // If present, allow all verified users from any domain except these pub verify_expiration: Option, // how long a verification is cached for before no longer being used pub verify_update_frequency: Option, // how often to attempt to update verification pub verify_expiration_duration: Option, // internal result of parsing verify_expiration pub verify_update_frequency_duration: Option, // internal result of parsing verify_update_frequency pub max_consecutive_failures: usize, // maximum number of verification failures in a row, before ceasing future checks } impl VerifiedUsers { pub fn init(&mut self) { self.verify_expiration_duration = self.verify_expiration_duration(); self.verify_update_frequency_duration = self.verify_update_duration(); } pub fn is_enabled(&self) -> bool { self.mode == VerifiedUsersMode::Enabled } pub fn is_active(&self) -> bool { self.mode == VerifiedUsersMode::Enabled || self.mode == VerifiedUsersMode::Passive } pub fn is_passive(&self) -> bool { self.mode == VerifiedUsersMode::Passive } pub fn verify_expiration_duration(&self) -> Option { self.verify_expiration .as_ref() .and_then(|x| parse_duration::parse(x).ok()) } pub fn verify_update_duration(&self) -> Option { self.verify_update_frequency .as_ref() .and_then(|x| parse_duration::parse(x).ok()) } pub fn is_valid(&self) -> bool { self.verify_expiration_duration().is_some() && self.verify_update_duration().is_some() } } #[derive(Debug, Serialize, Deserialize)] #[allow(unused)] pub struct Settings { pub info: Info, pub database: Database, pub network: Network, pub limits: Limits, pub authorization: Authorization, pub verified_users: VerifiedUsers, pub retention: Retention, pub options: Options, } impl Settings { pub fn new() -> Self { let d = Self::default(); // attempt to construct settings with file // Self::new_from_default(&d).unwrap_or(d) let from_file = Self::new_from_default(&d); match from_file { Ok(f) => f, Err(e) => { warn!("Error reading config file ({:?})", e); d } } } fn new_from_default(default: &Settings) -> Result { let config: config::Config = config::Config::new(); let mut settings: Settings = config // use defaults .with_merged(config::Config::try_from(default).unwrap())? // override with file contents .with_merged(config::File::with_name("config"))? .try_into()?; // ensure connection pool size is logical if settings.database.min_conn > settings.database.max_conn { panic!( "Database min_conn setting ({}) cannot exceed max_conn ({})", settings.database.min_conn, settings.database.max_conn ); } // ensure durations parse if !settings.verified_users.is_valid() { panic!("VerifiedUsers time settings could not be parsed"); } // initialize durations for verified users settings.verified_users.init(); Ok(settings) } } impl Default for Settings { fn default() -> Self { Settings { info: Info { relay_url: None, name: Some("Unnamed nostr-rs-relay".to_owned()), description: None, pubkey: None, contact: None, }, database: Database { data_directory: ".".to_owned(), min_conn: 4, max_conn: 128, }, network: Network { port: 8080, address: "0.0.0.0".to_owned(), }, limits: Limits { messages_per_sec: None, max_event_bytes: Some(2 << 17), // 128K max_ws_message_bytes: Some(2 << 17), // 128K max_ws_frame_bytes: Some(2 << 17), // 128K broadcast_buffer: 16384, event_persist_buffer: 4096, }, authorization: Authorization { pubkey_whitelist: None, // Allow any address to publish }, verified_users: VerifiedUsers { mode: VerifiedUsersMode::Disabled, domain_whitelist: None, domain_blacklist: None, verify_expiration: Some("1 week".to_owned()), verify_update_frequency: Some("1 day".to_owned()), verify_expiration_duration: None, verify_update_frequency_duration: None, max_consecutive_failures: 20, }, retention: Retention { max_events: None, // max events max_bytes: None, // max size persist_days: None, // oldest message whitelist_addresses: None, // whitelisted addresses (never delete) }, options: Options { reject_future_seconds: Some(30 * 60), // Reject events 30min in the future or greater }, } } }