1 const char jbsockets_rcs[] = "$Id: jbsockets.c,v 1.27 2002/03/13 00:27:05 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://ijbswa.sourceforge.net
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.27 2002/03/13 00:27:05 jongfoster
41 * Revision 1.26 2002/03/11 22:07:02 david__schmidt
42 * OS/2 port maintenance:
43 * - Fixed EMX build - it had decayed a little
44 * - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
45 * substituted a memset for now.
47 * Revision 1.25 2002/03/09 20:03:52 jongfoster
48 * - Making various functions return int rather than size_t.
49 * (Undoing a recent change). Since size_t is unsigned on
50 * Windows, functions like read_socket that return -1 on
51 * error cannot return a size_t.
53 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
54 * crashes, and also frequently caused JB to jump to 100%
55 * CPU and stay there. (Because it thought it had just
56 * read ((unsigned)-1) == 4Gb of data...)
58 * - The signature of write_socket has changed, it now simply
59 * returns success=0/failure=nonzero.
61 * - Trying to get rid of a few warnings --with-debug on
62 * Windows, I've introduced a new type "jb_socket". This is
63 * used for the socket file descriptors. On Windows, this
64 * is SOCKET (a typedef for unsigned). Everywhere else, it's
65 * an int. The error value can't be -1 any more, so it's
66 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
67 * Windows it maps to the #define INVALID_SOCKET.)
69 * - The signature of bind_port has changed.
71 * Revision 1.24 2002/03/07 03:51:36 oes
72 * - Improved handling of failed DNS lookups
73 * - Fixed compiler warnings etc
75 * Revision 1.23 2002/03/05 00:36:01 jongfoster
76 * Fixing bug 514988 - unable to restart JunkBuster
78 * Revision 1.22 2002/03/04 02:08:02 david__schmidt
79 * Enable web editing of actions file on OS/2 (it had been broken all this time!)
81 * Revision 1.21 2002/01/09 14:32:33 oes
82 * Added support for gethostbyname_r and gethostbyaddr_r.
84 * Revision 1.20 2001/11/16 00:48:48 jongfoster
85 * Enabling duplicate-socket detection for all platforms, not
88 * Revision 1.19 2001/10/25 03:40:47 david__schmidt
89 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
90 * threads to call select() simultaneously. So, it's time to do a real, live,
91 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
92 * (native). Both versions will work, but using __OS2__ offers multi-threading.
94 * Revision 1.18 2001/09/21 23:02:02 david__schmidt
95 * Cleaning up 2 compiler warnings on OS/2.
97 * Revision 1.17 2001/09/13 20:11:46 jongfoster
98 * Fixing 2 compiler warnings under Win32
100 * Revision 1.16 2001/07/30 22:08:36 jongfoster
101 * Tidying up #defines:
102 * - All feature #defines are now of the form FEATURE_xxx
103 * - Permanently turned off WIN_GUI_EDIT
104 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
106 * Revision 1.15 2001/07/29 17:40:43 jongfoster
107 * Fixed compiler warning by adding a cast
109 * Revision 1.14 2001/07/18 13:47:59 oes
110 * Eliminated dirty hack for getsockbyname()
112 * Revision 1.13 2001/07/15 13:56:57 jongfoster
113 * Removing unused local variable.
115 * Revision 1.12 2001/07/01 17:04:11 oes
116 * Bugfix: accept_connection no longer uses the obsolete hstrerror() function
118 * Revision 1.11 2001/06/29 21:45:41 oes
119 * Indentation, CRLF->LF, Tab-> Space
121 * Revision 1.10 2001/06/29 13:29:15 oes
122 * - Added remote (server) host IP to csp->http->host_ip_addr_str
123 * - Added detection of local socket IP and fqdn
124 * - Removed logentry from cancelled commit
126 * Revision 1.9 2001/06/07 23:06:09 jongfoster
127 * The host parameter to connect_to() is now const.
129 * Revision 1.8 2001/06/03 19:12:07 oes
132 * Revision 1.7 2001/05/28 16:14:00 jongfoster
133 * Fixing bug in LOG_LEVEL_LOG
135 * Revision 1.6 2001/05/26 17:28:32 jongfoster
136 * Fixed LOG_LEVEL_LOG
138 * Revision 1.5 2001/05/26 15:26:15 jongfoster
139 * ACL feature now provides more security by immediately dropping
140 * connections from untrusted hosts.
142 * Revision 1.4 2001/05/26 00:37:42 jongfoster
143 * Cosmetic indentation correction.
145 * Revision 1.3 2001/05/25 21:57:54 jongfoster
146 * Now gives a warning under Windows if you try to bind
147 * it to a port that's already in use.
149 * Revision 1.2 2001/05/17 23:01:01 oes
150 * - Cleaned CRLF's from the sources and related files
152 * Revision 1.1.1.1 2001/05/15 13:58:54 oes
153 * Initial import of version 2.9.3 source tree
156 *********************************************************************/
166 #include <sys/types.h>
171 #include <sys/timeb.h>
179 #include <sys/time.h>
180 #include <netinet/in.h>
181 #include <sys/ioctl.h>
183 #include <sys/socket.h>
186 #include <netinet/tcp.h>
188 #include <arpa/inet.h>
194 #if defined(__EMX__) || defined (__OS2__)
195 #include <sys/select.h> /* OS/2/EMX needs a little help with select */
204 #include "jbsockets.h"
208 const char jbsockets_h_rcs[] = JBSOCKETS_H_VERSION;
211 /*********************************************************************
213 * Function : connect_to
215 * Description : Open a socket and connect to it. Will check
216 * that this is allowed according to ACL.
219 * 1 : host = hostname to connect to
220 * 2 : portnum = port to connent on
221 * 3 : csp = Current client state (buffers, headers, etc...)
222 * Not modified, only used for source IP and ACL.
224 * Returns : JB_INVALID_SOCKET => failure, else it is the socket
227 *********************************************************************/
228 jb_socket connect_to(const char *host, int portnum, struct client_state *csp)
230 struct sockaddr_in inaddr;
234 struct timeval tv[1];
235 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA)
237 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
240 struct access_control_addr dst[1];
241 #endif /* def FEATURE_ACL */
243 memset((char *)&inaddr, 0, sizeof inaddr);
245 if ((addr = resolve_hostname_to_ip(host)) == INADDR_NONE)
247 csp->http->host_ip_addr_str = strdup("unknown");
248 return(JB_INVALID_SOCKET);
252 dst->addr = ntohl((unsigned long) addr);
255 if (block_acl(dst, csp))
262 return(JB_INVALID_SOCKET);
264 #endif /* def FEATURE_ACL */
266 inaddr.sin_addr.s_addr = addr;
267 inaddr.sin_family = AF_INET;
268 csp->http->host_ip_addr_str = strdup(inet_ntoa(inaddr.sin_addr));
271 if (sizeof(inaddr.sin_port) == sizeof(short))
272 #endif /* ndef _WIN32 */
274 inaddr.sin_port = htons((unsigned short) portnum);
279 inaddr.sin_port = htonl((unsigned long)portnum);
281 #endif /* ndef _WIN32 */
284 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) == JB_INVALID_SOCKET)
286 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) < 0)
289 return(JB_INVALID_SOCKET);
293 { /* turn off TCP coalescence */
295 setsockopt (fd, IPPROTO_TCP, TCP_NODELAY, (char *) &mi, sizeof (int));
297 #endif /* def TCP_NODELAY */
299 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
300 if ((flags = fcntl(fd, F_GETFL, 0)) != -1)
303 fcntl(fd, F_SETFL, flags);
305 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
307 while (connect(fd, (struct sockaddr *) & inaddr, sizeof inaddr) == JB_INVALID_SOCKET)
310 if (errno == WSAEINPROGRESS)
312 if (sock_errno() == EINPROGRESS)
313 #else /* ifndef _WIN32 */
314 if (errno == EINPROGRESS)
315 #endif /* ndef _WIN32 || __OS2__ */
321 if (sock_errno() != EINTR)
327 return(JB_INVALID_SOCKET);
331 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
335 fcntl(fd, F_SETFL, flags);
337 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
339 /* wait for connection to complete */
346 /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Wierd! */
347 if (select((int)fd + 1, NULL, &wfds, NULL, tv) <= 0)
350 return(JB_INVALID_SOCKET);
357 /*********************************************************************
359 * Function : write_socket
361 * Description : Write the contents of buf (for n bytes) to socket fd.
364 * 1 : fd = file descriptor (aka. handle) of socket to write to.
365 * 2 : buf = pointer to data to be written.
366 * 3 : len = length of data to be written to the socket "fd".
368 * Returns : 0 on success (entire buffer sent).
371 *********************************************************************/
372 int write_socket(jb_socket fd, const char *buf, size_t len)
384 log_error(LOG_LEVEL_LOG, "%N", len, buf);
387 return (send(fd, buf, (int)len, 0) != (int)len);
388 #elif defined(__BEOS__) || defined(AMIGA)
389 return (send(fd, buf, len, 0) != len);
390 #elif defined(__OS2__)
392 * Break the data up into SOCKET_SEND_MAX chunks for sending...
393 * OS/2 seemed to complain when the chunks were too large.
395 #define SOCKET_SEND_MAX 65000
397 int write_len = 0, send_len, send_rc = 0, i = 0;
398 while ((i < len) && (send_rc != -1))
400 if ((i + SOCKET_SEND_MAX) > len)
403 send_len = SOCKET_SEND_MAX;
404 send_rc = send(fd,(char*)buf + i, send_len, 0);
412 return (write(fd, buf, len) != len);
418 /*********************************************************************
420 * Function : read_socket
422 * Description : Read from a TCP/IP socket in a platform independent way.
425 * 1 : fd = file descriptor of the socket to read
426 * 2 : buf = pointer to buffer where data will be written
427 * Must be >= len bytes long.
428 * 3 : len = maximum number of bytes to read
430 * Returns : On success, the number of bytes read is returned (zero
431 * indicates end of file), and the file position is advanced
432 * by this number. It is not an error if this number is
433 * smaller than the number of bytes requested; this may hap-
434 * pen for example because fewer bytes are actually available
435 * right now (maybe because we were close to end-of-file, or
436 * because we are reading from a pipe, or from a terminal,
437 * or because read() was interrupted by a signal). On error,
438 * -1 is returned, and errno is set appropriately. In this
439 * case it is left unspecified whether the file position (if
442 *********************************************************************/
443 int read_socket(jb_socket fd, char *buf, int len)
451 return(recv(fd, buf, len, 0));
452 #elif defined(__BEOS__) || defined(AMIGA) || defined(__OS2__)
453 return(recv(fd, buf, (size_t)len, 0));
455 return(read(fd, buf, (size_t)len));
460 /*********************************************************************
462 * Function : close_socket
464 * Description : Closes a TCP/IP socket
467 * 1 : fd = file descriptor of socket to be closed
471 *********************************************************************/
472 void close_socket(jb_socket fd)
474 #if defined(_WIN32) || defined(__BEOS__)
478 #elif defined(__OS2__)
487 /*********************************************************************
489 * Function : bind_port
491 * Description : Call socket, set socket options, and listen.
492 * Called by listen_loop to "boot up" our proxy address.
495 * 1 : hostnam = TCP/IP address to bind/listen to
496 * 2 : portnum = port to listen on
497 * 3 : pfd = pointer used to return file descriptor.
499 * Returns : if success, returns 0 and sets *pfd.
500 * if failure, returns -3 if address is in use,
501 * -2 if address unresolvable,
503 *********************************************************************/
504 int bind_port(const char *hostnam, int portnum, jb_socket *pfd)
506 struct sockaddr_in inaddr;
510 #endif /* ndef _WIN32 */
512 *pfd = JB_INVALID_SOCKET;
514 memset((char *)&inaddr, '\0', sizeof inaddr);
516 inaddr.sin_family = AF_INET;
517 inaddr.sin_addr.s_addr = resolve_hostname_to_ip(hostnam);
519 if (inaddr.sin_addr.s_addr == INADDR_NONE)
525 if (sizeof(inaddr.sin_port) == sizeof(short))
526 #endif /* ndef _WIN32 */
528 inaddr.sin_port = htons((unsigned short) portnum);
533 inaddr.sin_port = htonl((unsigned long) portnum);
535 #endif /* ndef _WIN32 */
537 fd = socket(AF_INET, SOCK_STREAM, 0);
540 if (fd == JB_INVALID_SOCKET)
550 * This is not needed for Win32 - in fact, it stops
551 * duplicate instances of JunkBuster from being caught.
553 * On UNIX, we assume the user is sensible enough not
554 * to start JunkBuster multiple times on the same IP.
555 * Without this, stopping and restarting JunkBuster
556 * from a script fails.
557 * Note: SO_REUSEADDR is meant to only take over
558 * sockets which are *not* in listen state in Linux,
559 * e.g. sockets in TIME_WAIT. YMMV.
561 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (char *)&one, sizeof(one));
562 #endif /* ndef _WIN32 */
564 if (bind (fd, (struct sockaddr *)&inaddr, sizeof(inaddr)) < 0)
568 if (errno == WSAEADDRINUSE)
570 if (errno == EADDRINUSE)
581 while (listen(fd, 5) == -1)
595 /*********************************************************************
597 * Function : accept_connection
599 * Description : Accepts a connection on a socket. Socket must have
600 * been created using bind_port().
603 * 1 : csp = Client state, cfd, ip_addr_str, and
604 * ip_addr_long will be set by this routine.
605 * 2 : fd = file descriptor returned from bind_port
607 * Returns : when a connection is accepted, it returns 1 (TRUE).
608 * On an error it returns 0 (FALSE).
610 *********************************************************************/
611 int accept_connection(struct client_state * csp, jb_socket fd)
613 struct sockaddr_in client, server;
614 struct hostent *host = NULL;
617 /* Microsoft wierdness - fix a warning. */
618 int c_length, s_length;
620 size_t c_length, s_length;
622 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS) || defined(HAVE_GETHOSTBYADDR_R_7_ARGS) || defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
623 struct hostent result;
624 #if defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
625 struct hostent_data hdata;
627 char hbuf[HOSTENT_BUFFER_SIZE];
629 #endif /* def HAVE_GETHOSTBYADDR_R_5_ARGS */
630 #endif /* def HAVE_GETHOSTBYADDR_R_(8|7|5)_ARGS */
632 c_length = s_length = sizeof(client);
635 afd = accept (fd, (struct sockaddr *) &client, &c_length);
636 if (afd == JB_INVALID_SOCKET)
643 afd = accept (fd, (struct sockaddr *) &client, &c_length);
644 } while (afd < 1 && errno == EINTR);
652 * Determine the IP-Adress that the client used to reach us
653 * and the hostname associated with that address
655 if (!getsockname(afd, (struct sockaddr *) &server, &s_length))
657 csp->my_ip_addr_str = strdup(inet_ntoa(server.sin_addr));
658 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS)
659 gethostbyaddr_r((const char *)&server.sin_addr,
660 sizeof(server.sin_addr), AF_INET,
661 &result, hbuf, HOSTENT_BUFFER_SIZE,
663 #elif defined(HAVE_GETHOSTBYADDR_R_7_ARGS)
664 host = gethostbyaddr_r((const char *)&server.sin_addr,
665 sizeof(server.sin_addr), AF_INET,
666 &result, hbuf, HOSTENT_BUFFER_SIZE, &thd_err);
667 #elif defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
668 if (0 == gethostbyaddr_r((const char *)&server.sin_addr,
669 sizeof(server.sin_addr), AF_INET,
679 host = gethostbyaddr((const char *)&server.sin_addr,
680 sizeof(server.sin_addr), AF_INET);
684 log_error(LOG_LEVEL_ERROR, "Unable to get my own hostname: %E\n");
688 csp->my_hostname = strdup(host->h_name);
693 csp->ip_addr_str = strdup(inet_ntoa(client.sin_addr));
694 csp->ip_addr_long = ntohl(client.sin_addr.s_addr);
701 /*********************************************************************
703 * Function : resolve_hostname_to_ip
705 * Description : Resolve a hostname to an internet tcp/ip address.
706 * NULL or an empty string resolve to INADDR_ANY.
709 * 1 : host = hostname to resolve
711 * Returns : INADDR_NONE => failure, INADDR_ANY or tcp/ip address if succesful.
713 *********************************************************************/
714 unsigned long resolve_hostname_to_ip(const char *host)
716 struct sockaddr_in inaddr;
717 struct hostent *hostp;
718 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS) || defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
719 struct hostent result;
720 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
721 char hbuf[HOSTENT_BUFFER_SIZE];
723 #else /* defined(HAVE_GETHOSTBYNAME_R_3_ARGS) */
724 struct hostent_data hdata;
725 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5)_ARGS */
726 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
728 if ((host == NULL) || (*host == '\0'))
733 memset((char *) &inaddr, 0, sizeof inaddr);
735 if ((inaddr.sin_addr.s_addr = inet_addr(host)) == -1)
737 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS)
738 gethostbyname_r(host, &result, hbuf,
739 HOSTENT_BUFFER_SIZE, &hostp, &thd_err);
740 #elif defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
741 hostp = gethostbyname_r(host, &result, hbuf,
742 HOSTENT_BUFFER_SIZE, &thd_err);
743 #elif defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
744 if (0 == gethostbyname_r(host, &result, &hdata))
753 hostp = gethostbyname(host);
754 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
758 log_error(LOG_LEVEL_ERROR, "could not resolve hostname %s", host);
761 if (hostp->h_addrtype != AF_INET)
764 errno = WSAEPROTOTYPE;
768 log_error(LOG_LEVEL_ERROR, "hostname %s resolves to unknown address type.", host);
772 (char *) &inaddr.sin_addr,
773 (char *) hostp->h_addr,
774 sizeof(inaddr.sin_addr)
777 return(inaddr.sin_addr.s_addr);