Add a comment about possibly questionable behaviour in accept_connection()
[privoxy.git] / jbsockets.c
1 const char jbsockets_rcs[] = "$Id: jbsockets.c,v 1.106 2011/07/17 13:36:27 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-2011 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 #ifdef HAVE_RFC2553
122 static jb_socket rfc2553_connect_to(const char *host, int portnum, struct client_state *csp);
123 #else
124 static jb_socket no_rfc2553_connect_to(const char *host, int portnum, struct client_state *csp);
125 #endif
126
127 /*********************************************************************
128  *
129  * Function    :  connect_to
130  *
131  * Description :  Open a socket and connect to it.  Will check
132  *                that this is allowed according to ACL.
133  *
134  * Parameters  :
135  *          1  :  host = hostname to connect to
136  *          2  :  portnum = port to connent on (XXX: should be unsigned)
137  *          3  :  csp = Current client state (buffers, headers, etc...)
138  *
139  * Returns     :  JB_INVALID_SOCKET => failure, else it is the socket
140  *                file descriptor.
141  *
142  *********************************************************************/
143 jb_socket connect_to(const char *host, int portnum, struct client_state *csp)
144 {
145    jb_socket fd;
146    int forwarded_connect_retries = 0;
147
148    do
149    {
150       /*
151        * XXX: The whole errno overloading is ridiculous and should
152        *      be replaced with something sane and thread safe
153        */
154       /* errno = 0;*/
155 #ifdef HAVE_RFC2553
156       fd = rfc2553_connect_to(host, portnum, csp);
157 #else
158       fd = no_rfc2553_connect_to(host, portnum, csp);
159 #endif
160       if ((fd != JB_INVALID_SOCKET) || (errno == EINVAL)
161          || (csp->fwd == NULL)
162          || ((csp->fwd->forward_host == NULL) && (csp->fwd->type == SOCKS_NONE)))
163       {
164          break;
165       }
166       forwarded_connect_retries++;
167       if (csp->config->forwarded_connect_retries != 0)
168       {
169          log_error(LOG_LEVEL_ERROR,
170             "Attempt %d of %d to connect to %s failed. Trying again.",
171             forwarded_connect_retries, csp->config->forwarded_connect_retries, host);
172       }
173
174    } while (forwarded_connect_retries < csp->config->forwarded_connect_retries);
175
176    return fd;
177 }
178
179 #ifdef HAVE_RFC2553
180 /* Getaddrinfo implementation */
181 static jb_socket rfc2553_connect_to(const char *host, int portnum, struct client_state *csp)
182 {
183    struct addrinfo hints, *result, *rp;
184    char service[6];
185    int retval;
186    jb_socket fd;
187    fd_set wfds;
188    struct timeval timeout;
189 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
190    int   flags;
191 #endif
192    int connect_failed;
193    /*
194     * XXX: Initializeing it here is only necessary
195     *      because not all situations are properly
196     *      covered yet.
197     */
198    int socket_error = 0;
199
200 #ifdef FEATURE_ACL
201    struct access_control_addr dst[1];
202 #endif /* def FEATURE_ACL */
203
204    /* Don't leak memory when retrying. */
205    freez(csp->error_message);
206    freez(csp->http->host_ip_addr_str);
207
208    retval = snprintf(service, sizeof(service), "%d", portnum);
209    if ((-1 == retval) || (sizeof(service) <= retval))
210    {
211       log_error(LOG_LEVEL_ERROR,
212          "Port number (%d) ASCII decimal representation doesn't fit into 6 bytes",
213          portnum);
214       csp->error_message = strdup("Invalid port number");
215       csp->http->host_ip_addr_str = strdup("unknown");
216       return(JB_INVALID_SOCKET);
217    }
218
219    memset((char *)&hints, 0, sizeof(hints));
220    hints.ai_family = AF_UNSPEC;
221    hints.ai_socktype = SOCK_STREAM;
222    hints.ai_flags = AI_NUMERICSERV; /* avoid service look-up */
223 #ifdef AI_ADDRCONFIG
224    hints.ai_flags |= AI_ADDRCONFIG;
225 #endif
226    if ((retval = getaddrinfo(host, service, &hints, &result)))
227    {
228       log_error(LOG_LEVEL_INFO,
229          "Can not resolve %s: %s", host, gai_strerror(retval));
230       /* XXX: Should find a better way to propagate this error. */
231       errno = EINVAL;
232       csp->error_message = strdup(gai_strerror(retval));
233       csp->http->host_ip_addr_str = strdup("unknown");
234       return(JB_INVALID_SOCKET);
235    }
236
237    csp->http->host_ip_addr_str = malloc(NI_MAXHOST);
238    if (NULL == csp->http->host_ip_addr_str)
239    {
240       freeaddrinfo(result);
241       log_error(LOG_LEVEL_ERROR,
242          "Out of memory while getting the server IP address.");
243       return JB_INVALID_SOCKET;
244    }
245
246    for (rp = result; rp != NULL; rp = rp->ai_next)
247    {
248
249 #ifdef FEATURE_ACL
250       memcpy(&dst->addr, rp->ai_addr, rp->ai_addrlen);
251
252       if (block_acl(dst, csp))
253       {
254 #ifdef __OS2__
255          socket_error = errno = SOCEPERM;
256 #else
257          socket_error = errno = EPERM;
258 #endif
259          continue;
260       }
261 #endif /* def FEATURE_ACL */
262
263       retval = getnameinfo(rp->ai_addr, rp->ai_addrlen,
264          csp->http->host_ip_addr_str, NI_MAXHOST, NULL, 0, NI_NUMERICHOST);
265       if (retval)
266       {
267          log_error(LOG_LEVEL_ERROR,
268             "Failed to get the host name from the socket structure: %s",
269             gai_strerror(retval));
270          continue;
271       }
272
273       fd = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
274 #ifdef _WIN32
275       if (fd == JB_INVALID_SOCKET)
276 #else
277       if (fd < 0)
278 #endif
279       {
280          continue;
281       }
282
283 #ifdef TCP_NODELAY
284       {  /* turn off TCP coalescence */
285          int mi = 1;
286          setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, (char *) &mi, sizeof (int));
287       }
288 #endif /* def TCP_NODELAY */
289
290 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
291       if ((flags = fcntl(fd, F_GETFL, 0)) != -1)
292       {
293          flags |= O_NDELAY;
294          fcntl(fd, F_SETFL, flags);
295       }
296 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
297
298       connect_failed = 0;
299       while (connect(fd, rp->ai_addr, rp->ai_addrlen) == JB_INVALID_SOCKET)
300       {
301 #ifdef __OS2__
302          errno = sock_errno();
303 #endif /* __OS2__ */
304
305 #ifdef _WIN32
306          if (errno == WSAEINPROGRESS)
307 #else /* ifndef _WIN32 */
308          if (errno == EINPROGRESS)
309 #endif /* ndef _WIN32 || __OS2__ */
310          {
311             break;
312          }
313
314          if (errno != EINTR)
315          {
316             close_socket(fd);
317             connect_failed = 1;
318             break;
319          }
320       }
321       if (connect_failed)
322       {
323          continue;
324       }
325
326 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
327       if (flags != -1)
328       {
329          flags &= ~O_NDELAY;
330          fcntl(fd, F_SETFL, flags);
331       }
332 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
333
334       /* wait for connection to complete */
335       FD_ZERO(&wfds);
336       FD_SET(fd, &wfds);
337
338       memset(&timeout, 0, sizeof(timeout));
339       timeout.tv_sec  = 30;
340
341       /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Weird! */
342       if ((select((int)fd + 1, NULL, &wfds, NULL, &timeout) > 0)
343          && FD_ISSET(fd, &wfds))
344       {
345          socklen_t optlen = sizeof(socket_error);
346          if (!getsockopt(fd, SOL_SOCKET, SO_ERROR, &socket_error, &optlen))
347          {
348             if (!socket_error)
349             {
350                /* Connection established, no need to try other addresses. */
351                break;
352             }
353             if (rp->ai_next != NULL)
354             {
355                /*
356                 * There's another address we can try, so log that this
357                 * one didn't work out. If the last one fails, too,
358                 * it will get logged outside the loop body so we don't
359                 * have to mention it here.
360                 */
361                log_error(LOG_LEVEL_CONNECT, "Could not connect to [%s]:%s: %s.",
362                   csp->http->host_ip_addr_str, service, strerror(socket_error));
363             }
364          }
365          else
366          {
367             socket_error = errno;
368             log_error(LOG_LEVEL_ERROR, "Could not get the state of "
369                "the connection to [%s]:%s: %s; dropping connection.",
370                csp->http->host_ip_addr_str, service, strerror(errno));
371          }
372       }
373
374       /* Connection failed, try next address */
375       close_socket(fd);
376    }
377
378    freeaddrinfo(result);
379    if (!rp)
380    {
381       log_error(LOG_LEVEL_CONNECT, "Could not connect to [%s]:%s: %s.",
382          host, service, strerror(socket_error));
383       csp->error_message = strdup(strerror(socket_error));
384       return(JB_INVALID_SOCKET);
385    }
386    log_error(LOG_LEVEL_CONNECT, "Connected to %s[%s]:%s.",
387       host, csp->http->host_ip_addr_str, service);
388
389    return(fd);
390
391 }
392
393 #else /* ndef HAVE_RFC2553 */
394 /* Pre-getaddrinfo implementation */
395
396 static jb_socket no_rfc2553_connect_to(const char *host, int portnum, struct client_state *csp)
397 {
398    struct sockaddr_in inaddr;
399    jb_socket fd;
400    unsigned int addr;
401    fd_set wfds;
402    struct timeval tv[1];
403 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
404    int   flags;
405 #endif
406
407 #ifdef FEATURE_ACL
408    struct access_control_addr dst[1];
409 #endif /* def FEATURE_ACL */
410
411    /* Don't leak memory when retrying. */
412    freez(csp->http->host_ip_addr_str);
413
414    memset((char *)&inaddr, 0, sizeof inaddr);
415
416    if ((addr = resolve_hostname_to_ip(host)) == INADDR_NONE)
417    {
418       csp->http->host_ip_addr_str = strdup("unknown");
419       return(JB_INVALID_SOCKET);
420    }
421
422 #ifdef FEATURE_ACL
423    dst->addr = ntohl(addr);
424    dst->port = portnum;
425
426    if (block_acl(dst, csp))
427    {
428 #ifdef __OS2__
429       errno = SOCEPERM;
430 #else
431       errno = EPERM;
432 #endif
433       return(JB_INVALID_SOCKET);
434    }
435 #endif /* def FEATURE_ACL */
436
437    inaddr.sin_addr.s_addr = addr;
438    inaddr.sin_family      = AF_INET;
439    csp->http->host_ip_addr_str = strdup(inet_ntoa(inaddr.sin_addr));
440
441 #ifndef _WIN32
442    if (sizeof(inaddr.sin_port) == sizeof(short))
443 #endif /* ndef _WIN32 */
444    {
445       inaddr.sin_port = htons((unsigned short) portnum);
446    }
447 #ifndef _WIN32
448    else
449    {
450       inaddr.sin_port = htonl((unsigned long)portnum);
451    }
452 #endif /* ndef _WIN32 */
453
454    fd = socket(inaddr.sin_family, SOCK_STREAM, 0);
455 #ifdef _WIN32
456    if (fd == JB_INVALID_SOCKET)
457 #else
458    if (fd < 0)
459 #endif
460    {
461       return(JB_INVALID_SOCKET);
462    }
463
464 #ifdef TCP_NODELAY
465    {  /* turn off TCP coalescence */
466       int mi = 1;
467       setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, (char *) &mi, sizeof (int));
468    }
469 #endif /* def TCP_NODELAY */
470
471 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
472    if ((flags = fcntl(fd, F_GETFL, 0)) != -1)
473    {
474       flags |= O_NDELAY;
475       fcntl(fd, F_SETFL, flags);
476    }
477 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
478
479    while (connect(fd, (struct sockaddr *) & inaddr, sizeof inaddr) == JB_INVALID_SOCKET)
480    {
481 #ifdef _WIN32
482       if (errno == WSAEINPROGRESS)
483 #elif __OS2__ 
484       if (sock_errno() == EINPROGRESS)
485 #else /* ifndef _WIN32 */
486       if (errno == EINPROGRESS)
487 #endif /* ndef _WIN32 || __OS2__ */
488       {
489          break;
490       }
491
492 #ifdef __OS2__ 
493       if (sock_errno() != EINTR)
494 #else
495       if (errno != EINTR)
496 #endif /* __OS2__ */
497       {
498          close_socket(fd);
499          return(JB_INVALID_SOCKET);
500       }
501    }
502
503 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
504    if (flags != -1)
505    {
506       flags &= ~O_NDELAY;
507       fcntl(fd, F_SETFL, flags);
508    }
509 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
510
511    /* wait for connection to complete */
512    FD_ZERO(&wfds);
513    FD_SET(fd, &wfds);
514
515    tv->tv_sec  = 30;
516    tv->tv_usec = 0;
517
518    /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Weird! */
519    if (select((int)fd + 1, NULL, &wfds, NULL, tv) <= 0)
520    {
521       close_socket(fd);
522       return(JB_INVALID_SOCKET);
523    }
524    return(fd);
525
526 }
527 #endif /* ndef HAVE_RFC2553 */
528
529
530 /*********************************************************************
531  *
532  * Function    :  write_socket
533  *
534  * Description :  Write the contents of buf (for n bytes) to socket fd.
535  *
536  * Parameters  :
537  *          1  :  fd = file descriptor (aka. handle) of socket to write to.
538  *          2  :  buf = pointer to data to be written.
539  *          3  :  len = length of data to be written to the socket "fd".
540  *
541  * Returns     :  0 on success (entire buffer sent).
542  *                nonzero on error.
543  *
544  *********************************************************************/
545 #ifdef AMIGA
546 int write_socket(jb_socket fd, const char *buf, ssize_t len)
547 #else
548 int write_socket(jb_socket fd, const char *buf, size_t len)
549 #endif
550 {
551    if (len == 0)
552    {
553       return 0;
554    }
555
556    log_error(LOG_LEVEL_WRITING, "to socket %d: %N", fd, len, buf);
557
558 #if defined(_WIN32)
559    return (send(fd, buf, (int)len, 0) != (int)len);
560 #elif defined(__BEOS__) || defined(AMIGA)
561    return (send(fd, buf, len, 0) != len);
562 #elif defined(__OS2__)
563    /*
564     * Break the data up into SOCKET_SEND_MAX chunks for sending...
565     * OS/2 seemed to complain when the chunks were too large.
566     */
567 #define SOCKET_SEND_MAX 65000
568    {
569       int send_len, send_rc = 0, i = 0;
570       while ((i < len) && (send_rc != -1))
571       {
572          if ((i + SOCKET_SEND_MAX) > len)
573             send_len = len - i;
574          else
575             send_len = SOCKET_SEND_MAX;
576          send_rc = send(fd,(char*)buf + i, send_len, 0);
577          if (send_rc == -1)
578             return 1;
579          i = i + send_len;
580       }
581       return 0;
582    }
583 #else
584    return (write(fd, buf, len) != len);
585 #endif
586
587 }
588
589
590 /*********************************************************************
591  *
592  * Function    :  read_socket
593  *
594  * Description :  Read from a TCP/IP socket in a platform independent way.
595  *
596  * Parameters  :
597  *          1  :  fd = file descriptor of the socket to read
598  *          2  :  buf = pointer to buffer where data will be written
599  *                Must be >= len bytes long.
600  *          3  :  len = maximum number of bytes to read
601  *
602  * Returns     :  On success, the number of bytes read is returned (zero
603  *                indicates end of file), and the file position is advanced
604  *                by this number.  It is not an error if this number is
605  *                smaller than the number of bytes requested; this may hap-
606  *                pen for example because fewer bytes are actually available
607  *                right now (maybe because we were close to end-of-file, or
608  *                because we are reading from a pipe, or from a terminal,
609  *                or because read() was interrupted by a signal).  On error,
610  *                -1 is returned, and errno is set appropriately.  In this
611  *                case it is left unspecified whether the file position (if
612  *                any) changes.
613  *
614  *********************************************************************/
615 int read_socket(jb_socket fd, char *buf, int len)
616 {
617    int ret;
618
619    if (len <= 0)
620    {
621       return(0);
622    }
623
624 #if defined(_WIN32)
625    ret = recv(fd, buf, len, 0);
626 #elif defined(__BEOS__) || defined(AMIGA) || defined(__OS2__)
627    ret = recv(fd, buf, (size_t)len, 0);
628 #else
629    ret = (int)read(fd, buf, (size_t)len);
630 #endif
631
632    if (ret > 0)
633    {
634       log_error(LOG_LEVEL_RECEIVED, "from socket %d: %N", fd, ret, buf);
635    }
636
637    return ret;
638 }
639
640
641 /*********************************************************************
642  *
643  * Function    :  data_is_available
644  *
645  * Description :  Waits for data to arrive on a socket.
646  *
647  * Parameters  :
648  *          1  :  fd = file descriptor of the socket to read
649  *          2  :  seconds_to_wait = number of seconds after which we give up.
650  *
651  * Returns     :  TRUE if data arrived in time,
652  *                FALSE otherwise.
653  *
654  *********************************************************************/
655 int data_is_available(jb_socket fd, int seconds_to_wait)
656 {
657    char buf[10];
658    fd_set rfds;
659    struct timeval timeout;
660    int n;
661
662    memset(&timeout, 0, sizeof(timeout));
663    timeout.tv_sec = seconds_to_wait;
664
665 #ifdef __OS2__
666    /* Copy and pasted from jcc.c ... */
667    memset(&rfds, 0, sizeof(fd_set));
668 #else
669    FD_ZERO(&rfds);
670 #endif
671    FD_SET(fd, &rfds);
672
673    n = select(fd+1, &rfds, NULL, NULL, &timeout);
674
675    /*
676     * XXX: Do we care about the different error conditions?
677     */
678    return ((n == 1) && (1 == recv(fd, buf, 1, MSG_PEEK)));
679 }
680
681
682 /*********************************************************************
683  *
684  * Function    :  close_socket
685  *
686  * Description :  Closes a TCP/IP socket
687  *
688  * Parameters  :
689  *          1  :  fd = file descriptor of socket to be closed
690  *
691  * Returns     :  void
692  *
693  *********************************************************************/
694 void close_socket(jb_socket fd)
695 {
696 #if defined(_WIN32) || defined(__BEOS__)
697    closesocket(fd);
698 #elif defined(AMIGA)
699    CloseSocket(fd); 
700 #elif defined(__OS2__)
701    soclose(fd);
702 #else
703    close(fd);
704 #endif
705
706 }
707
708
709 /*********************************************************************
710  *
711  * Function    :  bind_port
712  *
713  * Description :  Call socket, set socket options, and listen.
714  *                Called by listen_loop to "boot up" our proxy address.
715  *
716  * Parameters  :
717  *          1  :  hostnam = TCP/IP address to bind/listen to
718  *          2  :  portnum = port to listen on
719  *          3  :  pfd = pointer used to return file descriptor.
720  *
721  * Returns     :  if success, returns 0 and sets *pfd.
722  *                if failure, returns -3 if address is in use,
723  *                                    -2 if address unresolvable,
724  *                                    -1 otherwise
725  *********************************************************************/
726 int bind_port(const char *hostnam, int portnum, jb_socket *pfd)
727 {
728 #ifdef HAVE_RFC2553
729    struct addrinfo hints;
730    struct addrinfo *result, *rp;
731    /*
732     * XXX: portnum should be a string to allow symbolic service
733     * names in the configuration file and to avoid the following
734     * int2string.
735     */
736    char servnam[6];
737    int retval;
738 #else
739    struct sockaddr_in inaddr;
740 #endif /* def HAVE_RFC2553 */
741    jb_socket fd;
742 #ifndef _WIN32
743    int one = 1;
744 #endif /* ndef _WIN32 */
745
746    *pfd = JB_INVALID_SOCKET;
747
748 #ifdef HAVE_RFC2553
749    retval = snprintf(servnam, sizeof(servnam), "%d", portnum);
750    if ((-1 == retval) || (sizeof(servnam) <= retval))
751    {
752       log_error(LOG_LEVEL_ERROR,
753          "Port number (%d) ASCII decimal representation doesn't fit into 6 bytes",
754          portnum);
755       return -1;
756    }
757
758    memset(&hints, 0, sizeof(struct addrinfo));
759    if (hostnam == NULL)
760    {
761       /*
762        * XXX: This is a hack. The right thing to do
763        * would be to bind to both AF_INET and AF_INET6.
764        * This will also fail if there is no AF_INET
765        * version available.
766        */
767       hints.ai_family = AF_INET;
768    }
769    else
770    {
771       hints.ai_family = AF_UNSPEC;
772    }
773    hints.ai_socktype = SOCK_STREAM;
774    hints.ai_flags = AI_PASSIVE;
775    hints.ai_protocol = 0; /* Really any stream protocol or TCP only */
776    hints.ai_canonname = NULL;
777    hints.ai_addr = NULL;
778    hints.ai_next = NULL;
779
780    if ((retval = getaddrinfo(hostnam, servnam, &hints, &result)))
781    {
782       log_error(LOG_LEVEL_ERROR,
783          "Can not resolve %s: %s", hostnam, gai_strerror(retval));
784       return -2;
785    }
786 #else
787    memset((char *)&inaddr, '\0', sizeof inaddr);
788
789    inaddr.sin_family      = AF_INET;
790    inaddr.sin_addr.s_addr = resolve_hostname_to_ip(hostnam);
791
792    if (inaddr.sin_addr.s_addr == INADDR_NONE)
793    {
794       return(-2);
795    }
796
797 #ifndef _WIN32
798    if (sizeof(inaddr.sin_port) == sizeof(short))
799 #endif /* ndef _WIN32 */
800    {
801       inaddr.sin_port = htons((unsigned short) portnum);
802    }
803 #ifndef _WIN32
804    else
805    {
806       inaddr.sin_port = htonl((unsigned long) portnum);
807    }
808 #endif /* ndef _WIN32 */
809 #endif /* def HAVE_RFC2553 */
810
811 #ifdef HAVE_RFC2553
812    for (rp = result; rp != NULL; rp = rp->ai_next)
813    {
814       fd = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
815 #else
816    fd = socket(AF_INET, SOCK_STREAM, 0);
817 #endif /* def HAVE_RFC2553 */
818
819 #ifdef _WIN32
820    if (fd == JB_INVALID_SOCKET)
821 #else
822    if (fd < 0)
823 #endif
824    {
825 #ifdef HAVE_RFC2553
826       continue;
827 #else
828       return(-1);
829 #endif
830    }
831
832 #ifndef _WIN32
833    /*
834     * This is not needed for Win32 - in fact, it stops
835     * duplicate instances of Privoxy from being caught.
836     *
837     * On UNIX, we assume the user is sensible enough not
838     * to start Privoxy multiple times on the same IP.
839     * Without this, stopping and restarting Privoxy
840     * from a script fails.
841     * Note: SO_REUSEADDR is meant to only take over
842     * sockets which are *not* in listen state in Linux,
843     * e.g. sockets in TIME_WAIT. YMMV.
844     */
845    setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (char *)&one, sizeof(one));
846 #endif /* ndef _WIN32 */
847
848 #ifdef HAVE_RFC2553
849    if (bind(fd, rp->ai_addr, rp->ai_addrlen) < 0)
850 #else
851    if (bind(fd, (struct sockaddr *)&inaddr, sizeof(inaddr)) < 0)
852 #endif
853    {
854 #ifdef _WIN32
855       errno = WSAGetLastError();
856       if (errno == WSAEADDRINUSE)
857 #else
858       if (errno == EADDRINUSE)
859 #endif
860       {
861 #ifdef HAVE_RFC2553
862          freeaddrinfo(result);
863 #endif
864          close_socket(fd);
865          return(-3);
866       }
867       else
868       {
869          close_socket(fd);
870 #ifndef HAVE_RFC2553
871          return(-1);
872       }
873    }
874 #else
875       }
876    }
877    else
878    {
879       /* bind() succeeded, escape from for-loop */
880       /*
881        * XXX: Support multiple listening sockets (e.g. localhost
882        * resolves to AF_INET and AF_INET6, but only the first address
883        * is used
884        */
885       break;
886    }
887    }
888
889    freeaddrinfo(result);
890    if (rp == NULL)
891    {
892       /* All bind()s failed */
893       return(-1);
894    }
895 #endif /* ndef HAVE_RFC2553 */
896
897    while (listen(fd, MAX_LISTEN_BACKLOG) == -1)
898    {
899       if (errno != EINTR)
900       {
901          return(-1);
902       }
903    }
904
905    *pfd = fd;
906    return 0;
907
908 }
909
910
911 /*********************************************************************
912  *
913  * Function    :  get_host_information
914  *
915  * Description :  Determines the IP address the client used to
916  *                reach us and the hostname associated with it.
917  *
918  *                XXX: Most of the code has been copy and pasted
919  *                from accept_connection() and not all of the
920  *                ifdefs paths have been tested afterwards.
921  *
922  * Parameters  :
923  *          1  :  afd = File descriptor returned from accept().
924  *          2  :  ip_address = Pointer to return the pointer to
925  *                             the ip address string.
926  *          3  :  port =       Pointer to return the pointer to
927  *                             the TCP port string.
928  *          4  :  hostname =   Pointer to return the pointer to
929  *                             the hostname or NULL if the caller
930  *                             isn't interested in it.
931  *
932  * Returns     :  void.
933  *
934  *********************************************************************/
935 void get_host_information(jb_socket afd, char **ip_address, char **port,
936                           char **hostname)
937 {
938 #ifdef HAVE_RFC2553
939    struct sockaddr_storage server;
940    int retval;
941 #else
942    struct sockaddr_in server;
943    struct hostent *host = NULL;
944 #endif /* HAVE_RFC2553 */
945 #if defined(_WIN32) || defined(__OS2__) || defined(__APPLE_CC__) || defined(AMIGA)
946    /* according to accept_connection() this fixes a warning. */
947    int s_length, s_length_provided;
948 #else
949    socklen_t s_length, s_length_provided;
950 #endif
951 #ifndef HAVE_RFC2553
952 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS) ||  defined(HAVE_GETHOSTBYADDR_R_7_ARGS) || defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
953    struct hostent result;
954 #if defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
955    struct hostent_data hdata;
956 #else
957    char hbuf[HOSTENT_BUFFER_SIZE];
958    int thd_err;
959 #endif /* def HAVE_GETHOSTBYADDR_R_5_ARGS */
960 #endif /* def HAVE_GETHOSTBYADDR_R_(8|7|5)_ARGS */
961 #endif /* ifndef HAVE_RFC2553 */
962    s_length = s_length_provided = sizeof(server);
963
964    if (NULL != hostname)
965    {
966       *hostname = NULL;
967    }
968    *ip_address = NULL;
969    *port = NULL;
970
971    if (!getsockname(afd, (struct sockaddr *) &server, &s_length))
972    {
973       if (s_length > s_length_provided)
974       {
975          log_error(LOG_LEVEL_ERROR, "getsockname() truncated server address");
976          return;
977       }
978       *port = malloc(NI_MAXSERV);
979       if (NULL == *port)
980       {
981          log_error(LOG_LEVEL_ERROR,
982             "Out of memory while getting the client's port.");
983          return;
984       }
985 #ifdef HAVE_RFC2553
986       *ip_address = malloc(NI_MAXHOST);
987       if (NULL == *ip_address)
988       {
989          log_error(LOG_LEVEL_ERROR,
990             "Out of memory while getting the client's IP address.");
991          freez(*port);
992          return;
993       }
994       retval = getnameinfo((struct sockaddr *) &server, s_length,
995          *ip_address, NI_MAXHOST, *port, NI_MAXSERV,
996          NI_NUMERICHOST|NI_NUMERICSERV);
997       if (retval)
998       {
999          log_error(LOG_LEVEL_ERROR,
1000             "Unable to print my own IP address: %s", gai_strerror(retval));
1001          freez(*ip_address);
1002          freez(*port);
1003          return;
1004       }
1005 #else
1006       *ip_address = strdup(inet_ntoa(server.sin_addr));
1007       snprintf(*port, NI_MAXSERV, "%hu", ntohs(server.sin_port));
1008       *port[NI_MAXSERV - 1] = '\0';
1009 #endif /* HAVE_RFC2553 */
1010       if (NULL == hostname)
1011       {
1012          /*
1013           * We're done here, the caller isn't
1014           * interested in knowing the hostname.
1015           */
1016          return;
1017       }
1018
1019 #ifdef HAVE_RFC2553
1020       *hostname = malloc(NI_MAXHOST);
1021       if (NULL == *hostname)
1022       {
1023          log_error(LOG_LEVEL_ERROR,
1024             "Out of memory while getting the client's hostname.");
1025          return;
1026       }
1027       retval = getnameinfo((struct sockaddr *) &server, s_length,
1028          *hostname, NI_MAXHOST, NULL, 0, NI_NAMEREQD);
1029       if (retval)
1030       {
1031          log_error(LOG_LEVEL_ERROR,
1032             "Unable to resolve my own IP address: %s", gai_strerror(retval));
1033          freez(*hostname);
1034       }
1035 #else
1036 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS)
1037       gethostbyaddr_r((const char *)&server.sin_addr,
1038                       sizeof(server.sin_addr), AF_INET,
1039                       &result, hbuf, HOSTENT_BUFFER_SIZE,
1040                       &host, &thd_err);
1041 #elif defined(HAVE_GETHOSTBYADDR_R_7_ARGS)
1042       host = gethostbyaddr_r((const char *)&server.sin_addr,
1043                       sizeof(server.sin_addr), AF_INET,
1044                       &result, hbuf, HOSTENT_BUFFER_SIZE, &thd_err);
1045 #elif defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
1046       if (0 == gethostbyaddr_r((const char *)&server.sin_addr,
1047                                sizeof(server.sin_addr), AF_INET,
1048                                &result, &hdata))
1049       {
1050          host = &result;
1051       }
1052       else
1053       {
1054          host = NULL;
1055       }
1056 #elif defined(MUTEX_LOCKS_AVAILABLE)
1057       privoxy_mutex_lock(&resolver_mutex);
1058       host = gethostbyaddr((const char *)&server.sin_addr, 
1059                            sizeof(server.sin_addr), AF_INET);
1060       privoxy_mutex_unlock(&resolver_mutex);
1061 #else
1062       host = gethostbyaddr((const char *)&server.sin_addr, 
1063                            sizeof(server.sin_addr), AF_INET);
1064 #endif
1065       if (host == NULL)
1066       {
1067          log_error(LOG_LEVEL_ERROR, "Unable to get my own hostname: %E\n");
1068       }
1069       else
1070       {
1071          *hostname = strdup(host->h_name);
1072       }
1073 #endif /* else def HAVE_RFC2553 */
1074    }
1075
1076    return;
1077 }
1078
1079
1080 /*********************************************************************
1081  *
1082  * Function    :  accept_connection
1083  *
1084  * Description :  Accepts a connection on one of possibly multiple
1085  *                sockets. The socket(s) to check must have been
1086  *                created using bind_port().
1087  *
1088  * Parameters  :
1089  *          1  :  csp = Client state, cfd, ip_addr_str, and 
1090  *                      ip_addr_long will be set by this routine.
1091  *          2  :  fds = File descriptors returned from bind_port
1092  *
1093  * Returns     :  when a connection is accepted, it returns 1 (TRUE).
1094  *                On an error it returns 0 (FALSE).
1095  *
1096  *********************************************************************/
1097 int accept_connection(struct client_state * csp, jb_socket fds[])
1098 {
1099 #ifdef HAVE_RFC2553
1100    /* XXX: client is stored directly into csp->tcp_addr */
1101 #define client (csp->tcp_addr)
1102 #else
1103    struct sockaddr_in client;
1104 #endif
1105    jb_socket afd;
1106 #if defined(_WIN32) || defined(__OS2__) || defined(__APPLE_CC__) || defined(AMIGA)
1107    /* Wierdness - fix a warning. */
1108    int c_length;
1109 #else
1110    socklen_t c_length;
1111 #endif
1112    int retval;
1113    int i;
1114    int max_selected_socket;
1115    fd_set selected_fds;
1116    jb_socket fd;
1117
1118    c_length = sizeof(client);
1119
1120    /*
1121     * Wait for a connection on any socket.
1122     * Return immediately if no socket is listening.
1123     * XXX: Why not treat this as fatal error?
1124     */
1125    FD_ZERO(&selected_fds);
1126    max_selected_socket = 0;
1127    for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
1128    {
1129       if (JB_INVALID_SOCKET != fds[i])
1130       {
1131          FD_SET(fds[i], &selected_fds);
1132          if (max_selected_socket < fds[i] + 1)
1133          {
1134             max_selected_socket = fds[i] + 1;
1135          }
1136       }
1137    }
1138    if (0 == max_selected_socket)
1139    {
1140       return 0;
1141    }
1142    do
1143    {
1144       retval = select(max_selected_socket, &selected_fds, NULL, NULL, NULL);
1145    } while (retval < 0 && errno == EINTR);
1146    if (retval <= 0)
1147    {
1148       if (0 == retval)
1149       {
1150          log_error(LOG_LEVEL_ERROR,
1151             "Waiting on new client failed because select(2) returned 0."
1152             " This should not happen.");
1153       }
1154       else
1155       {
1156          log_error(LOG_LEVEL_ERROR,
1157             "Waiting on new client failed because of problems in select(2): "
1158             "%s.", strerror(errno));
1159       }
1160       return 0;
1161    }
1162    for (i = 0; i < MAX_LISTENING_SOCKETS && !FD_ISSET(fds[i], &selected_fds);
1163          i++);
1164    if (i >= MAX_LISTENING_SOCKETS)
1165    {
1166       log_error(LOG_LEVEL_ERROR,
1167          "select(2) reported connected clients (number = %u, "
1168          "descriptor boundary = %u), but none found.",
1169          retval, max_selected_socket);
1170       return 0;
1171    }
1172    fd = fds[i];
1173
1174    /* Accept selected connection */
1175 #ifdef _WIN32
1176    afd = accept (fd, (struct sockaddr *) &client, &c_length);
1177    if (afd == JB_INVALID_SOCKET)
1178    {
1179       return 0;
1180    }
1181 #else
1182    do
1183    {
1184 #if defined(FEATURE_ACCEPT_FILTER) && defined(SO_ACCEPTFILTER)
1185       struct accept_filter_arg af_options;
1186       bzero(&af_options, sizeof(af_options));
1187       strlcpy(af_options.af_name, "httpready", sizeof(af_options.af_name));
1188       setsockopt(fd, SOL_SOCKET, SO_ACCEPTFILTER, &af_options, sizeof(af_options));
1189 #endif
1190       afd = accept (fd, (struct sockaddr *) &client, &c_length);
1191    } while (afd < 1 && errno == EINTR);
1192    if (afd < 0)
1193    {
1194       return 0;
1195    }
1196 #endif
1197
1198    csp->cfd = afd;
1199 #ifdef HAVE_RFC2553
1200    csp->ip_addr_str = malloc(NI_MAXHOST);
1201    if (NULL == csp->ip_addr_str)
1202    {
1203       log_error(LOG_LEVEL_ERROR,
1204          "Out of memory while getting the client's IP address.");
1205       return 0;
1206    }
1207    retval = getnameinfo((struct sockaddr *) &client, c_length,
1208          csp->ip_addr_str, NI_MAXHOST, NULL, 0, NI_NUMERICHOST);
1209    if (!csp->ip_addr_str || retval)
1210    {
1211       log_error(LOG_LEVEL_ERROR, "Can not save csp->ip_addr_str: %s",
1212          (csp->ip_addr_str) ? gai_strerror(retval) : "Insuffcient memory");
1213       freez(csp->ip_addr_str);
1214    }
1215 #undef client
1216 #else
1217    csp->ip_addr_str  = strdup(inet_ntoa(client.sin_addr));
1218    csp->ip_addr_long = ntohl(client.sin_addr.s_addr);
1219 #endif /* def HAVE_RFC2553 */
1220
1221    return 1;
1222
1223 }
1224
1225
1226 /*********************************************************************
1227  *
1228  * Function    :  resolve_hostname_to_ip
1229  *
1230  * Description :  Resolve a hostname to an internet tcp/ip address.
1231  *                NULL or an empty string resolve to INADDR_ANY.
1232  *
1233  * Parameters  :
1234  *          1  :  host = hostname to resolve
1235  *
1236  * Returns     :  INADDR_NONE => failure, INADDR_ANY or tcp/ip address if successful.
1237  *
1238  *********************************************************************/
1239 unsigned long resolve_hostname_to_ip(const char *host)
1240 {
1241    struct sockaddr_in inaddr;
1242    struct hostent *hostp;
1243 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS) || defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
1244    struct hostent result;
1245 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
1246    char hbuf[HOSTENT_BUFFER_SIZE];
1247    int thd_err;
1248 #else /* defined(HAVE_GETHOSTBYNAME_R_3_ARGS) */
1249    struct hostent_data hdata;
1250 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5)_ARGS */
1251 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
1252
1253    if ((host == NULL) || (*host == '\0'))
1254    {
1255       return(INADDR_ANY);
1256    }
1257
1258    memset((char *) &inaddr, 0, sizeof inaddr);
1259
1260    if ((inaddr.sin_addr.s_addr = inet_addr(host)) == -1)
1261    {
1262       unsigned int dns_retries = 0;
1263 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS)
1264       while (gethostbyname_r(host, &result, hbuf,
1265                 HOSTENT_BUFFER_SIZE, &hostp, &thd_err)
1266              && (thd_err == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
1267       {   
1268          log_error(LOG_LEVEL_ERROR,
1269             "Timeout #%u while trying to resolve %s. Trying again.",
1270             dns_retries, host);
1271       }
1272 #elif defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
1273       while (NULL == (hostp = gethostbyname_r(host, &result,
1274                                  hbuf, HOSTENT_BUFFER_SIZE, &thd_err))
1275              && (thd_err == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
1276       {   
1277          log_error(LOG_LEVEL_ERROR,
1278             "Timeout #%u while trying to resolve %s. Trying again.",
1279             dns_retries, host);
1280       }
1281 #elif defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
1282       /*
1283        * XXX: Doesn't retry in case of soft errors.
1284        * Does this gethostbyname_r version set h_errno?
1285        */
1286       if (0 == gethostbyname_r(host, &result, &hdata))
1287       {
1288          hostp = &result;
1289       }
1290       else
1291       {
1292          hostp = NULL;
1293       }
1294 #elif defined(MUTEX_LOCKS_AVAILABLE)
1295       privoxy_mutex_lock(&resolver_mutex);
1296       while (NULL == (hostp = gethostbyname(host))
1297              && (h_errno == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
1298       {   
1299          log_error(LOG_LEVEL_ERROR,
1300             "Timeout #%u while trying to resolve %s. Trying again.",
1301             dns_retries, host);
1302       }
1303       privoxy_mutex_unlock(&resolver_mutex);
1304 #else
1305       while (NULL == (hostp = gethostbyname(host))
1306              && (h_errno == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
1307       {
1308          log_error(LOG_LEVEL_ERROR,
1309             "Timeout #%u while trying to resolve %s. Trying again.",
1310             dns_retries, host);
1311       }
1312 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
1313       /*
1314        * On Mac OSX, if a domain exists but doesn't have a type A
1315        * record associated with it, the h_addr member of the struct
1316        * hostent returned by gethostbyname is NULL, even if h_length
1317        * is 4. Therefore the second test below.
1318        */
1319       if (hostp == NULL || hostp->h_addr == NULL)
1320       {
1321          errno = EINVAL;
1322          log_error(LOG_LEVEL_ERROR, "could not resolve hostname %s", host);
1323          return(INADDR_NONE);
1324       }
1325       if (hostp->h_addrtype != AF_INET)
1326       {
1327 #ifdef _WIN32
1328          errno = WSAEPROTOTYPE;
1329 #else
1330          errno = EPROTOTYPE;
1331 #endif 
1332          log_error(LOG_LEVEL_ERROR, "hostname %s resolves to unknown address type.", host);
1333          return(INADDR_NONE);
1334       }
1335       memcpy(
1336          (char *) &inaddr.sin_addr,
1337          (char *) hostp->h_addr,
1338          sizeof(inaddr.sin_addr)
1339       );
1340    }
1341    return(inaddr.sin_addr.s_addr);
1342
1343 }
1344
1345
1346 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1347 /*********************************************************************
1348  *
1349  * Function    :  socket_is_still_alive
1350  *
1351  * Description :  Figures out whether or not a socket is still alive.
1352  *
1353  * Parameters  :
1354  *          1  :  sfd = The socket to check.
1355  *
1356  * Returns     :  TRUE for yes, otherwise FALSE.
1357  *
1358  *********************************************************************/
1359 int socket_is_still_alive(jb_socket sfd)
1360 {
1361    char buf[10];
1362    int no_data_waiting;
1363
1364 #ifdef HAVE_POLL
1365    int poll_result;
1366    struct pollfd poll_fd[1];
1367
1368    memset(poll_fd, 0, sizeof(poll_fd));
1369    poll_fd[0].fd = sfd;
1370    poll_fd[0].events = POLLIN;
1371
1372    poll_result = poll(poll_fd, 1, 0);
1373
1374    if (-1 == poll_result)
1375    {
1376       log_error(LOG_LEVEL_CONNECT, "Polling socket %d failed.", sfd);
1377       return FALSE;
1378    }
1379    no_data_waiting = !(poll_fd[0].revents & POLLIN);
1380 #else
1381    fd_set readable_fds;
1382    struct timeval timeout;
1383    int ret;
1384
1385    memset(&timeout, '\0', sizeof(timeout));
1386    FD_ZERO(&readable_fds);
1387    FD_SET(sfd, &readable_fds);
1388
1389    ret = select((int)sfd+1, &readable_fds, NULL, NULL, &timeout);
1390    if (ret < 0)
1391    {
1392       log_error(LOG_LEVEL_CONNECT, "select() on socket %d failed: %E", sfd);
1393       return FALSE;
1394    }
1395    no_data_waiting = !FD_ISSET(sfd, &readable_fds);
1396 #endif /* def HAVE_POLL */
1397
1398    return (no_data_waiting || (1 == recv(sfd, buf, 1, MSG_PEEK)));
1399 }
1400 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1401
1402
1403 /*
1404   Local Variables:
1405   tab-width: 3
1406   end:
1407 */