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