fips-core 0.3.72

Reusable FIPS mesh, endpoint, transport, and protocol library
Documentation 
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

use super::*;

/// Placeholder TUN device for platforms where apps must own packet I/O.
pub struct TunDevice {
    name: String,
    mtu: u16,
    address: FipsAddress,
}

impl TunDevice {
    /// System TUN creation is not available on this platform.
    pub async fn create(config: &TunConfig, address: FipsAddress) -> Result<Self, TunError> {
        let _ = (config, address);
        Err(TunError::UnsupportedPlatform)
    }

    /// Get the configured device name.
    pub fn name(&self) -> &str {
        &self.name
    }

    /// Get the configured MTU.
    pub fn mtu(&self) -> u16 {
        self.mtu
    }

    /// Get the FIPS address assigned to this device.
    pub fn address(&self) -> &FipsAddress {
        &self.address
    }

    /// Creating a system TUN writer is not available on this platform.
    pub fn create_writer(
        &self,
        max_mss: u16,
        path_mtu_lookup: PathMtuLookup,
    ) -> Result<(TunWriter, TunTx), TunError> {
        let _ = (max_mss, path_mtu_lookup);
        Err(TunError::UnsupportedPlatform)
    }
}

impl std::fmt::Debug for TunDevice {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("TunDevice")
            .field("name", &self.name)
            .field("mtu", &self.mtu)
            .field("address", &self.address)
            .finish()
    }
}

/// Placeholder writer for type-checking unreachable system-TUN paths.
pub struct TunWriter;

impl TunWriter {
    /// No-op: system TUN is unavailable on this platform.
    pub fn run(self) {}
}

/// No-op reader placeholder for platforms where apps own packet I/O.
#[allow(clippy::too_many_arguments)]
pub fn run_tun_reader(
    device: TunDevice,
    mtu: u16,
    our_addr: FipsAddress,
    tun_tx: TunTx,
    outbound_tx: TunOutboundTx,
    transport_mtu: u16,
    path_mtu_lookup: PathMtuLookup,
) {
    let _ = (
        device,
        mtu,
        our_addr,
        tun_tx,
        outbound_tx,
        transport_mtu,
        path_mtu_lookup,
    );
}

/// No-op shutdown for platforms without a FIPS-created system TUN.
pub async fn shutdown_tun_interface(name: &str) -> Result<(), TunError> {
    let _ = name;
    Ok(())
}