contrib/bind9/lib/isc/sockaddr.c

   1 /*
   2  * Copyright (C) 2004-2007, 2010-2012, 2014, 2015  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 1999-2003  Internet Software Consortium.
   4  *
   5  * Permission to use, copy, modify, and/or distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  * PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 /* $Id$ */
  19
  20 /*! \file */
  21
  22 #include <config.h>
  23
  24 #include <stdio.h>
  25
  26 #include <isc/buffer.h>
  27 #include <isc/hash.h>
  28 #include <isc/msgs.h>
  29 #include <isc/netaddr.h>
  30 #include <isc/print.h>
  31 #include <isc/region.h>
  32 #include <isc/sockaddr.h>
  33 #include <isc/string.h>
  34 #include <isc/util.h>
  35
  36 isc_boolean_t
  37 isc_sockaddr_equal(const isc_sockaddr_t *a, const isc_sockaddr_t *b) {
  38         return (isc_sockaddr_compare(a, b, ISC_SOCKADDR_CMPADDR|
  39                                            ISC_SOCKADDR_CMPPORT|
  40                                            ISC_SOCKADDR_CMPSCOPE));
  41 }
  42
  43 isc_boolean_t
  44 isc_sockaddr_eqaddr(const isc_sockaddr_t *a, const isc_sockaddr_t *b) {
  45         return (isc_sockaddr_compare(a, b, ISC_SOCKADDR_CMPADDR|
  46                                            ISC_SOCKADDR_CMPSCOPE));
  47 }
  48
  49 isc_boolean_t
  50 isc_sockaddr_compare(const isc_sockaddr_t *a, const isc_sockaddr_t *b,
  51                      unsigned int flags)
  52 {
  53         REQUIRE(a != NULL && b != NULL);
  54
  55         if (a->length != b->length)
  56                 return (ISC_FALSE);
  57
  58         /*
  59          * We don't just memcmp because the sin_zero field isn't always
  60          * zero.
  61          */
  62
  63         if (a->type.sa.sa_family != b->type.sa.sa_family)
  64                 return (ISC_FALSE);
  65         switch (a->type.sa.sa_family) {
  66         case AF_INET:
  67                 if ((flags & ISC_SOCKADDR_CMPADDR) != 0 &&
  68                     memcmp(&a->type.sin.sin_addr, &b->type.sin.sin_addr,
  69                            sizeof(a->type.sin.sin_addr)) != 0)
  70                         return (ISC_FALSE);
  71                 if ((flags & ISC_SOCKADDR_CMPPORT) != 0 &&
  72                     a->type.sin.sin_port != b->type.sin.sin_port)
  73                         return (ISC_FALSE);
  74                 break;
  75         case AF_INET6:
  76                 if ((flags & ISC_SOCKADDR_CMPADDR) != 0 &&
  77                     memcmp(&a->type.sin6.sin6_addr, &b->type.sin6.sin6_addr,
  78                            sizeof(a->type.sin6.sin6_addr)) != 0)
  79                         return (ISC_FALSE);
  80 #ifdef ISC_PLATFORM_HAVESCOPEID
  81                 /*
  82                  * If ISC_SOCKADDR_CMPSCOPEZERO is set then don't return
  83                  * ISC_FALSE if one of the scopes in zero.
  84                  */
  85                 if ((flags & ISC_SOCKADDR_CMPSCOPE) != 0 &&
  86                     a->type.sin6.sin6_scope_id != b->type.sin6.sin6_scope_id &&
  87                     ((flags & ISC_SOCKADDR_CMPSCOPEZERO) == 0 ||
  88                       (a->type.sin6.sin6_scope_id != 0 &&
  89                        b->type.sin6.sin6_scope_id != 0)))
  90                         return (ISC_FALSE);
  91 #endif
  92                 if ((flags & ISC_SOCKADDR_CMPPORT) != 0 &&
  93                     a->type.sin6.sin6_port != b->type.sin6.sin6_port)
  94                         return (ISC_FALSE);
  95                 break;
  96         default:
  97                 if (memcmp(&a->type, &b->type, a->length) != 0)
  98                         return (ISC_FALSE);
  99         }
 100         return (ISC_TRUE);
 101 }
 102
 103 isc_boolean_t
 104 isc_sockaddr_eqaddrprefix(const isc_sockaddr_t *a, const isc_sockaddr_t *b,
 105                           unsigned int prefixlen)
 106 {
 107         isc_netaddr_t na, nb;
 108         isc_netaddr_fromsockaddr(&na, a);
 109         isc_netaddr_fromsockaddr(&nb, b);
 110         return (isc_netaddr_eqprefix(&na, &nb, prefixlen));
 111 }
 112
 113 isc_result_t
 114 isc_sockaddr_totext(const isc_sockaddr_t *sockaddr, isc_buffer_t *target) {
 115         isc_result_t result;
 116         isc_netaddr_t netaddr;
 117         char pbuf[sizeof("65000")];
 118         unsigned int plen;
 119         isc_region_t avail;
 120
 121         REQUIRE(sockaddr != NULL);
 122
 123         /*
 124          * Do the port first, giving us the opportunity to check for
 125          * unsupported address families before calling
 126          * isc_netaddr_fromsockaddr().
 127          */
 128         switch (sockaddr->type.sa.sa_family) {
 129         case AF_INET:
 130                 snprintf(pbuf, sizeof(pbuf), "%u", ntohs(sockaddr->type.sin.sin_port));
 131                 break;
 132         case AF_INET6:
 133                 snprintf(pbuf, sizeof(pbuf), "%u", ntohs(sockaddr->type.sin6.sin6_port));
 134                 break;
 135 #ifdef ISC_PLAFORM_HAVESYSUNH
 136         case AF_UNIX:
 137                 plen = strlen(sockaddr->type.sunix.sun_path);
 138                 if (plen >= isc_buffer_availablelength(target))
 139                         return (ISC_R_NOSPACE);
 140
 141                 isc_buffer_putmem(target, sockaddr->type.sunix.sun_path, plen);
 142
 143                 /*
 144                  * Null terminate after used region.
 145                  */
 146                 isc_buffer_availableregion(target, &avail);
 147                 INSIST(avail.length >= 1);
 148                 avail.base[0] = '\0';
 149
 150                 return (ISC_R_SUCCESS);
 151 #endif
 152         default:
 153                 return (ISC_R_FAILURE);
 154         }
 155
 156         plen = strlen(pbuf);
 157         INSIST(plen < sizeof(pbuf));
 158
 159         isc_netaddr_fromsockaddr(&netaddr, sockaddr);
 160         result = isc_netaddr_totext(&netaddr, target);
 161         if (result != ISC_R_SUCCESS)
 162                 return (result);
 163
 164         if (1 + plen + 1 > isc_buffer_availablelength(target))
 165                 return (ISC_R_NOSPACE);
 166
 167         isc_buffer_putmem(target, (const unsigned char *)"#", 1);
 168         isc_buffer_putmem(target, (const unsigned char *)pbuf, plen);
 169
 170         /*
 171          * Null terminate after used region.
 172          */
 173         isc_buffer_availableregion(target, &avail);
 174         INSIST(avail.length >= 1);
 175         avail.base[0] = '\0';
 176
 177         return (ISC_R_SUCCESS);
 178 }
 179
 180 void
 181 isc_sockaddr_format(const isc_sockaddr_t *sa, char *array, unsigned int size) {
 182         isc_result_t result;
 183         isc_buffer_t buf;
 184
 185         if (size == 0U)
 186                 return;
 187
 188         isc_buffer_init(&buf, array, size);
 189         result = isc_sockaddr_totext(sa, &buf);
 190         if (result != ISC_R_SUCCESS) {
 191                 /*
 192                  * The message is the same as in netaddr.c.
 193                  */
 194                 snprintf(array, size,
 195                          isc_msgcat_get(isc_msgcat, ISC_MSGSET_NETADDR,
 196                                         ISC_MSG_UNKNOWNADDR,
 197                                         "<unknown address, family %u>"),
 198                          sa->type.sa.sa_family);
 199                 array[size - 1] = '\0';
 200         }
 201 }
 202
 203 unsigned int
 204 isc_sockaddr_hash(const isc_sockaddr_t *sockaddr, isc_boolean_t address_only) {
 205         unsigned int length = 0;
 206         const unsigned char *s = NULL;
 207         unsigned int h = 0;
 208         unsigned int p = 0;
 209         const struct in6_addr *in6;
 210
 211         REQUIRE(sockaddr != NULL);
 212
 213         switch (sockaddr->type.sa.sa_family) {
 214         case AF_INET:
 215                 s = (const unsigned char *)&sockaddr->type.sin.sin_addr;
 216                 p = ntohs(sockaddr->type.sin.sin_port);
 217                 length = sizeof(sockaddr->type.sin.sin_addr.s_addr);
 218                 break;
 219         case AF_INET6:
 220                 in6 = &sockaddr->type.sin6.sin6_addr;
 221                 s = (const unsigned char *)in6;
 222                 if (IN6_IS_ADDR_V4MAPPED(in6)) {
 223                         s += 12;
 224                         length = sizeof(sockaddr->type.sin.sin_addr.s_addr);
 225                 } else
 226                         length = sizeof(sockaddr->type.sin6.sin6_addr);
 227                 p = ntohs(sockaddr->type.sin6.sin6_port);
 228                 break;
 229         default:
 230                 UNEXPECTED_ERROR(__FILE__, __LINE__,
 231                                  isc_msgcat_get(isc_msgcat,
 232                                                 ISC_MSGSET_SOCKADDR,
 233                                                 ISC_MSG_UNKNOWNFAMILY,
 234                                                 "unknown address family: %d"),
 235                                              (int)sockaddr->type.sa.sa_family);
 236                 s = (const unsigned char *)&sockaddr->type;
 237                 length = sockaddr->length;
 238                 p = 0;
 239         }
 240
 241         h = isc_hash_function(s, length, ISC_TRUE, NULL);
 242         if (!address_only)
 243                 h = isc_hash_function(&p, sizeof(p), ISC_TRUE, &h);
 244
 245         return (h);
 246 }
 247
 248 void
 249 isc_sockaddr_any(isc_sockaddr_t *sockaddr)
 250 {
 251         memset(sockaddr, 0, sizeof(*sockaddr));
 252         sockaddr->type.sin.sin_family = AF_INET;
 253 #ifdef ISC_PLATFORM_HAVESALEN
 254         sockaddr->type.sin.sin_len = sizeof(sockaddr->type.sin);
 255 #endif
 256         sockaddr->type.sin.sin_addr.s_addr = INADDR_ANY;
 257         sockaddr->type.sin.sin_port = 0;
 258         sockaddr->length = sizeof(sockaddr->type.sin);
 259         ISC_LINK_INIT(sockaddr, link);
 260 }
 261
 262 void
 263 isc_sockaddr_any6(isc_sockaddr_t *sockaddr)
 264 {
 265         memset(sockaddr, 0, sizeof(*sockaddr));
 266         sockaddr->type.sin6.sin6_family = AF_INET6;
 267 #ifdef ISC_PLATFORM_HAVESALEN
 268         sockaddr->type.sin6.sin6_len = sizeof(sockaddr->type.sin6);
 269 #endif
 270         sockaddr->type.sin6.sin6_addr = in6addr_any;
 271         sockaddr->type.sin6.sin6_port = 0;
 272         sockaddr->length = sizeof(sockaddr->type.sin6);
 273         ISC_LINK_INIT(sockaddr, link);
 274 }
 275
 276 void
 277 isc_sockaddr_fromin(isc_sockaddr_t *sockaddr, const struct in_addr *ina,
 278                     in_port_t port)
 279 {
 280         memset(sockaddr, 0, sizeof(*sockaddr));
 281         sockaddr->type.sin.sin_family = AF_INET;
 282 #ifdef ISC_PLATFORM_HAVESALEN
 283         sockaddr->type.sin.sin_len = sizeof(sockaddr->type.sin);
 284 #endif
 285         sockaddr->type.sin.sin_addr = *ina;
 286         sockaddr->type.sin.sin_port = htons(port);
 287         sockaddr->length = sizeof(sockaddr->type.sin);
 288         ISC_LINK_INIT(sockaddr, link);
 289 }
 290
 291 void
 292 isc_sockaddr_anyofpf(isc_sockaddr_t *sockaddr, int pf) {
 293      switch (pf) {
 294      case AF_INET:
 295              isc_sockaddr_any(sockaddr);
 296              break;
 297      case AF_INET6:
 298              isc_sockaddr_any6(sockaddr);
 299              break;
 300      default:
 301              INSIST(0);
 302      }
 303 }
 304
 305 void
 306 isc_sockaddr_fromin6(isc_sockaddr_t *sockaddr, const struct in6_addr *ina6,
 307                      in_port_t port)
 308 {
 309         memset(sockaddr, 0, sizeof(*sockaddr));
 310         sockaddr->type.sin6.sin6_family = AF_INET6;
 311 #ifdef ISC_PLATFORM_HAVESALEN
 312         sockaddr->type.sin6.sin6_len = sizeof(sockaddr->type.sin6);
 313 #endif
 314         sockaddr->type.sin6.sin6_addr = *ina6;
 315         sockaddr->type.sin6.sin6_port = htons(port);
 316         sockaddr->length = sizeof(sockaddr->type.sin6);
 317         ISC_LINK_INIT(sockaddr, link);
 318 }
 319
 320 void
 321 isc_sockaddr_v6fromin(isc_sockaddr_t *sockaddr, const struct in_addr *ina,
 322                       in_port_t port)
 323 {
 324         memset(sockaddr, 0, sizeof(*sockaddr));
 325         sockaddr->type.sin6.sin6_family = AF_INET6;
 326 #ifdef ISC_PLATFORM_HAVESALEN
 327         sockaddr->type.sin6.sin6_len = sizeof(sockaddr->type.sin6);
 328 #endif
 329         sockaddr->type.sin6.sin6_addr.s6_addr[10] = 0xff;
 330         sockaddr->type.sin6.sin6_addr.s6_addr[11] = 0xff;
 331         memmove(&sockaddr->type.sin6.sin6_addr.s6_addr[12], ina, 4);
 332         sockaddr->type.sin6.sin6_port = htons(port);
 333         sockaddr->length = sizeof(sockaddr->type.sin6);
 334         ISC_LINK_INIT(sockaddr, link);
 335 }
 336
 337 int
 338 isc_sockaddr_pf(const isc_sockaddr_t *sockaddr) {
 339
 340         /*
 341          * Get the protocol family of 'sockaddr'.
 342          */
 343
 344 #if (AF_INET == PF_INET && AF_INET6 == PF_INET6)
 345         /*
 346          * Assume that PF_xxx == AF_xxx for all AF and PF.
 347          */
 348         return (sockaddr->type.sa.sa_family);
 349 #else
 350         switch (sockaddr->type.sa.sa_family) {
 351         case AF_INET:
 352                 return (PF_INET);
 353         case AF_INET6:
 354                 return (PF_INET6);
 355         default:
 356                 FATAL_ERROR(__FILE__, __LINE__,
 357                             isc_msgcat_get(isc_msgcat, ISC_MSGSET_SOCKADDR,
 358                                            ISC_MSG_UNKNOWNFAMILY,
 359                                            "unknown address family: %d"),
 360                             (int)sockaddr->type.sa.sa_family);
 361         }
 362 #endif
 363 }
 364
 365 void
 366 isc_sockaddr_fromnetaddr(isc_sockaddr_t *sockaddr, const isc_netaddr_t *na,
 367                          in_port_t port)
 368 {
 369         memset(sockaddr, 0, sizeof(*sockaddr));
 370         sockaddr->type.sin.sin_family = na->family;
 371         switch (na->family) {
 372         case AF_INET:
 373                 sockaddr->length = sizeof(sockaddr->type.sin);
 374 #ifdef ISC_PLATFORM_HAVESALEN
 375                 sockaddr->type.sin.sin_len = sizeof(sockaddr->type.sin);
 376 #endif
 377                 sockaddr->type.sin.sin_addr = na->type.in;
 378                 sockaddr->type.sin.sin_port = htons(port);
 379                 break;
 380         case AF_INET6:
 381                 sockaddr->length = sizeof(sockaddr->type.sin6);
 382 #ifdef ISC_PLATFORM_HAVESALEN
 383                 sockaddr->type.sin6.sin6_len = sizeof(sockaddr->type.sin6);
 384 #endif
 385                 memmove(&sockaddr->type.sin6.sin6_addr, &na->type.in6, 16);
 386 #ifdef ISC_PLATFORM_HAVESCOPEID
 387                 sockaddr->type.sin6.sin6_scope_id = isc_netaddr_getzone(na);
 388 #endif
 389                 sockaddr->type.sin6.sin6_port = htons(port);
 390                 break;
 391         default:
 392                 INSIST(0);
 393         }
 394         ISC_LINK_INIT(sockaddr, link);
 395 }
 396
 397 void
 398 isc_sockaddr_setport(isc_sockaddr_t *sockaddr, in_port_t port) {
 399         switch (sockaddr->type.sa.sa_family) {
 400         case AF_INET:
 401                 sockaddr->type.sin.sin_port = htons(port);
 402                 break;
 403         case AF_INET6:
 404                 sockaddr->type.sin6.sin6_port = htons(port);
 405                 break;
 406         default:
 407                 FATAL_ERROR(__FILE__, __LINE__,
 408                             isc_msgcat_get(isc_msgcat, ISC_MSGSET_SOCKADDR,
 409                                            ISC_MSG_UNKNOWNFAMILY,
 410                                            "unknown address family: %d"),
 411                             (int)sockaddr->type.sa.sa_family);
 412         }
 413 }
 414
 415 in_port_t
 416 isc_sockaddr_getport(const isc_sockaddr_t *sockaddr) {
 417         in_port_t port = 0;
 418
 419         switch (sockaddr->type.sa.sa_family) {
 420         case AF_INET:
 421                 port = ntohs(sockaddr->type.sin.sin_port);
 422                 break;
 423         case AF_INET6:
 424                 port = ntohs(sockaddr->type.sin6.sin6_port);
 425                 break;
 426         default:
 427                 FATAL_ERROR(__FILE__, __LINE__,
 428                             isc_msgcat_get(isc_msgcat, ISC_MSGSET_SOCKADDR,
 429                                            ISC_MSG_UNKNOWNFAMILY,
 430                                            "unknown address family: %d"),
 431                             (int)sockaddr->type.sa.sa_family);
 432         }
 433
 434         return (port);
 435 }
 436
 437 isc_boolean_t
 438 isc_sockaddr_ismulticast(const isc_sockaddr_t *sockaddr) {
 439         isc_netaddr_t netaddr;
 440
 441         if (sockaddr->type.sa.sa_family == AF_INET ||
 442             sockaddr->type.sa.sa_family == AF_INET6) {
 443                 isc_netaddr_fromsockaddr(&netaddr, sockaddr);
 444                 return (isc_netaddr_ismulticast(&netaddr));
 445         }
 446         return (ISC_FALSE);
 447 }
 448
 449 isc_boolean_t
 450 isc_sockaddr_isexperimental(const isc_sockaddr_t *sockaddr) {
 451         isc_netaddr_t netaddr;
 452
 453         if (sockaddr->type.sa.sa_family == AF_INET) {
 454                 isc_netaddr_fromsockaddr(&netaddr, sockaddr);
 455                 return (isc_netaddr_isexperimental(&netaddr));
 456         }
 457         return (ISC_FALSE);
 458 }
 459
 460 isc_boolean_t
 461 isc_sockaddr_issitelocal(const isc_sockaddr_t *sockaddr) {
 462         isc_netaddr_t netaddr;
 463
 464         if (sockaddr->type.sa.sa_family == AF_INET6) {
 465                 isc_netaddr_fromsockaddr(&netaddr, sockaddr);
 466                 return (isc_netaddr_issitelocal(&netaddr));
 467         }
 468         return (ISC_FALSE);
 469 }
 470
 471 isc_boolean_t
 472 isc_sockaddr_islinklocal(const isc_sockaddr_t *sockaddr) {
 473         isc_netaddr_t netaddr;
 474
 475         if (sockaddr->type.sa.sa_family == AF_INET6) {
 476                 isc_netaddr_fromsockaddr(&netaddr, sockaddr);
 477                 return (isc_netaddr_islinklocal(&netaddr));
 478         }
 479         return (ISC_FALSE);
 480 }
 481
 482 isc_boolean_t
 483 isc_sockaddr_isnetzero(const isc_sockaddr_t *sockaddr) {
 484         isc_netaddr_t netaddr;
 485
 486         if (sockaddr->type.sa.sa_family == AF_INET) {
 487                 isc_netaddr_fromsockaddr(&netaddr, sockaddr);
 488                 return (isc_netaddr_isnetzero(&netaddr));
 489         }
 490         return (ISC_FALSE);
 491 }
 492
 493 isc_result_t
 494 isc_sockaddr_frompath(isc_sockaddr_t *sockaddr, const char *path) {
 495 #ifdef ISC_PLATFORM_HAVESYSUNH
 496         if (strlen(path) >= sizeof(sockaddr->type.sunix.sun_path))
 497                 return (ISC_R_NOSPACE);
 498         memset(sockaddr, 0, sizeof(*sockaddr));
 499         sockaddr->length = sizeof(sockaddr->type.sunix);
 500         sockaddr->type.sunix.sun_family = AF_UNIX;
 501 #ifdef ISC_PLATFORM_HAVESALEN
 502         sockaddr->type.sunix.sun_len =
 503                         (unsigned char)sizeof(sockaddr->type.sunix);
 504 #endif
 505         strcpy(sockaddr->type.sunix.sun_path, path);
 506         return (ISC_R_SUCCESS);
 507 #else
 508         UNUSED(sockaddr);
 509         UNUSED(path);
 510         return (ISC_R_NOTIMPLEMENTED);
 511 #endif
 512 }