1 const char jbsockets_rcs[] = "$Id: jbsockets.c,v 1.54 2009/04/17 11:45:19 fabiankeil Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/jbsockets.c,v $
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
11 * Copyright : Written by and Copyright (C) 2001-2009 the
12 * Privoxy team. http://www.privoxy.org/
14 * Based on the Internet Junkbuster originally written
15 * by and Copyright (C) 1997 Anonymous Coders and
16 * Junkbusters Corporation. http://www.junkbusters.com
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.
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.
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.
37 * $Log: jbsockets.c,v $
38 * Revision 1.54 2009/04/17 11:45:19 fabiankeil
39 * Replace HAVE_GETADDRINFO and HAVE_GETNAMEINFO macros
40 * with HAVE_RFC2553 macro. Original patch by Petr Pisar.
42 * Revision 1.53 2009/04/17 11:39:52 fabiankeil
43 * If the hostname is 'localhost' or not specified, request an AF_INET address.
45 * Revision 1.52 2009/04/17 11:34:34 fabiankeil
46 * Style cosmetics for the IPv6 code.
48 * Revision 1.51 2009/04/17 11:27:49 fabiankeil
49 * Petr Pisar's privoxy-3.0.12-ipv6-3.diff.
51 * Revision 1.50 2008/12/20 14:53:55 fabiankeil
52 * Add config option socket-timeout to control the time
53 * Privoxy waits for data to arrive on a socket. Useful
54 * in case of stale ssh tunnels or when fuzz-testing.
56 * Revision 1.49 2008/11/10 17:03:57 fabiankeil
57 * Fix a gcc44 warning and remove a now-obsolete cast.
59 * Revision 1.48 2008/09/04 08:13:58 fabiankeil
60 * Prepare for critical sections on Windows by adding a
61 * layer of indirection before the pthread mutex functions.
63 * Revision 1.47 2008/03/26 18:07:07 fabiankeil
64 * Add hostname directive. Closes PR#1918189.
66 * Revision 1.46 2008/03/21 11:13:57 fabiankeil
67 * Only gather host information if it's actually needed.
68 * Also move the code out of accept_connection() so it's less likely
69 * to delay other incoming connections if the host is misconfigured.
71 * Revision 1.45 2007/09/30 16:59:22 fabiankeil
72 * Set the maximum listen() backlog to 128. Apparently SOMAXCONN is
73 * neither high enough, nor a hard limit on mingw32. Again for BR#1795281.
75 * Revision 1.44 2007/09/15 13:01:31 fabiankeil
76 * Increase listen() backlog to SOMAXCONN (or 128) to decrease
77 * chances of dropped connections under load. Problem reported
78 * and fix suggested by nobody in BR#1795281.
80 * Revision 1.43 2007/06/01 18:16:36 fabiankeil
81 * Use the same mutex for gethostbyname() and gethostbyaddr() to prevent
82 * deadlocks and crashes on OpenBSD and possibly other OS with neither
83 * gethostbyname_r() nor gethostaddr_r(). Closes BR#1729174.
84 * Thanks to Ralf Horstmann for report and solution.
86 * Revision 1.42 2007/04/01 17:37:07 fabiankeil
87 * - Add DNS retries for Solaris and other systems
88 * whose gethostbyname_r version takes five arguments.
89 * - Move maximum number of DNS retries into a macro.
91 * Revision 1.41 2006/11/13 19:05:51 fabiankeil
92 * Make pthread mutex locking more generic. Instead of
93 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
94 * and use mutex locking unless there is an _r function
95 * available. Better safe than sorry.
97 * Fixes "./configure --disable-pthread" and should result
98 * in less threading-related problems on pthread-using platforms,
99 * but it still doesn't fix BR#1122404.
101 * Revision 1.40 2006/09/02 15:36:42 fabiankeil
102 * Follow the OpenBSD port's lead and protect the resolve
103 * functions on OpenBSD as well.
105 * Revision 1.39 2006/08/03 02:46:41 david__schmidt
106 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
108 * Revision 1.38 2006/07/18 14:48:46 david__schmidt
109 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
110 * with what was really the latest development (the v_3_0_branch branch)
112 * Revision 1.35.2.8 2006/01/21 16:16:08 david__schmidt
113 * Thanks to Edward Carrel for his patch to modernize OSX's
\rpthreads support. See bug #1409623.
115 * Revision 1.35.2.7 2005/05/07 21:50:55 david__schmidt
116 * A few memory leaks plugged (mostly on error paths)
118 * Revision 1.35.2.6 2003/12/17 16:34:40 oes
121 * Revision 1.35.2.5 2003/04/29 11:32:54 oes
122 * Don't rely on h_addr being non-NULL after gethostbyname.
123 * Works around an oddness in Max OSX and closes bug #724796
125 * Revision 1.35.2.4 2003/04/04 12:40:20 oes
126 * Made sure the errno set by bind, not close[socket] is used in
127 * bind_port. Probably fixes bugs #713777, #705562.
129 * Revision 1.35.2.3 2003/03/07 03:41:04 david__schmidt
130 * 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.
132 * Revision 1.35.2.2 2002/11/20 14:37:24 oes
133 * Fixed Win32 error logging in bind_port.
134 * Thanks to Oliver Stoeneberg for the hint.
136 * Revision 1.35.2.1 2002/05/26 23:41:27 joergs
137 * AmigaOS: Fixed wrong type of len in write_socket()
139 * Revision 1.35 2002/04/26 15:50:04 joergs
140 * AmigaOS: No socklen_t, added AMIGA to the systems using int instead.
142 * Revision 1.34 2002/04/08 20:31:41 swa
145 * Revision 1.33 2002/04/03 16:02:18 gliptak
146 * Correcting compile warning with older gcc
148 * Revision 1.32 2002/03/31 17:18:59 jongfoster
149 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
151 * Revision 1.31 2002/03/29 03:33:13 david__schmidt
152 * Fix Mac OSX compiler warnings
154 * Revision 1.30 2002/03/27 14:32:43 david__schmidt
155 * More compiler warning message maintenance
157 * Revision 1.29 2002/03/26 22:29:54 swa
158 * we have a new homepage!
160 * Revision 1.28 2002/03/24 13:25:43 swa
161 * name change related issues
163 * Revision 1.27 2002/03/13 00:27:05 jongfoster
166 * Revision 1.26 2002/03/11 22:07:02 david__schmidt
167 * OS/2 port maintenance:
168 * - Fixed EMX build - it had decayed a little
169 * - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
170 * substituted a memset for now.
172 * Revision 1.25 2002/03/09 20:03:52 jongfoster
173 * - Making various functions return int rather than size_t.
174 * (Undoing a recent change). Since size_t is unsigned on
175 * Windows, functions like read_socket that return -1 on
176 * error cannot return a size_t.
178 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
179 * crashes, and also frequently caused JB to jump to 100%
180 * CPU and stay there. (Because it thought it had just
181 * read ((unsigned)-1) == 4Gb of data...)
183 * - The signature of write_socket has changed, it now simply
184 * returns success=0/failure=nonzero.
186 * - Trying to get rid of a few warnings --with-debug on
187 * Windows, I've introduced a new type "jb_socket". This is
188 * used for the socket file descriptors. On Windows, this
189 * is SOCKET (a typedef for unsigned). Everywhere else, it's
190 * an int. The error value can't be -1 any more, so it's
191 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
192 * Windows it maps to the #define INVALID_SOCKET.)
194 * - The signature of bind_port has changed.
196 * Revision 1.24 2002/03/07 03:51:36 oes
197 * - Improved handling of failed DNS lookups
198 * - Fixed compiler warnings etc
200 * Revision 1.23 2002/03/05 00:36:01 jongfoster
201 * Fixing bug 514988 - unable to restart Junkbuster
203 * Revision 1.22 2002/03/04 02:08:02 david__schmidt
204 * Enable web editing of actions file on OS/2 (it had been broken all this time!)
206 * Revision 1.21 2002/01/09 14:32:33 oes
207 * Added support for gethostbyname_r and gethostbyaddr_r.
209 * Revision 1.20 2001/11/16 00:48:48 jongfoster
210 * Enabling duplicate-socket detection for all platforms, not
213 * Revision 1.19 2001/10/25 03:40:47 david__schmidt
214 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
215 * threads to call select() simultaneously. So, it's time to do a real, live,
216 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
217 * (native). Both versions will work, but using __OS2__ offers multi-threading.
219 * Revision 1.18 2001/09/21 23:02:02 david__schmidt
220 * Cleaning up 2 compiler warnings on OS/2.
222 * Revision 1.17 2001/09/13 20:11:46 jongfoster
223 * Fixing 2 compiler warnings under Win32
225 * Revision 1.16 2001/07/30 22:08:36 jongfoster
226 * Tidying up #defines:
227 * - All feature #defines are now of the form FEATURE_xxx
228 * - Permanently turned off WIN_GUI_EDIT
229 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
231 * Revision 1.15 2001/07/29 17:40:43 jongfoster
232 * Fixed compiler warning by adding a cast
234 * Revision 1.14 2001/07/18 13:47:59 oes
235 * Eliminated dirty hack for getsockbyname()
237 * Revision 1.13 2001/07/15 13:56:57 jongfoster
238 * Removing unused local variable.
240 * Revision 1.12 2001/07/01 17:04:11 oes
241 * Bugfix: accept_connection no longer uses the obsolete hstrerror() function
243 * Revision 1.11 2001/06/29 21:45:41 oes
244 * Indentation, CRLF->LF, Tab-> Space
246 * Revision 1.10 2001/06/29 13:29:15 oes
247 * - Added remote (server) host IP to csp->http->host_ip_addr_str
248 * - Added detection of local socket IP and fqdn
249 * - Removed logentry from cancelled commit
251 * Revision 1.9 2001/06/07 23:06:09 jongfoster
252 * The host parameter to connect_to() is now const.
254 * Revision 1.8 2001/06/03 19:12:07 oes
257 * Revision 1.7 2001/05/28 16:14:00 jongfoster
258 * Fixing bug in LOG_LEVEL_LOG
260 * Revision 1.6 2001/05/26 17:28:32 jongfoster
261 * Fixed LOG_LEVEL_LOG
263 * Revision 1.5 2001/05/26 15:26:15 jongfoster
264 * ACL feature now provides more security by immediately dropping
265 * connections from untrusted hosts.
267 * Revision 1.4 2001/05/26 00:37:42 jongfoster
268 * Cosmetic indentation correction.
270 * Revision 1.3 2001/05/25 21:57:54 jongfoster
271 * Now gives a warning under Windows if you try to bind
272 * it to a port that's already in use.
274 * Revision 1.2 2001/05/17 23:01:01 oes
275 * - Cleaned CRLF's from the sources and related files
277 * Revision 1.1.1.1 2001/05/15 13:58:54 oes
278 * Initial import of version 2.9.3 source tree
281 *********************************************************************/
291 #include <sys/types.h>
299 #include <sys/timeb.h>
307 #include <sys/time.h>
308 #include <netinet/in.h>
309 #include <sys/ioctl.h>
311 #include <sys/socket.h>
314 #include <netinet/tcp.h>
316 #include <arpa/inet.h>
322 #if defined(__EMX__) || defined (__OS2__)
323 #include <sys/select.h> /* OS/2/EMX needs a little help with select */
331 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
334 #include <sys/poll.h>
337 #endif /* def __GLIBC__ */
338 #endif /* HAVE_POLL */
339 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
343 #ifdef FEATURE_PTHREAD
345 /* jcc.h is for mutex semaphores only */
346 #endif /* def FEATURE_PTHREAD */
348 #include "jbsockets.h"
351 #include "miscutil.h"
353 const char jbsockets_h_rcs[] = JBSOCKETS_H_VERSION;
356 * Maximum number of gethostbyname(_r) retries in case of
357 * soft errors (TRY_AGAIN).
358 * XXX: Does it make sense to make this a config option?
360 #define MAX_DNS_RETRIES 10
362 #define MAX_LISTEN_BACKLOG 128
365 /*********************************************************************
367 * Function : connect_to
369 * Description : Open a socket and connect to it. Will check
370 * that this is allowed according to ACL.
373 * 1 : host = hostname to connect to
374 * 2 : portnum = port to connent on (XXX: should be unsigned)
375 * 3 : csp = Current client state (buffers, headers, etc...)
376 * Not modified, only used for source IP and ACL.
378 * Returns : JB_INVALID_SOCKET => failure, else it is the socket
381 *********************************************************************/
383 /* Getaddrinfo implementation */
384 jb_socket connect_to(const char *host, int portnum, struct client_state *csp)
386 struct addrinfo hints, *result, *rp;
391 struct timeval tv[1];
392 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA)
394 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
398 struct access_control_addr dst[1];
399 #endif /* def FEATURE_ACL */
401 retval = snprintf(service, sizeof(service), "%d", portnum);
402 if ((-1 == retval) || (sizeof(service) <= retval))
404 log_error(LOG_LEVEL_ERROR,
405 "Port number (%d) ASCII decimal representation doesn't fit into 6 bytes",
407 csp->http->host_ip_addr_str = strdup("unknown");
408 return(JB_INVALID_SOCKET);
411 memset((char *)&hints, 0, sizeof(hints));
412 hints.ai_family = AF_UNSPEC;
413 hints.ai_socktype = SOCK_STREAM;
414 hints.ai_flags = AI_ADDRCONFIG | AI_NUMERICSERV; /* avoid service look-up */
415 if ((retval = getaddrinfo(host, service, &hints, &result)))
417 log_error(LOG_LEVEL_INFO,
418 "Can not resolve %s: %s", host, gai_strerror(retval));
419 csp->http->host_ip_addr_str = strdup("unknown");
420 return(JB_INVALID_SOCKET);
423 for (rp = result; rp != NULL; rp = rp->ai_next)
427 memcpy(&dst->addr, rp->ai_addr, rp->ai_addrlen);
429 if (block_acl(dst, csp))
438 #endif /* def FEATURE_ACL */
440 csp->http->host_ip_addr_str = malloc(NI_MAXHOST);
441 retval = getnameinfo(rp->ai_addr, rp->ai_addrlen,
442 csp->http->host_ip_addr_str, NI_MAXHOST, NULL, 0, NI_NUMERICHOST);
443 if (!csp->http->host_ip_addr_str || retval)
445 log_error(LOG_LEVEL_ERROR,
446 "Can not save csp->http->host_ip_addr_str: %s",
447 (csp->http->host_ip_addr_str) ?
448 gai_strerror(retval) : "Insufficient memory");
449 freez(csp->http->host_ip_addr_str);
454 if ((fd = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol)) ==
457 if ((fd = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol)) < 0)
464 { /* turn off TCP coalescence */
466 setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, (char *) &mi, sizeof (int));
468 #endif /* def TCP_NODELAY */
470 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
471 if ((flags = fcntl(fd, F_GETFL, 0)) != -1)
474 fcntl(fd, F_SETFL, flags);
476 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
479 while (connect(fd, rp->ai_addr, rp->ai_addrlen) == JB_INVALID_SOCKET)
482 if (errno == WSAEINPROGRESS)
484 if (sock_errno() == EINPROGRESS)
485 #else /* ifndef _WIN32 */
486 if (errno == EINPROGRESS)
487 #endif /* ndef _WIN32 || __OS2__ */
493 if (sock_errno() != EINTR)
508 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
512 fcntl(fd, F_SETFL, flags);
514 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
516 /* wait for connection to complete */
523 /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Wierd! */
524 if (select((int)fd + 1, NULL, &wfds, NULL, tv) <= 0)
530 break; /* for; Connection established; don't try other addresses */
533 freeaddrinfo(result);
536 log_error(LOG_LEVEL_INFO,
537 "Could not connect to TCP/[%s]:%s", host, service);
538 return(JB_INVALID_SOCKET);
541 * XXX: Current connection verification (EINPROGRESS && select()
542 * for writing) is not sufficient. E.g. on Linux-2.6.27 with glibc-2.6
543 * select returns socket ready for writing, however subsequential
544 * write(2) fails with ENOCONNECT. Read Linux connect(2) man page
545 * about non-blocking sockets.
546 * Thus we can't log here that the socket is connected.
548 /* log_error(LOG_LEVEL_INFO, "Connected to TCP/[%s]:%s", host, service); */
554 #else /* ndef HAVE_RFC2553 */
555 /* Pre-getaddrinfo implementation */
557 jb_socket connect_to(const char *host, int portnum, struct client_state *csp)
559 struct sockaddr_in inaddr;
563 struct timeval tv[1];
564 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA)
566 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
569 struct access_control_addr dst[1];
570 #endif /* def FEATURE_ACL */
572 memset((char *)&inaddr, 0, sizeof inaddr);
574 if ((addr = resolve_hostname_to_ip(host)) == INADDR_NONE)
576 csp->http->host_ip_addr_str = strdup("unknown");
577 return(JB_INVALID_SOCKET);
581 dst->addr = ntohl(addr);
584 if (block_acl(dst, csp))
591 return(JB_INVALID_SOCKET);
593 #endif /* def FEATURE_ACL */
595 inaddr.sin_addr.s_addr = addr;
596 inaddr.sin_family = AF_INET;
597 csp->http->host_ip_addr_str = strdup(inet_ntoa(inaddr.sin_addr));
600 if (sizeof(inaddr.sin_port) == sizeof(short))
601 #endif /* ndef _WIN32 */
603 inaddr.sin_port = htons((unsigned short) portnum);
608 inaddr.sin_port = htonl((unsigned long)portnum);
610 #endif /* ndef _WIN32 */
613 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) == JB_INVALID_SOCKET)
615 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) < 0)
618 return(JB_INVALID_SOCKET);
622 { /* turn off TCP coalescence */
624 setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, (char *) &mi, sizeof (int));
626 #endif /* def TCP_NODELAY */
628 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
629 if ((flags = fcntl(fd, F_GETFL, 0)) != -1)
632 fcntl(fd, F_SETFL, flags);
634 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
636 while (connect(fd, (struct sockaddr *) & inaddr, sizeof inaddr) == JB_INVALID_SOCKET)
639 if (errno == WSAEINPROGRESS)
641 if (sock_errno() == EINPROGRESS)
642 #else /* ifndef _WIN32 */
643 if (errno == EINPROGRESS)
644 #endif /* ndef _WIN32 || __OS2__ */
650 if (sock_errno() != EINTR)
656 return(JB_INVALID_SOCKET);
660 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
664 fcntl(fd, F_SETFL, flags);
666 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
668 /* wait for connection to complete */
675 /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Wierd! */
676 if (select((int)fd + 1, NULL, &wfds, NULL, tv) <= 0)
679 return(JB_INVALID_SOCKET);
684 #endif /* ndef HAVE_RFC2553 */
687 /*********************************************************************
689 * Function : write_socket
691 * Description : Write the contents of buf (for n bytes) to socket fd.
694 * 1 : fd = file descriptor (aka. handle) of socket to write to.
695 * 2 : buf = pointer to data to be written.
696 * 3 : len = length of data to be written to the socket "fd".
698 * Returns : 0 on success (entire buffer sent).
701 *********************************************************************/
703 int write_socket(jb_socket fd, const char *buf, ssize_t len)
705 int write_socket(jb_socket fd, const char *buf, size_t len)
713 if (len < 0) /* constant condition - size_t isn't ever negative */
718 log_error(LOG_LEVEL_LOG, "%N", len, buf);
721 return (send(fd, buf, (int)len, 0) != (int)len);
722 #elif defined(__BEOS__) || defined(AMIGA)
723 return (send(fd, buf, len, 0) != len);
724 #elif defined(__OS2__)
726 * Break the data up into SOCKET_SEND_MAX chunks for sending...
727 * OS/2 seemed to complain when the chunks were too large.
729 #define SOCKET_SEND_MAX 65000
731 int write_len = 0, send_len, send_rc = 0, i = 0;
732 while ((i < len) && (send_rc != -1))
734 if ((i + SOCKET_SEND_MAX) > len)
737 send_len = SOCKET_SEND_MAX;
738 send_rc = send(fd,(char*)buf + i, send_len, 0);
746 return (write(fd, buf, len) != len);
752 /*********************************************************************
754 * Function : read_socket
756 * Description : Read from a TCP/IP socket in a platform independent way.
759 * 1 : fd = file descriptor of the socket to read
760 * 2 : buf = pointer to buffer where data will be written
761 * Must be >= len bytes long.
762 * 3 : len = maximum number of bytes to read
764 * Returns : On success, the number of bytes read is returned (zero
765 * indicates end of file), and the file position is advanced
766 * by this number. It is not an error if this number is
767 * smaller than the number of bytes requested; this may hap-
768 * pen for example because fewer bytes are actually available
769 * right now (maybe because we were close to end-of-file, or
770 * because we are reading from a pipe, or from a terminal,
771 * or because read() was interrupted by a signal). On error,
772 * -1 is returned, and errno is set appropriately. In this
773 * case it is left unspecified whether the file position (if
776 *********************************************************************/
777 int read_socket(jb_socket fd, char *buf, int len)
785 return(recv(fd, buf, len, 0));
786 #elif defined(__BEOS__) || defined(AMIGA) || defined(__OS2__)
787 return(recv(fd, buf, (size_t)len, 0));
789 return(read(fd, buf, (size_t)len));
794 /*********************************************************************
796 * Function : data_is_available
798 * Description : Waits for data to arrive on a socket.
801 * 1 : fd = file descriptor of the socket to read
802 * 2 : seconds_to_wait = number of seconds after which we give up.
804 * Returns : TRUE if data arrived in time,
807 *********************************************************************/
808 int data_is_available(jb_socket fd, int seconds_to_wait)
811 struct timeval timeout;
814 memset(&timeout, 0, sizeof(timeout));
815 timeout.tv_sec = seconds_to_wait;
818 /* Copy and pasted from jcc.c ... */
819 memset(&rfds, 0, sizeof(fd_set));
825 n = select(fd+1, &rfds, NULL, NULL, &timeout);
828 * XXX: Do we care about the different error conditions?
834 /*********************************************************************
836 * Function : close_socket
838 * Description : Closes a TCP/IP socket
841 * 1 : fd = file descriptor of socket to be closed
845 *********************************************************************/
846 void close_socket(jb_socket fd)
848 #if defined(_WIN32) || defined(__BEOS__)
852 #elif defined(__OS2__)
861 /*********************************************************************
863 * Function : bind_port
865 * Description : Call socket, set socket options, and listen.
866 * Called by listen_loop to "boot up" our proxy address.
869 * 1 : hostnam = TCP/IP address to bind/listen to
870 * 2 : portnum = port to listen on
871 * 3 : pfd = pointer used to return file descriptor.
873 * Returns : if success, returns 0 and sets *pfd.
874 * if failure, returns -3 if address is in use,
875 * -2 if address unresolvable,
877 *********************************************************************/
878 int bind_port(const char *hostnam, int portnum, jb_socket *pfd)
881 struct addrinfo hints;
882 struct addrinfo *result, *rp;
884 * XXX: portnum should be a string to allow symbolic service
885 * names in the configuration file and to avoid the following
891 struct sockaddr_in inaddr;
892 #endif /* def HAVE_RFC2553 */
896 #endif /* ndef _WIN32 */
898 *pfd = JB_INVALID_SOCKET;
901 retval = snprintf(servnam, sizeof(servnam), "%d", portnum);
902 if ((-1 == retval) || (sizeof(servnam) <= retval))
904 log_error(LOG_LEVEL_ERROR,
905 "Port number (%d) ASCII decimal representation doesn't fit into 6 bytes",
910 memset(&hints, 0, sizeof(struct addrinfo));
911 if ((hostnam == NULL) || !strcmpic(hostnam, "localhost"))
914 * XXX: This is a hack. The right thing to do
915 * would be to bind to both AF_INET and AF_INET6.
916 * This will also fail if there is no AF_INET
919 hints.ai_family = AF_INET;
923 hints.ai_family = AF_UNSPEC;
925 hints.ai_socktype = SOCK_STREAM;
926 hints.ai_flags = AI_PASSIVE | AI_ADDRCONFIG;
927 hints.ai_protocol = 0; /* Realy any stream protocol or TCP only */
928 hints.ai_canonname = NULL;
929 hints.ai_addr = NULL;
930 hints.ai_next = NULL;
932 if ((retval = getaddrinfo(hostnam, servnam, &hints, &result)))
934 log_error(LOG_LEVEL_ERROR,
935 "Can not resolve %s: %s", hostnam, gai_strerror(retval));
939 memset((char *)&inaddr, '\0', sizeof inaddr);
941 inaddr.sin_family = AF_INET;
942 inaddr.sin_addr.s_addr = resolve_hostname_to_ip(hostnam);
944 if (inaddr.sin_addr.s_addr == INADDR_NONE)
950 if (sizeof(inaddr.sin_port) == sizeof(short))
951 #endif /* ndef _WIN32 */
953 inaddr.sin_port = htons((unsigned short) portnum);
958 inaddr.sin_port = htonl((unsigned long) portnum);
960 #endif /* ndef _WIN32 */
961 #endif /* def HAVE_RFC2553 */
964 for (rp = result; rp != NULL; rp = rp->ai_next)
966 fd = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
968 fd = socket(AF_INET, SOCK_STREAM, 0);
969 #endif /* def HAVE_RFC2553 */
972 if (fd == JB_INVALID_SOCKET)
986 * This is not needed for Win32 - in fact, it stops
987 * duplicate instances of Privoxy from being caught.
989 * On UNIX, we assume the user is sensible enough not
990 * to start Privoxy multiple times on the same IP.
991 * Without this, stopping and restarting Privoxy
992 * from a script fails.
993 * Note: SO_REUSEADDR is meant to only take over
994 * sockets which are *not* in listen state in Linux,
995 * e.g. sockets in TIME_WAIT. YMMV.
997 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (char *)&one, sizeof(one));
998 #endif /* ndef _WIN32 */
1001 if (bind(fd, rp->ai_addr, rp->ai_addrlen) < 0)
1003 if (bind(fd, (struct sockaddr *)&inaddr, sizeof(inaddr)) < 0)
1007 errno = WSAGetLastError();
1008 if (errno == WSAEADDRINUSE)
1010 if (errno == EADDRINUSE)
1014 freeaddrinfo(result);
1022 #ifndef HAVE_RFC2553
1031 /* bind() succeeded, escape from for-loop */
1033 * XXX: Support multiple listening sockets (e.g. localhost
1034 * resolves to AF_INET and AF_INET6, but only the first address
1041 freeaddrinfo(result);
1044 /* All bind()s failed */
1047 #endif /* ndef HAVE_RFC2553 */
1049 while (listen(fd, MAX_LISTEN_BACKLOG) == -1)
1063 /*********************************************************************
1065 * Function : get_host_information
1067 * Description : Determines the IP address the client used to
1068 * reach us and the hostname associated with it.
1070 * XXX: Most of the code has been copy and pasted
1071 * from accept_connection() and not all of the
1072 * ifdefs paths have been tested afterwards.
1075 * 1 : afd = File descriptor returned from accept().
1076 * 2 : ip_address = Pointer to return the pointer to
1077 * the ip address string.
1078 * 3 : hostname = Pointer to return the pointer to
1079 * the hostname or NULL if the caller
1080 * isn't interested in it.
1084 *********************************************************************/
1085 void get_host_information(jb_socket afd, char **ip_address, char **hostname)
1088 struct sockaddr_storage server;
1091 struct sockaddr_in server;
1092 struct hostent *host = NULL;
1093 #endif /* HAVE_RFC2553 */
1094 #if defined(_WIN32) || defined(__OS2__) || defined(__APPLE_CC__) || defined(AMIGA)
1095 /* according to accept_connection() this fixes a warning. */
1096 int s_length, s_length_provided;
1098 socklen_t s_length, s_length_provided;
1100 #ifndef HAVE_RFC2553
1101 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS) || defined(HAVE_GETHOSTBYADDR_R_7_ARGS) || defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
1102 struct hostent result;
1103 #if defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
1104 struct hostent_data hdata;
1106 char hbuf[HOSTENT_BUFFER_SIZE];
1108 #endif /* def HAVE_GETHOSTBYADDR_R_5_ARGS */
1109 #endif /* def HAVE_GETHOSTBYADDR_R_(8|7|5)_ARGS */
1110 #endif /* ifndef HAVE_RFC2553 */
1111 s_length = s_length_provided = sizeof(server);
1113 if (NULL != hostname)
1119 if (!getsockname(afd, (struct sockaddr *) &server, &s_length))
1121 if (s_length > s_length_provided)
1123 log_error(LOG_LEVEL_ERROR, "getsockname() truncated server address");
1127 *ip_address = malloc(NI_MAXHOST);
1128 retval = getnameinfo((struct sockaddr *) &server, s_length,
1129 *ip_address, NI_MAXHOST, NULL, 0, NI_NUMERICHOST);
1132 log_error(LOG_LEVEL_ERROR,
1133 "Unable to print my own IP address: %s", gai_strerror(retval));
1138 *ip_address = strdup(inet_ntoa(server.sin_addr));
1139 #endif /* HAVE_RFC2553 */
1140 if (NULL == hostname)
1143 * We're done here, the caller isn't
1144 * interested in knowing the hostname.
1150 *hostname = malloc(NI_MAXHOST);
1151 retval = getnameinfo((struct sockaddr *) &server, s_length,
1152 *hostname, NI_MAXHOST, NULL, 0, NI_NAMEREQD);
1155 log_error(LOG_LEVEL_ERROR,
1156 "Unable to resolve my own IP address: %s", gai_strerror(retval));
1160 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS)
1161 gethostbyaddr_r((const char *)&server.sin_addr,
1162 sizeof(server.sin_addr), AF_INET,
1163 &result, hbuf, HOSTENT_BUFFER_SIZE,
1165 #elif defined(HAVE_GETHOSTBYADDR_R_7_ARGS)
1166 host = gethostbyaddr_r((const char *)&server.sin_addr,
1167 sizeof(server.sin_addr), AF_INET,
1168 &result, hbuf, HOSTENT_BUFFER_SIZE, &thd_err);
1169 #elif defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
1170 if (0 == gethostbyaddr_r((const char *)&server.sin_addr,
1171 sizeof(server.sin_addr), AF_INET,
1180 #elif FEATURE_PTHREAD
1181 privoxy_mutex_lock(&resolver_mutex);
1182 host = gethostbyaddr((const char *)&server.sin_addr,
1183 sizeof(server.sin_addr), AF_INET);
1184 privoxy_mutex_unlock(&resolver_mutex);
1186 host = gethostbyaddr((const char *)&server.sin_addr,
1187 sizeof(server.sin_addr), AF_INET);
1191 log_error(LOG_LEVEL_ERROR, "Unable to get my own hostname: %E\n");
1195 *hostname = strdup(host->h_name);
1197 #endif /* else def HAVE_RFC2553 */
1204 /*********************************************************************
1206 * Function : accept_connection
1208 * Description : Accepts a connection on a socket. Socket must have
1209 * been created using bind_port().
1212 * 1 : csp = Client state, cfd, ip_addr_str, and
1213 * ip_addr_long will be set by this routine.
1214 * 2 : fd = file descriptor returned from bind_port
1216 * Returns : when a connection is accepted, it returns 1 (TRUE).
1217 * On an error it returns 0 (FALSE).
1219 *********************************************************************/
1220 int accept_connection(struct client_state * csp, jb_socket fd)
1223 /* XXX: client is stored directly into csp->tcp_addr */
1224 #define client (csp->tcp_addr)
1227 struct sockaddr_in client;
1230 #if defined(_WIN32) || defined(__OS2__) || defined(__APPLE_CC__) || defined(AMIGA)
1231 /* Wierdness - fix a warning. */
1237 c_length = sizeof(client);
1240 afd = accept (fd, (struct sockaddr *) &client, &c_length);
1241 if (afd == JB_INVALID_SOCKET)
1248 afd = accept (fd, (struct sockaddr *) &client, &c_length);
1249 } while (afd < 1 && errno == EINTR);
1258 csp->ip_addr_str = malloc(NI_MAXHOST);
1259 retval = getnameinfo((struct sockaddr *) &client, c_length,
1260 csp->ip_addr_str, NI_MAXHOST, NULL, 0, NI_NUMERICHOST);
1261 if (!csp->ip_addr_str || retval)
1263 log_error(LOG_LEVEL_ERROR, "Can not save csp->ip_addr_str: %s",
1264 (csp->ip_addr_str) ? gai_strerror(retval) : "Insuffcient memory");
1265 freez(csp->ip_addr_str);
1269 csp->ip_addr_str = strdup(inet_ntoa(client.sin_addr));
1270 csp->ip_addr_long = ntohl(client.sin_addr.s_addr);
1271 #endif /* def HAVE_RFC2553 */
1278 /*********************************************************************
1280 * Function : resolve_hostname_to_ip
1282 * Description : Resolve a hostname to an internet tcp/ip address.
1283 * NULL or an empty string resolve to INADDR_ANY.
1286 * 1 : host = hostname to resolve
1288 * Returns : INADDR_NONE => failure, INADDR_ANY or tcp/ip address if succesful.
1290 *********************************************************************/
1291 unsigned long resolve_hostname_to_ip(const char *host)
1293 struct sockaddr_in inaddr;
1294 struct hostent *hostp;
1295 unsigned int dns_retries = 0;
1296 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS) || defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
1297 struct hostent result;
1298 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
1299 char hbuf[HOSTENT_BUFFER_SIZE];
1301 #else /* defined(HAVE_GETHOSTBYNAME_R_3_ARGS) */
1302 struct hostent_data hdata;
1303 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5)_ARGS */
1304 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
1306 if ((host == NULL) || (*host == '\0'))
1311 memset((char *) &inaddr, 0, sizeof inaddr);
1313 if ((inaddr.sin_addr.s_addr = inet_addr(host)) == -1)
1315 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS)
1316 while (gethostbyname_r(host, &result, hbuf,
1317 HOSTENT_BUFFER_SIZE, &hostp, &thd_err)
1318 && (thd_err == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
1320 log_error(LOG_LEVEL_ERROR,
1321 "Timeout #%u while trying to resolve %s. Trying again.",
1324 #elif defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
1325 while (NULL == (hostp = gethostbyname_r(host, &result,
1326 hbuf, HOSTENT_BUFFER_SIZE, &thd_err))
1327 && (thd_err == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
1329 log_error(LOG_LEVEL_ERROR,
1330 "Timeout #%u while trying to resolve %s. Trying again.",
1333 #elif defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
1335 * XXX: Doesn't retry in case of soft errors.
1336 * Does this gethostbyname_r version set h_errno?
1338 if (0 == gethostbyname_r(host, &result, &hdata))
1346 #elif FEATURE_PTHREAD
1347 privoxy_mutex_lock(&resolver_mutex);
1348 while (NULL == (hostp = gethostbyname(host))
1349 && (h_errno == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
1351 log_error(LOG_LEVEL_ERROR,
1352 "Timeout #%u while trying to resolve %s. Trying again.",
1355 privoxy_mutex_unlock(&resolver_mutex);
1357 while (NULL == (hostp = gethostbyname(host))
1358 && (h_errno == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
1360 log_error(LOG_LEVEL_ERROR,
1361 "Timeout #%u while trying to resolve %s. Trying again.",
1364 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
1366 * On Mac OSX, if a domain exists but doesn't have a type A
1367 * record associated with it, the h_addr member of the struct
1368 * hostent returned by gethostbyname is NULL, even if h_length
1369 * is 4. Therefore the second test below.
1371 if (hostp == NULL || hostp->h_addr == NULL)
1374 log_error(LOG_LEVEL_ERROR, "could not resolve hostname %s", host);
1375 return(INADDR_NONE);
1377 if (hostp->h_addrtype != AF_INET)
1380 errno = WSAEPROTOTYPE;
1384 log_error(LOG_LEVEL_ERROR, "hostname %s resolves to unknown address type.", host);
1385 return(INADDR_NONE);
1388 (char *) &inaddr.sin_addr,
1389 (char *) hostp->h_addr,
1390 sizeof(inaddr.sin_addr)
1393 return(inaddr.sin_addr.s_addr);
1398 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1399 /*********************************************************************
1401 * Function : socket_is_still_usable
1403 * Description : Decides whether or not an open socket is still usable.
1406 * 1 : sfd = The socket to check.
1408 * Returns : TRUE for yes, otherwise FALSE.
1410 *********************************************************************/
1411 int socket_is_still_usable(jb_socket sfd)
1415 struct pollfd poll_fd[1];
1417 memset(poll_fd, 0, sizeof(poll_fd));
1418 poll_fd[0].fd = sfd;
1419 poll_fd[0].events = POLLIN;
1421 poll_result = poll(poll_fd, 1, 0);
1423 if (-1 != poll_result)
1425 return !(poll_fd[0].revents & POLLIN);
1429 log_error(LOG_LEVEL_CONNECT, "Polling socket %d failed.", sfd);
1433 fd_set readable_fds;
1434 struct timeval timeout;
1436 int socket_is_alive = 0;
1438 memset(&timeout, '\0', sizeof(timeout));
1439 FD_ZERO(&readable_fds);
1440 FD_SET(sfd, &readable_fds);
1442 ret = select((int)sfd+1, &readable_fds, NULL, NULL, &timeout);
1445 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
1449 * XXX: I'm not sure why !FD_ISSET() works,
1450 * but apparently it does.
1452 socket_is_alive = !FD_ISSET(sfd, &readable_fds);
1454 return socket_is_alive;
1455 #endif /* def HAVE_POLL */
1457 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */