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