Deuxfleurs/diplonat
23
4
Fork 1
Code Issues 8 Pull requests Releases Wiki Activity

Modular Diplonat (with the option to disable useless modules) #8

Closed
adrien wants to merge 12 commits from adrien/diplonat:feature/modular-config into main
pull from: adrien/diplonat:feature/modular-config
merge into: Deuxfleurs:main
Conversation 4 Commits 12 Files changed 11 +424 -358
13 changed files with 424 additions and 358 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 2e797d2f62 - Show all commits

2
.rustfmt.toml Normal file
View file

@ -0,0 +1,2 @@
hard_tabs = false
tab_spaces = 2

10
src/config/mod.rs
View file

@ -3,9 +3,13 @@ mod options;
mod options_test; mod options_test;
mod runtime; mod runtime;
pub use options::{ConfigOpts, ConfigOptsConsul, ConfigOptsAcme, ConfigOptsFirewall, ConfigOptsIgd}; pub use options::{
pub use runtime::{RuntimeConfig, RuntimeConfigAcme, RuntimeConfigConsul, RuntimeConfigFirewall, RuntimeConfigIgd}; ConfigOpts, ConfigOptsAcme, ConfigOptsConsul, ConfigOptsFirewall, ConfigOptsIgd,
};
pub use runtime::{
RuntimeConfig, RuntimeConfigAcme, RuntimeConfigConsul, RuntimeConfigFirewall, RuntimeConfigIgd,
};
pub const EXPIRATION_TIME: u16 = 300; pub const EXPIRATION_TIME: u16 = 300;
pub const REFRESH_TIME: u16 = 60; pub const REFRESH_TIME: u16 = 60;
pub const CONSUL_URL: &str = "http://127.0.0.1:8500"; pub const CONSUL_URL: &str = "http://127.0.0.1:8500";

116
src/config/options.rs
View file

@ -12,93 +12,95 @@ use crate::config::RuntimeConfig;
// There is no *need* to have a 'DIPLONAT_XXX_*' prefix for all config options. // There is no *need* to have a 'DIPLONAT_XXX_*' prefix for all config options.
// If some config options are shared by several modules, a ConfigOptsBase could // If some config options are shared by several modules, a ConfigOptsBase could
// contain them, and parse the 'DIPLONAT_*' prefix directly. // contain them, and parse the 'DIPLONAT_*' prefix directly.
// Only in runtime.rs would these options find their proper location in each // Only in runtime.rs would these options find their proper location in each
// module's struct. // module's struct.
/// Consul configuration options /// Consul configuration options
#[derive(Clone, Default, Deserialize)] #[derive(Clone, Default, Deserialize)]
pub struct ConfigOptsConsul { pub struct ConfigOptsConsul {
/// Consul's node name [default: None] /// Consul's node name [default: None]
pub node_name: Option<String>, pub node_name: Option<String>,
/// Consul's REST URL [default: "http://127.0.0.1:8500"] /// Consul's REST URL [default: "http://127.0.0.1:8500"]
pub url: Option<String>, pub url: Option<String>,
} }
/// ACME configuration options /// ACME configuration options
#[derive(Clone, Default, Deserialize)] #[derive(Clone, Default, Deserialize)]
pub struct ConfigOptsAcme { pub struct ConfigOptsAcme {
/// Whether the ACME module is enabled [default: false] /// Whether the ACME module is enabled [default: false]
#[serde(default)] #[serde(default)]
pub enable: bool, pub enable: bool,
/// The default domain holder's e-mail [default: None] /// The default domain holder's e-mail [default: None]
pub email: Option<String>, pub email: Option<String>,
} }
/// Firewall configuration options /// Firewall configuration options
#[derive(Clone, Default, Deserialize)] #[derive(Clone, Default, Deserialize)]
pub struct ConfigOptsFirewall { pub struct ConfigOptsFirewall {
/// Whether the firewall module is enabled [default: false] /// Whether the firewall module is enabled [default: false]
#[serde(default)] #[serde(default)]
pub enable: bool, pub enable: bool,
/// Refresh time for firewall rules [default: 300] /// Refresh time for firewall rules [default: 300]
pub refresh_time: Option<u16>, pub refresh_time: Option<u16>,
} }
/// IGD configuration options /// IGD configuration options
#[derive(Clone, Default, Deserialize)] #[derive(Clone, Default, Deserialize)]
pub struct ConfigOptsIgd { pub struct ConfigOptsIgd {
/// Whether the IGD module is enabled [default: false] /// Whether the IGD module is enabled [default: false]
#[serde(default)] #[serde(default)]
pub enable: bool, pub enable: bool,
/// This node's private IP address [default: None] /// This node's private IP address [default: None]
pub private_ip: Option<String>, pub private_ip: Option<String>,
/// Expiration time for IGD rules [default: 60] /// Expiration time for IGD rules [default: 60]
pub expiration_time: Option<u16>, pub expiration_time: Option<u16>,
/// Refresh time for IGD rules [default: 300] /// Refresh time for IGD rules [default: 300]
pub refresh_time: Option<u16>, pub refresh_time: Option<u16>,
} }
/// Model of all potential configuration options /// Model of all potential configuration options
pub struct ConfigOpts { pub struct ConfigOpts {
pub consul: ConfigOptsConsul, pub consul: ConfigOptsConsul,
pub acme: ConfigOptsAcme, pub acme: ConfigOptsAcme,
pub firewall: ConfigOptsFirewall, pub firewall: ConfigOptsFirewall,
pub igd: ConfigOptsIgd, pub igd: ConfigOptsIgd,
} }
impl ConfigOpts { impl ConfigOpts {
pub fn from_env() -> Result<RuntimeConfig> { pub fn from_env() -> Result<RuntimeConfig> {
let consul: ConfigOptsConsul = envy::prefixed("DIPLONAT_CONSUL_").from_env()?; let consul: ConfigOptsConsul = envy::prefixed("DIPLONAT_CONSUL_").from_env()?;
let acme: ConfigOptsAcme = envy::prefixed("DIPLONAT_ACME_").from_env()?; let acme: ConfigOptsAcme = envy::prefixed("DIPLONAT_ACME_").from_env()?;
let firewall: ConfigOptsFirewall = envy::prefixed("DIPLONAT_FIREWALL_").from_env()?; let firewall: ConfigOptsFirewall = envy::prefixed("DIPLONAT_FIREWALL_").from_env()?;
let igd: ConfigOptsIgd = envy::prefixed("DIPLONAT_IGD_").from_env()?; let igd: ConfigOptsIgd = envy::prefixed("DIPLONAT_IGD_").from_env()?;
RuntimeConfig::new(Self { RuntimeConfig::new(Self {
consul, consul,
acme, acme,
firewall, firewall,
igd, igd,
}) })
} }
// Currently only used in tests // Currently only used in tests
#[allow(dead_code)] #[allow(dead_code)]
pub fn from_iter<Iter: Clone>(iter: Iter) -> Result<RuntimeConfig> pub fn from_iter<Iter: Clone>(iter: Iter) -> Result<RuntimeConfig>
where Iter: IntoIterator<Item = (String, String)> { where
let consul: ConfigOptsConsul = envy::prefixed("DIPLONAT_CONSUL_").from_iter(iter.clone())?; Iter: IntoIterator<Item = (String, String)>,
let acme: ConfigOptsAcme = envy::prefixed("DIPLONAT_ACME_").from_iter(iter.clone())?; {
let firewall: ConfigOptsFirewall = envy::prefixed("DIPLONAT_FIREWALL_").from_iter(iter.clone())?; let consul: ConfigOptsConsul = envy::prefixed("DIPLONAT_CONSUL_").from_iter(iter.clone())?;
let igd: ConfigOptsIgd = envy::prefixed("DIPLONAT_IGD_").from_iter(iter.clone())?; let acme: ConfigOptsAcme = envy::prefixed("DIPLONAT_ACME_").from_iter(iter.clone())?;
let firewall: ConfigOptsFirewall =
envy::prefixed("DIPLONAT_FIREWALL_").from_iter(iter.clone())?;
let igd: ConfigOptsIgd = envy::prefixed("DIPLONAT_IGD_").from_iter(iter.clone())?;
RuntimeConfig::new(Self { RuntimeConfig::new(Self {
consul, consul,
acme, acme,
firewall, firewall,
igd, igd,
}) })
} }
} }

