systemd-resolved-rs 0.1.1

A compatibility-oriented reimplementation of systemd-resolved
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
// SPDX-License-Identifier: LGPL-2.1-or-later
use crate::config::{
    parse_server_spec, DnsServerSpec, Domain, SupportMode, TlsMode, ValidationMode,
};
use crate::daemon::{request_stop, stop_requested};
use crate::native;
use crate::resolver::Resolver;
use std::collections::BTreeMap;
use std::fs;
use std::io;
use std::os::fd::{AsRawFd, FromRawFd, OwnedFd};
use std::path::Path;
use std::sync::Arc;
use std::thread::{self, JoinHandle};
use std::time::{Duration, Instant};

const NETWORKD_LINKS_DIRECTORY: &str = "/run/systemd/netif/links";
const NETWORKD_POLL_INTERVAL: Duration = Duration::from_millis(250);
const NETWORKD_REOPEN_INTERVAL: Duration = Duration::from_secs(1);

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum OperationalState {
    Missing,
    Off,
    NoCarrier,
    Dormant,
    DegradedCarrier,
    Carrier,
    Degraded,
    Enslaved,
    Routable,
    Unknown,
}

impl OperationalState {
    fn parse(value: Option<&str>) -> Self {
        match value {
            None => Self::Missing,
            Some("off") => Self::Off,
            Some("no-carrier") => Self::NoCarrier,
            Some("dormant") => Self::Dormant,
            Some("degraded-carrier") => Self::DegradedCarrier,
            Some("carrier") => Self::Carrier,
            Some("degraded") => Self::Degraded,
            Some("enslaved") => Self::Enslaved,
            Some("routable") => Self::Routable,
            Some(_) => Self::Unknown,
        }
    }

