package ipaddr

  1. Overview
  2. Docs
A library for manipulation of IP (and MAC) address representations

Install

Dune Dependency

Authors

Maintainers

Sources

ipaddr-5.3.1.tbz
sha256=9820bcbccadb6e6d9e22fe26b2f9a044897c8f47c29d157f464b41a2f191e7d4
sha512=1d400f8344d1a8c2ac1c55e4a7167484034094e2227ce7c8f2f45843b0875a83030851400ceb96b5cdb756fa8798d83c77d839705fcb9e3f2bd5e46d337d63d0

Description

Features:

  • Depends only on sexplib (conditionalization under consideration)
  • ounit2-based tests
  • IPv4 and IPv6 support
  • IPv4 and IPv6 CIDR prefix support
  • IPv4 and IPv6 CIDR-scoped address support
  • Ipaddr.V4 and Ipaddr.V4.Prefix modules are Map.OrderedType
  • Ipaddr.V6 and Ipaddr.V6.Prefix modules are Map.OrderedType
  • Ipaddr and Ipaddr.Prefix modules are Map.OrderedType
  • Ipaddr_unix in findlib subpackage ipaddr.unix provides compatibility with the standard library Unix module
  • Ipaddr_top in findlib subpackage ipaddr.top provides top-level pretty printers (requires compiler-libs default since OCaml 4.0)
  • IP address scope classification
  • IPv4-mapped addresses in IPv6 (::ffff:0:0/96) are an embedding of IPv4
  • MAC-48 (Ethernet) address support
  • Macaddr is a Map.OrderedType
  • All types have sexplib serializers/deserializers

Tags

org:mirage org:xapi-project

Published: 04 Jul 2022

README

ipaddr: IP and MAC address manipulation

A library for manipulation of IP and MAC address representations.

Features:

  • ounit2-based tests

  • IPv4 and IPv6 support

  • IPv4 and IPv6 CIDR prefix support

  • IPv4 and IPv6 CIDR-scoped address support

  • Ipaddr.V4 and Ipaddr.V4.Prefix modules are Map.OrderedType

  • Ipaddr.V6 and Ipaddr.V6.Prefix modules are Map.OrderedType

  • Ipaddr and Ipaddr.Prefix modules are Map.OrderedType

  • Ipaddr_unix in findlib subpackage ipaddr.unix provides compatibility with the standard library Unix module

  • Ipaddr_top in findlib subpackage ipaddr.top provides top-level pretty printers

  • IP address scope classification

  • IPv4-mapped addresses in IPv6 (::ffff:0:0/96) are an embedding of IPv4

  • MAC-48 (Ethernet) address support

  • Macaddr is a Map.OrderedType

  • All types have sexplib serializers/deserializers optionally via the Ipaddr_sexp and Macaddr_sexp libraries.

Usage

There are the following opam packages included:

  • ipaddr: the Ipaddr and associated modules

  • ipaddr-sexp

  • ipaddr-cstruct

  • macaddr: the Macaddr and associated modules.

  • macaddr-sexp

  • macaddr-cstruct

There are the following ocamlfind libraries included as part of this repository, included as part of the respective opam packages.

  • ipaddr: The Ipaddr module for IPv4/6 manipulation.

  • ipaddr.top: Toplevel printers for Ipaddr.

  • ipaddr-cstruct: The Ipaddr_cstruct module

  • macaddr: The Macaddr module for MAC address manipulation.

  • macaddr.top: Toplevel printers for Macaddr.

  • macaddr-cstruct: The Macaddr_cstruct module

  • ipaddr-sexp: S-expression converters for Ipaddr.

  • macaddr-sexp: S-expression converters for Macaddr.

Installation and development

The packages are released to the opam-repository. An opam install ipaddr (or any other above mentioned package) will install it. If you want to install the latest development commit, opam pin add ipaddr --dev will do this.

A local build, after a git clone can be done with dune build, a dune runtest compiles and executes the testsuite. If dependencies are missing, opam install (-t) --deps-only . in the cloned directory will install them.

The auto-formatter ocamlformat is used, please execute dune build @fmt --auto-promote before submitting a pull request.

Contact

Dependencies (4)

  1. domain-name >= "0.3.0"
  2. macaddr = version
  3. dune >= "1.9.0"
  4. ocaml >= "4.08.0"

Dev Dependencies (2)

  1. ppx_sexp_conv with-test & >= "v0.9.0"
  2. ounit2 with-test

