toe-beans 0.10.0

DHCP library, client, and server
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

use super::MAGIC;
use crate::v4::{MAX_MESSAGE_SIZE, MagicBuffer};
use log::trace;
use std::fmt::Debug;

/// A supertrait that defines everything a custom message
/// needs to be encoded before being sent by a socket.
pub trait Encodable: EncodeMessage + Debug {}

/// Define how your custom Message type encodes
/// itself into the bytes of a DHCP message's fields.
///
/// ...or don't and use our homemade [Message](crate::v4::message::Message)
/// with this already implemented.
///
/// If your type is in a different module you can define
/// [From or Into](https://doc.rust-lang.org/std/convert/index.html)
/// in that module and call that method in one of this trait's `encode_*`
/// methods. See Message's implementation for details.
pub trait EncodeMessage {
    /// Represent any data type as the correct amount of op field bytes.
    fn encode_op(&self) -> u8;
    /// Represent any data type as the correct amount of htype field bytes.
    fn encode_htype(&self) -> u8;
    /// Represent any data type as the correct amount of hlen field bytes.
    fn encode_hlen(&self) -> u8;
    /// Represent any data type as the correct amount of hops field bytes.
    fn encode_hops(&self) -> u8;
    /// Represent any data type as the correct amount of xid field bytes.
    fn encode_xid(&self) -> [u8; 4];
    /// Represent any data type as the correct amount of secs field bytes.
    fn encode_secs(&self) -> [u8; 2];
    /// Represent any data type as the correct amount of flags field bytes.
    fn encode_flags(&self) -> [u8; 2];
    /// Represent any data type as the correct amount of ciaddr field bytes.
    fn encode_ciaddr(&self) -> [u8; 4];
    /// Represent any data type as the correct amount of yiaddr field bytes.
    fn encode_yiaddr(&self) -> [u8; 4];
    /// Represent any data type as the correct amount of siaddr field bytes.
    fn encode_siaddr(&self) -> [u8; 4];
    /// Represent any data type as the correct amount of giaddr field bytes.
    fn encode_giaddr(&self) -> [u8; 4];
    /// Represent any data type as the correct amount of chaddr field bytes.
    fn encode_chaddr(&self) -> [u8; 16];
    /// Represent any data type as the correct amount of sname field bytes.
    fn encode_sname(&self) -> [u8; 64];
    /// Represent any data type as the correct amount of file field bytes.
    fn encode_file(&self) -> [u8; 128];
    /// Represent any data type as a variable amount of options field bytes.
    fn encode_options(&self) -> Vec<u8>;

    /// Automagically defined because its a constant
    fn encode_magic(&self) -> MagicBuffer {
        MAGIC
    }

    /// Encodes a [Message](crate::v4::Message) into a Vec of bytes
    /// by calling the encode_* methods defined in EncodeMessage,
    /// and uses a Encoder to store the output.
    fn to_bytes(&self) -> Vec<u8> {
        trace!("to_bytes");

        let mut encoder = Encoder {
            output: Vec::with_capacity(MAX_MESSAGE_SIZE),
        };

        trace!("encode op");
        encoder.encode_byte(self.encode_op());
        trace!("encode htype");
        encoder.encode_byte(self.encode_htype());
        trace!("encode hlen");
        encoder.encode_byte(self.encode_hlen());
        trace!("encode hops");
        encoder.encode_byte(self.encode_hops());
        trace!("encode xid");
        encoder.encode_bytes(&self.encode_xid());
        trace!("encode secs");
        encoder.encode_bytes(&self.encode_secs());
        trace!("encode flags");
        encoder.encode_bytes(&self.encode_flags());
        trace!("encode ciaddr");
        encoder.encode_bytes(&self.encode_ciaddr());
        trace!("encode yiaddr");
        encoder.encode_bytes(&self.encode_yiaddr());
        trace!("encode siaddr");
        encoder.encode_bytes(&self.encode_siaddr());
        trace!("encode giaddr");
        encoder.encode_bytes(&self.encode_giaddr());
        trace!("encode chaddr");
        encoder.encode_bytes(&self.encode_chaddr());
        trace!("encode sname");
        encoder.encode_bytes(&self.encode_sname());
        trace!("encode file");
        encoder.encode_bytes(&self.encode_file());
        trace!("encode magic");
        encoder.encode_bytes(&self.encode_magic());
        trace!("encode options");
        encoder.encode_bytes(self.encode_options().as_slice());

        // Automatically add the "End" option.
        encoder.encode_byte(255);

        encoder.output
    }
}

/// Keeps track of the state of the output and provides methods to add data to the output.
#[derive(Debug)]
pub struct Encoder {
    // This Vec starts empty and bytes are pushed as values are encoded.
    output: Vec<u8>,
}

// Helpers for serializing in encode methods
impl Encoder {
    #[inline]
    fn encode_bytes(&mut self, v: &[u8]) {
        trace!("encode_bytes");
        self.output.extend_from_slice(v);
    }

    #[inline]
    fn encode_byte(&mut self, v: u8) {
        trace!("encode_byte");
        self.output.push(v);
    }
}

// ---------------------------

#[cfg(test)]
mod tests {
    use std::net::Ipv4Addr;

    use super::*;
    use crate::v4::*;

    // Output additional debug info with
    // RUST_LOG=debug cargo test test_to_bytes -- --show-output
    fn init_logger() {
        let _ = env_logger::builder().is_test(true).try_init();
    }

    #[test]
    fn test_to_bytes() {
        init_logger();

        let message = Message {
            op: Ops::Request,
            htype: HTypes::Ethernet,
            hlen: 6,
            hops: 1,
            xid: 4,
            secs: 2,
            flags: Flags { broadcast: true },
            ciaddr: Ipv4Addr::new(1, 1, 1, 1),
            yiaddr: Ipv4Addr::new(1, 1, 1, 1),
            siaddr: Ipv4Addr::new(1, 1, 1, 1),
            giaddr: Ipv4Addr::new(1, 1, 1, 1),
            chaddr: [3; 16],
            sname: SName::new(c"000000000000000000000000000000000000000000000000000000000000000").unwrap(),
            file: File::new(c"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@").unwrap(),
            magic: [99, 130, 83, 99],
            options: vec![
                MessageOptions::MessageType(MessageTypes::Discover),
            ].into(),
        };

        let expected = vec![
            1, 1, 6, 1, 0, 0, 0, 4, 0, 2, 128, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
            3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48,
            48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48,
            48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48, 48,
            48, 48, 48, 48, 48, 48, 48, 48, 48, 0, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64,
            64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64,
            64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64,
            64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64,
            64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64,
            64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64,
            64, 64, 64, 64, 64, 0, 99, 130, 83, 99, 53, 1, 1, 255,
        ];

        assert_eq!(message.to_bytes(), expected);
    }
}