1 const char jbsockets_rcs[] = "$Id: jbsockets.c,v 1.51 2009/04/17 11:27:49 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-2007 the SourceForge
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.51 2009/04/17 11:27:49 fabiankeil
39 * Petr Pisar's privoxy-3.0.12-ipv6-3.diff.
41 * Revision 1.50 2008/12/20 14:53:55 fabiankeil
42 * Add config option socket-timeout to control the time
43 * Privoxy waits for data to arrive on a socket. Useful
44 * in case of stale ssh tunnels or when fuzz-testing.
46 * Revision 1.49 2008/11/10 17:03:57 fabiankeil
47 * Fix a gcc44 warning and remove a now-obsolete cast.
49 * Revision 1.48 2008/09/04 08:13:58 fabiankeil
50 * Prepare for critical sections on Windows by adding a
51 * layer of indirection before the pthread mutex functions.
53 * Revision 1.47 2008/03/26 18:07:07 fabiankeil
54 * Add hostname directive. Closes PR#1918189.
56 * Revision 1.46 2008/03/21 11:13:57 fabiankeil
57 * Only gather host information if it's actually needed.
58 * Also move the code out of accept_connection() so it's less likely
59 * to delay other incoming connections if the host is misconfigured.
61 * Revision 1.45 2007/09/30 16:59:22 fabiankeil
62 * Set the maximum listen() backlog to 128. Apparently SOMAXCONN is
63 * neither high enough, nor a hard limit on mingw32. Again for BR#1795281.
65 * Revision 1.44 2007/09/15 13:01:31 fabiankeil
66 * Increase listen() backlog to SOMAXCONN (or 128) to decrease
67 * chances of dropped connections under load. Problem reported
68 * and fix suggested by nobody in BR#1795281.
70 * Revision 1.43 2007/06/01 18:16:36 fabiankeil
71 * Use the same mutex for gethostbyname() and gethostbyaddr() to prevent
72 * deadlocks and crashes on OpenBSD and possibly other OS with neither
73 * gethostbyname_r() nor gethostaddr_r(). Closes BR#1729174.
74 * Thanks to Ralf Horstmann for report and solution.
76 * Revision 1.42 2007/04/01 17:37:07 fabiankeil
77 * - Add DNS retries for Solaris and other systems
78 * whose gethostbyname_r version takes five arguments.
79 * - Move maximum number of DNS retries into a macro.
81 * Revision 1.41 2006/11/13 19:05:51 fabiankeil
82 * Make pthread mutex locking more generic. Instead of
83 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
84 * and use mutex locking unless there is an _r function
85 * available. Better safe than sorry.
87 * Fixes "./configure --disable-pthread" and should result
88 * in less threading-related problems on pthread-using platforms,
89 * but it still doesn't fix BR#1122404.
91 * Revision 1.40 2006/09/02 15:36:42 fabiankeil
92 * Follow the OpenBSD port's lead and protect the resolve
93 * functions on OpenBSD as well.
95 * Revision 1.39 2006/08/03 02:46:41 david__schmidt
96 * Incorporate Fabian Keil's patch work:
\rhttp://www.fabiankeil.de/sourcecode/privoxy/
98 * Revision 1.38 2006/07/18 14:48:46 david__schmidt
99 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
100 * with what was really the latest development (the v_3_0_branch branch)
102 * Revision 1.35.2.8 2006/01/21 16:16:08 david__schmidt
103 * Thanks to Edward Carrel for his patch to modernize OSX's
\rpthreads support. See bug #1409623.
105 * Revision 1.35.2.7 2005/05/07 21:50:55 david__schmidt
106 * A few memory leaks plugged (mostly on error paths)
108 * Revision 1.35.2.6 2003/12/17 16:34:40 oes
111 * Revision 1.35.2.5 2003/04/29 11:32:54 oes
112 * Don't rely on h_addr being non-NULL after gethostbyname.
113 * Works around an oddness in Max OSX and closes bug #724796
115 * Revision 1.35.2.4 2003/04/04 12:40:20 oes
116 * Made sure the errno set by bind, not close[socket] is used in
117 * bind_port. Probably fixes bugs #713777, #705562.
119 * Revision 1.35.2.3 2003/03/07 03:41:04 david__schmidt
120 * 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.
122 * Revision 1.35.2.2 2002/11/20 14:37:24 oes
123 * Fixed Win32 error logging in bind_port.
124 * Thanks to Oliver Stoeneberg for the hint.
126 * Revision 1.35.2.1 2002/05/26 23:41:27 joergs
127 * AmigaOS: Fixed wrong type of len in write_socket()
129 * Revision 1.35 2002/04/26 15:50:04 joergs
130 * AmigaOS: No socklen_t, added AMIGA to the systems using int instead.
132 * Revision 1.34 2002/04/08 20:31:41 swa
135 * Revision 1.33 2002/04/03 16:02:18 gliptak
136 * Correcting compile warning with older gcc
138 * Revision 1.32 2002/03/31 17:18:59 jongfoster
139 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
141 * Revision 1.31 2002/03/29 03:33:13 david__schmidt
142 * Fix Mac OSX compiler warnings
144 * Revision 1.30 2002/03/27 14:32:43 david__schmidt
145 * More compiler warning message maintenance
147 * Revision 1.29 2002/03/26 22:29:54 swa
148 * we have a new homepage!
150 * Revision 1.28 2002/03/24 13:25:43 swa
151 * name change related issues
153 * Revision 1.27 2002/03/13 00:27:05 jongfoster
156 * Revision 1.26 2002/03/11 22:07:02 david__schmidt
157 * OS/2 port maintenance:
158 * - Fixed EMX build - it had decayed a little
159 * - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
160 * substituted a memset for now.
162 * Revision 1.25 2002/03/09 20:03:52 jongfoster
163 * - Making various functions return int rather than size_t.
164 * (Undoing a recent change). Since size_t is unsigned on
165 * Windows, functions like read_socket that return -1 on
166 * error cannot return a size_t.
168 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
169 * crashes, and also frequently caused JB to jump to 100%
170 * CPU and stay there. (Because it thought it had just
171 * read ((unsigned)-1) == 4Gb of data...)
173 * - The signature of write_socket has changed, it now simply
174 * returns success=0/failure=nonzero.
176 * - Trying to get rid of a few warnings --with-debug on
177 * Windows, I've introduced a new type "jb_socket". This is
178 * used for the socket file descriptors. On Windows, this
179 * is SOCKET (a typedef for unsigned). Everywhere else, it's
180 * an int. The error value can't be -1 any more, so it's
181 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
182 * Windows it maps to the #define INVALID_SOCKET.)
184 * - The signature of bind_port has changed.
186 * Revision 1.24 2002/03/07 03:51:36 oes
187 * - Improved handling of failed DNS lookups
188 * - Fixed compiler warnings etc
190 * Revision 1.23 2002/03/05 00:36:01 jongfoster
191 * Fixing bug 514988 - unable to restart Junkbuster
193 * Revision 1.22 2002/03/04 02:08:02 david__schmidt
194 * Enable web editing of actions file on OS/2 (it had been broken all this time!)
196 * Revision 1.21 2002/01/09 14:32:33 oes
197 * Added support for gethostbyname_r and gethostbyaddr_r.
199 * Revision 1.20 2001/11/16 00:48:48 jongfoster
200 * Enabling duplicate-socket detection for all platforms, not
203 * Revision 1.19 2001/10/25 03:40:47 david__schmidt
204 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
205 * threads to call select() simultaneously. So, it's time to do a real, live,
206 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
207 * (native). Both versions will work, but using __OS2__ offers multi-threading.
209 * Revision 1.18 2001/09/21 23:02:02 david__schmidt
210 * Cleaning up 2 compiler warnings on OS/2.
212 * Revision 1.17 2001/09/13 20:11:46 jongfoster
213 * Fixing 2 compiler warnings under Win32
215 * Revision 1.16 2001/07/30 22:08:36 jongfoster
216 * Tidying up #defines:
217 * - All feature #defines are now of the form FEATURE_xxx
218 * - Permanently turned off WIN_GUI_EDIT
219 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
221 * Revision 1.15 2001/07/29 17:40:43 jongfoster
222 * Fixed compiler warning by adding a cast
224 * Revision 1.14 2001/07/18 13:47:59 oes
225 * Eliminated dirty hack for getsockbyname()
227 * Revision 1.13 2001/07/15 13:56:57 jongfoster
228 * Removing unused local variable.
230 * Revision 1.12 2001/07/01 17:04:11 oes
231 * Bugfix: accept_connection no longer uses the obsolete hstrerror() function
233 * Revision 1.11 2001/06/29 21:45:41 oes
234 * Indentation, CRLF->LF, Tab-> Space
236 * Revision 1.10 2001/06/29 13:29:15 oes
237 * - Added remote (server) host IP to csp->http->host_ip_addr_str
238 * - Added detection of local socket IP and fqdn
239 * - Removed logentry from cancelled commit
241 * Revision 1.9 2001/06/07 23:06:09 jongfoster
242 * The host parameter to connect_to() is now const.
244 * Revision 1.8 2001/06/03 19:12:07 oes
247 * Revision 1.7 2001/05/28 16:14:00 jongfoster
248 * Fixing bug in LOG_LEVEL_LOG
250 * Revision 1.6 2001/05/26 17:28:32 jongfoster
251 * Fixed LOG_LEVEL_LOG
253 * Revision 1.5 2001/05/26 15:26:15 jongfoster
254 * ACL feature now provides more security by immediately dropping
255 * connections from untrusted hosts.
257 * Revision 1.4 2001/05/26 00:37:42 jongfoster
258 * Cosmetic indentation correction.
260 * Revision 1.3 2001/05/25 21:57:54 jongfoster
261 * Now gives a warning under Windows if you try to bind
262 * it to a port that's already in use.
264 * Revision 1.2 2001/05/17 23:01:01 oes
265 * - Cleaned CRLF's from the sources and related files
267 * Revision 1.1.1.1 2001/05/15 13:58:54 oes
268 * Initial import of version 2.9.3 source tree
271 *********************************************************************/
281 #include <sys/types.h>
289 #include <sys/timeb.h>
297 #include <sys/time.h>
298 #include <netinet/in.h>
299 #include <sys/ioctl.h>
301 #include <sys/socket.h>
304 #include <netinet/tcp.h>
306 #include <arpa/inet.h>
312 #if defined(__EMX__) || defined (__OS2__)
313 #include <sys/select.h> /* OS/2/EMX needs a little help with select */
323 #ifdef FEATURE_PTHREAD
325 /* jcc.h is for mutex semaphores only */
326 #endif /* def FEATURE_PTHREAD */
328 #include "jbsockets.h"
332 const char jbsockets_h_rcs[] = JBSOCKETS_H_VERSION;
335 * Maximum number of gethostbyname(_r) retries in case of
336 * soft errors (TRY_AGAIN).
337 * XXX: Does it make sense to make this a config option?
339 #define MAX_DNS_RETRIES 10
341 #define MAX_LISTEN_BACKLOG 128
344 /*********************************************************************
346 * Function : connect_to
348 * Description : Open a socket and connect to it. Will check
349 * that this is allowed according to ACL.
352 * 1 : host = hostname to connect to
353 * 2 : portnum = port to connent on (XXX: should be unsigned)
354 * 3 : csp = Current client state (buffers, headers, etc...)
355 * Not modified, only used for source IP and ACL.
357 * Returns : JB_INVALID_SOCKET => failure, else it is the socket
360 *********************************************************************/
361 #ifdef HAVE_GETADDRINFO
362 /* Getaddrinfo implementation */
363 jb_socket connect_to(const char *host, int portnum, struct client_state *csp)
365 struct addrinfo hints, *result, *rp;
370 struct timeval tv[1];
371 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA)
373 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
377 struct access_control_addr dst[1];
378 #endif /* def FEATURE_ACL */
380 retval = snprintf(service, sizeof(service), "%d", portnum);
381 if ((-1 == retval) || (sizeof(service) <= retval))
383 log_error(LOG_LEVEL_ERROR,
384 "Port number (%d) ASCII decimal representation doesn't fit into 6 bytes",
386 csp->http->host_ip_addr_str = strdup("unknown");
387 return(JB_INVALID_SOCKET);
390 memset((char *)&hints, 0, sizeof(hints));
391 hints.ai_family = AF_UNSPEC;
392 hints.ai_socktype = SOCK_STREAM;
393 hints.ai_flags = AI_ADDRCONFIG | AI_NUMERICSERV; /* avoid service look-up */
394 if ((retval = getaddrinfo(host, service, &hints, &result)))
396 log_error(LOG_LEVEL_INFO,
397 "Can not resolve %s: %s", host, gai_strerror(retval));
398 csp->http->host_ip_addr_str = strdup("unknown");
399 return(JB_INVALID_SOCKET);
402 for (rp = result; rp != NULL; rp = rp->ai_next)
406 memcpy(&dst->addr, rp->ai_addr, rp->ai_addrlen);
408 if (block_acl(dst, csp))
417 #endif /* def FEATURE_ACL */
419 csp->http->host_ip_addr_str = malloc(NI_MAXHOST);
420 retval = getnameinfo(rp->ai_addr, rp->ai_addrlen,
421 csp->http->host_ip_addr_str, NI_MAXHOST, NULL, 0, NI_NUMERICHOST);
422 if (!csp->http->host_ip_addr_str || retval)
424 log_error(LOG_LEVEL_ERROR,
425 "Can not save csp->http->host_ip_addr_str: %s",
426 (csp->http->host_ip_addr_str) ?
427 gai_strerror(retval) : "Insufficient memory");
428 freez(csp->http->host_ip_addr_str);
433 if ((fd = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol)) ==
436 if ((fd = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol)) < 0)
443 { /* turn off TCP coalescence */
445 setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, (char *) &mi, sizeof (int));
447 #endif /* def TCP_NODELAY */
449 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
450 if ((flags = fcntl(fd, F_GETFL, 0)) != -1)
453 fcntl(fd, F_SETFL, flags);
455 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
458 while (connect(fd, rp->ai_addr, rp->ai_addrlen) == JB_INVALID_SOCKET)
461 if (errno == WSAEINPROGRESS)
463 if (sock_errno() == EINPROGRESS)
464 #else /* ifndef _WIN32 */
465 if (errno == EINPROGRESS)
466 #endif /* ndef _WIN32 || __OS2__ */
472 if (sock_errno() != EINTR)
487 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
491 fcntl(fd, F_SETFL, flags);
493 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
495 /* wait for connection to complete */
502 /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Wierd! */
503 if (select((int)fd + 1, NULL, &wfds, NULL, tv) <= 0)
509 break; /* for; Connection established; don't try other addresses */
512 freeaddrinfo(result);
515 log_error(LOG_LEVEL_INFO,
516 "Could not connect to TCP/[%s]:%s", host, service);
517 return(JB_INVALID_SOCKET);
520 * XXX: Current connection verification (EINPROGRESS && select()
521 * for writing) is not sufficient. E.g. on Linux-2.6.27 with glibc-2.6
522 * select returns socket ready for writing, however subsequential
523 * write(2) fails with ENOCONNECT. Read Linux connect(2) man page
524 * about non-blocking sockets.
525 * Thus we can't log here that the socket is connected.
527 /* log_error(LOG_LEVEL_INFO, "Connected to TCP/[%s]:%s", host, service); */
533 # else /* ndef HAVE_GETADDRINFO */
534 /* Pre-getaddrinfo implementation */
536 jb_socket connect_to(const char *host, int portnum, struct client_state *csp)
538 struct sockaddr_in inaddr;
542 struct timeval tv[1];
543 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA)
545 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
548 struct access_control_addr dst[1];
549 #endif /* def FEATURE_ACL */
551 memset((char *)&inaddr, 0, sizeof inaddr);
553 if ((addr = resolve_hostname_to_ip(host)) == INADDR_NONE)
555 csp->http->host_ip_addr_str = strdup("unknown");
556 return(JB_INVALID_SOCKET);
560 dst->addr = ntohl(addr);
563 if (block_acl(dst, csp))
570 return(JB_INVALID_SOCKET);
572 #endif /* def FEATURE_ACL */
574 inaddr.sin_addr.s_addr = addr;
575 inaddr.sin_family = AF_INET;
576 csp->http->host_ip_addr_str = strdup(inet_ntoa(inaddr.sin_addr));
579 if (sizeof(inaddr.sin_port) == sizeof(short))
580 #endif /* ndef _WIN32 */
582 inaddr.sin_port = htons((unsigned short) portnum);
587 inaddr.sin_port = htonl((unsigned long)portnum);
589 #endif /* ndef _WIN32 */
592 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) == JB_INVALID_SOCKET)
594 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) < 0)
597 return(JB_INVALID_SOCKET);
601 { /* turn off TCP coalescence */
603 setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, (char *) &mi, sizeof (int));
605 #endif /* def TCP_NODELAY */
607 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
608 if ((flags = fcntl(fd, F_GETFL, 0)) != -1)
611 fcntl(fd, F_SETFL, flags);
613 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
615 while (connect(fd, (struct sockaddr *) & inaddr, sizeof inaddr) == JB_INVALID_SOCKET)
618 if (errno == WSAEINPROGRESS)
620 if (sock_errno() == EINPROGRESS)
621 #else /* ifndef _WIN32 */
622 if (errno == EINPROGRESS)
623 #endif /* ndef _WIN32 || __OS2__ */
629 if (sock_errno() != EINTR)
635 return(JB_INVALID_SOCKET);
639 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
643 fcntl(fd, F_SETFL, flags);
645 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
647 /* wait for connection to complete */
654 /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Wierd! */
655 if (select((int)fd + 1, NULL, &wfds, NULL, tv) <= 0)
658 return(JB_INVALID_SOCKET);
663 #endif /* ndef HAVE_GETADDRINFO */
666 /*********************************************************************
668 * Function : write_socket
670 * Description : Write the contents of buf (for n bytes) to socket fd.
673 * 1 : fd = file descriptor (aka. handle) of socket to write to.
674 * 2 : buf = pointer to data to be written.
675 * 3 : len = length of data to be written to the socket "fd".
677 * Returns : 0 on success (entire buffer sent).
680 *********************************************************************/
682 int write_socket(jb_socket fd, const char *buf, ssize_t len)
684 int write_socket(jb_socket fd, const char *buf, size_t len)
692 if (len < 0) /* constant condition - size_t isn't ever negative */
697 log_error(LOG_LEVEL_LOG, "%N", len, buf);
700 return (send(fd, buf, (int)len, 0) != (int)len);
701 #elif defined(__BEOS__) || defined(AMIGA)
702 return (send(fd, buf, len, 0) != len);
703 #elif defined(__OS2__)
705 * Break the data up into SOCKET_SEND_MAX chunks for sending...
706 * OS/2 seemed to complain when the chunks were too large.
708 #define SOCKET_SEND_MAX 65000
710 int write_len = 0, send_len, send_rc = 0, i = 0;
711 while ((i < len) && (send_rc != -1))
713 if ((i + SOCKET_SEND_MAX) > len)
716 send_len = SOCKET_SEND_MAX;
717 send_rc = send(fd,(char*)buf + i, send_len, 0);
725 return (write(fd, buf, len) != len);
731 /*********************************************************************
733 * Function : read_socket
735 * Description : Read from a TCP/IP socket in a platform independent way.
738 * 1 : fd = file descriptor of the socket to read
739 * 2 : buf = pointer to buffer where data will be written
740 * Must be >= len bytes long.
741 * 3 : len = maximum number of bytes to read
743 * Returns : On success, the number of bytes read is returned (zero
744 * indicates end of file), and the file position is advanced
745 * by this number. It is not an error if this number is
746 * smaller than the number of bytes requested; this may hap-
747 * pen for example because fewer bytes are actually available
748 * right now (maybe because we were close to end-of-file, or
749 * because we are reading from a pipe, or from a terminal,
750 * or because read() was interrupted by a signal). On error,
751 * -1 is returned, and errno is set appropriately. In this
752 * case it is left unspecified whether the file position (if
755 *********************************************************************/
756 int read_socket(jb_socket fd, char *buf, int len)
764 return(recv(fd, buf, len, 0));
765 #elif defined(__BEOS__) || defined(AMIGA) || defined(__OS2__)
766 return(recv(fd, buf, (size_t)len, 0));
768 return(read(fd, buf, (size_t)len));
773 /*********************************************************************
775 * Function : data_is_available
777 * Description : Waits for data to arrive on a socket.
780 * 1 : fd = file descriptor of the socket to read
781 * 2 : seconds_to_wait = number of seconds after which we give up.
783 * Returns : TRUE if data arrived in time,
786 *********************************************************************/
787 int data_is_available(jb_socket fd, int seconds_to_wait)
790 struct timeval timeout;
793 memset(&timeout, 0, sizeof(timeout));
794 timeout.tv_sec = seconds_to_wait;
797 /* Copy and pasted from jcc.c ... */
798 memset(&rfds, 0, sizeof(fd_set));
804 n = select(fd+1, &rfds, NULL, NULL, &timeout);
807 * XXX: Do we care about the different error conditions?
813 /*********************************************************************
815 * Function : close_socket
817 * Description : Closes a TCP/IP socket
820 * 1 : fd = file descriptor of socket to be closed
824 *********************************************************************/
825 void close_socket(jb_socket fd)
827 #if defined(_WIN32) || defined(__BEOS__)
831 #elif defined(__OS2__)
840 /*********************************************************************
842 * Function : bind_port
844 * Description : Call socket, set socket options, and listen.
845 * Called by listen_loop to "boot up" our proxy address.
848 * 1 : hostnam = TCP/IP address to bind/listen to
849 * 2 : portnum = port to listen on
850 * 3 : pfd = pointer used to return file descriptor.
852 * Returns : if success, returns 0 and sets *pfd.
853 * if failure, returns -3 if address is in use,
854 * -2 if address unresolvable,
856 *********************************************************************/
857 int bind_port(const char *hostnam, int portnum, jb_socket *pfd)
859 #ifdef HAVE_GETADDRINFO
860 struct addrinfo hints;
861 struct addrinfo *result, *rp;
863 * XXX: portnum should be a string to allow symbolic service
864 * names in the configuration file and to avoid the following
870 struct sockaddr_in inaddr;
871 #endif /* def HAVE_GETADDRINFO */
875 #endif /* ndef _WIN32 */
877 *pfd = JB_INVALID_SOCKET;
879 #ifdef HAVE_GETADDRINFO
880 retval = snprintf(servnam, sizeof(servnam), "%d", portnum);
881 if ((-1 == retval) || (sizeof(servnam) <= retval))
883 log_error(LOG_LEVEL_ERROR,
884 "Port number (%d) ASCII decimal representation doesn't fit into 6 bytes",
889 memset(&hints, 0, sizeof(struct addrinfo));
890 hints.ai_family = AF_UNSPEC;
891 hints.ai_socktype = SOCK_STREAM;
892 hints.ai_flags = AI_PASSIVE | AI_ADDRCONFIG;
893 hints.ai_protocol = 0; /* Realy any stream protocol or TCP only */
894 hints.ai_canonname = NULL;
895 hints.ai_addr = NULL;
896 hints.ai_next = NULL;
898 if ((retval = getaddrinfo(hostnam, servnam, &hints, &result)))
900 log_error(LOG_LEVEL_ERROR,
901 "Can not resolve %s: %s", hostnam, gai_strerror(retval));
905 memset((char *)&inaddr, '\0', sizeof inaddr);
907 inaddr.sin_family = AF_INET;
908 inaddr.sin_addr.s_addr = resolve_hostname_to_ip(hostnam);
910 if (inaddr.sin_addr.s_addr == INADDR_NONE)
916 if (sizeof(inaddr.sin_port) == sizeof(short))
917 #endif /* ndef _WIN32 */
919 inaddr.sin_port = htons((unsigned short) portnum);
924 inaddr.sin_port = htonl((unsigned long) portnum);
926 #endif /* ndef _WIN32 */
927 #endif /* def HAVE_GETADDRINFO */
929 #ifdef HAVE_GETADDRINFO
930 for (rp = result; rp != NULL; rp = rp->ai_next)
932 fd = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
934 fd = socket(AF_INET, SOCK_STREAM, 0);
935 #endif /* def HAVE_GETADDRINFO */
938 if (fd == JB_INVALID_SOCKET)
943 #ifdef HAVE_GETADDRINFO
952 * This is not needed for Win32 - in fact, it stops
953 * duplicate instances of Privoxy from being caught.
955 * On UNIX, we assume the user is sensible enough not
956 * to start Privoxy multiple times on the same IP.
957 * Without this, stopping and restarting Privoxy
958 * from a script fails.
959 * Note: SO_REUSEADDR is meant to only take over
960 * sockets which are *not* in listen state in Linux,
961 * e.g. sockets in TIME_WAIT. YMMV.
963 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (char *)&one, sizeof(one));
964 #endif /* ndef _WIN32 */
966 #ifdef HAVE_GETADDRINFO
967 if (bind(fd, rp->ai_addr, rp->ai_addrlen) < 0)
969 if (bind(fd, (struct sockaddr *)&inaddr, sizeof(inaddr)) < 0)
973 errno = WSAGetLastError();
974 if (errno == WSAEADDRINUSE)
976 if (errno == EADDRINUSE)
979 #ifdef HAVE_GETADDRINFO
980 freeaddrinfo(result);
988 #ifndef HAVE_GETADDRINFO
997 /* bind() succeeded, escape from for-loop */
999 * XXX: Support multiple listening sockets (e.g. localhost
1000 * resolves to AF_INET and AF_INET6, but only the first address
1007 freeaddrinfo(result);
1010 /* All bind()s failed */
1013 #endif /* ndef HAVE_GETADDRINFO */
1015 while (listen(fd, MAX_LISTEN_BACKLOG) == -1)
1029 /*********************************************************************
1031 * Function : get_host_information
1033 * Description : Determines the IP address the client used to
1034 * reach us and the hostname associated with it.
1036 * XXX: Most of the code has been copy and pasted
1037 * from accept_connection() and not all of the
1038 * ifdefs paths have been tested afterwards.
1041 * 1 : afd = File descriptor returned from accept().
1042 * 2 : ip_address = Pointer to return the pointer to
1043 * the ip address string.
1044 * 3 : hostname = Pointer to return the pointer to
1045 * the hostname or NULL if the caller
1046 * isn't interested in it.
1050 *********************************************************************/
1051 void get_host_information(jb_socket afd, char **ip_address, char **hostname)
1053 #ifdef HAVE_GETNAMEINFO
1054 struct sockaddr_storage server;
1057 struct sockaddr_in server;
1058 struct hostent *host = NULL;
1059 #endif /* HAVE_GETNAMEINFO */
1060 #if defined(_WIN32) || defined(__OS2__) || defined(__APPLE_CC__) || defined(AMIGA)
1061 /* according to accept_connection() this fixes a warning. */
1062 int s_length, s_length_provided;
1064 socklen_t s_length, s_length_provided;
1066 #ifndef HAVE_GETNAMEINFO
1067 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS) || defined(HAVE_GETHOSTBYADDR_R_7_ARGS) || defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
1068 struct hostent result;
1069 #if defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
1070 struct hostent_data hdata;
1072 char hbuf[HOSTENT_BUFFER_SIZE];
1074 #endif /* def HAVE_GETHOSTBYADDR_R_5_ARGS */
1075 #endif /* def HAVE_GETHOSTBYADDR_R_(8|7|5)_ARGS */
1076 #endif /* ifndef HAVE_GETNAMEINFO */
1077 s_length = s_length_provided = sizeof(server);
1079 if (NULL != hostname)
1085 if (!getsockname(afd, (struct sockaddr *) &server, &s_length))
1087 if (s_length > s_length_provided)
1089 log_error(LOG_LEVEL_ERROR, "getsockname() truncated server address");
1092 #ifdef HAVE_GETNAMEINFO
1093 *ip_address = malloc(NI_MAXHOST);
1094 retval = getnameinfo((struct sockaddr *) &server, s_length,
1095 *ip_address, NI_MAXHOST, NULL, 0, NI_NUMERICHOST);
1098 log_error(LOG_LEVEL_ERROR,
1099 "Unable to print my own IP address: %s", gai_strerror(retval));
1104 *ip_address = strdup(inet_ntoa(server.sin_addr));
1105 #endif /* HAVE_GETNAMEINFO */
1106 if (NULL == hostname)
1109 * We're done here, the caller isn't
1110 * interested in knowing the hostname.
1115 #ifdef HAVE_GETNAMEINFO
1116 *hostname = malloc(NI_MAXHOST);
1117 retval = getnameinfo((struct sockaddr *) &server, s_length,
1118 *hostname, NI_MAXHOST, NULL, 0, NI_NAMEREQD);
1121 log_error(LOG_LEVEL_ERROR,
1122 "Unable to resolve my own IP address: %s", gai_strerror(retval));
1126 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS)
1127 gethostbyaddr_r((const char *)&server.sin_addr,
1128 sizeof(server.sin_addr), AF_INET,
1129 &result, hbuf, HOSTENT_BUFFER_SIZE,
1131 #elif defined(HAVE_GETHOSTBYADDR_R_7_ARGS)
1132 host = gethostbyaddr_r((const char *)&server.sin_addr,
1133 sizeof(server.sin_addr), AF_INET,
1134 &result, hbuf, HOSTENT_BUFFER_SIZE, &thd_err);
1135 #elif defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
1136 if (0 == gethostbyaddr_r((const char *)&server.sin_addr,
1137 sizeof(server.sin_addr), AF_INET,
1146 #elif FEATURE_PTHREAD
1147 privoxy_mutex_lock(&resolver_mutex);
1148 host = gethostbyaddr((const char *)&server.sin_addr,
1149 sizeof(server.sin_addr), AF_INET);
1150 privoxy_mutex_unlock(&resolver_mutex);
1152 host = gethostbyaddr((const char *)&server.sin_addr,
1153 sizeof(server.sin_addr), AF_INET);
1157 log_error(LOG_LEVEL_ERROR, "Unable to get my own hostname: %E\n");
1161 *hostname = strdup(host->h_name);
1163 #endif /* else def HAVE_GETNAMEINFO */
1170 /*********************************************************************
1172 * Function : accept_connection
1174 * Description : Accepts a connection on a socket. Socket must have
1175 * been created using bind_port().
1178 * 1 : csp = Client state, cfd, ip_addr_str, and
1179 * ip_addr_long will be set by this routine.
1180 * 2 : fd = file descriptor returned from bind_port
1182 * Returns : when a connection is accepted, it returns 1 (TRUE).
1183 * On an error it returns 0 (FALSE).
1185 *********************************************************************/
1186 int accept_connection(struct client_state * csp, jb_socket fd)
1188 #ifdef HAVE_GETNAMEINFO
1189 /* XXX: client is stored directly into csp->tcp_addr */
1190 #define client (csp->tcp_addr)
1193 struct sockaddr_in client;
1196 #if defined(_WIN32) || defined(__OS2__) || defined(__APPLE_CC__) || defined(AMIGA)
1197 /* Wierdness - fix a warning. */
1203 c_length = sizeof(client);
1206 afd = accept (fd, (struct sockaddr *) &client, &c_length);
1207 if (afd == JB_INVALID_SOCKET)
1214 afd = accept (fd, (struct sockaddr *) &client, &c_length);
1215 } while (afd < 1 && errno == EINTR);
1223 #ifdef HAVE_GETNAMEINFO
1224 csp->ip_addr_str = malloc(NI_MAXHOST);
1225 retval = getnameinfo((struct sockaddr *) &client, c_length,
1226 csp->ip_addr_str, NI_MAXHOST, NULL, 0, NI_NUMERICHOST);
1227 if (!csp->ip_addr_str || retval)
1229 log_error(LOG_LEVEL_ERROR, "Can not save csp->ip_addr_str: %s",
1230 (csp->ip_addr_str) ? gai_strerror(retval) : "Insuffcient memory");
1231 freez(csp->ip_addr_str);
1235 csp->ip_addr_str = strdup(inet_ntoa(client.sin_addr));
1236 csp->ip_addr_long = ntohl(client.sin_addr.s_addr);
1237 #endif /* def HAVE_GETNAMEINFO */
1244 /*********************************************************************
1246 * Function : resolve_hostname_to_ip
1248 * Description : Resolve a hostname to an internet tcp/ip address.
1249 * NULL or an empty string resolve to INADDR_ANY.
1252 * 1 : host = hostname to resolve
1254 * Returns : INADDR_NONE => failure, INADDR_ANY or tcp/ip address if succesful.
1256 *********************************************************************/
1257 unsigned long resolve_hostname_to_ip(const char *host)
1259 struct sockaddr_in inaddr;
1260 struct hostent *hostp;
1261 unsigned int dns_retries = 0;
1262 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS) || defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
1263 struct hostent result;
1264 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
1265 char hbuf[HOSTENT_BUFFER_SIZE];
1267 #else /* defined(HAVE_GETHOSTBYNAME_R_3_ARGS) */
1268 struct hostent_data hdata;
1269 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5)_ARGS */
1270 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
1272 if ((host == NULL) || (*host == '\0'))
1277 memset((char *) &inaddr, 0, sizeof inaddr);
1279 if ((inaddr.sin_addr.s_addr = inet_addr(host)) == -1)
1281 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS)
1282 while (gethostbyname_r(host, &result, hbuf,
1283 HOSTENT_BUFFER_SIZE, &hostp, &thd_err)
1284 && (thd_err == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
1286 log_error(LOG_LEVEL_ERROR,
1287 "Timeout #%u while trying to resolve %s. Trying again.",
1290 #elif defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
1291 while (NULL == (hostp = gethostbyname_r(host, &result,
1292 hbuf, HOSTENT_BUFFER_SIZE, &thd_err))
1293 && (thd_err == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
1295 log_error(LOG_LEVEL_ERROR,
1296 "Timeout #%u while trying to resolve %s. Trying again.",
1299 #elif defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
1301 * XXX: Doesn't retry in case of soft errors.
1302 * Does this gethostbyname_r version set h_errno?
1304 if (0 == gethostbyname_r(host, &result, &hdata))
1312 #elif FEATURE_PTHREAD
1313 privoxy_mutex_lock(&resolver_mutex);
1314 while (NULL == (hostp = gethostbyname(host))
1315 && (h_errno == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
1317 log_error(LOG_LEVEL_ERROR,
1318 "Timeout #%u while trying to resolve %s. Trying again.",
1321 privoxy_mutex_unlock(&resolver_mutex);
1323 while (NULL == (hostp = gethostbyname(host))
1324 && (h_errno == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
1326 log_error(LOG_LEVEL_ERROR,
1327 "Timeout #%u while trying to resolve %s. Trying again.",
1330 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
1332 * On Mac OSX, if a domain exists but doesn't have a type A
1333 * record associated with it, the h_addr member of the struct
1334 * hostent returned by gethostbyname is NULL, even if h_length
1335 * is 4. Therefore the second test below.
1337 if (hostp == NULL || hostp->h_addr == NULL)
1340 log_error(LOG_LEVEL_ERROR, "could not resolve hostname %s", host);
1341 return(INADDR_NONE);
1343 if (hostp->h_addrtype != AF_INET)
1346 errno = WSAEPROTOTYPE;
1350 log_error(LOG_LEVEL_ERROR, "hostname %s resolves to unknown address type.", host);
1351 return(INADDR_NONE);
1354 (char *) &inaddr.sin_addr,
1355 (char *) hostp->h_addr,
1356 sizeof(inaddr.sin_addr)
1359 return(inaddr.sin_addr.s_addr);