1 /*********************************************************************
3 * File : $Source: /cvsroot/ijbswa/current/jbsockets.c,v $
5 * Purpose : Contains wrappers for system-specific sockets code,
6 * so that the rest of Privoxy can be more
7 * OS-independent. Contains #ifdefs to make this work
10 * Copyright : Written by and Copyright (C) 2001-2017 the
11 * Privoxy team. http://www.privoxy.org/
13 * Based on the Internet Junkbuster originally written
14 * by and Copyright (C) 1997 Anonymous Coders and
15 * Junkbusters Corporation. http://www.junkbusters.com
17 * This program is free software; you can redistribute it
18 * and/or modify it under the terms of the GNU General
19 * Public License as published by the Free Software
20 * Foundation; either version 2 of the License, or (at
21 * your option) any later version.
23 * This program is distributed in the hope that it will
24 * be useful, but WITHOUT ANY WARRANTY; without even the
25 * implied warranty of MERCHANTABILITY or FITNESS FOR A
26 * PARTICULAR PURPOSE. See the GNU General Public
27 * License for more details.
29 * The GNU General Public License should be included with
30 * this file. If not, you can view it at
31 * http://www.gnu.org/copyleft/gpl.html
32 * or write to the Free Software Foundation, Inc., 59
33 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
35 *********************************************************************/
45 #include <sys/types.h>
54 #include <sys/timeb.h>
63 #include <netinet/in.h>
64 #include <sys/ioctl.h>
66 #include <sys/socket.h>
69 #include <netinet/tcp.h>
71 #include <arpa/inet.h>
77 #if defined(__EMX__) || defined (__OS2__)
78 #include <sys/select.h> /* OS/2/EMX needs a little help with select */
91 #endif /* def __GLIBC__ */
92 #endif /* HAVE_POLL */
96 /* For mutex semaphores only */
99 #include "jbsockets.h"
102 #include "miscutil.h"
104 /* Mac OSX doesn't define AI_NUMERICSESRV */
105 #ifndef AI_NUMERICSERV
106 #define AI_NUMERICSERV 0
110 * Maximum number of gethostbyname(_r) retries in case of
111 * soft errors (TRY_AGAIN).
112 * XXX: Does it make sense to make this a config option?
114 #define MAX_DNS_RETRIES 10
117 static jb_socket rfc2553_connect_to(const char *host, int portnum, struct client_state *csp);
119 static jb_socket no_rfc2553_connect_to(const char *host, int portnum, struct client_state *csp);
122 /*********************************************************************
124 * Function : set_no_delay_flag
126 * Description : Disables the Nagle algorithm (TCP send coalescence)
127 * for the given socket.
130 * 1 : fd = The file descriptor to operate on
134 *********************************************************************/
135 static void set_no_delay_flag(int fd)
140 if (setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &mi, sizeof(int)))
142 log_error(LOG_LEVEL_ERROR,
143 "Failed to disable TCP coalescence for socket %d", fd);
146 #warning set_no_delay_flag() is a nop due to lack of TCP_NODELAY
147 #endif /* def TCP_NODELAY */
150 /*********************************************************************
152 * Function : connect_to
154 * Description : Open a socket and connect to it. Will check
155 * that this is allowed according to ACL.
158 * 1 : host = hostname to connect to
159 * 2 : portnum = port to connect to (XXX: should be unsigned)
160 * 3 : csp = Current client state (buffers, headers, etc...)
162 * Returns : JB_INVALID_SOCKET => failure, else it is the socket
165 *********************************************************************/
166 jb_socket connect_to(const char *host, int portnum, struct client_state *csp)
169 int forwarded_connect_retries = 0;
174 * XXX: The whole errno overloading is ridiculous and should
175 * be replaced with something sane and thread safe
179 fd = rfc2553_connect_to(host, portnum, csp);
181 fd = no_rfc2553_connect_to(host, portnum, csp);
183 if ((fd != JB_INVALID_SOCKET) || (errno == EINVAL)
184 || (csp->fwd == NULL)
185 || ((csp->fwd->forward_host == NULL) && (csp->fwd->type == SOCKS_NONE)))
189 forwarded_connect_retries++;
190 if (csp->config->forwarded_connect_retries != 0)
192 log_error(LOG_LEVEL_ERROR,
193 "Attempt %d of %d to connect to %s failed. Trying again.",
194 forwarded_connect_retries, csp->config->forwarded_connect_retries + 1, host);
197 } while (forwarded_connect_retries < csp->config->forwarded_connect_retries);
203 /* Getaddrinfo implementation */
204 static jb_socket rfc2553_connect_to(const char *host, int portnum, struct client_state *csp)
206 struct addrinfo hints, *result, *rp;
211 struct pollfd poll_fd[1];
214 struct timeval timeout;
216 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
221 * XXX: Initializeing it here is only necessary
222 * because not all situations are properly
225 int socket_error = 0;
228 struct access_control_addr dst[1];
229 #endif /* def FEATURE_ACL */
231 /* Don't leak memory when retrying. */
232 freez(csp->error_message);
233 freez(csp->http->host_ip_addr_str);
235 retval = snprintf(service, sizeof(service), "%d", portnum);
236 if ((-1 == retval) || (sizeof(service) <= retval))
238 log_error(LOG_LEVEL_ERROR,
239 "Port number (%d) ASCII decimal representation doesn't fit into 6 bytes",
241 csp->error_message = strdup("Invalid port number");
242 csp->http->host_ip_addr_str = strdup("unknown");
243 return(JB_INVALID_SOCKET);
246 memset((char *)&hints, 0, sizeof(hints));
247 hints.ai_family = AF_UNSPEC;
248 hints.ai_socktype = SOCK_STREAM;
249 hints.ai_flags = AI_NUMERICSERV; /* avoid service look-up */
251 hints.ai_flags |= AI_ADDRCONFIG;
253 if ((retval = getaddrinfo(host, service, &hints, &result)))
255 log_error(LOG_LEVEL_INFO,
256 "Can not resolve %s: %s", host, gai_strerror(retval));
257 /* XXX: Should find a better way to propagate this error. */
259 csp->error_message = strdup(gai_strerror(retval));
260 csp->http->host_ip_addr_str = strdup("unknown");
261 return(JB_INVALID_SOCKET);
264 csp->http->host_ip_addr_str = malloc_or_die(NI_MAXHOST);
266 for (rp = result; rp != NULL; rp = rp->ai_next)
270 memcpy(&dst->addr, rp->ai_addr, rp->ai_addrlen);
272 if (block_acl(dst, csp))
275 socket_error = errno = SOCEPERM;
277 socket_error = errno = EPERM;
281 #endif /* def FEATURE_ACL */
283 retval = getnameinfo(rp->ai_addr, rp->ai_addrlen,
284 csp->http->host_ip_addr_str, NI_MAXHOST, NULL, 0, NI_NUMERICHOST);
287 log_error(LOG_LEVEL_ERROR,
288 "Failed to get the host name from the socket structure: %s",
289 gai_strerror(retval));
293 fd = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
295 if (fd == JB_INVALID_SOCKET)
305 if (fd >= FD_SETSIZE)
307 log_error(LOG_LEVEL_ERROR,
308 "Server socket number too high to use select(): %d >= %d",
311 freeaddrinfo(result);
312 return JB_INVALID_SOCKET;
317 #ifdef FEATURE_EXTERNAL_FILTERS
318 mark_socket_for_close_on_execute(fd);
321 set_no_delay_flag(fd);
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__) */
332 while (connect(fd, rp->ai_addr, rp->ai_addrlen) == JB_INVALID_SOCKET)
335 errno = sock_errno();
339 if (errno == WSAEINPROGRESS)
340 #else /* ifndef _WIN32 */
341 if (errno == EINPROGRESS)
342 #endif /* ndef _WIN32 || __OS2__ */
349 socket_error = errno;
360 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
364 fcntl(fd, F_SETFL, flags);
366 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
370 poll_fd[0].events = POLLOUT;
372 retval = poll(poll_fd, 1, 30000);
375 if (rp->ai_next != NULL)
377 /* Log this now as we'll try another address next */
378 log_error(LOG_LEVEL_CONNECT,
379 "Could not connect to [%s]:%s: Operation timed out.",
380 csp->http->host_ip_addr_str, service);
385 * This is the last address, don't log this now
386 * as it would result in a duplicated log message.
388 socket_error = ETIMEDOUT;
393 /* wait for connection to complete */
397 memset(&timeout, 0, sizeof(timeout));
400 /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Weird! */
401 if ((select((int)fd + 1, NULL, &wfds, NULL, &timeout) > 0)
402 && FD_ISSET(fd, &wfds))
405 socklen_t optlen = sizeof(socket_error);
406 if (!getsockopt(fd, SOL_SOCKET, SO_ERROR, &socket_error, &optlen))
410 /* Connection established, no need to try other addresses. */
413 if (rp->ai_next != NULL)
416 * There's another address we can try, so log that this
417 * one didn't work out. If the last one fails, too,
418 * it will get logged outside the loop body so we don't
419 * have to mention it here.
421 log_error(LOG_LEVEL_CONNECT, "Could not connect to [%s]:%s: %s.",
422 csp->http->host_ip_addr_str, service, strerror(socket_error));
427 socket_error = errno;
428 log_error(LOG_LEVEL_ERROR, "Could not get the state of "
429 "the connection to [%s]:%s: %s; dropping connection.",
430 csp->http->host_ip_addr_str, service, strerror(errno));
434 /* Connection failed, try next address */
438 freeaddrinfo(result);
441 log_error(LOG_LEVEL_CONNECT, "Could not connect to [%s]:%s: %s.",
442 host, service, strerror(socket_error));
443 csp->error_message = strdup(strerror(socket_error));
444 return(JB_INVALID_SOCKET);
446 log_error(LOG_LEVEL_CONNECT, "Connected to %s[%s]:%s.",
447 host, csp->http->host_ip_addr_str, service);
453 #else /* ndef HAVE_RFC2553 */
454 /* Pre-getaddrinfo implementation */
456 static jb_socket no_rfc2553_connect_to(const char *host, int portnum, struct client_state *csp)
458 struct sockaddr_in inaddr;
462 struct pollfd poll_fd[1];
465 struct timeval tv[1];
467 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
472 struct access_control_addr dst[1];
473 #endif /* def FEATURE_ACL */
475 /* Don't leak memory when retrying. */
476 freez(csp->http->host_ip_addr_str);
478 memset((char *)&inaddr, 0, sizeof inaddr);
480 if ((addr = resolve_hostname_to_ip(host)) == INADDR_NONE)
482 csp->http->host_ip_addr_str = strdup("unknown");
483 return(JB_INVALID_SOCKET);
487 dst->addr = ntohl(addr);
490 if (block_acl(dst, csp))
497 return(JB_INVALID_SOCKET);
499 #endif /* def FEATURE_ACL */
501 inaddr.sin_addr.s_addr = addr;
502 inaddr.sin_family = AF_INET;
503 csp->http->host_ip_addr_str = strdup(inet_ntoa(inaddr.sin_addr));
506 if (sizeof(inaddr.sin_port) == sizeof(short))
507 #endif /* ndef _WIN32 */
509 inaddr.sin_port = htons((unsigned short) portnum);
514 inaddr.sin_port = htonl((unsigned long)portnum);
516 #endif /* ndef _WIN32 */
518 fd = socket(inaddr.sin_family, SOCK_STREAM, 0);
520 if (fd == JB_INVALID_SOCKET)
525 return(JB_INVALID_SOCKET);
530 if (fd >= FD_SETSIZE)
532 log_error(LOG_LEVEL_ERROR,
533 "Server socket number too high to use select(): %d >= %d",
536 return JB_INVALID_SOCKET;
541 set_no_delay_flag(fd);
543 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
544 if ((flags = fcntl(fd, F_GETFL, 0)) != -1)
547 fcntl(fd, F_SETFL, flags);
548 #ifdef FEATURE_EXTERNAL_FILTERS
549 mark_socket_for_close_on_execute(fd);
552 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
554 while (connect(fd, (struct sockaddr *) & inaddr, sizeof inaddr) == JB_INVALID_SOCKET)
557 if (errno == WSAEINPROGRESS)
559 if (sock_errno() == EINPROGRESS)
560 #else /* ifndef _WIN32 */
561 if (errno == EINPROGRESS)
562 #endif /* ndef _WIN32 || __OS2__ */
568 if (sock_errno() != EINTR)
574 return(JB_INVALID_SOCKET);
578 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
582 fcntl(fd, F_SETFL, flags);
584 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
588 poll_fd[0].events = POLLOUT;
590 if (poll(poll_fd, 1, 30000) <= 0)
592 /* wait for connection to complete */
599 /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Weird! */
600 if (select((int)fd + 1, NULL, &wfds, NULL, tv) <= 0)
604 return(JB_INVALID_SOCKET);
609 #endif /* ndef HAVE_RFC2553 */
612 /*********************************************************************
614 * Function : write_socket
616 * Description : Write the contents of buf (for n bytes) to socket fd.
619 * 1 : fd = file descriptor (aka. handle) of socket to write to.
620 * 2 : buf = pointer to data to be written.
621 * 3 : len = length of data to be written to the socket "fd".
623 * Returns : 0 on success (entire buffer sent).
626 *********************************************************************/
628 int write_socket(jb_socket fd, const char *buf, ssize_t len)
630 int write_socket(jb_socket fd, const char *buf, size_t len)
639 if (!daemon_mode && fd <= 3)
641 log_error(LOG_LEVEL_WRITING, "Pretending to write to socket %d: %N", fd, len, buf);
646 log_error(LOG_LEVEL_WRITING, "to socket %d: %N", fd, len, buf);
649 return (send(fd, buf, (int)len, 0) != (int)len);
650 #elif defined(__BEOS__) || defined(AMIGA)
651 return (send(fd, buf, len, 0) != len);
652 #elif defined(__OS2__)
654 * Break the data up into SOCKET_SEND_MAX chunks for sending...
655 * OS/2 seemed to complain when the chunks were too large.
657 #define SOCKET_SEND_MAX 65000
659 int send_len, send_rc = 0, i = 0;
660 while ((i < len) && (send_rc != -1))
662 if ((i + SOCKET_SEND_MAX) > len)
665 send_len = SOCKET_SEND_MAX;
666 send_rc = send(fd,(char*)buf + i, send_len, 0);
674 return (write(fd, buf, len) != len);
680 /*********************************************************************
682 * Function : read_socket
684 * Description : Read from a TCP/IP socket in a platform independent way.
687 * 1 : fd = file descriptor of the socket to read
688 * 2 : buf = pointer to buffer where data will be written
689 * Must be >= len bytes long.
690 * 3 : len = maximum number of bytes to read
692 * Returns : On success, the number of bytes read is returned (zero
693 * indicates end of file), and the file position is advanced
694 * by this number. It is not an error if this number is
695 * smaller than the number of bytes requested; this may hap-
696 * pen for example because fewer bytes are actually available
697 * right now (maybe because we were close to end-of-file, or
698 * because we are reading from a pipe, or from a terminal,
699 * or because read() was interrupted by a signal). On error,
700 * -1 is returned, and errno is set appropriately. In this
701 * case it is left unspecified whether the file position (if
704 *********************************************************************/
705 int read_socket(jb_socket fd, char *buf, int len)
715 ret = recv(fd, buf, len, 0);
716 #elif defined(__BEOS__) || defined(AMIGA) || defined(__OS2__)
717 ret = recv(fd, buf, (size_t)len, 0);
719 ret = (int)read(fd, buf, (size_t)len);
724 log_error(LOG_LEVEL_RECEIVED, "from socket %d: %N", fd, ret, buf);
731 /*********************************************************************
733 * Function : data_is_available
735 * Description : Waits for data to arrive on a socket.
738 * 1 : fd = file descriptor of the socket to read
739 * 2 : seconds_to_wait = number of seconds after which we give up.
741 * Returns : TRUE if data arrived in time,
744 *********************************************************************/
745 int data_is_available(jb_socket fd, int seconds_to_wait)
750 struct pollfd poll_fd[1];
753 poll_fd[0].events = POLLIN;
755 n = poll(poll_fd, 1, seconds_to_wait * 1000);
758 struct timeval timeout;
760 memset(&timeout, 0, sizeof(timeout));
761 timeout.tv_sec = seconds_to_wait;
764 /* Copy and pasted from jcc.c ... */
765 memset(&rfds, 0, sizeof(fd_set));
771 n = select(fd+1, &rfds, NULL, NULL, &timeout);
775 * XXX: Do we care about the different error conditions?
777 return ((n == 1) && (1 == recv(fd, buf, 1, MSG_PEEK)));
781 /*********************************************************************
783 * Function : close_socket
785 * Description : Closes a TCP/IP socket
788 * 1 : fd = file descriptor of socket to be closed
792 *********************************************************************/
793 void close_socket(jb_socket fd)
795 #if defined(_WIN32) || defined(__BEOS__)
799 #elif defined(__OS2__)
807 /*********************************************************************
809 * Function : drain_and_close_socket
811 * Description : Closes a TCP/IP socket after draining unread data
814 * 1 : fd = file descriptor of the socket to be closed
818 *********************************************************************/
819 void drain_and_close_socket(jb_socket fd)
821 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
822 if (socket_is_still_alive(fd))
825 int bytes_drained_total = 0;
829 /* Apparently Windows has shutdown() but not SHUT_WR. */
833 if (0 != shutdown(fd, SHUT_WR))
835 log_error(LOG_LEVEL_CONNECT, "Failed to shutdown socket %d: %E", fd);
838 #define ARBITRARY_DRAIN_LIMIT 10000
843 if (!data_is_available(fd, 0))
846 * If there is no data available right now, don't try
847 * to drain the socket as read_socket() could block.
852 bytes_drained = read_socket(fd, drainage, sizeof(drainage));
853 if (bytes_drained < 0)
855 log_error(LOG_LEVEL_CONNECT, "Failed to drain socket %d: %E", fd);
857 else if (bytes_drained > 0)
859 bytes_drained_total += bytes_drained;
860 if (bytes_drained_total > ARBITRARY_DRAIN_LIMIT)
862 log_error(LOG_LEVEL_CONNECT, "Giving up draining socket %d", fd);
866 } while (bytes_drained > 0);
867 if (bytes_drained_total != 0)
869 log_error(LOG_LEVEL_CONNECT,
870 "Drained %d bytes before closing socket %d", bytes_drained_total, fd);
879 /*********************************************************************
881 * Function : bind_port
883 * Description : Call socket, set socket options, and listen.
884 * Called by listen_loop to "boot up" our proxy address.
887 * 1 : hostnam = TCP/IP address to bind/listen to
888 * 2 : portnum = port to listen on
889 * 3 : backlog = Listen backlog
890 * 4 : pfd = pointer used to return file descriptor.
892 * Returns : if success, returns 0 and sets *pfd.
893 * if failure, returns -3 if address is in use,
894 * -2 if address unresolvable,
896 *********************************************************************/
897 int bind_port(const char *hostnam, int portnum, int backlog, jb_socket *pfd)
900 struct addrinfo hints;
901 struct addrinfo *result, *rp;
903 * XXX: portnum should be a string to allow symbolic service
904 * names in the configuration file and to avoid the following
910 struct sockaddr_in inaddr;
911 #endif /* def HAVE_RFC2553 */
915 #endif /* ndef _WIN32 */
917 *pfd = JB_INVALID_SOCKET;
920 retval = snprintf(servnam, sizeof(servnam), "%d", portnum);
921 if ((-1 == retval) || (sizeof(servnam) <= retval))
923 log_error(LOG_LEVEL_ERROR,
924 "Port number (%d) ASCII decimal representation doesn't fit into 6 bytes",
929 memset(&hints, 0, sizeof(struct addrinfo));
933 * XXX: This is a hack. The right thing to do
934 * would be to bind to both AF_INET and AF_INET6.
935 * This will also fail if there is no AF_INET
938 hints.ai_family = AF_INET;
942 hints.ai_family = AF_UNSPEC;
944 hints.ai_socktype = SOCK_STREAM;
945 hints.ai_flags = AI_PASSIVE;
946 hints.ai_protocol = 0; /* Really any stream protocol or TCP only */
947 hints.ai_canonname = NULL;
948 hints.ai_addr = NULL;
949 hints.ai_next = NULL;
951 if ((retval = getaddrinfo(hostnam, servnam, &hints, &result)))
953 log_error(LOG_LEVEL_ERROR,
954 "Can not resolve %s: %s", hostnam, gai_strerror(retval));
958 memset((char *)&inaddr, '\0', sizeof inaddr);
960 inaddr.sin_family = AF_INET;
961 inaddr.sin_addr.s_addr = resolve_hostname_to_ip(hostnam);
963 if (inaddr.sin_addr.s_addr == INADDR_NONE)
969 if (sizeof(inaddr.sin_port) == sizeof(short))
970 #endif /* ndef _WIN32 */
972 inaddr.sin_port = htons((unsigned short) portnum);
977 inaddr.sin_port = htonl((unsigned long) portnum);
979 #endif /* ndef _WIN32 */
980 #endif /* def HAVE_RFC2553 */
983 for (rp = result; rp != NULL; rp = rp->ai_next)
985 fd = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
987 fd = socket(AF_INET, SOCK_STREAM, 0);
988 #endif /* def HAVE_RFC2553 */
991 if (fd == JB_INVALID_SOCKET)
1003 #ifdef FEATURE_EXTERNAL_FILTERS
1004 mark_socket_for_close_on_execute(fd);
1009 * This is not needed for Win32 - in fact, it stops
1010 * duplicate instances of Privoxy from being caught.
1012 * On UNIX, we assume the user is sensible enough not
1013 * to start Privoxy multiple times on the same IP.
1014 * Without this, stopping and restarting Privoxy
1015 * from a script fails.
1016 * Note: SO_REUSEADDR is meant to only take over
1017 * sockets which are *not* in listen state in Linux,
1018 * e.g. sockets in TIME_WAIT. YMMV.
1020 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (char *)&one, sizeof(one));
1021 #endif /* ndef _WIN32 */
1024 if (bind(fd, rp->ai_addr, rp->ai_addrlen) < 0)
1026 if (bind(fd, (struct sockaddr *)&inaddr, sizeof(inaddr)) < 0)
1030 errno = WSAGetLastError();
1031 if (errno == WSAEADDRINUSE)
1033 if (errno == EADDRINUSE)
1037 freeaddrinfo(result);
1045 #ifndef HAVE_RFC2553
1054 /* bind() succeeded, escape from for-loop */
1056 * XXX: Support multiple listening sockets (e.g. localhost
1057 * resolves to AF_INET and AF_INET6, but only the first address
1064 freeaddrinfo(result);
1067 /* All bind()s failed */
1070 #endif /* ndef HAVE_RFC2553 */
1072 while (listen(fd, backlog) == -1)
1087 /*********************************************************************
1089 * Function : get_host_information
1091 * Description : Determines the IP address the client used to
1092 * reach us and the hostname associated with it.
1094 * XXX: Most of the code has been copy and pasted
1095 * from accept_connection() and not all of the
1096 * ifdefs paths have been tested afterwards.
1099 * 1 : afd = File descriptor returned from accept().
1100 * 2 : ip_address = Pointer to return the pointer to
1101 * the ip address string.
1102 * 3 : port = Pointer to return the pointer to
1103 * the TCP port string.
1104 * 4 : hostname = Pointer to return the pointer to
1105 * the hostname or NULL if the caller
1106 * isn't interested in it.
1110 *********************************************************************/
1111 void get_host_information(jb_socket afd, char **ip_address, char **port,
1115 struct sockaddr_storage server;
1118 struct sockaddr_in server;
1119 struct hostent *host = NULL;
1120 #endif /* HAVE_RFC2553 */
1121 #if defined(_WIN32) || defined(__OS2__) || defined(AMIGA)
1122 /* according to accept_connection() this fixes a warning. */
1123 int s_length, s_length_provided;
1125 socklen_t s_length, s_length_provided;
1127 #ifndef HAVE_RFC2553
1128 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS) || defined(HAVE_GETHOSTBYADDR_R_7_ARGS) || defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
1129 struct hostent result;
1130 #if defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
1131 struct hostent_data hdata;
1133 char hbuf[HOSTENT_BUFFER_SIZE];
1135 #endif /* def HAVE_GETHOSTBYADDR_R_5_ARGS */
1136 #endif /* def HAVE_GETHOSTBYADDR_R_(8|7|5)_ARGS */
1137 #endif /* ifndef HAVE_RFC2553 */
1138 s_length = s_length_provided = sizeof(server);
1140 if (NULL != hostname)
1147 if (!getsockname(afd, (struct sockaddr *) &server, &s_length))
1149 if (s_length > s_length_provided)
1151 log_error(LOG_LEVEL_ERROR, "getsockname() truncated server address");
1155 * XXX: Workaround for missing header on Windows when
1156 * configured with --disable-ipv6-support.
1157 * The proper fix is to not use NI_MAXSERV in
1158 * that case. It works by accident on other platforms
1159 * as <netdb.h> is included unconditionally there.
1162 #define NI_MAXSERV 32
1164 *port = malloc_or_die(NI_MAXSERV);
1167 *ip_address = malloc_or_die(NI_MAXHOST);
1168 retval = getnameinfo((struct sockaddr *) &server, s_length,
1169 *ip_address, NI_MAXHOST, *port, NI_MAXSERV,
1170 NI_NUMERICHOST|NI_NUMERICSERV);
1173 log_error(LOG_LEVEL_ERROR,
1174 "Unable to print my own IP address: %s", gai_strerror(retval));
1180 *ip_address = strdup(inet_ntoa(server.sin_addr));
1181 snprintf(*port, NI_MAXSERV, "%hu", ntohs(server.sin_port));
1182 #endif /* HAVE_RFC2553 */
1183 if (NULL == hostname)
1186 * We're done here, the caller isn't
1187 * interested in knowing the hostname.
1193 *hostname = malloc_or_die(NI_MAXHOST);
1194 retval = getnameinfo((struct sockaddr *) &server, s_length,
1195 *hostname, NI_MAXHOST, NULL, 0, NI_NAMEREQD);
1198 log_error(LOG_LEVEL_ERROR,
1199 "Unable to resolve my own IP address: %s", gai_strerror(retval));
1203 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS)
1204 gethostbyaddr_r((const char *)&server.sin_addr,
1205 sizeof(server.sin_addr), AF_INET,
1206 &result, hbuf, HOSTENT_BUFFER_SIZE,
1208 #elif defined(HAVE_GETHOSTBYADDR_R_7_ARGS)
1209 host = gethostbyaddr_r((const char *)&server.sin_addr,
1210 sizeof(server.sin_addr), AF_INET,
1211 &result, hbuf, HOSTENT_BUFFER_SIZE, &thd_err);
1212 #elif defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
1213 if (0 == gethostbyaddr_r((const char *)&server.sin_addr,
1214 sizeof(server.sin_addr), AF_INET,
1223 #elif defined(MUTEX_LOCKS_AVAILABLE)
1224 privoxy_mutex_lock(&resolver_mutex);
1225 host = gethostbyaddr((const char *)&server.sin_addr,
1226 sizeof(server.sin_addr), AF_INET);
1227 privoxy_mutex_unlock(&resolver_mutex);
1229 host = gethostbyaddr((const char *)&server.sin_addr,
1230 sizeof(server.sin_addr), AF_INET);
1234 log_error(LOG_LEVEL_ERROR, "Unable to get my own hostname: %E\n");
1238 *hostname = strdup(host->h_name);
1240 #endif /* else def HAVE_RFC2553 */
1247 /*********************************************************************
1249 * Function : accept_connection
1251 * Description : Accepts a connection on one of possibly multiple
1252 * sockets. The socket(s) to check must have been
1253 * created using bind_port().
1256 * 1 : csp = Client state, cfd, ip_addr_str, and
1257 * ip_addr_long will be set by this routine.
1258 * 2 : fds = File descriptors returned from bind_port
1260 * Returns : when a connection is accepted, it returns 1 (TRUE).
1261 * On an error it returns 0 (FALSE).
1263 *********************************************************************/
1264 int accept_connection(struct client_state * csp, jb_socket fds[])
1267 /* XXX: client is stored directly into csp->tcp_addr */
1268 #define client (csp->tcp_addr)
1270 struct sockaddr_in client;
1273 #if defined(_WIN32) || defined(__OS2__) || defined(AMIGA)
1274 /* Wierdness - fix a warning. */
1281 int max_selected_socket;
1283 struct pollfd poll_fds[MAX_LISTENING_SOCKETS];
1284 nfds_t polled_sockets;
1286 fd_set selected_fds;
1289 const char *host_addr;
1290 size_t listen_addr_size;
1292 c_length = sizeof(client);
1295 memset(poll_fds, 0, sizeof(poll_fds));
1299 * Wait for a connection on any socket.
1300 * Return immediately if no socket is listening.
1301 * XXX: Why not treat this as fatal error?
1303 FD_ZERO(&selected_fds);
1305 max_selected_socket = 0;
1306 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
1308 if (JB_INVALID_SOCKET != fds[i])
1311 poll_fds[i].fd = fds[i];
1312 poll_fds[i].events = POLLIN;
1315 FD_SET(fds[i], &selected_fds);
1317 if (max_selected_socket < fds[i] + 1)
1319 max_selected_socket = fds[i] + 1;
1323 if (0 == max_selected_socket)
1330 retval = poll(poll_fds, polled_sockets, -1);
1332 retval = select(max_selected_socket, &selected_fds, NULL, NULL, NULL);
1334 } while (retval < 0 && errno == EINTR);
1339 log_error(LOG_LEVEL_ERROR,
1340 "Waiting on new client failed because select(2) returned 0."
1341 " This should not happen.");
1345 log_error(LOG_LEVEL_ERROR,
1346 "Waiting on new client failed because of problems in select(2): "
1347 "%s.", strerror(errno));
1352 for (i = 0; i < MAX_LISTENING_SOCKETS && (poll_fds[i].revents == 0); i++);
1354 for (i = 0; i < MAX_LISTENING_SOCKETS && !FD_ISSET(fds[i], &selected_fds);
1357 if (i >= MAX_LISTENING_SOCKETS)
1359 log_error(LOG_LEVEL_ERROR,
1360 "select(2) reported connected clients (number = %u, "
1361 "descriptor boundary = %u), but none found.",
1362 retval, max_selected_socket);
1367 /* Accept selected connection */
1369 afd = accept (fd, (struct sockaddr *) &client, &c_length);
1370 if (afd == JB_INVALID_SOCKET)
1377 afd = accept (fd, (struct sockaddr *) &client, &c_length);
1378 } while (afd < 0 && errno == EINTR);
1387 struct linger linger_options;
1388 linger_options.l_onoff = 1;
1389 linger_options.l_linger = 5;
1390 if (0 != setsockopt(afd, SOL_SOCKET, SO_LINGER, &linger_options, sizeof(linger_options)))
1392 log_error(LOG_LEVEL_ERROR, "Setting SO_LINGER on socket %d failed.", afd);
1399 if (afd >= FD_SETSIZE)
1401 log_error(LOG_LEVEL_ERROR,
1402 "Client socket number too high to use select(): %d >= %d",
1410 #ifdef FEATURE_EXTERNAL_FILTERS
1411 mark_socket_for_close_on_execute(afd);
1414 set_no_delay_flag(afd);
1418 csp->ip_addr_str = malloc_or_die(NI_MAXHOST);
1419 retval = getnameinfo((struct sockaddr *) &client, c_length,
1420 csp->ip_addr_str, NI_MAXHOST, NULL, 0, NI_NUMERICHOST);
1421 if (!csp->ip_addr_str || retval)
1423 log_error(LOG_LEVEL_ERROR, "Can not save csp->ip_addr_str: %s",
1424 (csp->ip_addr_str) ? gai_strerror(retval) : "Insuffcient memory");
1425 freez(csp->ip_addr_str);
1429 csp->ip_addr_str = strdup(inet_ntoa(client.sin_addr));
1430 csp->ip_addr_long = ntohl(client.sin_addr.s_addr);
1431 #endif /* def HAVE_RFC2553 */
1434 * Save the name and port of the accepting socket for later lookup.
1436 * The string needs space for strlen(...) + 7 characters:
1437 * strlen(haddr[i]) + 1 (':') + 5 (port digits) + 1 ('\0')
1439 host_addr = (csp->config->haddr[i] != NULL) ? csp->config->haddr[i] : "";
1440 listen_addr_size = strlen(host_addr) + 7;
1441 csp->listen_addr_str = malloc_or_die(listen_addr_size);
1442 retval = snprintf(csp->listen_addr_str, listen_addr_size,
1443 "%s:%d", host_addr, csp->config->hport[i]);
1444 if ((-1 == retval) || listen_addr_size <= retval)
1446 log_error(LOG_LEVEL_ERROR,
1447 "Server name (%s) and port number (%d) ASCII decimal representation"
1448 "don't fit into %d bytes",
1449 host_addr, csp->config->hport[i], listen_addr_size);
1458 /*********************************************************************
1460 * Function : resolve_hostname_to_ip
1462 * Description : Resolve a hostname to an internet tcp/ip address.
1463 * NULL or an empty string resolve to INADDR_ANY.
1466 * 1 : host = hostname to resolve
1468 * Returns : INADDR_NONE => failure, INADDR_ANY or tcp/ip address if successful.
1470 *********************************************************************/
1471 unsigned long resolve_hostname_to_ip(const char *host)
1473 struct sockaddr_in inaddr;
1474 struct hostent *hostp;
1475 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS) || defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
1476 struct hostent result;
1477 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
1478 char hbuf[HOSTENT_BUFFER_SIZE];
1480 #else /* defined(HAVE_GETHOSTBYNAME_R_3_ARGS) */
1481 struct hostent_data hdata;
1482 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5)_ARGS */
1483 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
1485 if ((host == NULL) || (*host == '\0'))
1490 memset((char *) &inaddr, 0, sizeof inaddr);
1492 if ((inaddr.sin_addr.s_addr = inet_addr(host)) == -1)
1494 unsigned int dns_retries = 0;
1495 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS)
1496 while (gethostbyname_r(host, &result, hbuf,
1497 HOSTENT_BUFFER_SIZE, &hostp, &thd_err)
1498 && (thd_err == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
1500 log_error(LOG_LEVEL_ERROR,
1501 "Timeout #%u while trying to resolve %s. Trying again.",
1504 #elif defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
1505 while (NULL == (hostp = gethostbyname_r(host, &result,
1506 hbuf, HOSTENT_BUFFER_SIZE, &thd_err))
1507 && (thd_err == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
1509 log_error(LOG_LEVEL_ERROR,
1510 "Timeout #%u while trying to resolve %s. Trying again.",
1513 #elif defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
1515 * XXX: Doesn't retry in case of soft errors.
1516 * Does this gethostbyname_r version set h_errno?
1518 if (0 == gethostbyname_r(host, &result, &hdata))
1526 #elif defined(MUTEX_LOCKS_AVAILABLE)
1527 privoxy_mutex_lock(&resolver_mutex);
1528 while (NULL == (hostp = gethostbyname(host))
1529 && (h_errno == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
1531 log_error(LOG_LEVEL_ERROR,
1532 "Timeout #%u while trying to resolve %s. Trying again.",
1535 privoxy_mutex_unlock(&resolver_mutex);
1537 while (NULL == (hostp = gethostbyname(host))
1538 && (h_errno == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
1540 log_error(LOG_LEVEL_ERROR,
1541 "Timeout #%u while trying to resolve %s. Trying again.",
1544 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
1546 * On Mac OSX, if a domain exists but doesn't have a type A
1547 * record associated with it, the h_addr member of the struct
1548 * hostent returned by gethostbyname is NULL, even if h_length
1549 * is 4. Therefore the second test below.
1551 if (hostp == NULL || hostp->h_addr == NULL)
1554 log_error(LOG_LEVEL_ERROR, "could not resolve hostname %s", host);
1555 return(INADDR_NONE);
1557 if (hostp->h_addrtype != AF_INET)
1560 errno = WSAEPROTOTYPE;
1564 log_error(LOG_LEVEL_ERROR, "hostname %s resolves to unknown address type.", host);
1565 return(INADDR_NONE);
1567 memcpy((char *)&inaddr.sin_addr, (char *)hostp->h_addr, sizeof(inaddr.sin_addr));
1569 return(inaddr.sin_addr.s_addr);
1574 /*********************************************************************
1576 * Function : socket_is_still_alive
1578 * Description : Figures out whether or not a socket is still alive.
1581 * 1 : sfd = The socket to check.
1583 * Returns : TRUE for yes, otherwise FALSE.
1585 *********************************************************************/
1586 int socket_is_still_alive(jb_socket sfd)
1589 int no_data_waiting;
1592 struct pollfd poll_fd[1];
1594 memset(poll_fd, 0, sizeof(poll_fd));
1595 poll_fd[0].fd = sfd;
1596 poll_fd[0].events = POLLIN;
1598 poll_result = poll(poll_fd, 1, 0);
1600 if (-1 == poll_result)
1602 log_error(LOG_LEVEL_CONNECT, "Polling socket %d failed.", sfd);
1605 no_data_waiting = !(poll_fd[0].revents & POLLIN);
1607 fd_set readable_fds;
1608 struct timeval timeout;
1611 memset(&timeout, '\0', sizeof(timeout));
1612 FD_ZERO(&readable_fds);
1613 FD_SET(sfd, &readable_fds);
1615 ret = select((int)sfd+1, &readable_fds, NULL, NULL, &timeout);
1618 log_error(LOG_LEVEL_CONNECT, "select() on socket %d failed: %E", sfd);
1621 no_data_waiting = !FD_ISSET(sfd, &readable_fds);
1622 #endif /* def HAVE_POLL */
1624 return (no_data_waiting || (1 == recv(sfd, buf, 1, MSG_PEEK)));
1628 #ifdef FEATURE_EXTERNAL_FILTERS
1629 /*********************************************************************
1631 * Function : mark_socket_for_close_on_execute
1633 * Description : Marks a socket for close on execute.
1635 * Used so that external filters have no direct
1636 * access to sockets they shouldn't care about.
1638 * Not implemented for all platforms.
1641 * 1 : fd = The socket to mark
1645 *********************************************************************/
1646 void mark_socket_for_close_on_execute(jb_socket fd)
1648 #ifdef FEATURE_PTHREAD
1651 ret = fcntl(fd, F_SETFD, FD_CLOEXEC);
1655 log_error(LOG_LEVEL_ERROR,
1656 "fcntl(%d, F_SETFD, FD_CLOEXEC) failed", fd);
1659 #warning "Sockets will be visible to external filters"
1662 #endif /* def FEATURE_EXTERNAL_FILTERS */