fedimovies/src/config.rs
2021-11-26 22:39:54 +00:00

227 lines
6.2 KiB
Rust

use std::path::PathBuf;
use std::str::FromStr;
use rsa::RsaPrivateKey;
use serde::{de, Deserialize, Deserializer};
use url::Url;
use crate::activitypub::views::get_instance_actor_url;
use crate::errors::ConversionError;
use crate::utils::crypto::deserialize_private_key;
#[derive(Clone, Debug)]
pub enum Environment {
Development,
Production,
}
impl FromStr for Environment {
type Err = ConversionError;
fn from_str(val: &str) -> Result<Self, Self::Err> {
let environment = match val {
"development" => Environment::Development,
"production" => Environment::Production,
_ => return Err(ConversionError),
};
Ok(environment)
}
}
fn environment_from_str<'de, D>(deserializer: D) -> Result<Environment, D::Error>
where
D: Deserializer<'de>,
{
let s: String = Deserialize::deserialize(deserializer)?;
Environment::from_str(&s).map_err(de::Error::custom)
}
#[derive(Clone)]
pub struct EnvConfig {
pub environment: Option<Environment>,
pub config_path: String,
pub crate_version: String,
}
fn parse_env() -> EnvConfig {
dotenv::from_filename(".env.local").ok();
dotenv::dotenv().ok();
let environment_str = std::env::var("ENVIRONMENT").ok();
let environment = environment_str
.map(|val| Environment::from_str(&val).expect("invalid environment type"));
let config_path = std::env::var("CONFIG_PATH")
.unwrap_or("config.yaml".to_string());
let crate_version = env!("CARGO_PKG_VERSION").to_string();
EnvConfig {
environment,
config_path,
crate_version,
}
}
fn default_environment() -> Environment { Environment::Development }
#[derive(Clone, Deserialize)]
pub struct EthereumContract {
pub address: String,
pub chain_id: u32,
pub signing_key: String,
}
#[derive(Clone, Deserialize)]
pub struct Config {
#[serde(default = "default_environment")]
#[serde(deserialize_with = "environment_from_str")]
pub environment: Environment,
#[serde(skip)]
pub version: String,
// Core settings
pub database_url: String,
pub storage_dir: PathBuf,
pub http_host: String,
pub http_port: u32,
// Instance info
instance_uri: String,
pub instance_title: String,
pub instance_short_description: String,
pub instance_description: String,
instance_rsa_key: String,
#[serde(default)]
pub registrations_open: bool, // default is false
pub login_message: String,
// Ethereum & IPFS
pub ethereum_contract_dir: Option<PathBuf>,
pub ethereum_json_rpc_url: Option<String>,
pub ethereum_explorer_url: Option<String>,
pub ethereum_contract: Option<EthereumContract>,
pub ipfs_api_url: Option<String>,
pub ipfs_gateway_url: Option<String>,
}
impl Config {
fn try_instance_url(&self) -> Result<Url, ConversionError> {
// TODO: allow http in production
let scheme = match self.environment {
Environment::Development => "http",
Environment::Production => "https",
};
let url_str = format!("{}://{}", scheme, self.instance_uri);
let url = Url::parse(&url_str).map_err(|_| ConversionError)?;
url.host().ok_or(ConversionError)?; // validates URL
Ok(url)
}
fn try_instance_rsa_key(&self) -> Result<RsaPrivateKey, rsa::pkcs8::Error> {
deserialize_private_key(&self.instance_rsa_key)
}
pub fn instance(&self) -> Instance {
Instance {
_url: self.try_instance_url().unwrap(),
actor_key: self.try_instance_rsa_key().unwrap(),
is_private: matches!(self.environment, Environment::Development),
}
}
pub fn instance_url(&self) -> String {
self.instance().url()
}
pub fn media_dir(&self) -> PathBuf {
self.storage_dir.join("media")
}
}
pub struct Instance {
_url: Url,
// Instance actor
pub actor_key: RsaPrivateKey,
// Private instance won't send signed HTTP requests
pub is_private: bool,
}
impl Instance {
pub fn url(&self) -> String {
self._url.origin().ascii_serialization()
}
pub fn host(&self) -> String {
self._url.host_str().unwrap().to_string()
}
pub fn actor_id(&self) -> String {
get_instance_actor_url(&self.url())
}
pub fn actor_key_id(&self) -> String {
format!("{}#main-key", self.actor_id())
}
}
pub fn parse_config() -> Config {
let env = parse_env();
let config_yaml = std::fs::read_to_string(env.config_path)
.expect("failed to load config file");
let mut config = serde_yaml::from_str::<Config>(&config_yaml)
.expect("invalid yaml data");
// Override environment parameter in config if env variable is set
config.environment = env.environment.unwrap_or(config.environment);
// Set_version
config.version = env.crate_version;
// Validate config
if !config.storage_dir.exists() {
panic!("storage directory does not exist");
};
if let Some(contract_dir) = &config.ethereum_contract_dir {
if !contract_dir.exists() {
panic!("contract directory does not exist");
};
};
config.try_instance_url().expect("invalid instance URI");
config.try_instance_rsa_key().expect("invalid instance RSA key");
config
}
#[cfg(test)]
mod tests {
use rand::rngs::OsRng;
use super::*;
#[test]
fn test_instance_url_https_dns() {
let instance_url = Url::parse("https://example.com/").unwrap();
let instance_rsa_key = RsaPrivateKey::new(&mut OsRng, 512).unwrap();
let instance = Instance {
_url: instance_url,
actor_key: instance_rsa_key,
is_private: true,
};
assert_eq!(instance.url(), "https://example.com");
assert_eq!(instance.host(), "example.com");
}
#[test]
fn test_instance_url_http_ipv4() {
let instance_url = Url::parse("http://1.2.3.4:3777/").unwrap();
let instance_rsa_key = RsaPrivateKey::new(&mut OsRng, 512).unwrap();
let instance = Instance {
_url: instance_url,
actor_key: instance_rsa_key,
is_private: true,
};
assert_eq!(instance.url(), "http://1.2.3.4:3777");
assert_eq!(instance.host(), "1.2.3.4");
}
}