package charrua-client-lwt

  1. Overview
  2. Docs
A DHCP client using lwt as effectful layer

Install

Dune Dependency

Authors

Maintainers

Sources

charrua-v1.2.1.tbz
sha256=6c995afe52064abe012d06e850ada455b66e2c363d2ee093c4e4c8411b3a68ed
sha512=8e973b7aded4d6e9fb3c775b123c835c9f302af4ca990d20d7de49cdc8081a0ecc5252faeb6080732909fa1406f5b05048f8d1d039348f64db3c3440f6f55f79

Description

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.

Tags

org:mirage

Published: 12 May 2020

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 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 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 (13)

  1. lwt >= "4.0.0"
  2. fmt
  3. logs
  4. mirage-net >= "3.0.0"
  5. mirage-time >= "2.0.0"
  6. duration
  7. mirage-random >= "2.0.0" & < "4.0.0"
  8. ipaddr >= "4.0.0"
  9. cstruct >= "3.0.2"
  10. charrua-client = version
  11. charrua = version
  12. ocaml >= "4.06.0"
  13. dune >= "1.4.0"

Dev Dependencies (2)

  1. cstruct-unix with-test
  2. alcotest with-test

Used by (1)

  1. charrua-client-mirage = "0.12.0" | = "1.2.1"

Conflicts

None