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);
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)
2298 * We did not receive any data, most likely because the
2299 * client is done. Don't log this as a parse failure.
2301 return JB_ERR_PARSE;
2303 /* XXX: Also used for JB_ERR_MEMORY */
2304 log_error(LOG_LEVEL_ERROR, "Failed to receive encrypted request: %s",
2305 jb_err_to_string(err));
2306 ssl_send_data_delayed(&(csp->ssl_client_attr),
2307 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2311 /* We don't need get_request_line() because the whole HTTP head is buffered. */
2312 request_line = get_header(csp->client_iob);
2313 if (request_line == NULL)
2315 log_error(LOG_LEVEL_ERROR, "Failed to get the encrypted request line");
2316 ssl_send_data_delayed(&(csp->ssl_client_attr),
2317 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2318 return JB_ERR_PARSE;
2320 assert(*request_line != '\0');
2322 if (client_protocol_is_unsupported(csp, request_line))
2325 * If the protocol is unsupported we're done here.
2326 * client_protocol_is_unsupported() took care of sending
2327 * the error response and logging the error message.
2329 return JB_ERR_PARSE;
2332 #ifdef FEATURE_FORCE_LOAD
2333 if (force_required(csp, request_line))
2335 csp->flags |= CSP_FLAG_FORCED;
2337 #endif /* def FEATURE_FORCE_LOAD */
2339 free_http_request(csp->http);
2341 err = parse_http_request(request_line, csp->http);
2342 /* XXX: Restore ssl setting. This is ugly */
2343 csp->http->client_ssl = 1;
2344 csp->http->server_ssl = 1;
2346 freez(request_line);
2347 if (JB_ERR_OK != err)
2349 ssl_send_data_delayed(&(csp->ssl_client_attr),
2350 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2351 /* XXX: Use correct size */
2352 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
2353 log_error(LOG_LEVEL_ERROR,
2354 "Couldn't parse request line received from %s: %s",
2355 csp->ip_addr_str, jb_err_to_string(err));
2357 free_http_request(csp->http);
2358 return JB_ERR_PARSE;
2361 /* Parse the rest of the client's headers. */
2365 p = get_header(csp->client_iob);
2369 /* There are no additional headers to read. */
2376 if (JB_ERR_OK != get_destination_from_https_headers(headers, csp->http))
2379 * Our attempts to get the request destination
2382 log_error(LOG_LEVEL_ERROR,
2383 "Failed to get the encrypted request destination");
2384 ssl_send_data_delayed(&(csp->ssl_client_attr),
2385 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2386 return JB_ERR_PARSE;
2389 /* Split the domain we just got for pattern matching */
2390 init_domain_components(csp->http);
2392 #ifdef FEATURE_CLIENT_TAGS
2393 /* XXX: If the headers were enlisted sooner, passing csp would do. */
2394 if (csp->client_address == NULL)
2396 set_client_address(csp, headers);
2397 get_tag_list_for_client(csp->client_tags, csp->client_address);
2401 #ifdef FEATURE_TOGGLE
2402 if ((csp->flags & CSP_FLAG_TOGGLED_ON) != 0)
2406 * Determine the actions for this request after
2407 * clearing the ones from the previous one.
2409 free_current_action(csp->action);
2410 get_url_actions(csp, csp->http);
2413 enlist(csp->https_headers, csp->http->cmd);
2415 /* Append the previously read headers */
2416 err = list_append_list_unique(csp->https_headers, headers);
2417 destroy_list(headers);
2418 if (JB_ERR_OK != err)
2420 /* XXX: Send error message */
2424 /* XXX: Work around crash */
2425 csp->error_message = NULL;
2427 /* XXX: Why do this here? */
2430 err = sed_https(csp);
2431 if (JB_ERR_OK != err)
2433 ssl_send_data_delayed(&(csp->ssl_client_attr),
2434 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2435 log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
2437 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
2438 csp->ip_addr_str, csp->http->cmd);
2439 return JB_ERR_PARSE;
2442 log_error(LOG_LEVEL_HEADER, "Encrypted request processed");
2443 log_applied_actions(csp->action);
2444 log_error(LOG_LEVEL_REQUEST, "https://%s%s", csp->http->hostport,
2451 /*********************************************************************
2453 * Function : cgi_page_requested
2455 * Description : Checks if a request is for an internal CGI page.
2458 * 1 : host = The host requested by the client.
2460 * Returns : 1 if a CGI page has been requested, 0 otherwise
2462 *********************************************************************/
2463 static int cgi_page_requested(const char *host)
2465 if ((0 == strcmpic(host, CGI_SITE_1_HOST))
2466 || (0 == strcmpic(host, CGI_SITE_1_HOST "."))
2467 || (0 == strcmpic(host, CGI_SITE_2_HOST))
2468 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")))
2478 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2479 /*********************************************************************
2481 * Function : continue_https_chat
2483 * Description : Behaves similar to chat() but only deals with
2484 * https-inspected requests that arrive on an already
2485 * established connection. The first request is always
2486 * served by chat() which is a lot more complex as it
2487 * has to deal with forwarding settings and connection
2490 * If a connection to the server has already been
2491 * opened it is reused unless the request is blocked
2492 * or the forwarder changed.
2494 * If a connection to the server has not yet been
2495 * opened (because the previous request was crunched),
2496 * or the forwarder changed, the connection is dropped
2497 * so that the client retries on a fresh one.
2500 * 1 : csp = Current client state (buffers, headers, etc...)
2502 * Returns : Nothing.
2504 *********************************************************************/
2505 static void continue_https_chat(struct client_state *csp)
2507 const struct forward_spec *fwd;
2509 if (JB_ERR_OK != process_encrypted_request(csp))
2514 csp->requests_received_total++;
2517 * We have an encrypted request. Check if one of the crunchers wants it.
2519 if (crunch_response_triggered(csp, crunchers_all))
2522 * Yes. The client got the crunch response and we're done here.
2526 if (csp->ssl_with_server_is_opened == 0)
2528 log_error(LOG_LEVEL_CONNECT,
2529 "Dropping the client connection on socket %d. "
2530 "The server connection has not been established yet.",
2532 csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
2535 assert(csp->server_connection.sfd != JB_INVALID_SOCKET);
2537 fwd = forward_url(csp, csp->http);
2538 if (!connection_destination_matches(&csp->server_connection, csp->http, fwd))
2540 log_error(LOG_LEVEL_CONNECT,
2541 "Dropping the client connection on socket %d with "
2542 "server socket %d connected to %s. The forwarder has changed.",
2543 csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
2544 csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
2548 log_error(LOG_LEVEL_CONNECT,
2549 "Reusing server socket %d connected to %s. Requests already sent: %u.",
2550 csp->server_connection.sfd, csp->server_connection.host,
2551 csp->server_connection.requests_sent_total);
2553 if (send_https_request(csp))
2556 * Most likely the server connection timed out. We can't easily
2557 * create a new one so simply drop the client connection without a
2558 * error response to let the client retry.
2560 log_error(LOG_LEVEL_CONNECT,
2561 "Dropping client connection on socket %d. "
2562 "Forwarding the encrypted client request failed.",
2566 csp->server_connection.requests_sent_total++;
2567 handle_established_connection(csp);
2568 freez(csp->receive_buffer);
2570 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2574 /*********************************************************************
2576 * Function : handle_established_connection
2578 * Description : Shuffle data between client and server once the
2579 * connection has been established.
2582 * 1 : csp = Current client state (buffers, headers, etc...)
2584 * Returns : Nothing.
2586 *********************************************************************/
2587 static void handle_established_connection(struct client_state *csp)
2593 struct pollfd poll_fds[2];
2597 struct timeval timeout;
2600 int ms_iis5_hack = 0;
2601 unsigned long long byte_count = 0;
2602 struct http_request *http;
2603 long len = 0; /* for buffer sizes (and negative error codes) */
2604 int buffer_and_filter_content = 0;
2605 unsigned int write_delay;
2606 #ifdef FEATURE_HTTPS_INSPECTION
2608 int use_ssl_tunnel = 0;
2609 csp->dont_verify_certificate = 0;
2611 if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION))
2613 /* Pass encrypted content without filtering. */
2618 /* Skeleton for HTTP response, if we should intercept the request */
2619 struct http_response *rsp;
2620 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2621 int watch_client_socket;
2624 csp->receive_buffer_size = csp->config->receive_buffer_size;
2625 csp->receive_buffer = zalloc(csp->receive_buffer_size + 1);
2626 if (csp->receive_buffer == NULL)
2628 log_error(LOG_LEVEL_ERROR,
2629 "Out of memory. Failed to allocate the receive buffer.");
2630 rsp = cgi_error_memory();
2631 send_crunch_response(csp, rsp);
2638 maxfd = (csp->cfd > csp->server_connection.sfd) ?
2639 csp->cfd : csp->server_connection.sfd;
2642 /* pass data between the client and server
2643 * until one or the other shuts down the connection.
2648 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2649 watch_client_socket = 0 == (csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING);
2651 write_delay = get_write_delay(csp);
2657 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2658 if (!watch_client_socket)
2660 maxfd = csp->server_connection.sfd;
2663 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2665 FD_SET(csp->cfd, &rfds);
2668 FD_SET(csp->server_connection.sfd, &rfds);
2669 #endif /* ndef HAVE_POLL */
2671 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2672 if ((csp->flags & CSP_FLAG_CHUNKED)
2673 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2674 && ((csp->iob->eod - csp->iob->cur) >= 5)
2675 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
2678 * XXX: This check should be obsolete now,
2679 * but let's wait a while to be sure.
2681 log_error(LOG_LEVEL_CONNECT,
2682 "Looks like we got the last chunk together with "
2683 "the server headers but didn't detect it earlier. "
2684 "We better stop reading.");
2685 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2686 csp->expected_content_length = byte_count;
2687 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2689 if (server_body && server_response_is_complete(csp, byte_count))
2691 if (csp->expected_content_length == byte_count)
2693 log_error(LOG_LEVEL_CONNECT,
2694 "Done reading from server. Content length: %llu as expected. "
2695 "Bytes most recently read: %ld.",
2700 log_error(LOG_LEVEL_CONNECT,
2701 "Done reading from server. Expected content length: %llu. "
2702 "Actual content length: %llu. Bytes most recently read: %ld.",
2703 csp->expected_content_length, byte_count, len);
2707 * XXX: Should not jump around, handle_established_connection()
2708 * is complicated enough already.
2712 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2715 poll_fds[0].fd = csp->cfd;
2716 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2717 if (!watch_client_socket)
2720 * Ignore incoming data, but still watch out
2721 * for disconnects etc. These flags are always
2722 * implied anyway but explicitly setting them
2725 poll_fds[0].events = POLLERR|POLLHUP;
2730 poll_fds[0].events = POLLIN;
2732 poll_fds[1].fd = csp->server_connection.sfd;
2733 poll_fds[1].events = POLLIN;
2734 n = poll(poll_fds, 2, csp->config->socket_timeout * 1000);
2736 timeout.tv_sec = csp->config->socket_timeout;
2737 timeout.tv_usec = 0;
2738 n = select((int)maxfd + 1, &rfds, NULL, NULL, &timeout);
2739 #endif /* def HAVE_POLL */
2741 /*server or client not responding in timeout */
2744 log_error(LOG_LEVEL_CONNECT, "Socket timeout %d reached: %s",
2745 csp->config->socket_timeout, http->url);
2746 if ((byte_count == 0) && (http->ssl == 0))
2748 send_crunch_response(csp, error_response(csp, "connection-timeout"));
2750 mark_server_socket_tainted(csp);
2751 #ifdef FEATURE_HTTPS_INSPECTION
2752 close_client_and_server_ssl_connections(csp);
2759 log_error(LOG_LEVEL_ERROR, "poll() failed!: %E");
2761 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
2763 mark_server_socket_tainted(csp);
2764 #ifdef FEATURE_HTTPS_INSPECTION
2765 close_client_and_server_ssl_connections(csp);
2771 * This is the body of the browser's request,
2772 * just read and write it.
2774 * Receives data from browser and sends it to server
2776 * XXX: Make sure the client doesn't use pipelining
2777 * behind Privoxy's back.
2780 if ((poll_fds[0].revents & (POLLERR|POLLHUP|POLLNVAL)) != 0)
2782 log_error(LOG_LEVEL_CONNECT,
2783 "The client socket %d has become unusable while "
2784 "the server socket %d is still open.",
2785 csp->cfd, csp->server_connection.sfd);
2786 mark_server_socket_tainted(csp);
2790 if (poll_fds[0].revents != 0)
2792 if (FD_ISSET(csp->cfd, &rfds))
2793 #endif /* def HAVE_POLL*/
2795 int max_bytes_to_read = (int)csp->receive_buffer_size;
2797 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2798 if ((csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ))
2800 if (data_is_available(csp->cfd, 0))
2803 * If the next request is already waiting, we have
2804 * to stop select()ing the client socket. Otherwise
2805 * we would always return right away and get nothing
2808 watch_client_socket = 0;
2809 log_error(LOG_LEVEL_CONNECT,
2810 "Stop watching client socket %d. "
2811 "There's already another request waiting.",
2816 * If the client socket is set, but there's no data
2817 * available on the socket, the client went fishing
2818 * and continuing talking to the server makes no sense.
2820 log_error(LOG_LEVEL_CONNECT,
2821 "The client closed socket %d while "
2822 "the server socket %d is still open.",
2823 csp->cfd, csp->server_connection.sfd);
2824 mark_server_socket_tainted(csp);
2827 if (csp->expected_client_content_length != 0)
2829 if (csp->expected_client_content_length < csp->receive_buffer_size)
2831 max_bytes_to_read = (int)csp->expected_client_content_length;
2833 log_error(LOG_LEVEL_CONNECT,
2834 "Waiting for up to %d bytes from the client.",
2837 assert(max_bytes_to_read <= csp->receive_buffer_size);
2838 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2840 #ifdef FEATURE_HTTPS_INSPECTION
2841 if (client_use_ssl(csp))
2843 log_error(LOG_LEVEL_CONNECT, "Breaking with TLS/SSL.");
2847 #endif /* def FEATURE_HTTPS_INSPECTION */
2849 len = read_socket(csp->cfd, csp->receive_buffer, max_bytes_to_read);
2853 /* XXX: not sure if this is necessary. */
2854 mark_server_socket_tainted(csp);
2855 break; /* "game over, man" */
2858 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2859 if (csp->expected_client_content_length != 0)
2861 assert(len <= max_bytes_to_read);
2862 csp->expected_client_content_length -= (unsigned)len;
2863 log_error(LOG_LEVEL_CONNECT,
2864 "Expected client content length set to %llu "
2865 "after reading %ld bytes.",
2866 csp->expected_client_content_length, len);
2867 if (csp->expected_client_content_length == 0)
2869 log_error(LOG_LEVEL_CONNECT,
2870 "Done reading from the client.");
2871 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
2874 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2876 if (write_socket(csp->server_connection.sfd, csp->receive_buffer, (size_t)len))
2878 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
2879 mark_server_socket_tainted(csp);
2887 * The server wants to talk. It could be the header or the body.
2888 * If `hdr' is null, then it's the header otherwise it's the body.
2889 * FIXME: Does `hdr' really mean `host'? No.
2892 if (poll_fds[1].revents != 0)
2894 if (FD_ISSET(csp->server_connection.sfd, &rfds))
2895 #endif /* HAVE_POLL */
2897 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2899 * If we are buffering content, we don't want to eat up to
2900 * buffer-limit bytes if the client no longer cares about them.
2901 * If we aren't buffering, however, a dead client socket will be
2902 * noticed pretty much right away anyway, so we can reduce the
2903 * overhead by skipping the check.
2905 if (buffer_and_filter_content && !socket_is_still_alive(csp->cfd))
2908 log_error(LOG_LEVEL_CONNECT,
2909 "The server still wants to talk, but the client may already have hung up on us.");
2911 log_error(LOG_LEVEL_CONNECT,
2912 "The server still wants to talk, but the client hung up on us.");
2913 mark_server_socket_tainted(csp);
2914 #ifdef FEATURE_HTTPS_INSPECTION
2915 close_client_and_server_ssl_connections(csp);
2918 #endif /* def _WIN32 */
2920 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2922 #ifdef FEATURE_HTTPS_INSPECTION
2924 * Reading data from standard or secured connection (HTTP/HTTPS)
2926 if (server_use_ssl(csp))
2928 len = ssl_recv_data(&(csp->ssl_server_attr),
2929 (unsigned char *)csp->receive_buffer, csp->receive_buffer_size);
2934 len = read_socket(csp->server_connection.sfd, csp->receive_buffer,
2935 (int)csp->receive_buffer_size);
2940 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
2942 if ((http->ssl && (csp->fwd == NULL))
2943 #ifdef FEATURE_HTTPS_INSPECTION
2949 * Just hang up. We already confirmed the client's CONNECT
2950 * request with status code 200 and unencrypted content is
2951 * no longer welcome.
2953 log_error(LOG_LEVEL_ERROR,
2954 "CONNECT already confirmed. Unable to tell the client about the problem.");
2957 else if (byte_count)
2960 * Just hang up. We already transmitted the original headers
2961 * and parts of the original content and therefore missed the
2962 * chance to send an error message (without risking data corruption).
2964 * XXX: we could retry with a fancy range request here.
2966 log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
2967 "Unable to tell the client about the problem.");
2968 mark_server_socket_tainted(csp);
2969 #ifdef FEATURE_HTTPS_INSPECTION
2970 close_client_and_server_ssl_connections(csp);
2975 * XXX: Consider handling the cases above the same.
2977 mark_server_socket_tainted(csp);
2981 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2982 if (csp->flags & CSP_FLAG_CHUNKED)
2984 if ((len >= 5) && !memcmp(csp->receive_buffer+len-5, "0\r\n\r\n", 5))
2986 /* XXX: this is a temporary hack */
2987 log_error(LOG_LEVEL_CONNECT,
2988 "Looks like we reached the end of the last chunk. "
2989 "We better stop reading.");
2990 csp->expected_content_length = byte_count + (unsigned long long)len;
2991 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2995 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2998 * This is guaranteed by allocating with zalloc_or_die()
2999 * and never (intentionally) writing to the last byte.
3001 * csp->receive_buffer_size is the size of the part of the
3002 * buffer we intentionally write to, but we actually
3003 * allocated csp->receive_buffer_size+1 bytes so the assertion
3004 * stays within the allocated range.
3006 assert(csp->receive_buffer[csp->receive_buffer_size] == '\0');
3009 * Add a trailing zero to let be able to use string operations.
3010 * XXX: do we still need this with filter_popups gone?
3012 assert(len <= csp->receive_buffer_size);
3013 csp->receive_buffer[len] = '\0';
3016 * Normally, this would indicate that we've read
3017 * as much as the server has sent us and we can
3018 * close the client connection. However, Microsoft
3019 * in its wisdom has released IIS/5 with a bug that
3020 * prevents it from sending the trailing \r\n in
3021 * a 302 redirect header (and possibly other headers).
3022 * To work around this if we've haven't parsed
3023 * a full header we'll append a trailing \r\n
3024 * and see if this now generates a valid one.
3026 * This hack shouldn't have any impacts. If we've
3027 * already transmitted the header or if this is a
3028 * SSL connection, then we won't bother with this
3029 * hack. So we only work on partially received
3030 * headers. If we append a \r\n and this still
3031 * doesn't generate a valid header, then we won't
3032 * transmit anything to the client.
3037 if (server_body || (http->ssl
3038 #ifdef FEATURE_HTTPS_INSPECTION
3044 * If we have been buffering up the document,
3045 * now is the time to apply content modification
3046 * and send the result to the client.
3048 if (buffer_and_filter_content)
3050 p = execute_content_filters(csp);
3052 * If content filtering fails, use the original
3053 * buffer and length.
3054 * (see p != NULL ? p : csp->iob->cur below)
3058 csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
3060 #ifdef FEATURE_COMPRESSION
3061 else if ((csp->flags & CSP_FLAG_CLIENT_SUPPORTS_DEFLATE)
3062 && (csp->content_length > LOWER_LENGTH_LIMIT_FOR_COMPRESSION))
3064 char *compressed_content = compress_buffer(p,
3065 (size_t *)&csp->content_length, csp->config->compression_level);
3066 if (compressed_content != NULL)
3069 p = compressed_content;
3070 csp->flags |= CSP_FLAG_BUFFERED_CONTENT_DEFLATED;
3075 if (JB_ERR_OK != update_server_headers(csp))
3077 log_error(LOG_LEVEL_FATAL,
3078 "Failed to update server headers. after filtering.");
3081 hdr = list_to_text(csp->headers);
3084 /* FIXME Should handle error properly */
3085 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
3088 #ifdef FEATURE_HTTPS_INSPECTION
3090 * Sending data with standard or secured connection (HTTP/HTTPS)
3092 if (client_use_ssl(csp))
3094 if ((ssl_send_data_delayed(&(csp->ssl_client_attr),
3095 (const unsigned char *)hdr, strlen(hdr),
3096 get_write_delay(csp)) < 0)
3097 || (ssl_send_data_delayed(&(csp->ssl_client_attr),
3098 (const unsigned char *) ((p != NULL) ? p : csp->iob->cur),
3099 csp->content_length, get_write_delay(csp)) < 0))
3101 log_error(LOG_LEVEL_ERROR, "write modified content to "
3102 "client over TLS/SSL failed");
3105 mark_server_socket_tainted(csp);
3106 close_client_and_server_ssl_connections(csp);
3111 #endif /* def FEATURE_HTTPS_INSPECTION */
3113 if (write_socket_delayed(csp->cfd, hdr, strlen(hdr), write_delay)
3114 || write_socket_delayed(csp->cfd, ((p != NULL) ? p : csp->iob->cur),
3115 (size_t)csp->content_length, write_delay))
3117 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
3120 mark_server_socket_tainted(csp);
3129 break; /* "game over, man" */
3133 * This is NOT the body, so
3134 * Let's pretend the server just sent us a blank line.
3136 snprintf(csp->receive_buffer, csp->receive_buffer_size, "\r\n");
3137 len = (int)strlen(csp->receive_buffer);
3140 * Now, let the normal header parsing algorithm below do its
3141 * job. If it fails, we'll exit instead of continuing.
3148 * If we're in the body of the server document, just write it to
3149 * the client, unless we need to buffer the body for later
3150 * content-filtering.
3152 if (server_body || (http->ssl
3153 #ifdef FEATURE_HTTPS_INSPECTION
3158 if (buffer_and_filter_content)
3161 * If there is no memory left for buffering the content, or the buffer limit
3162 * has been reached, switch to non-filtering mode, i.e. make & write the
3163 * header, flush the iob and buf, and get out of the way.
3165 if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3170 log_error(LOG_LEVEL_INFO,
3171 "Flushing header and buffers. Stepping back from filtering.");
3173 hdr = list_to_text(csp->headers);
3177 * Memory is too tight to even generate the header.
3178 * Send our static "Out-of-memory" page.
3180 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
3181 rsp = cgi_error_memory();
3182 send_crunch_response(csp, rsp);
3183 mark_server_socket_tainted(csp);
3184 #ifdef FEATURE_HTTPS_INSPECTION
3185 close_client_and_server_ssl_connections(csp);
3189 hdrlen = strlen(hdr);
3191 #ifdef FEATURE_HTTPS_INSPECTION
3193 * Sending data with standard or secured connection (HTTP/HTTPS)
3195 if (client_use_ssl(csp))
3197 if ((ssl_send_data_delayed(&(csp->ssl_client_attr),
3198 (const unsigned char *)hdr, hdrlen, get_write_delay(csp)) < 0)
3199 || ((flushed = ssl_flush_socket(&(csp->ssl_client_attr),
3201 || (ssl_send_data_delayed(&(csp->ssl_client_attr),
3202 (const unsigned char *)csp->receive_buffer, (size_t)len,
3203 get_write_delay(csp)) < 0))
3205 log_error(LOG_LEVEL_CONNECT,
3206 "Flush header and buffers to client failed");
3208 mark_server_socket_tainted(csp);
3209 close_client_and_server_ssl_connections(csp);
3214 #endif /* def FEATURE_HTTPS_INSPECTION */
3216 if (write_socket_delayed(csp->cfd, hdr, hdrlen, write_delay)
3217 || ((flushed = flush_iob(csp->cfd, csp->iob, write_delay)) < 0)
3218 || write_socket_delayed(csp->cfd, csp->receive_buffer, (size_t)len,
3221 log_error(LOG_LEVEL_CONNECT,
3222 "Flush header and buffers to client failed: %E");
3224 mark_server_socket_tainted(csp);
3230 * Reset the byte_count to the amount of bytes
3231 * we just flushed. len will be added a few lines below,
3232 * hdrlen doesn't matter for LOG_LEVEL_CLF.
3234 byte_count = (unsigned long long)flushed;
3236 buffer_and_filter_content = 0;
3242 #ifdef FEATURE_HTTPS_INSPECTION
3244 * Sending data with standard or secured connection (HTTP/HTTPS)
3246 if (client_use_ssl(csp))
3248 ret = ssl_send_data_delayed(&(csp->ssl_client_attr),
3249 (const unsigned char *)csp->receive_buffer, (size_t)len,
3250 get_write_delay(csp));
3253 log_error(LOG_LEVEL_ERROR,
3254 "Sending data to client failed");
3255 mark_server_socket_tainted(csp);
3256 close_client_and_server_ssl_connections(csp);
3261 #endif /* def FEATURE_HTTPS_INSPECTION */
3263 if (write_socket_delayed(csp->cfd, csp->receive_buffer,
3264 (size_t)len, write_delay))
3266 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
3267 mark_server_socket_tainted(csp);
3272 byte_count += (unsigned long long)len;
3278 * We're still looking for the end of the server's header.
3279 * Buffer up the data we just read. If that fails, there's
3280 * little we can do but send our static out-of-memory page.
3282 if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3284 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
3285 rsp = cgi_error_memory();
3286 send_crunch_response(csp, rsp);
3287 mark_server_socket_tainted(csp);
3288 #ifdef FEATURE_HTTPS_INSPECTION
3289 close_client_and_server_ssl_connections(csp);
3294 /* Convert iob into something sed() can digest */
3295 if (JB_ERR_PARSE == get_server_headers(csp))
3300 * Well, we tried our MS IIS/5 hack and it didn't work.
3301 * The header is incomplete and there isn't anything
3302 * we can do about it.
3304 log_error(LOG_LEVEL_ERROR, "Invalid server headers. "
3305 "Applying the MS IIS5 hack didn't help.");
3306 log_error(LOG_LEVEL_CLF,
3307 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3308 #ifdef FEATURE_HTTPS_INSPECTION
3310 * Sending data with standard or secured connection (HTTP/HTTPS)
3312 if (client_use_ssl(csp))
3314 ssl_send_data_delayed(&(csp->ssl_client_attr),
3315 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3316 strlen(INVALID_SERVER_HEADERS_RESPONSE), get_write_delay(csp));
3319 #endif /* def FEATURE_HTTPS_INSPECTION */
3321 write_socket_delayed(csp->cfd,
3322 INVALID_SERVER_HEADERS_RESPONSE,
3323 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3325 mark_server_socket_tainted(csp);
3326 #ifdef FEATURE_HTTPS_INSPECTION
3327 close_client_and_server_ssl_connections(csp);
3334 * Since we have to wait for more from the server before
3335 * we can parse the headers we just continue here.
3337 log_error(LOG_LEVEL_CONNECT,
3338 "Continuing buffering server headers from socket %d. "
3339 "Bytes most recently read: %ld.", csp->cfd, len);
3346 * Account for the content bytes we
3347 * might have gotten with the headers.
3349 assert(csp->iob->eod >= csp->iob->cur);
3350 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3353 /* Did we actually get anything? */
3354 if (NULL == csp->headers->first)
3356 if ((csp->flags & CSP_FLAG_REUSED_CLIENT_CONNECTION))
3358 log_error(LOG_LEVEL_ERROR,
3359 "No server or forwarder response received on socket %d. "
3360 "Closing client socket %d without sending data.",
3361 csp->server_connection.sfd, csp->cfd);
3362 log_error(LOG_LEVEL_CLF,
3363 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3367 log_error(LOG_LEVEL_ERROR,
3368 "No server or forwarder response received on socket %d.",
3369 csp->server_connection.sfd);
3370 send_crunch_response(csp, error_response(csp, "no-server-data"));
3372 free_http_request(http);
3373 mark_server_socket_tainted(csp);
3374 #ifdef FEATURE_HTTPS_INSPECTION
3375 close_client_and_server_ssl_connections(csp);
3380 if (!csp->headers->first->str)
3382 log_error(LOG_LEVEL_ERROR, "header search: csp->headers->first->str == NULL, assert will be called");
3384 assert(csp->headers->first->str);
3386 if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
3387 strncmpic(csp->headers->first->str, "ICY", 3))
3390 * It doesn't look like a HTTP (or Shoutcast) response:
3391 * tell the client and log the problem.
3393 if (strlen(csp->headers->first->str) > 30)
3395 csp->headers->first->str[30] = '\0';
3397 log_error(LOG_LEVEL_ERROR,
3398 "Invalid server or forwarder response. Starts with: %s",
3399 csp->headers->first->str);
3400 log_error(LOG_LEVEL_CLF,
3401 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3402 #ifdef FEATURE_HTTPS_INSPECTION
3404 * Sending data with standard or secured connection (HTTP/HTTPS)
3406 if (client_use_ssl(csp))
3408 ssl_send_data_delayed(&(csp->ssl_client_attr),
3409 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3410 strlen(INVALID_SERVER_HEADERS_RESPONSE),
3411 get_write_delay(csp));
3414 #endif /* def FEATURE_HTTPS_INSPECTION */
3416 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3417 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3419 free_http_request(http);
3420 mark_server_socket_tainted(csp);
3421 #ifdef FEATURE_HTTPS_INSPECTION
3422 close_client_and_server_ssl_connections(csp);
3428 * We have now received the entire server header,
3429 * filter it and send the result to the client
3431 if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
3433 log_error(LOG_LEVEL_CLF,
3434 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3435 #ifdef FEATURE_HTTPS_INSPECTION
3437 * Sending data with standard or secured connection (HTTP/HTTPS)
3439 if (client_use_ssl(csp))
3441 ssl_send_data_delayed(&(csp->ssl_client_attr),
3442 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3443 strlen(INVALID_SERVER_HEADERS_RESPONSE),
3444 get_write_delay(csp));
3449 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3450 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3452 free_http_request(http);
3453 mark_server_socket_tainted(csp);
3454 #ifdef FEATURE_HTTPS_INSPECTION
3455 close_client_and_server_ssl_connections(csp);
3459 hdr = list_to_text(csp->headers);
3462 /* FIXME Should handle error properly */
3463 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
3466 if ((csp->flags & CSP_FLAG_CHUNKED)
3467 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3468 && ((csp->iob->eod - csp->iob->cur) >= 5)
3469 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
3471 log_error(LOG_LEVEL_CONNECT,
3472 "Looks like we got the last chunk together with "
3473 "the server headers. We better stop reading.");
3474 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3475 csp->expected_content_length = byte_count;
3476 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
3479 csp->server_connection.response_received = time(NULL);
3481 if (crunch_response_triggered(csp, crunchers_light))
3484 * One of the tags created by a server-header
3485 * tagger triggered a crunch. We already
3486 * delivered the crunch response to the client
3487 * and are done here after cleaning up.
3490 mark_server_socket_tainted(csp);
3491 #ifdef FEATURE_HTTPS_INSPECTION
3492 close_client_and_server_ssl_connections(csp);
3497 /* Buffer and pcrs filter this if appropriate. */
3498 buffer_and_filter_content = content_requires_filtering(csp);
3500 if (!buffer_and_filter_content)
3503 * Write the server's (modified) header to
3504 * the client (along with anything else that
3505 * may be in the buffer). Use standard or secured
3508 #ifdef FEATURE_HTTPS_INSPECTION
3509 if (client_use_ssl(csp))
3511 if ((ssl_send_data_delayed(&(csp->ssl_client_attr),
3512 (const unsigned char *)hdr, strlen(hdr),
3513 get_write_delay(csp)) < 0)
3514 || (len = ssl_flush_socket(&(csp->ssl_client_attr),
3517 log_error(LOG_LEVEL_CONNECT, "Write header to client failed");
3520 * The write failed, so don't bother mentioning it
3521 * to the client... it probably can't hear us anyway.
3524 mark_server_socket_tainted(csp);
3525 #ifdef FEATURE_HTTPS_INSPECTION
3526 close_client_and_server_ssl_connections(csp);
3532 #endif /* def FEATURE_HTTPS_INSPECTION */
3534 if (write_socket_delayed(csp->cfd, hdr, strlen(hdr), write_delay)
3535 || ((len = flush_iob(csp->cfd, csp->iob, write_delay)) < 0))
3537 log_error(LOG_LEVEL_ERROR,
3538 "write header to client failed");
3540 * The write failed, so don't bother mentioning it
3541 * to the client... it probably can't hear us anyway.
3544 mark_server_socket_tainted(csp);
3550 /* we're finished with the server's header */
3556 * If this was a MS IIS/5 hack then it means the server
3557 * has already closed the connection. Nothing more to read.
3562 log_error(LOG_LEVEL_ERROR,
3563 "Closed server connection detected. "
3564 "Applying the MS IIS5 hack didn't help.");
3565 log_error(LOG_LEVEL_CLF,
3566 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3567 #ifdef FEATURE_HTTPS_INSPECTION
3569 * Sending data with standard or secured connection (HTTP/HTTPS)
3571 if (client_use_ssl(csp))
3573 ssl_send_data_delayed(&(csp->ssl_client_attr),
3574 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3575 strlen(INVALID_SERVER_HEADERS_RESPONSE),
3576 get_write_delay(csp));
3579 #endif /* def FEATURE_HTTPS_INSPECTION */
3581 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3582 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3584 mark_server_socket_tainted(csp);
3585 #ifdef FEATURE_HTTPS_INSPECTION
3586 close_client_and_server_ssl_connections(csp);
3593 mark_server_socket_tainted(csp);
3594 #ifdef FEATURE_HTTPS_INSPECTION
3595 close_client_and_server_ssl_connections(csp);
3597 return; /* huh? we should never get here */
3600 if (csp->content_length == 0)
3603 * If Privoxy didn't recalculate the Content-Length,
3604 * byte_count is still correct.
3606 csp->content_length = byte_count;
3609 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3610 if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3611 && (csp->expected_content_length != byte_count))
3613 log_error(LOG_LEVEL_CONNECT,
3614 "Received %llu bytes while expecting %llu.",
3615 byte_count, csp->expected_content_length);
3616 mark_server_socket_tainted(csp);
3620 #ifdef FEATURE_HTTPS_INSPECTION
3621 if (client_use_ssl(csp))
3623 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s https://%s%s %s\" 200 %llu",
3624 csp->ip_addr_str, http->gpc, http->hostport, http->path,
3625 http->version, csp->content_length);
3630 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %llu",
3631 csp->ip_addr_str, http->ocmd, csp->content_length);
3633 csp->server_connection.timestamp = time(NULL);
3637 /*********************************************************************
3641 * Description : Once a connection from the client has been accepted,
3642 * this function is called (via serve()) to handle the
3643 * main business of the communication. This function
3644 * returns after dealing with a single request. It can
3645 * be called multiple times with the same client socket
3646 * if the client is keeping the connection alive.
3648 * The decision whether or not a client connection will
3649 * be kept alive is up to the caller which also must
3650 * close the client socket when done.
3652 * FIXME: chat is nearly thousand lines long.
3656 * 1 : csp = Current client state (buffers, headers, etc...)
3658 * Returns : Nothing.
3660 *********************************************************************/
3661 static void chat(struct client_state *csp)
3663 const struct forward_spec *fwd;
3664 struct http_request *http;
3665 /* Skeleton for HTTP response, if we should intercept the request */
3666 struct http_response *rsp;
3667 #ifdef FEATURE_HTTPS_INSPECTION
3668 int use_ssl_tunnel = 0;
3673 if (receive_client_request(csp) != JB_ERR_OK)
3677 if (parse_client_request(csp) != JB_ERR_OK)
3682 /* decide how to route the HTTP request */
3683 fwd = forward_url(csp, http);
3685 #ifdef FEATURE_HTTPS_INSPECTION
3687 * Setting flags to use old solution with SSL tunnel and to disable
3688 * certificate verification.
3690 if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION)
3691 && !cgi_page_requested(csp->http->host))
3696 if (http->ssl && csp->action->flags & ACTION_IGNORE_CERTIFICATE_ERRORS)
3698 csp->dont_verify_certificate = 1;
3703 * build the http request to send to the server
3704 * we have to do one of the following:
3706 * create = use the original HTTP request to create a new
3707 * HTTP request that has either the path component
3708 * without the http://domainspec (w/path) or the
3709 * full orininal URL (w/url)
3710 * Note that the path and/or the HTTP version may
3711 * have been altered by now.
3713 * SSL proxy = Open a socket to the host:port of the server
3714 * and create TLS/SSL connection with server and
3715 * with client. Then behave like mediator between
3716 * client and server over TLS/SSL.
3718 * SSL proxy = Pass the request unchanged if forwarding a CONNECT
3719 * with request to a parent proxy. Note that we'll be sending
3720 * forwarding the CFAIL message ourselves if connecting to the parent
3721 * fails, but we won't send a CSUCCEED message if it works,
3722 * since that would result in a double message (ours and the
3723 * parent's). After sending the request to the parent, we
3724 * must parse answer and send it to client. If connection
3725 * with server is established, we do TLS/SSL proxy. Otherwise
3726 * we send parent response to client and close connections.
3728 * here's the matrix:
3731 * +--------+--------+
3733 * 0 | create | SSL |
3734 * | w/path | proxy |
3735 * Forwarding +--------+--------+
3737 * 1 | create | proxy |
3738 * | w/url |+forward|
3739 * +--------+--------+
3743 #ifdef FEATURE_HTTPS_INSPECTION
3745 * Presetting SSL client and server flags
3747 if (http->ssl && !use_ssl_tunnel)
3749 http->client_ssl = 1;
3750 http->server_ssl = 1;
3754 http->client_ssl = 0;
3755 http->server_ssl = 0;
3759 #ifdef FEATURE_HTTPS_INSPECTION
3761 * Log the request unless we're https inspecting
3762 * in which case we don't have the path yet and
3763 * will log the request later.
3765 if (!client_use_ssl(csp))
3768 log_error(LOG_LEVEL_REQUEST, "%s%s", http->hostport, http->path);
3771 if (http->ssl && connect_port_is_forbidden(csp))
3773 const char *acceptable_connect_ports =
3774 csp->action->string[ACTION_STRING_LIMIT_CONNECT];
3775 assert(NULL != acceptable_connect_ports);
3776 log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
3777 "limit-connect{%s} doesn't allow CONNECT requests to %s",
3778 csp->ip_addr_str, acceptable_connect_ports, csp->http->hostport);
3779 csp->action->flags |= ACTION_BLOCK;
3781 #ifdef FEATURE_HTTPS_INSPECTION
3782 http->client_ssl = 0;
3783 http->server_ssl = 0;
3788 freez(csp->headers->first->str);
3789 build_request_line(csp, fwd, &csp->headers->first->str);
3792 * We have a request. Check if one of the crunchers wants it
3793 * unless the client wants to use TLS/SSL in which case we
3794 * haven't setup the TLS context yet and will send the crunch
3798 #ifdef FEATURE_HTTPS_INSPECTION
3799 !client_use_ssl(csp) &&
3801 crunch_response_triggered(csp, crunchers_all))
3804 * Yes. The client got the crunch response and we're done here.
3809 log_applied_actions(csp->action);
3810 if (fwd->forward_host)
3812 log_error(LOG_LEVEL_CONNECT, "via [%s]:%d to: %s",
3813 fwd->forward_host, fwd->forward_port, http->hostport);
3817 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
3820 /* here we connect to the server, gateway, or the forwarder */
3822 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3823 if ((csp->server_connection.sfd != JB_INVALID_SOCKET)
3824 && socket_is_still_alive(csp->server_connection.sfd)
3825 && connection_destination_matches(&csp->server_connection, http, fwd))
3827 log_error(LOG_LEVEL_CONNECT,
3828 "Reusing server socket %d connected to %s. Total requests: %u.",
3829 csp->server_connection.sfd, csp->server_connection.host,
3830 csp->server_connection.requests_sent_total);
3834 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
3836 #ifdef FEATURE_CONNECTION_SHARING
3837 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING
3838 #ifdef FEATURE_HTTPS_INSPECTION
3839 && !server_use_ssl(csp)
3843 remember_connection(&csp->server_connection);
3846 #endif /* def FEATURE_CONNECTION_SHARING */
3848 log_error(LOG_LEVEL_CONNECT,
3849 "Closing server socket %d connected to %s. Total requests: %u.",
3850 csp->server_connection.sfd, csp->server_connection.host,
3851 csp->server_connection.requests_sent_total);
3852 close_socket(csp->server_connection.sfd);
3854 mark_connection_closed(&csp->server_connection);
3856 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3857 #ifdef FEATURE_HTTPS_INSPECTION
3858 if (http->ssl && !use_ssl_tunnel)
3862 * Creating a SSL proxy.
3864 * By sending the CSUCCEED message we're lying to the client as
3865 * the connection hasn't actually been established yet. We don't
3866 * establish the connection until we have seen and parsed the
3867 * encrypted client headers.
3869 if (write_socket_delayed(csp->cfd, CSUCCEED,
3870 strlen(CSUCCEED), get_write_delay(csp)) != 0)
3872 log_error(LOG_LEVEL_ERROR, "Sending SUCCEED to client failed");
3876 ret = create_client_ssl_connection(csp);
3879 log_error(LOG_LEVEL_ERROR,
3880 "Failed to open a secure connection with the client");
3883 if (JB_ERR_OK != process_encrypted_request(csp))
3885 close_client_ssl_connection(csp);
3889 * We have an encrypted request. Check if one of the crunchers now
3890 * wants it (for example because the previously invisible path was
3891 * required to match).
3893 if (crunch_response_triggered(csp, crunchers_all))
3896 * Yes. The client got the crunch response and we're done here.
3903 * Connecting to destination server
3905 csp->server_connection.sfd = forwarded_connect(fwd, http, csp);
3907 if (csp->server_connection.sfd == JB_INVALID_SOCKET)
3909 if (fwd->type != SOCKS_NONE)
3912 rsp = error_response(csp, "forwarding-failed");
3914 else if (errno == EINVAL)
3916 rsp = error_response(csp, "no-such-domain");
3920 rsp = error_response(csp, "connect-failed");
3923 /* Write the answer to the client */
3926 send_crunch_response(csp, rsp);
3930 * Temporary workaround to prevent already-read client
3931 * bodies from being parsed as new requests. For now we
3932 * err on the safe side and throw all the following
3933 * requests under the bus, even if no client body has been
3934 * buffered. A compliant client will repeat the dropped
3935 * requests on an untainted connection.
3937 * The proper fix is to discard the no longer needed
3938 * client body in the buffer (if there is one) and to
3939 * continue parsing the bytes that follow.
3941 #ifdef FEATURE_HTTPS_INSPECTION
3942 close_client_ssl_connection(csp);
3944 drain_and_close_socket(csp->cfd);
3945 csp->cfd = JB_INVALID_SOCKET;
3950 #ifdef FEATURE_HTTPS_INSPECTION
3952 * Creating TLS/SSL connections with destination server or parent
3953 * proxy. If forwarding is enabled, we must send client request to
3954 * parent proxy and receive, parse and resend parent proxy answer.
3956 if (http->ssl && !use_ssl_tunnel)
3958 if (fwd->forward_host != NULL)
3960 char server_response[BUFFER_SIZE];
3963 char *hdr = list_to_text(csp->headers);
3964 memset(server_response, 0, sizeof(server_response));
3968 log_error(LOG_LEVEL_FATAL,
3969 "Out of memory parsing client header");
3971 list_remove_all(csp->headers);
3974 * Sending client's CONNECT request to the parent proxy
3976 ret = write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
3982 log_error(LOG_LEVEL_CONNECT,
3983 "Sending request headers to: %s failed", http->hostport);
3984 mark_server_socket_tainted(csp);
3985 close_client_ssl_connection(csp);
3989 /* Waiting for parent proxy server response */
3990 len = read_socket(csp->server_connection.sfd, server_response,
3991 sizeof(server_response)-1);
3995 log_error(LOG_LEVEL_ERROR, "No response from parent proxy "
3996 "server on socket %d.", csp->server_connection.sfd);
3998 rsp = error_response(csp, "no-server-data");
4001 send_crunch_response(csp, rsp);
4003 mark_server_socket_tainted(csp);
4004 close_client_ssl_connection(csp);
4009 * Test if the connection to the destination server was
4010 * established successfully by the parent proxy.
4012 if (!tunnel_established_successfully(server_response, (unsigned int)len))
4014 log_error(LOG_LEVEL_ERROR,
4015 "The forwarder %s failed to establish a connection with %s",
4016 fwd->forward_host, http->host);
4017 rsp = error_response(csp, "connect-failed");
4020 send_crunch_response(csp, rsp);
4022 mark_server_socket_tainted(csp);
4023 close_client_ssl_connection(csp);
4026 } /* -END- if (fwd->forward_host != NULL) */
4029 * We can now create the TLS/SSL connection with the destination server.
4031 int ret = create_server_ssl_connection(csp);
4034 if (csp->server_cert_verification_result != SSL_CERT_VALID &&
4035 csp->server_cert_verification_result != SSL_CERT_NOT_VERIFIED)
4038 * If the server certificate is invalid, we must inform
4039 * the client and then close connection to the client.
4041 ssl_send_certificate_error(csp);
4042 close_client_and_server_ssl_connections(csp);
4045 if (csp->server_cert_verification_result == SSL_CERT_NOT_VERIFIED
4046 || csp->server_cert_verification_result == SSL_CERT_VALID)
4049 * The TLS/SSL connection wasn't created but an invalid
4050 * certificate wasn't detected. Report it as connection
4053 rsp = error_response(csp, "connect-failed");
4056 send_crunch_response(csp, rsp);
4058 close_client_and_server_ssl_connections(csp);
4062 }/* -END- if (http->ssl) */
4063 #endif /* def FEATURE_HTTPS_INSPECTION */
4065 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4066 save_connection_destination(csp->server_connection.sfd,
4067 http, fwd, &csp->server_connection);
4068 csp->server_connection.keep_alive_timeout =
4069 (unsigned)csp->config->keep_alive_timeout;
4071 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4073 csp->server_connection.requests_sent_total++;
4075 if ((fwd->type == SOCKS_5T) && (NULL == csp->headers->first))
4077 /* Client headers have been sent optimistically */
4078 assert(csp->headers->last == NULL);
4080 else if (http->ssl == 0 || (fwd->forward_host
4081 #ifdef FEATURE_HTTPS_INSPECTION
4086 if (send_http_request(csp))
4088 rsp = error_response(csp, "connect-failed");
4091 send_crunch_response(csp, rsp);
4099 * Using old solution with SSL tunnel or new solution with SSL proxy
4101 list_remove_all(csp->headers);
4102 #ifdef FEATURE_HTTPS_INSPECTION
4107 * We're running an SSL tunnel and we're not forwarding,
4108 * so just ditch the client headers, send the "connect succeeded"
4109 * message to the client, flush the rest, and get out of the way.
4111 if (write_socket_delayed(csp->cfd, CSUCCEED,
4112 strlen(CSUCCEED), get_write_delay(csp)))
4117 #ifdef FEATURE_HTTPS_INSPECTION
4121 * If server certificate is invalid, we must inform client and then
4122 * close connection with client.
4124 if (csp->server_cert_verification_result != SSL_CERT_VALID)
4126 ssl_send_certificate_error(csp);
4127 close_client_and_server_ssl_connections(csp);
4130 if (send_https_request(csp))
4132 rsp = error_response(csp, "connect-failed");
4135 send_crunch_response(csp, rsp);
4137 close_client_and_server_ssl_connections(csp);
4141 #endif /* def FEATURE_HTTPS_INSPECTION */
4142 clear_iob(csp->client_iob);
4143 }/* -END- else ... if (http->ssl == 1) */
4145 log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
4147 /* XXX: should the time start earlier for optimistically sent data? */
4148 csp->server_connection.request_sent = time(NULL);
4150 handle_established_connection(csp);
4151 freez(csp->receive_buffer);
4156 /*********************************************************************
4158 * Function : fuzz_server_response
4160 * Description : Treat the input as a whole server response.
4163 * 1 : csp = Current client state (buffers, headers, etc...)
4164 * 2 : fuzz_input_file = File to read the input from.
4168 *********************************************************************/
4169 extern int fuzz_server_response(struct client_state *csp, char *fuzz_input_file)
4171 static struct forward_spec fwd; /* Zero'd due to being static */
4174 if (strcmp(fuzz_input_file, "-") == 0)
4176 /* XXX: Doesn't work yet. */
4177 csp->server_connection.sfd = 0;
4181 csp->server_connection.sfd = open(fuzz_input_file, O_RDONLY);
4182 if (csp->server_connection.sfd == -1)
4184 log_error(LOG_LEVEL_FATAL, "Failed to open %s: %E",
4189 csp->content_type |= CT_GIF;
4190 csp->action->flags |= ACTION_DEANIMATE;
4191 csp->action->string[ACTION_STRING_DEANIMATE] = "last";
4193 csp->http->path = strdup_or_die("/");
4194 csp->http->host = strdup_or_die("fuzz.example.org");
4195 csp->http->hostport = strdup_or_die("fuzz.example.org:80");
4196 /* Prevent client socket monitoring */
4197 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
4198 csp->flags |= CSP_FLAG_CHUNKED;
4200 csp->config->feature_flags |= RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
4201 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
4203 csp->content_type |= CT_DECLARED|CT_GIF;
4205 csp->config->socket_timeout = 0;
4207 cgi_init_error_messages();
4209 handle_established_connection(csp);
4210 freez(csp->receive_buffer);
4217 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4218 /*********************************************************************
4220 * Function : prepare_csp_for_next_request
4222 * Description : Put the csp in a mostly vergin state.
4225 * 1 : csp = Current client state (buffers, headers, etc...)
4229 *********************************************************************/
4230 static void prepare_csp_for_next_request(struct client_state *csp)
4232 csp->content_type = 0;
4233 csp->content_length = 0;
4234 csp->expected_content_length = 0;
4235 csp->expected_client_content_length = 0;
4236 list_remove_all(csp->headers);
4237 clear_iob(csp->iob);
4238 freez(csp->error_message);
4239 free_http_request(csp->http);
4240 destroy_list(csp->headers);
4241 #ifdef FEATURE_HTTPS_INSPECTION
4242 destroy_list(csp->https_headers);
4244 destroy_list(csp->tags);
4245 #ifdef FEATURE_CLIENT_TAGS
4246 destroy_list(csp->client_tags);
4247 freez(csp->client_address);
4249 free_current_action(csp->action);
4250 if (NULL != csp->fwd)
4252 unload_forward_spec(csp->fwd);
4255 /* XXX: Store per-connection flags someplace else. */
4256 csp->flags = (CSP_FLAG_ACTIVE | CSP_FLAG_REUSED_CLIENT_CONNECTION);
4257 #ifdef FEATURE_TOGGLE
4258 if (global_toggle_state)
4259 #endif /* def FEATURE_TOGGLE */
4261 csp->flags |= CSP_FLAG_TOGGLED_ON;
4264 if (csp->client_iob->eod > csp->client_iob->cur)
4266 long bytes_to_shift = csp->client_iob->cur - csp->client_iob->buf;
4267 size_t data_length = (size_t)(csp->client_iob->eod - csp->client_iob->cur);
4269 assert(bytes_to_shift > 0);
4270 assert(data_length > 0);
4272 log_error(LOG_LEVEL_CONNECT, "Shifting %lu pipelined bytes by %ld bytes",
4273 data_length, bytes_to_shift);
4274 memmove(csp->client_iob->buf, csp->client_iob->cur, data_length);
4275 csp->client_iob->cur = csp->client_iob->buf;
4276 assert(csp->client_iob->eod == csp->client_iob->buf + bytes_to_shift + data_length);
4277 csp->client_iob->eod = csp->client_iob->buf + data_length;
4278 memset(csp->client_iob->eod, '\0', (size_t)bytes_to_shift);
4280 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
4285 * We mainly care about resetting client_iob->cur so we don't
4286 * waste buffer space at the beginning and don't mess up the
4287 * request restoration done by cgi_show_request().
4289 * Freeing the buffer itself isn't technically necessary,
4290 * but makes debugging more convenient.
4292 clear_iob(csp->client_iob);
4295 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4298 /*********************************************************************
4302 * Description : This is little more than chat. We only "serve" to
4303 * to close (or remember) any socket that chat may have
4307 * 1 : csp = Current client state (buffers, headers, etc...)
4311 *********************************************************************/
4312 static void serve(struct client_state *csp)
4314 int config_file_change_detected = 0; /* Only used for debugging */
4315 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4316 #ifdef FEATURE_CONNECTION_SHARING
4317 static int monitor_thread_running = 0;
4318 #endif /* def FEATURE_CONNECTION_SHARING */
4319 int continue_chatting = 0;
4321 log_error(LOG_LEVEL_CONNECT, "Accepted connection from %s on socket %d",
4322 csp->ip_addr_str, csp->cfd);
4326 unsigned int latency;
4328 #ifdef FEATURE_HTTPS_INSPECTION
4329 if (continue_chatting && client_use_ssl(csp))
4331 continue_https_chat(csp);
4340 * If the request has been crunched,
4341 * the calculated latency is zero.
4343 latency = (unsigned)(csp->server_connection.response_received -
4344 csp->server_connection.request_sent) / 2;
4346 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4347 && (csp->flags & CSP_FLAG_CRUNCHED)
4348 && (csp->expected_client_content_length != 0))
4350 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
4351 log_error(LOG_LEVEL_CONNECT,
4352 "Tainting client socket %d due to unread data.", csp->cfd);
4355 continue_chatting = (csp->config->feature_flags
4356 & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
4357 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
4358 && (csp->cfd != JB_INVALID_SOCKET)
4359 && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4360 && ((csp->flags & CSP_FLAG_SERVER_CONTENT_LENGTH_SET)
4361 || (csp->flags & CSP_FLAG_CHUNKED));
4363 if (!(csp->flags & CSP_FLAG_CRUNCHED)
4364 && (csp->server_connection.sfd != JB_INVALID_SOCKET))
4366 if (!(csp->flags & CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET))
4368 csp->server_connection.keep_alive_timeout = csp->config->default_server_timeout;
4370 if (!(csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
4371 || (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
4372 || !socket_is_still_alive(csp->server_connection.sfd)
4373 || !(latency < csp->server_connection.keep_alive_timeout))
4375 log_error(LOG_LEVEL_CONNECT,
4376 "Closing server socket %d connected to %s. "
4377 "Keep-alive: %u. Tainted: %u. Socket alive: %u. Timeout: %u.",
4378 csp->server_connection.sfd, csp->server_connection.host,
4379 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
4380 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
4381 socket_is_still_alive(csp->server_connection.sfd),
4382 csp->server_connection.keep_alive_timeout);
4383 #ifdef FEATURE_CONNECTION_SHARING
4384 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4386 forget_connection(csp->server_connection.sfd);
4388 #endif /* def FEATURE_CONNECTION_SHARING */
4389 #ifdef FEATURE_HTTPS_INSPECTION
4390 close_server_ssl_connection(csp);
4392 close_socket(csp->server_connection.sfd);
4393 mark_connection_closed(&csp->server_connection);
4397 if (continue_chatting && any_loaded_file_changed(csp))
4399 continue_chatting = 0;
4400 config_file_change_detected = 1;
4402 #ifdef FEATURE_HTTPS_INSPECTION
4403 if (continue_chatting && client_use_ssl(csp) &&
4404 csp->ssl_with_client_is_opened == 0)
4406 continue_chatting = 0;
4407 log_error(LOG_LEVEL_CONNECT, "Client socket %d is no longer usable. "
4408 "The TLS session has been terminated.", csp->cfd);
4412 if (continue_chatting)
4414 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
4415 && socket_is_still_alive(csp->cfd))
4417 log_error(LOG_LEVEL_CONNECT, "Client request %d has been "
4418 "pipelined on socket %d and the socket is still alive.",
4419 csp->requests_received_total+1, csp->cfd);
4420 prepare_csp_for_next_request(csp);
4424 if (0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
4426 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4428 log_error(LOG_LEVEL_CONNECT,
4429 "Waiting for the next client request on socket %d. "
4430 "Keeping the server socket %d to %s open.",
4431 csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
4435 log_error(LOG_LEVEL_CONNECT,
4436 "Waiting for the next client request on socket %d. "
4437 "No server socket to keep open.", csp->cfd);
4441 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4442 && data_is_available(csp->cfd, (int)csp->config->keep_alive_timeout)
4443 && socket_is_still_alive(csp->cfd))
4445 log_error(LOG_LEVEL_CONNECT,
4446 "Data arrived in time on client socket %d. Requests so far: %u",
4447 csp->cfd, csp->requests_received_total);
4448 prepare_csp_for_next_request(csp);
4452 #ifdef FEATURE_CONNECTION_SHARING
4453 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4454 && (csp->server_connection.sfd != JB_INVALID_SOCKET)
4455 && (socket_is_still_alive(csp->server_connection.sfd))
4456 #ifdef FEATURE_HTTPS_INSPECTION
4457 && !server_use_ssl(csp)
4461 time_t time_open = time(NULL) - csp->server_connection.timestamp;
4463 if (csp->server_connection.keep_alive_timeout < time_open - (time_t)latency)
4468 remember_connection(&csp->server_connection);
4469 csp->server_connection.sfd = JB_INVALID_SOCKET;
4470 drain_and_close_socket(csp->cfd);
4471 csp->cfd = JB_INVALID_SOCKET;
4472 privoxy_mutex_lock(&connection_reuse_mutex);
4473 if (!monitor_thread_running)
4475 monitor_thread_running = 1;
4476 privoxy_mutex_unlock(&connection_reuse_mutex);
4477 wait_for_alive_connections();
4478 privoxy_mutex_lock(&connection_reuse_mutex);
4479 monitor_thread_running = 0;
4481 privoxy_mutex_unlock(&connection_reuse_mutex);
4483 #endif /* def FEATURE_CONNECTION_SHARING */
4487 else if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4489 log_error(LOG_LEVEL_CONNECT,
4490 "Closing server socket %d connected to %s. Keep-alive: %u. "
4491 "Tainted: %u. Socket alive: %u. Timeout: %u. "
4492 "Configuration file change detected: %u",
4493 csp->server_connection.sfd, csp->server_connection.host,
4494 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
4495 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
4496 socket_is_still_alive(csp->server_connection.sfd),
4497 csp->server_connection.keep_alive_timeout,
4498 config_file_change_detected);
4500 } while (continue_chatting);
4504 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4506 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4508 #ifdef FEATURE_CONNECTION_SHARING
4509 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4511 forget_connection(csp->server_connection.sfd);
4513 #endif /* def FEATURE_CONNECTION_SHARING */
4515 #ifdef FEATURE_HTTPS_INSPECTION
4516 close_server_ssl_connection(csp);
4517 #endif /* def FEATURE_HTTPS_INSPECTION */
4519 close_socket(csp->server_connection.sfd);
4522 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4523 mark_connection_closed(&csp->server_connection);
4526 if (csp->cfd != JB_INVALID_SOCKET)
4528 log_error(LOG_LEVEL_CONNECT, "Closing client socket %d. "
4529 "Keep-alive: %u. Socket alive: %u. Data available: %u. "
4530 "Configuration file change detected: %u. Requests received: %u.",
4531 csp->cfd, 0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE),
4532 socket_is_still_alive(csp->cfd), data_is_available(csp->cfd, 0),
4533 config_file_change_detected, csp->requests_received_total);
4534 #ifdef FEATURE_HTTPS_INSPECTION
4535 close_client_ssl_connection(csp);
4537 drain_and_close_socket(csp->cfd);
4540 free_csp_resources(csp);
4542 csp->flags &= ~CSP_FLAG_ACTIVE;
4548 /*********************************************************************
4550 * Function : server_thread
4552 * Description : We only exist to call `serve' in a threaded environment.
4555 * 1 : data = Current client state (buffers, headers, etc...)
4557 * Returns : Always 0.
4559 *********************************************************************/
4560 static int32 server_thread(void *data)
4562 serve((struct client_state *) data);
4569 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
4570 /*********************************************************************
4574 * Description : Print usage info & exit.
4576 * Parameters : Pointer to argv[0] for identifying ourselves
4580 *********************************************************************/
4581 static void usage(const char *name)
4583 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
4584 "Usage: %s [--config-test] "
4587 #endif /* defined(unix) */
4590 "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
4591 #endif /* defined(unix) */
4592 "[--version] [configfile]\n",
4596 show_fuzz_usage(name);
4599 printf("Aborting\n");
4604 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
4607 #ifdef MUTEX_LOCKS_AVAILABLE
4608 /*********************************************************************
4610 * Function : privoxy_mutex_lock
4612 * Description : Locks a mutex.
4615 * 1 : mutex = The mutex to lock.
4617 * Returns : Void. May exit in case of errors.
4619 *********************************************************************/
4620 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
4622 #ifdef FEATURE_PTHREAD
4623 int err = pthread_mutex_lock(mutex);
4626 if (mutex != &log_mutex)
4628 log_error(LOG_LEVEL_FATAL,
4629 "Mutex locking failed: %s.\n", strerror(err));
4634 EnterCriticalSection(mutex);
4635 #endif /* def FEATURE_PTHREAD */
4639 /*********************************************************************
4641 * Function : privoxy_mutex_unlock
4643 * Description : Unlocks a mutex.
4646 * 1 : mutex = The mutex to unlock.
4648 * Returns : Void. May exit in case of errors.
4650 *********************************************************************/
4651 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
4653 #ifdef FEATURE_PTHREAD
4654 int err = pthread_mutex_unlock(mutex);
4657 if (mutex != &log_mutex)
4659 log_error(LOG_LEVEL_FATAL,
4660 "Mutex unlocking failed: %s.\n", strerror(err));
4665 LeaveCriticalSection(mutex);
4666 #endif /* def FEATURE_PTHREAD */
4670 /*********************************************************************
4672 * Function : privoxy_mutex_init
4674 * Description : Prepares a mutex.
4677 * 1 : mutex = The mutex to initialize.
4679 * Returns : Void. May exit in case of errors.
4681 *********************************************************************/
4682 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
4684 #ifdef FEATURE_PTHREAD
4685 int err = pthread_mutex_init(mutex, 0);
4688 printf("Fatal error. Mutex initialization failed: %s.\n",
4693 InitializeCriticalSection(mutex);
4694 #endif /* def FEATURE_PTHREAD */
4696 #endif /* def MUTEX_LOCKS_AVAILABLE */
4698 /*********************************************************************
4700 * Function : initialize_mutexes
4702 * Description : Prepares mutexes if mutex support is available.
4706 * Returns : Void, exits in case of errors.
4708 *********************************************************************/
4709 static void initialize_mutexes(void)
4711 #ifdef MUTEX_LOCKS_AVAILABLE
4713 * Prepare global mutex semaphores
4716 #ifdef FEATURE_HTTPS_INSPECTION
4717 privoxy_mutex_init(&certificate_mutex);
4718 privoxy_mutex_init(&ssl_init_mutex);
4721 privoxy_mutex_init(&log_mutex);
4722 privoxy_mutex_init(&log_init_mutex);
4723 privoxy_mutex_init(&connection_reuse_mutex);
4724 #ifdef FEATURE_EXTERNAL_FILTERS
4725 privoxy_mutex_init(&external_filter_mutex);
4727 #ifdef FEATURE_CLIENT_TAGS
4728 privoxy_mutex_init(&client_tags_mutex);
4730 #ifdef FEATURE_EXTENDED_STATISTICS
4731 privoxy_mutex_init(&filter_statistics_mutex);
4732 privoxy_mutex_init(&block_statistics_mutex);
4736 * XXX: The assumptions below are a bit naive
4737 * and can cause locks that aren't necessary.
4739 * For example older FreeBSD versions (< 6.x?)
4740 * have no gethostbyname_r, but gethostbyname is
4743 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
4744 privoxy_mutex_init(&resolver_mutex);
4745 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
4747 * XXX: should we use a single mutex for
4748 * localtime() and gmtime() as well?
4750 #ifndef HAVE_GMTIME_R
4751 privoxy_mutex_init(&gmtime_mutex);
4752 #endif /* ndef HAVE_GMTIME_R */
4754 #ifndef HAVE_LOCALTIME_R
4755 privoxy_mutex_init(&localtime_mutex);
4756 #endif /* ndef HAVE_GMTIME_R */
4758 #if !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM)
4759 privoxy_mutex_init(&rand_mutex);
4760 #endif /* !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM) */
4762 #endif /* def MUTEX_LOCKS_AVAILABLE */
4765 /*********************************************************************
4769 * Description : Load the config file and start the listen loop.
4770 * This function is a lot more *sane* with the `load_config'
4771 * and `listen_loop' functions; although it stills does
4772 * a *little* too much for my taste.
4775 * 1 : argc = Number of parameters (including $0).
4776 * 2 : argv = Array of (char *)'s to the parameters.
4778 * Returns : 1 if : can't open config file, unrecognized directive,
4779 * stats requested in multi-thread mode, can't open the
4780 * log file, can't open the jar file, listen port is invalid,
4781 * any load fails, and can't bind port.
4783 * Else main never returns, the process must be signaled
4784 * to terminate execution. Or, on Windows, use the
4785 * "File", "Exit" menu option.
4787 *********************************************************************/
4789 int real_main(int argc, char **argv)
4791 int main(int argc, char **argv)
4795 int do_config_test = 0;
4796 #ifndef HAVE_ARC4RANDOM
4797 unsigned int random_seed;
4800 struct passwd *pw = NULL;
4801 struct group *grp = NULL;
4803 char *pre_chroot_nslookup_to_load_resolver = NULL;
4806 char *fuzz_input_type = NULL;
4807 char *fuzz_input_file = NULL;
4814 #if !defined(_WIN32)
4821 /* Prepare mutexes if supported and necessary. */
4822 initialize_mutexes();
4824 /* Enable logging until further notice. */
4828 * Parse the command line arguments
4830 * XXX: simply printing usage information in case of
4831 * invalid arguments isn't particularly user friendly.
4833 while (++argc_pos < argc)
4836 /* Check to see if the service must be installed or uninstalled */
4837 if (strncmp(argv[argc_pos], "--install", 9) == 0)
4839 const char *pName = argv[argc_pos] + 9;
4842 exit((install_service(pName)) ? 0 : 1);
4844 else if (strncmp(argv[argc_pos], "--uninstall", 11) == 0)
4846 const char *pName = argv[argc_pos] + 11;
4849 exit((uninstall_service(pName)) ? 0 : 1);
4851 else if (strcmp(argv[argc_pos], "--service") == 0)
4853 bRunAsService = TRUE;
4854 w32_set_service_cwd();
4855 atexit(w32_service_exit_notify);
4858 #endif /* defined(_WIN32) */
4861 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
4863 if (strcmp(argv[argc_pos], "--help") == 0)
4868 else if (strcmp(argv[argc_pos], "--version") == 0)
4870 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
4876 else if (strcmp(argv[argc_pos], "--no-daemon") == 0)
4878 set_debug_level(LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
4882 else if (strcmp(argv[argc_pos], "--pidfile") == 0)
4884 if (++argc_pos == argc) usage(argv[0]);
4885 pidfile = strdup_or_die(argv[argc_pos]);
4888 else if (strcmp(argv[argc_pos], "--user") == 0)
4893 if (++argc_pos == argc) usage(argv[argc_pos]);
4895 user_arg = strdup_or_die(argv[argc_pos]);
4896 group_name = strchr(user_arg, '.');
4897 if (NULL != group_name)
4899 /* Nul-terminate the user name */
4902 /* Skip the former delimiter to actually reach the group name */
4905 grp = getgrnam(group_name);
4908 log_error(LOG_LEVEL_FATAL, "Group '%s' not found.", group_name);
4911 pw = getpwnam(user_arg);
4914 log_error(LOG_LEVEL_FATAL, "User '%s' not found.", user_arg);
4920 else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup") == 0)
4922 if (++argc_pos == argc) usage(argv[0]);
4923 pre_chroot_nslookup_to_load_resolver = strdup_or_die(argv[argc_pos]);
4926 else if (strcmp(argv[argc_pos], "--chroot") == 0)
4930 #endif /* defined(unix) */
4932 else if (strcmp(argv[argc_pos], "--config-test") == 0)
4937 else if (strcmp(argv[argc_pos], "--fuzz") == 0)
4940 if (argc < argc_pos + 2) usage(argv[0]);
4941 fuzz_input_type = argv[argc_pos];
4943 fuzz_input_file = argv[argc_pos];
4945 else if (strcmp(argv[argc_pos], "--stfu") == 0)
4947 set_debug_level(LOG_LEVEL_STFU);
4950 else if (argc_pos + 1 != argc)
4953 * This is neither the last command line
4954 * option, nor was it recognized before,
4955 * therefore it must be invalid.
4961 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
4963 configfile = argv[argc_pos];
4966 } /* -END- while (more arguments) */
4968 show_version(Argv[0]);
4971 if (*configfile != '/')
4973 char cwd[BUFFER_SIZE];
4975 size_t abs_file_size;
4977 /* make config-filename absolute here */
4978 if (NULL == getcwd(cwd, sizeof(cwd)))
4980 perror("failed to get current working directory");
4984 basedir = strdup_or_die(cwd);
4986 abs_file_size = strlen(cwd) + strlen(configfile) + 5;
4987 abs_file = malloc_or_die(abs_file_size);
4988 strlcpy(abs_file, basedir, abs_file_size);
4989 strlcat(abs_file, "/", abs_file_size);
4990 strlcat(abs_file, configfile, abs_file_size);
4991 configfile = abs_file;
4993 #endif /* defined unix */
4997 clients->next = NULL;
4999 /* XXX: factor out initialising after the next stable release. */
5004 #ifndef HAVE_ARC4RANDOM
5005 random_seed = (unsigned int)time(NULL);
5007 srandom(random_seed);
5010 #endif /* ifdef HAVE_RANDOM */
5011 #endif /* ifndef HAVE_ARC4RANDOM */
5014 * Unix signal handling
5016 * Catch the abort, interrupt and terminate signals for a graceful exit
5017 * Catch the hangup signal so the errlog can be reopened.
5019 * Ignore the broken pipe signal as connection failures
5020 * are handled when and where they occur without relying
5023 #if !defined(_WIN32)
5026 const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP };
5028 for (idx = 0; idx < SZ(catched_signals); idx++)
5030 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
5031 if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
5033 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
5034 #endif /* ifdef sun */
5036 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
5040 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
5042 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for SIGPIPE: %E");
5046 #else /* ifdef _WIN32 */
5047 # ifdef _WIN_CONSOLE
5049 * We *are* in a windows console app.
5050 * Print a verbose messages about FAQ's and such
5052 printf("%s", win32_blurb);
5053 # endif /* def _WIN_CONSOLE */
5054 #endif /* def _WIN32 */
5057 if (fuzz_input_type != NULL)
5059 exit(process_fuzzed_input(fuzz_input_type, fuzz_input_file));
5061 log_error(LOG_LEVEL_FATAL,
5062 "When compiled with fuzzing support, Privoxy should only be used for fuzzing. "
5063 "Various data structures are static which is unsafe when using threads.");
5068 exit(NULL == load_config());
5071 /* Initialize the CGI subsystem */
5072 cgi_init_error_messages();
5075 * If running on unix and without the --no-daemon
5076 * option, become a daemon. I.e. fork, detach
5077 * from tty and get process group leadership
5086 if (pid < 0) /* error */
5091 else if (pid != 0) /* parent */
5096 * must check for errors
5097 * child died due to missing files aso
5100 wpid = waitpid(pid, &status, WNOHANG);
5112 * stderr (fd 2) will be closed later on,
5113 * when the config file has been parsed.
5119 * Reserve fd 0 and 1 to prevent abort() and friends
5120 * from sending stuff to the clients or servers.
5122 fd = open("/dev/null", O_RDONLY);
5125 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
5129 if (dup2(fd, 0) == -1)
5131 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 0: %E");
5135 fd = open("/dev/null", O_WRONLY);
5138 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
5142 if (dup2(fd, 1) == -1)
5144 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 1: %E");
5149 #ifdef FEATURE_EXTERNAL_FILTERS
5150 for (fd = 0; fd < 3; fd++)
5152 mark_socket_for_close_on_execute(fd);
5158 } /* -END- if (daemon_mode) */
5161 * As soon as we have written the PID file, we can switch
5162 * to the user and group ID indicated by the --user option
5164 if (pidfile != NULL)
5166 write_pid_file(pidfile);
5170 if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
5172 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
5176 if (setgroups(1, &grp->gr_gid))
5178 log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
5181 else if (initgroups(pw->pw_name, pw->pw_gid))
5183 log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
5189 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
5191 /* Read the time zone file from /etc before doing chroot. */
5193 if (NULL != pre_chroot_nslookup_to_load_resolver
5194 && '\0' != pre_chroot_nslookup_to_load_resolver[0])
5196 /* Initialize resolver library. */
5197 (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
5199 if (chroot(pw->pw_dir) < 0)
5201 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
5205 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
5208 if (setuid(pw->pw_uid))
5210 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
5214 char putenv_dummy[64];
5216 strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
5217 if (putenv(putenv_dummy) != 0)
5219 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
5222 snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
5223 if (putenv(putenv_dummy) != 0)
5225 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
5231 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
5234 #endif /* defined unix */
5237 /* This will be FALSE unless the command line specified --service
5241 /* Yup, so now we must attempt to establish a connection
5242 * with the service dispatcher. This will only work if this
5243 * process was launched by the service control manager to
5244 * actually run as a service. If this isn't the case, i've
5245 * known it take around 30 seconds or so for the call to return.
5248 /* The StartServiceCtrlDispatcher won't return until the service is stopping */
5249 if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
5251 /* Service has run, and at this point is now being stopped, so just return */
5256 printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
5258 /* An error occurred. Usually it's because --service was wrongly specified
5259 * and we were unable to connect to the Service Control Dispatcher because
5260 * it wasn't expecting us and is therefore not listening.
5262 * For now, just continue below to call the listen_loop function.
5265 #endif /* def _WIN32 */
5275 /*********************************************************************
5277 * Function : bind_port_helper
5279 * Description : Bind the listen port. Handles logging, and aborts
5283 * 1 : haddr = Host address to bind to. Use NULL to bind to
5285 * 2 : hport = Specifies port to bind to.
5286 * 3 : backlog = Listen backlog.
5288 * Returns : Port that was opened.
5290 *********************************************************************/
5291 static jb_socket bind_port_helper(const char *haddr, int hport, int backlog)
5296 result = bind_port(haddr, hport, backlog, &bfd);
5300 const char *bind_address = (NULL != haddr) ? haddr : "INADDR_ANY";
5304 log_error(LOG_LEVEL_FATAL,
5305 "can't bind to %s:%d: There may be another Privoxy "
5306 "or some other proxy running on port %d",
5307 bind_address, hport, hport);
5310 log_error(LOG_LEVEL_FATAL,
5311 "can't bind to %s:%d: The hostname is not resolvable",
5312 bind_address, hport);
5315 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: %E",
5316 bind_address, hport);
5319 /* shouldn't get here */
5320 return JB_INVALID_SOCKET;
5325 if (bfd >= FD_SETSIZE)
5327 log_error(LOG_LEVEL_FATAL,
5328 "Bind socket number too high to use select(): %d >= %d",
5336 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
5341 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
5349 /*********************************************************************
5351 * Function : bind_ports_helper
5353 * Description : Bind the listen ports. Handles logging, and aborts
5357 * 1 : config = Privoxy configuration. Specifies ports
5359 * 2 : sockets = Preallocated array of opened sockets
5360 * corresponding to specification in config.
5361 * All non-opened sockets will be set to
5362 * JB_INVALID_SOCKET.
5364 * Returns : Nothing. Inspect sockets argument.
5366 *********************************************************************/
5367 static void bind_ports_helper(struct configuration_spec * config,
5368 jb_socket sockets[])
5372 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
5374 if (config->hport[i])
5376 sockets[i] = bind_port_helper(config->haddr[i],
5377 config->hport[i], config->listen_backlog);
5378 #if defined(FEATURE_ACCEPT_FILTER) && defined(SO_ACCEPTFILTER)
5379 if (config->enable_accept_filter && sockets[i] != JB_INVALID_SOCKET)
5381 struct accept_filter_arg af_options;
5382 bzero(&af_options, sizeof(af_options));
5383 strlcpy(af_options.af_name, "httpready", sizeof(af_options.af_name));
5384 if (setsockopt(sockets[i], SOL_SOCKET, SO_ACCEPTFILTER, &af_options,
5385 sizeof(af_options)))
5387 log_error(LOG_LEVEL_ERROR,
5388 "Enabling accept filter for socket %d failed: %E", sockets[i]);
5395 sockets[i] = JB_INVALID_SOCKET;
5398 config->need_bind = 0;
5402 /*********************************************************************
5404 * Function : close_ports_helper
5406 * Description : Close listenings ports.
5409 * 1 : sockets = Array of opened and non-opened sockets to
5410 * close. All sockets will be set to
5411 * JB_INVALID_SOCKET.
5413 * Returns : Nothing.
5415 *********************************************************************/
5416 static void close_ports_helper(jb_socket sockets[])
5420 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
5422 if (JB_INVALID_SOCKET != sockets[i])
5424 close_socket(sockets[i]);
5426 sockets[i] = JB_INVALID_SOCKET;
5432 /* Without this simple workaround we get this compiler warning from _beginthread
5433 * warning C4028: formal parameter 1 different from declaration
5435 void w32_service_listen_loop(void *p)
5439 #endif /* def _WIN32 */
5442 /*********************************************************************
5444 * Function : listen_loop
5446 * Description : bind the listen port and enter a "FOREVER" listening loop.
5452 *********************************************************************/
5453 static void listen_loop(void)
5455 struct client_states *csp_list = NULL;
5456 struct client_state *csp = NULL;
5457 jb_socket bfds[MAX_LISTENING_SOCKETS];
5458 struct configuration_spec *config;
5459 unsigned int active_threads = 0;
5460 #if defined(FEATURE_PTHREAD)
5461 pthread_attr_t attrs;
5463 pthread_attr_init(&attrs);
5464 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
5467 config = load_config();
5469 #ifdef FEATURE_CONNECTION_SHARING
5471 * XXX: Should be relocated once it no
5472 * longer needs to emit log messages.
5474 initialize_reusable_connections();
5475 #endif /* def FEATURE_CONNECTION_SHARING */
5477 bind_ports_helper(config, bfds);
5479 #ifdef FEATURE_GRACEFUL_TERMINATION
5480 while (!g_terminate)
5485 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__)
5486 while (waitpid(-1, NULL, WNOHANG) > 0)
5488 /* zombie children */
5490 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) */
5493 * Free data that was used by died threads
5495 active_threads = sweep();
5499 * Re-open the errlog after HUP signal
5501 if (received_hup_signal)
5503 if (NULL != config->logfile)
5505 init_error_log(Argv[0], config->logfile);
5507 received_hup_signal = 0;
5511 csp_list = zalloc_or_die(sizeof(*csp_list));
5512 csp = &csp_list->csp;
5514 log_error(LOG_LEVEL_CONNECT,
5515 "Waiting for the next client connection. Currently active threads: %u",
5519 * This config may be outdated, but for accept_connection()
5520 * it's fresh enough.
5522 csp->config = config;
5524 if (!accept_connection(csp, bfds))
5526 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
5531 csp->flags |= CSP_FLAG_ACTIVE;
5532 csp->server_connection.sfd = JB_INVALID_SOCKET;
5534 csp->config = config = load_config();
5536 if (config->need_bind)
5539 * Since we were listening to the "old port", we will not see
5540 * a "listen" param change until the next request. So, at
5541 * least 1 more request must be made for us to find the new
5542 * setting. I am simply closing the old socket and binding the
5545 * Which-ever is correct, we will serve 1 more page via the
5546 * old settings. This should probably be a "show-status"
5547 * request. This should not be a so common of an operation
5548 * that this will hurt people's feelings.
5551 close_ports_helper(bfds);
5553 bind_ports_helper(config, bfds);
5556 #ifdef FEATURE_TOGGLE
5557 if (global_toggle_state)
5558 #endif /* def FEATURE_TOGGLE */
5560 csp->flags |= CSP_FLAG_TOGGLED_ON;
5563 if (run_loader(csp))
5565 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
5566 /* Never get here - LOG_LEVEL_FATAL causes program exit */
5570 if (block_acl(NULL,csp))
5572 log_error(LOG_LEVEL_CONNECT,
5573 "Connection from %s on %s (socket %d) dropped due to ACL",
5574 csp->ip_addr_str, csp->listen_addr_str, csp->cfd);
5575 close_socket(csp->cfd);
5576 freez(csp->ip_addr_str);
5577 freez(csp->listen_addr_str);
5581 #endif /* def FEATURE_ACL */
5583 if ((0 != config->max_client_connections)
5584 && (active_threads >= config->max_client_connections))
5586 log_error(LOG_LEVEL_CONNECT,
5587 "Rejecting connection from %s. Maximum number of connections reached.",
5589 write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
5590 strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
5591 close_socket(csp->cfd);
5592 freez(csp->ip_addr_str);
5593 freez(csp->listen_addr_str);
5598 /* add it to the list of clients */
5599 csp_list->next = clients->next;
5600 clients->next = csp_list;
5602 if (config->multi_threaded)
5606 /* this is a switch () statement in the C preprocessor - ugh */
5607 #undef SELECTED_ONE_OPTION
5609 /* Use Pthreads in preference to native code */
5610 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
5611 #define SELECTED_ONE_OPTION
5613 pthread_t the_thread;
5616 ret = pthread_create(&the_thread, &attrs,
5617 (void * (*)(void *))serve, csp);
5618 child_id = ret ? -1 : 0;
5622 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
5623 #define SELECTED_ONE_OPTION
5624 child_id = _beginthread(
5625 (void (*)(void *))serve,
5630 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
5631 #define SELECTED_ONE_OPTION
5633 thread_id tid = spawn_thread
5634 (server_thread, "server", B_NORMAL_PRIORITY, csp);
5636 if ((tid >= 0) && (resume_thread(tid) == B_OK))
5638 child_id = (int) tid;
5647 #if !defined(SELECTED_ONE_OPTION)
5650 /* This block is only needed when using fork().
5651 * When using threads, the server thread was
5652 * created and run by the call to _beginthread().
5654 if (child_id == 0) /* child */
5657 #ifdef FEATURE_TOGGLE
5658 int inherited_toggle_state = global_toggle_state;
5659 #endif /* def FEATURE_TOGGLE */
5664 * If we've been toggled or we've blocked the request, tell Mom
5667 #ifdef FEATURE_TOGGLE
5668 if (inherited_toggle_state != global_toggle_state)
5670 rc |= RC_FLAG_TOGGLED;
5672 #endif /* def FEATURE_TOGGLE */
5674 #ifdef FEATURE_STATISTICS
5675 if (csp->flags & CSP_FLAG_REJECTED)
5677 rc |= RC_FLAG_BLOCKED;
5679 #endif /* ndef FEATURE_STATISTICS */
5683 else if (child_id > 0) /* parent */
5685 /* in a fork()'d environment, the parent's
5686 * copy of the client socket and the CSP
5690 #if !defined(_WIN32) && !defined(__CYGWIN__)
5692 wait(&child_status);
5695 * Evaluate child's return code: If the child has
5696 * - been toggled, toggle ourselves
5697 * - blocked its request, bump up the stats counter
5700 #ifdef FEATURE_TOGGLE
5701 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
5703 global_toggle_state = !global_toggle_state;
5705 #endif /* def FEATURE_TOGGLE */
5707 #ifdef FEATURE_STATISTICS
5709 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
5713 #endif /* def FEATURE_STATISTICS */
5715 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
5716 close_socket(csp->cfd);
5717 csp->flags &= ~CSP_FLAG_ACTIVE;
5721 #undef SELECTED_ONE_OPTION
5722 /* end of cpp switch () */
5727 * Spawning the child failed, assume it's because
5728 * there are too many children running already.
5729 * XXX: If you assume ...
5731 log_error(LOG_LEVEL_ERROR,
5732 "Unable to take any additional connections: %E. Active threads: %u",
5734 write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
5735 strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
5736 close_socket(csp->cfd);
5737 csp->flags &= ~CSP_FLAG_ACTIVE;
5746 #if defined(FEATURE_PTHREAD)
5747 pthread_attr_destroy(&attrs);
5750 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
5752 #ifdef FEATURE_HTTPS_INSPECTION
5753 /* Clean up. Aim: free all memory (no leaks) */
5757 #ifdef FEATURE_GRACEFUL_TERMINATION
5759 log_error(LOG_LEVEL_INFO, "Graceful termination requested");
5761 unload_current_config_file();
5762 unload_current_actions_file();
5763 unload_current_re_filterfile();
5764 #ifdef FEATURE_TRUST
5765 unload_current_trust_file();
5768 if (config->multi_threaded)
5775 } while ((clients->next != NULL) && (--i > 0));
5779 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
5789 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
5790 /* Cleanup - remove taskbar icon etc. */
5795 #endif /* FEATURE_GRACEFUL_TERMINATION */