nlink 0.15.1

Async netlink library for Linux network configuration
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

//! Sysctl management via `/proc/sys/`.
//!
//! This module provides functions for reading and writing kernel parameters
//! (sysctls) through the `/proc/sys/` filesystem. For namespace-aware
//! operations, use the wrappers in [`super::namespace`].
//!
//! # Example
//!
//! ```ignore
//! use nlink::netlink::sysctl;
//!
//! // Read a sysctl value
//! let val = sysctl::get("net.ipv4.ip_forward")?;
//! println!("ip_forward = {}", val);
//!
//! // Set a sysctl value (requires root)
//! sysctl::set("net.ipv4.ip_forward", "1")?;
//!
//! // Set multiple values at once
//! sysctl::set_many(&[
//!     ("net.ipv4.ip_forward", "1"),
//!     ("net.ipv6.conf.all.forwarding", "1"),
//! ])?;
//! ```

use std::path::PathBuf;

use super::error::{Error, Result};

/// Convert a dotted sysctl key to a `/proc/sys/` path.
///
/// # Example
///
/// ```ignore
/// assert_eq!(
///     sysctl_path("net.ipv4.ip_forward")?,
///     PathBuf::from("/proc/sys/net/ipv4/ip_forward"),
/// );
/// ```
fn sysctl_path(key: &str) -> Result<PathBuf> {
    validate_key(key)?;
    let relative = key.replace('.', "/");
    Ok(PathBuf::from("/proc/sys").join(relative))
}

/// Validate a sysctl key to prevent path traversal.
fn validate_key(key: &str) -> Result<()> {
    if key.is_empty() {
        return Err(Error::InvalidMessage("sysctl key cannot be empty".into()));
    }
    if key.contains("..") || key.starts_with('/') || key.contains('\0') {
        return Err(Error::InvalidMessage(format!(
            "invalid sysctl key: {}",
            key
        )));
    }
    Ok(())
}

/// Read a sysctl value.
///
/// Reads from `/proc/sys/` in the current namespace. For namespace-aware
/// operations, use [`super::namespace::get_sysctl`].
///
/// # Example
///
/// ```ignore
/// use nlink::netlink::sysctl;
///
/// let val = sysctl::get("net.ipv4.ip_forward")?;
/// assert!(val == "0" || val == "1");
/// ```
pub fn get(key: &str) -> Result<String> {
    let path = sysctl_path(key)?;
    let contents = std::fs::read_to_string(&path).map_err(|e| match e.kind() {
        std::io::ErrorKind::NotFound => {
            Error::InvalidMessage(format!("sysctl key not found: {}", key))
        }
        std::io::ErrorKind::PermissionDenied => Error::Io(e),
        _ => Error::Io(e),
    })?;
    Ok(contents.trim_end().to_string())
}

/// Set a sysctl value.
///
/// Writes to `/proc/sys/` in the current namespace. Requires root or
/// `CAP_SYS_ADMIN`. For namespace-aware operations, use
/// [`super::namespace::set_sysctl`].
///
/// # Example
///
/// ```ignore
/// use nlink::netlink::sysctl;
///
/// sysctl::set("net.ipv4.ip_forward", "1")?;
/// ```
pub fn set(key: &str, value: &str) -> Result<()> {
    let path = sysctl_path(key)?;
    std::fs::write(&path, value).map_err(|e| match e.kind() {
        std::io::ErrorKind::NotFound => {
            Error::InvalidMessage(format!("sysctl key not found: {}", key))
        }
        std::io::ErrorKind::PermissionDenied => Error::Io(e),
        _ => Error::Io(e),
    })?;
    Ok(())
}

/// Set multiple sysctl values.
///
/// Applies all entries in order. If any entry fails, returns the error
/// immediately without applying remaining entries.
///
/// # Example
///
/// ```ignore
/// use nlink::netlink::sysctl;
///
/// sysctl::set_many(&[
///     ("net.ipv4.ip_forward", "1"),
///     ("net.ipv6.conf.all.forwarding", "1"),
/// ])?;
/// ```
pub fn set_many(entries: &[(&str, &str)]) -> Result<()> {
    for &(key, value) in entries {
        set(key, value)?;
    }
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_sysctl_path_conversion() {
        assert_eq!(
            sysctl_path("net.ipv4.ip_forward").unwrap(),
            PathBuf::from("/proc/sys/net/ipv4/ip_forward")
        );
        assert_eq!(
            sysctl_path("net.ipv6.conf.all.forwarding").unwrap(),
            PathBuf::from("/proc/sys/net/ipv6/conf/all/forwarding")
        );
    }

    #[test]
    fn test_validate_key_rejects_traversal() {
        assert!(validate_key("net..ipv4").is_err());
        assert!(validate_key("/etc/passwd").is_err());
        assert!(validate_key("").is_err());
        assert!(validate_key("net.ipv4\0.ip_forward").is_err());
    }

    #[test]
    fn test_validate_key_accepts_valid() {
        assert!(validate_key("net.ipv4.ip_forward").is_ok());
        assert!(validate_key("net.ipv6.conf.all.forwarding").is_ok());
        assert!(validate_key("kernel.hostname").is_ok());
    }
}