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

Authors

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

Maintainers

  1. A
    anil@recoil.org

Sources

ipaddr-5.3.0.tbz
sha256=36979edf64b464d44055f3504b97d61e22050e7369d983052c4ecc3d2b1ab755
sha512=06b16e319672c8182210296ed005accd9a4e190f99bd019f24232e213be8de6d198f9e8cb40ee00ec226184e1dd4ebd7e589d890b1f88f40f17eaf785dae975c

Description

Features:

  • Depends only on sexplib (conditionalization under consideration)
  • oUnit-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: 08 Mar 2022

README

ipaddr: IP and MAC address manipulation

A library for manipulation of IP and MAC address representations.

Features:

  • oUnit-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 (5)

  1. domain-name >= "0.3.0"
  2. stdlib-shims
  3. macaddr = version
  4. dune >= "1.9.0"
  5. ocaml >= "4.04.0"

Dev Dependencies (2)

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

Used by (97)

  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.0"
  43. ipaddr-sexp = "5.3.0"
  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. metrics-mirage
  50. miou
  51. mirage >= "0.10.0" & < "2.9.0" | >= "3.8.0"
  52. mirage-block-xen >= "1.1.0" & < "2.0.0"
  53. mirage-bootvar-xen < "0.4.0"
  54. mirage-conduit >= "3.2.0"
  55. mirage-console-xen-cli
  56. mirage-entropy-unix < "0.2.0"
  57. mirage-entropy-xen < "0.2.0"
  58. mirage-nat < "1.2.0" | >= "2.2.2"
  59. mirage-net-fd
  60. mirage-net-xen >= "2.1.4"
  61. mirage-protocols >= "4.0.0"
  62. mirage-protocols-lwt >= "1.4.1"
  63. mirage-qubes-ipv4 >= "0.6.1"
  64. mirage-runtime >= "3.8.0" & < "4.5.0"
  65. mirage-stack-lwt
  66. mirage-types-lwt < "3.7.1"
  67. mirage-unix >= "0.9.4" & < "0.9.9"
  68. mirage-vnetif >= "0.4.1"
  69. mirage-vnetif-stack
  70. mirage-www >= "1.1.0"
  71. mirage-xen >= "0.9.5" & < "0.9.9"
  72. mirari >= "0.9.6"
  73. mrmime
  74. mrt-format >= "0.3.0"
  75. nanomsg
  76. netchannel >= "1.8.1"
  77. ocsigenserver >= "2.4.0"
  78. octez-libs
  79. paf >= "0.0.2" & < "0.0.4"
  80. paf-cohttp
  81. pcap-format = "0.4.0"
  82. pf-qubes
  83. pgx >= "1.0"
  84. piaf >= "0.2.0"
  85. sendmail-lwt >= "0.10.0"
  86. tcpip >= "3.6.0" & < "8.1.0"
  87. tezos-base >= "8.0"
  88. tezos-stdlib-unix
  89. tls >= "0.15.0"
  90. tuntap >= "2.0.0"
  91. uspf
  92. vchan >= "0.9.6" & < "2.0.0"
  93. vhd-format >= "0.7.0" & < "0.9.1"
  94. vpnkit
  95. websocket-lwt
  96. x509 = "0.7.0" | >= "0.15.0"
  97. xentropyd

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