    pub const fn resolver_relevant(self) -> bool {
        matches!(
            self,
            Self::DegradedCarrier | Self::Degraded | Self::Routable
        )
    }
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct LinkState {
    pub ifindex: i32,
    pub managed: bool,
    pub operstate: OperationalState,
    pub dns_servers: Vec<std::net::SocketAddr>,
    pub dns_server_specs: Vec<DnsServerSpec>,
    pub domains: Vec<Domain>,
    pub default_route: Option<bool>,
    pub llmnr: SupportMode,
    pub multicast_dns: SupportMode,
    pub dns_over_tls: Option<TlsMode>,
    pub dnssec: Option<ValidationMode>,
    pub dnssec_negative_trust_anchors: Vec<String>,
}

impl LinkState {
    pub const fn resolver_relevant(&self) -> bool {
        !self.managed || self.operstate.resolver_relevant()
    }
}

pub fn read_all() -> io::Result<Vec<LinkState>> {
    read_directory(Path::new(NETWORKD_LINKS_DIRECTORY))
}

fn read_directory(directory: &Path) -> io::Result<Vec<LinkState>> {
    let entries = match fs::read_dir(directory) {
        Ok(entries) => entries,
        Err(error) if error.kind() == io::ErrorKind::NotFound => return Ok(Vec::new()),
        Err(error) => return Err(error),
    };
    let mut states = Vec::new();
    for entry in entries {
        let entry = entry?;
        let Some(name) = entry.file_name().to_str().map(str::to_owned) else {
            continue;
        };
        let Ok(ifindex) = name.parse::<i32>() else {
            continue;
        };
        if ifindex <= 0 {
            continue;
        }
        match fs::read_to_string(entry.path()) {
            Ok(text) => states.push(parse_link_state(ifindex, &text)?),
            Err(error) if error.kind() == io::ErrorKind::NotFound => {}
            Err(error) => return Err(error),
        }
    }
    states.sort_by_key(|state| state.ifindex);
    Ok(states)
}

fn parse_link_state(ifindex: i32, text: &str) -> io::Result<LinkState> {
    let values = parse_environment(text);
    let admin_state = values.get("ADMIN_STATE").map(String::as_str);
    let managed = !matches!(
        admin_state,
        None | Some("pending" | "initialized" | "unmanaged")
    );
    let operstate = OperationalState::parse(values.get("OPER_STATE").map(String::as_str));

    if !managed {
        return Ok(LinkState {
            ifindex,
            managed: false,
            operstate,
            dns_servers: Vec::new(),
            dns_server_specs: Vec::new(),
            domains: Vec::new(),
            default_route: None,
            llmnr: SupportMode::Yes,
            multicast_dns: SupportMode::Yes,
            dns_over_tls: None,
            dnssec: None,
            dnssec_negative_trust_anchors: Vec::new(),
        });
    }

    let dns_server_specs = parse_dns_specs(values.get("DNS").map_or("", String::as_str))?;
    let dns_servers = dns_server_specs.iter().map(|spec| spec.address).fold(
        Vec::new(),
        |mut servers, address| {
            if !servers.contains(&address) {
                servers.push(address);
            }
            servers
        },
    );
    let mut domains = parse_domains(values.get("DOMAINS").map_or("", String::as_str), false)?;
    for domain in parse_domains(values.get("ROUTE_DOMAINS").map_or("", String::as_str), true)? {
        if !domains.contains(&domain) {
            domains.push(domain);
        }
    }

    Ok(LinkState {
        ifindex,
        managed: true,
        operstate,
        dns_servers,
        dns_server_specs,
        domains,
        default_route: values
            .get("DNS_DEFAULT_ROUTE")
            .map(|value| parse_bool(value))
            .transpose()?,
        llmnr: values
            .get("LLMNR")
            .map(|value| parse_support_mode(value))
            .transpose()?
            .unwrap_or(SupportMode::Yes),
        multicast_dns: values
            .get("MDNS")
            .map(|value| parse_support_mode(value))
            .transpose()?
            .unwrap_or(SupportMode::Yes),
        dns_over_tls: values
            .get("DNS_OVER_TLS")
            .map(|value| parse_tls_mode(value))
            .transpose()?,
        dnssec: values
            .get("DNSSEC")
            .map(|value| parse_validation_mode(value))
            .transpose()?,
        dnssec_negative_trust_anchors: parse_names(
            values.get("DNSSEC_NTA").map_or("", String::as_str),
        )?,
    })
}

fn parse_environment(text: &str) -> BTreeMap<String, String> {
    text.lines()
        .filter_map(|line| {
            let line = line.trim();
            if line.is_empty() || line.starts_with('#') {
                return None;
            }
            let (key, value) = line.split_once('=')?;
            Some((key.trim().to_owned(), unquote(value.trim())))
        })
        .collect()
}

fn unquote(value: &str) -> String {
    if value.len() >= 2
        && ((value.starts_with('"') && value.ends_with('"'))
            || (value.starts_with('\'') && value.ends_with('\'')))
    {
        value[1..value.len() - 1].to_owned()
    } else {
        value.to_owned()
    }
}

fn parse_dns_specs(value: &str) -> io::Result<Vec<DnsServerSpec>> {
    let mut output = Vec::new();
    for token in value.split_whitespace() {
        let server = parse_server_spec(token).map_err(invalid_data)?;
        if !output.contains(&server) {
            output.push(server);
        }
    }
    Ok(output)
}

fn parse_domains(value: &str, route_only: bool) -> io::Result<Vec<Domain>> {
    let mut output = Vec::new();
    for token in value.split_whitespace() {
        let name = normalize_name(token)?;
        let domain = Domain { name, route_only };
        if !output.contains(&domain) {
            output.push(domain);
        }
    }
    Ok(output)
}

fn parse_names(value: &str) -> io::Result<Vec<String>> {
    let mut output = Vec::new();
    for token in value.split_whitespace() {
        let name = normalize_name(token)?;
        if !output.contains(&name) {
            output.push(name);
        }
    }
    Ok(output)
}

fn normalize_name(value: &str) -> io::Result<String> {
    let value = value.trim();
    if matches!(value, "." | "~" | "~.") {
        return Ok(".".to_owned());
    }
    let value = value
        .strip_prefix('~')
        .unwrap_or(value)
        .trim_end_matches('.');
    if value.is_empty()
        || !value.is_ascii()
        || value.len() > 253
        || value
            .split('.')
            .any(|label| label.is_empty() || label.len() > 63)
    {
        return Err(io::Error::new(
            io::ErrorKind::InvalidData,
            format!("invalid networkd DNS domain {value}"),
        ));
    }
    Ok(value.to_ascii_lowercase())
}

fn parse_bool(value: &str) -> io::Result<bool> {
    match value.trim().to_ascii_lowercase().as_str() {
        "yes" | "true" | "on" | "1" => Ok(true),
        "no" | "false" | "off" | "0" => Ok(false),
        _ => Err(io::Error::new(
            io::ErrorKind::InvalidData,
            format!("invalid networkd boolean {value}"),
        )),
    }
}

fn parse_support_mode(value: &str) -> io::Result<SupportMode> {
    match value.trim().to_ascii_lowercase().as_str() {
        "yes" => Ok(SupportMode::Yes),
        "resolve" => Ok(SupportMode::Resolve),
        "no" => Ok(SupportMode::No),
        _ => Err(io::Error::new(
            io::ErrorKind::InvalidData,
            format!("invalid networkd resolver support mode {value}"),
        )),
    }
}

fn parse_tls_mode(value: &str) -> io::Result<TlsMode> {
    match value.trim().to_ascii_lowercase().as_str() {
        "no" => Ok(TlsMode::No),
        "opportunistic" => Ok(TlsMode::Opportunistic),
        "yes" => Ok(TlsMode::Yes),
        _ => Err(io::Error::new(
            io::ErrorKind::InvalidData,
            format!("invalid networkd DNS-over-TLS mode {value}"),
        )),
    }
}

fn parse_validation_mode(value: &str) -> io::Result<ValidationMode> {
    match value.trim().to_ascii_lowercase().as_str() {
        "no" => Ok(ValidationMode::No),
        "allow-downgrade" => Ok(ValidationMode::AllowDowngrade),
        "yes" => Ok(ValidationMode::Yes),
        _ => Err(io::Error::new(
            io::ErrorKind::InvalidData,
            format!("invalid networkd DNSSEC mode {value}"),
        )),
    }
}

fn invalid_data(error: impl std::fmt::Display) -> io::Error {
    io::Error::new(io::ErrorKind::InvalidData, error.to_string())
}

pub fn synchronize(resolver: &Resolver) -> io::Result<()> {
    let links = read_all()?;
    if std::env::var_os("RESOLVED_RS_QUERY_DIAGNOSTICS").is_some() {
        for link in &links {
            eprintln!(
                "systemd-resolved: networkd link {} managed={} operstate={:?} DNS={:?}",
                link.ifindex, link.managed, link.operstate, link.dns_servers
            );
        }
    }
    resolver.sync_networkd_links(links).map_err(invalid_data)
}

pub fn spawn(resolver: Arc<Resolver>) -> io::Result<JoinHandle<()>> {
    synchronize(&resolver)?;
    thread::Builder::new()
        .name("resolved-networkd".to_owned())
        .spawn(move || monitor(&resolver))
}

fn monitor(resolver: &Resolver) {
    while !stop_requested() {
        let fd = match native::networkd_open() {
            Ok(fd) => fd,
            Err(error) => {
                eprintln!("systemd-resolved: networkd monitor setup failed: {error}");
                request_stop();
                break;
            }
        };
        // SAFETY: networkd_open returns a fresh owned descriptor.
        let fd = unsafe { OwnedFd::from_raw_fd(fd) };
        let reopen_at = Instant::now() + NETWORKD_REOPEN_INTERVAL;
        loop {
            match native::networkd_wait(fd.as_raw_fd(), NETWORKD_POLL_INTERVAL) {
                Ok(true) => {
                    if let Err(error) = synchronize(resolver) {
                        eprintln!(
                            "systemd-resolved: failed to refresh networkd DNS state: {error}"
                        );
                    }
                }
                Ok(false) if stop_requested() => return,
                Ok(false) if Instant::now() >= reopen_at => {
                    if let Err(error) = synchronize(resolver) {
                        eprintln!(
                            "systemd-resolved: failed to refresh networkd DNS state: {error}"
                        );
                    }
                    break;
                }
                Ok(false) => {}
                Err(error) => {
                    eprintln!("systemd-resolved: networkd monitoring failed: {error}");
                    request_stop();
                    return;
                }
            }
        }
    }
}

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

