1 const char jcc_rcs[] = "$Id: jcc.c,v 1.256 2009/06/11 11:49:11 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);
1080 server_connection->host = strdup(http->host);
1081 if (NULL == server_connection->host)
1083 log_error(LOG_LEVEL_FATAL, "Out of memory saving socket.");
1085 server_connection->port = http->port;
1087 assert(NULL != fwd);
1088 assert(server_connection->gateway_host == NULL);
1089 assert(server_connection->gateway_port == 0);
1090 assert(server_connection->forwarder_type == 0);
1091 assert(server_connection->forward_host == NULL);
1092 assert(server_connection->forward_port == 0);
1094 server_connection->forwarder_type = fwd->type;
1095 if (NULL != fwd->gateway_host)
1097 server_connection->gateway_host = strdup(fwd->gateway_host);
1098 if (NULL == server_connection->gateway_host)
1100 log_error(LOG_LEVEL_FATAL, "Out of memory saving gateway_host.");
1105 server_connection->gateway_host = NULL;
1107 server_connection->gateway_port = fwd->gateway_port;
1109 if (NULL != fwd->forward_host)
1111 server_connection->forward_host = strdup(fwd->forward_host);
1112 if (NULL == server_connection->forward_host)
1114 log_error(LOG_LEVEL_FATAL, "Out of memory saving forward_host.");
1119 server_connection->forward_host = NULL;
1121 server_connection->forward_port = fwd->forward_port;
1123 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1126 /*********************************************************************
1128 * Function : mark_server_socket_tainted
1130 * Description : Makes sure we don't reuse a server socket
1131 * (if we didn't read everything the server sent
1132 * us reusing the socket would lead to garbage).
1135 * 1 : csp = Current client state (buffers, headers, etc...)
1139 *********************************************************************/
1140 static void mark_server_socket_tainted(struct client_state *csp)
1142 if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE))
1144 log_error(LOG_LEVEL_CONNECT, "Unsetting keep-alive flag.");
1145 csp->flags &= ~CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE;
1149 /*********************************************************************
1151 * Function : get_request_line
1153 * Description : Read the client request line.
1156 * 1 : csp = Current client state (buffers, headers, etc...)
1158 * Returns : Pointer to request line or NULL in case of errors.
1160 *********************************************************************/
1161 static char *get_request_line(struct client_state *csp)
1163 char buf[BUFFER_SIZE];
1164 char *request_line = NULL;
1167 memset(buf, 0, sizeof(buf));
1171 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1173 log_error(LOG_LEVEL_ERROR,
1174 "Stopped waiting for the request line.");
1175 write_socket(csp->cfd, CLIENT_CONNECTION_TIMEOUT_RESPONSE,
1176 strlen(CLIENT_CONNECTION_TIMEOUT_RESPONSE));
1180 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1182 if (len <= 0) return NULL;
1185 * If there is no memory left for buffering the
1186 * request, there is nothing we can do but hang up
1188 if (add_to_iob(csp, buf, len))
1193 request_line = get_header(csp->iob);
1195 } while ((NULL != request_line) && ('\0' == *request_line));
1197 return request_line;
1202 /*********************************************************************
1204 * Function : receive_client_request
1206 * Description : Read the client's request (more precisely the
1207 * client headers) and answer it if necessary.
1209 * Note that since we're not using select() we could get
1210 * blocked here if a client connected, then didn't say
1214 * 1 : csp = Current client state (buffers, headers, etc...)
1216 * Returns : JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
1218 *********************************************************************/
1219 static jb_err receive_client_request(struct client_state *csp)
1221 char buf[BUFFER_SIZE];
1224 struct http_request *http;
1228 /* Temporary copy of the client's headers before they get enlisted in csp->headers */
1229 struct list header_list;
1230 struct list *headers = &header_list;
1234 memset(buf, 0, sizeof(buf));
1236 req = get_request_line(csp);
1239 return JB_ERR_PARSE;
1241 assert(*req != '\0');
1243 if (client_protocol_is_unsupported(csp, req))
1245 return JB_ERR_PARSE;
1248 #ifdef FEATURE_FORCE_LOAD
1250 * If this request contains the FORCE_PREFIX and blocks
1251 * aren't enforced, get rid of it and set the force flag.
1253 if (strstr(req, FORCE_PREFIX))
1255 if (csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS)
1257 log_error(LOG_LEVEL_FORCE,
1258 "Ignored force prefix in request: \"%s\".", req);
1262 strclean(req, FORCE_PREFIX);
1263 log_error(LOG_LEVEL_FORCE, "Enforcing request: \"%s\".", req);
1264 csp->flags |= CSP_FLAG_FORCED;
1267 #endif /* def FEATURE_FORCE_LOAD */
1269 err = parse_http_request(req, http);
1271 if (JB_ERR_OK != err)
1273 write_socket(csp->cfd, CHEADER, strlen(CHEADER));
1274 /* XXX: Use correct size */
1275 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1276 log_error(LOG_LEVEL_ERROR,
1277 "Couldn't parse request line received from %s: %s",
1278 csp->ip_addr_str, jb_err_to_string(err));
1280 free_http_request(http);
1281 return JB_ERR_PARSE;
1284 /* grab the rest of the client's headers */
1288 p = get_header(csp->iob);
1292 /* There are no additional headers to read. */
1299 * We didn't receive a complete header
1300 * line yet, get the rest of it.
1302 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1304 log_error(LOG_LEVEL_ERROR,
1305 "Stopped grabbing the client headers.");
1306 destroy_list(headers);
1307 return JB_ERR_PARSE;
1310 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1313 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1314 destroy_list(headers);
1315 return JB_ERR_PARSE;
1318 if (add_to_iob(csp, buf, len))
1321 * If there is no memory left for buffering the
1322 * request, there is nothing we can do but hang up
1324 destroy_list(headers);
1325 return JB_ERR_MEMORY;
1331 * We were able to read a complete
1332 * header and can finaly enlist it.
1339 if (http->host == NULL)
1342 * If we still don't know the request destination,
1343 * the request is invalid or the client uses
1344 * Privoxy without its knowledge.
1346 if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
1349 * Our attempts to get the request destination
1350 * elsewhere failed or Privoxy is configured
1351 * to only accept proxy requests.
1353 * An error response has already been send
1354 * and we're done here.
1356 return JB_ERR_PARSE;
1361 * Determine the actions for this URL
1363 #ifdef FEATURE_TOGGLE
1364 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
1366 /* Most compatible set of actions (i.e. none) */
1367 init_current_action(csp->action);
1370 #endif /* ndef FEATURE_TOGGLE */
1372 get_url_actions(csp, http);
1376 * Save a copy of the original request for logging
1378 http->ocmd = strdup(http->cmd);
1379 if (http->ocmd == NULL)
1381 log_error(LOG_LEVEL_FATAL,
1382 "Out of memory copying HTTP request line");
1384 enlist(csp->headers, http->cmd);
1386 /* Append the previously read headers */
1387 list_append_list_unique(csp->headers, headers);
1388 destroy_list(headers);
1395 /*********************************************************************
1397 * Function : parse_client_request
1399 * Description : Parses the client's request and decides what to do
1402 * Note that since we're not using select() we could get
1403 * blocked here if a client connected, then didn't say
1407 * 1 : csp = Current client state (buffers, headers, etc...)
1409 * Returns : JB_ERR_OK or JB_ERR_PARSE
1411 *********************************************************************/
1412 static jb_err parse_client_request(struct client_state *csp)
1414 struct http_request *http = csp->http;
1417 err = sed(csp, FILTER_CLIENT_HEADERS);
1418 if (JB_ERR_OK != err)
1420 /* XXX: Should be handled in sed(). */
1421 assert(err == JB_ERR_PARSE);
1422 log_error(LOG_LEVEL_FATAL, "Failed to parse client headers.");
1424 csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
1426 /* Check request line for rewrites. */
1427 if ((NULL == csp->headers->first->str)
1428 || (strcmp(http->cmd, csp->headers->first->str) &&
1429 (JB_ERR_OK != change_request_destination(csp))))
1432 * A header filter broke the request line - bail out.
1434 write_socket(csp->cfd, MESSED_UP_REQUEST_RESPONSE, strlen(MESSED_UP_REQUEST_RESPONSE));
1435 /* XXX: Use correct size */
1436 log_error(LOG_LEVEL_CLF,
1437 "%s - - [%T] \"Invalid request generated\" 500 0", csp->ip_addr_str);
1438 log_error(LOG_LEVEL_ERROR,
1439 "Invalid request line after applying header filters.");
1440 free_http_request(http);
1442 return JB_ERR_PARSE;
1450 /*********************************************************************
1454 * Description : Once a connection to the client has been accepted,
1455 * this function is called (via serve()) to handle the
1456 * main business of the communication. When this
1457 * function returns, the caller must close the client
1460 * FIXME: chat is nearly thousand lines long.
1464 * 1 : csp = Current client state (buffers, headers, etc...)
1466 * Returns : Nothing.
1468 *********************************************************************/
1469 static void chat(struct client_state *csp)
1471 char buf[BUFFER_SIZE];
1478 int ms_iis5_hack = 0;
1479 unsigned long long byte_count = 0;
1480 int forwarded_connect_retries = 0;
1481 int max_forwarded_connect_retries = csp->config->forwarded_connect_retries;
1482 const struct forward_spec *fwd;
1483 struct http_request *http;
1484 long len = 0; /* for buffer sizes (and negative error codes) */
1486 /* Function that does the content filtering for the current request */
1487 filter_function_ptr content_filter = NULL;
1489 /* Skeleton for HTTP response, if we should intercept the request */
1490 struct http_response *rsp;
1491 struct timeval timeout;
1493 memset(buf, 0, sizeof(buf));
1497 if (receive_client_request(csp) != JB_ERR_OK)
1501 if (parse_client_request(csp) != JB_ERR_OK)
1506 /* decide how to route the HTTP request */
1507 fwd = forward_url(csp, http);
1510 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!? This can't happen!");
1511 /* Never get here - LOG_LEVEL_FATAL causes program exit */
1516 * build the http request to send to the server
1517 * we have to do one of the following:
1519 * create = use the original HTTP request to create a new
1520 * HTTP request that has either the path component
1521 * without the http://domainspec (w/path) or the
1522 * full orininal URL (w/url)
1523 * Note that the path and/or the HTTP version may
1524 * have been altered by now.
1526 * connect = Open a socket to the host:port of the server
1527 * and short-circuit server and client socket.
1529 * pass = Pass the request unchanged if forwarding a CONNECT
1530 * request to a parent proxy. Note that we'll be sending
1531 * the CFAIL message ourselves if connecting to the parent
1532 * fails, but we won't send a CSUCCEED message if it works,
1533 * since that would result in a double message (ours and the
1534 * parent's). After sending the request to the parent, we simply
1537 * here's the matrix:
1540 * +--------+--------+
1542 * 0 | create | connect|
1544 * Forwarding +--------+--------+
1546 * 1 | create | pass |
1548 * +--------+--------+
1552 if (http->ssl && connect_port_is_forbidden(csp))
1554 const char *acceptable_connect_ports =
1555 csp->action->string[ACTION_STRING_LIMIT_CONNECT];
1556 assert(NULL != acceptable_connect_ports);
1557 log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
1558 "limit-connect{%s} doesn't allow CONNECT requests to port %d.",
1559 csp->ip_addr_str, acceptable_connect_ports, csp->http->port);
1560 csp->action->flags |= ACTION_BLOCK;
1566 freez(csp->headers->first->str);
1567 build_request_line(csp, fwd, &csp->headers->first->str);
1571 * We have a request. Check if one of the crunchers wants it.
1573 if (crunch_response_triggered(csp, crunchers_all))
1576 * Yes. The client got the crunch response
1577 * and we are done here after cleaning up.
1579 /* XXX: why list_remove_all()? */
1580 list_remove_all(csp->headers);
1585 log_error(LOG_LEVEL_GPC, "%s%s", http->hostport, http->path);
1587 if (fwd->forward_host)
1589 log_error(LOG_LEVEL_CONNECT, "via [%s]:%d to: %s",
1590 fwd->forward_host, fwd->forward_port, http->hostport);
1594 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
1597 /* here we connect to the server, gateway, or the forwarder */
1599 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1600 if ((csp->sfd != JB_INVALID_SOCKET)
1601 && socket_is_still_usable(csp->sfd)
1602 && connection_destination_matches(&csp->server_connection, http, fwd))
1604 log_error(LOG_LEVEL_CONNECT,
1605 "Reusing server socket %u. Opened for %s.",
1606 csp->sfd, csp->server_connection.host);
1610 if (csp->sfd != JB_INVALID_SOCKET)
1612 log_error(LOG_LEVEL_CONNECT,
1613 "Closing server socket %u. Opened for %s.",
1614 csp->sfd, csp->server_connection.host);
1615 close_socket(csp->sfd);
1616 mark_connection_closed(&csp->server_connection);
1618 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1620 while ((csp->sfd = forwarded_connect(fwd, http, csp))
1621 && (errno == EINVAL)
1622 && (forwarded_connect_retries++ < max_forwarded_connect_retries))
1624 log_error(LOG_LEVEL_ERROR,
1625 "failed request #%u to connect to %s. Trying again.",
1626 forwarded_connect_retries, http->hostport);
1629 if (csp->sfd == JB_INVALID_SOCKET)
1631 if (fwd->type != SOCKS_NONE)
1634 rsp = error_response(csp, "forwarding-failed");
1636 else if (errno == EINVAL)
1638 rsp = error_response(csp, "no-such-domain");
1642 rsp = error_response(csp, "connect-failed");
1643 log_error(LOG_LEVEL_CONNECT, "connect to: %s failed: %E",
1647 /* Write the answer to the client */
1650 send_crunch_response(csp, rsp);
1655 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1656 save_connection_destination(csp->sfd, http, fwd, &csp->server_connection);
1657 csp->server_connection.keep_alive_timeout = (unsigned)csp->config->keep_alive_timeout;
1659 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1661 hdr = list_to_text(csp->headers);
1664 /* FIXME Should handle error properly */
1665 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
1667 list_remove_all(csp->headers);
1669 if (fwd->forward_host || (http->ssl == 0))
1672 * Write the client's (modified) header to the server
1673 * (along with anything else that may be in the buffer)
1675 if (write_socket(csp->sfd, hdr, strlen(hdr))
1676 || (flush_socket(csp->sfd, csp->iob) < 0))
1678 log_error(LOG_LEVEL_CONNECT,
1679 "write header to: %s failed: %E", http->hostport);
1681 rsp = error_response(csp, "connect-failed");
1684 send_crunch_response(csp, rsp);
1694 * We're running an SSL tunnel and we're not forwarding,
1695 * so just send the "connect succeeded" message to the
1696 * client, flush the rest, and get out of the way.
1698 if (write_socket(csp->cfd, CSUCCEED, strlen(CSUCCEED)))
1706 log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
1708 /* we're finished with the client's header */
1711 maxfd = (csp->cfd > csp->sfd) ? csp->cfd : csp->sfd;
1713 /* pass data between the client and server
1714 * until one or the other shuts down the connection.
1723 * FD_ZERO here seems to point to an errant macro which crashes.
1724 * So do this by hand for now...
1726 memset(&rfds,0x00,sizeof(fd_set));
1730 FD_SET(csp->cfd, &rfds);
1731 FD_SET(csp->sfd, &rfds);
1733 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1734 if ((csp->flags & CSP_FLAG_CHUNKED)
1735 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
1736 && ((csp->iob->eod - csp->iob->cur) >= 5)
1737 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
1739 log_error(LOG_LEVEL_CONNECT,
1740 "Looks like we read the last chunk together with "
1741 "the server headers. We better stop reading.");
1742 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
1743 csp->expected_content_length = byte_count;
1744 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
1746 if (server_body && server_response_is_complete(csp, byte_count))
1748 log_error(LOG_LEVEL_CONNECT,
1749 "Done reading from server. Expected content length: %llu. "
1750 "Actual content length: %llu. Most recently received: %d.",
1751 csp->expected_content_length, byte_count, len);
1754 * XXX: should not jump around,
1755 * chat() is complicated enough already.
1759 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1761 timeout.tv_sec = csp->config->socket_timeout;
1762 timeout.tv_usec = 0;
1763 n = select((int)maxfd+1, &rfds, NULL, NULL, &timeout);
1767 log_error(LOG_LEVEL_ERROR,
1768 "Didn't receive data in time: %s", http->url);
1769 if ((byte_count == 0) && (http->ssl == 0))
1771 send_crunch_response(csp, error_response(csp, "connection-timeout"));
1773 mark_server_socket_tainted(csp);
1778 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
1779 mark_server_socket_tainted(csp);
1784 * This is the body of the browser's request,
1785 * just read and write it.
1787 * XXX: Make sure the client doesn't use pipelining
1788 * behind Privoxy's back.
1790 if (FD_ISSET(csp->cfd, &rfds))
1792 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1796 /* XXX: not sure if this is necessary. */
1797 mark_server_socket_tainted(csp);
1798 break; /* "game over, man" */
1801 if (write_socket(csp->sfd, buf, (size_t)len))
1803 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1804 mark_server_socket_tainted(csp);
1811 * The server wants to talk. It could be the header or the body.
1812 * If `hdr' is null, then it's the header otherwise it's the body.
1813 * FIXME: Does `hdr' really mean `host'? No.
1815 if (FD_ISSET(csp->sfd, &rfds))
1818 len = read_socket(csp->sfd, buf, sizeof(buf) - 1);
1822 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
1824 if (http->ssl && (fwd->forward_host == NULL))
1827 * Just hang up. We already confirmed the client's CONNECT
1828 * request with status code 200 and unencrypted content is
1829 * no longer welcome.
1831 log_error(LOG_LEVEL_ERROR,
1832 "CONNECT already confirmed. Unable to tell the client about the problem.");
1835 else if (byte_count)
1838 * Just hang up. We already transmitted the original headers
1839 * and parts of the original content and therefore missed the
1840 * chance to send an error message (without risking data corruption).
1842 * XXX: we could retry with a fancy range request here.
1844 log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
1845 "Unable to tell the client about the problem.");
1846 mark_server_socket_tainted(csp);
1850 * XXX: Consider handling the cases above the same.
1852 mark_server_socket_tainted(csp);
1856 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1857 if (csp->flags & CSP_FLAG_CHUNKED)
1859 if ((len >= 5) && !memcmp(buf+len-5, "0\r\n\r\n", 5))
1861 /* XXX: this is a temporary hack */
1862 log_error(LOG_LEVEL_CONNECT,
1863 "Looks like we reached the end of the last chunk. "
1864 "We better stop reading.");
1865 csp->expected_content_length = byte_count + (unsigned long long)len;
1866 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
1870 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1873 * Add a trailing zero to let be able to use string operations.
1874 * XXX: do we still need this with filter_popups gone?
1879 * Normally, this would indicate that we've read
1880 * as much as the server has sent us and we can
1881 * close the client connection. However, Microsoft
1882 * in its wisdom has released IIS/5 with a bug that
1883 * prevents it from sending the trailing \r\n in
1884 * a 302 redirect header (and possibly other headers).
1885 * To work around this if we've haven't parsed
1886 * a full header we'll append a trailing \r\n
1887 * and see if this now generates a valid one.
1889 * This hack shouldn't have any impacts. If we've
1890 * already transmitted the header or if this is a
1891 * SSL connection, then we won't bother with this
1892 * hack. So we only work on partially received
1893 * headers. If we append a \r\n and this still
1894 * doesn't generate a valid header, then we won't
1895 * transmit anything to the client.
1900 if (server_body || http->ssl)
1903 * If we have been buffering up the document,
1904 * now is the time to apply content modification
1905 * and send the result to the client.
1909 p = execute_content_filter(csp, content_filter);
1911 * If the content filter fails, use the original
1912 * buffer and length.
1913 * (see p != NULL ? p : csp->iob->cur below)
1917 csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
1920 if (JB_ERR_OK != update_server_headers(csp))
1922 log_error(LOG_LEVEL_FATAL,
1923 "Failed to update server headers. after filtering.");
1926 hdr = list_to_text(csp->headers);
1929 /* FIXME Should handle error properly */
1930 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
1933 if (write_socket(csp->cfd, hdr, strlen(hdr))
1934 || write_socket(csp->cfd,
1935 ((p != NULL) ? p : csp->iob->cur), (size_t)csp->content_length))
1937 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
1940 mark_server_socket_tainted(csp);
1948 break; /* "game over, man" */
1952 * This is NOT the body, so
1953 * Let's pretend the server just sent us a blank line.
1955 snprintf(buf, sizeof(buf), "\r\n");
1956 len = (int)strlen(buf);
1959 * Now, let the normal header parsing algorithm below do its
1960 * job. If it fails, we'll exit instead of continuing.
1967 * If this is an SSL connection or we're in the body
1968 * of the server document, just write it to the client,
1969 * unless we need to buffer the body for later content-filtering
1971 if (server_body || http->ssl)
1976 * If there is no memory left for buffering the content, or the buffer limit
1977 * has been reached, switch to non-filtering mode, i.e. make & write the
1978 * header, flush the iob and buf, and get out of the way.
1980 if (add_to_iob(csp, buf, len))
1985 log_error(LOG_LEVEL_INFO,
1986 "Flushing header and buffers. Stepping back from filtering.");
1988 hdr = list_to_text(csp->headers);
1992 * Memory is too tight to even generate the header.
1993 * Send our static "Out-of-memory" page.
1995 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
1996 rsp = cgi_error_memory();
1997 send_crunch_response(csp, rsp);
1998 mark_server_socket_tainted(csp);
2001 hdrlen = strlen(hdr);
2003 if (write_socket(csp->cfd, hdr, hdrlen)
2004 || ((flushed = flush_socket(csp->cfd, csp->iob)) < 0)
2005 || (write_socket(csp->cfd, buf, (size_t)len)))
2007 log_error(LOG_LEVEL_CONNECT,
2008 "Flush header and buffers to client failed: %E");
2010 mark_server_socket_tainted(csp);
2015 * Reset the byte_count to the amount of bytes
2016 * we just flushed. len will be added a few lines below,
2017 * hdrlen doesn't matter for LOG_LEVEL_CLF.
2019 byte_count = (unsigned long long)flushed;
2021 content_filter = NULL;
2027 if (write_socket(csp->cfd, buf, (size_t)len))
2029 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
2030 mark_server_socket_tainted(csp);
2034 byte_count += (unsigned long long)len;
2039 const char *header_start;
2041 * We're still looking for the end of the server's header.
2042 * Buffer up the data we just read. If that fails, there's
2043 * little we can do but send our static out-of-memory page.
2045 if (add_to_iob(csp, buf, len))
2047 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
2048 rsp = cgi_error_memory();
2049 send_crunch_response(csp, rsp);
2050 mark_server_socket_tainted(csp);
2054 header_start = csp->iob->cur;
2056 /* Convert iob into something sed() can digest */
2057 if (JB_ERR_PARSE == get_server_headers(csp))
2062 * Well, we tried our MS IIS/5 hack and it didn't work.
2063 * The header is incomplete and there isn't anything
2064 * we can do about it.
2066 log_error(LOG_LEVEL_ERROR, "Invalid server headers. "
2067 "Applying the MS IIS5 hack didn't help.");
2068 log_error(LOG_LEVEL_CLF,
2069 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2070 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2071 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2072 mark_server_socket_tainted(csp);
2078 * Since we have to wait for more from the server before
2079 * we can parse the headers we just continue here.
2081 long header_offset = csp->iob->cur - header_start;
2082 assert(csp->iob->cur >= header_start);
2083 byte_count += (unsigned long long)(len - header_offset);
2084 log_error(LOG_LEVEL_CONNECT, "Continuing buffering headers. "
2085 "byte_count: %llu. header_offset: %d. len: %d.",
2086 byte_count, header_offset, len);
2091 /* Did we actually get anything? */
2092 if (NULL == csp->headers->first)
2094 log_error(LOG_LEVEL_ERROR, "Empty server or forwarder response.");
2095 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2096 send_crunch_response(csp, error_response(csp, "no-server-data"));
2097 free_http_request(http);
2098 mark_server_socket_tainted(csp);
2102 assert(csp->headers->first->str);
2104 if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
2105 strncmpic(csp->headers->first->str, "ICY", 3))
2108 * It doesn't look like a HTTP (or Shoutcast) response:
2109 * tell the client and log the problem.
2111 if (strlen(csp->headers->first->str) > 30)
2113 csp->headers->first->str[30] = '\0';
2115 log_error(LOG_LEVEL_ERROR,
2116 "Invalid server or forwarder response. Starts with: %s",
2117 csp->headers->first->str);
2118 log_error(LOG_LEVEL_CLF,
2119 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2120 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2121 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2122 free_http_request(http);
2123 mark_server_socket_tainted(csp);
2128 * We have now received the entire server header,
2129 * filter it and send the result to the client
2131 if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
2133 log_error(LOG_LEVEL_FATAL, "Failed to parse server headers.");
2135 hdr = list_to_text(csp->headers);
2138 /* FIXME Should handle error properly */
2139 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2142 if (crunch_response_triggered(csp, crunchers_light))
2145 * One of the tags created by a server-header
2146 * tagger triggered a crunch. We already
2147 * delivered the crunch response to the client
2148 * and are done here after cleaning up.
2151 mark_server_socket_tainted(csp);
2154 /* Buffer and pcrs filter this if appropriate. */
2156 if (!http->ssl) /* We talk plaintext */
2158 content_filter = get_filter_function(csp);
2161 * Only write if we're not buffering for content modification
2163 if (!content_filter)
2166 * Write the server's (modified) header to
2167 * the client (along with anything else that
2168 * may be in the buffer)
2171 if (write_socket(csp->cfd, hdr, strlen(hdr))
2172 || ((len = flush_socket(csp->cfd, csp->iob)) < 0))
2174 log_error(LOG_LEVEL_CONNECT, "write header to client failed: %E");
2177 * The write failed, so don't bother mentioning it
2178 * to the client... it probably can't hear us anyway.
2181 mark_server_socket_tainted(csp);
2185 byte_count += (unsigned long long)len;
2190 * XXX: the header lenght should probably
2191 * be calculated by get_server_headers().
2193 long header_length = csp->iob->cur - header_start;
2194 assert(csp->iob->cur > header_start);
2195 byte_count += (unsigned long long)(len - header_length);
2198 /* we're finished with the server's header */
2204 * If this was a MS IIS/5 hack then it means the server
2205 * has already closed the connection. Nothing more to read.
2210 log_error(LOG_LEVEL_ERROR,
2211 "Closed server connection detected. "
2212 "Applying the MS IIS5 hack didn't help.");
2213 log_error(LOG_LEVEL_CLF,
2214 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2215 write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2216 strlen(INVALID_SERVER_HEADERS_RESPONSE));
2217 mark_server_socket_tainted(csp);
2223 mark_server_socket_tainted(csp);
2224 return; /* huh? we should never get here */
2227 if (csp->content_length == 0)
2230 * If Privoxy didn't recalculate the Content-Lenght,
2231 * byte_count is still correct.
2233 csp->content_length = byte_count;
2236 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2237 if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2238 && (csp->expected_content_length != byte_count))
2240 log_error(LOG_LEVEL_CONNECT,
2241 "Received %llu bytes while expecting %llu.",
2242 byte_count, csp->expected_content_length);
2243 mark_server_socket_tainted(csp);
2247 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %llu",
2248 csp->ip_addr_str, http->ocmd, csp->content_length);
2252 /*********************************************************************
2256 * Description : This is little more than chat. We only "serve" to
2257 * to close (or remember) any socket that chat may have
2261 * 1 : csp = Current client state (buffers, headers, etc...)
2265 *********************************************************************/
2267 void serve(struct client_state *csp)
2268 #else /* ifndef AMIGA */
2269 static void serve(struct client_state *csp)
2270 #endif /* def AMIGA */
2272 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2273 static int monitor_thread_running = 0;
2274 int continue_chatting = 0;
2279 continue_chatting = (csp->config->feature_flags
2280 & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
2281 && (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
2282 && (csp->cfd != JB_INVALID_SOCKET)
2283 && (csp->sfd != JB_INVALID_SOCKET)
2284 && socket_is_still_usable(csp->sfd);
2286 if (continue_chatting)
2288 log_error(LOG_LEVEL_CONNECT,
2289 "Waiting for the next client request. "
2290 "Keeping the server socket %d to %s open.",
2291 csp->sfd, csp->server_connection.host);
2293 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
2294 && data_is_available(csp->cfd, (int)csp->server_connection.keep_alive_timeout)
2295 && socket_is_still_usable(csp->cfd))
2297 log_error(LOG_LEVEL_CONNECT, "Client request arrived in "
2298 "time or the client closed the connection.");
2300 * Get the csp in a mostly vergin state again.
2301 * XXX: Should be done elsewhere.
2303 csp->content_type = 0;
2304 csp->content_length = 0;
2305 csp->expected_content_length = 0;
2306 list_remove_all(csp->headers);
2307 freez(csp->iob->buf);
2308 memset(csp->iob, 0, sizeof(csp->iob));
2309 freez(csp->error_message);
2310 free_http_request(csp->http);
2311 destroy_list(csp->headers);
2312 destroy_list(csp->tags);
2313 free_current_action(csp->action);
2314 if (NULL != csp->fwd)
2316 unload_forward_spec(csp->fwd);
2320 /* XXX: Store per-connection flags someplace else. */
2321 csp->flags = CSP_FLAG_ACTIVE | (csp->flags & CSP_FLAG_TOGGLED_ON);
2325 log_error(LOG_LEVEL_CONNECT,
2326 "No additional client request received in time.");
2327 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING))
2329 remember_connection(csp->sfd, csp->http,
2330 forward_url(csp, csp->http),
2331 csp->server_connection.keep_alive_timeout);
2332 csp->sfd = JB_INVALID_SOCKET;
2333 close_socket(csp->cfd);
2334 csp->cfd = JB_INVALID_SOCKET;
2335 privoxy_mutex_lock(&connection_reuse_mutex);
2336 if (!monitor_thread_running)
2338 monitor_thread_running = 1;
2339 privoxy_mutex_unlock(&connection_reuse_mutex);
2340 wait_for_alive_connections();
2341 privoxy_mutex_lock(&connection_reuse_mutex);
2342 monitor_thread_running = 0;
2344 privoxy_mutex_unlock(&connection_reuse_mutex);
2349 else if (csp->sfd != JB_INVALID_SOCKET)
2351 log_error(LOG_LEVEL_CONNECT,
2352 "The connection on server socket %d to %s isn't reusable. "
2353 "Closing.", csp->sfd, csp->server_connection.host);
2355 } while (continue_chatting);
2357 mark_connection_closed(&csp->server_connection);
2360 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2362 if (csp->sfd != JB_INVALID_SOCKET)
2364 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2365 forget_connection(csp->sfd);
2366 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2367 close_socket(csp->sfd);
2370 if (csp->cfd != JB_INVALID_SOCKET)
2372 close_socket(csp->cfd);
2375 csp->flags &= ~CSP_FLAG_ACTIVE;
2381 /*********************************************************************
2383 * Function : server_thread
2385 * Description : We only exist to call `serve' in a threaded environment.
2388 * 1 : data = Current client state (buffers, headers, etc...)
2390 * Returns : Always 0.
2392 *********************************************************************/
2393 static int32 server_thread(void *data)
2395 serve((struct client_state *) data);
2402 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
2403 /*********************************************************************
2407 * Description : Print usage info & exit.
2409 * Parameters : Pointer to argv[0] for identifying ourselves
2413 *********************************************************************/
2414 static void usage(const char *myname)
2416 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
2420 #endif /* defined(unix) */
2423 "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
2424 #endif /* defined(unix) */
2425 "[--version] [configfile]\n"
2426 "Aborting\n", myname);
2431 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
2434 #ifdef MUTEX_LOCKS_AVAILABLE
2435 /*********************************************************************
2437 * Function : privoxy_mutex_lock
2439 * Description : Locks a mutex.
2442 * 1 : mutex = The mutex to lock.
2444 * Returns : Void. May exit in case of errors.
2446 *********************************************************************/
2447 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
2449 #ifdef FEATURE_PTHREAD
2450 int err = pthread_mutex_lock(mutex);
2453 if (mutex != &log_mutex)
2455 log_error(LOG_LEVEL_FATAL,
2456 "Mutex locking failed: %s.\n", strerror(err));
2461 EnterCriticalSection(mutex);
2462 #endif /* def FEATURE_PTHREAD */
2466 /*********************************************************************
2468 * Function : privoxy_mutex_unlock
2470 * Description : Unlocks a mutex.
2473 * 1 : mutex = The mutex to unlock.
2475 * Returns : Void. May exit in case of errors.
2477 *********************************************************************/
2478 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
2480 #ifdef FEATURE_PTHREAD
2481 int err = pthread_mutex_unlock(mutex);
2484 if (mutex != &log_mutex)
2486 log_error(LOG_LEVEL_FATAL,
2487 "Mutex unlocking failed: %s.\n", strerror(err));
2492 LeaveCriticalSection(mutex);
2493 #endif /* def FEATURE_PTHREAD */
2497 /*********************************************************************
2499 * Function : privoxy_mutex_init
2501 * Description : Prepares a mutex.
2504 * 1 : mutex = The mutex to initialize.
2506 * Returns : Void. May exit in case of errors.
2508 *********************************************************************/
2509 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
2511 #ifdef FEATURE_PTHREAD
2512 int err = pthread_mutex_init(mutex, 0);
2515 printf("Fatal error. Mutex initialization failed: %s.\n",
2520 InitializeCriticalSection(mutex);
2521 #endif /* def FEATURE_PTHREAD */
2523 #endif /* def MUTEX_LOCKS_AVAILABLE */
2525 /*********************************************************************
2527 * Function : initialize_mutexes
2529 * Description : Prepares mutexes if mutex support is available.
2533 * Returns : Void, exits in case of errors.
2535 *********************************************************************/
2536 static void initialize_mutexes(void)
2538 #ifdef MUTEX_LOCKS_AVAILABLE
2540 * Prepare global mutex semaphores
2542 privoxy_mutex_init(&log_mutex);
2543 privoxy_mutex_init(&log_init_mutex);
2544 privoxy_mutex_init(&connection_reuse_mutex);
2547 * XXX: The assumptions below are a bit naive
2548 * and can cause locks that aren't necessary.
2550 * For example older FreeBSD versions (< 6.x?)
2551 * have no gethostbyname_r, but gethostbyname is
2554 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
2555 privoxy_mutex_init(&resolver_mutex);
2556 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
2558 * XXX: should we use a single mutex for
2559 * localtime() and gmtime() as well?
2561 #ifndef HAVE_GMTIME_R
2562 privoxy_mutex_init(&gmtime_mutex);
2563 #endif /* ndef HAVE_GMTIME_R */
2565 #ifndef HAVE_LOCALTIME_R
2566 privoxy_mutex_init(&localtime_mutex);
2567 #endif /* ndef HAVE_GMTIME_R */
2570 privoxy_mutex_init(&rand_mutex);
2571 #endif /* ndef HAVE_RANDOM */
2572 #endif /* def MUTEX_LOCKS_AVAILABLE */
2576 /*********************************************************************
2580 * Description : Load the config file and start the listen loop.
2581 * This function is a lot more *sane* with the `load_config'
2582 * and `listen_loop' functions; although it stills does
2583 * a *little* too much for my taste.
2586 * 1 : argc = Number of parameters (including $0).
2587 * 2 : argv = Array of (char *)'s to the parameters.
2589 * Returns : 1 if : can't open config file, unrecognized directive,
2590 * stats requested in multi-thread mode, can't open the
2591 * log file, can't open the jar file, listen port is invalid,
2592 * any load fails, and can't bind port.
2594 * Else main never returns, the process must be signaled
2595 * to terminate execution. Or, on Windows, use the
2596 * "File", "Exit" menu option.
2598 *********************************************************************/
2600 int real_main(int argc, const char *argv[])
2602 int main(int argc, const char *argv[])
2606 unsigned int random_seed;
2608 struct passwd *pw = NULL;
2609 struct group *grp = NULL;
2612 char *pre_chroot_nslookup_to_load_resolver = NULL;
2619 #if !defined(_WIN32)
2626 /* Prepare mutexes if supported and necessary. */
2627 initialize_mutexes();
2629 /* Enable logging until further notice. */
2633 * Parse the command line arguments
2635 * XXX: simply printing usage information in case of
2636 * invalid arguments isn't particularly user friendly.
2638 while (++argc_pos < argc)
2641 /* Check to see if the service must be installed or uninstalled */
2642 if (strncmp(argv[argc_pos], "--install", 9) == 0)
2644 const char *pName = argv[argc_pos] + 9;
2647 exit( (install_service(pName)) ? 0 : 1 );
2649 else if (strncmp(argv[argc_pos], "--uninstall", + 11) == 0)
2651 const char *pName = argv[argc_pos] + 11;
2654 exit((uninstall_service(pName)) ? 0 : 1);
2656 else if (strcmp(argv[argc_pos], "--service" ) == 0)
2658 bRunAsService = TRUE;
2659 w32_set_service_cwd();
2660 atexit(w32_service_exit_notify);
2663 #endif /* defined(_WIN32) */
2666 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
2668 if (strcmp(argv[argc_pos], "--help") == 0)
2673 else if(strcmp(argv[argc_pos], "--version") == 0)
2675 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
2681 else if (strcmp(argv[argc_pos], "--no-daemon" ) == 0)
2683 set_debug_level(LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
2687 else if (strcmp(argv[argc_pos], "--pidfile" ) == 0)
2689 if (++argc_pos == argc) usage(argv[0]);
2690 pidfile = strdup(argv[argc_pos]);
2693 else if (strcmp(argv[argc_pos], "--user" ) == 0)
2695 if (++argc_pos == argc) usage(argv[argc_pos]);
2697 if ((NULL != (p = strchr(argv[argc_pos], '.'))) && *(p + 1) != '0')
2700 if (NULL == (grp = getgrnam(p)))
2702 log_error(LOG_LEVEL_FATAL, "Group %s not found.", p);
2706 if (NULL == (pw = getpwnam(argv[argc_pos])))
2708 log_error(LOG_LEVEL_FATAL, "User %s not found.", argv[argc_pos]);
2711 if (p != NULL) *--p = '\0';
2714 else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup" ) == 0)
2716 if (++argc_pos == argc) usage(argv[0]);
2717 pre_chroot_nslookup_to_load_resolver = strdup(argv[argc_pos]);
2720 else if (strcmp(argv[argc_pos], "--chroot" ) == 0)
2724 #endif /* defined(unix) */
2726 else if (argc_pos + 1 != argc)
2729 * This is neither the last command line
2730 * option, nor was it recognized before,
2731 * therefore it must be invalid.
2737 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
2739 configfile = argv[argc_pos];
2742 } /* -END- while (more arguments) */
2744 show_version(Argv[0]);
2747 if ( *configfile != '/' )
2749 char cwd[BUFFER_SIZE];
2751 size_t abs_file_size;
2753 /* make config-filename absolute here */
2754 if (NULL == getcwd(cwd, sizeof(cwd)))
2756 perror("failed to get current working directory");
2761 abs_file_size = strlen(cwd) + strlen(configfile) + 5;
2762 basedir = strdup(cwd);
2764 if (NULL == basedir ||
2765 NULL == (abs_file = malloc(abs_file_size)))
2767 perror("malloc failed");
2770 strlcpy(abs_file, basedir, abs_file_size);
2771 strlcat(abs_file, "/", abs_file_size );
2772 strlcat(abs_file, configfile, abs_file_size);
2773 configfile = abs_file;
2775 #endif /* defined unix */
2779 clients->next = NULL;
2781 /* XXX: factor out initialising after the next stable release. */
2784 #elif defined(_WIN32)
2788 random_seed = (unsigned int)time(NULL);
2790 srandom(random_seed);
2793 #endif /* ifdef HAVE_RANDOM */
2796 * Unix signal handling
2798 * Catch the abort, interrupt and terminate signals for a graceful exit
2799 * Catch the hangup signal so the errlog can be reopened.
2800 * Ignore the broken pipe signals (FIXME: Why?)
2802 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
2805 const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP, 0 };
2806 const int ignored_signals[] = { SIGPIPE, 0 };
2808 for (idx = 0; catched_signals[idx] != 0; idx++)
2810 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
2811 if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
2813 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
2814 #endif /* ifdef sun */
2816 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
2820 for (idx = 0; ignored_signals[idx] != 0; idx++)
2822 if (signal(ignored_signals[idx], SIG_IGN) == SIG_ERR)
2824 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for signal %d: %E", ignored_signals[idx]);
2829 #else /* ifdef _WIN32 */
2830 # ifdef _WIN_CONSOLE
2832 * We *are* in a windows console app.
2833 * Print a verbose messages about FAQ's and such
2835 printf("%s", win32_blurb);
2836 # endif /* def _WIN_CONSOLE */
2837 #endif /* def _WIN32 */
2840 /* Initialize the CGI subsystem */
2841 cgi_init_error_messages();
2844 * If runnig on unix and without the --nodaemon
2845 * option, become a daemon. I.e. fork, detach
2846 * from tty and get process group leadership
2859 if ( pid < 0 ) /* error */
2864 else if ( pid != 0 ) /* parent */
2869 * must check for errors
2870 * child died due to missing files aso
2873 wpid = waitpid( pid, &status, WNOHANG );
2882 /* Should be more portable, but not as well tested */
2887 #else /* ndef __FreeBSD__ */
2889 #endif /* ndef __FreeBSD__ */
2890 fd = open("/dev/tty", O_RDONLY);
2893 /* no error check here */
2894 ioctl( fd, TIOCNOTTY,0 );
2899 * stderr (fd 2) will be closed later on,
2900 * when the config file has been parsed.
2907 } /* -END- if (!no_daemon) */
2910 * As soon as we have written the PID file, we can switch
2911 * to the user and group ID indicated by the --user option
2917 if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
2919 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
2923 if (setgroups(1, &grp->gr_gid))
2925 log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
2928 else if (initgroups(pw->pw_name, pw->pw_gid))
2930 log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
2936 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
2938 /* Read the time zone file from /etc before doing chroot. */
2940 if (NULL != pre_chroot_nslookup_to_load_resolver
2941 && '\0' != pre_chroot_nslookup_to_load_resolver[0])
2943 /* Initialize resolver library. */
2944 (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
2946 if (chroot(pw->pw_dir) < 0)
2948 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
2952 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
2955 if (setuid(pw->pw_uid))
2957 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
2961 char putenv_dummy[64];
2963 strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
2964 if (putenv(putenv_dummy) != 0)
2966 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
2969 snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
2970 if (putenv(putenv_dummy) != 0)
2972 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
2978 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
2981 #endif /* defined unix */
2984 /* This will be FALSE unless the command line specified --service
2988 /* Yup, so now we must attempt to establish a connection
2989 * with the service dispatcher. This will only work if this
2990 * process was launched by the service control manager to
2991 * actually run as a service. If this isn't the case, i've
2992 * known it take around 30 seconds or so for the call to return.
2995 /* The StartServiceCtrlDispatcher won't return until the service is stopping */
2996 if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
2998 /* Service has run, and at this point is now being stopped, so just return */
3003 printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
3005 /* An error occurred. Usually it's because --service was wrongly specified
3006 * and we were unable to connect to the Service Control Dispatcher because
3007 * it wasn't expecting us and is therefore not listening.
3009 * For now, just continue below to call the listen_loop function.
3012 #endif /* def _WIN32 */
3022 /*********************************************************************
3024 * Function : bind_port_helper
3026 * Description : Bind the listen port. Handles logging, and aborts
3030 * 1 : config = Privoxy configuration. Specifies port
3033 * Returns : Port that was opened.
3035 *********************************************************************/
3036 static jb_socket bind_port_helper(struct configuration_spec * config)
3041 if (config->haddr == NULL)
3043 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
3048 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
3049 config->hport, config->haddr);
3052 result = bind_port(config->haddr, config->hport, &bfd);
3059 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
3060 "There may be another Privoxy or some other "
3061 "proxy running on port %d",
3062 (NULL != config->haddr) ? config->haddr : "INADDR_ANY",
3063 config->hport, config->hport);
3066 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
3067 "The hostname is not resolvable",
3068 (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
3071 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: because %E",
3072 (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
3075 /* shouldn't get here */
3076 return JB_INVALID_SOCKET;
3079 config->need_bind = 0;
3086 /* Without this simple workaround we get this compiler warning from _beginthread
3087 * warning C4028: formal parameter 1 different from declaration
3089 void w32_service_listen_loop(void *p)
3093 #endif /* def _WIN32 */
3096 /*********************************************************************
3098 * Function : listen_loop
3100 * Description : bind the listen port and enter a "FOREVER" listening loop.
3106 *********************************************************************/
3107 static void listen_loop(void)
3109 struct client_state *csp = NULL;
3111 struct configuration_spec *config;
3112 unsigned int active_threads = 0;
3114 config = load_config();
3116 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3118 * XXX: Should be relocated once it no
3119 * longer needs to emit log messages.
3121 initialize_reusable_connections();
3122 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3124 bfd = bind_port_helper(config);
3126 #ifdef FEATURE_GRACEFUL_TERMINATION
3127 while (!g_terminate)
3132 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
3133 while (waitpid(-1, NULL, WNOHANG) > 0)
3135 /* zombie children */
3137 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
3140 * Free data that was used by died threads
3142 active_threads = sweep();
3146 * Re-open the errlog after HUP signal
3148 if (received_hup_signal)
3150 if (NULL != config->logfile)
3152 init_error_log(Argv[0], config->logfile);
3154 received_hup_signal = 0;
3158 if ( NULL == (csp = (struct client_state *) zalloc(sizeof(*csp))) )
3160 log_error(LOG_LEVEL_FATAL, "malloc(%d) for csp failed: %E", sizeof(*csp));
3164 csp->flags |= CSP_FLAG_ACTIVE;
3165 csp->sfd = JB_INVALID_SOCKET;
3167 csp->config = config = load_config();
3169 if ( config->need_bind )
3172 * Since we were listening to the "old port", we will not see
3173 * a "listen" param change until the next request. So, at
3174 * least 1 more request must be made for us to find the new
3175 * setting. I am simply closing the old socket and binding the
3178 * Which-ever is correct, we will serve 1 more page via the
3179 * old settings. This should probably be a "show-proxy-args"
3180 * request. This should not be a so common of an operation
3181 * that this will hurt people's feelings.
3186 bfd = bind_port_helper(config);
3189 log_error(LOG_LEVEL_CONNECT, "Listening for new connections ... ");
3191 if (!accept_connection(csp, bfd))
3193 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
3206 log_error(LOG_LEVEL_CONNECT, "accepted connection from %s", csp->ip_addr_str);
3209 #ifdef FEATURE_TOGGLE
3210 if (global_toggle_state)
3211 #endif /* def FEATURE_TOGGLE */
3213 csp->flags |= CSP_FLAG_TOGGLED_ON;
3216 if (run_loader(csp))
3218 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
3219 /* Never get here - LOG_LEVEL_FATAL causes program exit */
3223 if (block_acl(NULL,csp))
3225 log_error(LOG_LEVEL_CONNECT, "Connection from %s dropped due to ACL", csp->ip_addr_str);
3226 close_socket(csp->cfd);
3227 freez(csp->ip_addr_str);
3231 #endif /* def FEATURE_ACL */
3233 if ((0 != config->max_client_connections)
3234 && (active_threads >= config->max_client_connections))
3236 log_error(LOG_LEVEL_CONNECT,
3237 "Rejecting connection from %s. Maximum number of connections reached.",
3239 write_socket(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
3240 strlen(TOO_MANY_CONNECTIONS_RESPONSE));
3241 close_socket(csp->cfd);
3242 freez(csp->ip_addr_str);
3247 /* add it to the list of clients */
3248 csp->next = clients->next;
3249 clients->next = csp;
3251 if (config->multi_threaded)
3255 /* this is a switch () statment in the C preprocessor - ugh */
3256 #undef SELECTED_ONE_OPTION
3258 /* Use Pthreads in preference to native code */
3259 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
3260 #define SELECTED_ONE_OPTION
3262 pthread_t the_thread;
3263 pthread_attr_t attrs;
3265 pthread_attr_init(&attrs);
3266 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
3267 errno = pthread_create(&the_thread, &attrs,
3268 (void * (*)(void *))serve, csp);
3269 child_id = errno ? -1 : 0;
3270 pthread_attr_destroy(&attrs);
3274 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
3275 #define SELECTED_ONE_OPTION
3276 child_id = _beginthread(
3277 (void (*)(void *))serve,
3282 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
3283 #define SELECTED_ONE_OPTION
3284 child_id = _beginthread(
3285 (void(* _Optlink)(void*))serve,
3291 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
3292 #define SELECTED_ONE_OPTION
3294 thread_id tid = spawn_thread
3295 (server_thread, "server", B_NORMAL_PRIORITY, csp);
3297 if ((tid >= 0) && (resume_thread(tid) == B_OK))
3299 child_id = (int) tid;
3308 #if defined(AMIGA) && !defined(SELECTED_ONE_OPTION)
3309 #define SELECTED_ONE_OPTION
3310 csp->cfd = ReleaseSocket(csp->cfd, -1);
3313 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
3314 NP_Output, Output(),
3315 NP_CloseOutput, FALSE,
3316 NP_Name, (ULONG)"privoxy child",
3320 child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
3321 NP_Output, Output(),
3322 NP_CloseOutput, FALSE,
3323 NP_Name, (ULONG)"privoxy child",
3324 NP_StackSize, 200*1024,
3330 ((struct Task *)child_id)->tc_UserData = csp;
3331 Signal((struct Task *)child_id, SIGF_SINGLE);
3336 #if !defined(SELECTED_ONE_OPTION)
3339 /* This block is only needed when using fork().
3340 * When using threads, the server thread was
3341 * created and run by the call to _beginthread().
3343 if (child_id == 0) /* child */
3346 #ifdef FEATURE_TOGGLE
3347 int inherited_toggle_state = global_toggle_state;
3348 #endif /* def FEATURE_TOGGLE */
3353 * If we've been toggled or we've blocked the request, tell Mom
3356 #ifdef FEATURE_TOGGLE
3357 if (inherited_toggle_state != global_toggle_state)
3359 rc |= RC_FLAG_TOGGLED;
3361 #endif /* def FEATURE_TOGGLE */
3363 #ifdef FEATURE_STATISTICS
3364 if (csp->flags & CSP_FLAG_REJECTED)
3366 rc |= RC_FLAG_BLOCKED;
3368 #endif /* ndef FEATURE_STATISTICS */
3372 else if (child_id > 0) /* parent */
3374 /* in a fork()'d environment, the parent's
3375 * copy of the client socket and the CSP
3379 #if !defined(_WIN32) && !defined(__CYGWIN__)
3381 wait( &child_status );
3384 * Evaluate child's return code: If the child has
3385 * - been toggled, toggle ourselves
3386 * - blocked its request, bump up the stats counter
3389 #ifdef FEATURE_TOGGLE
3390 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
3392 global_toggle_state = !global_toggle_state;
3394 #endif /* def FEATURE_TOGGLE */
3396 #ifdef FEATURE_STATISTICS
3398 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
3402 #endif /* def FEATURE_STATISTICS */
3404 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
3405 close_socket(csp->cfd);
3406 csp->flags &= ~CSP_FLAG_ACTIVE;
3410 #undef SELECTED_ONE_OPTION
3411 /* end of cpp switch () */
3416 * Spawning the child failed, assume it's because
3417 * there are too many children running already.
3418 * XXX: If you assume ...
3420 log_error(LOG_LEVEL_ERROR,
3421 "Unable to take any additional connections: %E");
3422 write_socket(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
3423 strlen(TOO_MANY_CONNECTIONS_RESPONSE));
3424 close_socket(csp->cfd);
3425 csp->flags &= ~CSP_FLAG_ACTIVE;
3434 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
3436 /* Clean up. Aim: free all memory (no leaks) */
3437 #ifdef FEATURE_GRACEFUL_TERMINATION
3439 log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
3441 unload_current_config_file();
3442 unload_current_actions_file();
3443 unload_current_re_filterfile();
3444 #ifdef FEATURE_TRUST
3445 unload_current_trust_file();
3448 if (config->multi_threaded)
3455 } while ((clients->next != NULL) && (--i > 0));
3459 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
3470 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
3471 /* Cleanup - remove taskbar icon etc. */
3476 #endif /* FEATURE_GRACEFUL_TERMINATION */