this repo has no description
anil.recoil.org
1opam-version: "2.0"
2maintainer: ["Mindy Preston"]
3authors : ["Mindy Preston"]
4homepage: "https://github.com/mirage/charrua-core"
5bug-reports: "https://github.com/mirage/charrua-core/issues"
6dev-repo: "git+https://github.com/mirage/charrua-core.git"
7tags: [ "org:mirage"]
8doc: "https://docs.mirage.io"
9
10build: [
11 ["jbuilder" "subst" "-p" name] {dev}
12 ["jbuilder" "build" "-p" name "-j" jobs]
13 ["jbuilder" "runtest" "-p" name "-j" jobs] {with-test}
14]
15depends: [
16 "ocaml" {>= "4.03.0"}
17 "jbuilder" {>= "1.0+beta9"}
18 "alcotest" {with-test}
19 "cstruct-unix" {with-test}
20 "charrua-core" {= "0.10"}
21 "cstruct" {>= "3.0.2"}
22 "ipaddr" {< "4.0.0"}
23 "mirage-random" {>= "1.0.0" & < "1.2.0"}
24]
25synopsis: "DHCP - a DHCP client, server and wire frame encoder and decoder"
26description: """
27[](http://mirage.github.io/charrua-core/api)
28[](https://travis-ci.org/mirage/charrua-core)
29
30[charrua](http://www.github.com/mirage/charrua-core) is an
31_ISC-licensed_ DHCP library implementation in OCaml.
32It provides five packages:
33
34- charrua-core: a library that handles wire traffic parsing and a server implementation
35- charrua-client: a library for handling DHCP client state and messages
36- charrua-client-lwt: a DHCP client library with timeouts and network read/write
37- charrua-client-mirage: a MirageOS-compatible set of interfaces to charrua-client-lwt
38- charrua-unix: a Unix DHCP server implementation
39
40### Charrua-core
41
42Charrua-core consists of two modules, a `Dhcp_wire` responsible for parsing and
43constructing DHCP messages and a `Dhcp_server` module used for constructing DHCP
44servers.
45
46You can browse the API for [charrua-core](http://www.github.com/mirage/charrua-core) at
47http://mirage.github.io/charrua-core/api
48
49[dhcp](https://github.com/mirage/mirage-skeleton/tree/master/applications/dhcp)
50is a Mirage DHCP unikernel server based on charrua-core, included as a part of the MirageOS unikernel example and starting-point repository.
51
52#### Features
53
54* `Dhcp_server` supports a stripped down ISC dhcpd.conf, so you can probably just
55 use your old `dhcpd.conf`. It also supports manual configuration building in
56 OCaml.
57* `Dhcp_wire` provides marshalling and unmarshalling utilities for DHCP, it is the
58 base for `Dhcp_server`.
59* Logic/sequencing is agnostic of IO and platform, so it can run on Unix as a
60 process, as a Mirage unikernel or anything else.
61* All DHCP options are supported at the time of this writing.
62* Code is purely applicative.
63* It's in OCaml, so it's pretty cool.
64
65The name `charrua` is a reference to the, now extinct, semi-nomadic people of
66southern South America.
67
68### Charrua-client
69
70charrua-client is a DHCP client powered by [charrua-core](https://github.com/haesbaert/charrua-core).
71
72The base library exposes a simple state machine in `Dhcp_client`
73for use in acquiring a DHCP lease.
74
75`charrua-client-lwt` extends `charrua-client` with a functor `Dhcp_client_lwt`,
76using the provided modules for timing and networking logic,
77for convenient use by a program which might wish to implement a full client.
78
79`charrua-client-mirage` exposes an additional `Dhcp_client_mirage` for direct use
80with the [MirageOS library operating system](https://github.com/mirage/mirage).
81
82### Charrua-unix Server
83
84charrua-unix is an _ISC-licensed_ Unix DHCP daemon based on
85[charrua-core](http://www.github.com/mirage/charrua-core).
86
87#### Features
88
89* Supports a stripped down ISC dhcpd.conf. A configuration sample can be found
90[here](https://github.com/haesbaert/charrua-core/blob/master/sample/dhcpd.conf)
91* Privilege dropping: the daemon doesn't run as root.
92* Almost purely-functional code.
93* Support for multiple interfaces/subnets.
94
95Try `charruad --help` for options.
96
97This project became one of the [Mirage Pioneer](https://github.com/mirage/mirage-www/wiki/Pioneer-Projects)
98projects."""
99url {
100 src:
101 "https://github.com/mirage/charrua-core/releases/download/v0.10/charrua-core-0.10.tbz"
102 checksum: [
103 "sha256=a596f66acba08db8108f3d448d2afabaa28e42bacf73a9c98cab271aeba70fc3"
104 "md5=3892074e768f32d2a4a5cff14e1d9f5a"
105 ]
106}