1 const char jbsockets_rcs[] = "$Id: jbsockets.c,v 2.1 2002/12/30 19:56:16 david__schmidt Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/src/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 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 2.1 2002/12/30 19:56:16 david__schmidt
39 * End of initial drop of statistics console infrastructure. Data stream
40 * is transmitted on the stats port every interval, provided the data has
41 * changed since the last transmission. More work probably needs to be
42 * done with regard to multiplatform threading; I stole the thread spawning
43 * code from jcc.c, but haven't been able to test it everywhere.
45 * Revision 2.0 2002/06/04 14:34:21 jongfoster
46 * Moving source files to src/
48 * Revision 1.36 2002/05/26 23:23:10 joergs
49 * AmigaOS: Fixed wrong type for len in write_socket()
51 * Revision 1.35 2002/04/26 15:50:04 joergs
52 * AmigaOS: No socklen_t, added AMIGA to the systems using int instead.
54 * Revision 1.34 2002/04/08 20:31:41 swa
57 * Revision 1.33 2002/04/03 16:02:18 gliptak
58 * Correcting compile warning with older gcc
60 * Revision 1.32 2002/03/31 17:18:59 jongfoster
61 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
63 * Revision 1.31 2002/03/29 03:33:13 david__schmidt
64 * Fix Mac OSX compiler warnings
66 * Revision 1.30 2002/03/27 14:32:43 david__schmidt
67 * More compiler warning message maintenance
69 * Revision 1.29 2002/03/26 22:29:54 swa
70 * we have a new homepage!
72 * Revision 1.28 2002/03/24 13:25:43 swa
73 * name change related issues
75 * Revision 1.27 2002/03/13 00:27:05 jongfoster
78 * Revision 1.26 2002/03/11 22:07:02 david__schmidt
79 * OS/2 port maintenance:
80 * - Fixed EMX build - it had decayed a little
81 * - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
82 * substituted a memset for now.
84 * Revision 1.25 2002/03/09 20:03:52 jongfoster
85 * - Making various functions return int rather than size_t.
86 * (Undoing a recent change). Since size_t is unsigned on
87 * Windows, functions like read_socket that return -1 on
88 * error cannot return a size_t.
90 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
91 * crashes, and also frequently caused JB to jump to 100%
92 * CPU and stay there. (Because it thought it had just
93 * read ((unsigned)-1) == 4Gb of data...)
95 * - The signature of write_socket has changed, it now simply
96 * returns success=0/failure=nonzero.
98 * - Trying to get rid of a few warnings --with-debug on
99 * Windows, I've introduced a new type "jb_socket". This is
100 * used for the socket file descriptors. On Windows, this
101 * is SOCKET (a typedef for unsigned). Everywhere else, it's
102 * an int. The error value can't be -1 any more, so it's
103 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
104 * Windows it maps to the #define INVALID_SOCKET.)
106 * - The signature of bind_port has changed.
108 * Revision 1.24 2002/03/07 03:51:36 oes
109 * - Improved handling of failed DNS lookups
110 * - Fixed compiler warnings etc
112 * Revision 1.23 2002/03/05 00:36:01 jongfoster
113 * Fixing bug 514988 - unable to restart Junkbuster
115 * Revision 1.22 2002/03/04 02:08:02 david__schmidt
116 * Enable web editing of actions file on OS/2 (it had been broken all this time!)
118 * Revision 1.21 2002/01/09 14:32:33 oes
119 * Added support for gethostbyname_r and gethostbyaddr_r.
121 * Revision 1.20 2001/11/16 00:48:48 jongfoster
122 * Enabling duplicate-socket detection for all platforms, not
125 * Revision 1.19 2001/10/25 03:40:47 david__schmidt
126 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
127 * threads to call select() simultaneously. So, it's time to do a real, live,
128 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
129 * (native). Both versions will work, but using __OS2__ offers multi-threading.
131 * Revision 1.18 2001/09/21 23:02:02 david__schmidt
132 * Cleaning up 2 compiler warnings on OS/2.
134 * Revision 1.17 2001/09/13 20:11:46 jongfoster
135 * Fixing 2 compiler warnings under Win32
137 * Revision 1.16 2001/07/30 22:08:36 jongfoster
138 * Tidying up #defines:
139 * - All feature #defines are now of the form FEATURE_xxx
140 * - Permanently turned off WIN_GUI_EDIT
141 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
143 * Revision 1.15 2001/07/29 17:40:43 jongfoster
144 * Fixed compiler warning by adding a cast
146 * Revision 1.14 2001/07/18 13:47:59 oes
147 * Eliminated dirty hack for getsockbyname()
149 * Revision 1.13 2001/07/15 13:56:57 jongfoster
150 * Removing unused local variable.
152 * Revision 1.12 2001/07/01 17:04:11 oes
153 * Bugfix: accept_connection no longer uses the obsolete hstrerror() function
155 * Revision 1.11 2001/06/29 21:45:41 oes
156 * Indentation, CRLF->LF, Tab-> Space
158 * Revision 1.10 2001/06/29 13:29:15 oes
159 * - Added remote (server) host IP to csp->http->host_ip_addr_str
160 * - Added detection of local socket IP and fqdn
161 * - Removed logentry from cancelled commit
163 * Revision 1.9 2001/06/07 23:06:09 jongfoster
164 * The host parameter to connect_to() is now const.
166 * Revision 1.8 2001/06/03 19:12:07 oes
169 * Revision 1.7 2001/05/28 16:14:00 jongfoster
170 * Fixing bug in LOG_LEVEL_LOG
172 * Revision 1.6 2001/05/26 17:28:32 jongfoster
173 * Fixed LOG_LEVEL_LOG
175 * Revision 1.5 2001/05/26 15:26:15 jongfoster
176 * ACL feature now provides more security by immediately dropping
177 * connections from untrusted hosts.
179 * Revision 1.4 2001/05/26 00:37:42 jongfoster
180 * Cosmetic indentation correction.
182 * Revision 1.3 2001/05/25 21:57:54 jongfoster
183 * Now gives a warning under Windows if you try to bind
184 * it to a port that's already in use.
186 * Revision 1.2 2001/05/17 23:01:01 oes
187 * - Cleaned CRLF's from the sources and related files
189 * Revision 1.1.1.1 2001/05/15 13:58:54 oes
190 * Initial import of version 2.9.3 source tree
193 *********************************************************************/
203 #include <sys/types.h>
211 #include <sys/timeb.h>
219 #include <sys/time.h>
220 #include <netinet/in.h>
221 #include <sys/ioctl.h>
223 #include <sys/socket.h>
226 #include <netinet/tcp.h>
228 #include <arpa/inet.h>
234 #if defined(__EMX__) || defined (__OS2__)
235 #include <sys/select.h> /* OS/2/EMX needs a little help with select */
246 /* jcc.h is for mutex semaphores only */
247 #endif /* def OSX_DARWIN */
250 #include "jbsockets.h"
254 const char jbsockets_h_rcs[] = JBSOCKETS_H_VERSION;
257 /*********************************************************************
259 * Function : connect_to
261 * Description : Open a socket and connect to it. Will check
262 * that this is allowed according to ACL.
265 * 1 : host = hostname to connect to
266 * 2 : portnum = port to connent on
267 * 3 : csp = Current client state (buffers, headers, etc...)
268 * Not modified, only used for source IP and ACL.
270 * Returns : JB_INVALID_SOCKET => failure, else it is the socket
273 *********************************************************************/
274 jb_socket connect_to(const char *host, int portnum, struct client_state *csp)
276 struct sockaddr_in inaddr;
280 struct timeval tv[1];
281 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA)
283 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
286 struct access_control_addr dst[1];
287 #endif /* def FEATURE_ACL */
289 memset((char *)&inaddr, 0, sizeof inaddr);
291 if ((addr = resolve_hostname_to_ip(host)) == INADDR_NONE)
295 csp->http->host_ip_addr_str = strdup("unknown");
297 return(JB_INVALID_SOCKET);
303 dst->addr = ntohl((unsigned long) addr);
306 if (block_acl(dst, csp))
313 return(JB_INVALID_SOCKET);
316 #endif /* def FEATURE_ACL */
318 inaddr.sin_addr.s_addr = addr;
319 inaddr.sin_family = AF_INET;
322 csp->http->host_ip_addr_str = strdup(inet_ntoa(inaddr.sin_addr));
325 if (sizeof(inaddr.sin_port) == sizeof(short))
326 #endif /* ndef _WIN32 */
328 inaddr.sin_port = htons((unsigned short) portnum);
333 inaddr.sin_port = htonl((unsigned long)portnum);
335 #endif /* ndef _WIN32 */
338 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) == JB_INVALID_SOCKET)
340 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) < 0)
343 return(JB_INVALID_SOCKET);
347 { /* turn off TCP coalescence */
349 setsockopt (fd, IPPROTO_TCP, TCP_NODELAY, (char *) &mi, sizeof (int));
351 #endif /* def TCP_NODELAY */
353 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
354 if ((flags = fcntl(fd, F_GETFL, 0)) != -1)
357 fcntl(fd, F_SETFL, flags);
359 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
361 while (connect(fd, (struct sockaddr *) & inaddr, sizeof inaddr) == JB_INVALID_SOCKET)
364 if (errno == WSAEINPROGRESS)
366 if (sock_errno() == EINPROGRESS)
367 #else /* ifndef _WIN32 */
368 if (errno == EINPROGRESS)
369 #endif /* ndef _WIN32 || __OS2__ */
375 if (sock_errno() != EINTR)
381 return(JB_INVALID_SOCKET);
385 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
389 fcntl(fd, F_SETFL, flags);
391 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
393 /* wait for connection to complete */
400 /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Wierd! */
401 if (select((int)fd + 1, NULL, &wfds, NULL, tv) <= 0)
404 return(JB_INVALID_SOCKET);
411 /*********************************************************************
413 * Function : write_socket
415 * Description : Write the contents of buf (for n bytes) to socket fd.
418 * 1 : fd = file descriptor (aka. handle) of socket to write to.
419 * 2 : buf = pointer to data to be written.
420 * 3 : len = length of data to be written to the socket "fd".
422 * Returns : 0 on success (entire buffer sent).
425 *********************************************************************/
427 int write_socket(jb_socket fd, const char *buf, ssize_t len)
429 int write_socket(jb_socket fd, const char *buf, size_t len)
442 log_error(LOG_LEVEL_LOG, "%N", len, buf);
445 return (send(fd, buf, (int)len, 0) != (int)len);
446 #elif defined(__BEOS__) || defined(AMIGA)
447 return (send(fd, buf, len, 0) != len);
448 #elif defined(__OS2__)
450 * Break the data up into SOCKET_SEND_MAX chunks for sending...
451 * OS/2 seemed to complain when the chunks were too large.
453 #define SOCKET_SEND_MAX 65000
455 int write_len = 0, send_len, send_rc = 0, i = 0;
456 while ((i < len) && (send_rc != -1))
458 if ((i + SOCKET_SEND_MAX) > len)
461 send_len = SOCKET_SEND_MAX;
462 send_rc = send(fd,(char*)buf + i, send_len, 0);
470 return (write(fd, buf, len) != len);
476 /*********************************************************************
478 * Function : read_socket
480 * Description : Read from a TCP/IP socket in a platform independent way.
483 * 1 : fd = file descriptor of the socket to read
484 * 2 : buf = pointer to buffer where data will be written
485 * Must be >= len bytes long.
486 * 3 : len = maximum number of bytes to read
488 * Returns : On success, the number of bytes read is returned (zero
489 * indicates end of file), and the file position is advanced
490 * by this number. It is not an error if this number is
491 * smaller than the number of bytes requested; this may hap-
492 * pen for example because fewer bytes are actually available
493 * right now (maybe because we were close to end-of-file, or
494 * because we are reading from a pipe, or from a terminal,
495 * or because read() was interrupted by a signal). On error,
496 * -1 is returned, and errno is set appropriately. In this
497 * case it is left unspecified whether the file position (if
500 *********************************************************************/
501 int read_socket(jb_socket fd, char *buf, int len)
509 return(recv(fd, buf, len, 0));
510 #elif defined(__BEOS__) || defined(AMIGA) || defined(__OS2__)
511 return(recv(fd, buf, (size_t)len, 0));
513 return(read(fd, buf, (size_t)len));
518 /*********************************************************************
520 * Function : close_socket
522 * Description : Closes a TCP/IP socket
525 * 1 : fd = file descriptor of socket to be closed
529 *********************************************************************/
530 void close_socket(jb_socket fd)
532 #if defined(_WIN32) || defined(__BEOS__)
536 #elif defined(__OS2__)
545 /*********************************************************************
547 * Function : bind_port
549 * Description : Call socket, set socket options, and listen.
550 * Called by listen_loop to "boot up" our proxy address.
553 * 1 : hostnam = TCP/IP address to bind/listen to
554 * 2 : portnum = port to listen on
555 * 3 : pfd = pointer used to return file descriptor.
557 * Returns : if success, returns 0 and sets *pfd.
558 * if failure, returns -3 if address is in use,
559 * -2 if address unresolvable,
561 *********************************************************************/
562 int bind_port(const char *hostnam, int portnum, jb_socket *pfd)
564 struct sockaddr_in inaddr;
568 #endif /* ndef _WIN32 */
570 *pfd = JB_INVALID_SOCKET;
572 memset((char *)&inaddr, '\0', sizeof inaddr);
574 inaddr.sin_family = AF_INET;
575 inaddr.sin_addr.s_addr = resolve_hostname_to_ip(hostnam);
577 if (inaddr.sin_addr.s_addr == INADDR_NONE)
583 if (sizeof(inaddr.sin_port) == sizeof(short))
584 #endif /* ndef _WIN32 */
586 inaddr.sin_port = htons((unsigned short) portnum);
591 inaddr.sin_port = htonl((unsigned long) portnum);
593 #endif /* ndef _WIN32 */
595 fd = socket(AF_INET, SOCK_STREAM, 0);
598 if (fd == JB_INVALID_SOCKET)
608 * This is not needed for Win32 - in fact, it stops
609 * duplicate instances of Privoxy from being caught.
611 * On UNIX, we assume the user is sensible enough not
612 * to start Junkbuster multiple times on the same IP.
613 * Without this, stopping and restarting Privoxy
614 * from a script fails.
615 * Note: SO_REUSEADDR is meant to only take over
616 * sockets which are *not* in listen state in Linux,
617 * e.g. sockets in TIME_WAIT. YMMV.
619 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (char *)&one, sizeof(one));
620 #endif /* ndef _WIN32 */
622 if (bind (fd, (struct sockaddr *)&inaddr, sizeof(inaddr)) < 0)
626 if (errno == WSAEADDRINUSE)
628 if (errno == EADDRINUSE)
639 while (listen(fd, 5) == -1)
653 /*********************************************************************
655 * Function : accept_connection
657 * Description : Accepts a connection on a socket. Socket must have
658 * been created using bind_port().
661 * 1 : csp = Client state, cfd, ip_addr_str, and
662 * ip_addr_long will be set by this routine.
663 * 2 : fd = file descriptor returned from bind_port
665 * Returns : when a connection is accepted, it returns 1 (TRUE).
666 * On an error it returns 0 (FALSE).
668 *********************************************************************/
669 int accept_connection(struct client_state * csp, jb_socket fd)
671 struct sockaddr_in client, server;
672 struct hostent *host = NULL;
674 #if defined(_WIN32) || defined(__OS2__) || defined(__APPLE_CC__) || defined(AMIGA)
675 /* Wierdness - fix a warning. */
676 int c_length, s_length;
678 socklen_t c_length, s_length;
680 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS) || defined(HAVE_GETHOSTBYADDR_R_7_ARGS) || defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
681 struct hostent result;
682 #if defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
683 struct hostent_data hdata;
685 char hbuf[HOSTENT_BUFFER_SIZE];
687 #endif /* def HAVE_GETHOSTBYADDR_R_5_ARGS */
688 #endif /* def HAVE_GETHOSTBYADDR_R_(8|7|5)_ARGS */
690 c_length = s_length = sizeof(client);
693 afd = accept (fd, (struct sockaddr *) &client, &c_length);
694 if (afd == JB_INVALID_SOCKET)
701 afd = accept (fd, (struct sockaddr *) &client, &c_length);
702 } while (afd < 1 && errno == EINTR);
710 * Determine the IP-Adress that the client used to reach us
711 * and the hostname associated with that address
713 if (!getsockname(afd, (struct sockaddr *) &server, &s_length))
715 csp->my_ip_addr_str = strdup(inet_ntoa(server.sin_addr));
716 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS)
717 gethostbyaddr_r((const char *)&server.sin_addr,
718 sizeof(server.sin_addr), AF_INET,
719 &result, hbuf, HOSTENT_BUFFER_SIZE,
721 #elif defined(HAVE_GETHOSTBYADDR_R_7_ARGS)
722 host = gethostbyaddr_r((const char *)&server.sin_addr,
723 sizeof(server.sin_addr), AF_INET,
724 &result, hbuf, HOSTENT_BUFFER_SIZE, &thd_err);
725 #elif defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
726 if (0 == gethostbyaddr_r((const char *)&server.sin_addr,
727 sizeof(server.sin_addr), AF_INET,
736 #elif defined(OSX_DARWIN)
737 pthread_mutex_lock(&gethostbyaddr_mutex);
738 host = gethostbyaddr((const char *)&server.sin_addr,
739 sizeof(server.sin_addr), AF_INET);
740 pthread_mutex_unlock(&gethostbyaddr_mutex);
742 host = gethostbyaddr((const char *)&server.sin_addr,
743 sizeof(server.sin_addr), AF_INET);
747 log_error(LOG_LEVEL_ERROR, "Unable to get my own hostname: %E\n");
751 csp->my_hostname = strdup(host->h_name);
756 csp->ip_addr_str = strdup(inet_ntoa(client.sin_addr));
757 csp->ip_addr_long = ntohl(client.sin_addr.s_addr);
764 /*********************************************************************
766 * Function : resolve_hostname_to_ip
768 * Description : Resolve a hostname to an internet tcp/ip address.
769 * NULL or an empty string resolve to INADDR_ANY.
772 * 1 : host = hostname to resolve
774 * Returns : INADDR_NONE => failure, INADDR_ANY or tcp/ip address if succesful.
776 *********************************************************************/
777 unsigned long resolve_hostname_to_ip(const char *host)
779 struct sockaddr_in inaddr;
780 struct hostent *hostp;
781 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS) || defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
782 struct hostent result;
783 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
784 char hbuf[HOSTENT_BUFFER_SIZE];
786 #else /* defined(HAVE_GETHOSTBYNAME_R_3_ARGS) */
787 struct hostent_data hdata;
788 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5)_ARGS */
789 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
791 if ((host == NULL) || (*host == '\0'))
796 memset((char *) &inaddr, 0, sizeof inaddr);
798 if ((inaddr.sin_addr.s_addr = inet_addr(host)) == -1)
800 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS)
801 gethostbyname_r(host, &result, hbuf,
802 HOSTENT_BUFFER_SIZE, &hostp, &thd_err);
803 #elif defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
804 hostp = gethostbyname_r(host, &result, hbuf,
805 HOSTENT_BUFFER_SIZE, &thd_err);
806 #elif defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
807 if (0 == gethostbyname_r(host, &result, &hdata))
816 pthread_mutex_lock(&gethostbyname_mutex);
817 hostp = gethostbyname(host);
818 pthread_mutex_unlock(&gethostbyname_mutex);
820 hostp = gethostbyname(host);
821 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
823 * On Mac OSX, if a domain exists but doesn't have a type A
824 * record associated with it, the h_addr member of the struct
825 * hostent returned by gethostbyname is NULL, even if h_length
826 * is 4. Therefore the second test below.
828 if (hostp == NULL || hostp->h_addr == NULL)
831 log_error(LOG_LEVEL_ERROR, "could not resolve hostname %s", host);
834 if (hostp->h_addrtype != AF_INET)
837 errno = WSAEPROTOTYPE;
841 log_error(LOG_LEVEL_ERROR, "hostname %s resolves to unknown address type.", host);
845 (char *) &inaddr.sin_addr,
846 (char *) hostp->h_addr,
847 sizeof(inaddr.sin_addr)
850 return(inaddr.sin_addr.s_addr);