216
src/config/options_test.rs
View file

@ -5,28 +5,43 @@ use crate::config::*;
// Environment variables are set for the entire process and // Environment variables are set for the entire process and
// tests are run whithin the same process. // tests are run whithin the same process.
// => We cannot test ConfigOpts::from_env(), // => We cannot test ConfigOpts::from_env(),
// because tests modify each other's environment. // because tests modify each other's environment.
// This is why we only test ConfigOpts::from_iter(iter). // This is why we only test ConfigOpts::from_iter(iter).
fn minimal_valid_options() -> HashMap<String, String> { fn minimal_valid_options() -> HashMap<String, String> {
let mut opts = HashMap::new(); let mut opts = HashMap::new();
opts.insert("DIPLONAT_CONSUL_NODE_NAME".to_string(), "consul_node".to_string()); opts.insert(
opts "DIPLONAT_CONSUL_NODE_NAME".to_string(),
"consul_node".to_string(),
);
opts
} }
fn all_valid_options() -> HashMap<String, String> { fn all_valid_options() -> HashMap<String, String> {
let mut opts = minimal_valid_options(); let mut opts = minimal_valid_options();
opts.insert("DIPLONAT_CONSUL_URL".to_string(), "http://127.0.0.1:9999".to_string()); opts.insert(
opts.insert("DIPLONAT_ACME_ENABLE".to_string(), "true".to_string()); "DIPLONAT_CONSUL_URL".to_string(),
opts.insert("DIPLONAT_ACME_EMAIL".to_string(), "bozo@bozo.net".to_string()); "http://127.0.0.1:9999".to_string(),
opts.insert("DIPLONAT_FIREWALL_ENABLE".to_string(), "true".to_string()); );
opts.insert("DIPLONAT_FIREWALL_REFRESH_TIME".to_string(), "20".to_string()); opts.insert("DIPLONAT_ACME_ENABLE".to_string(), "true".to_string());
opts.insert("DIPLONAT_IGD_ENABLE".to_string(), "true".to_string()); opts.insert(
opts.insert("DIPLONAT_IGD_PRIVATE_IP".to_string(), "172.123.43.555".to_string()); "DIPLONAT_ACME_EMAIL".to_string(),
opts.insert("DIPLONAT_IGD_EXPIRATION_TIME".to_string(), "60".to_string()); "bozo@bozo.net".to_string(),
opts.insert("DIPLONAT_IGD_REFRESH_TIME".to_string(), "10".to_string()); );
opts opts.insert("DIPLONAT_FIREWALL_ENABLE".to_string(), "true".to_string());
opts.insert(
"DIPLONAT_FIREWALL_REFRESH_TIME".to_string(),
"20".to_string(),
);
opts.insert("DIPLONAT_IGD_ENABLE".to_string(), "true".to_string());
opts.insert(
"DIPLONAT_IGD_PRIVATE_IP".to_string(),
"172.123.43.555".to_string(),
);
opts.insert("DIPLONAT_IGD_EXPIRATION_TIME".to_string(), "60".to_string());
opts.insert("DIPLONAT_IGD_REFRESH_TIME".to_string(), "10".to_string());
opts
} }
// #[test] // #[test]
@ -39,107 +54,108 @@ fn all_valid_options() -> HashMap<String, String> {
#[test] #[test]
#[should_panic] #[should_panic]
fn err_empty_env() { fn err_empty_env() {
std::env::remove_var("DIPLONAT_CONSUL_NODE_NAME"); std::env::remove_var("DIPLONAT_CONSUL_NODE_NAME");
let opts: HashMap<String, String> = HashMap::new(); let opts: HashMap<String, String> = HashMap::new();
ConfigOpts::from_iter(opts).unwrap(); ConfigOpts::from_iter(opts).unwrap();
} }
#[test] #[test]
fn ok_minimal_valid_options() { fn ok_minimal_valid_options() {
let opts = minimal_valid_options(); let opts = minimal_valid_options();
let rt_config = ConfigOpts::from_iter(opts.clone()).unwrap(); let rt_config = ConfigOpts::from_iter(opts.clone()).unwrap();
assert_eq!( assert_eq!(
&rt_config.consul.node_name, &rt_config.consul.node_name,
opts.get(&"DIPLONAT_CONSUL_NODE_NAME".to_string()).unwrap() opts.get(&"DIPLONAT_CONSUL_NODE_NAME".to_string()).unwrap()
); );
assert_eq!( assert_eq!(rt_config.consul.url, CONSUL_URL.to_string());
rt_config.consul.url, assert!(rt_config.acme.is_none());
CONSUL_URL.to_string() assert!(rt_config.firewall.is_none());
); assert!(rt_config.igd.is_none());
assert!(rt_config.acme.is_none()); /*assert_eq!(
assert!(rt_config.firewall.is_none()); rt_config.firewall.refresh_time,
assert!(rt_config.igd.is_none()); Duration::from_secs(REFRESH_TIME.into())
/*assert_eq!( );
rt_config.firewall.refresh_time, assert_eq!(
Duration::from_secs(REFRESH_TIME.into()) &rt_config.igd.private_ip,
); opts.get(&"DIPLONAT_PRIVATE_IP".to_string()).unwrap()
assert_eq!( );
&rt_config.igd.private_ip, assert_eq!(
opts.get(&"DIPLONAT_PRIVATE_IP".to_string()).unwrap() rt_config.igd.expiration_time,
); Duration::from_secs(EXPIRATION_TIME.into())
assert_eq!( );
rt_config.igd.expiration_time, assert_eq!(
Duration::from_secs(EXPIRATION_TIME.into()) rt_config.igd.refresh_time,
); Duration::from_secs(REFRESH_TIME.into())
assert_eq!( );*/
rt_config.igd.refresh_time,
Duration::from_secs(REFRESH_TIME.into())
);*/
} }
#[test] #[test]
#[should_panic] #[should_panic]
fn err_invalid_igd_options() { fn err_invalid_igd_options() {
let mut opts = minimal_valid_options(); let mut opts = minimal_valid_options();
opts.insert("DIPLONAT_IGD_ENABLE".to_string(), "true".to_string()); opts.insert("DIPLONAT_IGD_ENABLE".to_string(), "true".to_string());
opts.insert("DIPLONAT_IGD_EXPIRATION_TIME".to_string(), "60".to_string()); opts.insert("DIPLONAT_IGD_EXPIRATION_TIME".to_string(), "60".to_string());
opts.insert("DIPLONAT_IGD_REFRESH_TIME".to_string(), "60".to_string()); opts.insert("DIPLONAT_IGD_REFRESH_TIME".to_string(), "60".to_string());
ConfigOpts::from_iter(opts).unwrap(); ConfigOpts::from_iter(opts).unwrap();
} }
#[test] #[test]
fn ok_all_valid_options() { fn ok_all_valid_options() {
let opts = all_valid_options(); let opts = all_valid_options();
let rt_config = ConfigOpts::from_iter(opts.clone()).unwrap(); let rt_config = ConfigOpts::from_iter(opts.clone()).unwrap();
let firewall_refresh_time = Duration::from_secs( let firewall_refresh_time = Duration::from_secs(
opts.get(&"DIPLONAT_FIREWALL_REFRESH_TIME".to_string()).unwrap() opts
.parse::<u64>().unwrap() .get(&"DIPLONAT_FIREWALL_REFRESH_TIME".to_string())
.into()); .unwrap()
let igd_expiration_time = Duration::from_secs( .parse::<u64>()
opts.get(&"DIPLONAT_IGD_EXPIRATION_TIME".to_string()).unwrap() .unwrap()
.parse::<u64>().unwrap() .into(),
.into()); );
let igd_refresh_time = Duration::from_secs( let igd_expiration_time = Duration::from_secs(
opts.get(&"DIPLONAT_IGD_REFRESH_TIME".to_string()).unwrap() opts
.parse::<u64>().unwrap() .get(&"DIPLONAT_IGD_EXPIRATION_TIME".to_string())
.into()); .unwrap()
.parse::<u64>()
.unwrap()
.into(),
);
let igd_refresh_time = Duration::from_secs(
opts
.get(&"DIPLONAT_IGD_REFRESH_TIME".to_string())
.unwrap()
.parse::<u64>()
.unwrap()
.into(),
);
assert_eq!( assert_eq!(
&rt_config.consul.node_name, &rt_config.consul.node_name,
opts.get(&"DIPLONAT_CONSUL_NODE_NAME".to_string()).unwrap() opts.get(&"DIPLONAT_CONSUL_NODE_NAME".to_string()).unwrap()
); );
assert_eq!( assert_eq!(
&rt_config.consul.url, &rt_config.consul.url,
opts.get(&"DIPLONAT_CONSUL_URL".to_string()).unwrap() opts.get(&"DIPLONAT_CONSUL_URL".to_string()).unwrap()
); );
assert!(rt_config.acme.is_some()); assert!(rt_config.acme.is_some());
let acme = rt_config.acme.unwrap(); let acme = rt_config.acme.unwrap();
assert_eq!( assert_eq!(
&acme.email, &acme.email,
opts.get(&"DIPLONAT_ACME_EMAIL".to_string()).unwrap()); opts.get(&"DIPLONAT_ACME_EMAIL".to_string()).unwrap()
);
assert!(rt_config.firewall.is_some()); assert!(rt_config.firewall.is_some());
let firewall = rt_config.firewall.unwrap(); let firewall = rt_config.firewall.unwrap();
assert_eq!( assert_eq!(firewall.refresh_time, firewall_refresh_time);
firewall.refresh_time,
firewall_refresh_time
);
assert!(rt_config.igd.is_some()); assert!(rt_config.igd.is_some());
let igd = rt_config.igd.unwrap(); let igd = rt_config.igd.unwrap();
assert_eq!( assert_eq!(
&igd.private_ip, &igd.private_ip,
opts.get(&"DIPLONAT_IGD_PRIVATE_IP".to_string()).unwrap() opts.get(&"DIPLONAT_IGD_PRIVATE_IP".to_string()).unwrap()
); );
assert_eq!( assert_eq!(igd.expiration_time, igd_expiration_time);
igd.expiration_time, assert_eq!(igd.refresh_time, igd_refresh_time);
igd_expiration_time }
);
assert_eq!(
igd.refresh_time,
igd_refresh_time
);
}

