Coverage Report

Created: 2026-01-24 06:23

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/bind9/lib/isc/sockaddr.c
Line
Count
Source
1
/*
2
 * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
3
 *
4
 * SPDX-License-Identifier: MPL-2.0
5
 *
6
 * This Source Code Form is subject to the terms of the Mozilla Public
7
 * License, v. 2.0. If a copy of the MPL was not distributed with this
8
 * file, you can obtain one at https://mozilla.org/MPL/2.0/.
9
 *
10
 * See the COPYRIGHT file distributed with this work for additional
11
 * information regarding copyright ownership.
12
 */
13
14
/*! \file */
15
16
#include <netdb.h>
17
#include <stdbool.h>
18
#include <stdio.h>
19
20
#include <isc/buffer.h>
21
#include <isc/hash.h>
22
#include <isc/netaddr.h>
23
#include <isc/region.h>
24
#include <isc/sockaddr.h>
25
#include <isc/string.h>
26
#include <isc/util.h>
27
28
bool
29
0
isc_sockaddr_equal(const isc_sockaddr_t *a, const isc_sockaddr_t *b) {
30
0
  return isc_sockaddr_compare(a, b,
31
0
            ISC_SOCKADDR_CMPADDR |
32
0
              ISC_SOCKADDR_CMPPORT |
33
0
              ISC_SOCKADDR_CMPSCOPE);
34
0
}
35
36
bool
37
0
isc_sockaddr_eqaddr(const isc_sockaddr_t *a, const isc_sockaddr_t *b) {
38
0
  return isc_sockaddr_compare(
39
0
    a, b, ISC_SOCKADDR_CMPADDR | ISC_SOCKADDR_CMPSCOPE);
40
0
}
41
42
bool
43
isc_sockaddr_compare(const isc_sockaddr_t *a, const isc_sockaddr_t *b,
44
0
         unsigned int flags) {
45
0
  REQUIRE(a != NULL && b != NULL);
46
47
0
  if (a->length != b->length) {
48
0
    return false;
49
0
  }
50
51
  /*
52
   * We don't just memcmp because the sin_zero field isn't always
53
   * zero.
54
   */
55
56
0
  if (a->type.sa.sa_family != b->type.sa.sa_family) {
57
0
    return false;
58
0
  }
59
0
  switch (a->type.sa.sa_family) {
60
0
  case AF_INET:
61
0
    if ((flags & ISC_SOCKADDR_CMPADDR) != 0 &&
62
0
        memcmp(&a->type.sin.sin_addr, &b->type.sin.sin_addr,
63
0
         sizeof(a->type.sin.sin_addr)) != 0)
64
0
    {
65
0
      return false;
66
0
    }
67
0
    if ((flags & ISC_SOCKADDR_CMPPORT) != 0 &&
68
0
        a->type.sin.sin_port != b->type.sin.sin_port)
69
0
    {
70
0
      return false;
71
0
    }
72
0
    break;
73
0
  case AF_INET6:
74
0
    if ((flags & ISC_SOCKADDR_CMPADDR) != 0 &&
75
0
        memcmp(&a->type.sin6.sin6_addr, &b->type.sin6.sin6_addr,
76
0
         sizeof(a->type.sin6.sin6_addr)) != 0)
77
0
    {
78
0
      return false;
79
0
    }
80
    /*
81
     * If ISC_SOCKADDR_CMPSCOPEZERO is set then don't return
82
     * false if one of the scopes in zero.
83
     */
84
0
    if ((flags & ISC_SOCKADDR_CMPSCOPE) != 0 &&
85
0
        a->type.sin6.sin6_scope_id != b->type.sin6.sin6_scope_id &&
86
0
        ((flags & ISC_SOCKADDR_CMPSCOPEZERO) == 0 ||
87
0
         (a->type.sin6.sin6_scope_id != 0 &&
88
0
          b->type.sin6.sin6_scope_id != 0)))
89
0
    {
90
0
      return false;
91
0
    }
92
0
    if ((flags & ISC_SOCKADDR_CMPPORT) != 0 &&
93
0
        a->type.sin6.sin6_port != b->type.sin6.sin6_port)
94
0
    {
95
0
      return false;
96
0
    }
97
0
    break;
98
0
  default:
99
0
    if (memcmp(&a->type, &b->type, a->length) != 0) {
100
0
      return false;
101
0
    }
102
0
  }
103
0
  return true;
104
0
}
105
106
bool
107
isc_sockaddr_eqaddrprefix(const isc_sockaddr_t *a, const isc_sockaddr_t *b,
108
0
        unsigned int prefixlen) {
109
0
  isc_netaddr_t na, nb;
110
0
  isc_netaddr_fromsockaddr(&na, a);
111
0
  isc_netaddr_fromsockaddr(&nb, b);
112
0
  return isc_netaddr_eqprefix(&na, &nb, prefixlen);
113
0
}
114
115
isc_result_t
116
0
isc_sockaddr_totext(const isc_sockaddr_t *sockaddr, isc_buffer_t *target) {
117
0
  isc_netaddr_t netaddr;
118
0
  char pbuf[sizeof("65000")];
119
0
  unsigned int plen;
120
0
  isc_region_t avail;
121
122
0
  REQUIRE(sockaddr != NULL);
123
124
  /*
125
   * Do the port first, giving us the opportunity to check for
126
   * unsupported address families before calling
127
   * isc_netaddr_fromsockaddr().
128
   */
129
0
  switch (sockaddr->type.sa.sa_family) {
130
0
  case AF_INET:
131
0
    snprintf(pbuf, sizeof(pbuf), "%u",
132
0
       ntohs(sockaddr->type.sin.sin_port));
133
0
    break;
134
0
  case AF_INET6:
135
0
    snprintf(pbuf, sizeof(pbuf), "%u",
136
0
       ntohs(sockaddr->type.sin6.sin6_port));
137
0
    break;
138
0
  default:
139
0
    return ISC_R_FAILURE;
140
0
  }
141
142
0
  plen = strlen(pbuf);
143
0
  INSIST(plen < sizeof(pbuf));
144
145
0
  isc_netaddr_fromsockaddr(&netaddr, sockaddr);
146
0
  RETERR(isc_netaddr_totext(&netaddr, target));
147
148
0
  if (1 + plen + 1 > isc_buffer_availablelength(target)) {
149
0
    return ISC_R_NOSPACE;
150
0
  }
151
152
0
  isc_buffer_putmem(target, (const unsigned char *)"#", 1);
153
0
  isc_buffer_putmem(target, (const unsigned char *)pbuf, plen);
154
155
  /*
156
   * Null terminate after used region.
157
   */
158
0
  isc_buffer_availableregion(target, &avail);
159
0
  INSIST(avail.length >= 1);
160
0
  avail.base[0] = '\0';
161
162
0
  return ISC_R_SUCCESS;
163
0
}
164
165
void
166
0
isc_sockaddr_format(const isc_sockaddr_t *sa, char *array, unsigned int size) {
167
0
  isc_result_t result;
168
0
  isc_buffer_t buf;
169
170
0
  if (size == 0U) {
171
0
    return;
172
0
  }
173
174
0
  isc_buffer_init(&buf, array, size);
175
0
  result = isc_sockaddr_totext(sa, &buf);
176
0
  if (result != ISC_R_SUCCESS) {
177
    /*
178
     * The message is the same as in netaddr.c.
179
     */
180
0
    snprintf(array, size, "<unknown address, family %u>",
181
0
       sa->type.sa.sa_family);
182
0
    array[size - 1] = '\0';
183
0
  }
184
0
}
185
186
void
187
isc_sockaddr_hash_ex(isc_hash32_t *hash, const isc_sockaddr_t *sockaddr,
188
0
         bool address_only) {
189
0
  REQUIRE(sockaddr != NULL);
190
191
0
  size_t len = 0;
192
0
  const uint8_t *s = NULL;
193
0
  unsigned int p = 0;
194
0
  const struct in6_addr *in6;
195
196
0
  switch (sockaddr->type.sa.sa_family) {
197
0
  case AF_INET:
198
0
    s = (const uint8_t *)&sockaddr->type.sin.sin_addr;
199
0
    len = sizeof(sockaddr->type.sin.sin_addr.s_addr);
200
0
    if (!address_only) {
201
0
      p = ntohs(sockaddr->type.sin.sin_port);
202
0
    }
203
0
    break;
204
0
  case AF_INET6:
205
0
    in6 = &sockaddr->type.sin6.sin6_addr;
206
0
    s = (const uint8_t *)in6;
207
0
    if (IN6_IS_ADDR_V4MAPPED(in6)) {
208
0
      s += 12;
209
0
      len = sizeof(sockaddr->type.sin.sin_addr.s_addr);
210
0
    } else {
211
0
      len = sizeof(sockaddr->type.sin6.sin6_addr);
212
0
    }
213
0
    if (!address_only) {
214
0
      p = ntohs(sockaddr->type.sin6.sin6_port);
215
0
    }
216
0
    break;
217
0
  default:
218
0
    UNREACHABLE();
219
0
  }
220
221
0
  isc_hash32_hash(hash, s, len, true);
222
0
  if (!address_only) {
223
0
    isc_hash32_hash(hash, &p, sizeof(p), true);
224
0
  }
225
0
}
226
227
uint32_t
228
0
isc_sockaddr_hash(const isc_sockaddr_t *sockaddr, bool address_only) {
229
0
  isc_hash32_t hash;
230
231
0
  isc_hash32_init(&hash);
232
233
0
  isc_sockaddr_hash_ex(&hash, sockaddr, address_only);
234
235
0
  return isc_hash32_finalize(&hash);
236
0
}
237
238
void
239
0
isc_sockaddr_any(isc_sockaddr_t *sockaddr) {
240
0
  memset(sockaddr, 0, sizeof(*sockaddr));
241
0
  sockaddr->type.sin.sin_family = AF_INET;
242
0
  sockaddr->type.sin.sin_addr.s_addr = INADDR_ANY;
243
0
  sockaddr->type.sin.sin_port = 0;
244
0
  sockaddr->length = sizeof(sockaddr->type.sin);
245
0
  ISC_LINK_INIT(sockaddr, link);
246
0
}
247
248
void
249
0
isc_sockaddr_any6(isc_sockaddr_t *sockaddr) {
250
0
  memset(sockaddr, 0, sizeof(*sockaddr));
251
0
  sockaddr->type.sin6.sin6_family = AF_INET6;
252
0
  sockaddr->type.sin6.sin6_addr = in6addr_any;
253
0
  sockaddr->type.sin6.sin6_port = 0;
254
0
  sockaddr->length = sizeof(sockaddr->type.sin6);
255
0
  ISC_LINK_INIT(sockaddr, link);
256
0
}
257
258
void
259
isc_sockaddr_fromin(isc_sockaddr_t *sockaddr, const struct in_addr *ina,
260
0
        in_port_t port) {
261
0
  memset(sockaddr, 0, sizeof(*sockaddr));
262
0
  sockaddr->type.sin.sin_family = AF_INET;
263
0
  sockaddr->type.sin.sin_addr = *ina;
264
0
  sockaddr->type.sin.sin_port = htons(port);
265
0
  sockaddr->length = sizeof(sockaddr->type.sin);
266
0
  ISC_LINK_INIT(sockaddr, link);
267
0
}
268
269
void
270
0
isc_sockaddr_anyofpf(isc_sockaddr_t *sockaddr, int pf) {
271
0
  switch (pf) {
272
0
  case AF_INET:
273
0
    isc_sockaddr_any(sockaddr);
274
0
    break;
275
0
  case AF_INET6:
276
0
    isc_sockaddr_any6(sockaddr);
277
0
    break;
278
0
  default:
279
0
    UNREACHABLE();
280
0
  }
281
0
}
282
283
void
284
isc_sockaddr_fromin6(isc_sockaddr_t *sockaddr, const struct in6_addr *ina6,
285
0
         in_port_t port) {
286
0
  memset(sockaddr, 0, sizeof(*sockaddr));
287
0
  sockaddr->type.sin6.sin6_family = AF_INET6;
288
0
  sockaddr->type.sin6.sin6_addr = *ina6;
289
0
  sockaddr->type.sin6.sin6_port = htons(port);
290
0
  sockaddr->length = sizeof(sockaddr->type.sin6);
291
0
  ISC_LINK_INIT(sockaddr, link);
292
0
}
293
294
void
295
isc_sockaddr_v6fromin(isc_sockaddr_t *sockaddr, const struct in_addr *ina,
296
0
          in_port_t port) {
297
0
  memset(sockaddr, 0, sizeof(*sockaddr));
298
0
  sockaddr->type.sin6.sin6_family = AF_INET6;
299
0
  sockaddr->type.sin6.sin6_addr.s6_addr[10] = 0xff;
300
0
  sockaddr->type.sin6.sin6_addr.s6_addr[11] = 0xff;
301
0
  memmove(&sockaddr->type.sin6.sin6_addr.s6_addr[12], ina, 4);
302
0
  sockaddr->type.sin6.sin6_port = htons(port);
303
0
  sockaddr->length = sizeof(sockaddr->type.sin6);
304
0
  ISC_LINK_INIT(sockaddr, link);
305
0
}
306
307
int
308
0
isc_sockaddr_pf(const isc_sockaddr_t *sockaddr) {
309
  /*
310
   * Get the protocol family of 'sockaddr'.
311
   */
312
313
0
#if (AF_INET == PF_INET && AF_INET6 == PF_INET6)
314
  /*
315
   * Assume that PF_xxx == AF_xxx for all AF and PF.
316
   */
317
0
  return sockaddr->type.sa.sa_family;
318
#else  /* if (AF_INET == PF_INET && AF_INET6 == PF_INET6) */
319
  switch (sockaddr->type.sa.sa_family) {
320
  case AF_INET:
321
    return PF_INET;
322
  case AF_INET6:
323
    return PF_INET6;
324
  default:
325
    FATAL_ERROR("unknown address family: %d",
326
          (int)sockaddr->type.sa.sa_family);
327
  }
328
#endif /* if (AF_INET == PF_INET && AF_INET6 == PF_INET6) */
329
0
}
330
331
void
332
isc_sockaddr_fromnetaddr(isc_sockaddr_t *sockaddr, const isc_netaddr_t *na,
333
0
       in_port_t port) {
334
0
  memset(sockaddr, 0, sizeof(*sockaddr));
335
0
  sockaddr->type.sin.sin_family = na->family;
336
0
  switch (na->family) {
337
0
  case AF_INET:
338
0
    sockaddr->length = sizeof(sockaddr->type.sin);
339
0
    sockaddr->type.sin.sin_addr = na->type.in;
340
0
    sockaddr->type.sin.sin_port = htons(port);
341
0
    break;
342
0
  case AF_INET6:
343
0
    sockaddr->length = sizeof(sockaddr->type.sin6);
344
0
    memmove(&sockaddr->type.sin6.sin6_addr, &na->type.in6, 16);
345
0
    sockaddr->type.sin6.sin6_scope_id = isc_netaddr_getzone(na);
346
0
    sockaddr->type.sin6.sin6_port = htons(port);
347
0
    break;
348
0
  default:
349
0
    UNREACHABLE();
350
0
  }
351
0
  ISC_LINK_INIT(sockaddr, link);
352
0
}
353
354
void
355
0
isc_sockaddr_setport(isc_sockaddr_t *sockaddr, in_port_t port) {
356
0
  switch (sockaddr->type.sa.sa_family) {
357
0
  case AF_INET:
358
0
    sockaddr->type.sin.sin_port = htons(port);
359
0
    break;
360
0
  case AF_INET6:
361
0
    sockaddr->type.sin6.sin6_port = htons(port);
362
0
    break;
363
0
  default:
364
0
    FATAL_ERROR("unknown address family: %d",
365
0
          (int)sockaddr->type.sa.sa_family);
366
0
  }
367
0
}
368
369
in_port_t
370
0
isc_sockaddr_getport(const isc_sockaddr_t *sockaddr) {
371
0
  in_port_t port = 0;
372
373
0
  switch (sockaddr->type.sa.sa_family) {
374
0
  case AF_INET:
375
0
    port = ntohs(sockaddr->type.sin.sin_port);
376
0
    break;
377
0
  case AF_INET6:
378
0
    port = ntohs(sockaddr->type.sin6.sin6_port);
379
0
    break;
380
0
  default:
381
0
    FATAL_ERROR("unknown address family: %d",
382
0
          (int)sockaddr->type.sa.sa_family);
383
0
  }
384
385
0
  return port;
386
0
}
387
388
bool
389
0
isc_sockaddr_ismulticast(const isc_sockaddr_t *sockaddr) {
390
0
  isc_netaddr_t netaddr;
391
392
0
  if (sockaddr->type.sa.sa_family == AF_INET ||
393
0
      sockaddr->type.sa.sa_family == AF_INET6)
394
0
  {
395
0
    isc_netaddr_fromsockaddr(&netaddr, sockaddr);
396
0
    return isc_netaddr_ismulticast(&netaddr);
397
0
  }
398
0
  return false;
399
0
}
400
401
bool
402
0
isc_sockaddr_isexperimental(const isc_sockaddr_t *sockaddr) {
403
0
  isc_netaddr_t netaddr;
404
405
0
  if (sockaddr->type.sa.sa_family == AF_INET) {
406
0
    isc_netaddr_fromsockaddr(&netaddr, sockaddr);
407
0
    return isc_netaddr_isexperimental(&netaddr);
408
0
  }
409
0
  return false;
410
0
}
411
412
bool
413
0
isc_sockaddr_issitelocal(const isc_sockaddr_t *sockaddr) {
414
0
  isc_netaddr_t netaddr;
415
416
0
  if (sockaddr->type.sa.sa_family == AF_INET6) {
417
0
    isc_netaddr_fromsockaddr(&netaddr, sockaddr);
418
0
    return isc_netaddr_issitelocal(&netaddr);
419
0
  }
420
0
  return false;
421
0
}
422
423
bool
424
0
isc_sockaddr_islinklocal(const isc_sockaddr_t *sockaddr) {
425
0
  isc_netaddr_t netaddr;
426
427
0
  if (sockaddr->type.sa.sa_family == AF_INET6) {
428
0
    isc_netaddr_fromsockaddr(&netaddr, sockaddr);
429
0
    return isc_netaddr_islinklocal(&netaddr);
430
0
  }
431
0
  return false;
432
0
}
433
434
bool
435
0
isc_sockaddr_isnetzero(const isc_sockaddr_t *sockaddr) {
436
0
  isc_netaddr_t netaddr;
437
438
0
  if (sockaddr->type.sa.sa_family == AF_INET) {
439
0
    isc_netaddr_fromsockaddr(&netaddr, sockaddr);
440
0
    return isc_netaddr_isnetzero(&netaddr);
441
0
  }
442
0
  return false;
443
0
}
444
445
isc_result_t
446
0
isc_sockaddr_fromsockaddr(isc_sockaddr_t *isa, const struct sockaddr *sa) {
447
0
  unsigned int length = 0;
448
449
0
  switch (sa->sa_family) {
450
0
  case AF_INET:
451
0
    length = sizeof(isa->type.sin);
452
0
    break;
453
0
  case AF_INET6:
454
0
    length = sizeof(isa->type.sin6);
455
0
    break;
456
0
  default:
457
0
    return ISC_R_NOTIMPLEMENTED;
458
0
  }
459
460
0
  *isa = (isc_sockaddr_t){ .length = length,
461
0
         .link = ISC_LINK_INITIALIZER };
462
0
  memmove(isa, sa, length);
463
464
0
  return ISC_R_SUCCESS;
465
0
}
466
467
bool
468
0
isc_sockaddr_disabled(const isc_sockaddr_t *sockaddr) {
469
0
  if ((sockaddr->type.sa.sa_family == AF_INET &&
470
0
       isc_net_probeipv4() == ISC_R_DISABLED) ||
471
0
      (sockaddr->type.sa.sa_family == AF_INET6 &&
472
0
       isc_net_probeipv6() == ISC_R_DISABLED))
473
0
  {
474
0
    return true;
475
0
  }
476
0
  return false;
477
0
}