ftth-rtnl 0.2.1

RTnetlink components for `ftth` suite of Rust FTTH CPE software.
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
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
#![allow(unreachable_patterns)]

use std::io::{self, ErrorKind};
use std::net::{Ipv4Addr, Ipv6Addr};

use ftth_common::channel::{AsyncWorldClient, AsyncWorldServer};
use futures::TryStreamExt;
use log::warn;
use netlink_packet_route::AddressFamily;
use netlink_packet_route::route::{RouteAddress, RouteAttribute, RouteMessage};
use rtnetlink::RouteMessageBuilder;

pub(crate) type Client = AsyncWorldClient<RtnlRouteRequest, RtnlRouteResponse>;
pub(crate) type Server = AsyncWorldServer<RtnlRouteRequest, RtnlRouteResponse>;

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Ipv4Route {
    pub if_id: Option<u32>,
    pub gateway: Option<Ipv4Addr>,
    pub source: Option<Ipv4Addr>,
    pub metric: Option<u32>,
    pub table: Option<u32>,
    pub route: crate::Ipv4Net,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Ipv6Route {
    pub if_id: Option<u32>,
    pub gateway: Option<Ipv6Addr>,
    pub source: Option<Ipv6Addr>,
    pub metric: Option<u32>,
    pub table: Option<u32>,
    pub route: crate::Ipv6Net,
}

#[derive(Debug, Clone, PartialEq)]
#[non_exhaustive]
pub enum RtnlRouteRequest {
    Ipv4RouteList,
    Ipv6RouteList,
    Ipv4RouteAdd(Ipv4Route),
    Ipv4RouteReplace(Ipv4Route),
    Ipv6RouteAdd(Ipv6Route),
    Ipv6RouteReplace(Ipv6Route),
    Ipv4RouteDel(Ipv4Route),
    Ipv6RouteDel(Ipv6Route),
    Ipv4RouteGet(Ipv4Addr),
    Ipv6RouteGet(Ipv6Addr),
}

#[derive(Debug, Clone, PartialEq)]
#[non_exhaustive]
pub enum RtnlRouteResponse {
    Success,
    Failed,
    NotImplemented,
    NotFound,
    Ipv4RouteList(Vec<Ipv4Route>),
    Ipv6RouteList(Vec<Ipv6Route>),
    Ipv4Route(Ipv4Route),
    Ipv6Route(Ipv6Route),
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct RtnlRouteClient {
    client: Client,
}

impl RtnlRouteClient {
    pub(crate) fn new(client: Client) -> Self {
        Self { client }
    }

    pub fn ipv4_route_add(&self, route: Ipv4Route) -> io::Result<()> {
        let res = self
            .client
            .send_request(RtnlRouteRequest::Ipv4RouteAdd(route))?;
        handle_route_status("IPv4 route add", res)
    }

    pub fn ipv4_route_replace(&self, route: Ipv4Route) -> io::Result<()> {
        let res = self
            .client
            .send_request(RtnlRouteRequest::Ipv4RouteReplace(route))?;
        handle_route_status("IPv4 route replace", res)
    }

    pub fn ipv4_route_del(&self, route: Ipv4Route) -> io::Result<()> {
        let res = self
            .client
            .send_request(RtnlRouteRequest::Ipv4RouteDel(route))?;
        handle_route_status("IPv4 route delete", res)
    }

    pub fn ipv4_route_list(&self) -> io::Result<Vec<Ipv4Route>> {
        match self.client.send_request(RtnlRouteRequest::Ipv4RouteList)? {
            RtnlRouteResponse::Ipv4RouteList(routes) => Ok(routes),
            other => Err(io::Error::other(format!(
                "Unexpected response for IPv4 route list: {:?}",
                other
            ))),
        }
    }

    pub fn ipv4_route_get(&self, destination: Ipv4Addr) -> io::Result<Ipv4Route> {
        match self
            .client
            .send_request(RtnlRouteRequest::Ipv4RouteGet(destination))?
        {
            RtnlRouteResponse::Ipv4Route(route) => Ok(route),
            RtnlRouteResponse::NotFound => {
                Err(io::Error::new(ErrorKind::NotFound, "Route not found"))
            }
            other => Err(io::Error::other(format!(
                "Unexpected response for IPv4 route get: {:?}",
                other
            ))),
        }
    }

    pub fn ipv6_route_add(&self, route: Ipv6Route) -> io::Result<()> {
        let res = self
            .client
            .send_request(RtnlRouteRequest::Ipv6RouteAdd(route))?;
        handle_route_status("IPv6 route add", res)
    }

    pub fn ipv6_route_replace(&self, route: Ipv6Route) -> io::Result<()> {
        let res = self
            .client
            .send_request(RtnlRouteRequest::Ipv6RouteReplace(route))?;
        handle_route_status("IPv6 route replace", res)
    }

    pub fn ipv6_route_del(&self, route: Ipv6Route) -> io::Result<()> {
        let res = self
            .client
            .send_request(RtnlRouteRequest::Ipv6RouteDel(route))?;
        handle_route_status("IPv6 route delete", res)
    }

    pub fn ipv6_route_list(&self) -> io::Result<Vec<Ipv6Route>> {
        match self.client.send_request(RtnlRouteRequest::Ipv6RouteList)? {
            RtnlRouteResponse::Ipv6RouteList(routes) => Ok(routes),
            other => Err(io::Error::other(format!(
                "Unexpected response for IPv6 route list: {:?}",
                other
            ))),
        }
    }

    pub fn ipv6_route_get(&self, destination: Ipv6Addr) -> io::Result<Ipv6Route> {
        match self
            .client
            .send_request(RtnlRouteRequest::Ipv6RouteGet(destination))?
        {
            RtnlRouteResponse::Ipv6Route(route) => Ok(route),
            RtnlRouteResponse::NotFound => {
                Err(io::Error::new(ErrorKind::NotFound, "Route not found"))
            }
            other => Err(io::Error::other(format!(
                "Unexpected response for IPv6 route get: {:?}",
                other
            ))),
        }
    }
}

pub(crate) async fn run_server(mut server: Server, handle: rtnetlink::RouteHandle) {
    while let Some((req, respond)) = server.accept().await {
        let response = match req {
            RtnlRouteRequest::Ipv4RouteList => list_routes_v4(&handle).await,
            RtnlRouteRequest::Ipv6RouteList => list_routes_v6(&handle).await,
            RtnlRouteRequest::Ipv4RouteAdd(route) => add_route_v4(&handle, route, false).await,
            RtnlRouteRequest::Ipv4RouteReplace(route) => add_route_v4(&handle, route, true).await,
            RtnlRouteRequest::Ipv6RouteAdd(route) => add_route_v6(&handle, route, false).await,
            RtnlRouteRequest::Ipv6RouteReplace(route) => add_route_v6(&handle, route, true).await,
            RtnlRouteRequest::Ipv4RouteDel(route) => delete_route_v4(&handle, route).await,
            RtnlRouteRequest::Ipv6RouteDel(route) => delete_route_v6(&handle, route).await,
            RtnlRouteRequest::Ipv4RouteGet(destination) => get_route_v4(&handle, destination).await,
            RtnlRouteRequest::Ipv6RouteGet(destination) => get_route_v6(&handle, destination).await,
        };
        respond(response);
    }
}

fn handle_route_status(op: &str, response: RtnlRouteResponse) -> io::Result<()> {
    match response {
        RtnlRouteResponse::Success => Ok(()),
        RtnlRouteResponse::NotFound => Err(io::Error::new(
            ErrorKind::NotFound,
            format!("{}: route not found", op),
        )),
        RtnlRouteResponse::Failed => Err(io::Error::other(format!("{} failed", op))),
        RtnlRouteResponse::NotImplemented => Err(io::Error::new(
            ErrorKind::Unsupported,
            format!("{} not implemented", op),
        )),
        other => Err(io::Error::other(format!(
            "{} returned unexpected response: {:?}",
            op, other
        ))),
    }
}

async fn list_routes_v4(handle: &rtnetlink::RouteHandle) -> RtnlRouteResponse {
    let message = RouteMessageBuilder::<Ipv4Addr>::new().build();
    let stream = handle.get(message).execute();
    futures::pin_mut!(stream);
    let mut routes = Vec::new();
    loop {
        match stream.try_next().await {
            Ok(Some(msg)) => {
                if let Some(route) = decode_ipv4_route(msg) {
                    routes.push(route);
                }
            }
            Ok(None) => break,
            Err(err) => {
                warn!("Failed to list IPv4 routes: {}", err);
                return RtnlRouteResponse::Failed;
            }
        }
    }
    RtnlRouteResponse::Ipv4RouteList(routes)
}

async fn list_routes_v6(handle: &rtnetlink::RouteHandle) -> RtnlRouteResponse {
    let message = RouteMessageBuilder::<Ipv6Addr>::new().build();
    let stream = handle.get(message).execute();
    futures::pin_mut!(stream);
    let mut routes = Vec::new();
    loop {
        match stream.try_next().await {
            Ok(Some(msg)) => {
                if let Some(route) = decode_ipv6_route(msg) {
                    routes.push(route);
                }
            }
            Ok(None) => break,
            Err(err) => {
                warn!("Failed to list IPv6 routes: {}", err);
                return RtnlRouteResponse::Failed;
            }
        }
    }
    RtnlRouteResponse::Ipv6RouteList(routes)
}

async fn add_route_v4(
    handle: &rtnetlink::RouteHandle,
    route: Ipv4Route,
    replace: bool,
) -> RtnlRouteResponse {
    let message = build_ipv4_route_message(&route);
    let request = handle.add(message);
    let request = if replace { request.replace() } else { request };
    map_route_result(
        request.execute().await,
        if replace {
            "replace IPv4 route"
        } else {
            "add IPv4 route"
        },
    )
}

async fn add_route_v6(
    handle: &rtnetlink::RouteHandle,
    route: Ipv6Route,
    replace: bool,
) -> RtnlRouteResponse {
    let message = build_ipv6_route_message(&route);
    let request = handle.add(message);
    let request = if replace { request.replace() } else { request };
    map_route_result(
        request.execute().await,
        if replace {
            "replace IPv6 route"
        } else {
            "add IPv6 route"
        },
    )
}

async fn delete_route_v4(handle: &rtnetlink::RouteHandle, route: Ipv4Route) -> RtnlRouteResponse {
    let message = build_ipv4_route_message(&route);
    map_route_result(handle.del(message).execute().await, "delete IPv4 route")
}

async fn delete_route_v6(handle: &rtnetlink::RouteHandle, route: Ipv6Route) -> RtnlRouteResponse {
    let message = build_ipv6_route_message(&route);
    map_route_result(handle.del(message).execute().await, "delete IPv6 route")
}

async fn get_route_v4(handle: &rtnetlink::RouteHandle, destination: Ipv4Addr) -> RtnlRouteResponse {
    let message = RouteMessageBuilder::<Ipv4Addr>::new()
        .destination_prefix(destination, 32)
        .build();
    let stream = handle.get(message).execute();
    futures::pin_mut!(stream);
    match stream.try_next().await {
        Ok(Some(msg)) => decode_ipv4_route(msg)
            .map(RtnlRouteResponse::Ipv4Route)
            .unwrap_or(RtnlRouteResponse::NotFound),
        Ok(None) => RtnlRouteResponse::NotFound,
        Err(err) => {
            warn!("Failed to get IPv4 route: {}", err);
            RtnlRouteResponse::Failed
        }
    }
}

async fn get_route_v6(handle: &rtnetlink::RouteHandle, destination: Ipv6Addr) -> RtnlRouteResponse {
    let message = RouteMessageBuilder::<Ipv6Addr>::new()
        .destination_prefix(destination, 128)
        .build();
    let stream = handle.get(message).execute();
    futures::pin_mut!(stream);
    match stream.try_next().await {
        Ok(Some(msg)) => decode_ipv6_route(msg)
            .map(RtnlRouteResponse::Ipv6Route)
            .unwrap_or(RtnlRouteResponse::NotFound),
        Ok(None) => RtnlRouteResponse::NotFound,
        Err(err) => {
            warn!("Failed to get IPv6 route: {}", err);
            RtnlRouteResponse::Failed
        }
    }
}

fn map_route_result(result: Result<(), rtnetlink::Error>, op: &str) -> RtnlRouteResponse {
    match result {
        Ok(()) => RtnlRouteResponse::Success,
        Err(rtnetlink::Error::NetlinkError(err_msg)) => {
            let io_err = err_msg.to_io();
            match io_err.kind() {
                ErrorKind::NotFound => RtnlRouteResponse::NotFound,
                ErrorKind::AlreadyExists => {
                    warn!("Route operation failed (already exists): {}", io_err);
                    RtnlRouteResponse::Failed
                }
                _ => {
                    warn!("Route operation '{}' failed: {}", op, io_err);
                    RtnlRouteResponse::Failed
                }
            }
        }
        Err(err) => {
            warn!("Route operation '{}' failed: {}", op, err);
            RtnlRouteResponse::Failed
        }
    }
}

fn build_ipv4_route_message(route: &Ipv4Route) -> RouteMessage {
    let mut builder = RouteMessageBuilder::<Ipv4Addr>::new()
        .destination_prefix(route.route.addr(), route.route.prefix_len());

    if let Some(if_id) = route.if_id.filter(|id| *id != 0) {
        builder = builder.output_interface(if_id);
    }

    if let Some(gw) = route.gateway {
        builder = builder.gateway(gw);
    }

    if let Some(src) = route.source {
        builder = builder.pref_source(src);
    }

    if let Some(metric) = route.metric {
        builder = builder.priority(metric);
    }

    if let Some(table) = route.table {
        builder = builder.table_id(table);
    }

    builder.build()
}

fn build_ipv6_route_message(route: &Ipv6Route) -> RouteMessage {
    let mut builder = RouteMessageBuilder::<Ipv6Addr>::new()
        .destination_prefix(route.route.addr(), route.route.prefix_len());

    if let Some(if_id) = route.if_id.filter(|id| *id != 0) {
        builder = builder.output_interface(if_id);
    }

    if let Some(gw) = route.gateway {
        builder = builder.gateway(gw);
    }

    if let Some(src) = route.source {
        builder = builder.pref_source(src);
    }

    if let Some(metric) = route.metric {
        builder = builder.priority(metric);
    }

    if let Some(table) = route.table {
        builder = builder.table_id(table);
    }

    builder.build()
}

fn decode_ipv4_route(message: RouteMessage) -> Option<Ipv4Route> {
    if message.header.address_family != AddressFamily::Inet {
        return None;
    }

    let header = message.header;
    let mut destination = None;
    let mut gateway = None;
    let mut source = None;
    let mut metric = None;
    let mut table = table_from_header(header.table);
    let mut oif = None;

    for attr in message.attributes {
        match attr {
            RouteAttribute::Destination(RouteAddress::Inet(addr)) => destination = Some(addr),
            RouteAttribute::Gateway(RouteAddress::Inet(addr)) => gateway = Some(addr),
            RouteAttribute::PrefSource(RouteAddress::Inet(addr)) => source = Some(addr),
            RouteAttribute::Priority(value) => metric = Some(value),
            RouteAttribute::Oif(index) => oif = Some(index),
            RouteAttribute::Table(value) => table = Some(value),
            _ => {}
        }
    }

    let addr = destination.unwrap_or(Ipv4Addr::UNSPECIFIED);
    let net = crate::Ipv4Net::new(addr, header.destination_prefix_length).ok()?;

    Some(Ipv4Route {
        if_id: oif.filter(|id| *id != 0),
        gateway,
        source,
        metric,
        table,
        route: net,
    })
}

fn decode_ipv6_route(message: RouteMessage) -> Option<Ipv6Route> {
    if message.header.address_family != AddressFamily::Inet6 {
        return None;
    }

    let header = message.header;
    let mut destination = None;
    let mut gateway = None;
    let mut source = None;
    let mut metric = None;
    let mut table = table_from_header(header.table);
    let mut oif = None;

    for attr in message.attributes {
        match attr {
            RouteAttribute::Destination(RouteAddress::Inet6(addr)) => destination = Some(addr),
            RouteAttribute::Gateway(RouteAddress::Inet6(addr)) => gateway = Some(addr),
            RouteAttribute::PrefSource(RouteAddress::Inet6(addr)) => source = Some(addr),
            RouteAttribute::Priority(value) => metric = Some(value),
            RouteAttribute::Oif(index) => oif = Some(index),
            RouteAttribute::Table(value) => table = Some(value),
            _ => {}
        }
    }

    let addr = destination.unwrap_or(Ipv6Addr::UNSPECIFIED);
    let net = crate::Ipv6Net::new(addr, header.destination_prefix_length).ok()?;

    Some(Ipv6Route {
        if_id: oif.filter(|id| *id != 0),
        gateway,
        source,
        metric,
        table,
        route: net,
    })
}

fn table_from_header(value: u8) -> Option<u32> {
    if value == 0 { None } else { Some(value as u32) }
}