1 const char jbsockets_rcs[] = "$Id: jbsockets.c,v 1.30 2002/03/27 14:32:43 david__schmidt 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 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.30 2002/03/27 14:32:43 david__schmidt
39 * More compiler warning message maintenance
41 * Revision 1.29 2002/03/26 22:29:54 swa
42 * we have a new homepage!
44 * Revision 1.28 2002/03/24 13:25:43 swa
45 * name change related issues
47 * Revision 1.27 2002/03/13 00:27:05 jongfoster
50 * Revision 1.26 2002/03/11 22:07:02 david__schmidt
51 * OS/2 port maintenance:
52 * - Fixed EMX build - it had decayed a little
53 * - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
54 * substituted a memset for now.
56 * Revision 1.25 2002/03/09 20:03:52 jongfoster
57 * - Making various functions return int rather than size_t.
58 * (Undoing a recent change). Since size_t is unsigned on
59 * Windows, functions like read_socket that return -1 on
60 * error cannot return a size_t.
62 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
63 * crashes, and also frequently caused JB to jump to 100%
64 * CPU and stay there. (Because it thought it had just
65 * read ((unsigned)-1) == 4Gb of data...)
67 * - The signature of write_socket has changed, it now simply
68 * returns success=0/failure=nonzero.
70 * - Trying to get rid of a few warnings --with-debug on
71 * Windows, I've introduced a new type "jb_socket". This is
72 * used for the socket file descriptors. On Windows, this
73 * is SOCKET (a typedef for unsigned). Everywhere else, it's
74 * an int. The error value can't be -1 any more, so it's
75 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
76 * Windows it maps to the #define INVALID_SOCKET.)
78 * - The signature of bind_port has changed.
80 * Revision 1.24 2002/03/07 03:51:36 oes
81 * - Improved handling of failed DNS lookups
82 * - Fixed compiler warnings etc
84 * Revision 1.23 2002/03/05 00:36:01 jongfoster
85 * Fixing bug 514988 - unable to restart JunkBuster
87 * Revision 1.22 2002/03/04 02:08:02 david__schmidt
88 * Enable web editing of actions file on OS/2 (it had been broken all this time!)
90 * Revision 1.21 2002/01/09 14:32:33 oes
91 * Added support for gethostbyname_r and gethostbyaddr_r.
93 * Revision 1.20 2001/11/16 00:48:48 jongfoster
94 * Enabling duplicate-socket detection for all platforms, not
97 * Revision 1.19 2001/10/25 03:40:47 david__schmidt
98 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
99 * threads to call select() simultaneously. So, it's time to do a real, live,
100 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
101 * (native). Both versions will work, but using __OS2__ offers multi-threading.
103 * Revision 1.18 2001/09/21 23:02:02 david__schmidt
104 * Cleaning up 2 compiler warnings on OS/2.
106 * Revision 1.17 2001/09/13 20:11:46 jongfoster
107 * Fixing 2 compiler warnings under Win32
109 * Revision 1.16 2001/07/30 22:08:36 jongfoster
110 * Tidying up #defines:
111 * - All feature #defines are now of the form FEATURE_xxx
112 * - Permanently turned off WIN_GUI_EDIT
113 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
115 * Revision 1.15 2001/07/29 17:40:43 jongfoster
116 * Fixed compiler warning by adding a cast
118 * Revision 1.14 2001/07/18 13:47:59 oes
119 * Eliminated dirty hack for getsockbyname()
121 * Revision 1.13 2001/07/15 13:56:57 jongfoster
122 * Removing unused local variable.
124 * Revision 1.12 2001/07/01 17:04:11 oes
125 * Bugfix: accept_connection no longer uses the obsolete hstrerror() function
127 * Revision 1.11 2001/06/29 21:45:41 oes
128 * Indentation, CRLF->LF, Tab-> Space
130 * Revision 1.10 2001/06/29 13:29:15 oes
131 * - Added remote (server) host IP to csp->http->host_ip_addr_str
132 * - Added detection of local socket IP and fqdn
133 * - Removed logentry from cancelled commit
135 * Revision 1.9 2001/06/07 23:06:09 jongfoster
136 * The host parameter to connect_to() is now const.
138 * Revision 1.8 2001/06/03 19:12:07 oes
141 * Revision 1.7 2001/05/28 16:14:00 jongfoster
142 * Fixing bug in LOG_LEVEL_LOG
144 * Revision 1.6 2001/05/26 17:28:32 jongfoster
145 * Fixed LOG_LEVEL_LOG
147 * Revision 1.5 2001/05/26 15:26:15 jongfoster
148 * ACL feature now provides more security by immediately dropping
149 * connections from untrusted hosts.
151 * Revision 1.4 2001/05/26 00:37:42 jongfoster
152 * Cosmetic indentation correction.
154 * Revision 1.3 2001/05/25 21:57:54 jongfoster
155 * Now gives a warning under Windows if you try to bind
156 * it to a port that's already in use.
158 * Revision 1.2 2001/05/17 23:01:01 oes
159 * - Cleaned CRLF's from the sources and related files
161 * Revision 1.1.1.1 2001/05/15 13:58:54 oes
162 * Initial import of version 2.9.3 source tree
165 *********************************************************************/
175 #include <sys/types.h>
180 #include <sys/timeb.h>
188 #include <sys/time.h>
189 #include <netinet/in.h>
190 #include <sys/ioctl.h>
192 #include <sys/socket.h>
195 #include <netinet/tcp.h>
197 #include <arpa/inet.h>
203 #if defined(__EMX__) || defined (__OS2__)
204 #include <sys/select.h> /* OS/2/EMX needs a little help with select */
213 #include "jbsockets.h"
217 const char jbsockets_h_rcs[] = JBSOCKETS_H_VERSION;
220 /*********************************************************************
222 * Function : connect_to
224 * Description : Open a socket and connect to it. Will check
225 * that this is allowed according to ACL.
228 * 1 : host = hostname to connect to
229 * 2 : portnum = port to connent on
230 * 3 : csp = Current client state (buffers, headers, etc...)
231 * Not modified, only used for source IP and ACL.
233 * Returns : JB_INVALID_SOCKET => failure, else it is the socket
236 *********************************************************************/
237 jb_socket connect_to(const char *host, int portnum, struct client_state *csp)
239 struct sockaddr_in inaddr;
243 struct timeval tv[1];
244 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA)
246 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
249 struct access_control_addr dst[1];
250 #endif /* def FEATURE_ACL */
252 memset((char *)&inaddr, 0, sizeof inaddr);
254 if ((addr = resolve_hostname_to_ip(host)) == INADDR_NONE)
256 csp->http->host_ip_addr_str = strdup("unknown");
257 return(JB_INVALID_SOCKET);
261 dst->addr = ntohl((unsigned long) addr);
264 if (block_acl(dst, csp))
271 return(JB_INVALID_SOCKET);
273 #endif /* def FEATURE_ACL */
275 inaddr.sin_addr.s_addr = addr;
276 inaddr.sin_family = AF_INET;
277 csp->http->host_ip_addr_str = strdup(inet_ntoa(inaddr.sin_addr));
280 if (sizeof(inaddr.sin_port) == sizeof(short))
281 #endif /* ndef _WIN32 */
283 inaddr.sin_port = htons((unsigned short) portnum);
288 inaddr.sin_port = htonl((unsigned long)portnum);
290 #endif /* ndef _WIN32 */
293 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) == JB_INVALID_SOCKET)
295 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) < 0)
298 return(JB_INVALID_SOCKET);
302 { /* turn off TCP coalescence */
304 setsockopt (fd, IPPROTO_TCP, TCP_NODELAY, (char *) &mi, sizeof (int));
306 #endif /* def TCP_NODELAY */
308 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
309 if ((flags = fcntl(fd, F_GETFL, 0)) != -1)
312 fcntl(fd, F_SETFL, flags);
314 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
316 while (connect(fd, (struct sockaddr *) & inaddr, sizeof inaddr) == JB_INVALID_SOCKET)
319 if (errno == WSAEINPROGRESS)
321 if (sock_errno() == EINPROGRESS)
322 #else /* ifndef _WIN32 */
323 if (errno == EINPROGRESS)
324 #endif /* ndef _WIN32 || __OS2__ */
330 if (sock_errno() != EINTR)
336 return(JB_INVALID_SOCKET);
340 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
344 fcntl(fd, F_SETFL, flags);
346 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
348 /* wait for connection to complete */
355 /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Wierd! */
356 if (select((int)fd + 1, NULL, &wfds, NULL, tv) <= 0)
359 return(JB_INVALID_SOCKET);
366 /*********************************************************************
368 * Function : write_socket
370 * Description : Write the contents of buf (for n bytes) to socket fd.
373 * 1 : fd = file descriptor (aka. handle) of socket to write to.
374 * 2 : buf = pointer to data to be written.
375 * 3 : len = length of data to be written to the socket "fd".
377 * Returns : 0 on success (entire buffer sent).
380 *********************************************************************/
381 int write_socket(jb_socket fd, const char *buf, size_t len)
393 log_error(LOG_LEVEL_LOG, "%N", len, buf);
396 return (send(fd, buf, (int)len, 0) != (int)len);
397 #elif defined(__BEOS__) || defined(AMIGA)
398 return (send(fd, buf, len, 0) != len);
399 #elif defined(__OS2__)
401 * Break the data up into SOCKET_SEND_MAX chunks for sending...
402 * OS/2 seemed to complain when the chunks were too large.
404 #define SOCKET_SEND_MAX 65000
406 int write_len = 0, send_len, send_rc = 0, i = 0;
407 while ((i < len) && (send_rc != -1))
409 if ((i + SOCKET_SEND_MAX) > len)
412 send_len = SOCKET_SEND_MAX;
413 send_rc = send(fd,(char*)buf + i, send_len, 0);
421 return (write(fd, buf, len) != len);
427 /*********************************************************************
429 * Function : read_socket
431 * Description : Read from a TCP/IP socket in a platform independent way.
434 * 1 : fd = file descriptor of the socket to read
435 * 2 : buf = pointer to buffer where data will be written
436 * Must be >= len bytes long.
437 * 3 : len = maximum number of bytes to read
439 * Returns : On success, the number of bytes read is returned (zero
440 * indicates end of file), and the file position is advanced
441 * by this number. It is not an error if this number is
442 * smaller than the number of bytes requested; this may hap-
443 * pen for example because fewer bytes are actually available
444 * right now (maybe because we were close to end-of-file, or
445 * because we are reading from a pipe, or from a terminal,
446 * or because read() was interrupted by a signal). On error,
447 * -1 is returned, and errno is set appropriately. In this
448 * case it is left unspecified whether the file position (if
451 *********************************************************************/
452 int read_socket(jb_socket fd, char *buf, int len)
460 return(recv(fd, buf, len, 0));
461 #elif defined(__BEOS__) || defined(AMIGA) || defined(__OS2__)
462 return(recv(fd, buf, (size_t)len, 0));
464 return(read(fd, buf, (size_t)len));
469 /*********************************************************************
471 * Function : close_socket
473 * Description : Closes a TCP/IP socket
476 * 1 : fd = file descriptor of socket to be closed
480 *********************************************************************/
481 void close_socket(jb_socket fd)
483 #if defined(_WIN32) || defined(__BEOS__)
487 #elif defined(__OS2__)
496 /*********************************************************************
498 * Function : bind_port
500 * Description : Call socket, set socket options, and listen.
501 * Called by listen_loop to "boot up" our proxy address.
504 * 1 : hostnam = TCP/IP address to bind/listen to
505 * 2 : portnum = port to listen on
506 * 3 : pfd = pointer used to return file descriptor.
508 * Returns : if success, returns 0 and sets *pfd.
509 * if failure, returns -3 if address is in use,
510 * -2 if address unresolvable,
512 *********************************************************************/
513 int bind_port(const char *hostnam, int portnum, jb_socket *pfd)
515 struct sockaddr_in inaddr;
519 #endif /* ndef _WIN32 */
521 *pfd = JB_INVALID_SOCKET;
523 memset((char *)&inaddr, '\0', sizeof inaddr);
525 inaddr.sin_family = AF_INET;
526 inaddr.sin_addr.s_addr = resolve_hostname_to_ip(hostnam);
528 if (inaddr.sin_addr.s_addr == INADDR_NONE)
534 if (sizeof(inaddr.sin_port) == sizeof(short))
535 #endif /* ndef _WIN32 */
537 inaddr.sin_port = htons((unsigned short) portnum);
542 inaddr.sin_port = htonl((unsigned long) portnum);
544 #endif /* ndef _WIN32 */
546 fd = socket(AF_INET, SOCK_STREAM, 0);
549 if (fd == JB_INVALID_SOCKET)
559 * This is not needed for Win32 - in fact, it stops
560 * duplicate instances of JunkBuster from being caught.
562 * On UNIX, we assume the user is sensible enough not
563 * to start JunkBuster multiple times on the same IP.
564 * Without this, stopping and restarting JunkBuster
565 * from a script fails.
566 * Note: SO_REUSEADDR is meant to only take over
567 * sockets which are *not* in listen state in Linux,
568 * e.g. sockets in TIME_WAIT. YMMV.
570 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (char *)&one, sizeof(one));
571 #endif /* ndef _WIN32 */
573 if (bind (fd, (struct sockaddr *)&inaddr, sizeof(inaddr)) < 0)
577 if (errno == WSAEADDRINUSE)
579 if (errno == EADDRINUSE)
590 while (listen(fd, 5) == -1)
604 /*********************************************************************
606 * Function : accept_connection
608 * Description : Accepts a connection on a socket. Socket must have
609 * been created using bind_port().
612 * 1 : csp = Client state, cfd, ip_addr_str, and
613 * ip_addr_long will be set by this routine.
614 * 2 : fd = file descriptor returned from bind_port
616 * Returns : when a connection is accepted, it returns 1 (TRUE).
617 * On an error it returns 0 (FALSE).
619 *********************************************************************/
620 int accept_connection(struct client_state * csp, jb_socket fd)
622 struct sockaddr_in client, server;
623 struct hostent *host = NULL;
625 #if defined(_WIN32) || defined(__OS2__) || defined(__APPLE_CC__)
626 /* Wierdness - fix a warning. */
627 int c_length, s_length;
629 size_t c_length, s_length;
631 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS) || defined(HAVE_GETHOSTBYADDR_R_7_ARGS) || defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
632 struct hostent result;
633 #if defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
634 struct hostent_data hdata;
636 char hbuf[HOSTENT_BUFFER_SIZE];
638 #endif /* def HAVE_GETHOSTBYADDR_R_5_ARGS */
639 #endif /* def HAVE_GETHOSTBYADDR_R_(8|7|5)_ARGS */
641 c_length = s_length = sizeof(client);
644 afd = accept (fd, (struct sockaddr *) &client, &c_length);
645 if (afd == JB_INVALID_SOCKET)
652 afd = accept (fd, (struct sockaddr *) &client, &c_length);
653 } while (afd < 1 && errno == EINTR);
661 * Determine the IP-Adress that the client used to reach us
662 * and the hostname associated with that address
664 if (!getsockname(afd, (struct sockaddr *) &server, &s_length))
666 csp->my_ip_addr_str = strdup(inet_ntoa(server.sin_addr));
667 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS)
668 gethostbyaddr_r((const char *)&server.sin_addr,
669 sizeof(server.sin_addr), AF_INET,
670 &result, hbuf, HOSTENT_BUFFER_SIZE,
672 #elif defined(HAVE_GETHOSTBYADDR_R_7_ARGS)
673 host = gethostbyaddr_r((const char *)&server.sin_addr,
674 sizeof(server.sin_addr), AF_INET,
675 &result, hbuf, HOSTENT_BUFFER_SIZE, &thd_err);
676 #elif defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
677 if (0 == gethostbyaddr_r((const char *)&server.sin_addr,
678 sizeof(server.sin_addr), AF_INET,
688 host = gethostbyaddr((const char *)&server.sin_addr,
689 sizeof(server.sin_addr), AF_INET);
693 log_error(LOG_LEVEL_ERROR, "Unable to get my own hostname: %E\n");
697 csp->my_hostname = strdup(host->h_name);
702 csp->ip_addr_str = strdup(inet_ntoa(client.sin_addr));
703 csp->ip_addr_long = ntohl(client.sin_addr.s_addr);
710 /*********************************************************************
712 * Function : resolve_hostname_to_ip
714 * Description : Resolve a hostname to an internet tcp/ip address.
715 * NULL or an empty string resolve to INADDR_ANY.
718 * 1 : host = hostname to resolve
720 * Returns : INADDR_NONE => failure, INADDR_ANY or tcp/ip address if succesful.
722 *********************************************************************/
723 unsigned long resolve_hostname_to_ip(const char *host)
725 struct sockaddr_in inaddr;
726 struct hostent *hostp;
727 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS) || defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
728 struct hostent result;
729 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
730 char hbuf[HOSTENT_BUFFER_SIZE];
732 #else /* defined(HAVE_GETHOSTBYNAME_R_3_ARGS) */
733 struct hostent_data hdata;
734 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5)_ARGS */
735 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
737 if ((host == NULL) || (*host == '\0'))
742 memset((char *) &inaddr, 0, sizeof inaddr);
744 if ((inaddr.sin_addr.s_addr = inet_addr(host)) == -1)
746 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS)
747 gethostbyname_r(host, &result, hbuf,
748 HOSTENT_BUFFER_SIZE, &hostp, &thd_err);
749 #elif defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
750 hostp = gethostbyname_r(host, &result, hbuf,
751 HOSTENT_BUFFER_SIZE, &thd_err);
752 #elif defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
753 if (0 == gethostbyname_r(host, &result, &hdata))
762 hostp = gethostbyname(host);
763 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
767 log_error(LOG_LEVEL_ERROR, "could not resolve hostname %s", host);
770 if (hostp->h_addrtype != AF_INET)
773 errno = WSAEPROTOTYPE;
777 log_error(LOG_LEVEL_ERROR, "hostname %s resolves to unknown address type.", host);
781 (char *) &inaddr.sin_addr,
782 (char *) hostp->h_addr,
783 sizeof(inaddr.sin_addr)
786 return(inaddr.sin_addr.s_addr);