libcontainer 0.6.0

Library for container control
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
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
use std::net::{IpAddr, Ipv4Addr};

use netlink_packet_core::{
    NLM_F_ACK, NLM_F_CREATE, NLM_F_DUMP, NLM_F_EXCL, NLM_F_REQUEST, NetlinkMessage, NetlinkPayload,
};
use netlink_packet_route::address::{AddressAttribute, AddressMessage};
use netlink_packet_route::{AddressFamily, RouteNetlinkMessage};

use crate::network::traits::{Client, NetlinkMessageHandler};
use crate::network::wrapper::ClientWrapper;
use crate::network::{NetlinkResponse, NetworkError, Result};

/// Handler for Address messages in Netlink communication.
///
/// This handler processes Netlink messages related to network addresses
/// and converts them into AddressMessage responses.
pub struct AddressMessageHandler {
    target_index: Option<u32>,
}

impl AddressMessageHandler {
    pub fn new() -> Self {
        Self { target_index: None }
    }

    pub fn with_index(index: u32) -> Self {
        Self {
            target_index: Some(index),
        }
    }
}

impl Default for AddressMessageHandler {
    fn default() -> Self {
        Self::new()
    }
}

impl NetlinkMessageHandler for AddressMessageHandler {
    type Response = AddressMessage;

    fn handle_payload(
        &self,
        payload: NetlinkPayload<RouteNetlinkMessage>,
    ) -> Result<NetlinkResponse<Self::Response>> {
        match payload {
            NetlinkPayload::InnerMessage(RouteNetlinkMessage::NewAddress(addr)) => {
                if let Some(target_index) = self.target_index {
                    if addr.header.index == target_index {
                        Ok(NetlinkResponse::Success(addr))
                    } else {
                        Ok(NetlinkResponse::None)
                    }
                } else {
                    Ok(NetlinkResponse::Success(addr))
                }
            }
            NetlinkPayload::Error(e) => match e.code {
                None => Ok(NetlinkResponse::Success(AddressMessage::default())),
                Some(code) => Ok(NetlinkResponse::Error(code.get())),
            },
            NetlinkPayload::Done(_) => Ok(NetlinkResponse::Done),
            _ => Err(NetworkError::IO(std::io::Error::other(format!(
                "Unexpected message type: {:?}",
                payload
            )))),
        }
    }
}

/// Client for managing network addresses.
///
/// This client provides methods for querying and modifying network address properties
/// through Netlink communication.
pub struct AddressClient {
    client: ClientWrapper,
}

impl AddressClient {
    /// Creates a new AddressClient instance.
    ///
    /// # Returns
    ///
    /// A Result containing either a new AddressClient or an IO error
    pub fn new(client: ClientWrapper) -> Result<Self> {
        Ok(Self { client })
    }

    /// Retrieves all addresses associated with a network interface.
    ///
    /// # Arguments
    ///
    /// * `index` - The index of the network interface
    ///
    /// # Returns
    ///
    /// A Result containing either a vector of AddressMessages or an error
    pub fn get_by_index(&mut self, index: u32) -> Result<Vec<AddressMessage>> {
        let mut message = AddressMessage::default();
        message.header.index = index;
        let mut req = NetlinkMessage::from(RouteNetlinkMessage::GetAddress(message));
        // NLM_F_REQUEST: This is a request to the kernel
        // NLM_F_DUMP: Request a dump of all matching entries
        req.header.flags = NLM_F_REQUEST | NLM_F_DUMP;
        req.finalize();

        let handler = AddressMessageHandler::with_index(index);

        self.client.send_and_receive_multiple(&req, handler)
    }

