1 const char jbsockets_rcs[] = "$Id: jbsockets.c,v 1.32 2002/03/31 17:18:59 jongfoster 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.32 2002/03/31 17:18:59 jongfoster
39 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
41 * Revision 1.31 2002/03/29 03:33:13 david__schmidt
42 * Fix Mac OSX compiler warnings
44 * Revision 1.30 2002/03/27 14:32:43 david__schmidt
45 * More compiler warning message maintenance
47 * Revision 1.29 2002/03/26 22:29:54 swa
48 * we have a new homepage!
50 * Revision 1.28 2002/03/24 13:25:43 swa
51 * name change related issues
53 * Revision 1.27 2002/03/13 00:27:05 jongfoster
56 * Revision 1.26 2002/03/11 22:07:02 david__schmidt
57 * OS/2 port maintenance:
58 * - Fixed EMX build - it had decayed a little
59 * - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
60 * substituted a memset for now.
62 * Revision 1.25 2002/03/09 20:03:52 jongfoster
63 * - Making various functions return int rather than size_t.
64 * (Undoing a recent change). Since size_t is unsigned on
65 * Windows, functions like read_socket that return -1 on
66 * error cannot return a size_t.
68 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
69 * crashes, and also frequently caused JB to jump to 100%
70 * CPU and stay there. (Because it thought it had just
71 * read ((unsigned)-1) == 4Gb of data...)
73 * - The signature of write_socket has changed, it now simply
74 * returns success=0/failure=nonzero.
76 * - Trying to get rid of a few warnings --with-debug on
77 * Windows, I've introduced a new type "jb_socket". This is
78 * used for the socket file descriptors. On Windows, this
79 * is SOCKET (a typedef for unsigned). Everywhere else, it's
80 * an int. The error value can't be -1 any more, so it's
81 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
82 * Windows it maps to the #define INVALID_SOCKET.)
84 * - The signature of bind_port has changed.
86 * Revision 1.24 2002/03/07 03:51:36 oes
87 * - Improved handling of failed DNS lookups
88 * - Fixed compiler warnings etc
90 * Revision 1.23 2002/03/05 00:36:01 jongfoster
91 * Fixing bug 514988 - unable to restart JunkBuster
93 * Revision 1.22 2002/03/04 02:08:02 david__schmidt
94 * Enable web editing of actions file on OS/2 (it had been broken all this time!)
96 * Revision 1.21 2002/01/09 14:32:33 oes
97 * Added support for gethostbyname_r and gethostbyaddr_r.
99 * Revision 1.20 2001/11/16 00:48:48 jongfoster
100 * Enabling duplicate-socket detection for all platforms, not
103 * Revision 1.19 2001/10/25 03:40:47 david__schmidt
104 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
105 * threads to call select() simultaneously. So, it's time to do a real, live,
106 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
107 * (native). Both versions will work, but using __OS2__ offers multi-threading.
109 * Revision 1.18 2001/09/21 23:02:02 david__schmidt
110 * Cleaning up 2 compiler warnings on OS/2.
112 * Revision 1.17 2001/09/13 20:11:46 jongfoster
113 * Fixing 2 compiler warnings under Win32
115 * Revision 1.16 2001/07/30 22:08:36 jongfoster
116 * Tidying up #defines:
117 * - All feature #defines are now of the form FEATURE_xxx
118 * - Permanently turned off WIN_GUI_EDIT
119 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
121 * Revision 1.15 2001/07/29 17:40:43 jongfoster
122 * Fixed compiler warning by adding a cast
124 * Revision 1.14 2001/07/18 13:47:59 oes
125 * Eliminated dirty hack for getsockbyname()
127 * Revision 1.13 2001/07/15 13:56:57 jongfoster
128 * Removing unused local variable.
130 * Revision 1.12 2001/07/01 17:04:11 oes
131 * Bugfix: accept_connection no longer uses the obsolete hstrerror() function
133 * Revision 1.11 2001/06/29 21:45:41 oes
134 * Indentation, CRLF->LF, Tab-> Space
136 * Revision 1.10 2001/06/29 13:29:15 oes
137 * - Added remote (server) host IP to csp->http->host_ip_addr_str
138 * - Added detection of local socket IP and fqdn
139 * - Removed logentry from cancelled commit
141 * Revision 1.9 2001/06/07 23:06:09 jongfoster
142 * The host parameter to connect_to() is now const.
144 * Revision 1.8 2001/06/03 19:12:07 oes
147 * Revision 1.7 2001/05/28 16:14:00 jongfoster
148 * Fixing bug in LOG_LEVEL_LOG
150 * Revision 1.6 2001/05/26 17:28:32 jongfoster
151 * Fixed LOG_LEVEL_LOG
153 * Revision 1.5 2001/05/26 15:26:15 jongfoster
154 * ACL feature now provides more security by immediately dropping
155 * connections from untrusted hosts.
157 * Revision 1.4 2001/05/26 00:37:42 jongfoster
158 * Cosmetic indentation correction.
160 * Revision 1.3 2001/05/25 21:57:54 jongfoster
161 * Now gives a warning under Windows if you try to bind
162 * it to a port that's already in use.
164 * Revision 1.2 2001/05/17 23:01:01 oes
165 * - Cleaned CRLF's from the sources and related files
167 * Revision 1.1.1.1 2001/05/15 13:58:54 oes
168 * Initial import of version 2.9.3 source tree
171 *********************************************************************/
181 #include <sys/types.h>
189 #include <sys/timeb.h>
197 #include <sys/time.h>
198 #include <netinet/in.h>
199 #include <sys/ioctl.h>
201 #include <sys/socket.h>
204 #include <netinet/tcp.h>
206 #include <arpa/inet.h>
212 #if defined(__EMX__) || defined (__OS2__)
213 #include <sys/select.h> /* OS/2/EMX needs a little help with select */
222 #include "jbsockets.h"
226 const char jbsockets_h_rcs[] = JBSOCKETS_H_VERSION;
229 /*********************************************************************
231 * Function : connect_to
233 * Description : Open a socket and connect to it. Will check
234 * that this is allowed according to ACL.
237 * 1 : host = hostname to connect to
238 * 2 : portnum = port to connent on
239 * 3 : csp = Current client state (buffers, headers, etc...)
240 * Not modified, only used for source IP and ACL.
242 * Returns : JB_INVALID_SOCKET => failure, else it is the socket
245 *********************************************************************/
246 jb_socket connect_to(const char *host, int portnum, struct client_state *csp)
248 struct sockaddr_in inaddr;
252 struct timeval tv[1];
253 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA)
255 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
258 struct access_control_addr dst[1];
259 #endif /* def FEATURE_ACL */
261 memset((char *)&inaddr, 0, sizeof inaddr);
263 if ((addr = resolve_hostname_to_ip(host)) == INADDR_NONE)
265 csp->http->host_ip_addr_str = strdup("unknown");
266 return(JB_INVALID_SOCKET);
270 dst->addr = ntohl((unsigned long) addr);
273 if (block_acl(dst, csp))
280 return(JB_INVALID_SOCKET);
282 #endif /* def FEATURE_ACL */
284 inaddr.sin_addr.s_addr = addr;
285 inaddr.sin_family = AF_INET;
286 csp->http->host_ip_addr_str = strdup(inet_ntoa(inaddr.sin_addr));
289 if (sizeof(inaddr.sin_port) == sizeof(short))
290 #endif /* ndef _WIN32 */
292 inaddr.sin_port = htons((unsigned short) portnum);
297 inaddr.sin_port = htonl((unsigned long)portnum);
299 #endif /* ndef _WIN32 */
302 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) == JB_INVALID_SOCKET)
304 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) < 0)
307 return(JB_INVALID_SOCKET);
311 { /* turn off TCP coalescence */
313 setsockopt (fd, IPPROTO_TCP, TCP_NODELAY, (char *) &mi, sizeof (int));
315 #endif /* def TCP_NODELAY */
317 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
318 if ((flags = fcntl(fd, F_GETFL, 0)) != -1)
321 fcntl(fd, F_SETFL, flags);
323 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
325 while (connect(fd, (struct sockaddr *) & inaddr, sizeof inaddr) == JB_INVALID_SOCKET)
328 if (errno == WSAEINPROGRESS)
330 if (sock_errno() == EINPROGRESS)
331 #else /* ifndef _WIN32 */
332 if (errno == EINPROGRESS)
333 #endif /* ndef _WIN32 || __OS2__ */
339 if (sock_errno() != EINTR)
345 return(JB_INVALID_SOCKET);
349 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
353 fcntl(fd, F_SETFL, flags);
355 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
357 /* wait for connection to complete */
364 /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Wierd! */
365 if (select((int)fd + 1, NULL, &wfds, NULL, tv) <= 0)
368 return(JB_INVALID_SOCKET);
375 /*********************************************************************
377 * Function : write_socket
379 * Description : Write the contents of buf (for n bytes) to socket fd.
382 * 1 : fd = file descriptor (aka. handle) of socket to write to.
383 * 2 : buf = pointer to data to be written.
384 * 3 : len = length of data to be written to the socket "fd".
386 * Returns : 0 on success (entire buffer sent).
389 *********************************************************************/
390 int write_socket(jb_socket fd, const char *buf, size_t len)
402 log_error(LOG_LEVEL_LOG, "%N", len, buf);
405 return (send(fd, buf, (int)len, 0) != (int)len);
406 #elif defined(__BEOS__) || defined(AMIGA)
407 return (send(fd, buf, len, 0) != len);
408 #elif defined(__OS2__)
410 * Break the data up into SOCKET_SEND_MAX chunks for sending...
411 * OS/2 seemed to complain when the chunks were too large.
413 #define SOCKET_SEND_MAX 65000
415 int write_len = 0, send_len, send_rc = 0, i = 0;
416 while ((i < len) && (send_rc != -1))
418 if ((i + SOCKET_SEND_MAX) > len)
421 send_len = SOCKET_SEND_MAX;
422 send_rc = send(fd,(char*)buf + i, send_len, 0);
430 return (write(fd, buf, len) != len);
436 /*********************************************************************
438 * Function : read_socket
440 * Description : Read from a TCP/IP socket in a platform independent way.
443 * 1 : fd = file descriptor of the socket to read
444 * 2 : buf = pointer to buffer where data will be written
445 * Must be >= len bytes long.
446 * 3 : len = maximum number of bytes to read
448 * Returns : On success, the number of bytes read is returned (zero
449 * indicates end of file), and the file position is advanced
450 * by this number. It is not an error if this number is
451 * smaller than the number of bytes requested; this may hap-
452 * pen for example because fewer bytes are actually available
453 * right now (maybe because we were close to end-of-file, or
454 * because we are reading from a pipe, or from a terminal,
455 * or because read() was interrupted by a signal). On error,
456 * -1 is returned, and errno is set appropriately. In this
457 * case it is left unspecified whether the file position (if
460 *********************************************************************/
461 int read_socket(jb_socket fd, char *buf, int len)
469 return(recv(fd, buf, len, 0));
470 #elif defined(__BEOS__) || defined(AMIGA) || defined(__OS2__)
471 return(recv(fd, buf, (size_t)len, 0));
473 return(read(fd, buf, (size_t)len));
478 /*********************************************************************
480 * Function : close_socket
482 * Description : Closes a TCP/IP socket
485 * 1 : fd = file descriptor of socket to be closed
489 *********************************************************************/
490 void close_socket(jb_socket fd)
492 #if defined(_WIN32) || defined(__BEOS__)
496 #elif defined(__OS2__)
505 /*********************************************************************
507 * Function : bind_port
509 * Description : Call socket, set socket options, and listen.
510 * Called by listen_loop to "boot up" our proxy address.
513 * 1 : hostnam = TCP/IP address to bind/listen to
514 * 2 : portnum = port to listen on
515 * 3 : pfd = pointer used to return file descriptor.
517 * Returns : if success, returns 0 and sets *pfd.
518 * if failure, returns -3 if address is in use,
519 * -2 if address unresolvable,
521 *********************************************************************/
522 int bind_port(const char *hostnam, int portnum, jb_socket *pfd)
524 struct sockaddr_in inaddr;
528 #endif /* ndef _WIN32 */
530 *pfd = JB_INVALID_SOCKET;
532 memset((char *)&inaddr, '\0', sizeof inaddr);
534 inaddr.sin_family = AF_INET;
535 inaddr.sin_addr.s_addr = resolve_hostname_to_ip(hostnam);
537 if (inaddr.sin_addr.s_addr == INADDR_NONE)
543 if (sizeof(inaddr.sin_port) == sizeof(short))
544 #endif /* ndef _WIN32 */
546 inaddr.sin_port = htons((unsigned short) portnum);
551 inaddr.sin_port = htonl((unsigned long) portnum);
553 #endif /* ndef _WIN32 */
555 fd = socket(AF_INET, SOCK_STREAM, 0);
558 if (fd == JB_INVALID_SOCKET)
568 * This is not needed for Win32 - in fact, it stops
569 * duplicate instances of JunkBuster from being caught.
571 * On UNIX, we assume the user is sensible enough not
572 * to start JunkBuster multiple times on the same IP.
573 * Without this, stopping and restarting JunkBuster
574 * from a script fails.
575 * Note: SO_REUSEADDR is meant to only take over
576 * sockets which are *not* in listen state in Linux,
577 * e.g. sockets in TIME_WAIT. YMMV.
579 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (char *)&one, sizeof(one));
580 #endif /* ndef _WIN32 */
582 if (bind (fd, (struct sockaddr *)&inaddr, sizeof(inaddr)) < 0)
586 if (errno == WSAEADDRINUSE)
588 if (errno == EADDRINUSE)
599 while (listen(fd, 5) == -1)
613 /*********************************************************************
615 * Function : accept_connection
617 * Description : Accepts a connection on a socket. Socket must have
618 * been created using bind_port().
621 * 1 : csp = Client state, cfd, ip_addr_str, and
622 * ip_addr_long will be set by this routine.
623 * 2 : fd = file descriptor returned from bind_port
625 * Returns : when a connection is accepted, it returns 1 (TRUE).
626 * On an error it returns 0 (FALSE).
628 *********************************************************************/
629 int accept_connection(struct client_state * csp, jb_socket fd)
631 struct sockaddr_in client, server;
632 struct hostent *host = NULL;
634 #if defined(_WIN32) || defined(__OS2__) || defined(__APPLE_CC__)
635 /* Wierdness - fix a warning. */
636 int c_length, s_length;
638 socklen_t c_length, s_length;
640 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS) || defined(HAVE_GETHOSTBYADDR_R_7_ARGS) || defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
641 struct hostent result;
642 #if defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
643 struct hostent_data hdata;
645 char hbuf[HOSTENT_BUFFER_SIZE];
647 #endif /* def HAVE_GETHOSTBYADDR_R_5_ARGS */
648 #endif /* def HAVE_GETHOSTBYADDR_R_(8|7|5)_ARGS */
650 c_length = s_length = sizeof(client);
653 afd = accept (fd, (struct sockaddr *) &client, &c_length);
654 if (afd == JB_INVALID_SOCKET)
661 afd = accept (fd, (struct sockaddr *) &client, &c_length);
662 } while (afd < 1 && errno == EINTR);
670 * Determine the IP-Adress that the client used to reach us
671 * and the hostname associated with that address
673 if (!getsockname(afd, (struct sockaddr *) &server, &s_length))
675 csp->my_ip_addr_str = strdup(inet_ntoa(server.sin_addr));
676 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS)
677 gethostbyaddr_r((const char *)&server.sin_addr,
678 sizeof(server.sin_addr), AF_INET,
679 &result, hbuf, HOSTENT_BUFFER_SIZE,
681 #elif defined(HAVE_GETHOSTBYADDR_R_7_ARGS)
682 host = gethostbyaddr_r((const char *)&server.sin_addr,
683 sizeof(server.sin_addr), AF_INET,
684 &result, hbuf, HOSTENT_BUFFER_SIZE, &thd_err);
685 #elif defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
686 if (0 == gethostbyaddr_r((const char *)&server.sin_addr,
687 sizeof(server.sin_addr), AF_INET,
697 host = gethostbyaddr((const char *)&server.sin_addr,
698 sizeof(server.sin_addr), AF_INET);
702 log_error(LOG_LEVEL_ERROR, "Unable to get my own hostname: %E\n");
706 csp->my_hostname = strdup(host->h_name);
711 csp->ip_addr_str = strdup(inet_ntoa(client.sin_addr));
712 csp->ip_addr_long = ntohl(client.sin_addr.s_addr);
719 /*********************************************************************
721 * Function : resolve_hostname_to_ip
723 * Description : Resolve a hostname to an internet tcp/ip address.
724 * NULL or an empty string resolve to INADDR_ANY.
727 * 1 : host = hostname to resolve
729 * Returns : INADDR_NONE => failure, INADDR_ANY or tcp/ip address if succesful.
731 *********************************************************************/
732 unsigned long resolve_hostname_to_ip(const char *host)
734 struct sockaddr_in inaddr;
735 struct hostent *hostp;
736 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS) || defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
737 struct hostent result;
738 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
739 char hbuf[HOSTENT_BUFFER_SIZE];
741 #else /* defined(HAVE_GETHOSTBYNAME_R_3_ARGS) */
742 struct hostent_data hdata;
743 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5)_ARGS */
744 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
746 if ((host == NULL) || (*host == '\0'))
751 memset((char *) &inaddr, 0, sizeof inaddr);
753 if ((inaddr.sin_addr.s_addr = inet_addr(host)) == -1)
755 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS)
756 gethostbyname_r(host, &result, hbuf,
757 HOSTENT_BUFFER_SIZE, &hostp, &thd_err);
758 #elif defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
759 hostp = gethostbyname_r(host, &result, hbuf,
760 HOSTENT_BUFFER_SIZE, &thd_err);
761 #elif defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
762 if (0 == gethostbyname_r(host, &result, &hdata))
771 hostp = gethostbyname(host);
772 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
776 log_error(LOG_LEVEL_ERROR, "could not resolve hostname %s", host);
779 if (hostp->h_addrtype != AF_INET)
782 errno = WSAEPROTOTYPE;
786 log_error(LOG_LEVEL_ERROR, "hostname %s resolves to unknown address type.", host);
790 (char *) &inaddr.sin_addr,
791 (char *) hostp->h_addr,
792 sizeof(inaddr.sin_addr)
795 return(inaddr.sin_addr.s_addr);