1 /*********************************************************************
3 * File : $Source: /cvsroot/ijbswa/current/jcc.c,v $
5 * Purpose : Main file. Contains main() method, main loop, and
6 * the main connection-handling function.
8 * Copyright : Written by and Copyright (C) 2001-2020 the
9 * Privoxy team. https://www.privoxy.org/
11 * Based on the Internet Junkbuster originally written
12 * by and Copyright (C) 1997 Anonymous Coders and
13 * Junkbusters Corporation. http://www.junkbusters.com
15 * This program is free software; you can redistribute it
16 * and/or modify it under the terms of the GNU General
17 * Public License as published by the Free Software
18 * Foundation; either version 2 of the License, or (at
19 * your option) any later version.
21 * This program is distributed in the hope that it will
22 * be useful, but WITHOUT ANY WARRANTY; without even the
23 * implied warranty of MERCHANTABILITY or FITNESS FOR A
24 * PARTICULAR PURPOSE. See the GNU General Public
25 * License for more details.
27 * The GNU General Public License should be included with
28 * this file. If not, you can view it at
29 * http://www.gnu.org/copyleft/gpl.html
30 * or write to the Free Software Foundation, Inc., 59
31 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
33 *********************************************************************/
39 #include <sys/types.h>
48 # ifndef FEATURE_PTHREAD
52 # include <winsock2.h>
55 # endif /* ndef FEATURE_PTHREAD */
60 # endif /* ndef _WIN_CONSOLE */
61 # include "w32svrapi.h"
63 #else /* ifndef _WIN32 */
66 # include <sys/wait.h>
67 # include <sys/time.h>
68 # include <sys/stat.h>
69 # include <sys/ioctl.h>
72 #include <sys/termios.h>
83 # include <socket.h> /* BeOS has select() for sockets only. */
84 # include <OS.h> /* declarations for threads and stuff. */
92 #endif /* def __GLIBC__ */
97 #warning poll() appears to be unavailable. Your platform will become unsupported in the future.
98 #endif /* HAVE_POLL */
105 #ifdef FEATURE_HTTPS_INSPECTION
111 #include "miscutil.h"
113 #include "jbsockets.h"
118 #include "urlmatch.h"
119 #ifdef FEATURE_CLIENT_TAGS
120 #include "client-tags.h"
124 struct client_states clients[1];
125 struct file_list files[1];
127 #ifdef FEATURE_STATISTICS
128 int urls_read = 0; /* total nr of urls read inc rejected */
129 int urls_rejected = 0; /* total nr of urls rejected */
130 #endif /* def FEATURE_STATISTICS */
132 #ifdef FEATURE_GRACEFUL_TERMINATION
137 static void sig_handler(int the_signal);
139 static int client_protocol_is_unsupported(struct client_state *csp, char *req);
140 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers);
141 static jb_err get_server_headers(struct client_state *csp);
142 static const char *crunch_reason(const struct http_response *rsp);
143 static void send_crunch_response(struct client_state *csp, struct http_response *rsp);
144 static char *get_request_line(struct client_state *csp);
145 static jb_err receive_client_request(struct client_state *csp);
146 static jb_err parse_client_request(struct client_state *csp);
147 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line);
148 static jb_err change_request_destination(struct client_state *csp);
149 static void handle_established_connection(struct client_state *csp);
150 static void chat(struct client_state *csp);
151 static void serve(struct client_state *csp);
152 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
153 static void usage(const char *myname);
155 static void initialize_mutexes(void);
156 static jb_socket bind_port_helper(const char *haddr, int hport, int backlog);
157 static void bind_ports_helper(struct configuration_spec *config, jb_socket sockets[]);
158 static void close_ports_helper(jb_socket sockets[]);
159 static void listen_loop(void);
160 static void serve(struct client_state *csp);
163 static int32 server_thread(void *data);
164 #endif /* def __BEOS__ */
167 #define sleep(N) Sleep(((N) * 1000))
171 int process_fuzzed_input(char *fuzz_input_type, char *fuzz_input_file);
172 void show_fuzz_usage(const char *name);
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 #ifdef FEATURE_HTTPS_INSPECTION
184 privoxy_mutex_t certificate_mutex;
185 privoxy_mutex_t ssl_init_mutex;
188 #ifdef FEATURE_EXTERNAL_FILTERS
189 privoxy_mutex_t external_filter_mutex;
191 #ifdef FEATURE_CLIENT_TAGS
192 privoxy_mutex_t client_tags_mutex;
194 #ifdef FEATURE_EXTENDED_STATISTICS
195 privoxy_mutex_t filter_statistics_mutex;
196 privoxy_mutex_t block_statistics_mutex;
199 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
200 privoxy_mutex_t resolver_mutex;
201 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
203 #ifndef HAVE_GMTIME_R
204 privoxy_mutex_t gmtime_mutex;
205 #endif /* ndef HAVE_GMTIME_R */
207 #ifndef HAVE_LOCALTIME_R
208 privoxy_mutex_t localtime_mutex;
209 #endif /* ndef HAVE_GMTIME_R */
211 #if !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM)
212 privoxy_mutex_t rand_mutex;
213 #endif /* !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM) */
215 #endif /* def MUTEX_LOCKS_AVAILABLE */
218 const char *basedir = NULL;
219 const char *pidfile = NULL;
220 static int received_hup_signal = 0;
221 #endif /* defined unix */
223 /* HTTP snipplets. */
224 static const char CSUCCEED[] =
225 "HTTP/1.1 200 Connection established\r\n\r\n";
227 static const char CHEADER[] =
228 "HTTP/1.1 400 Invalid header received from client\r\n"
229 "Content-Type: text/plain\r\n"
230 "Connection: close\r\n\r\n"
231 "Invalid header received from client.\r\n";
233 static const char FTP_RESPONSE[] =
234 "HTTP/1.1 400 Invalid request received from client\r\n"
235 "Content-Type: text/plain\r\n"
236 "Connection: close\r\n\r\n"
237 "Invalid request. Privoxy doesn't support FTP.\r\n";
239 static const char GOPHER_RESPONSE[] =
240 "HTTP/1.1 400 Invalid request received from client\r\n"
241 "Content-Type: text/plain\r\n"
242 "Connection: close\r\n\r\n"
243 "Invalid request. Privoxy doesn't support gopher.\r\n";
245 /* XXX: should be a template */
246 static const char MISSING_DESTINATION_RESPONSE[] =
247 "HTTP/1.1 400 Bad request received from client\r\n"
248 "Content-Type: text/plain\r\n"
249 "Connection: close\r\n\r\n"
250 "Bad request. Privoxy was unable to extract the destination.\r\n";
252 /* XXX: should be a template */
253 static const char INVALID_SERVER_HEADERS_RESPONSE[] =
254 "HTTP/1.1 502 Server or forwarder response invalid\r\n"
255 "Content-Type: text/plain\r\n"
256 "Connection: close\r\n\r\n"
257 "Bad response. The server or forwarder response doesn't look like HTTP.\r\n";
259 /* XXX: should be a template */
260 static const char MESSED_UP_REQUEST_RESPONSE[] =
261 "HTTP/1.1 400 Malformed request after rewriting\r\n"
262 "Content-Type: text/plain\r\n"
263 "Connection: close\r\n\r\n"
264 "Bad request. Messed up with header filters.\r\n";
266 static const char TOO_MANY_CONNECTIONS_RESPONSE[] =
267 "HTTP/1.1 503 Too many open connections\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.1 504 Connection timeout\r\n"
274 "Content-Type: text/plain\r\n"
275 "Connection: close\r\n\r\n"
276 "The connection timed out because the client request didn't arrive in time.\r\n";
278 static const char CLIENT_BODY_PARSE_ERROR_RESPONSE[] =
279 "HTTP/1.1 400 Failed reading client body\r\n"
280 "Content-Type: text/plain\r\n"
281 "Connection: close\r\n\r\n"
282 "Failed parsing or buffering the chunk-encoded client body.\r\n";
284 static const char UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE[] =
285 "HTTP/1.1 417 Expecting too much\r\n"
286 "Content-Type: text/plain\r\n"
287 "Connection: close\r\n\r\n"
288 "Privoxy detected an unsupported Expect header value.\r\n";
290 /* A function to crunch a response */
291 typedef struct http_response *(*crunch_func_ptr)(struct client_state *);
293 /* Crunch function flags */
294 #define CF_NO_FLAGS 0
295 /* Cruncher applies to forced requests as well */
296 #define CF_IGNORE_FORCE 1
297 /* Crunched requests are counted for the block statistics */
298 #define CF_COUNT_AS_REJECT 2
300 /* A crunch function and its flags */
303 const crunch_func_ptr cruncher;
307 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[]);
309 /* Complete list of cruncher functions */
310 static const struct cruncher crunchers_all[] = {
311 { direct_response, CF_COUNT_AS_REJECT|CF_IGNORE_FORCE},
312 { block_url, CF_COUNT_AS_REJECT },
314 { trust_url, CF_COUNT_AS_REJECT },
315 #endif /* def FEATURE_TRUST */
316 { redirect_url, CF_NO_FLAGS },
317 { dispatch_cgi, CF_IGNORE_FORCE},
321 /* Light version, used after tags are applied */
322 static const struct cruncher crunchers_light[] = {
323 { block_url, CF_COUNT_AS_REJECT },
324 { redirect_url, CF_NO_FLAGS },
330 * XXX: Don't we really mean
337 /*********************************************************************
339 * Function : sig_handler
341 * Description : Signal handler for different signals.
342 * Exit gracefully on TERM and INT
343 * or set a flag that will cause the errlog
344 * to be reopened by the main thread on HUP.
347 * 1 : the_signal = the signal cause this function to call
351 *********************************************************************/
352 static void sig_handler(int the_signal)
358 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
370 received_hup_signal = 1;
376 * We shouldn't be here, unless we catch signals
377 * in main() that we can't handle here!
379 log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
387 /*********************************************************************
389 * Function : get_write_delay
391 * Description : Parse the delay-response parameter.
394 * 1 : csp = Current client state (buffers, headers, etc...)
396 * Returns : Number of milliseconds to delay writes.
398 *********************************************************************/
399 static unsigned int get_write_delay(const struct client_state *csp)
405 if ((csp->action->flags & ACTION_DELAY_RESPONSE) == 0)
409 newval = csp->action->string[ACTION_STRING_DELAY_RESPONSE];
411 delay = (unsigned)strtol(newval, &endptr, 0);
414 log_error(LOG_LEVEL_FATAL,
415 "Invalid delay-response{} parameter: '%s'", newval);
423 /*********************************************************************
425 * Function : client_protocol_is_unsupported
427 * Description : Checks if the client used a known unsupported
428 * protocol and deals with it by sending an error
432 * 1 : csp = Current client state (buffers, headers, etc...)
433 * 2 : req = the first request line send by the client
435 * Returns : TRUE if an error response has been generated, or
436 * FALSE if the request doesn't look invalid.
438 *********************************************************************/
439 static int client_protocol_is_unsupported(struct client_state *csp, char *req)
442 * If it's a FTP or gopher request, we don't support it.
444 * These checks are better than nothing, but they might
445 * not work in all configurations and some clients might
446 * have problems digesting the answer.
448 * They should, however, never cause more problems than
449 * Privoxy's old behaviour (returning the misleading HTML
452 * "Could not resolve http://(ftp|gopher)://example.org").
454 if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
456 const char *response = NULL;
457 const char *protocol = NULL;
459 if (!strncmpic(req, "GET ftp://", 10))
461 response = FTP_RESPONSE;
466 response = GOPHER_RESPONSE;
469 log_error(LOG_LEVEL_ERROR,
470 "%s tried to use Privoxy as %s proxy: %s",
471 csp->ip_addr_str, protocol, req);
472 log_error(LOG_LEVEL_CLF,
473 "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, req);
476 #ifdef FEATURE_HTTPS_INSPECTION
477 if (client_use_ssl(csp))
479 ssl_send_data_delayed(&(csp->ssl_client_attr),
480 (const unsigned char *)response, strlen(response),
481 get_write_delay(csp));
486 write_socket_delayed(csp->cfd, response, strlen(response),
487 get_write_delay(csp));
497 /*********************************************************************
499 * Function : client_has_unsupported_expectations
501 * Description : Checks if the client used an unsupported expectation
502 * in which case an error message is delivered.
505 * 1 : csp = Current client state (buffers, headers, etc...)
507 * Returns : TRUE if an error response has been generated, or
508 * FALSE if the request doesn't look invalid.
510 *********************************************************************/
511 static int client_has_unsupported_expectations(const struct client_state *csp)
513 if ((csp->flags & CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION))
515 log_error(LOG_LEVEL_ERROR,
516 "Rejecting request from client %s with unsupported Expect header value",
518 log_error(LOG_LEVEL_CLF,
519 "%s - - [%T] \"%s\" 417 0", csp->ip_addr_str, csp->http->cmd);
520 write_socket_delayed(csp->cfd,
521 UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE,
522 strlen(UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE),
523 get_write_delay(csp));
533 /*********************************************************************
535 * Function : get_request_destination_elsewhere
537 * Description : If the client's request was redirected into
538 * Privoxy without the client's knowledge,
539 * the request line lacks the destination host.
541 * This function tries to get it elsewhere,
542 * provided accept-intercepted-requests is enabled.
544 * "Elsewhere" currently only means "Host: header",
545 * but in the future we may ask the redirecting
546 * packet filter to look the destination up.
548 * If the destination stays unknown, an error
549 * response is send to the client and headers
550 * are freed so that chat() can return directly.
553 * 1 : csp = Current client state (buffers, headers, etc...)
554 * 2 : headers = a header list
556 * Returns : JB_ERR_OK if the destination is now known, or
557 * JB_ERR_PARSE if it isn't.
559 *********************************************************************/
560 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
564 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
566 log_error(LOG_LEVEL_ERROR, "%s's request: \'%s\' is invalid."
567 " Privoxy isn't configured to accept intercepted requests.",
568 csp->ip_addr_str, csp->http->cmd);
569 /* XXX: Use correct size */
570 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
571 csp->ip_addr_str, csp->http->cmd);
573 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER),
574 get_write_delay(csp));
575 destroy_list(headers);
579 else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
581 /* Split the domain we just got for pattern matching */
582 init_domain_components(csp->http);
588 /* We can't work without destination. Go spread the news.*/
590 req = list_to_text(headers);
592 /* XXX: Use correct size */
593 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
594 csp->ip_addr_str, csp->http->cmd);
595 log_error(LOG_LEVEL_ERROR,
596 "Privoxy was unable to get the destination for %s's request:\n%s\n%s",
597 csp->ip_addr_str, csp->http->cmd, req);
600 write_socket_delayed(csp->cfd, MISSING_DESTINATION_RESPONSE,
601 strlen(MISSING_DESTINATION_RESPONSE), get_write_delay(csp));
602 destroy_list(headers);
607 * TODO: If available, use PF's ioctl DIOCNATLOOK as last resort
608 * to get the destination IP address, use it as host directly
609 * or do a reverse DNS lookup first.
614 /*********************************************************************
616 * Function : get_server_headers
618 * Description : Parses server headers in iob and fills them
619 * into csp->headers so that they can later be
623 * 1 : csp = Current client state (buffers, headers, etc...)
625 * Returns : JB_ERR_OK if everything went fine, or
626 * JB_ERR_PARSE if the headers were incomplete.
628 *********************************************************************/
629 static jb_err get_server_headers(struct client_state *csp)
631 int continue_hack_in_da_house = 0;
634 while (((header = get_header(csp->iob)) != NULL) || continue_hack_in_da_house)
639 * continue hack in da house. Ignore the ending of
640 * this head and continue enlisting header lines.
641 * The reason is described below.
643 enlist(csp->headers, "");
644 continue_hack_in_da_house = 0;
647 else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
650 * It's a bodyless continue response, don't
651 * stop header parsing after reaching its end.
653 * As a result Privoxy will concatenate the
654 * next response's head and parse and deliver
655 * the headers as if they belonged to one request.
657 * The client will separate them because of the
658 * empty line between them.
660 * XXX: What we're doing here is clearly against
661 * the intended purpose of the continue header,
662 * and under some conditions (HTTP/1.0 client request)
663 * it's a standard violation.
665 * Anyway, "sort of against the spec" is preferable
666 * to "always getting confused by Continue responses"
667 * (Privoxy's behaviour before this hack was added)
669 log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
670 continue_hack_in_da_house = 1;
672 else if (*header == '\0')
675 * If the header is empty, but the Continue hack
676 * isn't active, we can assume that we reached the
677 * end of the buffer before we hit the end of the
680 * Inform the caller an let it decide how to handle it.
685 if (JB_ERR_MEMORY == enlist(csp->headers, header))
688 * XXX: Should we quit the request and return a
689 * out of memory error page instead?
691 log_error(LOG_LEVEL_ERROR,
692 "Out of memory while enlisting server headers. %s lost.",
702 /*********************************************************************
704 * Function : crunch_reason
706 * Description : Translates the crunch reason code into a string.
709 * 1 : rsp = a http_response
711 * Returns : A string with the crunch reason or an error description.
713 *********************************************************************/
714 static const char *crunch_reason(const struct http_response *rsp)
716 char * reason = NULL;
721 return "Internal error while searching for crunch reason";
724 switch (rsp->crunch_reason)
727 reason = "Unsupported HTTP feature";
733 reason = "Untrusted";
736 reason = "Redirected";
742 reason = "DNS failure";
744 case FORWARDING_FAILED:
745 reason = "Forwarding failed";
748 reason = "Connection failure";
751 reason = "Out of memory (may mask other reasons)";
753 case CONNECTION_TIMEOUT:
754 reason = "Connection timeout";
757 reason = "No server data received";
760 reason = "No reason recorded";
768 /*********************************************************************
770 * Function : log_applied_actions
772 * Description : Logs the applied actions if LOG_LEVEL_ACTIONS is
776 * 1 : actions = Current action spec to log
780 *********************************************************************/
781 static void log_applied_actions(const struct current_action_spec *actions)
784 * The conversion to text requires lots of memory allocations so
785 * we only do the conversion if the user is actually interested.
787 if (debug_level_is_enabled(LOG_LEVEL_ACTIONS))
789 char *actions_as_text = actions_to_line_of_text(actions);
790 log_error(LOG_LEVEL_ACTIONS, "%s", actions_as_text);
791 freez(actions_as_text);
796 /*********************************************************************
798 * Function : send_crunch_response
800 * Description : Delivers already prepared response for
801 * intercepted requests, logs the interception
802 * and frees the response.
805 * 1 : csp = Current client state (buffers, headers, etc...)
806 * 2 : rsp = Fully prepared response. Will be freed on exit.
810 *********************************************************************/
811 static void send_crunch_response(struct client_state *csp, struct http_response *rsp)
813 const struct http_request *http = csp->http;
817 assert(rsp->head != NULL);
821 log_error(LOG_LEVEL_FATAL, "NULL response in send_crunch_response.");
825 * Extract the status code from the actual head
826 * that will be send to the client. It is the only
827 * way to get it right for all requests, including
828 * the fixed ones for out-of-memory problems.
830 * A head starts like this: 'HTTP/1.1 200...'
834 status_code[0] = rsp->head[9];
835 status_code[1] = rsp->head[10];
836 status_code[2] = rsp->head[11];
837 status_code[3] = '\0';
839 /* Log that the request was crunched and why. */
840 log_applied_actions(csp->action);
841 #ifdef FEATURE_HTTPS_INSPECTION
842 if (client_use_ssl(csp))
844 log_error(LOG_LEVEL_CRUNCH, "%s: https://%s%s", crunch_reason(rsp),
845 http->hostport, http->path);
846 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s https://%s%s %s\" %s %lu",
847 csp->ip_addr_str, http->gpc, http->hostport, http->path,
848 http->version, status_code, rsp->content_length);
853 log_error(LOG_LEVEL_CRUNCH, "%s: %s", crunch_reason(rsp), http->url);
854 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" %s %lu",
855 csp->ip_addr_str, http->ocmd, status_code, rsp->content_length);
857 /* Write the answer to the client */
858 #ifdef FEATURE_HTTPS_INSPECTION
859 if (client_use_ssl(csp))
861 if ((ssl_send_data_delayed(&(csp->ssl_client_attr),
862 (const unsigned char *)rsp->head, rsp->head_length,
863 get_write_delay(csp)) < 0)
864 || (ssl_send_data_delayed(&(csp->ssl_client_attr),
865 (const unsigned char *)rsp->body, rsp->content_length,
866 get_write_delay(csp)) < 0))
868 /* There is nothing we can do about it. */
869 log_error(LOG_LEVEL_CONNECT, "Couldn't deliver the error message "
870 "for https://%s%s through client socket %d using TLS/SSL",
871 http->hostport, http->url, csp->cfd);
877 if (write_socket_delayed(csp->cfd, rsp->head, rsp->head_length,
878 get_write_delay(csp))
879 || write_socket_delayed(csp->cfd, rsp->body, rsp->content_length,
880 get_write_delay(csp)))
882 /* There is nothing we can do about it. */
883 log_error(LOG_LEVEL_CONNECT,
884 "Couldn't deliver the error message for %s through client socket %d: %E",
885 http->url, csp->cfd);
889 /* Clean up and return */
890 if (cgi_error_memory() != rsp)
892 free_http_response(rsp);
898 /*********************************************************************
900 * Function : crunch_response_triggered
902 * Description : Checks if the request has to be crunched,
903 * and delivers the crunch response if necessary.
906 * 1 : csp = Current client state (buffers, headers, etc...)
907 * 2 : crunchers = list of cruncher functions to run
909 * Returns : TRUE if the request was answered with a crunch response
912 *********************************************************************/
913 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[])
915 struct http_response *rsp = NULL;
916 const struct cruncher *c;
919 * If CGI request crunching is disabled,
920 * check the CGI dispatcher out of order to
921 * prevent unintentional blocks or redirects.
923 if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_CRUNCHING)
924 && (NULL != (rsp = dispatch_cgi(csp))))
926 /* Deliver, log and free the interception response. */
927 send_crunch_response(csp, rsp);
928 csp->flags |= CSP_FLAG_CRUNCHED;
932 for (c = crunchers; c->cruncher != NULL; c++)
935 * Check the cruncher if either Privoxy is toggled
936 * on and the request isn't forced, or if the cruncher
937 * applies to forced requests as well.
939 if (((csp->flags & CSP_FLAG_TOGGLED_ON) &&
940 !(csp->flags & CSP_FLAG_FORCED)) ||
941 (c->flags & CF_IGNORE_FORCE))
943 rsp = c->cruncher(csp);
946 /* Deliver, log and free the interception response. */
947 send_crunch_response(csp, rsp);
948 csp->flags |= CSP_FLAG_CRUNCHED;
949 #ifdef FEATURE_STATISTICS
950 if (c->flags & CF_COUNT_AS_REJECT)
952 csp->flags |= CSP_FLAG_REJECTED;
954 #endif /* def FEATURE_STATISTICS */
965 /*********************************************************************
967 * Function : build_request_line
969 * Description : Builds the HTTP request line.
971 * If a HTTP forwarder is used it expects the whole URL,
972 * web servers only get the path.
975 * 1 : csp = Current client state (buffers, headers, etc...)
976 * 2 : fwd = The forwarding spec used for the request
977 * XXX: Should use http->fwd instead.
978 * 3 : request_line = The old request line which will be replaced.
980 * Returns : Nothing. Terminates in case of memory problems.
982 *********************************************************************/
983 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line)
985 struct http_request *http = csp->http;
988 * Downgrade http version from 1.1 to 1.0
989 * if +downgrade action applies.
991 if ((csp->action->flags & ACTION_DOWNGRADE)
992 && (!strcmpic(http->version, "HTTP/1.1")))
994 freez(http->version);
995 http->version = strdup_or_die("HTTP/1.0");
999 * Rebuild the request line.
1001 freez(*request_line);
1002 *request_line = strdup(http->gpc);
1003 string_append(request_line, " ");
1005 if (fwd->forward_host && fwd->type != FORWARD_WEBSERVER)
1007 string_append(request_line, http->url);
1011 string_append(request_line, http->path);
1013 string_append(request_line, " ");
1014 string_append(request_line, http->version);
1016 if (*request_line == NULL)
1018 log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
1020 log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", *request_line);
1024 /*********************************************************************
1026 * Function : change_request_destination
1028 * Description : Parse a (rewritten) request line and regenerate
1029 * the http request data.
1032 * 1 : csp = Current client state (buffers, headers, etc...)
1034 * Returns : Forwards the parse_http_request() return code.
1035 * Terminates in case of memory problems.
1037 *********************************************************************/
1038 static jb_err change_request_destination(struct client_state *csp)
1040 struct http_request *http = csp->http;
1043 log_error(LOG_LEVEL_REDIRECTS, "Rewrite detected: %s",
1044 csp->headers->first->str);
1045 free_http_request(http);
1046 err = parse_http_request(csp->headers->first->str, http);
1047 if (JB_ERR_OK != err)
1049 log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
1050 jb_err_to_string(err));
1057 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1058 /*********************************************************************
1060 * Function : server_response_is_complete
1062 * Description : Determines whether we should stop reading
1063 * from the server socket.
1066 * 1 : csp = Current client state (buffers, headers, etc...)
1067 * 2 : content_length = Length of content received so far.
1069 * Returns : TRUE if the response is complete,
1072 *********************************************************************/
1073 static int server_response_is_complete(struct client_state *csp,
1074 unsigned long long content_length)
1076 int content_length_known = !!(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET);
1078 if (!strcmpic(csp->http->gpc, "HEAD"))
1081 * "HEAD" implies no body, we are thus expecting
1082 * no content. XXX: incomplete "list" of methods?
1084 csp->expected_content_length = 0;
1085 content_length_known = TRUE;
1086 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1089 if (csp->http->status == 204 || csp->http->status == 304)
1092 * Expect no body. XXX: incomplete "list" of status codes?
1094 csp->expected_content_length = 0;
1095 content_length_known = TRUE;
1096 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1099 return (content_length_known && ((0 == csp->expected_content_length)
1100 || (csp->expected_content_length <= content_length)));
1104 #ifdef FEATURE_CONNECTION_SHARING
1105 /*********************************************************************
1107 * Function : wait_for_alive_connections
1109 * Description : Waits for alive connections to timeout.
1115 *********************************************************************/
1116 static void wait_for_alive_connections(void)
1118 int connections_alive = close_unusable_connections();
1120 while (0 < connections_alive)
1122 log_error(LOG_LEVEL_CONNECT,
1123 "Waiting for %d connections to timeout.",
1126 connections_alive = close_unusable_connections();
1129 log_error(LOG_LEVEL_CONNECT, "No connections to wait for left.");
1132 #endif /* def FEATURE_CONNECTION_SHARING */
1135 /*********************************************************************
1137 * Function : save_connection_destination
1139 * Description : Remembers a connection for reuse later on.
1142 * 1 : sfd = Open socket to remember.
1143 * 2 : http = The destination for the connection.
1144 * 3 : fwd = The forwarder settings used.
1145 * 4 : server_connection = storage.
1149 *********************************************************************/
1150 void save_connection_destination(jb_socket sfd,
1151 const struct http_request *http,
1152 const struct forward_spec *fwd,
1153 struct reusable_connection *server_connection)
1155 assert(sfd != JB_INVALID_SOCKET);
1156 assert(NULL != http->host);
1158 server_connection->sfd = sfd;
1159 server_connection->host = strdup_or_die(http->host);
1160 server_connection->port = http->port;
1162 assert(NULL != fwd);
1163 assert(server_connection->gateway_host == NULL);
1164 assert(server_connection->gateway_port == 0);
1165 assert(server_connection->forwarder_type == 0);
1166 assert(server_connection->forward_host == NULL);
1167 assert(server_connection->forward_port == 0);
1169 server_connection->forwarder_type = fwd->type;
1170 if (NULL != fwd->gateway_host)
1172 server_connection->gateway_host = strdup_or_die(fwd->gateway_host);
1176 server_connection->gateway_host = NULL;
1178 server_connection->gateway_port = fwd->gateway_port;
1179 if (NULL != fwd->auth_username)
1181 server_connection->auth_username = strdup_or_die(fwd->auth_username);
1185 server_connection->auth_username = NULL;
1187 if (NULL != fwd->auth_password)
1189 server_connection->auth_password = strdup_or_die(fwd->auth_password);
1193 server_connection->auth_password = NULL;
1196 if (NULL != fwd->forward_host)
1198 server_connection->forward_host = strdup_or_die(fwd->forward_host);
1202 server_connection->forward_host = NULL;
1204 server_connection->forward_port = fwd->forward_port;
1206 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1209 /*********************************************************************
1211 * Function : verify_request_length
1213 * Description : Checks if we already got the whole client requests
1214 * and sets CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ if
1217 * Data that doesn't belong to the current request is
1218 * either thrown away to let the client retry on a clean
1219 * socket, or stashed to be dealt with after the current
1220 * request is served.
1223 * 1 : csp = Current client state (buffers, headers, etc...)
1227 *********************************************************************/
1228 static void verify_request_length(struct client_state *csp)
1230 unsigned long long buffered_request_bytes =
1231 (unsigned long long)(csp->client_iob->eod - csp->client_iob->cur);
1233 if ((csp->expected_client_content_length != 0)
1234 && (buffered_request_bytes != 0))
1236 if (csp->expected_client_content_length >= buffered_request_bytes)
1238 csp->expected_client_content_length -= buffered_request_bytes;
1239 log_error(LOG_LEVEL_CONNECT, "Reduced expected bytes to %llu "
1240 "to account for the %llu ones we already got.",
1241 csp->expected_client_content_length, buffered_request_bytes);
1245 assert(csp->client_iob->eod > csp->client_iob->cur + csp->expected_client_content_length);
1246 csp->client_iob->eod = csp->client_iob->cur + csp->expected_client_content_length;
1247 log_error(LOG_LEVEL_CONNECT, "Reducing expected bytes to 0. "
1248 "Marking the server socket tainted after throwing %llu bytes away.",
1249 buffered_request_bytes - csp->expected_client_content_length);
1250 csp->expected_client_content_length = 0;
1251 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1254 if (csp->expected_client_content_length == 0)
1256 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1260 if (!(csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ)
1261 && ((csp->client_iob->cur < csp->client_iob->eod)
1262 || (csp->expected_client_content_length != 0)))
1264 if (strcmpic(csp->http->gpc, "GET")
1265 && strcmpic(csp->http->gpc, "HEAD")
1266 && strcmpic(csp->http->gpc, "TRACE")
1267 && strcmpic(csp->http->gpc, "OPTIONS")
1268 && strcmpic(csp->http->gpc, "DELETE"))
1270 /* XXX: this is an incomplete hack */
1271 csp->flags &= ~CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1272 log_error(LOG_LEVEL_CONNECT, "There better be a request body.");
1276 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1278 if ((csp->config->feature_flags & RUNTIME_FEATURE_TOLERATE_PIPELINING) == 0)
1280 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1281 log_error(LOG_LEVEL_CONNECT,
1282 "Possible pipeline attempt detected. The connection will not "
1283 "be kept alive and we will only serve the first request.");
1284 /* Nuke the pipelined requests from orbit, just to be sure. */
1285 clear_iob(csp->client_iob);
1290 * Keep the pipelined data around for now, we'll deal with
1291 * it once we're done serving the current request.
1293 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
1294 assert(csp->client_iob->eod >= csp->client_iob->cur);
1295 log_error(LOG_LEVEL_CONNECT, "Complete client request followed by "
1296 "%d bytes of pipelined data received.",
1297 (int)(csp->client_iob->eod - csp->client_iob->cur));
1303 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1304 log_error(LOG_LEVEL_CONNECT, "Complete client request received.");
1309 /*********************************************************************
1311 * Function : mark_server_socket_tainted
1313 * Description : Makes sure we don't reuse a server socket
1314 * (if we didn't read everything the server sent
1315 * us reusing the socket would lead to garbage).
1318 * 1 : csp = Current client state (buffers, headers, etc...)
1322 *********************************************************************/
1323 static void mark_server_socket_tainted(struct client_state *csp)
1326 * For consistency we always mark the server socket
1327 * tainted, however, to reduce the log noise we only
1328 * emit a log message if the server socket could have
1329 * actually been reused.
1331 if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
1332 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED))
1334 log_error(LOG_LEVEL_CONNECT,
1335 "Marking the server socket %d tainted.",
1336 csp->server_connection.sfd);
1338 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1341 /*********************************************************************
1343 * Function : get_request_line
1345 * Description : Read the client request line.
1348 * 1 : csp = Current client state (buffers, headers, etc...)
1350 * Returns : Pointer to request line or NULL in case of errors.
1352 *********************************************************************/
1353 static char *get_request_line(struct client_state *csp)
1355 char buf[BUFFER_SIZE];
1356 char *request_line = NULL;
1359 memset(buf, 0, sizeof(buf));
1361 if ((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
1364 * If there are multiple pipelined requests waiting,
1365 * the flag will be set again once the next request
1368 csp->flags &= ~CSP_FLAG_PIPELINED_REQUEST_WAITING;
1370 request_line = get_header(csp->client_iob);
1371 if ((NULL != request_line) && ('\0' != *request_line))
1373 return request_line;
1377 log_error(LOG_LEVEL_CONNECT, "No complete request line "
1378 "received yet. Continuing reading from %d.", csp->cfd);
1386 0 == (csp->flags & CSP_FLAG_FUZZED_INPUT) &&
1388 !data_is_available(csp->cfd, csp->config->socket_timeout)
1391 if (socket_is_still_alive(csp->cfd))
1393 log_error(LOG_LEVEL_CONNECT,
1394 "No request line on socket %d received in time. Timeout: %d.",
1395 csp->cfd, csp->config->socket_timeout);
1396 write_socket_delayed(csp->cfd, CLIENT_CONNECTION_TIMEOUT_RESPONSE,
1397 strlen(CLIENT_CONNECTION_TIMEOUT_RESPONSE),
1398 get_write_delay(csp));
1402 log_error(LOG_LEVEL_CONNECT,
1403 "The client side of the connection on socket %d got "
1404 "closed without sending a complete request line.", csp->cfd);
1409 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1411 if (len <= 0) return NULL;
1414 * If there is no memory left for buffering the
1415 * request, there is nothing we can do but hang up
1417 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1422 request_line = get_header(csp->client_iob);
1424 } while ((NULL != request_line) && ('\0' == *request_line));
1426 return request_line;
1432 CHUNK_STATUS_MISSING_DATA,
1433 CHUNK_STATUS_BODY_COMPLETE,
1434 CHUNK_STATUS_PARSE_ERROR
1438 /*********************************************************************
1440 * Function : chunked_body_is_complete
1442 * Description : Figures out whether or not a chunked body is complete.
1444 * Currently it always starts at the beginning of the
1445 * buffer which is somewhat wasteful and prevents Privoxy
1446 * from starting to forward the correctly parsed chunks
1447 * as soon as theoretically possible.
1449 * Should be modified to work with a common buffer,
1450 * and allow the caller to skip already parsed chunks.
1452 * This would allow the function to be used for unbuffered
1453 * response bodies as well.
1456 * 1 : iob = Buffer with the body to check.
1457 * 2 : length = Length of complete body
1459 * Returns : Enum with the result of the check.
1461 *********************************************************************/
1462 static enum chunk_status chunked_body_is_complete(struct iob *iob, size_t *length)
1464 unsigned int chunksize;
1470 * We need at least a single digit, followed by "\r\n",
1471 * followed by an unknown amount of data, followed by "\r\n".
1473 if (p + 5 > iob->eod)
1475 return CHUNK_STATUS_MISSING_DATA;
1477 if (sscanf(p, "%x", &chunksize) != 1)
1479 return CHUNK_STATUS_PARSE_ERROR;
1483 * We want at least a single digit, followed by "\r\n",
1484 * followed by the specified amount of data, followed by "\r\n".
1486 if (p + chunksize + 5 > iob->eod)
1488 return CHUNK_STATUS_MISSING_DATA;
1491 /* Skip chunk-size. */
1492 p = strstr(p, "\r\n");
1495 return CHUNK_STATUS_PARSE_ERROR;
1497 /* Move beyond the chunkdata. */
1500 /* There should be another "\r\n" to skip */
1501 if (memcmp(p, "\r\n", 2))
1503 return CHUNK_STATUS_PARSE_ERROR;
1506 } while (chunksize > 0U);
1508 *length = (size_t)(p - iob->cur);
1509 assert(*length <= (size_t)(iob->eod - iob->cur));
1510 assert(p <= iob->eod);
1512 return CHUNK_STATUS_BODY_COMPLETE;
1517 /*********************************************************************
1519 * Function : receive_chunked_client_request_body
1521 * Description : Read the chunk-encoded client request body.
1522 * Failures are dealt with.
1525 * 1 : csp = Current client state (buffers, headers, etc...)
1527 * Returns : JB_ERR_OK or JB_ERR_PARSE
1529 *********************************************************************/
1530 static jb_err receive_chunked_client_request_body(struct client_state *csp)
1533 enum chunk_status status;
1535 while (CHUNK_STATUS_MISSING_DATA ==
1536 (status = chunked_body_is_complete(csp->client_iob, &body_length)))
1538 char buf[BUFFER_SIZE];
1541 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1543 log_error(LOG_LEVEL_ERROR,
1544 "Timeout while waiting for the client body.");
1547 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1550 log_error(LOG_LEVEL_ERROR, "Read the client body failed: %E");
1553 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1558 if (status != CHUNK_STATUS_BODY_COMPLETE)
1560 write_socket_delayed(csp->cfd, CLIENT_BODY_PARSE_ERROR_RESPONSE,
1561 strlen(CLIENT_BODY_PARSE_ERROR_RESPONSE), get_write_delay(csp));
1562 log_error(LOG_LEVEL_CLF,
1563 "%s - - [%T] \"Failed reading chunked client body\" 400 0", csp->ip_addr_str);
1564 return JB_ERR_PARSE;
1566 log_error(LOG_LEVEL_CONNECT,
1567 "Chunked client body completely read. Length: %lu", body_length);
1568 csp->expected_client_content_length = body_length;
1576 /*********************************************************************
1578 * Function : fuzz_chunked_transfer_encoding
1580 * Description : Treat the fuzzed input as chunked transfer encoding
1581 * to check and dechunk.
1584 * 1 : csp = Used to store the data.
1585 * 2 : fuzz_input_file = File to read the input from.
1587 * Returns : Result of dechunking
1589 *********************************************************************/
1590 extern int fuzz_chunked_transfer_encoding(struct client_state *csp, char *fuzz_input_file)
1593 size_t size = (size_t)(csp->iob->eod - csp->iob->cur);
1594 enum chunk_status status;
1596 status = chunked_body_is_complete(csp->iob, &length);
1597 if (CHUNK_STATUS_BODY_COMPLETE != status)
1599 log_error(LOG_LEVEL_INFO, "Chunked body is incomplete or invalid");
1602 return (JB_ERR_OK == remove_chunked_transfer_coding(csp->iob->cur, &size));
1607 /*********************************************************************
1609 * Function : fuzz_client_request
1611 * Description : Try to get a client request from the fuzzed input.
1614 * 1 : csp = Current client state (buffers, headers, etc...)
1615 * 2 : fuzz_input_file = File to read the input from.
1617 * Returns : Result of fuzzing.
1619 *********************************************************************/
1620 extern int fuzz_client_request(struct client_state *csp, char *fuzz_input_file)
1625 csp->ip_addr_str = "fuzzer";
1627 if (strcmp(fuzz_input_file, "-") != 0)
1629 log_error(LOG_LEVEL_FATAL,
1630 "Fuzzed client requests can currently only be read from stdin (-).");
1632 err = receive_client_request(csp);
1633 if (err != JB_ERR_OK)
1637 err = parse_client_request(csp);
1638 if (err != JB_ERR_OK)
1646 #endif /* def FUZZ */
1649 #ifdef FEATURE_FORCE_LOAD
1650 /*********************************************************************
1652 * Function : force_required
1654 * Description : Checks a request line to see if it contains
1655 * the FORCE_PREFIX. If it does, it is removed
1656 * unless enforcing requests has beend disabled.
1659 * 1 : request_line = HTTP request line
1661 * Returns : TRUE if force is required, FALSE otherwise.
1663 *********************************************************************/
1664 static int force_required(const struct client_state *csp, char *request_line)
1668 p = strstr(request_line, "http://");
1672 p += strlen("http://");
1676 /* Intercepted request usually don't specify the protocol. */
1680 /* Go to the beginning of the path */
1685 * If the path is missing the request line is invalid and we
1686 * are done here. The client-visible rejection happens later on.
1691 if (0 == strncmpic(p, FORCE_PREFIX, strlen(FORCE_PREFIX) - 1))
1693 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS))
1695 /* XXX: Should clean more carefully */
1696 strclean(request_line, FORCE_PREFIX);
1697 log_error(LOG_LEVEL_FORCE,
1698 "Enforcing request: \"%s\".", request_line);
1702 log_error(LOG_LEVEL_FORCE,
1703 "Ignored force prefix in request: \"%s\".", request_line);
1709 #endif /* def FEATURE_FORCE_LOAD */
1712 /*********************************************************************
1714 * Function : receive_client_request
1716 * Description : Read the client's request (more precisely the
1717 * client headers) and answer it if necessary.
1720 * 1 : csp = Current client state (buffers, headers, etc...)
1722 * Returns : JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
1724 *********************************************************************/
1725 static jb_err receive_client_request(struct client_state *csp)
1727 char buf[BUFFER_SIZE];
1730 struct http_request *http;
1734 /* Temporary copy of the client's headers before they get enlisted in csp->headers */
1735 struct list header_list;
1736 struct list *headers = &header_list;
1738 /* We don't care if the arriving data is a valid HTTP request or not. */
1739 csp->requests_received_total++;
1743 memset(buf, 0, sizeof(buf));
1745 req = get_request_line(csp);
1748 mark_server_socket_tainted(csp);
1749 return JB_ERR_PARSE;
1751 assert(*req != '\0');
1753 if (client_protocol_is_unsupported(csp, req))
1755 return JB_ERR_PARSE;
1758 #ifdef FEATURE_FORCE_LOAD
1759 if (force_required(csp, req))
1761 csp->flags |= CSP_FLAG_FORCED;
1763 #endif /* def FEATURE_FORCE_LOAD */
1765 err = parse_http_request(req, http);
1767 if (JB_ERR_OK != err)
1769 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER),
1770 get_write_delay(csp));
1771 /* XXX: Use correct size */
1772 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1773 log_error(LOG_LEVEL_ERROR,
1774 "Couldn't parse request line received from %s: %s",
1775 csp->ip_addr_str, jb_err_to_string(err));
1777 free_http_request(http);
1778 return JB_ERR_PARSE;
1781 /* grab the rest of the client's headers */
1785 p = get_header(csp->client_iob);
1789 /* There are no additional headers to read. */
1796 * We didn't receive a complete header
1797 * line yet, get the rest of it.
1799 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1801 log_error(LOG_LEVEL_ERROR,
1802 "Stopped grabbing the client headers.");
1803 destroy_list(headers);
1804 return JB_ERR_PARSE;
1807 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1810 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1811 destroy_list(headers);
1812 return JB_ERR_PARSE;
1815 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1818 * If there is no memory left for buffering the
1819 * request, there is nothing we can do but hang up
1821 destroy_list(headers);
1822 return JB_ERR_MEMORY;
1827 if (!strncmpic(p, "Transfer-Encoding:", 18))
1830 * XXX: should be called through sed()
1831 * but currently can't.
1833 client_transfer_encoding(csp, &p);
1836 * We were able to read a complete
1837 * header and can finally enlist it.
1844 if (http->host == NULL)
1847 * If we still don't know the request destination,
1848 * the request is invalid or the client uses
1849 * Privoxy without its knowledge.
1851 if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
1854 * Our attempts to get the request destination
1855 * elsewhere failed or Privoxy is configured
1856 * to only accept proxy requests.
1858 * An error response has already been send
1859 * and we're done here.
1861 return JB_ERR_PARSE;
1865 #ifdef FEATURE_CLIENT_TAGS
1866 /* XXX: If the headers were enlisted sooner, passing csp would do. */
1867 set_client_address(csp, headers);
1868 get_tag_list_for_client(csp->client_tags, csp->client_address);
1872 * Determine the actions for this URL
1874 #ifdef FEATURE_TOGGLE
1875 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
1877 /* Most compatible set of actions (i.e. none) */
1878 init_current_action(csp->action);
1881 #endif /* ndef FEATURE_TOGGLE */
1883 get_url_actions(csp, http);
1886 enlist(csp->headers, http->cmd);
1888 /* Append the previously read headers */
1889 err = list_append_list_unique(csp->headers, headers);
1890 destroy_list(headers);
1897 /*********************************************************************
1899 * Function : parse_client_request
1901 * Description : Parses the client's request and decides what to do
1904 * Note that since we're not using select() we could get
1905 * blocked here if a client connected, then didn't say
1909 * 1 : csp = Current client state (buffers, headers, etc...)
1911 * Returns : JB_ERR_OK or JB_ERR_PARSE
1913 *********************************************************************/
1914 static jb_err parse_client_request(struct client_state *csp)
1916 struct http_request *http = csp->http;
1919 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1920 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
1921 && (!strcmpic(csp->http->version, "HTTP/1.1"))
1922 && (csp->http->ssl == 0))
1924 /* Assume persistence until further notice */
1925 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1927 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1929 if (csp->http->ssl == 0)
1932 * This whole block belongs to chat() but currently
1933 * has to be executed before sed().
1935 if (csp->flags & CSP_FLAG_CHUNKED_CLIENT_BODY)
1937 if (receive_chunked_client_request_body(csp) != JB_ERR_OK)
1939 return JB_ERR_PARSE;
1944 csp->expected_client_content_length = get_expected_content_length(csp->headers);
1946 verify_request_length(csp);
1948 #ifndef FEATURE_HTTPS_INSPECTION
1951 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1955 err = sed(csp, FILTER_CLIENT_HEADERS);
1956 if (JB_ERR_OK != err)
1958 log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
1960 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
1961 csp->ip_addr_str, csp->http->cmd);
1962 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER), get_write_delay(csp));
1963 return JB_ERR_PARSE;
1965 csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
1967 /* Check request line for rewrites. */
1968 if ((NULL == csp->headers->first->str)
1969 || (strcmp(http->cmd, csp->headers->first->str) &&
1970 (JB_ERR_OK != change_request_destination(csp))))
1973 * A header filter broke the request line - bail out.
1975 write_socket_delayed(csp->cfd, MESSED_UP_REQUEST_RESPONSE,
1976 strlen(MESSED_UP_REQUEST_RESPONSE), get_write_delay(csp));
1977 /* XXX: Use correct size */
1978 log_error(LOG_LEVEL_CLF,
1979 "%s - - [%T] \"Invalid request generated\" 500 0", csp->ip_addr_str);
1980 log_error(LOG_LEVEL_ERROR,
1981 "Invalid request line after applying header filters.");
1982 free_http_request(http);
1984 return JB_ERR_PARSE;
1987 if (client_has_unsupported_expectations(csp))
1989 return JB_ERR_PARSE;
1997 /*********************************************************************
1999 * Function : send_http_request
2001 * Description : Sends the HTTP headers from the client request
2002 * and all the body data that has already been received.
2005 * 1 : csp = Current client state (buffers, headers, etc...)
2007 * Returns : 0 on success, anything else is an error.
2009 *********************************************************************/
2010 static int send_http_request(struct client_state *csp)
2015 hdr = list_to_text(csp->headers);
2018 /* FIXME Should handle error properly */
2019 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
2021 list_remove_all(csp->headers);
2024 * Write the client's (modified) header to the server
2025 * (along with anything else that may be in the buffer)
2027 write_failure = 0 != write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
2032 log_error(LOG_LEVEL_CONNECT, "Failed sending request headers to: %s: %E",
2033 csp->http->hostport);
2035 else if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
2036 && (flush_iob(csp->server_connection.sfd, csp->client_iob, 0) < 0))
2039 log_error(LOG_LEVEL_CONNECT, "Failed sending request body to: %s: %E",
2040 csp->http->hostport);
2043 return write_failure;
2048 #ifdef FEATURE_HTTPS_INSPECTION
2049 /*********************************************************************
2051 * Function : receive_and_send_encrypted_post_data
2053 * Description : Reads remaining POST data from the client and sends
2057 * 1 : csp = Current client state (buffers, headers, etc...)
2059 * Returns : 0 on success, anything else is an error.
2061 *********************************************************************/
2062 static int receive_and_send_encrypted_post_data(struct client_state *csp)
2064 int content_length_known = csp->expected_client_content_length != 0;
2066 while (is_ssl_pending(&(csp->ssl_client_attr))
2067 || (content_length_known && csp->expected_client_content_length != 0))
2069 unsigned char buf[BUFFER_SIZE];
2071 int max_bytes_to_read = sizeof(buf);
2073 if (content_length_known && csp->expected_client_content_length < sizeof(buf))
2075 max_bytes_to_read = (int)csp->expected_client_content_length;
2077 log_error(LOG_LEVEL_CONNECT,
2078 "Waiting for up to %d bytes of POST data from the client.",
2080 len = ssl_recv_data(&(csp->ssl_client_attr), buf,
2081 (unsigned)max_bytes_to_read);
2088 /* XXX: Does this actually happen? */
2091 log_error(LOG_LEVEL_CONNECT, "Forwarding %d bytes of encrypted POST data",
2093 len = ssl_send_data(&(csp->ssl_server_attr), buf, (size_t)len);
2098 if (csp->expected_client_content_length != 0)
2100 if (csp->expected_client_content_length >= len)
2102 csp->expected_client_content_length -= (unsigned)len;
2104 if (csp->expected_client_content_length == 0)
2106 log_error(LOG_LEVEL_CONNECT, "Forwarded the last %d bytes", len);
2112 log_error(LOG_LEVEL_CONNECT, "Done forwarding encrypted POST data");
2119 /*********************************************************************
2121 * Function : send_https_request
2123 * Description : Sends the HTTP headers from the client request
2124 * and all the body data that has already been received.
2127 * 1 : csp = Current client state (buffers, headers, etc...)
2129 * Returns : 0 on success, anything else is an error.
2131 *********************************************************************/
2132 static int send_https_request(struct client_state *csp)
2138 hdr = list_to_text(csp->https_headers);
2141 /* FIXME Should handle error properly */
2142 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
2144 list_remove_all(csp->https_headers);
2147 * Write the client's (modified) header to the server
2148 * (along with anything else that may be in the buffer)
2150 ret = ssl_send_data(&(csp->ssl_server_attr),
2151 (const unsigned char *)hdr, strlen(hdr));
2156 log_error(LOG_LEVEL_CONNECT,
2157 "Failed sending encrypted request headers to: %s: %E",
2158 csp->http->hostport);
2159 mark_server_socket_tainted(csp);
2163 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
2164 && ((flushed = ssl_flush_socket(&(csp->ssl_server_attr),
2165 csp->client_iob)) < 0))
2167 log_error(LOG_LEVEL_CONNECT, "Failed sending request body to: %s: %E",
2168 csp->http->hostport);
2171 if (flushed != 0 || csp->expected_client_content_length != 0)
2173 if (csp->expected_client_content_length != 0)
2175 if (csp->expected_client_content_length < flushed)
2177 log_error(LOG_LEVEL_ERROR,
2178 "Flushed %ld bytes of request body while only expecting %llu",
2179 flushed, csp->expected_client_content_length);
2180 csp->expected_client_content_length = 0;
2184 log_error(LOG_LEVEL_CONNECT,
2185 "Flushed %ld bytes of request body while expecting %llu",
2186 flushed, csp->expected_client_content_length);
2187 csp->expected_client_content_length -= (unsigned)flushed;
2188 if (receive_and_send_encrypted_post_data(csp))
2196 log_error(LOG_LEVEL_CONNECT,
2197 "Flushed %ld bytes of request body", flushed);
2201 log_error(LOG_LEVEL_CONNECT, "Encrypted request sent");
2208 /*********************************************************************
2210 * Function : receive_encrypted_request
2212 * Description : Receives an encrypted request.
2215 * 1 : csp = Current client state (buffers, headers, etc...)
2217 * Returns : JB_ERR_OK on success,
2218 * JB_ERR_PARSE or JB_ERR_MEMORY otherwise
2220 *********************************************************************/
2221 static jb_err receive_encrypted_request(struct client_state *csp)
2223 char buf[BUFFER_SIZE];
2229 log_error(LOG_LEVEL_HEADER, "Reading encrypted headers");
2230 if (!is_ssl_pending(&(csp->ssl_client_attr)) &&
2231 !data_is_available(csp->cfd, csp->config->socket_timeout))
2233 log_error(LOG_LEVEL_CONNECT,
2234 "Socket %d timed out while waiting for client headers", csp->cfd);
2235 return JB_ERR_PARSE;
2237 len = ssl_recv_data(&(csp->ssl_client_attr),
2238 (unsigned char *)buf, sizeof(buf));
2241 log_error(LOG_LEVEL_CONNECT,
2242 "Socket %d closed while waiting for client headers", csp->cfd);
2243 return JB_ERR_PARSE;
2247 return JB_ERR_PARSE;
2249 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
2251 return JB_ERR_MEMORY;
2253 p = strstr(csp->client_iob->cur, "\r\n\r\n");
2254 } while (p == NULL);
2256 log_error(LOG_LEVEL_HEADER, "Encrypted headers received completely");
2262 /*********************************************************************
2264 * Function : process_encrypted_request
2266 * Description : Receives and parses an encrypted request.
2269 * 1 : csp = Current client state (buffers, headers, etc...)
2271 * Returns : JB_ERR_OK on success,
2272 * JB_ERR_PARSE or JB_ERR_MEMORY otherwise
2274 *********************************************************************/
2275 static jb_err process_encrypted_request(struct client_state *csp)
2280 /* Temporary copy of the client's headers before they get enlisted in csp->https_headers */
2281 struct list header_list;
2282 struct list *headers = &header_list;
2284 assert(csp->ssl_with_client_is_opened);
2286 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2287 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
2289 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
2292 err = receive_encrypted_request(csp);
2293 if (err != JB_ERR_OK)
2295 if (csp->client_iob->cur == NULL ||
2296 csp->client_iob->cur == csp->client_iob->eod)
2299 * We did not receive any data, most likely because the
2300 * client is done. Don't log this as a parse failure.
2302 return JB_ERR_PARSE;
2304 /* XXX: Also used for JB_ERR_MEMORY */
2305 log_error(LOG_LEVEL_ERROR, "Failed to receive encrypted request: %s",
2306 jb_err_to_string(err));
2307 ssl_send_data_delayed(&(csp->ssl_client_attr),
2308 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2312 /* We don't need get_request_line() because the whole HTTP head is buffered. */
2313 request_line = get_header(csp->client_iob);
2314 if (request_line == NULL)
2316 log_error(LOG_LEVEL_ERROR, "Failed to get the encrypted request line");
2317 ssl_send_data_delayed(&(csp->ssl_client_attr),
2318 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2319 return JB_ERR_PARSE;
2321 assert(*request_line != '\0');
2323 if (client_protocol_is_unsupported(csp, request_line))
2326 * If the protocol is unsupported we're done here.
2327 * client_protocol_is_unsupported() took care of sending
2328 * the error response and logging the error message.
2330 return JB_ERR_PARSE;
2333 #ifdef FEATURE_FORCE_LOAD
2334 if (force_required(csp, request_line))
2336 csp->flags |= CSP_FLAG_FORCED;
2338 #endif /* def FEATURE_FORCE_LOAD */
2340 free_http_request(csp->http);
2342 err = parse_http_request(request_line, csp->http);
2343 /* XXX: Restore ssl setting. This is ugly */
2344 csp->http->client_ssl = 1;
2345 csp->http->server_ssl = 1;
2347 freez(request_line);
2348 if (JB_ERR_OK != err)
2350 ssl_send_data_delayed(&(csp->ssl_client_attr),
2351 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2352 /* XXX: Use correct size */
2353 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
2354 log_error(LOG_LEVEL_ERROR,
2355 "Couldn't parse request line received from %s: %s",
2356 csp->ip_addr_str, jb_err_to_string(err));
2358 free_http_request(csp->http);
2359 return JB_ERR_PARSE;
2362 /* Parse the rest of the client's headers. */
2366 p = get_header(csp->client_iob);
2370 /* There are no additional headers to read. */
2377 if (JB_ERR_OK != get_destination_from_https_headers(headers, csp->http))
2380 * Our attempts to get the request destination
2383 log_error(LOG_LEVEL_ERROR,
2384 "Failed to get the encrypted request destination");
2385 ssl_send_data_delayed(&(csp->ssl_client_attr),
2386 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2387 return JB_ERR_PARSE;
2390 /* Split the domain we just got for pattern matching */
2391 init_domain_components(csp->http);
2393 #ifdef FEATURE_CLIENT_TAGS
2394 /* XXX: If the headers were enlisted sooner, passing csp would do. */
2395 if (csp->client_address == NULL)
2397 set_client_address(csp, headers);
2398 get_tag_list_for_client(csp->client_tags, csp->client_address);
2402 #ifdef FEATURE_TOGGLE
2403 if ((csp->flags & CSP_FLAG_TOGGLED_ON) != 0)
2407 * Determine the actions for this request after
2408 * clearing the ones from the previous one.
2410 free_current_action(csp->action);
2411 get_url_actions(csp, csp->http);
2414 enlist(csp->https_headers, csp->http->cmd);
2416 /* Append the previously read headers */
2417 err = list_append_list_unique(csp->https_headers, headers);
2418 destroy_list(headers);
2419 if (JB_ERR_OK != err)
2421 /* XXX: Send error message */
2425 /* XXX: Work around crash */
2426 csp->error_message = NULL;
2428 /* XXX: Why do this here? */
2431 err = sed_https(csp);
2432 if (JB_ERR_OK != err)
2434 ssl_send_data_delayed(&(csp->ssl_client_attr),
2435 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2436 log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
2438 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
2439 csp->ip_addr_str, csp->http->cmd);
2440 return JB_ERR_PARSE;
2443 log_error(LOG_LEVEL_HEADER, "Encrypted request processed");
2444 log_applied_actions(csp->action);
2445 log_error(LOG_LEVEL_REQUEST, "https://%s%s", csp->http->hostport,
2452 /*********************************************************************
2454 * Function : cgi_page_requested
2456 * Description : Checks if a request is for an internal CGI page.
2459 * 1 : host = The host requested by the client.
2461 * Returns : 1 if a CGI page has been requested, 0 otherwise
2463 *********************************************************************/
2464 static int cgi_page_requested(const char *host)
2466 if ((0 == strcmpic(host, CGI_SITE_1_HOST))
2467 || (0 == strcmpic(host, CGI_SITE_1_HOST "."))
2468 || (0 == strcmpic(host, CGI_SITE_2_HOST))
2469 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")))
2479 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2480 /*********************************************************************
2482 * Function : continue_https_chat
2484 * Description : Behaves similar to chat() but only deals with
2485 * https-inspected requests that arrive on an already
2486 * established connection. The first request is always
2487 * served by chat() which is a lot more complex as it
2488 * has to deal with forwarding settings and connection
2491 * If a connection to the server has already been
2492 * opened it is reused unless the request is blocked
2493 * or the forwarder changed.
2495 * If a connection to the server has not yet been
2496 * opened (because the previous request was crunched),
2497 * or the forwarder changed, the connection is dropped
2498 * so that the client retries on a fresh one.
2501 * 1 : csp = Current client state (buffers, headers, etc...)
2503 * Returns : Nothing.
2505 *********************************************************************/
2506 static void continue_https_chat(struct client_state *csp)
2508 const struct forward_spec *fwd;
2510 if (JB_ERR_OK != process_encrypted_request(csp))
2515 csp->requests_received_total++;
2518 * We have an encrypted request. Check if one of the crunchers wants it.
2520 if (crunch_response_triggered(csp, crunchers_all))
2523 * Yes. The client got the crunch response and we're done here.
2527 if (csp->ssl_with_server_is_opened == 0)
2529 log_error(LOG_LEVEL_CONNECT,
2530 "Dropping the client connection on socket %d. "
2531 "The server connection has not been established yet.",
2533 csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
2536 assert(csp->server_connection.sfd != JB_INVALID_SOCKET);
2538 fwd = forward_url(csp, csp->http);
2539 if (!connection_destination_matches(&csp->server_connection, csp->http, fwd))
2541 log_error(LOG_LEVEL_CONNECT,
2542 "Dropping the client connection on socket %d with "
2543 "server socket %d connected to %s. The forwarder has changed.",
2544 csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
2545 csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
2549 log_error(LOG_LEVEL_CONNECT,
2550 "Reusing server socket %d connected to %s. Requests already sent: %u.",
2551 csp->server_connection.sfd, csp->server_connection.host,
2552 csp->server_connection.requests_sent_total);
2554 if (send_https_request(csp))
2557 * Most likely the server connection timed out. We can't easily
2558 * create a new one so simply drop the client connection without a
2559 * error response to let the client retry.
2561 log_error(LOG_LEVEL_CONNECT,
2562 "Dropping client connection on socket %d. "
2563 "Forwarding the encrypted client request failed.",
2567 csp->server_connection.requests_sent_total++;
2568 handle_established_connection(csp);
2569 freez(csp->receive_buffer);
2571 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2575 /*********************************************************************
2577 * Function : handle_established_connection
2579 * Description : Shuffle data between client and server once the
2580 * connection has been established.
2583 * 1 : csp = Current client state (buffers, headers, etc...)
2585 * Returns : Nothing.
2587 *********************************************************************/
2588 static void handle_established_connection(struct client_state *csp)
2594 struct pollfd poll_fds[2];
2598 struct timeval timeout;
2601 int ms_iis5_hack = 0;
2602 unsigned long long byte_count = 0;
2603 struct http_request *http;
2604 long len = 0; /* for buffer sizes (and negative error codes) */
2605 int buffer_and_filter_content = 0;
2606 unsigned int write_delay;
2607 #ifdef FEATURE_HTTPS_INSPECTION
2609 int use_ssl_tunnel = 0;
2610 csp->dont_verify_certificate = 0;
2612 if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION))
2614 /* Pass encrypted content without filtering. */
2619 /* Skeleton for HTTP response, if we should intercept the request */
2620 struct http_response *rsp;
2621 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2622 int watch_client_socket;
2625 csp->receive_buffer_size = csp->config->receive_buffer_size;
2626 csp->receive_buffer = zalloc(csp->receive_buffer_size + 1);
2627 if (csp->receive_buffer == NULL)
2629 log_error(LOG_LEVEL_ERROR,
2630 "Out of memory. Failed to allocate the receive buffer.");
2631 rsp = cgi_error_memory();
2632 send_crunch_response(csp, rsp);
2639 maxfd = (csp->cfd > csp->server_connection.sfd) ?
2640 csp->cfd : csp->server_connection.sfd;
2643 /* pass data between the client and server
2644 * until one or the other shuts down the connection.
2649 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2650 watch_client_socket = 0 == (csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING);
2652 write_delay = get_write_delay(csp);
2658 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2659 if (!watch_client_socket)
2661 maxfd = csp->server_connection.sfd;
2664 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2666 FD_SET(csp->cfd, &rfds);
2669 FD_SET(csp->server_connection.sfd, &rfds);
2670 #endif /* ndef HAVE_POLL */
2672 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2673 if ((csp->flags & CSP_FLAG_CHUNKED)
2674 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2675 && ((csp->iob->eod - csp->iob->cur) >= 5)
2676 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
2679 * XXX: This check should be obsolete now,
2680 * but let's wait a while to be sure.
2682 log_error(LOG_LEVEL_CONNECT,
2683 "Looks like we got the last chunk together with "
2684 "the server headers but didn't detect it earlier. "
2685 "We better stop reading.");
2686 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2687 csp->expected_content_length = byte_count;
2688 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2690 if (server_body && server_response_is_complete(csp, byte_count))
2692 if (csp->expected_content_length == byte_count)
2694 log_error(LOG_LEVEL_CONNECT,
2695 "Done reading from server. Content length: %llu as expected. "
2696 "Bytes most recently read: %ld.",
2701 log_error(LOG_LEVEL_CONNECT,
2702 "Done reading from server. Expected content length: %llu. "
2703 "Actual content length: %llu. Bytes most recently read: %ld.",
2704 csp->expected_content_length, byte_count, len);
2708 * XXX: Should not jump around, handle_established_connection()
2709 * is complicated enough already.
2713 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2716 poll_fds[0].fd = csp->cfd;
2717 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2718 if (!watch_client_socket)
2721 * Ignore incoming data, but still watch out
2722 * for disconnects etc. These flags are always
2723 * implied anyway but explicitly setting them
2726 poll_fds[0].events = POLLERR|POLLHUP;
2731 poll_fds[0].events = POLLIN;
2733 poll_fds[1].fd = csp->server_connection.sfd;
2734 poll_fds[1].events = POLLIN;
2735 n = poll(poll_fds, 2, csp->config->socket_timeout * 1000);
2737 timeout.tv_sec = csp->config->socket_timeout;
2738 timeout.tv_usec = 0;
2739 n = select((int)maxfd + 1, &rfds, NULL, NULL, &timeout);
2740 #endif /* def HAVE_POLL */
2742 /*server or client not responding in timeout */
2745 log_error(LOG_LEVEL_CONNECT, "Socket timeout %d reached: %s",
2746 csp->config->socket_timeout, http->url);
2747 if ((byte_count == 0) && (http->ssl == 0))
2749 send_crunch_response(csp, error_response(csp, "connection-timeout"));
2751 mark_server_socket_tainted(csp);
2752 #ifdef FEATURE_HTTPS_INSPECTION
2753 close_client_and_server_ssl_connections(csp);
2760 log_error(LOG_LEVEL_ERROR, "poll() failed!: %E");
2762 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
2764 mark_server_socket_tainted(csp);
2765 #ifdef FEATURE_HTTPS_INSPECTION
2766 close_client_and_server_ssl_connections(csp);
2772 * This is the body of the browser's request,
2773 * just read and write it.
2775 * Receives data from browser and sends it to server
2777 * XXX: Make sure the client doesn't use pipelining
2778 * behind Privoxy's back.
2781 if ((poll_fds[0].revents & (POLLERR|POLLHUP|POLLNVAL)) != 0)
2783 log_error(LOG_LEVEL_CONNECT,
2784 "The client socket %d has become unusable while "
2785 "the server socket %d is still open.",
2786 csp->cfd, csp->server_connection.sfd);
2787 mark_server_socket_tainted(csp);
2791 if (poll_fds[0].revents != 0)
2793 if (FD_ISSET(csp->cfd, &rfds))
2794 #endif /* def HAVE_POLL*/
2796 int max_bytes_to_read = (int)csp->receive_buffer_size;
2798 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2799 if ((csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ))
2801 if (data_is_available(csp->cfd, 0))
2804 * If the next request is already waiting, we have
2805 * to stop select()ing the client socket. Otherwise
2806 * we would always return right away and get nothing
2809 watch_client_socket = 0;
2810 log_error(LOG_LEVEL_CONNECT,
2811 "Stop watching client socket %d. "
2812 "There's already another request waiting.",
2817 * If the client socket is set, but there's no data
2818 * available on the socket, the client went fishing
2819 * and continuing talking to the server makes no sense.
2821 log_error(LOG_LEVEL_CONNECT,
2822 "The client closed socket %d while "
2823 "the server socket %d is still open.",
2824 csp->cfd, csp->server_connection.sfd);
2825 mark_server_socket_tainted(csp);
2828 if (csp->expected_client_content_length != 0)
2830 if (csp->expected_client_content_length < csp->receive_buffer_size)
2832 max_bytes_to_read = (int)csp->expected_client_content_length;
2834 log_error(LOG_LEVEL_CONNECT,
2835 "Waiting for up to %d bytes from the client.",
2838 assert(max_bytes_to_read <= csp->receive_buffer_size);
2839 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2841 #ifdef FEATURE_HTTPS_INSPECTION
2842 if (client_use_ssl(csp))
2844 log_error(LOG_LEVEL_CONNECT, "Breaking with TLS/SSL.");
2848 #endif /* def FEATURE_HTTPS_INSPECTION */
2850 len = read_socket(csp->cfd, csp->receive_buffer, max_bytes_to_read);
2854 /* XXX: not sure if this is necessary. */
2855 mark_server_socket_tainted(csp);
2856 break; /* "game over, man" */
2859 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2860 if (csp->expected_client_content_length != 0)
2862 assert(len <= max_bytes_to_read);
2863 csp->expected_client_content_length -= (unsigned)len;
2864 log_error(LOG_LEVEL_CONNECT,
2865 "Expected client content length set to %llu "
2866 "after reading %ld bytes.",
2867 csp->expected_client_content_length, len);
2868 if (csp->expected_client_content_length == 0)
2870 log_error(LOG_LEVEL_CONNECT,
2871 "Done reading from the client.");
2872 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
2875 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2877 if (write_socket(csp->server_connection.sfd, csp->receive_buffer, (size_t)len))
2879 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
2880 mark_server_socket_tainted(csp);
2888 * The server wants to talk. It could be the header or the body.
2889 * If `hdr' is null, then it's the header otherwise it's the body.
2890 * FIXME: Does `hdr' really mean `host'? No.
2893 if (poll_fds[1].revents != 0)
2895 if (FD_ISSET(csp->server_connection.sfd, &rfds))
2896 #endif /* HAVE_POLL */
2898 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2900 * If we are buffering content, we don't want to eat up to
2901 * buffer-limit bytes if the client no longer cares about them.
2902 * If we aren't buffering, however, a dead client socket will be
2903 * noticed pretty much right away anyway, so we can reduce the
2904 * overhead by skipping the check.
2906 if (buffer_and_filter_content && !socket_is_still_alive(csp->cfd))
2909 log_error(LOG_LEVEL_CONNECT,
2910 "The server still wants to talk, but the client may already have hung up on us.");
2912 log_error(LOG_LEVEL_CONNECT,
2913 "The server still wants to talk, but the client hung up on us.");
2914 mark_server_socket_tainted(csp);
2915 #ifdef FEATURE_HTTPS_INSPECTION
2916 close_client_and_server_ssl_connections(csp);
2919 #endif /* def _WIN32 */
2921 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2923 #ifdef FEATURE_HTTPS_INSPECTION
2925 * Reading data from standard or secured connection (HTTP/HTTPS)
2927 if (server_use_ssl(csp))
2929 len = ssl_recv_data(&(csp->ssl_server_attr),
2930 (unsigned char *)csp->receive_buffer, csp->receive_buffer_size);
2935 len = read_socket(csp->server_connection.sfd, csp->receive_buffer,
2936 (int)csp->receive_buffer_size);
2941 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
2943 if ((http->ssl && (csp->fwd == NULL))
2944 #ifdef FEATURE_HTTPS_INSPECTION
2950 * Just hang up. We already confirmed the client's CONNECT
2951 * request with status code 200 and unencrypted content is
2952 * no longer welcome.
2954 log_error(LOG_LEVEL_ERROR,
2955 "CONNECT already confirmed. Unable to tell the client about the problem.");
2958 else if (byte_count)
2961 * Just hang up. We already transmitted the original headers
2962 * and parts of the original content and therefore missed the
2963 * chance to send an error message (without risking data corruption).
2965 * XXX: we could retry with a fancy range request here.
2967 log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
2968 "Unable to tell the client about the problem.");
2969 mark_server_socket_tainted(csp);
2970 #ifdef FEATURE_HTTPS_INSPECTION
2971 close_client_and_server_ssl_connections(csp);
2976 * XXX: Consider handling the cases above the same.
2978 mark_server_socket_tainted(csp);
2982 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2983 if (csp->flags & CSP_FLAG_CHUNKED)
2985 if ((len >= 5) && !memcmp(csp->receive_buffer+len-5, "0\r\n\r\n", 5))
2987 /* XXX: this is a temporary hack */
2988 log_error(LOG_LEVEL_CONNECT,
2989 "Looks like we reached the end of the last chunk. "
2990 "We better stop reading.");
2991 csp->expected_content_length = byte_count + (unsigned long long)len;
2992 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2996 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2999 * This is guaranteed by allocating with zalloc_or_die()
3000 * and never (intentionally) writing to the last byte.
3002 * csp->receive_buffer_size is the size of the part of the
3003 * buffer we intentionally write to, but we actually
3004 * allocated csp->receive_buffer_size+1 bytes so the assertion
3005 * stays within the allocated range.
3007 assert(csp->receive_buffer[csp->receive_buffer_size] == '\0');
3010 * Add a trailing zero to let be able to use string operations.
3011 * XXX: do we still need this with filter_popups gone?
3013 assert(len <= csp->receive_buffer_size);
3014 csp->receive_buffer[len] = '\0';
3017 * Normally, this would indicate that we've read
3018 * as much as the server has sent us and we can
3019 * close the client connection. However, Microsoft
3020 * in its wisdom has released IIS/5 with a bug that
3021 * prevents it from sending the trailing \r\n in
3022 * a 302 redirect header (and possibly other headers).
3023 * To work around this if we've haven't parsed
3024 * a full header we'll append a trailing \r\n
3025 * and see if this now generates a valid one.
3027 * This hack shouldn't have any impacts. If we've
3028 * already transmitted the header or if this is a
3029 * SSL connection, then we won't bother with this
3030 * hack. So we only work on partially received
3031 * headers. If we append a \r\n and this still
3032 * doesn't generate a valid header, then we won't
3033 * transmit anything to the client.
3038 if (server_body || (http->ssl
3039 #ifdef FEATURE_HTTPS_INSPECTION
3045 * If we have been buffering up the document,
3046 * now is the time to apply content modification
3047 * and send the result to the client.
3049 if (buffer_and_filter_content)
3051 p = execute_content_filters(csp);
3053 * If content filtering fails, use the original
3054 * buffer and length.
3055 * (see p != NULL ? p : csp->iob->cur below)
3059 csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
3061 #ifdef FEATURE_COMPRESSION
3062 else if ((csp->flags & CSP_FLAG_CLIENT_SUPPORTS_DEFLATE)
3063 && (csp->content_length > LOWER_LENGTH_LIMIT_FOR_COMPRESSION))
3065 char *compressed_content = compress_buffer(p,
3066 (size_t *)&csp->content_length, csp->config->compression_level);
3067 if (compressed_content != NULL)
3070 p = compressed_content;
3071 csp->flags |= CSP_FLAG_BUFFERED_CONTENT_DEFLATED;
3076 if (JB_ERR_OK != update_server_headers(csp))
3078 log_error(LOG_LEVEL_FATAL,
3079 "Failed to update server headers. after filtering.");
3082 hdr = list_to_text(csp->headers);
3085 /* FIXME Should handle error properly */
3086 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
3089 #ifdef FEATURE_HTTPS_INSPECTION
3091 * Sending data with standard or secured connection (HTTP/HTTPS)
3093 if (client_use_ssl(csp))
3095 if ((ssl_send_data_delayed(&(csp->ssl_client_attr),
3096 (const unsigned char *)hdr, strlen(hdr),
3097 get_write_delay(csp)) < 0)
3098 || (ssl_send_data_delayed(&(csp->ssl_client_attr),
3099 (const unsigned char *) ((p != NULL) ? p : csp->iob->cur),
3100 csp->content_length, get_write_delay(csp)) < 0))
3102 log_error(LOG_LEVEL_ERROR, "write modified content to "
3103 "client over TLS/SSL failed");
3106 mark_server_socket_tainted(csp);
3107 close_client_and_server_ssl_connections(csp);
3112 #endif /* def FEATURE_HTTPS_INSPECTION */
3114 if (write_socket_delayed(csp->cfd, hdr, strlen(hdr), write_delay)
3115 || write_socket_delayed(csp->cfd, ((p != NULL) ? p : csp->iob->cur),
3116 (size_t)csp->content_length, write_delay))
3118 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
3121 mark_server_socket_tainted(csp);
3130 break; /* "game over, man" */
3134 * This is NOT the body, so
3135 * Let's pretend the server just sent us a blank line.
3137 snprintf(csp->receive_buffer, csp->receive_buffer_size, "\r\n");
3138 len = (int)strlen(csp->receive_buffer);
3141 * Now, let the normal header parsing algorithm below do its
3142 * job. If it fails, we'll exit instead of continuing.
3149 * If we're in the body of the server document, just write it to
3150 * the client, unless we need to buffer the body for later
3151 * content-filtering.
3153 if (server_body || (http->ssl
3154 #ifdef FEATURE_HTTPS_INSPECTION
3159 if (buffer_and_filter_content)
3162 * If there is no memory left for buffering the content, or the buffer limit
3163 * has been reached, switch to non-filtering mode, i.e. make & write the
3164 * header, flush the iob and buf, and get out of the way.
3166 if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3171 log_error(LOG_LEVEL_INFO,
3172 "Flushing header and buffers. Stepping back from filtering.");
3174 hdr = list_to_text(csp->headers);
3178 * Memory is too tight to even generate the header.
3179 * Send our static "Out-of-memory" page.
3181 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
3182 rsp = cgi_error_memory();
3183 send_crunch_response(csp, rsp);
3184 mark_server_socket_tainted(csp);
3185 #ifdef FEATURE_HTTPS_INSPECTION
3186 close_client_and_server_ssl_connections(csp);
3190 hdrlen = strlen(hdr);
3192 #ifdef FEATURE_HTTPS_INSPECTION
3194 * Sending data with standard or secured connection (HTTP/HTTPS)
3196 if (client_use_ssl(csp))
3198 if ((ssl_send_data_delayed(&(csp->ssl_client_attr),
3199 (const unsigned char *)hdr, hdrlen, get_write_delay(csp)) < 0)
3200 || ((flushed = ssl_flush_socket(&(csp->ssl_client_attr),
3202 || (ssl_send_data_delayed(&(csp->ssl_client_attr),
3203 (const unsigned char *)csp->receive_buffer, (size_t)len,
3204 get_write_delay(csp)) < 0))
3206 log_error(LOG_LEVEL_CONNECT,
3207 "Flush header and buffers to client failed");
3209 mark_server_socket_tainted(csp);
3210 close_client_and_server_ssl_connections(csp);
3215 #endif /* def FEATURE_HTTPS_INSPECTION */
3217 if (write_socket_delayed(csp->cfd, hdr, hdrlen, write_delay)
3218 || ((flushed = flush_iob(csp->cfd, csp->iob, write_delay)) < 0)
3219 || write_socket_delayed(csp->cfd, csp->receive_buffer, (size_t)len,
3222 log_error(LOG_LEVEL_CONNECT,
3223 "Flush header and buffers to client failed: %E");
3225 mark_server_socket_tainted(csp);
3231 * Reset the byte_count to the amount of bytes
3232 * we just flushed. len will be added a few lines below,
3233 * hdrlen doesn't matter for LOG_LEVEL_CLF.
3235 byte_count = (unsigned long long)flushed;
3237 buffer_and_filter_content = 0;
3243 #ifdef FEATURE_HTTPS_INSPECTION
3245 * Sending data with standard or secured connection (HTTP/HTTPS)
3247 if (client_use_ssl(csp))
3249 ret = ssl_send_data_delayed(&(csp->ssl_client_attr),
3250 (const unsigned char *)csp->receive_buffer, (size_t)len,
3251 get_write_delay(csp));
3254 log_error(LOG_LEVEL_ERROR,
3255 "Sending data to client failed");
3256 mark_server_socket_tainted(csp);
3257 close_client_and_server_ssl_connections(csp);
3262 #endif /* def FEATURE_HTTPS_INSPECTION */
3264 if (write_socket_delayed(csp->cfd, csp->receive_buffer,
3265 (size_t)len, write_delay))
3267 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
3268 mark_server_socket_tainted(csp);
3273 byte_count += (unsigned long long)len;
3279 * We're still looking for the end of the server's header.
3280 * Buffer up the data we just read. If that fails, there's
3281 * little we can do but send our static out-of-memory page.
3283 if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3285 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
3286 rsp = cgi_error_memory();
3287 send_crunch_response(csp, rsp);
3288 mark_server_socket_tainted(csp);
3289 #ifdef FEATURE_HTTPS_INSPECTION
3290 close_client_and_server_ssl_connections(csp);
3295 /* Convert iob into something sed() can digest */
3296 if (JB_ERR_PARSE == get_server_headers(csp))
3301 * Well, we tried our MS IIS/5 hack and it didn't work.
3302 * The header is incomplete and there isn't anything
3303 * we can do about it.
3305 log_error(LOG_LEVEL_ERROR, "Invalid server headers. "
3306 "Applying the MS IIS5 hack didn't help.");
3307 log_error(LOG_LEVEL_CLF,
3308 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3309 #ifdef FEATURE_HTTPS_INSPECTION
3311 * Sending data with standard or secured connection (HTTP/HTTPS)
3313 if (client_use_ssl(csp))
3315 ssl_send_data_delayed(&(csp->ssl_client_attr),
3316 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3317 strlen(INVALID_SERVER_HEADERS_RESPONSE), get_write_delay(csp));
3320 #endif /* def FEATURE_HTTPS_INSPECTION */
3322 write_socket_delayed(csp->cfd,
3323 INVALID_SERVER_HEADERS_RESPONSE,
3324 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3326 mark_server_socket_tainted(csp);
3327 #ifdef FEATURE_HTTPS_INSPECTION
3328 close_client_and_server_ssl_connections(csp);
3335 * Since we have to wait for more from the server before
3336 * we can parse the headers we just continue here.
3338 log_error(LOG_LEVEL_CONNECT,
3339 "Continuing buffering server headers from socket %d. "
3340 "Bytes most recently read: %ld.", csp->cfd, len);
3347 * Account for the content bytes we
3348 * might have gotten with the headers.
3350 assert(csp->iob->eod >= csp->iob->cur);
3351 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3354 /* Did we actually get anything? */
3355 if (NULL == csp->headers->first)
3357 if ((csp->flags & CSP_FLAG_REUSED_CLIENT_CONNECTION))
3359 log_error(LOG_LEVEL_ERROR,
3360 "No server or forwarder response received on socket %d. "
3361 "Closing client socket %d without sending data.",
3362 csp->server_connection.sfd, csp->cfd);
3363 log_error(LOG_LEVEL_CLF,
3364 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3368 log_error(LOG_LEVEL_ERROR,
3369 "No server or forwarder response received on socket %d.",
3370 csp->server_connection.sfd);
3371 send_crunch_response(csp, error_response(csp, "no-server-data"));
3373 free_http_request(http);
3374 mark_server_socket_tainted(csp);
3375 #ifdef FEATURE_HTTPS_INSPECTION
3376 close_client_and_server_ssl_connections(csp);
3381 if (!csp->headers->first->str)
3383 log_error(LOG_LEVEL_ERROR, "header search: csp->headers->first->str == NULL, assert will be called");
3385 assert(csp->headers->first->str);
3387 if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
3388 strncmpic(csp->headers->first->str, "ICY", 3))
3391 * It doesn't look like a HTTP (or Shoutcast) response:
3392 * tell the client and log the problem.
3394 if (strlen(csp->headers->first->str) > 30)
3396 csp->headers->first->str[30] = '\0';
3398 log_error(LOG_LEVEL_ERROR,
3399 "Invalid server or forwarder response. Starts with: %s",
3400 csp->headers->first->str);
3401 log_error(LOG_LEVEL_CLF,
3402 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3403 #ifdef FEATURE_HTTPS_INSPECTION
3405 * Sending data with standard or secured connection (HTTP/HTTPS)
3407 if (client_use_ssl(csp))
3409 ssl_send_data_delayed(&(csp->ssl_client_attr),
3410 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3411 strlen(INVALID_SERVER_HEADERS_RESPONSE),
3412 get_write_delay(csp));
3415 #endif /* def FEATURE_HTTPS_INSPECTION */
3417 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3418 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3420 free_http_request(http);
3421 mark_server_socket_tainted(csp);
3422 #ifdef FEATURE_HTTPS_INSPECTION
3423 close_client_and_server_ssl_connections(csp);
3429 * We have now received the entire server header,
3430 * filter it and send the result to the client
3432 if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
3434 log_error(LOG_LEVEL_CLF,
3435 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3436 #ifdef FEATURE_HTTPS_INSPECTION
3438 * Sending data with standard or secured connection (HTTP/HTTPS)
3440 if (client_use_ssl(csp))
3442 ssl_send_data_delayed(&(csp->ssl_client_attr),
3443 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3444 strlen(INVALID_SERVER_HEADERS_RESPONSE),
3445 get_write_delay(csp));
3450 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3451 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3453 free_http_request(http);
3454 mark_server_socket_tainted(csp);
3455 #ifdef FEATURE_HTTPS_INSPECTION
3456 close_client_and_server_ssl_connections(csp);
3460 hdr = list_to_text(csp->headers);
3463 /* FIXME Should handle error properly */
3464 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
3467 if ((csp->flags & CSP_FLAG_CHUNKED)
3468 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3469 && ((csp->iob->eod - csp->iob->cur) >= 5)
3470 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
3472 log_error(LOG_LEVEL_CONNECT,
3473 "Looks like we got the last chunk together with "
3474 "the server headers. We better stop reading.");
3475 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3476 csp->expected_content_length = byte_count;
3477 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
3480 csp->server_connection.response_received = time(NULL);
3482 if (crunch_response_triggered(csp, crunchers_light))
3485 * One of the tags created by a server-header
3486 * tagger triggered a crunch. We already
3487 * delivered the crunch response to the client
3488 * and are done here after cleaning up.
3491 mark_server_socket_tainted(csp);
3492 #ifdef FEATURE_HTTPS_INSPECTION
3493 close_client_and_server_ssl_connections(csp);
3498 /* Buffer and pcrs filter this if appropriate. */
3499 buffer_and_filter_content = content_requires_filtering(csp);
3501 if (!buffer_and_filter_content)
3504 * Write the server's (modified) header to
3505 * the client (along with anything else that
3506 * may be in the buffer). Use standard or secured
3509 #ifdef FEATURE_HTTPS_INSPECTION
3510 if (client_use_ssl(csp))
3512 if ((ssl_send_data_delayed(&(csp->ssl_client_attr),
3513 (const unsigned char *)hdr, strlen(hdr),
3514 get_write_delay(csp)) < 0)
3515 || (len = ssl_flush_socket(&(csp->ssl_client_attr),
3518 log_error(LOG_LEVEL_CONNECT, "Write header to client failed");
3521 * The write failed, so don't bother mentioning it
3522 * to the client... it probably can't hear us anyway.
3525 mark_server_socket_tainted(csp);
3526 #ifdef FEATURE_HTTPS_INSPECTION
3527 close_client_and_server_ssl_connections(csp);
3533 #endif /* def FEATURE_HTTPS_INSPECTION */
3535 if (write_socket_delayed(csp->cfd, hdr, strlen(hdr), write_delay)
3536 || ((len = flush_iob(csp->cfd, csp->iob, write_delay)) < 0))
3538 log_error(LOG_LEVEL_ERROR,
3539 "write header to client failed");
3541 * The write failed, so don't bother mentioning it
3542 * to the client... it probably can't hear us anyway.
3545 mark_server_socket_tainted(csp);
3551 /* we're finished with the server's header */
3557 * If this was a MS IIS/5 hack then it means the server
3558 * has already closed the connection. Nothing more to read.
3563 log_error(LOG_LEVEL_ERROR,
3564 "Closed server connection detected. "
3565 "Applying the MS IIS5 hack didn't help.");
3566 log_error(LOG_LEVEL_CLF,
3567 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3568 #ifdef FEATURE_HTTPS_INSPECTION
3570 * Sending data with standard or secured connection (HTTP/HTTPS)
3572 if (client_use_ssl(csp))
3574 ssl_send_data_delayed(&(csp->ssl_client_attr),
3575 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3576 strlen(INVALID_SERVER_HEADERS_RESPONSE),
3577 get_write_delay(csp));
3580 #endif /* def FEATURE_HTTPS_INSPECTION */
3582 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3583 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3585 mark_server_socket_tainted(csp);
3586 #ifdef FEATURE_HTTPS_INSPECTION
3587 close_client_and_server_ssl_connections(csp);
3594 mark_server_socket_tainted(csp);
3595 #ifdef FEATURE_HTTPS_INSPECTION
3596 close_client_and_server_ssl_connections(csp);
3598 return; /* huh? we should never get here */
3601 if (csp->content_length == 0)
3604 * If Privoxy didn't recalculate the Content-Length,
3605 * byte_count is still correct.
3607 csp->content_length = byte_count;
3610 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3611 if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3612 && (csp->expected_content_length != byte_count))
3614 log_error(LOG_LEVEL_CONNECT,
3615 "Received %llu bytes while expecting %llu.",
3616 byte_count, csp->expected_content_length);
3617 mark_server_socket_tainted(csp);
3621 #ifdef FEATURE_HTTPS_INSPECTION
3622 if (client_use_ssl(csp))
3624 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s https://%s%s %s\" 200 %llu",
3625 csp->ip_addr_str, http->gpc, http->hostport, http->path,
3626 http->version, csp->content_length);
3631 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %llu",
3632 csp->ip_addr_str, http->ocmd, csp->content_length);
3634 csp->server_connection.timestamp = time(NULL);
3638 /*********************************************************************
3642 * Description : Once a connection from the client has been accepted,
3643 * this function is called (via serve()) to handle the
3644 * main business of the communication. This function
3645 * returns after dealing with a single request. It can
3646 * be called multiple times with the same client socket
3647 * if the client is keeping the connection alive.
3649 * The decision whether or not a client connection will
3650 * be kept alive is up to the caller which also must
3651 * close the client socket when done.
3653 * FIXME: chat is nearly thousand lines long.
3657 * 1 : csp = Current client state (buffers, headers, etc...)
3659 * Returns : Nothing.
3661 *********************************************************************/
3662 static void chat(struct client_state *csp)
3664 const struct forward_spec *fwd;
3665 struct http_request *http;
3666 /* Skeleton for HTTP response, if we should intercept the request */
3667 struct http_response *rsp;
3668 #ifdef FEATURE_HTTPS_INSPECTION
3669 int use_ssl_tunnel = 0;
3674 if (receive_client_request(csp) != JB_ERR_OK)
3678 if (parse_client_request(csp) != JB_ERR_OK)
3683 /* decide how to route the HTTP request */
3684 fwd = forward_url(csp, http);
3686 #ifdef FEATURE_HTTPS_INSPECTION
3688 * Setting flags to use old solution with SSL tunnel and to disable
3689 * certificate verification.
3691 if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION)
3692 && !cgi_page_requested(csp->http->host))
3697 if (http->ssl && csp->action->flags & ACTION_IGNORE_CERTIFICATE_ERRORS)
3699 csp->dont_verify_certificate = 1;
3704 * build the http request to send to the server
3705 * we have to do one of the following:
3707 * create = use the original HTTP request to create a new
3708 * HTTP request that has either the path component
3709 * without the http://domainspec (w/path) or the
3710 * full orininal URL (w/url)
3711 * Note that the path and/or the HTTP version may
3712 * have been altered by now.
3714 * SSL proxy = Open a socket to the host:port of the server
3715 * and create TLS/SSL connection with server and
3716 * with client. Then behave like mediator between
3717 * client and server over TLS/SSL.
3719 * SSL proxy = Pass the request unchanged if forwarding a CONNECT
3720 * with request to a parent proxy. Note that we'll be sending
3721 * forwarding the CFAIL message ourselves if connecting to the parent
3722 * fails, but we won't send a CSUCCEED message if it works,
3723 * since that would result in a double message (ours and the
3724 * parent's). After sending the request to the parent, we
3725 * must parse answer and send it to client. If connection
3726 * with server is established, we do TLS/SSL proxy. Otherwise
3727 * we send parent response to client and close connections.
3729 * here's the matrix:
3732 * +--------+--------+
3734 * 0 | create | SSL |
3735 * | w/path | proxy |
3736 * Forwarding +--------+--------+
3738 * 1 | create | proxy |
3739 * | w/url |+forward|
3740 * +--------+--------+
3744 #ifdef FEATURE_HTTPS_INSPECTION
3746 * Presetting SSL client and server flags
3748 if (http->ssl && !use_ssl_tunnel)
3750 http->client_ssl = 1;
3751 http->server_ssl = 1;
3755 http->client_ssl = 0;
3756 http->server_ssl = 0;
3760 #ifdef FEATURE_HTTPS_INSPECTION
3762 * Log the request unless we're https inspecting
3763 * in which case we don't have the path yet and
3764 * will log the request later.
3766 if (!client_use_ssl(csp))
3769 log_error(LOG_LEVEL_REQUEST, "%s%s", http->hostport, http->path);
3772 if (http->ssl && connect_port_is_forbidden(csp))
3774 const char *acceptable_connect_ports =
3775 csp->action->string[ACTION_STRING_LIMIT_CONNECT];
3776 assert(NULL != acceptable_connect_ports);
3777 log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
3778 "limit-connect{%s} doesn't allow CONNECT requests to %s",
3779 csp->ip_addr_str, acceptable_connect_ports, csp->http->hostport);
3780 csp->action->flags |= ACTION_BLOCK;
3782 #ifdef FEATURE_HTTPS_INSPECTION
3783 http->client_ssl = 0;
3784 http->server_ssl = 0;
3789 freez(csp->headers->first->str);
3790 build_request_line(csp, fwd, &csp->headers->first->str);
3793 * We have a request. Check if one of the crunchers wants it
3794 * unless the client wants to use TLS/SSL in which case we
3795 * haven't setup the TLS context yet and will send the crunch
3799 #ifdef FEATURE_HTTPS_INSPECTION
3800 !client_use_ssl(csp) &&
3802 crunch_response_triggered(csp, crunchers_all))
3805 * Yes. The client got the crunch response and we're done here.
3810 log_applied_actions(csp->action);
3811 if (fwd->forward_host)
3813 log_error(LOG_LEVEL_CONNECT, "via [%s]:%d to: %s",
3814 fwd->forward_host, fwd->forward_port, http->hostport);
3818 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
3821 /* here we connect to the server, gateway, or the forwarder */
3823 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3824 if ((csp->server_connection.sfd != JB_INVALID_SOCKET)
3825 && socket_is_still_alive(csp->server_connection.sfd)
3826 && connection_destination_matches(&csp->server_connection, http, fwd))
3828 log_error(LOG_LEVEL_CONNECT,
3829 "Reusing server socket %d connected to %s. Total requests: %u.",
3830 csp->server_connection.sfd, csp->server_connection.host,
3831 csp->server_connection.requests_sent_total);
3835 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
3837 #ifdef FEATURE_CONNECTION_SHARING
3838 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING
3839 #ifdef FEATURE_HTTPS_INSPECTION
3840 && !server_use_ssl(csp)
3844 remember_connection(&csp->server_connection);
3847 #endif /* def FEATURE_CONNECTION_SHARING */
3849 log_error(LOG_LEVEL_CONNECT,
3850 "Closing server socket %d connected to %s. Total requests: %u.",
3851 csp->server_connection.sfd, csp->server_connection.host,
3852 csp->server_connection.requests_sent_total);
3853 close_socket(csp->server_connection.sfd);
3855 mark_connection_closed(&csp->server_connection);
3857 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3858 #ifdef FEATURE_HTTPS_INSPECTION
3859 if (http->ssl && !use_ssl_tunnel)
3863 * Creating a SSL proxy.
3865 * By sending the CSUCCEED message we're lying to the client as
3866 * the connection hasn't actually been established yet. We don't
3867 * establish the connection until we have seen and parsed the
3868 * encrypted client headers.
3870 if (write_socket_delayed(csp->cfd, CSUCCEED,
3871 strlen(CSUCCEED), get_write_delay(csp)) != 0)
3873 log_error(LOG_LEVEL_ERROR, "Sending SUCCEED to client failed");
3877 ret = create_client_ssl_connection(csp);
3880 log_error(LOG_LEVEL_ERROR,
3881 "Failed to open a secure connection with the client");
3884 if (JB_ERR_OK != process_encrypted_request(csp))
3886 close_client_ssl_connection(csp);
3890 * We have an encrypted request. Check if one of the crunchers now
3891 * wants it (for example because the previously invisible path was
3892 * required to match).
3894 if (crunch_response_triggered(csp, crunchers_all))
3897 * Yes. The client got the crunch response and we're done here.
3904 * Connecting to destination server
3906 csp->server_connection.sfd = forwarded_connect(fwd, http, csp);
3908 if (csp->server_connection.sfd == JB_INVALID_SOCKET)
3910 if (fwd->type != SOCKS_NONE)
3913 rsp = error_response(csp, "forwarding-failed");
3915 else if (errno == EINVAL)
3917 rsp = error_response(csp, "no-such-domain");
3921 rsp = error_response(csp, "connect-failed");
3924 /* Write the answer to the client */
3927 send_crunch_response(csp, rsp);
3931 * Temporary workaround to prevent already-read client
3932 * bodies from being parsed as new requests. For now we
3933 * err on the safe side and throw all the following
3934 * requests under the bus, even if no client body has been
3935 * buffered. A compliant client will repeat the dropped
3936 * requests on an untainted connection.
3938 * The proper fix is to discard the no longer needed
3939 * client body in the buffer (if there is one) and to
3940 * continue parsing the bytes that follow.
3942 #ifdef FEATURE_HTTPS_INSPECTION
3943 close_client_ssl_connection(csp);
3945 drain_and_close_socket(csp->cfd);
3946 csp->cfd = JB_INVALID_SOCKET;
3951 #ifdef FEATURE_HTTPS_INSPECTION
3953 * Creating TLS/SSL connections with destination server or parent
3954 * proxy. If forwarding is enabled, we must send client request to
3955 * parent proxy and receive, parse and resend parent proxy answer.
3957 if (http->ssl && !use_ssl_tunnel)
3959 if (fwd->forward_host != NULL)
3961 char server_response[BUFFER_SIZE];
3964 char *hdr = list_to_text(csp->headers);
3965 memset(server_response, 0, sizeof(server_response));
3969 log_error(LOG_LEVEL_FATAL,
3970 "Out of memory parsing client header");
3972 list_remove_all(csp->headers);
3975 * Sending client's CONNECT request to the parent proxy
3977 ret = write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
3983 log_error(LOG_LEVEL_CONNECT,
3984 "Sending request headers to: %s failed", http->hostport);
3985 mark_server_socket_tainted(csp);
3986 close_client_ssl_connection(csp);
3990 /* Waiting for parent proxy server response */
3991 len = read_socket(csp->server_connection.sfd, server_response,
3992 sizeof(server_response)-1);
3996 log_error(LOG_LEVEL_ERROR, "No response from parent proxy "
3997 "server on socket %d.", csp->server_connection.sfd);
3999 rsp = error_response(csp, "no-server-data");
4002 send_crunch_response(csp, rsp);
4004 mark_server_socket_tainted(csp);
4005 close_client_ssl_connection(csp);
4010 * Test if the connection to the destination server was
4011 * established successfully by the parent proxy.
4013 if (!tunnel_established_successfully(server_response, (unsigned int)len))
4015 log_error(LOG_LEVEL_ERROR,
4016 "The forwarder %s failed to establish a connection with %s",
4017 fwd->forward_host, http->host);
4018 rsp = error_response(csp, "connect-failed");
4021 send_crunch_response(csp, rsp);
4023 mark_server_socket_tainted(csp);
4024 close_client_ssl_connection(csp);
4027 } /* -END- if (fwd->forward_host != NULL) */
4030 * We can now create the TLS/SSL connection with the destination server.
4032 int ret = create_server_ssl_connection(csp);
4035 if (csp->server_cert_verification_result != SSL_CERT_VALID &&
4036 csp->server_cert_verification_result != SSL_CERT_NOT_VERIFIED)
4039 * If the server certificate is invalid, we must inform
4040 * the client and then close connection to the client.
4042 ssl_send_certificate_error(csp);
4043 close_client_and_server_ssl_connections(csp);
4046 if (csp->server_cert_verification_result == SSL_CERT_NOT_VERIFIED
4047 || csp->server_cert_verification_result == SSL_CERT_VALID)
4050 * The TLS/SSL connection wasn't created but an invalid
4051 * certificate wasn't detected. Report it as connection
4054 rsp = error_response(csp, "connect-failed");
4057 send_crunch_response(csp, rsp);
4059 close_client_and_server_ssl_connections(csp);
4063 }/* -END- if (http->ssl) */
4064 #endif /* def FEATURE_HTTPS_INSPECTION */
4066 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4067 save_connection_destination(csp->server_connection.sfd,
4068 http, fwd, &csp->server_connection);
4069 csp->server_connection.keep_alive_timeout =
4070 (unsigned)csp->config->keep_alive_timeout;
4072 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4074 csp->server_connection.requests_sent_total++;
4076 if ((fwd->type == SOCKS_5T) && (NULL == csp->headers->first))
4078 /* Client headers have been sent optimistically */
4079 assert(csp->headers->last == NULL);
4081 else if (http->ssl == 0 || (fwd->forward_host
4082 #ifdef FEATURE_HTTPS_INSPECTION
4087 if (send_http_request(csp))
4089 rsp = error_response(csp, "connect-failed");
4092 send_crunch_response(csp, rsp);
4100 * Using old solution with SSL tunnel or new solution with SSL proxy
4102 list_remove_all(csp->headers);
4103 #ifdef FEATURE_HTTPS_INSPECTION
4108 * We're running an SSL tunnel and we're not forwarding,
4109 * so just ditch the client headers, send the "connect succeeded"
4110 * message to the client, flush the rest, and get out of the way.
4112 if (write_socket_delayed(csp->cfd, CSUCCEED,
4113 strlen(CSUCCEED), get_write_delay(csp)))
4118 #ifdef FEATURE_HTTPS_INSPECTION
4122 * If server certificate has been verified and is invalid,
4123 * we must inform the client and then close the connection
4124 * with client and server.
4126 if (csp->server_cert_verification_result != SSL_CERT_VALID &&
4127 csp->server_cert_verification_result != SSL_CERT_NOT_VERIFIED)
4129 ssl_send_certificate_error(csp);
4130 close_client_and_server_ssl_connections(csp);
4133 if (send_https_request(csp))
4135 rsp = error_response(csp, "connect-failed");
4138 send_crunch_response(csp, rsp);
4140 close_client_and_server_ssl_connections(csp);
4144 #endif /* def FEATURE_HTTPS_INSPECTION */
4145 clear_iob(csp->client_iob);
4146 }/* -END- else ... if (http->ssl == 1) */
4148 log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
4150 /* XXX: should the time start earlier for optimistically sent data? */
4151 csp->server_connection.request_sent = time(NULL);
4153 handle_established_connection(csp);
4154 freez(csp->receive_buffer);
4159 /*********************************************************************
4161 * Function : fuzz_server_response
4163 * Description : Treat the input as a whole server response.
4166 * 1 : csp = Current client state (buffers, headers, etc...)
4167 * 2 : fuzz_input_file = File to read the input from.
4171 *********************************************************************/
4172 extern int fuzz_server_response(struct client_state *csp, char *fuzz_input_file)
4174 static struct forward_spec fwd; /* Zero'd due to being static */
4177 if (strcmp(fuzz_input_file, "-") == 0)
4179 /* XXX: Doesn't work yet. */
4180 csp->server_connection.sfd = 0;
4184 csp->server_connection.sfd = open(fuzz_input_file, O_RDONLY);
4185 if (csp->server_connection.sfd == -1)
4187 log_error(LOG_LEVEL_FATAL, "Failed to open %s: %E",
4192 csp->content_type |= CT_GIF;
4193 csp->action->flags |= ACTION_DEANIMATE;
4194 csp->action->string[ACTION_STRING_DEANIMATE] = "last";
4196 csp->http->path = strdup_or_die("/");
4197 csp->http->host = strdup_or_die("fuzz.example.org");
4198 csp->http->hostport = strdup_or_die("fuzz.example.org:80");
4199 /* Prevent client socket monitoring */
4200 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
4201 csp->flags |= CSP_FLAG_CHUNKED;
4203 csp->config->feature_flags |= RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
4204 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
4206 csp->content_type |= CT_DECLARED|CT_GIF;
4208 csp->config->socket_timeout = 0;
4210 cgi_init_error_messages();
4212 handle_established_connection(csp);
4213 freez(csp->receive_buffer);
4220 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4221 /*********************************************************************
4223 * Function : prepare_csp_for_next_request
4225 * Description : Put the csp in a mostly vergin state.
4228 * 1 : csp = Current client state (buffers, headers, etc...)
4232 *********************************************************************/
4233 static void prepare_csp_for_next_request(struct client_state *csp)
4235 csp->content_type = 0;
4236 csp->content_length = 0;
4237 csp->expected_content_length = 0;
4238 csp->expected_client_content_length = 0;
4239 list_remove_all(csp->headers);
4240 clear_iob(csp->iob);
4241 freez(csp->error_message);
4242 free_http_request(csp->http);
4243 destroy_list(csp->headers);
4244 #ifdef FEATURE_HTTPS_INSPECTION
4245 destroy_list(csp->https_headers);
4247 destroy_list(csp->tags);
4248 #ifdef FEATURE_CLIENT_TAGS
4249 destroy_list(csp->client_tags);
4250 freez(csp->client_address);
4252 free_current_action(csp->action);
4253 if (NULL != csp->fwd)
4255 unload_forward_spec(csp->fwd);
4258 /* XXX: Store per-connection flags someplace else. */
4259 csp->flags = (CSP_FLAG_ACTIVE | CSP_FLAG_REUSED_CLIENT_CONNECTION);
4260 #ifdef FEATURE_TOGGLE
4261 if (global_toggle_state)
4262 #endif /* def FEATURE_TOGGLE */
4264 csp->flags |= CSP_FLAG_TOGGLED_ON;
4267 if (csp->client_iob->eod > csp->client_iob->cur)
4269 long bytes_to_shift = csp->client_iob->cur - csp->client_iob->buf;
4270 size_t data_length = (size_t)(csp->client_iob->eod - csp->client_iob->cur);
4272 assert(bytes_to_shift > 0);
4273 assert(data_length > 0);
4275 log_error(LOG_LEVEL_CONNECT, "Shifting %lu pipelined bytes by %ld bytes",
4276 data_length, bytes_to_shift);
4277 memmove(csp->client_iob->buf, csp->client_iob->cur, data_length);
4278 csp->client_iob->cur = csp->client_iob->buf;
4279 assert(csp->client_iob->eod == csp->client_iob->buf + bytes_to_shift + data_length);
4280 csp->client_iob->eod = csp->client_iob->buf + data_length;
4281 memset(csp->client_iob->eod, '\0', (size_t)bytes_to_shift);
4283 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
4288 * We mainly care about resetting client_iob->cur so we don't
4289 * waste buffer space at the beginning and don't mess up the
4290 * request restoration done by cgi_show_request().
4292 * Freeing the buffer itself isn't technically necessary,
4293 * but makes debugging more convenient.
4295 clear_iob(csp->client_iob);
4298 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4301 /*********************************************************************
4305 * Description : This is little more than chat. We only "serve" to
4306 * to close (or remember) any socket that chat may have
4310 * 1 : csp = Current client state (buffers, headers, etc...)
4314 *********************************************************************/
4315 static void serve(struct client_state *csp)
4317 int config_file_change_detected = 0; /* Only used for debugging */
4318 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4319 #ifdef FEATURE_CONNECTION_SHARING
4320 static int monitor_thread_running = 0;
4321 #endif /* def FEATURE_CONNECTION_SHARING */
4322 int continue_chatting = 0;
4324 log_error(LOG_LEVEL_CONNECT, "Accepted connection from %s on socket %d",
4325 csp->ip_addr_str, csp->cfd);
4329 unsigned int latency;
4331 #ifdef FEATURE_HTTPS_INSPECTION
4332 if (continue_chatting && client_use_ssl(csp))
4334 continue_https_chat(csp);
4343 * If the request has been crunched,
4344 * the calculated latency is zero.
4346 latency = (unsigned)(csp->server_connection.response_received -
4347 csp->server_connection.request_sent) / 2;
4349 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4350 && (csp->flags & CSP_FLAG_CRUNCHED)
4351 && (csp->expected_client_content_length != 0))
4353 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
4354 log_error(LOG_LEVEL_CONNECT,
4355 "Tainting client socket %d due to unread data.", csp->cfd);
4358 continue_chatting = (csp->config->feature_flags
4359 & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
4360 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
4361 && (csp->cfd != JB_INVALID_SOCKET)
4362 && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4363 && ((csp->flags & CSP_FLAG_SERVER_CONTENT_LENGTH_SET)
4364 || (csp->flags & CSP_FLAG_CHUNKED));
4366 if (!(csp->flags & CSP_FLAG_CRUNCHED)
4367 && (csp->server_connection.sfd != JB_INVALID_SOCKET))
4369 if (!(csp->flags & CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET))
4371 csp->server_connection.keep_alive_timeout = csp->config->default_server_timeout;
4373 if (!(csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
4374 || (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
4375 || !socket_is_still_alive(csp->server_connection.sfd)
4376 || !(latency < csp->server_connection.keep_alive_timeout))
4378 log_error(LOG_LEVEL_CONNECT,
4379 "Closing server socket %d connected to %s. "
4380 "Keep-alive: %u. Tainted: %u. Socket alive: %u. Timeout: %u.",
4381 csp->server_connection.sfd, csp->server_connection.host,
4382 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
4383 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
4384 socket_is_still_alive(csp->server_connection.sfd),
4385 csp->server_connection.keep_alive_timeout);
4386 #ifdef FEATURE_CONNECTION_SHARING
4387 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4389 forget_connection(csp->server_connection.sfd);
4391 #endif /* def FEATURE_CONNECTION_SHARING */
4392 #ifdef FEATURE_HTTPS_INSPECTION
4393 close_server_ssl_connection(csp);
4395 close_socket(csp->server_connection.sfd);
4396 mark_connection_closed(&csp->server_connection);
4400 if (continue_chatting && any_loaded_file_changed(csp))
4402 continue_chatting = 0;
4403 config_file_change_detected = 1;
4405 #ifdef FEATURE_HTTPS_INSPECTION
4406 if (continue_chatting && client_use_ssl(csp) &&
4407 csp->ssl_with_client_is_opened == 0)
4409 continue_chatting = 0;
4410 log_error(LOG_LEVEL_CONNECT, "Client socket %d is no longer usable. "
4411 "The TLS session has been terminated.", csp->cfd);
4415 if (continue_chatting)
4417 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
4418 && socket_is_still_alive(csp->cfd))
4420 log_error(LOG_LEVEL_CONNECT, "Client request %d has been "
4421 "pipelined on socket %d and the socket is still alive.",
4422 csp->requests_received_total+1, csp->cfd);
4423 prepare_csp_for_next_request(csp);
4427 if (0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
4429 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4431 log_error(LOG_LEVEL_CONNECT,
4432 "Waiting for the next client request on socket %d. "
4433 "Keeping the server socket %d to %s open.",
4434 csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
4438 log_error(LOG_LEVEL_CONNECT,
4439 "Waiting for the next client request on socket %d. "
4440 "No server socket to keep open.", csp->cfd);
4444 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4445 && data_is_available(csp->cfd, (int)csp->config->keep_alive_timeout)
4446 && socket_is_still_alive(csp->cfd))
4448 log_error(LOG_LEVEL_CONNECT,
4449 "Data arrived in time on client socket %d. Requests so far: %u",
4450 csp->cfd, csp->requests_received_total);
4451 prepare_csp_for_next_request(csp);
4455 #ifdef FEATURE_CONNECTION_SHARING
4456 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4457 && (csp->server_connection.sfd != JB_INVALID_SOCKET)
4458 && (socket_is_still_alive(csp->server_connection.sfd))
4459 #ifdef FEATURE_HTTPS_INSPECTION
4460 && !server_use_ssl(csp)
4464 time_t time_open = time(NULL) - csp->server_connection.timestamp;
4466 if (csp->server_connection.keep_alive_timeout < time_open - (time_t)latency)
4471 remember_connection(&csp->server_connection);
4472 csp->server_connection.sfd = JB_INVALID_SOCKET;
4473 drain_and_close_socket(csp->cfd);
4474 csp->cfd = JB_INVALID_SOCKET;
4475 privoxy_mutex_lock(&connection_reuse_mutex);
4476 if (!monitor_thread_running)
4478 monitor_thread_running = 1;
4479 privoxy_mutex_unlock(&connection_reuse_mutex);
4480 wait_for_alive_connections();
4481 privoxy_mutex_lock(&connection_reuse_mutex);
4482 monitor_thread_running = 0;
4484 privoxy_mutex_unlock(&connection_reuse_mutex);
4486 #endif /* def FEATURE_CONNECTION_SHARING */
4490 else if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4492 log_error(LOG_LEVEL_CONNECT,
4493 "Closing server socket %d connected to %s. Keep-alive: %u. "
4494 "Tainted: %u. Socket alive: %u. Timeout: %u. "
4495 "Configuration file change detected: %u",
4496 csp->server_connection.sfd, csp->server_connection.host,
4497 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
4498 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
4499 socket_is_still_alive(csp->server_connection.sfd),
4500 csp->server_connection.keep_alive_timeout,
4501 config_file_change_detected);
4503 } while (continue_chatting);
4507 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4509 if (csp->cfd != JB_INVALID_SOCKET)
4511 log_error(LOG_LEVEL_CONNECT, "Closing client socket %d. "
4512 "Keep-alive: %u. Socket alive: %u. Data available: %u. "
4513 "Configuration file change detected: %u. Requests received: %u.",
4514 csp->cfd, 0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE),
4515 socket_is_still_alive(csp->cfd), data_is_available(csp->cfd, 0),
4516 config_file_change_detected, csp->requests_received_total);
4517 #ifdef FEATURE_HTTPS_INSPECTION
4518 close_client_ssl_connection(csp);
4520 drain_and_close_socket(csp->cfd);
4523 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4525 #ifdef FEATURE_CONNECTION_SHARING
4526 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4528 forget_connection(csp->server_connection.sfd);
4530 #endif /* def FEATURE_CONNECTION_SHARING */
4532 #ifdef FEATURE_HTTPS_INSPECTION
4533 close_server_ssl_connection(csp);
4534 #endif /* def FEATURE_HTTPS_INSPECTION */
4536 close_socket(csp->server_connection.sfd);
4539 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4540 mark_connection_closed(&csp->server_connection);
4543 free_csp_resources(csp);
4545 csp->flags &= ~CSP_FLAG_ACTIVE;
4551 /*********************************************************************
4553 * Function : server_thread
4555 * Description : We only exist to call `serve' in a threaded environment.
4558 * 1 : data = Current client state (buffers, headers, etc...)
4560 * Returns : Always 0.
4562 *********************************************************************/
4563 static int32 server_thread(void *data)
4565 serve((struct client_state *) data);
4572 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
4573 /*********************************************************************
4577 * Description : Print usage info & exit.
4579 * Parameters : Pointer to argv[0] for identifying ourselves
4583 *********************************************************************/
4584 static void usage(const char *name)
4586 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
4587 "Usage: %s [--config-test] "
4590 #endif /* defined(unix) */
4593 "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
4594 #endif /* defined(unix) */
4595 "[--version] [configfile]\n",
4599 show_fuzz_usage(name);
4602 printf("Aborting\n");
4607 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
4610 #ifdef MUTEX_LOCKS_AVAILABLE
4611 /*********************************************************************
4613 * Function : privoxy_mutex_lock
4615 * Description : Locks a mutex.
4618 * 1 : mutex = The mutex to lock.
4620 * Returns : Void. May exit in case of errors.
4622 *********************************************************************/
4623 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
4625 #ifdef FEATURE_PTHREAD
4626 int err = pthread_mutex_lock(mutex);
4629 if (mutex != &log_mutex)
4631 log_error(LOG_LEVEL_FATAL,
4632 "Mutex locking failed: %s.\n", strerror(err));
4637 EnterCriticalSection(mutex);
4638 #endif /* def FEATURE_PTHREAD */
4642 /*********************************************************************
4644 * Function : privoxy_mutex_unlock
4646 * Description : Unlocks a mutex.
4649 * 1 : mutex = The mutex to unlock.
4651 * Returns : Void. May exit in case of errors.
4653 *********************************************************************/
4654 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
4656 #ifdef FEATURE_PTHREAD
4657 int err = pthread_mutex_unlock(mutex);
4660 if (mutex != &log_mutex)
4662 log_error(LOG_LEVEL_FATAL,
4663 "Mutex unlocking failed: %s.\n", strerror(err));
4668 LeaveCriticalSection(mutex);
4669 #endif /* def FEATURE_PTHREAD */
4673 /*********************************************************************
4675 * Function : privoxy_mutex_init
4677 * Description : Prepares a mutex.
4680 * 1 : mutex = The mutex to initialize.
4682 * Returns : Void. May exit in case of errors.
4684 *********************************************************************/
4685 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
4687 #ifdef FEATURE_PTHREAD
4688 int err = pthread_mutex_init(mutex, 0);
4691 printf("Fatal error. Mutex initialization failed: %s.\n",
4696 InitializeCriticalSection(mutex);
4697 #endif /* def FEATURE_PTHREAD */
4699 #endif /* def MUTEX_LOCKS_AVAILABLE */
4701 /*********************************************************************
4703 * Function : initialize_mutexes
4705 * Description : Prepares mutexes if mutex support is available.
4709 * Returns : Void, exits in case of errors.
4711 *********************************************************************/
4712 static void initialize_mutexes(void)
4714 #ifdef MUTEX_LOCKS_AVAILABLE
4716 * Prepare global mutex semaphores
4719 #ifdef FEATURE_HTTPS_INSPECTION
4720 privoxy_mutex_init(&certificate_mutex);
4721 privoxy_mutex_init(&ssl_init_mutex);
4724 privoxy_mutex_init(&log_mutex);
4725 privoxy_mutex_init(&log_init_mutex);
4726 privoxy_mutex_init(&connection_reuse_mutex);
4727 #ifdef FEATURE_EXTERNAL_FILTERS
4728 privoxy_mutex_init(&external_filter_mutex);
4730 #ifdef FEATURE_CLIENT_TAGS
4731 privoxy_mutex_init(&client_tags_mutex);
4733 #ifdef FEATURE_EXTENDED_STATISTICS
4734 privoxy_mutex_init(&filter_statistics_mutex);
4735 privoxy_mutex_init(&block_statistics_mutex);
4739 * XXX: The assumptions below are a bit naive
4740 * and can cause locks that aren't necessary.
4742 * For example older FreeBSD versions (< 6.x?)
4743 * have no gethostbyname_r, but gethostbyname is
4746 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
4747 privoxy_mutex_init(&resolver_mutex);
4748 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
4750 * XXX: should we use a single mutex for
4751 * localtime() and gmtime() as well?
4753 #ifndef HAVE_GMTIME_R
4754 privoxy_mutex_init(&gmtime_mutex);
4755 #endif /* ndef HAVE_GMTIME_R */
4757 #ifndef HAVE_LOCALTIME_R
4758 privoxy_mutex_init(&localtime_mutex);
4759 #endif /* ndef HAVE_GMTIME_R */
4761 #if !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM)
4762 privoxy_mutex_init(&rand_mutex);
4763 #endif /* !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM) */
4765 #endif /* def MUTEX_LOCKS_AVAILABLE */
4768 /*********************************************************************
4772 * Description : Load the config file and start the listen loop.
4773 * This function is a lot more *sane* with the `load_config'
4774 * and `listen_loop' functions; although it stills does
4775 * a *little* too much for my taste.
4778 * 1 : argc = Number of parameters (including $0).
4779 * 2 : argv = Array of (char *)'s to the parameters.
4781 * Returns : 1 if : can't open config file, unrecognized directive,
4782 * stats requested in multi-thread mode, can't open the
4783 * log file, can't open the jar file, listen port is invalid,
4784 * any load fails, and can't bind port.
4786 * Else main never returns, the process must be signaled
4787 * to terminate execution. Or, on Windows, use the
4788 * "File", "Exit" menu option.
4790 *********************************************************************/
4792 int real_main(int argc, char **argv)
4794 int main(int argc, char **argv)
4798 int do_config_test = 0;
4799 #ifndef HAVE_ARC4RANDOM
4800 unsigned int random_seed;
4803 struct passwd *pw = NULL;
4804 struct group *grp = NULL;
4806 char *pre_chroot_nslookup_to_load_resolver = NULL;
4809 char *fuzz_input_type = NULL;
4810 char *fuzz_input_file = NULL;
4817 #if !defined(_WIN32)
4824 /* Prepare mutexes if supported and necessary. */
4825 initialize_mutexes();
4827 /* Enable logging until further notice. */
4831 * Parse the command line arguments
4833 * XXX: simply printing usage information in case of
4834 * invalid arguments isn't particularly user friendly.
4836 while (++argc_pos < argc)
4839 /* Check to see if the service must be installed or uninstalled */
4840 if (strncmp(argv[argc_pos], "--install", 9) == 0)
4842 const char *pName = argv[argc_pos] + 9;
4845 exit((install_service(pName)) ? 0 : 1);
4847 else if (strncmp(argv[argc_pos], "--uninstall", 11) == 0)
4849 const char *pName = argv[argc_pos] + 11;
4852 exit((uninstall_service(pName)) ? 0 : 1);
4854 else if (strcmp(argv[argc_pos], "--service") == 0)
4856 bRunAsService = TRUE;
4857 w32_set_service_cwd();
4858 atexit(w32_service_exit_notify);
4861 #endif /* defined(_WIN32) */
4864 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
4866 if (strcmp(argv[argc_pos], "--help") == 0)
4871 else if (strcmp(argv[argc_pos], "--version") == 0)
4873 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
4879 else if (strcmp(argv[argc_pos], "--no-daemon") == 0)
4881 set_debug_level(LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
4885 else if (strcmp(argv[argc_pos], "--pidfile") == 0)
4887 if (++argc_pos == argc) usage(argv[0]);
4888 pidfile = strdup_or_die(argv[argc_pos]);
4891 else if (strcmp(argv[argc_pos], "--user") == 0)
4896 if (++argc_pos == argc) usage(argv[argc_pos]);
4898 user_arg = strdup_or_die(argv[argc_pos]);
4899 group_name = strchr(user_arg, '.');
4900 if (NULL != group_name)
4902 /* Nul-terminate the user name */
4905 /* Skip the former delimiter to actually reach the group name */
4908 grp = getgrnam(group_name);
4911 log_error(LOG_LEVEL_FATAL, "Group '%s' not found.", group_name);
4914 pw = getpwnam(user_arg);
4917 log_error(LOG_LEVEL_FATAL, "User '%s' not found.", user_arg);
4923 else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup") == 0)
4925 if (++argc_pos == argc) usage(argv[0]);
4926 pre_chroot_nslookup_to_load_resolver = strdup_or_die(argv[argc_pos]);
4929 else if (strcmp(argv[argc_pos], "--chroot") == 0)
4933 #endif /* defined(unix) */
4935 else if (strcmp(argv[argc_pos], "--config-test") == 0)
4940 else if (strcmp(argv[argc_pos], "--fuzz") == 0)
4943 if (argc < argc_pos + 2) usage(argv[0]);
4944 fuzz_input_type = argv[argc_pos];
4946 fuzz_input_file = argv[argc_pos];
4948 else if (strcmp(argv[argc_pos], "--stfu") == 0)
4950 set_debug_level(LOG_LEVEL_STFU);
4953 else if (argc_pos + 1 != argc)
4956 * This is neither the last command line
4957 * option, nor was it recognized before,
4958 * therefore it must be invalid.
4964 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
4966 configfile = argv[argc_pos];
4969 } /* -END- while (more arguments) */
4971 show_version(Argv[0]);
4974 if (*configfile != '/')
4976 char cwd[BUFFER_SIZE];
4978 size_t abs_file_size;
4980 /* make config-filename absolute here */
4981 if (NULL == getcwd(cwd, sizeof(cwd)))
4983 perror("failed to get current working directory");
4987 basedir = strdup_or_die(cwd);
4989 abs_file_size = strlen(cwd) + strlen(configfile) + 5;
4990 abs_file = malloc_or_die(abs_file_size);
4991 strlcpy(abs_file, basedir, abs_file_size);
4992 strlcat(abs_file, "/", abs_file_size);
4993 strlcat(abs_file, configfile, abs_file_size);
4994 configfile = abs_file;
4996 #endif /* defined unix */
5000 clients->next = NULL;
5002 /* XXX: factor out initialising after the next stable release. */
5007 #ifndef HAVE_ARC4RANDOM
5008 random_seed = (unsigned int)time(NULL);
5010 srandom(random_seed);
5013 #endif /* ifdef HAVE_RANDOM */
5014 #endif /* ifndef HAVE_ARC4RANDOM */
5017 * Unix signal handling
5019 * Catch the abort, interrupt and terminate signals for a graceful exit
5020 * Catch the hangup signal so the errlog can be reopened.
5022 * Ignore the broken pipe signal as connection failures
5023 * are handled when and where they occur without relying
5026 #if !defined(_WIN32)
5029 const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP };
5031 for (idx = 0; idx < SZ(catched_signals); idx++)
5033 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
5034 if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
5036 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
5037 #endif /* ifdef sun */
5039 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
5043 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
5045 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for SIGPIPE: %E");
5049 #else /* ifdef _WIN32 */
5050 # ifdef _WIN_CONSOLE
5052 * We *are* in a windows console app.
5053 * Print a verbose messages about FAQ's and such
5055 printf("%s", win32_blurb);
5056 # endif /* def _WIN_CONSOLE */
5057 #endif /* def _WIN32 */
5060 if (fuzz_input_type != NULL)
5062 exit(process_fuzzed_input(fuzz_input_type, fuzz_input_file));
5064 log_error(LOG_LEVEL_FATAL,
5065 "When compiled with fuzzing support, Privoxy should only be used for fuzzing. "
5066 "Various data structures are static which is unsafe when using threads.");
5071 exit(NULL == load_config());
5074 /* Initialize the CGI subsystem */
5075 cgi_init_error_messages();
5078 * If running on unix and without the --no-daemon
5079 * option, become a daemon. I.e. fork, detach
5080 * from tty and get process group leadership
5089 if (pid < 0) /* error */
5094 else if (pid != 0) /* parent */
5099 * must check for errors
5100 * child died due to missing files aso
5103 wpid = waitpid(pid, &status, WNOHANG);
5115 * stderr (fd 2) will be closed later on,
5116 * when the config file has been parsed.
5122 * Reserve fd 0 and 1 to prevent abort() and friends
5123 * from sending stuff to the clients or servers.
5125 fd = open("/dev/null", O_RDONLY);
5128 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
5132 if (dup2(fd, 0) == -1)
5134 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 0: %E");
5138 fd = open("/dev/null", O_WRONLY);
5141 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
5145 if (dup2(fd, 1) == -1)
5147 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 1: %E");
5152 #ifdef FEATURE_EXTERNAL_FILTERS
5153 for (fd = 0; fd < 3; fd++)
5155 mark_socket_for_close_on_execute(fd);
5161 } /* -END- if (daemon_mode) */
5164 * As soon as we have written the PID file, we can switch
5165 * to the user and group ID indicated by the --user option
5167 if (pidfile != NULL)
5169 write_pid_file(pidfile);
5173 if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
5175 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
5179 if (setgroups(1, &grp->gr_gid))
5181 log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
5184 else if (initgroups(pw->pw_name, pw->pw_gid))
5186 log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
5192 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
5194 /* Read the time zone file from /etc before doing chroot. */
5196 if (NULL != pre_chroot_nslookup_to_load_resolver
5197 && '\0' != pre_chroot_nslookup_to_load_resolver[0])
5199 /* Initialize resolver library. */
5200 (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
5202 if (chroot(pw->pw_dir) < 0)
5204 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
5208 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
5211 if (setuid(pw->pw_uid))
5213 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
5217 char putenv_dummy[64];
5219 strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
5220 if (putenv(putenv_dummy) != 0)
5222 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
5225 snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
5226 if (putenv(putenv_dummy) != 0)
5228 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
5234 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
5237 #endif /* defined unix */
5240 /* This will be FALSE unless the command line specified --service
5244 /* Yup, so now we must attempt to establish a connection
5245 * with the service dispatcher. This will only work if this
5246 * process was launched by the service control manager to
5247 * actually run as a service. If this isn't the case, i've
5248 * known it take around 30 seconds or so for the call to return.
5251 /* The StartServiceCtrlDispatcher won't return until the service is stopping */
5252 if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
5254 /* Service has run, and at this point is now being stopped, so just return */
5259 printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
5261 /* An error occurred. Usually it's because --service was wrongly specified
5262 * and we were unable to connect to the Service Control Dispatcher because
5263 * it wasn't expecting us and is therefore not listening.
5265 * For now, just continue below to call the listen_loop function.
5268 #endif /* def _WIN32 */
5278 /*********************************************************************
5280 * Function : bind_port_helper
5282 * Description : Bind the listen port. Handles logging, and aborts
5286 * 1 : haddr = Host address to bind to. Use NULL to bind to
5288 * 2 : hport = Specifies port to bind to.
5289 * 3 : backlog = Listen backlog.
5291 * Returns : Port that was opened.
5293 *********************************************************************/
5294 static jb_socket bind_port_helper(const char *haddr, int hport, int backlog)
5299 result = bind_port(haddr, hport, backlog, &bfd);
5303 const char *bind_address = (NULL != haddr) ? haddr : "INADDR_ANY";
5307 log_error(LOG_LEVEL_FATAL,
5308 "can't bind to %s:%d: There may be another Privoxy "
5309 "or some other proxy running on port %d",
5310 bind_address, hport, hport);
5313 log_error(LOG_LEVEL_FATAL,
5314 "can't bind to %s:%d: The hostname is not resolvable",
5315 bind_address, hport);
5318 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: %E",
5319 bind_address, hport);
5322 /* shouldn't get here */
5323 return JB_INVALID_SOCKET;
5328 if (bfd >= FD_SETSIZE)
5330 log_error(LOG_LEVEL_FATAL,
5331 "Bind socket number too high to use select(): %d >= %d",
5339 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
5344 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
5352 /*********************************************************************
5354 * Function : bind_ports_helper
5356 * Description : Bind the listen ports. Handles logging, and aborts
5360 * 1 : config = Privoxy configuration. Specifies ports
5362 * 2 : sockets = Preallocated array of opened sockets
5363 * corresponding to specification in config.
5364 * All non-opened sockets will be set to
5365 * JB_INVALID_SOCKET.
5367 * Returns : Nothing. Inspect sockets argument.
5369 *********************************************************************/
5370 static void bind_ports_helper(struct configuration_spec * config,
5371 jb_socket sockets[])
5375 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
5377 if (config->hport[i])
5379 sockets[i] = bind_port_helper(config->haddr[i],
5380 config->hport[i], config->listen_backlog);
5381 #if defined(FEATURE_ACCEPT_FILTER) && defined(SO_ACCEPTFILTER)
5382 if (config->enable_accept_filter && sockets[i] != JB_INVALID_SOCKET)
5384 struct accept_filter_arg af_options;
5385 bzero(&af_options, sizeof(af_options));
5386 strlcpy(af_options.af_name, "httpready", sizeof(af_options.af_name));
5387 if (setsockopt(sockets[i], SOL_SOCKET, SO_ACCEPTFILTER, &af_options,
5388 sizeof(af_options)))
5390 log_error(LOG_LEVEL_ERROR,
5391 "Enabling accept filter for socket %d failed: %E", sockets[i]);
5398 sockets[i] = JB_INVALID_SOCKET;
5401 config->need_bind = 0;
5405 /*********************************************************************
5407 * Function : close_ports_helper
5409 * Description : Close listenings ports.
5412 * 1 : sockets = Array of opened and non-opened sockets to
5413 * close. All sockets will be set to
5414 * JB_INVALID_SOCKET.
5416 * Returns : Nothing.
5418 *********************************************************************/
5419 static void close_ports_helper(jb_socket sockets[])
5423 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
5425 if (JB_INVALID_SOCKET != sockets[i])
5427 close_socket(sockets[i]);
5429 sockets[i] = JB_INVALID_SOCKET;
5435 /* Without this simple workaround we get this compiler warning from _beginthread
5436 * warning C4028: formal parameter 1 different from declaration
5438 void w32_service_listen_loop(void *p)
5442 #endif /* def _WIN32 */
5445 /*********************************************************************
5447 * Function : listen_loop
5449 * Description : bind the listen port and enter a "FOREVER" listening loop.
5455 *********************************************************************/
5456 static void listen_loop(void)
5458 struct client_states *csp_list = NULL;
5459 struct client_state *csp = NULL;
5460 jb_socket bfds[MAX_LISTENING_SOCKETS];
5461 struct configuration_spec *config;
5462 unsigned int active_threads = 0;
5463 #if defined(FEATURE_PTHREAD)
5464 pthread_attr_t attrs;
5466 pthread_attr_init(&attrs);
5467 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
5470 config = load_config();
5472 #ifdef FEATURE_CONNECTION_SHARING
5474 * XXX: Should be relocated once it no
5475 * longer needs to emit log messages.
5477 initialize_reusable_connections();
5478 #endif /* def FEATURE_CONNECTION_SHARING */
5480 bind_ports_helper(config, bfds);
5482 #ifdef FEATURE_GRACEFUL_TERMINATION
5483 while (!g_terminate)
5488 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__)
5489 while (waitpid(-1, NULL, WNOHANG) > 0)
5491 /* zombie children */
5493 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) */
5496 * Free data that was used by died threads
5498 active_threads = sweep();
5502 * Re-open the errlog after HUP signal
5504 if (received_hup_signal)
5506 if (NULL != config->logfile)
5508 init_error_log(Argv[0], config->logfile);
5510 received_hup_signal = 0;
5514 csp_list = zalloc_or_die(sizeof(*csp_list));
5515 csp = &csp_list->csp;
5517 log_error(LOG_LEVEL_CONNECT,
5518 "Waiting for the next client connection. Currently active threads: %u",
5522 * This config may be outdated, but for accept_connection()
5523 * it's fresh enough.
5525 csp->config = config;
5527 if (!accept_connection(csp, bfds))
5529 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
5534 csp->flags |= CSP_FLAG_ACTIVE;
5535 csp->server_connection.sfd = JB_INVALID_SOCKET;
5537 csp->config = config = load_config();
5539 if (config->need_bind)
5542 * Since we were listening to the "old port", we will not see
5543 * a "listen" param change until the next request. So, at
5544 * least 1 more request must be made for us to find the new
5545 * setting. I am simply closing the old socket and binding the
5548 * Which-ever is correct, we will serve 1 more page via the
5549 * old settings. This should probably be a "show-status"
5550 * request. This should not be a so common of an operation
5551 * that this will hurt people's feelings.
5554 close_ports_helper(bfds);
5556 bind_ports_helper(config, bfds);
5559 #ifdef FEATURE_TOGGLE
5560 if (global_toggle_state)
5561 #endif /* def FEATURE_TOGGLE */
5563 csp->flags |= CSP_FLAG_TOGGLED_ON;
5566 if (run_loader(csp))
5568 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
5569 /* Never get here - LOG_LEVEL_FATAL causes program exit */
5573 if (block_acl(NULL,csp))
5575 log_error(LOG_LEVEL_CONNECT,
5576 "Connection from %s on %s (socket %d) dropped due to ACL",
5577 csp->ip_addr_str, csp->listen_addr_str, csp->cfd);
5578 close_socket(csp->cfd);
5579 freez(csp->ip_addr_str);
5580 freez(csp->listen_addr_str);
5584 #endif /* def FEATURE_ACL */
5586 if ((0 != config->max_client_connections)
5587 && (active_threads >= config->max_client_connections))
5589 log_error(LOG_LEVEL_CONNECT,
5590 "Rejecting connection from %s. Maximum number of connections reached.",
5592 write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
5593 strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
5594 close_socket(csp->cfd);
5595 freez(csp->ip_addr_str);
5596 freez(csp->listen_addr_str);
5601 /* add it to the list of clients */
5602 csp_list->next = clients->next;
5603 clients->next = csp_list;
5605 if (config->multi_threaded)
5609 /* this is a switch () statement in the C preprocessor - ugh */
5610 #undef SELECTED_ONE_OPTION
5612 /* Use Pthreads in preference to native code */
5613 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
5614 #define SELECTED_ONE_OPTION
5616 pthread_t the_thread;
5619 ret = pthread_create(&the_thread, &attrs,
5620 (void * (*)(void *))serve, csp);
5621 child_id = ret ? -1 : 0;
5625 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
5626 #define SELECTED_ONE_OPTION
5627 child_id = _beginthread(
5628 (void (*)(void *))serve,
5633 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
5634 #define SELECTED_ONE_OPTION
5636 thread_id tid = spawn_thread
5637 (server_thread, "server", B_NORMAL_PRIORITY, csp);
5639 if ((tid >= 0) && (resume_thread(tid) == B_OK))
5641 child_id = (int) tid;
5650 #if !defined(SELECTED_ONE_OPTION)
5653 /* This block is only needed when using fork().
5654 * When using threads, the server thread was
5655 * created and run by the call to _beginthread().
5657 if (child_id == 0) /* child */
5660 #ifdef FEATURE_TOGGLE
5661 int inherited_toggle_state = global_toggle_state;
5662 #endif /* def FEATURE_TOGGLE */
5667 * If we've been toggled or we've blocked the request, tell Mom
5670 #ifdef FEATURE_TOGGLE
5671 if (inherited_toggle_state != global_toggle_state)
5673 rc |= RC_FLAG_TOGGLED;
5675 #endif /* def FEATURE_TOGGLE */
5677 #ifdef FEATURE_STATISTICS
5678 if (csp->flags & CSP_FLAG_REJECTED)
5680 rc |= RC_FLAG_BLOCKED;
5682 #endif /* ndef FEATURE_STATISTICS */
5686 else if (child_id > 0) /* parent */
5688 /* in a fork()'d environment, the parent's
5689 * copy of the client socket and the CSP
5693 #if !defined(_WIN32) && !defined(__CYGWIN__)
5695 wait(&child_status);
5698 * Evaluate child's return code: If the child has
5699 * - been toggled, toggle ourselves
5700 * - blocked its request, bump up the stats counter
5703 #ifdef FEATURE_TOGGLE
5704 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
5706 global_toggle_state = !global_toggle_state;
5708 #endif /* def FEATURE_TOGGLE */
5710 #ifdef FEATURE_STATISTICS
5712 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
5716 #endif /* def FEATURE_STATISTICS */
5718 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
5719 close_socket(csp->cfd);
5720 csp->flags &= ~CSP_FLAG_ACTIVE;
5724 #undef SELECTED_ONE_OPTION
5725 /* end of cpp switch () */
5730 * Spawning the child failed, assume it's because
5731 * there are too many children running already.
5732 * XXX: If you assume ...
5734 log_error(LOG_LEVEL_ERROR,
5735 "Unable to take any additional connections: %E. Active threads: %u",
5737 write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
5738 strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
5739 close_socket(csp->cfd);
5740 csp->flags &= ~CSP_FLAG_ACTIVE;
5749 #if defined(FEATURE_PTHREAD)
5750 pthread_attr_destroy(&attrs);
5753 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
5755 #ifdef FEATURE_HTTPS_INSPECTION
5756 /* Clean up. Aim: free all memory (no leaks) */
5760 #ifdef FEATURE_GRACEFUL_TERMINATION
5762 log_error(LOG_LEVEL_INFO, "Graceful termination requested");
5764 unload_current_config_file();
5765 unload_current_actions_file();
5766 unload_current_re_filterfile();
5767 #ifdef FEATURE_TRUST
5768 unload_current_trust_file();
5771 if (config->multi_threaded)
5778 } while ((clients->next != NULL) && (--i > 0));
5782 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
5792 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
5793 /* Cleanup - remove taskbar icon etc. */
5798 #endif /* FEATURE_GRACEFUL_TERMINATION */