    /// Adds a new address to a network interface.
    ///
    /// # Arguments
    ///
    /// * `index` - The index of the network interface
    /// * `address` - The IP address to add
    /// * `prefix_len` - The prefix length of the address
    ///
    /// # Returns
    ///
    /// A Result indicating success or failure of the operation
    pub fn add(&mut self, index: u32, address: IpAddr, prefix_len: u8) -> Result<()> {
        let message = self.create_address_request(index, address, prefix_len)?;

        let mut req = NetlinkMessage::from(RouteNetlinkMessage::NewAddress(message));
        // NLM_F_REQUEST: This is a request to the kernel
        // NLM_F_ACK: Request an acknowledgment from the kernel
        // NLM_F_EXCL: Fail if the address already exists
        // NLM_F_CREATE: Create the address if it doesn't exist
        req.header.flags = NLM_F_REQUEST | NLM_F_ACK | NLM_F_EXCL | NLM_F_CREATE;
        req.finalize();

        let handler = AddressMessageHandler::new();

        self.client.send_and_receive(&req, handler)?;
        Ok(())
    }

    /// Creates an address request message.
    ///
    /// # Arguments
    ///
    /// * `index` - The index of the network interface
    /// * `address` - The IP address to add
    /// * `prefix_len` - The prefix length of the address
    ///
    /// # Returns
    ///
    /// A Result containing either the created AddressMessage or an error
    /// ref: https://github.com/rust-netlink/rtnetlink/blob/v0.17.0/src/addr/add.rs#L27-L73
    fn create_address_request(
        &self,
        index: u32,
        address: IpAddr,
        prefix_len: u8,
    ) -> Result<AddressMessage> {
        let mut message = AddressMessage::default();
        message.header.prefix_len = prefix_len;
        message.header.index = index;
        message.header.family = match address {
            IpAddr::V4(_) => AddressFamily::Inet,
            IpAddr::V6(_) => AddressFamily::Inet6,
        };

        if address.is_multicast() {
            if let IpAddr::V6(a) = address {
                message.attributes.push(AddressAttribute::Multicast(a));
            }
        } else {
            message.attributes.push(AddressAttribute::Address(address));
            message.attributes.push(AddressAttribute::Local(address));

            if let IpAddr::V4(a) = address {
                if prefix_len == 32 {
                    message.attributes.push(AddressAttribute::Broadcast(a));
                } else {
                    let ip_addr = u32::from(a);
                    let brd =
                        Ipv4Addr::from(((0xffff_ffff_u32) >> u32::from(prefix_len)) | ip_addr);
                    message.attributes.push(AddressAttribute::Broadcast(brd));
                };
            }
        }

        Ok(message)
    }

    #[cfg(test)]
    /// Test method to get send calls from the fake client
    pub fn get_send_calls(
        &self,
    ) -> Option<&[netlink_packet_core::NetlinkMessage<RouteNetlinkMessage>]> {
        if let ClientWrapper::Fake(fake_client) = &self.client {
            Some(fake_client.get_send_calls())
        } else {
            None
        }
    }
}

#[cfg(test)]
mod tests {
    use serial_test::serial;

    use super::*;
    use crate::network::fake::FakeNetlinkClient;
    use crate::network::wrapper::create_network_client;

    #[test]
    #[serial]
    fn test_address_message_handler_success() {
        let handler = AddressMessageHandler::new();
        let mut addr_msg = AddressMessage::default();
        addr_msg.header.index = 1;
        addr_msg
            .attributes
            .push(AddressAttribute::Address(IpAddr::V4(Ipv4Addr::new(
                192, 168, 1, 1,
            ))));

        let payload =
            NetlinkPayload::InnerMessage(RouteNetlinkMessage::NewAddress(addr_msg.clone()));
        let result = handler.handle_payload(payload);

        assert!(result.is_ok());
        match result.unwrap() {
            NetlinkResponse::Success(response) => {
                assert_eq!(response.header.index, 1);
                assert_eq!(response.attributes.len(), 1);
            }
            _ => panic!("Expected Success response"),
        }
    }

