Lib.rs

› Network programming | Parser implementations
#dhcp-server #dhcp #message-parser #dhcpv6 #dhcpv4 #codec

dhcproto

A DHCP parser and encoder for DHCPv4/DHCPv6. dhcproto aims to be a functionally complete DHCP implementation.

by Evan Cameron and 10 contributors

13 releases (breaking)

0.12.0 Jun 7, 2024
0.11.0 Nov 6, 2023
0.10.0 Sep 29, 2023
0.9.0 Mar 6, 2023
0.1.0 Jul 15, 2021

#102 in Network programming

Download history 6604/week @ 2024-08-18 8081/week @ 2024-08-25 4800/week @ 2024-09-01 4792/week @ 2024-09-08 4790/week @ 2024-09-15 6413/week @ 2024-09-22 6073/week @ 2024-09-29 4949/week @ 2024-10-06 5653/week @ 2024-10-13 5077/week @ 2024-10-20 5092/week @ 2024-10-27 5213/week @ 2024-11-03 4212/week @ 2024-11-10 4386/week @ 2024-11-17 3337/week @ 2024-11-24 3139/week @ 2024-12-01

15,630 downloads per month
Used in 6 crates (4 directly)

MIT license

235KB
5K SLoC

dhcproto

A DHCP parser and encoder for DHCPv4/DHCPv6. dhcproto aims to be a functionally complete DHCP implementation. Many common option types are implemented, PRs are welcome to flesh out missing types.

Attention! We are developing a DHCP server using this library called dora!

features

  • v4 is 100% safe rust (v6 uses get_unchecked after bounds have been checked)
  • v4 & v6 Message types
  • v4 & v6 message header getters/setters, all data mutable
  • option types with 100's of fully type safe variants (accepting PR's for unknown variants)
  • Long option encoding supported (RFC 3396) (allows encoding options longer than 255 bytes)
  • benchmarked encoding/decoding

crates.io

https://crates.io/crates/dhcproto

Minimum Rust Version

This crate uses const generics, Rust 1.53 is required

Examples

(v4) Decoding/Encoding

use dhcproto::v4::{Message, Encoder, Decoder, Decodable, Encodable};
// decode
let bytes = dhcp_offer();
let msg = Message::decode(&mut Decoder::new(&bytes))?;
// now encode
let mut buf = Vec::new();
let mut e = Encoder::new(&mut buf);
msg.encode(&mut e)?;

(v4) Constructing messages

use dhcproto::{v4, Encodable, Encoder};
// hardware addr
let chaddr = vec![
    29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
];
// construct a new Message
let mut msg = v4::Message::default();
msg.set_flags(v4::Flags::default().set_broadcast()) // set broadcast to true
    .set_chaddr(&chaddr) // set chaddr
    .opts_mut()
    .insert(v4::DhcpOption::MessageType(v4::MessageType::Discover)); // set msg type

// set some more options
msg.opts_mut()
    .insert(v4::DhcpOption::ParameterRequestList(vec![
        v4::OptionCode::SubnetMask,
        v4::OptionCode::Router,
        v4::OptionCode::DomainNameServer,
        v4::OptionCode::DomainName,
    ]));
msg.opts_mut()
    .insert(v4::DhcpOption::ClientIdentifier(chaddr));

// now encode to bytes
let mut buf = Vec::new();
let mut e = Encoder::new(&mut buf);
msg.encode(&mut e)?;
// buf now has the contents of the encoded DHCP message

RFCs supported

DHCPv6:

DHCPv4:

Dependencies

~8MB
~151K SLoC