nex-packet 0.26.0

Cross-platform packet parsing and building library. Provides low-level packet handling. Part of nex project.
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

use crate::{
    ip::IpNextProtocol,
    ipv6::{Ipv6ExtensionHeader, Ipv6Header, Ipv6Packet},
    packet::Packet,
};
use bytes::Bytes;
use std::net::Ipv6Addr;

/// Builder for constructing IPv6 packets
#[derive(Debug, Clone)]
pub struct Ipv6PacketBuilder {
    packet: Ipv6Packet,
}

impl Ipv6PacketBuilder {
    /// Create a new builder
    pub fn new() -> Self {
        Self {
            packet: Ipv6Packet {
                header: Ipv6Header {
                    version: 6,
                    traffic_class: 0,
                    flow_label: 0,
                    payload_length: 0,
                    next_header: IpNextProtocol::Reserved,
                    hop_limit: 64,
                    source: Ipv6Addr::UNSPECIFIED,
                    destination: Ipv6Addr::UNSPECIFIED,
                },
                extensions: Vec::new(),
                payload: Bytes::new(),
            },
        }
    }

    pub fn source(mut self, addr: Ipv6Addr) -> Self {
        self.packet.header.source = addr;
        self
    }

    pub fn destination(mut self, addr: Ipv6Addr) -> Self {
        self.packet.header.destination = addr;
        self
    }

    pub fn traffic_class(mut self, tc: u8) -> Self {
        self.packet.header.traffic_class = tc;
        self
    }

    pub fn flow_label(mut self, label: u32) -> Self {
        self.packet.header.flow_label = label & 0x000FFFFF;
        self
    }

    pub fn hop_limit(mut self, limit: u8) -> Self {
        self.packet.header.hop_limit = limit;
        self
    }

    pub fn next_header(mut self, proto: IpNextProtocol) -> Self {
        self.packet.header.next_header = proto;
        self
    }

    pub fn extension(mut self, ext: Ipv6ExtensionHeader) -> Self {
        self.packet.extensions.push(ext);
        self
    }

    pub fn extensions(mut self, list: Vec<Ipv6ExtensionHeader>) -> Self {
        self.packet.extensions = list;
        self
    }

    pub fn payload(mut self, payload: Bytes) -> Self {
        self.packet.payload = payload;
        self
    }

    /// Build the packet and return it
    pub fn build(mut self) -> Ipv6Packet {
        let ext_len: usize = self.packet.extensions.iter().map(|e| e.len()).sum();
        self.packet.header.payload_length = (ext_len + self.packet.payload.len()) as u16;
        self.packet
    }

    /// Serialize the packet into bytes
    pub fn to_bytes(self) -> Bytes {
        self.build().to_bytes()
    }

    /// Get only the header bytes
    pub fn header_bytes(&self) -> Bytes {
        self.packet.header().slice(..)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::ip::IpNextProtocol;
    use bytes::Bytes;
    use std::net::Ipv6Addr;

    #[test]
    fn ipv6_builder_payload_len() {
        let payload = Bytes::from_static(&[1, 2, 3, 4]);
        let pkt = Ipv6PacketBuilder::new()
            .source(Ipv6Addr::LOCALHOST)
            .destination(Ipv6Addr::LOCALHOST)
            .next_header(IpNextProtocol::Tcp)
            .payload(payload.clone())
            .build();
        assert_eq!(pkt.header.payload_length, payload.len() as u16);
        assert_eq!(pkt.payload, payload);
    }
}