    #[test]
    #[serial]
    fn test_address_message_handler_errorcode_zero() {
        let handler = AddressMessageHandler::new();
        let mut error_msg = netlink_packet_core::ErrorMessage::default();
        error_msg.code = std::num::NonZeroI32::new(0);
        let error_payload = NetlinkPayload::Error(error_msg);
        let result = handler.handle_payload(error_payload);

        assert!(result.is_ok());
        match result.unwrap() {
            NetlinkResponse::Success(_) => {}
            _ => panic!("Expected Success response"),
        }
    }

    #[test]
    #[serial]
    fn test_address_message_handler_error() {
        let handler = AddressMessageHandler::new();
        let mut error_msg = netlink_packet_core::ErrorMessage::default();
        error_msg.code = std::num::NonZeroI32::new(1);
        let error_payload = NetlinkPayload::Error(error_msg);
        let result = handler.handle_payload(error_payload);

        assert!(result.is_ok());
        match result.unwrap() {
            NetlinkResponse::Error(code) => {
                assert_eq!(code, 1);
            }
            _ => panic!("Expected Error response"),
        }
    }

    #[test]
    #[serial]
    fn test_address_message_handler_done() {
        let handler = AddressMessageHandler::new();
        let done_payload = NetlinkPayload::Done(netlink_packet_core::DoneMessage::default());
        let result = handler.handle_payload(done_payload);

        assert!(result.is_ok());
        match result.unwrap() {
            NetlinkResponse::Done => {}
            _ => panic!("Expected Done response"),
        }
    }

    #[test]
    #[serial]
    fn test_address_message_handler_unexpected() {
        let handler = AddressMessageHandler::new();
        let unexpected_payload = NetlinkPayload::InnerMessage(RouteNetlinkMessage::NewLink(
            netlink_packet_route::link::LinkMessage::default(),
        ));
        let result = handler.handle_payload(unexpected_payload);

        assert!(result.is_err());
    }

    #[test]
    #[serial]
    fn test_address_client_new() {
        let result = AddressClient::new(create_network_client());
        assert!(result.is_ok());
    }

    #[test]
    #[serial]
    fn test_address_client_get_by_index_failure() {
        let mut fake_client = FakeNetlinkClient::new();
        fake_client.set_failure("Get by index failed".to_string());

        let mut addr_client = AddressClient::new(ClientWrapper::Fake(fake_client)).unwrap();
        let result = addr_client.get_by_index(1);

        assert!(result.is_err());
    }

    #[test]
    #[serial]
    fn test_address_client_get_by_index_without_response() {
        let fake_client = FakeNetlinkClient::new();
        let mut addr_client = AddressClient::new(ClientWrapper::Fake(fake_client)).unwrap();
        let result = addr_client.get_by_index(1);

        // Should failed without response
        assert!(result.is_ok());
    }

    #[test]
    #[serial]
    fn test_address_client_get_by_index_with_multiple_responses() {
        let mut fake_client = FakeNetlinkClient::new();

        // Set up multiple responses
        let mut addr1 = AddressMessage::default();
        addr1.header.index = 1;
        addr1
            .attributes
            .push(AddressAttribute::Address(IpAddr::V4(Ipv4Addr::new(
                192, 168, 1, 1,
            ))));

        let mut addr2 = AddressMessage::default();
        addr2.header.index = 1;
        addr2
            .attributes
            .push(AddressAttribute::Address(IpAddr::V4(Ipv4Addr::new(
                192, 168, 1, 2,
            ))));

        let responses = vec![
            RouteNetlinkMessage::NewAddress(addr1),
            RouteNetlinkMessage::NewAddress(addr2),
        ];
        fake_client.set_expected_responses(responses);

        let mut addr_client = AddressClient::new(ClientWrapper::Fake(fake_client)).unwrap();
        let result = addr_client.get_by_index(1);

        // Should succeed with multiple responses
        assert!(result.is_ok());
        let responses = result.unwrap();
        assert_eq!(responses.len(), 2);
        assert_eq!(responses[0].header.index, 1);
        assert_eq!(responses[1].header.index, 1);
    }

    #[test]
    #[serial]
    fn test_address_client_get_by_index_success() {
        let mut fake_client = FakeNetlinkClient::new();

        let responses = vec![RouteNetlinkMessage::NewAddress(AddressMessage::default())];
        fake_client.set_expected_responses(responses);

        let client_wrapper = ClientWrapper::Fake(fake_client);
        let mut addr_client = AddressClient::new(client_wrapper).unwrap();

        let result = addr_client.get_by_index(42);
        assert!(result.is_ok());

        // Verify the call was tracked
        if let Some(send_calls) = addr_client.get_send_calls() {
            assert_eq!(send_calls.len(), 1);

            // Verify the message details
            if let NetlinkPayload::InnerMessage(RouteNetlinkMessage::GetAddress(addr)) =
                &send_calls[0].payload
            {
                assert_eq!(addr.header.index, 42);
            } else {
                panic!("Expected GetAddress message");
            }

            // Verify the netlink flags
            let expected_flags = NLM_F_REQUEST | NLM_F_DUMP;
            assert_eq!(send_calls[0].header.flags, expected_flags);
        } else {
            panic!("Expected Fake client");
        }
    }

    #[test]
    #[serial]
    fn test_address_client_add_failure() {
        let mut fake_client = FakeNetlinkClient::new();
        fake_client.set_failure("Add address failed".to_string());

        let mut addr_client = AddressClient::new(ClientWrapper::Fake(fake_client)).unwrap();
        let result = addr_client.add(1, IpAddr::V4(Ipv4Addr::new(192, 168, 1, 1)), 24);

        assert!(result.is_err());
    }

    #[test]
    #[serial]
    fn test_address_client_add_success() {
        let mut fake_client = FakeNetlinkClient::new();

        let responses = vec![RouteNetlinkMessage::NewAddress(AddressMessage::default())];
        fake_client.set_expected_responses(responses);

        let client_wrapper = ClientWrapper::Fake(fake_client);
        let mut addr_client = AddressClient::new(client_wrapper).unwrap();

        let result = addr_client.add(42, IpAddr::V4(Ipv4Addr::new(10, 0, 0, 1)), 16);
        assert!(result.is_ok());

        // Verify the call was tracked
        if let Some(send_calls) = addr_client.get_send_calls() {
            assert_eq!(send_calls.len(), 1);

            // Verify the message details
            if let NetlinkPayload::InnerMessage(RouteNetlinkMessage::NewAddress(addr)) =
                &send_calls[0].payload
            {
                assert_eq!(addr.header.index, 42);
                assert_eq!(addr.header.prefix_len, 16);
                assert_eq!(addr.header.family, AddressFamily::Inet);
                assert_eq!(addr.attributes.len(), 3); // Address, Local, Broadcast

                // Check for Address attribute
                let mut found_address = false;
                for attr in &addr.attributes {
                    if let AddressAttribute::Address(ip) = attr {
                        assert_eq!(*ip, IpAddr::V4(Ipv4Addr::new(10, 0, 0, 1)));
                        found_address = true;
                        break;
                    }
                }
                assert!(found_address, "Address attribute not found");
            } else {
                panic!("Expected NewAddress message");
            }

            // Verify the netlink flags
            let expected_flags = NLM_F_REQUEST | NLM_F_ACK | NLM_F_EXCL | NLM_F_CREATE;
            assert_eq!(send_calls[0].header.flags, expected_flags);
        } else {
            panic!("Expected Fake client");
        }
    }

