jbsockets.c

   1 const char jbsockets_rcs[] = "$Id: jbsockets.c,v 1.45 2007/09/30 16:59:22 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-2007 the SourceForge
  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  * Revisions   :
  37  *    $Log: jbsockets.c,v $
  38  *    Revision 1.45  2007/09/30 16:59:22  fabiankeil
  39  *    Set the maximum listen() backlog to 128. Apparently SOMAXCONN is
  40  *    neither high enough, nor a hard limit on mingw32. Again for BR#1795281.
  41  *
  42  *    Revision 1.44  2007/09/15 13:01:31  fabiankeil
  43  *    Increase listen() backlog to SOMAXCONN (or 128) to decrease
  44  *    chances of dropped connections under load. Problem reported
  45  *    and fix suggested by nobody in BR#1795281.
  46  *
  47  *    Revision 1.43  2007/06/01 18:16:36  fabiankeil
  48  *    Use the same mutex for gethostbyname() and gethostbyaddr() to prevent
  49  *    deadlocks and crashes on OpenBSD and possibly other OS with neither
  50  *    gethostbyname_r() nor gethostaddr_r(). Closes BR#1729174.
  51  *    Thanks to Ralf Horstmann for report and solution.
  52  *
  53  *    Revision 1.42  2007/04/01 17:37:07  fabiankeil
  54  *    - Add DNS retries for Solaris and other systems
  55  *      whose gethostbyname_r version takes five arguments.
  56  *    - Move maximum number of DNS retries into a macro.
  57  *
  58  *    Revision 1.41  2006/11/13 19:05:51  fabiankeil
  59  *    Make pthread mutex locking more generic. Instead of
  60  *    checking for OSX and OpenBSD, check for FEATURE_PTHREAD
  61  *    and use mutex locking unless there is an _r function
  62  *    available. Better safe than sorry.
  63  *
  64  *    Fixes "./configure --disable-pthread" and should result
  65  *    in less threading-related problems on pthread-using platforms,
  66  *    but it still doesn't fix BR#1122404.
  67  *
  68  *    Revision 1.40  2006/09/02 15:36:42  fabiankeil
  69  *    Follow the OpenBSD port's lead and protect the resolve
  70  *    functions on OpenBSD as well.
  71  *
  72  *    Revision 1.39  2006/08/03 02:46:41  david__schmidt
  73  *    Incorporate Fabian Keil's patch work:\rhttp://www.fabiankeil.de/sourcecode/privoxy/
  74  *
  75  *    Revision 1.38  2006/07/18 14:48:46  david__schmidt
  76  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
  77  *    with what was really the latest development (the v_3_0_branch branch)
  78  *
  79  *    Revision 1.35.2.8  2006/01/21 16:16:08  david__schmidt
  80  *    Thanks to  Edward Carrel for his patch to modernize OSX's\rpthreads support.  See bug #1409623.
  81  *
  82  *    Revision 1.35.2.7  2005/05/07 21:50:55  david__schmidt
  83  *    A few memory leaks plugged (mostly on error paths)
  84  *
  85  *    Revision 1.35.2.6  2003/12/17 16:34:40  oes
  86  *    Cosmetics
  87  *
  88  *    Revision 1.35.2.5  2003/04/29 11:32:54  oes
  89  *    Don't rely on h_addr being non-NULL after gethostbyname.
  90  *    Works around an oddness in Max OSX and closes bug #724796
  91  *
  92  *    Revision 1.35.2.4  2003/04/04 12:40:20  oes
  93  *    Made sure the errno set by bind, not close[socket] is used in
  94  *    bind_port. Probably fixes bugs #713777, #705562.
  95  *
  96  *    Revision 1.35.2.3  2003/03/07 03:41:04  david__schmidt
  97  *    Wrapping all *_r functions (the non-_r versions of them) with mutex semaphores for OSX.  Hopefully this will take care of all of those pesky crash reports.
  98  *
  99  *    Revision 1.35.2.2  2002/11/20 14:37:24  oes
 100  *    Fixed Win32 error logging in bind_port.
 101  *    Thanks to Oliver Stoeneberg for the hint.
 102  *
 103  *    Revision 1.35.2.1  2002/05/26 23:41:27  joergs
 104  *    AmigaOS: Fixed wrong type of len in write_socket()
 105  *
 106  *    Revision 1.35  2002/04/26 15:50:04  joergs
 107  *    AmigaOS: No socklen_t, added AMIGA to the systems using int instead.
 108  *
 109  *    Revision 1.34  2002/04/08 20:31:41  swa
 110  *    fixed JB spelling
 111  *
 112  *    Revision 1.33  2002/04/03 16:02:18  gliptak
 113  *    Correcting compile warning with older gcc
 114  *
 115  *    Revision 1.32  2002/03/31 17:18:59  jongfoster
 116  *    Win32 only: Enabling STRICT to fix a VC++ compile warning.
 117  *
 118  *    Revision 1.31  2002/03/29 03:33:13  david__schmidt
 119  *    Fix Mac OSX compiler warnings
 120  *
 121  *    Revision 1.30  2002/03/27 14:32:43  david__schmidt
 122  *    More compiler warning message maintenance
 123  *
 124  *    Revision 1.29  2002/03/26 22:29:54  swa
 125  *    we have a new homepage!
 126  *
 127  *    Revision 1.28  2002/03/24 13:25:43  swa
 128  *    name change related issues
 129  *
 130  *    Revision 1.27  2002/03/13 00:27:05  jongfoster
 131  *    Killing warnings
 132  *
 133  *    Revision 1.26  2002/03/11 22:07:02  david__schmidt
 134  *    OS/2 port maintenance:
 135  *    - Fixed EMX build - it had decayed a little
 136  *    - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
 137  *      substituted a memset for now.
 138  *
 139  *    Revision 1.25  2002/03/09 20:03:52  jongfoster
 140  *    - Making various functions return int rather than size_t.
 141  *      (Undoing a recent change).  Since size_t is unsigned on
 142  *      Windows, functions like read_socket that return -1 on
 143  *      error cannot return a size_t.
 144  *
 145  *      THIS WAS A MAJOR BUG - it caused frequent, unpredictable
 146  *      crashes, and also frequently caused JB to jump to 100%
 147  *      CPU and stay there.  (Because it thought it had just
 148  *      read ((unsigned)-1) == 4Gb of data...)
 149  *
 150  *    - The signature of write_socket has changed, it now simply
 151  *      returns success=0/failure=nonzero.
 152  *
 153  *    - Trying to get rid of a few warnings --with-debug on
 154  *      Windows, I've introduced a new type "jb_socket".  This is
 155  *      used for the socket file descriptors.  On Windows, this
 156  *      is SOCKET (a typedef for unsigned).  Everywhere else, it's
 157  *      an int.  The error value can't be -1 any more, so it's
 158  *      now JB_INVALID_SOCKET (which is -1 on UNIX, and in
 159  *      Windows it maps to the #define INVALID_SOCKET.)
 160  *
 161  *    - The signature of bind_port has changed.
 162  *
 163  *    Revision 1.24  2002/03/07 03:51:36  oes
 164  *     - Improved handling of failed DNS lookups
 165  *     - Fixed compiler warnings etc
 166  *
 167  *    Revision 1.23  2002/03/05 00:36:01  jongfoster
 168  *    Fixing bug 514988 - unable to restart Junkbuster
 169  *
 170  *    Revision 1.22  2002/03/04 02:08:02  david__schmidt
 171  *    Enable web editing of actions file on OS/2 (it had been broken all this time!)
 172  *
 173  *    Revision 1.21  2002/01/09 14:32:33  oes
 174  *    Added support for gethostbyname_r and gethostbyaddr_r.
 175  *
 176  *    Revision 1.20  2001/11/16 00:48:48  jongfoster
 177  *    Enabling duplicate-socket detection for all platforms, not
 178  *    just Win32.
 179  *
 180  *    Revision 1.19  2001/10/25 03:40:47  david__schmidt
 181  *    Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
 182  *    threads to call select() simultaneously.  So, it's time to do a real, live,
 183  *    native OS/2 port.  See defines for __EMX__ (the porting layer) vs. __OS2__
 184  *    (native). Both versions will work, but using __OS2__ offers multi-threading.
 185  *
 186  *    Revision 1.18  2001/09/21 23:02:02  david__schmidt
 187  *    Cleaning up 2 compiler warnings on OS/2.
 188  *
 189  *    Revision 1.17  2001/09/13 20:11:46  jongfoster
 190  *    Fixing 2 compiler warnings under Win32
 191  *
 192  *    Revision 1.16  2001/07/30 22:08:36  jongfoster
 193  *    Tidying up #defines:
 194  *    - All feature #defines are now of the form FEATURE_xxx
 195  *    - Permanently turned off WIN_GUI_EDIT
 196  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
 197  *
 198  *    Revision 1.15  2001/07/29 17:40:43  jongfoster
 199  *    Fixed compiler warning by adding a cast
 200  *
 201  *    Revision 1.14  2001/07/18 13:47:59  oes
 202  *    Eliminated dirty hack for getsockbyname()
 203  *
 204  *    Revision 1.13  2001/07/15 13:56:57  jongfoster
 205  *    Removing unused local variable.
 206  *
 207  *    Revision 1.12  2001/07/01 17:04:11  oes
 208  *    Bugfix: accept_connection no longer uses the obsolete hstrerror() function
 209  *
 210  *    Revision 1.11  2001/06/29 21:45:41  oes
 211  *    Indentation, CRLF->LF, Tab-> Space
 212  *
 213  *    Revision 1.10  2001/06/29 13:29:15  oes
 214  *    - Added remote (server) host IP to csp->http->host_ip_addr_str
 215  *    - Added detection of local socket IP and fqdn
 216  *    - Removed logentry from cancelled commit
 217  *
 218  *    Revision 1.9  2001/06/07 23:06:09  jongfoster
 219  *    The host parameter to connect_to() is now const.
 220  *
 221  *    Revision 1.8  2001/06/03 19:12:07  oes
 222  *    filled comment
 223  *
 224  *    Revision 1.7  2001/05/28 16:14:00  jongfoster
 225  *    Fixing bug in LOG_LEVEL_LOG
 226  *
 227  *    Revision 1.6  2001/05/26 17:28:32  jongfoster
 228  *    Fixed LOG_LEVEL_LOG
 229  *
 230  *    Revision 1.5  2001/05/26 15:26:15  jongfoster
 231  *    ACL feature now provides more security by immediately dropping
 232  *    connections from untrusted hosts.
 233  *
 234  *    Revision 1.4  2001/05/26 00:37:42  jongfoster
 235  *    Cosmetic indentation correction.
 236  *
 237  *    Revision 1.3  2001/05/25 21:57:54  jongfoster
 238  *    Now gives a warning under Windows if you try to bind
 239  *    it to a port that's already in use.
 240  *
 241  *    Revision 1.2  2001/05/17 23:01:01  oes
 242  *     - Cleaned CRLF's from the sources and related files
 243  *
 244  *    Revision 1.1.1.1  2001/05/15 13:58:54  oes
 245  *    Initial import of version 2.9.3 source tree
 246  *
 247  *
 248  *********************************************************************/
 249 \f
 250
 251 #include "config.h"
 252
 253 #include <stdlib.h>
 254 #include <stdio.h>
 255 #include <string.h>
 256 #include <errno.h>
 257 #include <fcntl.h>
 258 #include <sys/types.h>
 259
 260 #ifdef _WIN32
 261
 262 #ifndef STRICT
 263 #define STRICT
 264 #endif
 265 #include <windows.h>
 266 #include <sys/timeb.h>
 267 #include <io.h>
 268
 269 #else
 270
 271 #ifndef __OS2__
 272 #include <unistd.h>
 273 #endif
 274 #include <sys/time.h>
 275 #include <netinet/in.h>
 276 #include <sys/ioctl.h>
 277 #include <netdb.h>
 278 #include <sys/socket.h>
 279
 280 #ifndef __BEOS__
 281 #include <netinet/tcp.h>
 282 #ifndef __OS2__
 283 #include <arpa/inet.h>
 284 #endif
 285 #else
 286 #include <socket.h>
 287 #endif
 288
 289 #if defined(__EMX__) || defined (__OS2__)
 290 #include <sys/select.h>  /* OS/2/EMX needs a little help with select */
 291 #ifdef __OS2__
 292 #include <nerrno.h>
 293 #endif
 294 #endif
 295
 296 #endif
 297
 298 #include "project.h"
 299
 300 #ifdef FEATURE_PTHREAD
 301 #include "jcc.h"
 302 /* jcc.h is for mutex semaphores only */
 303 #endif /* def FEATURE_PTHREAD */
 304
 305 #include "jbsockets.h"
 306 #include "filters.h"
 307 #include "errlog.h"
 308
 309 const char jbsockets_h_rcs[] = JBSOCKETS_H_VERSION;
 310
 311 /*
 312  * Maximum number of gethostbyname(_r) retries in case of
 313  * soft errors (TRY_AGAIN).
 314  * XXX: Does it make sense to make this a config option?
 315  */
 316 #define MAX_DNS_RETRIES 10
 317
 318 #define MAX_LISTEN_BACKLOG 128
 319
 320
 321 /*********************************************************************
 322  *
 323  * Function    :  connect_to
 324  *
 325  * Description :  Open a socket and connect to it.  Will check
 326  *                that this is allowed according to ACL.
 327  *
 328  * Parameters  :
 329  *          1  :  host = hostname to connect to
 330  *          2  :  portnum = port to connent on
 331  *          3  :  csp = Current client state (buffers, headers, etc...)
 332  *                      Not modified, only used for source IP and ACL.
 333  *
 334  * Returns     :  JB_INVALID_SOCKET => failure, else it is the socket
 335  *                file descriptor.
 336  *
 337  *********************************************************************/
 338 jb_socket connect_to(const char *host, int portnum, struct client_state *csp)
 339 {
 340    struct sockaddr_in inaddr;
 341    jb_socket fd;
 342    int addr;
 343    fd_set wfds;
 344    struct timeval tv[1];
 345 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA)
 346    int   flags;
 347 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
 348
 349 #ifdef FEATURE_ACL
 350    struct access_control_addr dst[1];
 351 #endif /* def FEATURE_ACL */
 352
 353    memset((char *)&inaddr, 0, sizeof inaddr);
 354
 355    if ((addr = resolve_hostname_to_ip(host)) == INADDR_NONE)
 356    {
 357       csp->http->host_ip_addr_str = strdup("unknown");
 358       return(JB_INVALID_SOCKET);
 359    }
 360
 361 #ifdef FEATURE_ACL
 362    dst->addr = ntohl((unsigned long) addr);
 363    dst->port = portnum;
 364
 365    if (block_acl(dst, csp))
 366    {
 367 #ifdef __OS2__
 368       errno = SOCEPERM;
 369 #else
 370       errno = EPERM;
 371 #endif
 372       return(JB_INVALID_SOCKET);
 373    }
 374 #endif /* def FEATURE_ACL */
 375
 376    inaddr.sin_addr.s_addr = addr;
 377    inaddr.sin_family      = AF_INET;
 378    csp->http->host_ip_addr_str = strdup(inet_ntoa(inaddr.sin_addr));
 379
 380 #ifndef _WIN32
 381    if (sizeof(inaddr.sin_port) == sizeof(short))
 382 #endif /* ndef _WIN32 */
 383    {
 384       inaddr.sin_port = htons((unsigned short) portnum);
 385    }
 386 #ifndef _WIN32
 387    else
 388    {
 389       inaddr.sin_port = htonl((unsigned long)portnum);
 390    }
 391 #endif /* ndef _WIN32 */
 392
 393 #ifdef _WIN32
 394    if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) == JB_INVALID_SOCKET)
 395 #else
 396    if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) < 0)
 397 #endif
 398    {
 399       return(JB_INVALID_SOCKET);
 400    }
 401
 402 #ifdef TCP_NODELAY
 403    {  /* turn off TCP coalescence */
 404       int mi = 1;
 405       setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, (char *) &mi, sizeof (int));
 406    }
 407 #endif /* def TCP_NODELAY */
 408
 409 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
 410    if ((flags = fcntl(fd, F_GETFL, 0)) != -1)
 411    {
 412       flags |= O_NDELAY;
 413       fcntl(fd, F_SETFL, flags);
 414    }
 415 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
 416
 417    while (connect(fd, (struct sockaddr *) & inaddr, sizeof inaddr) == JB_INVALID_SOCKET)
 418    {
 419 #ifdef _WIN32
 420       if (errno == WSAEINPROGRESS)
 421 #elif __OS2__
 422       if (sock_errno() == EINPROGRESS)
 423 #else /* ifndef _WIN32 */
 424       if (errno == EINPROGRESS)
 425 #endif /* ndef _WIN32 || __OS2__ */
 426       {
 427          break;
 428       }
 429
 430 #ifdef __OS2__
 431       if (sock_errno() != EINTR)
 432 #else
 433       if (errno != EINTR)
 434 #endif /* __OS2__ */
 435       {
 436          close_socket(fd);
 437          return(JB_INVALID_SOCKET);
 438       }
 439    }
 440
 441 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
 442    if (flags != -1)
 443    {
 444       flags &= ~O_NDELAY;
 445       fcntl(fd, F_SETFL, flags);
 446    }
 447 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
 448
 449    /* wait for connection to complete */
 450    FD_ZERO(&wfds);
 451    FD_SET(fd, &wfds);
 452
 453    tv->tv_sec  = 30;
 454    tv->tv_usec = 0;
 455
 456    /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Wierd! */
 457    if (select((int)fd + 1, NULL, &wfds, NULL, tv) <= 0)
 458    {
 459       close_socket(fd);
 460       return(JB_INVALID_SOCKET);
 461    }
 462    return(fd);
 463
 464 }
 465
 466
 467 /*********************************************************************
 468  *
 469  * Function    :  write_socket
 470  *
 471  * Description :  Write the contents of buf (for n bytes) to socket fd.
 472  *
 473  * Parameters  :
 474  *          1  :  fd = file descriptor (aka. handle) of socket to write to.
 475  *          2  :  buf = pointer to data to be written.
 476  *          3  :  len = length of data to be written to the socket "fd".
 477  *
 478  * Returns     :  0 on success (entire buffer sent).
 479  *                nonzero on error.
 480  *
 481  *********************************************************************/
 482 #ifdef AMIGA
 483 int write_socket(jb_socket fd, const char *buf, ssize_t len)
 484 #else
 485 int write_socket(jb_socket fd, const char *buf, size_t len)
 486 #endif
 487 {
 488    if (len == 0)
 489    {
 490       return 0;
 491    }
 492
 493    if (len < 0) /* constant condition - size_t isn't ever negative */
 494    {
 495       return 1;
 496    }
 497
 498    log_error(LOG_LEVEL_LOG, "%N", len, buf);
 499
 500 #if defined(_WIN32)
 501    return (send(fd, buf, (int)len, 0) != (int)len);
 502 #elif defined(__BEOS__) || defined(AMIGA)
 503    return (send(fd, buf, len, 0) != len);
 504 #elif defined(__OS2__)
 505    /*
 506     * Break the data up into SOCKET_SEND_MAX chunks for sending...
 507     * OS/2 seemed to complain when the chunks were too large.
 508     */
 509 #define SOCKET_SEND_MAX 65000
 510    {
 511       int write_len = 0, send_len, send_rc = 0, i = 0;
 512       while ((i < len) && (send_rc != -1))
 513       {
 514          if ((i + SOCKET_SEND_MAX) > len)
 515             send_len = len - i;
 516          else
 517             send_len = SOCKET_SEND_MAX;
 518          send_rc = send(fd,(char*)buf + i, send_len, 0);
 519          if (send_rc == -1)
 520             return 1;
 521          i = i + send_len;
 522       }
 523       return 0;
 524    }
 525 #else
 526    return (write(fd, buf, len) != len);
 527 #endif
 528
 529 }
 530
 531
 532 /*********************************************************************
 533  *
 534  * Function    :  read_socket
 535  *
 536  * Description :  Read from a TCP/IP socket in a platform independent way.
 537  *
 538  * Parameters  :
 539  *          1  :  fd = file descriptor of the socket to read
 540  *          2  :  buf = pointer to buffer where data will be written
 541  *                Must be >= len bytes long.
 542  *          3  :  len = maximum number of bytes to read
 543  *
 544  * Returns     :  On success, the number of bytes read is returned (zero
 545  *                indicates end of file), and the file position is advanced
 546  *                by this number.  It is not an error if this number is
 547  *                smaller than the number of bytes requested; this may hap-
 548  *                pen for example because fewer bytes are actually available
 549  *                right now (maybe because we were close to end-of-file, or
 550  *                because we are reading from a pipe, or from a terminal,
 551  *                or because read() was interrupted by a signal).  On error,
 552  *                -1 is returned, and errno is set appropriately.  In this
 553  *                case it is left unspecified whether the file position (if
 554  *                any) changes.
 555  *
 556  *********************************************************************/
 557 int read_socket(jb_socket fd, char *buf, int len)
 558 {
 559    if (len <= 0)
 560    {
 561       return(0);
 562    }
 563
 564 #if defined(_WIN32)
 565    return(recv(fd, buf, len, 0));
 566 #elif defined(__BEOS__) || defined(AMIGA) || defined(__OS2__)
 567    return(recv(fd, buf, (size_t)len, 0));
 568 #else
 569    return(read(fd, buf, (size_t)len));
 570 #endif
 571 }
 572
 573
 574 /*********************************************************************
 575  *
 576  * Function    :  close_socket
 577  *
 578  * Description :  Closes a TCP/IP socket
 579  *
 580  * Parameters  :
 581  *          1  :  fd = file descriptor of socket to be closed
 582  *
 583  * Returns     :  void
 584  *
 585  *********************************************************************/
 586 void close_socket(jb_socket fd)
 587 {
 588 #if defined(_WIN32) || defined(__BEOS__)
 589    closesocket(fd);
 590 #elif defined(AMIGA)
 591    CloseSocket(fd);
 592 #elif defined(__OS2__)
 593    soclose(fd);
 594 #else
 595    close(fd);
 596 #endif
 597
 598 }
 599
 600
 601 /*********************************************************************
 602  *
 603  * Function    :  bind_port
 604  *
 605  * Description :  Call socket, set socket options, and listen.
 606  *                Called by listen_loop to "boot up" our proxy address.
 607  *
 608  * Parameters  :
 609  *          1  :  hostnam = TCP/IP address to bind/listen to
 610  *          2  :  portnum = port to listen on
 611  *          3  :  pfd = pointer used to return file descriptor.
 612  *
 613  * Returns     :  if success, returns 0 and sets *pfd.
 614  *                if failure, returns -3 if address is in use,
 615  *                                    -2 if address unresolvable,
 616  *                                    -1 otherwise
 617  *********************************************************************/
 618 int bind_port(const char *hostnam, int portnum, jb_socket *pfd)
 619 {
 620    struct sockaddr_in inaddr;
 621    jb_socket fd;
 622 #ifndef _WIN32
 623    int one = 1;
 624 #endif /* ndef _WIN32 */
 625
 626    *pfd = JB_INVALID_SOCKET;
 627
 628    memset((char *)&inaddr, '\0', sizeof inaddr);
 629
 630    inaddr.sin_family      = AF_INET;
 631    inaddr.sin_addr.s_addr = resolve_hostname_to_ip(hostnam);
 632
 633    if (inaddr.sin_addr.s_addr == INADDR_NONE)
 634    {
 635       return(-2);
 636    }
 637
 638 #ifndef _WIN32
 639    if (sizeof(inaddr.sin_port) == sizeof(short))
 640 #endif /* ndef _WIN32 */
 641    {
 642       inaddr.sin_port = htons((unsigned short) portnum);
 643    }
 644 #ifndef _WIN32
 645    else
 646    {
 647       inaddr.sin_port = htonl((unsigned long) portnum);
 648    }
 649 #endif /* ndef _WIN32 */
 650
 651    fd = socket(AF_INET, SOCK_STREAM, 0);
 652
 653 #ifdef _WIN32
 654    if (fd == JB_INVALID_SOCKET)
 655 #else
 656    if (fd < 0)
 657 #endif
 658    {
 659       return(-1);
 660    }
 661
 662 #ifndef _WIN32
 663    /*
 664     * This is not needed for Win32 - in fact, it stops
 665     * duplicate instances of Privoxy from being caught.
 666     *
 667     * On UNIX, we assume the user is sensible enough not
 668     * to start Privoxy multiple times on the same IP.
 669     * Without this, stopping and restarting Privoxy
 670     * from a script fails.
 671     * Note: SO_REUSEADDR is meant to only take over
 672     * sockets which are *not* in listen state in Linux,
 673     * e.g. sockets in TIME_WAIT. YMMV.
 674     */
 675    setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (char *)&one, sizeof(one));
 676 #endif /* ndef _WIN32 */
 677
 678    if (bind(fd, (struct sockaddr *)&inaddr, sizeof(inaddr)) < 0)
 679    {
 680 #ifdef _WIN32
 681       errno = WSAGetLastError();
 682       if (errno == WSAEADDRINUSE)
 683 #else
 684       if (errno == EADDRINUSE)
 685 #endif
 686       {
 687          close_socket(fd);
 688          return(-3);
 689       }
 690       else
 691       {
 692          close_socket(fd);
 693          return(-1);
 694       }
 695    }
 696
 697    while (listen(fd, MAX_LISTEN_BACKLOG) == -1)
 698    {
 699       if (errno != EINTR)
 700       {
 701          return(-1);
 702       }
 703    }
 704
 705    *pfd = fd;
 706    return 0;
 707
 708 }
 709
 710
 711 /*********************************************************************
 712  *
 713  * Function    :  get_host_information
 714  *
 715  * Description :  Determines the IP address the client used to
 716  *                reach us and the hostname associated with it.
 717  *
 718  *                XXX: Most of the code has been copy and pasted
 719  *                from accept_connection() and not all of the
 720  *                ifdefs paths have been tested afterwards.
 721  *
 722  * Parameters  :
 723  *          1  :  afd = File descriptor returned from accept().
 724  *          2  :  ip_address = Pointer to return the pointer to
 725  *                             the ip address string.
 726  *          3  :  hostname =   Pointer to return the pointer to
 727  *                             the hostname.
 728  *
 729  * Returns     :  void.
 730  *
 731  *********************************************************************/
 732 void get_host_information(jb_socket afd, char **ip_address, char **hostname)
 733 {
 734    struct sockaddr_in server;
 735    struct hostent *host = NULL;
 736 #if defined(_WIN32) || defined(__OS2__) || defined(__APPLE_CC__) || defined(AMIGA)
 737    /* according to accept_connection() this fixes a warning. */
 738    int s_length;
 739 #else
 740    socklen_t s_length;
 741 #endif
 742 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS) ||  defined(HAVE_GETHOSTBYADDR_R_7_ARGS) || defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
 743    struct hostent result;
 744 #if defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
 745    struct hostent_data hdata;
 746 #else
 747    char hbuf[HOSTENT_BUFFER_SIZE];
 748    int thd_err;
 749 #endif /* def HAVE_GETHOSTBYADDR_R_5_ARGS */
 750 #endif /* def HAVE_GETHOSTBYADDR_R_(8|7|5)_ARGS */
 751    s_length = sizeof(server);
 752
 753    *hostname = NULL;
 754    *ip_address = NULL;
 755
 756    if (!getsockname(afd, (struct sockaddr *) &server, &s_length))
 757    {
 758       *ip_address = strdup(inet_ntoa(server.sin_addr));
 759 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS)
 760       gethostbyaddr_r((const char *)&server.sin_addr,
 761                       sizeof(server.sin_addr), AF_INET,
 762                       &result, hbuf, HOSTENT_BUFFER_SIZE,
 763                       &host, &thd_err);
 764 #elif defined(HAVE_GETHOSTBYADDR_R_7_ARGS)
 765       host = gethostbyaddr_r((const char *)&server.sin_addr,
 766                       sizeof(server.sin_addr), AF_INET,
 767                       &result, hbuf, HOSTENT_BUFFER_SIZE, &thd_err);
 768 #elif defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
 769       if (0 == gethostbyaddr_r((const char *)&server.sin_addr,
 770                                sizeof(server.sin_addr), AF_INET,
 771                                &result, &hdata))
 772       {
 773          host = &result;
 774       }
 775       else
 776       {
 777          host = NULL;
 778       }
 779 #elif FEATURE_PTHREAD
 780       pthread_mutex_lock(&resolver_mutex);
 781       host = gethostbyaddr((const char *)&server.sin_addr,
 782                            sizeof(server.sin_addr), AF_INET);
 783       pthread_mutex_unlock(&resolver_mutex);
 784 #else
 785       host = gethostbyaddr((const char *)&server.sin_addr,
 786                            sizeof(server.sin_addr), AF_INET);
 787 #endif
 788       if (host == NULL)
 789       {
 790          log_error(LOG_LEVEL_ERROR, "Unable to get my own hostname: %E\n");
 791       }
 792       else
 793       {
 794          *hostname = strdup(host->h_name);
 795       }
 796    }
 797
 798    return;
 799 }
 800
 801
 802 /*********************************************************************
 803  *
 804  * Function    :  accept_connection
 805  *
 806  * Description :  Accepts a connection on a socket.  Socket must have
 807  *                been created using bind_port().
 808  *
 809  * Parameters  :
 810  *          1  :  csp = Client state, cfd, ip_addr_str, and
 811  *                ip_addr_long will be set by this routine.
 812  *          2  :  fd  = file descriptor returned from bind_port
 813  *
 814  * Returns     :  when a connection is accepted, it returns 1 (TRUE).
 815  *                On an error it returns 0 (FALSE).
 816  *
 817  *********************************************************************/
 818 int accept_connection(struct client_state * csp, jb_socket fd)
 819 {
 820    struct sockaddr_in client;
 821    jb_socket afd;
 822 #if defined(_WIN32) || defined(__OS2__) || defined(__APPLE_CC__) || defined(AMIGA)
 823    /* Wierdness - fix a warning. */
 824    int c_length;
 825 #else
 826    socklen_t c_length;
 827 #endif
 828
 829    c_length = sizeof(client);
 830
 831 #ifdef _WIN32
 832    afd = accept (fd, (struct sockaddr *) &client, &c_length);
 833    if (afd == JB_INVALID_SOCKET)
 834    {
 835       return 0;
 836    }
 837 #else
 838    do
 839    {
 840       afd = accept (fd, (struct sockaddr *) &client, &c_length);
 841    } while (afd < 1 && errno == EINTR);
 842    if (afd < 0)
 843    {
 844       return 0;
 845    }
 846 #endif
 847
 848    csp->cfd = afd;
 849    csp->ip_addr_str  = strdup(inet_ntoa(client.sin_addr));
 850    csp->ip_addr_long = ntohl(client.sin_addr.s_addr);
 851
 852    return 1;
 853
 854 }
 855
 856
 857 /*********************************************************************
 858  *
 859  * Function    :  resolve_hostname_to_ip
 860  *
 861  * Description :  Resolve a hostname to an internet tcp/ip address.
 862  *                NULL or an empty string resolve to INADDR_ANY.
 863  *
 864  * Parameters  :
 865  *          1  :  host = hostname to resolve
 866  *
 867  * Returns     :  INADDR_NONE => failure, INADDR_ANY or tcp/ip address if succesful.
 868  *
 869  *********************************************************************/
 870 unsigned long resolve_hostname_to_ip(const char *host)
 871 {
 872    struct sockaddr_in inaddr;
 873    struct hostent *hostp;
 874    unsigned int dns_retries = 0;
 875 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS) || defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
 876    struct hostent result;
 877 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
 878    char hbuf[HOSTENT_BUFFER_SIZE];
 879    int thd_err;
 880 #else /* defined(HAVE_GETHOSTBYNAME_R_3_ARGS) */
 881    struct hostent_data hdata;
 882 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5)_ARGS */
 883 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
 884
 885    if ((host == NULL) || (*host == '\0'))
 886    {
 887       return(INADDR_ANY);
 888    }
 889
 890    memset((char *) &inaddr, 0, sizeof inaddr);
 891
 892    if ((inaddr.sin_addr.s_addr = inet_addr(host)) == -1)
 893    {
 894 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS)
 895       while (gethostbyname_r(host, &result, hbuf,
 896                 HOSTENT_BUFFER_SIZE, &hostp, &thd_err)
 897              && (thd_err == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
 898       {
 899          log_error(LOG_LEVEL_ERROR,
 900             "Timeout #%u while trying to resolve %s. Trying again.",
 901             dns_retries, host);
 902       }
 903 #elif defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
 904       while (NULL == (hostp = gethostbyname_r(host, &result,
 905                                  hbuf, HOSTENT_BUFFER_SIZE, &thd_err))
 906              && (thd_err == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
 907       {
 908          log_error(LOG_LEVEL_ERROR,
 909             "Timeout #%u while trying to resolve %s. Trying again.",
 910             dns_retries, host);
 911       }
 912 #elif defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
 913       /*
 914        * XXX: Doesn't retry in case of soft errors.
 915        * Does this gethostbyname_r version set h_errno?
 916        */
 917       if (0 == gethostbyname_r(host, &result, &hdata))
 918       {
 919          hostp = &result;
 920       }
 921       else
 922       {
 923          hostp = NULL;
 924       }
 925 #elif FEATURE_PTHREAD
 926       pthread_mutex_lock(&resolver_mutex);
 927       while (NULL == (hostp = gethostbyname(host))
 928              && (h_errno == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
 929       {
 930          log_error(LOG_LEVEL_ERROR,
 931             "Timeout #%u while trying to resolve %s. Trying again.",
 932             dns_retries, host);
 933       }
 934       pthread_mutex_unlock(&resolver_mutex);
 935 #else
 936       while (NULL == (hostp = gethostbyname(host))
 937              && (h_errno == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
 938       {
 939          log_error(LOG_LEVEL_ERROR,
 940             "Timeout #%u while trying to resolve %s. Trying again.",
 941             dns_retries, host);
 942       }
 943 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
 944       /*
 945        * On Mac OSX, if a domain exists but doesn't have a type A
 946        * record associated with it, the h_addr member of the struct
 947        * hostent returned by gethostbyname is NULL, even if h_length
 948        * is 4. Therefore the second test below.
 949        */
 950       if (hostp == NULL || hostp->h_addr == NULL)
 951       {
 952          errno = EINVAL;
 953          log_error(LOG_LEVEL_ERROR, "could not resolve hostname %s", host);
 954          return(INADDR_NONE);
 955       }
 956       if (hostp->h_addrtype != AF_INET)
 957       {
 958 #ifdef _WIN32
 959          errno = WSAEPROTOTYPE;
 960 #else
 961          errno = EPROTOTYPE;
 962 #endif
 963          log_error(LOG_LEVEL_ERROR, "hostname %s resolves to unknown address type.", host);
 964          return(INADDR_NONE);
 965       }
 966       memcpy(
 967          (char *) &inaddr.sin_addr,
 968          (char *) hostp->h_addr,
 969          sizeof(inaddr.sin_addr)
 970       );
 971    }
 972    return(inaddr.sin_addr.s_addr);
 973
 974 }
 975
 976
 977 /*
 978   Local Variables:
 979   tab-width: 3
 980   end:
 981 */