1 const char jbsockets_rcs[] = "$Id: jbsockets.c,v 1.36 2002/05/26 23:23:10 joergs 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.36 2002/05/26 23:23:10 joergs
39 * AmigaOS: Fixed wrong type for len in write_socket()
41 * Revision 1.35 2002/04/26 15:50:04 joergs
42 * AmigaOS: No socklen_t, added AMIGA to the systems using int instead.
44 * Revision 1.34 2002/04/08 20:31:41 swa
47 * Revision 1.33 2002/04/03 16:02:18 gliptak
48 * Correcting compile warning with older gcc
50 * Revision 1.32 2002/03/31 17:18:59 jongfoster
51 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
53 * Revision 1.31 2002/03/29 03:33:13 david__schmidt
54 * Fix Mac OSX compiler warnings
56 * Revision 1.30 2002/03/27 14:32:43 david__schmidt
57 * More compiler warning message maintenance
59 * Revision 1.29 2002/03/26 22:29:54 swa
60 * we have a new homepage!
62 * Revision 1.28 2002/03/24 13:25:43 swa
63 * name change related issues
65 * Revision 1.27 2002/03/13 00:27:05 jongfoster
68 * Revision 1.26 2002/03/11 22:07:02 david__schmidt
69 * OS/2 port maintenance:
70 * - Fixed EMX build - it had decayed a little
71 * - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
72 * substituted a memset for now.
74 * Revision 1.25 2002/03/09 20:03:52 jongfoster
75 * - Making various functions return int rather than size_t.
76 * (Undoing a recent change). Since size_t is unsigned on
77 * Windows, functions like read_socket that return -1 on
78 * error cannot return a size_t.
80 * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
81 * crashes, and also frequently caused JB to jump to 100%
82 * CPU and stay there. (Because it thought it had just
83 * read ((unsigned)-1) == 4Gb of data...)
85 * - The signature of write_socket has changed, it now simply
86 * returns success=0/failure=nonzero.
88 * - Trying to get rid of a few warnings --with-debug on
89 * Windows, I've introduced a new type "jb_socket". This is
90 * used for the socket file descriptors. On Windows, this
91 * is SOCKET (a typedef for unsigned). Everywhere else, it's
92 * an int. The error value can't be -1 any more, so it's
93 * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
94 * Windows it maps to the #define INVALID_SOCKET.)
96 * - The signature of bind_port has changed.
98 * Revision 1.24 2002/03/07 03:51:36 oes
99 * - Improved handling of failed DNS lookups
100 * - Fixed compiler warnings etc
102 * Revision 1.23 2002/03/05 00:36:01 jongfoster
103 * Fixing bug 514988 - unable to restart Junkbuster
105 * Revision 1.22 2002/03/04 02:08:02 david__schmidt
106 * Enable web editing of actions file on OS/2 (it had been broken all this time!)
108 * Revision 1.21 2002/01/09 14:32:33 oes
109 * Added support for gethostbyname_r and gethostbyaddr_r.
111 * Revision 1.20 2001/11/16 00:48:48 jongfoster
112 * Enabling duplicate-socket detection for all platforms, not
115 * Revision 1.19 2001/10/25 03:40:47 david__schmidt
116 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
117 * threads to call select() simultaneously. So, it's time to do a real, live,
118 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
119 * (native). Both versions will work, but using __OS2__ offers multi-threading.
121 * Revision 1.18 2001/09/21 23:02:02 david__schmidt
122 * Cleaning up 2 compiler warnings on OS/2.
124 * Revision 1.17 2001/09/13 20:11:46 jongfoster
125 * Fixing 2 compiler warnings under Win32
127 * Revision 1.16 2001/07/30 22:08:36 jongfoster
128 * Tidying up #defines:
129 * - All feature #defines are now of the form FEATURE_xxx
130 * - Permanently turned off WIN_GUI_EDIT
131 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
133 * Revision 1.15 2001/07/29 17:40:43 jongfoster
134 * Fixed compiler warning by adding a cast
136 * Revision 1.14 2001/07/18 13:47:59 oes
137 * Eliminated dirty hack for getsockbyname()
139 * Revision 1.13 2001/07/15 13:56:57 jongfoster
140 * Removing unused local variable.
142 * Revision 1.12 2001/07/01 17:04:11 oes
143 * Bugfix: accept_connection no longer uses the obsolete hstrerror() function
145 * Revision 1.11 2001/06/29 21:45:41 oes
146 * Indentation, CRLF->LF, Tab-> Space
148 * Revision 1.10 2001/06/29 13:29:15 oes
149 * - Added remote (server) host IP to csp->http->host_ip_addr_str
150 * - Added detection of local socket IP and fqdn
151 * - Removed logentry from cancelled commit
153 * Revision 1.9 2001/06/07 23:06:09 jongfoster
154 * The host parameter to connect_to() is now const.
156 * Revision 1.8 2001/06/03 19:12:07 oes
159 * Revision 1.7 2001/05/28 16:14:00 jongfoster
160 * Fixing bug in LOG_LEVEL_LOG
162 * Revision 1.6 2001/05/26 17:28:32 jongfoster
163 * Fixed LOG_LEVEL_LOG
165 * Revision 1.5 2001/05/26 15:26:15 jongfoster
166 * ACL feature now provides more security by immediately dropping
167 * connections from untrusted hosts.
169 * Revision 1.4 2001/05/26 00:37:42 jongfoster
170 * Cosmetic indentation correction.
172 * Revision 1.3 2001/05/25 21:57:54 jongfoster
173 * Now gives a warning under Windows if you try to bind
174 * it to a port that's already in use.
176 * Revision 1.2 2001/05/17 23:01:01 oes
177 * - Cleaned CRLF's from the sources and related files
179 * Revision 1.1.1.1 2001/05/15 13:58:54 oes
180 * Initial import of version 2.9.3 source tree
183 *********************************************************************/
193 #include <sys/types.h>
201 #include <sys/timeb.h>
209 #include <sys/time.h>
210 #include <netinet/in.h>
211 #include <sys/ioctl.h>
213 #include <sys/socket.h>
216 #include <netinet/tcp.h>
218 #include <arpa/inet.h>
224 #if defined(__EMX__) || defined (__OS2__)
225 #include <sys/select.h> /* OS/2/EMX needs a little help with select */
234 #include "jbsockets.h"
238 const char jbsockets_h_rcs[] = JBSOCKETS_H_VERSION;
241 /*********************************************************************
243 * Function : connect_to
245 * Description : Open a socket and connect to it. Will check
246 * that this is allowed according to ACL.
249 * 1 : host = hostname to connect to
250 * 2 : portnum = port to connent on
251 * 3 : csp = Current client state (buffers, headers, etc...)
252 * Not modified, only used for source IP and ACL.
254 * Returns : JB_INVALID_SOCKET => failure, else it is the socket
257 *********************************************************************/
258 jb_socket connect_to(const char *host, int portnum, struct client_state *csp)
260 struct sockaddr_in inaddr;
264 struct timeval tv[1];
265 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA)
267 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
270 struct access_control_addr dst[1];
271 #endif /* def FEATURE_ACL */
273 memset((char *)&inaddr, 0, sizeof inaddr);
275 if ((addr = resolve_hostname_to_ip(host)) == INADDR_NONE)
277 csp->http->host_ip_addr_str = strdup("unknown");
278 return(JB_INVALID_SOCKET);
282 dst->addr = ntohl((unsigned long) addr);
285 if (block_acl(dst, csp))
292 return(JB_INVALID_SOCKET);
294 #endif /* def FEATURE_ACL */
296 inaddr.sin_addr.s_addr = addr;
297 inaddr.sin_family = AF_INET;
298 csp->http->host_ip_addr_str = strdup(inet_ntoa(inaddr.sin_addr));
301 if (sizeof(inaddr.sin_port) == sizeof(short))
302 #endif /* ndef _WIN32 */
304 inaddr.sin_port = htons((unsigned short) portnum);
309 inaddr.sin_port = htonl((unsigned long)portnum);
311 #endif /* ndef _WIN32 */
314 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) == JB_INVALID_SOCKET)
316 if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) < 0)
319 return(JB_INVALID_SOCKET);
323 { /* turn off TCP coalescence */
325 setsockopt (fd, IPPROTO_TCP, TCP_NODELAY, (char *) &mi, sizeof (int));
327 #endif /* def TCP_NODELAY */
329 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
330 if ((flags = fcntl(fd, F_GETFL, 0)) != -1)
333 fcntl(fd, F_SETFL, flags);
335 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
337 while (connect(fd, (struct sockaddr *) & inaddr, sizeof inaddr) == JB_INVALID_SOCKET)
340 if (errno == WSAEINPROGRESS)
342 if (sock_errno() == EINPROGRESS)
343 #else /* ifndef _WIN32 */
344 if (errno == EINPROGRESS)
345 #endif /* ndef _WIN32 || __OS2__ */
351 if (sock_errno() != EINTR)
357 return(JB_INVALID_SOCKET);
361 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
365 fcntl(fd, F_SETFL, flags);
367 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
369 /* wait for connection to complete */
376 /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Wierd! */
377 if (select((int)fd + 1, NULL, &wfds, NULL, tv) <= 0)
380 return(JB_INVALID_SOCKET);
387 /*********************************************************************
389 * Function : write_socket
391 * Description : Write the contents of buf (for n bytes) to socket fd.
394 * 1 : fd = file descriptor (aka. handle) of socket to write to.
395 * 2 : buf = pointer to data to be written.
396 * 3 : len = length of data to be written to the socket "fd".
398 * Returns : 0 on success (entire buffer sent).
401 *********************************************************************/
403 int write_socket(jb_socket fd, const char *buf, ssize_t len)
405 int write_socket(jb_socket fd, const char *buf, size_t len)
418 log_error(LOG_LEVEL_LOG, "%N", len, buf);
421 return (send(fd, buf, (int)len, 0) != (int)len);
422 #elif defined(__BEOS__) || defined(AMIGA)
423 return (send(fd, buf, len, 0) != len);
424 #elif defined(__OS2__)
426 * Break the data up into SOCKET_SEND_MAX chunks for sending...
427 * OS/2 seemed to complain when the chunks were too large.
429 #define SOCKET_SEND_MAX 65000
431 int write_len = 0, send_len, send_rc = 0, i = 0;
432 while ((i < len) && (send_rc != -1))
434 if ((i + SOCKET_SEND_MAX) > len)
437 send_len = SOCKET_SEND_MAX;
438 send_rc = send(fd,(char*)buf + i, send_len, 0);
446 return (write(fd, buf, len) != len);
452 /*********************************************************************
454 * Function : read_socket
456 * Description : Read from a TCP/IP socket in a platform independent way.
459 * 1 : fd = file descriptor of the socket to read
460 * 2 : buf = pointer to buffer where data will be written
461 * Must be >= len bytes long.
462 * 3 : len = maximum number of bytes to read
464 * Returns : On success, the number of bytes read is returned (zero
465 * indicates end of file), and the file position is advanced
466 * by this number. It is not an error if this number is
467 * smaller than the number of bytes requested; this may hap-
468 * pen for example because fewer bytes are actually available
469 * right now (maybe because we were close to end-of-file, or
470 * because we are reading from a pipe, or from a terminal,
471 * or because read() was interrupted by a signal). On error,
472 * -1 is returned, and errno is set appropriately. In this
473 * case it is left unspecified whether the file position (if
476 *********************************************************************/
477 int read_socket(jb_socket fd, char *buf, int len)
485 return(recv(fd, buf, len, 0));
486 #elif defined(__BEOS__) || defined(AMIGA) || defined(__OS2__)
487 return(recv(fd, buf, (size_t)len, 0));
489 return(read(fd, buf, (size_t)len));
494 /*********************************************************************
496 * Function : close_socket
498 * Description : Closes a TCP/IP socket
501 * 1 : fd = file descriptor of socket to be closed
505 *********************************************************************/
506 void close_socket(jb_socket fd)
508 #if defined(_WIN32) || defined(__BEOS__)
512 #elif defined(__OS2__)
521 /*********************************************************************
523 * Function : bind_port
525 * Description : Call socket, set socket options, and listen.
526 * Called by listen_loop to "boot up" our proxy address.
529 * 1 : hostnam = TCP/IP address to bind/listen to
530 * 2 : portnum = port to listen on
531 * 3 : pfd = pointer used to return file descriptor.
533 * Returns : if success, returns 0 and sets *pfd.
534 * if failure, returns -3 if address is in use,
535 * -2 if address unresolvable,
537 *********************************************************************/
538 int bind_port(const char *hostnam, int portnum, jb_socket *pfd)
540 struct sockaddr_in inaddr;
544 #endif /* ndef _WIN32 */
546 *pfd = JB_INVALID_SOCKET;
548 memset((char *)&inaddr, '\0', sizeof inaddr);
550 inaddr.sin_family = AF_INET;
551 inaddr.sin_addr.s_addr = resolve_hostname_to_ip(hostnam);
553 if (inaddr.sin_addr.s_addr == INADDR_NONE)
559 if (sizeof(inaddr.sin_port) == sizeof(short))
560 #endif /* ndef _WIN32 */
562 inaddr.sin_port = htons((unsigned short) portnum);
567 inaddr.sin_port = htonl((unsigned long) portnum);
569 #endif /* ndef _WIN32 */
571 fd = socket(AF_INET, SOCK_STREAM, 0);
574 if (fd == JB_INVALID_SOCKET)
584 * This is not needed for Win32 - in fact, it stops
585 * duplicate instances of Junkbuster from being caught.
587 * On UNIX, we assume the user is sensible enough not
588 * to start Junkbuster multiple times on the same IP.
589 * Without this, stopping and restarting Junkbuster
590 * from a script fails.
591 * Note: SO_REUSEADDR is meant to only take over
592 * sockets which are *not* in listen state in Linux,
593 * e.g. sockets in TIME_WAIT. YMMV.
595 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (char *)&one, sizeof(one));
596 #endif /* ndef _WIN32 */
598 if (bind (fd, (struct sockaddr *)&inaddr, sizeof(inaddr)) < 0)
602 if (errno == WSAEADDRINUSE)
604 if (errno == EADDRINUSE)
615 while (listen(fd, 5) == -1)
629 /*********************************************************************
631 * Function : accept_connection
633 * Description : Accepts a connection on a socket. Socket must have
634 * been created using bind_port().
637 * 1 : csp = Client state, cfd, ip_addr_str, and
638 * ip_addr_long will be set by this routine.
639 * 2 : fd = file descriptor returned from bind_port
641 * Returns : when a connection is accepted, it returns 1 (TRUE).
642 * On an error it returns 0 (FALSE).
644 *********************************************************************/
645 int accept_connection(struct client_state * csp, jb_socket fd)
647 struct sockaddr_in client, server;
648 struct hostent *host = NULL;
650 #if defined(_WIN32) || defined(__OS2__) || defined(__APPLE_CC__) || defined(AMIGA)
651 /* Wierdness - fix a warning. */
652 int c_length, s_length;
654 socklen_t c_length, s_length;
656 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS) || defined(HAVE_GETHOSTBYADDR_R_7_ARGS) || defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
657 struct hostent result;
658 #if defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
659 struct hostent_data hdata;
661 char hbuf[HOSTENT_BUFFER_SIZE];
663 #endif /* def HAVE_GETHOSTBYADDR_R_5_ARGS */
664 #endif /* def HAVE_GETHOSTBYADDR_R_(8|7|5)_ARGS */
666 c_length = s_length = sizeof(client);
669 afd = accept (fd, (struct sockaddr *) &client, &c_length);
670 if (afd == JB_INVALID_SOCKET)
677 afd = accept (fd, (struct sockaddr *) &client, &c_length);
678 } while (afd < 1 && errno == EINTR);
686 * Determine the IP-Adress that the client used to reach us
687 * and the hostname associated with that address
689 if (!getsockname(afd, (struct sockaddr *) &server, &s_length))
691 csp->my_ip_addr_str = strdup(inet_ntoa(server.sin_addr));
692 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS)
693 gethostbyaddr_r((const char *)&server.sin_addr,
694 sizeof(server.sin_addr), AF_INET,
695 &result, hbuf, HOSTENT_BUFFER_SIZE,
697 #elif defined(HAVE_GETHOSTBYADDR_R_7_ARGS)
698 host = gethostbyaddr_r((const char *)&server.sin_addr,
699 sizeof(server.sin_addr), AF_INET,
700 &result, hbuf, HOSTENT_BUFFER_SIZE, &thd_err);
701 #elif defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
702 if (0 == gethostbyaddr_r((const char *)&server.sin_addr,
703 sizeof(server.sin_addr), AF_INET,
713 host = gethostbyaddr((const char *)&server.sin_addr,
714 sizeof(server.sin_addr), AF_INET);
718 log_error(LOG_LEVEL_ERROR, "Unable to get my own hostname: %E\n");
722 csp->my_hostname = strdup(host->h_name);
727 csp->ip_addr_str = strdup(inet_ntoa(client.sin_addr));
728 csp->ip_addr_long = ntohl(client.sin_addr.s_addr);
735 /*********************************************************************
737 * Function : resolve_hostname_to_ip
739 * Description : Resolve a hostname to an internet tcp/ip address.
740 * NULL or an empty string resolve to INADDR_ANY.
743 * 1 : host = hostname to resolve
745 * Returns : INADDR_NONE => failure, INADDR_ANY or tcp/ip address if succesful.
747 *********************************************************************/
748 unsigned long resolve_hostname_to_ip(const char *host)
750 struct sockaddr_in inaddr;
751 struct hostent *hostp;
752 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS) || defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
753 struct hostent result;
754 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
755 char hbuf[HOSTENT_BUFFER_SIZE];
757 #else /* defined(HAVE_GETHOSTBYNAME_R_3_ARGS) */
758 struct hostent_data hdata;
759 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5)_ARGS */
760 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
762 if ((host == NULL) || (*host == '\0'))
767 memset((char *) &inaddr, 0, sizeof inaddr);
769 if ((inaddr.sin_addr.s_addr = inet_addr(host)) == -1)
771 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS)
772 gethostbyname_r(host, &result, hbuf,
773 HOSTENT_BUFFER_SIZE, &hostp, &thd_err);
774 #elif defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
775 hostp = gethostbyname_r(host, &result, hbuf,
776 HOSTENT_BUFFER_SIZE, &thd_err);
777 #elif defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
778 if (0 == gethostbyname_r(host, &result, &hdata))
787 hostp = gethostbyname(host);
788 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
792 log_error(LOG_LEVEL_ERROR, "could not resolve hostname %s", host);
795 if (hostp->h_addrtype != AF_INET)
798 errno = WSAEPROTOTYPE;
802 log_error(LOG_LEVEL_ERROR, "hostname %s resolves to unknown address type.", host);
806 (char *) &inaddr.sin_addr,
807 (char *) hostp->h_addr,
808 sizeof(inaddr.sin_addr)
811 return(inaddr.sin_addr.s_addr);