1 const char jcc_rcs[] = "$Id: jcc.c,v 1.430 2014/07/25 11:56:54 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 static const char UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE[] =
283 "HTTP/1.1 417 Expecting too much\r\n"
284 "Proxy-Agent: Privoxy " VERSION "\r\n"
285 "Content-Type: text/plain\r\n"
286 "Connection: close\r\n\r\n"
287 "Privoxy detected an unsupported Expect header value.\r\n";
289 /* A function to crunch a response */
290 typedef struct http_response *(*crunch_func_ptr)(struct client_state *);
292 /* Crunch function flags */
293 #define CF_NO_FLAGS 0
294 /* Cruncher applies to forced requests as well */
295 #define CF_IGNORE_FORCE 1
296 /* Crunched requests are counted for the block statistics */
297 #define CF_COUNT_AS_REJECT 2
299 /* A crunch function and its flags */
302 const crunch_func_ptr cruncher;
306 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[]);
308 /* Complete list of cruncher functions */
309 static const struct cruncher crunchers_all[] = {
310 { direct_response, CF_COUNT_AS_REJECT|CF_IGNORE_FORCE},
311 { block_url, CF_COUNT_AS_REJECT },
313 { trust_url, CF_COUNT_AS_REJECT },
314 #endif /* def FEATURE_TRUST */
315 { redirect_url, CF_NO_FLAGS },
316 { dispatch_cgi, CF_IGNORE_FORCE},
320 /* Light version, used after tags are applied */
321 static const struct cruncher crunchers_light[] = {
322 { block_url, CF_COUNT_AS_REJECT },
323 { redirect_url, CF_NO_FLAGS },
329 * XXX: Don't we really mean
335 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
336 /*********************************************************************
338 * Function : sig_handler
340 * Description : Signal handler for different signals.
341 * Exit gracefully on TERM and INT
342 * or set a flag that will cause the errlog
343 * to be reopened by the main thread on HUP.
346 * 1 : the_signal = the signal cause this function to call
350 *********************************************************************/
351 static void sig_handler(int the_signal)
357 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
369 received_hup_signal = 1;
375 * We shouldn't be here, unless we catch signals
376 * in main() that we can't handle here!
378 log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
386 /*********************************************************************
388 * Function : client_protocol_is_unsupported
390 * Description : Checks if the client used a known unsupported
391 * protocol and deals with it by sending an error
395 * 1 : csp = Current client state (buffers, headers, etc...)
396 * 2 : req = the first request line send by the client
398 * Returns : TRUE if an error response has been generated, or
399 * FALSE if the request doesn't look invalid.
401 *********************************************************************/
402 static int client_protocol_is_unsupported(const struct client_state *csp, char *req)
405 * If it's a FTP or gopher request, we don't support it.
407 * These checks are better than nothing, but they might
408 * not work in all configurations and some clients might
409 * have problems digesting the answer.
411 * They should, however, never cause more problems than
412 * Privoxy's old behaviour (returning the misleading HTML
415 * "Could not resolve http://(ftp|gopher)://example.org").
417 if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
419 const char *response = NULL;
420 const char *protocol = NULL;
422 if (!strncmpic(req, "GET ftp://", 10))
424 response = FTP_RESPONSE;
429 response = GOPHER_RESPONSE;
432 log_error(LOG_LEVEL_ERROR,
433 "%s tried to use Privoxy as %s proxy: %s",
434 csp->ip_addr_str, protocol, req);
435 log_error(LOG_LEVEL_CLF,
436 "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, req);
438 write_socket(csp->cfd, response, strlen(response));
447 /*********************************************************************
449 * Function : client_has_unsupported_expectations
451 * Description : Checks if the client used an unsupported expectation
452 * in which case an error message is delivered.
455 * 1 : csp = Current client state (buffers, headers, etc...)
457 * Returns : TRUE if an error response has been generated, or
458 * FALSE if the request doesn't look invalid.
460 *********************************************************************/
461 static int client_has_unsupported_expectations(const struct client_state *csp)
463 if ((csp->flags & CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION))
465 log_error(LOG_LEVEL_ERROR,
466 "Rejecting request from client %s with unsupported Expect header value",
468 log_error(LOG_LEVEL_CLF,
469 "%s - - [%T] \"%s\" 417 0", csp->ip_addr_str, csp->http->cmd);
470 write_socket(csp->cfd, UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE,
471 strlen(UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE));
481 /*********************************************************************
483 * Function : get_request_destination_elsewhere
485 * Description : If the client's request was redirected into
486 * Privoxy without the client's knowledge,
487 * the request line lacks the destination host.
489 * This function tries to get it elsewhere,
490 * provided accept-intercepted-requests is enabled.
492 * "Elsewhere" currently only means "Host: header",
493 * but in the future we may ask the redirecting
494 * packet filter to look the destination up.
496 * If the destination stays unknown, an error
497 * response is send to the client and headers
498 * are freed so that chat() can return directly.
501 * 1 : csp = Current client state (buffers, headers, etc...)
502 * 2 : headers = a header list
504 * Returns : JB_ERR_OK if the destination is now known, or
505 * JB_ERR_PARSE if it isn't.
507 *********************************************************************/
508 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
512 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
514 log_error(LOG_LEVEL_ERROR, "%s's request: \'%s\' is invalid."
515 " Privoxy isn't configured to accept intercepted requests.",
516 csp->ip_addr_str, csp->http->cmd);
517 /* XXX: Use correct size */
518 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
519 csp->ip_addr_str, csp->http->cmd);
521 write_socket(csp->cfd, CHEADER, strlen(CHEADER));
522 destroy_list(headers);
526 else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
528 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
529 /* Split the domain we just got for pattern matching */
530 init_domain_components(csp->http);
537 /* We can't work without destination. Go spread the news.*/
539 req = list_to_text(headers);
541 /* XXX: Use correct size */
542 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
543 csp->ip_addr_str, csp->http->cmd);
544 log_error(LOG_LEVEL_ERROR,
545 "Privoxy was unable to get the destination for %s's request:\n%s\n%s",
546 csp->ip_addr_str, csp->http->cmd, req);
549 write_socket(csp->cfd, MISSING_DESTINATION_RESPONSE, strlen(MISSING_DESTINATION_RESPONSE));
550 destroy_list(headers);
555 * TODO: If available, use PF's ioctl DIOCNATLOOK as last resort
556 * to get the destination IP address, use it as host directly
557 * or do a reverse DNS lookup first.
562 /*********************************************************************
564 * Function : get_server_headers
566 * Description : Parses server headers in iob and fills them
567 * into csp->headers so that they can later be
571 * 1 : csp = Current client state (buffers, headers, etc...)
573 * Returns : JB_ERR_OK if everything went fine, or
574 * JB_ERR_PARSE if the headers were incomplete.
576 *********************************************************************/
577 static jb_err get_server_headers(struct client_state *csp)
579 int continue_hack_in_da_house = 0;
582 while (((header = get_header(csp->iob)) != NULL) || continue_hack_in_da_house)
587 * continue hack in da house. Ignore the ending of
588 * this head and continue enlisting header lines.
589 * The reason is described below.
591 enlist(csp->headers, "");
592 continue_hack_in_da_house = 0;
595 else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
598 * It's a bodyless continue response, don't
599 * stop header parsing after reaching its end.
601 * As a result Privoxy will concatenate the
602 * next response's head and parse and deliver
603 * the headers as if they belonged to one request.
605 * The client will separate them because of the
606 * empty line between them.
608 * XXX: What we're doing here is clearly against
609 * the intended purpose of the continue header,
610 * and under some conditions (HTTP/1.0 client request)
611 * it's a standard violation.
613 * Anyway, "sort of against the spec" is preferable
614 * to "always getting confused by Continue responses"
615 * (Privoxy's behaviour before this hack was added)
617 log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
618 continue_hack_in_da_house = 1;
620 else if (*header == '\0')
623 * If the header is empty, but the Continue hack
624 * isn't active, we can assume that we reached the
625 * end of the buffer before we hit the end of the
628 * Inform the caller an let it decide how to handle it.
633 if (JB_ERR_MEMORY == enlist(csp->headers, header))
636 * XXX: Should we quit the request and return a
637 * out of memory error page instead?
639 log_error(LOG_LEVEL_ERROR,
640 "Out of memory while enlisting server headers. %s lost.",
650 /*********************************************************************
652 * Function : crunch_reason
654 * Description : Translates the crunch reason code into a string.
657 * 1 : rsp = a http_response
659 * Returns : A string with the crunch reason or an error description.
661 *********************************************************************/
662 static const char *crunch_reason(const struct http_response *rsp)
664 char * reason = NULL;
669 return "Internal error while searching for crunch reason";
672 switch (rsp->crunch_reason)
675 reason = "Unsupported HTTP feature";
681 reason = "Untrusted";
684 reason = "Redirected";
690 reason = "DNS failure";
692 case FORWARDING_FAILED:
693 reason = "Forwarding failed";
696 reason = "Connection failure";
699 reason = "Out of memory (may mask other reasons)";
701 case CONNECTION_TIMEOUT:
702 reason = "Connection timeout";
705 reason = "No server data received";
708 reason = "No reason recorded";
716 /*********************************************************************
718 * Function : log_applied_actions
720 * Description : Logs the applied actions if LOG_LEVEL_ACTIONS is
724 * 1 : actions = Current action spec to log
728 *********************************************************************/
729 static void log_applied_actions(const struct current_action_spec *actions)
732 * The conversion to text requires lots of memory allocations so
733 * we only do the conversion if the user is actually interested.
735 if (debug_level_is_enabled(LOG_LEVEL_ACTIONS))
737 char *actions_as_text = actions_to_line_of_text(actions);
738 log_error(LOG_LEVEL_ACTIONS, "%s", actions_as_text);
739 freez(actions_as_text);
744 /*********************************************************************
746 * Function : send_crunch_response
748 * Description : Delivers already prepared response for
749 * intercepted requests, logs the interception
750 * and frees the response.
753 * 1 : csp = Current client state (buffers, headers, etc...)
754 * 1 : rsp = Fully prepared response. Will be freed on exit.
758 *********************************************************************/
759 static void send_crunch_response(const struct client_state *csp, struct http_response *rsp)
761 const struct http_request *http = csp->http;
765 assert(rsp->head != NULL);
769 log_error(LOG_LEVEL_FATAL, "NULL response in send_crunch_response.");
773 * Extract the status code from the actual head
774 * that will be send to the client. It is the only
775 * way to get it right for all requests, including
776 * the fixed ones for out-of-memory problems.
778 * A head starts like this: 'HTTP/1.1 200...'
782 status_code[0] = rsp->head[9];
783 status_code[1] = rsp->head[10];
784 status_code[2] = rsp->head[11];
785 status_code[3] = '\0';
787 /* Log that the request was crunched and why. */
788 log_applied_actions(csp->action);
789 log_error(LOG_LEVEL_CRUNCH, "%s: %s", crunch_reason(rsp), http->url);
790 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" %s %u",
791 csp->ip_addr_str, http->ocmd, status_code, rsp->content_length);
793 /* Write the answer to the client */
794 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
795 || write_socket(csp->cfd, rsp->body, rsp->content_length))
797 /* There is nothing we can do about it. */
798 log_error(LOG_LEVEL_ERROR,
799 "Couldn't deliver the error message through client socket %d: %E",
803 /* Clean up and return */
804 if (cgi_error_memory() != rsp)
806 free_http_response(rsp);
812 /*********************************************************************
814 * Function : crunch_response_triggered
816 * Description : Checks if the request has to be crunched,
817 * and delivers the crunch response if necessary.
820 * 1 : csp = Current client state (buffers, headers, etc...)
821 * 2 : crunchers = list of cruncher functions to run
823 * Returns : TRUE if the request was answered with a crunch response
826 *********************************************************************/
827 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[])
829 struct http_response *rsp = NULL;
830 const struct cruncher *c;
833 * If CGI request crunching is disabled,
834 * check the CGI dispatcher out of order to
835 * prevent unintentional blocks or redirects.
837 if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_CRUNCHING)
838 && (NULL != (rsp = dispatch_cgi(csp))))
840 /* Deliver, log and free the interception response. */
841 send_crunch_response(csp, rsp);
842 csp->flags |= CSP_FLAG_CRUNCHED;
846 for (c = crunchers; c->cruncher != NULL; c++)
849 * Check the cruncher if either Privoxy is toggled
850 * on and the request isn't forced, or if the cruncher
851 * applies to forced requests as well.
853 if (((csp->flags & CSP_FLAG_TOGGLED_ON) &&
854 !(csp->flags & CSP_FLAG_FORCED)) ||
855 (c->flags & CF_IGNORE_FORCE))
857 rsp = c->cruncher(csp);
860 /* Deliver, log and free the interception response. */
861 send_crunch_response(csp, rsp);
862 csp->flags |= CSP_FLAG_CRUNCHED;
863 #ifdef FEATURE_STATISTICS
864 if (c->flags & CF_COUNT_AS_REJECT)
866 csp->flags |= CSP_FLAG_REJECTED;
868 #endif /* def FEATURE_STATISTICS */
879 /*********************************************************************
881 * Function : build_request_line
883 * Description : Builds the HTTP request line.
885 * If a HTTP forwarder is used it expects the whole URL,
886 * web servers only get the path.
889 * 1 : csp = Current client state (buffers, headers, etc...)
890 * 2 : fwd = The forwarding spec used for the request
891 * XXX: Should use http->fwd instead.
892 * 3 : request_line = The old request line which will be replaced.
894 * Returns : Nothing. Terminates in case of memory problems.
896 *********************************************************************/
897 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line)
899 struct http_request *http = csp->http;
901 assert(http->ssl == 0);
904 * Downgrade http version from 1.1 to 1.0
905 * if +downgrade action applies.
907 if ((csp->action->flags & ACTION_DOWNGRADE)
908 && (!strcmpic(http->ver, "HTTP/1.1")))
911 http->ver = strdup_or_die("HTTP/1.0");
915 * Rebuild the request line.
917 freez(*request_line);
918 *request_line = strdup(http->gpc);
919 string_append(request_line, " ");
921 if (fwd->forward_host)
923 string_append(request_line, http->url);
927 string_append(request_line, http->path);
929 string_append(request_line, " ");
930 string_append(request_line, http->ver);
932 if (*request_line == NULL)
934 log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
936 log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", *request_line);
940 /*********************************************************************
942 * Function : change_request_destination
944 * Description : Parse a (rewritten) request line and regenerate
945 * the http request data.
948 * 1 : csp = Current client state (buffers, headers, etc...)
950 * Returns : Forwards the parse_http_request() return code.
951 * Terminates in case of memory problems.
953 *********************************************************************/
954 static jb_err change_request_destination(struct client_state *csp)
956 struct http_request *http = csp->http;
959 log_error(LOG_LEVEL_REDIRECTS, "Rewrite detected: %s",
960 csp->headers->first->str);
961 free_http_request(http);
962 err = parse_http_request(csp->headers->first->str, http);
963 if (JB_ERR_OK != err)
965 log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
966 jb_err_to_string(err));
973 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
974 /*********************************************************************
976 * Function : server_response_is_complete
978 * Description : Determines whether we should stop reading
979 * from the server socket.
982 * 1 : csp = Current client state (buffers, headers, etc...)
983 * 2 : content_length = Length of content received so far.
985 * Returns : TRUE if the response is complete,
988 *********************************************************************/
989 static int server_response_is_complete(struct client_state *csp,
990 unsigned long long content_length)
992 int content_length_known = !!(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET);
994 if (!strcmpic(csp->http->gpc, "HEAD"))
997 * "HEAD" implies no body, we are thus expecting
998 * no content. XXX: incomplete "list" of methods?
1000 csp->expected_content_length = 0;
1001 content_length_known = TRUE;
1002 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1005 if (csp->http->status == 204 || csp->http->status == 304)
1008 * Expect no body. XXX: incomplete "list" of status codes?
1010 csp->expected_content_length = 0;
1011 content_length_known = TRUE;
1012 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1015 return (content_length_known && ((0 == csp->expected_content_length)
1016 || (csp->expected_content_length <= content_length)));
1020 #ifdef FEATURE_CONNECTION_SHARING
1021 /*********************************************************************
1023 * Function : wait_for_alive_connections
1025 * Description : Waits for alive connections to timeout.
1031 *********************************************************************/
1032 static void wait_for_alive_connections(void)
1034 int connections_alive = close_unusable_connections();
1036 while (0 < connections_alive)
1038 log_error(LOG_LEVEL_CONNECT,
1039 "Waiting for %d connections to timeout.",
1042 connections_alive = close_unusable_connections();
1045 log_error(LOG_LEVEL_CONNECT, "No connections to wait for left.");
1048 #endif /* def FEATURE_CONNECTION_SHARING */
1051 /*********************************************************************
1053 * Function : save_connection_destination
1055 * Description : Remembers a connection for reuse later on.
1058 * 1 : sfd = Open socket to remember.
1059 * 2 : http = The destination for the connection.
1060 * 3 : fwd = The forwarder settings used.
1061 * 3 : server_connection = storage.
1065 *********************************************************************/
1066 void save_connection_destination(jb_socket sfd,
1067 const struct http_request *http,
1068 const struct forward_spec *fwd,
1069 struct reusable_connection *server_connection)
1071 assert(sfd != JB_INVALID_SOCKET);
1072 assert(NULL != http->host);
1074 server_connection->sfd = sfd;
1075 server_connection->host = strdup_or_die(http->host);
1076 server_connection->port = http->port;
1078 assert(NULL != fwd);
1079 assert(server_connection->gateway_host == NULL);
1080 assert(server_connection->gateway_port == 0);
1081 assert(server_connection->forwarder_type == 0);
1082 assert(server_connection->forward_host == NULL);
1083 assert(server_connection->forward_port == 0);
1085 server_connection->forwarder_type = fwd->type;
1086 if (NULL != fwd->gateway_host)
1088 server_connection->gateway_host = strdup_or_die(fwd->gateway_host);
1092 server_connection->gateway_host = NULL;
1094 server_connection->gateway_port = fwd->gateway_port;
1096 if (NULL != fwd->forward_host)
1098 server_connection->forward_host = strdup_or_die(fwd->forward_host);
1102 server_connection->forward_host = NULL;
1104 server_connection->forward_port = fwd->forward_port;
1108 /*********************************************************************
1110 * Function : verify_request_length
1112 * Description : Checks if we already got the whole client requests
1113 * and sets CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ if
1116 * Data that doesn't belong to the current request is
1117 * either thrown away to let the client retry on a clean
1118 * socket, or stashed to be dealt with after the current
1119 * request is served.
1122 * 1 : csp = Current client state (buffers, headers, etc...)
1126 *********************************************************************/
1127 static void verify_request_length(struct client_state *csp)
1129 unsigned long long buffered_request_bytes =
1130 (unsigned long long)(csp->client_iob->eod - csp->client_iob->cur);
1132 if ((csp->expected_client_content_length != 0)
1133 && (buffered_request_bytes != 0))
1135 if (csp->expected_client_content_length >= buffered_request_bytes)
1137 csp->expected_client_content_length -= buffered_request_bytes;
1138 log_error(LOG_LEVEL_CONNECT, "Reduced expected bytes to %llu "
1139 "to account for the %llu ones we already got.",
1140 csp->expected_client_content_length, buffered_request_bytes);
1144 assert(csp->client_iob->eod > csp->client_iob->cur + csp->expected_client_content_length);
1145 csp->client_iob->eod = csp->client_iob->cur + csp->expected_client_content_length;
1146 log_error(LOG_LEVEL_CONNECT, "Reducing expected bytes to 0. "
1147 "Marking the server socket tainted after throwing %llu bytes away.",
1148 buffered_request_bytes - csp->expected_client_content_length);
1149 csp->expected_client_content_length = 0;
1150 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1153 if (csp->expected_client_content_length == 0)
1155 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1159 if (!(csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ)
1160 && ((csp->client_iob->cur < csp->client_iob->eod)
1161 || (csp->expected_client_content_length != 0)))
1163 if (strcmpic(csp->http->gpc, "GET")
1164 && strcmpic(csp->http->gpc, "HEAD")
1165 && strcmpic(csp->http->gpc, "TRACE")
1166 && strcmpic(csp->http->gpc, "OPTIONS")
1167 && strcmpic(csp->http->gpc, "DELETE"))
1169 /* XXX: this is an incomplete hack */
1170 csp->flags &= ~CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1171 log_error(LOG_LEVEL_CONNECT, "There better be a request body.");
1175 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1177 if ((csp->config->feature_flags & RUNTIME_FEATURE_TOLERATE_PIPELINING) == 0)
1179 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1180 log_error(LOG_LEVEL_CONNECT,
1181 "Possible pipeline attempt detected. The connection will not "
1182 "be kept alive and we will only serve the first request.");
1183 /* Nuke the pipelined requests from orbit, just to be sure. */
1184 clear_iob(csp->client_iob);
1189 * Keep the pipelined data around for now, we'll deal with
1190 * it once we're done serving the current request.
1192 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
1193 assert(csp->client_iob->eod >= csp->client_iob->cur);
1194 log_error(LOG_LEVEL_CONNECT, "Complete client request followed by "
1195 "%d bytes of pipelined data received.",
1196 (int)(csp->client_iob->eod - csp->client_iob->cur));
1202 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1203 log_error(LOG_LEVEL_CONNECT, "Complete client request received.");
1206 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1209 /*********************************************************************
1211 * Function : mark_server_socket_tainted
1213 * Description : Makes sure we don't reuse a server socket
1214 * (if we didn't read everything the server sent
1215 * us reusing the socket would lead to garbage).
1218 * 1 : csp = Current client state (buffers, headers, etc...)
1222 *********************************************************************/
1223 static void mark_server_socket_tainted(struct client_state *csp)
1226 * For consistency we always mark the server socket
1227 * tainted, however, to reduce the log noise we only
1228 * emit a log message if the server socket could have
1229 * actually been reused.
1231 if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
1232 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED))
1234 log_error(LOG_LEVEL_CONNECT,
1235 "Marking the server socket %d tainted.",
1236 csp->server_connection.sfd);
1238 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1241 /*********************************************************************
1243 * Function : get_request_line
1245 * Description : Read the client request line.
1248 * 1 : csp = Current client state (buffers, headers, etc...)
1250 * Returns : Pointer to request line or NULL in case of errors.
1252 *********************************************************************/
1253 static char *get_request_line(struct client_state *csp)
1255 char buf[BUFFER_SIZE];
1256 char *request_line = NULL;
1259 memset(buf, 0, sizeof(buf));
1261 if ((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
1264 * If there are multiple pipelined requests waiting,
1265 * the flag will be set again once the next request
1268 csp->flags &= ~CSP_FLAG_PIPELINED_REQUEST_WAITING;
1270 request_line = get_header(csp->client_iob);
1271 if ((NULL != request_line) && ('\0' != *request_line))
1273 return request_line;
1277 log_error(LOG_LEVEL_CONNECT, "No complete request line "
1278 "received yet. Continuing reading from %d.", csp->cfd);
1284 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1286 if (socket_is_still_alive(csp->cfd))
1288 log_error(LOG_LEVEL_CONNECT,
1289 "No request line on socket %d received in time. Timeout: %d.",
1290 csp->cfd, csp->config->socket_timeout);
1291 write_socket(csp->cfd, CLIENT_CONNECTION_TIMEOUT_RESPONSE,
1292 strlen(CLIENT_CONNECTION_TIMEOUT_RESPONSE));
1296 log_error(LOG_LEVEL_CONNECT,
1297 "The client side of the connection on socket %d got "
1298 "closed without sending a complete request line.", csp->cfd);
1303 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1305 if (len <= 0) return NULL;
1308 * If there is no memory left for buffering the
1309 * request, there is nothing we can do but hang up
1311 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1316 request_line = get_header(csp->client_iob);
1318 } while ((NULL != request_line) && ('\0' == *request_line));
1320 return request_line;
1326 CHUNK_STATUS_MISSING_DATA,
1327 CHUNK_STATUS_BODY_COMPLETE,
1328 CHUNK_STATUS_PARSE_ERROR
1332 /*********************************************************************
1334 * Function : chunked_body_is_complete
1336 * Description : Figures out wheter or not a chunked body is complete.
1338 * Currently it always starts at the beginning of the
1339 * buffer which is somewhat wasteful and prevents Privoxy
1340 * from starting to forward the correctly parsed chunks
1341 * as soon as theoretically possible.
1343 * Should be modified to work with a common buffer,
1344 * and allow the caller to skip already parsed chunks.
1346 * This would allow the function to be used for unbuffered
1347 * response bodies as well.
1350 * 1 : iob = Buffer with the body to check.
1351 * 2 : length = Length of complete body
1353 * Returns : Enum with the result of the check.
1355 *********************************************************************/
1356 static enum chunk_status chunked_body_is_complete(struct iob *iob, size_t *length)
1358 unsigned int chunksize;
1364 * We need at least a single digit, followed by "\r\n",
1365 * followed by an unknown amount of data, followed by "\r\n".
1367 if (p + 5 > iob->eod)
1369 return CHUNK_STATUS_MISSING_DATA;
1371 if (sscanf(p, "%x", &chunksize) != 1)
1373 return CHUNK_STATUS_PARSE_ERROR;
1377 * We want at least a single digit, followed by "\r\n",
1378 * followed by the specified amount of data, followed by "\r\n".
1380 if (p + chunksize + 5 > iob->eod)
1382 return CHUNK_STATUS_MISSING_DATA;
1385 /* Skip chunk-size. */
1386 p = strstr(p, "\r\n");
1389 return CHUNK_STATUS_PARSE_ERROR;
1392 * Skip "\r\n", the chunk data and another "\r\n".
1393 * Moving p to either the beginning of the next chunk-size
1394 * or one byte beyond the end of the chunked data.
1396 p += 2 + chunksize + 2;
1397 } while (chunksize > 0U);
1399 *length = (size_t)(p - iob->cur);
1400 assert(*length <= (size_t)(iob->eod - iob->cur));
1401 assert(p <= iob->eod);
1403 return CHUNK_STATUS_BODY_COMPLETE;
1408 /*********************************************************************
1410 * Function : receive_chunked_client_request_body
1412 * Description : Read the chunk-encoded client request body.
1413 * Failures are dealt with.
1416 * 1 : csp = Current client state (buffers, headers, etc...)
1418 * Returns : JB_ERR_OK or JB_ERR_PARSE
1420 *********************************************************************/
1421 static jb_err receive_chunked_client_request_body(struct client_state *csp)
1424 enum chunk_status status;
1426 while (CHUNK_STATUS_MISSING_DATA ==
1427 (status = chunked_body_is_complete(csp->client_iob,&body_length)))
1429 char buf[BUFFER_SIZE];
1432 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1434 log_error(LOG_LEVEL_ERROR,
1435 "Timeout while waiting for the client body.");
1438 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1441 log_error(LOG_LEVEL_ERROR, "Read the client body failed: %E");
1444 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1449 if (status != CHUNK_STATUS_BODY_COMPLETE)
1451 write_socket(csp->cfd, CLIENT_BODY_PARSE_ERROR_RESPONSE,
1452 strlen(CLIENT_BODY_PARSE_ERROR_RESPONSE));
1453 log_error(LOG_LEVEL_CLF,
1454 "%s - - [%T] \"Failed reading chunked client body\" 400 0", csp->ip_addr_str);
1455 return JB_ERR_PARSE;
1457 log_error(LOG_LEVEL_CONNECT,
1458 "Chunked client body completely read. Length: %d", body_length);
1459 csp->expected_client_content_length = body_length;
1465 /*********************************************************************
1467 * Function : receive_client_request
1469 * Description : Read the client's request (more precisely the
1470 * client headers) and answer it if necessary.
1473 * 1 : csp = Current client state (buffers, headers, etc...)
1475 * Returns : JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
1477 *********************************************************************/
1478 static jb_err receive_client_request(struct client_state *csp)
1480 char buf[BUFFER_SIZE];
1483 struct http_request *http;
1487 /* Temporary copy of the client's headers before they get enlisted in csp->headers */
1488 struct list header_list;
1489 struct list *headers = &header_list;
1491 /* We don't care if the arriving data is a valid HTTP request or not. */
1492 csp->requests_received_total++;
1496 memset(buf, 0, sizeof(buf));
1498 req = get_request_line(csp);
1501 mark_server_socket_tainted(csp);
1502 return JB_ERR_PARSE;
1504 assert(*req != '\0');
1506 if (client_protocol_is_unsupported(csp, req))
1508 return JB_ERR_PARSE;
1511 #ifdef FEATURE_FORCE_LOAD
1513 * If this request contains the FORCE_PREFIX and blocks
1514 * aren't enforced, get rid of it and set the force flag.
1516 if (strstr(req, FORCE_PREFIX))
1518 if (csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS)
1520 log_error(LOG_LEVEL_FORCE,
1521 "Ignored force prefix in request: \"%s\".", req);
1525 strclean(req, FORCE_PREFIX);
1526 log_error(LOG_LEVEL_FORCE, "Enforcing request: \"%s\".", req);
1527 csp->flags |= CSP_FLAG_FORCED;
1530 #endif /* def FEATURE_FORCE_LOAD */
1532 err = parse_http_request(req, http);
1534 if (JB_ERR_OK != err)
1536 write_socket(csp->cfd, CHEADER, strlen(CHEADER));
1537 /* XXX: Use correct size */
1538 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1539 log_error(LOG_LEVEL_ERROR,
1540 "Couldn't parse request line received from %s: %s",
1541 csp->ip_addr_str, jb_err_to_string(err));
1543 free_http_request(http);
1544 return JB_ERR_PARSE;
1547 /* grab the rest of the client's headers */
1551 p = get_header(csp->client_iob);
1555 /* There are no additional headers to read. */
1562 * We didn't receive a complete header
1563 * line yet, get the rest of it.
1565 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1567 log_error(LOG_LEVEL_ERROR,
1568 "Stopped grabbing the client headers.");
1569 destroy_list(headers);
1570 return JB_ERR_PARSE;
1573 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1576 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1577 destroy_list(headers);
1578 return JB_ERR_PARSE;
1581 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1584 * If there is no memory left for buffering the
1585 * request, there is nothing we can do but hang up
1587 destroy_list(headers);
1588 return JB_ERR_MEMORY;
1593 if (!strncmpic(p, "Transfer-Encoding:", 18))
1596 * XXX: should be called through sed()
1597 * but currently can't.
1599 client_transfer_encoding(csp, &p);
1602 * We were able to read a complete
1603 * header and can finally enlist it.
1610 if (http->host == NULL)
1613 * If we still don't know the request destination,
1614 * the request is invalid or the client uses
1615 * Privoxy without its knowledge.
1617 if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
1620 * Our attempts to get the request destination
1621 * elsewhere failed or Privoxy is configured
1622 * to only accept proxy requests.
1624 * An error response has already been send
1625 * and we're done here.
1627 return JB_ERR_PARSE;
1632 * Determine the actions for this URL
1634 #ifdef FEATURE_TOGGLE
1635 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
1637 /* Most compatible set of actions (i.e. none) */
1638 init_current_action(csp->action);
1641 #endif /* ndef FEATURE_TOGGLE */
1643 get_url_actions(csp, http);
1646 enlist(csp->headers, http->cmd);
1648 /* Append the previously read headers */
1649 err = list_append_list_unique(csp->headers, headers);
1650 destroy_list(headers);
1657 /*********************************************************************
1659 * Function : parse_client_request
1661 * Description : Parses the client's request and decides what to do
1664 * Note that since we're not using select() we could get
1665 * blocked here if a client connected, then didn't say
1669 * 1 : csp = Current client state (buffers, headers, etc...)
1671 * Returns : JB_ERR_OK or JB_ERR_PARSE
1673 *********************************************************************/
1674 static jb_err parse_client_request(struct client_state *csp)
1676 struct http_request *http = csp->http;
1679 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1680 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
1681 && (!strcmpic(csp->http->ver, "HTTP/1.1"))
1682 && (csp->http->ssl == 0))
1684 /* Assume persistence until further notice */
1685 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1688 if (csp->http->ssl == 0)
1691 * This whole block belongs to chat() but currently
1692 * has to be executed before sed().
1694 if (csp->flags & CSP_FLAG_CHUNKED_CLIENT_BODY)
1696 if (receive_chunked_client_request_body(csp) != JB_ERR_OK)
1698 return JB_ERR_PARSE;
1703 csp->expected_client_content_length = get_expected_content_length(csp->headers);
1705 verify_request_length(csp);
1707 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1709 err = sed(csp, FILTER_CLIENT_HEADERS);
1710 if (JB_ERR_OK != err)
1712 log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
1714 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
1715 csp->ip_addr_str, csp->http->cmd);
1716 write_socket(csp->cfd, CHEADER, strlen(CHEADER));
1717 return JB_ERR_PARSE;
1719 csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
1721 /* Check request line for rewrites. */
1722 if ((NULL == csp->headers->first->str)
1723 || (strcmp(http->cmd, csp->headers->first->str) &&
1724 (JB_ERR_OK != change_request_destination(csp))))
1727 * A header filter broke the request line - bail out.
1729 write_socket(csp->cfd, MESSED_UP_REQUEST_RESPONSE, strlen(MESSED_UP_REQUEST_RESPONSE));
1730 /* XXX: Use correct size */
1731 log_error(LOG_LEVEL_CLF,
1732 "%s - - [%T] \"Invalid request generated\" 500 0", csp->ip_addr_str);
1733 log_error(LOG_LEVEL_ERROR,
1734 "Invalid request line after applying header filters.");
1735 free_http_request(http);
1737 return JB_ERR_PARSE;
1740 if (client_has_unsupported_expectations(csp))
1742 return JB_ERR_PARSE;
1750 /*********************************************************************
1754 * Description : Once a connection from the client has been accepted,
1755 * this function is called (via serve()) to handle the
1756 * main business of the communication. This function
1757 * returns after dealing with a single request. It can
1758 * be called multiple times with the same client socket
1759 * if the client is keeping the connection alive.
1761 * The decision whether or not a client connection will
1762 * be kept alive is up to the caller which also must
1763 * close the client socket when done.
1765 * FIXME: chat is nearly thousand lines long.
1769 * 1 : csp = Current client state (buffers, headers, etc...)
1771 * Returns : Nothing.
1773 *********************************************************************/
1774 static void chat(struct client_state *csp)
1776 char buf[BUFFER_SIZE];
1783 int ms_iis5_hack = 0;
1784 unsigned long long byte_count = 0;
1785 const struct forward_spec *fwd;
1786 struct http_request *http;
1787 long len = 0; /* for buffer sizes (and negative error codes) */
1788 int buffer_and_filter_content = 0;
1790 /* Skeleton for HTTP response, if we should intercept the request */
1791 struct http_response *rsp;
1792 struct timeval timeout;
1793 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1794 int watch_client_socket;
1797 memset(buf, 0, sizeof(buf));
1801 if (receive_client_request(csp) != JB_ERR_OK)
1805 if (parse_client_request(csp) != JB_ERR_OK)
1810 /* decide how to route the HTTP request */
1811 fwd = forward_url(csp, http);
1814 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!? This can't happen!");
1815 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1820 * build the http request to send to the server
1821 * we have to do one of the following:
1823 * create = use the original HTTP request to create a new
1824 * HTTP request that has either the path component
1825 * without the http://domainspec (w/path) or the
1826 * full orininal URL (w/url)
1827 * Note that the path and/or the HTTP version may
1828 * have been altered by now.
1830 * connect = Open a socket to the host:port of the server
1831 * and short-circuit server and client socket.
1833 * pass = Pass the request unchanged if forwarding a CONNECT
1834 * request to a parent proxy. Note that we'll be sending
1835 * the CFAIL message ourselves if connecting to the parent
1836 * fails, but we won't send a CSUCCEED message if it works,
1837 * since that would result in a double message (ours and the
1838 * parent's). After sending the request to the parent, we simply
1841 * here's the matrix:
1844 * +--------+--------+
1846 * 0 | create | connect|
1848 * Forwarding +--------+--------+
1850 * 1 | create | pass |
1852 * +--------+--------+
1856 if (http->ssl && connect_port_is_forbidden(csp))
1858 const char *acceptable_connect_ports =
1859 csp->action->string[ACTION_STRING_LIMIT_CONNECT];
1860 assert(NULL != acceptable_connect_ports);
1861 log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
1862 "limit-connect{%s} doesn't allow CONNECT requests to %s",
1863 csp->ip_addr_str, acceptable_connect_ports, csp->http->hostport);
1864 csp->action->flags |= ACTION_BLOCK;
1870 freez(csp->headers->first->str);
1871 build_request_line(csp, fwd, &csp->headers->first->str);
1875 * We have a request. Check if one of the crunchers wants it.
1877 if (crunch_response_triggered(csp, crunchers_all))
1880 * Yes. The client got the crunch response and we're done here.
1885 log_applied_actions(csp->action);
1886 log_error(LOG_LEVEL_GPC, "%s%s", http->hostport, http->path);
1888 if (fwd->forward_host)
1890 log_error(LOG_LEVEL_CONNECT, "via [%s]:%d to: %s",
1891 fwd->forward_host, fwd->forward_port, http->hostport);
1895 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
1898 /* here we connect to the server, gateway, or the forwarder */
1900 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1901 if ((csp->server_connection.sfd != JB_INVALID_SOCKET)
1902 && socket_is_still_alive(csp->server_connection.sfd)
1903 && connection_destination_matches(&csp->server_connection, http, fwd))
1905 log_error(LOG_LEVEL_CONNECT,
1906 "Reusing server socket %d connected to %s. Total requests: %u.",
1907 csp->server_connection.sfd, csp->server_connection.host,
1908 csp->server_connection.requests_sent_total);
1912 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
1914 #ifdef FEATURE_CONNECTION_SHARING
1915 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
1917 remember_connection(&csp->server_connection);
1920 #endif /* def FEATURE_CONNECTION_SHARING */
1922 log_error(LOG_LEVEL_CONNECT,
1923 "Closing server socket %d connected to %s. Total requests: %u.",
1924 csp->server_connection.sfd, csp->server_connection.host,
1925 csp->server_connection.requests_sent_total);
1926 close_socket(csp->server_connection.sfd);
1928 mark_connection_closed(&csp->server_connection);
1930 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1932 csp->server_connection.sfd = forwarded_connect(fwd, http, csp);
1934 if (csp->server_connection.sfd == JB_INVALID_SOCKET)
1936 if (fwd->type != SOCKS_NONE)
1939 rsp = error_response(csp, "forwarding-failed");
1941 else if (errno == EINVAL)
1943 rsp = error_response(csp, "no-such-domain");
1947 rsp = error_response(csp, "connect-failed");
1950 /* Write the answer to the client */
1953 send_crunch_response(csp, rsp);
1958 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1959 save_connection_destination(csp->server_connection.sfd,
1960 http, fwd, &csp->server_connection);
1961 csp->server_connection.keep_alive_timeout =
1962 (unsigned)csp->config->keep_alive_timeout;
1964 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1966 csp->server_connection.requests_sent_total++;
1968 if ((fwd->type == SOCKS_5T) && (NULL == csp->headers->first))
1970 /* Client headers have been sent optimistically */
1971 assert(csp->headers->last == NULL);
1973 else if (fwd->forward_host || (http->ssl == 0))
1976 hdr = list_to_text(csp->headers);
1979 /* FIXME Should handle error properly */
1980 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
1982 list_remove_all(csp->headers);
1985 * Write the client's (modified) header to the server
1986 * (along with anything else that may be in the buffer)
1988 write_failure = 0 != write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
1993 log_error(LOG_LEVEL_CONNECT,
1994 "Failed sending request headers to: %s: %E", http->hostport);
1996 else if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
1997 && (flush_socket(csp->server_connection.sfd, csp->client_iob) < 0))
2000 log_error(LOG_LEVEL_CONNECT,
2001 "Failed sending request body to: %s: %E", http->hostport);
2006 rsp = error_response(csp, "connect-failed");
2009 send_crunch_response(csp, rsp);
2017 * We're running an SSL tunnel and we're not forwarding,
2018 * so just ditch the client headers, send the "connect succeeded"
2019 * message to the client, flush the rest, and get out of the way.
2021 list_remove_all(csp->headers);
2022 if (write_socket(csp->cfd, CSUCCEED, strlen(CSUCCEED)))
2026 clear_iob(csp->client_iob);
2029 log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
2031 /* XXX: should the time start earlier for optimistically sent data? */
2032 csp->server_connection.request_sent = time(NULL);
2034 maxfd = (csp->cfd > csp->server_connection.sfd) ?
2035 csp->cfd : csp->server_connection.sfd;
2037 /* pass data between the client and server
2038 * until one or the other shuts down the connection.
2043 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2044 watch_client_socket = 0 == (csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING);
2051 * FD_ZERO here seems to point to an errant macro which crashes.
2052 * So do this by hand for now...
2054 memset(&rfds,0x00,sizeof(fd_set));
2058 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2059 if (!watch_client_socket)
2061 maxfd = csp->server_connection.sfd;
2064 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2066 FD_SET(csp->cfd, &rfds);
2069 FD_SET(csp->server_connection.sfd, &rfds);
2071 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2072 if ((csp->flags & CSP_FLAG_CHUNKED)
2073 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2074 && ((csp->iob->eod - csp->iob->cur) >= 5)
2075 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
2078 * XXX: This check should be obsolete now,
2079 * but let's wait a while to be sure.
2081 log_error(LOG_LEVEL_CONNECT,
2082 "Looks like we got the last chunk together with "
2083 "the server headers but didn't detect it earlier. "
2084 "We better stop reading.");
2085 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2086 csp->expected_content_length = byte_count;
2087 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2089 if (server_body && server_response_is_complete(csp, byte_count))
2091 if (csp->expected_content_length == byte_count)
2093 log_error(LOG_LEVEL_CONNECT,
2094 "Done reading from server. Content length: %llu as expected. "
2095 "Bytes most recently read: %d.",
2100 log_error(LOG_LEVEL_CONNECT,
2101 "Done reading from server. Expected content length: %llu. "
2102 "Actual content length: %llu. Bytes most recently read: %d.",
2103 csp->expected_content_length, byte_count, len);
2107 * XXX: should not jump around,
2108 * chat() is complicated enough already.
2112 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2114 timeout.tv_sec = csp->config->socket_timeout;
2115 timeout.tv_usec = 0;
2116 n = select((int)maxfd+1, &rfds, NULL, NULL, &timeout);
2120 log_error(LOG_LEVEL_ERROR,
2121 "Didn't receive data in time: %s", http->url);
2122 if ((byte_count == 0) && (http->ssl == 0))
2124 send_crunch_response(csp, error_response(csp, "connection-timeout"));
2126 mark_server_socket_tainted(csp);
2131 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
2132 mark_server_socket_tainted(csp);
2137 * This is the body of the browser's request,
2138 * just read and write it.
2140 * XXX: Make sure the client doesn't use pipelining
2141 * behind Privoxy's back.
2143 if (FD_ISSET(csp->cfd, &rfds))
2145 int max_bytes_to_read = sizeof(buf) - 1;
2147 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2148 if ((csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ))
2150 if (data_is_available(csp->cfd, 0))
2153 * If the next request is already waiting, we have
2154 * to stop select()ing the client socket. Otherwise
2155 * we would always return right away and get nothing
2158 watch_client_socket = 0;
2159 log_error(LOG_LEVEL_CONNECT,
2160 "Stopping to watch the client socket %d. "
2161 "There's already another request waiting.",
2166 * If the client socket is set, but there's no data
2167 * available on the socket, the client went fishing
2168 * and continuing talking to the server makes no sense.
2170 log_error(LOG_LEVEL_CONNECT,
2171 "The client closed socket %d while "
2172 "the server socket %d is still open.",
2173 csp->cfd, csp->server_connection.sfd);
2174 mark_server_socket_tainted(csp);
2177 if (csp->expected_client_content_length != 0)
2179 if (csp->expected_client_content_length < (sizeof(buf) - 1))
2181 max_bytes_to_read = (int)csp->expected_client_content_length;
2183 log_error(LOG_LEVEL_CONNECT,
2184 "Waiting for up to %d bytes from the client.",
2187 assert(max_bytes_to_read < sizeof(buf));
2188 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2190 len = read_socket(csp->cfd, buf, max_bytes_to_read);
2194 /* XXX: not sure if this is necessary. */
2195 mark_server_socket_tainted(csp);
2196 break; /* "game over, man" */
2199 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2200 if (csp->expected_client_content_length != 0)
2202 assert(len <= max_bytes_to_read);
2203 csp->expected_client_content_length -= (unsigned)len;
2204 log_error(LOG_LEVEL_CONNECT,
2205 "Expected client content length set to %llu "
2206 "after reading %d bytes.",
2207 csp->expected_client_content_length, len);
2208 if (csp->expected_client_content_length == 0)
2210 log_error(LOG_LEVEL_CONNECT,
2211 "Done reading from the client.");
2212 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
2215 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2217 if (write_socket(csp->server_connection.sfd, buf, (size_t)len))
2219 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
2220 mark_server_socket_tainted(csp);
2227 * The server wants to talk. It could be the header or the body.
2228 * If `hdr' is null, then it's the header otherwise it's the body.
2229 * FIXME: Does `hdr' really mean `host'? No.
2231 if (FD_ISSET(csp->server_connection.sfd, &rfds))
2233 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2235 * If we are buffering content, we don't want to eat up to
2236 * buffer-limit bytes if the client no longer cares about them.
2237 * If we aren't buffering, however, a dead client socket will be
2238 * noticed pretty much right away anyway, so we can reduce the
2239 * overhead by skipping the check.
2241 if (buffer_and_filter_content && !socket_is_still_alive(csp->cfd))
2244 log_error(LOG_LEVEL_CONNECT,
2245 "The server still wants to talk, but the client may already have hung up on us.");
2247 log_error(LOG_LEVEL_CONNECT,
2248 "The server still wants to talk, but the client hung up on us.");
2249 mark_server_socket_tainted(csp);
2251 #endif /* def _WIN32 */
2253 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2255 len = read_socket(csp->server_connection.sfd, buf, sizeof(buf) - 1);
2259 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
2261 if (http->ssl && (fwd->forward_host == NULL))
2264 * Just hang up. We already confirmed the client's CONNECT
2265 * request with status code 200 and unencrypted content is
2266 * no longer welcome.
2268 log_error(LOG_LEVEL_ERROR,
2269 "CONNECT already confirmed. Unable to tell the client about the problem.");
2272 else if (byte_count)
2275 * Just hang up. We already transmitted the original headers
2276 * and parts of the original content and therefore missed the
2277 * chance to send an error message (without risking data corruption).
2279 * XXX: we could retry with a fancy range request here.
2281 log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
2282 "Unable to tell the client about the problem.");
2283 mark_server_socket_tainted(csp);
2287 * XXX: Consider handling the cases above the same.
2289 mark_server_socket_tainted(csp);
2293 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2294 if (csp->flags & CSP_FLAG_CHUNKED)
2296 if ((len >= 5) && !memcmp(buf+len-5, "0\r\n\r\n", 5))
2298 /* XXX: this is a temporary hack */
2299 log_error(LOG_LEVEL_CONNECT,
2300 "Looks like we reached the end of the last chunk. "
2301 "We better stop reading.");
2302 csp->expected_content_length = byte_count + (unsigned long long)len;
2303 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2307 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2310 * Add a trailing zero to let be able to use string operations.
2311 * XXX: do we still need this with filter_popups gone?
2316 * Normally, this would indicate that we've read
2317 * as much as the server has sent us and we can
2318 * close the client connection. However, Microsoft
2319 * in its wisdom has released IIS/5 with a bug that
2320 * prevents it from sending the trailing \r\n in
2321 * a 302 redirect header (and possibly other headers).
2322 * To work around this if we've haven't parsed
2323 * a full header we'll append a trailing \r\n
2324 * and see if this now generates a valid one.
2326 * This hack shouldn't have any impacts. If we've
2327 * already transmitted the header or if this is a
2328 * SSL connection, then we won't bother with this
2329 * hack. So we only work on partially received
2330 * headers. If we append a \r\n and this still
2331 * doesn't generate a valid header, then we won't
2332 * transmit anything to the client.
2337 if (server_body || http->ssl)
2340 * If we have been buffering up the document,
2341 * now is the time to apply content modification
2342 * and send the result to the client.
2344 if (buffer_and_filter_content)
2346 p = execute_content_filters(csp);
2348 * If content filtering fails, use the original
2349 * buffer and length.
2350 * (see p != NULL ? p : csp->iob->cur below)
2354 csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
2356 #ifdef FEATURE_COMPRESSION
2357 else if ((csp->flags & CSP_FLAG_CLIENT_SUPPORTS_DEFLATE)
2358 && (csp->content_length > LOWER_LENGTH_LIMIT_FOR_COMPRESSION))
2360 char *compressed_content = compress_buffer(p,
2361 (size_t *)&csp->content_length, csp->config->compression_level);
2362 if (compressed_content != NULL)
2365 p = compressed_content;
2366 csp->flags |= CSP_FLAG_BUFFERED_CONTENT_DEFLATED;
2371 if (JB_ERR_OK != update_server_headers(csp))
2373 log_error(LOG_LEVEL_FATAL,
2374 "Failed to update server headers. after filtering.");
2377 hdr = list_to_text(csp->headers);
2380 /* FIXME Should handle error properly */
2381 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2384 if (write_socket(csp->cfd, hdr, strlen(hdr))
2385 || write_socket(csp->cfd,
2386 ((p != NULL) ? p : csp->iob->cur), (size_t)csp->content_length))
2388 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
2391 mark_server_socket_tainted(csp);
2399 break; /* "game over, man" */
2403 * This is NOT the body, so
2404 * Let's pretend the server just sent us a blank line.
2406 snprintf(buf, sizeof(buf), "\r\n");
2407 len = (int)strlen(buf);
2410 * Now, let the normal header parsing algorithm below do its
2411 * job. If it fails, we'll exit instead of continuing.
2418 * If this is an SSL connection or we're in the body
2419 * of the server document, just write it to the client,
2420 * unless we need to buffer the body for later content-filtering
2422 if (server_body || http->ssl)
2424 if (buffer_and_filter_content)
2427 * If there is no memory left for buffering the content, or the buffer limit
2428 * has been reached, switch to non-filtering mode, i.e. make & write the
2429 * header, flush the iob and buf, and get out of the way.
2431 if (add_to_iob(csp->iob, csp->config->buffer_limit, buf, len))
2436 log_error(LOG_LEVEL_INFO,
2437 "Flushing header and buffers. Stepping back from filtering.");
2439 hdr = list_to_text(csp->headers);
2443 * Memory is too tight to even generate the header.
2444 * Send our static "Out-of-memory" page.
2446 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
2447 rsp = cgi_error_memory();
2448 send_crunch_response(csp, rsp);
2449 mark_server_socket_tainted(csp);
2452 hdrlen = strlen(hdr);
2454 if (write_socket(csp->cfd, hdr, hdrlen)
2455 || ((flushed = flush_socket(csp->cfd, csp->iob)) < 0)
2456 || (write_socket(csp->cfd, buf, (size_t)len)))
2458 log_error(LOG_LEVEL_CONNECT,
2459 "Flush header and buffers to client failed: %E");
2461 mark_server_socket_tainted(csp);
2466 * Reset the byte_count to the amount of bytes
2467 * we just flushed. len will be added a few lines below,
2468 * hdrlen doesn't matter for LOG_LEVEL_CLF.
2470 byte_count = (unsigned long long)flushed;
2472 buffer_and_filter_content = 0;
2478 if (write_socket(csp->cfd, buf, (size_t)len))
2480 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
2481 mark_server_socket_tainted(csp);
2485 byte_count += (unsigned long long)len;
2491 * We're still looking for the end of the server's header.
2492 * Buffer up the data we just read. If that fails, there's
2493 * little we can do but send our static out-of-memory page.
2495 if (add_to_iob(csp->iob, csp->config->buffer_limit, buf, len))
2497 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
2498 rsp = cgi_error_memory();
2499 send_crunch_response(csp, rsp);
2500 mark_server_socket_tainted(csp);
2504 /* Convert iob into something sed() can digest */
2505 if (JB_ERR_PARSE == get_server_headers(csp))
2510 * Well, we tried our MS IIS/5 hack and it didn't work.
2511 * The header is incomplete and there isn't anything
2512 * we can do about it.
2514 log_error(LOG_LEVEL_ERROR, "Invalid server headers. "
2515 "Applying the MS IIS5 hack didn't help.");
2516 log_error(LOG_LEVEL_CLF,
2517 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2518 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2519 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2520 mark_server_socket_tainted(csp);
2526 * Since we have to wait for more from the server before
2527 * we can parse the headers we just continue here.
2529 log_error(LOG_LEVEL_CONNECT,
2530 "Continuing buffering server headers from socket %d. "
2531 "Bytes most recently read: %d.", csp->cfd, len);
2538 * Account for the content bytes we
2539 * might have gotten with the headers.
2541 assert(csp->iob->eod >= csp->iob->cur);
2542 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2545 /* Did we actually get anything? */
2546 if (NULL == csp->headers->first)
2548 if ((csp->flags & CSP_FLAG_REUSED_CLIENT_CONNECTION))
2550 log_error(LOG_LEVEL_ERROR,
2551 "No server or forwarder response received on socket %d. "
2552 "Closing client socket %d without sending data.",
2553 csp->server_connection.sfd, csp->cfd);
2554 log_error(LOG_LEVEL_CLF,
2555 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2559 log_error(LOG_LEVEL_ERROR,
2560 "No server or forwarder response received on socket %d.",
2561 csp->server_connection.sfd);
2562 send_crunch_response(csp, error_response(csp, "no-server-data"));
2564 free_http_request(http);
2565 mark_server_socket_tainted(csp);
2569 assert(csp->headers->first->str);
2571 if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
2572 strncmpic(csp->headers->first->str, "ICY", 3))
2575 * It doesn't look like a HTTP (or Shoutcast) response:
2576 * tell the client and log the problem.
2578 if (strlen(csp->headers->first->str) > 30)
2580 csp->headers->first->str[30] = '\0';
2582 log_error(LOG_LEVEL_ERROR,
2583 "Invalid server or forwarder response. Starts with: %s",
2584 csp->headers->first->str);
2585 log_error(LOG_LEVEL_CLF,
2586 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2587 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2588 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2589 free_http_request(http);
2590 mark_server_socket_tainted(csp);
2595 * We have now received the entire server header,
2596 * filter it and send the result to the client
2598 if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
2600 log_error(LOG_LEVEL_CLF,
2601 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2602 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2603 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2604 free_http_request(http);
2605 mark_server_socket_tainted(csp);
2608 hdr = list_to_text(csp->headers);
2611 /* FIXME Should handle error properly */
2612 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2615 if ((csp->flags & CSP_FLAG_CHUNKED)
2616 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2617 && ((csp->iob->eod - csp->iob->cur) >= 5)
2618 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
2620 log_error(LOG_LEVEL_CONNECT,
2621 "Looks like we got the last chunk together with "
2622 "the server headers. We better stop reading.");
2623 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2624 csp->expected_content_length = byte_count;
2625 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2628 csp->server_connection.response_received = time(NULL);
2630 if (crunch_response_triggered(csp, crunchers_light))
2633 * One of the tags created by a server-header
2634 * tagger triggered a crunch. We already
2635 * delivered the crunch response to the client
2636 * and are done here after cleaning up.
2639 mark_server_socket_tainted(csp);
2642 /* Buffer and pcrs filter this if appropriate. */
2644 if (!http->ssl) /* We talk plaintext */
2646 buffer_and_filter_content = content_requires_filtering(csp);
2649 * Only write if we're not buffering for content modification
2651 if (!buffer_and_filter_content)
2654 * Write the server's (modified) header to
2655 * the client (along with anything else that
2656 * may be in the buffer)
2659 if (write_socket(csp->cfd, hdr, strlen(hdr))
2660 || ((len = flush_socket(csp->cfd, csp->iob)) < 0))
2662 log_error(LOG_LEVEL_CONNECT, "write header to client failed: %E");
2665 * The write failed, so don't bother mentioning it
2666 * to the client... it probably can't hear us anyway.
2669 mark_server_socket_tainted(csp);
2674 /* we're finished with the server's header */
2680 * If this was a MS IIS/5 hack then it means the server
2681 * has already closed the connection. Nothing more to read.
2686 log_error(LOG_LEVEL_ERROR,
2687 "Closed server connection detected. "
2688 "Applying the MS IIS5 hack didn't help.");
2689 log_error(LOG_LEVEL_CLF,
2690 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2691 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2692 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2693 mark_server_socket_tainted(csp);
2699 mark_server_socket_tainted(csp);
2700 return; /* huh? we should never get here */
2703 if (csp->content_length == 0)
2706 * If Privoxy didn't recalculate the Content-Length,
2707 * byte_count is still correct.
2709 csp->content_length = byte_count;
2712 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2713 if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2714 && (csp->expected_content_length != byte_count))
2716 log_error(LOG_LEVEL_CONNECT,
2717 "Received %llu bytes while expecting %llu.",
2718 byte_count, csp->expected_content_length);
2719 mark_server_socket_tainted(csp);
2723 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %llu",
2724 csp->ip_addr_str, http->ocmd, csp->content_length);
2726 csp->server_connection.timestamp = time(NULL);
2730 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2731 /*********************************************************************
2733 * Function : prepare_csp_for_next_request
2735 * Description : Put the csp in a mostly vergin state.
2738 * 1 : csp = Current client state (buffers, headers, etc...)
2742 *********************************************************************/
2743 static void prepare_csp_for_next_request(struct client_state *csp)
2745 unsigned int toggled_on_flag_set = (0 != (csp->flags & CSP_FLAG_TOGGLED_ON));
2747 csp->content_type = 0;
2748 csp->content_length = 0;
2749 csp->expected_content_length = 0;
2750 csp->expected_client_content_length = 0;
2751 list_remove_all(csp->headers);
2752 clear_iob(csp->iob);
2753 freez(csp->error_message);
2754 free_http_request(csp->http);
2755 destroy_list(csp->headers);
2756 destroy_list(csp->tags);
2757 free_current_action(csp->action);
2758 if (NULL != csp->fwd)
2760 unload_forward_spec(csp->fwd);
2763 /* XXX: Store per-connection flags someplace else. */
2764 csp->flags = (CSP_FLAG_ACTIVE | CSP_FLAG_REUSED_CLIENT_CONNECTION);
2765 if (toggled_on_flag_set)
2767 csp->flags |= CSP_FLAG_TOGGLED_ON;
2770 if (csp->client_iob->eod > csp->client_iob->cur)
2772 long bytes_to_shift = csp->client_iob->cur - csp->client_iob->buf;
2773 size_t data_length = (size_t)(csp->client_iob->eod - csp->client_iob->cur);
2775 assert(bytes_to_shift > 0);
2776 assert(data_length > 0);
2778 log_error(LOG_LEVEL_CONNECT, "Shifting %d pipelined bytes by %d bytes",
2779 data_length, bytes_to_shift);
2780 memmove(csp->client_iob->buf, csp->client_iob->cur, data_length);
2781 csp->client_iob->cur = csp->client_iob->buf;
2782 assert(csp->client_iob->eod == csp->client_iob->buf + bytes_to_shift + data_length);
2783 csp->client_iob->eod = csp->client_iob->buf + data_length;
2784 memset(csp->client_iob->eod, '\0', (size_t)bytes_to_shift);
2786 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
2791 * We mainly care about resetting client_iob->cur so we don't
2792 * waste buffer space at the beginning and don't mess up the
2793 * request restoration done by cgi_show_request().
2795 * Freeing the buffer itself isn't technically necessary,
2796 * but makes debugging more convenient.
2798 clear_iob(csp->client_iob);
2801 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2804 /*********************************************************************
2808 * Description : This is little more than chat. We only "serve" to
2809 * to close (or remember) any socket that chat may have
2813 * 1 : csp = Current client state (buffers, headers, etc...)
2817 *********************************************************************/
2819 void serve(struct client_state *csp)
2820 #else /* ifndef AMIGA */
2821 static void serve(struct client_state *csp)
2822 #endif /* def AMIGA */
2824 int config_file_change_detected = 0; /* Only used for debugging */
2825 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2826 #ifdef FEATURE_CONNECTION_SHARING
2827 static int monitor_thread_running = 0;
2828 #endif /* def FEATURE_CONNECTION_SHARING */
2829 int continue_chatting = 0;
2831 log_error(LOG_LEVEL_CONNECT, "Accepted connection from %s on socket %d",
2832 csp->ip_addr_str, csp->cfd);
2836 unsigned int latency;
2841 * If the request has been crunched,
2842 * the calculated latency is zero.
2844 latency = (unsigned)(csp->server_connection.response_received -
2845 csp->server_connection.request_sent) / 2;
2847 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
2848 && (csp->flags & CSP_FLAG_CRUNCHED)
2849 && (csp->expected_client_content_length != 0))
2851 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
2852 log_error(LOG_LEVEL_CONNECT,
2853 "Tainting client socket %d due to unread data.", csp->cfd);
2856 continue_chatting = (csp->config->feature_flags
2857 & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
2858 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
2859 && (csp->cfd != JB_INVALID_SOCKET)
2860 && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
2861 && ((csp->flags & CSP_FLAG_SERVER_CONTENT_LENGTH_SET)
2862 || (csp->flags & CSP_FLAG_CHUNKED));
2864 if (!(csp->flags & CSP_FLAG_CRUNCHED)
2865 && (csp->server_connection.sfd != JB_INVALID_SOCKET))
2867 if (!(csp->flags & CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET))
2869 csp->server_connection.keep_alive_timeout = csp->config->default_server_timeout;
2871 if (!(csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
2872 || (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
2873 || !socket_is_still_alive(csp->server_connection.sfd)
2874 || !(latency < csp->server_connection.keep_alive_timeout))
2876 log_error(LOG_LEVEL_CONNECT,
2877 "Closing server socket %d connected to %s. "
2878 "Keep-alive %u. Tainted: %u. Socket alive %u. Timeout: %u.",
2879 csp->server_connection.sfd, csp->server_connection.host,
2880 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
2881 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
2882 socket_is_still_alive(csp->server_connection.sfd),
2883 csp->server_connection.keep_alive_timeout);
2884 #ifdef FEATURE_CONNECTION_SHARING
2885 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
2887 forget_connection(csp->server_connection.sfd);
2889 #endif /* def FEATURE_CONNECTION_SHARING */
2890 close_socket(csp->server_connection.sfd);
2891 mark_connection_closed(&csp->server_connection);
2895 if (continue_chatting && any_loaded_file_changed(csp))
2897 continue_chatting = 0;
2898 config_file_change_detected = 1;
2901 if (continue_chatting)
2903 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
2904 && socket_is_still_alive(csp->cfd))
2906 log_error(LOG_LEVEL_CONNECT, "Client request %d has been "
2907 "pipelined on socket %d and the socket is still alive.",
2908 csp->requests_received_total+1, csp->cfd);
2909 prepare_csp_for_next_request(csp);
2913 if (0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
2915 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
2917 log_error(LOG_LEVEL_CONNECT,
2918 "Waiting for the next client request on socket %d. "
2919 "Keeping the server socket %d to %s open.",
2920 csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
2924 log_error(LOG_LEVEL_CONNECT,
2925 "Waiting for the next client request on socket %d. "
2926 "No server socket to keep open.", csp->cfd);
2930 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
2931 && data_is_available(csp->cfd, (int)csp->config->keep_alive_timeout)
2932 && socket_is_still_alive(csp->cfd))
2934 log_error(LOG_LEVEL_CONNECT,
2935 "Client request %u arrived in time on socket %d.",
2936 csp->requests_received_total+1, csp->cfd);
2937 prepare_csp_for_next_request(csp);
2941 #ifdef FEATURE_CONNECTION_SHARING
2942 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
2943 && (csp->server_connection.sfd != JB_INVALID_SOCKET)
2944 && (socket_is_still_alive(csp->server_connection.sfd)))
2946 time_t time_open = time(NULL) - csp->server_connection.timestamp;
2948 if (csp->server_connection.keep_alive_timeout < time_open - (time_t)latency)
2953 remember_connection(&csp->server_connection);
2954 csp->server_connection.sfd = JB_INVALID_SOCKET;
2955 drain_and_close_socket(csp->cfd);
2956 csp->cfd = JB_INVALID_SOCKET;
2957 privoxy_mutex_lock(&connection_reuse_mutex);
2958 if (!monitor_thread_running)
2960 monitor_thread_running = 1;
2961 privoxy_mutex_unlock(&connection_reuse_mutex);
2962 wait_for_alive_connections();
2963 privoxy_mutex_lock(&connection_reuse_mutex);
2964 monitor_thread_running = 0;
2966 privoxy_mutex_unlock(&connection_reuse_mutex);
2968 #endif /* def FEATURE_CONNECTION_SHARING */
2972 else if (csp->server_connection.sfd != JB_INVALID_SOCKET)
2974 log_error(LOG_LEVEL_CONNECT,
2975 "Closing server socket %d connected to %s. Keep-alive: %u. "
2976 "Tainted: %u. Socket alive: %u. Timeout: %u. "
2977 "Configuration file change detected: %u",
2978 csp->server_connection.sfd, csp->server_connection.host,
2979 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
2980 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
2981 socket_is_still_alive(csp->server_connection.sfd),
2982 csp->server_connection.keep_alive_timeout,
2983 config_file_change_detected);
2985 } while (continue_chatting);
2989 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2991 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
2993 #ifdef FEATURE_CONNECTION_SHARING
2994 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
2996 forget_connection(csp->server_connection.sfd);
2998 #endif /* def FEATURE_CONNECTION_SHARING */
2999 close_socket(csp->server_connection.sfd);
3002 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3003 mark_connection_closed(&csp->server_connection);
3006 if (csp->cfd != JB_INVALID_SOCKET)
3008 log_error(LOG_LEVEL_CONNECT, "Closing client socket %d. "
3009 "Keep-alive: %u. Socket alive: %u. Data available: %u. "
3010 "Configuration file change detected: %u. Requests received: %u.",
3011 csp->cfd, 0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE),
3012 socket_is_still_alive(csp->cfd), data_is_available(csp->cfd, 0),
3013 config_file_change_detected, csp->requests_received_total);
3014 drain_and_close_socket(csp->cfd);
3017 csp->flags &= ~CSP_FLAG_ACTIVE;
3023 /*********************************************************************
3025 * Function : server_thread
3027 * Description : We only exist to call `serve' in a threaded environment.
3030 * 1 : data = Current client state (buffers, headers, etc...)
3032 * Returns : Always 0.
3034 *********************************************************************/
3035 static int32 server_thread(void *data)
3037 serve((struct client_state *) data);
3044 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
3045 /*********************************************************************
3049 * Description : Print usage info & exit.
3051 * Parameters : Pointer to argv[0] for identifying ourselves
3055 *********************************************************************/
3056 static void usage(const char *myname)
3058 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
3059 "Usage: %s [--config-test] "
3062 #endif /* defined(unix) */
3065 "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
3066 #endif /* defined(unix) */
3067 "[--version] [configfile]\n"
3068 "Aborting\n", myname);
3073 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
3076 #ifdef MUTEX_LOCKS_AVAILABLE
3077 /*********************************************************************
3079 * Function : privoxy_mutex_lock
3081 * Description : Locks a mutex.
3084 * 1 : mutex = The mutex to lock.
3086 * Returns : Void. May exit in case of errors.
3088 *********************************************************************/
3089 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
3091 #ifdef FEATURE_PTHREAD
3092 int err = pthread_mutex_lock(mutex);
3095 if (mutex != &log_mutex)
3097 log_error(LOG_LEVEL_FATAL,
3098 "Mutex locking failed: %s.\n", strerror(err));
3103 EnterCriticalSection(mutex);
3104 #endif /* def FEATURE_PTHREAD */
3108 /*********************************************************************
3110 * Function : privoxy_mutex_unlock
3112 * Description : Unlocks a mutex.
3115 * 1 : mutex = The mutex to unlock.
3117 * Returns : Void. May exit in case of errors.
3119 *********************************************************************/
3120 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
3122 #ifdef FEATURE_PTHREAD
3123 int err = pthread_mutex_unlock(mutex);
3126 if (mutex != &log_mutex)
3128 log_error(LOG_LEVEL_FATAL,
3129 "Mutex unlocking failed: %s.\n", strerror(err));
3134 LeaveCriticalSection(mutex);
3135 #endif /* def FEATURE_PTHREAD */
3139 /*********************************************************************
3141 * Function : privoxy_mutex_init
3143 * Description : Prepares a mutex.
3146 * 1 : mutex = The mutex to initialize.
3148 * Returns : Void. May exit in case of errors.
3150 *********************************************************************/
3151 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
3153 #ifdef FEATURE_PTHREAD
3154 int err = pthread_mutex_init(mutex, 0);
3157 printf("Fatal error. Mutex initialization failed: %s.\n",
3162 InitializeCriticalSection(mutex);
3163 #endif /* def FEATURE_PTHREAD */
3165 #endif /* def MUTEX_LOCKS_AVAILABLE */
3167 /*********************************************************************
3169 * Function : initialize_mutexes
3171 * Description : Prepares mutexes if mutex support is available.
3175 * Returns : Void, exits in case of errors.
3177 *********************************************************************/
3178 static void initialize_mutexes(void)
3180 #ifdef MUTEX_LOCKS_AVAILABLE
3182 * Prepare global mutex semaphores
3184 privoxy_mutex_init(&log_mutex);
3185 privoxy_mutex_init(&log_init_mutex);
3186 privoxy_mutex_init(&connection_reuse_mutex);
3187 #ifdef FEATURE_EXTERNAL_FILTERS
3188 privoxy_mutex_init(&external_filter_mutex);
3192 * XXX: The assumptions below are a bit naive
3193 * and can cause locks that aren't necessary.
3195 * For example older FreeBSD versions (< 6.x?)
3196 * have no gethostbyname_r, but gethostbyname is
3199 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
3200 privoxy_mutex_init(&resolver_mutex);
3201 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
3203 * XXX: should we use a single mutex for
3204 * localtime() and gmtime() as well?
3206 #ifndef HAVE_GMTIME_R
3207 privoxy_mutex_init(&gmtime_mutex);
3208 #endif /* ndef HAVE_GMTIME_R */
3210 #ifndef HAVE_LOCALTIME_R
3211 privoxy_mutex_init(&localtime_mutex);
3212 #endif /* ndef HAVE_GMTIME_R */
3215 privoxy_mutex_init(&rand_mutex);
3216 #endif /* ndef HAVE_RANDOM */
3218 #endif /* def MUTEX_LOCKS_AVAILABLE */
3222 /*********************************************************************
3226 * Description : Load the config file and start the listen loop.
3227 * This function is a lot more *sane* with the `load_config'
3228 * and `listen_loop' functions; although it stills does
3229 * a *little* too much for my taste.
3232 * 1 : argc = Number of parameters (including $0).
3233 * 2 : argv = Array of (char *)'s to the parameters.
3235 * Returns : 1 if : can't open config file, unrecognized directive,
3236 * stats requested in multi-thread mode, can't open the
3237 * log file, can't open the jar file, listen port is invalid,
3238 * any load fails, and can't bind port.
3240 * Else main never returns, the process must be signaled
3241 * to terminate execution. Or, on Windows, use the
3242 * "File", "Exit" menu option.
3244 *********************************************************************/
3246 int real_main(int argc, char **argv)
3248 int main(int argc, char **argv)
3252 int do_config_test = 0;
3253 unsigned int random_seed;
3255 struct passwd *pw = NULL;
3256 struct group *grp = NULL;
3258 char *pre_chroot_nslookup_to_load_resolver = NULL;
3265 #if !defined(_WIN32)
3272 /* Prepare mutexes if supported and necessary. */
3273 initialize_mutexes();
3275 /* Enable logging until further notice. */
3279 * Parse the command line arguments
3281 * XXX: simply printing usage information in case of
3282 * invalid arguments isn't particularly user friendly.
3284 while (++argc_pos < argc)
3287 /* Check to see if the service must be installed or uninstalled */
3288 if (strncmp(argv[argc_pos], "--install", 9) == 0)
3290 const char *pName = argv[argc_pos] + 9;
3293 exit((install_service(pName)) ? 0 : 1);
3295 else if (strncmp(argv[argc_pos], "--uninstall", 11) == 0)
3297 const char *pName = argv[argc_pos] + 11;
3300 exit((uninstall_service(pName)) ? 0 : 1);
3302 else if (strcmp(argv[argc_pos], "--service") == 0)
3304 bRunAsService = TRUE;
3305 w32_set_service_cwd();
3306 atexit(w32_service_exit_notify);
3309 #endif /* defined(_WIN32) */
3312 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
3314 if (strcmp(argv[argc_pos], "--help") == 0)
3319 else if (strcmp(argv[argc_pos], "--version") == 0)
3321 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
3327 else if (strcmp(argv[argc_pos], "--no-daemon") == 0)
3329 set_debug_level(LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
3333 else if (strcmp(argv[argc_pos], "--pidfile") == 0)
3335 if (++argc_pos == argc) usage(argv[0]);
3336 pidfile = strdup_or_die(argv[argc_pos]);
3339 else if (strcmp(argv[argc_pos], "--user") == 0)
3344 if (++argc_pos == argc) usage(argv[argc_pos]);
3346 user_arg = strdup_or_die(argv[argc_pos]);
3347 group_name = strchr(user_arg, '.');
3348 if (NULL != group_name)
3350 /* Nul-terminate the user name */
3353 /* Skip the former delimiter to actually reach the group name */
3356 grp = getgrnam(group_name);
3359 log_error(LOG_LEVEL_FATAL, "Group '%s' not found.", group_name);
3362 pw = getpwnam(user_arg);
3365 log_error(LOG_LEVEL_FATAL, "User '%s' not found.", user_arg);
3371 else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup") == 0)
3373 if (++argc_pos == argc) usage(argv[0]);
3374 pre_chroot_nslookup_to_load_resolver = strdup_or_die(argv[argc_pos]);
3377 else if (strcmp(argv[argc_pos], "--chroot") == 0)
3381 #endif /* defined(unix) */
3383 else if (strcmp(argv[argc_pos], "--config-test") == 0)
3388 else if (argc_pos + 1 != argc)
3391 * This is neither the last command line
3392 * option, nor was it recognized before,
3393 * therefore it must be invalid.
3399 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
3401 configfile = argv[argc_pos];
3404 } /* -END- while (more arguments) */
3406 show_version(Argv[0]);
3409 if (*configfile != '/')
3411 char cwd[BUFFER_SIZE];
3413 size_t abs_file_size;
3415 /* make config-filename absolute here */
3416 if (NULL == getcwd(cwd, sizeof(cwd)))
3418 perror("failed to get current working directory");
3422 basedir = strdup_or_die(cwd);
3424 abs_file_size = strlen(cwd) + strlen(configfile) + 5;
3425 abs_file = malloc_or_die(abs_file_size);
3426 strlcpy(abs_file, basedir, abs_file_size);
3427 strlcat(abs_file, "/", abs_file_size);
3428 strlcat(abs_file, configfile, abs_file_size);
3429 configfile = abs_file;
3431 #endif /* defined unix */
3435 clients->next = NULL;
3437 /* XXX: factor out initialising after the next stable release. */
3440 #elif defined(_WIN32)
3444 random_seed = (unsigned int)time(NULL);
3446 srandom(random_seed);
3449 #endif /* ifdef HAVE_RANDOM */
3452 * Unix signal handling
3454 * Catch the abort, interrupt and terminate signals for a graceful exit
3455 * Catch the hangup signal so the errlog can be reopened.
3456 * Ignore the broken pipe signals (FIXME: Why?)
3458 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
3461 const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP };
3463 for (idx = 0; idx < SZ(catched_signals); idx++)
3465 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
3466 if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
3468 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
3469 #endif /* ifdef sun */
3471 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
3475 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
3477 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for SIGPIPE: %E");
3481 #else /* ifdef _WIN32 */
3482 # ifdef _WIN_CONSOLE
3484 * We *are* in a windows console app.
3485 * Print a verbose messages about FAQ's and such
3487 printf("%s", win32_blurb);
3488 # endif /* def _WIN_CONSOLE */
3489 #endif /* def _WIN32 */
3493 exit(NULL == load_config());
3496 /* Initialize the CGI subsystem */
3497 cgi_init_error_messages();
3500 * If runnig on unix and without the --nodaemon
3501 * option, become a daemon. I.e. fork, detach
3502 * from tty and get process group leadership
3511 if (pid < 0) /* error */
3516 else if (pid != 0) /* parent */
3521 * must check for errors
3522 * child died due to missing files aso
3525 wpid = waitpid(pid, &status, WNOHANG);
3537 * stderr (fd 2) will be closed later on,
3538 * when the config file has been parsed.
3544 * Reserve fd 0 and 1 to prevent abort() and friends
3545 * from sending stuff to the clients or servers.
3547 fd = open("/dev/null", O_RDONLY);
3550 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
3554 if (dup2(fd, 0) == -1)
3556 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 0: %E");
3560 fd = open("/dev/null", O_WRONLY);
3563 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
3567 if (dup2(fd, 1) == -1)
3569 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 1: %E");
3574 #ifdef FEATURE_EXTERNAL_FILTERS
3575 for (fd = 0; fd < 3; fd++)
3577 mark_socket_for_close_on_execute(fd);
3583 } /* -END- if (daemon_mode) */
3586 * As soon as we have written the PID file, we can switch
3587 * to the user and group ID indicated by the --user option
3593 if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
3595 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
3599 if (setgroups(1, &grp->gr_gid))
3601 log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
3604 else if (initgroups(pw->pw_name, pw->pw_gid))
3606 log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
3612 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
3614 /* Read the time zone file from /etc before doing chroot. */
3616 if (NULL != pre_chroot_nslookup_to_load_resolver
3617 && '\0' != pre_chroot_nslookup_to_load_resolver[0])
3619 /* Initialize resolver library. */
3620 (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
3622 if (chroot(pw->pw_dir) < 0)
3624 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
3628 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
3631 if (setuid(pw->pw_uid))
3633 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
3637 char putenv_dummy[64];
3639 strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
3640 if (putenv(putenv_dummy) != 0)
3642 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
3645 snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
3646 if (putenv(putenv_dummy) != 0)
3648 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
3654 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
3657 #endif /* defined unix */
3660 /* This will be FALSE unless the command line specified --service
3664 /* Yup, so now we must attempt to establish a connection
3665 * with the service dispatcher. This will only work if this
3666 * process was launched by the service control manager to
3667 * actually run as a service. If this isn't the case, i've
3668 * known it take around 30 seconds or so for the call to return.
3671 /* The StartServiceCtrlDispatcher won't return until the service is stopping */
3672 if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
3674 /* Service has run, and at this point is now being stopped, so just return */
3679 printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
3681 /* An error occurred. Usually it's because --service was wrongly specified
3682 * and we were unable to connect to the Service Control Dispatcher because
3683 * it wasn't expecting us and is therefore not listening.
3685 * For now, just continue below to call the listen_loop function.
3688 #endif /* def _WIN32 */
3698 /*********************************************************************
3700 * Function : bind_port_helper
3702 * Description : Bind the listen port. Handles logging, and aborts
3706 * 1 : haddr = Host address to bind to. Use NULL to bind to
3708 * 2 : hport = Specifies port to bind to.
3710 * Returns : Port that was opened.
3712 *********************************************************************/
3713 static jb_socket bind_port_helper(const char *haddr, int hport)
3718 result = bind_port(haddr, hport, &bfd);
3722 const char *bind_address = (NULL != haddr) ? haddr : "INADDR_ANY";
3726 log_error(LOG_LEVEL_FATAL,
3727 "can't bind to %s:%d: There may be another Privoxy "
3728 "or some other proxy running on port %d",
3729 bind_address, hport, hport);
3732 log_error(LOG_LEVEL_FATAL,
3733 "can't bind to %s:%d: The hostname is not resolvable",
3734 bind_address, hport);
3737 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: %E",
3738 bind_address, hport);
3741 /* shouldn't get here */
3742 return JB_INVALID_SOCKET;
3746 if (bfd >= FD_SETSIZE)
3748 log_error(LOG_LEVEL_FATAL,
3749 "Bind socket number too high to use select(): %d >= %d",
3756 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
3761 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
3769 /*********************************************************************
3771 * Function : bind_ports_helper
3773 * Description : Bind the listen ports. Handles logging, and aborts
3777 * 1 : config = Privoxy configuration. Specifies ports
3779 * 2 : sockets = Preallocated array of opened sockets
3780 * corresponding to specification in config.
3781 * All non-opened sockets will be set to
3782 * JB_INVALID_SOCKET.
3784 * Returns : Nothing. Inspect sockets argument.
3786 *********************************************************************/
3787 static void bind_ports_helper(struct configuration_spec * config,
3788 jb_socket sockets[])
3792 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
3794 if (config->hport[i])
3796 sockets[i] = bind_port_helper(config->haddr[i], config->hport[i]);
3800 sockets[i] = JB_INVALID_SOCKET;
3803 config->need_bind = 0;
3807 /*********************************************************************
3809 * Function : close_ports_helper
3811 * Description : Close listenings ports.
3814 * 1 : sockets = Array of opened and non-opened sockets to
3815 * close. All sockets will be set to
3816 * JB_INVALID_SOCKET.
3818 * Returns : Nothing.
3820 *********************************************************************/
3821 static void close_ports_helper(jb_socket sockets[])
3825 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
3827 if (JB_INVALID_SOCKET != sockets[i])
3829 close_socket(sockets[i]);
3831 sockets[i] = JB_INVALID_SOCKET;
3837 /* Without this simple workaround we get this compiler warning from _beginthread
3838 * warning C4028: formal parameter 1 different from declaration
3840 void w32_service_listen_loop(void *p)
3844 #endif /* def _WIN32 */
3847 /*********************************************************************
3849 * Function : listen_loop
3851 * Description : bind the listen port and enter a "FOREVER" listening loop.
3857 *********************************************************************/
3858 static void listen_loop(void)
3860 struct client_states *csp_list = NULL;
3861 struct client_state *csp = NULL;
3862 jb_socket bfds[MAX_LISTENING_SOCKETS];
3863 struct configuration_spec *config;
3864 unsigned int active_threads = 0;
3866 config = load_config();
3868 #ifdef FEATURE_CONNECTION_SHARING
3870 * XXX: Should be relocated once it no
3871 * longer needs to emit log messages.
3873 initialize_reusable_connections();
3874 #endif /* def FEATURE_CONNECTION_SHARING */
3876 bind_ports_helper(config, bfds);
3878 #ifdef FEATURE_GRACEFUL_TERMINATION
3879 while (!g_terminate)
3884 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
3885 while (waitpid(-1, NULL, WNOHANG) > 0)
3887 /* zombie children */
3889 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
3892 * Free data that was used by died threads
3894 active_threads = sweep();
3898 * Re-open the errlog after HUP signal
3900 if (received_hup_signal)
3902 if (NULL != config->logfile)
3904 init_error_log(Argv[0], config->logfile);
3906 received_hup_signal = 0;
3910 csp_list = (struct client_states *)zalloc(sizeof(*csp_list));
3911 if (NULL == csp_list)
3913 log_error(LOG_LEVEL_FATAL,
3914 "malloc(%d) for csp_list failed: %E", sizeof(*csp_list));
3917 csp = &csp_list->csp;
3919 log_error(LOG_LEVEL_CONNECT, "Listening for new connections ... ");
3921 if (!accept_connection(csp, bfds))
3923 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
3935 csp->flags |= CSP_FLAG_ACTIVE;
3936 csp->server_connection.sfd = JB_INVALID_SOCKET;
3938 csp->config = config = load_config();
3940 if (config->need_bind)
3943 * Since we were listening to the "old port", we will not see
3944 * a "listen" param change until the next request. So, at
3945 * least 1 more request must be made for us to find the new
3946 * setting. I am simply closing the old socket and binding the
3949 * Which-ever is correct, we will serve 1 more page via the
3950 * old settings. This should probably be a "show-proxy-args"
3951 * request. This should not be a so common of an operation
3952 * that this will hurt people's feelings.
3955 close_ports_helper(bfds);
3957 bind_ports_helper(config, bfds);
3960 #ifdef FEATURE_TOGGLE
3961 if (global_toggle_state)
3962 #endif /* def FEATURE_TOGGLE */
3964 csp->flags |= CSP_FLAG_TOGGLED_ON;
3967 if (run_loader(csp))
3969 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
3970 /* Never get here - LOG_LEVEL_FATAL causes program exit */
3974 if (block_acl(NULL,csp))
3976 log_error(LOG_LEVEL_CONNECT,
3977 "Connection from %s on socket %d dropped due to ACL", csp->ip_addr_str, csp->cfd);
3978 close_socket(csp->cfd);
3979 freez(csp->ip_addr_str);
3983 #endif /* def FEATURE_ACL */
3985 if ((0 != config->max_client_connections)
3986 && (active_threads >= config->max_client_connections))
3988 log_error(LOG_LEVEL_CONNECT,
3989 "Rejecting connection from %s. Maximum number of connections reached.",
3991 write_socket(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
3992 strlen(TOO_MANY_CONNECTIONS_RESPONSE));
3993 close_socket(csp->cfd);
3994 freez(csp->ip_addr_str);
3999 /* add it to the list of clients */
4000 csp_list->next = clients->next;
4001 clients->next = csp_list;
4003 if (config->multi_threaded)
4007 /* this is a switch () statement in the C preprocessor - ugh */
4008 #undef SELECTED_ONE_OPTION
4010 /* Use Pthreads in preference to native code */
4011 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
4012 #define SELECTED_ONE_OPTION
4014 pthread_t the_thread;
4015 pthread_attr_t attrs;
4017 pthread_attr_init(&attrs);
4018 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
4019 errno = pthread_create(&the_thread, &attrs,
4020 (void * (*)(void *))serve, csp);
4021 child_id = errno ? -1 : 0;
4022 pthread_attr_destroy(&attrs);
4026 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
4027 #define SELECTED_ONE_OPTION
4028 child_id = _beginthread(
4029 (void (*)(void *))serve,
4034 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
4035 #define SELECTED_ONE_OPTION
4036 child_id = _beginthread(
4037 (void(* _Optlink)(void*))serve,
4043 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
4044 #define SELECTED_ONE_OPTION
4046 thread_id tid = spawn_thread
4047 (server_thread, "server", B_NORMAL_PRIORITY, csp);
4049 if ((tid >= 0) && (resume_thread(tid) == B_OK))
4051 child_id = (int) tid;
4060 #if defined(AMIGA) && !defined(SELECTED_ONE_OPTION)
4061 #define SELECTED_ONE_OPTION
4062 csp->cfd = ReleaseSocket(csp->cfd, -1);
4065 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
4066 NP_Output, Output(),
4067 NP_CloseOutput, FALSE,
4068 NP_Name, (ULONG)"privoxy child",
4072 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
4073 NP_Output, Output(),
4074 NP_CloseOutput, FALSE,
4075 NP_Name, (ULONG)"privoxy child",
4076 NP_StackSize, 200*1024,
4082 ((struct Task *)child_id)->tc_UserData = csp;
4083 Signal((struct Task *)child_id, SIGF_SINGLE);
4088 #if !defined(SELECTED_ONE_OPTION)
4091 /* This block is only needed when using fork().
4092 * When using threads, the server thread was
4093 * created and run by the call to _beginthread().
4095 if (child_id == 0) /* child */
4098 #ifdef FEATURE_TOGGLE
4099 int inherited_toggle_state = global_toggle_state;
4100 #endif /* def FEATURE_TOGGLE */
4105 * If we've been toggled or we've blocked the request, tell Mom
4108 #ifdef FEATURE_TOGGLE
4109 if (inherited_toggle_state != global_toggle_state)
4111 rc |= RC_FLAG_TOGGLED;
4113 #endif /* def FEATURE_TOGGLE */
4115 #ifdef FEATURE_STATISTICS
4116 if (csp->flags & CSP_FLAG_REJECTED)
4118 rc |= RC_FLAG_BLOCKED;
4120 #endif /* ndef FEATURE_STATISTICS */
4124 else if (child_id > 0) /* parent */
4126 /* in a fork()'d environment, the parent's
4127 * copy of the client socket and the CSP
4131 #if !defined(_WIN32) && !defined(__CYGWIN__)
4133 wait(&child_status);
4136 * Evaluate child's return code: If the child has
4137 * - been toggled, toggle ourselves
4138 * - blocked its request, bump up the stats counter
4141 #ifdef FEATURE_TOGGLE
4142 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
4144 global_toggle_state = !global_toggle_state;
4146 #endif /* def FEATURE_TOGGLE */
4148 #ifdef FEATURE_STATISTICS
4150 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
4154 #endif /* def FEATURE_STATISTICS */
4156 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
4157 close_socket(csp->cfd);
4158 csp->flags &= ~CSP_FLAG_ACTIVE;
4162 #undef SELECTED_ONE_OPTION
4163 /* end of cpp switch () */
4168 * Spawning the child failed, assume it's because
4169 * there are too many children running already.
4170 * XXX: If you assume ...
4172 log_error(LOG_LEVEL_ERROR,
4173 "Unable to take any additional connections: %E");
4174 write_socket(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
4175 strlen(TOO_MANY_CONNECTIONS_RESPONSE));
4176 close_socket(csp->cfd);
4177 csp->flags &= ~CSP_FLAG_ACTIVE;
4186 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
4188 /* Clean up. Aim: free all memory (no leaks) */
4189 #ifdef FEATURE_GRACEFUL_TERMINATION
4191 log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
4193 unload_current_config_file();
4194 unload_current_actions_file();
4195 unload_current_re_filterfile();
4196 #ifdef FEATURE_TRUST
4197 unload_current_trust_file();
4200 if (config->multi_threaded)
4207 } while ((clients->next != NULL) && (--i > 0));
4211 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
4221 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
4222 /* Cleanup - remove taskbar icon etc. */
4227 #endif /* FEATURE_GRACEFUL_TERMINATION */