package ipaddr

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

Install

Dune Dependency

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

Authors

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

Maintainers

  1. A
    anil@recoil.org

Sources

ipaddr-5.6.0.tbz
sha256=9e30433fdb4ca437a6aa8ffb447baca5eba7615fb88e7b0cd8a4b416c3208133
sha512=66a3bedfd91dacd6c1de9ba35abac3ef2ad3c2c8543f7b4e2a0cc6283a8d42138b48d02e904df0232ee9f320920e889bddbbda9a5148c5c6b72fd0164e0c6a34

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: 24 May 2024

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

  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. dream_middleware_ext
  32. eliom
  33. emile
  34. frenetic
  35. git >= "3.2.0"
  36. git-mirage
  37. git-paf
  38. git-unix >= "3.2.0"
  39. happy-eyeballs
  40. happy-eyeballs-lwt
  41. happy-eyeballs-miou-unix
  42. happy-eyeballs-mirage
  43. ip2location
  44. ip2proxy
  45. ipaddr-cstruct
  46. ipaddr-sexp
  47. irmin-client
  48. learn-ocaml < "0.14.0"
  49. letsencrypt-app >= "1.1.0"
  50. mehari-mirage
  51. miou
  52. mirage
  53. mirage-conduit
  54. mirage-nat
  55. mirage-net-xen
  56. mirage-protocols >= "7.0.0"
  57. mirage-protocols-lwt
  58. mirage-qubes-ipv4
  59. mirage-runtime
  60. mirage-stack-lwt
  61. mirage-types-lwt
  62. mirage-vnetif
  63. mrmime
  64. ocsigenserver
  65. octez-libs
  66. paf-cohttp
  67. pcap-format < "0.5.2"
  68. pf-qubes
  69. pgx >= "1.0"
  70. piaf >= "0.2.0"
  71. sendmail-lwt >= "0.10.0"
  72. tcpip
  73. tezos-base
  74. tezos-stdlib-unix
  75. tls >= "0.15.2"
  76. tuntap
  77. uspf
  78. vpnkit
  79. websocket-lwt
  80. x509 = "0.7.0" | >= "0.15.0"

Conflicts

None

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct