nmstate 2.2.60

Library for networking management in a declarative manner
Documentation
// SPDX-License-Identifier: Apache-2.0

use std::convert::TryFrom;

use super::super::{
    ErrorKind, NmDevice, NmDeviceState, NmDeviceStateReason, NmError,
    NmIfaceType,
    connection::DbusDictionary,
    dbus::{NM_DBUS_INTERFACE_DEV, NM_DBUS_INTERFACE_ROOT},
    lldp::NmLldpNeighbor,
};

const NM_DEVICE_TYPE_UNKNOWN: u32 = 0;
const NM_DEVICE_TYPE_ETHERNET: u32 = 1;
const NM_DEVICE_TYPE_WIFI: u32 = 2;
// const NM_DEVICE_TYPE_UNUSED1: u32 = 3;
// const NM_DEVICE_TYPE_UNUSED2: u32 = 4;
const NM_DEVICE_TYPE_BT: u32 = 5;
const NM_DEVICE_TYPE_OLPC_MESH: u32 = 6;
// WIMAX is not supported by NM
// const NM_DEVICE_TYPE_WIMAX: u32 = 7;
// Nmstate do not support MODEM
// const NM_DEVICE_TYPE_MODEM: u32 = 8;
const NM_DEVICE_TYPE_INFINIBAND: u32 = 9;
const NM_DEVICE_TYPE_BOND: u32 = 10;
const NM_DEVICE_TYPE_VLAN: u32 = 11;
// Nmstate do not support ADSL
// const NM_DEVICE_TYPE_ADSL: u32 = 12;
const NM_DEVICE_TYPE_BRIDGE: u32 = 13;
const NM_DEVICE_TYPE_GENERIC: u32 = 14;
// Team is not supported by nmstate
// const NM_DEVICE_TYPE_TEAM: u32 = 15;
const NM_DEVICE_TYPE_TUN: u32 = 16;
const NM_DEVICE_TYPE_IP_TUNNEL: u32 = 17;
const NM_DEVICE_TYPE_MACVLAN: u32 = 18;
const NM_DEVICE_TYPE_VXLAN: u32 = 19;
const NM_DEVICE_TYPE_VETH: u32 = 20;
const NM_DEVICE_TYPE_MACSEC: u32 = 21;
const NM_DEVICE_TYPE_DUMMY: u32 = 22;
const NM_DEVICE_TYPE_PPP: u32 = 23;
const NM_DEVICE_TYPE_OVS_INTERFACE: u32 = 24;
const NM_DEVICE_TYPE_OVS_PORT: u32 = 25;
const NM_DEVICE_TYPE_OVS_BRIDGE: u32 = 26;
const NM_DEVICE_TYPE_WPAN: u32 = 27;
const NM_DEVICE_TYPE_6LOWPAN: u32 = 28;
const NM_DEVICE_TYPE_WIREGUARD: u32 = 29;
const NM_DEVICE_TYPE_WIFI_P2P: u32 = 30;
const NM_DEVICE_TYPE_VRF: u32 = 31;
const NM_DEVICE_TYPE_LOOPBACK: u32 = 32;
const NM_DEVICE_TYPE_HSR: u32 = 33;
const NM_DEVICE_TYPE_IPVLAN: u32 = 34;

async fn nm_dev_name_get(
    dbus_conn: &zbus::Connection,
    obj_path: &str,
) -> Result<String, NmError> {
    let proxy = zbus::Proxy::new(
        dbus_conn,
        NM_DBUS_INTERFACE_ROOT,
        obj_path,
        NM_DBUS_INTERFACE_DEV,
    )
    .await?;
    match proxy.get_property::<String>("Interface").await {
        Ok(n) => Ok(n),
        Err(e) => Err(NmError::new(
            ErrorKind::Bug,
            format!(
                "Failed to retrieve interface name of device {obj_path}: {e}"
            ),
        )),
    }
}

