package ipaddr

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

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (5)

Authors

  1. D
    David Sheets
  2. A
    Anil Madhavapeddy
  3. H
    Hugo Heuzard

Maintainers

  1. A
    anil@recoil.org

Sources

ipaddr-5.6.1.tbz
sha256=1e617df8abd45843c823e9be75267d27426cb578661cf25622d50b25ae14a319
sha512=09c37f963d27f697ee17b83f26364002cc2e60516c2199f78cd20663aaf293a1ce4380d728641b4c9b79066dc814c8f9293722a567ce6898261c4e98b34d80c2

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: 03 Aug 2025

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 (81)

  1. albatross
  2. arp
  3. builder-web
  4. capnp-rpc-unix >= "2.1"
  5. caqti >= "2.0.1"
  6. caqti-async >= "2.1.1"
  7. caqti-driver-pgx >= "2.1.1"
  8. caqti-lwt >= "2.1.1"
  9. caqti-mirage >= "2.1.1"
  10. charrua
  11. charrua-client
  12. charrua-server
  13. charrua-unix
  14. cohttp-async >= "4.1.2"
  15. cohttp-lwt >= "6.1.0"
  16. colombe
  17. conduit >= "1.5.0"
  18. conduit-async
  19. conduit-lwt-unix >= "1.5.0"
  20. conduit-mirage
  21. corosync
  22. current-albatross-deployer
  23. dkim
  24. dns >= "1.1.3"
  25. dns-cli
  26. dns-client != "7.0.3"
  27. dns-client-lwt
  28. dns-client-miou-unix
  29. dns-client-mirage
  30. dns-mirage
  31. dns-resolver >= "10.2.1"
  32. dream_middleware_ext
  33. eliom
  34. emile
  35. frenetic
  36. git >= "3.2.0"
  37. git-mirage
  38. git-paf
  39. git-unix >= "3.2.0"
  40. happy-eyeballs
  41. happy-eyeballs-lwt
  42. happy-eyeballs-miou-unix
  43. happy-eyeballs-mirage
  44. ip2location
  45. ip2proxy
  46. ipaddr-cstruct >= "5.6.1"
  47. ipaddr-sexp >= "5.6.1"
  48. irmin-client
  49. learn-ocaml < "0.14.0"
  50. letsencrypt-app >= "1.1.0"
  51. mehari-mirage
  52. miou
  53. mirage
  54. mirage-conduit
  55. mirage-nat
  56. mirage-net-xen
  57. mirage-protocols >= "7.0.0"
  58. mirage-protocols-lwt
  59. mirage-qubes-ipv4
  60. mirage-runtime
  61. mirage-stack-lwt
  62. mirage-types-lwt
  63. mirage-vnetif
  64. mrmime
  65. ocsigenserver
  66. octez-libs
  67. paf-cohttp
  68. pcap-format < "0.5.2"
  69. pf-qubes
  70. pgx >= "1.0"
  71. piaf >= "0.2.0"
  72. sendmail-lwt >= "0.10.0"
  73. tcpip
  74. tezos-base
  75. tezos-stdlib-unix
  76. tls >= "0.15.2"
  77. tuntap
  78. uspf
  79. vpnkit
  80. websocket-lwt
  81. x509 = "0.7.0" | >= "0.15.0"

Conflicts

None