README

Charrua DHCP - a DHCP client, server and wire frame encoder and decoder

charrua is anISC-licensed DHCP library implementation in OCaml. It provides five packages:

• charrua: a library that handles wire traffic parsing

• charrua-server: a DHCP server implementation

• charrua-client: a library for handling DHCP client state and messages

• charrua-client-lwt: a DHCP client library with timeouts and network read/write

• charrua-client-mirage: a MirageOS-compatible set of interfaces to charrua-client-lwt

• charrua-unix: a Unix DHCP server implementation

Charrua

The namecharrua is a reference to the, now extinct, semi-nomadic people of southern South America.

Charrua consists of the single moduleDhcp_wire responsible for parsing and constructing DHCP messages,

You can browse the API forcharrua at https://mirage.github.io/charrua/

Features

• Dhcp_wire provides marshalling and unmarshalling utilities for DHCP, it is the base forDhcp_server.

• Logic/sequencing is agnostic of IO and platform, so it can run on Unix as a process, as a Mirage unikernel or anything else.

• All DHCP options are supported at the time of this writing.

• Code is purely applicative.

• It's in OCaml, so it's pretty cool.

Charrua-server

The moduleDhcp_server supports a stripped down ISCdhcpd.conf, so you can probably just use your olddhcpd.conf. It also supports manual configuration building in OCaml.

dhcp is aMirageOS DHCP unikernel server based on charrua, included as a part of the MirageOS unikernel example and starting-point repository.

Charrua-client

charrua-client is a DHCP client powered bycharrua.

The base library exposes a simple state machine inDhcp_client for use in acquiring a DHCP lease.

charrua-client-lwt extendscharrua-client with a functorDhcp_client_lwt, using the provided modules for timing and networking logic, for convenient use by a program which might wish to implement a full client.

charrua-client-mirage exposes an additionalDhcp_client_mirage for direct use with theMirageOS library operating system.

Charrua-unix Server

charrua-unix is anISC-licensed Unix DHCP daemon based oncharrua.

Features

• Supports a stripped down ISC dhcpd.conf. A configuration sample can be foundhere

• Privilege dropping: the daemon doesn't run as root.

• Almost purely-functional code.

• Support for multiple interfaces/subnets.

Trycharruad --help for options.

This project became one of theMirage Pioneer projects.

1. lwt>= "4.0.0"
2. logs
3. mirage-protocols>= "4.0.0" & < "5.0.0"
4. mirage-net>= "3.0.0"
5. mirage-time>= "2.0.0"
6. mirage-clock>= "3.0.0"
7. mirage-random>= "2.0.0" & < "4.0.0"
8. ipaddr>= "5.0.0"
9. charrua-client-lwt= version
10. ocaml>= "4.06.0"
11. dune>= "1.4.0"

None

1. vpnkit

None