1 const char jbsockets_rcs[] = "$Id: jbsockets.c,v 1.31 2002/03/29 03:33:13 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.31 2002/03/29 03:33:13 david__schmidt
39 * Fix Mac OSX compiler warnings
41 * Revision 1.30 2002/03/27 14:32:43 david__schmidt
42 * More compiler warning message maintenance
44 * Revision 1.29 2002/03/26 22:29:54 swa
45 * we have a new homepage!
47 * Revision 1.28 2002/03/24 13:25:43 swa
48 * name change related issues
50 * Revision 1.27 2002/03/13 00:27:05 jongfoster
53 * Revision 1.26 2002/03/11 22:07:02 david__schmidt
54 * OS/2 port maintenance:
55 * - Fixed EMX build - it had decayed a little
56 * - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
57 * substituted a memset for now.
59 * Revision 1.25 2002/03/09 20:03:52 jongfoster
60 * - Making various functions return int rather than size_t.
61 * (Undoing a recent change). Since size_t is unsigned on
62 * Windows, functions like read_socket that return -1 on
63 * error cannot return a size_t.
65 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
66 * crashes, and also frequently caused JB to jump to 100%
67 * CPU and stay there. (Because it thought it had just
68 * read ((unsigned)-1) == 4Gb of data...)
70 * - The signature of write_socket has changed, it now simply
71 * returns success=0/failure=nonzero.
73 * - Trying to get rid of a few warnings --with-debug on
74 * Windows, I've introduced a new type "jb_socket". This is
75 * used for the socket file descriptors. On Windows, this
76 * is SOCKET (a typedef for unsigned). Everywhere else, it's
77 * an int. The error value can't be -1 any more, so it's
78 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
79 * Windows it maps to the #define INVALID_SOCKET.)
81 * - The signature of bind_port has changed.
83 * Revision 1.24 2002/03/07 03:51:36 oes
84 * - Improved handling of failed DNS lookups
85 * - Fixed compiler warnings etc
87 * Revision 1.23 2002/03/05 00:36:01 jongfoster
88 * Fixing bug 514988 - unable to restart JunkBuster
90 * Revision 1.22 2002/03/04 02:08:02 david__schmidt
91 * Enable web editing of actions file on OS/2 (it had been broken all this time!)
93 * Revision 1.21 2002/01/09 14:32:33 oes
94 * Added support for gethostbyname_r and gethostbyaddr_r.
96 * Revision 1.20 2001/11/16 00:48:48 jongfoster
97 * Enabling duplicate-socket detection for all platforms, not
100 * Revision 1.19 2001/10/25 03:40:47 david__schmidt
101 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
102 * threads to call select() simultaneously. So, it's time to do a real, live,
103 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
104 * (native). Both versions will work, but using __OS2__ offers multi-threading.
106 * Revision 1.18 2001/09/21 23:02:02 david__schmidt
107 * Cleaning up 2 compiler warnings on OS/2.
109 * Revision 1.17 2001/09/13 20:11:46 jongfoster
110 * Fixing 2 compiler warnings under Win32
112 * Revision 1.16 2001/07/30 22:08:36 jongfoster
113 * Tidying up #defines:
114 * - All feature #defines are now of the form FEATURE_xxx
115 * - Permanently turned off WIN_GUI_EDIT
116 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
118 * Revision 1.15 2001/07/29 17:40:43 jongfoster
119 * Fixed compiler warning by adding a cast
121 * Revision 1.14 2001/07/18 13:47:59 oes
122 * Eliminated dirty hack for getsockbyname()
124 * Revision 1.13 2001/07/15 13:56:57 jongfoster
125 * Removing unused local variable.
127 * Revision 1.12 2001/07/01 17:04:11 oes
128 * Bugfix: accept_connection no longer uses the obsolete hstrerror() function
130 * Revision 1.11 2001/06/29 21:45:41 oes
131 * Indentation, CRLF->LF, Tab-> Space
133 * Revision 1.10 2001/06/29 13:29:15 oes
134 * - Added remote (server) host IP to csp->http->host_ip_addr_str
135 * - Added detection of local socket IP and fqdn
136 * - Removed logentry from cancelled commit
138 * Revision 1.9 2001/06/07 23:06:09 jongfoster
139 * The host parameter to connect_to() is now const.
141 * Revision 1.8 2001/06/03 19:12:07 oes
144 * Revision 1.7 2001/05/28 16:14:00 jongfoster
145 * Fixing bug in LOG_LEVEL_LOG
147 * Revision 1.6 2001/05/26 17:28:32 jongfoster
148 * Fixed LOG_LEVEL_LOG
150 * Revision 1.5 2001/05/26 15:26:15 jongfoster
151 * ACL feature now provides more security by immediately dropping
152 * connections from untrusted hosts.
154 * Revision 1.4 2001/05/26 00:37:42 jongfoster
155 * Cosmetic indentation correction.
157 * Revision 1.3 2001/05/25 21:57:54 jongfoster
158 * Now gives a warning under Windows if you try to bind
159 * it to a port that's already in use.
161 * Revision 1.2 2001/05/17 23:01:01 oes
162 * - Cleaned CRLF's from the sources and related files
164 * Revision 1.1.1.1 2001/05/15 13:58:54 oes
165 * Initial import of version 2.9.3 source tree
168 *********************************************************************/
178 #include <sys/types.h>
186 #include <sys/timeb.h>
194 #include <sys/time.h>
195 #include <netinet/in.h>
196 #include <sys/ioctl.h>
198 #include <sys/socket.h>
201 #include <netinet/tcp.h>
203 #include <arpa/inet.h>
209 #if defined(__EMX__) || defined (__OS2__)
210 #include <sys/select.h> /* OS/2/EMX needs a little help with select */
219 #include "jbsockets.h"
223 const char jbsockets_h_rcs[] = JBSOCKETS_H_VERSION;
226 /*********************************************************************
228 * Function : connect_to
230 * Description : Open a socket and connect to it. Will check
231 * that this is allowed according to ACL.
234 * 1 : host = hostname to connect to
235 * 2 : portnum = port to connent on
236 * 3 : csp = Current client state (buffers, headers, etc...)
237 * Not modified, only used for source IP and ACL.
239 * Returns : JB_INVALID_SOCKET => failure, else it is the socket
242 *********************************************************************/
243 jb_socket connect_to(const char *host, int portnum, struct client_state *csp)
245 struct sockaddr_in inaddr;
249 struct timeval tv[1];
250 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA)
252 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
255 struct access_control_addr dst[1];
256 #endif /* def FEATURE_ACL */
258 memset((char *)&inaddr, 0, sizeof inaddr);
260 if ((addr = resolve_hostname_to_ip(host)) == INADDR_NONE)
262 csp->http->host_ip_addr_str = strdup("unknown");
263 return(JB_INVALID_SOCKET);
267 dst->addr = ntohl((unsigned long) addr);
270 if (block_acl(dst, csp))
277 return(JB_INVALID_SOCKET);
279 #endif /* def FEATURE_ACL */
281 inaddr.sin_addr.s_addr = addr;
282 inaddr.sin_family = AF_INET;
283 csp->http->host_ip_addr_str = strdup(inet_ntoa(inaddr.sin_addr));
286 if (sizeof(inaddr.sin_port) == sizeof(short))
287 #endif /* ndef _WIN32 */
289 inaddr.sin_port = htons((unsigned short) portnum);
294 inaddr.sin_port = htonl((unsigned long)portnum);
296 #endif /* ndef _WIN32 */
299 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) == JB_INVALID_SOCKET)
301 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) < 0)
304 return(JB_INVALID_SOCKET);
308 { /* turn off TCP coalescence */
310 setsockopt (fd, IPPROTO_TCP, TCP_NODELAY, (char *) &mi, sizeof (int));
312 #endif /* def TCP_NODELAY */
314 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
315 if ((flags = fcntl(fd, F_GETFL, 0)) != -1)
318 fcntl(fd, F_SETFL, flags);
320 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
322 while (connect(fd, (struct sockaddr *) & inaddr, sizeof inaddr) == JB_INVALID_SOCKET)
325 if (errno == WSAEINPROGRESS)
327 if (sock_errno() == EINPROGRESS)
328 #else /* ifndef _WIN32 */
329 if (errno == EINPROGRESS)
330 #endif /* ndef _WIN32 || __OS2__ */
336 if (sock_errno() != EINTR)
342 return(JB_INVALID_SOCKET);
346 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
350 fcntl(fd, F_SETFL, flags);
352 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
354 /* wait for connection to complete */
361 /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Wierd! */
362 if (select((int)fd + 1, NULL, &wfds, NULL, tv) <= 0)
365 return(JB_INVALID_SOCKET);
372 /*********************************************************************
374 * Function : write_socket
376 * Description : Write the contents of buf (for n bytes) to socket fd.
379 * 1 : fd = file descriptor (aka. handle) of socket to write to.
380 * 2 : buf = pointer to data to be written.
381 * 3 : len = length of data to be written to the socket "fd".
383 * Returns : 0 on success (entire buffer sent).
386 *********************************************************************/
387 int write_socket(jb_socket fd, const char *buf, size_t len)
399 log_error(LOG_LEVEL_LOG, "%N", len, buf);
402 return (send(fd, buf, (int)len, 0) != (int)len);
403 #elif defined(__BEOS__) || defined(AMIGA)
404 return (send(fd, buf, len, 0) != len);
405 #elif defined(__OS2__)
407 * Break the data up into SOCKET_SEND_MAX chunks for sending...
408 * OS/2 seemed to complain when the chunks were too large.
410 #define SOCKET_SEND_MAX 65000
412 int write_len = 0, send_len, send_rc = 0, i = 0;
413 while ((i < len) && (send_rc != -1))
415 if ((i + SOCKET_SEND_MAX) > len)
418 send_len = SOCKET_SEND_MAX;
419 send_rc = send(fd,(char*)buf + i, send_len, 0);
427 return (write(fd, buf, len) != len);
433 /*********************************************************************
435 * Function : read_socket
437 * Description : Read from a TCP/IP socket in a platform independent way.
440 * 1 : fd = file descriptor of the socket to read
441 * 2 : buf = pointer to buffer where data will be written
442 * Must be >= len bytes long.
443 * 3 : len = maximum number of bytes to read
445 * Returns : On success, the number of bytes read is returned (zero
446 * indicates end of file), and the file position is advanced
447 * by this number. It is not an error if this number is
448 * smaller than the number of bytes requested; this may hap-
449 * pen for example because fewer bytes are actually available
450 * right now (maybe because we were close to end-of-file, or
451 * because we are reading from a pipe, or from a terminal,
452 * or because read() was interrupted by a signal). On error,
453 * -1 is returned, and errno is set appropriately. In this
454 * case it is left unspecified whether the file position (if
457 *********************************************************************/
458 int read_socket(jb_socket fd, char *buf, int len)
466 return(recv(fd, buf, len, 0));
467 #elif defined(__BEOS__) || defined(AMIGA) || defined(__OS2__)
468 return(recv(fd, buf, (size_t)len, 0));
470 return(read(fd, buf, (size_t)len));
475 /*********************************************************************
477 * Function : close_socket
479 * Description : Closes a TCP/IP socket
482 * 1 : fd = file descriptor of socket to be closed
486 *********************************************************************/
487 void close_socket(jb_socket fd)
489 #if defined(_WIN32) || defined(__BEOS__)
493 #elif defined(__OS2__)
502 /*********************************************************************
504 * Function : bind_port
506 * Description : Call socket, set socket options, and listen.
507 * Called by listen_loop to "boot up" our proxy address.
510 * 1 : hostnam = TCP/IP address to bind/listen to
511 * 2 : portnum = port to listen on
512 * 3 : pfd = pointer used to return file descriptor.
514 * Returns : if success, returns 0 and sets *pfd.
515 * if failure, returns -3 if address is in use,
516 * -2 if address unresolvable,
518 *********************************************************************/
519 int bind_port(const char *hostnam, int portnum, jb_socket *pfd)
521 struct sockaddr_in inaddr;
525 #endif /* ndef _WIN32 */
527 *pfd = JB_INVALID_SOCKET;
529 memset((char *)&inaddr, '\0', sizeof inaddr);
531 inaddr.sin_family = AF_INET;
532 inaddr.sin_addr.s_addr = resolve_hostname_to_ip(hostnam);
534 if (inaddr.sin_addr.s_addr == INADDR_NONE)
540 if (sizeof(inaddr.sin_port) == sizeof(short))
541 #endif /* ndef _WIN32 */
543 inaddr.sin_port = htons((unsigned short) portnum);
548 inaddr.sin_port = htonl((unsigned long) portnum);
550 #endif /* ndef _WIN32 */
552 fd = socket(AF_INET, SOCK_STREAM, 0);
555 if (fd == JB_INVALID_SOCKET)
565 * This is not needed for Win32 - in fact, it stops
566 * duplicate instances of JunkBuster from being caught.
568 * On UNIX, we assume the user is sensible enough not
569 * to start JunkBuster multiple times on the same IP.
570 * Without this, stopping and restarting JunkBuster
571 * from a script fails.
572 * Note: SO_REUSEADDR is meant to only take over
573 * sockets which are *not* in listen state in Linux,
574 * e.g. sockets in TIME_WAIT. YMMV.
576 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (char *)&one, sizeof(one));
577 #endif /* ndef _WIN32 */
579 if (bind (fd, (struct sockaddr *)&inaddr, sizeof(inaddr)) < 0)
583 if (errno == WSAEADDRINUSE)
585 if (errno == EADDRINUSE)
596 while (listen(fd, 5) == -1)
610 /*********************************************************************
612 * Function : accept_connection
614 * Description : Accepts a connection on a socket. Socket must have
615 * been created using bind_port().
618 * 1 : csp = Client state, cfd, ip_addr_str, and
619 * ip_addr_long will be set by this routine.
620 * 2 : fd = file descriptor returned from bind_port
622 * Returns : when a connection is accepted, it returns 1 (TRUE).
623 * On an error it returns 0 (FALSE).
625 *********************************************************************/
626 int accept_connection(struct client_state * csp, jb_socket fd)
628 struct sockaddr_in client, server;
629 struct hostent *host = NULL;
631 #if defined(_WIN32) || defined(__OS2__) || defined(__APPLE_CC__)
632 /* Wierdness - fix a warning. */
633 int c_length, s_length;
635 size_t c_length, s_length;
637 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS) || defined(HAVE_GETHOSTBYADDR_R_7_ARGS) || defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
638 struct hostent result;
639 #if defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
640 struct hostent_data hdata;
642 char hbuf[HOSTENT_BUFFER_SIZE];
644 #endif /* def HAVE_GETHOSTBYADDR_R_5_ARGS */
645 #endif /* def HAVE_GETHOSTBYADDR_R_(8|7|5)_ARGS */
647 c_length = s_length = sizeof(client);
650 afd = accept (fd, (struct sockaddr *) &client, &c_length);
651 if (afd == JB_INVALID_SOCKET)
658 afd = accept (fd, (struct sockaddr *) &client, &c_length);
659 } while (afd < 1 && errno == EINTR);
667 * Determine the IP-Adress that the client used to reach us
668 * and the hostname associated with that address
670 if (!getsockname(afd, (struct sockaddr *) &server, &s_length))
672 csp->my_ip_addr_str = strdup(inet_ntoa(server.sin_addr));
673 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS)
674 gethostbyaddr_r((const char *)&server.sin_addr,
675 sizeof(server.sin_addr), AF_INET,
676 &result, hbuf, HOSTENT_BUFFER_SIZE,
678 #elif defined(HAVE_GETHOSTBYADDR_R_7_ARGS)
679 host = gethostbyaddr_r((const char *)&server.sin_addr,
680 sizeof(server.sin_addr), AF_INET,
681 &result, hbuf, HOSTENT_BUFFER_SIZE, &thd_err);
682 #elif defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
683 if (0 == gethostbyaddr_r((const char *)&server.sin_addr,
684 sizeof(server.sin_addr), AF_INET,
694 host = gethostbyaddr((const char *)&server.sin_addr,
695 sizeof(server.sin_addr), AF_INET);
699 log_error(LOG_LEVEL_ERROR, "Unable to get my own hostname: %E\n");
703 csp->my_hostname = strdup(host->h_name);
708 csp->ip_addr_str = strdup(inet_ntoa(client.sin_addr));
709 csp->ip_addr_long = ntohl(client.sin_addr.s_addr);
716 /*********************************************************************
718 * Function : resolve_hostname_to_ip
720 * Description : Resolve a hostname to an internet tcp/ip address.
721 * NULL or an empty string resolve to INADDR_ANY.
724 * 1 : host = hostname to resolve
726 * Returns : INADDR_NONE => failure, INADDR_ANY or tcp/ip address if succesful.
728 *********************************************************************/
729 unsigned long resolve_hostname_to_ip(const char *host)
731 struct sockaddr_in inaddr;
732 struct hostent *hostp;
733 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS) || defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
734 struct hostent result;
735 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
736 char hbuf[HOSTENT_BUFFER_SIZE];
738 #else /* defined(HAVE_GETHOSTBYNAME_R_3_ARGS) */
739 struct hostent_data hdata;
740 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5)_ARGS */
741 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
743 if ((host == NULL) || (*host == '\0'))
748 memset((char *) &inaddr, 0, sizeof inaddr);
750 if ((inaddr.sin_addr.s_addr = inet_addr(host)) == -1)
752 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS)
753 gethostbyname_r(host, &result, hbuf,
754 HOSTENT_BUFFER_SIZE, &hostp, &thd_err);
755 #elif defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
756 hostp = gethostbyname_r(host, &result, hbuf,
757 HOSTENT_BUFFER_SIZE, &thd_err);
758 #elif defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
759 if (0 == gethostbyname_r(host, &result, &hdata))
768 hostp = gethostbyname(host);
769 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
773 log_error(LOG_LEVEL_ERROR, "could not resolve hostname %s", host);
776 if (hostp->h_addrtype != AF_INET)
779 errno = WSAEPROTOTYPE;
783 log_error(LOG_LEVEL_ERROR, "hostname %s resolves to unknown address type.", host);
787 (char *) &inaddr.sin_addr,
788 (char *) hostp->h_addr,
789 sizeof(inaddr.sin_addr)
792 return(inaddr.sin_addr.s_addr);