package charrua-client

  1. Overview
  2. Docs
DHCP client implementation

Install

Dune Dependency

Authors

Maintainers

Sources

charrua-v1.5.0.tbz
sha256=4ce74a5e78402f3d645ddcb344aaa1348349a8d5a35b8b55112aff0cb84db8e1
sha512=ac6960de516642793b928224c95da997042d2907829496843481894b38804e3b465b5f9703bd8c02e5202059847ee5c16db6975c630b462448db511b39f34f87

Description

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.

Tags

org:mirage

Published: 16 Dec 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 (17)

  1. lwt >= "4.0.0"
  2. tcpip >= "7.0.0"
  3. arp >= "3.0.0"
  4. ethernet >= "3.0.0"
  5. fmt
  6. logs
  7. duration
  8. mirage-net >= "3.0.0"
  9. mirage-time >= "2.0.0"
  10. mirage-clock >= "3.0.0"
  11. mirage-random >= "2.0.0"
  12. macaddr >= "4.0.0"
  13. ipaddr >= "5.0.0"
  14. cstruct >= "6.0.0"
  15. charrua = version
  16. ocaml >= "4.08.0"
  17. dune >= "1.4.0"

Dev Dependencies (4)

  1. charrua-server = version & with-test
  2. mirage-random-test with-test & >= "0.1.0"
  3. cstruct-unix with-test
  4. alcotest with-test

Used by

None

Conflicts

None