Coverage Report

Created: 2025-11-24 06:17

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_result_t result;
118
0
  isc_netaddr_t netaddr;
119
0
  char pbuf[sizeof("65000")];
120
0
  unsigned int plen;
121
0
  isc_region_t avail;
122
123
0
  REQUIRE(sockaddr != NULL);
124
125
  /*
126
   * Do the port first, giving us the opportunity to check for
127
   * unsupported address families before calling
128
   * isc_netaddr_fromsockaddr().
129
   */
130
0
  switch (sockaddr->type.sa.sa_family) {
131
0
  case AF_INET:
132
0
    snprintf(pbuf, sizeof(pbuf), "%u",
133
0
       ntohs(sockaddr->type.sin.sin_port));
134
0
    break;
135
0
  case AF_INET6:
136
0
    snprintf(pbuf, sizeof(pbuf), "%u",
137
0
       ntohs(sockaddr->type.sin6.sin6_port));
138
0
    break;
139
0
  default:
140
0
    return ISC_R_FAILURE;
141
0
  }
142
143
0
  plen = strlen(pbuf);
144
0
  INSIST(plen < sizeof(pbuf));
145
146
0
  isc_netaddr_fromsockaddr(&netaddr, sockaddr);
147
0
  result = isc_netaddr_totext(&netaddr, target);
148
0
  if (result != ISC_R_SUCCESS) {
149
0
    return result;
150
0
  }
151
152
0
  if (1 + plen + 1 > isc_buffer_availablelength(target)) {
153
0
    return ISC_R_NOSPACE;
154
0
  }
155
156
0
  isc_buffer_putmem(target, (const unsigned char *)"#", 1);
157
0
  isc_buffer_putmem(target, (const unsigned char *)pbuf, plen);
158
159
  /*
160
   * Null terminate after used region.
161
   */
162
0
  isc_buffer_availableregion(target, &avail);
163
0
  INSIST(avail.length >= 1);
164
0
  avail.base[0] = '\0';
165
166
0
  return ISC_R_SUCCESS;
