-const char gateway_rcs[] = "$Id: gateway.c,v 1.26 2008/08/18 17:42:06 fabiankeil Exp $";
+const char gateway_rcs[] = "$Id: gateway.c,v 1.64 2009/10/03 10:37:49 fabiankeil Exp $";
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/gateway.c,v $
*
* Purpose : Contains functions to connect to a server, possibly
* using a "forwarder" (i.e. HTTP proxy and/or a SOCKS4
- * proxy).
+ * or SOCKS5 proxy).
*
- * Copyright : Written by and Copyright (C) 2001-2007 the SourceForge
+ * Copyright : Written by and Copyright (C) 2001-2009 the
* Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
* or write to the Free Software Foundation, Inc., 59
* Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
- * Revisions :
- * $Log: gateway.c,v $
- * Revision 1.26 2008/08/18 17:42:06 fabiankeil
- * Fix typo in macro name.
- *
- * Revision 1.25 2008/02/07 18:09:46 fabiankeil
- * In socks5_connect:
- * - make the buffers quite a bit smaller.
- * - properly report "socks5 server unreachable" failures.
- * - let strncpy() use the whole buffer. Using a length of 0xffu wasn't actually
- * wrong, but requires too much thinking as it doesn't depend on the buffer size.
- * - log a message if the socks5 server sends more data than expected.
- * - add some assertions and comments.
- *
- * Revision 1.24 2008/02/04 14:56:29 fabiankeil
- * - Fix a compiler warning.
- * - Stop assuming that htonl(INADDR_NONE) equals INADDR_NONE.
- *
- * Revision 1.23 2008/02/04 13:11:35 fabiankeil
- * Remember the cause of the SOCKS5 error for the CGI message.
- *
- * Revision 1.22 2008/02/03 13:46:15 fabiankeil
- * Add SOCKS5 support. Patch #1862863 by Eric M. Hopper with minor changes.
- *
- * Revision 1.21 2007/07/28 12:30:03 fabiankeil
- * Modified patch from Song Weijia (#1762559) to
- * fix socks requests on big-endian platforms.
- *
- * Revision 1.20 2007/05/14 10:23:48 fabiankeil
- * - Use strlcpy() instead of strcpy().
- * - Use the same buffer for socks requests and socks responses.
- * - Fix bogus warning about web_server_addr being used uninitialized.
- *
- * Revision 1.19 2007/01/25 14:09:45 fabiankeil
- * - Save errors in socks4_connect() to csp->error_message.
- * - Silence some gcc43 warnings, hopefully the right way.
- *
- * Revision 1.18 2006/07/18 14:48:46 david__schmidt
- * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
- * with what was really the latest development (the v_3_0_branch branch)
- *
- * Revision 1.16 2002/05/12 21:36:29 jongfoster
- * Correcting function comments
- *
- * Revision 1.15 2002/03/26 22:29:54 swa
- * we have a new homepage!
- *
- * Revision 1.14 2002/03/24 13:25:43 swa
- * name change related issues
- *
- * Revision 1.13 2002/03/13 00:29:59 jongfoster
- * Killing warnings
- *
- * Revision 1.12 2002/03/09 20:03:52 jongfoster
- * - Making various functions return int rather than size_t.
- * (Undoing a recent change). Since size_t is unsigned on
- * Windows, functions like read_socket that return -1 on
- * error cannot return a size_t.
- *
- * THIS WAS A MAJOR BUG - it caused frequent, unpredictable
- * crashes, and also frequently caused JB to jump to 100%
- * CPU and stay there. (Because it thought it had just
- * read ((unsigned)-1) == 4Gb of data...)
- *
- * - The signature of write_socket has changed, it now simply
- * returns success=0/failure=nonzero.
- *
- * - Trying to get rid of a few warnings --with-debug on
- * Windows, I've introduced a new type "jb_socket". This is
- * used for the socket file descriptors. On Windows, this
- * is SOCKET (a typedef for unsigned). Everywhere else, it's
- * an int. The error value can't be -1 any more, so it's
- * now JB_INVALID_SOCKET (which is -1 on UNIX, and in
- * Windows it maps to the #define INVALID_SOCKET.)
- *
- * - The signature of bind_port has changed.
- *
- * Revision 1.11 2002/03/08 17:46:04 jongfoster
- * Fixing int/size_t warnings
- *
- * Revision 1.10 2002/03/07 03:50:19 oes
- * - Improved handling of failed DNS lookups
- * - Fixed compiler warnings
- *
- * Revision 1.9 2001/10/25 03:40:48 david__schmidt
- * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
- * threads to call select() simultaneously. So, it's time to do a real, live,
- * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
- * (native). Both versions will work, but using __OS2__ offers multi-threading.
- *
- * Revision 1.8 2001/09/13 20:10:12 jongfoster
- * Fixing missing #include under Windows
- *
- * Revision 1.7 2001/09/12 17:58:26 steudten
- *
- * add #include <string.h>
- *
- * Revision 1.6 2001/09/10 10:41:16 oes
- * Added #include in.h
- *
- * Revision 1.5 2001/07/29 18:47:57 jongfoster
- * Adding missing #include project.h
- *
- * Revision 1.4 2001/07/24 12:47:06 oes
- * Applied BeOS support update by Eugenia
- *
- * Revision 1.3 2001/06/09 10:55:28 jongfoster
- * Changing BUFSIZ ==> BUFFER_SIZE
- *
- * Revision 1.2 2001/06/07 23:11:38 jongfoster
- * Removing gateways[] list - no longer used.
- * Replacing function pointer in struct gateway with a directly
- * called function forwarded_connect(), which can do the common
- * task of deciding whether to connect to the web server or HTTP
- * proxy.
- * Replacing struct gateway with struct forward_spec
- * Fixing bug with SOCKS4A and HTTP proxy server in combination.
- * It was a bug which led to the connection being made to the web
- * server rather than the HTTP proxy, and also a buffer overrun.
- *
- * Revision 1.1.1.1 2001/05/15 13:58:54 oes
- * Initial import of version 2.9.3 source tree
- *
- *
*********************************************************************/
-\f
+
#include "config.h"
#include "jbsockets.h"
#include "gateway.h"
#include "miscutil.h"
+#ifdef FEATURE_CONNECTION_KEEP_ALIVE
+#ifdef HAVE_POLL
+#ifdef __GLIBC__
+#include <sys/poll.h>
+#else
+#include <poll.h>
+#endif /* def __GLIBC__ */
+#endif /* HAVE_POLL */
+#endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
const char gateway_h_rcs[] = GATEWAY_H_VERSION;
static const char socks_userid[] = "anonymous";
+#ifdef FEATURE_CONNECTION_SHARING
+
+#define MAX_REUSABLE_CONNECTIONS 100
+static unsigned int keep_alive_timeout = DEFAULT_KEEP_ALIVE_TIMEOUT;
+
+static struct reusable_connection reusable_connection[MAX_REUSABLE_CONNECTIONS];
+static int mark_connection_unused(const struct reusable_connection *connection);
+
+/*********************************************************************
+ *
+ * Function : initialize_reusable_connections
+ *
+ * Description : Initializes the reusable_connection structures.
+ * Must be called with connection_reuse_mutex locked.
+ *
+ * Parameters : N/A
+ *
+ * Returns : void
+ *
+ *********************************************************************/
+extern void initialize_reusable_connections(void)
+{
+ unsigned int slot = 0;
+
+#if !defined(HAVE_POLL) && !defined(_WIN32)
+ log_error(LOG_LEVEL_INFO,
+ "Detecting already dead connections might not work "
+ "correctly on your platform. In case of problems, "
+ "unset the keep-alive-timeout option.");
+#endif
+
+ for (slot = 0; slot < SZ(reusable_connection); slot++)
+ {
+ mark_connection_closed(&reusable_connection[slot]);
+ }
+
+ log_error(LOG_LEVEL_CONNECT, "Initialized %d socket slots.", slot);
+}
+
+
+/*********************************************************************
+ *
+ * Function : remember_connection
+ *
+ * Description : Remembers a server connection for reuse later on.
+ *
+ * Parameters :
+ * 1 : connection = The server connection to remember.
+ *
+ * Returns : void
+ *
+ *********************************************************************/
+void remember_connection(const struct reusable_connection *connection)
+{
+ unsigned int slot = 0;
+ int free_slot_found = FALSE;
+
+ assert(NULL != connection);
+ assert(connection->sfd != JB_INVALID_SOCKET);
+
+ if (mark_connection_unused(connection))
+ {
+ return;
+ }
+
+ privoxy_mutex_lock(&connection_reuse_mutex);
+
+ /* Find free socket slot. */
+ for (slot = 0; slot < SZ(reusable_connection); slot++)
+ {
+ if (reusable_connection[slot].sfd == JB_INVALID_SOCKET)
+ {
+ assert(reusable_connection[slot].in_use == 0);
+ log_error(LOG_LEVEL_CONNECT,
+ "Remembering socket %d for %s:%d in slot %d.",
+ connection->sfd, connection->host, connection->port, slot);
+ free_slot_found = TRUE;
+ break;
+ }
+ }
+
+ if (!free_slot_found)
+ {
+ log_error(LOG_LEVEL_CONNECT,
+ "No free slots found to remembering socket for %s:%d. Last slot %d.",
+ connection->host, connection->port, slot);
+ privoxy_mutex_unlock(&connection_reuse_mutex);
+ close_socket(connection->sfd);
+ return;
+ }
+
+ assert(NULL != connection->host);
+ reusable_connection[slot].host = strdup(connection->host);
+ if (NULL == reusable_connection[slot].host)
+ {
+ log_error(LOG_LEVEL_FATAL, "Out of memory saving socket.");
+ }
+ reusable_connection[slot].sfd = connection->sfd;
+ reusable_connection[slot].port = connection->port;
+ reusable_connection[slot].in_use = 0;
+ reusable_connection[slot].timestamp = connection->timestamp;
+ reusable_connection->request_sent = connection->request_sent;
+ reusable_connection->response_received = connection->response_received;
+ reusable_connection[slot].keep_alive_timeout = connection->keep_alive_timeout;
+
+ assert(reusable_connection[slot].gateway_host == NULL);
+ assert(reusable_connection[slot].gateway_port == 0);
+ assert(reusable_connection[slot].forwarder_type == SOCKS_NONE);
+ assert(reusable_connection[slot].forward_host == NULL);
+ assert(reusable_connection[slot].forward_port == 0);
+
+ reusable_connection[slot].forwarder_type = connection->forwarder_type;
+ if (NULL != connection->gateway_host)
+ {
+ reusable_connection[slot].gateway_host = strdup(connection->gateway_host);
+ if (NULL == reusable_connection[slot].gateway_host)
+ {
+ log_error(LOG_LEVEL_FATAL, "Out of memory saving gateway_host.");
+ }
+ }
+ else
+ {
+ reusable_connection[slot].gateway_host = NULL;
+ }
+ reusable_connection[slot].gateway_port = connection->gateway_port;
+
+ if (NULL != connection->forward_host)
+ {
+ reusable_connection[slot].forward_host = strdup(connection->forward_host);
+ if (NULL == reusable_connection[slot].forward_host)
+ {
+ log_error(LOG_LEVEL_FATAL, "Out of memory saving forward_host.");
+ }
+ }
+ else
+ {
+ reusable_connection[slot].forward_host = NULL;
+ }
+ reusable_connection[slot].forward_port = connection->forward_port;
+
+ privoxy_mutex_unlock(&connection_reuse_mutex);
+}
+#endif /* def FEATURE_CONNECTION_SHARING */
+
+
+#ifdef FEATURE_CONNECTION_KEEP_ALIVE
+/*********************************************************************
+ *
+ * Function : mark_connection_closed
+ *
+ * Description : Marks a reused connection closed.
+ *
+ * Parameters :
+ * 1 : closed_connection = The connection to mark as closed.
+ *
+ * Returns : void
+ *
+ *********************************************************************/
+void mark_connection_closed(struct reusable_connection *closed_connection)
+{
+ closed_connection->in_use = FALSE;
+ closed_connection->sfd = JB_INVALID_SOCKET;
+ freez(closed_connection->host);
+ closed_connection->port = 0;
+ closed_connection->timestamp = 0;
+ closed_connection->request_sent = 0;
+ closed_connection->response_received = 0;
+ closed_connection->keep_alive_timeout = 0;
+ closed_connection->forwarder_type = SOCKS_NONE;
+ freez(closed_connection->gateway_host);
+ closed_connection->gateway_port = 0;
+ freez(closed_connection->forward_host);
+ closed_connection->forward_port = 0;
+}
+#endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
+
+
+#ifdef FEATURE_CONNECTION_SHARING
+/*********************************************************************
+ *
+ * Function : forget_connection
+ *
+ * Description : Removes a previously remembered connection from
+ * the list of reusable connections.
+ *
+ * Parameters :
+ * 1 : sfd = The socket belonging to the connection in question.
+ *
+ * Returns : void
+ *
+ *********************************************************************/
+void forget_connection(jb_socket sfd)
+{
+ unsigned int slot = 0;
+
+ assert(sfd != JB_INVALID_SOCKET);
+
+ privoxy_mutex_lock(&connection_reuse_mutex);
+
+ for (slot = 0; slot < SZ(reusable_connection); slot++)
+ {
+ if (reusable_connection[slot].sfd == sfd)
+ {
+ assert(reusable_connection[slot].in_use);
+
+ log_error(LOG_LEVEL_CONNECT,
+ "Forgetting socket %d for %s:%d in slot %d.",
+ sfd, reusable_connection[slot].host,
+ reusable_connection[slot].port, slot);
+ mark_connection_closed(&reusable_connection[slot]);
+ privoxy_mutex_unlock(&connection_reuse_mutex);
+
+ return;
+ }
+ }
+
+ log_error(LOG_LEVEL_CONNECT,
+ "Socket %d already forgotten or never remembered.", sfd);
+
+ privoxy_mutex_unlock(&connection_reuse_mutex);
+}
+#endif /* def FEATURE_CONNECTION_SHARING */
+
+
+#ifdef FEATURE_CONNECTION_KEEP_ALIVE
+/*********************************************************************
+ *
+ * Function : connection_destination_matches
+ *
+ * Description : Determines whether a remembered connection can
+ * be reused. That is, whether the destination and
+ * the forwarding settings match.
+ *
+ * Parameters :
+ * 1 : connection = The connection to check.
+ * 2 : http = The destination for the connection.
+ * 3 : fwd = The forwarder settings.
+ *
+ * Returns : TRUE for yes, FALSE otherwise.
+ *
+ *********************************************************************/
+int connection_destination_matches(const struct reusable_connection *connection,
+ const struct http_request *http,
+ const struct forward_spec *fwd)
+{
+ if ((connection->forwarder_type != fwd->type)
+ || (connection->gateway_port != fwd->gateway_port)
+ || (connection->forward_port != fwd->forward_port)
+ || (connection->port != http->port))
+ {
+ return FALSE;
+ }
+
+ if (( (NULL != connection->gateway_host)
+ && (NULL != fwd->gateway_host)
+ && strcmpic(connection->gateway_host, fwd->gateway_host))
+ && (connection->gateway_host != fwd->gateway_host))
+ {
+ log_error(LOG_LEVEL_CONNECT, "Gateway mismatch.");
+ return FALSE;
+ }
+
+ if (( (NULL != connection->forward_host)
+ && (NULL != fwd->forward_host)
+ && strcmpic(connection->forward_host, fwd->forward_host))
+ && (connection->forward_host != fwd->forward_host))
+ {
+ log_error(LOG_LEVEL_CONNECT, "Forwarding proxy mismatch.");
+ return FALSE;
+ }
+
+ return (!strcmpic(connection->host, http->host));
+
+}
+#endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
+
+
+#ifdef FEATURE_CONNECTION_SHARING
+/*********************************************************************
+ *
+ * Function : close_unusable_connections
+ *
+ * Description : Closes remembered connections that have timed
+ * out or have been closed on the other side.
+ *
+ * Parameters : none
+ *
+ * Returns : Number of connections that are still alive.
+ *
+ *********************************************************************/
+int close_unusable_connections(void)
+{
+ unsigned int slot = 0;
+ int connections_alive = 0;
+
+ privoxy_mutex_lock(&connection_reuse_mutex);
+
+ for (slot = 0; slot < SZ(reusable_connection); slot++)
+ {
+ if (!reusable_connection[slot].in_use
+ && (JB_INVALID_SOCKET != reusable_connection[slot].sfd))
+ {
+ time_t time_open = time(NULL) - reusable_connection[slot].timestamp;
+ time_t latency = (reusable_connection[slot].response_received -
+ reusable_connection[slot].request_sent) / 2;
+
+ if (reusable_connection[slot].keep_alive_timeout < time_open + latency)
+ {
+ log_error(LOG_LEVEL_CONNECT,
+ "The connection to %s:%d in slot %d timed out. "
+ "Closing socket %d. Timeout is: %d. Assumed latency: %d.",
+ reusable_connection[slot].host,
+ reusable_connection[slot].port, slot,
+ reusable_connection[slot].sfd,
+ reusable_connection[slot].keep_alive_timeout,
+ latency);
+ close_socket(reusable_connection[slot].sfd);
+ mark_connection_closed(&reusable_connection[slot]);
+ }
+ else if (!socket_is_still_alive(reusable_connection[slot].sfd))
+ {
+ log_error(LOG_LEVEL_CONNECT,
+ "The connection to %s:%d in slot %d is no longer usable. "
+ "Closing socket %d.", reusable_connection[slot].host,
+ reusable_connection[slot].port, slot,
+ reusable_connection[slot].sfd);
+ close_socket(reusable_connection[slot].sfd);
+ mark_connection_closed(&reusable_connection[slot]);
+ }
+ else
+ {
+ connections_alive++;
+ }
+ }
+ }
+
+ privoxy_mutex_unlock(&connection_reuse_mutex);
+
+ return connections_alive;
+
+}
+
+
+/*********************************************************************
+ *
+ * Function : get_reusable_connection
+ *
+ * Description : Returns an open socket to a previously remembered
+ * open connection (if there is one).
+ *
+ * Parameters :
+ * 1 : http = The destination for the connection.
+ * 2 : fwd = The forwarder settings.
+ *
+ * Returns : JB_INVALID_SOCKET => No reusable connection found,
+ * otherwise a usable socket.
+ *
+ *********************************************************************/
+static jb_socket get_reusable_connection(const struct http_request *http,
+ const struct forward_spec *fwd)
+{
+ jb_socket sfd = JB_INVALID_SOCKET;
+ unsigned int slot = 0;
+
+ close_unusable_connections();
+
+ privoxy_mutex_lock(&connection_reuse_mutex);
+
+ for (slot = 0; slot < SZ(reusable_connection); slot++)
+ {
+ if (!reusable_connection[slot].in_use
+ && (JB_INVALID_SOCKET != reusable_connection[slot].sfd))
+ {
+ if (connection_destination_matches(&reusable_connection[slot], http, fwd))
+ {
+ reusable_connection[slot].in_use = TRUE;
+ sfd = reusable_connection[slot].sfd;
+ log_error(LOG_LEVEL_CONNECT,
+ "Found reusable socket %d for %s:%d in slot %d. "
+ "Timestamp made %d seconds ago. Timeout: %d. Latency: %d.",
+ sfd, reusable_connection[slot].host, reusable_connection[slot].port,
+ slot, time(NULL) - reusable_connection[slot].timestamp,
+ reusable_connection[slot].keep_alive_timeout,
+ (int)(reusable_connection[slot].response_received -
+ reusable_connection[slot].request_sent));
+ break;
+ }
+ }
+ }
+
+ privoxy_mutex_unlock(&connection_reuse_mutex);
+
+ return sfd;
+
+}
+
+
+/*********************************************************************
+ *
+ * Function : mark_connection_unused
+ *
+ * Description : Gives a remembered connection free for reuse.
+ *
+ * Parameters :
+ * 1 : connection = The connection in question.
+ *
+ * Returns : TRUE => Socket found and marked as unused.
+ * FALSE => Socket not found.
+ *
+ *********************************************************************/
+static int mark_connection_unused(const struct reusable_connection *connection)
+{
+ unsigned int slot = 0;
+ int socket_found = FALSE;
+
+ assert(connection->sfd != JB_INVALID_SOCKET);
+
+ privoxy_mutex_lock(&connection_reuse_mutex);
+
+ for (slot = 0; slot < SZ(reusable_connection); slot++)
+ {
+ if (reusable_connection[slot].sfd == connection->sfd)
+ {
+ assert(reusable_connection[slot].in_use);
+ socket_found = TRUE;
+ log_error(LOG_LEVEL_CONNECT,
+ "Marking open socket %d for %s:%d in slot %d as unused.",
+ connection->sfd, reusable_connection[slot].host,
+ reusable_connection[slot].port, slot);
+ reusable_connection[slot].in_use = 0;
+ reusable_connection[slot].timestamp = connection->timestamp;
+ break;
+ }
+ }
+
+ privoxy_mutex_unlock(&connection_reuse_mutex);
+
+ return socket_found;
+
+}
+
+
+/*********************************************************************
+ *
+ * Function : set_keep_alive_timeout
+ *
+ * Description : Sets the timeout after which open
+ * connections will no longer be reused.
+ *
+ * Parameters :
+ * 1 : timeout = The timeout in seconds.
+ *
+ * Returns : void
+ *
+ *********************************************************************/
+void set_keep_alive_timeout(unsigned int timeout)
+{
+ keep_alive_timeout = timeout;
+}
+#endif /* def FEATURE_CONNECTION_SHARING */
+
/*********************************************************************
*
int dest_port;
jb_socket sfd = JB_INVALID_SOCKET;
+#ifdef FEATURE_CONNECTION_SHARING
+ if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
+ && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED))
+ {
+ sfd = get_reusable_connection(http, fwd);
+ if (JB_INVALID_SOCKET != sfd)
+ {
+ return sfd;
+ }
+ }
+#endif /* def FEATURE_CONNECTION_SHARING */
+
/* Figure out if we need to connect to the web server or a HTTP proxy. */
if (fwd->forward_host)
{
"SOCKS4 impossible internal error - bad SOCKS type.");
}
+ if (JB_INVALID_SOCKET != sfd)
+ {
+ log_error(LOG_LEVEL_CONNECT,
+ "Created new connection to %s:%d on socket %d.",
+ http->host, http->port, sfd);
+ }
+
return sfd;
}
int target_port,
struct client_state *csp)
{
- unsigned int web_server_addr;
+ unsigned long web_server_addr;
char buf[BUFFER_SIZE];
struct socks_op *c = (struct socks_op *)buf;
struct socks_reply *s = (struct socks_reply *)buf;
{
case SOCKS_REQUEST_GRANTED:
return(sfd);
- break;
case SOCKS_REQUEST_REJECT:
errstr = "SOCKS request rejected or failed.";
errno = EINVAL;
}
hostlen = strlen(target_host);
- if (hostlen > 255)
+ if (hostlen > (size_t)255)
{
errstr = "target host name is longer than 255 characters";
err = 1;
cbuf[client_pos++] = '\x00'; /* Reserved, must be 0x00 */
cbuf[client_pos++] = '\x03'; /* Address is domain name */
cbuf[client_pos++] = (char)(hostlen & 0xffu);
- assert(sizeof(cbuf) - client_pos > 255);
+ assert(sizeof(cbuf) - client_pos > (size_t)255);
/* Using strncpy because we really want the nul byte padding. */
strncpy(cbuf + client_pos, target_host, sizeof(cbuf) - client_pos);
client_pos += (hostlen & 0xffu);
- cbuf[client_pos++] = (char)((target_port >> 8) & 0xffu);
- cbuf[client_pos++] = (char)((target_port ) & 0xffu);
+ cbuf[client_pos++] = (char)((target_port >> 8) & 0xff);
+ cbuf[client_pos++] = (char)((target_port ) & 0xff);
if (write_socket(sfd, cbuf, client_pos))
{
return(sfd);
}
errstr = translate_socks5_error(sbuf[1]);
- err = 1;
}
assert(errstr != NULL);