jbsockets.c

   1 const char jbsockets_rcs[] = "$Id: jbsockets.c,v 1.79 2010/07/26 11:30:09 fabiankeil Exp $";
   2 /*********************************************************************
   3  *
   4  * File        :  $Source: /cvsroot/ijbswa/current/jbsockets.c,v $
   5  *
   6  * Purpose     :  Contains wrappers for system-specific sockets code,
   7  *                so that the rest of Junkbuster can be more
   8  *                OS-independent.  Contains #ifdefs to make this work
   9  *                on many platforms.
  10  *
  11  * Copyright   :  Written by and Copyright (C) 2001-2010 the
  12  *                Privoxy team. http://www.privoxy.org/
  13  *
  14  *                Based on the Internet Junkbuster originally written
  15  *                by and Copyright (C) 1997 Anonymous Coders and
  16  *                Junkbusters Corporation.  http://www.junkbusters.com
  17  *
  18  *                This program is free software; you can redistribute it
  19  *                and/or modify it under the terms of the GNU General
  20  *                Public License as published by the Free Software
  21  *                Foundation; either version 2 of the License, or (at
  22  *                your option) any later version.
  23  *
  24  *                This program is distributed in the hope that it will
  25  *                be useful, but WITHOUT ANY WARRANTY; without even the
  26  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  27  *                PARTICULAR PURPOSE.  See the GNU General Public
  28  *                License for more details.
  29  *
  30  *                The GNU General Public License should be included with
  31  *                this file.  If not, you can view it at
  32  *                http://www.gnu.org/copyleft/gpl.html
  33  *                or write to the Free Software Foundation, Inc., 59
  34  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  35  *
  36  *********************************************************************/
  37
  38
  39 #include "config.h"
  40
  41 #include <stdlib.h>
  42 #include <stdio.h>
  43 #include <string.h>
  44 #include <errno.h>
  45 #include <fcntl.h>
  46 #include <sys/types.h>
  47
  48 #ifdef _WIN32
  49
  50 #ifndef STRICT
  51 #define STRICT
  52 #endif
  53 #include <windows.h>
  54 #include <sys/timeb.h>
  55 #include <io.h>
  56
  57 #else
  58
  59 #ifndef __OS2__
  60 #include <unistd.h>
  61 #endif
  62 #include <sys/time.h>
  63 #include <netinet/in.h>
  64 #include <sys/ioctl.h>
  65 #include <netdb.h>
  66 #include <sys/socket.h>
  67
  68 #ifndef __BEOS__
  69 #include <netinet/tcp.h>
  70 #ifndef __OS2__
  71 #include <arpa/inet.h>
  72 #endif
  73 #else
  74 #include <socket.h>
  75 #endif
  76
  77 #if defined(__EMX__) || defined (__OS2__)
  78 #include <sys/select.h>  /* OS/2/EMX needs a little help with select */
  79 #ifdef __OS2__
  80 #include <nerrno.h>
  81 #endif
  82 #endif
  83
  84 #endif
  85
  86 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
  87 #ifdef HAVE_POLL
  88 #ifdef __GLIBC__
  89 #include <sys/poll.h>
  90 #else
  91 #include <poll.h>
  92 #endif /* def __GLIBC__ */
  93 #endif /* HAVE_POLL */
  94 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
  95
  96 #include "project.h"
  97
  98 /* For mutex semaphores only */
  99 #include "jcc.h"
 100
 101 #include "jbsockets.h"
 102 #include "filters.h"
 103 #include "errlog.h"
 104
 105 /* Mac OSX doesn't define AI_NUMERICSESRV */
 106 #ifndef AI_NUMERICSERV
 107 #define AI_NUMERICSERV 0
 108 #endif
 109
 110 const char jbsockets_h_rcs[] = JBSOCKETS_H_VERSION;
 111
 112 /*
 113  * Maximum number of gethostbyname(_r) retries in case of
 114  * soft errors (TRY_AGAIN).
 115  * XXX: Does it make sense to make this a config option?
 116  */
 117 #define MAX_DNS_RETRIES 10
 118
 119 #define MAX_LISTEN_BACKLOG 128
 120
 121
 122 /*********************************************************************
 123  *
 124  * Function    :  connect_to
 125  *
 126  * Description :  Open a socket and connect to it.  Will check
 127  *                that this is allowed according to ACL.
 128  *
 129  * Parameters  :
 130  *          1  :  host = hostname to connect to
 131  *          2  :  portnum = port to connent on (XXX: should be unsigned)
 132  *          3  :  csp = Current client state (buffers, headers, etc...)
 133  *
 134  * Returns     :  JB_INVALID_SOCKET => failure, else it is the socket
 135  *                file descriptor.
 136  *
 137  *********************************************************************/
 138 #ifdef HAVE_RFC2553
 139 /* Getaddrinfo implementation */
 140 jb_socket connect_to(const char *host, int portnum, struct client_state *csp)
 141 {
 142    struct addrinfo hints, *result, *rp;
 143    char service[6];
 144    int retval;
 145    jb_socket fd;
 146    fd_set wfds;
 147    struct timeval tv[1];
 148 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
 149    int   flags;
 150 #endif
 151    int connect_failed;
 152
 153 #ifdef FEATURE_ACL
 154    struct access_control_addr dst[1];
 155 #endif /* def FEATURE_ACL */
 156
 157    retval = snprintf(service, sizeof(service), "%d", portnum);
 158    if ((-1 == retval) || (sizeof(service) <= retval))
 159    {
 160       log_error(LOG_LEVEL_ERROR,
 161          "Port number (%d) ASCII decimal representation doesn't fit into 6 bytes",
 162          portnum);
 163       csp->http->host_ip_addr_str = strdup("unknown");
 164       return(JB_INVALID_SOCKET);
 165    }
 166
 167    memset((char *)&hints, 0, sizeof(hints));
 168    hints.ai_family = AF_UNSPEC;
 169    hints.ai_socktype = SOCK_STREAM;
 170    hints.ai_flags = AI_NUMERICSERV; /* avoid service look-up */
 171 #ifdef AI_ADDRCONFIG
 172    hints.ai_flags |= AI_ADDRCONFIG;
 173 #endif
 174    if ((retval = getaddrinfo(host, service, &hints, &result)))
 175    {
 176       log_error(LOG_LEVEL_INFO,
 177          "Can not resolve %s: %s", host, gai_strerror(retval));
 178       /* XXX: Should find a better way to propagate this error. */
 179       errno = EINVAL;
 180       csp->http->host_ip_addr_str = strdup("unknown");
 181       return(JB_INVALID_SOCKET);
 182    }
 183
 184    for (rp = result; rp != NULL; rp = rp->ai_next)
 185    {
 186
 187 #ifdef FEATURE_ACL
 188       memcpy(&dst->addr, rp->ai_addr, rp->ai_addrlen);
 189
 190       if (block_acl(dst, csp))
 191       {
 192 #ifdef __OS2__
 193          errno = SOCEPERM;
 194 #else
 195          errno = EPERM;
 196 #endif
 197          continue;
 198       }
 199 #endif /* def FEATURE_ACL */
 200
 201       csp->http->host_ip_addr_str = malloc(NI_MAXHOST);
 202       if (NULL == csp->http->host_ip_addr_str)
 203       {
 204          log_error(LOG_LEVEL_ERROR,
 205             "Out of memory while getting the server IP address.");
 206          return JB_INVALID_SOCKET;
 207       }
 208       retval = getnameinfo(rp->ai_addr, rp->ai_addrlen,
 209          csp->http->host_ip_addr_str, NI_MAXHOST, NULL, 0, NI_NUMERICHOST);
 210       if (!csp->http->host_ip_addr_str || retval)
 211       {
 212          log_error(LOG_LEVEL_ERROR,
 213             "Can not save csp->http->host_ip_addr_str: %s",
 214             (csp->http->host_ip_addr_str) ?
 215             gai_strerror(retval) : "Insufficient memory");
 216          freez(csp->http->host_ip_addr_str);
 217          continue;
 218       }
 219
 220 #ifdef _WIN32
 221       if ((fd = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol)) ==
 222             JB_INVALID_SOCKET)
 223 #else
 224       if ((fd = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol)) < 0)
 225 #endif
 226       {
 227          continue;
 228       }
 229
 230 #ifdef TCP_NODELAY
 231       {  /* turn off TCP coalescence */
 232          int mi = 1;
 233          setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, (char *) &mi, sizeof (int));
 234       }
 235 #endif /* def TCP_NODELAY */
 236
 237 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
 238       if ((flags = fcntl(fd, F_GETFL, 0)) != -1)
 239       {
 240          flags |= O_NDELAY;
 241          fcntl(fd, F_SETFL, flags);
 242       }
 243 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
 244
 245       connect_failed = 0;
 246       while (connect(fd, rp->ai_addr, rp->ai_addrlen) == JB_INVALID_SOCKET)
 247       {
 248 #ifdef _WIN32
 249          if (errno == WSAEINPROGRESS)
 250 #elif __OS2__
 251          if (sock_errno() == EINPROGRESS)
 252 #else /* ifndef _WIN32 */
 253          if (errno == EINPROGRESS)
 254 #endif /* ndef _WIN32 || __OS2__ */
 255          {
 256             break;
 257          }
 258
 259 #ifdef __OS2__
 260          if (sock_errno() != EINTR)
 261 #else
 262          if (errno != EINTR)
 263 #endif /* __OS2__ */
 264          {
 265             close_socket(fd);
 266             connect_failed = 1;
 267             break;
 268          }
 269       }
 270       if (connect_failed)
 271       {
 272          continue;
 273       }
 274
 275 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
 276       if (flags != -1)
 277       {
 278          flags &= ~O_NDELAY;
 279          fcntl(fd, F_SETFL, flags);
 280       }
 281 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
 282
 283       /* wait for connection to complete */
 284       FD_ZERO(&wfds);
 285       FD_SET(fd, &wfds);
 286
 287       tv->tv_sec  = 30;
 288       tv->tv_usec = 0;
 289
 290       /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Wierd! */
 291       if ((select((int)fd + 1, NULL, &wfds, NULL, tv) > 0)
 292          && FD_ISSET(fd, &wfds))
 293       {
 294          /*
 295           * See Linux connect(2) man page for more info
 296           * about connecting on non-blocking socket.
 297           */
 298          int socket_in_error;
 299          socklen_t optlen = sizeof(socket_in_error);
 300          if (!getsockopt(fd, SOL_SOCKET, SO_ERROR, &socket_in_error, &optlen))
 301          {
 302             if (!socket_in_error)
 303             {
 304                /* Connection established, no need to try other addresses. */
 305                break;
 306             }
 307             log_error(LOG_LEVEL_CONNECT, "Could not connect to [%s]:%s: %s.",
 308                csp->http->host_ip_addr_str, service, strerror(socket_in_error));
 309          }
 310          else
 311          {
 312             log_error(LOG_LEVEL_ERROR, "Could not get the state of "
 313                "the connection to [%s]:%s: %s; dropping connection.",
 314                csp->http->host_ip_addr_str, service, strerror(errno));
 315          }
 316       }
 317
 318       /* Connection failed, try next address */
 319       close_socket(fd);
 320    }
 321
 322    freeaddrinfo(result);
 323    if (!rp)
 324    {
 325       log_error(LOG_LEVEL_CONNECT, "Could not connect to [%s]:%s.",
 326          host, service);
 327       return(JB_INVALID_SOCKET);
 328    }
 329    log_error(LOG_LEVEL_CONNECT, "Connected to %s[%s]:%s.",
 330       host, csp->http->host_ip_addr_str, service);
 331
 332    return(fd);
 333
 334 }
 335
 336 #else /* ndef HAVE_RFC2553 */
 337 /* Pre-getaddrinfo implementation */
 338
 339 jb_socket connect_to(const char *host, int portnum, struct client_state *csp)
 340 {
 341    struct sockaddr_in inaddr;
 342    jb_socket fd;
 343    unsigned int addr;
 344    fd_set wfds;
 345    struct timeval tv[1];
 346 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
 347    int   flags;
 348 #endif
 349
 350 #ifdef FEATURE_ACL
 351    struct access_control_addr dst[1];
 352 #endif /* def FEATURE_ACL */
 353
 354    memset((char *)&inaddr, 0, sizeof inaddr);
 355
 356    if ((addr = resolve_hostname_to_ip(host)) == INADDR_NONE)
 357    {
 358       csp->http->host_ip_addr_str = strdup("unknown");
 359       return(JB_INVALID_SOCKET);
 360    }
 361
 362 #ifdef FEATURE_ACL
 363    dst->addr = ntohl(addr);
 364    dst->port = portnum;
 365
 366    if (block_acl(dst, csp))
 367    {
 368 #ifdef __OS2__
 369       errno = SOCEPERM;
 370 #else
 371       errno = EPERM;
 372 #endif
 373       return(JB_INVALID_SOCKET);
 374    }
 375 #endif /* def FEATURE_ACL */
 376
 377    inaddr.sin_addr.s_addr = addr;
 378    inaddr.sin_family      = AF_INET;
 379    csp->http->host_ip_addr_str = strdup(inet_ntoa(inaddr.sin_addr));
 380
 381 #ifndef _WIN32
 382    if (sizeof(inaddr.sin_port) == sizeof(short))
 383 #endif /* ndef _WIN32 */
 384    {
 385       inaddr.sin_port = htons((unsigned short) portnum);
 386    }
 387 #ifndef _WIN32
 388    else
 389    {
 390       inaddr.sin_port = htonl((unsigned long)portnum);
 391    }
 392 #endif /* ndef _WIN32 */
 393
 394 #ifdef _WIN32
 395    if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) == JB_INVALID_SOCKET)
 396 #else
 397    if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) < 0)
 398 #endif
 399    {
 400       return(JB_INVALID_SOCKET);
 401    }
 402
 403 #ifdef TCP_NODELAY
 404    {  /* turn off TCP coalescence */
 405       int mi = 1;
 406       setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, (char *) &mi, sizeof (int));
 407    }
 408 #endif /* def TCP_NODELAY */
 409
 410 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
 411    if ((flags = fcntl(fd, F_GETFL, 0)) != -1)
 412    {
 413       flags |= O_NDELAY;
 414       fcntl(fd, F_SETFL, flags);
 415    }
 416 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
 417
 418    while (connect(fd, (struct sockaddr *) & inaddr, sizeof inaddr) == JB_INVALID_SOCKET)
 419    {
 420 #ifdef _WIN32
 421       if (errno == WSAEINPROGRESS)
 422 #elif __OS2__
 423       if (sock_errno() == EINPROGRESS)
 424 #else /* ifndef _WIN32 */
 425       if (errno == EINPROGRESS)
 426 #endif /* ndef _WIN32 || __OS2__ */
 427       {
 428          break;
 429       }
 430
 431 #ifdef __OS2__
 432       if (sock_errno() != EINTR)
 433 #else
 434       if (errno != EINTR)
 435 #endif /* __OS2__ */
 436       {
 437          close_socket(fd);
 438          return(JB_INVALID_SOCKET);
 439       }
 440    }
 441
 442 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
 443    if (flags != -1)
 444    {
 445       flags &= ~O_NDELAY;
 446       fcntl(fd, F_SETFL, flags);
 447    }
 448 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
 449
 450    /* wait for connection to complete */
 451    FD_ZERO(&wfds);
 452    FD_SET(fd, &wfds);
 453
 454    tv->tv_sec  = 30;
 455    tv->tv_usec = 0;
 456
 457    /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Wierd! */
 458    if (select((int)fd + 1, NULL, &wfds, NULL, tv) <= 0)
 459    {
 460       close_socket(fd);
 461       return(JB_INVALID_SOCKET);
 462    }
 463    return(fd);
 464
 465 }
 466 #endif /* ndef HAVE_RFC2553 */
 467
 468
 469 /*********************************************************************
 470  *
 471  * Function    :  write_socket
 472  *
 473  * Description :  Write the contents of buf (for n bytes) to socket fd.
 474  *
 475  * Parameters  :
 476  *          1  :  fd = file descriptor (aka. handle) of socket to write to.
 477  *          2  :  buf = pointer to data to be written.
 478  *          3  :  len = length of data to be written to the socket "fd".
 479  *
 480  * Returns     :  0 on success (entire buffer sent).
 481  *                nonzero on error.
 482  *
 483  *********************************************************************/
 484 #ifdef AMIGA
 485 int write_socket(jb_socket fd, const char *buf, ssize_t len)
 486 #else
 487 int write_socket(jb_socket fd, const char *buf, size_t len)
 488 #endif
 489 {
 490    if (len == 0)
 491    {
 492       return 0;
 493    }
 494
 495    if (len < 0) /* constant condition - size_t isn't ever negative */
 496    {
 497       return 1;
 498    }
 499
 500    log_error(LOG_LEVEL_WRITING, "to socket %d: %N", fd, len, buf);
 501
 502 #if defined(_WIN32)
 503    return (send(fd, buf, (int)len, 0) != (int)len);
 504 #elif defined(__BEOS__) || defined(AMIGA)
 505    return (send(fd, buf, len, 0) != len);
 506 #elif defined(__OS2__)
 507    /*
 508     * Break the data up into SOCKET_SEND_MAX chunks for sending...
 509     * OS/2 seemed to complain when the chunks were too large.
 510     */
 511 #define SOCKET_SEND_MAX 65000
 512    {
 513       int send_len, send_rc = 0, i = 0;
 514       while ((i < len) && (send_rc != -1))
 515       {
 516          if ((i + SOCKET_SEND_MAX) > len)
 517             send_len = len - i;
 518          else
 519             send_len = SOCKET_SEND_MAX;
 520          send_rc = send(fd,(char*)buf + i, send_len, 0);
 521          if (send_rc == -1)
 522             return 1;
 523          i = i + send_len;
 524       }
 525       return 0;
 526    }
 527 #else
 528    return (write(fd, buf, len) != len);
 529 #endif
 530
 531 }
 532
 533
 534 /*********************************************************************
 535  *
 536  * Function    :  read_socket
 537  *
 538  * Description :  Read from a TCP/IP socket in a platform independent way.
 539  *
 540  * Parameters  :
 541  *          1  :  fd = file descriptor of the socket to read
 542  *          2  :  buf = pointer to buffer where data will be written
 543  *                Must be >= len bytes long.
 544  *          3  :  len = maximum number of bytes to read
 545  *
 546  * Returns     :  On success, the number of bytes read is returned (zero
 547  *                indicates end of file), and the file position is advanced
 548  *                by this number.  It is not an error if this number is
 549  *                smaller than the number of bytes requested; this may hap-
 550  *                pen for example because fewer bytes are actually available
 551  *                right now (maybe because we were close to end-of-file, or
 552  *                because we are reading from a pipe, or from a terminal,
 553  *                or because read() was interrupted by a signal).  On error,
 554  *                -1 is returned, and errno is set appropriately.  In this
 555  *                case it is left unspecified whether the file position (if
 556  *                any) changes.
 557  *
 558  *********************************************************************/
 559 int read_socket(jb_socket fd, char *buf, int len)
 560 {
 561    int ret;
 562
 563    if (len <= 0)
 564    {
 565       return(0);
 566    }
 567
 568 #if defined(_WIN32)
 569    ret = recv(fd, buf, len, 0);
 570 #elif defined(__BEOS__) || defined(AMIGA) || defined(__OS2__)
 571    ret = recv(fd, buf, (size_t)len, 0);
 572 #else
 573    ret = (int)read(fd, buf, (size_t)len);
 574 #endif
 575
 576    if (ret > 0)
 577    {
 578       log_error(LOG_LEVEL_RECEIVED, "from socket %d: %N", fd, ret, buf);
 579    }
 580
 581    return ret;
 582 }
 583
 584
 585 /*********************************************************************
 586  *
 587  * Function    :  data_is_available
 588  *
 589  * Description :  Waits for data to arrive on a socket.
 590  *
 591  * Parameters  :
 592  *          1  :  fd = file descriptor of the socket to read
 593  *          2  :  seconds_to_wait = number of seconds after which we give up.
 594  *
 595  * Returns     :  TRUE if data arrived in time,
 596  *                FALSE otherwise.
 597  *
 598  *********************************************************************/
 599 int data_is_available(jb_socket fd, int seconds_to_wait)
 600 {
 601    char buf[10];
 602    fd_set rfds;
 603    struct timeval timeout;
 604    int n;
 605
 606    memset(&timeout, 0, sizeof(timeout));
 607    timeout.tv_sec = seconds_to_wait;
 608
 609 #ifdef __OS2__
 610    /* Copy and pasted from jcc.c ... */
 611    memset(&rfds, 0, sizeof(fd_set));
 612 #else
 613    FD_ZERO(&rfds);
 614 #endif
 615    FD_SET(fd, &rfds);
 616
 617    n = select(fd+1, &rfds, NULL, NULL, &timeout);
 618
 619    /*
 620     * XXX: Do we care about the different error conditions?
 621     */
 622    return ((n == 1) && (1 == recv(fd, buf, 1, MSG_PEEK)));
 623 }
 624
 625
 626 /*********************************************************************
 627  *
 628  * Function    :  close_socket
 629  *
 630  * Description :  Closes a TCP/IP socket
 631  *
 632  * Parameters  :
 633  *          1  :  fd = file descriptor of socket to be closed
 634  *
 635  * Returns     :  void
 636  *
 637  *********************************************************************/
 638 void close_socket(jb_socket fd)
 639 {
 640 #if defined(_WIN32) || defined(__BEOS__)
 641    closesocket(fd);
 642 #elif defined(AMIGA)
 643    CloseSocket(fd);
 644 #elif defined(__OS2__)
 645    soclose(fd);
 646 #else
 647    close(fd);
 648 #endif
 649
 650 }
 651
 652
 653 /*********************************************************************
 654  *
 655  * Function    :  bind_port
 656  *
 657  * Description :  Call socket, set socket options, and listen.
 658  *                Called by listen_loop to "boot up" our proxy address.
 659  *
 660  * Parameters  :
 661  *          1  :  hostnam = TCP/IP address to bind/listen to
 662  *          2  :  portnum = port to listen on
 663  *          3  :  pfd = pointer used to return file descriptor.
 664  *
 665  * Returns     :  if success, returns 0 and sets *pfd.
 666  *                if failure, returns -3 if address is in use,
 667  *                                    -2 if address unresolvable,
 668  *                                    -1 otherwise
 669  *********************************************************************/
 670 int bind_port(const char *hostnam, int portnum, jb_socket *pfd)
 671 {
 672 #ifdef HAVE_RFC2553
 673    struct addrinfo hints;
 674    struct addrinfo *result, *rp;
 675    /*
 676     * XXX: portnum should be a string to allow symbolic service
 677     * names in the configuration file and to avoid the following
 678     * int2string.
 679     */
 680    char servnam[6];
 681    int retval;
 682 #else
 683    struct sockaddr_in inaddr;
 684 #endif /* def HAVE_RFC2553 */
 685    jb_socket fd;
 686 #ifndef _WIN32
 687    int one = 1;
 688 #endif /* ndef _WIN32 */
 689
 690    *pfd = JB_INVALID_SOCKET;
 691
 692 #ifdef HAVE_RFC2553
 693    retval = snprintf(servnam, sizeof(servnam), "%d", portnum);
 694    if ((-1 == retval) || (sizeof(servnam) <= retval))
 695    {
 696       log_error(LOG_LEVEL_ERROR,
 697          "Port number (%d) ASCII decimal representation doesn't fit into 6 bytes",
 698          portnum);
 699       return -1;
 700    }
 701
 702    memset(&hints, 0, sizeof(struct addrinfo));
 703    if (hostnam == NULL)
 704    {
 705       /*
 706        * XXX: This is a hack. The right thing to do
 707        * would be to bind to both AF_INET and AF_INET6.
 708        * This will also fail if there is no AF_INET
 709        * version available.
 710        */
 711       hints.ai_family = AF_INET;
 712    }
 713    else
 714    {
 715       hints.ai_family = AF_UNSPEC;
 716    }
 717    hints.ai_socktype = SOCK_STREAM;
 718    hints.ai_flags = AI_PASSIVE;
 719 #ifdef AI_ADDRCONFIG
 720    hints.ai_flags |= AI_ADDRCONFIG;
 721 #endif
 722    hints.ai_protocol = 0; /* Realy any stream protocol or TCP only */
 723    hints.ai_canonname = NULL;
 724    hints.ai_addr = NULL;
 725    hints.ai_next = NULL;
 726
 727    if ((retval = getaddrinfo(hostnam, servnam, &hints, &result)))
 728    {
 729       log_error(LOG_LEVEL_ERROR,
 730          "Can not resolve %s: %s", hostnam, gai_strerror(retval));
 731       return -2;
 732    }
 733 #else
 734    memset((char *)&inaddr, '\0', sizeof inaddr);
 735
 736    inaddr.sin_family      = AF_INET;
 737    inaddr.sin_addr.s_addr = resolve_hostname_to_ip(hostnam);
 738
 739    if (inaddr.sin_addr.s_addr == INADDR_NONE)
 740    {
 741       return(-2);
 742    }
 743
 744 #ifndef _WIN32
 745    if (sizeof(inaddr.sin_port) == sizeof(short))
 746 #endif /* ndef _WIN32 */
 747    {
 748       inaddr.sin_port = htons((unsigned short) portnum);
 749    }
 750 #ifndef _WIN32
 751    else
 752    {
 753       inaddr.sin_port = htonl((unsigned long) portnum);
 754    }
 755 #endif /* ndef _WIN32 */
 756 #endif /* def HAVE_RFC2553 */
 757
 758 #ifdef HAVE_RFC2553
 759    for (rp = result; rp != NULL; rp = rp->ai_next)
 760    {
 761       fd = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
 762 #else
 763    fd = socket(AF_INET, SOCK_STREAM, 0);
 764 #endif /* def HAVE_RFC2553 */
 765
 766 #ifdef _WIN32
 767    if (fd == JB_INVALID_SOCKET)
 768 #else
 769    if (fd < 0)
 770 #endif
 771    {
 772 #ifdef HAVE_RFC2553
 773       continue;
 774 #else
 775       return(-1);
 776 #endif
 777    }
 778
 779 #ifndef _WIN32
 780    /*
 781     * This is not needed for Win32 - in fact, it stops
 782     * duplicate instances of Privoxy from being caught.
 783     *
 784     * On UNIX, we assume the user is sensible enough not
 785     * to start Privoxy multiple times on the same IP.
 786     * Without this, stopping and restarting Privoxy
 787     * from a script fails.
 788     * Note: SO_REUSEADDR is meant to only take over
 789     * sockets which are *not* in listen state in Linux,
 790     * e.g. sockets in TIME_WAIT. YMMV.
 791     */
 792    setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (char *)&one, sizeof(one));
 793 #endif /* ndef _WIN32 */
 794
 795 #ifdef HAVE_RFC2553
 796    if (bind(fd, rp->ai_addr, rp->ai_addrlen) < 0)
 797 #else
 798    if (bind(fd, (struct sockaddr *)&inaddr, sizeof(inaddr)) < 0)
 799 #endif
 800    {
 801 #ifdef _WIN32
 802       errno = WSAGetLastError();
 803       if (errno == WSAEADDRINUSE)
 804 #else
 805       if (errno == EADDRINUSE)
 806 #endif
 807       {
 808 #ifdef HAVE_RFC2553
 809          freeaddrinfo(result);
 810 #endif
 811          close_socket(fd);
 812          return(-3);
 813       }
 814       else
 815       {
 816          close_socket(fd);
 817 #ifndef HAVE_RFC2553
 818          return(-1);
 819       }
 820    }
 821 #else
 822       }
 823    }
 824    else
 825    {
 826       /* bind() succeeded, escape from for-loop */
 827       /*
 828        * XXX: Support multiple listening sockets (e.g. localhost
 829        * resolves to AF_INET and AF_INET6, but only the first address
 830        * is used
 831        */
 832       break;
 833    }
 834    }
 835
 836    freeaddrinfo(result);
 837    if (rp == NULL)
 838    {
 839       /* All bind()s failed */
 840       return(-1);
 841    }
 842 #endif /* ndef HAVE_RFC2553 */
 843
 844    while (listen(fd, MAX_LISTEN_BACKLOG) == -1)
 845    {
 846       if (errno != EINTR)
 847       {
 848          return(-1);
 849       }
 850    }
 851
 852    *pfd = fd;
 853    return 0;
 854
 855 }
 856
 857
 858 /*********************************************************************
 859  *
 860  * Function    :  get_host_information
 861  *
 862  * Description :  Determines the IP address the client used to
 863  *                reach us and the hostname associated with it.
 864  *
 865  *                XXX: Most of the code has been copy and pasted
 866  *                from accept_connection() and not all of the
 867  *                ifdefs paths have been tested afterwards.
 868  *
 869  * Parameters  :
 870  *          1  :  afd = File descriptor returned from accept().
 871  *          2  :  ip_address = Pointer to return the pointer to
 872  *                             the ip address string.
 873  *          3  :  hostname =   Pointer to return the pointer to
 874  *                             the hostname or NULL if the caller
 875  *                             isn't interested in it.
 876  *
 877  * Returns     :  void.
 878  *
 879  *********************************************************************/
 880 void get_host_information(jb_socket afd, char **ip_address, char **hostname)
 881 {
 882 #ifdef HAVE_RFC2553
 883    struct sockaddr_storage server;
 884    int retval;
 885 #else
 886    struct sockaddr_in server;
 887    struct hostent *host = NULL;
 888 #endif /* HAVE_RFC2553 */
 889 #if defined(_WIN32) || defined(__OS2__) || defined(__APPLE_CC__) || defined(AMIGA)
 890    /* according to accept_connection() this fixes a warning. */
 891    int s_length, s_length_provided;
 892 #else
 893    socklen_t s_length, s_length_provided;
 894 #endif
 895 #ifndef HAVE_RFC2553
 896 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS) ||  defined(HAVE_GETHOSTBYADDR_R_7_ARGS) || defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
 897    struct hostent result;
 898 #if defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
 899    struct hostent_data hdata;
 900 #else
 901    char hbuf[HOSTENT_BUFFER_SIZE];
 902    int thd_err;
 903 #endif /* def HAVE_GETHOSTBYADDR_R_5_ARGS */
 904 #endif /* def HAVE_GETHOSTBYADDR_R_(8|7|5)_ARGS */
 905 #endif /* ifndef HAVE_RFC2553 */
 906    s_length = s_length_provided = sizeof(server);
 907
 908    if (NULL != hostname)
 909    {
 910       *hostname = NULL;
 911    }
 912    *ip_address = NULL;
 913
 914    if (!getsockname(afd, (struct sockaddr *) &server, &s_length))
 915    {
 916       if (s_length > s_length_provided)
 917       {
 918          log_error(LOG_LEVEL_ERROR, "getsockname() truncated server address");
 919          return;
 920       }
 921 #ifdef HAVE_RFC2553
 922       *ip_address = malloc(NI_MAXHOST);
 923       if (NULL == *ip_address)
 924       {
 925          log_error(LOG_LEVEL_ERROR,
 926             "Out of memory while getting the client's IP address.");
 927          return;
 928       }
 929       retval = getnameinfo((struct sockaddr *) &server, s_length,
 930          *ip_address, NI_MAXHOST, NULL, 0, NI_NUMERICHOST);
 931       if (retval)
 932       {
 933          log_error(LOG_LEVEL_ERROR,
 934             "Unable to print my own IP address: %s", gai_strerror(retval));
 935          freez(*ip_address);
 936          return;
 937       }
 938 #else
 939       *ip_address = strdup(inet_ntoa(server.sin_addr));
 940 #endif /* HAVE_RFC2553 */
 941       if (NULL == hostname)
 942       {
 943          /*
 944           * We're done here, the caller isn't
 945           * interested in knowing the hostname.
 946           */
 947          return;
 948       }
 949
 950 #ifdef HAVE_RFC2553
 951       *hostname = malloc(NI_MAXHOST);
 952       if (NULL == *hostname)
 953       {
 954          log_error(LOG_LEVEL_ERROR,
 955             "Out of memory while getting the client's hostname.");
 956          return;
 957       }
 958       retval = getnameinfo((struct sockaddr *) &server, s_length,
 959          *hostname, NI_MAXHOST, NULL, 0, NI_NAMEREQD);
 960       if (retval)
 961       {
 962          log_error(LOG_LEVEL_ERROR,
 963             "Unable to resolve my own IP address: %s", gai_strerror(retval));
 964          freez(*hostname);
 965       }
 966 #else
 967 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS)
 968       gethostbyaddr_r((const char *)&server.sin_addr,
 969                       sizeof(server.sin_addr), AF_INET,
 970                       &result, hbuf, HOSTENT_BUFFER_SIZE,
 971                       &host, &thd_err);
 972 #elif defined(HAVE_GETHOSTBYADDR_R_7_ARGS)
 973       host = gethostbyaddr_r((const char *)&server.sin_addr,
 974                       sizeof(server.sin_addr), AF_INET,
 975                       &result, hbuf, HOSTENT_BUFFER_SIZE, &thd_err);
 976 #elif defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
 977       if (0 == gethostbyaddr_r((const char *)&server.sin_addr,
 978                                sizeof(server.sin_addr), AF_INET,
 979                                &result, &hdata))
 980       {
 981          host = &result;
 982       }
 983       else
 984       {
 985          host = NULL;
 986       }
 987 #elif defined(MUTEX_LOCKS_AVAILABLE)
 988       privoxy_mutex_lock(&resolver_mutex);
 989       host = gethostbyaddr((const char *)&server.sin_addr,
 990                            sizeof(server.sin_addr), AF_INET);
 991       privoxy_mutex_unlock(&resolver_mutex);
 992 #else
 993       host = gethostbyaddr((const char *)&server.sin_addr,
 994                            sizeof(server.sin_addr), AF_INET);
 995 #endif
 996       if (host == NULL)
 997       {
 998          log_error(LOG_LEVEL_ERROR, "Unable to get my own hostname: %E\n");
 999       }
