1 const char jcc_rcs[] = "$Id: jcc.c,v 1.280 2009/08/28 14:42:06 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-2009 the SourceForge
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_state 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(struct configuration_spec *config);
155 static void listen_loop(void);
158 void serve(struct client_state *csp);
159 #else /* ifndef AMIGA */
160 static void serve(struct client_state *csp);
161 #endif /* def AMIGA */
164 static int32 server_thread(void *data);
165 #endif /* def __BEOS__ */
168 #define sleep(N) Sleep(((N) * 1000))
172 #define sleep(N) DosSleep(((N) * 100))
175 #ifdef MUTEX_LOCKS_AVAILABLE
177 * XXX: Does the locking stuff really belong in this file?
179 privoxy_mutex_t log_mutex;
180 privoxy_mutex_t log_init_mutex;
181 privoxy_mutex_t connection_reuse_mutex;
183 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
184 privoxy_mutex_t resolver_mutex;
185 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
187 #ifndef HAVE_GMTIME_R
188 privoxy_mutex_t gmtime_mutex;
189 #endif /* ndef HAVE_GMTIME_R */
191 #ifndef HAVE_LOCALTIME_R
192 privoxy_mutex_t localtime_mutex;
193 #endif /* ndef HAVE_GMTIME_R */
196 privoxy_mutex_t rand_mutex;
197 #endif /* ndef HAVE_RANDOM */
199 #endif /* def MUTEX_LOCKS_AVAILABLE */
202 const char *basedir = NULL;
203 const char *pidfile = NULL;
204 static int received_hup_signal = 0;
205 #endif /* defined unix */
207 /* HTTP snipplets. */
208 static const char CSUCCEED[] =
209 "HTTP/1.0 200 Connection established\r\n"
210 "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
212 static const char CHEADER[] =
213 "HTTP/1.0 400 Invalid header received from client\r\n"
214 "Proxy-Agent: Privoxy " VERSION "\r\n"
215 "Content-Type: text/plain\r\n"
216 "Connection: close\r\n\r\n"
217 "Invalid header received from client.\r\n";
219 static const char FTP_RESPONSE[] =
220 "HTTP/1.0 400 Invalid request received from client\r\n"
221 "Content-Type: text/plain\r\n"
222 "Connection: close\r\n\r\n"
223 "Invalid request. Privoxy doesn't support FTP.\r\n";
225 static const char GOPHER_RESPONSE[] =
226 "HTTP/1.0 400 Invalid request received from client\r\n"
227 "Content-Type: text/plain\r\n"
228 "Connection: close\r\n\r\n"
229 "Invalid request. Privoxy doesn't support gopher.\r\n";
231 /* XXX: should be a template */
232 static const char MISSING_DESTINATION_RESPONSE[] =
233 "HTTP/1.0 400 Bad request received from client\r\n"
234 "Proxy-Agent: Privoxy " VERSION "\r\n"
235 "Content-Type: text/plain\r\n"
236 "Connection: close\r\n\r\n"
237 "Bad request. Privoxy was unable to extract the destination.\r\n";
239 /* XXX: should be a template */
240 static const char INVALID_SERVER_HEADERS_RESPONSE[] =
241 "HTTP/1.0 502 Server or forwarder response invalid\r\n"
242 "Proxy-Agent: Privoxy " VERSION "\r\n"
243 "Content-Type: text/plain\r\n"
244 "Connection: close\r\n\r\n"
245 "Bad response. The server or forwarder response doesn't look like HTTP.\r\n";
248 /* XXX: should be a template */
249 static const char NULL_BYTE_RESPONSE[] =
250 "HTTP/1.0 400 Bad request received from client\r\n"
251 "Proxy-Agent: Privoxy " VERSION "\r\n"
252 "Content-Type: text/plain\r\n"
253 "Connection: close\r\n\r\n"
254 "Bad request. Null byte(s) before end of request.\r\n";
257 /* XXX: should be a template */
258 static const char MESSED_UP_REQUEST_RESPONSE[] =
259 "HTTP/1.0 400 Malformed request after rewriting\r\n"
260 "Proxy-Agent: Privoxy " VERSION "\r\n"
261 "Content-Type: text/plain\r\n"
262 "Connection: close\r\n\r\n"
263 "Bad request. Messed up with header filters.\r\n";
265 static const char TOO_MANY_CONNECTIONS_RESPONSE[] =
266 "HTTP/1.0 503 Too many open connections\r\n"
267 "Proxy-Agent: Privoxy " VERSION "\r\n"
268 "Content-Type: text/plain\r\n"
269 "Connection: close\r\n\r\n"
270 "Maximum number of open connections reached.\r\n";
272 static const char CLIENT_CONNECTION_TIMEOUT_RESPONSE[] =
273 "HTTP/1.0 504 Connection timeout\r\n"
274 "Proxy-Agent: Privoxy " VERSION "\r\n"
275 "Content-Type: text/plain\r\n"
276 "Connection: close\r\n\r\n"
277 "The connection timed out because the client request didn't arrive in time.\r\n";
279 /* A function to crunch a response */
280 typedef struct http_response *(*crunch_func_ptr)(struct client_state *);
282 /* Crunch function flags */
283 #define CF_NO_FLAGS 0
284 /* Cruncher applies to forced requests as well */
285 #define CF_IGNORE_FORCE 1
286 /* Crunched requests are counted for the block statistics */
287 #define CF_COUNT_AS_REJECT 2
289 /* A crunch function and its flags */
292 const crunch_func_ptr cruncher;
296 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[]);
298 /* Complete list of cruncher functions */
299 static const struct cruncher crunchers_all[] = {
300 { direct_response, CF_COUNT_AS_REJECT|CF_IGNORE_FORCE},
301 { block_url, CF_COUNT_AS_REJECT },
303 { trust_url, CF_COUNT_AS_REJECT },
304 #endif /* def FEATURE_TRUST */
305 { redirect_url, CF_NO_FLAGS },
306 { dispatch_cgi, CF_IGNORE_FORCE},
310 /* Light version, used after tags are applied */
311 static const struct cruncher crunchers_light[] = {
312 { block_url, CF_COUNT_AS_REJECT },
313 { redirect_url, CF_NO_FLAGS },
319 * XXX: Don't we really mean
325 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
326 /*********************************************************************
328 * Function : sig_handler
330 * Description : Signal handler for different signals.
331 * Exit gracefully on TERM and INT
332 * or set a flag that will cause the errlog
333 * to be reopened by the main thread on HUP.
336 * 1 : the_signal = the signal cause this function to call
340 *********************************************************************/
341 static void sig_handler(int the_signal)
347 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
359 received_hup_signal = 1;
365 * We shouldn't be here, unless we catch signals
366 * in main() that we can't handle here!
368 log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
376 /*********************************************************************
378 * Function : client_protocol_is_unsupported
380 * Description : Checks if the client used a known unsupported
381 * protocol and deals with it by sending an error
385 * 1 : csp = Current client state (buffers, headers, etc...)
386 * 2 : req = the first request line send by the client
388 * Returns : TRUE if an error response has been generated, or
389 * FALSE if the request doesn't look invalid.
391 *********************************************************************/
392 static int client_protocol_is_unsupported(const struct client_state *csp, char *req)
395 * If it's a FTP or gopher request, we don't support it.
397 * These checks are better than nothing, but they might
398 * not work in all configurations and some clients might
399 * have problems digesting the answer.
401 * They should, however, never cause more problems than
402 * Privoxy's old behaviour (returning the misleading HTML
405 * "Could not resolve http://(ftp|gopher)://example.org").
407 if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
409 const char *response = NULL;
410 const char *protocol = NULL;
412 if (!strncmpic(req, "GET ftp://", 10))
414 response = FTP_RESPONSE;
419 response = GOPHER_RESPONSE;
422 log_error(LOG_LEVEL_ERROR,
423 "%s tried to use Privoxy as %s proxy: %s",
424 csp->ip_addr_str, protocol, req);
425 log_error(LOG_LEVEL_CLF,
426 "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, req);
428 write_socket(csp->cfd, response, strlen(response));
437 /*********************************************************************
439 * Function : get_request_destination_elsewhere
441 * Description : If the client's request was redirected into
442 * Privoxy without the client's knowledge,
443 * the request line lacks the destination host.
445 * This function tries to get it elsewhere,
446 * provided accept-intercepted-requests is enabled.
448 * "Elsewhere" currently only means "Host: header",
449 * but in the future we may ask the redirecting
450 * packet filter to look the destination up.
452 * If the destination stays unknown, an error
453 * response is send to the client and headers
454 * are freed so that chat() can return directly.
457 * 1 : csp = Current client state (buffers, headers, etc...)
458 * 2 : headers = a header list
460 * Returns : JB_ERR_OK if the destination is now known, or
461 * JB_ERR_PARSE if it isn't.
463 *********************************************************************/
464 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
468 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
470 log_error(LOG_LEVEL_ERROR, "%s's request: \'%s\' is invalid."
471 " Privoxy isn't configured to accept intercepted requests.",
472 csp->ip_addr_str, csp->http->cmd);
473 /* XXX: Use correct size */
474 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
475 csp->ip_addr_str, csp->http->cmd);
477 write_socket(csp->cfd, CHEADER, strlen(CHEADER));
478 destroy_list(headers);
482 else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
484 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
485 /* Split the domain we just got for pattern matching */
486 init_domain_components(csp->http);
493 /* We can't work without destination. Go spread the news.*/
495 req = list_to_text(headers);
497 /* XXX: Use correct size */
498 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
499 csp->ip_addr_str, csp->http->cmd);
500 log_error(LOG_LEVEL_ERROR,
501 "Privoxy was unable to get the destination for %s's request:\n%s\n%s",
502 csp->ip_addr_str, csp->http->cmd, req);
505 write_socket(csp->cfd, MISSING_DESTINATION_RESPONSE, strlen(MISSING_DESTINATION_RESPONSE));
506 destroy_list(headers);
511 * TODO: If available, use PF's ioctl DIOCNATLOOK as last resort
512 * to get the destination IP address, use it as host directly
513 * or do a reverse DNS lookup first.
518 /*********************************************************************
520 * Function : get_server_headers
522 * Description : Parses server headers in iob and fills them
523 * into csp->headers so that they can later be
527 * 1 : csp = Current client state (buffers, headers, etc...)
529 * Returns : JB_ERR_OK if everything went fine, or
530 * JB_ERR_PARSE if the headers were incomplete.
532 *********************************************************************/
533 static jb_err get_server_headers(struct client_state *csp)
535 int continue_hack_in_da_house = 0;
538 while (((header = get_header(csp->iob)) != NULL) || continue_hack_in_da_house)
543 * continue hack in da house. Ignore the ending of
544 * this head and continue enlisting header lines.
545 * The reason is described below.
547 enlist(csp->headers, "");
548 continue_hack_in_da_house = 0;
551 else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
554 * It's a bodyless continue response, don't
555 * stop header parsing after reaching its end.
557 * As a result Privoxy will concatenate the
558 * next response's head and parse and deliver
559 * the headers as if they belonged to one request.
561 * The client will separate them because of the
562 * empty line between them.
564 * XXX: What we're doing here is clearly against
565 * the intended purpose of the continue header,
566 * and under some conditions (HTTP/1.0 client request)
567 * it's a standard violation.
569 * Anyway, "sort of against the spec" is preferable
570 * to "always getting confused by Continue responses"
571 * (Privoxy's behaviour before this hack was added)
573 log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
574 continue_hack_in_da_house = 1;
576 else if (*header == '\0')
579 * If the header is empty, but the Continue hack
580 * isn't active, we can assume that we reached the
581 * end of the buffer before we hit the end of the
584 * Inform the caller an let it decide how to handle it.
589 if (JB_ERR_MEMORY == enlist(csp->headers, header))
592 * XXX: Should we quit the request and return a
593 * out of memory error page instead?
595 log_error(LOG_LEVEL_ERROR,
596 "Out of memory while enlisting server headers. %s lost.",
606 /*********************************************************************
608 * Function : crunch_reason
610 * Description : Translates the crunch reason code into a string.
613 * 1 : rsp = a http_response
615 * Returns : A string with the crunch reason or an error description.
617 *********************************************************************/
618 static const char *crunch_reason(const struct http_response *rsp)
620 char * reason = NULL;
625 return "Internal error while searching for crunch reason";
630 case RSP_REASON_UNSUPPORTED:
631 reason = "Unsupported HTTP feature";
633 case RSP_REASON_BLOCKED:
636 case RSP_REASON_UNTRUSTED:
637 reason = "Untrusted";
639 case RSP_REASON_REDIRECTED:
640 reason = "Redirected";
642 case RSP_REASON_CGI_CALL:
645 case RSP_REASON_NO_SUCH_DOMAIN:
646 reason = "DNS failure";
648 case RSP_REASON_FORWARDING_FAILED:
649 reason = "Forwarding failed";
651 case RSP_REASON_CONNECT_FAILED:
652 reason = "Connection failure";
654 case RSP_REASON_OUT_OF_MEMORY:
655 reason = "Out of memory (may mask other reasons)";
657 case RSP_REASON_CONNECTION_TIMEOUT:
658 reason = "Connection timeout";
660 case RSP_REASON_NO_SERVER_DATA:
661 reason = "No server data received";
664 reason = "No reason recorded";
672 /*********************************************************************
674 * Function : send_crunch_response
676 * Description : Delivers already prepared response for
677 * intercepted requests, logs the interception
678 * and frees the response.
681 * 1 : csp = Current client state (buffers, headers, etc...)
682 * 1 : rsp = Fully prepared response. Will be freed on exit.
686 *********************************************************************/
687 static void send_crunch_response(const struct client_state *csp, struct http_response *rsp)
689 const struct http_request *http = csp->http;
693 assert(rsp->head != NULL);
698 * Not supposed to happen. If it does
699 * anyway, treat it as an unknown error.
701 cgi_error_unknown(csp, rsp, RSP_REASON_INTERNAL_ERROR);
702 /* return code doesn't matter */
707 /* If rsp is still NULL, we have serious internal problems. */
708 log_error(LOG_LEVEL_FATAL,
709 "NULL response in send_crunch_response and cgi_error_unknown failed as well.");
713 * Extract the status code from the actual head
714 * that was send to the client. It is the only
715 * way to get it right for all requests, including
716 * the fixed ones for out-of-memory problems.
718 * A head starts like this: 'HTTP/1.1 200...'
722 status_code[0] = rsp->head[9];
723 status_code[1] = rsp->head[10];
724 status_code[2] = rsp->head[11];
725 status_code[3] = '\0';
727 /* Write the answer to the client */
728 if (write_socket(csp->cfd, rsp->head, rsp->head_length)
729 || write_socket(csp->cfd, rsp->body, rsp->content_length))
731 /* There is nothing we can do about it. */
732 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", csp->http->host);
735 /* Log that the request was crunched and why. */
736 log_error(LOG_LEVEL_CRUNCH, "%s: %s", crunch_reason(rsp), http->url);
737 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" %s %u",
738 csp->ip_addr_str, http->ocmd, status_code, rsp->content_length);
740 /* Clean up and return */
741 if (cgi_error_memory() != rsp)
743 free_http_response(rsp);
750 /*********************************************************************
752 * Function : request_contains_null_bytes
754 * Description : Checks for NULL bytes in the request and sends
755 * an error message to the client if any were found.
757 * XXX: currently not used, see comment in chat().
760 * 1 : csp = Current client state (buffers, headers, etc...)
761 * 2 : buf = Data from the client's request to check.
762 * 3 : len = The data length.
764 * Returns : TRUE if the request contained one or more NULL bytes, or
767 *********************************************************************/
768 static int request_contains_null_bytes(const struct client_state *csp, char *buf, int len)
770 size_t c_len; /* Request lenght when treated as C string */
777 * Null byte(s) found. Log the request,
778 * return an error response and hang up.
780 size_t tmp_len = c_len;
785 * Replace NULL byte(s) with '°' characters
786 * so the request can be logged as string.
787 * XXX: Is there a better replacement character?
790 tmp_len += strlen(buf+tmp_len);
791 } while (tmp_len < len);
793 log_error(LOG_LEVEL_ERROR, "%s\'s request contains at least one NULL byte "
794 "(length=%d, strlen=%u).", csp->ip_addr_str, len, c_len);
795 log_error(LOG_LEVEL_HEADER,
796 "Offending request data with NULL bytes turned into \'°\' characters: %s", buf);
798 write_socket(csp->cfd, NULL_BYTE_RESPONSE, strlen(NULL_BYTE_RESPONSE));
800 /* XXX: Log correct size */
801 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
811 /*********************************************************************
813 * Function : crunch_response_triggered
815 * Description : Checks if the request has to be crunched,
816 * and delivers the crunch response if necessary.
819 * 1 : csp = Current client state (buffers, headers, etc...)
820 * 2 : crunchers = list of cruncher functions to run
822 * Returns : TRUE if the request was answered with a crunch response
825 *********************************************************************/
826 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[])
828 struct http_response *rsp = NULL;
829 const struct cruncher *c;
832 * If CGI request crunching is disabled,
833 * check the CGI dispatcher out of order to
834 * prevent unintentional blocks or redirects.
836 if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_CRUNCHING)
837 && (NULL != (rsp = dispatch_cgi(csp))))
839 /* Deliver, log and free the interception response. */
840 send_crunch_response(csp, rsp);
844 for (c = crunchers; c->cruncher != NULL; c++)
847 * Check the cruncher if either Privoxy is toggled
848 * on and the request isn't forced, or if the cruncher
849 * applies to forced requests as well.
851 if (((csp->flags & CSP_FLAG_TOGGLED_ON) &&
852 !(csp->flags & CSP_FLAG_FORCED)) ||
853 (c->flags & CF_IGNORE_FORCE))
855 rsp = c->cruncher(csp);
858 /* Deliver, log and free the interception response. */
859 send_crunch_response(csp, rsp);
860 #ifdef FEATURE_STATISTICS
861 if (c->flags & CF_COUNT_AS_REJECT)
863 csp->flags |= CSP_FLAG_REJECTED;
865 #endif /* def FEATURE_STATISTICS */
876 /*********************************************************************
878 * Function : build_request_line
880 * Description : Builds the HTTP request line.
882 * If a HTTP forwarder is used it expects the whole URL,
883 * web servers only get the path.
886 * 1 : csp = Current client state (buffers, headers, etc...)
887 * 2 : fwd = The forwarding spec used for the request
888 * XXX: Should use http->fwd instead.
889 * 3 : request_line = The old request line which will be replaced.
891 * Returns : Nothing. Terminates in case of memory problems.
893 *********************************************************************/
894 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line)
896 struct http_request *http = csp->http;
898 assert(http->ssl == 0);
901 * Downgrade http version from 1.1 to 1.0
902 * if +downgrade action applies.
904 if ( (csp->action->flags & ACTION_DOWNGRADE)
905 && (!strcmpic(http->ver, "HTTP/1.1")))
908 http->ver = strdup("HTTP/1.0");
910 if (http->ver == NULL)
912 log_error(LOG_LEVEL_FATAL, "Out of memory downgrading HTTP version");
917 * Rebuild the request line.
919 freez(*request_line);
920 *request_line = strdup(http->gpc);
921 string_append(request_line, " ");
923 if (fwd->forward_host)
925 string_append(request_line, http->url);
929 string_append(request_line, http->path);
931 string_append(request_line, " ");
932 string_append(request_line, http->ver);
934 if (*request_line == NULL)
936 log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
938 log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", *request_line);
942 /*********************************************************************
944 * Function : change_request_destination
946 * Description : Parse a (rewritten) request line and regenerate
947 * the http request data.
950 * 1 : csp = Current client state (buffers, headers, etc...)
952 * Returns : Forwards the parse_http_request() return code.
953 * Terminates in case of memory problems.
955 *********************************************************************/
956 static jb_err change_request_destination(struct client_state *csp)
958 struct http_request *http = csp->http;
961 log_error(LOG_LEVEL_INFO, "Rewrite detected: %s", csp->headers->first->str);
962 free_http_request(http);
963 err = parse_http_request(csp->headers->first->str, http);
964 if (JB_ERR_OK != err)
966 log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
967 jb_err_to_string(err));
971 /* XXX: ocmd is a misleading name */
972 http->ocmd = strdup(http->cmd);
973 if (http->ocmd == NULL)
975 log_error(LOG_LEVEL_FATAL,
976 "Out of memory copying rewritten HTTP request line");
984 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
985 /*********************************************************************
987 * Function : server_response_is_complete
989 * Description : Determines whether we should stop reading
990 * from the server socket.
993 * 1 : csp = Current client state (buffers, headers, etc...)
994 * 2 : content_length = Length of content received so far.
996 * Returns : TRUE if the response is complete,
999 *********************************************************************/
1000 static int server_response_is_complete(struct client_state *csp,
1001 unsigned long long content_length)
1003 int content_length_known = !!(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET);
1005 if (!strcmpic(csp->http->gpc, "HEAD"))
1008 * "HEAD" implies no body, we are thus expecting
1009 * no content. XXX: incomplete "list" of methods?
1011 csp->expected_content_length = 0;
1012 content_length_known = TRUE;
1015 if (csp->http->status == 304)
1018 * Expect no body. XXX: incomplete "list" of status codes?
1020 csp->expected_content_length = 0;
1021 content_length_known = TRUE;
1024 return (content_length_known && ((0 == csp->expected_content_length)
1025 || (csp->expected_content_length <= content_length)));
1029 /*********************************************************************
1031 * Function : wait_for_alive_connections
1033 * Description : Waits for alive connections to timeout.
1039 *********************************************************************/
1040 static void wait_for_alive_connections(void)
1042 int connections_alive = close_unusable_connections();
1044 while (0 < connections_alive)
1046 log_error(LOG_LEVEL_CONNECT,
1047 "Waiting for %d connections to timeout.",
1050 connections_alive = close_unusable_connections();
1053 log_error(LOG_LEVEL_CONNECT, "No connections to wait for left.");
1058 /*********************************************************************
1060 * Function : save_connection_destination
1062 * Description : Remembers a connection for reuse later on.
1065 * 1 : sfd = Open socket to remember.
1066 * 2 : http = The destination for the connection.
1067 * 3 : fwd = The forwarder settings used.
1068 * 3 : server_connection = storage.
1072 *********************************************************************/
1073 void save_connection_destination(jb_socket sfd,
1074 const struct http_request *http,
1075 const struct forward_spec *fwd,
1076 struct reusable_connection *server_connection)
1078 assert(sfd != JB_INVALID_SOCKET);
1079 assert(NULL != http->host);
1081 server_connection->sfd = sfd;
1082 server_connection->host = strdup(http->host);
1083 if (NULL == server_connection->host)
1085 log_error(LOG_LEVEL_FATAL, "Out of memory saving socket.");
1087 server_connection->port = http->port;
1089 assert(NULL != fwd);
1090 assert(server_connection->gateway_host == NULL);
1091 assert(server_connection->gateway_port == 0);
1092 assert(server_connection->forwarder_type == 0);
1093 assert(server_connection->forward_host == NULL);
1094 assert(server_connection->forward_port == 0);
1096 server_connection->forwarder_type = fwd->type;
1097 if (NULL != fwd->gateway_host)
1099 server_connection->gateway_host = strdup(fwd->gateway_host);
1100 if (NULL == server_connection->gateway_host)
1102 log_error(LOG_LEVEL_FATAL, "Out of memory saving gateway_host.");
1107 server_connection->gateway_host = NULL;
1109 server_connection->gateway_port = fwd->gateway_port;
1111 if (NULL != fwd->forward_host)
1113 server_connection->forward_host = strdup(fwd->forward_host);
1114 if (NULL == server_connection->forward_host)
1116 log_error(LOG_LEVEL_FATAL, "Out of memory saving forward_host.");
1121 server_connection->forward_host = NULL;
1123 server_connection->forward_port = fwd->forward_port;
1127 /*********************************************************************
1129 * Function : verify_request_length
1131 * Description : Checks if we already got the whole client requests
1132 * and sets CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ if
1135 * Data that doesn't belong to the current request is
1136 * thrown away to let the client retry on a clean socket.
1138 * XXX: This is a hack until we can deal with multiple
1139 * pipelined requests at the same time.
1143 * 1 : csp = Current client state (buffers, headers, etc...)
1147 *********************************************************************/
1148 static void verify_request_length(struct client_state *csp)
1150 unsigned long long buffered_request_bytes =
1151 (unsigned long long)(csp->iob->eod - csp->iob->cur);
1153 if ((csp->expected_client_content_length != 0)
1154 && (buffered_request_bytes != 0))
1156 if (csp->expected_client_content_length >= buffered_request_bytes)
1158 csp->expected_client_content_length -= buffered_request_bytes;
1159 log_error(LOG_LEVEL_CONNECT, "Reduced expected bytes to %llu "
1160 "to account for the %llu ones we already got.",
1161 csp->expected_client_content_length, buffered_request_bytes);
1165 assert(csp->iob->eod > csp->iob->cur + csp->expected_client_content_length);
1166 csp->iob->eod = csp->iob->cur + csp->expected_client_content_length;
1167 log_error(LOG_LEVEL_CONNECT, "Reducing expected bytes to 0. "
1168 "Marking the server socket tainted after throwing %llu bytes away.",
1169 buffered_request_bytes - csp->expected_client_content_length);
1170 csp->expected_client_content_length = 0;
1171 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1174 if (csp->expected_client_content_length == 0)
1176 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1180 if (!(csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ)
1181 && ((csp->iob->cur[0] != '\0') || (csp->expected_client_content_length != 0)))
1183 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1184 if (strcmpic(csp->http->gpc, "GET")
1185 && strcmpic(csp->http->gpc, "HEAD")
1186 && strcmpic(csp->http->gpc, "TRACE")
1187 && strcmpic(csp->http->gpc, "OPTIONS")
1188 && strcmpic(csp->http->gpc, "DELETE"))
1190 /* XXX: this is an incomplete hack */
1191 csp->flags &= ~CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1192 log_error(LOG_LEVEL_CONNECT,
1193 "There might be a request body. The connection will not be kept alive.");
1197 /* XXX: and so is this */
1198 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1199 log_error(LOG_LEVEL_CONNECT,
1200 "Possible pipeline attempt detected. The connection will not "
1201 "be kept alive and we will only serve the first request.");
1202 /* Nuke the pipelined requests from orbit, just to be sure. */
1203 csp->iob->buf[0] = '\0';
1204 csp->iob->eod = csp->iob->cur = csp->iob->buf;
1209 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1210 log_error(LOG_LEVEL_CONNECT, "Complete client request received.");
1213 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1216 /*********************************************************************
1218 * Function : mark_server_socket_tainted
1220 * Description : Makes sure we don't reuse a server socket
1221 * (if we didn't read everything the server sent
1222 * us reusing the socket would lead to garbage).
1225 * 1 : csp = Current client state (buffers, headers, etc...)
1229 *********************************************************************/
1230 static void mark_server_socket_tainted(struct client_state *csp)
1232 if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE))
1234 log_error(LOG_LEVEL_CONNECT,
1235 "Marking the server socket %d tainted.", csp->sfd);
1236 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1240 /*********************************************************************
1242 * Function : get_request_line
1244 * Description : Read the client request line.
1247 * 1 : csp = Current client state (buffers, headers, etc...)
1249 * Returns : Pointer to request line or NULL in case of errors.
1251 *********************************************************************/
1252 static char *get_request_line(struct client_state *csp)
1254 char buf[BUFFER_SIZE];
1255 char *request_line = NULL;
1258 memset(buf, 0, sizeof(buf));
1262 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1264 log_error(LOG_LEVEL_ERROR,
1265 "Stopped waiting for the request line.");
1266 write_socket(csp->cfd, CLIENT_CONNECTION_TIMEOUT_RESPONSE,
1267 strlen(CLIENT_CONNECTION_TIMEOUT_RESPONSE));
1271 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1273 if (len <= 0) return NULL;
1276 * If there is no memory left for buffering the
1277 * request, there is nothing we can do but hang up
1279 if (add_to_iob(csp, buf, len))
1284 request_line = get_header(csp->iob);
1286 } while ((NULL != request_line) && ('\0' == *request_line));
1288 return request_line;
1293 /*********************************************************************
1295 * Function : receive_client_request
1297 * Description : Read the client's request (more precisely the
1298 * client headers) and answer it if necessary.
1300 * Note that since we're not using select() we could get
1301 * blocked here if a client connected, then didn't say
1305 * 1 : csp = Current client state (buffers, headers, etc...)
1307 * Returns : JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
1309 *********************************************************************/
1310 static jb_err receive_client_request(struct client_state *csp)
1312 char buf[BUFFER_SIZE];
1315 struct http_request *http;
1319 /* Temporary copy of the client's headers before they get enlisted in csp->headers */
1320 struct list header_list;
1321 struct list *headers = &header_list;
1325 memset(buf, 0, sizeof(buf));
1327 req = get_request_line(csp);
1330 return JB_ERR_PARSE;
1332 assert(*req != '\0');
1334 if (client_protocol_is_unsupported(csp, req))
1336 return JB_ERR_PARSE;
1339 #ifdef FEATURE_FORCE_LOAD
1341 * If this request contains the FORCE_PREFIX and blocks
1342 * aren't enforced, get rid of it and set the force flag.
1344 if (strstr(req, FORCE_PREFIX))
1346 if (csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS)
1348 log_error(LOG_LEVEL_FORCE,
1349 "Ignored force prefix in request: \"%s\".", req);
1353 strclean(req, FORCE_PREFIX);
1354 log_error(LOG_LEVEL_FORCE, "Enforcing request: \"%s\".", req);
1355 csp->flags |= CSP_FLAG_FORCED;
1358 #endif /* def FEATURE_FORCE_LOAD */
1360 err = parse_http_request(req, http);
1362 if (JB_ERR_OK != err)
1364 write_socket(csp->cfd, CHEADER, strlen(CHEADER));
1365 /* XXX: Use correct size */
1366 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1367 log_error(LOG_LEVEL_ERROR,
1368 "Couldn't parse request line received from %s: %s",
1369 csp->ip_addr_str, jb_err_to_string(err));
1371 free_http_request(http);
1372 return JB_ERR_PARSE;
1375 /* grab the rest of the client's headers */
1379 p = get_header(csp->iob);
1383 /* There are no additional headers to read. */
1390 * We didn't receive a complete header
1391 * line yet, get the rest of it.
1393 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1395 log_error(LOG_LEVEL_ERROR,
1396 "Stopped grabbing the client headers.");
1397 destroy_list(headers);
1398 return JB_ERR_PARSE;
1401 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1404 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1405 destroy_list(headers);
1406 return JB_ERR_PARSE;
1409 if (add_to_iob(csp, buf, len))
1412 * If there is no memory left for buffering the
1413 * request, there is nothing we can do but hang up
1415 destroy_list(headers);
1416 return JB_ERR_MEMORY;
1422 * We were able to read a complete
1423 * header and can finaly enlist it.
1430 if (http->host == NULL)
1433 * If we still don't know the request destination,
1434 * the request is invalid or the client uses
1435 * Privoxy without its knowledge.
1437 if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
1440 * Our attempts to get the request destination
1441 * elsewhere failed or Privoxy is configured
1442 * to only accept proxy requests.
1444 * An error response has already been send
1445 * and we're done here.
1447 return JB_ERR_PARSE;
1452 * Determine the actions for this URL
1454 #ifdef FEATURE_TOGGLE
1455 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
1457 /* Most compatible set of actions (i.e. none) */
1458 init_current_action(csp->action);
1461 #endif /* ndef FEATURE_TOGGLE */
1463 get_url_actions(csp, http);
1467 * Save a copy of the original request for logging
1469 http->ocmd = strdup(http->cmd);
1470 if (http->ocmd == NULL)
1472 log_error(LOG_LEVEL_FATAL,
1473 "Out of memory copying HTTP request line");
1475 enlist(csp->headers, http->cmd);
1477 /* Append the previously read headers */
1478 list_append_list_unique(csp->headers, headers);
1479 destroy_list(headers);
1486 /*********************************************************************
1488 * Function : parse_client_request
1490 * Description : Parses the client's request and decides what to do
1493 * Note that since we're not using select() we could get
1494 * blocked here if a client connected, then didn't say
1498 * 1 : csp = Current client state (buffers, headers, etc...)
1500 * Returns : JB_ERR_OK or JB_ERR_PARSE
1502 *********************************************************************/
1503 static jb_err parse_client_request(struct client_state *csp)
1505 struct http_request *http = csp->http;
1508 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1509 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
1510 && (!strcmpic(csp->http->ver, "HTTP/1.1"))
1511 && (csp->http->ssl == 0))
1513 /* Assume persistence until further notice */
1514 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1516 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1518 err = sed(csp, FILTER_CLIENT_HEADERS);
1519 if (JB_ERR_OK != err)
1521 /* XXX: Should be handled in sed(). */
1522 assert(err == JB_ERR_PARSE);
1523 log_error(LOG_LEVEL_FATAL, "Failed to parse client headers.");
1525 csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
1527 /* Check request line for rewrites. */
1528 if ((NULL == csp->headers->first->str)
1529 || (strcmp(http->cmd, csp->headers->first->str) &&
1530 (JB_ERR_OK != change_request_destination(csp))))
1533 * A header filter broke the request line - bail out.
1535 write_socket(csp->cfd, MESSED_UP_REQUEST_RESPONSE, strlen(MESSED_UP_REQUEST_RESPONSE));
1536 /* XXX: Use correct size */
1537 log_error(LOG_LEVEL_CLF,
1538 "%s - - [%T] \"Invalid request generated\" 500 0", csp->ip_addr_str);
1539 log_error(LOG_LEVEL_ERROR,
1540 "Invalid request line after applying header filters.");
1541 free_http_request(http);
1543 return JB_ERR_PARSE;
1546 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1547 if (csp->http->ssl == 0)
1549 verify_request_length(csp);
1551 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1558 /*********************************************************************
1562 * Description : Once a connection to the client has been accepted,
1563 * this function is called (via serve()) to handle the
1564 * main business of the communication. When this
1565 * function returns, the caller must close the client
1568 * FIXME: chat is nearly thousand lines long.
1572 * 1 : csp = Current client state (buffers, headers, etc...)
1574 * Returns : Nothing.
1576 *********************************************************************/
1577 static void chat(struct client_state *csp)
1579 char buf[BUFFER_SIZE];
1586 int ms_iis5_hack = 0;
1587 unsigned long long byte_count = 0;
1588 int forwarded_connect_retries = 0;
1589 int max_forwarded_connect_retries = csp->config->forwarded_connect_retries;
1590 const struct forward_spec *fwd;
1591 struct http_request *http;
1592 long len = 0; /* for buffer sizes (and negative error codes) */
1594 /* Function that does the content filtering for the current request */
1595 filter_function_ptr content_filter = NULL;
1597 /* Skeleton for HTTP response, if we should intercept the request */
1598 struct http_response *rsp;
1599 struct timeval timeout;
1601 memset(buf, 0, sizeof(buf));
1605 if (receive_client_request(csp) != JB_ERR_OK)
1609 if (parse_client_request(csp) != JB_ERR_OK)
1614 /* decide how to route the HTTP request */
1615 fwd = forward_url(csp, http);
1618 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!? This can't happen!");
1619 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1624 * build the http request to send to the server
1625 * we have to do one of the following:
1627 * create = use the original HTTP request to create a new
1628 * HTTP request that has either the path component
1629 * without the http://domainspec (w/path) or the
1630 * full orininal URL (w/url)
1631 * Note that the path and/or the HTTP version may
1632 * have been altered by now.
1634 * connect = Open a socket to the host:port of the server
1635 * and short-circuit server and client socket.
1637 * pass = Pass the request unchanged if forwarding a CONNECT
1638 * request to a parent proxy. Note that we'll be sending
1639 * the CFAIL message ourselves if connecting to the parent
1640 * fails, but we won't send a CSUCCEED message if it works,
1641 * since that would result in a double message (ours and the
1642 * parent's). After sending the request to the parent, we simply
1645 * here's the matrix:
1648 * +--------+--------+
1650 * 0 | create | connect|
1652 * Forwarding +--------+--------+
1654 * 1 | create | pass |
1656 * +--------+--------+
1660 if (http->ssl && connect_port_is_forbidden(csp))
1662 const char *acceptable_connect_ports =
1663 csp->action->string[ACTION_STRING_LIMIT_CONNECT];
1664 assert(NULL != acceptable_connect_ports);
1665 log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
1666 "limit-connect{%s} doesn't allow CONNECT requests to port %d.",
1667 csp->ip_addr_str, acceptable_connect_ports, csp->http->port);
1668 csp->action->flags |= ACTION_BLOCK;
1674 freez(csp->headers->first->str);
1675 build_request_line(csp, fwd, &csp->headers->first->str);
1679 * We have a request. Check if one of the crunchers wants it.
1681 if (crunch_response_triggered(csp, crunchers_all))
1684 * Yes. The client got the crunch response
1685 * and we are done here after cleaning up.
1687 /* XXX: why list_remove_all()? */
1688 list_remove_all(csp->headers);
1693 log_error(LOG_LEVEL_GPC, "%s%s", http->hostport, http->path);
1695 if (fwd->forward_host)
1697 log_error(LOG_LEVEL_CONNECT, "via [%s]:%d to: %s",
1698 fwd->forward_host, fwd->forward_port, http->hostport);
1702 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
1705 /* here we connect to the server, gateway, or the forwarder */
1707 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1708 if ((csp->sfd != JB_INVALID_SOCKET)
1709 && socket_is_still_usable(csp->sfd)
1710 && connection_destination_matches(&csp->server_connection, http, fwd))
1712 log_error(LOG_LEVEL_CONNECT,
1713 "Reusing server socket %u. Opened for %s.",
1714 csp->sfd, csp->server_connection.host);
1718 if (csp->sfd != JB_INVALID_SOCKET)
1720 log_error(LOG_LEVEL_CONNECT,
1721 "Closing server socket %u. Opened for %s.",
1722 csp->sfd, csp->server_connection.host);
1723 close_socket(csp->sfd);
1724 mark_connection_closed(&csp->server_connection);
1726 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1728 while ((csp->sfd = forwarded_connect(fwd, http, csp))
1729 && (errno == EINVAL)
1730 && (forwarded_connect_retries++ < max_forwarded_connect_retries))
1732 log_error(LOG_LEVEL_ERROR,
1733 "failed request #%u to connect to %s. Trying again.",
1734 forwarded_connect_retries, http->hostport);
1737 if (csp->sfd == JB_INVALID_SOCKET)
1739 if (fwd->type != SOCKS_NONE)
1742 rsp = error_response(csp, "forwarding-failed");
1744 else if (errno == EINVAL)
1746 rsp = error_response(csp, "no-such-domain");
1750 rsp = error_response(csp, "connect-failed");
1751 log_error(LOG_LEVEL_CONNECT, "connect to: %s failed: %E",
1755 /* Write the answer to the client */
1758 send_crunch_response(csp, rsp);
1763 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1764 save_connection_destination(csp->sfd, http, fwd, &csp->server_connection);
1765 csp->server_connection.keep_alive_timeout = (unsigned)csp->config->keep_alive_timeout;
1767 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1769 hdr = list_to_text(csp->headers);
1772 /* FIXME Should handle error properly */
1773 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
1775 list_remove_all(csp->headers);
1777 if (fwd->forward_host || (http->ssl == 0))
1780 * Write the client's (modified) header to the server
1781 * (along with anything else that may be in the buffer)
1783 if (write_socket(csp->sfd, hdr, strlen(hdr))
1784 || (flush_socket(csp->sfd, csp->iob) < 0))
1786 log_error(LOG_LEVEL_CONNECT,
1787 "write header to: %s failed: %E", http->hostport);
1789 rsp = error_response(csp, "connect-failed");
1792 send_crunch_response(csp, rsp);
1802 * We're running an SSL tunnel and we're not forwarding,
1803 * so just send the "connect succeeded" message to the
1804 * client, flush the rest, and get out of the way.
1806 if (write_socket(csp->cfd, CSUCCEED, strlen(CSUCCEED)))
1814 log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
1816 csp->server_connection.request_sent = time(NULL);
1818 /* we're finished with the client's header */
1821 maxfd = (csp->cfd > csp->sfd) ? csp->cfd : csp->sfd;
1823 /* pass data between the client and server
1824 * until one or the other shuts down the connection.
1833 * FD_ZERO here seems to point to an errant macro which crashes.
1834 * So do this by hand for now...
1836 memset(&rfds,0x00,sizeof(fd_set));
1840 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1841 if ((csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ))
1846 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1848 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1851 log_error(LOG_LEVEL_CONNECT,
1852 "Allowing the client to continue talking. "
1853 "Expecting %llu bytes.", csp->expected_client_content_length);
1855 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1856 FD_SET(csp->cfd, &rfds);
1859 FD_SET(csp->sfd, &rfds);
1861 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1862 if ((csp->flags & CSP_FLAG_CHUNKED)
1863 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
1864 && ((csp->iob->eod - csp->iob->cur) >= 5)
1865 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
1867 log_error(LOG_LEVEL_CONNECT,
1868 "Looks like we read the last chunk together with "
1869 "the server headers. We better stop reading.");
1870 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
1871 csp->expected_content_length = byte_count;
1872 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
1874 if (server_body && server_response_is_complete(csp, byte_count))
1876 log_error(LOG_LEVEL_CONNECT,
1877 "Done reading from server. Expected content length: %llu. "
1878 "Actual content length: %llu. Most recently received: %d.",
1879 csp->expected_content_length, byte_count, len);
1882 * XXX: should not jump around,
1883 * chat() is complicated enough already.
1887 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1889 timeout.tv_sec = csp->config->socket_timeout;
1890 timeout.tv_usec = 0;
1891 n = select((int)maxfd+1, &rfds, NULL, NULL, &timeout);
1895 log_error(LOG_LEVEL_ERROR,
1896 "Didn't receive data in time: %s", http->url);
1897 if ((byte_count == 0) && (http->ssl == 0))
1899 send_crunch_response(csp, error_response(csp, "connection-timeout"));
1901 mark_server_socket_tainted(csp);
1906 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
1907 mark_server_socket_tainted(csp);
1912 * This is the body of the browser's request,
1913 * just read and write it.
1915 * XXX: Make sure the client doesn't use pipelining
1916 * behind Privoxy's back.
1918 if (FD_ISSET(csp->cfd, &rfds))
1920 unsigned max_bytes_to_read = sizeof(buf) - 1;
1922 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1923 if (csp->expected_client_content_length != 0)
1925 if (csp->expected_client_content_length < (sizeof(buf) - 1))
1927 max_bytes_to_read = csp->expected_client_content_length;
1929 log_error(LOG_LEVEL_CONNECT,
1930 "Waiting for up to %d bytes from the client.",
1933 assert(max_bytes_to_read < sizeof(buf));
1934 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1936 len = read_socket(csp->cfd, buf, max_bytes_to_read);
1940 /* XXX: not sure if this is necessary. */
1941 mark_server_socket_tainted(csp);
1942 break; /* "game over, man" */
1945 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1946 if (csp->expected_client_content_length != 0)
1948 assert(len <= max_bytes_to_read);
1949 csp->expected_client_content_length -= len;
1950 log_error(LOG_LEVEL_CONNECT,
1951 "Expected client content length set to %llu "
1952 "after reading %d bytes.",
1953 csp->expected_client_content_length, len);
1954 if (csp->expected_client_content_length == 0)
1956 log_error(LOG_LEVEL_CONNECT,
1957 "Done reading from the client.");
1958 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1961 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1963 if (write_socket(csp->sfd, buf, (size_t)len))
1965 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1966 mark_server_socket_tainted(csp);
1973 * The server wants to talk. It could be the header or the body.
1974 * If `hdr' is null, then it's the header otherwise it's the body.
1975 * FIXME: Does `hdr' really mean `host'? No.
1977 if (FD_ISSET(csp->sfd, &rfds))
1979 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1980 if (!socket_is_still_usable(csp->cfd))
1983 log_error(LOG_LEVEL_CONNECT,
1984 "The server still wants to talk, but the client may already have hung up on us.");
1986 log_error(LOG_LEVEL_CONNECT,
1987 "The server still wants to talk, but the client hung up on us.");
1988 mark_server_socket_tainted(csp);
1990 #endif /* def _WIN32 */
1992 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1995 len = read_socket(csp->sfd, buf, sizeof(buf) - 1);
1999 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
2001 if (http->ssl && (fwd->forward_host == NULL))
2004 * Just hang up. We already confirmed the client's CONNECT
2005 * request with status code 200 and unencrypted content is
2006 * no longer welcome.
2008 log_error(LOG_LEVEL_ERROR,
2009 "CONNECT already confirmed. Unable to tell the client about the problem.");
2012 else if (byte_count)
2015 * Just hang up. We already transmitted the original headers
2016 * and parts of the original content and therefore missed the
2017 * chance to send an error message (without risking data corruption).
2019 * XXX: we could retry with a fancy range request here.
2021 log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
2022 "Unable to tell the client about the problem.");
2023 mark_server_socket_tainted(csp);
2027 * XXX: Consider handling the cases above the same.
2029 mark_server_socket_tainted(csp);
2033 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2034 if (csp->flags & CSP_FLAG_CHUNKED)
2036 if ((len >= 5) && !memcmp(buf+len-5, "0\r\n\r\n", 5))
2038 /* XXX: this is a temporary hack */
2039 log_error(LOG_LEVEL_CONNECT,
2040 "Looks like we reached the end of the last chunk. "
2041 "We better stop reading.");
2042 csp->expected_content_length = byte_count + (unsigned long long)len;
2043 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2047 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2050 * Add a trailing zero to let be able to use string operations.
2051 * XXX: do we still need this with filter_popups gone?
2056 * Normally, this would indicate that we've read
2057 * as much as the server has sent us and we can
2058 * close the client connection. However, Microsoft
2059 * in its wisdom has released IIS/5 with a bug that
2060 * prevents it from sending the trailing \r\n in
2061 * a 302 redirect header (and possibly other headers).
2062 * To work around this if we've haven't parsed
2063 * a full header we'll append a trailing \r\n
2064 * and see if this now generates a valid one.
2066 * This hack shouldn't have any impacts. If we've
2067 * already transmitted the header or if this is a
2068 * SSL connection, then we won't bother with this
2069 * hack. So we only work on partially received
2070 * headers. If we append a \r\n and this still
2071 * doesn't generate a valid header, then we won't
2072 * transmit anything to the client.
2077 if (server_body || http->ssl)
2080 * If we have been buffering up the document,
2081 * now is the time to apply content modification
2082 * and send the result to the client.
2086 p = execute_content_filter(csp, content_filter);
2088 * If the content filter fails, use the original
2089 * buffer and length.
2090 * (see p != NULL ? p : csp->iob->cur below)
2094 csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
2097 if (JB_ERR_OK != update_server_headers(csp))
2099 log_error(LOG_LEVEL_FATAL,
2100 "Failed to update server headers. after filtering.");
2103 hdr = list_to_text(csp->headers);
2106 /* FIXME Should handle error properly */
2107 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2110 if (write_socket(csp->cfd, hdr, strlen(hdr))
2111 || write_socket(csp->cfd,
2112 ((p != NULL) ? p : csp->iob->cur), (size_t)csp->content_length))
2114 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
2117 mark_server_socket_tainted(csp);
2125 break; /* "game over, man" */
2129 * This is NOT the body, so
2130 * Let's pretend the server just sent us a blank line.
2132 snprintf(buf, sizeof(buf), "\r\n");
2133 len = (int)strlen(buf);
2136 * Now, let the normal header parsing algorithm below do its
2137 * job. If it fails, we'll exit instead of continuing.
2144 * If this is an SSL connection or we're in the body
2145 * of the server document, just write it to the client,
2146 * unless we need to buffer the body for later content-filtering
2148 if (server_body || http->ssl)
2153 * If there is no memory left for buffering the content, or the buffer limit
2154 * has been reached, switch to non-filtering mode, i.e. make & write the
2155 * header, flush the iob and buf, and get out of the way.
2157 if (add_to_iob(csp, buf, len))
2162 log_error(LOG_LEVEL_INFO,
2163 "Flushing header and buffers. Stepping back from filtering.");
2165 hdr = list_to_text(csp->headers);
2169 * Memory is too tight to even generate the header.
2170 * Send our static "Out-of-memory" page.
2172 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
2173 rsp = cgi_error_memory();
2174 send_crunch_response(csp, rsp);
2175 mark_server_socket_tainted(csp);
2178 hdrlen = strlen(hdr);
2180 if (write_socket(csp->cfd, hdr, hdrlen)
2181 || ((flushed = flush_socket(csp->cfd, csp->iob)) < 0)
2182 || (write_socket(csp->cfd, buf, (size_t)len)))
2184 log_error(LOG_LEVEL_CONNECT,
2185 "Flush header and buffers to client failed: %E");
2187 mark_server_socket_tainted(csp);
2192 * Reset the byte_count to the amount of bytes
2193 * we just flushed. len will be added a few lines below,
2194 * hdrlen doesn't matter for LOG_LEVEL_CLF.
2196 byte_count = (unsigned long long)flushed;
2198 content_filter = NULL;
2204 if (write_socket(csp->cfd, buf, (size_t)len))
2206 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
2207 mark_server_socket_tainted(csp);
2211 byte_count += (unsigned long long)len;
2216 const char *header_start;
2218 * We're still looking for the end of the server's header.
2219 * Buffer up the data we just read. If that fails, there's
2220 * little we can do but send our static out-of-memory page.
2222 if (add_to_iob(csp, buf, len))
2224 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
2225 rsp = cgi_error_memory();
2226 send_crunch_response(csp, rsp);
2227 mark_server_socket_tainted(csp);
2231 header_start = csp->iob->cur;
2233 /* Convert iob into something sed() can digest */
2234 if (JB_ERR_PARSE == get_server_headers(csp))
2239 * Well, we tried our MS IIS/5 hack and it didn't work.
2240 * The header is incomplete and there isn't anything
2241 * we can do about it.
2243 log_error(LOG_LEVEL_ERROR, "Invalid server headers. "
2244 "Applying the MS IIS5 hack didn't help.");
2245 log_error(LOG_LEVEL_CLF,
2246 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2247 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2248 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2249 mark_server_socket_tainted(csp);
2255 * Since we have to wait for more from the server before
2256 * we can parse the headers we just continue here.
2258 long header_offset = csp->iob->cur - header_start;
2259 assert(csp->iob->cur >= header_start);
2263 * If there's a header offset, we got content
2264 * as well and have to account for it.
2266 byte_count += (unsigned long long)(len - header_offset);
2268 log_error(LOG_LEVEL_CONNECT, "Continuing buffering headers. "
2269 "byte_count: %llu. header_offset: %d. len: %d.",
2270 byte_count, header_offset, len);
2275 /* Did we actually get anything? */
2276 if (NULL == csp->headers->first)
2278 log_error(LOG_LEVEL_ERROR,
2279 "Empty server or forwarder response received on socket %d.", csp->sfd);
2280 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2281 send_crunch_response(csp, error_response(csp, "no-server-data"));
2282 free_http_request(http);
2283 mark_server_socket_tainted(csp);
2287 assert(csp->headers->first->str);
2289 if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
2290 strncmpic(csp->headers->first->str, "ICY", 3))
2293 * It doesn't look like a HTTP (or Shoutcast) response:
2294 * tell the client and log the problem.
2296 if (strlen(csp->headers->first->str) > 30)
2298 csp->headers->first->str[30] = '\0';
2300 log_error(LOG_LEVEL_ERROR,
2301 "Invalid server or forwarder response. Starts with: %s",
2302 csp->headers->first->str);
2303 log_error(LOG_LEVEL_CLF,
2304 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2305 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2306 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2307 free_http_request(http);
2308 mark_server_socket_tainted(csp);
2313 * We have now received the entire server header,
2314 * filter it and send the result to the client
2316 if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
2318 log_error(LOG_LEVEL_FATAL, "Failed to parse server headers.");
2320 hdr = list_to_text(csp->headers);
2323 /* FIXME Should handle error properly */
2324 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2327 csp->server_connection.response_received = time(NULL);
2329 if (crunch_response_triggered(csp, crunchers_light))
2332 * One of the tags created by a server-header
2333 * tagger triggered a crunch. We already
2334 * delivered the crunch response to the client
2335 * and are done here after cleaning up.
2338 mark_server_socket_tainted(csp);
2341 /* Buffer and pcrs filter this if appropriate. */
2343 if (!http->ssl) /* We talk plaintext */
2345 content_filter = get_filter_function(csp);
2348 * Only write if we're not buffering for content modification
2350 if (!content_filter)
2353 * Write the server's (modified) header to
2354 * the client (along with anything else that
2355 * may be in the buffer)
2358 if (write_socket(csp->cfd, hdr, strlen(hdr))
2359 || ((len = flush_socket(csp->cfd, csp->iob)) < 0))
2361 log_error(LOG_LEVEL_CONNECT, "write header to client failed: %E");
2364 * The write failed, so don't bother mentioning it
2365 * to the client... it probably can't hear us anyway.
2368 mark_server_socket_tainted(csp);
2372 byte_count += (unsigned long long)len;
2377 * XXX: the header lenght should probably
2378 * be calculated by get_server_headers().
2380 long header_length = csp->iob->cur - header_start;
2381 assert(csp->iob->cur > header_start);
2382 byte_count += (unsigned long long)(len - header_length);
2385 /* we're finished with the server's header */
2391 * If this was a MS IIS/5 hack then it means the server
2392 * has already closed the connection. Nothing more to read.
2397 log_error(LOG_LEVEL_ERROR,
2398 "Closed server connection detected. "
2399 "Applying the MS IIS5 hack didn't help.");
2400 log_error(LOG_LEVEL_CLF,
2401 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2402 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2403 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2404 mark_server_socket_tainted(csp);
2410 mark_server_socket_tainted(csp);
2411 return; /* huh? we should never get here */
2414 if (csp->content_length == 0)
2417 * If Privoxy didn't recalculate the Content-Lenght,
2418 * byte_count is still correct.
2420 csp->content_length = byte_count;
2423 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2424 if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2425 && (csp->expected_content_length != byte_count))
2427 log_error(LOG_LEVEL_CONNECT,
2428 "Received %llu bytes while expecting %llu.",
2429 byte_count, csp->expected_content_length);
2430 mark_server_socket_tainted(csp);
2434 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %llu",
2435 csp->ip_addr_str, http->ocmd, csp->content_length);
2437 csp->server_connection.timestamp = time(NULL);
2441 /*********************************************************************
2445 * Description : This is little more than chat. We only "serve" to
2446 * to close (or remember) any socket that chat may have
2450 * 1 : csp = Current client state (buffers, headers, etc...)
2454 *********************************************************************/
2456 void serve(struct client_state *csp)
2457 #else /* ifndef AMIGA */
2458 static void serve(struct client_state *csp)
2459 #endif /* def AMIGA */
2461 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2462 static int monitor_thread_running = 0;
2463 int continue_chatting = 0;
2464 unsigned int latency = 0;
2470 if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
2471 && !(csp->flags & CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET))
2473 log_error(LOG_LEVEL_CONNECT, "The server didn't specify how long "
2474 "the connection will stay open. Assume it's only a second.");
2475 csp->server_connection.keep_alive_timeout = 1;
2478 continue_chatting = (csp->config->feature_flags
2479 & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
2480 && (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
2481 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
2482 && (csp->cfd != JB_INVALID_SOCKET)
2483 && (csp->sfd != JB_INVALID_SOCKET)
2484 && socket_is_still_usable(csp->sfd)
2485 && (latency < csp->server_connection.keep_alive_timeout);
2487 if (continue_chatting)
2489 unsigned int client_timeout = (unsigned)csp->server_connection.keep_alive_timeout - latency;
2490 log_error(LOG_LEVEL_CONNECT,
2491 "Waiting for the next client request. "
2492 "Keeping the server socket %d to %s open.",
2493 csp->sfd, csp->server_connection.host);
2495 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
2496 && data_is_available(csp->cfd, (int)client_timeout)
2497 && socket_is_still_usable(csp->cfd))
2499 log_error(LOG_LEVEL_CONNECT, "Client request arrived in "
2500 "time or the client closed the connection.");
2502 * Get the csp in a mostly vergin state again.
2503 * XXX: Should be done elsewhere.
2505 csp->content_type = 0;
2506 csp->content_length = 0;
2507 csp->expected_content_length = 0;
2508 csp->expected_client_content_length = 0;
2509 list_remove_all(csp->headers);
2510 freez(csp->iob->buf);
2511 memset(csp->iob, 0, sizeof(csp->iob));
2512 freez(csp->error_message);
2513 free_http_request(csp->http);
2514 destroy_list(csp->headers);
2515 destroy_list(csp->tags);
2516 free_current_action(csp->action);
2517 if (NULL != csp->fwd)
2519 unload_forward_spec(csp->fwd);
2523 /* XXX: Store per-connection flags someplace else. */
2524 csp->flags = CSP_FLAG_ACTIVE | (csp->flags & CSP_FLAG_TOGGLED_ON);
2528 log_error(LOG_LEVEL_CONNECT,
2529 "No additional client request received in time.");
2530 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
2531 && (socket_is_still_usable(csp->sfd)))
2533 remember_connection(csp, forward_url(csp, csp->http));
2534 csp->sfd = JB_INVALID_SOCKET;
2535 close_socket(csp->cfd);
2536 csp->cfd = JB_INVALID_SOCKET;
2537 privoxy_mutex_lock(&connection_reuse_mutex);
2538 if (!monitor_thread_running)
2540 monitor_thread_running = 1;
2541 privoxy_mutex_unlock(&connection_reuse_mutex);
2542 wait_for_alive_connections();
2543 privoxy_mutex_lock(&connection_reuse_mutex);
2544 monitor_thread_running = 0;
2546 privoxy_mutex_unlock(&connection_reuse_mutex);
2551 else if (csp->sfd != JB_INVALID_SOCKET)
2553 log_error(LOG_LEVEL_CONNECT,
2554 "The connection on server socket %d to %s isn't reusable. "
2555 "Closing.", csp->sfd, csp->server_connection.host);
2557 } while (continue_chatting);
2559 mark_connection_closed(&csp->server_connection);
2562 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2564 if (csp->sfd != JB_INVALID_SOCKET)
2566 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2567 forget_connection(csp->sfd);
2568 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2569 close_socket(csp->sfd);
2572 if (csp->cfd != JB_INVALID_SOCKET)
2574 close_socket(csp->cfd);
2577 csp->flags &= ~CSP_FLAG_ACTIVE;
2583 /*********************************************************************
2585 * Function : server_thread
2587 * Description : We only exist to call `serve' in a threaded environment.
2590 * 1 : data = Current client state (buffers, headers, etc...)
2592 * Returns : Always 0.
2594 *********************************************************************/
2595 static int32 server_thread(void *data)
2597 serve((struct client_state *) data);
2604 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
2605 /*********************************************************************
2609 * Description : Print usage info & exit.
2611 * Parameters : Pointer to argv[0] for identifying ourselves
2615 *********************************************************************/
2616 static void usage(const char *myname)
2618 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
2622 #endif /* defined(unix) */
2625 "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
2626 #endif /* defined(unix) */
2627 "[--version] [configfile]\n"
2628 "Aborting\n", myname);
2633 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
2636 #ifdef MUTEX_LOCKS_AVAILABLE
2637 /*********************************************************************
2639 * Function : privoxy_mutex_lock
2641 * Description : Locks a mutex.
2644 * 1 : mutex = The mutex to lock.
2646 * Returns : Void. May exit in case of errors.
2648 *********************************************************************/
2649 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
2651 #ifdef FEATURE_PTHREAD
2652 int err = pthread_mutex_lock(mutex);
2655 if (mutex != &log_mutex)
2657 log_error(LOG_LEVEL_FATAL,
2658 "Mutex locking failed: %s.\n", strerror(err));
2663 EnterCriticalSection(mutex);
2664 #endif /* def FEATURE_PTHREAD */
2668 /*********************************************************************
2670 * Function : privoxy_mutex_unlock
2672 * Description : Unlocks a mutex.
2675 * 1 : mutex = The mutex to unlock.
2677 * Returns : Void. May exit in case of errors.
2679 *********************************************************************/
2680 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
2682 #ifdef FEATURE_PTHREAD
2683 int err = pthread_mutex_unlock(mutex);
2686 if (mutex != &log_mutex)
2688 log_error(LOG_LEVEL_FATAL,
2689 "Mutex unlocking failed: %s.\n", strerror(err));
2694 LeaveCriticalSection(mutex);
2695 #endif /* def FEATURE_PTHREAD */
2699 /*********************************************************************
2701 * Function : privoxy_mutex_init
2703 * Description : Prepares a mutex.
2706 * 1 : mutex = The mutex to initialize.
2708 * Returns : Void. May exit in case of errors.
2710 *********************************************************************/
2711 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
2713 #ifdef FEATURE_PTHREAD
2714 int err = pthread_mutex_init(mutex, 0);
2717 printf("Fatal error. Mutex initialization failed: %s.\n",
2722 InitializeCriticalSection(mutex);
2723 #endif /* def FEATURE_PTHREAD */
2725 #endif /* def MUTEX_LOCKS_AVAILABLE */
2727 /*********************************************************************
2729 * Function : initialize_mutexes
2731 * Description : Prepares mutexes if mutex support is available.
2735 * Returns : Void, exits in case of errors.
2737 *********************************************************************/
2738 static void initialize_mutexes(void)
2740 #ifdef MUTEX_LOCKS_AVAILABLE
2742 * Prepare global mutex semaphores
2744 privoxy_mutex_init(&log_mutex);
2745 privoxy_mutex_init(&log_init_mutex);
2746 privoxy_mutex_init(&connection_reuse_mutex);
2749 * XXX: The assumptions below are a bit naive
2750 * and can cause locks that aren't necessary.
2752 * For example older FreeBSD versions (< 6.x?)
2753 * have no gethostbyname_r, but gethostbyname is
2756 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
2757 privoxy_mutex_init(&resolver_mutex);
2758 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
2760 * XXX: should we use a single mutex for
2761 * localtime() and gmtime() as well?
2763 #ifndef HAVE_GMTIME_R
2764 privoxy_mutex_init(&gmtime_mutex);
2765 #endif /* ndef HAVE_GMTIME_R */
2767 #ifndef HAVE_LOCALTIME_R
2768 privoxy_mutex_init(&localtime_mutex);
2769 #endif /* ndef HAVE_GMTIME_R */
2772 privoxy_mutex_init(&rand_mutex);
2773 #endif /* ndef HAVE_RANDOM */
2774 #endif /* def MUTEX_LOCKS_AVAILABLE */
2778 /*********************************************************************
2782 * Description : Load the config file and start the listen loop.
2783 * This function is a lot more *sane* with the `load_config'
2784 * and `listen_loop' functions; although it stills does
2785 * a *little* too much for my taste.
2788 * 1 : argc = Number of parameters (including $0).
2789 * 2 : argv = Array of (char *)'s to the parameters.
2791 * Returns : 1 if : can't open config file, unrecognized directive,
2792 * stats requested in multi-thread mode, can't open the
2793 * log file, can't open the jar file, listen port is invalid,
2794 * any load fails, and can't bind port.
2796 * Else main never returns, the process must be signaled
2797 * to terminate execution. Or, on Windows, use the
2798 * "File", "Exit" menu option.
2800 *********************************************************************/
2802 int real_main(int argc, const char *argv[])
2804 int main(int argc, const char *argv[])
2808 unsigned int random_seed;
2810 struct passwd *pw = NULL;
2811 struct group *grp = NULL;
2814 char *pre_chroot_nslookup_to_load_resolver = NULL;
2821 #if !defined(_WIN32)
2828 /* Prepare mutexes if supported and necessary. */
2829 initialize_mutexes();
2831 /* Enable logging until further notice. */
2835 * Parse the command line arguments
2837 * XXX: simply printing usage information in case of
2838 * invalid arguments isn't particularly user friendly.
2840 while (++argc_pos < argc)
2843 /* Check to see if the service must be installed or uninstalled */
2844 if (strncmp(argv[argc_pos], "--install", 9) == 0)
2846 const char *pName = argv[argc_pos] + 9;
2849 exit( (install_service(pName)) ? 0 : 1 );
2851 else if (strncmp(argv[argc_pos], "--uninstall", + 11) == 0)
2853 const char *pName = argv[argc_pos] + 11;
2856 exit((uninstall_service(pName)) ? 0 : 1);
2858 else if (strcmp(argv[argc_pos], "--service" ) == 0)
2860 bRunAsService = TRUE;
2861 w32_set_service_cwd();
2862 atexit(w32_service_exit_notify);
2865 #endif /* defined(_WIN32) */
2868 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
2870 if (strcmp(argv[argc_pos], "--help") == 0)
2875 else if(strcmp(argv[argc_pos], "--version") == 0)
2877 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
2883 else if (strcmp(argv[argc_pos], "--no-daemon" ) == 0)
2885 set_debug_level(LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
2889 else if (strcmp(argv[argc_pos], "--pidfile" ) == 0)
2891 if (++argc_pos == argc) usage(argv[0]);
2892 pidfile = strdup(argv[argc_pos]);
2895 else if (strcmp(argv[argc_pos], "--user" ) == 0)
2897 if (++argc_pos == argc) usage(argv[argc_pos]);
2899 if ((NULL != (p = strchr(argv[argc_pos], '.'))) && *(p + 1) != '0')
2902 if (NULL == (grp = getgrnam(p)))
2904 log_error(LOG_LEVEL_FATAL, "Group %s not found.", p);
2908 if (NULL == (pw = getpwnam(argv[argc_pos])))
2910 log_error(LOG_LEVEL_FATAL, "User %s not found.", argv[argc_pos]);
2913 if (p != NULL) *--p = '\0';
2916 else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup" ) == 0)
2918 if (++argc_pos == argc) usage(argv[0]);
2919 pre_chroot_nslookup_to_load_resolver = strdup(argv[argc_pos]);
2922 else if (strcmp(argv[argc_pos], "--chroot" ) == 0)
2926 #endif /* defined(unix) */
2928 else if (argc_pos + 1 != argc)
2931 * This is neither the last command line
2932 * option, nor was it recognized before,
2933 * therefore it must be invalid.
2939 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
2941 configfile = argv[argc_pos];
2944 } /* -END- while (more arguments) */
2946 show_version(Argv[0]);
2949 if ( *configfile != '/' )
2951 char cwd[BUFFER_SIZE];
2953 size_t abs_file_size;
2955 /* make config-filename absolute here */
2956 if (NULL == getcwd(cwd, sizeof(cwd)))
2958 perror("failed to get current working directory");
2963 abs_file_size = strlen(cwd) + strlen(configfile) + 5;
2964 basedir = strdup(cwd);
2966 if (NULL == basedir ||
2967 NULL == (abs_file = malloc(abs_file_size)))
2969 perror("malloc failed");
2972 strlcpy(abs_file, basedir, abs_file_size);
2973 strlcat(abs_file, "/", abs_file_size );
2974 strlcat(abs_file, configfile, abs_file_size);
2975 configfile = abs_file;
2977 #endif /* defined unix */
2981 clients->next = NULL;
2983 /* XXX: factor out initialising after the next stable release. */
2986 #elif defined(_WIN32)
2990 random_seed = (unsigned int)time(NULL);
2992 srandom(random_seed);
2995 #endif /* ifdef HAVE_RANDOM */
2998 * Unix signal handling
3000 * Catch the abort, interrupt and terminate signals for a graceful exit
3001 * Catch the hangup signal so the errlog can be reopened.
3002 * Ignore the broken pipe signals (FIXME: Why?)
3004 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
3007 const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP, 0 };
3008 const int ignored_signals[] = { SIGPIPE, 0 };
3010 for (idx = 0; catched_signals[idx] != 0; idx++)
3012 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
3013 if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
3015 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
3016 #endif /* ifdef sun */
3018 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
3022 for (idx = 0; ignored_signals[idx] != 0; idx++)
3024 if (signal(ignored_signals[idx], SIG_IGN) == SIG_ERR)
3026 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for signal %d: %E", ignored_signals[idx]);
3031 #else /* ifdef _WIN32 */
3032 # ifdef _WIN_CONSOLE
3034 * We *are* in a windows console app.
3035 * Print a verbose messages about FAQ's and such
3037 printf("%s", win32_blurb);
3038 # endif /* def _WIN_CONSOLE */
3039 #endif /* def _WIN32 */
3042 /* Initialize the CGI subsystem */
3043 cgi_init_error_messages();
3046 * If runnig on unix and without the --nodaemon
3047 * option, become a daemon. I.e. fork, detach
3048 * from tty and get process group leadership
3061 if ( pid < 0 ) /* error */
3066 else if ( pid != 0 ) /* parent */
3071 * must check for errors
3072 * child died due to missing files aso
3075 wpid = waitpid( pid, &status, WNOHANG );
3084 /* Should be more portable, but not as well tested */
3089 #else /* ndef __FreeBSD__ */
3091 #endif /* ndef __FreeBSD__ */
3092 fd = open("/dev/tty", O_RDONLY);
3095 /* no error check here */
3096 ioctl( fd, TIOCNOTTY,0 );
3101 * stderr (fd 2) will be closed later on,
3102 * when the config file has been parsed.
3109 } /* -END- if (!no_daemon) */
3112 * As soon as we have written the PID file, we can switch
3113 * to the user and group ID indicated by the --user option
3119 if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
3121 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
3125 if (setgroups(1, &grp->gr_gid))
3127 log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
3130 else if (initgroups(pw->pw_name, pw->pw_gid))
3132 log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
3138 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
3140 /* Read the time zone file from /etc before doing chroot. */
3142 if (NULL != pre_chroot_nslookup_to_load_resolver
3143 && '\0' != pre_chroot_nslookup_to_load_resolver[0])
3145 /* Initialize resolver library. */
3146 (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
3148 if (chroot(pw->pw_dir) < 0)
3150 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
3154 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
3157 if (setuid(pw->pw_uid))
3159 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
3163 char putenv_dummy[64];
3165 strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
3166 if (putenv(putenv_dummy) != 0)
3168 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
3171 snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
3172 if (putenv(putenv_dummy) != 0)
3174 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
3180 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
3183 #endif /* defined unix */
3186 /* This will be FALSE unless the command line specified --service
3190 /* Yup, so now we must attempt to establish a connection
3191 * with the service dispatcher. This will only work if this
3192 * process was launched by the service control manager to
3193 * actually run as a service. If this isn't the case, i've
3194 * known it take around 30 seconds or so for the call to return.
3197 /* The StartServiceCtrlDispatcher won't return until the service is stopping */
3198 if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
3200 /* Service has run, and at this point is now being stopped, so just return */
3205 printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
3207 /* An error occurred. Usually it's because --service was wrongly specified
3208 * and we were unable to connect to the Service Control Dispatcher because
3209 * it wasn't expecting us and is therefore not listening.
3211 * For now, just continue below to call the listen_loop function.
3214 #endif /* def _WIN32 */
3224 /*********************************************************************
3226 * Function : bind_port_helper
3228 * Description : Bind the listen port. Handles logging, and aborts
3232 * 1 : config = Privoxy configuration. Specifies port
3235 * Returns : Port that was opened.
3237 *********************************************************************/
3238 static jb_socket bind_port_helper(struct configuration_spec * config)
3243 if (config->haddr == NULL)
3245 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
3250 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
3251 config->hport, config->haddr);
3254 result = bind_port(config->haddr, config->hport, &bfd);
3261 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
3262 "There may be another Privoxy or some other "
3263 "proxy running on port %d",
3264 (NULL != config->haddr) ? config->haddr : "INADDR_ANY",
3265 config->hport, config->hport);
3268 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
3269 "The hostname is not resolvable",
3270 (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
3273 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: %E",
3274 (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
3277 /* shouldn't get here */
3278 return JB_INVALID_SOCKET;
3281 config->need_bind = 0;
3288 /* Without this simple workaround we get this compiler warning from _beginthread
3289 * warning C4028: formal parameter 1 different from declaration
3291 void w32_service_listen_loop(void *p)
3295 #endif /* def _WIN32 */
3298 /*********************************************************************
3300 * Function : listen_loop
3302 * Description : bind the listen port and enter a "FOREVER" listening loop.
3308 *********************************************************************/
3309 static void listen_loop(void)
3311 struct client_state *csp = NULL;
3313 struct configuration_spec *config;
3314 unsigned int active_threads = 0;
3316 config = load_config();
3318 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3320 * XXX: Should be relocated once it no
3321 * longer needs to emit log messages.
3323 initialize_reusable_connections();
3324 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3326 bfd = bind_port_helper(config);
3328 #ifdef FEATURE_GRACEFUL_TERMINATION
3329 while (!g_terminate)
3334 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
3335 while (waitpid(-1, NULL, WNOHANG) > 0)
3337 /* zombie children */
3339 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
3342 * Free data that was used by died threads
3344 active_threads = sweep();
3348 * Re-open the errlog after HUP signal
3350 if (received_hup_signal)
3352 if (NULL != config->logfile)
3354 init_error_log(Argv[0], config->logfile);
3356 received_hup_signal = 0;
3360 if ( NULL == (csp = (struct client_state *) zalloc(sizeof(*csp))) )
3362 log_error(LOG_LEVEL_FATAL, "malloc(%d) for csp failed: %E", sizeof(*csp));
3366 csp->flags |= CSP_FLAG_ACTIVE;
3367 csp->sfd = JB_INVALID_SOCKET;
3369 csp->config = config = load_config();
3371 if ( config->need_bind )
3374 * Since we were listening to the "old port", we will not see
3375 * a "listen" param change until the next request. So, at
3376 * least 1 more request must be made for us to find the new
3377 * setting. I am simply closing the old socket and binding the
3380 * Which-ever is correct, we will serve 1 more page via the
3381 * old settings. This should probably be a "show-proxy-args"
3382 * request. This should not be a so common of an operation
3383 * that this will hurt people's feelings.
3388 bfd = bind_port_helper(config);
3391 log_error(LOG_LEVEL_CONNECT, "Listening for new connections ... ");
3393 if (!accept_connection(csp, bfd))
3395 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
3408 log_error(LOG_LEVEL_CONNECT, "accepted connection from %s", csp->ip_addr_str);
3411 #ifdef FEATURE_TOGGLE
3412 if (global_toggle_state)
3413 #endif /* def FEATURE_TOGGLE */
3415 csp->flags |= CSP_FLAG_TOGGLED_ON;
3418 if (run_loader(csp))
3420 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
3421 /* Never get here - LOG_LEVEL_FATAL causes program exit */
3425 if (block_acl(NULL,csp))
3427 log_error(LOG_LEVEL_CONNECT, "Connection from %s dropped due to ACL", csp->ip_addr_str);
3428 close_socket(csp->cfd);
3429 freez(csp->ip_addr_str);
3433 #endif /* def FEATURE_ACL */
3435 if ((0 != config->max_client_connections)
3436 && (active_threads >= config->max_client_connections))
3438 log_error(LOG_LEVEL_CONNECT,
3439 "Rejecting connection from %s. Maximum number of connections reached.",
3441 write_socket(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
3442 strlen(TOO_MANY_CONNECTIONS_RESPONSE));
3443 close_socket(csp->cfd);
3444 freez(csp->ip_addr_str);
3449 /* add it to the list of clients */
3450 csp->next = clients->next;
3451 clients->next = csp;
3453 if (config->multi_threaded)
3457 /* this is a switch () statment in the C preprocessor - ugh */
3458 #undef SELECTED_ONE_OPTION
3460 /* Use Pthreads in preference to native code */
3461 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
3462 #define SELECTED_ONE_OPTION
3464 pthread_t the_thread;
3465 pthread_attr_t attrs;
3467 pthread_attr_init(&attrs);
3468 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
3469 errno = pthread_create(&the_thread, &attrs,
3470 (void * (*)(void *))serve, csp);
3471 child_id = errno ? -1 : 0;
3472 pthread_attr_destroy(&attrs);
3476 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
3477 #define SELECTED_ONE_OPTION
3478 child_id = _beginthread(
3479 (void (*)(void *))serve,
3484 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
3485 #define SELECTED_ONE_OPTION
3486 child_id = _beginthread(
3487 (void(* _Optlink)(void*))serve,
3493 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
3494 #define SELECTED_ONE_OPTION
3496 thread_id tid = spawn_thread
3497 (server_thread, "server", B_NORMAL_PRIORITY, csp);
3499 if ((tid >= 0) && (resume_thread(tid) == B_OK))
3501 child_id = (int) tid;
3510 #if defined(AMIGA) && !defined(SELECTED_ONE_OPTION)
3511 #define SELECTED_ONE_OPTION
3512 csp->cfd = ReleaseSocket(csp->cfd, -1);
3515 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
3516 NP_Output, Output(),
3517 NP_CloseOutput, FALSE,
3518 NP_Name, (ULONG)"privoxy child",
3522 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
3523 NP_Output, Output(),
3524 NP_CloseOutput, FALSE,
3525 NP_Name, (ULONG)"privoxy child",
3526 NP_StackSize, 200*1024,
3532 ((struct Task *)child_id)->tc_UserData = csp;
3533 Signal((struct Task *)child_id, SIGF_SINGLE);
3538 #if !defined(SELECTED_ONE_OPTION)
3541 /* This block is only needed when using fork().
3542 * When using threads, the server thread was
3543 * created and run by the call to _beginthread().
3545 if (child_id == 0) /* child */
3548 #ifdef FEATURE_TOGGLE
3549 int inherited_toggle_state = global_toggle_state;
3550 #endif /* def FEATURE_TOGGLE */
3555 * If we've been toggled or we've blocked the request, tell Mom
3558 #ifdef FEATURE_TOGGLE
3559 if (inherited_toggle_state != global_toggle_state)
3561 rc |= RC_FLAG_TOGGLED;
3563 #endif /* def FEATURE_TOGGLE */
3565 #ifdef FEATURE_STATISTICS
3566 if (csp->flags & CSP_FLAG_REJECTED)
3568 rc |= RC_FLAG_BLOCKED;
3570 #endif /* ndef FEATURE_STATISTICS */
3574 else if (child_id > 0) /* parent */
3576 /* in a fork()'d environment, the parent's
3577 * copy of the client socket and the CSP
3581 #if !defined(_WIN32) && !defined(__CYGWIN__)
3583 wait( &child_status );
3586 * Evaluate child's return code: If the child has
3587 * - been toggled, toggle ourselves
3588 * - blocked its request, bump up the stats counter
3591 #ifdef FEATURE_TOGGLE
3592 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
3594 global_toggle_state = !global_toggle_state;
3596 #endif /* def FEATURE_TOGGLE */
3598 #ifdef FEATURE_STATISTICS
3600 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
3604 #endif /* def FEATURE_STATISTICS */
3606 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
3607 close_socket(csp->cfd);
3608 csp->flags &= ~CSP_FLAG_ACTIVE;
3612 #undef SELECTED_ONE_OPTION
3613 /* end of cpp switch () */
3618 * Spawning the child failed, assume it's because
3619 * there are too many children running already.
3620 * XXX: If you assume ...
3622 log_error(LOG_LEVEL_ERROR,
3623 "Unable to take any additional connections: %E");
3624 write_socket(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
3625 strlen(TOO_MANY_CONNECTIONS_RESPONSE));
3626 close_socket(csp->cfd);
3627 csp->flags &= ~CSP_FLAG_ACTIVE;
3636 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
3638 /* Clean up. Aim: free all memory (no leaks) */
3639 #ifdef FEATURE_GRACEFUL_TERMINATION
3641 log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
3643 unload_current_config_file();
3644 unload_current_actions_file();
3645 unload_current_re_filterfile();
3646 #ifdef FEATURE_TRUST
3647 unload_current_trust_file();
3650 if (config->multi_threaded)
3657 } while ((clients->next != NULL) && (--i > 0));
3661 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
3672 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
3673 /* Cleanup - remove taskbar icon etc. */
3678 #endif /* FEATURE_GRACEFUL_TERMINATION */