toe_beans/v4/server/

leases.rs

use super::Config;
use crate::v4::error::Result;
use log::{debug, info, warn};
use mac_address::MacAddress;
use serde::{Deserialize, Serialize};
use std::fs::{read_to_string, File};
use std::io::Write;
use std::os::unix::fs::OpenOptionsExt;
use std::path::PathBuf;
use std::time::{Duration, SystemTime};
use std::{
    collections::{HashMap, HashSet},
    fs::OpenOptions,
    net::Ipv4Addr,
};

#[derive(Deserialize, Serialize, Clone)]
enum LeaseStatus {
    Offered,
    Acked,
}

#[derive(Deserialize, Serialize, Clone)]
struct Lease {
    ip: Ipv4Addr,
    status: LeaseStatus,
    is_static: bool,
    // TODO this time measurement is not monotonic.
    when: SystemTime,
}

impl Lease {
    #[inline]
    fn new(ip: Ipv4Addr, status: LeaseStatus, is_static: bool) -> Self {
        Self {
            ip,
            status,
            is_static,
            when: SystemTime::now(),
        }
    }

    /// Resets the time that this was considered leased.
    #[inline]
    fn extend(&mut self) {
        self.when = SystemTime::now();
    }

    fn is_expired(&self, lease_time: u32) -> Result<bool> {
        match self.when.elapsed() {
            Ok(elapsed) => Ok(elapsed >= Duration::from_secs(lease_time as u64)),
            Err(_) => Err("Problem getting elapsed system time"),
        }
    }
}

/// Used to manage the dynamic collection of IP addresses that the server leases.
#[derive(Deserialize, Serialize)]
pub struct Leases {
    #[serde(skip)]
    available: HashSet<Ipv4Addr>,
    leased: HashMap<MacAddress, Lease>,
    /// The server will always assign these ip adddresses to these mac addresses.
    /// All static leases must be within the network_cidr range.
    #[serde(skip)]
    static_leases: HashMap<MacAddress, Ipv4Addr>,
    /// Passed to Leases from Config.lease_time, so Leases can check for lease expiration.
    lease_time: u32,
    /// An open descriptor to the leases file that is written to for each commit.
    ///
    /// This will be None until partway through a `restore`,
    /// and will always be Some after `new` or `restore`.
    #[serde(skip)]
    leases_file: Option<File>,
}

impl Leases {
    /// The file name that the Leases is read from and written to.
    pub const FILE_NAME: &'static str = "toe-beans-leases.toml";

    /// Offers only valid for about 5 minutes (300 seconds)
    /// at which point the offer's IP address may be reused.
    ///
    /// "Because the servers have not committed any network address assignments"
    /// "on the basis of a DHCPOFFER, server are free to reuse offered network addresses in response to subsequent requests."
    /// "Servers SHOULD NOT reuse offered addresses and may use an implementation-specific timeout mechanism to decide when to reuse an offered address."
    const OFFER_TIMEOUT: u32 = 300;

    fn open_leases_file(path: &PathBuf) -> File {
        OpenOptions::new()
            .read(false)
            .write(true)
            .create(true)
            .truncate(true)
            .mode(0o644) // ensure that file permissions are set before creating file
            .open(path.join(Self::FILE_NAME))
            .expect("Failed to open leases file")
    }

    /// Only call this _after_ `leased` and `static_leases` is filled.
    fn fill_available(&mut self, config: &Config) {
        let network = config.network_cidr;
        let hosts = network.hosts();

        self.available.extend(hosts);

        // Dont assign the broadcast or network addresses
        self.available.remove(&network.broadcast_address());
        self.available.remove(&network.network_address());

        // Dont assign the already assigned addresses
        self.leased.values().for_each(|lease| {
            self.available.remove(&lease.ip);
        });

        // Dont assign the statically reserved addresses
        self.static_leases.values().for_each(|ip| {
            self.available.remove(ip);
        });
    }

    /// Create a pool with the capacity of the configured network's size.
    pub fn new(config: &Config) -> Self {
        #[cfg(not(feature = "benchmark"))]
        let leases_file = Some(Self::open_leases_file(&config.path));
        #[cfg(feature = "benchmark")]
        let leases_file = None;

        let size = config.network_cidr.hosts().len();

        let mut leases = Self {
            available: HashSet::with_capacity(size),
            leased: HashMap::with_capacity(size),
            static_leases: config.static_leases.clone(),
            lease_time: config.lease_time.as_server(),
            leases_file,
        };

        leases.fill_available(config);

        leases
    }

