1 const char jbsockets_rcs[] = "$Id: jbsockets.c,v 1.28 2002/03/24 13:25:43 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.28 2002/03/24 13:25:43 swa
39 * name change related issues
41 * Revision 1.27 2002/03/13 00:27:05 jongfoster
44 * Revision 1.26 2002/03/11 22:07:02 david__schmidt
45 * OS/2 port maintenance:
46 * - Fixed EMX build - it had decayed a little
47 * - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
48 * substituted a memset for now.
50 * Revision 1.25 2002/03/09 20:03:52 jongfoster
51 * - Making various functions return int rather than size_t.
52 * (Undoing a recent change). Since size_t is unsigned on
53 * Windows, functions like read_socket that return -1 on
54 * error cannot return a size_t.
56 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
57 * crashes, and also frequently caused JB to jump to 100%
58 * CPU and stay there. (Because it thought it had just
59 * read ((unsigned)-1) == 4Gb of data...)
61 * - The signature of write_socket has changed, it now simply
62 * returns success=0/failure=nonzero.
64 * - Trying to get rid of a few warnings --with-debug on
65 * Windows, I've introduced a new type "jb_socket". This is
66 * used for the socket file descriptors. On Windows, this
67 * is SOCKET (a typedef for unsigned). Everywhere else, it's
68 * an int. The error value can't be -1 any more, so it's
69 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
70 * Windows it maps to the #define INVALID_SOCKET.)
72 * - The signature of bind_port has changed.
74 * Revision 1.24 2002/03/07 03:51:36 oes
75 * - Improved handling of failed DNS lookups
76 * - Fixed compiler warnings etc
78 * Revision 1.23 2002/03/05 00:36:01 jongfoster
79 * Fixing bug 514988 - unable to restart JunkBuster
81 * Revision 1.22 2002/03/04 02:08:02 david__schmidt
82 * Enable web editing of actions file on OS/2 (it had been broken all this time!)
84 * Revision 1.21 2002/01/09 14:32:33 oes
85 * Added support for gethostbyname_r and gethostbyaddr_r.
87 * Revision 1.20 2001/11/16 00:48:48 jongfoster
88 * Enabling duplicate-socket detection for all platforms, not
91 * Revision 1.19 2001/10/25 03:40:47 david__schmidt
92 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
93 * threads to call select() simultaneously. So, it's time to do a real, live,
94 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
95 * (native). Both versions will work, but using __OS2__ offers multi-threading.
97 * Revision 1.18 2001/09/21 23:02:02 david__schmidt
98 * Cleaning up 2 compiler warnings on OS/2.
100 * Revision 1.17 2001/09/13 20:11:46 jongfoster
101 * Fixing 2 compiler warnings under Win32
103 * Revision 1.16 2001/07/30 22:08:36 jongfoster
104 * Tidying up #defines:
105 * - All feature #defines are now of the form FEATURE_xxx
106 * - Permanently turned off WIN_GUI_EDIT
107 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
109 * Revision 1.15 2001/07/29 17:40:43 jongfoster
110 * Fixed compiler warning by adding a cast
112 * Revision 1.14 2001/07/18 13:47:59 oes
113 * Eliminated dirty hack for getsockbyname()
115 * Revision 1.13 2001/07/15 13:56:57 jongfoster
116 * Removing unused local variable.
118 * Revision 1.12 2001/07/01 17:04:11 oes
119 * Bugfix: accept_connection no longer uses the obsolete hstrerror() function
121 * Revision 1.11 2001/06/29 21:45:41 oes
122 * Indentation, CRLF->LF, Tab-> Space
124 * Revision 1.10 2001/06/29 13:29:15 oes
125 * - Added remote (server) host IP to csp->http->host_ip_addr_str
126 * - Added detection of local socket IP and fqdn
127 * - Removed logentry from cancelled commit
129 * Revision 1.9 2001/06/07 23:06:09 jongfoster
130 * The host parameter to connect_to() is now const.
132 * Revision 1.8 2001/06/03 19:12:07 oes
135 * Revision 1.7 2001/05/28 16:14:00 jongfoster
136 * Fixing bug in LOG_LEVEL_LOG
138 * Revision 1.6 2001/05/26 17:28:32 jongfoster
139 * Fixed LOG_LEVEL_LOG
141 * Revision 1.5 2001/05/26 15:26:15 jongfoster
142 * ACL feature now provides more security by immediately dropping
143 * connections from untrusted hosts.
145 * Revision 1.4 2001/05/26 00:37:42 jongfoster
146 * Cosmetic indentation correction.
148 * Revision 1.3 2001/05/25 21:57:54 jongfoster
149 * Now gives a warning under Windows if you try to bind
150 * it to a port that's already in use.
152 * Revision 1.2 2001/05/17 23:01:01 oes
153 * - Cleaned CRLF's from the sources and related files
155 * Revision 1.1.1.1 2001/05/15 13:58:54 oes
156 * Initial import of version 2.9.3 source tree
159 *********************************************************************/
169 #include <sys/types.h>
174 #include <sys/timeb.h>
182 #include <sys/time.h>
183 #include <netinet/in.h>
184 #include <sys/ioctl.h>
186 #include <sys/socket.h>
189 #include <netinet/tcp.h>
191 #include <arpa/inet.h>
197 #if defined(__EMX__) || defined (__OS2__)
198 #include <sys/select.h> /* OS/2/EMX needs a little help with select */
207 #include "jbsockets.h"
211 const char jbsockets_h_rcs[] = JBSOCKETS_H_VERSION;
214 /*********************************************************************
216 * Function : connect_to
218 * Description : Open a socket and connect to it. Will check
219 * that this is allowed according to ACL.
222 * 1 : host = hostname to connect to
223 * 2 : portnum = port to connent on
224 * 3 : csp = Current client state (buffers, headers, etc...)
225 * Not modified, only used for source IP and ACL.
227 * Returns : JB_INVALID_SOCKET => failure, else it is the socket
230 *********************************************************************/
231 jb_socket connect_to(const char *host, int portnum, struct client_state *csp)
233 struct sockaddr_in inaddr;
237 struct timeval tv[1];
238 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA)
240 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
243 struct access_control_addr dst[1];
244 #endif /* def FEATURE_ACL */
246 memset((char *)&inaddr, 0, sizeof inaddr);
248 if ((addr = resolve_hostname_to_ip(host)) == INADDR_NONE)
250 csp->http->host_ip_addr_str = strdup("unknown");
251 return(JB_INVALID_SOCKET);
255 dst->addr = ntohl((unsigned long) addr);
258 if (block_acl(dst, csp))
265 return(JB_INVALID_SOCKET);
267 #endif /* def FEATURE_ACL */
269 inaddr.sin_addr.s_addr = addr;
270 inaddr.sin_family = AF_INET;
271 csp->http->host_ip_addr_str = strdup(inet_ntoa(inaddr.sin_addr));
274 if (sizeof(inaddr.sin_port) == sizeof(short))
275 #endif /* ndef _WIN32 */
277 inaddr.sin_port = htons((unsigned short) portnum);
282 inaddr.sin_port = htonl((unsigned long)portnum);
284 #endif /* ndef _WIN32 */
287 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) == JB_INVALID_SOCKET)
289 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) < 0)
292 return(JB_INVALID_SOCKET);
296 { /* turn off TCP coalescence */
298 setsockopt (fd, IPPROTO_TCP, TCP_NODELAY, (char *) &mi, sizeof (int));
300 #endif /* def TCP_NODELAY */
302 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
303 if ((flags = fcntl(fd, F_GETFL, 0)) != -1)
306 fcntl(fd, F_SETFL, flags);
308 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
310 while (connect(fd, (struct sockaddr *) & inaddr, sizeof inaddr) == JB_INVALID_SOCKET)
313 if (errno == WSAEINPROGRESS)
315 if (sock_errno() == EINPROGRESS)
316 #else /* ifndef _WIN32 */
317 if (errno == EINPROGRESS)
318 #endif /* ndef _WIN32 || __OS2__ */
324 if (sock_errno() != EINTR)
330 return(JB_INVALID_SOCKET);
334 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
338 fcntl(fd, F_SETFL, flags);
340 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
342 /* wait for connection to complete */
349 /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Wierd! */
350 if (select((int)fd + 1, NULL, &wfds, NULL, tv) <= 0)
353 return(JB_INVALID_SOCKET);
360 /*********************************************************************
362 * Function : write_socket
364 * Description : Write the contents of buf (for n bytes) to socket fd.
367 * 1 : fd = file descriptor (aka. handle) of socket to write to.
368 * 2 : buf = pointer to data to be written.
369 * 3 : len = length of data to be written to the socket "fd".
371 * Returns : 0 on success (entire buffer sent).
374 *********************************************************************/
375 int write_socket(jb_socket fd, const char *buf, size_t len)
387 log_error(LOG_LEVEL_LOG, "%N", len, buf);
390 return (send(fd, buf, (int)len, 0) != (int)len);
391 #elif defined(__BEOS__) || defined(AMIGA)
392 return (send(fd, buf, len, 0) != len);
393 #elif defined(__OS2__)
395 * Break the data up into SOCKET_SEND_MAX chunks for sending...
396 * OS/2 seemed to complain when the chunks were too large.
398 #define SOCKET_SEND_MAX 65000
400 int write_len = 0, send_len, send_rc = 0, i = 0;
401 while ((i < len) && (send_rc != -1))
403 if ((i + SOCKET_SEND_MAX) > len)
406 send_len = SOCKET_SEND_MAX;
407 send_rc = send(fd,(char*)buf + i, send_len, 0);
415 return (write(fd, buf, len) != len);
421 /*********************************************************************
423 * Function : read_socket
425 * Description : Read from a TCP/IP socket in a platform independent way.
428 * 1 : fd = file descriptor of the socket to read
429 * 2 : buf = pointer to buffer where data will be written
430 * Must be >= len bytes long.
431 * 3 : len = maximum number of bytes to read
433 * Returns : On success, the number of bytes read is returned (zero
434 * indicates end of file), and the file position is advanced
435 * by this number. It is not an error if this number is
436 * smaller than the number of bytes requested; this may hap-
437 * pen for example because fewer bytes are actually available
438 * right now (maybe because we were close to end-of-file, or
439 * because we are reading from a pipe, or from a terminal,
440 * or because read() was interrupted by a signal). On error,
441 * -1 is returned, and errno is set appropriately. In this
442 * case it is left unspecified whether the file position (if
445 *********************************************************************/
446 int read_socket(jb_socket fd, char *buf, int len)
454 return(recv(fd, buf, len, 0));
455 #elif defined(__BEOS__) || defined(AMIGA) || defined(__OS2__)
456 return(recv(fd, buf, (size_t)len, 0));
458 return(read(fd, buf, (size_t)len));
463 /*********************************************************************
465 * Function : close_socket
467 * Description : Closes a TCP/IP socket
470 * 1 : fd = file descriptor of socket to be closed
474 *********************************************************************/
475 void close_socket(jb_socket fd)
477 #if defined(_WIN32) || defined(__BEOS__)
481 #elif defined(__OS2__)
490 /*********************************************************************
492 * Function : bind_port
494 * Description : Call socket, set socket options, and listen.
495 * Called by listen_loop to "boot up" our proxy address.
498 * 1 : hostnam = TCP/IP address to bind/listen to
499 * 2 : portnum = port to listen on
500 * 3 : pfd = pointer used to return file descriptor.
502 * Returns : if success, returns 0 and sets *pfd.
503 * if failure, returns -3 if address is in use,
504 * -2 if address unresolvable,
506 *********************************************************************/
507 int bind_port(const char *hostnam, int portnum, jb_socket *pfd)
509 struct sockaddr_in inaddr;
513 #endif /* ndef _WIN32 */
515 *pfd = JB_INVALID_SOCKET;
517 memset((char *)&inaddr, '\0', sizeof inaddr);
519 inaddr.sin_family = AF_INET;
520 inaddr.sin_addr.s_addr = resolve_hostname_to_ip(hostnam);
522 if (inaddr.sin_addr.s_addr == INADDR_NONE)
528 if (sizeof(inaddr.sin_port) == sizeof(short))
529 #endif /* ndef _WIN32 */
531 inaddr.sin_port = htons((unsigned short) portnum);
536 inaddr.sin_port = htonl((unsigned long) portnum);
538 #endif /* ndef _WIN32 */
540 fd = socket(AF_INET, SOCK_STREAM, 0);
543 if (fd == JB_INVALID_SOCKET)
553 * This is not needed for Win32 - in fact, it stops
554 * duplicate instances of JunkBuster from being caught.
556 * On UNIX, we assume the user is sensible enough not
557 * to start JunkBuster multiple times on the same IP.
558 * Without this, stopping and restarting JunkBuster
559 * from a script fails.
560 * Note: SO_REUSEADDR is meant to only take over
561 * sockets which are *not* in listen state in Linux,
562 * e.g. sockets in TIME_WAIT. YMMV.
564 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (char *)&one, sizeof(one));
565 #endif /* ndef _WIN32 */
567 if (bind (fd, (struct sockaddr *)&inaddr, sizeof(inaddr)) < 0)
571 if (errno == WSAEADDRINUSE)
573 if (errno == EADDRINUSE)
584 while (listen(fd, 5) == -1)
598 /*********************************************************************
600 * Function : accept_connection
602 * Description : Accepts a connection on a socket. Socket must have
603 * been created using bind_port().
606 * 1 : csp = Client state, cfd, ip_addr_str, and
607 * ip_addr_long will be set by this routine.
608 * 2 : fd = file descriptor returned from bind_port
610 * Returns : when a connection is accepted, it returns 1 (TRUE).
611 * On an error it returns 0 (FALSE).
613 *********************************************************************/
614 int accept_connection(struct client_state * csp, jb_socket fd)
616 struct sockaddr_in client, server;
617 struct hostent *host = NULL;
620 /* Microsoft wierdness - fix a warning. */
621 int c_length, s_length;
623 size_t c_length, s_length;
625 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS) || defined(HAVE_GETHOSTBYADDR_R_7_ARGS) || defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
626 struct hostent result;
627 #if defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
628 struct hostent_data hdata;
630 char hbuf[HOSTENT_BUFFER_SIZE];
632 #endif /* def HAVE_GETHOSTBYADDR_R_5_ARGS */
633 #endif /* def HAVE_GETHOSTBYADDR_R_(8|7|5)_ARGS */
635 c_length = s_length = sizeof(client);
638 afd = accept (fd, (struct sockaddr *) &client, &c_length);
639 if (afd == JB_INVALID_SOCKET)
646 afd = accept (fd, (struct sockaddr *) &client, &c_length);
647 } while (afd < 1 && errno == EINTR);
655 * Determine the IP-Adress that the client used to reach us
656 * and the hostname associated with that address
658 if (!getsockname(afd, (struct sockaddr *) &server, &s_length))
660 csp->my_ip_addr_str = strdup(inet_ntoa(server.sin_addr));
661 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS)
662 gethostbyaddr_r((const char *)&server.sin_addr,
663 sizeof(server.sin_addr), AF_INET,
664 &result, hbuf, HOSTENT_BUFFER_SIZE,
666 #elif defined(HAVE_GETHOSTBYADDR_R_7_ARGS)
667 host = gethostbyaddr_r((const char *)&server.sin_addr,
668 sizeof(server.sin_addr), AF_INET,
669 &result, hbuf, HOSTENT_BUFFER_SIZE, &thd_err);
670 #elif defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
671 if (0 == gethostbyaddr_r((const char *)&server.sin_addr,
672 sizeof(server.sin_addr), AF_INET,
682 host = gethostbyaddr((const char *)&server.sin_addr,
683 sizeof(server.sin_addr), AF_INET);
687 log_error(LOG_LEVEL_ERROR, "Unable to get my own hostname: %E\n");
691 csp->my_hostname = strdup(host->h_name);
696 csp->ip_addr_str = strdup(inet_ntoa(client.sin_addr));
697 csp->ip_addr_long = ntohl(client.sin_addr.s_addr);
704 /*********************************************************************
706 * Function : resolve_hostname_to_ip
708 * Description : Resolve a hostname to an internet tcp/ip address.
709 * NULL or an empty string resolve to INADDR_ANY.
712 * 1 : host = hostname to resolve
714 * Returns : INADDR_NONE => failure, INADDR_ANY or tcp/ip address if succesful.
716 *********************************************************************/
717 unsigned long resolve_hostname_to_ip(const char *host)
719 struct sockaddr_in inaddr;
720 struct hostent *hostp;
721 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS) || defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
722 struct hostent result;
723 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
724 char hbuf[HOSTENT_BUFFER_SIZE];
726 #else /* defined(HAVE_GETHOSTBYNAME_R_3_ARGS) */
727 struct hostent_data hdata;
728 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5)_ARGS */
729 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
731 if ((host == NULL) || (*host == '\0'))
736 memset((char *) &inaddr, 0, sizeof inaddr);
738 if ((inaddr.sin_addr.s_addr = inet_addr(host)) == -1)
740 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS)
741 gethostbyname_r(host, &result, hbuf,
742 HOSTENT_BUFFER_SIZE, &hostp, &thd_err);
743 #elif defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
744 hostp = gethostbyname_r(host, &result, hbuf,
745 HOSTENT_BUFFER_SIZE, &thd_err);
746 #elif defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
747 if (0 == gethostbyname_r(host, &result, &hdata))
756 hostp = gethostbyname(host);
757 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
761 log_error(LOG_LEVEL_ERROR, "could not resolve hostname %s", host);
764 if (hostp->h_addrtype != AF_INET)
767 errno = WSAEPROTOTYPE;
771 log_error(LOG_LEVEL_ERROR, "hostname %s resolves to unknown address type.", host);
775 (char *) &inaddr.sin_addr,
776 (char *) hostp->h_addr,
777 sizeof(inaddr.sin_addr)
780 return(inaddr.sin_addr.s_addr);