source3/lib/util_sock.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Samba utility functions
   4    Copyright (C) Andrew Tridgell 1992-1998
   5    Copyright (C) Tim Potter      2000-2001
   6    Copyright (C) Jeremy Allison  1992-2007
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #include "includes.h"
  23
  24 /****************************************************************************
  25  Return true if a string could be an IPv4 address.
  26 ****************************************************************************/
  27
  28 bool is_ipaddress_v4(const char *str)
  29 {
  30         int ret = -1;
  31         struct in_addr dest;
  32
  33         ret = inet_pton(AF_INET, str, &dest);
  34         if (ret > 0) {
  35                 return true;
  36         }
  37         return false;
  38 }
  39
  40 /****************************************************************************
  41  Return true if a string could be an IPv4 or IPv6 address.
  42 ****************************************************************************/
  43
  44 bool is_ipaddress(const char *str)
  45 {
  46 #if defined(HAVE_IPV6)
  47         int ret = -1;
  48
  49         if (strchr_m(str, ':')) {
  50                 char addr[INET6_ADDRSTRLEN];
  51                 struct in6_addr dest6;
  52                 const char *sp = str;
  53                 char *p = strchr_m(str, '%');
  54
  55                 /*
  56                  * Cope with link-local.
  57                  * This is IP:v6:addr%ifname.
  58                  */
  59
  60                 if (p && (p > str) && (if_nametoindex(p+1) != 0)) {
  61                         strlcpy(addr, str,
  62                                 MIN(PTR_DIFF(p,str)+1,
  63                                         sizeof(addr)));
  64                         sp = addr;
  65                 }
  66                 ret = inet_pton(AF_INET6, sp, &dest6);
  67                 if (ret > 0) {
  68                         return true;
  69                 }
  70         }
  71 #endif
  72         return is_ipaddress_v4(str);
  73 }
  74
  75 /****************************************************************************
  76  Is a sockaddr_storage a broadcast address ?
  77 ****************************************************************************/
  78
  79 bool is_broadcast_addr(const struct sockaddr_storage *pss)
  80 {
  81 #if defined(HAVE_IPV6)
  82         if (pss->ss_family == AF_INET6) {
  83                 const struct in6_addr *sin6 =
  84                         &((const struct sockaddr_in6 *)pss)->sin6_addr;
  85                 return IN6_IS_ADDR_MULTICAST(sin6);
  86         }
  87 #endif
  88         if (pss->ss_family == AF_INET) {
  89                 uint32_t addr =
  90                 ntohl(((const struct sockaddr_in *)pss)->sin_addr.s_addr);
  91                 return addr == INADDR_BROADCAST;
  92         }
  93         return false;
  94 }
  95
  96 /*******************************************************************
  97  Wrap getaddrinfo...
  98 ******************************************************************/
  99
 100 static bool interpret_string_addr_internal(struct addrinfo **ppres,
 101                                         const char *str, int flags)
 102 {
 103         int ret;
 104         struct addrinfo hints;
 105
 106         memset(&hints, '\0', sizeof(hints));
 107         /* By default make sure it supports TCP. */
 108         hints.ai_socktype = SOCK_STREAM;
 109         hints.ai_flags = flags;
 110
 111         /* Linux man page on getaddinfo() says port will be
 112            uninitialized when service string in NULL */
 113
 114         ret = getaddrinfo(str, NULL,
 115                         &hints,
 116                         ppres);
 117
 118         if (ret) {
 119                 DEBUG(3,("interpret_string_addr_internal: getaddrinfo failed "
 120                         "for name %s [%s]\n",
 121                         str,
 122                         gai_strerror(ret) ));
 123                 return false;
 124         }
 125         return true;
 126 }
 127
 128 /****************************************************************************
 129  Interpret an internet address or name into an IP address in 4 byte form.
 130  RETURNS IN NETWORK BYTE ORDER (big endian).
 131 ****************************************************************************/
 132
 133 uint32 interpret_addr(const char *str)
 134 {
 135         uint32 ret;
 136
 137         /* If it's in the form of an IP address then
 138          * get the lib to interpret it */
 139         if (is_ipaddress_v4(str)) {
 140                 struct in_addr dest;
 141
 142                 if (inet_pton(AF_INET, str, &dest) <= 0) {
 143                         /* Error - this shouldn't happen ! */
 144                         DEBUG(0,("interpret_addr: inet_pton failed "
 145                                 "host %s\n",
 146                                 str));
 147                         return 0;
 148                 }
 149                 ret = dest.s_addr; /* NETWORK BYTE ORDER ! */
 150         } else {
 151                 /* Otherwise assume it's a network name of some sort and use
 152                         getadddrinfo. */
 153                 struct addrinfo *res = NULL;
 154                 struct addrinfo *res_list = NULL;
 155                 if (!interpret_string_addr_internal(&res_list,
 156                                         str,
 157                                         AI_ADDRCONFIG)) {
 158                         DEBUG(3,("interpret_addr: Unknown host. %s\n",str));
 159                         return 0;
 160                 }
 161
 162                 /* Find the first IPv4 address. */
 163                 for (res = res_list; res; res = res->ai_next) {
 164                         if (res->ai_family != AF_INET) {
 165                                 continue;
 166                         }
 167                         if (res->ai_addr == NULL) {
 168                                 continue;
 169                         }
 170                         break;
 171                 }
 172                 if(res == NULL) {
 173                         DEBUG(3,("interpret_addr: host address is "
 174                                 "invalid for host %s\n",str));
 175                         if (res_list) {
 176                                 freeaddrinfo(res_list);
 177                         }
 178                         return 0;
 179                 }
 180                 putip((char *)&ret,
 181                         &((struct sockaddr_in *)res->ai_addr)->sin_addr.s_addr);
 182                 if (res_list) {
 183                         freeaddrinfo(res_list);
 184                 }
 185         }
 186
 187         /* This is so bogus - all callers need fixing... JRA. */
 188         if (ret == (uint32)-1) {
 189                 return 0;
 190         }
 191
 192         return ret;
 193 }
 194
 195 /*******************************************************************
 196  A convenient addition to interpret_addr().
 197 ******************************************************************/
 198
 199 struct in_addr *interpret_addr2(struct in_addr *ip, const char *str)
 200 {
 201         uint32 a = interpret_addr(str);
 202         ip->s_addr = a;
 203         return ip;
 204 }
 205
 206 /*******************************************************************
 207  Map a text hostname or IP address (IPv4 or IPv6) into a
 208  struct sockaddr_storage.
 209 ******************************************************************/
 210
 211 bool interpret_string_addr(struct sockaddr_storage *pss,
 212                 const char *str,
 213                 int flags)
 214 {
 215         struct addrinfo *res = NULL;
 216 #if defined(HAVE_IPV6)
 217         char addr[INET6_ADDRSTRLEN];
 218         unsigned int scope_id = 0;
 219
 220         if (strchr_m(str, ':')) {
 221                 char *p = strchr_m(str, '%');
 222
 223                 /*
 224                  * Cope with link-local.
 225                  * This is IP:v6:addr%ifname.
 226                  */
 227
 228                 if (p && (p > str) && ((scope_id = if_nametoindex(p+1)) != 0)) {
 229                         strlcpy(addr, str,
 230                                 MIN(PTR_DIFF(p,str)+1,
 231                                         sizeof(addr)));
 232                         str = addr;
 233                 }
 234         }
 235 #endif
 236
 237         zero_addr(pss);
 238
 239         if (!interpret_string_addr_internal(&res, str, flags|AI_ADDRCONFIG)) {
 240                 return false;
 241         }
 242         if (!res) {
 243                 return false;
 244         }
 245         /* Copy the first sockaddr. */
 246         memcpy(pss, res->ai_addr, res->ai_addrlen);
 247
 248 #if defined(HAVE_IPV6)
 249         if (pss->ss_family == AF_INET6 && scope_id) {
 250                 struct sockaddr_in6 *ps6 = (struct sockaddr_in6 *)pss;
 251                 if (IN6_IS_ADDR_LINKLOCAL(&ps6->sin6_addr) &&
 252                                 ps6->sin6_scope_id == 0) {
 253                         ps6->sin6_scope_id = scope_id;
 254                 }
 255         }
 256 #endif
 257
 258         freeaddrinfo(res);
 259         return true;
 260 }
 261
 262 /*******************************************************************
 263  Check if an IPv7 is 127.0.0.1
 264 ******************************************************************/
 265
 266 bool is_loopback_ip_v4(struct in_addr ip)
 267 {
 268         struct in_addr a;
 269         a.s_addr = htonl(INADDR_LOOPBACK);
 270         return(ip.s_addr == a.s_addr);
 271 }
 272
 273 /*******************************************************************
 274  Check if a struct sockaddr_storage is the loopback address.
 275 ******************************************************************/
 276
 277 bool is_loopback_addr(const struct sockaddr_storage *pss)
 278 {
 279 #if defined(HAVE_IPV6)
 280         if (pss->ss_family == AF_INET6) {
 281                 struct in6_addr *pin6 =
 282                         &((struct sockaddr_in6 *)pss)->sin6_addr;
 283                 return IN6_IS_ADDR_LOOPBACK(pin6);
 284         }
 285 #endif
 286         if (pss->ss_family == AF_INET) {
 287                 struct in_addr *pin = &((struct sockaddr_in *)pss)->sin_addr;
 288                 return is_loopback_ip_v4(*pin);
 289         }
 290         return false;
 291 }
 292
 293 /*******************************************************************
 294  Check if an IPv4 is 0.0.0.0.
 295 ******************************************************************/
 296
 297 bool is_zero_ip_v4(struct in_addr ip)
 298 {
 299         uint32 a;
 300         putip((char *)&a,(char *)&ip);
 301         return(a == 0);
 302 }
 303
 304 /*******************************************************************
 305  Check if a struct sockaddr_storage has an unspecified address.
 306 ******************************************************************/
 307
 308 bool is_zero_addr(const struct sockaddr_storage *pss)
 309 {
 310 #if defined(HAVE_IPV6)
 311         if (pss->ss_family == AF_INET6) {
 312                 struct in6_addr *pin6 =
 313                         &((struct sockaddr_in6 *)pss)->sin6_addr;
 314                 return IN6_IS_ADDR_UNSPECIFIED(pin6);
 315         }
 316 #endif
 317         if (pss->ss_family == AF_INET) {
 318                 struct in_addr *pin = &((struct sockaddr_in *)pss)->sin_addr;
 319                 return is_zero_ip_v4(*pin);
 320         }
 321         return false;
 322 }
 323
 324 /*******************************************************************
 325  Set an IP to 0.0.0.0.
 326 ******************************************************************/
 327
 328 void zero_ip_v4(struct in_addr *ip)
 329 {
 330         memset(ip, '\0', sizeof(struct in_addr));
 331 }
 332
 333 /*******************************************************************
 334  Set an address to INADDR_ANY.
 335 ******************************************************************/
 336
 337 void zero_addr(struct sockaddr_storage *pss)
 338 {
 339         memset(pss, '\0', sizeof(*pss));
 340         /* Ensure we're at least a valid sockaddr-storage. */
 341         pss->ss_family = AF_INET;
 342 }
 343
 344 /*******************************************************************
 345  Are two IPs on the same subnet - IPv4 version ?
 346 ********************************************************************/
 347
 348 bool same_net_v4(struct in_addr ip1,struct in_addr ip2,struct in_addr mask)
 349 {
 350         uint32 net1,net2,nmask;
 351
 352         nmask = ntohl(mask.s_addr);
 353         net1  = ntohl(ip1.s_addr);
 354         net2  = ntohl(ip2.s_addr);
 355
 356         return((net1 & nmask) == (net2 & nmask));
 357 }
 358
 359 /*******************************************************************
 360  Convert an IPv4 struct in_addr to a struct sockaddr_storage.
 361 ********************************************************************/
 362
 363 void in_addr_to_sockaddr_storage(struct sockaddr_storage *ss,
 364                 struct in_addr ip)
 365 {
 366         struct sockaddr_in *sa = (struct sockaddr_in *)ss;
 367         memset(ss, '\0', sizeof(*ss));
 368         sa->sin_family = AF_INET;
 369         sa->sin_addr = ip;
 370 }
 371
 372 #if defined(HAVE_IPV6)
 373 /*******************************************************************
 374  Convert an IPv6 struct in_addr to a struct sockaddr_storage.
 375 ********************************************************************/
 376
 377  void in6_addr_to_sockaddr_storage(struct sockaddr_storage *ss,
 378                 struct in6_addr ip)
 379 {
 380         struct sockaddr_in6 *sa = (struct sockaddr_in6 *)ss;
 381         memset(ss, '\0', sizeof(*ss));
 382         sa->sin6_family = AF_INET6;
 383         sa->sin6_addr = ip;
 384 }
 385 #endif
 386
 387 /*******************************************************************
 388  Are two IPs on the same subnet?
 389 ********************************************************************/
 390
 391 bool same_net(const struct sockaddr_storage *ip1,
 392                 const struct sockaddr_storage *ip2,
 393                 const struct sockaddr_storage *mask)
 394 {
 395         if (ip1->ss_family != ip2->ss_family) {
 396                 /* Never on the same net. */
 397                 return false;
 398         }
 399
 400 #if defined(HAVE_IPV6)
 401         if (ip1->ss_family == AF_INET6) {
 402                 struct sockaddr_in6 ip1_6 = *(struct sockaddr_in6 *)ip1;
 403                 struct sockaddr_in6 ip2_6 = *(struct sockaddr_in6 *)ip2;
 404                 struct sockaddr_in6 mask_6 = *(struct sockaddr_in6 *)mask;
 405                 char *p1 = (char *)&ip1_6.sin6_addr;
 406                 char *p2 = (char *)&ip2_6.sin6_addr;
 407                 char *m = (char *)&mask_6.sin6_addr;
 408                 int i;
 409
 410                 for (i = 0; i < sizeof(struct in6_addr); i++) {
 411                         *p1++ &= *m;
 412                         *p2++ &= *m;
 413                         m++;
 414                 }
 415                 return (memcmp(&ip1_6.sin6_addr,
 416                                 &ip2_6.sin6_addr,
 417                                 sizeof(struct in6_addr)) == 0);
 418         }
 419 #endif
 420         if (ip1->ss_family == AF_INET) {
 421                 return same_net_v4(((const struct sockaddr_in *)ip1)->sin_addr,
 422                                 ((const struct sockaddr_in *)ip2)->sin_addr,
 423                                 ((const struct sockaddr_in *)mask)->sin_addr);
 424         }
 425         return false;
 426 }
 427
 428 /*******************************************************************
 429  Are two sockaddr_storage's the same family and address ? Ignore port etc.
 430 ********************************************************************/
 431
 432 bool addr_equal(const struct sockaddr_storage *ip1,
 433                 const struct sockaddr_storage *ip2)
 434 {
 435         if (ip1->ss_family != ip2->ss_family) {
 436                 /* Never the same. */
 437                 return false;
 438         }
 439
 440 #if defined(HAVE_IPV6)
 441         if (ip1->ss_family == AF_INET6) {
 442                 return (memcmp(&((const struct sockaddr_in6 *)ip1)->sin6_addr,
 443                                 &((const struct sockaddr_in6 *)ip2)->sin6_addr,
 444                                 sizeof(struct in6_addr)) == 0);
 445         }
 446 #endif
 447         if (ip1->ss_family == AF_INET) {
 448                 return (memcmp(&((const struct sockaddr_in *)ip1)->sin_addr,
 449                                 &((const struct sockaddr_in *)ip2)->sin_addr,
 450                                 sizeof(struct in_addr)) == 0);
 451         }
 452         return false;
 453 }
 454
 455 /****************************************************************************
 456  Is an IP address the INADDR_ANY or in6addr_any value ?
 457 ****************************************************************************/
 458
 459 bool is_address_any(const struct sockaddr_storage *psa)
 460 {
 461 #if defined(HAVE_IPV6)
 462         if (psa->ss_family == AF_INET6) {
 463                 struct sockaddr_in6 *si6 = (struct sockaddr_in6 *)psa;
 464                 if (memcmp(&in6addr_any,
 465                                 &si6->sin6_addr,
 466                                 sizeof(in6addr_any)) == 0) {
 467                         return true;
 468                 }
 469                 return false;
 470         }
 471 #endif
 472         if (psa->ss_family == AF_INET) {
 473                 struct sockaddr_in *si = (struct sockaddr_in *)psa;
 474                 if (si->sin_addr.s_addr == INADDR_ANY) {
 475                         return true;
 476                 }
 477                 return false;
 478         }
 479         return false;
 480 }
 481
 482 /****************************************************************************
 483  Get a port number in host byte order from a sockaddr_storage.
 484 ****************************************************************************/
 485
 486 uint16_t get_sockaddr_port(const struct sockaddr_storage *pss)
 487 {
 488         uint16_t port = 0;
 489
 490         if (pss->ss_family != AF_INET) {
 491 #if defined(HAVE_IPV6)
 492                 /* IPv6 */
 493                 const struct sockaddr_in6 *sa6 =
 494                         (const struct sockaddr_in6 *)pss;
 495                 port = ntohs(sa6->sin6_port);
 496 #endif
 497         } else {
 498                 const struct sockaddr_in *sa =
 499                         (const struct sockaddr_in *)pss;
 500                 port = ntohs(sa->sin_port);
 501         }
 502         return port;
 503 }
 504
 505 /****************************************************************************
 506  Print out an IPv4 or IPv6 address from a struct sockaddr_storage.
 507 ****************************************************************************/
 508
 509 static char *print_sockaddr_len(char *dest,
 510                         size_t destlen,
 511                         const struct sockaddr_storage *psa,
 512                         socklen_t psalen)
 513 {
 514         if (destlen > 0) {
 515                 dest[0] = '\0';
 516         }
 517         (void)sys_getnameinfo((const struct sockaddr *)psa,
 518                         psalen,
 519                         dest, destlen,
 520                         NULL, 0,
 521                         NI_NUMERICHOST);
 522         return dest;
 523 }
 524
 525 /****************************************************************************
 526  Print out an IPv4 or IPv6 address from a struct sockaddr_storage.
 527 ****************************************************************************/
 528
 529 char *print_sockaddr(char *dest,
 530                         size_t destlen,
 531                         const struct sockaddr_storage *psa)
 532 {
 533         return print_sockaddr_len(dest, destlen, psa,
 534                         sizeof(struct sockaddr_storage));
 535 }
 536
 537 /****************************************************************************
 538  Print out a canonical IPv4 or IPv6 address from a struct sockaddr_storage.
 539 ****************************************************************************/
 540
 541 char *print_canonical_sockaddr(TALLOC_CTX *ctx,
 542                         const struct sockaddr_storage *pss)
 543 {
 544         char addr[INET6_ADDRSTRLEN];
 545         char *dest = NULL;
 546         int ret;
 547
 548         /* Linux getnameinfo() man pages says port is unitialized if
 549            service name is NULL. */
 550
 551         ret = sys_getnameinfo((const struct sockaddr *)pss,
 552                         sizeof(struct sockaddr_storage),
 553                         addr, sizeof(addr),
 554                         NULL, 0,
 555                         NI_NUMERICHOST);
 556         if (ret != 0) {
 557                 return NULL;
 558         }
 559
 560         if (pss->ss_family != AF_INET) {
 561 #if defined(HAVE_IPV6)
 562                 dest = talloc_asprintf(ctx, "[%s]", addr);
 563 #else
 564                 return NULL;
 565 #endif
 566         } else {
 567                 dest = talloc_asprintf(ctx, "%s", addr);
 568         }
 569
 570         return dest;
 571 }
 572
 573 /****************************************************************************
 574  Return the string of an IP address (IPv4 or IPv6).
 575 ****************************************************************************/
 576
 577 static const char *get_socket_addr(int fd, char *addr_buf, size_t addr_len)
 578 {
 579         struct sockaddr_storage sa;
 580         socklen_t length = sizeof(sa);
 581
 582         /* Ok, returning a hard coded IPv4 address
 583          * is bogus, but it's just as bogus as a
 584          * zero IPv6 address. No good choice here.
 585          */
 586
 587         strlcpy(addr_buf, "0.0.0.0", addr_len);
 588
 589         if (fd == -1) {
 590                 return addr_buf;
 591         }
 592
 593         if (getsockname(fd, (struct sockaddr *)&sa, &length) < 0) {
 594                 DEBUG(0,("getsockname failed. Error was %s\n",
 595                         strerror(errno) ));
 596                 return addr_buf;
 597         }
 598
 599         return print_sockaddr_len(addr_buf, addr_len, &sa, length);
 600 }
 601
 602 #if 0
 603 /* Not currently used. JRA. */
 604 /****************************************************************************
 605  Return the port number we've bound to on a socket.
 606 ****************************************************************************/
 607
 608 static int get_socket_port(int fd)
 609 {
 610         struct sockaddr_storage sa;
 611         socklen_t length = sizeof(sa);
 612
 613         if (fd == -1) {
 614                 return -1;
 615         }
 616
 617         if (getsockname(fd, (struct sockaddr *)&sa, &length) < 0) {
 618                 DEBUG(0,("getpeername failed. Error was %s\n",
 619                         strerror(errno) ));
 620                 return -1;
 621         }
 622
 623 #if defined(HAVE_IPV6)
 624         if (sa.ss_family == AF_INET6) {
 625                 return ntohs(((struct sockaddr_in6 *)&sa)->sin6_port);
 626         }
 627 #endif
 628         if (sa.ss_family == AF_INET) {
 629                 return ntohs(((struct sockaddr_in *)&sa)->sin_port);
 630         }
 631         return -1;
 632 }
 633 #endif
 634
 635 void set_sockaddr_port(struct sockaddr_storage *psa, uint16 port)
 636 {
 637 #if defined(HAVE_IPV6)
 638         if (psa->ss_family == AF_INET6) {
 639                 ((struct sockaddr_in6 *)psa)->sin6_port = htons(port);
 640         }
 641 #endif
 642         if (psa->ss_family == AF_INET) {
 643                 ((struct sockaddr_in *)psa)->sin_port = htons(port);
 644         }
 645 }
 646
 647 const char *client_name(int fd)
 648 {
 649         return get_peer_name(fd,false);
 650 }
 651
 652 const char *client_addr(int fd, char *addr, size_t addrlen)
 653 {
 654         return get_peer_addr(fd,addr,addrlen);
 655 }
 656
 657 const char *client_socket_addr(int fd, char *addr, size_t addr_len)
 658 {
 659         return get_socket_addr(fd, addr, addr_len);
 660 }
 661
 662 #if 0
 663 /* Not currently used. JRA. */
 664 int client_socket_port(int fd)
 665 {
 666         return get_socket_port(fd);
 667 }
 668 #endif
 669
 670 /****************************************************************************
 671  Accessor functions to make thread-safe code easier later...
 672 ****************************************************************************/
 673
 674 void set_smb_read_error(enum smb_read_errors *pre,
 675                         enum smb_read_errors newerr)
 676 {
 677         if (pre) {
 678                 *pre = newerr;
 679         }
 680 }
 681
 682 void cond_set_smb_read_error(enum smb_read_errors *pre,
 683                         enum smb_read_errors newerr)
 684 {
 685         if (pre && *pre == SMB_READ_OK) {
 686                 *pre = newerr;
 687         }
 688 }
 689
 690 /****************************************************************************
 691  Determine if a file descriptor is in fact a socket.
 692 ****************************************************************************/
 693
 694 bool is_a_socket(int fd)
 695 {
 696         int v;
 697         socklen_t l;
 698         l = sizeof(int);
 699         return(getsockopt(fd, SOL_SOCKET, SO_TYPE, (char *)&v, &l) == 0);
 700 }
 701
 702 enum SOCK_OPT_TYPES {OPT_BOOL,OPT_INT,OPT_ON};
 703
 704 typedef struct smb_socket_option {
 705         const char *name;
 706         int level;
 707         int option;
 708         int value;
 709         int opttype;
 710 } smb_socket_option;
 711
 712 static const smb_socket_option socket_options[] = {
 713   {"SO_KEEPALIVE", SOL_SOCKET, SO_KEEPALIVE, 0, OPT_BOOL},
 714   {"SO_REUSEADDR", SOL_SOCKET, SO_REUSEADDR, 0, OPT_BOOL},
 715   {"SO_BROADCAST", SOL_SOCKET, SO_BROADCAST, 0, OPT_BOOL},
 716 #ifdef TCP_NODELAY
 717   {"TCP_NODELAY", IPPROTO_TCP, TCP_NODELAY, 0, OPT_BOOL},
 718 #endif
 719 #ifdef TCP_KEEPCNT
 720   {"TCP_KEEPCNT", IPPROTO_TCP, TCP_KEEPCNT, 0, OPT_INT},
 721 #endif
 722 #ifdef TCP_KEEPIDLE
 723   {"TCP_KEEPIDLE", IPPROTO_TCP, TCP_KEEPIDLE, 0, OPT_INT},
 724 #endif
 725 #ifdef TCP_KEEPINTVL
 726   {"TCP_KEEPINTVL", IPPROTO_TCP, TCP_KEEPINTVL, 0, OPT_INT},
 727 #endif
 728 #ifdef IPTOS_LOWDELAY
 729   {"IPTOS_LOWDELAY", IPPROTO_IP, IP_TOS, IPTOS_LOWDELAY, OPT_ON},
 730 #endif
 731 #ifdef IPTOS_THROUGHPUT
 732   {"IPTOS_THROUGHPUT", IPPROTO_IP, IP_TOS, IPTOS_THROUGHPUT, OPT_ON},
 733 #endif
 734 #ifdef SO_REUSEPORT
 735   {"SO_REUSEPORT", SOL_SOCKET, SO_REUSEPORT, 0, OPT_BOOL},
 736 #endif
 737 #ifdef SO_SNDBUF
 738   {"SO_SNDBUF", SOL_SOCKET, SO_SNDBUF, 0, OPT_INT},
 739 #endif
 740 #ifdef SO_RCVBUF
 741   {"SO_RCVBUF", SOL_SOCKET, SO_RCVBUF, 0, OPT_INT},
 742 #endif
 743 #ifdef SO_SNDLOWAT
 744   {"SO_SNDLOWAT", SOL_SOCKET, SO_SNDLOWAT, 0, OPT_INT},
 745 #endif
 746 #ifdef SO_RCVLOWAT
 747   {"SO_RCVLOWAT", SOL_SOCKET, SO_RCVLOWAT, 0, OPT_INT},
 748 #endif
 749 #ifdef SO_SNDTIMEO
 750   {"SO_SNDTIMEO", SOL_SOCKET, SO_SNDTIMEO, 0, OPT_INT},
 751 #endif
 752 #ifdef SO_RCVTIMEO
 753   {"SO_RCVTIMEO", SOL_SOCKET, SO_RCVTIMEO, 0, OPT_INT},
 754 #endif
 755 #ifdef TCP_FASTACK
 756   {"TCP_FASTACK", IPPROTO_TCP, TCP_FASTACK, 0, OPT_INT},
 757 #endif
 758   {NULL,0,0,0,0}};
 759
 760 /****************************************************************************
 761  Print socket options.
 762 ****************************************************************************/
 763
 764 static void print_socket_options(int s)
 765 {
 766         int value;
 767         socklen_t vlen = 4;
 768         const smb_socket_option *p = &socket_options[0];
 769
 770         /* wrapped in if statement to prevent streams
 771          * leak in SCO Openserver 5.0 */
 772         /* reported on samba-technical  --jerry */
 773         if ( DEBUGLEVEL >= 5 ) {
 774                 for (; p->name != NULL; p++) {
 775                         if (getsockopt(s, p->level, p->option,
 776                                                 (void *)&value, &vlen) == -1) {
 777                                 DEBUG(5,("Could not test socket option %s.\n",
 778                                                         p->name));
 779                         } else {
 780                                 DEBUG(5,("socket option %s = %d\n",
 781                                                         p->name,value));
 782                         }
 783                 }
 784         }
 785  }
 786
 787 /****************************************************************************
 788  Set user socket options.
 789 ****************************************************************************/
 790
 791 void set_socket_options(int fd, const char *options)
 792 {
 793         TALLOC_CTX *ctx = talloc_stackframe();
 794         char *tok;
 795
 796         while (next_token_talloc(ctx, &options, &tok," \t,")) {
 797                 int ret=0,i;
 798                 int value = 1;
 799                 char *p;
 800                 bool got_value = false;
 801
 802                 if ((p = strchr_m(tok,'='))) {
 803                         *p = 0;
 804                         value = atoi(p+1);
 805                         got_value = true;
 806                 }
 807
 808                 for (i=0;socket_options[i].name;i++)
 809                         if (strequal(socket_options[i].name,tok))
 810                                 break;
 811
 812                 if (!socket_options[i].name) {
 813                         DEBUG(0,("Unknown socket option %s\n",tok));
 814                         continue;
 815                 }
 816
 817                 switch (socket_options[i].opttype) {
 818                 case OPT_BOOL:
 819                 case OPT_INT:
 820                         ret = setsockopt(fd,socket_options[i].level,
 821                                         socket_options[i].option,
 822                                         (char *)&value,sizeof(int));
 823                         break;
 824
 825                 case OPT_ON:
 826                         if (got_value)
 827                                 DEBUG(0,("syntax error - %s "
 828                                         "does not take a value\n",tok));
 829
 830                         {
 831                                 int on = socket_options[i].value;
 832                                 ret = setsockopt(fd,socket_options[i].level,
 833                                         socket_options[i].option,
 834                                         (char *)&on,sizeof(int));
 835                         }
 836                         break;
 837                 }
 838
 839                 if (ret != 0) {
 840                         /* be aware that some systems like Solaris return
 841                          * EINVAL to a setsockopt() call when the client
 842                          * sent a RST previously - no need to worry */
 843                         DEBUG(2,("Failed to set socket option %s (Error %s)\n",
 844                                 tok, strerror(errno) ));
 845                 }
 846         }
 847
 848         TALLOC_FREE(ctx);
 849         print_socket_options(fd);
 850 }
 851
 852 /****************************************************************************
 853  Read from a socket.
 854 ****************************************************************************/
 855
 856 ssize_t read_udp_v4_socket(int fd,
 857                         char *buf,
 858                         size_t len,
 859                         struct sockaddr_storage *psa)
 860 {
 861         ssize_t ret;
 862         socklen_t socklen = sizeof(*psa);
 863         struct sockaddr_in *si = (struct sockaddr_in *)psa;
 864
 865         memset((char *)psa,'\0',socklen);
 866
 867         ret = (ssize_t)sys_recvfrom(fd,buf,len,0,
 868                         (struct sockaddr *)psa,&socklen);
 869         if (ret <= 0) {
 870                 /* Don't print a low debug error for a non-blocking socket. */
 871                 if (errno == EAGAIN) {
 872                         DEBUG(10,("read_udp_v4_socket: returned EAGAIN\n"));
 873                 } else {
 874                         DEBUG(2,("read_udp_v4_socket: failed. errno=%s\n",
 875                                 strerror(errno)));
 876                 }
 877                 return 0;
 878         }
 879
 880         if (psa->ss_family != AF_INET) {
 881                 DEBUG(2,("read_udp_v4_socket: invalid address family %d "
 882                         "(not IPv4)\n", (int)psa->ss_family));
 883                 return 0;
 884         }
 885
 886         DEBUG(10,("read_udp_v4_socket: ip %s port %d read: %lu\n",
 887                         inet_ntoa(si->sin_addr),
 888                         si->sin_port,
 889                         (unsigned long)ret));
 890
 891         return ret;
 892 }
 893
 894 /****************************************************************************
 895  Read data from a socket with a timout in msec.
 896  mincount = if timeout, minimum to read before returning
 897  maxcount = number to be read.
 898  time_out = timeout in milliseconds
 899 ****************************************************************************/
 900
 901 NTSTATUS read_socket_with_timeout(int fd, char *buf,
 902                                   size_t mincnt, size_t maxcnt,
 903                                   unsigned int time_out,
 904                                   size_t *size_ret)
 905 {
 906         fd_set fds;
 907         int selrtn;
 908         ssize_t readret;
 909         size_t nread = 0;
 910         struct timeval timeout;
 911         char addr[INET6_ADDRSTRLEN];
 912
 913         /* just checking .... */
 914         if (maxcnt <= 0)
 915                 return NT_STATUS_OK;
 916
 917         /* Blocking read */
 918         if (time_out == 0) {
 919                 if (mincnt == 0) {
 920                         mincnt = maxcnt;
 921                 }
 922
 923                 while (nread < mincnt) {
 924                         readret = sys_read(fd, buf + nread, maxcnt - nread);
 925
 926                         if (readret == 0) {
 927                                 DEBUG(5,("read_socket_with_timeout: "
 928                                         "blocking read. EOF from client.\n"));
 929                                 return NT_STATUS_END_OF_FILE;
 930                         }
 931
 932                         if (readret == -1) {
 933                                 if (fd == get_client_fd()) {
 934                                         /* Try and give an error message
 935                                          * saying what client failed. */
 936                                         DEBUG(0,("read_socket_with_timeout: "
 937                                                 "client %s read error = %s.\n",
 938                                                 get_peer_addr(fd,addr,sizeof(addr)),
 939                                                 strerror(errno) ));
 940                                 } else {
 941                                         DEBUG(0,("read_socket_with_timeout: "
 942                                                 "read error = %s.\n",
 943                                                 strerror(errno) ));
 944                                 }
 945                                 return map_nt_error_from_unix(errno);
 946                         }
 947                         nread += readret;
 948                 }
 949                 goto done;
 950         }
 951
 952         /* Most difficult - timeout read */
 953         /* If this is ever called on a disk file and
 954            mincnt is greater then the filesize then
 955            system performance will suffer severely as
 956            select always returns true on disk files */
 957
 958         /* Set initial timeout */
 959         timeout.tv_sec = (time_t)(time_out / 1000);
 960         timeout.tv_usec = (long)(1000 * (time_out % 1000));
 961
 962         for (nread=0; nread < mincnt; ) {
 963                 FD_ZERO(&fds);
 964                 FD_SET(fd,&fds);
 965
 966                 selrtn = sys_select_intr(fd+1,&fds,NULL,NULL,&timeout);
 967
 968                 /* Check if error */
 969                 if (selrtn == -1) {
 970                         /* something is wrong. Maybe the socket is dead? */
 971                         if (fd == get_client_fd()) {
 972                                 /* Try and give an error message saying
 973                                  * what client failed. */
 974                                 DEBUG(0,("read_socket_with_timeout: timeout "
 975                                 "read for client %s. select error = %s.\n",
 976                                 get_peer_addr(fd,addr,sizeof(addr)),
 977                                 strerror(errno) ));
 978                         } else {
 979                                 DEBUG(0,("read_socket_with_timeout: timeout "
 980                                 "read. select error = %s.\n",
 981                                 strerror(errno) ));
 982                         }
 983                         return map_nt_error_from_unix(errno);
 984                 }
 985
 986                 /* Did we timeout ? */
 987                 if (selrtn == 0) {
 988                         DEBUG(10,("read_socket_with_timeout: timeout read. "
 989                                 "select timed out.\n"));
 990                         return NT_STATUS_IO_TIMEOUT;
 991                 }
 992
 993                 readret = sys_read(fd, buf+nread, maxcnt-nread);
 994
 995                 if (readret == 0) {
 996                         /* we got EOF on the file descriptor */
 997                         DEBUG(5,("read_socket_with_timeout: timeout read. "
 998                                 "EOF from client.\n"));
 999                         return NT_STATUS_END_OF_FILE;
1000                 }
1001
1002                 if (readret == -1) {
1003                         /* the descriptor is probably dead */
1004                         if (fd == get_client_fd()) {
1005                                 /* Try and give an error message
1006                                  * saying what client failed. */
1007                                 DEBUG(0,("read_socket_with_timeout: timeout "
1008                                         "read to client %s. read error = %s.\n",
1009                                         get_peer_addr(fd,addr,sizeof(addr)),
1010                                         strerror(errno) ));
1011                         } else {
1012                                 DEBUG(0,("read_socket_with_timeout: timeout "
1013                                         "read. read error = %s.\n",
1014                                         strerror(errno) ));
1015                         }
1016                         return map_nt_error_from_unix(errno);
1017                 }
1018
1019                 nread += readret;
1020         }
1021
1022  done:
1023         /* Return the number we got */
1024         if (size_ret) {
1025                 *size_ret = nread;
1026         }
1027         return NT_STATUS_OK;
1028 }
1029
1030 /****************************************************************************
1031  Read data from the client, reading exactly N bytes.
1032 ****************************************************************************/
1033
1034 NTSTATUS read_data(int fd, char *buffer, size_t N)
1035 {
1036         return read_socket_with_timeout(fd, buffer, N, N, 0, NULL);
1037 }
1038
1039 /****************************************************************************
1040  Write data to a fd.
1041 ****************************************************************************/
1042
1043 ssize_t write_data(int fd, const char *buffer, size_t N)
1044 {
1045         size_t total=0;
1046         ssize_t ret;
1047         char addr[INET6_ADDRSTRLEN];
1048
1049         while (total < N) {
1050                 ret = sys_write(fd,buffer + total,N - total);
1051
1052                 if (ret == -1) {
1053                         if (fd == get_client_fd()) {
1054                                 /* Try and give an error message saying
1055                                  * what client failed. */
1056                                 DEBUG(0,("write_data: write failure in "
1057                                         "writing to client %s. Error %s\n",
1058                                         get_peer_addr(fd,addr,sizeof(addr)),
1059                                         strerror(errno) ));
1060                         } else {
1061                                 DEBUG(0,("write_data: write failure. "
1062                                         "Error = %s\n", strerror(errno) ));
1063                         }
1064                         return -1;
1065                 }
1066
1067                 if (ret == 0) {
1068                         return total;
1069                 }
1070
1071                 total += ret;
1072         }
1073         return (ssize_t)total;
1074 }
1075
1076 /****************************************************************************
1077  Send a keepalive packet (rfc1002).
1078 ****************************************************************************/
1079
1080 bool send_keepalive(int client)
1081 {
1082         unsigned char buf[4];
1083
1084         buf[0] = SMBkeepalive;
1085         buf[1] = buf[2] = buf[3] = 0;
1086
1087         return(write_data(client,(char *)buf,4) == 4);
1088 }
1089
1090 /****************************************************************************
1091  Read 4 bytes of a smb packet and return the smb length of the packet.
1092  Store the result in the buffer.
1093  This version of the function will return a length of zero on receiving
1094  a keepalive packet.
1095  Timeout is in milliseconds.
1096 ****************************************************************************/
1097
1098 NTSTATUS read_smb_length_return_keepalive(int fd, char *inbuf,
1099                                           unsigned int timeout,
1100                                           size_t *len)
1101 {
1102         int msg_type;
1103         NTSTATUS status;
1104
1105         status = read_socket_with_timeout(fd, inbuf, 4, 4, timeout, NULL);
1106
1107         if (!NT_STATUS_IS_OK(status)) {
1108                 return status;
1109         }
1110
1111         *len = smb_len(inbuf);
1112         msg_type = CVAL(inbuf,0);
1113
1114         if (msg_type == SMBkeepalive) {
1115                 DEBUG(5,("Got keepalive packet\n"));
1116         }
1117
1118         DEBUG(10,("got smb length of %lu\n",(unsigned long)(*len)));
1119
1120         return NT_STATUS_OK;
1121 }
1122
1123 /****************************************************************************
1124  Read 4 bytes of a smb packet and return the smb length of the packet.
1125  Store the result in the buffer. This version of the function will
1126  never return a session keepalive (length of zero).
1127  Timeout is in milliseconds.
1128 ****************************************************************************/
1129
1130 NTSTATUS read_smb_length(int fd, char *inbuf, unsigned int timeout,
1131                          size_t *len)
1132 {
1133         uint8_t msgtype = SMBkeepalive;
1134
1135         while (msgtype == SMBkeepalive) {
1136                 NTSTATUS status;
1137
1138                 status = read_smb_length_return_keepalive(fd, inbuf, timeout,
1139                                                           len);
1140                 if (!NT_STATUS_IS_OK(status)) {
1141                         return status;
1142                 }
1143
1144                 msgtype = CVAL(inbuf, 0);
1145         }
1146
1147         DEBUG(10,("read_smb_length: got smb length of %lu\n",
1148                   (unsigned long)len));
1149
1150         return NT_STATUS_OK;
1151 }
1152
1153 /****************************************************************************
1154  Read an smb from a fd.
1155  The timeout is in milliseconds.
1156  This function will return on receipt of a session keepalive packet.
1157  maxlen is the max number of bytes to return, not including the 4 byte
1158  length. If zero it means buflen limit.
1159  Doesn't check the MAC on signed packets.
1160 ****************************************************************************/
1161
1162 NTSTATUS receive_smb_raw(int fd, char *buffer, size_t buflen, unsigned int timeout,
1163                          size_t maxlen, size_t *p_len)
1164 {
1165         size_t len;
1166         NTSTATUS status;
1167
1168         status = read_smb_length_return_keepalive(fd,buffer,timeout,&len);
1169
1170         if (!NT_STATUS_IS_OK(status)) {
1171                 DEBUG(10, ("receive_smb_raw: %s!\n", nt_errstr(status)));
1172                 return status;
1173         }
1174
1175         if (len > buflen) {
1176                 DEBUG(0,("Invalid packet length! (%lu bytes).\n",
1177                                         (unsigned long)len));
1178                 return NT_STATUS_INVALID_PARAMETER;
1179         }
1180
1181         if(len > 0) {
1182                 if (maxlen) {
1183                         len = MIN(len,maxlen);
1184                 }
1185
1186                 status = read_socket_with_timeout(
1187                         fd, buffer+4, len, len, timeout, &len);
1188
1189                 if (!NT_STATUS_IS_OK(status)) {
1190                         return status;
1191                 }
1192
1193                 /* not all of samba3 properly checks for packet-termination
1194                  * of strings. This ensures that we don't run off into
1195                  * empty space. */
1196                 SSVAL(buffer+4,len, 0);
1197         }
1198
1199         *p_len = len;
1200         return NT_STATUS_OK;
1201 }
1202
1203 /****************************************************************************
1204  Open a socket of the specified type, port, and address for incoming data.
1205 ****************************************************************************/
1206
1207 int open_socket_in(int type,
1208                 uint16_t port,
1209                 int dlevel,
1210                 const struct sockaddr_storage *psock,
1211                 bool rebind)
1212 {
1213         struct sockaddr_storage sock;
1214         int res;
1215         socklen_t slen = sizeof(struct sockaddr_in);
1216
1217         sock = *psock;
1218
1219 #if defined(HAVE_IPV6)
1220         if (sock.ss_family == AF_INET6) {
1221                 ((struct sockaddr_in6 *)&sock)->sin6_port = htons(port);
1222                 slen = sizeof(struct sockaddr_in6);
1223         }
1224 #endif
1225         if (sock.ss_family == AF_INET) {
1226                 ((struct sockaddr_in *)&sock)->sin_port = htons(port);
1227         }
1228
1229         res = socket(sock.ss_family, type, 0 );
1230         if( res == -1 ) {
1231                 if( DEBUGLVL(0) ) {
1232                         dbgtext( "open_socket_in(): socket() call failed: " );
1233                         dbgtext( "%s\n", strerror( errno ) );
1234                 }
1235                 return -1;
1236         }
1237
1238         /* This block sets/clears the SO_REUSEADDR and possibly SO_REUSEPORT. */
1239         {
1240                 int val = rebind ? 1 : 0;
1241                 if( setsockopt(res,SOL_SOCKET,SO_REUSEADDR,
1242                                         (char *)&val,sizeof(val)) == -1 ) {
1243                         if( DEBUGLVL( dlevel ) ) {
1244                                 dbgtext( "open_socket_in(): setsockopt: " );
1245                                 dbgtext( "SO_REUSEADDR = %s ",
1246                                                 val?"true":"false" );
1247                                 dbgtext( "on port %d failed ", port );
1248                                 dbgtext( "with error = %s\n", strerror(errno) );
1249                         }
1250                 }
1251 #ifdef SO_REUSEPORT
1252                 if( setsockopt(res,SOL_SOCKET,SO_REUSEPORT,
1253                                         (char *)&val,sizeof(val)) == -1 ) {
1254                         if( DEBUGLVL( dlevel ) ) {
1255                                 dbgtext( "open_socket_in(): setsockopt: ");
1256                                 dbgtext( "SO_REUSEPORT = %s ",
1257                                                 val?"true":"false");
1258                                 dbgtext( "on port %d failed ", port);
1259                                 dbgtext( "with error = %s\n", strerror(errno));
1260                         }
1261                 }
1262 #endif /* SO_REUSEPORT */
1263         }
1264
1265         /* now we've got a socket - we need to bind it */
1266         if (bind(res, (struct sockaddr *)&sock, slen) == -1 ) {
1267                 if( DEBUGLVL(dlevel) && (port == SMB_PORT1 ||
1268                                 port == SMB_PORT2 || port == NMB_PORT) ) {
1269                         char addr[INET6_ADDRSTRLEN];
1270                         print_sockaddr(addr, sizeof(addr),
1271                                         &sock);
1272                         dbgtext( "bind failed on port %d ", port);
1273                         dbgtext( "socket_addr = %s.\n", addr);
1274                         dbgtext( "Error = %s\n", strerror(errno));
1275                 }
1276                 close(res);
1277                 return -1;
1278         }
1279
1280         DEBUG( 10, ( "bind succeeded on port %d\n", port ) );
1281         return( res );
1282  }
1283
1284 /****************************************************************************
1285  Create an outgoing socket. timeout is in milliseconds.
1286 **************************************************************************/
1287
1288 int open_socket_out(int type,
1289                 const struct sockaddr_storage *pss,
1290                 uint16_t port,
1291                 int timeout)
1292 {
1293         char addr[INET6_ADDRSTRLEN];
1294         struct sockaddr_storage sock_out = *pss;
1295         int res,ret;
1296         int connect_loop = 10;
1297         int increment = 10;
1298
1299         /* create a socket to write to */
1300         res = socket(pss->ss_family, type, 0);
1301         if (res == -1) {
1302                 DEBUG(0,("socket error (%s)\n", strerror(errno)));
1303                 return -1;
1304         }
1305
1306         if (type != SOCK_STREAM) {
1307                 return res;
1308         }
1309
1310 #if defined(HAVE_IPV6)
1311         if (pss->ss_family == AF_INET6) {
1312                 struct sockaddr_in6 *psa6 = (struct sockaddr_in6 *)&sock_out;
1313                 psa6->sin6_port = htons(port);
1314                 if (psa6->sin6_scope_id == 0 &&
1315                                 IN6_IS_ADDR_LINKLOCAL(&psa6->sin6_addr)) {
1316                         setup_linklocal_scope_id(&sock_out);
1317                 }
1318         }
1319 #endif
1320         if (pss->ss_family == AF_INET) {
1321                 struct sockaddr_in *psa = (struct sockaddr_in *)&sock_out;
1322                 psa->sin_port = htons(port);
1323         }
1324
1325         /* set it non-blocking */
1326         set_blocking(res,false);
1327
1328         print_sockaddr(addr, sizeof(addr), &sock_out);
1329         DEBUG(3,("Connecting to %s at port %u\n",
1330                                 addr,
1331                                 (unsigned int)port));
1332
1333         /* and connect it to the destination */
1334   connect_again:
1335
1336         ret = sys_connect(res, (struct sockaddr *)&sock_out);
1337
1338         /* Some systems return EAGAIN when they mean EINPROGRESS */
1339         if (ret < 0 && (errno == EINPROGRESS || errno == EALREADY ||
1340                         errno == EAGAIN) && (connect_loop < timeout) ) {
1341                 smb_msleep(connect_loop);
1342                 timeout -= connect_loop;
1343                 connect_loop += increment;
1344                 if (increment < 250) {
1345                         /* After 8 rounds we end up at a max of 255 msec */
1346                         increment *= 1.5;
1347                 }
1348                 goto connect_again;
1349         }
1350
1351         if (ret < 0 && (errno == EINPROGRESS || errno == EALREADY ||
1352                         errno == EAGAIN)) {
1353                 DEBUG(1,("timeout connecting to %s:%u\n",
1354                                         addr,
1355                                         (unsigned int)port));
1356                 close(res);
1357                 return -1;
1358         }
1359
1360 #ifdef EISCONN
1361         if (ret < 0 && errno == EISCONN) {
1362                 errno = 0;
1363                 ret = 0;
1364         }
1365 #endif
1366
1367         if (ret < 0) {
1368                 DEBUG(2,("error connecting to %s:%d (%s)\n",
1369                                 addr,
1370                                 (unsigned int)port,
1371                                 strerror(errno)));
1372                 close(res);
1373                 return -1;
1374         }
1375
1376         /* set it blocking again */
1377         set_blocking(res,true);
1378
1379         return res;
1380 }
1381
1382 /*******************************************************************
1383  Create an outgoing TCP socket to the first addr that connects.
1384
1385  This is for simultaneous connection attempts to port 445 and 139 of a host
1386  or for simultatneous connection attempts to multiple DCs at once.  We return
1387  a socket fd of the first successful connection.
1388
1389  @param[in] addrs list of Internet addresses and ports to connect to
1390  @param[in] num_addrs number of address/port pairs in the addrs list
1391  @param[in] timeout time after which we stop waiting for a socket connection
1392             to succeed, given in milliseconds
1393  @param[out] fd_index the entry in addrs which we successfully connected to
1394  @param[out] fd fd of the open and connected socket
1395  @return true on a successful connection, false if all connection attempts
1396          failed or we timed out
1397 *******************************************************************/
1398
1399 bool open_any_socket_out(struct sockaddr_storage *addrs, int num_addrs,
1400                          int timeout, int *fd_index, int *fd)
1401 {
1402         int i, resulting_index, res;
1403         int *sockets;
1404         bool good_connect;
1405
1406         fd_set r_fds, wr_fds;
1407         struct timeval tv;
1408         int maxfd;
1409
1410         int connect_loop = 10000; /* 10 milliseconds */
1411
1412         timeout *= 1000;        /* convert to microseconds */
1413
1414         sockets = SMB_MALLOC_ARRAY(int, num_addrs);
1415
1416         if (sockets == NULL)
1417                 return false;
1418
1419         resulting_index = -1;
1420
1421         for (i=0; i<num_addrs; i++)
1422                 sockets[i] = -1;
1423
1424         for (i=0; i<num_addrs; i++) {
1425                 sockets[i] = socket(addrs[i].ss_family, SOCK_STREAM, 0);
1426                 if (sockets[i] < 0)
1427                         goto done;
1428                 set_blocking(sockets[i], false);
1429         }
1430
1431  connect_again:
1432         good_connect = false;
1433
1434         for (i=0; i<num_addrs; i++) {
1435                 const struct sockaddr * a =
1436                     (const struct sockaddr *)&(addrs[i]);
1437
1438                 if (sockets[i] == -1)
1439                         continue;
1440
1441                 if (sys_connect(sockets[i], a) == 0) {
1442                         /* Rather unlikely as we are non-blocking, but it
1443                          * might actually happen. */
1444                         resulting_index = i;
1445                         goto done;
1446                 }
1447
1448                 if (errno == EINPROGRESS || errno == EALREADY ||
1449 #ifdef EISCONN
1450                         errno == EISCONN ||
1451 #endif
1452                     errno == EAGAIN || errno == EINTR) {
1453                         /* These are the error messages that something is
1454                            progressing. */
1455                         good_connect = true;
1456                 } else if (errno != 0) {
1457                         /* There was a direct error */
1458                         close(sockets[i]);
1459                         sockets[i] = -1;
1460                 }
1461         }
1462
1463         if (!good_connect) {
1464                 /* All of the connect's resulted in real error conditions */
1465                 goto done;
1466         }
1467
1468         /* Lets see if any of the connect attempts succeeded */
1469
1470         maxfd = 0;
1471         FD_ZERO(&wr_fds);
1472         FD_ZERO(&r_fds);
1473
1474         for (i=0; i<num_addrs; i++) {
1475                 if (sockets[i] == -1)
1476                         continue;
1477                 FD_SET(sockets[i], &wr_fds);
1478                 FD_SET(sockets[i], &r_fds);
1479                 if (sockets[i]>maxfd)
1480                         maxfd = sockets[i];
1481         }
1482
1483         tv.tv_sec = 0;
1484         tv.tv_usec = connect_loop;
1485
1486         res = sys_select_intr(maxfd+1, &r_fds, &wr_fds, NULL, &tv);
1487
1488         if (res < 0)
1489                 goto done;
1490
1491         if (res == 0)
1492                 goto next_round;
1493
1494         for (i=0; i<num_addrs; i++) {
1495
1496                 if (sockets[i] == -1)
1497                         continue;
1498
1499                 /* Stevens, Network Programming says that if there's a
1500                  * successful connect, the socket is only writable. Upon an
1501                  * error, it's both readable and writable. */
1502
1503                 if (FD_ISSET(sockets[i], &r_fds) &&
1504                     FD_ISSET(sockets[i], &wr_fds)) {
1505                         /* readable and writable, so it's an error */
1506                         close(sockets[i]);
1507                         sockets[i] = -1;
1508                         continue;
1509                 }
1510
1511                 if (!FD_ISSET(sockets[i], &r_fds) &&
1512                     FD_ISSET(sockets[i], &wr_fds)) {
1513                         /* Only writable, so it's connected */
1514                         resulting_index = i;
1515                         goto done;
1516                 }
1517         }
1518
1519  next_round:
1520
1521         timeout -= connect_loop;
1522         if (timeout <= 0)
1523                 goto done;
1524         connect_loop *= 1.5;
1525         if (connect_loop > timeout)
1526                 connect_loop = timeout;
1527         goto connect_again;
1528
1529  done:
1530         for (i=0; i<num_addrs; i++) {
1531                 if (i == resulting_index)
1532                         continue;
1533                 if (sockets[i] >= 0)
1534                         close(sockets[i]);
1535         }
1536
1537         if (resulting_index >= 0) {
1538                 *fd_index = resulting_index;
1539                 *fd = sockets[*fd_index];
1540                 set_blocking(*fd, true);
1541         }
1542
1543         free(sockets);
1544
1545         return (resulting_index >= 0);
1546 }
1547 /****************************************************************************
1548  Open a connected UDP socket to host on port
1549 **************************************************************************/
1550
1551 int open_udp_socket(const char *host, int port)
1552 {
1553         int type = SOCK_DGRAM;
1554         struct sockaddr_in sock_out;
1555         int res;
1556         struct in_addr addr;
1557
1558         (void)interpret_addr2(&addr, host);
1559
1560         res = socket(PF_INET, type, 0);
1561         if (res == -1) {
1562                 return -1;
1563         }
1564
1565         memset((char *)&sock_out,'\0',sizeof(sock_out));
1566         putip((char *)&sock_out.sin_addr,(char *)&addr);
1567         sock_out.sin_port = htons(port);
1568         sock_out.sin_family = PF_INET;
1569
1570         if (sys_connect(res,(struct sockaddr *)&sock_out)) {
1571                 close(res);
1572                 return -1;
1573         }
1574
1575         return res;
1576 }
1577
1578 /*******************************************************************
1579  Return the IP addr of the remote end of a socket as a string.
1580  Optionally return the struct sockaddr_storage.
1581  ******************************************************************/
1582
1583 static const char *get_peer_addr_internal(int fd,
1584                                 char *addr_buf,
1585                                 size_t addr_buf_len,
1586                                 struct sockaddr_storage *pss,
1587                                 socklen_t *plength)
1588 {
1589         struct sockaddr_storage ss;
1590         socklen_t length = sizeof(ss);
1591
1592         strlcpy(addr_buf,"0.0.0.0",addr_buf_len);
1593
1594         if (fd == -1) {
1595                 return addr_buf;
1596         }
1597
1598         if (pss == NULL) {
1599                 pss = &ss;
1600         }
1601         if (plength == NULL) {
1602                 plength = &length;
1603         }
1604
1605         if (getpeername(fd, (struct sockaddr *)pss, plength) < 0) {
1606                 DEBUG(0,("getpeername failed. Error was %s\n",
1607                                         strerror(errno) ));
1608                 return addr_buf;
1609         }
1610
1611         print_sockaddr_len(addr_buf,
1612                         addr_buf_len,
1613                         pss,
1614                         *plength);
1615         return addr_buf;
1616 }
1617
1618 /*******************************************************************
1619  Matchname - determine if host name matches IP address. Used to
1620  confirm a hostname lookup to prevent spoof attacks.
1621 ******************************************************************/
1622
1623 static bool matchname(const char *remotehost,
1624                 const struct sockaddr_storage *pss,
1625                 socklen_t len)
1626 {
1627         struct addrinfo *res = NULL;
1628         struct addrinfo *ailist = NULL;
1629         char addr_buf[INET6_ADDRSTRLEN];
1630         bool ret = interpret_string_addr_internal(&ailist,
1631                         remotehost,
1632                         AI_ADDRCONFIG|AI_CANONNAME);
1633
1634         if (!ret || ailist == NULL) {
1635                 DEBUG(3,("matchname: getaddrinfo failed for "
1636                         "name %s [%s]\n",
1637                         remotehost,
1638                         gai_strerror(ret) ));
1639                 return false;
1640         }
1641
1642         /*
1643          * Make sure that getaddrinfo() returns the "correct" host name.
1644          */
1645
1646         if (ailist->ai_canonname == NULL ||
1647                 (!strequal(remotehost, ailist->ai_canonname) &&
1648                  !strequal(remotehost, "localhost"))) {
1649                 DEBUG(0,("matchname: host name/name mismatch: %s != %s\n",
1650                          remotehost,
1651                          ailist->ai_canonname ?
1652                                  ailist->ai_canonname : "(NULL)"));
1653                 freeaddrinfo(ailist);
1654                 return false;
1655         }
1656
1657         /* Look up the host address in the address list we just got. */
1658         for (res = ailist; res; res = res->ai_next) {
1659                 if (!res->ai_addr) {
1660                         continue;
1661                 }
1662                 if (addr_equal((const struct sockaddr_storage *)res->ai_addr,
1663                                         pss)) {
1664                         freeaddrinfo(ailist);
1665                         return true;
1666                 }
1667         }
1668
1669         /*
1670          * The host name does not map to the original host address. Perhaps
1671          * someone has compromised a name server. More likely someone botched
1672          * it, but that could be dangerous, too.
1673          */
1674
1675         DEBUG(0,("matchname: host name/address mismatch: %s != %s\n",
1676                 print_sockaddr_len(addr_buf,
1677                         sizeof(addr_buf),
1678                         pss,
1679                         len),
1680                  ailist->ai_canonname ? ailist->ai_canonname : "(NULL)"));
1681
1682         if (ailist) {
1683                 freeaddrinfo(ailist);
1684         }
1685         return false;
1686 }
1687
1688 /*******************************************************************
1689  Deal with the singleton cache.
1690 ******************************************************************/
1691
1692 struct name_addr_pair {
1693         struct sockaddr_storage ss;
1694         const char *name;
1695 };
1696
1697 /*******************************************************************
1698  Lookup a name/addr pair. Returns memory allocated from memcache.
1699 ******************************************************************/
1700
1701 static bool lookup_nc(struct name_addr_pair *nc)
1702 {
1703         DATA_BLOB tmp;
1704
1705         ZERO_STRUCTP(nc);
1706
1707         if (!memcache_lookup(
1708                         NULL, SINGLETON_CACHE,
1709                         data_blob_string_const("get_peer_name"),
1710                         &tmp)) {
1711                 return false;
1712         }
1713
1714         memcpy(&nc->ss, tmp.data, sizeof(nc->ss));
1715         nc->name = (const char *)tmp.data + sizeof(nc->ss);
1716         return true;
1717 }
1718
1719 /*******************************************************************
1720  Save a name/addr pair.
1721 ******************************************************************/
1722
1723 static void store_nc(const struct name_addr_pair *nc)
1724 {
1725         DATA_BLOB tmp;
1726         size_t namelen = strlen(nc->name);
1727
1728         tmp = data_blob(NULL, sizeof(nc->ss) + namelen + 1);
1729         if (!tmp.data) {
1730                 return;
1731         }
1732         memcpy(tmp.data, &nc->ss, sizeof(nc->ss));
1733         memcpy(tmp.data+sizeof(nc->ss), nc->name, namelen+1);
1734
1735         memcache_add(NULL, SINGLETON_CACHE,
1736                         data_blob_string_const("get_peer_name"),
1737                         tmp);
1738         data_blob_free(&tmp);
1739 }
1740
1741 /*******************************************************************
1742  Return the DNS name of the remote end of a socket.
1743 ******************************************************************/
1744
1745 const char *get_peer_name(int fd, bool force_lookup)
1746 {
1747         struct name_addr_pair nc;
1748         char addr_buf[INET6_ADDRSTRLEN];
1749         struct sockaddr_storage ss;
1750         socklen_t length = sizeof(ss);
1751         const char *p;
1752         int ret;
1753         char name_buf[MAX_DNS_NAME_LENGTH];
1754         char tmp_name[MAX_DNS_NAME_LENGTH];
1755
1756         /* reverse lookups can be *very* expensive, and in many
1757            situations won't work because many networks don't link dhcp
1758            with dns. To avoid the delay we avoid the lookup if
1759            possible */
1760         if (!lp_hostname_lookups() && (force_lookup == false)) {
1761                 length = sizeof(nc.ss);
1762                 nc.name = get_peer_addr_internal(fd, addr_buf, sizeof(addr_buf),
1763                         &nc.ss, &length);
1764                 store_nc(&nc);
1765                 lookup_nc(&nc);
1766                 return nc.name ? nc.name : "UNKNOWN";
1767         }
1768
1769         lookup_nc(&nc);
1770
1771         memset(&ss, '\0', sizeof(ss));
1772         p = get_peer_addr_internal(fd, addr_buf, sizeof(addr_buf), &ss, &length);
1773
1774         /* it might be the same as the last one - save some DNS work */
1775         if (addr_equal(&ss, &nc.ss)) {
1776                 return nc.name ? nc.name : "UNKNOWN";
1777         }
1778
1779         /* Not the same. We need to lookup. */
1780         if (fd == -1) {
1781                 return "UNKNOWN";
1782         }
1783
1784         /* Look up the remote host name. */
1785         ret = sys_getnameinfo((struct sockaddr *)&ss,
1786                         length,
1787                         name_buf,
1788                         sizeof(name_buf),
1789                         NULL,
1790                         0,
1791                         0);
1792
1793         if (ret) {
1794                 DEBUG(1,("get_peer_name: getnameinfo failed "
1795                         "for %s with error %s\n",
1796                         p,
1797                         gai_strerror(ret)));
1798                 strlcpy(name_buf, p, sizeof(name_buf));
1799         } else {
1800                 if (!matchname(name_buf, &ss, length)) {
1801                         DEBUG(0,("Matchname failed on %s %s\n",name_buf,p));
1802                         strlcpy(name_buf,"UNKNOWN",sizeof(name_buf));
1803                 }
1804         }
1805
1806         /* can't pass the same source and dest strings in when you
1807            use --enable-developer or the clobber_region() call will
1808            get you */
1809
1810         strlcpy(tmp_name, name_buf, sizeof(tmp_name));
1811         alpha_strcpy(name_buf, tmp_name, "_-.", sizeof(name_buf));
1812         if (strstr(name_buf,"..")) {
1813                 strlcpy(name_buf, "UNKNOWN", sizeof(name_buf));
1814         }
1815
1816         nc.name = name_buf;
1817         nc.ss = ss;
1818
1819         store_nc(&nc);
1820         lookup_nc(&nc);
1821         return nc.name ? nc.name : "UNKNOWN";
1822 }
1823
1824 /*******************************************************************
1825  Return the IP addr of the remote end of a socket as a string.
1826  ******************************************************************/
1827
1828 const char *get_peer_addr(int fd, char *addr, size_t addr_len)
1829 {
1830         return get_peer_addr_internal(fd, addr, addr_len, NULL, NULL);
1831 }
1832
1833 /*******************************************************************
1834  Create protected unix domain socket.
1835
1836  Some unixes cannot set permissions on a ux-dom-sock, so we
1837  have to make sure that the directory contains the protection
1838  permissions instead.
1839  ******************************************************************/
1840
1841 int create_pipe_sock(const char *socket_dir,
1842                      const char *socket_name,
1843                      mode_t dir_perms)
1844 {
1845 #ifdef HAVE_UNIXSOCKET
1846         struct sockaddr_un sunaddr;
1847         struct stat st;
1848         int sock;
1849         mode_t old_umask;
1850         char *path = NULL;
1851
1852         old_umask = umask(0);
1853
1854         /* Create the socket directory or reuse the existing one */
1855
1856         if (lstat(socket_dir, &st) == -1) {
1857                 if (errno == ENOENT) {
1858                         /* Create directory */
1859                         if (mkdir(socket_dir, dir_perms) == -1) {
1860                                 DEBUG(0, ("error creating socket directory "
1861                                         "%s: %s\n", socket_dir,
1862                                         strerror(errno)));
1863                                 goto out_umask;
1864                         }
1865                 } else {
1866                         DEBUG(0, ("lstat failed on socket directory %s: %s\n",
1867                                 socket_dir, strerror(errno)));
1868                         goto out_umask;
1869                 }
1870         } else {
1871                 /* Check ownership and permission on existing directory */
1872                 if (!S_ISDIR(st.st_mode)) {
1873                         DEBUG(0, ("socket directory %s isn't a directory\n",
1874                                 socket_dir));
1875                         goto out_umask;
1876                 }
1877                 if ((st.st_uid != sec_initial_uid()) ||
1878                                 ((st.st_mode & 0777) != dir_perms)) {
1879                         DEBUG(0, ("invalid permissions on socket directory "
1880                                 "%s\n", socket_dir));
1881                         goto out_umask;
1882                 }
1883         }
1884
1885         /* Create the socket file */
1886
1887         sock = socket(AF_UNIX, SOCK_STREAM, 0);
1888
1889         if (sock == -1) {
1890                 DEBUG(0, ("create_pipe_sock: socket error %s\n",
1891                         strerror(errno) ));
1892                 goto out_close;
1893         }
1894
1895         if (asprintf(&path, "%s/%s", socket_dir, socket_name) == -1) {
1896                 goto out_close;
1897         }
1898
1899         unlink(path);
1900         memset(&sunaddr, 0, sizeof(sunaddr));
1901         sunaddr.sun_family = AF_UNIX;
1902         strlcpy(sunaddr.sun_path, path, sizeof(sunaddr.sun_path));
1903
1904         if (bind(sock, (struct sockaddr *)&sunaddr, sizeof(sunaddr)) == -1) {
1905                 DEBUG(0, ("bind failed on pipe socket %s: %s\n", path,
1906                         strerror(errno)));
1907                 goto out_close;
1908         }
1909
1910         if (listen(sock, 5) == -1) {
1911                 DEBUG(0, ("listen failed on pipe socket %s: %s\n", path,
1912                         strerror(errno)));
1913                 goto out_close;
1914         }
1915
1916         SAFE_FREE(path);
1917
1918         umask(old_umask);
1919         return sock;
1920
1921 out_close:
1922         SAFE_FREE(path);
1923         if (sock != -1)
1924                 close(sock);
1925
1926 out_umask:
1927         umask(old_umask);
1928         return -1;
1929
1930 #else
1931         DEBUG(0, ("create_pipe_sock: No Unix sockets on this system\n"));
1932         return -1;
1933 #endif /* HAVE_UNIXSOCKET */
1934 }
1935
1936 /****************************************************************************
1937  Get my own canonical name, including domain.
1938 ****************************************************************************/
1939
1940 const char *get_mydnsfullname(void)
1941 {
1942         struct addrinfo *res = NULL;
1943         char my_hostname[HOST_NAME_MAX];
1944         bool ret;
1945         DATA_BLOB tmp;
1946
1947         if (memcache_lookup(NULL, SINGLETON_CACHE,
1948                         data_blob_string_const("get_mydnsfullname"),
1949                         &tmp)) {
1950                 SMB_ASSERT(tmp.length > 0);
1951                 return (const char *)tmp.data;
1952         }
1953
1954         /* get my host name */
1955         if (gethostname(my_hostname, sizeof(my_hostname)) == -1) {
1956                 DEBUG(0,("get_mydnsfullname: gethostname failed\n"));
1957                 return NULL;
1958         }
1959
1960         /* Ensure null termination. */
1961         my_hostname[sizeof(my_hostname)-1] = '\0';
1962
1963         ret = interpret_string_addr_internal(&res,
1964                                 my_hostname,
1965                                 AI_ADDRCONFIG|AI_CANONNAME);
1966
1967         if (!ret || res == NULL) {
1968                 DEBUG(3,("get_mydnsfullname: getaddrinfo failed for "
1969                         "name %s [%s]\n",
1970                         my_hostname,
1971                         gai_strerror(ret) ));
1972                 return NULL;
1973         }
1974
1975         /*
1976          * Make sure that getaddrinfo() returns the "correct" host name.
1977          */
1978
1979         if (res->ai_canonname == NULL) {
1980                 DEBUG(3,("get_mydnsfullname: failed to get "
1981                         "canonical name for %s\n",
1982                         my_hostname));
1983                 freeaddrinfo(res);
1984                 return NULL;
1985         }
1986
1987         /* This copies the data, so we must do a lookup
1988          * afterwards to find the value to return.
1989          */
1990
1991         memcache_add(NULL, SINGLETON_CACHE,
1992                         data_blob_string_const("get_mydnsfullname"),
1993                         data_blob_string_const(res->ai_canonname));
1994
1995         if (!memcache_lookup(NULL, SINGLETON_CACHE,
1996                         data_blob_string_const("get_mydnsfullname"),
1997                         &tmp)) {
1998                 tmp = data_blob_talloc(talloc_tos(), res->ai_canonname,
1999                                 strlen(res->ai_canonname) + 1);
2000         }
2001
2002         freeaddrinfo(res);
2003
2004         return (const char *)tmp.data;
2005 }
2006
2007 /************************************************************
2008  Is this my name ?
2009 ************************************************************/
2010
2011 bool is_myname_or_ipaddr(const char *s)
2012 {
2013         TALLOC_CTX *ctx = talloc_tos();
2014         char *name = NULL;
2015         const char *dnsname;
2016         char *servername = NULL;
2017
2018         if (!s) {
2019                 return false;
2020         }
2021
2022         /* Santize the string from '\\name' */
2023         name = talloc_strdup(ctx, s);
2024         if (!name) {
2025                 return false;
2026         }
2027
2028         servername = strrchr_m(name, '\\' );
2029         if (!servername) {
2030                 servername = name;
2031         } else {
2032                 servername++;
2033         }
2034
2035         /* Optimize for the common case */
2036         if (strequal(servername, global_myname())) {
2037                 return true;
2038         }
2039
2040         /* Check for an alias */
2041         if (is_myname(servername)) {
2042                 return true;
2043         }
2044
2045         /* Check for loopback */
2046         if (strequal(servername, "127.0.0.1") ||
2047                         strequal(servername, "::1")) {
2048                 return true;
2049         }
2050
2051         if (strequal(servername, "localhost")) {
2052                 return true;
2053         }
2054
2055         /* Maybe it's my dns name */
2056         dnsname = get_mydnsfullname();
2057         if (dnsname && strequal(servername, dnsname)) {
2058                 return true;
2059         }
2060
2061         /* Handle possible CNAME records - convert to an IP addr. */
2062         if (!is_ipaddress(servername)) {
2063                 /* Use DNS to resolve the name, but only the first address */
2064                 struct sockaddr_storage ss;
2065                 if (interpret_string_addr(&ss, servername,0)) {
2066                         print_sockaddr(name,
2067                                         sizeof(name),
2068                                         &ss);
2069                         servername = name;
2070                 }
2071         }
2072
2073         /* Maybe its an IP address? */
2074         if (is_ipaddress(servername)) {
2075                 struct sockaddr_storage ss;
2076                 struct iface_struct *nics;
2077                 int i, n;
2078
2079                 if (!interpret_string_addr(&ss, servername, AI_NUMERICHOST)) {
2080                         return false;
2081                 }
2082
2083                 if (is_zero_addr(&ss) || is_loopback_addr(&ss)) {
2084                         return false;
2085                 }
2086
2087                 nics = TALLOC_ARRAY(ctx, struct iface_struct,
2088                                         MAX_INTERFACES);
2089                 if (!nics) {
2090                         return false;
2091                 }
2092                 n = get_interfaces(nics, MAX_INTERFACES);
2093                 for (i=0; i<n; i++) {
2094                         if (addr_equal(&nics[i].ip, &ss)) {
2095                                 TALLOC_FREE(nics);
2096                                 return true;
2097                         }
2098                 }
2099                 TALLOC_FREE(nics);
2100         }
2101
2102         /* No match */
2103         return false;
2104 }