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