1 const char jcc_rcs[] = "$Id: jcc.c,v 1.406 2012/10/21 14:40:44 fabiankeil Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/jcc.c,v $
6 * Purpose : Main file. Contains main() method, main loop, and
7 * the main connection-handling function.
9 * Copyright : Written by and Copyright (C) 2001-2012 the
10 * Privoxy team. http://www.privoxy.org/
12 * Based on the Internet Junkbuster originally written
13 * by and Copyright (C) 1997 Anonymous Coders and
14 * Junkbusters Corporation. http://www.junkbusters.com
16 * This program is free software; you can redistribute it
17 * and/or modify it under the terms of the GNU General
18 * Public License as published by the Free Software
19 * Foundation; either version 2 of the License, or (at
20 * your option) any later version.
22 * This program is distributed in the hope that it will
23 * be useful, but WITHOUT ANY WARRANTY; without even the
24 * implied warranty of MERCHANTABILITY or FITNESS FOR A
25 * PARTICULAR PURPOSE. See the GNU General Public
26 * License for more details.
28 * The GNU General Public License should be included with
29 * this file. If not, you can view it at
30 * http://www.gnu.org/copyleft/gpl.html
31 * or write to the Free Software Foundation, Inc., 59
32 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
34 *********************************************************************/
40 #include <sys/types.h>
49 # ifndef FEATURE_PTHREAD
55 # endif /* ndef FEATURE_PTHREAD */
60 # endif /* ndef _WIN_CONSOLE */
61 # include "w32svrapi.h"
63 #else /* ifndef _WIN32 */
65 # if !defined (__OS2__)
67 # include <sys/wait.h>
68 # endif /* ndef __OS2__ */
69 # include <sys/time.h>
70 # include <sys/stat.h>
71 # include <sys/ioctl.h>
74 #include <sys/termios.h>
85 # include <socket.h> /* BeOS has select() for sockets only. */
86 # include <OS.h> /* declarations for threads and stuff. */
89 # if defined(__EMX__) || defined(__OS2__)
90 # include <sys/select.h> /* OS/2/EMX needs a little help with select */
95 #define bzero(B,N) memset(B,0x00,n)
110 #include "miscutil.h"
112 #include "jbsockets.h"
117 #include "urlmatch.h"
119 const char jcc_h_rcs[] = JCC_H_VERSION;
120 const char project_h_rcs[] = PROJECT_H_VERSION;
123 struct client_states clients[1];
124 struct file_list files[1];
126 #ifdef FEATURE_STATISTICS
127 int urls_read = 0; /* total nr of urls read inc rejected */
128 int urls_rejected = 0; /* total nr of urls rejected */
129 #endif /* def FEATURE_STATISTICS */
131 #ifdef FEATURE_GRACEFUL_TERMINATION
135 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
136 static void sig_handler(int the_signal);
138 static int client_protocol_is_unsupported(const struct client_state *csp, char *req);
139 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers);
140 static jb_err get_server_headers(struct client_state *csp);
141 static const char *crunch_reason(const struct http_response *rsp);
142 static void send_crunch_response(const struct client_state *csp, struct http_response *rsp);
143 static char *get_request_line(struct client_state *csp);
144 static jb_err receive_client_request(struct client_state *csp);
145 static jb_err parse_client_request(struct client_state *csp);
146 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line);
147 static jb_err change_request_destination(struct client_state *csp);
148 static void chat(struct client_state *csp);
149 static void serve(struct client_state *csp);
150 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
151 static void usage(const char *myname);
153 static void initialize_mutexes(void);
154 static jb_socket bind_port_helper(const char *haddr, int hport);
155 static void bind_ports_helper(struct configuration_spec *config, jb_socket sockets[]);
156 static void close_ports_helper(jb_socket sockets[]);
157 static void listen_loop(void);
160 void serve(struct client_state *csp);
161 #else /* ifndef AMIGA */
162 static void serve(struct client_state *csp);
163 #endif /* def AMIGA */
166 static int32 server_thread(void *data);
167 #endif /* def __BEOS__ */
170 #define sleep(N) Sleep(((N) * 1000))
174 #define sleep(N) DosSleep(((N) * 100))
177 #ifdef MUTEX_LOCKS_AVAILABLE
179 * XXX: Does the locking stuff really belong in this file?
181 privoxy_mutex_t log_mutex;
182 privoxy_mutex_t log_init_mutex;
183 privoxy_mutex_t connection_reuse_mutex;
185 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
186 privoxy_mutex_t resolver_mutex;
187 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
189 #ifndef HAVE_GMTIME_R
190 privoxy_mutex_t gmtime_mutex;
191 #endif /* ndef HAVE_GMTIME_R */
193 #ifndef HAVE_LOCALTIME_R
194 privoxy_mutex_t localtime_mutex;
195 #endif /* ndef HAVE_GMTIME_R */
198 privoxy_mutex_t rand_mutex;
199 #endif /* ndef HAVE_RANDOM */
201 #endif /* def MUTEX_LOCKS_AVAILABLE */
204 const char *basedir = NULL;
205 const char *pidfile = NULL;
206 static int received_hup_signal = 0;
207 #endif /* defined unix */
209 /* HTTP snipplets. */
210 static const char CSUCCEED[] =
211 "HTTP/1.1 200 Connection established\r\n"
212 "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
214 static const char CHEADER[] =
215 "HTTP/1.1 400 Invalid header received from client\r\n"
216 "Proxy-Agent: Privoxy " VERSION "\r\n"
217 "Content-Type: text/plain\r\n"
218 "Connection: close\r\n\r\n"
219 "Invalid header received from client.\r\n";
221 static const char FTP_RESPONSE[] =
222 "HTTP/1.1 400 Invalid request received from client\r\n"
223 "Content-Type: text/plain\r\n"
224 "Connection: close\r\n\r\n"
225 "Invalid request. Privoxy doesn't support FTP.\r\n";
227 static const char GOPHER_RESPONSE[] =
228 "HTTP/1.1 400 Invalid request received from client\r\n"
229 "Content-Type: text/plain\r\n"
230 "Connection: close\r\n\r\n"
231 "Invalid request. Privoxy doesn't support gopher.\r\n";
233 /* XXX: should be a template */
234 static const char MISSING_DESTINATION_RESPONSE[] =
235 "HTTP/1.1 400 Bad request received from client\r\n"
236 "Proxy-Agent: Privoxy " VERSION "\r\n"
237 "Content-Type: text/plain\r\n"
238 "Connection: close\r\n\r\n"
239 "Bad request. Privoxy was unable to extract the destination.\r\n";
241 /* XXX: should be a template */
242 static const char INVALID_SERVER_HEADERS_RESPONSE[] =
243 "HTTP/1.1 502 Server or forwarder response invalid\r\n"
244 "Proxy-Agent: Privoxy " VERSION "\r\n"
245 "Content-Type: text/plain\r\n"
246 "Connection: close\r\n\r\n"
247 "Bad response. The server or forwarder response doesn't look like HTTP.\r\n";
249 /* XXX: should be a template */
250 static const char MESSED_UP_REQUEST_RESPONSE[] =
251 "HTTP/1.1 400 Malformed request after rewriting\r\n"
252 "Proxy-Agent: Privoxy " VERSION "\r\n"
253 "Content-Type: text/plain\r\n"
254 "Connection: close\r\n\r\n"
255 "Bad request. Messed up with header filters.\r\n";
257 static const char TOO_MANY_CONNECTIONS_RESPONSE[] =
258 "HTTP/1.1 503 Too many open connections\r\n"
259 "Proxy-Agent: Privoxy " VERSION "\r\n"
260 "Content-Type: text/plain\r\n"
261 "Connection: close\r\n\r\n"
262 "Maximum number of open connections reached.\r\n";
264 static const char CLIENT_CONNECTION_TIMEOUT_RESPONSE[] =
265 "HTTP/1.1 504 Connection timeout\r\n"
266 "Proxy-Agent: Privoxy " VERSION "\r\n"
267 "Content-Type: text/plain\r\n"
268 "Connection: close\r\n\r\n"
269 "The connection timed out because the client request didn't arrive in time.\r\n";
271 /* A function to crunch a response */
272 typedef struct http_response *(*crunch_func_ptr)(struct client_state *);
274 /* Crunch function flags */
275 #define CF_NO_FLAGS 0
276 /* Cruncher applies to forced requests as well */
277 #define CF_IGNORE_FORCE 1
278 /* Crunched requests are counted for the block statistics */
279 #define CF_COUNT_AS_REJECT 2
281 /* A crunch function and its flags */
284 const crunch_func_ptr cruncher;
288 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[]);
290 /* Complete list of cruncher functions */
291 static const struct cruncher crunchers_all[] = {
292 { direct_response, CF_COUNT_AS_REJECT|CF_IGNORE_FORCE},
293 { block_url, CF_COUNT_AS_REJECT },
295 { trust_url, CF_COUNT_AS_REJECT },
296 #endif /* def FEATURE_TRUST */
297 { redirect_url, CF_NO_FLAGS },
298 { dispatch_cgi, CF_IGNORE_FORCE},
302 /* Light version, used after tags are applied */
303 static const struct cruncher crunchers_light[] = {
304 { block_url, CF_COUNT_AS_REJECT },
305 { redirect_url, CF_NO_FLAGS },
311 * XXX: Don't we really mean
317 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
318 /*********************************************************************
320 * Function : sig_handler
322 * Description : Signal handler for different signals.
323 * Exit gracefully on TERM and INT
324 * or set a flag that will cause the errlog
325 * to be reopened by the main thread on HUP.
328 * 1 : the_signal = the signal cause this function to call
332 *********************************************************************/
333 static void sig_handler(int the_signal)
339 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
351 received_hup_signal = 1;
357 * We shouldn't be here, unless we catch signals
358 * in main() that we can't handle here!
360 log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
368 /*********************************************************************
370 * Function : client_protocol_is_unsupported
372 * Description : Checks if the client used a known unsupported
373 * protocol and deals with it by sending an error
377 * 1 : csp = Current client state (buffers, headers, etc...)
378 * 2 : req = the first request line send by the client
380 * Returns : TRUE if an error response has been generated, or
381 * FALSE if the request doesn't look invalid.
383 *********************************************************************/
384 static int client_protocol_is_unsupported(const struct client_state *csp, char *req)
387 * If it's a FTP or gopher request, we don't support it.
389 * These checks are better than nothing, but they might
390 * not work in all configurations and some clients might
391 * have problems digesting the answer.
393 * They should, however, never cause more problems than
394 * Privoxy's old behaviour (returning the misleading HTML
397 * "Could not resolve http://(ftp|gopher)://example.org").
399 if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
401 const char *response = NULL;
402 const char *protocol = NULL;
404 if (!strncmpic(req, "GET ftp://", 10))
406 response = FTP_RESPONSE;
411 response = GOPHER_RESPONSE;
414 log_error(LOG_LEVEL_ERROR,
415 "%s tried to use Privoxy as %s proxy: %s",
416 csp->ip_addr_str, protocol, req);
417 log_error(LOG_LEVEL_CLF,
418 "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, req);
420 write_socket(csp->cfd, response, strlen(response));
429 /*********************************************************************
431 * Function : get_request_destination_elsewhere
433 * Description : If the client's request was redirected into
434 * Privoxy without the client's knowledge,
435 * the request line lacks the destination host.
437 * This function tries to get it elsewhere,
438 * provided accept-intercepted-requests is enabled.
440 * "Elsewhere" currently only means "Host: header",
441 * but in the future we may ask the redirecting
442 * packet filter to look the destination up.
444 * If the destination stays unknown, an error
445 * response is send to the client and headers
446 * are freed so that chat() can return directly.
449 * 1 : csp = Current client state (buffers, headers, etc...)
450 * 2 : headers = a header list
452 * Returns : JB_ERR_OK if the destination is now known, or
453 * JB_ERR_PARSE if it isn't.
455 *********************************************************************/
456 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
460 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
462 log_error(LOG_LEVEL_ERROR, "%s's request: \'%s\' is invalid."
463 " Privoxy isn't configured to accept intercepted requests.",
464 csp->ip_addr_str, csp->http->cmd);
465 /* XXX: Use correct size */
466 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
467 csp->ip_addr_str, csp->http->cmd);
469 write_socket(csp->cfd, CHEADER, strlen(CHEADER));
470 destroy_list(headers);
474 else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
476 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
477 /* Split the domain we just got for pattern matching */
478 init_domain_components(csp->http);
485 /* We can't work without destination. Go spread the news.*/
487 req = list_to_text(headers);
489 /* XXX: Use correct size */
490 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
491 csp->ip_addr_str, csp->http->cmd);
492 log_error(LOG_LEVEL_ERROR,
493 "Privoxy was unable to get the destination for %s's request:\n%s\n%s",
494 csp->ip_addr_str, csp->http->cmd, req);
497 write_socket(csp->cfd, MISSING_DESTINATION_RESPONSE, strlen(MISSING_DESTINATION_RESPONSE));
498 destroy_list(headers);
503 * TODO: If available, use PF's ioctl DIOCNATLOOK as last resort
504 * to get the destination IP address, use it as host directly
505 * or do a reverse DNS lookup first.
510 /*********************************************************************
512 * Function : get_server_headers
514 * Description : Parses server headers in iob and fills them
515 * into csp->headers so that they can later be
519 * 1 : csp = Current client state (buffers, headers, etc...)
521 * Returns : JB_ERR_OK if everything went fine, or
522 * JB_ERR_PARSE if the headers were incomplete.
524 *********************************************************************/
525 static jb_err get_server_headers(struct client_state *csp)
527 int continue_hack_in_da_house = 0;
530 while (((header = get_header(csp->iob)) != NULL) || continue_hack_in_da_house)
535 * continue hack in da house. Ignore the ending of
536 * this head and continue enlisting header lines.
537 * The reason is described below.
539 enlist(csp->headers, "");
540 continue_hack_in_da_house = 0;
543 else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
546 * It's a bodyless continue response, don't
547 * stop header parsing after reaching its end.
549 * As a result Privoxy will concatenate the
550 * next response's head and parse and deliver
551 * the headers as if they belonged to one request.
553 * The client will separate them because of the
554 * empty line between them.
556 * XXX: What we're doing here is clearly against
557 * the intended purpose of the continue header,
558 * and under some conditions (HTTP/1.0 client request)
559 * it's a standard violation.
561 * Anyway, "sort of against the spec" is preferable
562 * to "always getting confused by Continue responses"
563 * (Privoxy's behaviour before this hack was added)
565 log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
566 continue_hack_in_da_house = 1;
568 else if (*header == '\0')
571 * If the header is empty, but the Continue hack
572 * isn't active, we can assume that we reached the
573 * end of the buffer before we hit the end of the
576 * Inform the caller an let it decide how to handle it.
581 if (JB_ERR_MEMORY == enlist(csp->headers, header))
584 * XXX: Should we quit the request and return a
585 * out of memory error page instead?
587 log_error(LOG_LEVEL_ERROR,
588 "Out of memory while enlisting server headers. %s lost.",
598 /*********************************************************************
600 * Function : crunch_reason
602 * Description : Translates the crunch reason code into a string.
605 * 1 : rsp = a http_response
607 * Returns : A string with the crunch reason or an error description.
609 *********************************************************************/
610 static const char *crunch_reason(const struct http_response *rsp)
612 char * reason = NULL;
617 return "Internal error while searching for crunch reason";
620 switch (rsp->crunch_reason)
623 reason = "Unsupported HTTP feature";
629 reason = "Untrusted";
632 reason = "Redirected";
638 reason = "DNS failure";
640 case FORWARDING_FAILED:
641 reason = "Forwarding failed";
644 reason = "Connection failure";
647 reason = "Out of memory (may mask other reasons)";
649 case CONNECTION_TIMEOUT:
650 reason = "Connection timeout";
653 reason = "No server data received";
656 reason = "No reason recorded";
664 /*********************************************************************
666 * Function : log_applied_actions
668 * Description : Logs the applied actions if LOG_LEVEL_ACTIONS is
672 * 1 : actions = Current action spec to log
676 *********************************************************************/
677 static void log_applied_actions(const struct current_action_spec *actions)
680 * The conversion to text requires lots of memory allocations so
681 * we only do the conversion if the user is actually interested.
683 if (debug_level_is_enabled(LOG_LEVEL_ACTIONS))
685 char *actions_as_text = actions_to_line_of_text(actions);
686 log_error(LOG_LEVEL_ACTIONS, "%s", actions_as_text);
687 freez(actions_as_text);
692 /*********************************************************************
694 * Function : send_crunch_response
696 * Description : Delivers already prepared response for
697 * intercepted requests, logs the interception
698 * and frees the response.
701 * 1 : csp = Current client state (buffers, headers, etc...)
702 * 1 : rsp = Fully prepared response. Will be freed on exit.
706 *********************************************************************/
707 static void send_crunch_response(const struct client_state *csp, struct http_response *rsp)
709 const struct http_request *http = csp->http;
713 assert(rsp->head != NULL);
717 log_error(LOG_LEVEL_FATAL, "NULL response in send_crunch_response.");
721 * Extract the status code from the actual head
722 * that will be send to the client. It is the only
723 * way to get it right for all requests, including
724 * the fixed ones for out-of-memory problems.
726 * A head starts like this: 'HTTP/1.1 200...'
730 status_code[0] = rsp->head[9];
731 status_code[1] = rsp->head[10];
732 status_code[2] = rsp->head[11];
733 status_code[3] = '\0';
735 /* Log that the request was crunched and why. */
736 log_applied_actions(csp->action);
737 log_error(LOG_LEVEL_CRUNCH, "%s: %s", crunch_reason(rsp), http->url);
738 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" %s %u",
739 csp->ip_addr_str, http->ocmd, status_code, rsp->content_length);
741 /* Write the answer to the client */
742 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
743 || write_socket(csp->cfd, rsp->body, rsp->content_length))
745 /* There is nothing we can do about it. */
746 log_error(LOG_LEVEL_ERROR,
747 "Couldn't deliver the error message through client socket %d: %E",
751 /* Clean up and return */
752 if (cgi_error_memory() != rsp)
754 free_http_response(rsp);
760 /*********************************************************************
762 * Function : crunch_response_triggered
764 * Description : Checks if the request has to be crunched,
765 * and delivers the crunch response if necessary.
768 * 1 : csp = Current client state (buffers, headers, etc...)
769 * 2 : crunchers = list of cruncher functions to run
771 * Returns : TRUE if the request was answered with a crunch response
774 *********************************************************************/
775 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[])
777 struct http_response *rsp = NULL;
778 const struct cruncher *c;
781 * If CGI request crunching is disabled,
782 * check the CGI dispatcher out of order to
783 * prevent unintentional blocks or redirects.
785 if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_CRUNCHING)
786 && (NULL != (rsp = dispatch_cgi(csp))))
788 /* Deliver, log and free the interception response. */
789 send_crunch_response(csp, rsp);
790 csp->flags |= CSP_FLAG_CRUNCHED;
794 for (c = crunchers; c->cruncher != NULL; c++)
797 * Check the cruncher if either Privoxy is toggled
798 * on and the request isn't forced, or if the cruncher
799 * applies to forced requests as well.
801 if (((csp->flags & CSP_FLAG_TOGGLED_ON) &&
802 !(csp->flags & CSP_FLAG_FORCED)) ||
803 (c->flags & CF_IGNORE_FORCE))
805 rsp = c->cruncher(csp);
808 /* Deliver, log and free the interception response. */
809 send_crunch_response(csp, rsp);
810 csp->flags |= CSP_FLAG_CRUNCHED;
811 #ifdef FEATURE_STATISTICS
812 if (c->flags & CF_COUNT_AS_REJECT)
814 csp->flags |= CSP_FLAG_REJECTED;
816 #endif /* def FEATURE_STATISTICS */
827 /*********************************************************************
829 * Function : build_request_line
831 * Description : Builds the HTTP request line.
833 * If a HTTP forwarder is used it expects the whole URL,
834 * web servers only get the path.
837 * 1 : csp = Current client state (buffers, headers, etc...)
838 * 2 : fwd = The forwarding spec used for the request
839 * XXX: Should use http->fwd instead.
840 * 3 : request_line = The old request line which will be replaced.
842 * Returns : Nothing. Terminates in case of memory problems.
844 *********************************************************************/
845 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line)
847 struct http_request *http = csp->http;
849 assert(http->ssl == 0);
852 * Downgrade http version from 1.1 to 1.0
853 * if +downgrade action applies.
855 if ((csp->action->flags & ACTION_DOWNGRADE)
856 && (!strcmpic(http->ver, "HTTP/1.1")))
859 http->ver = strdup_or_die("HTTP/1.0");
863 * Rebuild the request line.
865 freez(*request_line);
866 *request_line = strdup(http->gpc);
867 string_append(request_line, " ");
869 if (fwd->forward_host)
871 string_append(request_line, http->url);
875 string_append(request_line, http->path);
877 string_append(request_line, " ");
878 string_append(request_line, http->ver);
880 if (*request_line == NULL)
882 log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
884 log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", *request_line);
888 /*********************************************************************
890 * Function : change_request_destination
892 * Description : Parse a (rewritten) request line and regenerate
893 * the http request data.
896 * 1 : csp = Current client state (buffers, headers, etc...)
898 * Returns : Forwards the parse_http_request() return code.
899 * Terminates in case of memory problems.
901 *********************************************************************/
902 static jb_err change_request_destination(struct client_state *csp)
904 struct http_request *http = csp->http;
907 log_error(LOG_LEVEL_INFO, "Rewrite detected: %s", csp->headers->first->str);
908 free_http_request(http);
909 err = parse_http_request(csp->headers->first->str, http);
910 if (JB_ERR_OK != err)
912 log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
913 jb_err_to_string(err));
917 /* XXX: ocmd is a misleading name */
918 http->ocmd = strdup_or_die(http->cmd);
925 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
926 /*********************************************************************
928 * Function : server_response_is_complete
930 * Description : Determines whether we should stop reading
931 * from the server socket.
934 * 1 : csp = Current client state (buffers, headers, etc...)
935 * 2 : content_length = Length of content received so far.
937 * Returns : TRUE if the response is complete,
940 *********************************************************************/
941 static int server_response_is_complete(struct client_state *csp,
942 unsigned long long content_length)
944 int content_length_known = !!(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET);
946 if (!strcmpic(csp->http->gpc, "HEAD"))
949 * "HEAD" implies no body, we are thus expecting
950 * no content. XXX: incomplete "list" of methods?
952 csp->expected_content_length = 0;
953 content_length_known = TRUE;
956 if (csp->http->status == 204 || csp->http->status == 304)
959 * Expect no body. XXX: incomplete "list" of status codes?
961 csp->expected_content_length = 0;
962 content_length_known = TRUE;
965 return (content_length_known && ((0 == csp->expected_content_length)
966 || (csp->expected_content_length <= content_length)));
970 #ifdef FEATURE_CONNECTION_SHARING
971 /*********************************************************************
973 * Function : wait_for_alive_connections
975 * Description : Waits for alive connections to timeout.
981 *********************************************************************/
982 static void wait_for_alive_connections(void)
984 int connections_alive = close_unusable_connections();
986 while (0 < connections_alive)
988 log_error(LOG_LEVEL_CONNECT,
989 "Waiting for %d connections to timeout.",
992 connections_alive = close_unusable_connections();
995 log_error(LOG_LEVEL_CONNECT, "No connections to wait for left.");
998 #endif /* def FEATURE_CONNECTION_SHARING */
1001 /*********************************************************************
1003 * Function : save_connection_destination
1005 * Description : Remembers a connection for reuse later on.
1008 * 1 : sfd = Open socket to remember.
1009 * 2 : http = The destination for the connection.
1010 * 3 : fwd = The forwarder settings used.
1011 * 3 : server_connection = storage.
1015 *********************************************************************/
1016 void save_connection_destination(jb_socket sfd,
1017 const struct http_request *http,
1018 const struct forward_spec *fwd,
1019 struct reusable_connection *server_connection)
1021 assert(sfd != JB_INVALID_SOCKET);
1022 assert(NULL != http->host);
1024 server_connection->sfd = sfd;
1025 server_connection->host = strdup_or_die(http->host);
1026 server_connection->port = http->port;
1028 assert(NULL != fwd);
1029 assert(server_connection->gateway_host == NULL);
1030 assert(server_connection->gateway_port == 0);
1031 assert(server_connection->forwarder_type == 0);
1032 assert(server_connection->forward_host == NULL);
1033 assert(server_connection->forward_port == 0);
1035 server_connection->forwarder_type = fwd->type;
1036 if (NULL != fwd->gateway_host)
1038 server_connection->gateway_host = strdup_or_die(fwd->gateway_host);
1042 server_connection->gateway_host = NULL;
1044 server_connection->gateway_port = fwd->gateway_port;
1046 if (NULL != fwd->forward_host)
1048 server_connection->forward_host = strdup_or_die(fwd->forward_host);
1052 server_connection->forward_host = NULL;
1054 server_connection->forward_port = fwd->forward_port;
1058 /*********************************************************************
1060 * Function : verify_request_length
1062 * Description : Checks if we already got the whole client requests
1063 * and sets CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ if
1066 * Data that doesn't belong to the current request is
1067 * thrown away to let the client retry on a clean socket.
1069 * XXX: This is a hack until we can deal with multiple
1070 * pipelined requests at the same time.
1074 * 1 : csp = Current client state (buffers, headers, etc...)
1078 *********************************************************************/
1079 static void verify_request_length(struct client_state *csp)
1081 unsigned long long buffered_request_bytes =
1082 (unsigned long long)(csp->client_iob->eod - csp->client_iob->cur);
1084 if ((csp->expected_client_content_length != 0)
1085 && (buffered_request_bytes != 0))
1087 if (csp->expected_client_content_length >= buffered_request_bytes)
1089 csp->expected_client_content_length -= buffered_request_bytes;
1090 log_error(LOG_LEVEL_CONNECT, "Reduced expected bytes to %llu "
1091 "to account for the %llu ones we already got.",
1092 csp->expected_client_content_length, buffered_request_bytes);
1096 assert(csp->client_iob->eod > csp->client_iob->cur + csp->expected_client_content_length);
1097 csp->client_iob->eod = csp->client_iob->cur + csp->expected_client_content_length;
1098 log_error(LOG_LEVEL_CONNECT, "Reducing expected bytes to 0. "
1099 "Marking the server socket tainted after throwing %llu bytes away.",
1100 buffered_request_bytes - csp->expected_client_content_length);
1101 csp->expected_client_content_length = 0;
1102 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1105 if (csp->expected_client_content_length == 0)
1107 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1111 if (!(csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ)
1112 && ((csp->client_iob->cur[0] != '\0') || (csp->expected_client_content_length != 0)))
1114 if (strcmpic(csp->http->gpc, "GET")
1115 && strcmpic(csp->http->gpc, "HEAD")
1116 && strcmpic(csp->http->gpc, "TRACE")
1117 && strcmpic(csp->http->gpc, "OPTIONS")
1118 && strcmpic(csp->http->gpc, "DELETE"))
1120 /* XXX: this is an incomplete hack */
1121 csp->flags &= ~CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1122 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1123 log_error(LOG_LEVEL_CONNECT,
1124 "There might be a request body. The connection will not be kept alive.");
1128 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1130 if ((csp->config->feature_flags & RUNTIME_FEATURE_TOLERATE_PIPELINING) == 0)
1132 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1133 log_error(LOG_LEVEL_CONNECT,
1134 "Possible pipeline attempt detected. The connection will not "
1135 "be kept alive and we will only serve the first request.");
1136 /* Nuke the pipelined requests from orbit, just to be sure. */
1137 clear_iob(csp->client_iob);
1142 * Keep the pipelined data around for now, we'll deal with
1143 * it once we're done serving the current request.
1145 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
1146 assert(csp->client_iob->eod > csp->client_iob->cur);
1147 log_error(LOG_LEVEL_CONNECT, "Complete client request followed by "
1148 "%d bytes of pipelined data received.",
1149 (int)(csp->client_iob->eod - csp->client_iob->cur));
1155 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1156 log_error(LOG_LEVEL_CONNECT, "Complete client request received.");
1159 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1162 /*********************************************************************
1164 * Function : mark_server_socket_tainted
1166 * Description : Makes sure we don't reuse a server socket
1167 * (if we didn't read everything the server sent
1168 * us reusing the socket would lead to garbage).
1171 * 1 : csp = Current client state (buffers, headers, etc...)
1175 *********************************************************************/
1176 static void mark_server_socket_tainted(struct client_state *csp)
1179 * For consistency we always mark the server socket
1180 * tainted, however, to reduce the log noise we only
1181 * emit a log message if the server socket could have
1182 * actually been reused.
1184 if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
1185 && !(csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED))
1187 log_error(LOG_LEVEL_CONNECT,
1188 "Marking the server socket %d tainted.",
1189 csp->server_connection.sfd);
1191 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1194 /*********************************************************************
1196 * Function : get_request_line
1198 * Description : Read the client request line.
1201 * 1 : csp = Current client state (buffers, headers, etc...)
1203 * Returns : Pointer to request line or NULL in case of errors.
1205 *********************************************************************/
1206 static char *get_request_line(struct client_state *csp)
1208 char buf[BUFFER_SIZE];
1209 char *request_line = NULL;
1212 memset(buf, 0, sizeof(buf));
1214 if ((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
1217 * If there are multiple pipelined requests waiting,
1218 * the flag will be set again once the next request
1221 csp->flags &= ~CSP_FLAG_PIPELINED_REQUEST_WAITING;
1223 request_line = get_header(csp->client_iob);
1224 if ((NULL != request_line) && ('\0' != *request_line))
1226 return request_line;
1230 log_error(LOG_LEVEL_CONNECT, "No complete request line "
1231 "received yet. Continuing reading from %d.", csp->cfd);
1237 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1239 if (socket_is_still_alive(csp->cfd))
1241 log_error(LOG_LEVEL_CONNECT,
1242 "No request line on socket %d received in time. Timeout: %d.",
1243 csp->cfd, csp->config->socket_timeout);
1244 write_socket(csp->cfd, CLIENT_CONNECTION_TIMEOUT_RESPONSE,
1245 strlen(CLIENT_CONNECTION_TIMEOUT_RESPONSE));
1249 log_error(LOG_LEVEL_CONNECT,
1250 "The client side of the connection on socket %d got "
1251 "closed without sending a complete request line.", csp->cfd);
1256 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1258 if (len <= 0) return NULL;
1261 * If there is no memory left for buffering the
1262 * request, there is nothing we can do but hang up
1264 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1269 request_line = get_header(csp->client_iob);
1271 } while ((NULL != request_line) && ('\0' == *request_line));
1273 return request_line;
1278 /*********************************************************************
1280 * Function : receive_client_request
1282 * Description : Read the client's request (more precisely the
1283 * client headers) and answer it if necessary.
1286 * 1 : csp = Current client state (buffers, headers, etc...)
1288 * Returns : JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
1290 *********************************************************************/
1291 static jb_err receive_client_request(struct client_state *csp)
1293 char buf[BUFFER_SIZE];
1296 struct http_request *http;
1300 /* Temporary copy of the client's headers before they get enlisted in csp->headers */
1301 struct list header_list;
1302 struct list *headers = &header_list;
1304 /* We don't care if the arriving data is a valid HTTP request or not. */
1305 csp->requests_received_total++;
1309 memset(buf, 0, sizeof(buf));
1311 req = get_request_line(csp);
1314 mark_server_socket_tainted(csp);
1315 return JB_ERR_PARSE;
1317 assert(*req != '\0');
1319 if (client_protocol_is_unsupported(csp, req))
1321 return JB_ERR_PARSE;
1324 #ifdef FEATURE_FORCE_LOAD
1326 * If this request contains the FORCE_PREFIX and blocks
1327 * aren't enforced, get rid of it and set the force flag.
1329 if (strstr(req, FORCE_PREFIX))
1331 if (csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS)
1333 log_error(LOG_LEVEL_FORCE,
1334 "Ignored force prefix in request: \"%s\".", req);
1338 strclean(req, FORCE_PREFIX);
1339 log_error(LOG_LEVEL_FORCE, "Enforcing request: \"%s\".", req);
1340 csp->flags |= CSP_FLAG_FORCED;
1343 #endif /* def FEATURE_FORCE_LOAD */
1345 err = parse_http_request(req, http);
1347 if (JB_ERR_OK != err)
1349 write_socket(csp->cfd, CHEADER, strlen(CHEADER));
1350 /* XXX: Use correct size */
1351 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1352 log_error(LOG_LEVEL_ERROR,
1353 "Couldn't parse request line received from %s: %s",
1354 csp->ip_addr_str, jb_err_to_string(err));
1356 free_http_request(http);
1357 return JB_ERR_PARSE;
1360 /* grab the rest of the client's headers */
1364 p = get_header(csp->client_iob);
1368 /* There are no additional headers to read. */
1375 * We didn't receive a complete header
1376 * line yet, get the rest of it.
1378 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1380 log_error(LOG_LEVEL_ERROR,
1381 "Stopped grabbing the client headers.");
1382 destroy_list(headers);
1383 return JB_ERR_PARSE;
1386 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1389 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1390 destroy_list(headers);
1391 return JB_ERR_PARSE;
1394 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1397 * If there is no memory left for buffering the
1398 * request, there is nothing we can do but hang up
1400 destroy_list(headers);
1401 return JB_ERR_MEMORY;
1407 * We were able to read a complete
1408 * header and can finally enlist it.
1415 if (http->host == NULL)
1418 * If we still don't know the request destination,
1419 * the request is invalid or the client uses
1420 * Privoxy without its knowledge.
1422 if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
1425 * Our attempts to get the request destination
1426 * elsewhere failed or Privoxy is configured
1427 * to only accept proxy requests.
1429 * An error response has already been send
1430 * and we're done here.
1432 return JB_ERR_PARSE;
1437 * Determine the actions for this URL
1439 #ifdef FEATURE_TOGGLE
1440 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
1442 /* Most compatible set of actions (i.e. none) */
1443 init_current_action(csp->action);
1446 #endif /* ndef FEATURE_TOGGLE */
1448 get_url_actions(csp, http);
1452 * Save a copy of the original request for logging
1454 http->ocmd = strdup_or_die(http->cmd);
1455 enlist(csp->headers, http->cmd);
1457 /* Append the previously read headers */
1458 list_append_list_unique(csp->headers, headers);
1459 destroy_list(headers);
1466 /*********************************************************************
1468 * Function : parse_client_request
1470 * Description : Parses the client's request and decides what to do
1473 * Note that since we're not using select() we could get
1474 * blocked here if a client connected, then didn't say
1478 * 1 : csp = Current client state (buffers, headers, etc...)
1480 * Returns : JB_ERR_OK or JB_ERR_PARSE
1482 *********************************************************************/
1483 static jb_err parse_client_request(struct client_state *csp)
1485 struct http_request *http = csp->http;
1488 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1489 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
1490 && (!strcmpic(csp->http->ver, "HTTP/1.1"))
1491 && (csp->http->ssl == 0))
1493 /* Assume persistence until further notice */
1494 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1497 if (csp->http->ssl == 0)
1499 csp->expected_client_content_length = get_expected_content_length(csp->headers);
1500 verify_request_length(csp);
1502 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1504 err = sed(csp, FILTER_CLIENT_HEADERS);
1505 if (JB_ERR_OK != err)
1507 /* XXX: Should be handled in sed(). */
1508 assert(err == JB_ERR_PARSE);
1509 log_error(LOG_LEVEL_FATAL, "Failed to parse client headers.");
1511 csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
1513 /* Check request line for rewrites. */
1514 if ((NULL == csp->headers->first->str)
1515 || (strcmp(http->cmd, csp->headers->first->str) &&
1516 (JB_ERR_OK != change_request_destination(csp))))
1519 * A header filter broke the request line - bail out.
1521 write_socket(csp->cfd, MESSED_UP_REQUEST_RESPONSE, strlen(MESSED_UP_REQUEST_RESPONSE));
1522 /* XXX: Use correct size */
1523 log_error(LOG_LEVEL_CLF,
1524 "%s - - [%T] \"Invalid request generated\" 500 0", csp->ip_addr_str);
1525 log_error(LOG_LEVEL_ERROR,
1526 "Invalid request line after applying header filters.");
1527 free_http_request(http);
1529 return JB_ERR_PARSE;
1537 /*********************************************************************
1541 * Description : Once a connection from the client has been accepted,
1542 * this function is called (via serve()) to handle the
1543 * main business of the communication. This function
1544 * returns after dealing with a single request. It can
1545 * be called multiple times with the same client socket
1546 * if the client is keeping the connection alive.
1548 * The decision whether or not a client connection will
1549 * be kept alive is up to the caller which also must
1550 * close the client socket when done.
1552 * FIXME: chat is nearly thousand lines long.
1556 * 1 : csp = Current client state (buffers, headers, etc...)
1558 * Returns : Nothing.
1560 *********************************************************************/
1561 static void chat(struct client_state *csp)
1563 char buf[BUFFER_SIZE];
1570 int ms_iis5_hack = 0;
1571 unsigned long long byte_count = 0;
1572 const struct forward_spec *fwd;
1573 struct http_request *http;
1574 long len = 0; /* for buffer sizes (and negative error codes) */
1575 int buffer_and_filter_content = 0;
1577 /* Skeleton for HTTP response, if we should intercept the request */
1578 struct http_response *rsp;
1579 struct timeval timeout;
1580 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1581 int watch_client_socket;
1584 memset(buf, 0, sizeof(buf));
1588 if (receive_client_request(csp) != JB_ERR_OK)
1592 if (parse_client_request(csp) != JB_ERR_OK)
1597 /* decide how to route the HTTP request */
1598 fwd = forward_url(csp, http);
1601 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!? This can't happen!");
1602 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1607 * build the http request to send to the server
1608 * we have to do one of the following:
1610 * create = use the original HTTP request to create a new
1611 * HTTP request that has either the path component
1612 * without the http://domainspec (w/path) or the
1613 * full orininal URL (w/url)
1614 * Note that the path and/or the HTTP version may
1615 * have been altered by now.
1617 * connect = Open a socket to the host:port of the server
1618 * and short-circuit server and client socket.
1620 * pass = Pass the request unchanged if forwarding a CONNECT
1621 * request to a parent proxy. Note that we'll be sending
1622 * the CFAIL message ourselves if connecting to the parent
1623 * fails, but we won't send a CSUCCEED message if it works,
1624 * since that would result in a double message (ours and the
1625 * parent's). After sending the request to the parent, we simply
1628 * here's the matrix:
1631 * +--------+--------+
1633 * 0 | create | connect|
1635 * Forwarding +--------+--------+
1637 * 1 | create | pass |
1639 * +--------+--------+
1643 if (http->ssl && connect_port_is_forbidden(csp))
1645 const char *acceptable_connect_ports =
1646 csp->action->string[ACTION_STRING_LIMIT_CONNECT];
1647 assert(NULL != acceptable_connect_ports);
1648 log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
1649 "limit-connect{%s} doesn't allow CONNECT requests to %s",
1650 csp->ip_addr_str, acceptable_connect_ports, csp->http->hostport);
1651 csp->action->flags |= ACTION_BLOCK;
1657 freez(csp->headers->first->str);
1658 build_request_line(csp, fwd, &csp->headers->first->str);
1662 * We have a request. Check if one of the crunchers wants it.
1664 if (crunch_response_triggered(csp, crunchers_all))
1667 * Yes. The client got the crunch response and we're done here.
1672 log_applied_actions(csp->action);
1673 log_error(LOG_LEVEL_GPC, "%s%s", http->hostport, http->path);
1675 if (fwd->forward_host)
1677 log_error(LOG_LEVEL_CONNECT, "via [%s]:%d to: %s",
1678 fwd->forward_host, fwd->forward_port, http->hostport);
1682 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
1685 /* here we connect to the server, gateway, or the forwarder */
1687 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1688 if ((csp->server_connection.sfd != JB_INVALID_SOCKET)
1689 && socket_is_still_alive(csp->server_connection.sfd)
1690 && connection_destination_matches(&csp->server_connection, http, fwd))
1692 log_error(LOG_LEVEL_CONNECT,
1693 "Reusing server socket %d connected to %s. Total requests: %u.",
1694 csp->server_connection.sfd, csp->server_connection.host,
1695 csp->server_connection.requests_sent_total);
1699 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
1701 #ifdef FEATURE_CONNECTION_SHARING
1702 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
1704 remember_connection(&csp->server_connection);
1707 #endif /* def FEATURE_CONNECTION_SHARING */
1709 log_error(LOG_LEVEL_CONNECT,
1710 "Closing server socket %d connected to %s. Total requests: %u.",
1711 csp->server_connection.sfd, csp->server_connection.host,
1712 csp->server_connection.requests_sent_total);
1713 close_socket(csp->server_connection.sfd);
1715 mark_connection_closed(&csp->server_connection);
1717 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1719 csp->server_connection.sfd = forwarded_connect(fwd, http, csp);
1721 if (csp->server_connection.sfd == JB_INVALID_SOCKET)
1723 if (fwd->type != SOCKS_NONE)
1726 rsp = error_response(csp, "forwarding-failed");
1728 else if (errno == EINVAL)
1730 rsp = error_response(csp, "no-such-domain");
1734 rsp = error_response(csp, "connect-failed");
1737 /* Write the answer to the client */
1740 send_crunch_response(csp, rsp);
1745 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1746 save_connection_destination(csp->server_connection.sfd,
1747 http, fwd, &csp->server_connection);
1748 csp->server_connection.keep_alive_timeout =
1749 (unsigned)csp->config->keep_alive_timeout;
1751 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1753 csp->server_connection.requests_sent_total++;
1755 if (fwd->forward_host || (http->ssl == 0))
1758 hdr = list_to_text(csp->headers);
1761 /* FIXME Should handle error properly */
1762 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
1764 list_remove_all(csp->headers);
1767 * Write the client's (modified) header to the server
1768 * (along with anything else that may be in the buffer)
1770 write_failure = 0 != write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
1775 log_error(LOG_LEVEL_CONNECT,
1776 "Failed sending request headers to: %s: %E", http->hostport);
1778 else if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
1779 && (flush_socket(csp->server_connection.sfd, csp->client_iob) < 0))
1782 log_error(LOG_LEVEL_CONNECT,
1783 "Failed sending request body to: %s: %E", http->hostport);
1788 rsp = error_response(csp, "connect-failed");
1791 send_crunch_response(csp, rsp);
1799 * We're running an SSL tunnel and we're not forwarding,
1800 * so just ditch the client headers, send the "connect succeeded"
1801 * message to the client, flush the rest, and get out of the way.
1803 list_remove_all(csp->headers);
1804 if (write_socket(csp->cfd, CSUCCEED, strlen(CSUCCEED)))
1808 clear_iob(csp->client_iob);
1811 log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
1813 csp->server_connection.request_sent = time(NULL);
1815 maxfd = (csp->cfd > csp->server_connection.sfd) ?
1816 csp->cfd : csp->server_connection.sfd;
1818 /* pass data between the client and server
1819 * until one or the other shuts down the connection.
1824 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1825 watch_client_socket = 0 == (csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING);
1832 * FD_ZERO here seems to point to an errant macro which crashes.
1833 * So do this by hand for now...
1835 memset(&rfds,0x00,sizeof(fd_set));
1839 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1840 if (!watch_client_socket)
1842 maxfd = csp->server_connection.sfd;
1845 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1847 FD_SET(csp->cfd, &rfds);
1850 FD_SET(csp->server_connection.sfd, &rfds);
1852 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1853 if ((csp->flags & CSP_FLAG_CHUNKED)
1854 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
1855 && ((csp->iob->eod - csp->iob->cur) >= 5)
1856 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
1859 * XXX: This check should be obsolete now,
1860 * but let's wait a while to be sure.
1862 log_error(LOG_LEVEL_CONNECT,
1863 "Looks like we got the last chunk together with "
1864 "the server headers but didn't detect it earlier. "
1865 "We better stop reading.");
1866 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
1867 csp->expected_content_length = byte_count;
1868 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
1870 if (server_body && server_response_is_complete(csp, byte_count))
1872 if (csp->expected_content_length == byte_count)
1874 log_error(LOG_LEVEL_CONNECT,
1875 "Done reading from server. Content length: %llu as expected. "
1876 "Bytes most recently read: %d.",
1881 log_error(LOG_LEVEL_CONNECT,
1882 "Done reading from server. Expected content length: %llu. "
1883 "Actual content length: %llu. Bytes most recently read: %d.",
1884 csp->expected_content_length, byte_count, len);
1888 * XXX: should not jump around,
1889 * chat() is complicated enough already.
1893 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1895 timeout.tv_sec = csp->config->socket_timeout;
1896 timeout.tv_usec = 0;
1897 n = select((int)maxfd+1, &rfds, NULL, NULL, &timeout);
1901 log_error(LOG_LEVEL_ERROR,
1902 "Didn't receive data in time: %s", http->url);
1903 if ((byte_count == 0) && (http->ssl == 0))
1905 send_crunch_response(csp, error_response(csp, "connection-timeout"));
1907 mark_server_socket_tainted(csp);
1912 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
1913 mark_server_socket_tainted(csp);
1918 * This is the body of the browser's request,
1919 * just read and write it.
1921 * XXX: Make sure the client doesn't use pipelining
1922 * behind Privoxy's back.
1924 if (FD_ISSET(csp->cfd, &rfds))
1926 int max_bytes_to_read = sizeof(buf) - 1;
1928 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1929 if ((csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ))
1931 if (data_is_available(csp->cfd, 0))
1934 * If the next request is already waiting, we have
1935 * to stop select()ing the client socket. Otherwise
1936 * we would always return right away and get nothing
1939 watch_client_socket = 0;
1940 log_error(LOG_LEVEL_CONNECT,
1941 "Stopping to watch the client socket %d. "
1942 "There's already another request waiting.",
1947 * If the client socket is set, but there's no data
1948 * available on the socket, the client went fishing
1949 * and continuing talking to the server makes no sense.
1951 log_error(LOG_LEVEL_CONNECT,
1952 "The client closed socket %d while "
1953 "the server socket %d is still open.",
1954 csp->cfd, csp->server_connection.sfd);
1955 mark_server_socket_tainted(csp);
1958 if (csp->expected_client_content_length != 0)
1960 if (csp->expected_client_content_length < (sizeof(buf) - 1))
1962 max_bytes_to_read = (int)csp->expected_client_content_length;
1964 log_error(LOG_LEVEL_CONNECT,
1965 "Waiting for up to %d bytes from the client.",
1968 assert(max_bytes_to_read < sizeof(buf));
1969 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1971 len = read_socket(csp->cfd, buf, max_bytes_to_read);
1975 /* XXX: not sure if this is necessary. */
1976 mark_server_socket_tainted(csp);
1977 break; /* "game over, man" */
1980 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1981 if (csp->expected_client_content_length != 0)
1983 assert(len <= max_bytes_to_read);
1984 csp->expected_client_content_length -= (unsigned)len;
1985 log_error(LOG_LEVEL_CONNECT,
1986 "Expected client content length set to %llu "
1987 "after reading %d bytes.",
1988 csp->expected_client_content_length, len);
1989 if (csp->expected_client_content_length == 0)
1991 log_error(LOG_LEVEL_CONNECT,
1992 "Done reading from the client.");
1993 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1996 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1998 if (write_socket(csp->server_connection.sfd, buf, (size_t)len))
2000 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
2001 mark_server_socket_tainted(csp);
2008 * The server wants to talk. It could be the header or the body.
2009 * If `hdr' is null, then it's the header otherwise it's the body.
2010 * FIXME: Does `hdr' really mean `host'? No.
2012 if (FD_ISSET(csp->server_connection.sfd, &rfds))
2014 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2016 * If we are buffering content, we don't want to eat up to
2017 * buffer-limit bytes if the client no longer cares about them.
2018 * If we aren't buffering, however, a dead client socket will be
2019 * noticed pretty much right away anyway, so we can reduce the
2020 * overhead by skipping the check.
2022 if (buffer_and_filter_content && !socket_is_still_alive(csp->cfd))
2025 log_error(LOG_LEVEL_CONNECT,
2026 "The server still wants to talk, but the client may already have hung up on us.");
2028 log_error(LOG_LEVEL_CONNECT,
2029 "The server still wants to talk, but the client hung up on us.");
2030 mark_server_socket_tainted(csp);
2032 #endif /* def _WIN32 */
2034 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2036 len = read_socket(csp->server_connection.sfd, buf, sizeof(buf) - 1);
2040 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
2042 if (http->ssl && (fwd->forward_host == NULL))
2045 * Just hang up. We already confirmed the client's CONNECT
2046 * request with status code 200 and unencrypted content is
2047 * no longer welcome.
2049 log_error(LOG_LEVEL_ERROR,
2050 "CONNECT already confirmed. Unable to tell the client about the problem.");
2053 else if (byte_count)
2056 * Just hang up. We already transmitted the original headers
2057 * and parts of the original content and therefore missed the
2058 * chance to send an error message (without risking data corruption).
2060 * XXX: we could retry with a fancy range request here.
2062 log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
2063 "Unable to tell the client about the problem.");
2064 mark_server_socket_tainted(csp);
2068 * XXX: Consider handling the cases above the same.
2070 mark_server_socket_tainted(csp);
2074 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2075 if (csp->flags & CSP_FLAG_CHUNKED)
2077 if ((len >= 5) && !memcmp(buf+len-5, "0\r\n\r\n", 5))
2079 /* XXX: this is a temporary hack */
2080 log_error(LOG_LEVEL_CONNECT,
2081 "Looks like we reached the end of the last chunk. "
2082 "We better stop reading.");
2083 csp->expected_content_length = byte_count + (unsigned long long)len;
2084 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2088 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2091 * Add a trailing zero to let be able to use string operations.
2092 * XXX: do we still need this with filter_popups gone?
2097 * Normally, this would indicate that we've read
2098 * as much as the server has sent us and we can
2099 * close the client connection. However, Microsoft
2100 * in its wisdom has released IIS/5 with a bug that
2101 * prevents it from sending the trailing \r\n in
2102 * a 302 redirect header (and possibly other headers).
2103 * To work around this if we've haven't parsed
2104 * a full header we'll append a trailing \r\n
2105 * and see if this now generates a valid one.
2107 * This hack shouldn't have any impacts. If we've
2108 * already transmitted the header or if this is a
2109 * SSL connection, then we won't bother with this
2110 * hack. So we only work on partially received
2111 * headers. If we append a \r\n and this still
2112 * doesn't generate a valid header, then we won't
2113 * transmit anything to the client.
2118 if (server_body || http->ssl)
2121 * If we have been buffering up the document,
2122 * now is the time to apply content modification
2123 * and send the result to the client.
2125 if (buffer_and_filter_content)
2127 p = execute_content_filters(csp);
2129 * If content filtering fails, use the original
2130 * buffer and length.
2131 * (see p != NULL ? p : csp->iob->cur below)
2135 csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
2137 #ifdef FEATURE_COMPRESSION
2138 else if ((csp->flags & CSP_FLAG_CLIENT_SUPPORTS_DEFLATE)
2139 && (csp->content_length > LOWER_LENGTH_LIMIT_FOR_COMPRESSION))
2141 char *compressed_content = compress_buffer(p,
2142 (size_t *)&csp->content_length, csp->config->compression_level);
2143 if (compressed_content != NULL)
2146 p = compressed_content;
2147 csp->flags |= CSP_FLAG_BUFFERED_CONTENT_DEFLATED;
2152 if (JB_ERR_OK != update_server_headers(csp))
2154 log_error(LOG_LEVEL_FATAL,
2155 "Failed to update server headers. after filtering.");
2158 hdr = list_to_text(csp->headers);
2161 /* FIXME Should handle error properly */
2162 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2165 if (write_socket(csp->cfd, hdr, strlen(hdr))
2166 || write_socket(csp->cfd,
2167 ((p != NULL) ? p : csp->iob->cur), (size_t)csp->content_length))
2169 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
2172 mark_server_socket_tainted(csp);
2180 break; /* "game over, man" */
2184 * This is NOT the body, so
2185 * Let's pretend the server just sent us a blank line.
2187 snprintf(buf, sizeof(buf), "\r\n");
2188 len = (int)strlen(buf);
2191 * Now, let the normal header parsing algorithm below do its
2192 * job. If it fails, we'll exit instead of continuing.
2199 * If this is an SSL connection or we're in the body
2200 * of the server document, just write it to the client,
2201 * unless we need to buffer the body for later content-filtering
2203 if (server_body || http->ssl)
2205 if (buffer_and_filter_content)
2208 * If there is no memory left for buffering the content, or the buffer limit
2209 * has been reached, switch to non-filtering mode, i.e. make & write the
2210 * header, flush the iob and buf, and get out of the way.
2212 if (add_to_iob(csp->iob, csp->config->buffer_limit, buf, len))
2217 log_error(LOG_LEVEL_INFO,
2218 "Flushing header and buffers. Stepping back from filtering.");
2220 hdr = list_to_text(csp->headers);
2224 * Memory is too tight to even generate the header.
2225 * Send our static "Out-of-memory" page.
2227 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
2228 rsp = cgi_error_memory();
2229 send_crunch_response(csp, rsp);
2230 mark_server_socket_tainted(csp);
2233 hdrlen = strlen(hdr);
2235 if (write_socket(csp->cfd, hdr, hdrlen)
2236 || ((flushed = flush_socket(csp->cfd, csp->iob)) < 0)
2237 || (write_socket(csp->cfd, buf, (size_t)len)))
2239 log_error(LOG_LEVEL_CONNECT,
2240 "Flush header and buffers to client failed: %E");
2242 mark_server_socket_tainted(csp);
2247 * Reset the byte_count to the amount of bytes
2248 * we just flushed. len will be added a few lines below,
2249 * hdrlen doesn't matter for LOG_LEVEL_CLF.
2251 byte_count = (unsigned long long)flushed;
2253 buffer_and_filter_content = 0;
2259 if (write_socket(csp->cfd, buf, (size_t)len))
2261 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
2262 mark_server_socket_tainted(csp);
2266 byte_count += (unsigned long long)len;
2272 * We're still looking for the end of the server's header.
2273 * Buffer up the data we just read. If that fails, there's
2274 * little we can do but send our static out-of-memory page.
2276 if (add_to_iob(csp->iob, csp->config->buffer_limit, buf, len))
2278 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
2279 rsp = cgi_error_memory();
2280 send_crunch_response(csp, rsp);
2281 mark_server_socket_tainted(csp);
2285 /* Convert iob into something sed() can digest */
2286 if (JB_ERR_PARSE == get_server_headers(csp))
2291 * Well, we tried our MS IIS/5 hack and it didn't work.
2292 * The header is incomplete and there isn't anything
2293 * we can do about it.
2295 log_error(LOG_LEVEL_ERROR, "Invalid server headers. "
2296 "Applying the MS IIS5 hack didn't help.");
2297 log_error(LOG_LEVEL_CLF,
2298 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2299 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2300 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2301 mark_server_socket_tainted(csp);
2307 * Since we have to wait for more from the server before
2308 * we can parse the headers we just continue here.
2310 log_error(LOG_LEVEL_CONNECT,
2311 "Continuing buffering server headers from socket %d. "
2312 "Bytes most recently read: %d.", csp->cfd, len);
2319 * Account for the content bytes we
2320 * might have gotten with the headers.
2322 assert(csp->iob->eod >= csp->iob->cur);
2323 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2326 /* Did we actually get anything? */
2327 if (NULL == csp->headers->first)
2329 if ((csp->flags & CSP_FLAG_REUSED_CLIENT_CONNECTION))
2331 log_error(LOG_LEVEL_ERROR,
2332 "No server or forwarder response received on socket %d. "
2333 "Closing client socket %d without sending data.",
2334 csp->server_connection.sfd, csp->cfd);
2335 log_error(LOG_LEVEL_CLF,
2336 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2340 log_error(LOG_LEVEL_ERROR,
2341 "No server or forwarder response received on socket %d.",
2342 csp->server_connection.sfd);
2343 send_crunch_response(csp, error_response(csp, "no-server-data"));
2345 free_http_request(http);
2346 mark_server_socket_tainted(csp);
2350 assert(csp->headers->first->str);
2352 if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
2353 strncmpic(csp->headers->first->str, "ICY", 3))
2356 * It doesn't look like a HTTP (or Shoutcast) response:
2357 * tell the client and log the problem.
2359 if (strlen(csp->headers->first->str) > 30)
2361 csp->headers->first->str[30] = '\0';
2363 log_error(LOG_LEVEL_ERROR,
2364 "Invalid server or forwarder response. Starts with: %s",
2365 csp->headers->first->str);
2366 log_error(LOG_LEVEL_CLF,
2367 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2368 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2369 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2370 free_http_request(http);
2371 mark_server_socket_tainted(csp);
2376 * We have now received the entire server header,
2377 * filter it and send the result to the client
2379 if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
2381 log_error(LOG_LEVEL_FATAL, "Failed to parse server headers.");
2383 hdr = list_to_text(csp->headers);
2386 /* FIXME Should handle error properly */
2387 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2390 if ((csp->flags & CSP_FLAG_CHUNKED)
2391 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2392 && ((csp->iob->eod - csp->iob->cur) >= 5)
2393 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
2395 log_error(LOG_LEVEL_CONNECT,
2396 "Looks like we got the last chunk together with "
2397 "the server headers. We better stop reading.");
2398 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2399 csp->expected_content_length = byte_count;
2400 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2403 csp->server_connection.response_received = time(NULL);
2405 if (crunch_response_triggered(csp, crunchers_light))
2408 * One of the tags created by a server-header
2409 * tagger triggered a crunch. We already
2410 * delivered the crunch response to the client
2411 * and are done here after cleaning up.
2414 mark_server_socket_tainted(csp);
2417 /* Buffer and pcrs filter this if appropriate. */
2419 if (!http->ssl) /* We talk plaintext */
2421 buffer_and_filter_content = content_requires_filtering(csp);
2424 * Only write if we're not buffering for content modification
2426 if (!buffer_and_filter_content)
2429 * Write the server's (modified) header to
2430 * the client (along with anything else that
2431 * may be in the buffer)
2434 if (write_socket(csp->cfd, hdr, strlen(hdr))
2435 || ((len = flush_socket(csp->cfd, csp->iob)) < 0))
2437 log_error(LOG_LEVEL_CONNECT, "write header to client failed: %E");
2440 * The write failed, so don't bother mentioning it
2441 * to the client... it probably can't hear us anyway.
2444 mark_server_socket_tainted(csp);
2449 /* we're finished with the server's header */
2455 * If this was a MS IIS/5 hack then it means the server
2456 * has already closed the connection. Nothing more to read.
2461 log_error(LOG_LEVEL_ERROR,
2462 "Closed server connection detected. "
2463 "Applying the MS IIS5 hack didn't help.");
2464 log_error(LOG_LEVEL_CLF,
2465 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2466 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2467 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2468 mark_server_socket_tainted(csp);
2474 mark_server_socket_tainted(csp);
2475 return; /* huh? we should never get here */
2478 if (csp->content_length == 0)
2481 * If Privoxy didn't recalculate the Content-Length,
2482 * byte_count is still correct.
2484 csp->content_length = byte_count;
2487 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2488 if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2489 && (csp->expected_content_length != byte_count))
2491 log_error(LOG_LEVEL_CONNECT,
2492 "Received %llu bytes while expecting %llu.",
2493 byte_count, csp->expected_content_length);
2494 mark_server_socket_tainted(csp);
2498 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %llu",
2499 csp->ip_addr_str, http->ocmd, csp->content_length);
2501 csp->server_connection.timestamp = time(NULL);
2505 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2506 /*********************************************************************
2508 * Function : prepare_csp_for_next_request
2510 * Description : Put the csp in a mostly vergin state.
2513 * 1 : csp = Current client state (buffers, headers, etc...)
2517 *********************************************************************/
2518 static void prepare_csp_for_next_request(struct client_state *csp)
2520 unsigned int toggled_on_flag_set = (0 != (csp->flags & CSP_FLAG_TOGGLED_ON));
2522 csp->content_type = 0;
2523 csp->content_length = 0;
2524 csp->expected_content_length = 0;
2525 csp->expected_client_content_length = 0;
2526 list_remove_all(csp->headers);
2527 clear_iob(csp->iob);
2528 freez(csp->error_message);
2529 free_http_request(csp->http);
2530 destroy_list(csp->headers);
2531 destroy_list(csp->tags);
2532 free_current_action(csp->action);
2533 if (NULL != csp->fwd)
2535 unload_forward_spec(csp->fwd);
2538 /* XXX: Store per-connection flags someplace else. */
2539 csp->flags = (CSP_FLAG_ACTIVE | CSP_FLAG_REUSED_CLIENT_CONNECTION);
2540 if (toggled_on_flag_set)
2542 csp->flags |= CSP_FLAG_TOGGLED_ON;
2545 if (csp->client_iob->eod > csp->client_iob->cur)
2547 long bytes_to_shift = csp->client_iob->cur - csp->client_iob->buf;
2548 size_t data_length = (size_t)(csp->client_iob->eod - csp->client_iob->cur);
2550 assert(bytes_to_shift > 0);
2551 assert(data_length > 0);
2553 log_error(LOG_LEVEL_CONNECT, "Shifting %d pipelined bytes by %d bytes",
2554 data_length, bytes_to_shift);
2555 memmove(csp->client_iob->buf, csp->client_iob->cur, data_length);
2556 csp->client_iob->cur = csp->client_iob->buf;
2557 assert(csp->client_iob->eod == csp->client_iob->buf + bytes_to_shift + data_length);
2558 csp->client_iob->eod = csp->client_iob->buf + data_length;
2559 memset(csp->client_iob->eod, '\0', (size_t)bytes_to_shift);
2561 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
2566 * We mainly care about resetting client_iob->cur so we don't
2567 * waste buffer space at the beginning and don't mess up the
2568 * request restoration done by cgi_show_request().
2570 * Freeing the buffer itself isn't technically necessary,
2571 * but makes debugging more convenient.
2573 clear_iob(csp->client_iob);
2576 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2579 /*********************************************************************
2583 * Description : This is little more than chat. We only "serve" to
2584 * to close (or remember) any socket that chat may have
2588 * 1 : csp = Current client state (buffers, headers, etc...)
2592 *********************************************************************/
2594 void serve(struct client_state *csp)
2595 #else /* ifndef AMIGA */
2596 static void serve(struct client_state *csp)
2597 #endif /* def AMIGA */
2599 int config_file_change_detected = 0; /* Only used for debugging */
2600 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2601 #ifdef FEATURE_CONNECTION_SHARING
2602 static int monitor_thread_running = 0;
2603 #endif /* def FEATURE_CONNECTION_SHARING */
2604 int continue_chatting = 0;
2606 log_error(LOG_LEVEL_CONNECT, "Accepted connection from %s on socket %d",
2607 csp->ip_addr_str, csp->cfd);
2611 unsigned int latency;
2616 * If the request has been crunched,
2617 * the calculated latency is zero.
2619 latency = (unsigned)(csp->server_connection.response_received -
2620 csp->server_connection.request_sent) / 2;
2622 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
2623 && (csp->flags & CSP_FLAG_CRUNCHED)
2624 && (csp->expected_client_content_length != 0))
2626 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
2627 log_error(LOG_LEVEL_CONNECT,
2628 "Tainting client socket %d due to unread data.", csp->cfd);
2631 continue_chatting = (csp->config->feature_flags
2632 & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
2633 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
2634 && (csp->cfd != JB_INVALID_SOCKET)
2635 && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE);
2637 if (!(csp->flags & CSP_FLAG_CRUNCHED)
2638 && (csp->server_connection.sfd != JB_INVALID_SOCKET))
2640 if (!(csp->flags & CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET))
2642 csp->server_connection.keep_alive_timeout = csp->config->default_server_timeout;
2644 if (!(csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
2645 || (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
2646 || !socket_is_still_alive(csp->server_connection.sfd)
2647 || !(latency < csp->server_connection.keep_alive_timeout))
2649 log_error(LOG_LEVEL_CONNECT,
2650 "Closing server socket %d connected to %s: "
2651 "Keep-alive %u. Tainted: %u. Socket alive %u. Timeout: %u.",
2652 csp->server_connection.sfd, csp->server_connection.host,
2653 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
2654 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
2655 socket_is_still_alive(csp->server_connection.sfd),
2656 csp->server_connection.keep_alive_timeout);
2657 #ifdef FEATURE_CONNECTION_SHARING
2658 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
2660 forget_connection(csp->server_connection.sfd);
2662 #endif /* def FEATURE_CONNECTION_SHARING */
2663 close_socket(csp->server_connection.sfd);
2664 mark_connection_closed(&csp->server_connection);
2668 if (continue_chatting && any_loaded_file_changed(csp->config->config_file_list))
2670 continue_chatting = 0;
2671 config_file_change_detected = 1;
2674 if (continue_chatting)
2676 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
2677 && socket_is_still_alive(csp->cfd))
2679 log_error(LOG_LEVEL_CONNECT, "Client request %d has been "
2680 "pipelined on socket %d and the socket is still alive.",
2681 csp->requests_received_total+1, csp->cfd);
2682 prepare_csp_for_next_request(csp);
2686 if (0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
2688 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
2690 log_error(LOG_LEVEL_CONNECT,
2691 "Waiting for the next client request on socket %d. "
2692 "Keeping the server socket %d to %s open.",
2693 csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
2697 log_error(LOG_LEVEL_CONNECT,
2698 "Waiting for the next client request on socket %d. "
2699 "No server socket to keep open.", csp->cfd);
2703 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
2704 && data_is_available(csp->cfd, (int)csp->config->keep_alive_timeout)
2705 && socket_is_still_alive(csp->cfd))
2707 log_error(LOG_LEVEL_CONNECT,
2708 "Client request %u arrived in time on socket %d.",
2709 csp->requests_received_total+1, csp->cfd);
2710 prepare_csp_for_next_request(csp);
2714 #ifdef FEATURE_CONNECTION_SHARING
2715 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
2716 && (csp->server_connection.sfd != JB_INVALID_SOCKET)
2717 && (socket_is_still_alive(csp->server_connection.sfd)))
2719 time_t time_open = time(NULL) - csp->server_connection.timestamp;
2721 if (csp->server_connection.keep_alive_timeout < time_open - (time_t)latency)
2726 remember_connection(&csp->server_connection);
2727 csp->server_connection.sfd = JB_INVALID_SOCKET;
2728 drain_and_close_socket(csp->cfd);
2729 csp->cfd = JB_INVALID_SOCKET;
2730 privoxy_mutex_lock(&connection_reuse_mutex);
2731 if (!monitor_thread_running)
2733 monitor_thread_running = 1;
2734 privoxy_mutex_unlock(&connection_reuse_mutex);
2735 wait_for_alive_connections();
2736 privoxy_mutex_lock(&connection_reuse_mutex);
2737 monitor_thread_running = 0;
2739 privoxy_mutex_unlock(&connection_reuse_mutex);
2741 #endif /* def FEATURE_CONNECTION_SHARING */
2745 else if (csp->server_connection.sfd != JB_INVALID_SOCKET)
2747 log_error(LOG_LEVEL_CONNECT,
2748 "Closing server socket %d connected to %s. Keep-alive: %u. "
2749 "Tainted: %u. Socket alive: %u. Timeout: %u. "
2750 "Configuration file change detected: %u",
2751 csp->server_connection.sfd, csp->server_connection.host,
2752 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
2753 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
2754 socket_is_still_alive(csp->server_connection.sfd),
2755 csp->server_connection.keep_alive_timeout,
2756 config_file_change_detected);
2758 } while (continue_chatting);
2762 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2764 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
2766 #ifdef FEATURE_CONNECTION_SHARING
2767 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
2769 forget_connection(csp->server_connection.sfd);
2771 #endif /* def FEATURE_CONNECTION_SHARING */
2772 close_socket(csp->server_connection.sfd);
2775 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2776 mark_connection_closed(&csp->server_connection);
2779 if (csp->cfd != JB_INVALID_SOCKET)
2781 log_error(LOG_LEVEL_CONNECT, "Closing client socket %d. "
2782 "Keep-alive: %u. Socket alive: %u. Data available: %u. "
2783 "Configuration file change detected: %u. Requests received: %u.",
2784 csp->cfd, 0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE),
2785 socket_is_still_alive(csp->cfd), data_is_available(csp->cfd, 0),
2786 config_file_change_detected, csp->requests_received_total);
2787 drain_and_close_socket(csp->cfd);
2790 csp->flags &= ~CSP_FLAG_ACTIVE;
2796 /*********************************************************************
2798 * Function : server_thread
2800 * Description : We only exist to call `serve' in a threaded environment.
2803 * 1 : data = Current client state (buffers, headers, etc...)
2805 * Returns : Always 0.
2807 *********************************************************************/
2808 static int32 server_thread(void *data)
2810 serve((struct client_state *) data);
2817 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
2818 /*********************************************************************
2822 * Description : Print usage info & exit.
2824 * Parameters : Pointer to argv[0] for identifying ourselves
2828 *********************************************************************/
2829 static void usage(const char *myname)
2831 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
2835 #endif /* defined(unix) */
2838 "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
2839 #endif /* defined(unix) */
2840 "[--version] [configfile]\n"
2841 "Aborting\n", myname);
2846 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
2849 #ifdef MUTEX_LOCKS_AVAILABLE
2850 /*********************************************************************
2852 * Function : privoxy_mutex_lock
2854 * Description : Locks a mutex.
2857 * 1 : mutex = The mutex to lock.
2859 * Returns : Void. May exit in case of errors.
2861 *********************************************************************/
2862 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
2864 #ifdef FEATURE_PTHREAD
2865 int err = pthread_mutex_lock(mutex);
2868 if (mutex != &log_mutex)
2870 log_error(LOG_LEVEL_FATAL,
2871 "Mutex locking failed: %s.\n", strerror(err));
2876 EnterCriticalSection(mutex);
2877 #endif /* def FEATURE_PTHREAD */
2881 /*********************************************************************
2883 * Function : privoxy_mutex_unlock
2885 * Description : Unlocks a mutex.
2888 * 1 : mutex = The mutex to unlock.
2890 * Returns : Void. May exit in case of errors.
2892 *********************************************************************/
2893 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
2895 #ifdef FEATURE_PTHREAD
2896 int err = pthread_mutex_unlock(mutex);
2899 if (mutex != &log_mutex)
2901 log_error(LOG_LEVEL_FATAL,
2902 "Mutex unlocking failed: %s.\n", strerror(err));
2907 LeaveCriticalSection(mutex);
2908 #endif /* def FEATURE_PTHREAD */
2912 /*********************************************************************
2914 * Function : privoxy_mutex_init
2916 * Description : Prepares a mutex.
2919 * 1 : mutex = The mutex to initialize.
2921 * Returns : Void. May exit in case of errors.
2923 *********************************************************************/
2924 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
2926 #ifdef FEATURE_PTHREAD
2927 int err = pthread_mutex_init(mutex, 0);
2930 printf("Fatal error. Mutex initialization failed: %s.\n",
2935 InitializeCriticalSection(mutex);
2936 #endif /* def FEATURE_PTHREAD */
2938 #endif /* def MUTEX_LOCKS_AVAILABLE */
2940 /*********************************************************************
2942 * Function : initialize_mutexes
2944 * Description : Prepares mutexes if mutex support is available.
2948 * Returns : Void, exits in case of errors.
2950 *********************************************************************/
2951 static void initialize_mutexes(void)
2953 #ifdef MUTEX_LOCKS_AVAILABLE
2955 * Prepare global mutex semaphores
2957 privoxy_mutex_init(&log_mutex);
2958 privoxy_mutex_init(&log_init_mutex);
2959 privoxy_mutex_init(&connection_reuse_mutex);
2962 * XXX: The assumptions below are a bit naive
2963 * and can cause locks that aren't necessary.
2965 * For example older FreeBSD versions (< 6.x?)
2966 * have no gethostbyname_r, but gethostbyname is
2969 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
2970 privoxy_mutex_init(&resolver_mutex);
2971 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
2973 * XXX: should we use a single mutex for
2974 * localtime() and gmtime() as well?
2976 #ifndef HAVE_GMTIME_R
2977 privoxy_mutex_init(&gmtime_mutex);
2978 #endif /* ndef HAVE_GMTIME_R */
2980 #ifndef HAVE_LOCALTIME_R
2981 privoxy_mutex_init(&localtime_mutex);
2982 #endif /* ndef HAVE_GMTIME_R */
2985 privoxy_mutex_init(&rand_mutex);
2986 #endif /* ndef HAVE_RANDOM */
2988 #endif /* def MUTEX_LOCKS_AVAILABLE */
2992 /*********************************************************************
2996 * Description : Load the config file and start the listen loop.
2997 * This function is a lot more *sane* with the `load_config'
2998 * and `listen_loop' functions; although it stills does
2999 * a *little* too much for my taste.
3002 * 1 : argc = Number of parameters (including $0).
3003 * 2 : argv = Array of (char *)'s to the parameters.
3005 * Returns : 1 if : can't open config file, unrecognized directive,
3006 * stats requested in multi-thread mode, can't open the
3007 * log file, can't open the jar file, listen port is invalid,
3008 * any load fails, and can't bind port.
3010 * Else main never returns, the process must be signaled
3011 * to terminate execution. Or, on Windows, use the
3012 * "File", "Exit" menu option.
3014 *********************************************************************/
3016 int real_main(int argc, char **argv)
3018 int main(int argc, char **argv)
3022 unsigned int random_seed;
3024 struct passwd *pw = NULL;
3025 struct group *grp = NULL;
3027 char *pre_chroot_nslookup_to_load_resolver = NULL;
3034 #if !defined(_WIN32)
3041 /* Prepare mutexes if supported and necessary. */
3042 initialize_mutexes();
3044 /* Enable logging until further notice. */
3048 * Parse the command line arguments
3050 * XXX: simply printing usage information in case of
3051 * invalid arguments isn't particularly user friendly.
3053 while (++argc_pos < argc)
3056 /* Check to see if the service must be installed or uninstalled */
3057 if (strncmp(argv[argc_pos], "--install", 9) == 0)
3059 const char *pName = argv[argc_pos] + 9;
3062 exit((install_service(pName)) ? 0 : 1);
3064 else if (strncmp(argv[argc_pos], "--uninstall", 11) == 0)
3066 const char *pName = argv[argc_pos] + 11;
3069 exit((uninstall_service(pName)) ? 0 : 1);
3071 else if (strcmp(argv[argc_pos], "--service") == 0)
3073 bRunAsService = TRUE;
3074 w32_set_service_cwd();
3075 atexit(w32_service_exit_notify);
3078 #endif /* defined(_WIN32) */
3081 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
3083 if (strcmp(argv[argc_pos], "--help") == 0)
3088 else if (strcmp(argv[argc_pos], "--version") == 0)
3090 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
3096 else if (strcmp(argv[argc_pos], "--no-daemon") == 0)
3098 set_debug_level(LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
3102 else if (strcmp(argv[argc_pos], "--pidfile") == 0)
3104 if (++argc_pos == argc) usage(argv[0]);
3105 pidfile = strdup_or_die(argv[argc_pos]);
3108 else if (strcmp(argv[argc_pos], "--user") == 0)
3113 if (++argc_pos == argc) usage(argv[argc_pos]);
3115 user_arg = strdup_or_die(argv[argc_pos]);
3116 group_name = strchr(user_arg, '.');
3117 if (NULL != group_name)
3119 /* Nul-terminate the user name */
3122 /* Skip the former delimiter to actually reach the group name */
3125 grp = getgrnam(group_name);
3128 log_error(LOG_LEVEL_FATAL, "Group '%s' not found.", group_name);
3131 pw = getpwnam(user_arg);
3134 log_error(LOG_LEVEL_FATAL, "User '%s' not found.", user_arg);
3140 else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup") == 0)
3142 if (++argc_pos == argc) usage(argv[0]);
3143 pre_chroot_nslookup_to_load_resolver = strdup_or_die(argv[argc_pos]);
3146 else if (strcmp(argv[argc_pos], "--chroot") == 0)
3150 #endif /* defined(unix) */
3152 else if (argc_pos + 1 != argc)
3155 * This is neither the last command line
3156 * option, nor was it recognized before,
3157 * therefore it must be invalid.
3163 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
3165 configfile = argv[argc_pos];
3168 } /* -END- while (more arguments) */
3170 show_version(Argv[0]);
3173 if (*configfile != '/')
3175 char cwd[BUFFER_SIZE];
3177 size_t abs_file_size;
3179 /* make config-filename absolute here */
3180 if (NULL == getcwd(cwd, sizeof(cwd)))
3182 perror("failed to get current working directory");
3186 basedir = strdup_or_die(cwd);
3188 abs_file_size = strlen(cwd) + strlen(configfile) + 5;
3189 abs_file = malloc_or_die(abs_file_size);
3190 strlcpy(abs_file, basedir, abs_file_size);
3191 strlcat(abs_file, "/", abs_file_size);
3192 strlcat(abs_file, configfile, abs_file_size);
3193 configfile = abs_file;
3195 #endif /* defined unix */
3199 clients->next = NULL;
3201 /* XXX: factor out initialising after the next stable release. */
3204 #elif defined(_WIN32)
3208 random_seed = (unsigned int)time(NULL);
3210 srandom(random_seed);
3213 #endif /* ifdef HAVE_RANDOM */
3216 * Unix signal handling
3218 * Catch the abort, interrupt and terminate signals for a graceful exit
3219 * Catch the hangup signal so the errlog can be reopened.
3220 * Ignore the broken pipe signals (FIXME: Why?)
3222 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
3225 const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP };
3227 for (idx = 0; idx < SZ(catched_signals); idx++)
3229 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
3230 if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
3232 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
3233 #endif /* ifdef sun */
3235 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
3239 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
3241 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for SIGPIPE: %E");
3245 #else /* ifdef _WIN32 */
3246 # ifdef _WIN_CONSOLE
3248 * We *are* in a windows console app.
3249 * Print a verbose messages about FAQ's and such
3251 printf("%s", win32_blurb);
3252 # endif /* def _WIN_CONSOLE */
3253 #endif /* def _WIN32 */
3256 /* Initialize the CGI subsystem */
3257 cgi_init_error_messages();
3260 * If runnig on unix and without the --nodaemon
3261 * option, become a daemon. I.e. fork, detach
3262 * from tty and get process group leadership
3271 if (pid < 0) /* error */
3276 else if (pid != 0) /* parent */
3281 * must check for errors
3282 * child died due to missing files aso
3285 wpid = waitpid(pid, &status, WNOHANG);
3297 * stderr (fd 2) will be closed later on,
3298 * when the config file has been parsed.
3304 * Reserve fd 0 and 1 to prevent abort() and friends
3305 * from sending stuff to the clients or servers.
3307 fd = open("/dev/null", O_RDONLY);
3310 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
3314 if (dup2(fd, 0) == -1)
3316 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 0: %E");
3320 fd = open("/dev/null", O_WRONLY);
3323 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
3327 if (dup2(fd, 1) == -1)
3329 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 1: %E");
3336 } /* -END- if (daemon_mode) */
3339 * As soon as we have written the PID file, we can switch
3340 * to the user and group ID indicated by the --user option
3346 if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
3348 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
3352 if (setgroups(1, &grp->gr_gid))
3354 log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
3357 else if (initgroups(pw->pw_name, pw->pw_gid))
3359 log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
3365 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
3367 /* Read the time zone file from /etc before doing chroot. */
3369 if (NULL != pre_chroot_nslookup_to_load_resolver
3370 && '\0' != pre_chroot_nslookup_to_load_resolver[0])
3372 /* Initialize resolver library. */
3373 (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
3375 if (chroot(pw->pw_dir) < 0)
3377 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
3381 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
3384 if (setuid(pw->pw_uid))
3386 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
3390 char putenv_dummy[64];
3392 strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
3393 if (putenv(putenv_dummy) != 0)
3395 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
3398 snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
3399 if (putenv(putenv_dummy) != 0)
3401 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
3407 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
3410 #endif /* defined unix */
3413 /* This will be FALSE unless the command line specified --service
3417 /* Yup, so now we must attempt to establish a connection
3418 * with the service dispatcher. This will only work if this
3419 * process was launched by the service control manager to
3420 * actually run as a service. If this isn't the case, i've
3421 * known it take around 30 seconds or so for the call to return.
3424 /* The StartServiceCtrlDispatcher won't return until the service is stopping */
3425 if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
3427 /* Service has run, and at this point is now being stopped, so just return */
3432 printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
3434 /* An error occurred. Usually it's because --service was wrongly specified
3435 * and we were unable to connect to the Service Control Dispatcher because
3436 * it wasn't expecting us and is therefore not listening.
3438 * For now, just continue below to call the listen_loop function.
3441 #endif /* def _WIN32 */
3451 /*********************************************************************
3453 * Function : bind_port_helper
3455 * Description : Bind the listen port. Handles logging, and aborts
3459 * 1 : haddr = Host addres to bind to. Use NULL to bind to
3461 * 2 : hport = Specifies port to bind to.
3463 * Returns : Port that was opened.
3465 *********************************************************************/
3466 static jb_socket bind_port_helper(const char *haddr, int hport)
3471 result = bind_port(haddr, hport, &bfd);
3475 const char *bind_address = (NULL != haddr) ? haddr : "INADDR_ANY";
3479 log_error(LOG_LEVEL_FATAL,
3480 "can't bind to %s:%d: There may be another Privoxy "
3481 "or some other proxy running on port %d",
3482 bind_address, hport, hport);
3485 log_error(LOG_LEVEL_FATAL,
3486 "can't bind to %s:%d: The hostname is not resolvable",
3487 bind_address, hport);
3490 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: %E",
3491 bind_address, hport);
3494 /* shouldn't get here */
3495 return JB_INVALID_SOCKET;
3500 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
3505 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
3513 /*********************************************************************
3515 * Function : bind_ports_helper
3517 * Description : Bind the listen ports. Handles logging, and aborts
3521 * 1 : config = Privoxy configuration. Specifies ports
3523 * 2 : sockets = Preallocated array of opened sockets
3524 * corresponding to specification in config.
3525 * All non-opened sockets will be set to
3526 * JB_INVALID_SOCKET.
3528 * Returns : Nothing. Inspect sockets argument.
3530 *********************************************************************/
3531 static void bind_ports_helper(struct configuration_spec * config,
3532 jb_socket sockets[])
3536 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
3538 if (config->hport[i])
3540 sockets[i] = bind_port_helper(config->haddr[i], config->hport[i]);
3544 sockets[i] = JB_INVALID_SOCKET;
3547 config->need_bind = 0;
3551 /*********************************************************************
3553 * Function : close_ports_helper
3555 * Description : Close listenings ports.
3558 * 1 : sockets = Array of opened and non-opened sockets to
3559 * close. All sockets will be set to
3560 * JB_INVALID_SOCKET.
3562 * Returns : Nothing.
3564 *********************************************************************/
3565 static void close_ports_helper(jb_socket sockets[])
3569 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
3571 if (JB_INVALID_SOCKET != sockets[i])
3573 close_socket(sockets[i]);
3575 sockets[i] = JB_INVALID_SOCKET;
3581 /* Without this simple workaround we get this compiler warning from _beginthread
3582 * warning C4028: formal parameter 1 different from declaration
3584 void w32_service_listen_loop(void *p)
3588 #endif /* def _WIN32 */
3591 /*********************************************************************
3593 * Function : listen_loop
3595 * Description : bind the listen port and enter a "FOREVER" listening loop.
3601 *********************************************************************/
3602 static void listen_loop(void)
3604 struct client_states *csp_list = NULL;
3605 struct client_state *csp = NULL;
3606 jb_socket bfds[MAX_LISTENING_SOCKETS];
3607 struct configuration_spec *config;
3608 unsigned int active_threads = 0;
3610 config = load_config();
3612 #ifdef FEATURE_CONNECTION_SHARING
3614 * XXX: Should be relocated once it no
3615 * longer needs to emit log messages.
3617 initialize_reusable_connections();
3618 #endif /* def FEATURE_CONNECTION_SHARING */
3620 bind_ports_helper(config, bfds);
3622 #ifdef FEATURE_GRACEFUL_TERMINATION
3623 while (!g_terminate)
3628 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
3629 while (waitpid(-1, NULL, WNOHANG) > 0)
3631 /* zombie children */
3633 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
3636 * Free data that was used by died threads
3638 active_threads = sweep();
3642 * Re-open the errlog after HUP signal
3644 if (received_hup_signal)
3646 if (NULL != config->logfile)
3648 init_error_log(Argv[0], config->logfile);
3650 received_hup_signal = 0;
3654 csp_list = (struct client_states *)zalloc(sizeof(*csp_list));
3655 if (NULL == csp_list)
3657 log_error(LOG_LEVEL_FATAL,
3658 "malloc(%d) for csp_list failed: %E", sizeof(*csp_list));
3661 csp = &csp_list->csp;
3663 log_error(LOG_LEVEL_CONNECT, "Listening for new connections ... ");
3665 if (!accept_connection(csp, bfds))
3667 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
3679 csp->flags |= CSP_FLAG_ACTIVE;
3680 csp->server_connection.sfd = JB_INVALID_SOCKET;
3682 csp->config = config = load_config();
3684 if (config->need_bind)
3687 * Since we were listening to the "old port", we will not see
3688 * a "listen" param change until the next request. So, at
3689 * least 1 more request must be made for us to find the new
3690 * setting. I am simply closing the old socket and binding the
3693 * Which-ever is correct, we will serve 1 more page via the
3694 * old settings. This should probably be a "show-proxy-args"
3695 * request. This should not be a so common of an operation
3696 * that this will hurt people's feelings.
3699 close_ports_helper(bfds);
3701 bind_ports_helper(config, bfds);
3704 #ifdef FEATURE_TOGGLE
3705 if (global_toggle_state)
3706 #endif /* def FEATURE_TOGGLE */
3708 csp->flags |= CSP_FLAG_TOGGLED_ON;
3711 if (run_loader(csp))
3713 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
3714 /* Never get here - LOG_LEVEL_FATAL causes program exit */
3718 if (block_acl(NULL,csp))
3720 log_error(LOG_LEVEL_CONNECT,
3721 "Connection from %s on socket %d dropped due to ACL", csp->ip_addr_str, csp->cfd);
3722 close_socket(csp->cfd);
3723 freez(csp->ip_addr_str);
3727 #endif /* def FEATURE_ACL */
3729 if ((0 != config->max_client_connections)
3730 && (active_threads >= config->max_client_connections))
3732 log_error(LOG_LEVEL_CONNECT,
3733 "Rejecting connection from %s. Maximum number of connections reached.",
3735 write_socket(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
3736 strlen(TOO_MANY_CONNECTIONS_RESPONSE));
3737 close_socket(csp->cfd);
3738 freez(csp->ip_addr_str);
3743 /* add it to the list of clients */
3744 csp_list->next = clients->next;
3745 clients->next = csp_list;
3747 if (config->multi_threaded)
3751 /* this is a switch () statement in the C preprocessor - ugh */
3752 #undef SELECTED_ONE_OPTION
3754 /* Use Pthreads in preference to native code */
3755 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
3756 #define SELECTED_ONE_OPTION
3758 pthread_t the_thread;
3759 pthread_attr_t attrs;
3761 pthread_attr_init(&attrs);
3762 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
3763 errno = pthread_create(&the_thread, &attrs,
3764 (void * (*)(void *))serve, csp);
3765 child_id = errno ? -1 : 0;
3766 pthread_attr_destroy(&attrs);
3770 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
3771 #define SELECTED_ONE_OPTION
3772 child_id = _beginthread(
3773 (void (*)(void *))serve,
3778 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
3779 #define SELECTED_ONE_OPTION
3780 child_id = _beginthread(
3781 (void(* _Optlink)(void*))serve,
3787 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
3788 #define SELECTED_ONE_OPTION
3790 thread_id tid = spawn_thread
3791 (server_thread, "server", B_NORMAL_PRIORITY, csp);
3793 if ((tid >= 0) && (resume_thread(tid) == B_OK))
3795 child_id = (int) tid;
3804 #if defined(AMIGA) && !defined(SELECTED_ONE_OPTION)
3805 #define SELECTED_ONE_OPTION
3806 csp->cfd = ReleaseSocket(csp->cfd, -1);
3809 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
3810 NP_Output, Output(),
3811 NP_CloseOutput, FALSE,
3812 NP_Name, (ULONG)"privoxy child",
3816 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
3817 NP_Output, Output(),
3818 NP_CloseOutput, FALSE,
3819 NP_Name, (ULONG)"privoxy child",
3820 NP_StackSize, 200*1024,
3826 ((struct Task *)child_id)->tc_UserData = csp;
3827 Signal((struct Task *)child_id, SIGF_SINGLE);
3832 #if !defined(SELECTED_ONE_OPTION)
3835 /* This block is only needed when using fork().
3836 * When using threads, the server thread was
3837 * created and run by the call to _beginthread().
3839 if (child_id == 0) /* child */
3842 #ifdef FEATURE_TOGGLE
3843 int inherited_toggle_state = global_toggle_state;
3844 #endif /* def FEATURE_TOGGLE */
3849 * If we've been toggled or we've blocked the request, tell Mom
3852 #ifdef FEATURE_TOGGLE
3853 if (inherited_toggle_state != global_toggle_state)
3855 rc |= RC_FLAG_TOGGLED;
3857 #endif /* def FEATURE_TOGGLE */
3859 #ifdef FEATURE_STATISTICS
3860 if (csp->flags & CSP_FLAG_REJECTED)
3862 rc |= RC_FLAG_BLOCKED;
3864 #endif /* ndef FEATURE_STATISTICS */
3868 else if (child_id > 0) /* parent */
3870 /* in a fork()'d environment, the parent's
3871 * copy of the client socket and the CSP
3875 #if !defined(_WIN32) && !defined(__CYGWIN__)
3877 wait(&child_status);
3880 * Evaluate child's return code: If the child has
3881 * - been toggled, toggle ourselves
3882 * - blocked its request, bump up the stats counter
3885 #ifdef FEATURE_TOGGLE
3886 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
3888 global_toggle_state = !global_toggle_state;
3890 #endif /* def FEATURE_TOGGLE */
3892 #ifdef FEATURE_STATISTICS
3894 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
3898 #endif /* def FEATURE_STATISTICS */
3900 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
3901 close_socket(csp->cfd);
3902 csp->flags &= ~CSP_FLAG_ACTIVE;
3906 #undef SELECTED_ONE_OPTION
3907 /* end of cpp switch () */
3912 * Spawning the child failed, assume it's because
3913 * there are too many children running already.
3914 * XXX: If you assume ...
3916 log_error(LOG_LEVEL_ERROR,
3917 "Unable to take any additional connections: %E");
3918 write_socket(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
3919 strlen(TOO_MANY_CONNECTIONS_RESPONSE));
3920 close_socket(csp->cfd);
3921 csp->flags &= ~CSP_FLAG_ACTIVE;
3930 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
3932 /* Clean up. Aim: free all memory (no leaks) */
3933 #ifdef FEATURE_GRACEFUL_TERMINATION
3935 log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
3937 unload_current_config_file();
3938 unload_current_actions_file();
3939 unload_current_re_filterfile();
3940 #ifdef FEATURE_TRUST
3941 unload_current_trust_file();
3944 if (config->multi_threaded)
3951 } while ((clients->next != NULL) && (--i > 0));
3955 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
3965 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
3966 /* Cleanup - remove taskbar icon etc. */
3971 #endif /* FEATURE_GRACEFUL_TERMINATION */