Used by (98)

  1. albatross
  2. arp >= "2.1.0"
  3. builder-web
  4. caqti >= "2.0.1"
  5. caqti-async >= "2.1.1"
  6. caqti-driver-pgx >= "2.1.1"
  7. caqti-lwt >= "2.1.1"
  8. caqti-mirage >= "2.1.1"
  9. charrua >= "1.2.2"
  10. charrua-client >= "1.1.0"
  11. charrua-client-lwt >= "0.11.1"
  12. charrua-client-mirage
  13. charrua-server < "1.1.0" | >= "1.2.2"
  14. charrua-unix = "0.6" | >= "1.4.0"
  15. cohttp-async >= "3.0.0"
  16. colombe
  17. conduit >= "1.5.0"
  18. conduit-async >= "1.4.0" & != "3.0.0"
  19. conduit-lwt-unix >= "1.5.0"
  20. conduit-mirage != "3.0.0"
  21. corosync
  22. current-albatross-deployer
  23. dkim >= "0.2.0"
  24. dns >= "0.8.0" & < "0.10.0" | >= "1.1.3"
  25. dns-cli
  26. dns-client < "7.0.0"
  27. dns-client-lwt
  28. dns-client-miou-unix
  29. dns-client-mirage
  30. dns-mirage
  31. eliom >= "4.0.0"
  32. emile
  33. frenetic >= "3.2.0"
  34. git >= "3.0.0"
  35. git-mirage >= "3.0.0"
  36. git-paf
  37. git-unix >= "3.0.0"
  38. happy-eyeballs
  39. happy-eyeballs-lwt
  40. happy-eyeballs-mirage
  41. ip2location
  42. ipaddr-cstruct = "5.3.1"
  43. ipaddr-sexp = "5.3.1"
  44. irmin-client
  45. jitsu
  46. learn-ocaml >= "0.12" & < "0.14.0"
  47. learn-ocaml-client < "0.13.0"
  48. mbr-format < "1.0.0"
  49. mehari-mirage
  50. metrics-mirage
  51. miou
  52. mirage >= "0.10.0" & < "2.9.0" | >= "3.8.0"
  53. mirage-block-xen >= "1.1.0" & < "2.0.0"
  54. mirage-bootvar-xen < "0.4.0"
  55. mirage-conduit >= "3.2.0"
  56. mirage-console-xen-cli
  57. mirage-entropy-unix < "0.2.0"
  58. mirage-entropy-xen < "0.2.0"
  59. mirage-nat < "1.2.0" | >= "2.2.2"
  60. mirage-net-fd
  61. mirage-net-xen >= "2.1.4"
  62. mirage-protocols >= "4.0.0"
  63. mirage-protocols-lwt >= "1.4.1"
  64. mirage-qubes-ipv4 >= "0.6.1"
  65. mirage-runtime >= "3.8.0" & < "4.5.0"
  66. mirage-stack-lwt
  67. mirage-types-lwt < "3.7.1"
  68. mirage-unix >= "0.9.4" & < "0.9.9"
  69. mirage-vnetif >= "0.4.1"
  70. mirage-vnetif-stack
  71. mirage-www >= "1.1.0"
  72. mirage-xen >= "0.9.5" & < "0.9.9"
  73. mirari >= "0.9.6"
  74. mrmime
  75. mrt-format >= "0.3.0"
  76. nanomsg
  77. netchannel >= "1.8.1"
  78. ocsigenserver >= "2.4.0"
  79. octez-libs
  80. paf >= "0.0.2" & < "0.0.4"
  81. paf-cohttp
  82. pcap-format = "0.4.0"
  83. pf-qubes
  84. pgx >= "1.0"
  85. piaf >= "0.2.0"
  86. sendmail-lwt >= "0.10.0"
  87. tcpip >= "3.6.0" & < "8.1.0"
  88. tezos-base >= "8.0"
  89. tezos-stdlib-unix
  90. tls >= "0.15.0"
  91. tuntap >= "2.0.0"
  92. uspf
  93. vchan >= "0.9.6" & < "2.0.0"
  94. vhd-format >= "0.7.0" & < "0.9.1"
  95. vpnkit
  96. websocket-lwt
  97. x509 = "0.7.0" | >= "0.15.0"
  98. xentropyd

Conflicts

None

OCaml

Innovation. Community. Security.