1 const char jbsockets_rcs[] = "$Id: jbsockets.c,v 2.0 2002/06/04 14:34:21 jongfoster 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.0 2002/06/04 14:34:21 jongfoster
39 * Moving source files to src/
41 * Revision 1.36 2002/05/26 23:23:10 joergs
42 * AmigaOS: Fixed wrong type for len in write_socket()
44 * Revision 1.35 2002/04/26 15:50:04 joergs
45 * AmigaOS: No socklen_t, added AMIGA to the systems using int instead.
47 * Revision 1.34 2002/04/08 20:31:41 swa
50 * Revision 1.33 2002/04/03 16:02:18 gliptak
51 * Correcting compile warning with older gcc
53 * Revision 1.32 2002/03/31 17:18:59 jongfoster
54 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
56 * Revision 1.31 2002/03/29 03:33:13 david__schmidt
57 * Fix Mac OSX compiler warnings
59 * Revision 1.30 2002/03/27 14:32:43 david__schmidt
60 * More compiler warning message maintenance
62 * Revision 1.29 2002/03/26 22:29:54 swa
63 * we have a new homepage!
65 * Revision 1.28 2002/03/24 13:25:43 swa
66 * name change related issues
68 * Revision 1.27 2002/03/13 00:27:05 jongfoster
71 * Revision 1.26 2002/03/11 22:07:02 david__schmidt
72 * OS/2 port maintenance:
73 * - Fixed EMX build - it had decayed a little
74 * - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
75 * substituted a memset for now.
77 * Revision 1.25 2002/03/09 20:03:52 jongfoster
78 * - Making various functions return int rather than size_t.
79 * (Undoing a recent change). Since size_t is unsigned on
80 * Windows, functions like read_socket that return -1 on
81 * error cannot return a size_t.
83 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
84 * crashes, and also frequently caused JB to jump to 100%
85 * CPU and stay there. (Because it thought it had just
86 * read ((unsigned)-1) == 4Gb of data...)
88 * - The signature of write_socket has changed, it now simply
89 * returns success=0/failure=nonzero.
91 * - Trying to get rid of a few warnings --with-debug on
92 * Windows, I've introduced a new type "jb_socket". This is
93 * used for the socket file descriptors. On Windows, this
94 * is SOCKET (a typedef for unsigned). Everywhere else, it's
95 * an int. The error value can't be -1 any more, so it's
96 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
97 * Windows it maps to the #define INVALID_SOCKET.)
99 * - The signature of bind_port has changed.
101 * Revision 1.24 2002/03/07 03:51:36 oes
102 * - Improved handling of failed DNS lookups
103 * - Fixed compiler warnings etc
105 * Revision 1.23 2002/03/05 00:36:01 jongfoster
106 * Fixing bug 514988 - unable to restart Junkbuster
108 * Revision 1.22 2002/03/04 02:08:02 david__schmidt
109 * Enable web editing of actions file on OS/2 (it had been broken all this time!)
111 * Revision 1.21 2002/01/09 14:32:33 oes
112 * Added support for gethostbyname_r and gethostbyaddr_r.
114 * Revision 1.20 2001/11/16 00:48:48 jongfoster
115 * Enabling duplicate-socket detection for all platforms, not
118 * Revision 1.19 2001/10/25 03:40:47 david__schmidt
119 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
120 * threads to call select() simultaneously. So, it's time to do a real, live,
121 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
122 * (native). Both versions will work, but using __OS2__ offers multi-threading.
124 * Revision 1.18 2001/09/21 23:02:02 david__schmidt
125 * Cleaning up 2 compiler warnings on OS/2.
127 * Revision 1.17 2001/09/13 20:11:46 jongfoster
128 * Fixing 2 compiler warnings under Win32
130 * Revision 1.16 2001/07/30 22:08:36 jongfoster
131 * Tidying up #defines:
132 * - All feature #defines are now of the form FEATURE_xxx
133 * - Permanently turned off WIN_GUI_EDIT
134 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
136 * Revision 1.15 2001/07/29 17:40:43 jongfoster
137 * Fixed compiler warning by adding a cast
139 * Revision 1.14 2001/07/18 13:47:59 oes
140 * Eliminated dirty hack for getsockbyname()
142 * Revision 1.13 2001/07/15 13:56:57 jongfoster
143 * Removing unused local variable.
145 * Revision 1.12 2001/07/01 17:04:11 oes
146 * Bugfix: accept_connection no longer uses the obsolete hstrerror() function
148 * Revision 1.11 2001/06/29 21:45:41 oes
149 * Indentation, CRLF->LF, Tab-> Space
151 * Revision 1.10 2001/06/29 13:29:15 oes
152 * - Added remote (server) host IP to csp->http->host_ip_addr_str
153 * - Added detection of local socket IP and fqdn
154 * - Removed logentry from cancelled commit
156 * Revision 1.9 2001/06/07 23:06:09 jongfoster
157 * The host parameter to connect_to() is now const.
159 * Revision 1.8 2001/06/03 19:12:07 oes
162 * Revision 1.7 2001/05/28 16:14:00 jongfoster
163 * Fixing bug in LOG_LEVEL_LOG
165 * Revision 1.6 2001/05/26 17:28:32 jongfoster
166 * Fixed LOG_LEVEL_LOG
168 * Revision 1.5 2001/05/26 15:26:15 jongfoster
169 * ACL feature now provides more security by immediately dropping
170 * connections from untrusted hosts.
172 * Revision 1.4 2001/05/26 00:37:42 jongfoster
173 * Cosmetic indentation correction.
175 * Revision 1.3 2001/05/25 21:57:54 jongfoster
176 * Now gives a warning under Windows if you try to bind
177 * it to a port that's already in use.
179 * Revision 1.2 2001/05/17 23:01:01 oes
180 * - Cleaned CRLF's from the sources and related files
182 * Revision 1.1.1.1 2001/05/15 13:58:54 oes
183 * Initial import of version 2.9.3 source tree
186 *********************************************************************/
196 #include <sys/types.h>
204 #include <sys/timeb.h>
212 #include <sys/time.h>
213 #include <netinet/in.h>
214 #include <sys/ioctl.h>
216 #include <sys/socket.h>
219 #include <netinet/tcp.h>
221 #include <arpa/inet.h>
227 #if defined(__EMX__) || defined (__OS2__)
228 #include <sys/select.h> /* OS/2/EMX needs a little help with select */
237 #include "jbsockets.h"
241 const char jbsockets_h_rcs[] = JBSOCKETS_H_VERSION;
244 /*********************************************************************
246 * Function : connect_to
248 * Description : Open a socket and connect to it. Will check
249 * that this is allowed according to ACL.
252 * 1 : host = hostname to connect to
253 * 2 : portnum = port to connent on
254 * 3 : csp = Current client state (buffers, headers, etc...)
255 * Not modified, only used for source IP and ACL.
257 * Returns : JB_INVALID_SOCKET => failure, else it is the socket
260 *********************************************************************/
261 jb_socket connect_to(const char *host, int portnum, struct client_state *csp)
263 struct sockaddr_in inaddr;
267 struct timeval tv[1];
268 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA)
270 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
273 struct access_control_addr dst[1];
274 #endif /* def FEATURE_ACL */
276 memset((char *)&inaddr, 0, sizeof inaddr);
278 if ((addr = resolve_hostname_to_ip(host)) == INADDR_NONE)
282 csp->http->host_ip_addr_str = strdup("unknown");
284 return(JB_INVALID_SOCKET);
290 dst->addr = ntohl((unsigned long) addr);
293 if (block_acl(dst, csp))
300 return(JB_INVALID_SOCKET);
303 #endif /* def FEATURE_ACL */
305 inaddr.sin_addr.s_addr = addr;
306 inaddr.sin_family = AF_INET;
309 csp->http->host_ip_addr_str = strdup(inet_ntoa(inaddr.sin_addr));
312 if (sizeof(inaddr.sin_port) == sizeof(short))
313 #endif /* ndef _WIN32 */
315 inaddr.sin_port = htons((unsigned short) portnum);
320 inaddr.sin_port = htonl((unsigned long)portnum);
322 #endif /* ndef _WIN32 */
325 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) == JB_INVALID_SOCKET)
327 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) < 0)
330 return(JB_INVALID_SOCKET);
334 { /* turn off TCP coalescence */
336 setsockopt (fd, IPPROTO_TCP, TCP_NODELAY, (char *) &mi, sizeof (int));
338 #endif /* def TCP_NODELAY */
340 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
341 if ((flags = fcntl(fd, F_GETFL, 0)) != -1)
344 fcntl(fd, F_SETFL, flags);
346 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
348 while (connect(fd, (struct sockaddr *) & inaddr, sizeof inaddr) == JB_INVALID_SOCKET)
351 if (errno == WSAEINPROGRESS)
353 if (sock_errno() == EINPROGRESS)
354 #else /* ifndef _WIN32 */
355 if (errno == EINPROGRESS)
356 #endif /* ndef _WIN32 || __OS2__ */
362 if (sock_errno() != EINTR)
368 return(JB_INVALID_SOCKET);
372 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
376 fcntl(fd, F_SETFL, flags);
378 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
380 /* wait for connection to complete */
387 /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Wierd! */
388 if (select((int)fd + 1, NULL, &wfds, NULL, tv) <= 0)
391 return(JB_INVALID_SOCKET);
398 /*********************************************************************
400 * Function : write_socket
402 * Description : Write the contents of buf (for n bytes) to socket fd.
405 * 1 : fd = file descriptor (aka. handle) of socket to write to.
406 * 2 : buf = pointer to data to be written.
407 * 3 : len = length of data to be written to the socket "fd".
409 * Returns : 0 on success (entire buffer sent).
412 *********************************************************************/
414 int write_socket(jb_socket fd, const char *buf, ssize_t len)
416 int write_socket(jb_socket fd, const char *buf, size_t len)
429 log_error(LOG_LEVEL_LOG, "%N", len, buf);
432 return (send(fd, buf, (int)len, 0) != (int)len);
433 #elif defined(__BEOS__) || defined(AMIGA)
434 return (send(fd, buf, len, 0) != len);
435 #elif defined(__OS2__)
437 * Break the data up into SOCKET_SEND_MAX chunks for sending...
438 * OS/2 seemed to complain when the chunks were too large.
440 #define SOCKET_SEND_MAX 65000
442 int write_len = 0, send_len, send_rc = 0, i = 0;
443 while ((i < len) && (send_rc != -1))
445 if ((i + SOCKET_SEND_MAX) > len)
448 send_len = SOCKET_SEND_MAX;
449 send_rc = send(fd,(char*)buf + i, send_len, 0);
457 return (write(fd, buf, len) != len);
463 /*********************************************************************
465 * Function : read_socket
467 * Description : Read from a TCP/IP socket in a platform independent way.
470 * 1 : fd = file descriptor of the socket to read
471 * 2 : buf = pointer to buffer where data will be written
472 * Must be >= len bytes long.
473 * 3 : len = maximum number of bytes to read
475 * Returns : On success, the number of bytes read is returned (zero
476 * indicates end of file), and the file position is advanced
477 * by this number. It is not an error if this number is
478 * smaller than the number of bytes requested; this may hap-
479 * pen for example because fewer bytes are actually available
480 * right now (maybe because we were close to end-of-file, or
481 * because we are reading from a pipe, or from a terminal,
482 * or because read() was interrupted by a signal). On error,
483 * -1 is returned, and errno is set appropriately. In this
484 * case it is left unspecified whether the file position (if
487 *********************************************************************/
488 int read_socket(jb_socket fd, char *buf, int len)
496 return(recv(fd, buf, len, 0));
497 #elif defined(__BEOS__) || defined(AMIGA) || defined(__OS2__)
498 return(recv(fd, buf, (size_t)len, 0));
500 return(read(fd, buf, (size_t)len));
505 /*********************************************************************
507 * Function : close_socket
509 * Description : Closes a TCP/IP socket
512 * 1 : fd = file descriptor of socket to be closed
516 *********************************************************************/
517 void close_socket(jb_socket fd)
519 #if defined(_WIN32) || defined(__BEOS__)
523 #elif defined(__OS2__)
532 /*********************************************************************
534 * Function : bind_port
536 * Description : Call socket, set socket options, and listen.
537 * Called by listen_loop to "boot up" our proxy address.
540 * 1 : hostnam = TCP/IP address to bind/listen to
541 * 2 : portnum = port to listen on
542 * 3 : pfd = pointer used to return file descriptor.
544 * Returns : if success, returns 0 and sets *pfd.
545 * if failure, returns -3 if address is in use,
546 * -2 if address unresolvable,
548 *********************************************************************/
549 int bind_port(const char *hostnam, int portnum, jb_socket *pfd)
551 struct sockaddr_in inaddr;
555 #endif /* ndef _WIN32 */
557 *pfd = JB_INVALID_SOCKET;
559 memset((char *)&inaddr, '\0', sizeof inaddr);
561 inaddr.sin_family = AF_INET;
562 inaddr.sin_addr.s_addr = resolve_hostname_to_ip(hostnam);
564 if (inaddr.sin_addr.s_addr == INADDR_NONE)
570 if (sizeof(inaddr.sin_port) == sizeof(short))
571 #endif /* ndef _WIN32 */
573 inaddr.sin_port = htons((unsigned short) portnum);
578 inaddr.sin_port = htonl((unsigned long) portnum);
580 #endif /* ndef _WIN32 */
582 fd = socket(AF_INET, SOCK_STREAM, 0);
585 if (fd == JB_INVALID_SOCKET)
595 * This is not needed for Win32 - in fact, it stops
596 * duplicate instances of Junkbuster from being caught.
598 * On UNIX, we assume the user is sensible enough not
599 * to start Junkbuster multiple times on the same IP.
600 * Without this, stopping and restarting Junkbuster
601 * from a script fails.
602 * Note: SO_REUSEADDR is meant to only take over
603 * sockets which are *not* in listen state in Linux,
604 * e.g. sockets in TIME_WAIT. YMMV.
606 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (char *)&one, sizeof(one));
607 #endif /* ndef _WIN32 */
609 if (bind (fd, (struct sockaddr *)&inaddr, sizeof(inaddr)) < 0)
613 if (errno == WSAEADDRINUSE)
615 if (errno == EADDRINUSE)
626 while (listen(fd, 5) == -1)
640 /*********************************************************************
642 * Function : accept_connection
644 * Description : Accepts a connection on a socket. Socket must have
645 * been created using bind_port().
648 * 1 : csp = Client state, cfd, ip_addr_str, and
649 * ip_addr_long will be set by this routine.
650 * 2 : fd = file descriptor returned from bind_port
652 * Returns : when a connection is accepted, it returns 1 (TRUE).
653 * On an error it returns 0 (FALSE).
655 *********************************************************************/
656 int accept_connection(struct client_state * csp, jb_socket fd)
658 struct sockaddr_in client, server;
659 struct hostent *host = NULL;
661 #if defined(_WIN32) || defined(__OS2__) || defined(__APPLE_CC__) || defined(AMIGA)
662 /* Wierdness - fix a warning. */
663 int c_length, s_length;
665 socklen_t c_length, s_length;
667 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS) || defined(HAVE_GETHOSTBYADDR_R_7_ARGS) || defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
668 struct hostent result;
669 #if defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
670 struct hostent_data hdata;
672 char hbuf[HOSTENT_BUFFER_SIZE];
674 #endif /* def HAVE_GETHOSTBYADDR_R_5_ARGS */
675 #endif /* def HAVE_GETHOSTBYADDR_R_(8|7|5)_ARGS */
677 c_length = s_length = sizeof(client);
680 afd = accept (fd, (struct sockaddr *) &client, &c_length);
681 if (afd == JB_INVALID_SOCKET)
688 afd = accept (fd, (struct sockaddr *) &client, &c_length);
689 } while (afd < 1 && errno == EINTR);
697 * Determine the IP-Adress that the client used to reach us
698 * and the hostname associated with that address
700 if (!getsockname(afd, (struct sockaddr *) &server, &s_length))
702 csp->my_ip_addr_str = strdup(inet_ntoa(server.sin_addr));
703 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS)
704 gethostbyaddr_r((const char *)&server.sin_addr,
705 sizeof(server.sin_addr), AF_INET,
706 &result, hbuf, HOSTENT_BUFFER_SIZE,
708 #elif defined(HAVE_GETHOSTBYADDR_R_7_ARGS)
709 host = gethostbyaddr_r((const char *)&server.sin_addr,
710 sizeof(server.sin_addr), AF_INET,
711 &result, hbuf, HOSTENT_BUFFER_SIZE, &thd_err);
712 #elif defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
713 if (0 == gethostbyaddr_r((const char *)&server.sin_addr,
714 sizeof(server.sin_addr), AF_INET,
724 host = gethostbyaddr((const char *)&server.sin_addr,
725 sizeof(server.sin_addr), AF_INET);
729 log_error(LOG_LEVEL_ERROR, "Unable to get my own hostname: %E\n");
733 csp->my_hostname = strdup(host->h_name);
738 csp->ip_addr_str = strdup(inet_ntoa(client.sin_addr));
739 csp->ip_addr_long = ntohl(client.sin_addr.s_addr);
746 /*********************************************************************
748 * Function : resolve_hostname_to_ip
750 * Description : Resolve a hostname to an internet tcp/ip address.
751 * NULL or an empty string resolve to INADDR_ANY.
754 * 1 : host = hostname to resolve
756 * Returns : INADDR_NONE => failure, INADDR_ANY or tcp/ip address if succesful.
758 *********************************************************************/
759 unsigned long resolve_hostname_to_ip(const char *host)
761 struct sockaddr_in inaddr;
762 struct hostent *hostp;
763 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS) || defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
764 struct hostent result;
765 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
766 char hbuf[HOSTENT_BUFFER_SIZE];
768 #else /* defined(HAVE_GETHOSTBYNAME_R_3_ARGS) */
769 struct hostent_data hdata;
770 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5)_ARGS */
771 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
773 if ((host == NULL) || (*host == '\0'))
778 memset((char *) &inaddr, 0, sizeof inaddr);
780 if ((inaddr.sin_addr.s_addr = inet_addr(host)) == -1)
782 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS)
783 gethostbyname_r(host, &result, hbuf,
784 HOSTENT_BUFFER_SIZE, &hostp, &thd_err);
785 #elif defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
786 hostp = gethostbyname_r(host, &result, hbuf,
787 HOSTENT_BUFFER_SIZE, &thd_err);
788 #elif defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
789 if (0 == gethostbyname_r(host, &result, &hdata))
798 hostp = gethostbyname(host);
799 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
803 log_error(LOG_LEVEL_ERROR, "could not resolve hostname %s", host);
806 if (hostp->h_addrtype != AF_INET)
809 errno = WSAEPROTOTYPE;
813 log_error(LOG_LEVEL_ERROR, "hostname %s resolves to unknown address type.", host);
817 (char *) &inaddr.sin_addr,
818 (char *) hostp->h_addr,
819 sizeof(inaddr.sin_addr)
822 return(inaddr.sin_addr.s_addr);