lib/sockunion.c

   1 /* Socket union related function.
   2  * Copyright (c) 1997, 98 Kunihiro Ishiguro
   3  *
   4  * This file is part of GNU Zebra.
   5  *
   6  * GNU Zebra is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; either version 2, or (at your option) any
   9  * later version.
  10  *
  11  * GNU Zebra is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; see the file COPYING; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #include <zebra.h>
  22
  23 #include "prefix.h"
  24 #include "vty.h"
  25 #include "sockunion.h"
  26 #include "memory.h"
  27 #include "log.h"
  28 #include "jhash.h"
  29 #include "lib_errors.h"
  30
  31 DEFINE_MTYPE_STATIC(LIB, SOCKUNION, "Socket union")
  32
  33 const char *inet_sutop(const union sockunion *su, char *str)
  34 {
  35         switch (su->sa.sa_family) {
  36         case AF_INET:
  37                 inet_ntop(AF_INET, &su->sin.sin_addr, str, INET_ADDRSTRLEN);
  38                 break;
  39         case AF_INET6:
  40                 inet_ntop(AF_INET6, &su->sin6.sin6_addr, str, INET6_ADDRSTRLEN);
  41                 break;
  42         }
  43         return str;
  44 }
  45
  46 int str2sockunion(const char *str, union sockunion *su)
  47 {
  48         int ret;
  49
  50         if (str == NULL)
  51                 return -1;
  52
  53         memset(su, 0, sizeof(union sockunion));
  54
  55         ret = inet_pton(AF_INET, str, &su->sin.sin_addr);
  56         if (ret > 0) /* Valid IPv4 address format. */
  57         {
  58                 su->sin.sin_family = AF_INET;
  59 #ifdef HAVE_STRUCT_SOCKADDR_IN_SIN_LEN
  60                 su->sin.sin_len = sizeof(struct sockaddr_in);
  61 #endif /* HAVE_STRUCT_SOCKADDR_IN_SIN_LEN */
  62                 return 0;
  63         }
  64         ret = inet_pton(AF_INET6, str, &su->sin6.sin6_addr);
  65         if (ret > 0) /* Valid IPv6 address format. */
  66         {
  67                 su->sin6.sin6_family = AF_INET6;
  68 #ifdef SIN6_LEN
  69                 su->sin6.sin6_len = sizeof(struct sockaddr_in6);
  70 #endif /* SIN6_LEN */
  71                 return 0;
  72         }
  73         return -1;
  74 }
  75
  76 const char *sockunion2str(const union sockunion *su, char *buf, size_t len)
  77 {
  78         switch (sockunion_family(su)) {
  79         case AF_UNSPEC:
  80                 snprintf(buf, len, "(unspec)");
  81                 return buf;
  82         case AF_INET:
  83                 return inet_ntop(AF_INET, &su->sin.sin_addr, buf, len);
  84         case AF_INET6:
  85                 return inet_ntop(AF_INET6, &su->sin6.sin6_addr, buf, len);
  86         }
  87         snprintf(buf, len, "(af %d)", sockunion_family(su));
  88         return buf;
  89 }
  90
  91 union sockunion *sockunion_str2su(const char *str)
  92 {
  93         union sockunion *su = XCALLOC(MTYPE_SOCKUNION, sizeof(union sockunion));
  94
  95         if (!str2sockunion(str, su))
  96                 return su;
  97
  98         XFREE(MTYPE_SOCKUNION, su);
  99         return NULL;
 100 }
 101
 102 /* Convert IPv4 compatible IPv6 address to IPv4 address. */
 103 static void sockunion_normalise_mapped(union sockunion *su)
 104 {
 105         struct sockaddr_in sin;
 106
 107         if (su->sa.sa_family == AF_INET6
 108             && IN6_IS_ADDR_V4MAPPED(&su->sin6.sin6_addr)) {
 109                 memset(&sin, 0, sizeof(struct sockaddr_in));
 110                 sin.sin_family = AF_INET;
 111                 sin.sin_port = su->sin6.sin6_port;
 112                 memcpy(&sin.sin_addr, ((char *)&su->sin6.sin6_addr) + 12, 4);
 113                 memcpy(su, &sin, sizeof(struct sockaddr_in));
 114         }
 115 }
 116
 117 /* return sockunion structure : this function should be revised. */
 118 static const char *sockunion_log(const union sockunion *su, char *buf,
 119                                  size_t len)
 120 {
 121         switch (su->sa.sa_family) {
 122         case AF_INET:
 123                 return inet_ntop(AF_INET, &su->sin.sin_addr, buf, len);
 124
 125         case AF_INET6:
 126                 return inet_ntop(AF_INET6, &(su->sin6.sin6_addr), buf, len);
 127                 break;
 128
 129         default:
 130                 snprintf(buf, len, "af_unknown %d ", su->sa.sa_family);
 131                 return buf;
 132         }
 133 }
 134
 135 /* Return socket of sockunion. */
 136 int sockunion_socket(const union sockunion *su)
 137 {
 138         int sock;
 139
 140         sock = socket(su->sa.sa_family, SOCK_STREAM, 0);
 141         if (sock < 0) {
 142                 char buf[SU_ADDRSTRLEN];
 143                 zlog_warn("Can't make socket for %s : %s",
 144                           sockunion_log(su, buf, SU_ADDRSTRLEN),
 145                           safe_strerror(errno));
 146                 return -1;
 147         }
 148
 149         return sock;
 150 }
 151
 152 /* Return accepted new socket file descriptor. */
 153 int sockunion_accept(int sock, union sockunion *su)
 154 {
 155         socklen_t len;
 156         int client_sock;
 157
 158         len = sizeof(union sockunion);
 159         client_sock = accept(sock, (struct sockaddr *)su, &len);
 160
 161         sockunion_normalise_mapped(su);
 162         return client_sock;
 163 }
 164
 165 /* Return sizeof union sockunion.  */
 166 static int sockunion_sizeof(const union sockunion *su)
 167 {
 168         int ret;
 169
 170         ret = 0;
 171         switch (su->sa.sa_family) {
 172         case AF_INET:
 173                 ret = sizeof(struct sockaddr_in);
 174                 break;
 175         case AF_INET6:
 176                 ret = sizeof(struct sockaddr_in6);
 177                 break;
 178         }
 179         return ret;
 180 }
 181
 182 /* Performs a non-blocking connect().  */
 183 enum connect_result sockunion_connect(int fd, const union sockunion *peersu,
 184                                       unsigned short port, ifindex_t ifindex)
 185 {
 186         int ret;
 187         union sockunion su;
 188
 189         memcpy(&su, peersu, sizeof(union sockunion));
 190
 191         switch (su.sa.sa_family) {
 192         case AF_INET:
 193                 su.sin.sin_port = port;
 194                 break;
 195         case AF_INET6:
 196                 su.sin6.sin6_port = port;
 197 #ifdef KAME
 198                 if (IN6_IS_ADDR_LINKLOCAL(&su.sin6.sin6_addr) && ifindex) {
 199                         su.sin6.sin6_scope_id = ifindex;
 200                         SET_IN6_LINKLOCAL_IFINDEX(su.sin6.sin6_addr, ifindex);
 201                 }
 202 #endif /* KAME */
 203                 break;
 204         }
 205
 206         /* Call connect function. */
 207         ret = connect(fd, (struct sockaddr *)&su, sockunion_sizeof(&su));
 208
 209         /* Immediate success */
 210         if (ret == 0)
 211                 return connect_success;
 212
 213         /* If connect is in progress then return 1 else it's real error. */
 214         if (ret < 0) {
 215                 if (errno != EINPROGRESS) {
 216                         char str[SU_ADDRSTRLEN];
 217                         zlog_info("can't connect to %s fd %d : %s",
 218                                   sockunion_log(&su, str, sizeof str), fd,
 219                                   safe_strerror(errno));
 220                         return connect_error;
 221                 }
 222         }
 223
 224         return connect_in_progress;
 225 }
 226
 227 /* Make socket from sockunion union. */
 228 int sockunion_stream_socket(union sockunion *su)
 229 {
 230         int sock;
 231
 232         if (su->sa.sa_family == 0)
 233                 su->sa.sa_family = AF_INET_UNION;
 234
 235         sock = socket(su->sa.sa_family, SOCK_STREAM, 0);
 236
 237         if (sock < 0)
 238                 zlog_warn("can't make socket sockunion_stream_socket");
 239
 240         return sock;
 241 }
 242
 243 /* Bind socket to specified address. */
 244 int sockunion_bind(int sock, union sockunion *su, unsigned short port,
 245                    union sockunion *su_addr)
 246 {
 247         int size = 0;
 248         int ret;
 249
 250         if (su->sa.sa_family == AF_INET) {
 251                 size = sizeof(struct sockaddr_in);
 252                 su->sin.sin_port = htons(port);
 253 #ifdef HAVE_STRUCT_SOCKADDR_IN_SIN_LEN
 254                 su->sin.sin_len = size;
 255 #endif /* HAVE_STRUCT_SOCKADDR_IN_SIN_LEN */
 256                 if (su_addr == NULL)
 257                         sockunion2ip(su) = htonl(INADDR_ANY);
 258         } else if (su->sa.sa_family == AF_INET6) {
 259                 size = sizeof(struct sockaddr_in6);
 260                 su->sin6.sin6_port = htons(port);
 261 #ifdef SIN6_LEN
 262                 su->sin6.sin6_len = size;
 263 #endif /* SIN6_LEN */
 264                 if (su_addr == NULL) {
 265 #ifdef LINUX_IPV6
 266                         memset(&su->sin6.sin6_addr, 0, sizeof(struct in6_addr));
 267 #else
 268                         su->sin6.sin6_addr = in6addr_any;
 269 #endif /* LINUX_IPV6 */
 270                 }
 271         }
 272
 273         ret = bind(sock, (struct sockaddr *)su, size);
 274         if (ret < 0) {
 275                 char buf[SU_ADDRSTRLEN];
 276                 zlog_warn("can't bind socket for %s : %s",
 277                           sockunion_log(su, buf, SU_ADDRSTRLEN),
 278                           safe_strerror(errno));
 279         }
 280
 281         return ret;
 282 }
 283
 284 int sockopt_reuseaddr(int sock)
 285 {
 286         int ret;
 287         int on = 1;
 288
 289         ret = setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, (void *)&on,
 290                          sizeof(on));
 291         if (ret < 0) {
 292                 zlog_warn("can't set sockopt SO_REUSEADDR to socket %d", sock);
 293                 return -1;
 294         }
 295         return 0;
 296 }
 297
 298 #ifdef SO_REUSEPORT
 299 int sockopt_reuseport(int sock)
 300 {
 301         int ret;
 302         int on = 1;
 303
 304         ret = setsockopt(sock, SOL_SOCKET, SO_REUSEPORT, (void *)&on,
 305                          sizeof(on));
 306         if (ret < 0) {
 307                 zlog_warn("can't set sockopt SO_REUSEPORT to socket %d", sock);
 308                 return -1;
 309         }
 310         return 0;
 311 }
 312 #else
 313 int sockopt_reuseport(int sock)
 314 {
 315         return 0;
 316 }
 317 #endif /* 0 */
 318
 319 int sockopt_ttl(int family, int sock, int ttl)
 320 {
 321         int ret;
 322
 323 #ifdef IP_TTL
 324         if (family == AF_INET) {
 325                 ret = setsockopt(sock, IPPROTO_IP, IP_TTL, (void *)&ttl,
 326                                  sizeof(int));
 327                 if (ret < 0) {
 328                         zlog_warn("can't set sockopt IP_TTL %d to socket %d",
 329                                   ttl, sock);
 330                         return -1;
 331                 }
 332                 return 0;
 333         }
 334 #endif /* IP_TTL */
 335         if (family == AF_INET6) {
 336                 ret = setsockopt(sock, IPPROTO_IPV6, IPV6_UNICAST_HOPS,
 337                                  (void *)&ttl, sizeof(int));
 338                 if (ret < 0) {
 339                         zlog_warn(
 340                                 "can't set sockopt IPV6_UNICAST_HOPS %d to socket %d",
 341                                 ttl, sock);
 342                         return -1;
 343                 }
 344                 return 0;
 345         }
 346         return 0;
 347 }
 348
 349 /*
 350  * This function called setsockopt(.., TCP_CORK,...)
 351  * Which on linux is a no-op since it is enabled by
 352  * default and on BSD it uses TCP_NOPUSH to do
 353  * the same thing( which it was not configured to
 354  * use).  This cleanup of the api occured on 8/1/17
 355  * I imagine if after more than 1 year of no-one
 356  * complaining, and a major upgrade release we
 357  * can deprecate and remove this function call
 358  */
 359 int sockopt_cork(int sock, int onoff)
 360 {
 361         return 0;
 362 }
 363
 364 int sockopt_mark_default(int sock, int mark, struct zebra_privs_t *cap)
 365 {
 366 #ifdef SO_MARK
 367         int ret;
 368
 369         frr_elevate_privs(cap) {
 370                 ret = setsockopt(sock, SOL_SOCKET, SO_MARK, &mark,
 371                                  sizeof(mark));
 372         }
 373         return ret;
 374 #else
 375         return 0;
 376 #endif
 377 }
 378
 379 int sockopt_minttl(int family, int sock, int minttl)
 380 {
 381 #ifdef IP_MINTTL
 382         if (family == AF_INET) {
 383                 int ret = setsockopt(sock, IPPROTO_IP, IP_MINTTL, &minttl,
 384                                      sizeof(minttl));
 385                 if (ret < 0)
 386                         zlog_warn(
 387                                 "can't set sockopt IP_MINTTL to %d on socket %d: %s",
 388                                 minttl, sock, safe_strerror(errno));
 389                 return ret;
 390         }
 391 #endif /* IP_MINTTL */
 392 #ifdef IPV6_MINHOPCOUNT
 393         if (family == AF_INET6) {
 394                 int ret = setsockopt(sock, IPPROTO_IPV6, IPV6_MINHOPCOUNT,
 395                                      &minttl, sizeof(minttl));
 396                 if (ret < 0)
 397                         zlog_warn(
 398                                 "can't set sockopt IPV6_MINHOPCOUNT to %d on socket %d: %s",
 399                                 minttl, sock, safe_strerror(errno));
 400                 return ret;
 401         }
 402 #endif
 403
 404         errno = EOPNOTSUPP;
 405         return -1;
 406 }
 407
 408 int sockopt_v6only(int family, int sock)
 409 {
 410         int ret, on = 1;
 411
 412 #ifdef IPV6_V6ONLY
 413         if (family == AF_INET6) {
 414                 ret = setsockopt(sock, IPPROTO_IPV6, IPV6_V6ONLY, (void *)&on,
 415                                  sizeof(int));
 416                 if (ret < 0) {
 417                         zlog_warn(
 418                                 "can't set sockopt IPV6_V6ONLY "
 419                                 "to socket %d",
 420                                 sock);
 421                         return -1;
 422                 }
 423                 return 0;
 424         }
 425 #endif /* IPV6_V6ONLY */
 426         return 0;
 427 }
 428
 429 /* If same family and same prefix return 1. */
 430 int sockunion_same(const union sockunion *su1, const union sockunion *su2)
 431 {
 432         int ret = 0;
 433
 434         if (su1->sa.sa_family != su2->sa.sa_family)
 435                 return 0;
 436
 437         switch (su1->sa.sa_family) {
 438         case AF_INET:
 439                 ret = memcmp(&su1->sin.sin_addr, &su2->sin.sin_addr,
 440                              sizeof(struct in_addr));
 441                 break;
 442         case AF_INET6:
 443                 ret = memcmp(&su1->sin6.sin6_addr, &su2->sin6.sin6_addr,
 444                              sizeof(struct in6_addr));
 445                 if ((ret == 0) && IN6_IS_ADDR_LINKLOCAL(&su1->sin6.sin6_addr)) {
 446                         /* compare interface indices */
 447                         if (su1->sin6.sin6_scope_id && su2->sin6.sin6_scope_id)
 448                                 ret = (su1->sin6.sin6_scope_id
 449                                        == su2->sin6.sin6_scope_id)
 450                                               ? 0
 451                                               : 1;
 452                 }
 453                 break;
 454         }
 455         if (ret == 0)
 456                 return 1;
 457         else
 458                 return 0;
 459 }
 460
 461 unsigned int sockunion_hash(const union sockunion *su)
 462 {
 463         switch (sockunion_family(su)) {
 464         case AF_INET:
 465                 return jhash_1word(su->sin.sin_addr.s_addr, 0);
 466         case AF_INET6:
 467                 return jhash2(su->sin6.sin6_addr.s6_addr32,
 468                               ZEBRA_NUM_OF(su->sin6.sin6_addr.s6_addr32), 0);
 469         }
 470         return 0;
 471 }
 472
 473 size_t family2addrsize(int family)
 474 {
 475         switch (family) {
 476         case AF_INET:
 477                 return sizeof(struct in_addr);
 478         case AF_INET6:
 479                 return sizeof(struct in6_addr);
 480         }
 481         return 0;
 482 }
 483
 484 size_t sockunion_get_addrlen(const union sockunion *su)
 485 {
 486         return family2addrsize(sockunion_family(su));
 487 }
 488
 489 const uint8_t *sockunion_get_addr(const union sockunion *su)
 490 {
 491         switch (sockunion_family(su)) {
 492         case AF_INET:
 493                 return (const uint8_t *)&su->sin.sin_addr.s_addr;
 494         case AF_INET6:
 495                 return (const uint8_t *)&su->sin6.sin6_addr;
 496         }
 497         return NULL;
 498 }
 499
 500 void sockunion_set(union sockunion *su, int family, const uint8_t *addr,
 501                    size_t bytes)
 502 {
 503         if (family2addrsize(family) != bytes)
 504                 return;
 505
 506         sockunion_family(su) = family;
 507         switch (family) {
 508         case AF_INET:
 509                 memcpy(&su->sin.sin_addr.s_addr, addr, bytes);
 510                 break;
 511         case AF_INET6:
 512                 memcpy(&su->sin6.sin6_addr, addr, bytes);
 513                 break;
 514         }
 515 }
 516
 517 /* After TCP connection is established.  Get local address and port. */
 518 union sockunion *sockunion_getsockname(int fd)
 519 {
 520         int ret;
 521         socklen_t len;
 522         union {
 523                 struct sockaddr sa;
 524                 struct sockaddr_in sin;
 525                 struct sockaddr_in6 sin6;
 526                 char tmp_buffer[128];
 527         } name;
 528         union sockunion *su;
 529
 530         memset(&name, 0, sizeof name);
 531         len = sizeof name;
 532
 533         ret = getsockname(fd, (struct sockaddr *)&name, &len);
 534         if (ret < 0) {
 535                 zlog_warn("Can't get local address and port by getsockname: %s",
 536                           safe_strerror(errno));
 537                 return NULL;
 538         }
 539
 540         if (name.sa.sa_family == AF_INET) {
 541                 su = XCALLOC(MTYPE_SOCKUNION, sizeof(union sockunion));
 542                 memcpy(su, &name, sizeof(struct sockaddr_in));
 543                 return su;
 544         }
 545         if (name.sa.sa_family == AF_INET6) {
 546                 su = XCALLOC(MTYPE_SOCKUNION, sizeof(union sockunion));
 547                 memcpy(su, &name, sizeof(struct sockaddr_in6));
 548                 sockunion_normalise_mapped(su);
 549                 return su;
 550         }
 551         return NULL;
 552 }
 553
 554 /* After TCP connection is established.  Get remote address and port. */
 555 union sockunion *sockunion_getpeername(int fd)
 556 {
 557         int ret;
 558         socklen_t len;
 559         union {
 560                 struct sockaddr sa;
 561                 struct sockaddr_in sin;
 562                 struct sockaddr_in6 sin6;
 563                 char tmp_buffer[128];
 564         } name;
 565         union sockunion *su;
 566
 567         memset(&name, 0, sizeof name);
 568         len = sizeof name;
 569         ret = getpeername(fd, (struct sockaddr *)&name, &len);
 570         if (ret < 0) {
 571                 zlog_warn("Can't get remote address and port: %s",
 572                           safe_strerror(errno));
 573                 return NULL;
 574         }
 575
 576         if (name.sa.sa_family == AF_INET) {
 577                 su = XCALLOC(MTYPE_SOCKUNION, sizeof(union sockunion));
 578                 memcpy(su, &name, sizeof(struct sockaddr_in));
 579                 return su;
 580         }
 581         if (name.sa.sa_family == AF_INET6) {
 582                 su = XCALLOC(MTYPE_SOCKUNION, sizeof(union sockunion));
 583                 memcpy(su, &name, sizeof(struct sockaddr_in6));
 584                 sockunion_normalise_mapped(su);
 585                 return su;
 586         }
 587         return NULL;
 588 }
 589
 590 /* Print sockunion structure */
 591 static void __attribute__((unused)) sockunion_print(const union sockunion *su)
 592 {
 593         if (su == NULL)
 594                 return;
 595
 596         switch (su->sa.sa_family) {
 597         case AF_INET:
 598                 printf("%s\n", inet_ntoa(su->sin.sin_addr));
 599                 break;
 600         case AF_INET6: {
 601                 char buf[SU_ADDRSTRLEN];
 602
 603                 printf("%s\n", inet_ntop(AF_INET6, &(su->sin6.sin6_addr), buf,
 604                                          sizeof(buf)));
 605         } break;
 606
 607 #ifdef AF_LINK
 608         case AF_LINK: {
 609                 struct sockaddr_dl *sdl;
 610
 611                 sdl = (struct sockaddr_dl *)&(su->sa);
 612                 printf("link#%d\n", sdl->sdl_index);
 613         } break;
 614 #endif /* AF_LINK */
 615         default:
 616                 printf("af_unknown %d\n", su->sa.sa_family);
 617                 break;
 618         }
 619 }
 620
 621 static int in6addr_cmp(const struct in6_addr *addr1,
 622                        const struct in6_addr *addr2)
 623 {
 624         unsigned int i;
 625         const uint8_t *p1, *p2;
 626
 627         p1 = (const uint8_t *)addr1;
 628         p2 = (const uint8_t *)addr2;
 629
 630         for (i = 0; i < sizeof(struct in6_addr); i++) {
 631                 if (p1[i] > p2[i])
 632                         return 1;
 633                 else if (p1[i] < p2[i])
 634                         return -1;
 635         }
 636         return 0;
 637 }
 638
 639 int sockunion_cmp(const union sockunion *su1, const union sockunion *su2)
 640 {
 641         if (su1->sa.sa_family > su2->sa.sa_family)
 642                 return 1;
 643         if (su1->sa.sa_family < su2->sa.sa_family)
 644                 return -1;
 645
 646         if (su1->sa.sa_family == AF_INET) {
 647                 if (ntohl(sockunion2ip(su1)) == ntohl(sockunion2ip(su2)))
 648                         return 0;
 649                 if (ntohl(sockunion2ip(su1)) > ntohl(sockunion2ip(su2)))
 650                         return 1;
 651                 else
 652                         return -1;
 653         }
 654         if (su1->sa.sa_family == AF_INET6)
 655                 return in6addr_cmp(&su1->sin6.sin6_addr, &su2->sin6.sin6_addr);
 656         return 0;
 657 }
 658
 659 /* Duplicate sockunion. */
 660 union sockunion *sockunion_dup(const union sockunion *su)
 661 {
 662         union sockunion *dup =
 663                 XCALLOC(MTYPE_SOCKUNION, sizeof(union sockunion));
 664         memcpy(dup, su, sizeof(union sockunion));
 665         return dup;
 666 }
 667
 668 void sockunion_free(union sockunion *su)
 669 {
 670         XFREE(MTYPE_SOCKUNION, su);
 671 }
 672
 673 void sockunion_init(union sockunion *su)
 674 {
 675         memset(su, 0, sizeof(union sockunion));
 676 }