    #[test]
    fn parses_managed_networkd_resolver_state() {
        let state = parse_link_state(
            7,
            "ADMIN_STATE=configured\n\
             OPER_STATE=degraded-carrier\n\
             DNS=192.0.2.53 2001:db8::53\n\
             DOMAINS=example.test\n\
             ROUTE_DOMAINS=corp.example\n\
             DNS_DEFAULT_ROUTE=no\n\
             LLMNR=resolve\n\
             MDNS=no\n\
             DNS_OVER_TLS=opportunistic\n\
             DNSSEC=allow-downgrade\n\
             DNSSEC_NTA=private.example.\n",
        )
        .expect("networkd state");
        assert!(state.managed);
        assert!(state.resolver_relevant());
        assert_eq!(state.dns_servers.len(), 2);
        assert_eq!(state.dns_server_specs.len(), 2);
        assert_eq!(
            state.domains,
            vec![
                Domain {
                    name: "example.test".to_owned(),
                    route_only: false,
                },
                Domain {
                    name: "corp.example".to_owned(),
                    route_only: true,
                },
            ]
        );
        assert_eq!(state.default_route, Some(false));
        assert_eq!(state.llmnr, SupportMode::Resolve);
        assert_eq!(state.multicast_dns, SupportMode::No);
        assert_eq!(state.dns_over_tls, Some(TlsMode::Opportunistic));
        assert_eq!(state.dnssec, Some(ValidationMode::AllowDowngrade));
        assert_eq!(
            state.dnssec_negative_trust_anchors,
            vec!["private.example".to_owned()]
        );
    }