async fn nm_dev_iface_type_get(
    dbus_conn: &zbus::Connection,
    obj_path: &str,
) -> Result<NmIfaceType, NmError> {
    let proxy = zbus::Proxy::new(
        dbus_conn,
        NM_DBUS_INTERFACE_ROOT,
        obj_path,
        NM_DBUS_INTERFACE_DEV,
    )
    .await?;
    match proxy.get_property::<u32>("DeviceType").await {
        Ok(i) => Ok(match i {
            // Using the NM_SETTING_*_NAME string
            NM_DEVICE_TYPE_UNKNOWN => NmIfaceType::Unknown,
            NM_DEVICE_TYPE_ETHERNET => NmIfaceType::Ethernet,
            NM_DEVICE_TYPE_WIFI => NmIfaceType::Wireless,
            NM_DEVICE_TYPE_BT => NmIfaceType::Bluetooth,
            NM_DEVICE_TYPE_OLPC_MESH => NmIfaceType::OlpcMesh,
            NM_DEVICE_TYPE_INFINIBAND => NmIfaceType::Infiniband,
            NM_DEVICE_TYPE_BOND => NmIfaceType::Bond,
            NM_DEVICE_TYPE_VLAN => NmIfaceType::Vlan,
            NM_DEVICE_TYPE_BRIDGE => NmIfaceType::Bridge,
            NM_DEVICE_TYPE_GENERIC => NmIfaceType::Generic,
            NM_DEVICE_TYPE_TUN => NmIfaceType::Tun,
            NM_DEVICE_TYPE_IP_TUNNEL => NmIfaceType::IpTunnel,
            NM_DEVICE_TYPE_MACVLAN => NmIfaceType::Macvlan,
            NM_DEVICE_TYPE_VXLAN => NmIfaceType::Vxlan,
            NM_DEVICE_TYPE_VETH => NmIfaceType::Veth,
            NM_DEVICE_TYPE_MACSEC => NmIfaceType::Macsec,
            NM_DEVICE_TYPE_DUMMY => NmIfaceType::Dummy,
            NM_DEVICE_TYPE_PPP => NmIfaceType::Ppp,
            NM_DEVICE_TYPE_OVS_INTERFACE => NmIfaceType::OvsIface,
            NM_DEVICE_TYPE_OVS_PORT => NmIfaceType::OvsPort,
            NM_DEVICE_TYPE_OVS_BRIDGE => NmIfaceType::OvsBridge,
            NM_DEVICE_TYPE_WPAN => NmIfaceType::Wpan,
            NM_DEVICE_TYPE_6LOWPAN => NmIfaceType::SixLowPan,
            NM_DEVICE_TYPE_WIREGUARD => NmIfaceType::Wireguard,
            NM_DEVICE_TYPE_WIFI_P2P => NmIfaceType::WifiP2p,
            NM_DEVICE_TYPE_VRF => NmIfaceType::Vrf,
            NM_DEVICE_TYPE_LOOPBACK => NmIfaceType::Loopback,
            NM_DEVICE_TYPE_HSR => NmIfaceType::Hsr,
            NM_DEVICE_TYPE_IPVLAN => NmIfaceType::Ipvlan,
            _ => {
                log::debug!("Unknown NM_DEVICE_TYPE_XXX: {i}");
                NmIfaceType::Unknown
            }
        }),
        Err(e) => Err(NmError::new(
            ErrorKind::Bug,
            format!("Failed to retrieve device type of device {obj_path}: {e}"),
        )),
    }
}

async fn nm_dev_state_reason_get(
    dbus_conn: &zbus::Connection,
    obj_path: &str,
) -> Result<(NmDeviceState, NmDeviceStateReason), NmError> {
    let proxy = zbus::Proxy::new(
        dbus_conn,
        NM_DBUS_INTERFACE_ROOT,
        obj_path,
        NM_DBUS_INTERFACE_DEV,
    )
    .await?;
    match proxy.get_property::<(u32, u32)>("StateReason").await {
        Ok((state, state_reason)) => Ok((state.into(), state_reason.into())),
        Err(e) => Err(NmError::new(
            ErrorKind::Bug,
            format!(
                "Failed to retrieve state reason of device {obj_path}: {e}"
            ),
        )),
    }
}

async fn nm_dev_is_mac_vtap_get(
    dbus_conn: &zbus::Connection,
    obj_path: &str,
) -> Result<bool, NmError> {
    let dbus_iface = format!("{NM_DBUS_INTERFACE_DEV}.Macvlan");
    let proxy = zbus::Proxy::new(
        dbus_conn,
        NM_DBUS_INTERFACE_ROOT,
        obj_path,
        dbus_iface.as_str(),
    )
    .await?;
    match proxy.get_property::<bool>("Tab").await {
        Ok(v) => Ok(v),
        Err(e) => Err(NmError::new(
            ErrorKind::Bug,
            format!(
                "Failed to retrieve Macvlan.Tab(tap) of device {obj_path}: {e}"
            ),
        )),
    }
}

