1 const char jcc_rcs[] = "$Id: jcc.c,v 1.418 2012/12/07 12:43:05 fabiankeil Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/jcc.c,v $
6 * Purpose : Main file. Contains main() method, main loop, and
7 * the main connection-handling function.
9 * Copyright : Written by and Copyright (C) 2001-2012 the
10 * Privoxy team. http://www.privoxy.org/
12 * Based on the Internet Junkbuster originally written
13 * by and Copyright (C) 1997 Anonymous Coders and
14 * Junkbusters Corporation. http://www.junkbusters.com
16 * This program is free software; you can redistribute it
17 * and/or modify it under the terms of the GNU General
18 * Public License as published by the Free Software
19 * Foundation; either version 2 of the License, or (at
20 * your option) any later version.
22 * This program is distributed in the hope that it will
23 * be useful, but WITHOUT ANY WARRANTY; without even the
24 * implied warranty of MERCHANTABILITY or FITNESS FOR A
25 * PARTICULAR PURPOSE. See the GNU General Public
26 * License for more details.
28 * The GNU General Public License should be included with
29 * this file. If not, you can view it at
30 * http://www.gnu.org/copyleft/gpl.html
31 * or write to the Free Software Foundation, Inc., 59
32 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
34 *********************************************************************/
40 #include <sys/types.h>
49 # ifndef FEATURE_PTHREAD
55 # endif /* ndef FEATURE_PTHREAD */
60 # endif /* ndef _WIN_CONSOLE */
61 # include "w32svrapi.h"
63 #else /* ifndef _WIN32 */
65 # if !defined (__OS2__)
67 # include <sys/wait.h>
68 # endif /* ndef __OS2__ */
69 # include <sys/time.h>
70 # include <sys/stat.h>
71 # include <sys/ioctl.h>
74 #include <sys/termios.h>
85 # include <socket.h> /* BeOS has select() for sockets only. */
86 # include <OS.h> /* declarations for threads and stuff. */
89 # if defined(__EMX__) || defined(__OS2__)
90 # include <sys/select.h> /* OS/2/EMX needs a little help with select */
95 #define bzero(B,N) memset(B,0x00,n)
110 #include "miscutil.h"
112 #include "jbsockets.h"
117 #include "urlmatch.h"
119 const char jcc_h_rcs[] = JCC_H_VERSION;
120 const char project_h_rcs[] = PROJECT_H_VERSION;
123 struct client_states clients[1];
124 struct file_list files[1];
126 #ifdef FEATURE_STATISTICS
127 int urls_read = 0; /* total nr of urls read inc rejected */
128 int urls_rejected = 0; /* total nr of urls rejected */
129 #endif /* def FEATURE_STATISTICS */
131 #ifdef FEATURE_GRACEFUL_TERMINATION
135 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
136 static void sig_handler(int the_signal);
138 static int client_protocol_is_unsupported(const struct client_state *csp, char *req);
139 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers);
140 static jb_err get_server_headers(struct client_state *csp);
141 static const char *crunch_reason(const struct http_response *rsp);
142 static void send_crunch_response(const struct client_state *csp, struct http_response *rsp);
143 static char *get_request_line(struct client_state *csp);
144 static jb_err receive_client_request(struct client_state *csp);
145 static jb_err parse_client_request(struct client_state *csp);
146 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line);
147 static jb_err change_request_destination(struct client_state *csp);
148 static void chat(struct client_state *csp);
149 static void serve(struct client_state *csp);
150 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
151 static void usage(const char *myname);
153 static void initialize_mutexes(void);
154 static jb_socket bind_port_helper(const char *haddr, int hport);
155 static void bind_ports_helper(struct configuration_spec *config, jb_socket sockets[]);
156 static void close_ports_helper(jb_socket sockets[]);
157 static void listen_loop(void);
160 void serve(struct client_state *csp);
161 #else /* ifndef AMIGA */
162 static void serve(struct client_state *csp);
163 #endif /* def AMIGA */
166 static int32 server_thread(void *data);
167 #endif /* def __BEOS__ */
170 #define sleep(N) Sleep(((N) * 1000))
174 #define sleep(N) DosSleep(((N) * 100))
177 #ifdef MUTEX_LOCKS_AVAILABLE
179 * XXX: Does the locking stuff really belong in this file?
181 privoxy_mutex_t log_mutex;
182 privoxy_mutex_t log_init_mutex;
183 privoxy_mutex_t connection_reuse_mutex;
185 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
186 privoxy_mutex_t resolver_mutex;
187 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
189 #ifndef HAVE_GMTIME_R
190 privoxy_mutex_t gmtime_mutex;
191 #endif /* ndef HAVE_GMTIME_R */
193 #ifndef HAVE_LOCALTIME_R
194 privoxy_mutex_t localtime_mutex;
195 #endif /* ndef HAVE_GMTIME_R */
198 privoxy_mutex_t rand_mutex;
199 #endif /* ndef HAVE_RANDOM */
201 #endif /* def MUTEX_LOCKS_AVAILABLE */
204 const char *basedir = NULL;
205 const char *pidfile = NULL;
206 static int received_hup_signal = 0;
207 #endif /* defined unix */
209 /* HTTP snipplets. */
210 static const char CSUCCEED[] =
211 "HTTP/1.1 200 Connection established\r\n"
212 "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
214 static const char CHEADER[] =
215 "HTTP/1.1 400 Invalid header received from client\r\n"
216 "Proxy-Agent: Privoxy " VERSION "\r\n"
217 "Content-Type: text/plain\r\n"
218 "Connection: close\r\n\r\n"
219 "Invalid header received from client.\r\n";
221 static const char FTP_RESPONSE[] =
222 "HTTP/1.1 400 Invalid request received from client\r\n"
223 "Content-Type: text/plain\r\n"
224 "Connection: close\r\n\r\n"
225 "Invalid request. Privoxy doesn't support FTP.\r\n";
227 static const char GOPHER_RESPONSE[] =
228 "HTTP/1.1 400 Invalid request received from client\r\n"
229 "Content-Type: text/plain\r\n"
230 "Connection: close\r\n\r\n"
231 "Invalid request. Privoxy doesn't support gopher.\r\n";
233 /* XXX: should be a template */
234 static const char MISSING_DESTINATION_RESPONSE[] =
235 "HTTP/1.1 400 Bad request received from client\r\n"
236 "Proxy-Agent: Privoxy " VERSION "\r\n"
237 "Content-Type: text/plain\r\n"
238 "Connection: close\r\n\r\n"
239 "Bad request. Privoxy was unable to extract the destination.\r\n";
241 /* XXX: should be a template */
242 static const char INVALID_SERVER_HEADERS_RESPONSE[] =
243 "HTTP/1.1 502 Server or forwarder response invalid\r\n"
244 "Proxy-Agent: Privoxy " VERSION "\r\n"
245 "Content-Type: text/plain\r\n"
246 "Connection: close\r\n\r\n"
247 "Bad response. The server or forwarder response doesn't look like HTTP.\r\n";
249 /* XXX: should be a template */
250 static const char MESSED_UP_REQUEST_RESPONSE[] =
251 "HTTP/1.1 400 Malformed request after rewriting\r\n"
252 "Proxy-Agent: Privoxy " VERSION "\r\n"
253 "Content-Type: text/plain\r\n"
254 "Connection: close\r\n\r\n"
255 "Bad request. Messed up with header filters.\r\n";
257 static const char TOO_MANY_CONNECTIONS_RESPONSE[] =
258 "HTTP/1.1 503 Too many open connections\r\n"
259 "Proxy-Agent: Privoxy " VERSION "\r\n"
260 "Content-Type: text/plain\r\n"
261 "Connection: close\r\n\r\n"
262 "Maximum number of open connections reached.\r\n";
264 static const char CLIENT_CONNECTION_TIMEOUT_RESPONSE[] =
265 "HTTP/1.1 504 Connection timeout\r\n"
266 "Proxy-Agent: Privoxy " VERSION "\r\n"
267 "Content-Type: text/plain\r\n"
268 "Connection: close\r\n\r\n"
269 "The connection timed out because the client request didn't arrive in time.\r\n";
271 static const char CLIENT_BODY_PARSE_ERROR_RESPONSE[] =
272 "HTTP/1.1 400 Failed reading client body\r\n"
273 "Proxy-Agent: Privoxy " VERSION "\r\n"
274 "Content-Type: text/plain\r\n"
275 "Connection: close\r\n\r\n"
276 "Failed parsing or buffering the chunk-encoded client body.\r\n";
278 /* A function to crunch a response */
279 typedef struct http_response *(*crunch_func_ptr)(struct client_state *);
281 /* Crunch function flags */
282 #define CF_NO_FLAGS 0
283 /* Cruncher applies to forced requests as well */
284 #define CF_IGNORE_FORCE 1
285 /* Crunched requests are counted for the block statistics */
286 #define CF_COUNT_AS_REJECT 2
288 /* A crunch function and its flags */
291 const crunch_func_ptr cruncher;
295 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[]);
297 /* Complete list of cruncher functions */
298 static const struct cruncher crunchers_all[] = {
299 { direct_response, CF_COUNT_AS_REJECT|CF_IGNORE_FORCE},
300 { block_url, CF_COUNT_AS_REJECT },
302 { trust_url, CF_COUNT_AS_REJECT },
303 #endif /* def FEATURE_TRUST */
304 { redirect_url, CF_NO_FLAGS },
305 { dispatch_cgi, CF_IGNORE_FORCE},
309 /* Light version, used after tags are applied */
310 static const struct cruncher crunchers_light[] = {
311 { block_url, CF_COUNT_AS_REJECT },
312 { redirect_url, CF_NO_FLAGS },
318 * XXX: Don't we really mean
324 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
325 /*********************************************************************
327 * Function : sig_handler
329 * Description : Signal handler for different signals.
330 * Exit gracefully on TERM and INT
331 * or set a flag that will cause the errlog
332 * to be reopened by the main thread on HUP.
335 * 1 : the_signal = the signal cause this function to call
339 *********************************************************************/
340 static void sig_handler(int the_signal)
346 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
358 received_hup_signal = 1;
364 * We shouldn't be here, unless we catch signals
365 * in main() that we can't handle here!
367 log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
375 /*********************************************************************
377 * Function : client_protocol_is_unsupported
379 * Description : Checks if the client used a known unsupported
380 * protocol and deals with it by sending an error
384 * 1 : csp = Current client state (buffers, headers, etc...)
385 * 2 : req = the first request line send by the client
387 * Returns : TRUE if an error response has been generated, or
388 * FALSE if the request doesn't look invalid.
390 *********************************************************************/
391 static int client_protocol_is_unsupported(const struct client_state *csp, char *req)
394 * If it's a FTP or gopher request, we don't support it.
396 * These checks are better than nothing, but they might
397 * not work in all configurations and some clients might
398 * have problems digesting the answer.
400 * They should, however, never cause more problems than
401 * Privoxy's old behaviour (returning the misleading HTML
404 * "Could not resolve http://(ftp|gopher)://example.org").
406 if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
408 const char *response = NULL;
409 const char *protocol = NULL;
411 if (!strncmpic(req, "GET ftp://", 10))
413 response = FTP_RESPONSE;
418 response = GOPHER_RESPONSE;
421 log_error(LOG_LEVEL_ERROR,
422 "%s tried to use Privoxy as %s proxy: %s",
423 csp->ip_addr_str, protocol, req);
424 log_error(LOG_LEVEL_CLF,
425 "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, req);
427 write_socket(csp->cfd, response, strlen(response));
436 /*********************************************************************
438 * Function : get_request_destination_elsewhere
440 * Description : If the client's request was redirected into
441 * Privoxy without the client's knowledge,
442 * the request line lacks the destination host.
444 * This function tries to get it elsewhere,
445 * provided accept-intercepted-requests is enabled.
447 * "Elsewhere" currently only means "Host: header",
448 * but in the future we may ask the redirecting
449 * packet filter to look the destination up.
451 * If the destination stays unknown, an error
452 * response is send to the client and headers
453 * are freed so that chat() can return directly.
456 * 1 : csp = Current client state (buffers, headers, etc...)
457 * 2 : headers = a header list
459 * Returns : JB_ERR_OK if the destination is now known, or
460 * JB_ERR_PARSE if it isn't.
462 *********************************************************************/
463 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
467 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
469 log_error(LOG_LEVEL_ERROR, "%s's request: \'%s\' is invalid."
470 " Privoxy isn't configured to accept intercepted requests.",
471 csp->ip_addr_str, csp->http->cmd);
472 /* XXX: Use correct size */
473 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
474 csp->ip_addr_str, csp->http->cmd);
476 write_socket(csp->cfd, CHEADER, strlen(CHEADER));
477 destroy_list(headers);
481 else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
483 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
484 /* Split the domain we just got for pattern matching */
485 init_domain_components(csp->http);
492 /* We can't work without destination. Go spread the news.*/
494 req = list_to_text(headers);
496 /* XXX: Use correct size */
497 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
498 csp->ip_addr_str, csp->http->cmd);
499 log_error(LOG_LEVEL_ERROR,
500 "Privoxy was unable to get the destination for %s's request:\n%s\n%s",
501 csp->ip_addr_str, csp->http->cmd, req);
504 write_socket(csp->cfd, MISSING_DESTINATION_RESPONSE, strlen(MISSING_DESTINATION_RESPONSE));
505 destroy_list(headers);
510 * TODO: If available, use PF's ioctl DIOCNATLOOK as last resort
511 * to get the destination IP address, use it as host directly
512 * or do a reverse DNS lookup first.
517 /*********************************************************************
519 * Function : get_server_headers
521 * Description : Parses server headers in iob and fills them
522 * into csp->headers so that they can later be
526 * 1 : csp = Current client state (buffers, headers, etc...)
528 * Returns : JB_ERR_OK if everything went fine, or
529 * JB_ERR_PARSE if the headers were incomplete.
531 *********************************************************************/
532 static jb_err get_server_headers(struct client_state *csp)
534 int continue_hack_in_da_house = 0;
537 while (((header = get_header(csp->iob)) != NULL) || continue_hack_in_da_house)
542 * continue hack in da house. Ignore the ending of
543 * this head and continue enlisting header lines.
544 * The reason is described below.
546 enlist(csp->headers, "");
547 continue_hack_in_da_house = 0;
550 else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
553 * It's a bodyless continue response, don't
554 * stop header parsing after reaching its end.
556 * As a result Privoxy will concatenate the
557 * next response's head and parse and deliver
558 * the headers as if they belonged to one request.
560 * The client will separate them because of the
561 * empty line between them.
563 * XXX: What we're doing here is clearly against
564 * the intended purpose of the continue header,
565 * and under some conditions (HTTP/1.0 client request)
566 * it's a standard violation.
568 * Anyway, "sort of against the spec" is preferable
569 * to "always getting confused by Continue responses"
570 * (Privoxy's behaviour before this hack was added)
572 log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
573 continue_hack_in_da_house = 1;
575 else if (*header == '\0')
578 * If the header is empty, but the Continue hack
579 * isn't active, we can assume that we reached the
580 * end of the buffer before we hit the end of the
583 * Inform the caller an let it decide how to handle it.
588 if (JB_ERR_MEMORY == enlist(csp->headers, header))
591 * XXX: Should we quit the request and return a
592 * out of memory error page instead?
594 log_error(LOG_LEVEL_ERROR,
595 "Out of memory while enlisting server headers. %s lost.",
605 /*********************************************************************
607 * Function : crunch_reason
609 * Description : Translates the crunch reason code into a string.
612 * 1 : rsp = a http_response
614 * Returns : A string with the crunch reason or an error description.
616 *********************************************************************/
617 static const char *crunch_reason(const struct http_response *rsp)
619 char * reason = NULL;
624 return "Internal error while searching for crunch reason";
627 switch (rsp->crunch_reason)
630 reason = "Unsupported HTTP feature";
636 reason = "Untrusted";
639 reason = "Redirected";
645 reason = "DNS failure";
647 case FORWARDING_FAILED:
648 reason = "Forwarding failed";
651 reason = "Connection failure";
654 reason = "Out of memory (may mask other reasons)";
656 case CONNECTION_TIMEOUT:
657 reason = "Connection timeout";
660 reason = "No server data received";
663 reason = "No reason recorded";
671 /*********************************************************************
673 * Function : log_applied_actions
675 * Description : Logs the applied actions if LOG_LEVEL_ACTIONS is
679 * 1 : actions = Current action spec to log
683 *********************************************************************/
684 static void log_applied_actions(const struct current_action_spec *actions)
687 * The conversion to text requires lots of memory allocations so
688 * we only do the conversion if the user is actually interested.
690 if (debug_level_is_enabled(LOG_LEVEL_ACTIONS))
692 char *actions_as_text = actions_to_line_of_text(actions);
693 log_error(LOG_LEVEL_ACTIONS, "%s", actions_as_text);
694 freez(actions_as_text);
699 /*********************************************************************
701 * Function : send_crunch_response
703 * Description : Delivers already prepared response for
704 * intercepted requests, logs the interception
705 * and frees the response.
708 * 1 : csp = Current client state (buffers, headers, etc...)
709 * 1 : rsp = Fully prepared response. Will be freed on exit.
713 *********************************************************************/
714 static void send_crunch_response(const struct client_state *csp, struct http_response *rsp)
716 const struct http_request *http = csp->http;
720 assert(rsp->head != NULL);
724 log_error(LOG_LEVEL_FATAL, "NULL response in send_crunch_response.");
728 * Extract the status code from the actual head
729 * that will be send to the client. It is the only
730 * way to get it right for all requests, including
731 * the fixed ones for out-of-memory problems.
733 * A head starts like this: 'HTTP/1.1 200...'
737 status_code[0] = rsp->head[9];
738 status_code[1] = rsp->head[10];
739 status_code[2] = rsp->head[11];
740 status_code[3] = '\0';
742 /* Log that the request was crunched and why. */
743 log_applied_actions(csp->action);
744 log_error(LOG_LEVEL_CRUNCH, "%s: %s", crunch_reason(rsp), http->url);
745 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" %s %u",
746 csp->ip_addr_str, http->ocmd, status_code, rsp->content_length);
748 /* Write the answer to the client */
749 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
750 || write_socket(csp->cfd, rsp->body, rsp->content_length))
752 /* There is nothing we can do about it. */
753 log_error(LOG_LEVEL_ERROR,
754 "Couldn't deliver the error message through client socket %d: %E",
758 /* Clean up and return */
759 if (cgi_error_memory() != rsp)
761 free_http_response(rsp);
767 /*********************************************************************
769 * Function : crunch_response_triggered
771 * Description : Checks if the request has to be crunched,
772 * and delivers the crunch response if necessary.
775 * 1 : csp = Current client state (buffers, headers, etc...)
776 * 2 : crunchers = list of cruncher functions to run
778 * Returns : TRUE if the request was answered with a crunch response
781 *********************************************************************/
782 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[])
784 struct http_response *rsp = NULL;
785 const struct cruncher *c;
788 * If CGI request crunching is disabled,
789 * check the CGI dispatcher out of order to
790 * prevent unintentional blocks or redirects.
792 if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_CRUNCHING)
793 && (NULL != (rsp = dispatch_cgi(csp))))
795 /* Deliver, log and free the interception response. */
796 send_crunch_response(csp, rsp);
797 csp->flags |= CSP_FLAG_CRUNCHED;
801 for (c = crunchers; c->cruncher != NULL; c++)
804 * Check the cruncher if either Privoxy is toggled
805 * on and the request isn't forced, or if the cruncher
806 * applies to forced requests as well.
808 if (((csp->flags & CSP_FLAG_TOGGLED_ON) &&
809 !(csp->flags & CSP_FLAG_FORCED)) ||
810 (c->flags & CF_IGNORE_FORCE))
812 rsp = c->cruncher(csp);
815 /* Deliver, log and free the interception response. */
816 send_crunch_response(csp, rsp);
817 csp->flags |= CSP_FLAG_CRUNCHED;
818 #ifdef FEATURE_STATISTICS
819 if (c->flags & CF_COUNT_AS_REJECT)
821 csp->flags |= CSP_FLAG_REJECTED;
823 #endif /* def FEATURE_STATISTICS */
834 /*********************************************************************
836 * Function : build_request_line
838 * Description : Builds the HTTP request line.
840 * If a HTTP forwarder is used it expects the whole URL,
841 * web servers only get the path.
844 * 1 : csp = Current client state (buffers, headers, etc...)
845 * 2 : fwd = The forwarding spec used for the request
846 * XXX: Should use http->fwd instead.
847 * 3 : request_line = The old request line which will be replaced.
849 * Returns : Nothing. Terminates in case of memory problems.
851 *********************************************************************/
852 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line)
854 struct http_request *http = csp->http;
856 assert(http->ssl == 0);
859 * Downgrade http version from 1.1 to 1.0
860 * if +downgrade action applies.
862 if ((csp->action->flags & ACTION_DOWNGRADE)
863 && (!strcmpic(http->ver, "HTTP/1.1")))
866 http->ver = strdup_or_die("HTTP/1.0");
870 * Rebuild the request line.
872 freez(*request_line);
873 *request_line = strdup(http->gpc);
874 string_append(request_line, " ");
876 if (fwd->forward_host)
878 string_append(request_line, http->url);
882 string_append(request_line, http->path);
884 string_append(request_line, " ");
885 string_append(request_line, http->ver);
887 if (*request_line == NULL)
889 log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
891 log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", *request_line);
895 /*********************************************************************
897 * Function : change_request_destination
899 * Description : Parse a (rewritten) request line and regenerate
900 * the http request data.
903 * 1 : csp = Current client state (buffers, headers, etc...)
905 * Returns : Forwards the parse_http_request() return code.
906 * Terminates in case of memory problems.
908 *********************************************************************/
909 static jb_err change_request_destination(struct client_state *csp)
911 struct http_request *http = csp->http;
914 log_error(LOG_LEVEL_INFO, "Rewrite detected: %s", csp->headers->first->str);
915 free_http_request(http);
916 err = parse_http_request(csp->headers->first->str, http);
917 if (JB_ERR_OK != err)
919 log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
920 jb_err_to_string(err));
924 /* XXX: ocmd is a misleading name */
925 http->ocmd = strdup_or_die(http->cmd);
932 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
933 /*********************************************************************
935 * Function : server_response_is_complete
937 * Description : Determines whether we should stop reading
938 * from the server socket.
941 * 1 : csp = Current client state (buffers, headers, etc...)
942 * 2 : content_length = Length of content received so far.
944 * Returns : TRUE if the response is complete,
947 *********************************************************************/
948 static int server_response_is_complete(struct client_state *csp,
949 unsigned long long content_length)
951 int content_length_known = !!(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET);
953 if (!strcmpic(csp->http->gpc, "HEAD"))
956 * "HEAD" implies no body, we are thus expecting
957 * no content. XXX: incomplete "list" of methods?
959 csp->expected_content_length = 0;
960 content_length_known = TRUE;
961 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
964 if (csp->http->status == 204 || csp->http->status == 304)
967 * Expect no body. XXX: incomplete "list" of status codes?
969 csp->expected_content_length = 0;
970 content_length_known = TRUE;
971 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
974 return (content_length_known && ((0 == csp->expected_content_length)
975 || (csp->expected_content_length <= content_length)));
979 #ifdef FEATURE_CONNECTION_SHARING
980 /*********************************************************************
982 * Function : wait_for_alive_connections
984 * Description : Waits for alive connections to timeout.
990 *********************************************************************/
991 static void wait_for_alive_connections(void)
993 int connections_alive = close_unusable_connections();
995 while (0 < connections_alive)
997 log_error(LOG_LEVEL_CONNECT,
998 "Waiting for %d connections to timeout.",
1001 connections_alive = close_unusable_connections();
1004 log_error(LOG_LEVEL_CONNECT, "No connections to wait for left.");
1007 #endif /* def FEATURE_CONNECTION_SHARING */
1010 /*********************************************************************
1012 * Function : save_connection_destination
1014 * Description : Remembers a connection for reuse later on.
1017 * 1 : sfd = Open socket to remember.
1018 * 2 : http = The destination for the connection.
1019 * 3 : fwd = The forwarder settings used.
1020 * 3 : server_connection = storage.
1024 *********************************************************************/
1025 void save_connection_destination(jb_socket sfd,
1026 const struct http_request *http,
1027 const struct forward_spec *fwd,
1028 struct reusable_connection *server_connection)
1030 assert(sfd != JB_INVALID_SOCKET);
1031 assert(NULL != http->host);
1033 server_connection->sfd = sfd;
1034 server_connection->host = strdup_or_die(http->host);
1035 server_connection->port = http->port;
1037 assert(NULL != fwd);
1038 assert(server_connection->gateway_host == NULL);
1039 assert(server_connection->gateway_port == 0);
1040 assert(server_connection->forwarder_type == 0);
1041 assert(server_connection->forward_host == NULL);
1042 assert(server_connection->forward_port == 0);
1044 server_connection->forwarder_type = fwd->type;
1045 if (NULL != fwd->gateway_host)
1047 server_connection->gateway_host = strdup_or_die(fwd->gateway_host);
1051 server_connection->gateway_host = NULL;
1053 server_connection->gateway_port = fwd->gateway_port;
1055 if (NULL != fwd->forward_host)
1057 server_connection->forward_host = strdup_or_die(fwd->forward_host);
1061 server_connection->forward_host = NULL;
1063 server_connection->forward_port = fwd->forward_port;
1067 /*********************************************************************
1069 * Function : verify_request_length
1071 * Description : Checks if we already got the whole client requests
1072 * and sets CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ if
1075 * Data that doesn't belong to the current request is
1076 * either thrown away to let the client retry on a clean
1077 * socket, or stashed to be dealt with after the current
1078 * request is served.
1081 * 1 : csp = Current client state (buffers, headers, etc...)
1085 *********************************************************************/
1086 static void verify_request_length(struct client_state *csp)
1088 unsigned long long buffered_request_bytes =
1089 (unsigned long long)(csp->client_iob->eod - csp->client_iob->cur);
1091 if ((csp->expected_client_content_length != 0)
1092 && (buffered_request_bytes != 0))
1094 if (csp->expected_client_content_length >= buffered_request_bytes)
1096 csp->expected_client_content_length -= buffered_request_bytes;
1097 log_error(LOG_LEVEL_CONNECT, "Reduced expected bytes to %llu "
1098 "to account for the %llu ones we already got.",
1099 csp->expected_client_content_length, buffered_request_bytes);
1103 assert(csp->client_iob->eod > csp->client_iob->cur + csp->expected_client_content_length);
1104 csp->client_iob->eod = csp->client_iob->cur + csp->expected_client_content_length;
1105 log_error(LOG_LEVEL_CONNECT, "Reducing expected bytes to 0. "
1106 "Marking the server socket tainted after throwing %llu bytes away.",
1107 buffered_request_bytes - csp->expected_client_content_length);
1108 csp->expected_client_content_length = 0;
1109 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1112 if (csp->expected_client_content_length == 0)
1114 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1118 if (!(csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ)
1119 && ((csp->client_iob->cur < csp->client_iob->eod)
1120 || (csp->expected_client_content_length != 0)))
1122 if (strcmpic(csp->http->gpc, "GET")
1123 && strcmpic(csp->http->gpc, "HEAD")
1124 && strcmpic(csp->http->gpc, "TRACE")
1125 && strcmpic(csp->http->gpc, "OPTIONS")
1126 && strcmpic(csp->http->gpc, "DELETE"))
1128 /* XXX: this is an incomplete hack */
1129 csp->flags &= ~CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1130 log_error(LOG_LEVEL_CONNECT, "There better be a request body.");
1134 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1136 if ((csp->config->feature_flags & RUNTIME_FEATURE_TOLERATE_PIPELINING) == 0)
1138 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1139 log_error(LOG_LEVEL_CONNECT,
1140 "Possible pipeline attempt detected. The connection will not "
1141 "be kept alive and we will only serve the first request.");
1142 /* Nuke the pipelined requests from orbit, just to be sure. */
1143 clear_iob(csp->client_iob);
1148 * Keep the pipelined data around for now, we'll deal with
1149 * it once we're done serving the current request.
1151 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
1152 assert(csp->client_iob->eod >= csp->client_iob->cur);
1153 log_error(LOG_LEVEL_CONNECT, "Complete client request followed by "
1154 "%d bytes of pipelined data received.",
1155 (int)(csp->client_iob->eod - csp->client_iob->cur));
1161 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1162 log_error(LOG_LEVEL_CONNECT, "Complete client request received.");
1165 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1168 /*********************************************************************
1170 * Function : mark_server_socket_tainted
1172 * Description : Makes sure we don't reuse a server socket
1173 * (if we didn't read everything the server sent
1174 * us reusing the socket would lead to garbage).
1177 * 1 : csp = Current client state (buffers, headers, etc...)
1181 *********************************************************************/
1182 static void mark_server_socket_tainted(struct client_state *csp)
1185 * For consistency we always mark the server socket
1186 * tainted, however, to reduce the log noise we only
1187 * emit a log message if the server socket could have
1188 * actually been reused.
1190 if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
1191 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED))
1193 log_error(LOG_LEVEL_CONNECT,
1194 "Marking the server socket %d tainted.",
1195 csp->server_connection.sfd);
1197 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1200 /*********************************************************************
1202 * Function : get_request_line
1204 * Description : Read the client request line.
1207 * 1 : csp = Current client state (buffers, headers, etc...)
1209 * Returns : Pointer to request line or NULL in case of errors.
1211 *********************************************************************/
1212 static char *get_request_line(struct client_state *csp)
1214 char buf[BUFFER_SIZE];
1215 char *request_line = NULL;
1218 memset(buf, 0, sizeof(buf));
1220 if ((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
1223 * If there are multiple pipelined requests waiting,
1224 * the flag will be set again once the next request
1227 csp->flags &= ~CSP_FLAG_PIPELINED_REQUEST_WAITING;
1229 request_line = get_header(csp->client_iob);
1230 if ((NULL != request_line) && ('\0' != *request_line))
1232 return request_line;
1236 log_error(LOG_LEVEL_CONNECT, "No complete request line "
1237 "received yet. Continuing reading from %d.", csp->cfd);
1243 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1245 if (socket_is_still_alive(csp->cfd))
1247 log_error(LOG_LEVEL_CONNECT,
1248 "No request line on socket %d received in time. Timeout: %d.",
1249 csp->cfd, csp->config->socket_timeout);
1250 write_socket(csp->cfd, CLIENT_CONNECTION_TIMEOUT_RESPONSE,
1251 strlen(CLIENT_CONNECTION_TIMEOUT_RESPONSE));
1255 log_error(LOG_LEVEL_CONNECT,
1256 "The client side of the connection on socket %d got "
1257 "closed without sending a complete request line.", csp->cfd);
1262 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1264 if (len <= 0) return NULL;
1267 * If there is no memory left for buffering the
1268 * request, there is nothing we can do but hang up
1270 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1275 request_line = get_header(csp->client_iob);
1277 } while ((NULL != request_line) && ('\0' == *request_line));
1279 return request_line;
1285 CHUNK_STATUS_MISSING_DATA,
1286 CHUNK_STATUS_BODY_COMPLETE,
1287 CHUNK_STATUS_PARSE_ERROR
1291 /*********************************************************************
1293 * Function : chunked_body_is_complete
1295 * Description : Figures out wheter or not a chunked body is complete.
1297 * Currently it always starts at the beginning of the
1298 * buffer which is somewhat wasteful and prevents Privoxy
1299 * from starting to forward the correctly parsed chunks
1300 * as soon as theoretically possible.
1302 * Should be modified to work with a common buffer,
1303 * and allow the caller to skip already parsed chunks.
1305 * This would allow the function to be used for unbuffered
1306 * response bodies as well.
1309 * 1 : iob = Buffer with the body to check.
1310 * 2 : length = Length of complete body
1312 * Returns : Enum with the result of the check.
1314 *********************************************************************/
1315 static enum chunk_status chunked_body_is_complete(struct iob *iob, size_t *length)
1317 unsigned int chunksize;
1323 * We need at least a single digit, followed by "\r\n",
1324 * followed by an unknown amount of data, followed by "\r\n".
1326 if (p + 5 > iob->eod)
1328 return CHUNK_STATUS_MISSING_DATA;
1330 if (sscanf(p, "%x", &chunksize) != 1)
1332 return CHUNK_STATUS_PARSE_ERROR;
1336 * We want at least a single digit, followed by "\r\n",
1337 * followed by the specified amount of data, followed by "\r\n".
1339 if (p + chunksize + 5 > iob->eod)
1341 return CHUNK_STATUS_MISSING_DATA;
1344 /* Skip chunk-size. */
1345 p = strstr(p, "\r\n");
1348 return CHUNK_STATUS_PARSE_ERROR;
1351 * Skip "\r\n", the chunk data and another "\r\n".
1352 * Moving p to either the beginning of the next chunk-size
1353 * or one byte beyond the end of the chunked data.
1355 p += 2 + chunksize + 2;
1356 } while (chunksize > 0U);
1358 *length = (size_t)(p - iob->cur);
1359 assert(*length <= (size_t)(iob->eod - iob->cur));
1360 assert(p <= iob->eod);
1362 return CHUNK_STATUS_BODY_COMPLETE;
1367 /*********************************************************************
1369 * Function : receive_chunked_client_request_body
1371 * Description : Read the chunk-encoded client request body.
1372 * Failures are dealt with.
1375 * 1 : csp = Current client state (buffers, headers, etc...)
1377 * Returns : JB_ERR_OK or JB_ERR_PARSE
1379 *********************************************************************/
1380 static jb_err receive_chunked_client_request_body(struct client_state *csp)
1383 enum chunk_status status;
1385 while (CHUNK_STATUS_MISSING_DATA ==
1386 (status = chunked_body_is_complete(csp->client_iob,&body_length)))
1388 char buf[BUFFER_SIZE];
1391 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1393 log_error(LOG_LEVEL_ERROR,
1394 "Timeout while waiting for the client body.");
1397 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1400 log_error(LOG_LEVEL_ERROR, "Read the client body failed: %E");
1403 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1408 if (status != CHUNK_STATUS_BODY_COMPLETE)
1410 write_socket(csp->cfd, CLIENT_BODY_PARSE_ERROR_RESPONSE,
1411 strlen(CLIENT_BODY_PARSE_ERROR_RESPONSE));
1412 log_error(LOG_LEVEL_CLF,
1413 "%s - - [%T] \"Failed reading chunked client body\" 400 0", csp->ip_addr_str);
1414 return JB_ERR_PARSE;
1416 log_error(LOG_LEVEL_CONNECT,
1417 "Chunked client body completely read. Length: %d", body_length);
1418 csp->expected_client_content_length = body_length;
1424 /*********************************************************************
1426 * Function : receive_client_request
1428 * Description : Read the client's request (more precisely the
1429 * client headers) and answer it if necessary.
1432 * 1 : csp = Current client state (buffers, headers, etc...)
1434 * Returns : JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
1436 *********************************************************************/
1437 static jb_err receive_client_request(struct client_state *csp)
1439 char buf[BUFFER_SIZE];
1442 struct http_request *http;
1446 /* Temporary copy of the client's headers before they get enlisted in csp->headers */
1447 struct list header_list;
1448 struct list *headers = &header_list;
1450 /* We don't care if the arriving data is a valid HTTP request or not. */
1451 csp->requests_received_total++;
1455 memset(buf, 0, sizeof(buf));
1457 req = get_request_line(csp);
1460 mark_server_socket_tainted(csp);
1461 return JB_ERR_PARSE;
1463 assert(*req != '\0');
1465 if (client_protocol_is_unsupported(csp, req))
1467 return JB_ERR_PARSE;
1470 #ifdef FEATURE_FORCE_LOAD
1472 * If this request contains the FORCE_PREFIX and blocks
1473 * aren't enforced, get rid of it and set the force flag.
1475 if (strstr(req, FORCE_PREFIX))
1477 if (csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS)
1479 log_error(LOG_LEVEL_FORCE,
1480 "Ignored force prefix in request: \"%s\".", req);
1484 strclean(req, FORCE_PREFIX);
1485 log_error(LOG_LEVEL_FORCE, "Enforcing request: \"%s\".", req);
1486 csp->flags |= CSP_FLAG_FORCED;
1489 #endif /* def FEATURE_FORCE_LOAD */
1491 err = parse_http_request(req, http);
1493 if (JB_ERR_OK != err)
1495 write_socket(csp->cfd, CHEADER, strlen(CHEADER));
1496 /* XXX: Use correct size */
1497 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1498 log_error(LOG_LEVEL_ERROR,
1499 "Couldn't parse request line received from %s: %s",
1500 csp->ip_addr_str, jb_err_to_string(err));
1502 free_http_request(http);
1503 return JB_ERR_PARSE;
1506 /* grab the rest of the client's headers */
1510 p = get_header(csp->client_iob);
1514 /* There are no additional headers to read. */
1521 * We didn't receive a complete header
1522 * line yet, get the rest of it.
1524 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1526 log_error(LOG_LEVEL_ERROR,
1527 "Stopped grabbing the client headers.");
1528 destroy_list(headers);
1529 return JB_ERR_PARSE;
1532 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1535 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1536 destroy_list(headers);
1537 return JB_ERR_PARSE;
1540 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1543 * If there is no memory left for buffering the
1544 * request, there is nothing we can do but hang up
1546 destroy_list(headers);
1547 return JB_ERR_MEMORY;
1552 if (!strncmpic(p, "Transfer-Encoding:", 18))
1555 * XXX: should be called through sed()
1556 * but currently can't.
1558 client_transfer_encoding(csp, &p);
1561 * We were able to read a complete
1562 * header and can finally enlist it.
1569 if (http->host == NULL)
1572 * If we still don't know the request destination,
1573 * the request is invalid or the client uses
1574 * Privoxy without its knowledge.
1576 if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
1579 * Our attempts to get the request destination
1580 * elsewhere failed or Privoxy is configured
1581 * to only accept proxy requests.
1583 * An error response has already been send
1584 * and we're done here.
1586 return JB_ERR_PARSE;
1591 * Determine the actions for this URL
1593 #ifdef FEATURE_TOGGLE
1594 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
1596 /* Most compatible set of actions (i.e. none) */
1597 init_current_action(csp->action);
1600 #endif /* ndef FEATURE_TOGGLE */
1602 get_url_actions(csp, http);
1606 * Save a copy of the original request for logging
1608 http->ocmd = strdup_or_die(http->cmd);
1609 enlist(csp->headers, http->cmd);
1611 /* Append the previously read headers */
1612 list_append_list_unique(csp->headers, headers);
1613 destroy_list(headers);
1620 /*********************************************************************
1622 * Function : parse_client_request
1624 * Description : Parses the client's request and decides what to do
1627 * Note that since we're not using select() we could get
1628 * blocked here if a client connected, then didn't say
1632 * 1 : csp = Current client state (buffers, headers, etc...)
1634 * Returns : JB_ERR_OK or JB_ERR_PARSE
1636 *********************************************************************/
1637 static jb_err parse_client_request(struct client_state *csp)
1639 struct http_request *http = csp->http;
1642 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1643 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
1644 && (!strcmpic(csp->http->ver, "HTTP/1.1"))
1645 && (csp->http->ssl == 0))
1647 /* Assume persistence until further notice */
1648 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1651 if (csp->http->ssl == 0)
1654 * This whole block belongs to chat() but currently
1655 * has to be executed before sed().
1657 if (csp->flags & CSP_FLAG_CHUNKED_CLIENT_BODY)
1659 if (receive_chunked_client_request_body(csp) != JB_ERR_OK)
1661 return JB_ERR_PARSE;
1666 csp->expected_client_content_length = get_expected_content_length(csp->headers);
1668 verify_request_length(csp);
1670 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1672 err = sed(csp, FILTER_CLIENT_HEADERS);
1673 if (JB_ERR_OK != err)
1675 /* XXX: Should be handled in sed(). */
1676 assert(err == JB_ERR_PARSE);
1677 log_error(LOG_LEVEL_FATAL, "Failed to parse client headers.");
1679 csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
1681 /* Check request line for rewrites. */
1682 if ((NULL == csp->headers->first->str)
1683 || (strcmp(http->cmd, csp->headers->first->str) &&
1684 (JB_ERR_OK != change_request_destination(csp))))
1687 * A header filter broke the request line - bail out.
1689 write_socket(csp->cfd, MESSED_UP_REQUEST_RESPONSE, strlen(MESSED_UP_REQUEST_RESPONSE));
1690 /* XXX: Use correct size */
1691 log_error(LOG_LEVEL_CLF,
1692 "%s - - [%T] \"Invalid request generated\" 500 0", csp->ip_addr_str);
1693 log_error(LOG_LEVEL_ERROR,
1694 "Invalid request line after applying header filters.");
1695 free_http_request(http);
1697 return JB_ERR_PARSE;
1705 /*********************************************************************
1709 * Description : Once a connection from the client has been accepted,
1710 * this function is called (via serve()) to handle the
1711 * main business of the communication. This function
1712 * returns after dealing with a single request. It can
1713 * be called multiple times with the same client socket
1714 * if the client is keeping the connection alive.
1716 * The decision whether or not a client connection will
1717 * be kept alive is up to the caller which also must
1718 * close the client socket when done.
1720 * FIXME: chat is nearly thousand lines long.
1724 * 1 : csp = Current client state (buffers, headers, etc...)
1726 * Returns : Nothing.
1728 *********************************************************************/
1729 static void chat(struct client_state *csp)
1731 char buf[BUFFER_SIZE];
1738 int ms_iis5_hack = 0;
1739 unsigned long long byte_count = 0;
1740 const struct forward_spec *fwd;
1741 struct http_request *http;
1742 long len = 0; /* for buffer sizes (and negative error codes) */
1743 int buffer_and_filter_content = 0;
1745 /* Skeleton for HTTP response, if we should intercept the request */
1746 struct http_response *rsp;
1747 struct timeval timeout;
1748 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1749 int watch_client_socket;
1752 memset(buf, 0, sizeof(buf));
1756 if (receive_client_request(csp) != JB_ERR_OK)
1760 if (parse_client_request(csp) != JB_ERR_OK)
1765 /* decide how to route the HTTP request */
1766 fwd = forward_url(csp, http);
1769 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!? This can't happen!");
1770 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1775 * build the http request to send to the server
1776 * we have to do one of the following:
1778 * create = use the original HTTP request to create a new
1779 * HTTP request that has either the path component
1780 * without the http://domainspec (w/path) or the
1781 * full orininal URL (w/url)
1782 * Note that the path and/or the HTTP version may
1783 * have been altered by now.
1785 * connect = Open a socket to the host:port of the server
1786 * and short-circuit server and client socket.
1788 * pass = Pass the request unchanged if forwarding a CONNECT
1789 * request to a parent proxy. Note that we'll be sending
1790 * the CFAIL message ourselves if connecting to the parent
1791 * fails, but we won't send a CSUCCEED message if it works,
1792 * since that would result in a double message (ours and the
1793 * parent's). After sending the request to the parent, we simply
1796 * here's the matrix:
1799 * +--------+--------+
1801 * 0 | create | connect|
1803 * Forwarding +--------+--------+
1805 * 1 | create | pass |
1807 * +--------+--------+
1811 if (http->ssl && connect_port_is_forbidden(csp))
1813 const char *acceptable_connect_ports =
1814 csp->action->string[ACTION_STRING_LIMIT_CONNECT];
1815 assert(NULL != acceptable_connect_ports);
1816 log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
1817 "limit-connect{%s} doesn't allow CONNECT requests to %s",
1818 csp->ip_addr_str, acceptable_connect_ports, csp->http->hostport);
1819 csp->action->flags |= ACTION_BLOCK;
1825 freez(csp->headers->first->str);
1826 build_request_line(csp, fwd, &csp->headers->first->str);
1830 * We have a request. Check if one of the crunchers wants it.
1832 if (crunch_response_triggered(csp, crunchers_all))
1835 * Yes. The client got the crunch response and we're done here.
1840 log_applied_actions(csp->action);
1841 log_error(LOG_LEVEL_GPC, "%s%s", http->hostport, http->path);
1843 if (fwd->forward_host)
1845 log_error(LOG_LEVEL_CONNECT, "via [%s]:%d to: %s",
1846 fwd->forward_host, fwd->forward_port, http->hostport);
1850 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
1853 /* here we connect to the server, gateway, or the forwarder */
1855 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1856 if ((csp->server_connection.sfd != JB_INVALID_SOCKET)
1857 && socket_is_still_alive(csp->server_connection.sfd)
1858 && connection_destination_matches(&csp->server_connection, http, fwd))
1860 log_error(LOG_LEVEL_CONNECT,
1861 "Reusing server socket %d connected to %s. Total requests: %u.",
1862 csp->server_connection.sfd, csp->server_connection.host,
1863 csp->server_connection.requests_sent_total);
1867 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
1869 #ifdef FEATURE_CONNECTION_SHARING
1870 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
1872 remember_connection(&csp->server_connection);
1875 #endif /* def FEATURE_CONNECTION_SHARING */
1877 log_error(LOG_LEVEL_CONNECT,
1878 "Closing server socket %d connected to %s. Total requests: %u.",
1879 csp->server_connection.sfd, csp->server_connection.host,
1880 csp->server_connection.requests_sent_total);
1881 close_socket(csp->server_connection.sfd);
1883 mark_connection_closed(&csp->server_connection);
1885 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1887 csp->server_connection.sfd = forwarded_connect(fwd, http, csp);
1889 if (csp->server_connection.sfd == JB_INVALID_SOCKET)
1891 if (fwd->type != SOCKS_NONE)
1894 rsp = error_response(csp, "forwarding-failed");
1896 else if (errno == EINVAL)
1898 rsp = error_response(csp, "no-such-domain");
1902 rsp = error_response(csp, "connect-failed");
1905 /* Write the answer to the client */
1908 send_crunch_response(csp, rsp);
1913 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1914 save_connection_destination(csp->server_connection.sfd,
1915 http, fwd, &csp->server_connection);
1916 csp->server_connection.keep_alive_timeout =
1917 (unsigned)csp->config->keep_alive_timeout;
1919 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1921 csp->server_connection.requests_sent_total++;
1923 if (fwd->forward_host || (http->ssl == 0))
1926 hdr = list_to_text(csp->headers);
1929 /* FIXME Should handle error properly */
1930 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
1932 list_remove_all(csp->headers);
1935 * Write the client's (modified) header to the server
1936 * (along with anything else that may be in the buffer)
1938 write_failure = 0 != write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
1943 log_error(LOG_LEVEL_CONNECT,
1944 "Failed sending request headers to: %s: %E", http->hostport);
1946 else if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
1947 && (flush_socket(csp->server_connection.sfd, csp->client_iob) < 0))
1950 log_error(LOG_LEVEL_CONNECT,
1951 "Failed sending request body to: %s: %E", http->hostport);
1956 rsp = error_response(csp, "connect-failed");
1959 send_crunch_response(csp, rsp);
1967 * We're running an SSL tunnel and we're not forwarding,
1968 * so just ditch the client headers, send the "connect succeeded"
1969 * message to the client, flush the rest, and get out of the way.
1971 list_remove_all(csp->headers);
1972 if (write_socket(csp->cfd, CSUCCEED, strlen(CSUCCEED)))
1976 clear_iob(csp->client_iob);
1979 log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
1981 csp->server_connection.request_sent = time(NULL);
1983 maxfd = (csp->cfd > csp->server_connection.sfd) ?
1984 csp->cfd : csp->server_connection.sfd;
1986 /* pass data between the client and server
1987 * until one or the other shuts down the connection.
1992 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1993 watch_client_socket = 0 == (csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING);
2000 * FD_ZERO here seems to point to an errant macro which crashes.
2001 * So do this by hand for now...
2003 memset(&rfds,0x00,sizeof(fd_set));
2007 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2008 if (!watch_client_socket)
2010 maxfd = csp->server_connection.sfd;
2013 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2015 FD_SET(csp->cfd, &rfds);
2018 FD_SET(csp->server_connection.sfd, &rfds);
2020 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2021 if ((csp->flags & CSP_FLAG_CHUNKED)
2022 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2023 && ((csp->iob->eod - csp->iob->cur) >= 5)
2024 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
2027 * XXX: This check should be obsolete now,
2028 * but let's wait a while to be sure.
2030 log_error(LOG_LEVEL_CONNECT,
2031 "Looks like we got the last chunk together with "
2032 "the server headers but didn't detect it earlier. "
2033 "We better stop reading.");
2034 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2035 csp->expected_content_length = byte_count;
2036 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2038 if (server_body && server_response_is_complete(csp, byte_count))
2040 if (csp->expected_content_length == byte_count)
2042 log_error(LOG_LEVEL_CONNECT,
2043 "Done reading from server. Content length: %llu as expected. "
2044 "Bytes most recently read: %d.",
2049 log_error(LOG_LEVEL_CONNECT,
2050 "Done reading from server. Expected content length: %llu. "
2051 "Actual content length: %llu. Bytes most recently read: %d.",
2052 csp->expected_content_length, byte_count, len);
2056 * XXX: should not jump around,
2057 * chat() is complicated enough already.
2061 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2063 timeout.tv_sec = csp->config->socket_timeout;
2064 timeout.tv_usec = 0;
2065 n = select((int)maxfd+1, &rfds, NULL, NULL, &timeout);
2069 log_error(LOG_LEVEL_ERROR,
2070 "Didn't receive data in time: %s", http->url);
2071 if ((byte_count == 0) && (http->ssl == 0))
2073 send_crunch_response(csp, error_response(csp, "connection-timeout"));
2075 mark_server_socket_tainted(csp);
2080 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
2081 mark_server_socket_tainted(csp);
2086 * This is the body of the browser's request,
2087 * just read and write it.
2089 * XXX: Make sure the client doesn't use pipelining
2090 * behind Privoxy's back.
2092 if (FD_ISSET(csp->cfd, &rfds))
2094 int max_bytes_to_read = sizeof(buf) - 1;
2096 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2097 if ((csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ))
2099 if (data_is_available(csp->cfd, 0))
2102 * If the next request is already waiting, we have
2103 * to stop select()ing the client socket. Otherwise
2104 * we would always return right away and get nothing
2107 watch_client_socket = 0;
2108 log_error(LOG_LEVEL_CONNECT,
2109 "Stopping to watch the client socket %d. "
2110 "There's already another request waiting.",
2115 * If the client socket is set, but there's no data
2116 * available on the socket, the client went fishing
2117 * and continuing talking to the server makes no sense.
2119 log_error(LOG_LEVEL_CONNECT,
2120 "The client closed socket %d while "
2121 "the server socket %d is still open.",
2122 csp->cfd, csp->server_connection.sfd);
2123 mark_server_socket_tainted(csp);
2126 if (csp->expected_client_content_length != 0)
2128 if (csp->expected_client_content_length < (sizeof(buf) - 1))
2130 max_bytes_to_read = (int)csp->expected_client_content_length;
2132 log_error(LOG_LEVEL_CONNECT,
2133 "Waiting for up to %d bytes from the client.",
2136 assert(max_bytes_to_read < sizeof(buf));
2137 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2139 len = read_socket(csp->cfd, buf, max_bytes_to_read);
2143 /* XXX: not sure if this is necessary. */
2144 mark_server_socket_tainted(csp);
2145 break; /* "game over, man" */
2148 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2149 if (csp->expected_client_content_length != 0)
2151 assert(len <= max_bytes_to_read);
2152 csp->expected_client_content_length -= (unsigned)len;
2153 log_error(LOG_LEVEL_CONNECT,
2154 "Expected client content length set to %llu "
2155 "after reading %d bytes.",
2156 csp->expected_client_content_length, len);
2157 if (csp->expected_client_content_length == 0)
2159 log_error(LOG_LEVEL_CONNECT,
2160 "Done reading from the client.");
2161 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
2164 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2166 if (write_socket(csp->server_connection.sfd, buf, (size_t)len))
2168 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
2169 mark_server_socket_tainted(csp);
2176 * The server wants to talk. It could be the header or the body.
2177 * If `hdr' is null, then it's the header otherwise it's the body.
2178 * FIXME: Does `hdr' really mean `host'? No.
2180 if (FD_ISSET(csp->server_connection.sfd, &rfds))
2182 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2184 * If we are buffering content, we don't want to eat up to
2185 * buffer-limit bytes if the client no longer cares about them.
2186 * If we aren't buffering, however, a dead client socket will be
2187 * noticed pretty much right away anyway, so we can reduce the
2188 * overhead by skipping the check.
2190 if (buffer_and_filter_content && !socket_is_still_alive(csp->cfd))
2193 log_error(LOG_LEVEL_CONNECT,
2194 "The server still wants to talk, but the client may already have hung up on us.");
2196 log_error(LOG_LEVEL_CONNECT,
2197 "The server still wants to talk, but the client hung up on us.");
2198 mark_server_socket_tainted(csp);
2200 #endif /* def _WIN32 */
2202 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2204 len = read_socket(csp->server_connection.sfd, buf, sizeof(buf) - 1);
2208 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
2210 if (http->ssl && (fwd->forward_host == NULL))
2213 * Just hang up. We already confirmed the client's CONNECT
2214 * request with status code 200 and unencrypted content is
2215 * no longer welcome.
2217 log_error(LOG_LEVEL_ERROR,
2218 "CONNECT already confirmed. Unable to tell the client about the problem.");
2221 else if (byte_count)
2224 * Just hang up. We already transmitted the original headers
2225 * and parts of the original content and therefore missed the
2226 * chance to send an error message (without risking data corruption).
2228 * XXX: we could retry with a fancy range request here.
2230 log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
2231 "Unable to tell the client about the problem.");
2232 mark_server_socket_tainted(csp);
2236 * XXX: Consider handling the cases above the same.
2238 mark_server_socket_tainted(csp);
2242 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2243 if (csp->flags & CSP_FLAG_CHUNKED)
2245 if ((len >= 5) && !memcmp(buf+len-5, "0\r\n\r\n", 5))
2247 /* XXX: this is a temporary hack */
2248 log_error(LOG_LEVEL_CONNECT,
2249 "Looks like we reached the end of the last chunk. "
2250 "We better stop reading.");
2251 csp->expected_content_length = byte_count + (unsigned long long)len;
2252 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2256 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2259 * Add a trailing zero to let be able to use string operations.
2260 * XXX: do we still need this with filter_popups gone?
2265 * Normally, this would indicate that we've read
2266 * as much as the server has sent us and we can
2267 * close the client connection. However, Microsoft
2268 * in its wisdom has released IIS/5 with a bug that
2269 * prevents it from sending the trailing \r\n in
2270 * a 302 redirect header (and possibly other headers).
2271 * To work around this if we've haven't parsed
2272 * a full header we'll append a trailing \r\n
2273 * and see if this now generates a valid one.
2275 * This hack shouldn't have any impacts. If we've
2276 * already transmitted the header or if this is a
2277 * SSL connection, then we won't bother with this
2278 * hack. So we only work on partially received
2279 * headers. If we append a \r\n and this still
2280 * doesn't generate a valid header, then we won't
2281 * transmit anything to the client.
2286 if (server_body || http->ssl)
2289 * If we have been buffering up the document,
2290 * now is the time to apply content modification
2291 * and send the result to the client.
2293 if (buffer_and_filter_content)
2295 p = execute_content_filters(csp);
2297 * If content filtering fails, use the original
2298 * buffer and length.
2299 * (see p != NULL ? p : csp->iob->cur below)
2303 csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
2305 #ifdef FEATURE_COMPRESSION
2306 else if ((csp->flags & CSP_FLAG_CLIENT_SUPPORTS_DEFLATE)
2307 && (csp->content_length > LOWER_LENGTH_LIMIT_FOR_COMPRESSION))
2309 char *compressed_content = compress_buffer(p,
2310 (size_t *)&csp->content_length, csp->config->compression_level);
2311 if (compressed_content != NULL)
2314 p = compressed_content;
2315 csp->flags |= CSP_FLAG_BUFFERED_CONTENT_DEFLATED;
2320 if (JB_ERR_OK != update_server_headers(csp))
2322 log_error(LOG_LEVEL_FATAL,
2323 "Failed to update server headers. after filtering.");
2326 hdr = list_to_text(csp->headers);
2329 /* FIXME Should handle error properly */
2330 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2333 if (write_socket(csp->cfd, hdr, strlen(hdr))
2334 || write_socket(csp->cfd,
2335 ((p != NULL) ? p : csp->iob->cur), (size_t)csp->content_length))
2337 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
2340 mark_server_socket_tainted(csp);
2348 break; /* "game over, man" */
2352 * This is NOT the body, so
2353 * Let's pretend the server just sent us a blank line.
2355 snprintf(buf, sizeof(buf), "\r\n");
2356 len = (int)strlen(buf);
2359 * Now, let the normal header parsing algorithm below do its
2360 * job. If it fails, we'll exit instead of continuing.
2367 * If this is an SSL connection or we're in the body
2368 * of the server document, just write it to the client,
2369 * unless we need to buffer the body for later content-filtering
2371 if (server_body || http->ssl)
2373 if (buffer_and_filter_content)
2376 * If there is no memory left for buffering the content, or the buffer limit
2377 * has been reached, switch to non-filtering mode, i.e. make & write the
2378 * header, flush the iob and buf, and get out of the way.
2380 if (add_to_iob(csp->iob, csp->config->buffer_limit, buf, len))
2385 log_error(LOG_LEVEL_INFO,
2386 "Flushing header and buffers. Stepping back from filtering.");
2388 hdr = list_to_text(csp->headers);
2392 * Memory is too tight to even generate the header.
2393 * Send our static "Out-of-memory" page.
2395 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
2396 rsp = cgi_error_memory();
2397 send_crunch_response(csp, rsp);
2398 mark_server_socket_tainted(csp);
2401 hdrlen = strlen(hdr);
2403 if (write_socket(csp->cfd, hdr, hdrlen)
2404 || ((flushed = flush_socket(csp->cfd, csp->iob)) < 0)
2405 || (write_socket(csp->cfd, buf, (size_t)len)))
2407 log_error(LOG_LEVEL_CONNECT,
2408 "Flush header and buffers to client failed: %E");
2410 mark_server_socket_tainted(csp);
2415 * Reset the byte_count to the amount of bytes
2416 * we just flushed. len will be added a few lines below,
2417 * hdrlen doesn't matter for LOG_LEVEL_CLF.
2419 byte_count = (unsigned long long)flushed;
2421 buffer_and_filter_content = 0;
2427 if (write_socket(csp->cfd, buf, (size_t)len))
2429 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
2430 mark_server_socket_tainted(csp);
2434 byte_count += (unsigned long long)len;
2440 * We're still looking for the end of the server's header.
2441 * Buffer up the data we just read. If that fails, there's
2442 * little we can do but send our static out-of-memory page.
2444 if (add_to_iob(csp->iob, csp->config->buffer_limit, buf, len))
2446 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
2447 rsp = cgi_error_memory();
2448 send_crunch_response(csp, rsp);
2449 mark_server_socket_tainted(csp);
2453 /* Convert iob into something sed() can digest */
2454 if (JB_ERR_PARSE == get_server_headers(csp))
2459 * Well, we tried our MS IIS/5 hack and it didn't work.
2460 * The header is incomplete and there isn't anything
2461 * we can do about it.
2463 log_error(LOG_LEVEL_ERROR, "Invalid server headers. "
2464 "Applying the MS IIS5 hack didn't help.");
2465 log_error(LOG_LEVEL_CLF,
2466 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2467 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2468 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2469 mark_server_socket_tainted(csp);
2475 * Since we have to wait for more from the server before
2476 * we can parse the headers we just continue here.
2478 log_error(LOG_LEVEL_CONNECT,
2479 "Continuing buffering server headers from socket %d. "
2480 "Bytes most recently read: %d.", csp->cfd, len);
2487 * Account for the content bytes we
2488 * might have gotten with the headers.
2490 assert(csp->iob->eod >= csp->iob->cur);
2491 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2494 /* Did we actually get anything? */
2495 if (NULL == csp->headers->first)
2497 if ((csp->flags & CSP_FLAG_REUSED_CLIENT_CONNECTION))
2499 log_error(LOG_LEVEL_ERROR,
2500 "No server or forwarder response received on socket %d. "
2501 "Closing client socket %d without sending data.",
2502 csp->server_connection.sfd, csp->cfd);
2503 log_error(LOG_LEVEL_CLF,
2504 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2508 log_error(LOG_LEVEL_ERROR,
2509 "No server or forwarder response received on socket %d.",
2510 csp->server_connection.sfd);
2511 send_crunch_response(csp, error_response(csp, "no-server-data"));
2513 free_http_request(http);
2514 mark_server_socket_tainted(csp);
2518 assert(csp->headers->first->str);
2520 if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
2521 strncmpic(csp->headers->first->str, "ICY", 3))
2524 * It doesn't look like a HTTP (or Shoutcast) response:
2525 * tell the client and log the problem.
2527 if (strlen(csp->headers->first->str) > 30)
2529 csp->headers->first->str[30] = '\0';
2531 log_error(LOG_LEVEL_ERROR,
2532 "Invalid server or forwarder response. Starts with: %s",
2533 csp->headers->first->str);
2534 log_error(LOG_LEVEL_CLF,
2535 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2536 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2537 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2538 free_http_request(http);
2539 mark_server_socket_tainted(csp);
2544 * We have now received the entire server header,
2545 * filter it and send the result to the client
2547 if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
2549 log_error(LOG_LEVEL_FATAL, "Failed to parse server headers.");
2551 hdr = list_to_text(csp->headers);
2554 /* FIXME Should handle error properly */
2555 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2558 if ((csp->flags & CSP_FLAG_CHUNKED)
2559 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2560 && ((csp->iob->eod - csp->iob->cur) >= 5)
2561 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
2563 log_error(LOG_LEVEL_CONNECT,
2564 "Looks like we got the last chunk together with "
2565 "the server headers. We better stop reading.");
2566 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2567 csp->expected_content_length = byte_count;
2568 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2571 csp->server_connection.response_received = time(NULL);
2573 if (crunch_response_triggered(csp, crunchers_light))
2576 * One of the tags created by a server-header
2577 * tagger triggered a crunch. We already
2578 * delivered the crunch response to the client
2579 * and are done here after cleaning up.
2582 mark_server_socket_tainted(csp);
2585 /* Buffer and pcrs filter this if appropriate. */
2587 if (!http->ssl) /* We talk plaintext */
2589 buffer_and_filter_content = content_requires_filtering(csp);
2592 * Only write if we're not buffering for content modification
2594 if (!buffer_and_filter_content)
2597 * Write the server's (modified) header to
2598 * the client (along with anything else that
2599 * may be in the buffer)
2602 if (write_socket(csp->cfd, hdr, strlen(hdr))
2603 || ((len = flush_socket(csp->cfd, csp->iob)) < 0))
2605 log_error(LOG_LEVEL_CONNECT, "write header to client failed: %E");
2608 * The write failed, so don't bother mentioning it
2609 * to the client... it probably can't hear us anyway.
2612 mark_server_socket_tainted(csp);
2617 /* we're finished with the server's header */
2623 * If this was a MS IIS/5 hack then it means the server
2624 * has already closed the connection. Nothing more to read.
2629 log_error(LOG_LEVEL_ERROR,
2630 "Closed server connection detected. "
2631 "Applying the MS IIS5 hack didn't help.");
2632 log_error(LOG_LEVEL_CLF,
2633 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2634 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2635 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2636 mark_server_socket_tainted(csp);
2642 mark_server_socket_tainted(csp);
2643 return; /* huh? we should never get here */
2646 if (csp->content_length == 0)
2649 * If Privoxy didn't recalculate the Content-Length,
2650 * byte_count is still correct.
2652 csp->content_length = byte_count;
2655 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2656 if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2657 && (csp->expected_content_length != byte_count))
2659 log_error(LOG_LEVEL_CONNECT,
2660 "Received %llu bytes while expecting %llu.",
2661 byte_count, csp->expected_content_length);
2662 mark_server_socket_tainted(csp);
2666 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %llu",
2667 csp->ip_addr_str, http->ocmd, csp->content_length);
2669 csp->server_connection.timestamp = time(NULL);
2673 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2674 /*********************************************************************
2676 * Function : prepare_csp_for_next_request
2678 * Description : Put the csp in a mostly vergin state.
2681 * 1 : csp = Current client state (buffers, headers, etc...)
2685 *********************************************************************/
2686 static void prepare_csp_for_next_request(struct client_state *csp)
2688 unsigned int toggled_on_flag_set = (0 != (csp->flags & CSP_FLAG_TOGGLED_ON));
2690 csp->content_type = 0;
2691 csp->content_length = 0;
2692 csp->expected_content_length = 0;
2693 csp->expected_client_content_length = 0;
2694 list_remove_all(csp->headers);
2695 clear_iob(csp->iob);
2696 freez(csp->error_message);
2697 free_http_request(csp->http);
2698 destroy_list(csp->headers);
2699 destroy_list(csp->tags);
2700 free_current_action(csp->action);
2701 if (NULL != csp->fwd)
2703 unload_forward_spec(csp->fwd);
2706 /* XXX: Store per-connection flags someplace else. */
2707 csp->flags = (CSP_FLAG_ACTIVE | CSP_FLAG_REUSED_CLIENT_CONNECTION);
2708 if (toggled_on_flag_set)
2710 csp->flags |= CSP_FLAG_TOGGLED_ON;
2713 if (csp->client_iob->eod > csp->client_iob->cur)
2715 long bytes_to_shift = csp->client_iob->cur - csp->client_iob->buf;
2716 size_t data_length = (size_t)(csp->client_iob->eod - csp->client_iob->cur);
2718 assert(bytes_to_shift > 0);
2719 assert(data_length > 0);
2721 log_error(LOG_LEVEL_CONNECT, "Shifting %d pipelined bytes by %d bytes",
2722 data_length, bytes_to_shift);
2723 memmove(csp->client_iob->buf, csp->client_iob->cur, data_length);
2724 csp->client_iob->cur = csp->client_iob->buf;
2725 assert(csp->client_iob->eod == csp->client_iob->buf + bytes_to_shift + data_length);
2726 csp->client_iob->eod = csp->client_iob->buf + data_length;
2727 memset(csp->client_iob->eod, '\0', (size_t)bytes_to_shift);
2729 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
2734 * We mainly care about resetting client_iob->cur so we don't
2735 * waste buffer space at the beginning and don't mess up the
2736 * request restoration done by cgi_show_request().
2738 * Freeing the buffer itself isn't technically necessary,
2739 * but makes debugging more convenient.
2741 clear_iob(csp->client_iob);
2744 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2747 /*********************************************************************
2751 * Description : This is little more than chat. We only "serve" to
2752 * to close (or remember) any socket that chat may have
2756 * 1 : csp = Current client state (buffers, headers, etc...)
2760 *********************************************************************/
2762 void serve(struct client_state *csp)
2763 #else /* ifndef AMIGA */
2764 static void serve(struct client_state *csp)
2765 #endif /* def AMIGA */
2767 int config_file_change_detected = 0; /* Only used for debugging */
2768 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2769 #ifdef FEATURE_CONNECTION_SHARING
2770 static int monitor_thread_running = 0;
2771 #endif /* def FEATURE_CONNECTION_SHARING */
2772 int continue_chatting = 0;
2774 log_error(LOG_LEVEL_CONNECT, "Accepted connection from %s on socket %d",
2775 csp->ip_addr_str, csp->cfd);
2779 unsigned int latency;
2784 * If the request has been crunched,
2785 * the calculated latency is zero.
2787 latency = (unsigned)(csp->server_connection.response_received -
2788 csp->server_connection.request_sent) / 2;
2790 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
2791 && (csp->flags & CSP_FLAG_CRUNCHED)
2792 && (csp->expected_client_content_length != 0))
2794 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
2795 log_error(LOG_LEVEL_CONNECT,
2796 "Tainting client socket %d due to unread data.", csp->cfd);
2799 continue_chatting = (csp->config->feature_flags
2800 & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
2801 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
2802 && (csp->cfd != JB_INVALID_SOCKET)
2803 && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
2804 && ((csp->flags & CSP_FLAG_SERVER_CONTENT_LENGTH_SET)
2805 || (csp->flags & CSP_FLAG_CHUNKED));
2807 if (!(csp->flags & CSP_FLAG_CRUNCHED)
2808 && (csp->server_connection.sfd != JB_INVALID_SOCKET))
2810 if (!(csp->flags & CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET))
2812 csp->server_connection.keep_alive_timeout = csp->config->default_server_timeout;
2814 if (!(csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
2815 || (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
2816 || !socket_is_still_alive(csp->server_connection.sfd)
2817 || !(latency < csp->server_connection.keep_alive_timeout))
2819 log_error(LOG_LEVEL_CONNECT,
2820 "Closing server socket %d connected to %s. "
2821 "Keep-alive %u. Tainted: %u. Socket alive %u. Timeout: %u.",
2822 csp->server_connection.sfd, csp->server_connection.host,
2823 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
2824 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
2825 socket_is_still_alive(csp->server_connection.sfd),
2826 csp->server_connection.keep_alive_timeout);
2827 #ifdef FEATURE_CONNECTION_SHARING
2828 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
2830 forget_connection(csp->server_connection.sfd);
2832 #endif /* def FEATURE_CONNECTION_SHARING */
2833 close_socket(csp->server_connection.sfd);
2834 mark_connection_closed(&csp->server_connection);
2838 if (continue_chatting && any_loaded_file_changed(csp))
2840 continue_chatting = 0;
2841 config_file_change_detected = 1;
2844 if (continue_chatting)
2846 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
2847 && socket_is_still_alive(csp->cfd))
2849 log_error(LOG_LEVEL_CONNECT, "Client request %d has been "
2850 "pipelined on socket %d and the socket is still alive.",
2851 csp->requests_received_total+1, csp->cfd);
2852 prepare_csp_for_next_request(csp);
2856 if (0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
2858 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
2860 log_error(LOG_LEVEL_CONNECT,
2861 "Waiting for the next client request on socket %d. "
2862 "Keeping the server socket %d to %s open.",
2863 csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
2867 log_error(LOG_LEVEL_CONNECT,
2868 "Waiting for the next client request on socket %d. "
2869 "No server socket to keep open.", csp->cfd);
2873 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
2874 && data_is_available(csp->cfd, (int)csp->config->keep_alive_timeout)
2875 && socket_is_still_alive(csp->cfd))
2877 log_error(LOG_LEVEL_CONNECT,
2878 "Client request %u arrived in time on socket %d.",
2879 csp->requests_received_total+1, csp->cfd);
2880 prepare_csp_for_next_request(csp);
2884 #ifdef FEATURE_CONNECTION_SHARING
2885 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
2886 && (csp->server_connection.sfd != JB_INVALID_SOCKET)
2887 && (socket_is_still_alive(csp->server_connection.sfd)))
2889 time_t time_open = time(NULL) - csp->server_connection.timestamp;
2891 if (csp->server_connection.keep_alive_timeout < time_open - (time_t)latency)
2896 remember_connection(&csp->server_connection);
2897 csp->server_connection.sfd = JB_INVALID_SOCKET;
2898 drain_and_close_socket(csp->cfd);
2899 csp->cfd = JB_INVALID_SOCKET;
2900 privoxy_mutex_lock(&connection_reuse_mutex);
2901 if (!monitor_thread_running)
2903 monitor_thread_running = 1;
2904 privoxy_mutex_unlock(&connection_reuse_mutex);
2905 wait_for_alive_connections();
2906 privoxy_mutex_lock(&connection_reuse_mutex);
2907 monitor_thread_running = 0;
2909 privoxy_mutex_unlock(&connection_reuse_mutex);
2911 #endif /* def FEATURE_CONNECTION_SHARING */
2915 else if (csp->server_connection.sfd != JB_INVALID_SOCKET)
2917 log_error(LOG_LEVEL_CONNECT,
2918 "Closing server socket %d connected to %s. Keep-alive: %u. "
2919 "Tainted: %u. Socket alive: %u. Timeout: %u. "
2920 "Configuration file change detected: %u",
2921 csp->server_connection.sfd, csp->server_connection.host,
2922 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
2923 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
2924 socket_is_still_alive(csp->server_connection.sfd),
2925 csp->server_connection.keep_alive_timeout,
2926 config_file_change_detected);
2928 } while (continue_chatting);
2932 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2934 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
2936 #ifdef FEATURE_CONNECTION_SHARING
2937 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
2939 forget_connection(csp->server_connection.sfd);
2941 #endif /* def FEATURE_CONNECTION_SHARING */
2942 close_socket(csp->server_connection.sfd);
2945 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2946 mark_connection_closed(&csp->server_connection);
2949 if (csp->cfd != JB_INVALID_SOCKET)
2951 log_error(LOG_LEVEL_CONNECT, "Closing client socket %d. "
2952 "Keep-alive: %u. Socket alive: %u. Data available: %u. "
2953 "Configuration file change detected: %u. Requests received: %u.",
2954 csp->cfd, 0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE),
2955 socket_is_still_alive(csp->cfd), data_is_available(csp->cfd, 0),
2956 config_file_change_detected, csp->requests_received_total);
2957 drain_and_close_socket(csp->cfd);
2960 csp->flags &= ~CSP_FLAG_ACTIVE;
2966 /*********************************************************************
2968 * Function : server_thread
2970 * Description : We only exist to call `serve' in a threaded environment.
2973 * 1 : data = Current client state (buffers, headers, etc...)
2975 * Returns : Always 0.
2977 *********************************************************************/
2978 static int32 server_thread(void *data)
2980 serve((struct client_state *) data);
2987 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
2988 /*********************************************************************
2992 * Description : Print usage info & exit.
2994 * Parameters : Pointer to argv[0] for identifying ourselves
2998 *********************************************************************/
2999 static void usage(const char *myname)
3001 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
3002 "Usage: %s [--config-test] "
3005 #endif /* defined(unix) */
3008 "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
3009 #endif /* defined(unix) */
3010 "[--version] [configfile]\n"
3011 "Aborting\n", myname);
3016 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
3019 #ifdef MUTEX_LOCKS_AVAILABLE
3020 /*********************************************************************
3022 * Function : privoxy_mutex_lock
3024 * Description : Locks a mutex.
3027 * 1 : mutex = The mutex to lock.
3029 * Returns : Void. May exit in case of errors.
3031 *********************************************************************/
3032 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
3034 #ifdef FEATURE_PTHREAD
3035 int err = pthread_mutex_lock(mutex);
3038 if (mutex != &log_mutex)
3040 log_error(LOG_LEVEL_FATAL,
3041 "Mutex locking failed: %s.\n", strerror(err));
3046 EnterCriticalSection(mutex);
3047 #endif /* def FEATURE_PTHREAD */
3051 /*********************************************************************
3053 * Function : privoxy_mutex_unlock
3055 * Description : Unlocks a mutex.
3058 * 1 : mutex = The mutex to unlock.
3060 * Returns : Void. May exit in case of errors.
3062 *********************************************************************/
3063 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
3065 #ifdef FEATURE_PTHREAD
3066 int err = pthread_mutex_unlock(mutex);
3069 if (mutex != &log_mutex)
3071 log_error(LOG_LEVEL_FATAL,
3072 "Mutex unlocking failed: %s.\n", strerror(err));
3077 LeaveCriticalSection(mutex);
3078 #endif /* def FEATURE_PTHREAD */
3082 /*********************************************************************
3084 * Function : privoxy_mutex_init
3086 * Description : Prepares a mutex.
3089 * 1 : mutex = The mutex to initialize.
3091 * Returns : Void. May exit in case of errors.
3093 *********************************************************************/
3094 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
3096 #ifdef FEATURE_PTHREAD
3097 int err = pthread_mutex_init(mutex, 0);
3100 printf("Fatal error. Mutex initialization failed: %s.\n",
3105 InitializeCriticalSection(mutex);
3106 #endif /* def FEATURE_PTHREAD */
3108 #endif /* def MUTEX_LOCKS_AVAILABLE */
3110 /*********************************************************************
3112 * Function : initialize_mutexes
3114 * Description : Prepares mutexes if mutex support is available.
3118 * Returns : Void, exits in case of errors.
3120 *********************************************************************/
3121 static void initialize_mutexes(void)
3123 #ifdef MUTEX_LOCKS_AVAILABLE
3125 * Prepare global mutex semaphores
3127 privoxy_mutex_init(&log_mutex);
3128 privoxy_mutex_init(&log_init_mutex);
3129 privoxy_mutex_init(&connection_reuse_mutex);
3132 * XXX: The assumptions below are a bit naive
3133 * and can cause locks that aren't necessary.
3135 * For example older FreeBSD versions (< 6.x?)
3136 * have no gethostbyname_r, but gethostbyname is
3139 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
3140 privoxy_mutex_init(&resolver_mutex);
3141 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
3143 * XXX: should we use a single mutex for
3144 * localtime() and gmtime() as well?
3146 #ifndef HAVE_GMTIME_R
3147 privoxy_mutex_init(&gmtime_mutex);
3148 #endif /* ndef HAVE_GMTIME_R */
3150 #ifndef HAVE_LOCALTIME_R
3151 privoxy_mutex_init(&localtime_mutex);
3152 #endif /* ndef HAVE_GMTIME_R */
3155 privoxy_mutex_init(&rand_mutex);
3156 #endif /* ndef HAVE_RANDOM */
3158 #endif /* def MUTEX_LOCKS_AVAILABLE */
3162 /*********************************************************************
3166 * Description : Load the config file and start the listen loop.
3167 * This function is a lot more *sane* with the `load_config'
3168 * and `listen_loop' functions; although it stills does
3169 * a *little* too much for my taste.
3172 * 1 : argc = Number of parameters (including $0).
3173 * 2 : argv = Array of (char *)'s to the parameters.
3175 * Returns : 1 if : can't open config file, unrecognized directive,
3176 * stats requested in multi-thread mode, can't open the
3177 * log file, can't open the jar file, listen port is invalid,
3178 * any load fails, and can't bind port.
3180 * Else main never returns, the process must be signaled
3181 * to terminate execution. Or, on Windows, use the
3182 * "File", "Exit" menu option.
3184 *********************************************************************/
3186 int real_main(int argc, char **argv)
3188 int main(int argc, char **argv)
3192 int do_config_test = 0;
3193 unsigned int random_seed;
3195 struct passwd *pw = NULL;
3196 struct group *grp = NULL;
3198 char *pre_chroot_nslookup_to_load_resolver = NULL;
3205 #if !defined(_WIN32)
3212 /* Prepare mutexes if supported and necessary. */
3213 initialize_mutexes();
3215 /* Enable logging until further notice. */
3219 * Parse the command line arguments
3221 * XXX: simply printing usage information in case of
3222 * invalid arguments isn't particularly user friendly.
3224 while (++argc_pos < argc)
3227 /* Check to see if the service must be installed or uninstalled */
3228 if (strncmp(argv[argc_pos], "--install", 9) == 0)
3230 const char *pName = argv[argc_pos] + 9;
3233 exit((install_service(pName)) ? 0 : 1);
3235 else if (strncmp(argv[argc_pos], "--uninstall", 11) == 0)
3237 const char *pName = argv[argc_pos] + 11;
3240 exit((uninstall_service(pName)) ? 0 : 1);
3242 else if (strcmp(argv[argc_pos], "--service") == 0)
3244 bRunAsService = TRUE;
3245 w32_set_service_cwd();
3246 atexit(w32_service_exit_notify);
3249 #endif /* defined(_WIN32) */
3252 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
3254 if (strcmp(argv[argc_pos], "--help") == 0)
3259 else if (strcmp(argv[argc_pos], "--version") == 0)
3261 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
3267 else if (strcmp(argv[argc_pos], "--no-daemon") == 0)
3269 set_debug_level(LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
3273 else if (strcmp(argv[argc_pos], "--pidfile") == 0)
3275 if (++argc_pos == argc) usage(argv[0]);
3276 pidfile = strdup_or_die(argv[argc_pos]);
3279 else if (strcmp(argv[argc_pos], "--user") == 0)
3284 if (++argc_pos == argc) usage(argv[argc_pos]);
3286 user_arg = strdup_or_die(argv[argc_pos]);
3287 group_name = strchr(user_arg, '.');
3288 if (NULL != group_name)
3290 /* Nul-terminate the user name */
3293 /* Skip the former delimiter to actually reach the group name */
3296 grp = getgrnam(group_name);
3299 log_error(LOG_LEVEL_FATAL, "Group '%s' not found.", group_name);
3302 pw = getpwnam(user_arg);
3305 log_error(LOG_LEVEL_FATAL, "User '%s' not found.", user_arg);
3311 else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup") == 0)
3313 if (++argc_pos == argc) usage(argv[0]);
3314 pre_chroot_nslookup_to_load_resolver = strdup_or_die(argv[argc_pos]);
3317 else if (strcmp(argv[argc_pos], "--chroot") == 0)
3321 #endif /* defined(unix) */
3323 else if (strcmp(argv[argc_pos], "--config-test") == 0)
3328 else if (argc_pos + 1 != argc)
3331 * This is neither the last command line
3332 * option, nor was it recognized before,
3333 * therefore it must be invalid.
3339 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
3341 configfile = argv[argc_pos];
3344 } /* -END- while (more arguments) */
3346 show_version(Argv[0]);
3349 if (*configfile != '/')
3351 char cwd[BUFFER_SIZE];
3353 size_t abs_file_size;
3355 /* make config-filename absolute here */
3356 if (NULL == getcwd(cwd, sizeof(cwd)))
3358 perror("failed to get current working directory");
3362 basedir = strdup_or_die(cwd);
3364 abs_file_size = strlen(cwd) + strlen(configfile) + 5;
3365 abs_file = malloc_or_die(abs_file_size);
3366 strlcpy(abs_file, basedir, abs_file_size);
3367 strlcat(abs_file, "/", abs_file_size);
3368 strlcat(abs_file, configfile, abs_file_size);
3369 configfile = abs_file;
3371 #endif /* defined unix */
3375 clients->next = NULL;
3377 /* XXX: factor out initialising after the next stable release. */
3380 #elif defined(_WIN32)
3384 random_seed = (unsigned int)time(NULL);
3386 srandom(random_seed);
3389 #endif /* ifdef HAVE_RANDOM */
3392 * Unix signal handling
3394 * Catch the abort, interrupt and terminate signals for a graceful exit
3395 * Catch the hangup signal so the errlog can be reopened.
3396 * Ignore the broken pipe signals (FIXME: Why?)
3398 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
3401 const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP };
3403 for (idx = 0; idx < SZ(catched_signals); idx++)
3405 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
3406 if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
3408 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
3409 #endif /* ifdef sun */
3411 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
3415 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
3417 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for SIGPIPE: %E");
3421 #else /* ifdef _WIN32 */
3422 # ifdef _WIN_CONSOLE
3424 * We *are* in a windows console app.
3425 * Print a verbose messages about FAQ's and such
3427 printf("%s", win32_blurb);
3428 # endif /* def _WIN_CONSOLE */
3429 #endif /* def _WIN32 */
3433 exit(NULL == load_config());
3436 /* Initialize the CGI subsystem */
3437 cgi_init_error_messages();
3440 * If runnig on unix and without the --nodaemon
3441 * option, become a daemon. I.e. fork, detach
3442 * from tty and get process group leadership
3451 if (pid < 0) /* error */
3456 else if (pid != 0) /* parent */
3461 * must check for errors
3462 * child died due to missing files aso
3465 wpid = waitpid(pid, &status, WNOHANG);
3477 * stderr (fd 2) will be closed later on,
3478 * when the config file has been parsed.
3484 * Reserve fd 0 and 1 to prevent abort() and friends
3485 * from sending stuff to the clients or servers.
3487 fd = open("/dev/null", O_RDONLY);
3490 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
3494 if (dup2(fd, 0) == -1)
3496 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 0: %E");
3500 fd = open("/dev/null", O_WRONLY);
3503 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
3507 if (dup2(fd, 1) == -1)
3509 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 1: %E");
3516 } /* -END- if (daemon_mode) */
3519 * As soon as we have written the PID file, we can switch
3520 * to the user and group ID indicated by the --user option
3526 if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
3528 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
3532 if (setgroups(1, &grp->gr_gid))
3534 log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
3537 else if (initgroups(pw->pw_name, pw->pw_gid))
3539 log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
3545 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
3547 /* Read the time zone file from /etc before doing chroot. */
3549 if (NULL != pre_chroot_nslookup_to_load_resolver
3550 && '\0' != pre_chroot_nslookup_to_load_resolver[0])
3552 /* Initialize resolver library. */
3553 (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
3555 if (chroot(pw->pw_dir) < 0)
3557 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
3561 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
3564 if (setuid(pw->pw_uid))
3566 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
3570 char putenv_dummy[64];
3572 strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
3573 if (putenv(putenv_dummy) != 0)
3575 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
3578 snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
3579 if (putenv(putenv_dummy) != 0)
3581 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
3587 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
3590 #endif /* defined unix */
3593 /* This will be FALSE unless the command line specified --service
3597 /* Yup, so now we must attempt to establish a connection
3598 * with the service dispatcher. This will only work if this
3599 * process was launched by the service control manager to
3600 * actually run as a service. If this isn't the case, i've
3601 * known it take around 30 seconds or so for the call to return.
3604 /* The StartServiceCtrlDispatcher won't return until the service is stopping */
3605 if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
3607 /* Service has run, and at this point is now being stopped, so just return */
3612 printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
3614 /* An error occurred. Usually it's because --service was wrongly specified
3615 * and we were unable to connect to the Service Control Dispatcher because
3616 * it wasn't expecting us and is therefore not listening.
3618 * For now, just continue below to call the listen_loop function.
3621 #endif /* def _WIN32 */
3631 /*********************************************************************
3633 * Function : bind_port_helper
3635 * Description : Bind the listen port. Handles logging, and aborts
3639 * 1 : haddr = Host addres to bind to. Use NULL to bind to
3641 * 2 : hport = Specifies port to bind to.
3643 * Returns : Port that was opened.
3645 *********************************************************************/
3646 static jb_socket bind_port_helper(const char *haddr, int hport)
3651 result = bind_port(haddr, hport, &bfd);
3655 const char *bind_address = (NULL != haddr) ? haddr : "INADDR_ANY";
3659 log_error(LOG_LEVEL_FATAL,
3660 "can't bind to %s:%d: There may be another Privoxy "
3661 "or some other proxy running on port %d",
3662 bind_address, hport, hport);
3665 log_error(LOG_LEVEL_FATAL,
3666 "can't bind to %s:%d: The hostname is not resolvable",
3667 bind_address, hport);
3670 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: %E",
3671 bind_address, hport);
3674 /* shouldn't get here */
3675 return JB_INVALID_SOCKET;
3680 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
3685 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
3693 /*********************************************************************
3695 * Function : bind_ports_helper
3697 * Description : Bind the listen ports. Handles logging, and aborts
3701 * 1 : config = Privoxy configuration. Specifies ports
3703 * 2 : sockets = Preallocated array of opened sockets
3704 * corresponding to specification in config.
3705 * All non-opened sockets will be set to
3706 * JB_INVALID_SOCKET.
3708 * Returns : Nothing. Inspect sockets argument.
3710 *********************************************************************/
3711 static void bind_ports_helper(struct configuration_spec * config,
3712 jb_socket sockets[])
3716 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
3718 if (config->hport[i])
3720 sockets[i] = bind_port_helper(config->haddr[i], config->hport[i]);
3724 sockets[i] = JB_INVALID_SOCKET;
3727 config->need_bind = 0;
3731 /*********************************************************************
3733 * Function : close_ports_helper
3735 * Description : Close listenings ports.
3738 * 1 : sockets = Array of opened and non-opened sockets to
3739 * close. All sockets will be set to
3740 * JB_INVALID_SOCKET.
3742 * Returns : Nothing.
3744 *********************************************************************/
3745 static void close_ports_helper(jb_socket sockets[])
3749 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
3751 if (JB_INVALID_SOCKET != sockets[i])
3753 close_socket(sockets[i]);
3755 sockets[i] = JB_INVALID_SOCKET;
3761 /* Without this simple workaround we get this compiler warning from _beginthread
3762 * warning C4028: formal parameter 1 different from declaration
3764 void w32_service_listen_loop(void *p)
3768 #endif /* def _WIN32 */
3771 /*********************************************************************
3773 * Function : listen_loop
3775 * Description : bind the listen port and enter a "FOREVER" listening loop.
3781 *********************************************************************/
3782 static void listen_loop(void)
3784 struct client_states *csp_list = NULL;
3785 struct client_state *csp = NULL;
3786 jb_socket bfds[MAX_LISTENING_SOCKETS];
3787 struct configuration_spec *config;
3788 unsigned int active_threads = 0;
3790 config = load_config();
3792 #ifdef FEATURE_CONNECTION_SHARING
3794 * XXX: Should be relocated once it no
3795 * longer needs to emit log messages.
3797 initialize_reusable_connections();
3798 #endif /* def FEATURE_CONNECTION_SHARING */
3800 bind_ports_helper(config, bfds);
3802 #ifdef FEATURE_GRACEFUL_TERMINATION
3803 while (!g_terminate)
3808 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
3809 while (waitpid(-1, NULL, WNOHANG) > 0)
3811 /* zombie children */
3813 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
3816 * Free data that was used by died threads
3818 active_threads = sweep();
3822 * Re-open the errlog after HUP signal
3824 if (received_hup_signal)
3826 if (NULL != config->logfile)
3828 init_error_log(Argv[0], config->logfile);
3830 received_hup_signal = 0;
3834 csp_list = (struct client_states *)zalloc(sizeof(*csp_list));
3835 if (NULL == csp_list)
3837 log_error(LOG_LEVEL_FATAL,
3838 "malloc(%d) for csp_list failed: %E", sizeof(*csp_list));
3841 csp = &csp_list->csp;
3843 log_error(LOG_LEVEL_CONNECT, "Listening for new connections ... ");
3845 if (!accept_connection(csp, bfds))
3847 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
3859 csp->flags |= CSP_FLAG_ACTIVE;
3860 csp->server_connection.sfd = JB_INVALID_SOCKET;
3862 csp->config = config = load_config();
3864 if (config->need_bind)
3867 * Since we were listening to the "old port", we will not see
3868 * a "listen" param change until the next request. So, at
3869 * least 1 more request must be made for us to find the new
3870 * setting. I am simply closing the old socket and binding the
3873 * Which-ever is correct, we will serve 1 more page via the
3874 * old settings. This should probably be a "show-proxy-args"
3875 * request. This should not be a so common of an operation
3876 * that this will hurt people's feelings.
3879 close_ports_helper(bfds);
3881 bind_ports_helper(config, bfds);
3884 #ifdef FEATURE_TOGGLE
3885 if (global_toggle_state)
3886 #endif /* def FEATURE_TOGGLE */
3888 csp->flags |= CSP_FLAG_TOGGLED_ON;
3891 if (run_loader(csp))
3893 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
3894 /* Never get here - LOG_LEVEL_FATAL causes program exit */
3898 if (block_acl(NULL,csp))
3900 log_error(LOG_LEVEL_CONNECT,
3901 "Connection from %s on socket %d dropped due to ACL", csp->ip_addr_str, csp->cfd);
3902 close_socket(csp->cfd);
3903 freez(csp->ip_addr_str);
3907 #endif /* def FEATURE_ACL */
3909 if ((0 != config->max_client_connections)
3910 && (active_threads >= config->max_client_connections))
3912 log_error(LOG_LEVEL_CONNECT,
3913 "Rejecting connection from %s. Maximum number of connections reached.",
3915 write_socket(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
3916 strlen(TOO_MANY_CONNECTIONS_RESPONSE));
3917 close_socket(csp->cfd);
3918 freez(csp->ip_addr_str);
3923 /* add it to the list of clients */
3924 csp_list->next = clients->next;
3925 clients->next = csp_list;
3927 if (config->multi_threaded)
3931 /* this is a switch () statement in the C preprocessor - ugh */
3932 #undef SELECTED_ONE_OPTION
3934 /* Use Pthreads in preference to native code */
3935 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
3936 #define SELECTED_ONE_OPTION
3938 pthread_t the_thread;
3939 pthread_attr_t attrs;
3941 pthread_attr_init(&attrs);
3942 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
3943 errno = pthread_create(&the_thread, &attrs,
3944 (void * (*)(void *))serve, csp);
3945 child_id = errno ? -1 : 0;
3946 pthread_attr_destroy(&attrs);
3950 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
3951 #define SELECTED_ONE_OPTION
3952 child_id = _beginthread(
3953 (void (*)(void *))serve,
3958 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
3959 #define SELECTED_ONE_OPTION
3960 child_id = _beginthread(
3961 (void(* _Optlink)(void*))serve,
3967 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
3968 #define SELECTED_ONE_OPTION
3970 thread_id tid = spawn_thread
3971 (server_thread, "server", B_NORMAL_PRIORITY, csp);
3973 if ((tid >= 0) && (resume_thread(tid) == B_OK))
3975 child_id = (int) tid;
3984 #if defined(AMIGA) && !defined(SELECTED_ONE_OPTION)
3985 #define SELECTED_ONE_OPTION
3986 csp->cfd = ReleaseSocket(csp->cfd, -1);
3989 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
3990 NP_Output, Output(),
3991 NP_CloseOutput, FALSE,
3992 NP_Name, (ULONG)"privoxy child",
3996 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
3997 NP_Output, Output(),
3998 NP_CloseOutput, FALSE,
3999 NP_Name, (ULONG)"privoxy child",
4000 NP_StackSize, 200*1024,
4006 ((struct Task *)child_id)->tc_UserData = csp;
4007 Signal((struct Task *)child_id, SIGF_SINGLE);
4012 #if !defined(SELECTED_ONE_OPTION)
4015 /* This block is only needed when using fork().
4016 * When using threads, the server thread was
4017 * created and run by the call to _beginthread().
4019 if (child_id == 0) /* child */
4022 #ifdef FEATURE_TOGGLE
4023 int inherited_toggle_state = global_toggle_state;
4024 #endif /* def FEATURE_TOGGLE */
4029 * If we've been toggled or we've blocked the request, tell Mom
4032 #ifdef FEATURE_TOGGLE
4033 if (inherited_toggle_state != global_toggle_state)
4035 rc |= RC_FLAG_TOGGLED;
4037 #endif /* def FEATURE_TOGGLE */
4039 #ifdef FEATURE_STATISTICS
4040 if (csp->flags & CSP_FLAG_REJECTED)
4042 rc |= RC_FLAG_BLOCKED;
4044 #endif /* ndef FEATURE_STATISTICS */
4048 else if (child_id > 0) /* parent */
4050 /* in a fork()'d environment, the parent's
4051 * copy of the client socket and the CSP
4055 #if !defined(_WIN32) && !defined(__CYGWIN__)
4057 wait(&child_status);
4060 * Evaluate child's return code: If the child has
4061 * - been toggled, toggle ourselves
4062 * - blocked its request, bump up the stats counter
4065 #ifdef FEATURE_TOGGLE
4066 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
4068 global_toggle_state = !global_toggle_state;
4070 #endif /* def FEATURE_TOGGLE */
4072 #ifdef FEATURE_STATISTICS
4074 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
4078 #endif /* def FEATURE_STATISTICS */
4080 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
4081 close_socket(csp->cfd);
4082 csp->flags &= ~CSP_FLAG_ACTIVE;
4086 #undef SELECTED_ONE_OPTION
4087 /* end of cpp switch () */
4092 * Spawning the child failed, assume it's because
4093 * there are too many children running already.
4094 * XXX: If you assume ...
4096 log_error(LOG_LEVEL_ERROR,
4097 "Unable to take any additional connections: %E");
4098 write_socket(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
4099 strlen(TOO_MANY_CONNECTIONS_RESPONSE));
4100 close_socket(csp->cfd);
4101 csp->flags &= ~CSP_FLAG_ACTIVE;
4110 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
4112 /* Clean up. Aim: free all memory (no leaks) */
4113 #ifdef FEATURE_GRACEFUL_TERMINATION
4115 log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
4117 unload_current_config_file();
4118 unload_current_actions_file();
4119 unload_current_re_filterfile();
4120 #ifdef FEATURE_TRUST
4121 unload_current_trust_file();
4124 if (config->multi_threaded)
4131 } while ((clients->next != NULL) && (--i > 0));
4135 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
4145 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
4146 /* Cleanup - remove taskbar icon etc. */
4151 #endif /* FEATURE_GRACEFUL_TERMINATION */