167
0
}
168
169
void
170
0
isc_sockaddr_format(const isc_sockaddr_t *sa, char *array, unsigned int size) {
171
0
  isc_result_t result;
172
0
  isc_buffer_t buf;
173
174
0
  if (size == 0U) {
175
0
    return;
176
0
  }
177
178
0
  isc_buffer_init(&buf, array, size);
179
0
  result = isc_sockaddr_totext(sa, &buf);
180
0
  if (result != ISC_R_SUCCESS) {
181
    /*
182
     * The message is the same as in netaddr.c.
183
     */
184
0
    snprintf(array, size, "<unknown address, family %u>",
185
0
       sa->type.sa.sa_family);
186
0
    array[size - 1] = '\0';
187
0
  }
188
0
}
189
190
void
191
isc_sockaddr_hash_ex(isc_hash32_t *hash, const isc_sockaddr_t *sockaddr,
192
0
         bool address_only) {
193
0
  REQUIRE(sockaddr != NULL);
194
195
0
  size_t len = 0;
196
0
  const uint8_t *s = NULL;
197
0
  unsigned int p = 0;
198
0
  const struct in6_addr *in6;
199
200
0
  switch (sockaddr->type.sa.sa_family) {
201
0
  case AF_INET:
202
0
    s = (const uint8_t *)&sockaddr->type.sin.sin_addr;
203
0
    len = sizeof(sockaddr->type.sin.sin_addr.s_addr);
204
0
    if (!address_only) {
205
0
      p = ntohs(sockaddr->type.sin.sin_port);
206
0
    }
207
0
    break;
208
0
  case AF_INET6:
209
0
    in6 = &sockaddr->type.sin6.sin6_addr;
210
0
    s = (const uint8_t *)in6;
211
0
    if (IN6_IS_ADDR_V4MAPPED(in6)) {
212
0
      s += 12;
213
0
      len = sizeof(sockaddr->type.sin.sin_addr.s_addr);
214
0
    } else {
215
0
      len = sizeof(sockaddr->type.sin6.sin6_addr);
216
0
    }
217
0
    if (!address_only) {
218
0
      p = ntohs(sockaddr->type.sin6.sin6_port);
219
0
    }
220
0
    break;
221
0
  default:
222
0
    UNREACHABLE();
223
0
  }
224
225
0
  isc_hash32_hash(hash, s, len, true);
226
0
  if (!address_only) {
227
0
    isc_hash32_hash(hash, &p, sizeof(p), true);
228
0
  }
229
0
}
230
231
uint32_t
232
0
isc_sockaddr_hash(const isc_sockaddr_t *sockaddr, bool address_only) {
233
0
  isc_hash32_t hash;
234
235
0
  isc_hash32_init(&hash);
236
237
0
  isc_sockaddr_hash_ex(&hash, sockaddr, address_only);
238
239
0
  return isc_hash32_finalize(&hash);
240
0
}
241
242
void
243
0
isc_sockaddr_any(isc_sockaddr_t *sockaddr) {
244
0
  memset(sockaddr, 0, sizeof(*sockaddr));
245
0
  sockaddr->type.sin.sin_family = AF_INET;
246
0
  sockaddr->type.sin.sin_addr.s_addr = INADDR_ANY;
247
0
  sockaddr->type.sin.sin_port = 0;
248
0
  sockaddr->length = sizeof(sockaddr->type.sin);
249
0
  ISC_LINK_INIT(sockaddr, link);
250
0
}
251
252
void
253
0
isc_sockaddr_any6(isc_sockaddr_t *sockaddr) {
254
0
  memset(sockaddr, 0, sizeof(*sockaddr));
255
0
  sockaddr->type.sin6.sin6_family = AF_INET6;
256
0
  sockaddr->type.sin6.sin6_addr = in6addr_any;
257
0
  sockaddr->type.sin6.sin6_port = 0;
258
0
  sockaddr->length = sizeof(sockaddr->type.sin6);
259
0
  ISC_LINK_INIT(sockaddr, link);
260
0
}
261
262
void
263
isc_sockaddr_fromin(isc_sockaddr_t *sockaddr, const struct in_addr *ina,
264
0
        in_port_t port) {
265
0
  memset(sockaddr, 0, sizeof(*sockaddr));
266
0
  sockaddr->type.sin.sin_family = AF_INET;
267
0
  sockaddr->type.sin.sin_addr = *ina;
268
0
  sockaddr->type.sin.sin_port = htons(port);
269
0
  sockaddr->length = sizeof(sockaddr->type.sin);
270
0
  ISC_LINK_INIT(sockaddr, link);
271
0
}
272
273
void
274
0
isc_sockaddr_anyofpf(isc_sockaddr_t *sockaddr, int pf) {
275
0
  switch (pf) {
276
0
  case AF_INET:
277
0
    isc_sockaddr_any(sockaddr);
278
0
    break;
279
0
  case AF_INET6:
280
0
    isc_sockaddr_any6(sockaddr);
281
0
    break;
282
0
  default:
283
0
    UNREACHABLE();
284
0
  }
285
0
}
286
287
void
288
isc_sockaddr_fromin6(isc_sockaddr_t *sockaddr, const struct in6_addr *ina6,
289
0
         in_port_t port) {
290
0
  memset(sockaddr, 0, sizeof(*sockaddr));
291
0
  sockaddr->type.sin6.sin6_family = AF_INET6;
292
0
  sockaddr->type.sin6.sin6_addr = *ina6;
293
0
  sockaddr->type.sin6.sin6_port = htons(port);
294
0
  sockaddr->length = sizeof(sockaddr->type.sin6);
295
0
  ISC_LINK_INIT(sockaddr, link);
296
0
}
297
298
void
299
isc_sockaddr_v6fromin(isc_sockaddr_t *sockaddr, const struct in_addr *ina,
300
0
          in_port_t port) {
301
0
  memset(sockaddr, 0, sizeof(*sockaddr));
302
0
  sockaddr->type.sin6.sin6_family = AF_INET6;
303
0
  sockaddr->type.sin6.sin6_addr.s6_addr[10] = 0xff;
304
0
  sockaddr->type.sin6.sin6_addr.s6_addr[11] = 0xff;
305
0
  memmove(&sockaddr->type.sin6.sin6_addr.s6_addr[12], ina, 4);
306
0
  sockaddr->type.sin6.sin6_port = htons(port);
307
0
  sockaddr->length = sizeof(sockaddr->type.sin6);
308
0
  ISC_LINK_INIT(sockaddr, link);
309
0
}
310
311
int
312
0
isc_sockaddr_pf(const isc_sockaddr_t *sockaddr) {
313
  /*
314
   * Get the protocol family of 'sockaddr'.
315
   */
316
317
0
#if (AF_INET == PF_INET && AF_INET6 == PF_INET6)
318
  /*
319
   * Assume that PF_xxx == AF_xxx for all AF and PF.
320
   */
321
0
  return sockaddr->type.sa.sa_family;
322
#else  /* if (AF_INET == PF_INET && AF_INET6 == PF_INET6) */
323
  switch (sockaddr->type.sa.sa_family) {
324
  case AF_INET:
325
    return PF_INET;
326
  case AF_INET6:
327
    return PF_INET6;
328
  default:
329
    FATAL_ERROR("unknown address family: %d",
330
          (int)sockaddr->type.sa.sa_family);
331
  }
332
#endif /* if (AF_INET == PF_INET && AF_INET6 == PF_INET6) */
333
0
}
334
335
void
336
isc_sockaddr_fromnetaddr(isc_sockaddr_t *sockaddr, const isc_netaddr_t *na,
337
0
       in_port_t port) {
338
0
  memset(sockaddr, 0, sizeof(*sockaddr));
339
0
  sockaddr->type.sin.sin_family = na->family;
340
0
  switch (na->family) {
341
0
  case AF_INET:
342
0
    sockaddr->length = sizeof(sockaddr->type.sin);
343
0
    sockaddr->type.sin.sin_addr = na->type.in;
344
0
    sockaddr->type.sin.sin_port = htons(port);
345
0
    break;
346
0
  case AF_INET6:
347
0
    sockaddr->length = sizeof(sockaddr->type.sin6);
348
0
    memmove(&sockaddr->type.sin6.sin6_addr, &na->type.in6, 16);
349
0
    sockaddr->type.sin6.sin6_scope_id = isc_netaddr_getzone(na);
350
0
    sockaddr->type.sin6.sin6_port = htons(port);
351
0
    break;
352
0
  default:
353
0
    UNREACHABLE();
354
0
  }
355
0
  ISC_LINK_INIT(sockaddr, link);
356
0
}
357
358
void
359
0
isc_sockaddr_setport(isc_sockaddr_t *sockaddr, in_port_t port) {
360
0
  switch (sockaddr->type.sa.sa_family) {
361
0
  case AF_INET:
362
0
    sockaddr->type.sin.sin_port = htons(port);
363
0
    break;
364
0
  case AF_INET6:
365
0
    sockaddr->type.sin6.sin6_port = htons(port);
366
0
    break;
367
0
  default:
368
0
    FATAL_ERROR("unknown address family: %d",
369
0
          (int)sockaddr->type.sa.sa_family);
370
0
  }
371
0
}
372
373
in_port_t
374
0
isc_sockaddr_getport(const isc_sockaddr_t *sockaddr) {
375
0
  in_port_t port = 0;
376
377
0
  switch (sockaddr->type.sa.sa_family) {
378
0
  case AF_INET:
379
0
    port = ntohs(sockaddr->type.sin.sin_port);
380
0
    break;
381
0
  case AF_INET6:
382
0
    port = ntohs(sockaddr->type.sin6.sin6_port);
383
0
    break;
384
0
  default:
385
0
    FATAL_ERROR("unknown address family: %d",
386
0
          (int)sockaddr->type.sa.sa_family);
387
0
  }
388
389
0
  return port;
390
0
}
391
392
bool
393
0
isc_sockaddr_ismulticast(const isc_sockaddr_t *sockaddr) {
394
0
  isc_netaddr_t netaddr;
395
396
0
  if (sockaddr->type.sa.sa_family == AF_INET ||
397
0
      sockaddr->type.sa.sa_family == AF_INET6)
398
0
  {
399
0
    isc_netaddr_fromsockaddr(&netaddr, sockaddr);
400
0
    return isc_netaddr_ismulticast(&netaddr);
401
0
  }
402
0
  return false;
403
0
}
404
405
bool
406
0
isc_sockaddr_isexperimental(const isc_sockaddr_t *sockaddr) {
407
0
  isc_netaddr_t netaddr;
408
409
0
  if (sockaddr->type.sa.sa_family == AF_INET) {
410
0
    isc_netaddr_fromsockaddr(&netaddr, sockaddr);
411
0
    return isc_netaddr_isexperimental(&netaddr);
412
0
  }
413
0
  return false;
414
0
}
415
416
bool
417
0
isc_sockaddr_issitelocal(const isc_sockaddr_t *sockaddr) {
418
0
  isc_netaddr_t netaddr;
419
420
0
  if (sockaddr->type.sa.sa_family == AF_INET6) {
421
0
    isc_netaddr_fromsockaddr(&netaddr, sockaddr);
422
0
    return isc_netaddr_issitelocal(&netaddr);
423
0
  }
424
0
  return false;
425
0
}
426
427
bool
428
0
isc_sockaddr_islinklocal(const isc_sockaddr_t *sockaddr) {
429
0
  isc_netaddr_t netaddr;
430
431
0
  if (sockaddr->type.sa.sa_family == AF_INET6) {
432
0
    isc_netaddr_fromsockaddr(&netaddr, sockaddr);
433
0
    return isc_netaddr_islinklocal(&netaddr);
434
0
  }
435
0
  return false;
436
0
}
437
438
bool
439
0
isc_sockaddr_isnetzero(const isc_sockaddr_t *sockaddr) {
440
0
  isc_netaddr_t netaddr;
441
442
0
  if (sockaddr->type.sa.sa_family == AF_INET) {
443
0
    isc_netaddr_fromsockaddr(&netaddr, sockaddr);
444
0
    return isc_netaddr_isnetzero(&netaddr);
445
0
  }
446
0
  return false;
447
0
}
448
449
isc_result_t
450
0
isc_sockaddr_fromsockaddr(isc_sockaddr_t *isa, const struct sockaddr *sa) {
451
0
  unsigned int length = 0;
452
453
0
  switch (sa->sa_family) {
454
0
  case AF_INET:
455
0
    length = sizeof(isa->type.sin);
456
0
    break;
457
0
  case AF_INET6:
458
0
    length = sizeof(isa->type.sin6);
459
0
    break;
460
0
  default:
461
0
    return ISC_R_NOTIMPLEMENTED;
462
0
  }
463
464
0
  *isa = (isc_sockaddr_t){ .length = length,
465
0
         .link = ISC_LINK_INITIALIZER };
466
0
  memmove(isa, sa, length);
467
468
0
  return ISC_R_SUCCESS;
469
0
}
470
471
bool
472
0
isc_sockaddr_disabled(const isc_sockaddr_t *sockaddr) {
473
0
  if ((sockaddr->type.sa.sa_family == AF_INET &&
474
0
       isc_net_probeipv4() == ISC_R_DISABLED) ||
475
0
      (sockaddr->type.sa.sa_family == AF_INET6 &&
476
0
       isc_net_probeipv6() == ISC_R_DISABLED))
477
0
  {
478
0
    return true;
479
0
  }
480
0
  return false;
481
0
}