1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
/*
* Copyright (C) Internet Systems Consortium, Inc. ("ISC")
*
* SPDX-License-Identifier: MPL-2.0
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, you can obtain one at https://mozilla.org/MPL/2.0/.
*
* See the COPYRIGHT file distributed with this work for additional
* information regarding copyright ownership.
*/
#pragma once
/*! \file isc/sockaddr.h */
#include <stdbool.h>
#include <isc/lang.h>
#include <isc/net.h>
#include <isc/types.h>
#include <sys/un.h>
/*
* Any updates to this structure should also be applied in
* contrib/modules/dlz/dlz_minmal.h.
*/
struct isc_sockaddr {
union {
struct sockaddr sa;
struct sockaddr_in sin;
struct sockaddr_in6 sin6;
struct sockaddr_storage ss;
struct sockaddr_un sunix;
} type;
unsigned int length; /* XXXRTH beginning? */
ISC_LINK(struct isc_sockaddr) link;
};
#define ISC_SOCKADDR_CMPADDR \
0x0001 /*%< compare the address \
* sin_addr/sin6_addr */
#define ISC_SOCKADDR_CMPPORT \
0x0002 /*%< compare the port \
* sin_port/sin6_port */
#define ISC_SOCKADDR_CMPSCOPE \
0x0004 /*%< compare the scope \
* sin6_scope */
#define ISC_SOCKADDR_CMPSCOPEZERO \
0x0008 /*%< when comparing scopes \
* zero scopes always match */
ISC_LANG_BEGINDECLS
bool
isc_sockaddr_compare(const isc_sockaddr_t *a, const isc_sockaddr_t *b,
unsigned int flags);
/*%<
* Compare the elements of the two address ('a' and 'b') as specified
* by 'flags' and report if they are equal or not.
*
* 'flags' is set from ISC_SOCKADDR_CMP*.
*/
bool
isc_sockaddr_equal(const isc_sockaddr_t *a, const isc_sockaddr_t *b);
/*%<
* Return true iff the socket addresses 'a' and 'b' are equal.
*/
bool
isc_sockaddr_eqaddr(const isc_sockaddr_t *a, const isc_sockaddr_t *b);
/*%<
* Return true iff the address parts of the socket addresses
* 'a' and 'b' are equal, ignoring the ports.
*/
bool
isc_sockaddr_eqaddrprefix(const isc_sockaddr_t *a, const isc_sockaddr_t *b,
unsigned int prefixlen);
/*%<
* Return true iff the most significant 'prefixlen' bits of the
* socket addresses 'a' and 'b' are equal, ignoring the ports.
* If 'b''s scope is zero then 'a''s scope will be ignored.
*/
unsigned int
isc_sockaddr_hash(const isc_sockaddr_t *sockaddr, bool address_only);
/*%<
* Return a hash value for the socket address 'sockaddr'. If 'address_only'
* is true, the hash value will not depend on the port.
*
* IPv6 addresses containing mapped IPv4 addresses generate the same hash
* value as the equivalent IPv4 address.
*/
void
isc_sockaddr_any(isc_sockaddr_t *sockaddr);
/*%<
* Return the IPv4 wildcard address.
*/
void
isc_sockaddr_any6(isc_sockaddr_t *sockaddr);
/*%<
* Return the IPv6 wildcard address.
*/
void
isc_sockaddr_anyofpf(isc_sockaddr_t *sockaddr, int family);
/*%<
* Set '*sockaddr' to the wildcard address of protocol family
* 'family'.
*
* Requires:
* \li 'family' is AF_INET or AF_INET6.
*/
void
isc_sockaddr_fromin(isc_sockaddr_t *sockaddr, const struct in_addr *ina,
in_port_t port);
/*%<
* Construct an isc_sockaddr_t from an IPv4 address and port.
*/
void
isc_sockaddr_fromin6(isc_sockaddr_t *sockaddr, const struct in6_addr *ina6,
in_port_t port);
/*%<
* Construct an isc_sockaddr_t from an IPv6 address and port.
*/
void
isc_sockaddr_v6fromin(isc_sockaddr_t *sockaddr, const struct in_addr *ina,
in_port_t port);
/*%<
* Construct an IPv6 isc_sockaddr_t representing a mapped IPv4 address.
*/
void
isc_sockaddr_fromnetaddr(isc_sockaddr_t *sockaddr, const isc_netaddr_t *na,
in_port_t port);
/*%<
* Construct an isc_sockaddr_t from an isc_netaddr_t and port.
*/
int
isc_sockaddr_pf(const isc_sockaddr_t *sockaddr);
/*%<
* Get the protocol family of 'sockaddr'.
*
* Requires:
*
*\li 'sockaddr' is a valid sockaddr with an address family of AF_INET
* or AF_INET6.
*
* Returns:
*
*\li The protocol family of 'sockaddr', e.g. PF_INET or PF_INET6.
*/
void
isc_sockaddr_setport(isc_sockaddr_t *sockaddr, in_port_t port);
/*%<
* Set the port of 'sockaddr' to 'port'.
*/
in_port_t
isc_sockaddr_getport(const isc_sockaddr_t *sockaddr);
/*%<
* Get the port stored in 'sockaddr'.
*/
isc_result_t
isc_sockaddr_totext(const isc_sockaddr_t *sockaddr, isc_buffer_t *target);
/*%<
* Append a text representation of 'sockaddr' to the buffer 'target'.
* The text will include both the IP address (v4 or v6) and the port.
* The text is null terminated, but the terminating null is not
* part of the buffer's used region.
*
* Returns:
* \li ISC_R_SUCCESS
* \li ISC_R_NOSPACE The text or the null termination did not fit.
*/
void
isc_sockaddr_format(const isc_sockaddr_t *sa, char *array, unsigned int size);
/*%<
* Format a human-readable representation of the socket address '*sa'
* into the character array 'array', which is of size 'size'.
* The resulting string is guaranteed to be null-terminated.
*/
bool
isc_sockaddr_ismulticast(const isc_sockaddr_t *sa);
/*%<
* Returns #true if the address is a multicast address.
*/
bool
isc_sockaddr_isexperimental(const isc_sockaddr_t *sa);
/*
* Returns true if the address is a experimental (CLASS E) address.
*/
bool
isc_sockaddr_islinklocal(const isc_sockaddr_t *sa);
/*%<
* Returns true if the address is a link local address.
*/
bool
isc_sockaddr_issitelocal(const isc_sockaddr_t *sa);
/*%<
* Returns true if the address is a sitelocal address.
*/
bool
isc_sockaddr_isnetzero(const isc_sockaddr_t *sa);
/*%<
* Returns true if the address is in net zero.
*/
isc_result_t
isc_sockaddr_frompath(isc_sockaddr_t *sockaddr, const char *path);
/*
* Create a UNIX domain sockaddr that refers to path.
*
* Returns:
* \li ISC_R_NOSPACE
* \li ISC_R_NOTIMPLEMENTED
* \li ISC_R_SUCCESS
*/
isc_result_t
isc_sockaddr_fromsockaddr(isc_sockaddr_t *isa, const struct sockaddr *sa);
#define ISC_SOCKADDR_FORMATSIZE \
sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:XXX.XXX.XXX.XXX%SSSSSSSSSS#" \
"YYYYY")
/*%<
* Minimum size of array to pass to isc_sockaddr_format().
*/
ISC_LANG_ENDDECLS
|
