README

mirage-tcpip - an OCaml TCP/IP networking stack

mirage-tcpip provides a networking stack for theMirage operating system. It provides implementations for the following module types (which correspond with the similarly-named protocols):

• IP (via the IPv4 and IPv6 modules)

• ICMP

• UDP

• TCP

Implementations

There are two implementations of the IP, ICMP, UDP, and TCP module types - thesocket stack, and thedirect stack.

Thesocket stack

Thesocket stack uses socket calls to a traditional operating system to provide the functionality described in the module types.

See thesrc/stack-unix/ directory for the modules used as implementations of thesocket stack.

Thesocket stack is used for testing or other applications which do not expect to run as unikernels.

Thedirect stack

Thedirect stack expects to write to a device implementing theNETIF module type defined for MirageOS.

See thesrc/ directory for the modules used as implementations of thedirect stack, which is the expected stack for most MirageOS applications.

Thedirect stack is the only usable set of implementations for applications which will run as unikernels on a hypervisor target.

Community

• WWW:https://mirage.io

• E-mail:mirageos-devel@lists.xenproject.org

• Issues:https://github.com/mirage/mirage-tcpip/issues

• API docs:http://docs.mirage.io/tcpip/index.html

License

mirage-tcpip is distributed under the ISC license.

1. cmdliner>= "1.1.0"
2. metrics
3. lru>= "0.3.0"
4. macaddr-cstruct
5. ipaddr-cstruct
6. mirage-flow>= "4.0.0"
7. arp>= "4.0.0"
8. ethernet>= "3.0.0"
9. randomconv>= "0.2.0"
10. duration
11. logs>= "0.6.0"
12. lwt-dllist
13. lwt>= "4.0.0"
14. fmt>= "0.8.7"
15. macaddr-cstruct
16. macaddr>= "4.0.0"
17. ipaddr>= "5.6.0"
18. mirage-sleep>= "4.0.0"
19. mirage-crypto-rng>= "1.2.0"
20. mirage-mtime>= "4.0.0"
21. mirage-net>= "3.0.0"
22. cstruct-lwt
23. cstruct>= "6.0.0"
24. ocaml>= "4.08.0"
25. dune>= "2.7.0"

1. pcap-formatwith-test
2. alcotestwith-test & >= "1.5.0"
3. mirage-vnetifwith-test & >= "0.6.2"
4. bisect_ppxdev & >= "2.5.0"

1. arp< "0.2.0"
2. caldav
3. capnp-rpc-mirage>= "0.3.2" & < "0.6.0" | >= "0.9.0" & < "1.1" | >= "1.2.2"
4. caqti-mirage
5. charrua>= "1.5.0"
6. charrua-client>= "1.4.0" & < "1.5.0" | >= "2.0.0"
7. charrua-client-lwt>= "0.11.1" & < "0.12.0"
8. charrua-client-mirage>= "0.11.1" & < "0.12.0"
9. charrua-core>= "0.11.2"
10. charrua-server>= "1.4.0"
11. charrua-unix>= "1.4.0"
12. conduit-mirage>= "2.3.0"
13. dkim-mirage>= "0.4.0"
14. dns-certify>= "6.1.3"
15. dns-client>= "6.1.3" & < "7.0.0"
16. dns-client-mirage
17. dns-mirage>= "6.1.3"
18. dns-resolver>= "6.1.3"
19. dns-server>= "6.1.3"
20. dns-stub>= "6.1.3"
21. git-mirage>= "3.7.0"
22. git-paf>= "3.7.0"
23. git-unix>= "3.0.0"
24. happy-eyeballs-mirage>= "0.1.2"
25. http-mirage-client
26. letsencrypt-mirage
27. mehari-lwt-unix
28. mehari-mirage
29. mirage-monitoring
30. mirage-nat= "2.2.4" | >= "3.0.2"
31. mirage-protocols>= "8.0.0"
32. mirage-qubes-ipv4>= "2.0.0"
33. paf
34. paf-cohttp
35. paf-le>= "0.0.8"
36. pgx_lwt_mirage>= "2.1"
37. spoke
38. vpnkit

1. result< "1.5"
2. ocaml-freestanding
3. mirage-xen< "6.0.0"