148
src/config/runtime.rs
View file

@ -1,8 +1,10 @@
use std::time::Duration; use std::time::Duration;
use anyhow::{Result, anyhow}; use anyhow::{anyhow, Result};
use crate::config::{ConfigOpts, ConfigOptsConsul, ConfigOptsAcme, ConfigOptsFirewall, ConfigOptsIgd}; use crate::config::{
ConfigOpts, ConfigOptsAcme, ConfigOptsConsul, ConfigOptsFirewall, ConfigOptsIgd,
};
// This code is inspired by the Trunk crate (https://github.com/thedodd/trunk) // This code is inspired by the Trunk crate (https://github.com/thedodd/trunk)
@ -13,118 +15,116 @@ use crate::config::{ConfigOpts, ConfigOptsConsul, ConfigOptsAcme, ConfigOptsFire
#[derive(Debug)] #[derive(Debug)]
pub struct RuntimeConfigConsul { pub struct RuntimeConfigConsul {
pub node_name: String, pub node_name: String,
pub url: String, pub url: String,
} }
#[derive(Debug)] #[derive(Debug)]
pub struct RuntimeConfigAcme { pub struct RuntimeConfigAcme {
pub email: String, pub email: String,
} }
#[derive(Debug)] #[derive(Debug)]
pub struct RuntimeConfigFirewall { pub struct RuntimeConfigFirewall {
pub refresh_time: Duration, pub refresh_time: Duration,
} }
#[derive(Debug)] #[derive(Debug)]
pub struct RuntimeConfigIgd { pub struct RuntimeConfigIgd {
pub private_ip: String, pub private_ip: String,
pub expiration_time: Duration, pub expiration_time: Duration,
pub refresh_time: Duration, pub refresh_time: Duration,
} }
#[derive(Debug)] #[derive(Debug)]
pub struct RuntimeConfig { pub struct RuntimeConfig {
pub consul: RuntimeConfigConsul, pub consul: RuntimeConfigConsul,
pub acme: Option<RuntimeConfigAcme>, pub acme: Option<RuntimeConfigAcme>,
pub firewall: Option<RuntimeConfigFirewall>, pub firewall: Option<RuntimeConfigFirewall>,
pub igd: Option<RuntimeConfigIgd>, pub igd: Option<RuntimeConfigIgd>,
} }
impl RuntimeConfig { impl RuntimeConfig {
pub fn new(opts: ConfigOpts) -> Result<Self> { pub fn new(opts: ConfigOpts) -> Result<Self> {
let consul = RuntimeConfigConsul::new(opts.consul.clone())?; let consul = RuntimeConfigConsul::new(opts.consul.clone())?;
let acme = RuntimeConfigAcme::new(opts.acme.clone())?; let acme = RuntimeConfigAcme::new(opts.acme.clone())?;
let firewall = RuntimeConfigFirewall::new(opts.firewall.clone())?; let firewall = RuntimeConfigFirewall::new(opts.firewall.clone())?;
let igd = RuntimeConfigIgd::new(opts.igd.clone())?; let igd = RuntimeConfigIgd::new(opts.igd.clone())?;
Ok(Self { Ok(Self {
acme, acme,
consul, consul,
firewall, firewall,
igd, igd,
}) })
} }
} }
impl RuntimeConfigConsul { impl RuntimeConfigConsul {
pub(super) fn new(opts: ConfigOptsConsul) -> Result<Self> { pub(super) fn new(opts: ConfigOptsConsul) -> Result<Self> {
let node_name = opts.node_name.expect( let node_name = opts
"'DIPLONAT_CONSUL_NODE_NAME' is required"); .node_name
let url = opts.url.unwrap_or(super::CONSUL_URL.to_string()); .expect("'DIPLONAT_CONSUL_NODE_NAME' is required");
let url = opts.url.unwrap_or(super::CONSUL_URL.to_string());
Ok(Self { Ok(Self { node_name, url })
node_name, }
url,
})
}
} }
impl RuntimeConfigAcme { impl RuntimeConfigAcme {
pub fn new(opts: ConfigOptsAcme) -> Result<Option<Self>> { pub fn new(opts: ConfigOptsAcme) -> Result<Option<Self>> {
if !opts.enable { if !opts.enable {
return Ok(None); return Ok(None);
} }
let email = opts.email.expect( let email = opts
"'DIPLONAT_ACME_EMAIL' is required if ACME is enabled"); .email
.expect("'DIPLONAT_ACME_EMAIL' is required if ACME is enabled");
Ok(Some(Self { Ok(Some(Self { email }))
email, }
}))
}
} }
impl RuntimeConfigFirewall { impl RuntimeConfigFirewall {
pub(super) fn new(opts: ConfigOptsFirewall) -> Result<Option<Self>> { pub(super) fn new(opts: ConfigOptsFirewall) -> Result<Option<Self>> {
if !opts.enable { if !opts.enable {
return Ok(None); return Ok(None);
} }
let refresh_time = Duration::from_secs( let refresh_time = Duration::from_secs(opts.refresh_time.unwrap_or(super::REFRESH_TIME).into());
opts.refresh_time.unwrap_or(super::REFRESH_TIME).into());
Ok(Some(Self { Ok(Some(Self { refresh_time }))
refresh_time, }
}))
}
} }
impl RuntimeConfigIgd { impl RuntimeConfigIgd {
pub(super) fn new(opts: ConfigOptsIgd) -> Result<Option<Self>> { pub(super) fn new(opts: ConfigOptsIgd) -> Result<Option<Self>> {
if !opts.enable { if !opts.enable {
return Ok(None); return Ok(None);
} }
let private_ip = opts.private_ip.expect( let private_ip = opts
"'DIPLONAT_IGD_PRIVATE_IP' is required if IGD is enabled"); .private_ip
let expiration_time = Duration::from_secs( .expect("'DIPLONAT_IGD_PRIVATE_IP' is required if IGD is enabled");
opts.expiration_time.unwrap_or(super::EXPIRATION_TIME).into()); let expiration_time = Duration::from_secs(
let refresh_time = Duration::from_secs( opts
opts.refresh_time.unwrap_or(super::REFRESH_TIME).into()); .expiration_time
.unwrap_or(super::EXPIRATION_TIME)
.into(),
);
let refresh_time = Duration::from_secs(opts.refresh_time.unwrap_or(super::REFRESH_TIME).into());
if refresh_time.as_secs() * 2 > expiration_time.as_secs() { if refresh_time.as_secs() * 2 > expiration_time.as_secs() {
return Err(anyhow!( return Err(anyhow!(
"IGD expiration time (currently: {}s) must be at least twice bigger than refresh time (currently: {}s)", "IGD expiration time (currently: {}s) must be at least twice bigger than refresh time (currently: {}s)",
expiration_time.as_secs(), expiration_time.as_secs(),
refresh_time.as_secs())); refresh_time.as_secs()));
} }
Ok(Some(Self { Ok(Some(Self {
private_ip, private_ip,
expiration_time, expiration_time,
refresh_time, refresh_time,
})) }))
} }
} }

18
src/consul.rs
View file

@ -1,22 +1,22 @@
use std::collections::HashMap; use std::collections::HashMap;
use anyhow::{Result, anyhow}; use anyhow::{anyhow, Result};
use serde::{Serialize, Deserialize}; use serde::{Deserialize, Serialize};
#[derive(Serialize, Deserialize, Debug)] #[derive(Serialize, Deserialize, Debug)]
pub struct ServiceEntry { pub struct ServiceEntry {
pub Tags: Vec<String> pub Tags: Vec<String>,
} }
#[derive(Serialize, Deserialize, Debug)] #[derive(Serialize, Deserialize, Debug)]
pub struct CatalogNode { pub struct CatalogNode {
pub Services: HashMap<String, ServiceEntry> pub Services: HashMap<String, ServiceEntry>,
} }
pub struct Consul { pub struct Consul {
client: reqwest::Client, client: reqwest::Client,
url: String, url: String,
idx: Option<u64> idx: Option<u64>,
} }
impl Consul { impl Consul {
@ -24,7 +24,7 @@ impl Consul {
return Self { return Self {
client: reqwest::Client::new(), client: reqwest::Client::new(),
url: url.to_string(), url: url.to_string(),
idx: None idx: None,
}; };
} }
@ -35,16 +35,16 @@ impl Consul {
pub async fn watch_node(&mut self, host: &str) -> Result<CatalogNode> { pub async fn watch_node(&mut self, host: &str) -> Result<CatalogNode> {
let url = match self.idx { let url = match self.idx {
Some(i) => format!("{}/v1/catalog/node/{}?index={}", self.url, host, i), Some(i) => format!("{}/v1/catalog/node/{}?index={}", self.url, host, i),
None => format!("{}/v1/catalog/node/{}", self.url, host) None => format!("{}/v1/catalog/node/{}", self.url, host),
}; };
let http = self.client.get(&url).send().await?; let http = self.client.get(&url).send().await?;
self.idx = match http.headers().get("X-Consul-Index") { self.idx = match http.headers().get("X-Consul-Index") {
Some(v) => Some(v.to_str()?.parse::<u64>()?), Some(v) => Some(v.to_str()?.parse::<u64>()?),
None => return Err(anyhow!("X-Consul-Index header not found")) None => return Err(anyhow!("X-Consul-Index header not found")),
}; };
let resp: CatalogNode = http.json().await?; let resp: CatalogNode = http.json().await?;
return Ok(resp) return Ok(resp);
} }
} }

29
src/consul_actor.rs
View file

@ -4,8 +4,8 @@ use std::time::Duration;
use anyhow::Result; use anyhow::Result;
use log::*; use log::*;
use serde::{Serialize, Deserialize}; use serde::{Deserialize, Serialize};
use serde_lexpr::{from_str,error}; use serde_lexpr::{error, from_str};
use tokio::sync::watch; use tokio::sync::watch;
use tokio::time::delay_for; use tokio::time::delay_for;
@ -16,12 +16,12 @@ use crate::messages;
#[derive(Serialize, Deserialize, Debug)] #[derive(Serialize, Deserialize, Debug)]
pub enum DiplonatParameter { pub enum DiplonatParameter {
tcp_port(HashSet<u16>), tcp_port(HashSet<u16>),
udp_port(HashSet<u16>) udp_port(HashSet<u16>),
} }
#[derive(Serialize, Deserialize, Debug)] #[derive(Serialize, Deserialize, Debug)]
pub enum DiplonatConsul { pub enum DiplonatConsul {
diplonat(Vec<DiplonatParameter>) diplonat(Vec<DiplonatParameter>),
} }
pub struct ConsulActor { pub struct ConsulActor {
@ -31,13 +31,16 @@ pub struct ConsulActor {
node: String, node: String,
retries: u32, retries: u32,
tx_open_ports: watch::Sender<messages::PublicExposedPorts> tx_open_ports: watch::Sender<messages::PublicExposedPorts>,
} }
fn retry_to_time(retries: u32, max_time: Duration) -> Duration { fn retry_to_time(retries: u32, max_time: Duration) -> Duration {
// 1.2^x seems to be a good value to exponentially increase time at a good pace // 1.2^x seems to be a good value to exponentially increase time at a good pace
// eg. 1.2^32 = 341 seconds ~= 5 minutes - ie. after 32 retries we wait 5 minutes // eg. 1.2^32 = 341 seconds ~= 5 minutes - ie. after 32 retries we wait 5 minutes
return Duration::from_secs(cmp::min(max_time.as_secs(), 1.2f64.powf(retries as f64) as u64)) return Duration::from_secs(cmp::min(
max_time.as_secs(),
1.2f64.powf(retries as f64) as u64,
));
} }
fn to_parameters(catalog: &consul::CatalogNode) -> Vec<DiplonatConsul> { fn to_parameters(catalog: &consul::CatalogNode) -> Vec<DiplonatConsul> {
@ -57,9 +60,9 @@ fn to_parameters(catalog: &consul::CatalogNode) -> Vec<DiplonatConsul> {
} }
fn to_open_ports(params: &Vec<DiplonatConsul>) -> messages::PublicExposedPorts { fn to_open_ports(params: &Vec<DiplonatConsul>) -> messages::PublicExposedPorts {
let mut op = messages::PublicExposedPorts { let mut op = messages::PublicExposedPorts {
tcp_ports: HashSet::new(), tcp_ports: HashSet::new(),
udp_ports: HashSet::new() udp_ports: HashSet::new(),
}; };
for conf in params { for conf in params {
@ -77,9 +80,9 @@ fn to_open_ports(params: &Vec<DiplonatConsul>) -> messages::PublicExposedPorts {
impl ConsulActor { impl ConsulActor {
pub fn new(config: RuntimeConfigConsul) -> Self { pub fn new(config: RuntimeConfigConsul) -> Self {
let (tx, rx) = watch::channel(messages::PublicExposedPorts{ let (tx, rx) = watch::channel(messages::PublicExposedPorts {
tcp_ports: HashSet::new(), tcp_ports: HashSet::new(),
udp_ports: HashSet::new() udp_ports: HashSet::new(),
}); });
return Self { return Self {
@ -99,7 +102,11 @@ impl ConsulActor {
self.consul.watch_node_reset(); self.consul.watch_node_reset();
self.retries = cmp::min(std::u32::MAX - 1, self.retries) + 1; self.retries = cmp::min(std::u32::MAX - 1, self.retries) + 1;
let will_retry_in = retry_to_time(self.retries, Duration::from_secs(600)); let will_retry_in = retry_to_time(self.retries, Duration::from_secs(600));
error!("Failed to query consul. Will retry in {}s. {}", will_retry_in.as_secs(), e); error!(
"Failed to query consul. Will retry in {}s. {}",
will_retry_in.as_secs(),
e
);
delay_for(will_retry_in).await; delay_for(will_retry_in).await;
continue; continue;
} }

23
src/diplonat.rs
View file

@ -1,4 +1,4 @@
use anyhow::{Result, anyhow}; use anyhow::{anyhow, Result};
use tokio::try_join; use tokio::try_join;
use crate::config::ConfigOpts; use crate::config::ConfigOpts;
@ -17,22 +17,17 @@ impl Diplonat {
pub async fn new() -> Result<Self> { pub async fn new() -> Result<Self> {
let config = ConfigOpts::from_env()?; let config = ConfigOpts::from_env()?;
println!("{:#?}", config); println!("{:#?}", config);
quentin commented 2021-09-20 16:06:44 +00:00
Review
Copy link

Now that our actors are modular, I think that this function fails to convey the real meaning of what we want to do.

IMHO, I think we want to:

  1. Instantiate actors chosen by the user
  2. Run them

With the current code, I see many problems.

((1)) I have a feeling that we are duplicating logic between the "runtime config" and our actor initialization. Currently, the constructor of the actor is only:

  • some boilerplate
  • a duplicated check found in runtime

To fix this problem, I see 2 options:

  • Delete your runtime configuration file and let actors initialize themselves from their constructor
  • Remove actors' constructor and instantiate them directly from this function only if they are required

((2)) The current try_join! fails to convey the information that we run only the initialized actors. I think that, independently of the choice you made for 1, you should create a vector of initialized actors that you will populate and then run. You will replace try_join! by try_join_all

Tip: start by solving problem number 2, it will help you solve problem number 1

Now that our actors are modular, I think that this function fails to convey the real meaning of what we want to do. IMHO, I think we want to: 1. Instantiate actors chosen by the user 2. Run them --- With the current code, I see many problems. ((1)) I have a feeling that we are duplicating logic between the "runtime config" and our actor initialization. Currently, the constructor of the actor is only: - some boilerplate - a duplicated check found in runtime To fix this problem, I see 2 options: - Delete your runtime configuration file and let actors initialize themselves from their constructor - Remove actors' constructor and instantiate them directly from this function only if they are required ((2)) The current `try_join!` fails to convey the information that we run only the initialized actors. I think that, independently of the choice you made for 1, you should create a vector of initialized actors that you will populate and then run. You will replace `try_join!` by [`try_join_all`](https://docs.rs/futures/0.3.17/futures/future/fn.try_join_all.html) *Tip: start by solving problem number 2, it will help you solve problem number 1*
let consul_actor = ConsulActor::new(config.consul); let consul_actor = ConsulActor::new(config.consul);
let firewall_actor = FirewallActor::new( let firewall_actor = FirewallActor::new(config.firewall, &consul_actor.rx_open_ports).await?;
config.firewall,
&consul_actor.rx_open_ports let igd_actor = IgdActor::new(config.igd, &consul_actor.rx_open_ports).await?;
).await?;
let igd_actor = IgdActor::new(
config.igd,
&consul_actor.rx_open_ports
).await?;
if firewall_actor.is_none() && igd_actor.is_none() { if firewall_actor.is_none() && igd_actor.is_none() {
return Err(anyhow!( return Err(anyhow!(
"At least enable *one* module, otherwise it's boring!")); "At least enable *one* module, otherwise it's boring!"
));
} }
let ctx = Self { let ctx = Self {
@ -53,13 +48,13 @@ impl Diplonat {
async { async {
match firewall { match firewall {
Some(x) => x.listen().await, Some(x) => x.listen().await,
None => Ok(()) None => Ok(()),
} }
}, },
async { async {
match igd { match igd {
Some(x) => x.listen().await, Some(x) => x.listen().await,
None => Ok(()) None => Ok(()),
} }
}, },
)?; )?;

122
src/fw.rs
View file

@ -1,6 +1,6 @@
use std::collections::HashSet; use std::collections::HashSet;
use anyhow::{Result,Context}; use anyhow::{Context, Result};
use iptables; use iptables;
use log::*; use log::*;
use regex::Regex; use regex::Regex;
@ -8,76 +8,92 @@ use regex::Regex;
use crate::messages; use crate::messages;
pub fn setup(ipt: &iptables::IPTables) -> Result<()> { pub fn setup(ipt: &iptables::IPTables) -> Result<()> {
// ensure we start from a clean state without any rule already set
cleanup(ipt)?;
// ensure we start from a clean state without any rule already set ipt
cleanup(ipt)?; .new_chain("filter", "DIPLONAT")
.context("Failed to create new chain")?;
ipt.new_chain("filter", "DIPLONAT").context("Failed to create new chain")?; ipt
ipt.insert_unique("filter", "INPUT", "-j DIPLONAT", 1).context("Failed to insert jump rule")?; .insert_unique("filter", "INPUT", "-j DIPLONAT", 1)
.context("Failed to insert jump rule")?;
Ok(()) Ok(())
} }
pub fn open_ports(ipt: &iptables::IPTables, ports: messages::PublicExposedPorts) -> Result<()> { pub fn open_ports(ipt: &iptables::IPTables, ports: messages::PublicExposedPorts) -> Result<()> {
for p in ports.tcp_ports { for p in ports.tcp_ports {
ipt.append("filter", "DIPLONAT", &format!("-p tcp --dport {} -j ACCEPT", p)).context("Failed to insert port rule")?; ipt
} .append(
"filter",
"DIPLONAT",
&format!("-p tcp --dport {} -j ACCEPT", p),
)
.context("Failed to insert port rule")?;
}
for p in ports.udp_ports { for p in ports.udp_ports {
ipt.append("filter", "DIPLONAT", &format!("-p udp --dport {} -j ACCEPT", p)).context("Failed to insert port rule")?; ipt
} .append(
"filter",
"DIPLONAT",
&format!("-p udp --dport {} -j ACCEPT", p),
)
.context("Failed to insert port rule")?;
}
Ok(()) Ok(())
} }
pub fn get_opened_ports(ipt: &iptables::IPTables) -> Result<messages::PublicExposedPorts> { pub fn get_opened_ports(ipt: &iptables::IPTables) -> Result<messages::PublicExposedPorts> {
let mut ports = messages::PublicExposedPorts { let mut ports = messages::PublicExposedPorts {
tcp_ports: HashSet::new(), tcp_ports: HashSet::new(),
udp_ports: HashSet::new() udp_ports: HashSet::new(),
}; };
let list = ipt.list("filter", "DIPLONAT")?; let list = ipt.list("filter", "DIPLONAT")?;
let re = Regex::new(r"\-A.*? \-p (\w+).*\-\-dport (\d+).*?\-j ACCEPT").context("Regex matching open ports encountered an unexpected rule")?; let re = Regex::new(r"\-A.*? \-p (\w+).*\-\-dport (\d+).*?\-j ACCEPT")
for i in list { .context("Regex matching open ports encountered an unexpected rule")?;
let caps = re.captures(&i); for i in list {
match caps { let caps = re.captures(&i);
Some(c) => { match caps {
Some(c) => {
if let (Some(raw_proto), Some(raw_port)) = (c.get(1), c.get(2)) { if let (Some(raw_proto), Some(raw_port)) = (c.get(1), c.get(2)) {
let proto = String::from(raw_proto.as_str());
let number = String::from(raw_port.as_str()).parse::<u16>()?;
let proto = String::from(raw_proto.as_str()); if proto == "tcp" {
let number = String::from(raw_port.as_str()).parse::<u16>()?; ports.tcp_ports.insert(number);
} else {
if proto == "tcp" { ports.udp_ports.insert(number);
ports.tcp_ports.insert(number); }
} else { } else {
ports.udp_ports.insert(number); error!("Unexpected rule found in DIPLONAT chain")
}
} else {
error!("Unexpected rule found in DIPLONAT chain")
}
},
_ => {}
} }
}
_ => {}
} }
}
Ok(ports) Ok(ports)
} }
pub fn cleanup(ipt: &iptables::IPTables) -> Result<()> { pub fn cleanup(ipt: &iptables::IPTables) -> Result<()> {
if ipt.chain_exists("filter", "DIPLONAT")? {
if ipt.chain_exists("filter", "DIPLONAT")? { ipt
ipt.flush_chain("filter", "DIPLONAT").context("Failed to flush the DIPLONAT chain")?; .flush_chain("filter", "DIPLONAT")
.context("Failed to flush the DIPLONAT chain")?;
if ipt.exists("filter", "INPUT", "-j DIPLONAT")? {
ipt.delete("filter", "INPUT", "-j DIPLONAT").context("Failed to delete jump rule")?; if ipt.exists("filter", "INPUT", "-j DIPLONAT")? {
} ipt
.delete("filter", "INPUT", "-j DIPLONAT")
ipt.delete_chain("filter", "DIPLONAT").context("Failed to delete chain")?; .context("Failed to delete jump rule")?;
} }
Ok(()) ipt
} .delete_chain("filter", "DIPLONAT")
.context("Failed to delete chain")?;
}
Ok(())
}

44
src/fw_actor.rs
View file

@ -4,18 +4,15 @@ use anyhow::Result;
use iptables; use iptables;
use log::*; use log::*;
use tokio::{ use tokio::{
select, select,
sync::watch, sync::watch,
time::{ time::{self, Duration},
Duration, };
self,
}};
use crate::config::RuntimeConfigFirewall; use crate::config::RuntimeConfigFirewall;
use crate::fw; use crate::fw;
use crate::messages; use crate::messages;
pub struct FirewallActor { pub struct FirewallActor {
pub ipt: iptables::IPTables, pub ipt: iptables::IPTables,
@ -26,13 +23,16 @@ pub struct FirewallActor {
} }
impl FirewallActor { impl FirewallActor {
pub async fn new(config: Option<RuntimeConfigFirewall>, rxp: &watch::Receiver<messages::PublicExposedPorts>) -> Result<Option<Self>> { pub async fn new(
config: Option<RuntimeConfigFirewall>,
rxp: &watch::Receiver<messages::PublicExposedPorts>,
) -> Result<Option<Self>> {
if config.is_none() { if config.is_none() {
return Ok(None); return Ok(None);
} }
let config = config.unwrap(); let config = config.unwrap();
let ctx = Self { let ctx = Self {
ipt: iptables::new(false)?, ipt: iptables::new(false)?,
last_ports: messages::PublicExposedPorts::new(), last_ports: messages::PublicExposedPorts::new(),
refresh: config.refresh_time, refresh: config.refresh_time,
@ -40,7 +40,7 @@ impl FirewallActor {
}; };
fw::setup(&ctx.ipt)?; fw::setup(&ctx.ipt)?;
return Ok(Some(ctx)); return Ok(Some(ctx));
} }
@ -55,7 +55,9 @@ impl FirewallActor {
}; };
// 2. Update last ports if needed // 2. Update last ports if needed
if let Some(p) = new_ports { self.last_ports = p; } if let Some(p) = new_ports {
self.last_ports = p;
}
// 3. Update firewall rules // 3. Update firewall rules
match self.do_fw_update().await { match self.do_fw_update().await {
@ -68,18 +70,26 @@ impl FirewallActor {
pub async fn do_fw_update(&self) -> Result<()> { pub async fn do_fw_update(&self) -> Result<()> {
let curr_opened_ports = fw::get_opened_ports(&self.ipt)?; let curr_opened_ports = fw::get_opened_ports(&self.ipt)?;
let diff_tcp = self.last_ports.tcp_ports.difference(&curr_opened_ports.tcp_ports).copied().collect::<HashSet<u16>>(); let diff_tcp = self
let diff_udp = self.last_ports.udp_ports.difference(&curr_opened_ports.udp_ports).copied().collect::<HashSet<u16>>(); .last_ports
.tcp_ports
.difference(&curr_opened_ports.tcp_ports)
.copied()
.collect::<HashSet<u16>>();
let diff_udp = self
.last_ports
.udp_ports
.difference(&curr_opened_ports.udp_ports)
.copied()
.collect::<HashSet<u16>>();
let ports_to_open = messages::PublicExposedPorts { let ports_to_open = messages::PublicExposedPorts {
tcp_ports: diff_tcp, tcp_ports: diff_tcp,
udp_ports: diff_udp udp_ports: diff_udp,
}; };
fw::open_ports(&self.ipt, ports_to_open)?; fw::open_ports(&self.ipt, ports_to_open)?;
return Ok(()); return Ok(());
} }
} }

46
src/igd_actor.rs
View file

@ -1,16 +1,14 @@
use std::net::SocketAddrV4; use std::net::SocketAddrV4;
use anyhow::{Result, Context}; use anyhow::{Context, Result};
use igd::aio::*; use igd::aio::*;
use igd::PortMappingProtocol; use igd::PortMappingProtocol;
use log::*; use log::*;
use tokio::{ use tokio::{
select, select,
sync::watch, sync::watch,
time::{ time::{self, Duration},
Duration, };
self,
}};
use crate::config::RuntimeConfigIgd; use crate::config::RuntimeConfigIgd;
use crate::messages; use crate::messages;
@ -26,18 +24,21 @@ pub struct IgdActor {
} }
impl IgdActor { impl IgdActor {
pub async fn new(config: Option<RuntimeConfigIgd>, rxp: &watch::Receiver<messages::PublicExposedPorts>) -> Result<Option<Self>> { pub async fn new(
config: Option<RuntimeConfigIgd>,
rxp: &watch::Receiver<messages::PublicExposedPorts>,
) -> Result<Option<Self>> {
if config.is_none() { if config.is_none() {
return Ok(None); return Ok(None);
} }
let config = config.unwrap(); let config = config.unwrap();
let gw = search_gateway(Default::default()) let gw = search_gateway(Default::default())
.await .await
.context("Failed to find IGD gateway")?; .context("Failed to find IGD gateway")?;
info!("IGD gateway: {}", gw); info!("IGD gateway: {}", gw);
let ctx = Self { let ctx = Self {
expire: config.expiration_time, expire: config.expiration_time,
gateway: gw, gateway: gw,
last_ports: messages::PublicExposedPorts::new(), last_ports: messages::PublicExposedPorts::new(),
@ -60,7 +61,9 @@ impl IgdActor {
}; };
// 2. Update last ports if needed // 2. Update last ports if needed
if let Some(p) = new_ports { self.last_ports = p; } if let Some(p) = new_ports {
self.last_ports = p;
}
// 3. Flush IGD requests // 3. Flush IGD requests
match self.do_igd().await { match self.do_igd().await {
@ -72,15 +75,26 @@ impl IgdActor {
pub async fn do_igd(&self) -> Result<()> { pub async fn do_igd(&self) -> Result<()> {
let actions = [ let actions = [
(PortMappingProtocol::TCP, &self.last_ports.tcp_ports), (PortMappingProtocol::TCP, &self.last_ports.tcp_ports),
(PortMappingProtocol::UDP, &self.last_ports.udp_ports) (PortMappingProtocol::UDP, &self.last_ports.udp_ports),
]; ];
for (proto, list) in actions.iter() { for (proto, list) in actions.iter() {
for port in *list { for port in *list {
let service_str = format!("{}:{}", self.private_ip, port); let service_str = format!("{}:{}", self.private_ip, port);
let service = service_str.parse::<SocketAddrV4>().context("Invalid socket address")?; let service = service_str
self.gateway.add_port(*proto, *port, service, self.expire.as_secs() as u32, "diplonat").await?; .parse::<SocketAddrV4>()
.context("Invalid socket address")?;
self
.gateway
.add_port(
*proto,
*port,
service,
self.expire.as_secs() as u32,
"diplonat",
)
.await?;
debug!("IGD request successful for {:#?} {}", proto, service); debug!("IGD request successful for {:#?} {}", proto, service);
} }
} }

2
src/main.rs
View file

@ -7,8 +7,8 @@ mod fw_actor;
mod igd_actor; mod igd_actor;
mod messages; mod messages;
use log::*;
use diplonat::Diplonat; use diplonat::Diplonat;
use log::*;
#[tokio::main] #[tokio::main]
async fn main() { async fn main() {

6
src/messages.rs
View file

@ -3,14 +3,14 @@ use std::collections::HashSet;
#[derive(Debug, Clone, PartialEq, Eq)] #[derive(Debug, Clone, PartialEq, Eq)]
pub struct PublicExposedPorts { pub struct PublicExposedPorts {
pub tcp_ports: HashSet<u16>, pub tcp_ports: HashSet<u16>,
pub udp_ports: HashSet<u16> pub udp_ports: HashSet<u16>,
} }
impl PublicExposedPorts { impl PublicExposedPorts {
pub fn new() -> Self { pub fn new() -> Self {
return Self { return Self {
tcp_ports: HashSet::new(), tcp_ports: HashSet::new(),
udp_ports: HashSet::new() udp_ports: HashSet::new(),
} };
} }
} }