    /// Checks that both `static_leases` and `leased` are:
    /// 1. Only contain ip addresses in the configured network range
    /// 2. Don't contain the broadcast or network address (which are unassignable)
    #[inline]
    fn validate(&self, config: &Config) -> Result<()> {
        let network = config.network_cidr;
        let broadcast_address = network.broadcast_address();
        let network_address = network.network_address();

        self.static_leases.values().try_for_each(|static_ip| {
            if !network.contains(*static_ip) {
                return Err("The configured network range does not include the restored static ip. Did the network range change?");
            }

            if static_ip == &broadcast_address {
                return Err("The network's broadcast address can't be statically leased");
            }

            if static_ip == &network_address {
                return Err("The network's network address can't be statically leased");
            }

            Ok(())
        })?;

        self.leased.values().try_for_each(|lease| {
            let ip = lease.ip;

            if !network.contains(ip) {
                return Err("The configured network range does not include the restored leased ip. Did the network range change?");
            }

            if ip == broadcast_address {
                return Err("The network's broadcast address can't be leased");
            }

            if ip == network_address {
                return Err("The network's network address can't be leased");
            }

            Ok(())
        })?;

        Ok(())
    }

    /// Restores the state of a `Leases` from a `toe-beans-leases.toml`.
    /// This involves validating that a user has not edited the file in a way that is invalid.
    pub fn restore(config: &Config) -> Result<Self> {
        let read_result = read_to_string(config.path.join(Self::FILE_NAME));

        let mut leases: Leases = match read_result {
            Ok(toml_string) => {
                let toml_result = toml::from_str(&toml_string);
                match toml_result {
                    Ok(leases) => leases,
                    Err(_) => return Err("Problem parsing leases file"),
                }
            }
            Err(_) => {
                return Err("Problem reading leases file");
            }
        };

        leases.validate(config)?;

        leases.leases_file = Some(Self::open_leases_file(&config.path));
        leases.static_leases = config.static_leases.clone();
        leases.fill_available(config);

        info!("Restored IP address leases");
        Ok(leases)
    }

    /// Use the toe-beans-leases.toml to restore past leases
    /// or return a new Leases if that was not successful.
    pub fn restore_or_new(config: &Config) -> Self {
        Leases::restore(config).unwrap_or_else(|_| Leases::new(config))
    }

    /// Writes leases to persistent storage as toe-beans-leases.toml
    fn commit(&mut self) -> Result<()> {
        debug!("Writing {}", Self::FILE_NAME);

        let file_content = match toml::to_string_pretty(&self) {
            Ok(content) => content,
            Err(_) => return Err("Failed to generate toml content for leases file"),
        };

        match self
            .leases_file
            .as_mut()
            .expect("A leases file should always be Some at this point")
            .write_all(file_content.as_bytes())
        {
            Ok(_) => Ok(()),
            Err(_) => Err("Failed to write to leases file"),
        }
    }

    /// Takes an available IP address, marks it as offered, and returns it.
    ///
    /// Returns one of:
    /// - The previously offered address, if one has been offered.
    /// - The requested address:
    ///   - If one was requested,
    ///   - _and_ it is available,
    ///   - _and_ there is not a static lease
    /// - Otherwise any available address (unless none are available).
    pub fn offer(&mut self, owner: MacAddress, requested_ip: Option<Ipv4Addr>) -> Result<Ipv4Addr> {
        if let Some(lease) = self.leased.get_mut(&owner) {
            match lease.status {
                LeaseStatus::Offered => {
                    warn!(
                        "{} will be offered an IP address that it has already been offered",
                        owner
                    );
                    lease.extend();
                    return Ok(lease.ip);
                }
                LeaseStatus::Acked => {
                    if !lease.is_expired(self.lease_time)? {
                        warn!(
                            "{} will be offered its non-expired, acked IP address again",
                            owner
                        );
                        lease.status = LeaseStatus::Offered;
                        lease.extend();
                        return Ok(lease.ip);
                    }
                    // else if it is expired then continue to offer new address below...
                }
            }
        }

        if let Some(requested_ip) = requested_ip {
            let not_available = !self.available.contains(&requested_ip);
            let has_static_lease = self.static_leases.contains_key(&owner);

            if not_available {
                // we validated that available and leased were in range in `restore`
                debug!("Requested IP Address is not available (or maybe not in network range)");
            } else if has_static_lease {
                debug!("Requested IP Address ignored because owner has static lease");
            } else {
                self.available.remove(&requested_ip);
                self.leased
                    .insert(owner, Lease::new(requested_ip, LeaseStatus::Offered, false));
                return Ok(requested_ip);
            }
        }

        // else give an available ip address below...
        let lease = self.get_lease(&owner, LeaseStatus::Offered)?;
        let ip = lease.ip;
        self.leased.insert(owner, lease);
        Ok(ip)
    }

