src/basic/in-addr-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2 #pragma once
   3
   4 #include <arpa/inet.h>
   5 #include <netinet/in.h>
   6 #include <stddef.h>
   7 #include <sys/socket.h>
   8
   9 #include "hash-funcs.h"
  10 #include "macro.h"
  11 #include "util.h"
  12
  13 union in_addr_union {
  14         struct in_addr in;
  15         struct in6_addr in6;
  16         uint8_t bytes[CONST_MAX(sizeof(struct in_addr), sizeof(struct in6_addr))];
  17 };
  18
  19 struct in_addr_data {
  20         int family;
  21         union in_addr_union address;
  22 };
  23
  24 bool in4_addr_is_null(const struct in_addr *a);
  25 static inline bool in4_addr_is_set(const struct in_addr *a) {
  26         return !in4_addr_is_null(a);
  27 }
  28 bool in6_addr_is_null(const struct in6_addr *a);
  29 static inline bool in6_addr_is_set(const struct in6_addr *a) {
  30         return !in6_addr_is_null(a);
  31 }
  32 int in_addr_is_null(int family, const union in_addr_union *u);
  33 static inline bool in_addr_is_set(int family, const union in_addr_union *u) {
  34         return in_addr_is_null(family, u) == 0;
  35 }
  36 static inline int in_addr_data_is_null(const struct in_addr_data *a) {
  37         assert(a);
  38         return in_addr_is_null(a->family, &a->address);
  39 }
  40 static inline bool in_addr_data_is_set(const struct in_addr_data *a) {
  41         return in_addr_data_is_null(a);
  42 }
  43
  44 int in_addr_is_multicast(int family, const union in_addr_union *u);
  45
  46 bool in4_addr_is_link_local(const struct in_addr *a);
  47 bool in6_addr_is_link_local(const struct in6_addr *a);
  48 int in_addr_is_link_local(int family, const union in_addr_union *u);
  49 bool in6_addr_is_link_local_all_nodes(const struct in6_addr *a);
  50
  51 bool in4_addr_is_localhost(const struct in_addr *a);
  52 int in_addr_is_localhost(int family, const union in_addr_union *u);
  53 int in_addr_is_localhost_one(int family, const union in_addr_union *u);
  54
  55 bool in4_addr_is_local_multicast(const struct in_addr *a);
  56 bool in4_addr_is_non_local(const struct in_addr *a);
  57 bool in6_addr_is_ipv4_mapped_address(const struct in6_addr *a);
  58
  59 bool in4_addr_equal(const struct in_addr *a, const struct in_addr *b);
  60 bool in6_addr_equal(const struct in6_addr *a, const struct in6_addr *b);
  61 int in_addr_equal(int family, const union in_addr_union *a, const union in_addr_union *b);
  62 int in_addr_prefix_intersect(int family, const union in_addr_union *a, unsigned aprefixlen, const union in_addr_union *b, unsigned bprefixlen);
  63 int in_addr_prefix_next(int family, union in_addr_union *u, unsigned prefixlen);
  64 int in_addr_prefix_nth(int family, union in_addr_union *u, unsigned prefixlen, uint64_t nth);
  65 int in_addr_random_prefix(int family, union in_addr_union *u, unsigned prefixlen_fixed_part, unsigned prefixlen);
  66 int in_addr_prefix_range(
  67                 int family,
  68                 const union in_addr_union *in,
  69                 unsigned prefixlen,
  70                 union in_addr_union *ret_start,
  71                 union in_addr_union *ret_end);
  72
  73 int in_addr_to_string(int family, const union in_addr_union *u, char **ret);
  74 static inline int in6_addr_to_string(const struct in6_addr *u, char **ret) {
  75         return in_addr_to_string(AF_INET6, (const union in_addr_union*) u, ret);
  76 }
  77
  78 static inline const char* typesafe_inet_ntop(int family, const union in_addr_union *a, char *buf, size_t len) {
  79         return inet_ntop(family, a, buf, len);
  80 }
  81 static inline const char* typesafe_inet_ntop4(const struct in_addr *a, char *buf, size_t len) {
  82         return inet_ntop(AF_INET, a, buf, len);
  83 }
  84 static inline const char* typesafe_inet_ntop6(const struct in6_addr *a, char *buf, size_t len) {
  85         return inet_ntop(AF_INET6, a, buf, len);
  86 }
  87
  88 /* Note: the lifetime of the compound literal is the immediately surrounding block,
  89  * see C11 §6.5.2.5, and
  90  * https://stackoverflow.com/questions/34880638/compound-literal-lifetime-and-if-blocks */
  91 #define IN_ADDR_MAX CONST_MAX(INET_ADDRSTRLEN, INET6_ADDRSTRLEN)
  92 #define IN_ADDR_TO_STRING(family, addr) typesafe_inet_ntop(family, addr, (char[IN_ADDR_MAX]){}, IN_ADDR_MAX)
  93 #define IN4_ADDR_TO_STRING(addr) typesafe_inet_ntop4(addr, (char[INET_ADDRSTRLEN]){}, INET_ADDRSTRLEN)
  94 #define IN6_ADDR_TO_STRING(addr) typesafe_inet_ntop6(addr, (char[INET6_ADDRSTRLEN]){}, INET6_ADDRSTRLEN)
  95
  96 int in_addr_prefix_to_string(
  97                 int family,
  98                 const union in_addr_union *u,
  99                 unsigned prefixlen,
 100                 char *buf,
 101                 size_t buf_len);
 102
 103 static inline const char* _in_addr_prefix_to_string(
 104                 int family,
 105                 const union in_addr_union *u,
 106                 unsigned prefixlen,
 107                 char *buf,
 108                 size_t buf_len) {
 109         /* We assume that this is called with an appropriately sized buffer and can never fail. */
 110         assert_se(in_addr_prefix_to_string(family, u, prefixlen, buf, buf_len) == 0);
 111         return buf;
 112 }
 113 static inline const char* _in4_addr_prefix_to_string(const struct in_addr *a, unsigned prefixlen, char *buf, size_t buf_len) {
 114         return _in_addr_prefix_to_string(AF_INET, (const union in_addr_union *) a, prefixlen, buf, buf_len);
 115 }
 116 static inline const char* _in6_addr_prefix_to_string(const struct in6_addr *a, unsigned prefixlen, char *buf, size_t buf_len) {
 117         return _in_addr_prefix_to_string(AF_INET6, (const union in_addr_union *) a, prefixlen, buf, buf_len);
 118 }
 119
 120 #define PREFIX_SUFFIX_MAX (1 + DECIMAL_STR_MAX(unsigned))
 121 #define IN_ADDR_PREFIX_TO_STRING(family, addr, prefixlen) \
 122         _in_addr_prefix_to_string(family, addr, prefixlen, (char[IN_ADDR_MAX + PREFIX_SUFFIX_MAX]){}, IN_ADDR_MAX + PREFIX_SUFFIX_MAX)
 123 #define IN4_ADDR_PREFIX_TO_STRING(addr, prefixlen) \
 124         _in4_addr_prefix_to_string(addr, prefixlen, (char[INET_ADDRSTRLEN + PREFIX_SUFFIX_MAX]){}, INET_ADDRSTRLEN + PREFIX_SUFFIX_MAX)
 125 #define IN6_ADDR_PREFIX_TO_STRING(addr, prefixlen) \
 126         _in6_addr_prefix_to_string(addr, prefixlen, (char[INET6_ADDRSTRLEN + PREFIX_SUFFIX_MAX]){}, INET6_ADDRSTRLEN + PREFIX_SUFFIX_MAX)
 127
 128 int in_addr_port_ifindex_name_to_string(int family, const union in_addr_union *u, uint16_t port, int ifindex, const char *server_name, char **ret);
 129 static inline int in_addr_ifindex_to_string(int family, const union in_addr_union *u, int ifindex, char **ret) {
 130         return in_addr_port_ifindex_name_to_string(family, u, 0, ifindex, NULL, ret);
 131 }
 132 static inline int in_addr_port_to_string(int family, const union in_addr_union *u, uint16_t port, char **ret) {
 133         return in_addr_port_ifindex_name_to_string(family, u, port, 0, NULL, ret);
 134 }
 135 int in_addr_from_string(int family, const char *s, union in_addr_union *ret);
 136 int in_addr_from_string_auto(const char *s, int *ret_family, union in_addr_union *ret);
 137
 138 unsigned char in4_addr_netmask_to_prefixlen(const struct in_addr *addr);
 139 struct in_addr* in4_addr_prefixlen_to_netmask(struct in_addr *addr, unsigned char prefixlen);
 140 int in4_addr_default_prefixlen(const struct in_addr *addr, unsigned char *prefixlen);
 141 int in4_addr_default_subnet_mask(const struct in_addr *addr, struct in_addr *mask);
 142 int in4_addr_mask(struct in_addr *addr, unsigned char prefixlen);
 143 int in6_addr_mask(struct in6_addr *addr, unsigned char prefixlen);
 144 int in_addr_mask(int family, union in_addr_union *addr, unsigned char prefixlen);
 145 int in4_addr_prefix_covers(const struct in_addr *prefix, unsigned char prefixlen, const struct in_addr *address);
 146 int in6_addr_prefix_covers(const struct in6_addr *prefix, unsigned char prefixlen, const struct in6_addr *address);
 147 int in_addr_prefix_covers(int family, const union in_addr_union *prefix, unsigned char prefixlen, const union in_addr_union *address);
 148 int in_addr_parse_prefixlen(int family, const char *p, unsigned char *ret);
 149 int in_addr_prefix_from_string(const char *p, int family, union in_addr_union *ret_prefix, unsigned char *ret_prefixlen);
 150
 151 typedef enum InAddrPrefixLenMode {
 152         PREFIXLEN_FULL,   /* Default to prefixlen of address size, 32 for IPv4 or 128 for IPv6, if not specified. */
 153         PREFIXLEN_REFUSE, /* Fail with -ENOANO if prefixlen is not specified. */
 154         PREFIXLEN_LEGACY, /* Default to legacy default prefixlen calculation from address if not specified. */
 155 } InAddrPrefixLenMode;
 156
 157 int in_addr_prefix_from_string_auto_internal(const char *p, InAddrPrefixLenMode mode, int *ret_family, union in_addr_union *ret_prefix, unsigned char *ret_prefixlen);
 158 static inline int in_addr_prefix_from_string_auto(const char *p, int *ret_family, union in_addr_union *ret_prefix, unsigned char *ret_prefixlen) {
 159         return in_addr_prefix_from_string_auto_internal(p, PREFIXLEN_FULL, ret_family, ret_prefix, ret_prefixlen);
 160 }
 161
 162 static inline size_t FAMILY_ADDRESS_SIZE(int family) {
 163         assert(IN_SET(family, AF_INET, AF_INET6));
 164         return family == AF_INET6 ? 16 : 4;
 165 }
 166
 167 #define FAMILY_ADDRESS_SIZE_SAFE(f)                                     \
 168         ({                                                              \
 169                 int _f = (f);                                           \
 170                 _f == AF_INET ? sizeof(struct in_addr) :                \
 171                 _f == AF_INET6 ? sizeof(struct in6_addr) : 0;           \
 172         })
 173
 174 /* Workaround for clang, explicitly specify the maximum-size element here.
 175  * See also oss-fuzz#11344. */
 176 #define IN_ADDR_NULL ((union in_addr_union) { .in6 = {} })
 177
 178 void in6_addr_hash_func(const struct in6_addr *addr, struct siphash *state);
 179 int in6_addr_compare_func(const struct in6_addr *a, const struct in6_addr *b);
 180
 181 extern const struct hash_ops in_addr_data_hash_ops;
 182 extern const struct hash_ops in6_addr_hash_ops;
 183 extern const struct hash_ops in6_addr_hash_ops_free;
 184
 185 #define IPV4_ADDRESS_FMT_STR     "%u.%u.%u.%u"
 186 #define IPV4_ADDRESS_FMT_VAL(address)              \
 187         be32toh((address).s_addr) >> 24,           \
 188         (be32toh((address).s_addr) >> 16) & 0xFFu, \
 189         (be32toh((address).s_addr) >> 8) & 0xFFu,  \
 190         be32toh((address).s_addr) & 0xFFu