async fn nm_dev_real_get(
    dbus_conn: &zbus::Connection,
    obj_path: &str,
) -> Result<bool, NmError> {
    let proxy = zbus::Proxy::new(
        dbus_conn,
        NM_DBUS_INTERFACE_ROOT,
        obj_path,
        NM_DBUS_INTERFACE_DEV,
    )
    .await?;
    match proxy.get_property::<bool>("Real").await {
        Ok(r) => Ok(r),
        Err(e) => Err(NmError::new(
            ErrorKind::Bug,
            format!("Failed to retrieve real of device {obj_path}: {e}"),
        )),
    }
}

pub(crate) async fn nm_dev_from_obj_path(
    dbus_conn: &zbus::Connection,
    obj_path: &str,
) -> Result<NmDevice, NmError> {
    let real = nm_dev_real_get(dbus_conn, obj_path).await?;
    let (state, state_reason) =
        nm_dev_state_reason_get(dbus_conn, obj_path).await?;
    let mut dev = NmDevice {
        name: nm_dev_name_get(dbus_conn, obj_path).await?,
        iface_type: nm_dev_iface_type_get(dbus_conn, obj_path).await?,
        state,
        state_reason,
        obj_path: obj_path.to_string(),
        is_mac_vtap: false,
        real,
        mac_address: nm_dev_get_mac_address(dbus_conn, obj_path).await?,
    };
    if dev.iface_type == NmIfaceType::Macvlan {
        dev.is_mac_vtap = nm_dev_is_mac_vtap_get(dbus_conn, obj_path).await?;
    }
    Ok(dev)
}

pub(crate) async fn nm_dev_disconnect(
    dbus_conn: &zbus::Connection,
    obj_path: &str,
) -> Result<(), NmError> {
    let proxy = zbus::Proxy::new(
        dbus_conn,
        NM_DBUS_INTERFACE_ROOT,
        obj_path,
        NM_DBUS_INTERFACE_DEV,
    )
    .await?;
    match proxy.call::<&str, (), ()>("Disconnect", &()).await {
        Ok(()) => Ok(()),
        Err(e) => {
            let nm_err: NmError = e.into();
            Err(NmError::new(
                nm_err.kind,
                format!(
                    "Failed to disconnect device {obj_path}: {}",
                    nm_err.msg
                ),
            ))
        }
    }
}

pub(crate) async fn nm_dev_delete(
    dbus_conn: &zbus::Connection,
    obj_path: &str,
) -> Result<(), NmError> {
    let proxy = zbus::Proxy::new(
        dbus_conn,
        NM_DBUS_INTERFACE_ROOT,
        obj_path,
        NM_DBUS_INTERFACE_DEV,
    )
    .await?;
    match proxy.call::<&str, (), ()>("Delete", &()).await {
        Ok(()) => Ok(()),
        Err(e) => Err(NmError::new(
            ErrorKind::Bug,
            format!("Failed to delete device {obj_path}: {e}"),
        )),
    }
}

pub(crate) async fn nm_dev_get_llpd(
    dbus_conn: &zbus::Connection,
    obj_path: &str,
) -> Result<Vec<NmLldpNeighbor>, NmError> {
    let proxy = zbus::Proxy::new(
        dbus_conn,
        NM_DBUS_INTERFACE_ROOT,
        obj_path,
        NM_DBUS_INTERFACE_DEV,
    )
    .await?;
    match proxy
        .get_property::<Vec<DbusDictionary>>("LldpNeighbors")
        .await
    {
        Ok(v) => {
            let mut ret = Vec::new();
            for value in v {
                ret.push(NmLldpNeighbor::try_from(value)?);
            }
            Ok(ret)
        }
        Err(e) => Err(NmError::new(
            ErrorKind::Bug,
            format!(
                "Failed to retrieve LLDP neighbors of device {obj_path}: {e}"
            ),
        )),
    }
}

async fn nm_dev_get_mac_address(
    dbus_conn: &zbus::Connection,
    obj_path: &str,
) -> Result<String, NmError> {
    let proxy = zbus::Proxy::new(
        dbus_conn,
        NM_DBUS_INTERFACE_ROOT,
        obj_path,
        NM_DBUS_INTERFACE_DEV,
    )
    .await?;
    match proxy.get_property::<String>("HwAddress").await {
        Ok(v) => Ok(v),
        Err(e) => Err(NmError::new(
            ErrorKind::Bug,
            format!("Failed to retrieve HwAddress of device {obj_path}: {e}"),
        )),
    }
}