1000       else
1001       {
1002          *hostname = strdup(host->h_name);
1003       }
1004 #endif /* else def HAVE_RFC2553 */
1005    }
1006
1007    return;
1008 }
1009
1010
1011 /*********************************************************************
1012  *
1013  * Function    :  accept_connection
1014  *
1015  * Description :  Accepts a connection on a socket.  Socket must have
1016  *                been created using bind_port().
1017  *
1018  * Parameters  :
1019  *          1  :  csp = Client state, cfd, ip_addr_str, and
1020  *                ip_addr_long will be set by this routine.
1021  *          2  :  fd  = file descriptor returned from bind_port
1022  *
1023  * Returns     :  when a connection is accepted, it returns 1 (TRUE).
1024  *                On an error it returns 0 (FALSE).
1025  *
1026  *********************************************************************/
1027 int accept_connection(struct client_state * csp, jb_socket fd)
1028 {
1029 #ifdef HAVE_RFC2553
1030    /* XXX: client is stored directly into csp->tcp_addr */
1031 #define client (csp->tcp_addr)
1032    int retval;
1033 #else
1034    struct sockaddr_in client;
1035 #endif
1036    jb_socket afd;
1037 #if defined(_WIN32) || defined(__OS2__) || defined(__APPLE_CC__) || defined(AMIGA)
1038    /* Wierdness - fix a warning. */
1039    int c_length;
1040 #else
1041    socklen_t c_length;
1042 #endif
1043
1044    c_length = sizeof(client);
1045
1046 #ifdef _WIN32
1047    afd = accept (fd, (struct sockaddr *) &client, &c_length);
1048    if (afd == JB_INVALID_SOCKET)
1049    {
1050       return 0;
1051    }
1052 #else
1053    do
1054    {
1055 #if defined(FEATURE_ACCEPT_FILTER) && defined(SO_ACCEPTFILTER)
1056       struct accept_filter_arg af_options;
1057       bzero(&af_options, sizeof(af_options));
1058       strlcpy(af_options.af_name, "httpready", sizeof(af_options.af_name));
1059       setsockopt(fd, SOL_SOCKET, SO_ACCEPTFILTER, &af_options, sizeof(af_options));
1060 #endif
1061       afd = accept (fd, (struct sockaddr *) &client, &c_length);
1062    } while (afd < 1 && errno == EINTR);
1063    if (afd < 0)
1064    {
1065       return 0;
1066    }
1067 #endif
1068
1069    csp->cfd = afd;
1070 #ifdef HAVE_RFC2553
1071    csp->ip_addr_str = malloc(NI_MAXHOST);
1072    if (NULL == csp->ip_addr_str)
1073    {
1074       log_error(LOG_LEVEL_ERROR,
1075          "Out of memory while getting the client's IP address.");
1076       return 0;
1077    }
1078    retval = getnameinfo((struct sockaddr *) &client, c_length,
1079          csp->ip_addr_str, NI_MAXHOST, NULL, 0, NI_NUMERICHOST);
1080    if (!csp->ip_addr_str || retval)
1081    {
1082       log_error(LOG_LEVEL_ERROR, "Can not save csp->ip_addr_str: %s",
1083             (csp->ip_addr_str) ? gai_strerror(retval) : "Insuffcient memory");
1084       freez(csp->ip_addr_str);
1085    }
1086 #undef client
1087 #else
1088    csp->ip_addr_str  = strdup(inet_ntoa(client.sin_addr));
1089    csp->ip_addr_long = ntohl(client.sin_addr.s_addr);
1090 #endif /* def HAVE_RFC2553 */
1091
1092    return 1;
1093
1094 }
1095
1096
1097 /*********************************************************************
1098  *
1099  * Function    :  resolve_hostname_to_ip
1100  *
1101  * Description :  Resolve a hostname to an internet tcp/ip address.
1102  *                NULL or an empty string resolve to INADDR_ANY.
1103  *
1104  * Parameters  :
1105  *          1  :  host = hostname to resolve
1106  *
1107  * Returns     :  INADDR_NONE => failure, INADDR_ANY or tcp/ip address if succesful.
1108  *
1109  *********************************************************************/
1110 unsigned long resolve_hostname_to_ip(const char *host)
1111 {
1112    struct sockaddr_in inaddr;
1113    struct hostent *hostp;
1114 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS) || defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
1115    struct hostent result;
1116 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
1117    char hbuf[HOSTENT_BUFFER_SIZE];
1118    int thd_err;
1119 #else /* defined(HAVE_GETHOSTBYNAME_R_3_ARGS) */
1120    struct hostent_data hdata;
1121 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5)_ARGS */
1122 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
1123
1124    if ((host == NULL) || (*host == '\0'))
1125    {
1126       return(INADDR_ANY);
1127    }
1128
1129    memset((char *) &inaddr, 0, sizeof inaddr);
1130
1131    if ((inaddr.sin_addr.s_addr = inet_addr(host)) == -1)
1132    {
1133       unsigned int dns_retries = 0;
1134 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS)
1135       while (gethostbyname_r(host, &result, hbuf,
1136                 HOSTENT_BUFFER_SIZE, &hostp, &thd_err)
1137              && (thd_err == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
1138       {
1139          log_error(LOG_LEVEL_ERROR,
1140             "Timeout #%u while trying to resolve %s. Trying again.",
1141             dns_retries, host);
1142       }
1143 #elif defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
1144       while (NULL == (hostp = gethostbyname_r(host, &result,
1145                                  hbuf, HOSTENT_BUFFER_SIZE, &thd_err))
1146              && (thd_err == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
1147       {
1148          log_error(LOG_LEVEL_ERROR,
1149             "Timeout #%u while trying to resolve %s. Trying again.",
1150             dns_retries, host);
1151       }
1152 #elif defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
1153       /*
1154        * XXX: Doesn't retry in case of soft errors.
1155        * Does this gethostbyname_r version set h_errno?
1156        */
1157       if (0 == gethostbyname_r(host, &result, &hdata))
1158       {
1159          hostp = &result;
1160       }
1161       else
1162       {
1163          hostp = NULL;
1164       }
1165 #elif defined(MUTEX_LOCKS_AVAILABLE)
1166       privoxy_mutex_lock(&resolver_mutex);
1167       while (NULL == (hostp = gethostbyname(host))
1168              && (h_errno == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
1169       {
1170          log_error(LOG_LEVEL_ERROR,
1171             "Timeout #%u while trying to resolve %s. Trying again.",
1172             dns_retries, host);
1173       }
1174       privoxy_mutex_unlock(&resolver_mutex);
1175 #else
1176       while (NULL == (hostp = gethostbyname(host))
1177              && (h_errno == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
1178       {
1179          log_error(LOG_LEVEL_ERROR,
1180             "Timeout #%u while trying to resolve %s. Trying again.",
1181             dns_retries, host);
1182       }
1183 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
1184       /*
1185        * On Mac OSX, if a domain exists but doesn't have a type A
1186        * record associated with it, the h_addr member of the struct
1187        * hostent returned by gethostbyname is NULL, even if h_length
1188        * is 4. Therefore the second test below.
1189        */
1190       if (hostp == NULL || hostp->h_addr == NULL)
1191       {
1192          errno = EINVAL;
1193          log_error(LOG_LEVEL_ERROR, "could not resolve hostname %s", host);
1194          return(INADDR_NONE);
1195       }
1196       if (hostp->h_addrtype != AF_INET)
1197       {
1198 #ifdef _WIN32
1199          errno = WSAEPROTOTYPE;
1200 #else
1201          errno = EPROTOTYPE;
1202 #endif
1203          log_error(LOG_LEVEL_ERROR, "hostname %s resolves to unknown address type.", host);
1204          return(INADDR_NONE);
1205       }
1206       memcpy(
1207          (char *) &inaddr.sin_addr,
1208          (char *) hostp->h_addr,
1209          sizeof(inaddr.sin_addr)
1210       );
1211    }
1212    return(inaddr.sin_addr.s_addr);
1213
1214 }
1215
1216
1217 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1218 /*********************************************************************
1219  *
1220  * Function    :  socket_is_still_alive
1221  *
1222  * Description :  Figures out whether or not a socket is still alive.
1223  *
1224  * Parameters  :
1225  *          1  :  sfd = The socket to check.
1226  *
1227  * Returns     :  TRUE for yes, otherwise FALSE.
1228  *
1229  *********************************************************************/
1230 int socket_is_still_alive(jb_socket sfd)
1231 {
1232    char buf[10];
1233    int no_data_waiting;
1234
1235 #ifdef HAVE_POLL
1236    int poll_result;
1237    struct pollfd poll_fd[1];
1238
1239    memset(poll_fd, 0, sizeof(poll_fd));
1240    poll_fd[0].fd = sfd;
1241    poll_fd[0].events = POLLIN;
1242
1243    poll_result = poll(poll_fd, 1, 0);
1244
1245    if (-1 == poll_result)
1246    {
1247       log_error(LOG_LEVEL_CONNECT, "Polling socket %d failed.", sfd);
1248       return FALSE;
1249    }
1250    no_data_waiting = !(poll_fd[0].revents & POLLIN);
1251 #else
1252    fd_set readable_fds;
1253    struct timeval timeout;
1254    int ret;
1255
1256    memset(&timeout, '\0', sizeof(timeout));
1257    FD_ZERO(&readable_fds);
1258    FD_SET(sfd, &readable_fds);
1259
1260    ret = select((int)sfd+1, &readable_fds, NULL, NULL, &timeout);
1261    if (ret < 0)
1262    {
1263       log_error(LOG_LEVEL_CONNECT, "select() on socket %d failed: %E", sfd);
1264       return FALSE;
1265    }
1266    no_data_waiting = !FD_ISSET(sfd, &readable_fds);
1267 #endif /* def HAVE_POLL */
1268
1269    return (no_data_waiting || (1 == recv(sfd, buf, 1, MSG_PEEK)));
1270 }
1271 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1272
1273
1274 /*
1275   Local Variables:
1276   tab-width: 3
1277   end:
1278 */