    #[test]
    fn managed_dns_metadata_is_preserved() {
        let state = parse_link_state(
            7,
            "ADMIN_STATE=configured\nOPER_STATE=routable\nDNS=192.0.2.53:853%vpn0#resolver.example\n",
        )
        .expect("networkd DNS metadata");
        assert_eq!(state.dns_servers.len(), 1);
        assert_eq!(state.dns_server_specs.len(), 1);
        assert_eq!(state.dns_server_specs[0].interface.as_deref(), Some("vpn0"));
        assert_eq!(
            state.dns_server_specs[0].server_name.as_deref(),
            Some("resolver.example")
        );
    }

    #[test]
    fn root_route_domain_is_preserved() {
        let state = parse_link_state(
            7,
            "ADMIN_STATE=configured\nOPER_STATE=routable\nROUTE_DOMAINS=.\n",
        )
        .expect("root route domain");
        assert_eq!(
            state.domains,
            vec![Domain {
                name: ".".to_owned(),
                route_only: true,
            }]
        );
    }

    #[test]
    fn unmanaged_state_ignores_networkd_resolver_values() {
        let state = parse_link_state(
            7,
            "ADMIN_STATE=unmanaged\nOPER_STATE=routable\nDNS=192.0.2.53\nDOMAINS=example.test\n",
        )
        .expect("unmanaged state");
        assert!(!state.managed);
        assert!(state.dns_servers.is_empty());
        assert!(state.domains.is_empty());
    }

    #[test]
    fn managed_operstate_gates_resolver_relevance() {
        let configuring = parse_link_state(7, "ADMIN_STATE=configuring\nOPER_STATE=carrier\n")
            .expect("configuring state");
        assert!(!configuring.resolver_relevant());
        let routable = parse_link_state(7, "ADMIN_STATE=configured\nOPER_STATE=routable\n")
            .expect("routable state");
        assert!(routable.resolver_relevant());
    }

    #[test]
    fn quoted_environment_values_are_unwrapped() {
        let values = parse_environment("ADMIN_STATE=\"configured\"\nDNS='192.0.2.53'\n");
        assert_eq!(
            values.get("ADMIN_STATE").map(String::as_str),
            Some("configured")
        );
        assert_eq!(values.get("DNS").map(String::as_str), Some("192.0.2.53"));
    }
}