    /// Takes a chaddr's offered ip address and marks it as reserved
    /// then commits it to persistent storage and returns the address.
    pub fn ack(&mut self, owner: MacAddress) -> Result<Ipv4Addr> {
        let maybe_leased = self.leased.get_mut(&owner);
        let ip = match maybe_leased {
            Some(leased) => {
                match leased.status {
                    LeaseStatus::Offered => {
                        leased.status = LeaseStatus::Acked;
                    }
                    LeaseStatus::Acked => {
                        warn!(
                            "{} will be leased an IP address it was already leased",
                            owner
                        );
                    }
                };

                leased.extend();
                leased.ip
            }
            None => {
                // nothing was offered, but this might be a rapid commit
                let lease = self.get_lease(&owner, LeaseStatus::Acked)?;
                let ip = lease.ip;
                self.leased.insert(owner, lease);
                ip
            }
        };

        #[cfg(not(feature = "benchmark"))]
        self.commit()?;

        Ok(ip)
    }

    /// Resets the time of an offered or acked lease.
    /// Used by the server in the lease renew/rebind process.
    pub fn extend(&mut self, owner: MacAddress) -> Result<()> {
        match self.leased.get_mut(&owner) {
            Some(lease) => {
                lease.extend();
                Ok(())
            }
            None => Err("No IP address lease found with that owner"),
        }
    }

    /// Makes an ip address that was offered or acked available again.
    pub fn release(&mut self, owner: MacAddress) -> Result<()> {
        let maybe_leased = self.leased.remove(&owner);

        match maybe_leased {
            Some(lease) => {
                if !lease.is_static {
                    self.available.insert(lease.ip);
                }
                Ok(())
            }
            None => Err("No IP address lease found with that owner"),
        }
    }

    /// Returns either a lease with a static address or one with the next available address
    fn get_lease(&mut self, owner: &MacAddress, status: LeaseStatus) -> Result<Lease> {
        let lease = match self.static_leases.get(owner) {
            Some(ip) => Lease::new(*ip, status, true),
            None => Lease::new(self.get_ip()?, status, false),
        };
        Ok(lease)
    }

    /// Returns a static ip address or gets the next available address.
    /// If there are no more available addresses, then it will:
    /// 1. Search for offered addresses older than 1 minute
    /// 2. Search for acked addresses that have expired.
    fn get_ip(&mut self) -> Result<Ipv4Addr> {
        if let Some(any) = self.available.iter().next().cloned() {
            debug!("Chose available IP address {any}");
            // UNWRAP is okay because we've found this element above
            return Ok(self.available.take(&any).unwrap());
        }

        let maybe_expired_lease = self
            .leased
            .clone() // TODO slow
            .into_iter() // TODO slow
            .find(|(_owner, lease)| match lease.status {
                LeaseStatus::Offered => lease.is_expired(Self::OFFER_TIMEOUT).unwrap_or(false),
                LeaseStatus::Acked => lease.is_expired(self.lease_time).unwrap_or(false),
            });

        if let Some(expired_lease) = maybe_expired_lease {
            debug!("Reusing expired lease's IP address");
            // UNWRAP is okay because we've found this element above
            return Ok(self.leased.remove(&expired_lease.0).unwrap().ip);
        }

        Err("No more IP addresses available")
    }

    /// Checks whether the passed IP address is available in the pool.
    pub fn is_available(&self, ip: &Ipv4Addr) -> bool {
        self.available.contains(ip)
    }

    /// Checks if the passed IP address matches the committed, leased IP address,
    /// and that the lease is not expired.
    pub fn verify_lease(&self, owner: MacAddress, ip: &Ipv4Addr) -> Result<()> {
        let maybe_leased = self.leased.get(&owner);

        match maybe_leased {
            Some(lease) => {
                if let LeaseStatus::Offered = lease.status {
                    return Err("Lease offered but not previously acked");
                }

                if &lease.ip != ip {
                    return Err("Client's notion of ip address is wrong");
                }

                if lease.is_expired(self.lease_time)? {
                    return Err("Lease has expired");
                }

                Ok(())
            }
            None => Err("No IP address lease found with that owner"),
        }
    }
}