    #[test]
    #[serial]
    fn test_address_client_add_with_different_parameters() {
        let mut fake_client = FakeNetlinkClient::new();
        let test_cases = vec![
            (1, IpAddr::V4(Ipv4Addr::new(192, 168, 1, 1)), 24),
            (10, IpAddr::V4(Ipv4Addr::new(10, 0, 0, 1)), 16),
            (
                100,
                IpAddr::V6(std::net::Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 1)),
                64,
            ),
        ];
        let responses: Vec<_> = test_cases
            .iter()
            .map(|(index, address, prefix_len)| {
                let mut msg = AddressMessage::default();
                msg.header.index = *index;
                msg.header.prefix_len = *prefix_len;
                msg.header.family = match address {
                    IpAddr::V4(_) => AddressFamily::Inet,
                    IpAddr::V6(_) => AddressFamily::Inet6,
                };
                msg.attributes.push(AddressAttribute::Address(*address));
                msg.attributes.push(AddressAttribute::Local(*address));
                if let IpAddr::V4(a) = address {
                    msg.attributes.push(AddressAttribute::Broadcast(*a));
                }
                RouteNetlinkMessage::NewAddress(msg)
            })
            .collect();
        fake_client.set_expected_responses(responses);

        let client_wrapper = ClientWrapper::Fake(fake_client);
        let mut addr_client = AddressClient::new(client_wrapper).unwrap();

        // Test with different parameters
        let test_cases_clone = test_cases.clone();

        for (index, address, prefix_len) in test_cases {
            let result = addr_client.add(index, address, prefix_len);
            assert!(
                result.is_ok(),
                "add failed for index {}, address {:?}, prefix_len {}",
                index,
                address,
                prefix_len
            );
        }

        // Verify all calls were tracked
        if let Some(send_calls) = addr_client.get_send_calls() {
            assert_eq!(send_calls.len(), test_cases_clone.len());

            for (i, (index, address, prefix_len)) in test_cases_clone.iter().enumerate() {
                if let NetlinkPayload::InnerMessage(RouteNetlinkMessage::NewAddress(addr)) =
                    &send_calls[i].payload
                {
                    assert_eq!(addr.header.index, *index);
                    assert_eq!(addr.header.prefix_len, *prefix_len);

                    // Check address family
                    let expected_family = match address {
                        IpAddr::V4(_) => AddressFamily::Inet,
                        IpAddr::V6(_) => AddressFamily::Inet6,
                    };
                    assert_eq!(addr.header.family, expected_family);

                    // Check for Address attribute
                    let mut found_address = false;
                    for attr in &addr.attributes {
                        if let AddressAttribute::Address(ip) = attr {
                            assert_eq!(*ip, *address);
                            found_address = true;
                            break;
                        }
                    }
                    assert!(
                        found_address,
                        "Address attribute not found for index {}",
                        index
                    );
                } else {
                    panic!("Expected NewAddress message for index {}", index);
                }
            }
        } else {
            panic!("Expected Fake client");
        }
    }

    #[test]
    #[serial]
    fn test_create_address_request_ipv4() {
        let addr_client = AddressClient::new(create_network_client()).unwrap();
        let result =
            addr_client.create_address_request(1, IpAddr::V4(Ipv4Addr::new(192, 168, 1, 1)), 24);

        assert!(result.is_ok());
        let message = result.unwrap();
        assert_eq!(message.header.index, 1);
        assert_eq!(message.header.prefix_len, 24);
        assert_eq!(message.header.family, AddressFamily::Inet);
        assert_eq!(message.attributes.len(), 3); // Address, Local, Broadcast
    }

    #[test]
    #[serial]
    fn test_create_address_request_ipv6() {
        let addr_client = AddressClient::new(create_network_client()).unwrap();
        let result = addr_client.create_address_request(
            1,
            IpAddr::V6(std::net::Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 1)),
            64,
        );

        assert!(result.is_ok());
        let message = result.unwrap();
        assert_eq!(message.header.index, 1);
        assert_eq!(message.header.prefix_len, 64);
        assert_eq!(message.header.family, AddressFamily::Inet6);
        assert_eq!(message.attributes.len(), 2); // Address, Local
    }
}