1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
//! Server configuration.
use serde::{Deserialize, Serialize};
use std::{
collections::HashSet,
net::{IpAddr, Ipv4Addr, SocketAddr},
path::{Path, PathBuf},
};
use url::Url;
use super::backend::Backend;
use super::{Error, Result};
use sos_protocol::sdk::{signer::ecdsa::Address, vfs};
/// Configuration for the web server.
#[derive(Default, Debug, Serialize, Deserialize)]
#[serde(default)]
pub struct ServerConfig {
/// Storage for the backend.
pub storage: StorageConfig,
/// Access controls.
pub access: Option<AccessControlConfig>,
/// Configuration for the network.
pub net: NetworkConfig,
/// Path the file was loaded from used to determine
/// relative paths.
#[serde(skip)]
file: Option<PathBuf>,
}
/// Access control configuration.
///
/// Denied entries take precedence so if you allow and
/// deny the same address it will be denied.
#[derive(Debug, Default, Clone, Serialize, Deserialize)]
pub struct AccessControlConfig {
/// Addresses that are explicitly allowed.
pub allow: Option<HashSet<Address>>,
/// Addresses that are explicitly denied.
pub deny: Option<HashSet<Address>>,
}
impl AccessControlConfig {
/// Determine if a signing key address is allowed access
/// to this server.
pub fn is_allowed_access(&self, address: &Address) -> bool {
let has_definitions = self.allow.is_some() || self.deny.is_some();
if has_definitions {
match (&self.deny, &self.allow) {
(Some(deny), None) => {
if deny.iter().any(|a| a == address) {
return false;
}
true
}
(None, Some(allow)) => {
if allow.iter().any(|a| a == address) {
return true;
}
false
}
(Some(deny), Some(allow)) => {
if allow.iter().any(|a| a == address) {
return true;
}
if deny.iter().any(|a| a == address) {
return false;
}
false
}
_ => true,
}
} else {
true
}
}
}
/// Server network configuration.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(default)]
pub struct NetworkConfig {
/// Bind address for the server.
pub bind: SocketAddr,
/// SSL configuration.
pub ssl: SslConfig,
/// Configuration for CORS.
pub cors: Option<CorsConfig>,
}
impl Default for NetworkConfig {
fn default() -> Self {
Self {
bind: SocketAddr::new(
IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)),
5053,
),
ssl: Default::default(),
cors: None,
}
}
}
/// Server SSL configuration.
#[derive(Debug, Default, Clone, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum SslConfig {
/// Default HTTP transport.
#[default]
None,
/// Configuration for TLS certificate and private key.
Tls(TlsConfig),
/// Configuration for Let's Encrypt ACME certificates.
#[cfg(feature = "acme")]
Acme(AcmeConfig),
}
/// Certificate and key for TLS.
#[derive(Debug, Default, Clone, Serialize, Deserialize)]
pub struct TlsConfig {
/// Path to the certificate.
pub cert: PathBuf,
/// Path to the certificate key file.
pub key: PathBuf,
}
/// Configuration for ACME certficates.
#[cfg(feature = "acme")]
#[derive(Debug, Default, Clone, Serialize, Deserialize)]
pub struct AcmeConfig {
/// Path to the cache directory.
pub cache: PathBuf,
/// List of domain names.
pub domains: Vec<String>,
/// List of email addresses.
pub email: Vec<String>,
/// Use production environment.
pub production: bool,
}
/// Configuration for CORS.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CorsConfig {
/// List of additional CORS origins for the server.
pub origins: Vec<Url>,
}
/// Configuration for storage locations.
#[derive(Debug, Serialize, Deserialize)]
pub struct StorageConfig {
/// URL for the backend storage.
pub path: PathBuf,
}
impl Default for StorageConfig {
fn default() -> Self {
Self {
path: PathBuf::from("."),
}
}
}
impl ServerConfig {
/// Load a server config from a file path.
pub async fn load<P: AsRef<Path>>(path: P) -> Result<Self> {
if !vfs::try_exists(path.as_ref()).await? {
return Err(Error::NotFile(path.as_ref().to_path_buf()));
}
let contents = vfs::read_to_string(path.as_ref()).await?;
let mut config: ServerConfig = toml::from_str(&contents)?;
config.file = Some(path.as_ref().canonicalize()?);
let dir = config.directory();
if let SslConfig::Tls(tls) = &mut config.net.ssl {
if tls.cert.is_relative() {
tls.cert = dir.join(&tls.cert);
}
if tls.key.is_relative() {
tls.key = dir.join(&tls.key);
}
tls.cert = tls.cert.canonicalize()?;
tls.key = tls.key.canonicalize()?;
}
Ok(config)
}
/// Set the server bind address.
pub fn set_bind_address(&mut self, addr: SocketAddr) {
self.net.bind = addr;
}
/// Server bind address.
pub fn bind_address(&self) -> &SocketAddr {
&self.net.bind
}
/// Parent directory of the configuration file.
fn directory(&self) -> PathBuf {
self.file
.as_ref()
.unwrap()
.parent()
.map(|p| p.to_path_buf())
.unwrap()
}
/// Get the backend implementation.
pub async fn backend(&self) -> Result<Backend> {
// Config file directory for relative file paths.
let dir = self.directory();
let path = &self.storage.path;
let path = if path.is_relative() {
dir.join(path)
} else {
path.to_owned()
};
let path = path.canonicalize()?;
let mut backend = Backend::new(path);
backend.read_dir().await?;
Ok(backend)
}
}