1 const char jcc_rcs[] = "$Id: jcc.c,v 1.427 2014/06/02 06:22:21 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-2014 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 #ifdef FEATURE_EXTERNAL_FILTERS
186 privoxy_mutex_t external_filter_mutex;
189 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
190 privoxy_mutex_t resolver_mutex;
191 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
193 #ifndef HAVE_GMTIME_R
194 privoxy_mutex_t gmtime_mutex;
195 #endif /* ndef HAVE_GMTIME_R */
197 #ifndef HAVE_LOCALTIME_R
198 privoxy_mutex_t localtime_mutex;
199 #endif /* ndef HAVE_GMTIME_R */
202 privoxy_mutex_t rand_mutex;
203 #endif /* ndef HAVE_RANDOM */
205 #endif /* def MUTEX_LOCKS_AVAILABLE */
208 const char *basedir = NULL;
209 const char *pidfile = NULL;
210 static int received_hup_signal = 0;
211 #endif /* defined unix */
213 /* HTTP snipplets. */
214 static const char CSUCCEED[] =
215 "HTTP/1.1 200 Connection established\r\n"
216 "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
218 static const char CHEADER[] =
219 "HTTP/1.1 400 Invalid header received from client\r\n"
220 "Proxy-Agent: Privoxy " VERSION "\r\n"
221 "Content-Type: text/plain\r\n"
222 "Connection: close\r\n\r\n"
223 "Invalid header received from client.\r\n";
225 static const char FTP_RESPONSE[] =
226 "HTTP/1.1 400 Invalid request received from client\r\n"
227 "Content-Type: text/plain\r\n"
228 "Connection: close\r\n\r\n"
229 "Invalid request. Privoxy doesn't support FTP.\r\n";
231 static const char GOPHER_RESPONSE[] =
232 "HTTP/1.1 400 Invalid request received from client\r\n"
233 "Content-Type: text/plain\r\n"
234 "Connection: close\r\n\r\n"
235 "Invalid request. Privoxy doesn't support gopher.\r\n";
237 /* XXX: should be a template */
238 static const char MISSING_DESTINATION_RESPONSE[] =
239 "HTTP/1.1 400 Bad request received from client\r\n"
240 "Proxy-Agent: Privoxy " VERSION "\r\n"
241 "Content-Type: text/plain\r\n"
242 "Connection: close\r\n\r\n"
243 "Bad request. Privoxy was unable to extract the destination.\r\n";
245 /* XXX: should be a template */
246 static const char INVALID_SERVER_HEADERS_RESPONSE[] =
247 "HTTP/1.1 502 Server or forwarder response invalid\r\n"
248 "Proxy-Agent: Privoxy " VERSION "\r\n"
249 "Content-Type: text/plain\r\n"
250 "Connection: close\r\n\r\n"
251 "Bad response. The server or forwarder response doesn't look like HTTP.\r\n";
253 /* XXX: should be a template */
254 static const char MESSED_UP_REQUEST_RESPONSE[] =
255 "HTTP/1.1 400 Malformed request after rewriting\r\n"
256 "Proxy-Agent: Privoxy " VERSION "\r\n"
257 "Content-Type: text/plain\r\n"
258 "Connection: close\r\n\r\n"
259 "Bad request. Messed up with header filters.\r\n";
261 static const char TOO_MANY_CONNECTIONS_RESPONSE[] =
262 "HTTP/1.1 503 Too many open connections\r\n"
263 "Proxy-Agent: Privoxy " VERSION "\r\n"
264 "Content-Type: text/plain\r\n"
265 "Connection: close\r\n\r\n"
266 "Maximum number of open connections reached.\r\n";
268 static const char CLIENT_CONNECTION_TIMEOUT_RESPONSE[] =
269 "HTTP/1.1 504 Connection timeout\r\n"
270 "Proxy-Agent: Privoxy " VERSION "\r\n"
271 "Content-Type: text/plain\r\n"
272 "Connection: close\r\n\r\n"
273 "The connection timed out because the client request didn't arrive in time.\r\n";
275 static const char CLIENT_BODY_PARSE_ERROR_RESPONSE[] =
276 "HTTP/1.1 400 Failed reading client body\r\n"
277 "Proxy-Agent: Privoxy " VERSION "\r\n"
278 "Content-Type: text/plain\r\n"
279 "Connection: close\r\n\r\n"
280 "Failed parsing or buffering the chunk-encoded client body.\r\n";
282 /* A function to crunch a response */
283 typedef struct http_response *(*crunch_func_ptr)(struct client_state *);
285 /* Crunch function flags */
286 #define CF_NO_FLAGS 0
287 /* Cruncher applies to forced requests as well */
288 #define CF_IGNORE_FORCE 1
289 /* Crunched requests are counted for the block statistics */
290 #define CF_COUNT_AS_REJECT 2
292 /* A crunch function and its flags */
295 const crunch_func_ptr cruncher;
299 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[]);
301 /* Complete list of cruncher functions */
302 static const struct cruncher crunchers_all[] = {
303 { direct_response, CF_COUNT_AS_REJECT|CF_IGNORE_FORCE},
304 { block_url, CF_COUNT_AS_REJECT },
306 { trust_url, CF_COUNT_AS_REJECT },
307 #endif /* def FEATURE_TRUST */
308 { redirect_url, CF_NO_FLAGS },
309 { dispatch_cgi, CF_IGNORE_FORCE},
313 /* Light version, used after tags are applied */
314 static const struct cruncher crunchers_light[] = {
315 { block_url, CF_COUNT_AS_REJECT },
316 { redirect_url, CF_NO_FLAGS },
322 * XXX: Don't we really mean
328 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
329 /*********************************************************************
331 * Function : sig_handler
333 * Description : Signal handler for different signals.
334 * Exit gracefully on TERM and INT
335 * or set a flag that will cause the errlog
336 * to be reopened by the main thread on HUP.
339 * 1 : the_signal = the signal cause this function to call
343 *********************************************************************/
344 static void sig_handler(int the_signal)
350 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
362 received_hup_signal = 1;
368 * We shouldn't be here, unless we catch signals
369 * in main() that we can't handle here!
371 log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
379 /*********************************************************************
381 * Function : client_protocol_is_unsupported
383 * Description : Checks if the client used a known unsupported
384 * protocol and deals with it by sending an error
388 * 1 : csp = Current client state (buffers, headers, etc...)
389 * 2 : req = the first request line send by the client
391 * Returns : TRUE if an error response has been generated, or
392 * FALSE if the request doesn't look invalid.
394 *********************************************************************/
395 static int client_protocol_is_unsupported(const struct client_state *csp, char *req)
398 * If it's a FTP or gopher request, we don't support it.
400 * These checks are better than nothing, but they might
401 * not work in all configurations and some clients might
402 * have problems digesting the answer.
404 * They should, however, never cause more problems than
405 * Privoxy's old behaviour (returning the misleading HTML
408 * "Could not resolve http://(ftp|gopher)://example.org").
410 if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
412 const char *response = NULL;
413 const char *protocol = NULL;
415 if (!strncmpic(req, "GET ftp://", 10))
417 response = FTP_RESPONSE;
422 response = GOPHER_RESPONSE;
425 log_error(LOG_LEVEL_ERROR,
426 "%s tried to use Privoxy as %s proxy: %s",
427 csp->ip_addr_str, protocol, req);
428 log_error(LOG_LEVEL_CLF,
429 "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, req);
431 write_socket(csp->cfd, response, strlen(response));
440 /*********************************************************************
442 * Function : get_request_destination_elsewhere
444 * Description : If the client's request was redirected into
445 * Privoxy without the client's knowledge,
446 * the request line lacks the destination host.
448 * This function tries to get it elsewhere,
449 * provided accept-intercepted-requests is enabled.
451 * "Elsewhere" currently only means "Host: header",
452 * but in the future we may ask the redirecting
453 * packet filter to look the destination up.
455 * If the destination stays unknown, an error
456 * response is send to the client and headers
457 * are freed so that chat() can return directly.
460 * 1 : csp = Current client state (buffers, headers, etc...)
461 * 2 : headers = a header list
463 * Returns : JB_ERR_OK if the destination is now known, or
464 * JB_ERR_PARSE if it isn't.
466 *********************************************************************/
467 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
471 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
473 log_error(LOG_LEVEL_ERROR, "%s's request: \'%s\' is invalid."
474 " Privoxy isn't configured to accept intercepted requests.",
475 csp->ip_addr_str, csp->http->cmd);
476 /* XXX: Use correct size */
477 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
478 csp->ip_addr_str, csp->http->cmd);
480 write_socket(csp->cfd, CHEADER, strlen(CHEADER));
481 destroy_list(headers);
485 else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
487 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
488 /* Split the domain we just got for pattern matching */
489 init_domain_components(csp->http);
496 /* We can't work without destination. Go spread the news.*/
498 req = list_to_text(headers);
500 /* XXX: Use correct size */
501 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
502 csp->ip_addr_str, csp->http->cmd);
503 log_error(LOG_LEVEL_ERROR,
504 "Privoxy was unable to get the destination for %s's request:\n%s\n%s",
505 csp->ip_addr_str, csp->http->cmd, req);
508 write_socket(csp->cfd, MISSING_DESTINATION_RESPONSE, strlen(MISSING_DESTINATION_RESPONSE));
509 destroy_list(headers);
514 * TODO: If available, use PF's ioctl DIOCNATLOOK as last resort
515 * to get the destination IP address, use it as host directly
516 * or do a reverse DNS lookup first.
521 /*********************************************************************
523 * Function : get_server_headers
525 * Description : Parses server headers in iob and fills them
526 * into csp->headers so that they can later be
530 * 1 : csp = Current client state (buffers, headers, etc...)
532 * Returns : JB_ERR_OK if everything went fine, or
533 * JB_ERR_PARSE if the headers were incomplete.
535 *********************************************************************/
536 static jb_err get_server_headers(struct client_state *csp)
538 int continue_hack_in_da_house = 0;
541 while (((header = get_header(csp->iob)) != NULL) || continue_hack_in_da_house)
546 * continue hack in da house. Ignore the ending of
547 * this head and continue enlisting header lines.
548 * The reason is described below.
550 enlist(csp->headers, "");
551 continue_hack_in_da_house = 0;
554 else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
557 * It's a bodyless continue response, don't
558 * stop header parsing after reaching its end.
560 * As a result Privoxy will concatenate the
561 * next response's head and parse and deliver
562 * the headers as if they belonged to one request.
564 * The client will separate them because of the
565 * empty line between them.
567 * XXX: What we're doing here is clearly against
568 * the intended purpose of the continue header,
569 * and under some conditions (HTTP/1.0 client request)
570 * it's a standard violation.
572 * Anyway, "sort of against the spec" is preferable
573 * to "always getting confused by Continue responses"
574 * (Privoxy's behaviour before this hack was added)
576 log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
577 continue_hack_in_da_house = 1;
579 else if (*header == '\0')
582 * If the header is empty, but the Continue hack
583 * isn't active, we can assume that we reached the
584 * end of the buffer before we hit the end of the
587 * Inform the caller an let it decide how to handle it.
592 if (JB_ERR_MEMORY == enlist(csp->headers, header))
595 * XXX: Should we quit the request and return a
596 * out of memory error page instead?
598 log_error(LOG_LEVEL_ERROR,
599 "Out of memory while enlisting server headers. %s lost.",
609 /*********************************************************************
611 * Function : crunch_reason
613 * Description : Translates the crunch reason code into a string.
616 * 1 : rsp = a http_response
618 * Returns : A string with the crunch reason or an error description.
620 *********************************************************************/
621 static const char *crunch_reason(const struct http_response *rsp)
623 char * reason = NULL;
628 return "Internal error while searching for crunch reason";
631 switch (rsp->crunch_reason)
634 reason = "Unsupported HTTP feature";
640 reason = "Untrusted";
643 reason = "Redirected";
649 reason = "DNS failure";
651 case FORWARDING_FAILED:
652 reason = "Forwarding failed";
655 reason = "Connection failure";
658 reason = "Out of memory (may mask other reasons)";
660 case CONNECTION_TIMEOUT:
661 reason = "Connection timeout";
664 reason = "No server data received";
667 reason = "No reason recorded";
675 /*********************************************************************
677 * Function : log_applied_actions
679 * Description : Logs the applied actions if LOG_LEVEL_ACTIONS is
683 * 1 : actions = Current action spec to log
687 *********************************************************************/
688 static void log_applied_actions(const struct current_action_spec *actions)
691 * The conversion to text requires lots of memory allocations so
692 * we only do the conversion if the user is actually interested.
694 if (debug_level_is_enabled(LOG_LEVEL_ACTIONS))
696 char *actions_as_text = actions_to_line_of_text(actions);
697 log_error(LOG_LEVEL_ACTIONS, "%s", actions_as_text);
698 freez(actions_as_text);
703 /*********************************************************************
705 * Function : send_crunch_response
707 * Description : Delivers already prepared response for
708 * intercepted requests, logs the interception
709 * and frees the response.
712 * 1 : csp = Current client state (buffers, headers, etc...)
713 * 1 : rsp = Fully prepared response. Will be freed on exit.
717 *********************************************************************/
718 static void send_crunch_response(const struct client_state *csp, struct http_response *rsp)
720 const struct http_request *http = csp->http;
724 assert(rsp->head != NULL);
728 log_error(LOG_LEVEL_FATAL, "NULL response in send_crunch_response.");
732 * Extract the status code from the actual head
733 * that will be send to the client. It is the only
734 * way to get it right for all requests, including
735 * the fixed ones for out-of-memory problems.
737 * A head starts like this: 'HTTP/1.1 200...'
741 status_code[0] = rsp->head[9];
742 status_code[1] = rsp->head[10];
743 status_code[2] = rsp->head[11];
744 status_code[3] = '\0';
746 /* Log that the request was crunched and why. */
747 log_applied_actions(csp->action);
748 log_error(LOG_LEVEL_CRUNCH, "%s: %s", crunch_reason(rsp), http->url);
749 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" %s %u",
750 csp->ip_addr_str, http->ocmd, status_code, rsp->content_length);
752 /* Write the answer to the client */
753 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
754 || write_socket(csp->cfd, rsp->body, rsp->content_length))
756 /* There is nothing we can do about it. */
757 log_error(LOG_LEVEL_ERROR,
758 "Couldn't deliver the error message through client socket %d: %E",
762 /* Clean up and return */
763 if (cgi_error_memory() != rsp)
765 free_http_response(rsp);
771 /*********************************************************************
773 * Function : crunch_response_triggered
775 * Description : Checks if the request has to be crunched,
776 * and delivers the crunch response if necessary.
779 * 1 : csp = Current client state (buffers, headers, etc...)
780 * 2 : crunchers = list of cruncher functions to run
782 * Returns : TRUE if the request was answered with a crunch response
785 *********************************************************************/
786 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[])
788 struct http_response *rsp = NULL;
789 const struct cruncher *c;
792 * If CGI request crunching is disabled,
793 * check the CGI dispatcher out of order to
794 * prevent unintentional blocks or redirects.
796 if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_CRUNCHING)
797 && (NULL != (rsp = dispatch_cgi(csp))))
799 /* Deliver, log and free the interception response. */
800 send_crunch_response(csp, rsp);
801 csp->flags |= CSP_FLAG_CRUNCHED;
805 for (c = crunchers; c->cruncher != NULL; c++)
808 * Check the cruncher if either Privoxy is toggled
809 * on and the request isn't forced, or if the cruncher
810 * applies to forced requests as well.
812 if (((csp->flags & CSP_FLAG_TOGGLED_ON) &&
813 !(csp->flags & CSP_FLAG_FORCED)) ||
814 (c->flags & CF_IGNORE_FORCE))
816 rsp = c->cruncher(csp);
819 /* Deliver, log and free the interception response. */
820 send_crunch_response(csp, rsp);
821 csp->flags |= CSP_FLAG_CRUNCHED;
822 #ifdef FEATURE_STATISTICS
823 if (c->flags & CF_COUNT_AS_REJECT)
825 csp->flags |= CSP_FLAG_REJECTED;
827 #endif /* def FEATURE_STATISTICS */
838 /*********************************************************************
840 * Function : build_request_line
842 * Description : Builds the HTTP request line.
844 * If a HTTP forwarder is used it expects the whole URL,
845 * web servers only get the path.
848 * 1 : csp = Current client state (buffers, headers, etc...)
849 * 2 : fwd = The forwarding spec used for the request
850 * XXX: Should use http->fwd instead.
851 * 3 : request_line = The old request line which will be replaced.
853 * Returns : Nothing. Terminates in case of memory problems.
855 *********************************************************************/
856 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line)
858 struct http_request *http = csp->http;
860 assert(http->ssl == 0);
863 * Downgrade http version from 1.1 to 1.0
864 * if +downgrade action applies.
866 if ((csp->action->flags & ACTION_DOWNGRADE)
867 && (!strcmpic(http->ver, "HTTP/1.1")))
870 http->ver = strdup_or_die("HTTP/1.0");
874 * Rebuild the request line.
876 freez(*request_line);
877 *request_line = strdup(http->gpc);
878 string_append(request_line, " ");
880 if (fwd->forward_host)
882 string_append(request_line, http->url);
886 string_append(request_line, http->path);
888 string_append(request_line, " ");
889 string_append(request_line, http->ver);
891 if (*request_line == NULL)
893 log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
895 log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", *request_line);
899 /*********************************************************************
901 * Function : change_request_destination
903 * Description : Parse a (rewritten) request line and regenerate
904 * the http request data.
907 * 1 : csp = Current client state (buffers, headers, etc...)
909 * Returns : Forwards the parse_http_request() return code.
910 * Terminates in case of memory problems.
912 *********************************************************************/
913 static jb_err change_request_destination(struct client_state *csp)
915 struct http_request *http = csp->http;
918 log_error(LOG_LEVEL_REDIRECTS, "Rewrite detected: %s",
919 csp->headers->first->str);
920 free_http_request(http);
921 err = parse_http_request(csp->headers->first->str, http);
922 if (JB_ERR_OK != err)
924 log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
925 jb_err_to_string(err));
932 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
933 /*********************************************************************
935 * Function : server_response_is_complete
937 * Description : Determines whether we should stop reading
938 * from the server socket.
941 * 1 : csp = Current client state (buffers, headers, etc...)
942 * 2 : content_length = Length of content received so far.
944 * Returns : TRUE if the response is complete,
947 *********************************************************************/
948 static int server_response_is_complete(struct client_state *csp,
949 unsigned long long content_length)
951 int content_length_known = !!(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET);
953 if (!strcmpic(csp->http->gpc, "HEAD"))
956 * "HEAD" implies no body, we are thus expecting
957 * no content. XXX: incomplete "list" of methods?
959 csp->expected_content_length = 0;
960 content_length_known = TRUE;
961 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
964 if (csp->http->status == 204 || csp->http->status == 304)
967 * Expect no body. XXX: incomplete "list" of status codes?
969 csp->expected_content_length = 0;
970 content_length_known = TRUE;
971 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
974 return (content_length_known && ((0 == csp->expected_content_length)
975 || (csp->expected_content_length <= content_length)));
979 #ifdef FEATURE_CONNECTION_SHARING
980 /*********************************************************************
982 * Function : wait_for_alive_connections
984 * Description : Waits for alive connections to timeout.
990 *********************************************************************/
991 static void wait_for_alive_connections(void)
993 int connections_alive = close_unusable_connections();
995 while (0 < connections_alive)
997 log_error(LOG_LEVEL_CONNECT,
998 "Waiting for %d connections to timeout.",
1001 connections_alive = close_unusable_connections();
1004 log_error(LOG_LEVEL_CONNECT, "No connections to wait for left.");
1007 #endif /* def FEATURE_CONNECTION_SHARING */
1010 /*********************************************************************
1012 * Function : save_connection_destination
1014 * Description : Remembers a connection for reuse later on.
1017 * 1 : sfd = Open socket to remember.
1018 * 2 : http = The destination for the connection.
1019 * 3 : fwd = The forwarder settings used.
1020 * 3 : server_connection = storage.
1024 *********************************************************************/
1025 void save_connection_destination(jb_socket sfd,
1026 const struct http_request *http,
1027 const struct forward_spec *fwd,
1028 struct reusable_connection *server_connection)
1030 assert(sfd != JB_INVALID_SOCKET);
1031 assert(NULL != http->host);
1033 server_connection->sfd = sfd;
1034 server_connection->host = strdup_or_die(http->host);
1035 server_connection->port = http->port;
1037 assert(NULL != fwd);
1038 assert(server_connection->gateway_host == NULL);
1039 assert(server_connection->gateway_port == 0);
1040 assert(server_connection->forwarder_type == 0);
1041 assert(server_connection->forward_host == NULL);
1042 assert(server_connection->forward_port == 0);
1044 server_connection->forwarder_type = fwd->type;
1045 if (NULL != fwd->gateway_host)
1047 server_connection->gateway_host = strdup_or_die(fwd->gateway_host);
1051 server_connection->gateway_host = NULL;
1053 server_connection->gateway_port = fwd->gateway_port;
1055 if (NULL != fwd->forward_host)
1057 server_connection->forward_host = strdup_or_die(fwd->forward_host);
1061 server_connection->forward_host = NULL;
1063 server_connection->forward_port = fwd->forward_port;
1067 /*********************************************************************
1069 * Function : verify_request_length
1071 * Description : Checks if we already got the whole client requests
1072 * and sets CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ if
1075 * Data that doesn't belong to the current request is
1076 * either thrown away to let the client retry on a clean
1077 * socket, or stashed to be dealt with after the current
1078 * request is served.
1081 * 1 : csp = Current client state (buffers, headers, etc...)
1085 *********************************************************************/
1086 static void verify_request_length(struct client_state *csp)
1088 unsigned long long buffered_request_bytes =
1089 (unsigned long long)(csp->client_iob->eod - csp->client_iob->cur);
1091 if ((csp->expected_client_content_length != 0)
1092 && (buffered_request_bytes != 0))
1094 if (csp->expected_client_content_length >= buffered_request_bytes)
1096 csp->expected_client_content_length -= buffered_request_bytes;
1097 log_error(LOG_LEVEL_CONNECT, "Reduced expected bytes to %llu "
1098 "to account for the %llu ones we already got.",
1099 csp->expected_client_content_length, buffered_request_bytes);
1103 assert(csp->client_iob->eod > csp->client_iob->cur + csp->expected_client_content_length);
1104 csp->client_iob->eod = csp->client_iob->cur + csp->expected_client_content_length;
1105 log_error(LOG_LEVEL_CONNECT, "Reducing expected bytes to 0. "
1106 "Marking the server socket tainted after throwing %llu bytes away.",
1107 buffered_request_bytes - csp->expected_client_content_length);
1108 csp->expected_client_content_length = 0;
1109 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1112 if (csp->expected_client_content_length == 0)
1114 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1118 if (!(csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ)
1119 && ((csp->client_iob->cur < csp->client_iob->eod)
1120 || (csp->expected_client_content_length != 0)))
1122 if (strcmpic(csp->http->gpc, "GET")
1123 && strcmpic(csp->http->gpc, "HEAD")
1124 && strcmpic(csp->http->gpc, "TRACE")
1125 && strcmpic(csp->http->gpc, "OPTIONS")
1126 && strcmpic(csp->http->gpc, "DELETE"))
1128 /* XXX: this is an incomplete hack */
1129 csp->flags &= ~CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1130 log_error(LOG_LEVEL_CONNECT, "There better be a request body.");
1134 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1136 if ((csp->config->feature_flags & RUNTIME_FEATURE_TOLERATE_PIPELINING) == 0)
1138 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1139 log_error(LOG_LEVEL_CONNECT,
1140 "Possible pipeline attempt detected. The connection will not "
1141 "be kept alive and we will only serve the first request.");
1142 /* Nuke the pipelined requests from orbit, just to be sure. */
1143 clear_iob(csp->client_iob);
1148 * Keep the pipelined data around for now, we'll deal with
1149 * it once we're done serving the current request.
1151 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
1152 assert(csp->client_iob->eod >= csp->client_iob->cur);
1153 log_error(LOG_LEVEL_CONNECT, "Complete client request followed by "
1154 "%d bytes of pipelined data received.",
1155 (int)(csp->client_iob->eod - csp->client_iob->cur));
1161 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1162 log_error(LOG_LEVEL_CONNECT, "Complete client request received.");
1165 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1168 /*********************************************************************
1170 * Function : mark_server_socket_tainted
1172 * Description : Makes sure we don't reuse a server socket
1173 * (if we didn't read everything the server sent
1174 * us reusing the socket would lead to garbage).
1177 * 1 : csp = Current client state (buffers, headers, etc...)
1181 *********************************************************************/
1182 static void mark_server_socket_tainted(struct client_state *csp)
1185 * For consistency we always mark the server socket
1186 * tainted, however, to reduce the log noise we only
1187 * emit a log message if the server socket could have
1188 * actually been reused.
1190 if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
1191 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED))
1193 log_error(LOG_LEVEL_CONNECT,
1194 "Marking the server socket %d tainted.",
1195 csp->server_connection.sfd);
1197 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1200 /*********************************************************************
1202 * Function : get_request_line
1204 * Description : Read the client request line.
1207 * 1 : csp = Current client state (buffers, headers, etc...)
1209 * Returns : Pointer to request line or NULL in case of errors.
1211 *********************************************************************/
1212 static char *get_request_line(struct client_state *csp)
1214 char buf[BUFFER_SIZE];
1215 char *request_line = NULL;
1218 memset(buf, 0, sizeof(buf));
1220 if ((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
1223 * If there are multiple pipelined requests waiting,
1224 * the flag will be set again once the next request
1227 csp->flags &= ~CSP_FLAG_PIPELINED_REQUEST_WAITING;
1229 request_line = get_header(csp->client_iob);
1230 if ((NULL != request_line) && ('\0' != *request_line))
1232 return request_line;
1236 log_error(LOG_LEVEL_CONNECT, "No complete request line "
1237 "received yet. Continuing reading from %d.", csp->cfd);
1243 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1245 if (socket_is_still_alive(csp->cfd))
1247 log_error(LOG_LEVEL_CONNECT,
1248 "No request line on socket %d received in time. Timeout: %d.",
1249 csp->cfd, csp->config->socket_timeout);
1250 write_socket(csp->cfd, CLIENT_CONNECTION_TIMEOUT_RESPONSE,
1251 strlen(CLIENT_CONNECTION_TIMEOUT_RESPONSE));
1255 log_error(LOG_LEVEL_CONNECT,
1256 "The client side of the connection on socket %d got "
1257 "closed without sending a complete request line.", csp->cfd);
1262 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1264 if (len <= 0) return NULL;
1267 * If there is no memory left for buffering the
1268 * request, there is nothing we can do but hang up
1270 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1275 request_line = get_header(csp->client_iob);
1277 } while ((NULL != request_line) && ('\0' == *request_line));
1279 return request_line;
1285 CHUNK_STATUS_MISSING_DATA,
1286 CHUNK_STATUS_BODY_COMPLETE,
1287 CHUNK_STATUS_PARSE_ERROR
1291 /*********************************************************************
1293 * Function : chunked_body_is_complete
1295 * Description : Figures out wheter or not a chunked body is complete.
1297 * Currently it always starts at the beginning of the
1298 * buffer which is somewhat wasteful and prevents Privoxy
1299 * from starting to forward the correctly parsed chunks
1300 * as soon as theoretically possible.
1302 * Should be modified to work with a common buffer,
1303 * and allow the caller to skip already parsed chunks.
1305 * This would allow the function to be used for unbuffered
1306 * response bodies as well.
1309 * 1 : iob = Buffer with the body to check.
1310 * 2 : length = Length of complete body
1312 * Returns : Enum with the result of the check.
1314 *********************************************************************/
1315 static enum chunk_status chunked_body_is_complete(struct iob *iob, size_t *length)
1317 unsigned int chunksize;
1323 * We need at least a single digit, followed by "\r\n",
1324 * followed by an unknown amount of data, followed by "\r\n".
1326 if (p + 5 > iob->eod)
1328 return CHUNK_STATUS_MISSING_DATA;
1330 if (sscanf(p, "%x", &chunksize) != 1)
1332 return CHUNK_STATUS_PARSE_ERROR;
1336 * We want at least a single digit, followed by "\r\n",
1337 * followed by the specified amount of data, followed by "\r\n".
1339 if (p + chunksize + 5 > iob->eod)
1341 return CHUNK_STATUS_MISSING_DATA;
1344 /* Skip chunk-size. */
1345 p = strstr(p, "\r\n");
1348 return CHUNK_STATUS_PARSE_ERROR;
1351 * Skip "\r\n", the chunk data and another "\r\n".
1352 * Moving p to either the beginning of the next chunk-size
1353 * or one byte beyond the end of the chunked data.
1355 p += 2 + chunksize + 2;
1356 } while (chunksize > 0U);
1358 *length = (size_t)(p - iob->cur);
1359 assert(*length <= (size_t)(iob->eod - iob->cur));
1360 assert(p <= iob->eod);
1362 return CHUNK_STATUS_BODY_COMPLETE;
1367 /*********************************************************************
1369 * Function : receive_chunked_client_request_body
1371 * Description : Read the chunk-encoded client request body.
1372 * Failures are dealt with.
1375 * 1 : csp = Current client state (buffers, headers, etc...)
1377 * Returns : JB_ERR_OK or JB_ERR_PARSE
1379 *********************************************************************/
1380 static jb_err receive_chunked_client_request_body(struct client_state *csp)
1383 enum chunk_status status;
1385 while (CHUNK_STATUS_MISSING_DATA ==
1386 (status = chunked_body_is_complete(csp->client_iob,&body_length)))
1388 char buf[BUFFER_SIZE];
1391 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1393 log_error(LOG_LEVEL_ERROR,
1394 "Timeout while waiting for the client body.");
1397 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1400 log_error(LOG_LEVEL_ERROR, "Read the client body failed: %E");
1403 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1408 if (status != CHUNK_STATUS_BODY_COMPLETE)
1410 write_socket(csp->cfd, CLIENT_BODY_PARSE_ERROR_RESPONSE,
1411 strlen(CLIENT_BODY_PARSE_ERROR_RESPONSE));
1412 log_error(LOG_LEVEL_CLF,
1413 "%s - - [%T] \"Failed reading chunked client body\" 400 0", csp->ip_addr_str);
1414 return JB_ERR_PARSE;
1416 log_error(LOG_LEVEL_CONNECT,
1417 "Chunked client body completely read. Length: %d", body_length);
1418 csp->expected_client_content_length = body_length;
1424 /*********************************************************************
1426 * Function : receive_client_request
1428 * Description : Read the client's request (more precisely the
1429 * client headers) and answer it if necessary.
1432 * 1 : csp = Current client state (buffers, headers, etc...)
1434 * Returns : JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
1436 *********************************************************************/
1437 static jb_err receive_client_request(struct client_state *csp)
1439 char buf[BUFFER_SIZE];
1442 struct http_request *http;
1446 /* Temporary copy of the client's headers before they get enlisted in csp->headers */
1447 struct list header_list;
1448 struct list *headers = &header_list;
1450 /* We don't care if the arriving data is a valid HTTP request or not. */
1451 csp->requests_received_total++;
1455 memset(buf, 0, sizeof(buf));
1457 req = get_request_line(csp);
1460 mark_server_socket_tainted(csp);
1461 return JB_ERR_PARSE;
1463 assert(*req != '\0');
1465 if (client_protocol_is_unsupported(csp, req))
1467 return JB_ERR_PARSE;
1470 #ifdef FEATURE_FORCE_LOAD
1472 * If this request contains the FORCE_PREFIX and blocks
1473 * aren't enforced, get rid of it and set the force flag.
1475 if (strstr(req, FORCE_PREFIX))
1477 if (csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS)
1479 log_error(LOG_LEVEL_FORCE,
1480 "Ignored force prefix in request: \"%s\".", req);
1484 strclean(req, FORCE_PREFIX);
1485 log_error(LOG_LEVEL_FORCE, "Enforcing request: \"%s\".", req);
1486 csp->flags |= CSP_FLAG_FORCED;
1489 #endif /* def FEATURE_FORCE_LOAD */
1491 err = parse_http_request(req, http);
1493 if (JB_ERR_OK != err)
1495 write_socket(csp->cfd, CHEADER, strlen(CHEADER));
1496 /* XXX: Use correct size */
1497 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1498 log_error(LOG_LEVEL_ERROR,
1499 "Couldn't parse request line received from %s: %s",
1500 csp->ip_addr_str, jb_err_to_string(err));
1502 free_http_request(http);
1503 return JB_ERR_PARSE;
1506 /* grab the rest of the client's headers */
1510 p = get_header(csp->client_iob);
1514 /* There are no additional headers to read. */
1521 * We didn't receive a complete header
1522 * line yet, get the rest of it.
1524 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1526 log_error(LOG_LEVEL_ERROR,
1527 "Stopped grabbing the client headers.");
1528 destroy_list(headers);
1529 return JB_ERR_PARSE;
1532 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1535 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1536 destroy_list(headers);
1537 return JB_ERR_PARSE;
1540 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1543 * If there is no memory left for buffering the
1544 * request, there is nothing we can do but hang up
1546 destroy_list(headers);
1547 return JB_ERR_MEMORY;
1552 if (!strncmpic(p, "Transfer-Encoding:", 18))
1555 * XXX: should be called through sed()
1556 * but currently can't.
1558 client_transfer_encoding(csp, &p);
1561 * We were able to read a complete
1562 * header and can finally enlist it.
1569 if (http->host == NULL)
1572 * If we still don't know the request destination,
1573 * the request is invalid or the client uses
1574 * Privoxy without its knowledge.
1576 if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
1579 * Our attempts to get the request destination
1580 * elsewhere failed or Privoxy is configured
1581 * to only accept proxy requests.
1583 * An error response has already been send
1584 * and we're done here.
1586 return JB_ERR_PARSE;
1591 * Determine the actions for this URL
1593 #ifdef FEATURE_TOGGLE
1594 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
1596 /* Most compatible set of actions (i.e. none) */
1597 init_current_action(csp->action);
1600 #endif /* ndef FEATURE_TOGGLE */
1602 get_url_actions(csp, http);
1605 enlist(csp->headers, http->cmd);
1607 /* Append the previously read headers */
1608 list_append_list_unique(csp->headers, headers);
1609 destroy_list(headers);
1616 /*********************************************************************
1618 * Function : parse_client_request
1620 * Description : Parses the client's request and decides what to do
1623 * Note that since we're not using select() we could get
1624 * blocked here if a client connected, then didn't say
1628 * 1 : csp = Current client state (buffers, headers, etc...)
1630 * Returns : JB_ERR_OK or JB_ERR_PARSE
1632 *********************************************************************/
1633 static jb_err parse_client_request(struct client_state *csp)
1635 struct http_request *http = csp->http;
1638 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1639 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
1640 && (!strcmpic(csp->http->ver, "HTTP/1.1"))
1641 && (csp->http->ssl == 0))
1643 /* Assume persistence until further notice */
1644 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1647 if (csp->http->ssl == 0)
1650 * This whole block belongs to chat() but currently
1651 * has to be executed before sed().
1653 if (csp->flags & CSP_FLAG_CHUNKED_CLIENT_BODY)
1655 if (receive_chunked_client_request_body(csp) != JB_ERR_OK)
1657 return JB_ERR_PARSE;
1662 csp->expected_client_content_length = get_expected_content_length(csp->headers);
1664 verify_request_length(csp);
1666 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1668 err = sed(csp, FILTER_CLIENT_HEADERS);
1669 if (JB_ERR_OK != err)
1671 /* XXX: Should be handled in sed(). */
1672 assert(err == JB_ERR_PARSE);
1673 log_error(LOG_LEVEL_FATAL, "Failed to parse client headers.");
1675 csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
1677 /* Check request line for rewrites. */
1678 if ((NULL == csp->headers->first->str)
1679 || (strcmp(http->cmd, csp->headers->first->str) &&
1680 (JB_ERR_OK != change_request_destination(csp))))
1683 * A header filter broke the request line - bail out.
1685 write_socket(csp->cfd, MESSED_UP_REQUEST_RESPONSE, strlen(MESSED_UP_REQUEST_RESPONSE));
1686 /* XXX: Use correct size */
1687 log_error(LOG_LEVEL_CLF,
1688 "%s - - [%T] \"Invalid request generated\" 500 0", csp->ip_addr_str);
1689 log_error(LOG_LEVEL_ERROR,
1690 "Invalid request line after applying header filters.");
1691 free_http_request(http);
1693 return JB_ERR_PARSE;
1701 /*********************************************************************
1705 * Description : Once a connection from the client has been accepted,
1706 * this function is called (via serve()) to handle the
1707 * main business of the communication. This function
1708 * returns after dealing with a single request. It can
1709 * be called multiple times with the same client socket
1710 * if the client is keeping the connection alive.
1712 * The decision whether or not a client connection will
1713 * be kept alive is up to the caller which also must
1714 * close the client socket when done.
1716 * FIXME: chat is nearly thousand lines long.
1720 * 1 : csp = Current client state (buffers, headers, etc...)
1722 * Returns : Nothing.
1724 *********************************************************************/
1725 static void chat(struct client_state *csp)
1727 char buf[BUFFER_SIZE];
1734 int ms_iis5_hack = 0;
1735 unsigned long long byte_count = 0;
1736 const struct forward_spec *fwd;
1737 struct http_request *http;
1738 long len = 0; /* for buffer sizes (and negative error codes) */
1739 int buffer_and_filter_content = 0;
1741 /* Skeleton for HTTP response, if we should intercept the request */
1742 struct http_response *rsp;
1743 struct timeval timeout;
1744 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1745 int watch_client_socket;
1748 memset(buf, 0, sizeof(buf));
1752 if (receive_client_request(csp) != JB_ERR_OK)
1756 if (parse_client_request(csp) != JB_ERR_OK)
1761 /* decide how to route the HTTP request */
1762 fwd = forward_url(csp, http);
1765 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!? This can't happen!");
1766 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1771 * build the http request to send to the server
1772 * we have to do one of the following:
1774 * create = use the original HTTP request to create a new
1775 * HTTP request that has either the path component
1776 * without the http://domainspec (w/path) or the
1777 * full orininal URL (w/url)
1778 * Note that the path and/or the HTTP version may
1779 * have been altered by now.
1781 * connect = Open a socket to the host:port of the server
1782 * and short-circuit server and client socket.
1784 * pass = Pass the request unchanged if forwarding a CONNECT
1785 * request to a parent proxy. Note that we'll be sending
1786 * the CFAIL message ourselves if connecting to the parent
1787 * fails, but we won't send a CSUCCEED message if it works,
1788 * since that would result in a double message (ours and the
1789 * parent's). After sending the request to the parent, we simply
1792 * here's the matrix:
1795 * +--------+--------+
1797 * 0 | create | connect|
1799 * Forwarding +--------+--------+
1801 * 1 | create | pass |
1803 * +--------+--------+
1807 if (http->ssl && connect_port_is_forbidden(csp))
1809 const char *acceptable_connect_ports =
1810 csp->action->string[ACTION_STRING_LIMIT_CONNECT];
1811 assert(NULL != acceptable_connect_ports);
1812 log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
1813 "limit-connect{%s} doesn't allow CONNECT requests to %s",
1814 csp->ip_addr_str, acceptable_connect_ports, csp->http->hostport);
1815 csp->action->flags |= ACTION_BLOCK;
1821 freez(csp->headers->first->str);
1822 build_request_line(csp, fwd, &csp->headers->first->str);
1826 * We have a request. Check if one of the crunchers wants it.
1828 if (crunch_response_triggered(csp, crunchers_all))
1831 * Yes. The client got the crunch response and we're done here.
1836 log_applied_actions(csp->action);
1837 log_error(LOG_LEVEL_GPC, "%s%s", http->hostport, http->path);
1839 if (fwd->forward_host)
1841 log_error(LOG_LEVEL_CONNECT, "via [%s]:%d to: %s",
1842 fwd->forward_host, fwd->forward_port, http->hostport);
1846 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
1849 /* here we connect to the server, gateway, or the forwarder */
1851 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1852 if ((csp->server_connection.sfd != JB_INVALID_SOCKET)
1853 && socket_is_still_alive(csp->server_connection.sfd)
1854 && connection_destination_matches(&csp->server_connection, http, fwd))
1856 log_error(LOG_LEVEL_CONNECT,
1857 "Reusing server socket %d connected to %s. Total requests: %u.",
1858 csp->server_connection.sfd, csp->server_connection.host,
1859 csp->server_connection.requests_sent_total);
1863 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
1865 #ifdef FEATURE_CONNECTION_SHARING
1866 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
1868 remember_connection(&csp->server_connection);
1871 #endif /* def FEATURE_CONNECTION_SHARING */
1873 log_error(LOG_LEVEL_CONNECT,
1874 "Closing server socket %d connected to %s. Total requests: %u.",
1875 csp->server_connection.sfd, csp->server_connection.host,
1876 csp->server_connection.requests_sent_total);
1877 close_socket(csp->server_connection.sfd);
1879 mark_connection_closed(&csp->server_connection);
1881 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1883 csp->server_connection.sfd = forwarded_connect(fwd, http, csp);
1885 if (csp->server_connection.sfd == JB_INVALID_SOCKET)
1887 if (fwd->type != SOCKS_NONE)
1890 rsp = error_response(csp, "forwarding-failed");
1892 else if (errno == EINVAL)
1894 rsp = error_response(csp, "no-such-domain");
1898 rsp = error_response(csp, "connect-failed");
1901 /* Write the answer to the client */
1904 send_crunch_response(csp, rsp);
1909 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1910 save_connection_destination(csp->server_connection.sfd,
1911 http, fwd, &csp->server_connection);
1912 csp->server_connection.keep_alive_timeout =
1913 (unsigned)csp->config->keep_alive_timeout;
1915 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1917 csp->server_connection.requests_sent_total++;
1919 if ((fwd->type == SOCKS_5T) && (NULL == csp->headers->first))
1921 /* Client headers have been sent optimistically */
1922 assert(csp->headers->last == NULL);
1924 else if (fwd->forward_host || (http->ssl == 0))
1927 hdr = list_to_text(csp->headers);
1930 /* FIXME Should handle error properly */
1931 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
1933 list_remove_all(csp->headers);
1936 * Write the client's (modified) header to the server
1937 * (along with anything else that may be in the buffer)
1939 write_failure = 0 != write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
1944 log_error(LOG_LEVEL_CONNECT,
1945 "Failed sending request headers to: %s: %E", http->hostport);
1947 else if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
1948 && (flush_socket(csp->server_connection.sfd, csp->client_iob) < 0))
1951 log_error(LOG_LEVEL_CONNECT,
1952 "Failed sending request body to: %s: %E", http->hostport);
1957 rsp = error_response(csp, "connect-failed");
1960 send_crunch_response(csp, rsp);
1968 * We're running an SSL tunnel and we're not forwarding,
1969 * so just ditch the client headers, send the "connect succeeded"
1970 * message to the client, flush the rest, and get out of the way.
1972 list_remove_all(csp->headers);
1973 if (write_socket(csp->cfd, CSUCCEED, strlen(CSUCCEED)))
1977 clear_iob(csp->client_iob);
1980 log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
1982 /* XXX: should the time start earlier for optimistically sent data? */
1983 csp->server_connection.request_sent = time(NULL);
1985 maxfd = (csp->cfd > csp->server_connection.sfd) ?
1986 csp->cfd : csp->server_connection.sfd;
1988 /* pass data between the client and server
1989 * until one or the other shuts down the connection.
1994 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1995 watch_client_socket = 0 == (csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING);
2002 * FD_ZERO here seems to point to an errant macro which crashes.
2003 * So do this by hand for now...
2005 memset(&rfds,0x00,sizeof(fd_set));
2009 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2010 if (!watch_client_socket)
2012 maxfd = csp->server_connection.sfd;
2015 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2017 FD_SET(csp->cfd, &rfds);
2020 FD_SET(csp->server_connection.sfd, &rfds);
2022 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2023 if ((csp->flags & CSP_FLAG_CHUNKED)
2024 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2025 && ((csp->iob->eod - csp->iob->cur) >= 5)
2026 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
2029 * XXX: This check should be obsolete now,
2030 * but let's wait a while to be sure.
2032 log_error(LOG_LEVEL_CONNECT,
2033 "Looks like we got the last chunk together with "
2034 "the server headers but didn't detect it earlier. "
2035 "We better stop reading.");
2036 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2037 csp->expected_content_length = byte_count;
2038 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2040 if (server_body && server_response_is_complete(csp, byte_count))
2042 if (csp->expected_content_length == byte_count)
2044 log_error(LOG_LEVEL_CONNECT,
2045 "Done reading from server. Content length: %llu as expected. "
2046 "Bytes most recently read: %d.",
2051 log_error(LOG_LEVEL_CONNECT,
2052 "Done reading from server. Expected content length: %llu. "
2053 "Actual content length: %llu. Bytes most recently read: %d.",
2054 csp->expected_content_length, byte_count, len);
2058 * XXX: should not jump around,
2059 * chat() is complicated enough already.
2063 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2065 timeout.tv_sec = csp->config->socket_timeout;
2066 timeout.tv_usec = 0;
2067 n = select((int)maxfd+1, &rfds, NULL, NULL, &timeout);
2071 log_error(LOG_LEVEL_ERROR,
2072 "Didn't receive data in time: %s", http->url);
2073 if ((byte_count == 0) && (http->ssl == 0))
2075 send_crunch_response(csp, error_response(csp, "connection-timeout"));
2077 mark_server_socket_tainted(csp);
2082 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
2083 mark_server_socket_tainted(csp);
2088 * This is the body of the browser's request,
2089 * just read and write it.
2091 * XXX: Make sure the client doesn't use pipelining
2092 * behind Privoxy's back.
2094 if (FD_ISSET(csp->cfd, &rfds))
2096 int max_bytes_to_read = sizeof(buf) - 1;
2098 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2099 if ((csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ))
2101 if (data_is_available(csp->cfd, 0))
2104 * If the next request is already waiting, we have
2105 * to stop select()ing the client socket. Otherwise
2106 * we would always return right away and get nothing
2109 watch_client_socket = 0;
2110 log_error(LOG_LEVEL_CONNECT,
2111 "Stopping to watch the client socket %d. "
2112 "There's already another request waiting.",
2117 * If the client socket is set, but there's no data
2118 * available on the socket, the client went fishing
2119 * and continuing talking to the server makes no sense.
2121 log_error(LOG_LEVEL_CONNECT,
2122 "The client closed socket %d while "
2123 "the server socket %d is still open.",
2124 csp->cfd, csp->server_connection.sfd);
2125 mark_server_socket_tainted(csp);
2128 if (csp->expected_client_content_length != 0)
2130 if (csp->expected_client_content_length < (sizeof(buf) - 1))
2132 max_bytes_to_read = (int)csp->expected_client_content_length;
2134 log_error(LOG_LEVEL_CONNECT,
2135 "Waiting for up to %d bytes from the client.",
2138 assert(max_bytes_to_read < sizeof(buf));
2139 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2141 len = read_socket(csp->cfd, buf, max_bytes_to_read);
2145 /* XXX: not sure if this is necessary. */
2146 mark_server_socket_tainted(csp);
2147 break; /* "game over, man" */
2150 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2151 if (csp->expected_client_content_length != 0)
2153 assert(len <= max_bytes_to_read);
2154 csp->expected_client_content_length -= (unsigned)len;
2155 log_error(LOG_LEVEL_CONNECT,
2156 "Expected client content length set to %llu "
2157 "after reading %d bytes.",
2158 csp->expected_client_content_length, len);
2159 if (csp->expected_client_content_length == 0)
2161 log_error(LOG_LEVEL_CONNECT,
2162 "Done reading from the client.");
2163 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
2166 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2168 if (write_socket(csp->server_connection.sfd, buf, (size_t)len))
2170 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
2171 mark_server_socket_tainted(csp);
2178 * The server wants to talk. It could be the header or the body.
2179 * If `hdr' is null, then it's the header otherwise it's the body.
2180 * FIXME: Does `hdr' really mean `host'? No.
2182 if (FD_ISSET(csp->server_connection.sfd, &rfds))
2184 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2186 * If we are buffering content, we don't want to eat up to
2187 * buffer-limit bytes if the client no longer cares about them.
2188 * If we aren't buffering, however, a dead client socket will be
2189 * noticed pretty much right away anyway, so we can reduce the
2190 * overhead by skipping the check.
2192 if (buffer_and_filter_content && !socket_is_still_alive(csp->cfd))
2195 log_error(LOG_LEVEL_CONNECT,
2196 "The server still wants to talk, but the client may already have hung up on us.");
2198 log_error(LOG_LEVEL_CONNECT,
2199 "The server still wants to talk, but the client hung up on us.");
2200 mark_server_socket_tainted(csp);
2202 #endif /* def _WIN32 */
2204 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2206 len = read_socket(csp->server_connection.sfd, buf, sizeof(buf) - 1);
2210 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
2212 if (http->ssl && (fwd->forward_host == NULL))
2215 * Just hang up. We already confirmed the client's CONNECT
2216 * request with status code 200 and unencrypted content is
2217 * no longer welcome.
2219 log_error(LOG_LEVEL_ERROR,
2220 "CONNECT already confirmed. Unable to tell the client about the problem.");
2223 else if (byte_count)
2226 * Just hang up. We already transmitted the original headers
2227 * and parts of the original content and therefore missed the
2228 * chance to send an error message (without risking data corruption).
2230 * XXX: we could retry with a fancy range request here.
2232 log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
2233 "Unable to tell the client about the problem.");
2234 mark_server_socket_tainted(csp);
2238 * XXX: Consider handling the cases above the same.
2240 mark_server_socket_tainted(csp);
2244 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2245 if (csp->flags & CSP_FLAG_CHUNKED)
2247 if ((len >= 5) && !memcmp(buf+len-5, "0\r\n\r\n", 5))
2249 /* XXX: this is a temporary hack */
2250 log_error(LOG_LEVEL_CONNECT,
2251 "Looks like we reached the end of the last chunk. "
2252 "We better stop reading.");
2253 csp->expected_content_length = byte_count + (unsigned long long)len;
2254 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2258 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2261 * Add a trailing zero to let be able to use string operations.
2262 * XXX: do we still need this with filter_popups gone?
2267 * Normally, this would indicate that we've read
2268 * as much as the server has sent us and we can
2269 * close the client connection. However, Microsoft
2270 * in its wisdom has released IIS/5 with a bug that
2271 * prevents it from sending the trailing \r\n in
2272 * a 302 redirect header (and possibly other headers).
2273 * To work around this if we've haven't parsed
2274 * a full header we'll append a trailing \r\n
2275 * and see if this now generates a valid one.
2277 * This hack shouldn't have any impacts. If we've
2278 * already transmitted the header or if this is a
2279 * SSL connection, then we won't bother with this
2280 * hack. So we only work on partially received
2281 * headers. If we append a \r\n and this still
2282 * doesn't generate a valid header, then we won't
2283 * transmit anything to the client.
2288 if (server_body || http->ssl)
2291 * If we have been buffering up the document,
2292 * now is the time to apply content modification
2293 * and send the result to the client.
2295 if (buffer_and_filter_content)
2297 p = execute_content_filters(csp);
2299 * If content filtering fails, use the original
2300 * buffer and length.
2301 * (see p != NULL ? p : csp->iob->cur below)
2305 csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
2307 #ifdef FEATURE_COMPRESSION
2308 else if ((csp->flags & CSP_FLAG_CLIENT_SUPPORTS_DEFLATE)
2309 && (csp->content_length > LOWER_LENGTH_LIMIT_FOR_COMPRESSION))
2311 char *compressed_content = compress_buffer(p,
2312 (size_t *)&csp->content_length, csp->config->compression_level);
2313 if (compressed_content != NULL)
2316 p = compressed_content;
2317 csp->flags |= CSP_FLAG_BUFFERED_CONTENT_DEFLATED;
2322 if (JB_ERR_OK != update_server_headers(csp))
2324 log_error(LOG_LEVEL_FATAL,
2325 "Failed to update server headers. after filtering.");
2328 hdr = list_to_text(csp->headers);
2331 /* FIXME Should handle error properly */
2332 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2335 if (write_socket(csp->cfd, hdr, strlen(hdr))
2336 || write_socket(csp->cfd,
2337 ((p != NULL) ? p : csp->iob->cur), (size_t)csp->content_length))
2339 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
2342 mark_server_socket_tainted(csp);
2350 break; /* "game over, man" */
2354 * This is NOT the body, so
2355 * Let's pretend the server just sent us a blank line.
2357 snprintf(buf, sizeof(buf), "\r\n");
2358 len = (int)strlen(buf);
2361 * Now, let the normal header parsing algorithm below do its
2362 * job. If it fails, we'll exit instead of continuing.
2369 * If this is an SSL connection or we're in the body
2370 * of the server document, just write it to the client,
2371 * unless we need to buffer the body for later content-filtering
2373 if (server_body || http->ssl)
2375 if (buffer_and_filter_content)
2378 * If there is no memory left for buffering the content, or the buffer limit
2379 * has been reached, switch to non-filtering mode, i.e. make & write the
2380 * header, flush the iob and buf, and get out of the way.
2382 if (add_to_iob(csp->iob, csp->config->buffer_limit, buf, len))
2387 log_error(LOG_LEVEL_INFO,
2388 "Flushing header and buffers. Stepping back from filtering.");
2390 hdr = list_to_text(csp->headers);
2394 * Memory is too tight to even generate the header.
2395 * Send our static "Out-of-memory" page.
2397 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
2398 rsp = cgi_error_memory();
2399 send_crunch_response(csp, rsp);
2400 mark_server_socket_tainted(csp);
2403 hdrlen = strlen(hdr);
2405 if (write_socket(csp->cfd, hdr, hdrlen)
2406 || ((flushed = flush_socket(csp->cfd, csp->iob)) < 0)
2407 || (write_socket(csp->cfd, buf, (size_t)len)))
2409 log_error(LOG_LEVEL_CONNECT,
2410 "Flush header and buffers to client failed: %E");
2412 mark_server_socket_tainted(csp);
2417 * Reset the byte_count to the amount of bytes
2418 * we just flushed. len will be added a few lines below,
2419 * hdrlen doesn't matter for LOG_LEVEL_CLF.
2421 byte_count = (unsigned long long)flushed;
2423 buffer_and_filter_content = 0;
2429 if (write_socket(csp->cfd, buf, (size_t)len))
2431 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
2432 mark_server_socket_tainted(csp);
2436 byte_count += (unsigned long long)len;
2442 * We're still looking for the end of the server's header.
2443 * Buffer up the data we just read. If that fails, there's
2444 * little we can do but send our static out-of-memory page.
2446 if (add_to_iob(csp->iob, csp->config->buffer_limit, buf, len))
2448 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
2449 rsp = cgi_error_memory();
2450 send_crunch_response(csp, rsp);
2451 mark_server_socket_tainted(csp);
2455 /* Convert iob into something sed() can digest */
2456 if (JB_ERR_PARSE == get_server_headers(csp))
2461 * Well, we tried our MS IIS/5 hack and it didn't work.
2462 * The header is incomplete and there isn't anything
2463 * we can do about it.
2465 log_error(LOG_LEVEL_ERROR, "Invalid server headers. "
2466 "Applying the MS IIS5 hack didn't help.");
2467 log_error(LOG_LEVEL_CLF,
2468 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2469 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2470 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2471 mark_server_socket_tainted(csp);
2477 * Since we have to wait for more from the server before
2478 * we can parse the headers we just continue here.
2480 log_error(LOG_LEVEL_CONNECT,
2481 "Continuing buffering server headers from socket %d. "
2482 "Bytes most recently read: %d.", csp->cfd, len);
2489 * Account for the content bytes we
2490 * might have gotten with the headers.
2492 assert(csp->iob->eod >= csp->iob->cur);
2493 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2496 /* Did we actually get anything? */
2497 if (NULL == csp->headers->first)
2499 if ((csp->flags & CSP_FLAG_REUSED_CLIENT_CONNECTION))
2501 log_error(LOG_LEVEL_ERROR,
2502 "No server or forwarder response received on socket %d. "
2503 "Closing client socket %d without sending data.",
2504 csp->server_connection.sfd, csp->cfd);
2505 log_error(LOG_LEVEL_CLF,
2506 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2510 log_error(LOG_LEVEL_ERROR,
2511 "No server or forwarder response received on socket %d.",
2512 csp->server_connection.sfd);
2513 send_crunch_response(csp, error_response(csp, "no-server-data"));
2515 free_http_request(http);
2516 mark_server_socket_tainted(csp);
2520 assert(csp->headers->first->str);
2522 if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
2523 strncmpic(csp->headers->first->str, "ICY", 3))
2526 * It doesn't look like a HTTP (or Shoutcast) response:
2527 * tell the client and log the problem.
2529 if (strlen(csp->headers->first->str) > 30)
2531 csp->headers->first->str[30] = '\0';
2533 log_error(LOG_LEVEL_ERROR,
2534 "Invalid server or forwarder response. Starts with: %s",
2535 csp->headers->first->str);
2536 log_error(LOG_LEVEL_CLF,
2537 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2538 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2539 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2540 free_http_request(http);
2541 mark_server_socket_tainted(csp);
2546 * We have now received the entire server header,
2547 * filter it and send the result to the client
2549 if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
2551 log_error(LOG_LEVEL_FATAL, "Failed to parse server headers.");
2553 hdr = list_to_text(csp->headers);
2556 /* FIXME Should handle error properly */
2557 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2560 if ((csp->flags & CSP_FLAG_CHUNKED)
2561 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2562 && ((csp->iob->eod - csp->iob->cur) >= 5)
2563 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
2565 log_error(LOG_LEVEL_CONNECT,
2566 "Looks like we got the last chunk together with "
2567 "the server headers. We better stop reading.");
2568 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2569 csp->expected_content_length = byte_count;
2570 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2573 csp->server_connection.response_received = time(NULL);
2575 if (crunch_response_triggered(csp, crunchers_light))
2578 * One of the tags created by a server-header
2579 * tagger triggered a crunch. We already
2580 * delivered the crunch response to the client
2581 * and are done here after cleaning up.
2584 mark_server_socket_tainted(csp);
2587 /* Buffer and pcrs filter this if appropriate. */
2589 if (!http->ssl) /* We talk plaintext */
2591 buffer_and_filter_content = content_requires_filtering(csp);
2594 * Only write if we're not buffering for content modification
2596 if (!buffer_and_filter_content)
2599 * Write the server's (modified) header to
2600 * the client (along with anything else that
2601 * may be in the buffer)
2604 if (write_socket(csp->cfd, hdr, strlen(hdr))
2605 || ((len = flush_socket(csp->cfd, csp->iob)) < 0))
2607 log_error(LOG_LEVEL_CONNECT, "write header to client failed: %E");
2610 * The write failed, so don't bother mentioning it
2611 * to the client... it probably can't hear us anyway.
2614 mark_server_socket_tainted(csp);
2619 /* we're finished with the server's header */
2625 * If this was a MS IIS/5 hack then it means the server
2626 * has already closed the connection. Nothing more to read.
2631 log_error(LOG_LEVEL_ERROR,
2632 "Closed server connection detected. "
2633 "Applying the MS IIS5 hack didn't help.");
2634 log_error(LOG_LEVEL_CLF,
2635 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2636 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2637 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2638 mark_server_socket_tainted(csp);
2644 mark_server_socket_tainted(csp);
2645 return; /* huh? we should never get here */
2648 if (csp->content_length == 0)
2651 * If Privoxy didn't recalculate the Content-Length,
2652 * byte_count is still correct.
2654 csp->content_length = byte_count;
2657 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2658 if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2659 && (csp->expected_content_length != byte_count))
2661 log_error(LOG_LEVEL_CONNECT,
2662 "Received %llu bytes while expecting %llu.",
2663 byte_count, csp->expected_content_length);
2664 mark_server_socket_tainted(csp);
2668 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %llu",
2669 csp->ip_addr_str, http->ocmd, csp->content_length);
2671 csp->server_connection.timestamp = time(NULL);
2675 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2676 /*********************************************************************
2678 * Function : prepare_csp_for_next_request
2680 * Description : Put the csp in a mostly vergin state.
2683 * 1 : csp = Current client state (buffers, headers, etc...)
2687 *********************************************************************/
2688 static void prepare_csp_for_next_request(struct client_state *csp)
2690 unsigned int toggled_on_flag_set = (0 != (csp->flags & CSP_FLAG_TOGGLED_ON));
2692 csp->content_type = 0;
2693 csp->content_length = 0;
2694 csp->expected_content_length = 0;
2695 csp->expected_client_content_length = 0;
2696 list_remove_all(csp->headers);
2697 clear_iob(csp->iob);
2698 freez(csp->error_message);
2699 free_http_request(csp->http);
2700 destroy_list(csp->headers);
2701 destroy_list(csp->tags);
2702 free_current_action(csp->action);
2703 if (NULL != csp->fwd)
2705 unload_forward_spec(csp->fwd);
2708 /* XXX: Store per-connection flags someplace else. */
2709 csp->flags = (CSP_FLAG_ACTIVE | CSP_FLAG_REUSED_CLIENT_CONNECTION);
2710 if (toggled_on_flag_set)
2712 csp->flags |= CSP_FLAG_TOGGLED_ON;
2715 if (csp->client_iob->eod > csp->client_iob->cur)
2717 long bytes_to_shift = csp->client_iob->cur - csp->client_iob->buf;
2718 size_t data_length = (size_t)(csp->client_iob->eod - csp->client_iob->cur);
2720 assert(bytes_to_shift > 0);
2721 assert(data_length > 0);
2723 log_error(LOG_LEVEL_CONNECT, "Shifting %d pipelined bytes by %d bytes",
2724 data_length, bytes_to_shift);
2725 memmove(csp->client_iob->buf, csp->client_iob->cur, data_length);
2726 csp->client_iob->cur = csp->client_iob->buf;
2727 assert(csp->client_iob->eod == csp->client_iob->buf + bytes_to_shift + data_length);
2728 csp->client_iob->eod = csp->client_iob->buf + data_length;
2729 memset(csp->client_iob->eod, '\0', (size_t)bytes_to_shift);
2731 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
2736 * We mainly care about resetting client_iob->cur so we don't
2737 * waste buffer space at the beginning and don't mess up the
2738 * request restoration done by cgi_show_request().
2740 * Freeing the buffer itself isn't technically necessary,
2741 * but makes debugging more convenient.
2743 clear_iob(csp->client_iob);
2746 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2749 /*********************************************************************
2753 * Description : This is little more than chat. We only "serve" to
2754 * to close (or remember) any socket that chat may have
2758 * 1 : csp = Current client state (buffers, headers, etc...)
2762 *********************************************************************/
2764 void serve(struct client_state *csp)
2765 #else /* ifndef AMIGA */
2766 static void serve(struct client_state *csp)
2767 #endif /* def AMIGA */
2769 int config_file_change_detected = 0; /* Only used for debugging */
2770 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2771 #ifdef FEATURE_CONNECTION_SHARING
2772 static int monitor_thread_running = 0;
2773 #endif /* def FEATURE_CONNECTION_SHARING */
2774 int continue_chatting = 0;
2776 log_error(LOG_LEVEL_CONNECT, "Accepted connection from %s on socket %d",
2777 csp->ip_addr_str, csp->cfd);
2781 unsigned int latency;
2786 * If the request has been crunched,
2787 * the calculated latency is zero.
2789 latency = (unsigned)(csp->server_connection.response_received -
2790 csp->server_connection.request_sent) / 2;
2792 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
2793 && (csp->flags & CSP_FLAG_CRUNCHED)
2794 && (csp->expected_client_content_length != 0))
2796 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
2797 log_error(LOG_LEVEL_CONNECT,
2798 "Tainting client socket %d due to unread data.", csp->cfd);
2801 continue_chatting = (csp->config->feature_flags
2802 & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
2803 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
2804 && (csp->cfd != JB_INVALID_SOCKET)
2805 && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
2806 && ((csp->flags & CSP_FLAG_SERVER_CONTENT_LENGTH_SET)
2807 || (csp->flags & CSP_FLAG_CHUNKED));
2809 if (!(csp->flags & CSP_FLAG_CRUNCHED)
2810 && (csp->server_connection.sfd != JB_INVALID_SOCKET))
2812 if (!(csp->flags & CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET))
2814 csp->server_connection.keep_alive_timeout = csp->config->default_server_timeout;
2816 if (!(csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
2817 || (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
2818 || !socket_is_still_alive(csp->server_connection.sfd)
2819 || !(latency < csp->server_connection.keep_alive_timeout))
2821 log_error(LOG_LEVEL_CONNECT,
2822 "Closing server socket %d connected to %s. "
2823 "Keep-alive %u. Tainted: %u. Socket alive %u. Timeout: %u.",
2824 csp->server_connection.sfd, csp->server_connection.host,
2825 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
2826 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
2827 socket_is_still_alive(csp->server_connection.sfd),
2828 csp->server_connection.keep_alive_timeout);
2829 #ifdef FEATURE_CONNECTION_SHARING
2830 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
2832 forget_connection(csp->server_connection.sfd);
2834 #endif /* def FEATURE_CONNECTION_SHARING */
2835 close_socket(csp->server_connection.sfd);
2836 mark_connection_closed(&csp->server_connection);
2840 if (continue_chatting && any_loaded_file_changed(csp))
2842 continue_chatting = 0;
2843 config_file_change_detected = 1;
2846 if (continue_chatting)
2848 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
2849 && socket_is_still_alive(csp->cfd))
2851 log_error(LOG_LEVEL_CONNECT, "Client request %d has been "
2852 "pipelined on socket %d and the socket is still alive.",
2853 csp->requests_received_total+1, csp->cfd);
2854 prepare_csp_for_next_request(csp);
2858 if (0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
2860 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
2862 log_error(LOG_LEVEL_CONNECT,
2863 "Waiting for the next client request on socket %d. "
2864 "Keeping the server socket %d to %s open.",
2865 csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
2869 log_error(LOG_LEVEL_CONNECT,
2870 "Waiting for the next client request on socket %d. "
2871 "No server socket to keep open.", csp->cfd);
2875 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
2876 && data_is_available(csp->cfd, (int)csp->config->keep_alive_timeout)
2877 && socket_is_still_alive(csp->cfd))
2879 log_error(LOG_LEVEL_CONNECT,
2880 "Client request %u arrived in time on socket %d.",
2881 csp->requests_received_total+1, csp->cfd);
2882 prepare_csp_for_next_request(csp);
2886 #ifdef FEATURE_CONNECTION_SHARING
2887 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
2888 && (csp->server_connection.sfd != JB_INVALID_SOCKET)
2889 && (socket_is_still_alive(csp->server_connection.sfd)))
2891 time_t time_open = time(NULL) - csp->server_connection.timestamp;
2893 if (csp->server_connection.keep_alive_timeout < time_open - (time_t)latency)
2898 remember_connection(&csp->server_connection);
2899 csp->server_connection.sfd = JB_INVALID_SOCKET;
2900 drain_and_close_socket(csp->cfd);
2901 csp->cfd = JB_INVALID_SOCKET;
2902 privoxy_mutex_lock(&connection_reuse_mutex);
2903 if (!monitor_thread_running)
2905 monitor_thread_running = 1;
2906 privoxy_mutex_unlock(&connection_reuse_mutex);
2907 wait_for_alive_connections();
2908 privoxy_mutex_lock(&connection_reuse_mutex);
2909 monitor_thread_running = 0;
2911 privoxy_mutex_unlock(&connection_reuse_mutex);
2913 #endif /* def FEATURE_CONNECTION_SHARING */
2917 else if (csp->server_connection.sfd != JB_INVALID_SOCKET)
2919 log_error(LOG_LEVEL_CONNECT,
2920 "Closing server socket %d connected to %s. Keep-alive: %u. "
2921 "Tainted: %u. Socket alive: %u. Timeout: %u. "
2922 "Configuration file change detected: %u",
2923 csp->server_connection.sfd, csp->server_connection.host,
2924 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
2925 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
2926 socket_is_still_alive(csp->server_connection.sfd),
2927 csp->server_connection.keep_alive_timeout,
2928 config_file_change_detected);
2930 } while (continue_chatting);
2934 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2936 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
2938 #ifdef FEATURE_CONNECTION_SHARING
2939 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
2941 forget_connection(csp->server_connection.sfd);
2943 #endif /* def FEATURE_CONNECTION_SHARING */
2944 close_socket(csp->server_connection.sfd);
2947 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2948 mark_connection_closed(&csp->server_connection);
2951 if (csp->cfd != JB_INVALID_SOCKET)
2953 log_error(LOG_LEVEL_CONNECT, "Closing client socket %d. "
2954 "Keep-alive: %u. Socket alive: %u. Data available: %u. "
2955 "Configuration file change detected: %u. Requests received: %u.",
2956 csp->cfd, 0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE),
2957 socket_is_still_alive(csp->cfd), data_is_available(csp->cfd, 0),
2958 config_file_change_detected, csp->requests_received_total);
2959 drain_and_close_socket(csp->cfd);
2962 csp->flags &= ~CSP_FLAG_ACTIVE;
2968 /*********************************************************************
2970 * Function : server_thread
2972 * Description : We only exist to call `serve' in a threaded environment.
2975 * 1 : data = Current client state (buffers, headers, etc...)
2977 * Returns : Always 0.
2979 *********************************************************************/
2980 static int32 server_thread(void *data)
2982 serve((struct client_state *) data);
2989 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
2990 /*********************************************************************
2994 * Description : Print usage info & exit.
2996 * Parameters : Pointer to argv[0] for identifying ourselves
3000 *********************************************************************/
3001 static void usage(const char *myname)
3003 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
3004 "Usage: %s [--config-test] "
3007 #endif /* defined(unix) */
3010 "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
3011 #endif /* defined(unix) */
3012 "[--version] [configfile]\n"
3013 "Aborting\n", myname);
3018 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
3021 #ifdef MUTEX_LOCKS_AVAILABLE
3022 /*********************************************************************
3024 * Function : privoxy_mutex_lock
3026 * Description : Locks a mutex.
3029 * 1 : mutex = The mutex to lock.
3031 * Returns : Void. May exit in case of errors.
3033 *********************************************************************/
3034 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
3036 #ifdef FEATURE_PTHREAD
3037 int err = pthread_mutex_lock(mutex);
3040 if (mutex != &log_mutex)
3042 log_error(LOG_LEVEL_FATAL,
3043 "Mutex locking failed: %s.\n", strerror(err));
3048 EnterCriticalSection(mutex);
3049 #endif /* def FEATURE_PTHREAD */
3053 /*********************************************************************
3055 * Function : privoxy_mutex_unlock
3057 * Description : Unlocks a mutex.
3060 * 1 : mutex = The mutex to unlock.
3062 * Returns : Void. May exit in case of errors.
3064 *********************************************************************/
3065 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
3067 #ifdef FEATURE_PTHREAD
3068 int err = pthread_mutex_unlock(mutex);
3071 if (mutex != &log_mutex)
3073 log_error(LOG_LEVEL_FATAL,
3074 "Mutex unlocking failed: %s.\n", strerror(err));
3079 LeaveCriticalSection(mutex);
3080 #endif /* def FEATURE_PTHREAD */
3084 /*********************************************************************
3086 * Function : privoxy_mutex_init
3088 * Description : Prepares a mutex.
3091 * 1 : mutex = The mutex to initialize.
3093 * Returns : Void. May exit in case of errors.
3095 *********************************************************************/
3096 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
3098 #ifdef FEATURE_PTHREAD
3099 int err = pthread_mutex_init(mutex, 0);
3102 printf("Fatal error. Mutex initialization failed: %s.\n",
3107 InitializeCriticalSection(mutex);
3108 #endif /* def FEATURE_PTHREAD */
3110 #endif /* def MUTEX_LOCKS_AVAILABLE */
3112 /*********************************************************************
3114 * Function : initialize_mutexes
3116 * Description : Prepares mutexes if mutex support is available.
3120 * Returns : Void, exits in case of errors.
3122 *********************************************************************/
3123 static void initialize_mutexes(void)
3125 #ifdef MUTEX_LOCKS_AVAILABLE
3127 * Prepare global mutex semaphores
3129 privoxy_mutex_init(&log_mutex);
3130 privoxy_mutex_init(&log_init_mutex);
3131 privoxy_mutex_init(&connection_reuse_mutex);
3132 #ifdef FEATURE_EXTERNAL_FILTERS
3133 privoxy_mutex_init(&external_filter_mutex);
3137 * XXX: The assumptions below are a bit naive
3138 * and can cause locks that aren't necessary.
3140 * For example older FreeBSD versions (< 6.x?)
3141 * have no gethostbyname_r, but gethostbyname is
3144 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
3145 privoxy_mutex_init(&resolver_mutex);
3146 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
3148 * XXX: should we use a single mutex for
3149 * localtime() and gmtime() as well?
3151 #ifndef HAVE_GMTIME_R
3152 privoxy_mutex_init(&gmtime_mutex);
3153 #endif /* ndef HAVE_GMTIME_R */
3155 #ifndef HAVE_LOCALTIME_R
3156 privoxy_mutex_init(&localtime_mutex);
3157 #endif /* ndef HAVE_GMTIME_R */
3160 privoxy_mutex_init(&rand_mutex);
3161 #endif /* ndef HAVE_RANDOM */
3163 #endif /* def MUTEX_LOCKS_AVAILABLE */
3167 /*********************************************************************
3171 * Description : Load the config file and start the listen loop.
3172 * This function is a lot more *sane* with the `load_config'
3173 * and `listen_loop' functions; although it stills does
3174 * a *little* too much for my taste.
3177 * 1 : argc = Number of parameters (including $0).
3178 * 2 : argv = Array of (char *)'s to the parameters.
3180 * Returns : 1 if : can't open config file, unrecognized directive,
3181 * stats requested in multi-thread mode, can't open the
3182 * log file, can't open the jar file, listen port is invalid,
3183 * any load fails, and can't bind port.
3185 * Else main never returns, the process must be signaled
3186 * to terminate execution. Or, on Windows, use the
3187 * "File", "Exit" menu option.
3189 *********************************************************************/
3191 int real_main(int argc, char **argv)
3193 int main(int argc, char **argv)
3197 int do_config_test = 0;
3198 unsigned int random_seed;
3200 struct passwd *pw = NULL;
3201 struct group *grp = NULL;
3203 char *pre_chroot_nslookup_to_load_resolver = NULL;
3210 #if !defined(_WIN32)
3217 /* Prepare mutexes if supported and necessary. */
3218 initialize_mutexes();
3220 /* Enable logging until further notice. */
3224 * Parse the command line arguments
3226 * XXX: simply printing usage information in case of
3227 * invalid arguments isn't particularly user friendly.
3229 while (++argc_pos < argc)
3232 /* Check to see if the service must be installed or uninstalled */
3233 if (strncmp(argv[argc_pos], "--install", 9) == 0)
3235 const char *pName = argv[argc_pos] + 9;
3238 exit((install_service(pName)) ? 0 : 1);
3240 else if (strncmp(argv[argc_pos], "--uninstall", 11) == 0)
3242 const char *pName = argv[argc_pos] + 11;
3245 exit((uninstall_service(pName)) ? 0 : 1);
3247 else if (strcmp(argv[argc_pos], "--service") == 0)
3249 bRunAsService = TRUE;
3250 w32_set_service_cwd();
3251 atexit(w32_service_exit_notify);
3254 #endif /* defined(_WIN32) */
3257 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
3259 if (strcmp(argv[argc_pos], "--help") == 0)
3264 else if (strcmp(argv[argc_pos], "--version") == 0)
3266 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
3272 else if (strcmp(argv[argc_pos], "--no-daemon") == 0)
3274 set_debug_level(LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
3278 else if (strcmp(argv[argc_pos], "--pidfile") == 0)
3280 if (++argc_pos == argc) usage(argv[0]);
3281 pidfile = strdup_or_die(argv[argc_pos]);
3284 else if (strcmp(argv[argc_pos], "--user") == 0)
3289 if (++argc_pos == argc) usage(argv[argc_pos]);
3291 user_arg = strdup_or_die(argv[argc_pos]);
3292 group_name = strchr(user_arg, '.');
3293 if (NULL != group_name)
3295 /* Nul-terminate the user name */
3298 /* Skip the former delimiter to actually reach the group name */
3301 grp = getgrnam(group_name);
3304 log_error(LOG_LEVEL_FATAL, "Group '%s' not found.", group_name);
3307 pw = getpwnam(user_arg);
3310 log_error(LOG_LEVEL_FATAL, "User '%s' not found.", user_arg);
3316 else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup") == 0)
3318 if (++argc_pos == argc) usage(argv[0]);
3319 pre_chroot_nslookup_to_load_resolver = strdup_or_die(argv[argc_pos]);
3322 else if (strcmp(argv[argc_pos], "--chroot") == 0)
3326 #endif /* defined(unix) */
3328 else if (strcmp(argv[argc_pos], "--config-test") == 0)
3333 else if (argc_pos + 1 != argc)
3336 * This is neither the last command line
3337 * option, nor was it recognized before,
3338 * therefore it must be invalid.
3344 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
3346 configfile = argv[argc_pos];
3349 } /* -END- while (more arguments) */
3351 show_version(Argv[0]);
3354 if (*configfile != '/')
3356 char cwd[BUFFER_SIZE];
3358 size_t abs_file_size;
3360 /* make config-filename absolute here */
3361 if (NULL == getcwd(cwd, sizeof(cwd)))
3363 perror("failed to get current working directory");
3367 basedir = strdup_or_die(cwd);
3369 abs_file_size = strlen(cwd) + strlen(configfile) + 5;
3370 abs_file = malloc_or_die(abs_file_size);
3371 strlcpy(abs_file, basedir, abs_file_size);
3372 strlcat(abs_file, "/", abs_file_size);
3373 strlcat(abs_file, configfile, abs_file_size);
3374 configfile = abs_file;
3376 #endif /* defined unix */
3380 clients->next = NULL;
3382 /* XXX: factor out initialising after the next stable release. */
3385 #elif defined(_WIN32)
3389 random_seed = (unsigned int)time(NULL);
3391 srandom(random_seed);
3394 #endif /* ifdef HAVE_RANDOM */
3397 * Unix signal handling
3399 * Catch the abort, interrupt and terminate signals for a graceful exit
3400 * Catch the hangup signal so the errlog can be reopened.
3401 * Ignore the broken pipe signals (FIXME: Why?)
3403 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
3406 const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP };
3408 for (idx = 0; idx < SZ(catched_signals); idx++)
3410 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
3411 if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
3413 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
3414 #endif /* ifdef sun */
3416 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
3420 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
3422 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for SIGPIPE: %E");
3426 #else /* ifdef _WIN32 */
3427 # ifdef _WIN_CONSOLE
3429 * We *are* in a windows console app.
3430 * Print a verbose messages about FAQ's and such
3432 printf("%s", win32_blurb);
3433 # endif /* def _WIN_CONSOLE */
3434 #endif /* def _WIN32 */
3438 exit(NULL == load_config());
3441 /* Initialize the CGI subsystem */
3442 cgi_init_error_messages();
3445 * If runnig on unix and without the --nodaemon
3446 * option, become a daemon. I.e. fork, detach
3447 * from tty and get process group leadership
3456 if (pid < 0) /* error */
3461 else if (pid != 0) /* parent */
3466 * must check for errors
3467 * child died due to missing files aso
3470 wpid = waitpid(pid, &status, WNOHANG);
3482 * stderr (fd 2) will be closed later on,
3483 * when the config file has been parsed.
3489 * Reserve fd 0 and 1 to prevent abort() and friends
3490 * from sending stuff to the clients or servers.
3492 fd = open("/dev/null", O_RDONLY);
3495 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
3499 if (dup2(fd, 0) == -1)
3501 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 0: %E");
3505 fd = open("/dev/null", O_WRONLY);
3508 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
3512 if (dup2(fd, 1) == -1)
3514 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 1: %E");
3519 #ifdef FEATURE_EXTERNAL_FILTERS
3520 for (fd = 0; fd < 3; fd++)
3522 mark_socket_for_close_on_execute(fd);
3528 } /* -END- if (daemon_mode) */
3531 * As soon as we have written the PID file, we can switch
3532 * to the user and group ID indicated by the --user option
3538 if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
3540 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
3544 if (setgroups(1, &grp->gr_gid))
3546 log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
3549 else if (initgroups(pw->pw_name, pw->pw_gid))
3551 log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
3557 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
3559 /* Read the time zone file from /etc before doing chroot. */
3561 if (NULL != pre_chroot_nslookup_to_load_resolver
3562 && '\0' != pre_chroot_nslookup_to_load_resolver[0])
3564 /* Initialize resolver library. */
3565 (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
3567 if (chroot(pw->pw_dir) < 0)
3569 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
3573 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
3576 if (setuid(pw->pw_uid))
3578 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
3582 char putenv_dummy[64];
3584 strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
3585 if (putenv(putenv_dummy) != 0)
3587 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
3590 snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
3591 if (putenv(putenv_dummy) != 0)
3593 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
3599 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
3602 #endif /* defined unix */
3605 /* This will be FALSE unless the command line specified --service
3609 /* Yup, so now we must attempt to establish a connection
3610 * with the service dispatcher. This will only work if this
3611 * process was launched by the service control manager to
3612 * actually run as a service. If this isn't the case, i've
3613 * known it take around 30 seconds or so for the call to return.
3616 /* The StartServiceCtrlDispatcher won't return until the service is stopping */
3617 if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
3619 /* Service has run, and at this point is now being stopped, so just return */
3624 printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
3626 /* An error occurred. Usually it's because --service was wrongly specified
3627 * and we were unable to connect to the Service Control Dispatcher because
3628 * it wasn't expecting us and is therefore not listening.
3630 * For now, just continue below to call the listen_loop function.
3633 #endif /* def _WIN32 */
3643 /*********************************************************************
3645 * Function : bind_port_helper
3647 * Description : Bind the listen port. Handles logging, and aborts
3651 * 1 : haddr = Host address to bind to. Use NULL to bind to
3653 * 2 : hport = Specifies port to bind to.
3655 * Returns : Port that was opened.
3657 *********************************************************************/
3658 static jb_socket bind_port_helper(const char *haddr, int hport)
3663 result = bind_port(haddr, hport, &bfd);
3667 const char *bind_address = (NULL != haddr) ? haddr : "INADDR_ANY";
3671 log_error(LOG_LEVEL_FATAL,
3672 "can't bind to %s:%d: There may be another Privoxy "
3673 "or some other proxy running on port %d",
3674 bind_address, hport, hport);
3677 log_error(LOG_LEVEL_FATAL,
3678 "can't bind to %s:%d: The hostname is not resolvable",
3679 bind_address, hport);
3682 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: %E",
3683 bind_address, hport);
3686 /* shouldn't get here */
3687 return JB_INVALID_SOCKET;
3691 if (bfd >= FD_SETSIZE)
3693 log_error(LOG_LEVEL_FATAL,
3694 "Bind socket number too high to use select(): %d >= %d",
3701 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
3706 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
3714 /*********************************************************************
3716 * Function : bind_ports_helper
3718 * Description : Bind the listen ports. Handles logging, and aborts
3722 * 1 : config = Privoxy configuration. Specifies ports
3724 * 2 : sockets = Preallocated array of opened sockets
3725 * corresponding to specification in config.
3726 * All non-opened sockets will be set to
3727 * JB_INVALID_SOCKET.
3729 * Returns : Nothing. Inspect sockets argument.
3731 *********************************************************************/
3732 static void bind_ports_helper(struct configuration_spec * config,
3733 jb_socket sockets[])
3737 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
3739 if (config->hport[i])
3741 sockets[i] = bind_port_helper(config->haddr[i], config->hport[i]);
3745 sockets[i] = JB_INVALID_SOCKET;
3748 config->need_bind = 0;
3752 /*********************************************************************
3754 * Function : close_ports_helper
3756 * Description : Close listenings ports.
3759 * 1 : sockets = Array of opened and non-opened sockets to
3760 * close. All sockets will be set to
3761 * JB_INVALID_SOCKET.
3763 * Returns : Nothing.
3765 *********************************************************************/
3766 static void close_ports_helper(jb_socket sockets[])
3770 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
3772 if (JB_INVALID_SOCKET != sockets[i])
3774 close_socket(sockets[i]);
3776 sockets[i] = JB_INVALID_SOCKET;
3782 /* Without this simple workaround we get this compiler warning from _beginthread
3783 * warning C4028: formal parameter 1 different from declaration
3785 void w32_service_listen_loop(void *p)
3789 #endif /* def _WIN32 */
3792 /*********************************************************************
3794 * Function : listen_loop
3796 * Description : bind the listen port and enter a "FOREVER" listening loop.
3802 *********************************************************************/
3803 static void listen_loop(void)
3805 struct client_states *csp_list = NULL;
3806 struct client_state *csp = NULL;
3807 jb_socket bfds[MAX_LISTENING_SOCKETS];
3808 struct configuration_spec *config;
3809 unsigned int active_threads = 0;
3811 config = load_config();
3813 #ifdef FEATURE_CONNECTION_SHARING
3815 * XXX: Should be relocated once it no
3816 * longer needs to emit log messages.
3818 initialize_reusable_connections();
3819 #endif /* def FEATURE_CONNECTION_SHARING */
3821 bind_ports_helper(config, bfds);
3823 #ifdef FEATURE_GRACEFUL_TERMINATION
3824 while (!g_terminate)
3829 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
3830 while (waitpid(-1, NULL, WNOHANG) > 0)
3832 /* zombie children */
3834 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
3837 * Free data that was used by died threads
3839 active_threads = sweep();
3843 * Re-open the errlog after HUP signal
3845 if (received_hup_signal)
3847 if (NULL != config->logfile)
3849 init_error_log(Argv[0], config->logfile);
3851 received_hup_signal = 0;
3855 csp_list = (struct client_states *)zalloc(sizeof(*csp_list));
3856 if (NULL == csp_list)
3858 log_error(LOG_LEVEL_FATAL,
3859 "malloc(%d) for csp_list failed: %E", sizeof(*csp_list));
3862 csp = &csp_list->csp;
3864 log_error(LOG_LEVEL_CONNECT, "Listening for new connections ... ");
3866 if (!accept_connection(csp, bfds))
3868 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
3880 csp->flags |= CSP_FLAG_ACTIVE;
3881 csp->server_connection.sfd = JB_INVALID_SOCKET;
3883 csp->config = config = load_config();
3885 if (config->need_bind)
3888 * Since we were listening to the "old port", we will not see
3889 * a "listen" param change until the next request. So, at
3890 * least 1 more request must be made for us to find the new
3891 * setting. I am simply closing the old socket and binding the
3894 * Which-ever is correct, we will serve 1 more page via the
3895 * old settings. This should probably be a "show-proxy-args"
3896 * request. This should not be a so common of an operation
3897 * that this will hurt people's feelings.
3900 close_ports_helper(bfds);
3902 bind_ports_helper(config, bfds);
3905 #ifdef FEATURE_TOGGLE
3906 if (global_toggle_state)
3907 #endif /* def FEATURE_TOGGLE */
3909 csp->flags |= CSP_FLAG_TOGGLED_ON;
3912 if (run_loader(csp))
3914 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
3915 /* Never get here - LOG_LEVEL_FATAL causes program exit */
3919 if (block_acl(NULL,csp))
3921 log_error(LOG_LEVEL_CONNECT,
3922 "Connection from %s on socket %d dropped due to ACL", csp->ip_addr_str, csp->cfd);
3923 close_socket(csp->cfd);
3924 freez(csp->ip_addr_str);
3928 #endif /* def FEATURE_ACL */
3930 if ((0 != config->max_client_connections)
3931 && (active_threads >= config->max_client_connections))
3933 log_error(LOG_LEVEL_CONNECT,
3934 "Rejecting connection from %s. Maximum number of connections reached.",
3936 write_socket(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
3937 strlen(TOO_MANY_CONNECTIONS_RESPONSE));
3938 close_socket(csp->cfd);
3939 freez(csp->ip_addr_str);
3944 /* add it to the list of clients */
3945 csp_list->next = clients->next;
3946 clients->next = csp_list;
3948 if (config->multi_threaded)
3952 /* this is a switch () statement in the C preprocessor - ugh */
3953 #undef SELECTED_ONE_OPTION
3955 /* Use Pthreads in preference to native code */
3956 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
3957 #define SELECTED_ONE_OPTION
3959 pthread_t the_thread;
3960 pthread_attr_t attrs;
3962 pthread_attr_init(&attrs);
3963 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
3964 errno = pthread_create(&the_thread, &attrs,
3965 (void * (*)(void *))serve, csp);
3966 child_id = errno ? -1 : 0;
3967 pthread_attr_destroy(&attrs);
3971 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
3972 #define SELECTED_ONE_OPTION
3973 child_id = _beginthread(
3974 (void (*)(void *))serve,
3979 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
3980 #define SELECTED_ONE_OPTION
3981 child_id = _beginthread(
3982 (void(* _Optlink)(void*))serve,
3988 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
3989 #define SELECTED_ONE_OPTION
3991 thread_id tid = spawn_thread
3992 (server_thread, "server", B_NORMAL_PRIORITY, csp);
3994 if ((tid >= 0) && (resume_thread(tid) == B_OK))
3996 child_id = (int) tid;
4005 #if defined(AMIGA) && !defined(SELECTED_ONE_OPTION)
4006 #define SELECTED_ONE_OPTION
4007 csp->cfd = ReleaseSocket(csp->cfd, -1);
4010 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
4011 NP_Output, Output(),
4012 NP_CloseOutput, FALSE,
4013 NP_Name, (ULONG)"privoxy child",
4017 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
4018 NP_Output, Output(),
4019 NP_CloseOutput, FALSE,
4020 NP_Name, (ULONG)"privoxy child",
4021 NP_StackSize, 200*1024,
4027 ((struct Task *)child_id)->tc_UserData = csp;
4028 Signal((struct Task *)child_id, SIGF_SINGLE);
4033 #if !defined(SELECTED_ONE_OPTION)
4036 /* This block is only needed when using fork().
4037 * When using threads, the server thread was
4038 * created and run by the call to _beginthread().
4040 if (child_id == 0) /* child */
4043 #ifdef FEATURE_TOGGLE
4044 int inherited_toggle_state = global_toggle_state;
4045 #endif /* def FEATURE_TOGGLE */
4050 * If we've been toggled or we've blocked the request, tell Mom
4053 #ifdef FEATURE_TOGGLE
4054 if (inherited_toggle_state != global_toggle_state)
4056 rc |= RC_FLAG_TOGGLED;
4058 #endif /* def FEATURE_TOGGLE */
4060 #ifdef FEATURE_STATISTICS
4061 if (csp->flags & CSP_FLAG_REJECTED)
4063 rc |= RC_FLAG_BLOCKED;
4065 #endif /* ndef FEATURE_STATISTICS */
4069 else if (child_id > 0) /* parent */
4071 /* in a fork()'d environment, the parent's
4072 * copy of the client socket and the CSP
4076 #if !defined(_WIN32) && !defined(__CYGWIN__)
4078 wait(&child_status);
4081 * Evaluate child's return code: If the child has
4082 * - been toggled, toggle ourselves
4083 * - blocked its request, bump up the stats counter
4086 #ifdef FEATURE_TOGGLE
4087 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
4089 global_toggle_state = !global_toggle_state;
4091 #endif /* def FEATURE_TOGGLE */
4093 #ifdef FEATURE_STATISTICS
4095 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
4099 #endif /* def FEATURE_STATISTICS */
4101 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
4102 close_socket(csp->cfd);
4103 csp->flags &= ~CSP_FLAG_ACTIVE;
4107 #undef SELECTED_ONE_OPTION
4108 /* end of cpp switch () */
4113 * Spawning the child failed, assume it's because
4114 * there are too many children running already.
4115 * XXX: If you assume ...
4117 log_error(LOG_LEVEL_ERROR,
4118 "Unable to take any additional connections: %E");
4119 write_socket(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
4120 strlen(TOO_MANY_CONNECTIONS_RESPONSE));
4121 close_socket(csp->cfd);
4122 csp->flags &= ~CSP_FLAG_ACTIVE;
4131 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
4133 /* Clean up. Aim: free all memory (no leaks) */
4134 #ifdef FEATURE_GRACEFUL_TERMINATION
4136 log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
4138 unload_current_config_file();
4139 unload_current_actions_file();
4140 unload_current_re_filterfile();
4141 #ifdef FEATURE_TRUST
4142 unload_current_trust_file();
4145 if (config->multi_threaded)
4152 } while ((clients->next != NULL) && (--i > 0));
4156 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
4166 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
4167 /* Cleanup - remove taskbar icon etc. */
4172 #endif /* FEATURE_GRACEFUL_TERMINATION */