1 const char jbsockets_rcs[] = "$Id: jbsockets.c,v 1.34 2002/04/08 20:31:41 swa 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.34 2002/04/08 20:31:41 swa
41 * Revision 1.33 2002/04/03 16:02:18 gliptak
42 * Correcting compile warning with older gcc
44 * Revision 1.32 2002/03/31 17:18:59 jongfoster
45 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
47 * Revision 1.31 2002/03/29 03:33:13 david__schmidt
48 * Fix Mac OSX compiler warnings
50 * Revision 1.30 2002/03/27 14:32:43 david__schmidt
51 * More compiler warning message maintenance
53 * Revision 1.29 2002/03/26 22:29:54 swa
54 * we have a new homepage!
56 * Revision 1.28 2002/03/24 13:25:43 swa
57 * name change related issues
59 * Revision 1.27 2002/03/13 00:27:05 jongfoster
62 * Revision 1.26 2002/03/11 22:07:02 david__schmidt
63 * OS/2 port maintenance:
64 * - Fixed EMX build - it had decayed a little
65 * - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
66 * substituted a memset for now.
68 * Revision 1.25 2002/03/09 20:03:52 jongfoster
69 * - Making various functions return int rather than size_t.
70 * (Undoing a recent change). Since size_t is unsigned on
71 * Windows, functions like read_socket that return -1 on
72 * error cannot return a size_t.
74 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
75 * crashes, and also frequently caused JB to jump to 100%
76 * CPU and stay there. (Because it thought it had just
77 * read ((unsigned)-1) == 4Gb of data...)
79 * - The signature of write_socket has changed, it now simply
80 * returns success=0/failure=nonzero.
82 * - Trying to get rid of a few warnings --with-debug on
83 * Windows, I've introduced a new type "jb_socket". This is
84 * used for the socket file descriptors. On Windows, this
85 * is SOCKET (a typedef for unsigned). Everywhere else, it's
86 * an int. The error value can't be -1 any more, so it's
87 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
88 * Windows it maps to the #define INVALID_SOCKET.)
90 * - The signature of bind_port has changed.
92 * Revision 1.24 2002/03/07 03:51:36 oes
93 * - Improved handling of failed DNS lookups
94 * - Fixed compiler warnings etc
96 * Revision 1.23 2002/03/05 00:36:01 jongfoster
97 * Fixing bug 514988 - unable to restart Junkbuster
99 * Revision 1.22 2002/03/04 02:08:02 david__schmidt
100 * Enable web editing of actions file on OS/2 (it had been broken all this time!)
102 * Revision 1.21 2002/01/09 14:32:33 oes
103 * Added support for gethostbyname_r and gethostbyaddr_r.
105 * Revision 1.20 2001/11/16 00:48:48 jongfoster
106 * Enabling duplicate-socket detection for all platforms, not
109 * Revision 1.19 2001/10/25 03:40:47 david__schmidt
110 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
111 * threads to call select() simultaneously. So, it's time to do a real, live,
112 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
113 * (native). Both versions will work, but using __OS2__ offers multi-threading.
115 * Revision 1.18 2001/09/21 23:02:02 david__schmidt
116 * Cleaning up 2 compiler warnings on OS/2.
118 * Revision 1.17 2001/09/13 20:11:46 jongfoster
119 * Fixing 2 compiler warnings under Win32
121 * Revision 1.16 2001/07/30 22:08:36 jongfoster
122 * Tidying up #defines:
123 * - All feature #defines are now of the form FEATURE_xxx
124 * - Permanently turned off WIN_GUI_EDIT
125 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
127 * Revision 1.15 2001/07/29 17:40:43 jongfoster
128 * Fixed compiler warning by adding a cast
130 * Revision 1.14 2001/07/18 13:47:59 oes
131 * Eliminated dirty hack for getsockbyname()
133 * Revision 1.13 2001/07/15 13:56:57 jongfoster
134 * Removing unused local variable.
136 * Revision 1.12 2001/07/01 17:04:11 oes
137 * Bugfix: accept_connection no longer uses the obsolete hstrerror() function
139 * Revision 1.11 2001/06/29 21:45:41 oes
140 * Indentation, CRLF->LF, Tab-> Space
142 * Revision 1.10 2001/06/29 13:29:15 oes
143 * - Added remote (server) host IP to csp->http->host_ip_addr_str
144 * - Added detection of local socket IP and fqdn
145 * - Removed logentry from cancelled commit
147 * Revision 1.9 2001/06/07 23:06:09 jongfoster
148 * The host parameter to connect_to() is now const.
150 * Revision 1.8 2001/06/03 19:12:07 oes
153 * Revision 1.7 2001/05/28 16:14:00 jongfoster
154 * Fixing bug in LOG_LEVEL_LOG
156 * Revision 1.6 2001/05/26 17:28:32 jongfoster
157 * Fixed LOG_LEVEL_LOG
159 * Revision 1.5 2001/05/26 15:26:15 jongfoster
160 * ACL feature now provides more security by immediately dropping
161 * connections from untrusted hosts.
163 * Revision 1.4 2001/05/26 00:37:42 jongfoster
164 * Cosmetic indentation correction.
166 * Revision 1.3 2001/05/25 21:57:54 jongfoster
167 * Now gives a warning under Windows if you try to bind
168 * it to a port that's already in use.
170 * Revision 1.2 2001/05/17 23:01:01 oes
171 * - Cleaned CRLF's from the sources and related files
173 * Revision 1.1.1.1 2001/05/15 13:58:54 oes
174 * Initial import of version 2.9.3 source tree
177 *********************************************************************/
187 #include <sys/types.h>
195 #include <sys/timeb.h>
203 #include <sys/time.h>
204 #include <netinet/in.h>
205 #include <sys/ioctl.h>
207 #include <sys/socket.h>
210 #include <netinet/tcp.h>
212 #include <arpa/inet.h>
218 #if defined(__EMX__) || defined (__OS2__)
219 #include <sys/select.h> /* OS/2/EMX needs a little help with select */
228 #include "jbsockets.h"
232 const char jbsockets_h_rcs[] = JBSOCKETS_H_VERSION;
235 /*********************************************************************
237 * Function : connect_to
239 * Description : Open a socket and connect to it. Will check
240 * that this is allowed according to ACL.
243 * 1 : host = hostname to connect to
244 * 2 : portnum = port to connent on
245 * 3 : csp = Current client state (buffers, headers, etc...)
246 * Not modified, only used for source IP and ACL.
248 * Returns : JB_INVALID_SOCKET => failure, else it is the socket
251 *********************************************************************/
252 jb_socket connect_to(const char *host, int portnum, struct client_state *csp)
254 struct sockaddr_in inaddr;
258 struct timeval tv[1];
259 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA)
261 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
264 struct access_control_addr dst[1];
265 #endif /* def FEATURE_ACL */
267 memset((char *)&inaddr, 0, sizeof inaddr);
269 if ((addr = resolve_hostname_to_ip(host)) == INADDR_NONE)
271 csp->http->host_ip_addr_str = strdup("unknown");
272 return(JB_INVALID_SOCKET);
276 dst->addr = ntohl((unsigned long) addr);
279 if (block_acl(dst, csp))
286 return(JB_INVALID_SOCKET);
288 #endif /* def FEATURE_ACL */
290 inaddr.sin_addr.s_addr = addr;
291 inaddr.sin_family = AF_INET;
292 csp->http->host_ip_addr_str = strdup(inet_ntoa(inaddr.sin_addr));
295 if (sizeof(inaddr.sin_port) == sizeof(short))
296 #endif /* ndef _WIN32 */
298 inaddr.sin_port = htons((unsigned short) portnum);
303 inaddr.sin_port = htonl((unsigned long)portnum);
305 #endif /* ndef _WIN32 */
308 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) == JB_INVALID_SOCKET)
310 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) < 0)
313 return(JB_INVALID_SOCKET);
317 { /* turn off TCP coalescence */
319 setsockopt (fd, IPPROTO_TCP, TCP_NODELAY, (char *) &mi, sizeof (int));
321 #endif /* def TCP_NODELAY */
323 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
324 if ((flags = fcntl(fd, F_GETFL, 0)) != -1)
327 fcntl(fd, F_SETFL, flags);
329 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
331 while (connect(fd, (struct sockaddr *) & inaddr, sizeof inaddr) == JB_INVALID_SOCKET)
334 if (errno == WSAEINPROGRESS)
336 if (sock_errno() == EINPROGRESS)
337 #else /* ifndef _WIN32 */
338 if (errno == EINPROGRESS)
339 #endif /* ndef _WIN32 || __OS2__ */
345 if (sock_errno() != EINTR)
351 return(JB_INVALID_SOCKET);
355 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
359 fcntl(fd, F_SETFL, flags);
361 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
363 /* wait for connection to complete */
370 /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Wierd! */
371 if (select((int)fd + 1, NULL, &wfds, NULL, tv) <= 0)
374 return(JB_INVALID_SOCKET);
381 /*********************************************************************
383 * Function : write_socket
385 * Description : Write the contents of buf (for n bytes) to socket fd.
388 * 1 : fd = file descriptor (aka. handle) of socket to write to.
389 * 2 : buf = pointer to data to be written.
390 * 3 : len = length of data to be written to the socket "fd".
392 * Returns : 0 on success (entire buffer sent).
395 *********************************************************************/
396 int write_socket(jb_socket fd, const char *buf, size_t len)
408 log_error(LOG_LEVEL_LOG, "%N", len, buf);
411 return (send(fd, buf, (int)len, 0) != (int)len);
412 #elif defined(__BEOS__) || defined(AMIGA)
413 return (send(fd, buf, len, 0) != len);
414 #elif defined(__OS2__)
416 * Break the data up into SOCKET_SEND_MAX chunks for sending...
417 * OS/2 seemed to complain when the chunks were too large.
419 #define SOCKET_SEND_MAX 65000
421 int write_len = 0, send_len, send_rc = 0, i = 0;
422 while ((i < len) && (send_rc != -1))
424 if ((i + SOCKET_SEND_MAX) > len)
427 send_len = SOCKET_SEND_MAX;
428 send_rc = send(fd,(char*)buf + i, send_len, 0);
436 return (write(fd, buf, len) != len);
442 /*********************************************************************
444 * Function : read_socket
446 * Description : Read from a TCP/IP socket in a platform independent way.
449 * 1 : fd = file descriptor of the socket to read
450 * 2 : buf = pointer to buffer where data will be written
451 * Must be >= len bytes long.
452 * 3 : len = maximum number of bytes to read
454 * Returns : On success, the number of bytes read is returned (zero
455 * indicates end of file), and the file position is advanced
456 * by this number. It is not an error if this number is
457 * smaller than the number of bytes requested; this may hap-
458 * pen for example because fewer bytes are actually available
459 * right now (maybe because we were close to end-of-file, or
460 * because we are reading from a pipe, or from a terminal,
461 * or because read() was interrupted by a signal). On error,
462 * -1 is returned, and errno is set appropriately. In this
463 * case it is left unspecified whether the file position (if
466 *********************************************************************/
467 int read_socket(jb_socket fd, char *buf, int len)
475 return(recv(fd, buf, len, 0));
476 #elif defined(__BEOS__) || defined(AMIGA) || defined(__OS2__)
477 return(recv(fd, buf, (size_t)len, 0));
479 return(read(fd, buf, (size_t)len));
484 /*********************************************************************
486 * Function : close_socket
488 * Description : Closes a TCP/IP socket
491 * 1 : fd = file descriptor of socket to be closed
495 *********************************************************************/
496 void close_socket(jb_socket fd)
498 #if defined(_WIN32) || defined(__BEOS__)
502 #elif defined(__OS2__)
511 /*********************************************************************
513 * Function : bind_port
515 * Description : Call socket, set socket options, and listen.
516 * Called by listen_loop to "boot up" our proxy address.
519 * 1 : hostnam = TCP/IP address to bind/listen to
520 * 2 : portnum = port to listen on
521 * 3 : pfd = pointer used to return file descriptor.
523 * Returns : if success, returns 0 and sets *pfd.
524 * if failure, returns -3 if address is in use,
525 * -2 if address unresolvable,
527 *********************************************************************/
528 int bind_port(const char *hostnam, int portnum, jb_socket *pfd)
530 struct sockaddr_in inaddr;
534 #endif /* ndef _WIN32 */
536 *pfd = JB_INVALID_SOCKET;
538 memset((char *)&inaddr, '\0', sizeof inaddr);
540 inaddr.sin_family = AF_INET;
541 inaddr.sin_addr.s_addr = resolve_hostname_to_ip(hostnam);
543 if (inaddr.sin_addr.s_addr == INADDR_NONE)
549 if (sizeof(inaddr.sin_port) == sizeof(short))
550 #endif /* ndef _WIN32 */
552 inaddr.sin_port = htons((unsigned short) portnum);
557 inaddr.sin_port = htonl((unsigned long) portnum);
559 #endif /* ndef _WIN32 */
561 fd = socket(AF_INET, SOCK_STREAM, 0);
564 if (fd == JB_INVALID_SOCKET)
574 * This is not needed for Win32 - in fact, it stops
575 * duplicate instances of Junkbuster from being caught.
577 * On UNIX, we assume the user is sensible enough not
578 * to start Junkbuster multiple times on the same IP.
579 * Without this, stopping and restarting Junkbuster
580 * from a script fails.
581 * Note: SO_REUSEADDR is meant to only take over
582 * sockets which are *not* in listen state in Linux,
583 * e.g. sockets in TIME_WAIT. YMMV.
585 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (char *)&one, sizeof(one));
586 #endif /* ndef _WIN32 */
588 if (bind (fd, (struct sockaddr *)&inaddr, sizeof(inaddr)) < 0)
592 if (errno == WSAEADDRINUSE)
594 if (errno == EADDRINUSE)
605 while (listen(fd, 5) == -1)
619 /*********************************************************************
621 * Function : accept_connection
623 * Description : Accepts a connection on a socket. Socket must have
624 * been created using bind_port().
627 * 1 : csp = Client state, cfd, ip_addr_str, and
628 * ip_addr_long will be set by this routine.
629 * 2 : fd = file descriptor returned from bind_port
631 * Returns : when a connection is accepted, it returns 1 (TRUE).
632 * On an error it returns 0 (FALSE).
634 *********************************************************************/
635 int accept_connection(struct client_state * csp, jb_socket fd)
637 struct sockaddr_in client, server;
638 struct hostent *host = NULL;
640 #if defined(_WIN32) || defined(__OS2__) || defined(__APPLE_CC__) || defined(AMIGA)
641 /* Wierdness - fix a warning. */
642 int c_length, s_length;
644 socklen_t c_length, s_length;
646 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS) || defined(HAVE_GETHOSTBYADDR_R_7_ARGS) || defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
647 struct hostent result;
648 #if defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
649 struct hostent_data hdata;
651 char hbuf[HOSTENT_BUFFER_SIZE];
653 #endif /* def HAVE_GETHOSTBYADDR_R_5_ARGS */
654 #endif /* def HAVE_GETHOSTBYADDR_R_(8|7|5)_ARGS */
656 c_length = s_length = sizeof(client);
659 afd = accept (fd, (struct sockaddr *) &client, &c_length);
660 if (afd == JB_INVALID_SOCKET)
667 afd = accept (fd, (struct sockaddr *) &client, &c_length);
668 } while (afd < 1 && errno == EINTR);
676 * Determine the IP-Adress that the client used to reach us
677 * and the hostname associated with that address
679 if (!getsockname(afd, (struct sockaddr *) &server, &s_length))
681 csp->my_ip_addr_str = strdup(inet_ntoa(server.sin_addr));
682 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS)
683 gethostbyaddr_r((const char *)&server.sin_addr,
684 sizeof(server.sin_addr), AF_INET,
685 &result, hbuf, HOSTENT_BUFFER_SIZE,
687 #elif defined(HAVE_GETHOSTBYADDR_R_7_ARGS)
688 host = gethostbyaddr_r((const char *)&server.sin_addr,
689 sizeof(server.sin_addr), AF_INET,
690 &result, hbuf, HOSTENT_BUFFER_SIZE, &thd_err);
691 #elif defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
692 if (0 == gethostbyaddr_r((const char *)&server.sin_addr,
693 sizeof(server.sin_addr), AF_INET,
703 host = gethostbyaddr((const char *)&server.sin_addr,
704 sizeof(server.sin_addr), AF_INET);
708 log_error(LOG_LEVEL_ERROR, "Unable to get my own hostname: %E\n");
712 csp->my_hostname = strdup(host->h_name);
717 csp->ip_addr_str = strdup(inet_ntoa(client.sin_addr));
718 csp->ip_addr_long = ntohl(client.sin_addr.s_addr);
725 /*********************************************************************
727 * Function : resolve_hostname_to_ip
729 * Description : Resolve a hostname to an internet tcp/ip address.
730 * NULL or an empty string resolve to INADDR_ANY.
733 * 1 : host = hostname to resolve
735 * Returns : INADDR_NONE => failure, INADDR_ANY or tcp/ip address if succesful.
737 *********************************************************************/
738 unsigned long resolve_hostname_to_ip(const char *host)
740 struct sockaddr_in inaddr;
741 struct hostent *hostp;
742 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS) || defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
743 struct hostent result;
744 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
745 char hbuf[HOSTENT_BUFFER_SIZE];
747 #else /* defined(HAVE_GETHOSTBYNAME_R_3_ARGS) */
748 struct hostent_data hdata;
749 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5)_ARGS */
750 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
752 if ((host == NULL) || (*host == '\0'))
757 memset((char *) &inaddr, 0, sizeof inaddr);
759 if ((inaddr.sin_addr.s_addr = inet_addr(host)) == -1)
761 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS)
762 gethostbyname_r(host, &result, hbuf,
763 HOSTENT_BUFFER_SIZE, &hostp, &thd_err);
764 #elif defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
765 hostp = gethostbyname_r(host, &result, hbuf,
766 HOSTENT_BUFFER_SIZE, &thd_err);
767 #elif defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
768 if (0 == gethostbyname_r(host, &result, &hdata))
777 hostp = gethostbyname(host);
778 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
782 log_error(LOG_LEVEL_ERROR, "could not resolve hostname %s", host);
785 if (hostp->h_addrtype != AF_INET)
788 errno = WSAEPROTOTYPE;
792 log_error(LOG_LEVEL_ERROR, "hostname %s resolves to unknown address type.", host);
796 (char *) &inaddr.sin_addr,
797 (char *) hostp->h_addr,
798 sizeof(inaddr.sin_addr)
801 return(inaddr.sin_addr.s_addr);