1 const char jbsockets_rcs[] = "$Id: jbsockets.c,v 1.35.2.4 2003/04/04 12:40:20 oes Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/Attic/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 1.35.2.4 2003/04/04 12:40:20 oes
39 * Made sure the errno set by bind, not close[socket] is used in
40 * bind_port. Probably fixes bugs #713777, #705562.
42 * Revision 1.35.2.3 2003/03/07 03:41:04 david__schmidt
43 * 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.
45 * Revision 1.35.2.2 2002/11/20 14:37:24 oes
46 * Fixed Win32 error logging in bind_port.
47 * Thanks to Oliver Stoeneberg for the hint.
49 * Revision 1.35.2.1 2002/05/26 23:41:27 joergs
50 * AmigaOS: Fixed wrong type of len in write_socket()
52 * Revision 1.35 2002/04/26 15:50:04 joergs
53 * AmigaOS: No socklen_t, added AMIGA to the systems using int instead.
55 * Revision 1.34 2002/04/08 20:31:41 swa
58 * Revision 1.33 2002/04/03 16:02:18 gliptak
59 * Correcting compile warning with older gcc
61 * Revision 1.32 2002/03/31 17:18:59 jongfoster
62 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
64 * Revision 1.31 2002/03/29 03:33:13 david__schmidt
65 * Fix Mac OSX compiler warnings
67 * Revision 1.30 2002/03/27 14:32:43 david__schmidt
68 * More compiler warning message maintenance
70 * Revision 1.29 2002/03/26 22:29:54 swa
71 * we have a new homepage!
73 * Revision 1.28 2002/03/24 13:25:43 swa
74 * name change related issues
76 * Revision 1.27 2002/03/13 00:27:05 jongfoster
79 * Revision 1.26 2002/03/11 22:07:02 david__schmidt
80 * OS/2 port maintenance:
81 * - Fixed EMX build - it had decayed a little
82 * - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
83 * substituted a memset for now.
85 * Revision 1.25 2002/03/09 20:03:52 jongfoster
86 * - Making various functions return int rather than size_t.
87 * (Undoing a recent change). Since size_t is unsigned on
88 * Windows, functions like read_socket that return -1 on
89 * error cannot return a size_t.
91 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
92 * crashes, and also frequently caused JB to jump to 100%
93 * CPU and stay there. (Because it thought it had just
94 * read ((unsigned)-1) == 4Gb of data...)
96 * - The signature of write_socket has changed, it now simply
97 * returns success=0/failure=nonzero.
99 * - Trying to get rid of a few warnings --with-debug on
100 * Windows, I've introduced a new type "jb_socket". This is
101 * used for the socket file descriptors. On Windows, this
102 * is SOCKET (a typedef for unsigned). Everywhere else, it's
103 * an int. The error value can't be -1 any more, so it's
104 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
105 * Windows it maps to the #define INVALID_SOCKET.)
107 * - The signature of bind_port has changed.
109 * Revision 1.24 2002/03/07 03:51:36 oes
110 * - Improved handling of failed DNS lookups
111 * - Fixed compiler warnings etc
113 * Revision 1.23 2002/03/05 00:36:01 jongfoster
114 * Fixing bug 514988 - unable to restart Junkbuster
116 * Revision 1.22 2002/03/04 02:08:02 david__schmidt
117 * Enable web editing of actions file on OS/2 (it had been broken all this time!)
119 * Revision 1.21 2002/01/09 14:32:33 oes
120 * Added support for gethostbyname_r and gethostbyaddr_r.
122 * Revision 1.20 2001/11/16 00:48:48 jongfoster
123 * Enabling duplicate-socket detection for all platforms, not
126 * Revision 1.19 2001/10/25 03:40:47 david__schmidt
127 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
128 * threads to call select() simultaneously. So, it's time to do a real, live,
129 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
130 * (native). Both versions will work, but using __OS2__ offers multi-threading.
132 * Revision 1.18 2001/09/21 23:02:02 david__schmidt
133 * Cleaning up 2 compiler warnings on OS/2.
135 * Revision 1.17 2001/09/13 20:11:46 jongfoster
136 * Fixing 2 compiler warnings under Win32
138 * Revision 1.16 2001/07/30 22:08:36 jongfoster
139 * Tidying up #defines:
140 * - All feature #defines are now of the form FEATURE_xxx
141 * - Permanently turned off WIN_GUI_EDIT
142 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
144 * Revision 1.15 2001/07/29 17:40:43 jongfoster
145 * Fixed compiler warning by adding a cast
147 * Revision 1.14 2001/07/18 13:47:59 oes
148 * Eliminated dirty hack for getsockbyname()
150 * Revision 1.13 2001/07/15 13:56:57 jongfoster
151 * Removing unused local variable.
153 * Revision 1.12 2001/07/01 17:04:11 oes
154 * Bugfix: accept_connection no longer uses the obsolete hstrerror() function
156 * Revision 1.11 2001/06/29 21:45:41 oes
157 * Indentation, CRLF->LF, Tab-> Space
159 * Revision 1.10 2001/06/29 13:29:15 oes
160 * - Added remote (server) host IP to csp->http->host_ip_addr_str
161 * - Added detection of local socket IP and fqdn
162 * - Removed logentry from cancelled commit
164 * Revision 1.9 2001/06/07 23:06:09 jongfoster
165 * The host parameter to connect_to() is now const.
167 * Revision 1.8 2001/06/03 19:12:07 oes
170 * Revision 1.7 2001/05/28 16:14:00 jongfoster
171 * Fixing bug in LOG_LEVEL_LOG
173 * Revision 1.6 2001/05/26 17:28:32 jongfoster
174 * Fixed LOG_LEVEL_LOG
176 * Revision 1.5 2001/05/26 15:26:15 jongfoster
177 * ACL feature now provides more security by immediately dropping
178 * connections from untrusted hosts.
180 * Revision 1.4 2001/05/26 00:37:42 jongfoster
181 * Cosmetic indentation correction.
183 * Revision 1.3 2001/05/25 21:57:54 jongfoster
184 * Now gives a warning under Windows if you try to bind
185 * it to a port that's already in use.
187 * Revision 1.2 2001/05/17 23:01:01 oes
188 * - Cleaned CRLF's from the sources and related files
190 * Revision 1.1.1.1 2001/05/15 13:58:54 oes
191 * Initial import of version 2.9.3 source tree
194 *********************************************************************/
204 #include <sys/types.h>
212 #include <sys/timeb.h>
220 #include <sys/time.h>
221 #include <netinet/in.h>
222 #include <sys/ioctl.h>
224 #include <sys/socket.h>
227 #include <netinet/tcp.h>
229 #include <arpa/inet.h>
235 #if defined(__EMX__) || defined (__OS2__)
236 #include <sys/select.h> /* OS/2/EMX needs a little help with select */
247 /* jcc.h is for mutex semaphores only */
248 #endif /* def OSX_DARWIN */
251 #include "jbsockets.h"
255 const char jbsockets_h_rcs[] = JBSOCKETS_H_VERSION;
258 /*********************************************************************
260 * Function : connect_to
262 * Description : Open a socket and connect to it. Will check
263 * that this is allowed according to ACL.
266 * 1 : host = hostname to connect to
267 * 2 : portnum = port to connent on
268 * 3 : csp = Current client state (buffers, headers, etc...)
269 * Not modified, only used for source IP and ACL.
271 * Returns : JB_INVALID_SOCKET => failure, else it is the socket
274 *********************************************************************/
275 jb_socket connect_to(const char *host, int portnum, struct client_state *csp)
277 struct sockaddr_in inaddr;
281 struct timeval tv[1];
282 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA)
284 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
287 struct access_control_addr dst[1];
288 #endif /* def FEATURE_ACL */
290 memset((char *)&inaddr, 0, sizeof inaddr);
292 if ((addr = resolve_hostname_to_ip(host)) == INADDR_NONE)
294 csp->http->host_ip_addr_str = strdup("unknown");
295 return(JB_INVALID_SOCKET);
299 dst->addr = ntohl((unsigned long) addr);
302 if (block_acl(dst, csp))
309 return(JB_INVALID_SOCKET);
311 #endif /* def FEATURE_ACL */
313 inaddr.sin_addr.s_addr = addr;
314 inaddr.sin_family = AF_INET;
315 csp->http->host_ip_addr_str = strdup(inet_ntoa(inaddr.sin_addr));
318 if (sizeof(inaddr.sin_port) == sizeof(short))
319 #endif /* ndef _WIN32 */
321 inaddr.sin_port = htons((unsigned short) portnum);
326 inaddr.sin_port = htonl((unsigned long)portnum);
328 #endif /* ndef _WIN32 */
331 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) == JB_INVALID_SOCKET)
333 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) < 0)
336 return(JB_INVALID_SOCKET);
340 { /* turn off TCP coalescence */
342 setsockopt (fd, IPPROTO_TCP, TCP_NODELAY, (char *) &mi, sizeof (int));
344 #endif /* def TCP_NODELAY */
346 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
347 if ((flags = fcntl(fd, F_GETFL, 0)) != -1)
350 fcntl(fd, F_SETFL, flags);
352 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
354 while (connect(fd, (struct sockaddr *) & inaddr, sizeof inaddr) == JB_INVALID_SOCKET)
357 if (errno == WSAEINPROGRESS)
359 if (sock_errno() == EINPROGRESS)
360 #else /* ifndef _WIN32 */
361 if (errno == EINPROGRESS)
362 #endif /* ndef _WIN32 || __OS2__ */
368 if (sock_errno() != EINTR)
374 return(JB_INVALID_SOCKET);
378 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
382 fcntl(fd, F_SETFL, flags);
384 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
386 /* wait for connection to complete */
393 /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Wierd! */
394 if (select((int)fd + 1, NULL, &wfds, NULL, tv) <= 0)
397 return(JB_INVALID_SOCKET);
404 /*********************************************************************
406 * Function : write_socket
408 * Description : Write the contents of buf (for n bytes) to socket fd.
411 * 1 : fd = file descriptor (aka. handle) of socket to write to.
412 * 2 : buf = pointer to data to be written.
413 * 3 : len = length of data to be written to the socket "fd".
415 * Returns : 0 on success (entire buffer sent).
418 *********************************************************************/
420 int write_socket(jb_socket fd, const char *buf, ssize_t len)
422 int write_socket(jb_socket fd, const char *buf, size_t len)
435 log_error(LOG_LEVEL_LOG, "%N", len, buf);
438 return (send(fd, buf, (int)len, 0) != (int)len);
439 #elif defined(__BEOS__) || defined(AMIGA)
440 return (send(fd, buf, len, 0) != len);
441 #elif defined(__OS2__)
443 * Break the data up into SOCKET_SEND_MAX chunks for sending...
444 * OS/2 seemed to complain when the chunks were too large.
446 #define SOCKET_SEND_MAX 65000
448 int write_len = 0, send_len, send_rc = 0, i = 0;
449 while ((i < len) && (send_rc != -1))
451 if ((i + SOCKET_SEND_MAX) > len)
454 send_len = SOCKET_SEND_MAX;
455 send_rc = send(fd,(char*)buf + i, send_len, 0);
463 return (write(fd, buf, len) != len);
469 /*********************************************************************
471 * Function : read_socket
473 * Description : Read from a TCP/IP socket in a platform independent way.
476 * 1 : fd = file descriptor of the socket to read
477 * 2 : buf = pointer to buffer where data will be written
478 * Must be >= len bytes long.
479 * 3 : len = maximum number of bytes to read
481 * Returns : On success, the number of bytes read is returned (zero
482 * indicates end of file), and the file position is advanced
483 * by this number. It is not an error if this number is
484 * smaller than the number of bytes requested; this may hap-
485 * pen for example because fewer bytes are actually available
486 * right now (maybe because we were close to end-of-file, or
487 * because we are reading from a pipe, or from a terminal,
488 * or because read() was interrupted by a signal). On error,
489 * -1 is returned, and errno is set appropriately. In this
490 * case it is left unspecified whether the file position (if
493 *********************************************************************/
494 int read_socket(jb_socket fd, char *buf, int len)
502 return(recv(fd, buf, len, 0));
503 #elif defined(__BEOS__) || defined(AMIGA) || defined(__OS2__)
504 return(recv(fd, buf, (size_t)len, 0));
506 return(read(fd, buf, (size_t)len));
511 /*********************************************************************
513 * Function : close_socket
515 * Description : Closes a TCP/IP socket
518 * 1 : fd = file descriptor of socket to be closed
522 *********************************************************************/
523 void close_socket(jb_socket fd)
525 #if defined(_WIN32) || defined(__BEOS__)
529 #elif defined(__OS2__)
538 /*********************************************************************
540 * Function : bind_port
542 * Description : Call socket, set socket options, and listen.
543 * Called by listen_loop to "boot up" our proxy address.
546 * 1 : hostnam = TCP/IP address to bind/listen to
547 * 2 : portnum = port to listen on
548 * 3 : pfd = pointer used to return file descriptor.
550 * Returns : if success, returns 0 and sets *pfd.
551 * if failure, returns -3 if address is in use,
552 * -2 if address unresolvable,
554 *********************************************************************/
555 int bind_port(const char *hostnam, int portnum, jb_socket *pfd)
557 struct sockaddr_in inaddr;
561 #endif /* ndef _WIN32 */
563 *pfd = JB_INVALID_SOCKET;
565 memset((char *)&inaddr, '\0', sizeof inaddr);
567 inaddr.sin_family = AF_INET;
568 inaddr.sin_addr.s_addr = resolve_hostname_to_ip(hostnam);
570 if (inaddr.sin_addr.s_addr == INADDR_NONE)
576 if (sizeof(inaddr.sin_port) == sizeof(short))
577 #endif /* ndef _WIN32 */
579 inaddr.sin_port = htons((unsigned short) portnum);
584 inaddr.sin_port = htonl((unsigned long) portnum);
586 #endif /* ndef _WIN32 */
588 fd = socket(AF_INET, SOCK_STREAM, 0);
591 if (fd == JB_INVALID_SOCKET)
601 * This is not needed for Win32 - in fact, it stops
602 * duplicate instances of Privoxy from being caught.
604 * On UNIX, we assume the user is sensible enough not
605 * to start Junkbuster multiple times on the same IP.
606 * Without this, stopping and restarting Privoxy
607 * from a script fails.
608 * Note: SO_REUSEADDR is meant to only take over
609 * sockets which are *not* in listen state in Linux,
610 * e.g. sockets in TIME_WAIT. YMMV.
612 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (char *)&one, sizeof(one));
613 #endif /* ndef _WIN32 */
615 if (bind(fd, (struct sockaddr *)&inaddr, sizeof(inaddr)) < 0)
618 errno = WSAGetLastError();
619 if (errno == WSAEADDRINUSE)
621 if (errno == EADDRINUSE)
634 while (listen(fd, 5) == -1)
648 /*********************************************************************
650 * Function : accept_connection
652 * Description : Accepts a connection on a socket. Socket must have
653 * been created using bind_port().
656 * 1 : csp = Client state, cfd, ip_addr_str, and
657 * ip_addr_long will be set by this routine.
658 * 2 : fd = file descriptor returned from bind_port
660 * Returns : when a connection is accepted, it returns 1 (TRUE).
661 * On an error it returns 0 (FALSE).
663 *********************************************************************/
664 int accept_connection(struct client_state * csp, jb_socket fd)
666 struct sockaddr_in client, server;
667 struct hostent *host = NULL;
669 #if defined(_WIN32) || defined(__OS2__) || defined(__APPLE_CC__) || defined(AMIGA)
670 /* Wierdness - fix a warning. */
671 int c_length, s_length;
673 socklen_t c_length, s_length;
675 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS) || defined(HAVE_GETHOSTBYADDR_R_7_ARGS) || defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
676 struct hostent result;
677 #if defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
678 struct hostent_data hdata;
680 char hbuf[HOSTENT_BUFFER_SIZE];
682 #endif /* def HAVE_GETHOSTBYADDR_R_5_ARGS */
683 #endif /* def HAVE_GETHOSTBYADDR_R_(8|7|5)_ARGS */
685 c_length = s_length = sizeof(client);
688 afd = accept (fd, (struct sockaddr *) &client, &c_length);
689 if (afd == JB_INVALID_SOCKET)
696 afd = accept (fd, (struct sockaddr *) &client, &c_length);
697 } while (afd < 1 && errno == EINTR);
705 * Determine the IP-Adress that the client used to reach us
706 * and the hostname associated with that address
708 if (!getsockname(afd, (struct sockaddr *) &server, &s_length))
710 csp->my_ip_addr_str = strdup(inet_ntoa(server.sin_addr));
711 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS)
712 gethostbyaddr_r((const char *)&server.sin_addr,
713 sizeof(server.sin_addr), AF_INET,
714 &result, hbuf, HOSTENT_BUFFER_SIZE,
716 #elif defined(HAVE_GETHOSTBYADDR_R_7_ARGS)
717 host = gethostbyaddr_r((const char *)&server.sin_addr,
718 sizeof(server.sin_addr), AF_INET,
719 &result, hbuf, HOSTENT_BUFFER_SIZE, &thd_err);
720 #elif defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
721 if (0 == gethostbyaddr_r((const char *)&server.sin_addr,
722 sizeof(server.sin_addr), AF_INET,
731 #elif defined(OSX_DARWIN)
732 pthread_mutex_lock(&gethostbyaddr_mutex);
733 host = gethostbyaddr((const char *)&server.sin_addr,
734 sizeof(server.sin_addr), AF_INET);
735 pthread_mutex_unlock(&gethostbyaddr_mutex);
737 host = gethostbyaddr((const char *)&server.sin_addr,
738 sizeof(server.sin_addr), AF_INET);
742 log_error(LOG_LEVEL_ERROR, "Unable to get my own hostname: %E\n");
746 csp->my_hostname = strdup(host->h_name);
751 csp->ip_addr_str = strdup(inet_ntoa(client.sin_addr));
752 csp->ip_addr_long = ntohl(client.sin_addr.s_addr);
759 /*********************************************************************
761 * Function : resolve_hostname_to_ip
763 * Description : Resolve a hostname to an internet tcp/ip address.
764 * NULL or an empty string resolve to INADDR_ANY.
767 * 1 : host = hostname to resolve
769 * Returns : INADDR_NONE => failure, INADDR_ANY or tcp/ip address if succesful.
771 *********************************************************************/
772 unsigned long resolve_hostname_to_ip(const char *host)
774 struct sockaddr_in inaddr;
775 struct hostent *hostp;
776 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS) || defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
777 struct hostent result;
778 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
779 char hbuf[HOSTENT_BUFFER_SIZE];
781 #else /* defined(HAVE_GETHOSTBYNAME_R_3_ARGS) */
782 struct hostent_data hdata;
783 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5)_ARGS */
784 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
786 if ((host == NULL) || (*host == '\0'))
791 memset((char *) &inaddr, 0, sizeof inaddr);
793 if ((inaddr.sin_addr.s_addr = inet_addr(host)) == -1)
795 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS)
796 gethostbyname_r(host, &result, hbuf,
797 HOSTENT_BUFFER_SIZE, &hostp, &thd_err);
798 #elif defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
799 hostp = gethostbyname_r(host, &result, hbuf,
800 HOSTENT_BUFFER_SIZE, &thd_err);
801 #elif defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
802 if (0 == gethostbyname_r(host, &result, &hdata))
811 pthread_mutex_lock(&gethostbyname_mutex);
812 hostp = gethostbyname(host);
813 pthread_mutex_unlock(&gethostbyname_mutex);
815 hostp = gethostbyname(host);
816 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
818 * On Mac OSX, if a domain exists but doesn't have a type A
819 * record associated with it, the h_addr member of the struct
820 * hostent returned by gethostbyname is NULL, even if h_length
821 * is 4. Therefore the second test below.
823 if (hostp == NULL || hostp->h_addr == NULL)
826 log_error(LOG_LEVEL_ERROR, "could not resolve hostname %s", host);
829 if (hostp->h_addrtype != AF_INET)
832 errno = WSAEPROTOTYPE;
836 log_error(LOG_LEVEL_ERROR, "hostname %s resolves to unknown address type.", host);
840 (char *) &inaddr.sin_addr,
841 (char *) hostp->h_addr,
842 sizeof(inaddr.sin_addr)
845 return(inaddr.sin_addr.s_addr);