package charrua-server

  1. Overview
  2. Docs
DHCP server

Install

Dune Dependency

Authors

Maintainers

Sources

charrua-v1.4.1.tbz
sha256=39545b2b8c70df937fcb701b4d80aa52cf95a89ab96fed8e4422e52e9a97f979
sha512=6e399ab93f7306df1a96fb6690545de241cac2db93540d42c6ae08d9ba149a83061cb21a7bd7a2735fe7a8363c21a55773acbf969484c675e956257888a67f4f

Description

Charrua-server consists of a single Dhcp_server module used for constructing DHCP servers.

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

Features

  • Dhcp_server supports a stripped down ISC dhcpd.conf, so you can probably just use your old dhcpd.conf. It also supports manual configuration building in OCaml.
  • 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.

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

Published: 27 Oct 2021

README

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

charrua is an ISC-licensed DHCP library implementation in OCaml. It provides the following 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-unix: a Unix DHCP server implementation

Charrua

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

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

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

Features
  • Dhcp_wire provides marshalling and unmarshalling utilities for DHCP, it is the base for Dhcp_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 module Dhcp_server supports a stripped down ISC dhcpd.conf, so you can probably just use your old dhcpd.conf. It also supports manual configuration building in OCaml.

dhcp is a MirageOS 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 by charrua.

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

charrua-client-lwt extends charrua-client with a functor Dhcp_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 additional Dhcp_client_mirage for direct use with the MirageOS library operating system.

Charrua-unix Server

charrua-unix is an ISC-licensed Unix DHCP daemon based on charrua.

Features
  • Supports a stripped down ISC dhcpd.conf. A configuration sample can be found here

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

  • Almost purely-functional code.

  • Support for multiple interfaces/subnets.

Try charruad --help for options.

This project became one of the Mirage Pioneer projects.

Dependencies (11)

  1. macaddr-sexp
  2. ipaddr-sexp
  3. macaddr >= "4.0.0"
  4. ipaddr >= "5.0.0"
  5. sexplib
  6. cstruct >= "6.0.0"
  7. charrua = version
  8. menhir build & >= "20180523"
  9. ppx_sexp_conv >= "v0.9.0"
  10. dune >= "1.4.0"
  11. ocaml >= "4.08.0"

Dev Dependencies (4)

  1. alcotest with-test & >= "1.4.0"
  2. tcpip >= "6.1.0" & with-test
  3. ppx_cstruct >= "6.0.0" & with-test
  4. cstruct-unix with-test

Used by (2)

  1. charrua-client = "1.0.0" | = "1.4.1"
  2. charrua-unix = "1.4.1"

Conflicts

None