Add CLI option for a custom host suffix (tonarino#373)

* client, server:  option for custom host suffixes

* shared: Better wording in the doc

* client, shared: nits and formatting

* shared: underscore to dash in option name

---------

Co-authored-by: Štěpán Mikéska <stepan@nesp.im>

Author: HaroldVemeno

client/src/main.rs

@@ -9,7 +9,7 @@ use innernet_shared::{
     prompts, update_hosts_file,
     wg::{DeviceExt, PeerInfoExt},
     AddCidrOpts, AddDeleteAssociationOpts, AddPeerOpts, Association, AssociationContents, Cidr,
-    CidrTree, DeleteCidrOpts, EnableDisablePeerOpts, Endpoint, EndpointContents, HostsOpt,
+    CidrTree, DeleteCidrOpts, EnableDisablePeerOpts, Endpoint, EndpointContents, HostsOpts,
     InstallOpts, Interface, IoErrorContext, ListenPortOpts, NatOpts, NetworkOpts,
     OverrideEndpointOpts, Peer, RedeemContents, RenameCidrOpts, RenamePeerOpts, ServerCapabilities,
     State, WrappedIoError, REDEEM_TRANSITION_WAIT,
@@ -82,7 +82,7 @@ enum Command {
         invite: PathBuf,
 
         #[clap(flatten)]
-        hosts: HostsOpt,
+        hosts: HostsOpts,
 
         #[clap(flatten)]
         install_opts: InstallOpts,
@@ -118,7 +118,7 @@ enum Command {
         interval: u64,
 
         #[clap(flatten)]
-        hosts: HostsOpt,
+        hosts: HostsOpts,
 
         #[clap(flatten)]
         nat: NatOpts,
@@ -131,7 +131,7 @@ enum Command {
         interface: Interface,
 
         #[clap(flatten)]
-        hosts: HostsOpt,
+        hosts: HostsOpts,
 
         #[clap(flatten)]
         nat: NatOpts,
@@ -274,7 +274,7 @@ enum Command {
 fn install(
     opts: &Opts,
     invite: &Path,
-    hosts_file: Option<PathBuf>,
+    hosts_opts: HostsOpts,
     install_opts: InstallOpts,
     nat: &NatOpts,
 ) -> Result<(), Error> {
@@ -323,7 +323,7 @@ fn install(
 
     let mut fetch_success = false;
     for _ in 0..3 {
-        if fetch(&iface, opts, true, hosts_file.clone(), nat).is_ok() {
+        if fetch(&iface, opts, true, &hosts_opts, nat).is_ok() {
             fetch_success = true;
             break;
         }
@@ -466,7 +466,7 @@ fn up(
     interface: Option<Interface>,
     opts: &Opts,
     loop_interval: Option<Duration>,
-    hosts_path: Option<PathBuf>,
+    hosts_opts: HostsOpts,
     nat: &NatOpts,
 ) -> Result<(), Error> {
     loop {
@@ -476,7 +476,7 @@ fn up(
         };
 
         for iface in interfaces {
-            fetch(&iface, opts, true, hosts_path.clone(), nat)?;
+            fetch(&iface, opts, true, &hosts_opts, nat)?;
         }
 
         match loop_interval {
@@ -492,7 +492,7 @@ fn fetch(
     interface: &InterfaceName,
     opts: &Opts,
     bring_up_interface: bool,
-    hosts_path: Option<PathBuf>,
+    hosts_opts: &HostsOpts,
     nat: &NatOpts,
 ) -> Result<(), Error> {
     let config = InterfaceConfig::from_interface(&opts.config_dir, interface)?;
@@ -577,8 +577,8 @@ fn fetch(
             .apply(interface, opts.network.backend)
             .with_str(interface.to_string())?;
 
-        if let Some(path) = hosts_path {
-            update_hosts_file(interface, &path, &peers)?;
+        if !hosts_opts.no_write_hosts {
+            update_hosts_file(interface, hosts_opts, &peers)?;
         }
 
         println!();
@@ -1290,7 +1290,7 @@ fn run(opts: &Opts) -> Result<(), Error> {
             hosts,
             install_opts,
             nat,
-        } => install(opts, &invite, hosts.into(), install_opts, &nat)?,
+        } => install(opts, &invite, hosts, install_opts, &nat)?,
         Command::Show {
             short,
             tree,
@@ -1300,7 +1300,7 @@ fn run(opts: &Opts) -> Result<(), Error> {
             interface,
             hosts,
             nat,
-        } => fetch(&interface, opts, false, hosts.into(), &nat)?,
+        } => fetch(&interface, opts, false, &hosts, &nat)?,
         Command::Up {
             interface,
             daemon,
@@ -1311,7 +1311,7 @@ fn run(opts: &Opts) -> Result<(), Error> {
             interface,
             opts,
             daemon.then(|| Duration::from_secs(interval)),
-            hosts.into(),
+            hosts,
             &nat,
         )?,
         Command::Down { interface } => wg::down(&interface, opts.network.backend)?,

server/src/lib.rs

@@ -5,8 +5,8 @@ use hyper::{http, server::conn::AddrStream, Body, Request, Response};
 use indoc::printdoc;
 use innernet_shared::{
     get_local_addrs, update_hosts_file, AddCidrOpts, AddPeerOpts, DeleteCidrOpts,
-    EnableDisablePeerOpts, Endpoint, IoErrorContext, NetworkOpts, PeerContents, RenameCidrOpts,
-    RenamePeerOpts, INNERNET_PUBKEY_HEADER,
+    EnableDisablePeerOpts, Endpoint, HostsOpts, IoErrorContext, NetworkOpts, PeerContents,
+    RenameCidrOpts, RenamePeerOpts, INNERNET_PUBKEY_HEADER,
 };
 use ipnet::IpNet;
 use parking_lot::{Mutex, RwLock};
@@ -429,7 +429,7 @@ fn spawn_expired_invite_sweeper(db: Db) {
     });
 }
 
-fn spawn_hostfile_writer(db: Db, interface: InterfaceName, hosts_path: PathBuf) {
+fn spawn_hostfile_writer(db: Db, interface: InterfaceName, hosts_opts: HostsOpts) {
     tokio::task::spawn({
         async move {
             let mut interval = tokio::time::interval(Duration::from_secs(10));
@@ -440,7 +440,7 @@ fn spawn_hostfile_writer(db: Db, interface: InterfaceName, hosts_path: PathBuf)
                     Ok(peers) => {
                         if let Err(e) = update_hosts_file(
                             &interface,
-                            &hosts_path,
+                            &hosts_opts,
                             peers.into_iter().map(|peer| peer.inner),
                         ) {
                             log::error!("Failed to write hostfile: {}", e);
@@ -459,7 +459,7 @@ pub async fn serve(
     interface: InterfaceName,
     conf: &ServerConfig,
     network: NetworkOpts,
-    hosts_path: Option<PathBuf>,
+    hosts_opts: HostsOpts,
 ) -> Result<(), Error> {
     let config = ConfigFile::from_file(conf.config_path(&interface))?;
     log::debug!("opening database connection...");
@@ -514,8 +514,8 @@ pub async fn serve(
     let endpoints = spawn_endpoint_refresher(interface, network);
     spawn_expired_invite_sweeper(db.clone());
 
-    if let Some(path) = hosts_path {
-        spawn_hostfile_writer(db.clone(), interface, path);
+    if !hosts_opts.no_write_hosts {
+        spawn_hostfile_writer(db.clone(), interface, hosts_opts);
     }
 
     let context = Context {

server/src/main.rs

@@ -1,7 +1,7 @@
 use clap::{Parser, Subcommand};
 use colored::*;
 use innernet_shared::{
-    AddCidrOpts, AddPeerOpts, DeleteCidrOpts, EnableDisablePeerOpts, HostsOpt, NetworkOpts,
+    AddCidrOpts, AddPeerOpts, DeleteCidrOpts, EnableDisablePeerOpts, HostsOpts, NetworkOpts,
     RenameCidrOpts, RenamePeerOpts,
 };
 use std::{env, path::PathBuf};
@@ -62,7 +62,7 @@ enum Command {
         network: NetworkOpts,
 
         #[clap(flatten)]
-        hosts: HostsOpt,
+        hosts: HostsOpts,
     },
 
     /// Add a peer to an existing network.
@@ -156,7 +156,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
             interface,
             network: routing,
             hosts,
-        } => serve(*interface, &conf, routing, hosts.into()).await?,
+        } => serve(*interface, &conf, routing, hosts).await?,
         Command::AddPeer { interface, args } => add_peer(&interface, &conf, args, opts.network)?,
         Command::RenamePeer { interface, args } => rename_peer(&interface, &conf, args)?,
         Command::DisablePeer { interface, args } => {

shared/src/lib.rs

@@ -147,22 +147,35 @@ impl IpNetExt for IpNet {
 
 pub fn update_hosts_file(
     interface: &InterfaceName,
-    hosts_path: &Path,
+    opts: &HostsOpts,
     peers: impl IntoIterator<Item = impl AsRef<Peer>>,
 ) -> Result<(), WrappedIoError> {
+    if opts.no_write_hosts {
+        return Ok(());
+    }
+
     let mut hosts_builder = HostsBuilder::new(format!("innernet {interface}"));
     for peer in peers {
         let peer = peer.as_ref();
-        hosts_builder.add_hostname(
-            peer.contents.ip,
-            format!("{}.{}.wg", peer.contents.name, interface),
-        );
+        let peer_hostname = if let Some(suffix) = &opts.host_suffix {
+            if suffix.is_empty() {
+                peer.contents.name.to_string()
+            } else {
+                format!("{}.{}", peer.contents.name, suffix)
+            }
+        } else {
+            format!("{}.{}.wg", peer.contents.name, interface)
+        };
+        hosts_builder.add_hostname(peer.contents.ip, peer_hostname);
     }
-    match hosts_builder.write_to(hosts_path).with_path(hosts_path) {
+    match hosts_builder
+        .write_to(opts.hosts_path.as_path())
+        .with_path(opts.hosts_path.as_path())
+    {
         Ok(has_written) if has_written => {
             log::info!(
                 "updated {} with the latest peers.",
-                hosts_path.to_string_lossy().yellow()
+                opts.hosts_path.to_string_lossy().yellow()
             )
         },
         Ok(_) => {},

shared/src/types.rs

@@ -521,20 +521,20 @@ pub struct NetworkOpts {
 }
 
 #[derive(Clone, Debug, Args)]
-pub struct HostsOpt {
+pub struct HostsOpts {
     /// The path to write hosts to
     #[clap(long = "hosts-path", default_value = "/etc/hosts")]
     pub hosts_path: PathBuf,
 
     /// Don't write to any hosts files
     #[clap(long = "no-write-hosts", conflicts_with = "hosts_path")]
     pub no_write_hosts: bool,
-}
 
-impl From<HostsOpt> for Option<PathBuf> {
-    fn from(opt: HostsOpt) -> Self {
-        (!opt.no_write_hosts).then_some(opt.hosts_path)
-    }
+    /// Use a different suffix for hosts, than '<interface>.wg' , ex.
+    /// --host-suffix 'evilnet' names peers: <peer>.evilnet, and
+    /// --host-suffix '' gives peers no suffix, just: <peer>
+    #[clap(long = "host-suffix")]
+    pub host_suffix: Option<String>,
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]