Debian Codegraph @

src/basic/in-addr-util.h

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