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;
1180 if (NULL != fwd->forward_host)
1182 server_connection->forward_host = strdup_or_die(fwd->forward_host);
1186 server_connection->forward_host = NULL;
1188 server_connection->forward_port = fwd->forward_port;
1190 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1193 /*********************************************************************
1195 * Function : verify_request_length
1197 * Description : Checks if we already got the whole client requests
1198 * and sets CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ if
1201 * Data that doesn't belong to the current request is
1202 * either thrown away to let the client retry on a clean
1203 * socket, or stashed to be dealt with after the current
1204 * request is served.
1207 * 1 : csp = Current client state (buffers, headers, etc...)
1211 *********************************************************************/
1212 static void verify_request_length(struct client_state *csp)
1214 unsigned long long buffered_request_bytes =
1215 (unsigned long long)(csp->client_iob->eod - csp->client_iob->cur);
1217 if ((csp->expected_client_content_length != 0)
1218 && (buffered_request_bytes != 0))
1220 if (csp->expected_client_content_length >= buffered_request_bytes)
1222 csp->expected_client_content_length -= buffered_request_bytes;
1223 log_error(LOG_LEVEL_CONNECT, "Reduced expected bytes to %llu "
1224 "to account for the %llu ones we already got.",
1225 csp->expected_client_content_length, buffered_request_bytes);
1229 assert(csp->client_iob->eod > csp->client_iob->cur + csp->expected_client_content_length);
1230 csp->client_iob->eod = csp->client_iob->cur + csp->expected_client_content_length;
1231 log_error(LOG_LEVEL_CONNECT, "Reducing expected bytes to 0. "
1232 "Marking the server socket tainted after throwing %llu bytes away.",
1233 buffered_request_bytes - csp->expected_client_content_length);
1234 csp->expected_client_content_length = 0;
1235 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1238 if (csp->expected_client_content_length == 0)
1240 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1244 if (!(csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ)
1245 && ((csp->client_iob->cur < csp->client_iob->eod)
1246 || (csp->expected_client_content_length != 0)))
1248 if (strcmpic(csp->http->gpc, "GET")
1249 && strcmpic(csp->http->gpc, "HEAD")
1250 && strcmpic(csp->http->gpc, "TRACE")
1251 && strcmpic(csp->http->gpc, "OPTIONS")
1252 && strcmpic(csp->http->gpc, "DELETE"))
1254 /* XXX: this is an incomplete hack */
1255 csp->flags &= ~CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1256 log_error(LOG_LEVEL_CONNECT, "There better be a request body.");
1260 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1262 if ((csp->config->feature_flags & RUNTIME_FEATURE_TOLERATE_PIPELINING) == 0)
1264 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1265 log_error(LOG_LEVEL_CONNECT,
1266 "Possible pipeline attempt detected. The connection will not "
1267 "be kept alive and we will only serve the first request.");
1268 /* Nuke the pipelined requests from orbit, just to be sure. */
1269 clear_iob(csp->client_iob);
1274 * Keep the pipelined data around for now, we'll deal with
1275 * it once we're done serving the current request.
1277 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
1278 assert(csp->client_iob->eod >= csp->client_iob->cur);
1279 log_error(LOG_LEVEL_CONNECT, "Complete client request followed by "
1280 "%d bytes of pipelined data received.",
1281 (int)(csp->client_iob->eod - csp->client_iob->cur));
1287 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1288 log_error(LOG_LEVEL_CONNECT, "Complete client request received.");
1293 /*********************************************************************
1295 * Function : mark_server_socket_tainted
1297 * Description : Makes sure we don't reuse a server socket
1298 * (if we didn't read everything the server sent
1299 * us reusing the socket would lead to garbage).
1302 * 1 : csp = Current client state (buffers, headers, etc...)
1306 *********************************************************************/
1307 static void mark_server_socket_tainted(struct client_state *csp)
1310 * For consistency we always mark the server socket
1311 * tainted, however, to reduce the log noise we only
1312 * emit a log message if the server socket could have
1313 * actually been reused.
1315 if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
1316 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED))
1318 log_error(LOG_LEVEL_CONNECT,
1319 "Marking the server socket %d tainted.",
1320 csp->server_connection.sfd);
1322 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1325 /*********************************************************************
1327 * Function : get_request_line
1329 * Description : Read the client request line.
1332 * 1 : csp = Current client state (buffers, headers, etc...)
1334 * Returns : Pointer to request line or NULL in case of errors.
1336 *********************************************************************/
1337 static char *get_request_line(struct client_state *csp)
1339 char buf[BUFFER_SIZE];
1340 char *request_line = NULL;
1343 memset(buf, 0, sizeof(buf));
1345 if ((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
1348 * If there are multiple pipelined requests waiting,
1349 * the flag will be set again once the next request
1352 csp->flags &= ~CSP_FLAG_PIPELINED_REQUEST_WAITING;
1354 request_line = get_header(csp->client_iob);
1355 if ((NULL != request_line) && ('\0' != *request_line))
1357 return request_line;
1361 log_error(LOG_LEVEL_CONNECT, "No complete request line "
1362 "received yet. Continuing reading from %d.", csp->cfd);
1370 0 == (csp->flags & CSP_FLAG_FUZZED_INPUT) &&
1372 !data_is_available(csp->cfd, csp->config->socket_timeout)
1375 if (socket_is_still_alive(csp->cfd))
1377 log_error(LOG_LEVEL_CONNECT,
1378 "No request line on socket %d received in time. Timeout: %d.",
1379 csp->cfd, csp->config->socket_timeout);
1380 write_socket_delayed(csp->cfd, CLIENT_CONNECTION_TIMEOUT_RESPONSE,
1381 strlen(CLIENT_CONNECTION_TIMEOUT_RESPONSE),
1382 get_write_delay(csp));
1386 log_error(LOG_LEVEL_CONNECT,
1387 "The client side of the connection on socket %d got "
1388 "closed without sending a complete request line.", csp->cfd);
1393 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1395 if (len <= 0) return NULL;
1398 * If there is no memory left for buffering the
1399 * request, there is nothing we can do but hang up
1401 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1406 request_line = get_header(csp->client_iob);
1408 } while ((NULL != request_line) && ('\0' == *request_line));
1410 return request_line;
1416 CHUNK_STATUS_MISSING_DATA,
1417 CHUNK_STATUS_BODY_COMPLETE,
1418 CHUNK_STATUS_PARSE_ERROR
1422 /*********************************************************************
1424 * Function : chunked_body_is_complete
1426 * Description : Figures out whether or not a chunked body is complete.
1428 * Currently it always starts at the beginning of the
1429 * buffer which is somewhat wasteful and prevents Privoxy
1430 * from starting to forward the correctly parsed chunks
1431 * as soon as theoretically possible.
1433 * Should be modified to work with a common buffer,
1434 * and allow the caller to skip already parsed chunks.
1436 * This would allow the function to be used for unbuffered
1437 * response bodies as well.
1440 * 1 : iob = Buffer with the body to check.
1441 * 2 : length = Length of complete body
1443 * Returns : Enum with the result of the check.
1445 *********************************************************************/
1446 static enum chunk_status chunked_body_is_complete(struct iob *iob, size_t *length)
1448 unsigned int chunksize;
1454 * We need at least a single digit, followed by "\r\n",
1455 * followed by an unknown amount of data, followed by "\r\n".
1457 if (p + 5 > iob->eod)
1459 return CHUNK_STATUS_MISSING_DATA;
1461 if (sscanf(p, "%x", &chunksize) != 1)
1463 return CHUNK_STATUS_PARSE_ERROR;
1467 * We want at least a single digit, followed by "\r\n",
1468 * followed by the specified amount of data, followed by "\r\n".
1470 if (p + chunksize + 5 > iob->eod)
1472 return CHUNK_STATUS_MISSING_DATA;
1475 /* Skip chunk-size. */
1476 p = strstr(p, "\r\n");
1479 return CHUNK_STATUS_PARSE_ERROR;
1481 /* Move beyond the chunkdata. */
1484 /* There should be another "\r\n" to skip */
1485 if (memcmp(p, "\r\n", 2))
1487 return CHUNK_STATUS_PARSE_ERROR;
1490 } while (chunksize > 0U);
1492 *length = (size_t)(p - iob->cur);
1493 assert(*length <= (size_t)(iob->eod - iob->cur));
1494 assert(p <= iob->eod);
1496 return CHUNK_STATUS_BODY_COMPLETE;
1501 /*********************************************************************
1503 * Function : receive_chunked_client_request_body
1505 * Description : Read the chunk-encoded client request body.
1506 * Failures are dealt with.
1509 * 1 : csp = Current client state (buffers, headers, etc...)
1511 * Returns : JB_ERR_OK or JB_ERR_PARSE
1513 *********************************************************************/
1514 static jb_err receive_chunked_client_request_body(struct client_state *csp)
1517 enum chunk_status status;
1519 while (CHUNK_STATUS_MISSING_DATA ==
1520 (status = chunked_body_is_complete(csp->client_iob, &body_length)))
1522 char buf[BUFFER_SIZE];
1525 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1527 log_error(LOG_LEVEL_ERROR,
1528 "Timeout while waiting for the client body.");
1531 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1534 log_error(LOG_LEVEL_ERROR, "Read the client body failed: %E");
1537 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1542 if (status != CHUNK_STATUS_BODY_COMPLETE)
1544 write_socket_delayed(csp->cfd, CLIENT_BODY_PARSE_ERROR_RESPONSE,
1545 strlen(CLIENT_BODY_PARSE_ERROR_RESPONSE), get_write_delay(csp));
1546 log_error(LOG_LEVEL_CLF,
1547 "%s - - [%T] \"Failed reading chunked client body\" 400 0", csp->ip_addr_str);
1548 return JB_ERR_PARSE;
1550 log_error(LOG_LEVEL_CONNECT,
1551 "Chunked client body completely read. Length: %lu", body_length);
1552 csp->expected_client_content_length = body_length;
1560 /*********************************************************************
1562 * Function : fuzz_chunked_transfer_encoding
1564 * Description : Treat the fuzzed input as chunked transfer encoding
1565 * to check and dechunk.
1568 * 1 : csp = Used to store the data.
1569 * 2 : fuzz_input_file = File to read the input from.
1571 * Returns : Result of dechunking
1573 *********************************************************************/
1574 extern int fuzz_chunked_transfer_encoding(struct client_state *csp, char *fuzz_input_file)
1577 size_t size = (size_t)(csp->iob->eod - csp->iob->cur);
1578 enum chunk_status status;
1580 status = chunked_body_is_complete(csp->iob, &length);
1581 if (CHUNK_STATUS_BODY_COMPLETE != status)
1583 log_error(LOG_LEVEL_INFO, "Chunked body is incomplete or invalid");
1586 return (JB_ERR_OK == remove_chunked_transfer_coding(csp->iob->cur, &size));
1591 /*********************************************************************
1593 * Function : fuzz_client_request
1595 * Description : Try to get a client request from the fuzzed input.
1598 * 1 : csp = Current client state (buffers, headers, etc...)
1599 * 2 : fuzz_input_file = File to read the input from.
1601 * Returns : Result of fuzzing.
1603 *********************************************************************/
1604 extern int fuzz_client_request(struct client_state *csp, char *fuzz_input_file)
1609 csp->ip_addr_str = "fuzzer";
1611 if (strcmp(fuzz_input_file, "-") != 0)
1613 log_error(LOG_LEVEL_FATAL,
1614 "Fuzzed client requests can currently only be read from stdin (-).");
1616 err = receive_client_request(csp);
1617 if (err != JB_ERR_OK)
1621 err = parse_client_request(csp);
1622 if (err != JB_ERR_OK)
1630 #endif /* def FUZZ */
1633 #ifdef FEATURE_FORCE_LOAD
1634 /*********************************************************************
1636 * Function : force_required
1638 * Description : Checks a request line to see if it contains
1639 * the FORCE_PREFIX. If it does, it is removed
1640 * unless enforcing requests has beend disabled.
1643 * 1 : request_line = HTTP request line
1645 * Returns : TRUE if force is required, FALSE otherwise.
1647 *********************************************************************/
1648 static int force_required(const struct client_state *csp, char *request_line)
1652 p = strstr(request_line, "http://");
1656 p += strlen("http://");
1660 /* Intercepted request usually don't specify the protocol. */
1664 /* Go to the beginning of the path */
1669 * If the path is missing the request line is invalid and we
1670 * are done here. The client-visible rejection happens later on.
1675 if (0 == strncmpic(p, FORCE_PREFIX, strlen(FORCE_PREFIX) - 1))
1677 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS))
1679 /* XXX: Should clean more carefully */
1680 strclean(request_line, FORCE_PREFIX);
1681 log_error(LOG_LEVEL_FORCE,
1682 "Enforcing request: \"%s\".", request_line);
1686 log_error(LOG_LEVEL_FORCE,
1687 "Ignored force prefix in request: \"%s\".", request_line);
1693 #endif /* def FEATURE_FORCE_LOAD */
1696 /*********************************************************************
1698 * Function : receive_client_request
1700 * Description : Read the client's request (more precisely the
1701 * client headers) and answer it if necessary.
1704 * 1 : csp = Current client state (buffers, headers, etc...)
1706 * Returns : JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
1708 *********************************************************************/
1709 static jb_err receive_client_request(struct client_state *csp)
1711 char buf[BUFFER_SIZE];
1714 struct http_request *http;
1718 /* Temporary copy of the client's headers before they get enlisted in csp->headers */
1719 struct list header_list;
1720 struct list *headers = &header_list;
1722 /* We don't care if the arriving data is a valid HTTP request or not. */
1723 csp->requests_received_total++;
1727 memset(buf, 0, sizeof(buf));
1729 req = get_request_line(csp);
1732 mark_server_socket_tainted(csp);
1733 return JB_ERR_PARSE;
1735 assert(*req != '\0');
1737 if (client_protocol_is_unsupported(csp, req))
1739 return JB_ERR_PARSE;
1742 #ifdef FEATURE_FORCE_LOAD
1743 if (force_required(csp, req))
1745 csp->flags |= CSP_FLAG_FORCED;
1747 #endif /* def FEATURE_FORCE_LOAD */
1749 err = parse_http_request(req, http);
1751 if (JB_ERR_OK != err)
1753 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER),
1754 get_write_delay(csp));
1755 /* XXX: Use correct size */
1756 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1757 log_error(LOG_LEVEL_ERROR,
1758 "Couldn't parse request line received from %s: %s",
1759 csp->ip_addr_str, jb_err_to_string(err));
1761 free_http_request(http);
1762 return JB_ERR_PARSE;
1765 /* grab the rest of the client's headers */
1769 p = get_header(csp->client_iob);
1773 /* There are no additional headers to read. */
1780 * We didn't receive a complete header
1781 * line yet, get the rest of it.
1783 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1785 log_error(LOG_LEVEL_ERROR,
1786 "Stopped grabbing the client headers.");
1787 destroy_list(headers);
1788 return JB_ERR_PARSE;
1791 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1794 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1795 destroy_list(headers);
1796 return JB_ERR_PARSE;
1799 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1802 * If there is no memory left for buffering the
1803 * request, there is nothing we can do but hang up
1805 destroy_list(headers);
1806 return JB_ERR_MEMORY;
1811 if (!strncmpic(p, "Transfer-Encoding:", 18))
1814 * XXX: should be called through sed()
1815 * but currently can't.
1817 client_transfer_encoding(csp, &p);
1820 * We were able to read a complete
1821 * header and can finally enlist it.
1828 if (http->host == NULL)
1831 * If we still don't know the request destination,
1832 * the request is invalid or the client uses
1833 * Privoxy without its knowledge.
1835 if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
1838 * Our attempts to get the request destination
1839 * elsewhere failed or Privoxy is configured
1840 * to only accept proxy requests.
1842 * An error response has already been send
1843 * and we're done here.
1845 return JB_ERR_PARSE;
1849 #ifdef FEATURE_CLIENT_TAGS
1850 /* XXX: If the headers were enlisted sooner, passing csp would do. */
1851 set_client_address(csp, headers);
1852 get_tag_list_for_client(csp->client_tags, csp->client_address);
1856 * Determine the actions for this URL
1858 #ifdef FEATURE_TOGGLE
1859 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
1861 /* Most compatible set of actions (i.e. none) */
1862 init_current_action(csp->action);
1865 #endif /* ndef FEATURE_TOGGLE */
1867 get_url_actions(csp, http);
1870 enlist(csp->headers, http->cmd);
1872 /* Append the previously read headers */
1873 err = list_append_list_unique(csp->headers, headers);
1874 destroy_list(headers);
1881 /*********************************************************************
1883 * Function : parse_client_request
1885 * Description : Parses the client's request and decides what to do
1888 * Note that since we're not using select() we could get
1889 * blocked here if a client connected, then didn't say
1893 * 1 : csp = Current client state (buffers, headers, etc...)
1895 * Returns : JB_ERR_OK or JB_ERR_PARSE
1897 *********************************************************************/
1898 static jb_err parse_client_request(struct client_state *csp)
1900 struct http_request *http = csp->http;
1903 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1904 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
1905 && (!strcmpic(csp->http->version, "HTTP/1.1"))
1906 && (csp->http->ssl == 0))
1908 /* Assume persistence until further notice */
1909 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1911 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1913 if (csp->http->ssl == 0)
1916 * This whole block belongs to chat() but currently
1917 * has to be executed before sed().
1919 if (csp->flags & CSP_FLAG_CHUNKED_CLIENT_BODY)
1921 if (receive_chunked_client_request_body(csp) != JB_ERR_OK)
1923 return JB_ERR_PARSE;
1928 csp->expected_client_content_length = get_expected_content_length(csp->headers);
1930 verify_request_length(csp);
1932 #ifndef FEATURE_HTTPS_INSPECTION
1935 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1939 err = sed(csp, FILTER_CLIENT_HEADERS);
1940 if (JB_ERR_OK != err)
1942 log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
1944 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
1945 csp->ip_addr_str, csp->http->cmd);
1946 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER), get_write_delay(csp));
1947 return JB_ERR_PARSE;
1949 csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
1951 /* Check request line for rewrites. */
1952 if ((NULL == csp->headers->first->str)
1953 || (strcmp(http->cmd, csp->headers->first->str) &&
1954 (JB_ERR_OK != change_request_destination(csp))))
1957 * A header filter broke the request line - bail out.
1959 write_socket_delayed(csp->cfd, MESSED_UP_REQUEST_RESPONSE,
1960 strlen(MESSED_UP_REQUEST_RESPONSE), get_write_delay(csp));
1961 /* XXX: Use correct size */
1962 log_error(LOG_LEVEL_CLF,
1963 "%s - - [%T] \"Invalid request generated\" 500 0", csp->ip_addr_str);
1964 log_error(LOG_LEVEL_ERROR,
1965 "Invalid request line after applying header filters.");
1966 free_http_request(http);
1968 return JB_ERR_PARSE;
1971 if (client_has_unsupported_expectations(csp))
1973 return JB_ERR_PARSE;
1981 /*********************************************************************
1983 * Function : send_http_request
1985 * Description : Sends the HTTP headers from the client request
1986 * and all the body data that has already been received.
1989 * 1 : csp = Current client state (buffers, headers, etc...)
1991 * Returns : 0 on success, anything else is an error.
1993 *********************************************************************/
1994 static int send_http_request(struct client_state *csp)
1999 hdr = list_to_text(csp->headers);
2002 /* FIXME Should handle error properly */
2003 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
2005 list_remove_all(csp->headers);
2008 * Write the client's (modified) header to the server
2009 * (along with anything else that may be in the buffer)
2011 write_failure = 0 != write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
2016 log_error(LOG_LEVEL_CONNECT, "Failed sending request headers to: %s: %E",
2017 csp->http->hostport);
2019 else if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
2020 && (flush_iob(csp->server_connection.sfd, csp->client_iob, 0) < 0))
2023 log_error(LOG_LEVEL_CONNECT, "Failed sending request body to: %s: %E",
2024 csp->http->hostport);
2027 return write_failure;
2032 #ifdef FEATURE_HTTPS_INSPECTION
2033 /*********************************************************************
2035 * Function : receive_and_send_encrypted_post_data
2037 * Description : Reads remaining POST data from the client and sends
2041 * 1 : csp = Current client state (buffers, headers, etc...)
2043 * Returns : 0 on success, anything else is an error.
2045 *********************************************************************/
2046 static int receive_and_send_encrypted_post_data(struct client_state *csp)
2048 int content_length_known = csp->expected_client_content_length != 0;
2050 while (is_ssl_pending(&(csp->ssl_client_attr))
2051 || (content_length_known && csp->expected_client_content_length != 0))
2053 unsigned char buf[BUFFER_SIZE];
2055 int max_bytes_to_read = sizeof(buf);
2057 if (content_length_known && csp->expected_client_content_length < sizeof(buf))
2059 max_bytes_to_read = (int)csp->expected_client_content_length;
2061 log_error(LOG_LEVEL_CONNECT,
2062 "Waiting for up to %d bytes of POST data from the client.",
2064 len = ssl_recv_data(&(csp->ssl_client_attr), buf,
2065 (unsigned)max_bytes_to_read);
2072 /* XXX: Does this actually happen? */
2075 log_error(LOG_LEVEL_CONNECT, "Forwarding %d bytes of encrypted POST data",
2077 len = ssl_send_data(&(csp->ssl_server_attr), buf, (size_t)len);
2082 if (csp->expected_client_content_length != 0)
2084 if (csp->expected_client_content_length >= len)
2086 csp->expected_client_content_length -= (unsigned)len;
2088 if (csp->expected_client_content_length == 0)
2090 log_error(LOG_LEVEL_CONNECT, "Forwarded the last %d bytes", len);
2096 log_error(LOG_LEVEL_CONNECT, "Done forwarding encrypted POST data");
2103 /*********************************************************************
2105 * Function : send_https_request
2107 * Description : Sends the HTTP headers from the client request
2108 * and all the body data that has already been received.
2111 * 1 : csp = Current client state (buffers, headers, etc...)
2113 * Returns : 0 on success, anything else is an error.
2115 *********************************************************************/
2116 static int send_https_request(struct client_state *csp)
2122 hdr = list_to_text(csp->https_headers);
2125 /* FIXME Should handle error properly */
2126 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
2128 list_remove_all(csp->https_headers);
2131 * Write the client's (modified) header to the server
2132 * (along with anything else that may be in the buffer)
2134 ret = ssl_send_data(&(csp->ssl_server_attr),
2135 (const unsigned char *)hdr, strlen(hdr));
2140 log_error(LOG_LEVEL_CONNECT,
2141 "Failed sending encrypted request headers to: %s: %E",
2142 csp->http->hostport);
2143 mark_server_socket_tainted(csp);
2147 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
2148 && ((flushed = ssl_flush_socket(&(csp->ssl_server_attr),
2149 csp->client_iob)) < 0))
2151 log_error(LOG_LEVEL_CONNECT, "Failed sending request body to: %s: %E",
2152 csp->http->hostport);
2157 if (csp->expected_client_content_length != 0)
2159 if (csp->expected_client_content_length < flushed)
2161 log_error(LOG_LEVEL_ERROR,
2162 "Flushed %ld bytes of request body while only expecting %llu",
2163 flushed, csp->expected_client_content_length);
2164 csp->expected_client_content_length = 0;
2168 log_error(LOG_LEVEL_CONNECT,
2169 "Flushed %ld bytes of request body while expecting %llu",
2170 flushed, csp->expected_client_content_length);
2171 csp->expected_client_content_length -= (unsigned)flushed;
2172 if (receive_and_send_encrypted_post_data(csp))
2180 log_error(LOG_LEVEL_CONNECT,
2181 "Flushed %ld bytes of request body", flushed);
2185 log_error(LOG_LEVEL_CONNECT, "Encrypted request sent");
2192 /*********************************************************************
2194 * Function : receive_encrypted_request
2196 * Description : Receives an encrypted request.
2199 * 1 : csp = Current client state (buffers, headers, etc...)
2201 * Returns : JB_ERR_OK on success,
2202 * JB_ERR_PARSE or JB_ERR_MEMORY otherwise
2204 *********************************************************************/
2205 static jb_err receive_encrypted_request(struct client_state *csp)
2207 char buf[BUFFER_SIZE];
2213 log_error(LOG_LEVEL_HEADER, "Reading encrypted headers");
2214 if (!is_ssl_pending(&(csp->ssl_client_attr)) &&
2215 !data_is_available(csp->cfd, csp->config->socket_timeout))
2217 log_error(LOG_LEVEL_CONNECT,
2218 "Socket %d timed out while waiting for client headers", csp->cfd);
2219 return JB_ERR_PARSE;
2221 len = ssl_recv_data(&(csp->ssl_client_attr),
2222 (unsigned char *)buf, sizeof(buf));
2225 log_error(LOG_LEVEL_CONNECT,
2226 "Socket %d closed while waiting for client headers", csp->cfd);
2227 return JB_ERR_PARSE;
2231 return JB_ERR_PARSE;
2233 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
2235 return JB_ERR_MEMORY;
2237 p = strstr(csp->client_iob->cur, "\r\n\r\n");
2238 } while (p == NULL);
2240 log_error(LOG_LEVEL_HEADER, "Encrypted headers received completely");
2246 /*********************************************************************
2248 * Function : process_encrypted_request
2250 * Description : Receives and parses an encrypted request.
2253 * 1 : csp = Current client state (buffers, headers, etc...)
2255 * Returns : JB_ERR_OK on success,
2256 * JB_ERR_PARSE or JB_ERR_MEMORY otherwise
2258 *********************************************************************/
2259 static jb_err process_encrypted_request(struct client_state *csp)
2264 /* Temporary copy of the client's headers before they get enlisted in csp->https_headers */
2265 struct list header_list;
2266 struct list *headers = &header_list;
2268 assert(csp->ssl_with_client_is_opened);
2270 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2271 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
2273 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
2276 err = receive_encrypted_request(csp);
2277 if (err != JB_ERR_OK)
2279 if (csp->client_iob->cur == NULL)
2282 * We did not receive any data, most likely because the
2283 * client is done. Don't log this as a parse failure.
2285 return JB_ERR_PARSE;
2287 /* XXX: Also used for JB_ERR_MEMORY */
2288 log_error(LOG_LEVEL_ERROR, "Failed to receive encrypted request: %s",
2289 jb_err_to_string(err));
2290 ssl_send_data_delayed(&(csp->ssl_client_attr),
2291 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2295 /* We don't need get_request_line() because the whole HTTP head is buffered. */
2296 request_line = get_header(csp->client_iob);
2297 if (request_line == NULL)
2299 log_error(LOG_LEVEL_ERROR, "Failed to get the encrypted request line");
2300 ssl_send_data_delayed(&(csp->ssl_client_attr),
2301 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2302 return JB_ERR_PARSE;
2304 assert(*request_line != '\0');
2306 if (client_protocol_is_unsupported(csp, request_line))
2309 * If the protocol is unsupported we're done here.
2310 * client_protocol_is_unsupported() took care of sending
2311 * the error response and logging the error message.
2313 return JB_ERR_PARSE;
2316 #ifdef FEATURE_FORCE_LOAD
2317 if (force_required(csp, request_line))
2319 csp->flags |= CSP_FLAG_FORCED;
2321 #endif /* def FEATURE_FORCE_LOAD */
2323 free_http_request(csp->http);
2325 err = parse_http_request(request_line, csp->http);
2326 /* XXX: Restore ssl setting. This is ugly */
2327 csp->http->client_ssl = 1;
2328 csp->http->server_ssl = 1;
2330 freez(request_line);
2331 if (JB_ERR_OK != err)
2333 ssl_send_data_delayed(&(csp->ssl_client_attr),
2334 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2335 /* XXX: Use correct size */
2336 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
2337 log_error(LOG_LEVEL_ERROR,
2338 "Couldn't parse request line received from %s: %s",
2339 csp->ip_addr_str, jb_err_to_string(err));
2341 free_http_request(csp->http);
2342 return JB_ERR_PARSE;
2345 /* Parse the rest of the client's headers. */
2349 p = get_header(csp->client_iob);
2353 /* There are no additional headers to read. */
2360 if (JB_ERR_OK != get_destination_from_https_headers(headers, csp->http))
2363 * Our attempts to get the request destination
2366 log_error(LOG_LEVEL_ERROR,
2367 "Failed to get the encrypted request destination");
2368 ssl_send_data_delayed(&(csp->ssl_client_attr),
2369 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2370 return JB_ERR_PARSE;
2373 /* Split the domain we just got for pattern matching */
2374 init_domain_components(csp->http);
2376 #ifdef FEATURE_CLIENT_TAGS
2377 /* XXX: If the headers were enlisted sooner, passing csp would do. */
2378 if (csp->client_address == NULL)
2380 set_client_address(csp, headers);
2381 get_tag_list_for_client(csp->client_tags, csp->client_address);
2385 #ifdef FEATURE_TOGGLE
2386 if ((csp->flags & CSP_FLAG_TOGGLED_ON) != 0)
2390 * Determine the actions for this request after
2391 * clearing the ones from the previous one.
2393 free_current_action(csp->action);
2394 get_url_actions(csp, csp->http);
2397 enlist(csp->https_headers, csp->http->cmd);
2399 /* Append the previously read headers */
2400 err = list_append_list_unique(csp->https_headers, headers);
2401 destroy_list(headers);
2402 if (JB_ERR_OK != err)
2404 /* XXX: Send error message */
2408 /* XXX: Work around crash */
2409 csp->error_message = NULL;
2411 /* XXX: Why do this here? */
2414 err = sed_https(csp);
2415 if (JB_ERR_OK != err)
2417 ssl_send_data_delayed(&(csp->ssl_client_attr),
2418 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2419 log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
2421 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
2422 csp->ip_addr_str, csp->http->cmd);
2423 return JB_ERR_PARSE;
2426 log_error(LOG_LEVEL_HEADER, "Encrypted request processed");
2427 log_applied_actions(csp->action);
2428 log_error(LOG_LEVEL_REQUEST, "https://%s%s", csp->http->hostport,
2435 /*********************************************************************
2437 * Function : cgi_page_requested
2439 * Description : Checks if a request is for an internal CGI page.
2442 * 1 : host = The host requested by the client.
2444 * Returns : 1 if a CGI page has been requested, 0 otherwise
2446 *********************************************************************/
2447 static int cgi_page_requested(const char *host)
2449 if ((0 == strcmpic(host, CGI_SITE_1_HOST))
2450 || (0 == strcmpic(host, CGI_SITE_1_HOST "."))
2451 || (0 == strcmpic(host, CGI_SITE_2_HOST))
2452 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")))
2462 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2463 /*********************************************************************
2465 * Function : continue_https_chat
2467 * Description : Behaves similar to chat() but only deals with
2468 * https-inspected requests that arrive on an already
2469 * established connection. The first request is always
2470 * served by chat() which is a lot more complex as it
2471 * has to deal with forwarding settings and connection
2474 * If a connection to the server has already been
2475 * opened it is reused unless the request is blocked
2476 * or the forwarder changed.
2478 * If a connection to the server has not yet been
2479 * opened (because the previous request was crunched),
2480 * or the forwarder changed, the connection is dropped
2481 * so that the client retries on a fresh one.
2484 * 1 : csp = Current client state (buffers, headers, etc...)
2486 * Returns : Nothing.
2488 *********************************************************************/
2489 static void continue_https_chat(struct client_state *csp)
2491 const struct forward_spec *fwd;
2493 if (JB_ERR_OK != process_encrypted_request(csp))
2498 csp->requests_received_total++;
2501 * We have an encrypted request. Check if one of the crunchers wants it.
2503 if (crunch_response_triggered(csp, crunchers_all))
2506 * Yes. The client got the crunch response and we're done here.
2510 if (csp->ssl_with_server_is_opened == 0)
2512 log_error(LOG_LEVEL_CONNECT,
2513 "Dropping the client connection on socket %d. "
2514 "The server connection has not been established yet.",
2516 csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
2519 assert(csp->server_connection.sfd != JB_INVALID_SOCKET);
2521 fwd = forward_url(csp, csp->http);
2522 if (!connection_destination_matches(&csp->server_connection, csp->http, fwd))
2524 log_error(LOG_LEVEL_CONNECT,
2525 "Dropping the client connection on socket %d with "
2526 "server socket %d connected to %s. The forwarder has changed.",
2527 csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
2528 csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
2532 log_error(LOG_LEVEL_CONNECT,
2533 "Reusing server socket %d connected to %s. Requests already sent: %u.",
2534 csp->server_connection.sfd, csp->server_connection.host,
2535 csp->server_connection.requests_sent_total);
2537 if (send_https_request(csp))
2540 * Most likely the server connection timed out. We can't easily
2541 * create a new one so simply drop the client connection without a
2542 * error response to let the client retry.
2544 log_error(LOG_LEVEL_CONNECT,
2545 "Dropping client connection on socket %d. "
2546 "Forwarding the encrypted client request failed.",
2550 csp->server_connection.requests_sent_total++;
2551 handle_established_connection(csp);
2552 freez(csp->receive_buffer);
2554 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2558 /*********************************************************************
2560 * Function : handle_established_connection
2562 * Description : Shuffle data between client and server once the
2563 * connection has been established.
2566 * 1 : csp = Current client state (buffers, headers, etc...)
2568 * Returns : Nothing.
2570 *********************************************************************/
2571 static void handle_established_connection(struct client_state *csp)
2577 struct pollfd poll_fds[2];
2581 struct timeval timeout;
2584 int ms_iis5_hack = 0;
2585 unsigned long long byte_count = 0;
2586 struct http_request *http;
2587 long len = 0; /* for buffer sizes (and negative error codes) */
2588 int buffer_and_filter_content = 0;
2589 unsigned int write_delay;
2590 #ifdef FEATURE_HTTPS_INSPECTION
2592 int use_ssl_tunnel = 0;
2593 csp->dont_verify_certificate = 0;
2595 if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION))
2597 /* Pass encrypted content without filtering. */
2602 /* Skeleton for HTTP response, if we should intercept the request */
2603 struct http_response *rsp;
2604 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2605 int watch_client_socket;
2608 csp->receive_buffer_size = csp->config->receive_buffer_size;
2609 csp->receive_buffer = zalloc(csp->receive_buffer_size + 1);
2610 if (csp->receive_buffer == NULL)
2612 log_error(LOG_LEVEL_ERROR,
2613 "Out of memory. Failed to allocate the receive buffer.");
2614 rsp = cgi_error_memory();
2615 send_crunch_response(csp, rsp);
2622 maxfd = (csp->cfd > csp->server_connection.sfd) ?
2623 csp->cfd : csp->server_connection.sfd;
2626 /* pass data between the client and server
2627 * until one or the other shuts down the connection.
2632 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2633 watch_client_socket = 0 == (csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING);
2635 write_delay = get_write_delay(csp);
2641 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2642 if (!watch_client_socket)
2644 maxfd = csp->server_connection.sfd;
2647 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2649 FD_SET(csp->cfd, &rfds);
2652 FD_SET(csp->server_connection.sfd, &rfds);
2653 #endif /* ndef HAVE_POLL */
2655 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2656 if ((csp->flags & CSP_FLAG_CHUNKED)
2657 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2658 && ((csp->iob->eod - csp->iob->cur) >= 5)
2659 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
2662 * XXX: This check should be obsolete now,
2663 * but let's wait a while to be sure.
2665 log_error(LOG_LEVEL_CONNECT,
2666 "Looks like we got the last chunk together with "
2667 "the server headers but didn't detect it earlier. "
2668 "We better stop reading.");
2669 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2670 csp->expected_content_length = byte_count;
2671 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2673 if (server_body && server_response_is_complete(csp, byte_count))
2675 if (csp->expected_content_length == byte_count)
2677 log_error(LOG_LEVEL_CONNECT,
2678 "Done reading from server. Content length: %llu as expected. "
2679 "Bytes most recently read: %ld.",
2684 log_error(LOG_LEVEL_CONNECT,
2685 "Done reading from server. Expected content length: %llu. "
2686 "Actual content length: %llu. Bytes most recently read: %ld.",
2687 csp->expected_content_length, byte_count, len);
2691 * XXX: Should not jump around, handle_established_connection()
2692 * is complicated enough already.
2696 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2699 poll_fds[0].fd = csp->cfd;
2700 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2701 if (!watch_client_socket)
2704 * Ignore incoming data, but still watch out
2705 * for disconnects etc. These flags are always
2706 * implied anyway but explicitly setting them
2709 poll_fds[0].events = POLLERR|POLLHUP;
2714 poll_fds[0].events = POLLIN;
2716 poll_fds[1].fd = csp->server_connection.sfd;
2717 poll_fds[1].events = POLLIN;
2718 n = poll(poll_fds, 2, csp->config->socket_timeout * 1000);
2720 timeout.tv_sec = csp->config->socket_timeout;
2721 timeout.tv_usec = 0;
2722 n = select((int)maxfd + 1, &rfds, NULL, NULL, &timeout);
2723 #endif /* def HAVE_POLL */
2725 /*server or client not responding in timeout */
2728 log_error(LOG_LEVEL_CONNECT, "Socket timeout %d reached: %s",
2729 csp->config->socket_timeout, http->url);
2730 if ((byte_count == 0) && (http->ssl == 0))
2732 send_crunch_response(csp, error_response(csp, "connection-timeout"));
2734 mark_server_socket_tainted(csp);
2735 #ifdef FEATURE_HTTPS_INSPECTION
2736 close_client_and_server_ssl_connections(csp);
2743 log_error(LOG_LEVEL_ERROR, "poll() failed!: %E");
2745 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
2747 mark_server_socket_tainted(csp);
2748 #ifdef FEATURE_HTTPS_INSPECTION
2749 close_client_and_server_ssl_connections(csp);
2755 * This is the body of the browser's request,
2756 * just read and write it.
2758 * Receives data from browser and sends it to server
2760 * XXX: Make sure the client doesn't use pipelining
2761 * behind Privoxy's back.
2764 if ((poll_fds[0].revents & (POLLERR|POLLHUP|POLLNVAL)) != 0)
2766 log_error(LOG_LEVEL_CONNECT,
2767 "The client socket %d has become unusable while "
2768 "the server socket %d is still open.",
2769 csp->cfd, csp->server_connection.sfd);
2770 mark_server_socket_tainted(csp);
2774 if (poll_fds[0].revents != 0)
2776 if (FD_ISSET(csp->cfd, &rfds))
2777 #endif /* def HAVE_POLL*/
2779 int max_bytes_to_read = (int)csp->receive_buffer_size;
2781 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2782 if ((csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ))
2784 if (data_is_available(csp->cfd, 0))
2787 * If the next request is already waiting, we have
2788 * to stop select()ing the client socket. Otherwise
2789 * we would always return right away and get nothing
2792 watch_client_socket = 0;
2793 log_error(LOG_LEVEL_CONNECT,
2794 "Stop watching client socket %d. "
2795 "There's already another request waiting.",
2800 * If the client socket is set, but there's no data
2801 * available on the socket, the client went fishing
2802 * and continuing talking to the server makes no sense.
2804 log_error(LOG_LEVEL_CONNECT,
2805 "The client closed socket %d while "
2806 "the server socket %d is still open.",
2807 csp->cfd, csp->server_connection.sfd);
2808 mark_server_socket_tainted(csp);
2811 if (csp->expected_client_content_length != 0)
2813 if (csp->expected_client_content_length < csp->receive_buffer_size)
2815 max_bytes_to_read = (int)csp->expected_client_content_length;
2817 log_error(LOG_LEVEL_CONNECT,
2818 "Waiting for up to %d bytes from the client.",
2821 assert(max_bytes_to_read <= csp->receive_buffer_size);
2822 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2824 #ifdef FEATURE_HTTPS_INSPECTION
2825 if (client_use_ssl(csp))
2827 log_error(LOG_LEVEL_CONNECT, "Breaking with TLS/SSL.");
2831 #endif /* def FEATURE_HTTPS_INSPECTION */
2833 len = read_socket(csp->cfd, csp->receive_buffer, max_bytes_to_read);
2837 /* XXX: not sure if this is necessary. */
2838 mark_server_socket_tainted(csp);
2839 break; /* "game over, man" */
2842 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2843 if (csp->expected_client_content_length != 0)
2845 assert(len <= max_bytes_to_read);
2846 csp->expected_client_content_length -= (unsigned)len;
2847 log_error(LOG_LEVEL_CONNECT,
2848 "Expected client content length set to %llu "
2849 "after reading %ld bytes.",
2850 csp->expected_client_content_length, len);
2851 if (csp->expected_client_content_length == 0)
2853 log_error(LOG_LEVEL_CONNECT,
2854 "Done reading from the client.");
2855 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
2858 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2860 if (write_socket(csp->server_connection.sfd, csp->receive_buffer, (size_t)len))
2862 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
2863 mark_server_socket_tainted(csp);
2871 * The server wants to talk. It could be the header or the body.
2872 * If `hdr' is null, then it's the header otherwise it's the body.
2873 * FIXME: Does `hdr' really mean `host'? No.
2876 if (poll_fds[1].revents != 0)
2878 if (FD_ISSET(csp->server_connection.sfd, &rfds))
2879 #endif /* HAVE_POLL */
2881 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2883 * If we are buffering content, we don't want to eat up to
2884 * buffer-limit bytes if the client no longer cares about them.
2885 * If we aren't buffering, however, a dead client socket will be
2886 * noticed pretty much right away anyway, so we can reduce the
2887 * overhead by skipping the check.
2889 if (buffer_and_filter_content && !socket_is_still_alive(csp->cfd))
2892 log_error(LOG_LEVEL_CONNECT,
2893 "The server still wants to talk, but the client may already have hung up on us.");
2895 log_error(LOG_LEVEL_CONNECT,
2896 "The server still wants to talk, but the client hung up on us.");
2897 mark_server_socket_tainted(csp);
2898 #ifdef FEATURE_HTTPS_INSPECTION
2899 close_client_and_server_ssl_connections(csp);
2902 #endif /* def _WIN32 */
2904 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2906 #ifdef FEATURE_HTTPS_INSPECTION
2908 * Reading data from standard or secured connection (HTTP/HTTPS)
2910 if (server_use_ssl(csp))
2912 len = ssl_recv_data(&(csp->ssl_server_attr),
2913 (unsigned char *)csp->receive_buffer, csp->receive_buffer_size);
2918 len = read_socket(csp->server_connection.sfd, csp->receive_buffer,
2919 (int)csp->receive_buffer_size);
2924 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
2926 if ((http->ssl && (csp->fwd == NULL))
2927 #ifdef FEATURE_HTTPS_INSPECTION
2933 * Just hang up. We already confirmed the client's CONNECT
2934 * request with status code 200 and unencrypted content is
2935 * no longer welcome.
2937 log_error(LOG_LEVEL_ERROR,
2938 "CONNECT already confirmed. Unable to tell the client about the problem.");
2941 else if (byte_count)
2944 * Just hang up. We already transmitted the original headers
2945 * and parts of the original content and therefore missed the
2946 * chance to send an error message (without risking data corruption).
2948 * XXX: we could retry with a fancy range request here.
2950 log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
2951 "Unable to tell the client about the problem.");
2952 mark_server_socket_tainted(csp);
2953 #ifdef FEATURE_HTTPS_INSPECTION
2954 close_client_and_server_ssl_connections(csp);
2959 * XXX: Consider handling the cases above the same.
2961 mark_server_socket_tainted(csp);
2965 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2966 if (csp->flags & CSP_FLAG_CHUNKED)
2968 if ((len >= 5) && !memcmp(csp->receive_buffer+len-5, "0\r\n\r\n", 5))
2970 /* XXX: this is a temporary hack */
2971 log_error(LOG_LEVEL_CONNECT,
2972 "Looks like we reached the end of the last chunk. "
2973 "We better stop reading.");
2974 csp->expected_content_length = byte_count + (unsigned long long)len;
2975 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2979 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2982 * This is guaranteed by allocating with zalloc_or_die()
2983 * and never (intentionally) writing to the last byte.
2985 * csp->receive_buffer_size is the size of the part of the
2986 * buffer we intentionally write to, but we actually
2987 * allocated csp->receive_buffer_size+1 bytes so the assertion
2988 * stays within the allocated range.
2990 assert(csp->receive_buffer[csp->receive_buffer_size] == '\0');
2993 * Add a trailing zero to let be able to use string operations.
2994 * XXX: do we still need this with filter_popups gone?
2996 assert(len <= csp->receive_buffer_size);
2997 csp->receive_buffer[len] = '\0';
3000 * Normally, this would indicate that we've read
3001 * as much as the server has sent us and we can
3002 * close the client connection. However, Microsoft
3003 * in its wisdom has released IIS/5 with a bug that
3004 * prevents it from sending the trailing \r\n in
3005 * a 302 redirect header (and possibly other headers).
3006 * To work around this if we've haven't parsed
3007 * a full header we'll append a trailing \r\n
3008 * and see if this now generates a valid one.
3010 * This hack shouldn't have any impacts. If we've
3011 * already transmitted the header or if this is a
3012 * SSL connection, then we won't bother with this
3013 * hack. So we only work on partially received
3014 * headers. If we append a \r\n and this still
3015 * doesn't generate a valid header, then we won't
3016 * transmit anything to the client.
3021 if (server_body || (http->ssl
3022 #ifdef FEATURE_HTTPS_INSPECTION
3028 * If we have been buffering up the document,
3029 * now is the time to apply content modification
3030 * and send the result to the client.
3032 if (buffer_and_filter_content)
3034 p = execute_content_filters(csp);
3036 * If content filtering fails, use the original
3037 * buffer and length.
3038 * (see p != NULL ? p : csp->iob->cur below)
3042 csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
3044 #ifdef FEATURE_COMPRESSION
3045 else if ((csp->flags & CSP_FLAG_CLIENT_SUPPORTS_DEFLATE)
3046 && (csp->content_length > LOWER_LENGTH_LIMIT_FOR_COMPRESSION))
3048 char *compressed_content = compress_buffer(p,
3049 (size_t *)&csp->content_length, csp->config->compression_level);
3050 if (compressed_content != NULL)
3053 p = compressed_content;
3054 csp->flags |= CSP_FLAG_BUFFERED_CONTENT_DEFLATED;
3059 if (JB_ERR_OK != update_server_headers(csp))
3061 log_error(LOG_LEVEL_FATAL,
3062 "Failed to update server headers. after filtering.");
3065 hdr = list_to_text(csp->headers);
3068 /* FIXME Should handle error properly */
3069 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
3072 #ifdef FEATURE_HTTPS_INSPECTION
3074 * Sending data with standard or secured connection (HTTP/HTTPS)
3076 if (client_use_ssl(csp))
3078 if ((ssl_send_data_delayed(&(csp->ssl_client_attr),
3079 (const unsigned char *)hdr, strlen(hdr),
3080 get_write_delay(csp)) < 0)
3081 || (ssl_send_data_delayed(&(csp->ssl_client_attr),
3082 (const unsigned char *) ((p != NULL) ? p : csp->iob->cur),
3083 csp->content_length, get_write_delay(csp)) < 0))
3085 log_error(LOG_LEVEL_ERROR, "write modified content to "
3086 "client over TLS/SSL failed");
3089 mark_server_socket_tainted(csp);
3090 close_client_and_server_ssl_connections(csp);
3095 #endif /* def FEATURE_HTTPS_INSPECTION */
3097 if (write_socket_delayed(csp->cfd, hdr, strlen(hdr), write_delay)
3098 || write_socket_delayed(csp->cfd, ((p != NULL) ? p : csp->iob->cur),
3099 (size_t)csp->content_length, write_delay))
3101 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
3104 mark_server_socket_tainted(csp);
3113 break; /* "game over, man" */
3117 * This is NOT the body, so
3118 * Let's pretend the server just sent us a blank line.
3120 snprintf(csp->receive_buffer, csp->receive_buffer_size, "\r\n");
3121 len = (int)strlen(csp->receive_buffer);
3124 * Now, let the normal header parsing algorithm below do its
3125 * job. If it fails, we'll exit instead of continuing.
3132 * If we're in the body of the server document, just write it to
3133 * the client, unless we need to buffer the body for later
3134 * content-filtering.
3136 if (server_body || (http->ssl
3137 #ifdef FEATURE_HTTPS_INSPECTION
3142 if (buffer_and_filter_content)
3145 * If there is no memory left for buffering the content, or the buffer limit
3146 * has been reached, switch to non-filtering mode, i.e. make & write the
3147 * header, flush the iob and buf, and get out of the way.
3149 if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3154 log_error(LOG_LEVEL_INFO,
3155 "Flushing header and buffers. Stepping back from filtering.");
3157 hdr = list_to_text(csp->headers);
3161 * Memory is too tight to even generate the header.
3162 * Send our static "Out-of-memory" page.
3164 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
3165 rsp = cgi_error_memory();
3166 send_crunch_response(csp, rsp);
3167 mark_server_socket_tainted(csp);
3168 #ifdef FEATURE_HTTPS_INSPECTION
3169 close_client_and_server_ssl_connections(csp);
3173 hdrlen = strlen(hdr);
3175 #ifdef FEATURE_HTTPS_INSPECTION
3177 * Sending data with standard or secured connection (HTTP/HTTPS)
3179 if (client_use_ssl(csp))
3181 if ((ssl_send_data_delayed(&(csp->ssl_client_attr),
3182 (const unsigned char *)hdr, hdrlen, get_write_delay(csp)) < 0)
3183 || ((flushed = ssl_flush_socket(&(csp->ssl_client_attr),
3185 || (ssl_send_data_delayed(&(csp->ssl_client_attr),
3186 (const unsigned char *)csp->receive_buffer, (size_t)len,
3187 get_write_delay(csp)) < 0))
3189 log_error(LOG_LEVEL_CONNECT,
3190 "Flush header and buffers to client failed");
3192 mark_server_socket_tainted(csp);
3193 close_client_and_server_ssl_connections(csp);
3198 #endif /* def FEATURE_HTTPS_INSPECTION */
3200 if (write_socket_delayed(csp->cfd, hdr, hdrlen, write_delay)
3201 || ((flushed = flush_iob(csp->cfd, csp->iob, write_delay)) < 0)
3202 || write_socket_delayed(csp->cfd, csp->receive_buffer, (size_t)len,
3205 log_error(LOG_LEVEL_CONNECT,
3206 "Flush header and buffers to client failed: %E");
3208 mark_server_socket_tainted(csp);
3214 * Reset the byte_count to the amount of bytes
3215 * we just flushed. len will be added a few lines below,
3216 * hdrlen doesn't matter for LOG_LEVEL_CLF.
3218 byte_count = (unsigned long long)flushed;
3220 buffer_and_filter_content = 0;
3226 #ifdef FEATURE_HTTPS_INSPECTION
3228 * Sending data with standard or secured connection (HTTP/HTTPS)
3230 if (client_use_ssl(csp))
3232 ret = ssl_send_data_delayed(&(csp->ssl_client_attr),
3233 (const unsigned char *)csp->receive_buffer, (size_t)len,
3234 get_write_delay(csp));
3237 log_error(LOG_LEVEL_ERROR,
3238 "Sending data to client failed");
3239 mark_server_socket_tainted(csp);
3240 close_client_and_server_ssl_connections(csp);
3245 #endif /* def FEATURE_HTTPS_INSPECTION */
3247 if (write_socket_delayed(csp->cfd, csp->receive_buffer,
3248 (size_t)len, write_delay))
3250 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
3251 mark_server_socket_tainted(csp);
3256 byte_count += (unsigned long long)len;
3262 * We're still looking for the end of the server's header.
3263 * Buffer up the data we just read. If that fails, there's
3264 * little we can do but send our static out-of-memory page.
3266 if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3268 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
3269 rsp = cgi_error_memory();
3270 send_crunch_response(csp, rsp);
3271 mark_server_socket_tainted(csp);
3272 #ifdef FEATURE_HTTPS_INSPECTION
3273 close_client_and_server_ssl_connections(csp);
3278 /* Convert iob into something sed() can digest */
3279 if (JB_ERR_PARSE == get_server_headers(csp))
3284 * Well, we tried our MS IIS/5 hack and it didn't work.
3285 * The header is incomplete and there isn't anything
3286 * we can do about it.
3288 log_error(LOG_LEVEL_ERROR, "Invalid server headers. "
3289 "Applying the MS IIS5 hack didn't help.");
3290 log_error(LOG_LEVEL_CLF,
3291 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3292 #ifdef FEATURE_HTTPS_INSPECTION
3294 * Sending data with standard or secured connection (HTTP/HTTPS)
3296 if (client_use_ssl(csp))
3298 ssl_send_data_delayed(&(csp->ssl_client_attr),
3299 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3300 strlen(INVALID_SERVER_HEADERS_RESPONSE), get_write_delay(csp));
3303 #endif /* def FEATURE_HTTPS_INSPECTION */
3305 write_socket_delayed(csp->cfd,
3306 INVALID_SERVER_HEADERS_RESPONSE,
3307 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3309 mark_server_socket_tainted(csp);
3310 #ifdef FEATURE_HTTPS_INSPECTION
3311 close_client_and_server_ssl_connections(csp);
3318 * Since we have to wait for more from the server before
3319 * we can parse the headers we just continue here.
3321 log_error(LOG_LEVEL_CONNECT,
3322 "Continuing buffering server headers from socket %d. "
3323 "Bytes most recently read: %ld.", csp->cfd, len);
3330 * Account for the content bytes we
3331 * might have gotten with the headers.
3333 assert(csp->iob->eod >= csp->iob->cur);
3334 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3337 /* Did we actually get anything? */
3338 if (NULL == csp->headers->first)
3340 if ((csp->flags & CSP_FLAG_REUSED_CLIENT_CONNECTION))
3342 log_error(LOG_LEVEL_ERROR,
3343 "No server or forwarder response received on socket %d. "
3344 "Closing client socket %d without sending data.",
3345 csp->server_connection.sfd, csp->cfd);
3346 log_error(LOG_LEVEL_CLF,
3347 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3351 log_error(LOG_LEVEL_ERROR,
3352 "No server or forwarder response received on socket %d.",
3353 csp->server_connection.sfd);
3354 send_crunch_response(csp, error_response(csp, "no-server-data"));
3356 free_http_request(http);
3357 mark_server_socket_tainted(csp);
3358 #ifdef FEATURE_HTTPS_INSPECTION
3359 close_client_and_server_ssl_connections(csp);
3364 if (!csp->headers->first->str)
3366 log_error(LOG_LEVEL_ERROR, "header search: csp->headers->first->str == NULL, assert will be called");
3368 assert(csp->headers->first->str);
3370 if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
3371 strncmpic(csp->headers->first->str, "ICY", 3))
3374 * It doesn't look like a HTTP (or Shoutcast) response:
3375 * tell the client and log the problem.
3377 if (strlen(csp->headers->first->str) > 30)
3379 csp->headers->first->str[30] = '\0';
3381 log_error(LOG_LEVEL_ERROR,
3382 "Invalid server or forwarder response. Starts with: %s",
3383 csp->headers->first->str);
3384 log_error(LOG_LEVEL_CLF,
3385 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3386 #ifdef FEATURE_HTTPS_INSPECTION
3388 * Sending data with standard or secured connection (HTTP/HTTPS)
3390 if (client_use_ssl(csp))
3392 ssl_send_data_delayed(&(csp->ssl_client_attr),
3393 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3394 strlen(INVALID_SERVER_HEADERS_RESPONSE),
3395 get_write_delay(csp));
3398 #endif /* def FEATURE_HTTPS_INSPECTION */
3400 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3401 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3403 free_http_request(http);
3404 mark_server_socket_tainted(csp);
3405 #ifdef FEATURE_HTTPS_INSPECTION
3406 close_client_and_server_ssl_connections(csp);
3412 * We have now received the entire server header,
3413 * filter it and send the result to the client
3415 if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
3417 log_error(LOG_LEVEL_CLF,
3418 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3419 #ifdef FEATURE_HTTPS_INSPECTION
3421 * Sending data with standard or secured connection (HTTP/HTTPS)
3423 if (client_use_ssl(csp))
3425 ssl_send_data_delayed(&(csp->ssl_client_attr),
3426 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3427 strlen(INVALID_SERVER_HEADERS_RESPONSE),
3428 get_write_delay(csp));
3433 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3434 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3436 free_http_request(http);
3437 mark_server_socket_tainted(csp);
3438 #ifdef FEATURE_HTTPS_INSPECTION
3439 close_client_and_server_ssl_connections(csp);
3443 hdr = list_to_text(csp->headers);
3446 /* FIXME Should handle error properly */
3447 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
3450 if ((csp->flags & CSP_FLAG_CHUNKED)
3451 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3452 && ((csp->iob->eod - csp->iob->cur) >= 5)
3453 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
3455 log_error(LOG_LEVEL_CONNECT,
3456 "Looks like we got the last chunk together with "
3457 "the server headers. We better stop reading.");
3458 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3459 csp->expected_content_length = byte_count;
3460 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
3463 csp->server_connection.response_received = time(NULL);
3465 if (crunch_response_triggered(csp, crunchers_light))
3468 * One of the tags created by a server-header
3469 * tagger triggered a crunch. We already
3470 * delivered the crunch response to the client
3471 * and are done here after cleaning up.
3474 mark_server_socket_tainted(csp);
3475 #ifdef FEATURE_HTTPS_INSPECTION
3476 close_client_and_server_ssl_connections(csp);
3481 /* Buffer and pcrs filter this if appropriate. */
3482 buffer_and_filter_content = content_requires_filtering(csp);
3484 if (!buffer_and_filter_content)
3487 * Write the server's (modified) header to
3488 * the client (along with anything else that
3489 * may be in the buffer). Use standard or secured
3492 #ifdef FEATURE_HTTPS_INSPECTION
3493 if (client_use_ssl(csp))
3495 if ((ssl_send_data_delayed(&(csp->ssl_client_attr),
3496 (const unsigned char *)hdr, strlen(hdr),
3497 get_write_delay(csp)) < 0)
3498 || (len = ssl_flush_socket(&(csp->ssl_client_attr),
3501 log_error(LOG_LEVEL_CONNECT, "Write header to client failed");
3504 * The write failed, so don't bother mentioning it
3505 * to the client... it probably can't hear us anyway.
3508 mark_server_socket_tainted(csp);
3509 #ifdef FEATURE_HTTPS_INSPECTION
3510 close_client_and_server_ssl_connections(csp);
3516 #endif /* def FEATURE_HTTPS_INSPECTION */
3518 if (write_socket_delayed(csp->cfd, hdr, strlen(hdr), write_delay)
3519 || ((len = flush_iob(csp->cfd, csp->iob, write_delay)) < 0))
3521 log_error(LOG_LEVEL_ERROR,
3522 "write header to client failed");
3524 * The write failed, so don't bother mentioning it
3525 * to the client... it probably can't hear us anyway.
3528 mark_server_socket_tainted(csp);
3534 /* we're finished with the server's header */
3540 * If this was a MS IIS/5 hack then it means the server
3541 * has already closed the connection. Nothing more to read.
3546 log_error(LOG_LEVEL_ERROR,
3547 "Closed server connection detected. "
3548 "Applying the MS IIS5 hack didn't help.");
3549 log_error(LOG_LEVEL_CLF,
3550 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3551 #ifdef FEATURE_HTTPS_INSPECTION
3553 * Sending data with standard or secured connection (HTTP/HTTPS)
3555 if (client_use_ssl(csp))
3557 ssl_send_data_delayed(&(csp->ssl_client_attr),
3558 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3559 strlen(INVALID_SERVER_HEADERS_RESPONSE),
3560 get_write_delay(csp));
3563 #endif /* def FEATURE_HTTPS_INSPECTION */
3565 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3566 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3568 mark_server_socket_tainted(csp);
3569 #ifdef FEATURE_HTTPS_INSPECTION
3570 close_client_and_server_ssl_connections(csp);
3577 mark_server_socket_tainted(csp);
3578 #ifdef FEATURE_HTTPS_INSPECTION
3579 close_client_and_server_ssl_connections(csp);
3581 return; /* huh? we should never get here */
3584 if (csp->content_length == 0)
3587 * If Privoxy didn't recalculate the Content-Length,
3588 * byte_count is still correct.
3590 csp->content_length = byte_count;
3593 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3594 if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3595 && (csp->expected_content_length != byte_count))
3597 log_error(LOG_LEVEL_CONNECT,
3598 "Received %llu bytes while expecting %llu.",
3599 byte_count, csp->expected_content_length);
3600 mark_server_socket_tainted(csp);
3604 #ifdef FEATURE_HTTPS_INSPECTION
3605 if (client_use_ssl(csp))
3607 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s https://%s%s %s\" 200 %llu",
3608 csp->ip_addr_str, http->gpc, http->hostport, http->path,
3609 http->version, csp->content_length);
3614 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %llu",
3615 csp->ip_addr_str, http->ocmd, csp->content_length);
3617 csp->server_connection.timestamp = time(NULL);
3621 /*********************************************************************
3625 * Description : Once a connection from the client has been accepted,
3626 * this function is called (via serve()) to handle the
3627 * main business of the communication. This function
3628 * returns after dealing with a single request. It can
3629 * be called multiple times with the same client socket
3630 * if the client is keeping the connection alive.
3632 * The decision whether or not a client connection will
3633 * be kept alive is up to the caller which also must
3634 * close the client socket when done.
3636 * FIXME: chat is nearly thousand lines long.
3640 * 1 : csp = Current client state (buffers, headers, etc...)
3642 * Returns : Nothing.
3644 *********************************************************************/
3645 static void chat(struct client_state *csp)
3647 const struct forward_spec *fwd;
3648 struct http_request *http;
3649 /* Skeleton for HTTP response, if we should intercept the request */
3650 struct http_response *rsp;
3651 #ifdef FEATURE_HTTPS_INSPECTION
3652 int use_ssl_tunnel = 0;
3657 if (receive_client_request(csp) != JB_ERR_OK)
3661 if (parse_client_request(csp) != JB_ERR_OK)
3666 /* decide how to route the HTTP request */
3667 fwd = forward_url(csp, http);
3669 #ifdef FEATURE_HTTPS_INSPECTION
3671 * Setting flags to use old solution with SSL tunnel and to disable
3672 * certificate verification.
3674 if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION)
3675 && !cgi_page_requested(csp->http->host))
3680 if (http->ssl && csp->action->flags & ACTION_IGNORE_CERTIFICATE_ERRORS)
3682 csp->dont_verify_certificate = 1;
3687 * build the http request to send to the server
3688 * we have to do one of the following:
3690 * create = use the original HTTP request to create a new
3691 * HTTP request that has either the path component
3692 * without the http://domainspec (w/path) or the
3693 * full orininal URL (w/url)
3694 * Note that the path and/or the HTTP version may
3695 * have been altered by now.
3697 * SSL proxy = Open a socket to the host:port of the server
3698 * and create TLS/SSL connection with server and
3699 * with client. Then behave like mediator between
3700 * client and server over TLS/SSL.
3702 * SSL proxy = Pass the request unchanged if forwarding a CONNECT
3703 * with request to a parent proxy. Note that we'll be sending
3704 * forwarding the CFAIL message ourselves if connecting to the parent
3705 * fails, but we won't send a CSUCCEED message if it works,
3706 * since that would result in a double message (ours and the
3707 * parent's). After sending the request to the parent, we
3708 * must parse answer and send it to client. If connection
3709 * with server is established, we do TLS/SSL proxy. Otherwise
3710 * we send parent response to client and close connections.
3712 * here's the matrix:
3715 * +--------+--------+
3717 * 0 | create | SSL |
3718 * | w/path | proxy |
3719 * Forwarding +--------+--------+
3721 * 1 | create | proxy |
3722 * | w/url |+forward|
3723 * +--------+--------+
3727 #ifdef FEATURE_HTTPS_INSPECTION
3729 * Presetting SSL client and server flags
3731 if (http->ssl && !use_ssl_tunnel)
3733 http->client_ssl = 1;
3734 http->server_ssl = 1;
3738 http->client_ssl = 0;
3739 http->server_ssl = 0;
3743 #ifdef FEATURE_HTTPS_INSPECTION
3745 * Log the request unless we're https inspecting
3746 * in which case we don't have the path yet and
3747 * will log the request later.
3749 if (!client_use_ssl(csp))
3752 log_error(LOG_LEVEL_REQUEST, "%s%s", http->hostport, http->path);
3755 if (http->ssl && connect_port_is_forbidden(csp))
3757 const char *acceptable_connect_ports =
3758 csp->action->string[ACTION_STRING_LIMIT_CONNECT];
3759 assert(NULL != acceptable_connect_ports);
3760 log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
3761 "limit-connect{%s} doesn't allow CONNECT requests to %s",
3762 csp->ip_addr_str, acceptable_connect_ports, csp->http->hostport);
3763 csp->action->flags |= ACTION_BLOCK;
3765 #ifdef FEATURE_HTTPS_INSPECTION
3766 http->client_ssl = 0;
3767 http->server_ssl = 0;
3772 freez(csp->headers->first->str);
3773 build_request_line(csp, fwd, &csp->headers->first->str);
3776 * We have a request. Check if one of the crunchers wants it
3777 * unless the client wants to use TLS/SSL in which case we
3778 * haven't setup the TLS context yet and will send the crunch
3782 #ifdef FEATURE_HTTPS_INSPECTION
3783 !client_use_ssl(csp) &&
3785 crunch_response_triggered(csp, crunchers_all))
3788 * Yes. The client got the crunch response and we're done here.
3793 log_applied_actions(csp->action);
3794 if (fwd->forward_host)
3796 log_error(LOG_LEVEL_CONNECT, "via [%s]:%d to: %s",
3797 fwd->forward_host, fwd->forward_port, http->hostport);
3801 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
3804 /* here we connect to the server, gateway, or the forwarder */
3806 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3807 if ((csp->server_connection.sfd != JB_INVALID_SOCKET)
3808 && socket_is_still_alive(csp->server_connection.sfd)
3809 && connection_destination_matches(&csp->server_connection, http, fwd))
3811 log_error(LOG_LEVEL_CONNECT,
3812 "Reusing server socket %d connected to %s. Total requests: %u.",
3813 csp->server_connection.sfd, csp->server_connection.host,
3814 csp->server_connection.requests_sent_total);
3818 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
3820 #ifdef FEATURE_CONNECTION_SHARING
3821 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING
3822 #ifdef FEATURE_HTTPS_INSPECTION
3823 && !server_use_ssl(csp)
3827 remember_connection(&csp->server_connection);
3830 #endif /* def FEATURE_CONNECTION_SHARING */
3832 log_error(LOG_LEVEL_CONNECT,
3833 "Closing server socket %d connected to %s. Total requests: %u.",
3834 csp->server_connection.sfd, csp->server_connection.host,
3835 csp->server_connection.requests_sent_total);
3836 close_socket(csp->server_connection.sfd);
3838 mark_connection_closed(&csp->server_connection);
3840 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3841 #ifdef FEATURE_HTTPS_INSPECTION
3842 if (http->ssl && !use_ssl_tunnel)
3846 * Creating a SSL proxy.
3848 * By sending the CSUCCEED message we're lying to the client as
3849 * the connection hasn't actually been established yet. We don't
3850 * establish the connection until we have seen and parsed the
3851 * encrypted client headers.
3853 if (write_socket_delayed(csp->cfd, CSUCCEED,
3854 strlen(CSUCCEED), get_write_delay(csp)) != 0)
3856 log_error(LOG_LEVEL_ERROR, "Sending SUCCEED to client failed");
3860 ret = create_client_ssl_connection(csp);
3863 log_error(LOG_LEVEL_ERROR,
3864 "Failed to open a secure connection with the client");
3867 if (JB_ERR_OK != process_encrypted_request(csp))
3869 close_client_ssl_connection(csp);
3873 * We have an encrypted request. Check if one of the crunchers now
3874 * wants it (for example because the previously invisible path was
3875 * required to match).
3877 if (crunch_response_triggered(csp, crunchers_all))
3880 * Yes. The client got the crunch response and we're done here.
3887 * Connecting to destination server
3889 csp->server_connection.sfd = forwarded_connect(fwd, http, csp);
3891 if (csp->server_connection.sfd == JB_INVALID_SOCKET)
3893 if (fwd->type != SOCKS_NONE)
3896 rsp = error_response(csp, "forwarding-failed");
3898 else if (errno == EINVAL)
3900 rsp = error_response(csp, "no-such-domain");
3904 rsp = error_response(csp, "connect-failed");
3907 /* Write the answer to the client */
3910 send_crunch_response(csp, rsp);
3914 * Temporary workaround to prevent already-read client
3915 * bodies from being parsed as new requests. For now we
3916 * err on the safe side and throw all the following
3917 * requests under the bus, even if no client body has been
3918 * buffered. A compliant client will repeat the dropped
3919 * requests on an untainted connection.
3921 * The proper fix is to discard the no longer needed
3922 * client body in the buffer (if there is one) and to
3923 * continue parsing the bytes that follow.
3925 #ifdef FEATURE_HTTPS_INSPECTION
3926 close_client_ssl_connection(csp);
3928 drain_and_close_socket(csp->cfd);
3929 csp->cfd = JB_INVALID_SOCKET;
3934 #ifdef FEATURE_HTTPS_INSPECTION
3936 * Creating TLS/SSL connections with destination server or parent
3937 * proxy. If forwarding is enabled, we must send client request to
3938 * parent proxy and receive, parse and resend parent proxy answer.
3940 if (http->ssl && !use_ssl_tunnel)
3942 if (fwd->forward_host != NULL)
3944 char server_response[BUFFER_SIZE];
3947 char *hdr = list_to_text(csp->headers);
3948 memset(server_response, 0, sizeof(server_response));
3952 log_error(LOG_LEVEL_FATAL,
3953 "Out of memory parsing client header");
3955 list_remove_all(csp->headers);
3958 * Sending client's CONNECT request to the parent proxy
3960 ret = write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
3966 log_error(LOG_LEVEL_CONNECT,
3967 "Sending request headers to: %s failed", http->hostport);
3968 mark_server_socket_tainted(csp);
3969 close_client_ssl_connection(csp);
3973 /* Waiting for parent proxy server response */
3974 len = read_socket(csp->server_connection.sfd, server_response,
3975 sizeof(server_response)-1);
3979 log_error(LOG_LEVEL_ERROR, "No response from parent proxy "
3980 "server on socket %d.", csp->server_connection.sfd);
3982 rsp = error_response(csp, "no-server-data");
3985 send_crunch_response(csp, rsp);
3987 mark_server_socket_tainted(csp);
3988 close_client_ssl_connection(csp);
3993 * Test if the connection to the destination server was
3994 * established successfully by the parent proxy.
3996 if (!tunnel_established_successfully(server_response, (unsigned int)len))
3998 log_error(LOG_LEVEL_ERROR,
3999 "The forwarder %s failed to establish a connection with %s",
4000 fwd->forward_host, http->host);
4001 rsp = error_response(csp, "connect-failed");
4004 send_crunch_response(csp, rsp);
4006 mark_server_socket_tainted(csp);
4007 close_client_ssl_connection(csp);
4010 } /* -END- if (fwd->forward_host != NULL) */
4013 * We can now create the TLS/SSL connection with the destination server.
4015 int ret = create_server_ssl_connection(csp);
4018 if (csp->server_cert_verification_result != SSL_CERT_VALID &&
4019 csp->server_cert_verification_result != SSL_CERT_NOT_VERIFIED)
4022 * If the server certificate is invalid, we must inform
4023 * the client and then close connection to the client.
4025 ssl_send_certificate_error(csp);
4026 close_client_and_server_ssl_connections(csp);
4029 if (csp->server_cert_verification_result == SSL_CERT_NOT_VERIFIED
4030 || csp->server_cert_verification_result == SSL_CERT_VALID)
4033 * The TLS/SSL connection wasn't created but an invalid
4034 * certificate wasn't detected. Report it as connection
4037 rsp = error_response(csp, "connect-failed");
4040 send_crunch_response(csp, rsp);
4042 close_client_and_server_ssl_connections(csp);
4046 }/* -END- if (http->ssl) */
4047 #endif /* def FEATURE_HTTPS_INSPECTION */
4049 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4050 save_connection_destination(csp->server_connection.sfd,
4051 http, fwd, &csp->server_connection);
4052 csp->server_connection.keep_alive_timeout =
4053 (unsigned)csp->config->keep_alive_timeout;
4055 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4057 csp->server_connection.requests_sent_total++;
4059 if ((fwd->type == SOCKS_5T) && (NULL == csp->headers->first))
4061 /* Client headers have been sent optimistically */
4062 assert(csp->headers->last == NULL);
4064 else if (http->ssl == 0 || (fwd->forward_host
4065 #ifdef FEATURE_HTTPS_INSPECTION
4070 if (send_http_request(csp))
4072 rsp = error_response(csp, "connect-failed");
4075 send_crunch_response(csp, rsp);
4083 * Using old solution with SSL tunnel or new solution with SSL proxy
4085 list_remove_all(csp->headers);
4086 #ifdef FEATURE_HTTPS_INSPECTION
4091 * We're running an SSL tunnel and we're not forwarding,
4092 * so just ditch the client headers, send the "connect succeeded"
4093 * message to the client, flush the rest, and get out of the way.
4095 if (write_socket_delayed(csp->cfd, CSUCCEED,
4096 strlen(CSUCCEED), get_write_delay(csp)))
4101 #ifdef FEATURE_HTTPS_INSPECTION
4105 * If server certificate is invalid, we must inform client and then
4106 * close connection with client.
4108 if (csp->server_cert_verification_result != SSL_CERT_VALID)
4110 ssl_send_certificate_error(csp);
4111 close_client_and_server_ssl_connections(csp);
4114 if (send_https_request(csp))
4116 rsp = error_response(csp, "connect-failed");
4119 send_crunch_response(csp, rsp);
4121 close_client_and_server_ssl_connections(csp);
4125 #endif /* def FEATURE_HTTPS_INSPECTION */
4126 clear_iob(csp->client_iob);
4127 }/* -END- else ... if (http->ssl == 1) */
4129 log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
4131 /* XXX: should the time start earlier for optimistically sent data? */
4132 csp->server_connection.request_sent = time(NULL);
4134 handle_established_connection(csp);
4135 freez(csp->receive_buffer);
4140 /*********************************************************************
4142 * Function : fuzz_server_response
4144 * Description : Treat the input as a whole server response.
4147 * 1 : csp = Current client state (buffers, headers, etc...)
4148 * 2 : fuzz_input_file = File to read the input from.
4152 *********************************************************************/
4153 extern int fuzz_server_response(struct client_state *csp, char *fuzz_input_file)
4155 static struct forward_spec fwd; /* Zero'd due to being static */
4158 if (strcmp(fuzz_input_file, "-") == 0)
4160 /* XXX: Doesn't work yet. */
4161 csp->server_connection.sfd = 0;
4165 csp->server_connection.sfd = open(fuzz_input_file, O_RDONLY);
4166 if (csp->server_connection.sfd == -1)
4168 log_error(LOG_LEVEL_FATAL, "Failed to open %s: %E",
4173 csp->content_type |= CT_GIF;
4174 csp->action->flags |= ACTION_DEANIMATE;
4175 csp->action->string[ACTION_STRING_DEANIMATE] = "last";
4177 csp->http->path = strdup_or_die("/");
4178 csp->http->host = strdup_or_die("fuzz.example.org");
4179 csp->http->hostport = strdup_or_die("fuzz.example.org:80");
4180 /* Prevent client socket monitoring */
4181 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
4182 csp->flags |= CSP_FLAG_CHUNKED;
4184 csp->config->feature_flags |= RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
4185 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
4187 csp->content_type |= CT_DECLARED|CT_GIF;
4189 csp->config->socket_timeout = 0;
4191 cgi_init_error_messages();
4193 handle_established_connection(csp);
4194 freez(csp->receive_buffer);
4201 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4202 /*********************************************************************
4204 * Function : prepare_csp_for_next_request
4206 * Description : Put the csp in a mostly vergin state.
4209 * 1 : csp = Current client state (buffers, headers, etc...)
4213 *********************************************************************/
4214 static void prepare_csp_for_next_request(struct client_state *csp)
4216 csp->content_type = 0;
4217 csp->content_length = 0;
4218 csp->expected_content_length = 0;
4219 csp->expected_client_content_length = 0;
4220 list_remove_all(csp->headers);
4221 clear_iob(csp->iob);
4222 freez(csp->error_message);
4223 free_http_request(csp->http);
4224 destroy_list(csp->headers);
4225 #ifdef FEATURE_HTTPS_INSPECTION
4226 destroy_list(csp->https_headers);
4228 destroy_list(csp->tags);
4229 #ifdef FEATURE_CLIENT_TAGS
4230 destroy_list(csp->client_tags);
4231 freez(csp->client_address);
4233 free_current_action(csp->action);
4234 if (NULL != csp->fwd)
4236 unload_forward_spec(csp->fwd);
4239 /* XXX: Store per-connection flags someplace else. */
4240 csp->flags = (CSP_FLAG_ACTIVE | CSP_FLAG_REUSED_CLIENT_CONNECTION);
4241 #ifdef FEATURE_TOGGLE
4242 if (global_toggle_state)
4243 #endif /* def FEATURE_TOGGLE */
4245 csp->flags |= CSP_FLAG_TOGGLED_ON;
4248 if (csp->client_iob->eod > csp->client_iob->cur)
4250 long bytes_to_shift = csp->client_iob->cur - csp->client_iob->buf;
4251 size_t data_length = (size_t)(csp->client_iob->eod - csp->client_iob->cur);
4253 assert(bytes_to_shift > 0);
4254 assert(data_length > 0);
4256 log_error(LOG_LEVEL_CONNECT, "Shifting %d pipelined bytes by %d bytes",
4257 data_length, bytes_to_shift);
4258 memmove(csp->client_iob->buf, csp->client_iob->cur, data_length);
4259 csp->client_iob->cur = csp->client_iob->buf;
4260 assert(csp->client_iob->eod == csp->client_iob->buf + bytes_to_shift + data_length);
4261 csp->client_iob->eod = csp->client_iob->buf + data_length;
4262 memset(csp->client_iob->eod, '\0', (size_t)bytes_to_shift);
4264 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
4269 * We mainly care about resetting client_iob->cur so we don't
4270 * waste buffer space at the beginning and don't mess up the
4271 * request restoration done by cgi_show_request().
4273 * Freeing the buffer itself isn't technically necessary,
4274 * but makes debugging more convenient.
4276 clear_iob(csp->client_iob);
4279 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4282 /*********************************************************************
4286 * Description : This is little more than chat. We only "serve" to
4287 * to close (or remember) any socket that chat may have
4291 * 1 : csp = Current client state (buffers, headers, etc...)
4295 *********************************************************************/
4296 static void serve(struct client_state *csp)
4298 int config_file_change_detected = 0; /* Only used for debugging */
4299 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4300 #ifdef FEATURE_CONNECTION_SHARING
4301 static int monitor_thread_running = 0;
4302 #endif /* def FEATURE_CONNECTION_SHARING */
4303 int continue_chatting = 0;
4305 log_error(LOG_LEVEL_CONNECT, "Accepted connection from %s on socket %d",
4306 csp->ip_addr_str, csp->cfd);
4310 unsigned int latency;
4312 #ifdef FEATURE_HTTPS_INSPECTION
4313 if (continue_chatting && client_use_ssl(csp))
4315 continue_https_chat(csp);
4324 * If the request has been crunched,
4325 * the calculated latency is zero.
4327 latency = (unsigned)(csp->server_connection.response_received -
4328 csp->server_connection.request_sent) / 2;
4330 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4331 && (csp->flags & CSP_FLAG_CRUNCHED)
4332 && (csp->expected_client_content_length != 0))
4334 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
4335 log_error(LOG_LEVEL_CONNECT,
4336 "Tainting client socket %d due to unread data.", csp->cfd);
4339 continue_chatting = (csp->config->feature_flags
4340 & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
4341 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
4342 && (csp->cfd != JB_INVALID_SOCKET)
4343 && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4344 && ((csp->flags & CSP_FLAG_SERVER_CONTENT_LENGTH_SET)
4345 || (csp->flags & CSP_FLAG_CHUNKED));
4347 if (!(csp->flags & CSP_FLAG_CRUNCHED)
4348 && (csp->server_connection.sfd != JB_INVALID_SOCKET))
4350 if (!(csp->flags & CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET))
4352 csp->server_connection.keep_alive_timeout = csp->config->default_server_timeout;
4354 if (!(csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
4355 || (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
4356 || !socket_is_still_alive(csp->server_connection.sfd)
4357 || !(latency < csp->server_connection.keep_alive_timeout))
4359 log_error(LOG_LEVEL_CONNECT,
4360 "Closing server socket %d connected to %s. "
4361 "Keep-alive: %u. Tainted: %u. Socket alive: %u. Timeout: %u.",
4362 csp->server_connection.sfd, csp->server_connection.host,
4363 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
4364 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
4365 socket_is_still_alive(csp->server_connection.sfd),
4366 csp->server_connection.keep_alive_timeout);
4367 #ifdef FEATURE_CONNECTION_SHARING
4368 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4370 forget_connection(csp->server_connection.sfd);
4372 #endif /* def FEATURE_CONNECTION_SHARING */
4373 #ifdef FEATURE_HTTPS_INSPECTION
4374 close_server_ssl_connection(csp);
4376 close_socket(csp->server_connection.sfd);
4377 mark_connection_closed(&csp->server_connection);
4381 if (continue_chatting && any_loaded_file_changed(csp))
4383 continue_chatting = 0;
4384 config_file_change_detected = 1;
4386 #ifdef FEATURE_HTTPS_INSPECTION
4387 if (continue_chatting && client_use_ssl(csp) &&
4388 csp->ssl_with_client_is_opened == 0)
4390 continue_chatting = 0;
4391 log_error(LOG_LEVEL_CONNECT, "Client socket %d is no longer usable. "
4392 "The TLS session has been terminated.", csp->cfd);
4396 if (continue_chatting)
4398 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
4399 && socket_is_still_alive(csp->cfd))
4401 log_error(LOG_LEVEL_CONNECT, "Client request %d has been "
4402 "pipelined on socket %d and the socket is still alive.",
4403 csp->requests_received_total+1, csp->cfd);
4404 prepare_csp_for_next_request(csp);
4408 if (0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
4410 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4412 log_error(LOG_LEVEL_CONNECT,
4413 "Waiting for the next client request on socket %d. "
4414 "Keeping the server socket %d to %s open.",
4415 csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
4419 log_error(LOG_LEVEL_CONNECT,
4420 "Waiting for the next client request on socket %d. "
4421 "No server socket to keep open.", csp->cfd);
4425 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4426 && data_is_available(csp->cfd, (int)csp->config->keep_alive_timeout)
4427 && socket_is_still_alive(csp->cfd))
4429 log_error(LOG_LEVEL_CONNECT,
4430 "Data arrived in time on client socket %d. Requests so far: %u",
4431 csp->cfd, csp->requests_received_total);
4432 prepare_csp_for_next_request(csp);
4436 #ifdef FEATURE_CONNECTION_SHARING
4437 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4438 && (csp->server_connection.sfd != JB_INVALID_SOCKET)
4439 && (socket_is_still_alive(csp->server_connection.sfd))
4440 #ifdef FEATURE_HTTPS_INSPECTION
4441 && !server_use_ssl(csp)
4445 time_t time_open = time(NULL) - csp->server_connection.timestamp;
4447 if (csp->server_connection.keep_alive_timeout < time_open - (time_t)latency)
4452 remember_connection(&csp->server_connection);
4453 csp->server_connection.sfd = JB_INVALID_SOCKET;
4454 drain_and_close_socket(csp->cfd);
4455 csp->cfd = JB_INVALID_SOCKET;
4456 privoxy_mutex_lock(&connection_reuse_mutex);
4457 if (!monitor_thread_running)
4459 monitor_thread_running = 1;
4460 privoxy_mutex_unlock(&connection_reuse_mutex);
4461 wait_for_alive_connections();
4462 privoxy_mutex_lock(&connection_reuse_mutex);
4463 monitor_thread_running = 0;
4465 privoxy_mutex_unlock(&connection_reuse_mutex);
4467 #endif /* def FEATURE_CONNECTION_SHARING */
4471 else if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4473 log_error(LOG_LEVEL_CONNECT,
4474 "Closing server socket %d connected to %s. Keep-alive: %u. "
4475 "Tainted: %u. Socket alive: %u. Timeout: %u. "
4476 "Configuration file change detected: %u",
4477 csp->server_connection.sfd, csp->server_connection.host,
4478 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
4479 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
4480 socket_is_still_alive(csp->server_connection.sfd),
4481 csp->server_connection.keep_alive_timeout,
4482 config_file_change_detected);
4484 } while (continue_chatting);
4488 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4490 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4492 #ifdef FEATURE_CONNECTION_SHARING
4493 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4495 forget_connection(csp->server_connection.sfd);
4497 #endif /* def FEATURE_CONNECTION_SHARING */
4499 #ifdef FEATURE_HTTPS_INSPECTION
4500 close_server_ssl_connection(csp);
4501 #endif /* def FEATURE_HTTPS_INSPECTION */
4503 close_socket(csp->server_connection.sfd);
4506 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4507 mark_connection_closed(&csp->server_connection);
4510 if (csp->cfd != JB_INVALID_SOCKET)
4512 log_error(LOG_LEVEL_CONNECT, "Closing client socket %d. "
4513 "Keep-alive: %u. Socket alive: %u. Data available: %u. "
4514 "Configuration file change detected: %u. Requests received: %u.",
4515 csp->cfd, 0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE),
4516 socket_is_still_alive(csp->cfd), data_is_available(csp->cfd, 0),
4517 config_file_change_detected, csp->requests_received_total);
4518 #ifdef FEATURE_HTTPS_INSPECTION
4519 close_client_ssl_connection(csp);
4521 drain_and_close_socket(csp->cfd);
4524 free_csp_resources(csp);
4526 csp->flags &= ~CSP_FLAG_ACTIVE;
4532 /*********************************************************************
4534 * Function : server_thread
4536 * Description : We only exist to call `serve' in a threaded environment.
4539 * 1 : data = Current client state (buffers, headers, etc...)
4541 * Returns : Always 0.
4543 *********************************************************************/
4544 static int32 server_thread(void *data)
4546 serve((struct client_state *) data);
4553 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
4554 /*********************************************************************
4558 * Description : Print usage info & exit.
4560 * Parameters : Pointer to argv[0] for identifying ourselves
4564 *********************************************************************/
4565 static void usage(const char *name)
4567 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
4568 "Usage: %s [--config-test] "
4571 #endif /* defined(unix) */
4574 "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
4575 #endif /* defined(unix) */
4576 "[--version] [configfile]\n",
4580 show_fuzz_usage(name);
4583 printf("Aborting\n");
4588 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
4591 #ifdef MUTEX_LOCKS_AVAILABLE
4592 /*********************************************************************
4594 * Function : privoxy_mutex_lock
4596 * Description : Locks a mutex.
4599 * 1 : mutex = The mutex to lock.
4601 * Returns : Void. May exit in case of errors.
4603 *********************************************************************/
4604 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
4606 #ifdef FEATURE_PTHREAD
4607 int err = pthread_mutex_lock(mutex);
4610 if (mutex != &log_mutex)
4612 log_error(LOG_LEVEL_FATAL,
4613 "Mutex locking failed: %s.\n", strerror(err));
4618 EnterCriticalSection(mutex);
4619 #endif /* def FEATURE_PTHREAD */
4623 /*********************************************************************
4625 * Function : privoxy_mutex_unlock
4627 * Description : Unlocks a mutex.
4630 * 1 : mutex = The mutex to unlock.
4632 * Returns : Void. May exit in case of errors.
4634 *********************************************************************/
4635 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
4637 #ifdef FEATURE_PTHREAD
4638 int err = pthread_mutex_unlock(mutex);
4641 if (mutex != &log_mutex)
4643 log_error(LOG_LEVEL_FATAL,
4644 "Mutex unlocking failed: %s.\n", strerror(err));
4649 LeaveCriticalSection(mutex);
4650 #endif /* def FEATURE_PTHREAD */
4654 /*********************************************************************
4656 * Function : privoxy_mutex_init
4658 * Description : Prepares a mutex.
4661 * 1 : mutex = The mutex to initialize.
4663 * Returns : Void. May exit in case of errors.
4665 *********************************************************************/
4666 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
4668 #ifdef FEATURE_PTHREAD
4669 int err = pthread_mutex_init(mutex, 0);
4672 printf("Fatal error. Mutex initialization failed: %s.\n",
4677 InitializeCriticalSection(mutex);
4678 #endif /* def FEATURE_PTHREAD */
4680 #endif /* def MUTEX_LOCKS_AVAILABLE */
4682 /*********************************************************************
4684 * Function : initialize_mutexes
4686 * Description : Prepares mutexes if mutex support is available.
4690 * Returns : Void, exits in case of errors.
4692 *********************************************************************/
4693 static void initialize_mutexes(void)
4695 #ifdef MUTEX_LOCKS_AVAILABLE
4697 * Prepare global mutex semaphores
4700 #ifdef FEATURE_HTTPS_INSPECTION
4701 privoxy_mutex_init(&certificate_mutex);
4702 privoxy_mutex_init(&ssl_init_mutex);
4705 privoxy_mutex_init(&log_mutex);
4706 privoxy_mutex_init(&log_init_mutex);
4707 privoxy_mutex_init(&connection_reuse_mutex);
4708 #ifdef FEATURE_EXTERNAL_FILTERS
4709 privoxy_mutex_init(&external_filter_mutex);
4711 #ifdef FEATURE_CLIENT_TAGS
4712 privoxy_mutex_init(&client_tags_mutex);
4714 #ifdef FEATURE_EXTENDED_STATISTICS
4715 privoxy_mutex_init(&filter_statistics_mutex);
4716 privoxy_mutex_init(&block_statistics_mutex);
4720 * XXX: The assumptions below are a bit naive
4721 * and can cause locks that aren't necessary.
4723 * For example older FreeBSD versions (< 6.x?)
4724 * have no gethostbyname_r, but gethostbyname is
4727 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
4728 privoxy_mutex_init(&resolver_mutex);
4729 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
4731 * XXX: should we use a single mutex for
4732 * localtime() and gmtime() as well?
4734 #ifndef HAVE_GMTIME_R
4735 privoxy_mutex_init(&gmtime_mutex);
4736 #endif /* ndef HAVE_GMTIME_R */
4738 #ifndef HAVE_LOCALTIME_R
4739 privoxy_mutex_init(&localtime_mutex);
4740 #endif /* ndef HAVE_GMTIME_R */
4742 #if !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM)
4743 privoxy_mutex_init(&rand_mutex);
4744 #endif /* !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM) */
4746 #endif /* def MUTEX_LOCKS_AVAILABLE */
4749 /*********************************************************************
4753 * Description : Load the config file and start the listen loop.
4754 * This function is a lot more *sane* with the `load_config'
4755 * and `listen_loop' functions; although it stills does
4756 * a *little* too much for my taste.
4759 * 1 : argc = Number of parameters (including $0).
4760 * 2 : argv = Array of (char *)'s to the parameters.
4762 * Returns : 1 if : can't open config file, unrecognized directive,
4763 * stats requested in multi-thread mode, can't open the
4764 * log file, can't open the jar file, listen port is invalid,
4765 * any load fails, and can't bind port.
4767 * Else main never returns, the process must be signaled
4768 * to terminate execution. Or, on Windows, use the
4769 * "File", "Exit" menu option.
4771 *********************************************************************/
4773 int real_main(int argc, char **argv)
4775 int main(int argc, char **argv)
4779 int do_config_test = 0;
4780 #ifndef HAVE_ARC4RANDOM
4781 unsigned int random_seed;
4784 struct passwd *pw = NULL;
4785 struct group *grp = NULL;
4787 char *pre_chroot_nslookup_to_load_resolver = NULL;
4790 char *fuzz_input_type = NULL;
4791 char *fuzz_input_file = NULL;
4798 #if !defined(_WIN32)
4805 /* Prepare mutexes if supported and necessary. */
4806 initialize_mutexes();
4808 /* Enable logging until further notice. */
4812 * Parse the command line arguments
4814 * XXX: simply printing usage information in case of
4815 * invalid arguments isn't particularly user friendly.
4817 while (++argc_pos < argc)
4820 /* Check to see if the service must be installed or uninstalled */
4821 if (strncmp(argv[argc_pos], "--install", 9) == 0)
4823 const char *pName = argv[argc_pos] + 9;
4826 exit((install_service(pName)) ? 0 : 1);
4828 else if (strncmp(argv[argc_pos], "--uninstall", 11) == 0)
4830 const char *pName = argv[argc_pos] + 11;
4833 exit((uninstall_service(pName)) ? 0 : 1);
4835 else if (strcmp(argv[argc_pos], "--service") == 0)
4837 bRunAsService = TRUE;
4838 w32_set_service_cwd();
4839 atexit(w32_service_exit_notify);
4842 #endif /* defined(_WIN32) */
4845 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
4847 if (strcmp(argv[argc_pos], "--help") == 0)
4852 else if (strcmp(argv[argc_pos], "--version") == 0)
4854 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
4860 else if (strcmp(argv[argc_pos], "--no-daemon") == 0)
4862 set_debug_level(LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
4866 else if (strcmp(argv[argc_pos], "--pidfile") == 0)
4868 if (++argc_pos == argc) usage(argv[0]);
4869 pidfile = strdup_or_die(argv[argc_pos]);
4872 else if (strcmp(argv[argc_pos], "--user") == 0)
4877 if (++argc_pos == argc) usage(argv[argc_pos]);
4879 user_arg = strdup_or_die(argv[argc_pos]);
4880 group_name = strchr(user_arg, '.');
4881 if (NULL != group_name)
4883 /* Nul-terminate the user name */
4886 /* Skip the former delimiter to actually reach the group name */
4889 grp = getgrnam(group_name);
4892 log_error(LOG_LEVEL_FATAL, "Group '%s' not found.", group_name);
4895 pw = getpwnam(user_arg);
4898 log_error(LOG_LEVEL_FATAL, "User '%s' not found.", user_arg);
4904 else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup") == 0)
4906 if (++argc_pos == argc) usage(argv[0]);
4907 pre_chroot_nslookup_to_load_resolver = strdup_or_die(argv[argc_pos]);
4910 else if (strcmp(argv[argc_pos], "--chroot") == 0)
4914 #endif /* defined(unix) */
4916 else if (strcmp(argv[argc_pos], "--config-test") == 0)
4921 else if (strcmp(argv[argc_pos], "--fuzz") == 0)
4924 if (argc < argc_pos + 2) usage(argv[0]);
4925 fuzz_input_type = argv[argc_pos];
4927 fuzz_input_file = argv[argc_pos];
4929 else if (strcmp(argv[argc_pos], "--stfu") == 0)
4931 set_debug_level(LOG_LEVEL_STFU);
4934 else if (argc_pos + 1 != argc)
4937 * This is neither the last command line
4938 * option, nor was it recognized before,
4939 * therefore it must be invalid.
4945 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
4947 configfile = argv[argc_pos];
4950 } /* -END- while (more arguments) */
4952 show_version(Argv[0]);
4955 if (*configfile != '/')
4957 char cwd[BUFFER_SIZE];
4959 size_t abs_file_size;
4961 /* make config-filename absolute here */
4962 if (NULL == getcwd(cwd, sizeof(cwd)))
4964 perror("failed to get current working directory");
4968 basedir = strdup_or_die(cwd);
4970 abs_file_size = strlen(cwd) + strlen(configfile) + 5;
4971 abs_file = malloc_or_die(abs_file_size);
4972 strlcpy(abs_file, basedir, abs_file_size);
4973 strlcat(abs_file, "/", abs_file_size);
4974 strlcat(abs_file, configfile, abs_file_size);
4975 configfile = abs_file;
4977 #endif /* defined unix */
4981 clients->next = NULL;
4983 /* XXX: factor out initialising after the next stable release. */
4988 #ifndef HAVE_ARC4RANDOM
4989 random_seed = (unsigned int)time(NULL);
4991 srandom(random_seed);
4994 #endif /* ifdef HAVE_RANDOM */
4995 #endif /* ifndef HAVE_ARC4RANDOM */
4998 * Unix signal handling
5000 * Catch the abort, interrupt and terminate signals for a graceful exit
5001 * Catch the hangup signal so the errlog can be reopened.
5003 * Ignore the broken pipe signal as connection failures
5004 * are handled when and where they occur without relying
5007 #if !defined(_WIN32)
5010 const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP };
5012 for (idx = 0; idx < SZ(catched_signals); idx++)
5014 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
5015 if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
5017 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
5018 #endif /* ifdef sun */
5020 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
5024 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
5026 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for SIGPIPE: %E");
5030 #else /* ifdef _WIN32 */
5031 # ifdef _WIN_CONSOLE
5033 * We *are* in a windows console app.
5034 * Print a verbose messages about FAQ's and such
5036 printf("%s", win32_blurb);
5037 # endif /* def _WIN_CONSOLE */
5038 #endif /* def _WIN32 */
5041 if (fuzz_input_type != NULL)
5043 exit(process_fuzzed_input(fuzz_input_type, fuzz_input_file));
5045 log_error(LOG_LEVEL_FATAL,
5046 "When compiled with fuzzing support, Privoxy should only be used for fuzzing. "
5047 "Various data structures are static which is unsafe when using threads.");
5052 exit(NULL == load_config());
5055 /* Initialize the CGI subsystem */
5056 cgi_init_error_messages();
5059 * If running on unix and without the --no-daemon
5060 * option, become a daemon. I.e. fork, detach
5061 * from tty and get process group leadership
5070 if (pid < 0) /* error */
5075 else if (pid != 0) /* parent */
5080 * must check for errors
5081 * child died due to missing files aso
5084 wpid = waitpid(pid, &status, WNOHANG);
5096 * stderr (fd 2) will be closed later on,
5097 * when the config file has been parsed.
5103 * Reserve fd 0 and 1 to prevent abort() and friends
5104 * from sending stuff to the clients or servers.
5106 fd = open("/dev/null", O_RDONLY);
5109 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
5113 if (dup2(fd, 0) == -1)
5115 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 0: %E");
5119 fd = open("/dev/null", O_WRONLY);
5122 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
5126 if (dup2(fd, 1) == -1)
5128 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 1: %E");
5133 #ifdef FEATURE_EXTERNAL_FILTERS
5134 for (fd = 0; fd < 3; fd++)
5136 mark_socket_for_close_on_execute(fd);
5142 } /* -END- if (daemon_mode) */
5145 * As soon as we have written the PID file, we can switch
5146 * to the user and group ID indicated by the --user option
5148 if (pidfile != NULL)
5150 write_pid_file(pidfile);
5154 if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
5156 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
5160 if (setgroups(1, &grp->gr_gid))
5162 log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
5165 else if (initgroups(pw->pw_name, pw->pw_gid))
5167 log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
5173 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
5175 /* Read the time zone file from /etc before doing chroot. */
5177 if (NULL != pre_chroot_nslookup_to_load_resolver
5178 && '\0' != pre_chroot_nslookup_to_load_resolver[0])
5180 /* Initialize resolver library. */
5181 (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
5183 if (chroot(pw->pw_dir) < 0)
5185 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
5189 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
5192 if (setuid(pw->pw_uid))
5194 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
5198 char putenv_dummy[64];
5200 strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
5201 if (putenv(putenv_dummy) != 0)
5203 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
5206 snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
5207 if (putenv(putenv_dummy) != 0)
5209 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
5215 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
5218 #endif /* defined unix */
5221 /* This will be FALSE unless the command line specified --service
5225 /* Yup, so now we must attempt to establish a connection
5226 * with the service dispatcher. This will only work if this
5227 * process was launched by the service control manager to
5228 * actually run as a service. If this isn't the case, i've
5229 * known it take around 30 seconds or so for the call to return.
5232 /* The StartServiceCtrlDispatcher won't return until the service is stopping */
5233 if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
5235 /* Service has run, and at this point is now being stopped, so just return */
5240 printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
5242 /* An error occurred. Usually it's because --service was wrongly specified
5243 * and we were unable to connect to the Service Control Dispatcher because
5244 * it wasn't expecting us and is therefore not listening.
5246 * For now, just continue below to call the listen_loop function.
5249 #endif /* def _WIN32 */
5259 /*********************************************************************
5261 * Function : bind_port_helper
5263 * Description : Bind the listen port. Handles logging, and aborts
5267 * 1 : haddr = Host address to bind to. Use NULL to bind to
5269 * 2 : hport = Specifies port to bind to.
5270 * 3 : backlog = Listen backlog.
5272 * Returns : Port that was opened.
5274 *********************************************************************/
5275 static jb_socket bind_port_helper(const char *haddr, int hport, int backlog)
5280 result = bind_port(haddr, hport, backlog, &bfd);
5284 const char *bind_address = (NULL != haddr) ? haddr : "INADDR_ANY";
5288 log_error(LOG_LEVEL_FATAL,
5289 "can't bind to %s:%d: There may be another Privoxy "
5290 "or some other proxy running on port %d",
5291 bind_address, hport, hport);
5294 log_error(LOG_LEVEL_FATAL,
5295 "can't bind to %s:%d: The hostname is not resolvable",
5296 bind_address, hport);
5299 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: %E",
5300 bind_address, hport);
5303 /* shouldn't get here */
5304 return JB_INVALID_SOCKET;
5309 if (bfd >= FD_SETSIZE)
5311 log_error(LOG_LEVEL_FATAL,
5312 "Bind socket number too high to use select(): %d >= %d",
5320 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
5325 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
5333 /*********************************************************************
5335 * Function : bind_ports_helper
5337 * Description : Bind the listen ports. Handles logging, and aborts
5341 * 1 : config = Privoxy configuration. Specifies ports
5343 * 2 : sockets = Preallocated array of opened sockets
5344 * corresponding to specification in config.
5345 * All non-opened sockets will be set to
5346 * JB_INVALID_SOCKET.
5348 * Returns : Nothing. Inspect sockets argument.
5350 *********************************************************************/
5351 static void bind_ports_helper(struct configuration_spec * config,
5352 jb_socket sockets[])
5356 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
5358 if (config->hport[i])
5360 sockets[i] = bind_port_helper(config->haddr[i],
5361 config->hport[i], config->listen_backlog);
5362 #if defined(FEATURE_ACCEPT_FILTER) && defined(SO_ACCEPTFILTER)
5363 if (config->enable_accept_filter && sockets[i] != JB_INVALID_SOCKET)
5365 struct accept_filter_arg af_options;
5366 bzero(&af_options, sizeof(af_options));
5367 strlcpy(af_options.af_name, "httpready", sizeof(af_options.af_name));
5368 if (setsockopt(sockets[i], SOL_SOCKET, SO_ACCEPTFILTER, &af_options,
5369 sizeof(af_options)))
5371 log_error(LOG_LEVEL_ERROR,
5372 "Enabling accept filter for socket %d failed: %E", sockets[i]);
5379 sockets[i] = JB_INVALID_SOCKET;
5382 config->need_bind = 0;
5386 /*********************************************************************
5388 * Function : close_ports_helper
5390 * Description : Close listenings ports.
5393 * 1 : sockets = Array of opened and non-opened sockets to
5394 * close. All sockets will be set to
5395 * JB_INVALID_SOCKET.
5397 * Returns : Nothing.
5399 *********************************************************************/
5400 static void close_ports_helper(jb_socket sockets[])
5404 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
5406 if (JB_INVALID_SOCKET != sockets[i])
5408 close_socket(sockets[i]);
5410 sockets[i] = JB_INVALID_SOCKET;
5416 /* Without this simple workaround we get this compiler warning from _beginthread
5417 * warning C4028: formal parameter 1 different from declaration
5419 void w32_service_listen_loop(void *p)
5423 #endif /* def _WIN32 */
5426 /*********************************************************************
5428 * Function : listen_loop
5430 * Description : bind the listen port and enter a "FOREVER" listening loop.
5436 *********************************************************************/
5437 static void listen_loop(void)
5439 struct client_states *csp_list = NULL;
5440 struct client_state *csp = NULL;
5441 jb_socket bfds[MAX_LISTENING_SOCKETS];
5442 struct configuration_spec *config;
5443 unsigned int active_threads = 0;
5444 #if defined(FEATURE_PTHREAD)
5445 pthread_attr_t attrs;
5447 pthread_attr_init(&attrs);
5448 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
5451 config = load_config();
5453 #ifdef FEATURE_CONNECTION_SHARING
5455 * XXX: Should be relocated once it no
5456 * longer needs to emit log messages.
5458 initialize_reusable_connections();
5459 #endif /* def FEATURE_CONNECTION_SHARING */
5461 bind_ports_helper(config, bfds);
5463 #ifdef FEATURE_GRACEFUL_TERMINATION
5464 while (!g_terminate)
5469 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__)
5470 while (waitpid(-1, NULL, WNOHANG) > 0)
5472 /* zombie children */
5474 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) */
5477 * Free data that was used by died threads
5479 active_threads = sweep();
5483 * Re-open the errlog after HUP signal
5485 if (received_hup_signal)
5487 if (NULL != config->logfile)
5489 init_error_log(Argv[0], config->logfile);
5491 received_hup_signal = 0;
5495 csp_list = zalloc_or_die(sizeof(*csp_list));
5496 csp = &csp_list->csp;
5498 log_error(LOG_LEVEL_CONNECT,
5499 "Waiting for the next client connection. Currently active threads: %d",
5503 * This config may be outdated, but for accept_connection()
5504 * it's fresh enough.
5506 csp->config = config;
5508 if (!accept_connection(csp, bfds))
5510 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
5515 csp->flags |= CSP_FLAG_ACTIVE;
5516 csp->server_connection.sfd = JB_INVALID_SOCKET;
5518 csp->config = config = load_config();
5520 if (config->need_bind)
5523 * Since we were listening to the "old port", we will not see
5524 * a "listen" param change until the next request. So, at
5525 * least 1 more request must be made for us to find the new
5526 * setting. I am simply closing the old socket and binding the
5529 * Which-ever is correct, we will serve 1 more page via the
5530 * old settings. This should probably be a "show-status"
5531 * request. This should not be a so common of an operation
5532 * that this will hurt people's feelings.
5535 close_ports_helper(bfds);
5537 bind_ports_helper(config, bfds);
5540 #ifdef FEATURE_TOGGLE
5541 if (global_toggle_state)
5542 #endif /* def FEATURE_TOGGLE */
5544 csp->flags |= CSP_FLAG_TOGGLED_ON;
5547 if (run_loader(csp))
5549 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
5550 /* Never get here - LOG_LEVEL_FATAL causes program exit */
5554 if (block_acl(NULL,csp))
5556 log_error(LOG_LEVEL_CONNECT,
5557 "Connection from %s on %s (socket %d) dropped due to ACL",
5558 csp->ip_addr_str, csp->listen_addr_str, csp->cfd);
5559 close_socket(csp->cfd);
5560 freez(csp->ip_addr_str);
5561 freez(csp->listen_addr_str);
5565 #endif /* def FEATURE_ACL */
5567 if ((0 != config->max_client_connections)
5568 && (active_threads >= config->max_client_connections))
5570 log_error(LOG_LEVEL_CONNECT,
5571 "Rejecting connection from %s. Maximum number of connections reached.",
5573 write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
5574 strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
5575 close_socket(csp->cfd);
5576 freez(csp->ip_addr_str);
5577 freez(csp->listen_addr_str);
5582 /* add it to the list of clients */
5583 csp_list->next = clients->next;
5584 clients->next = csp_list;
5586 if (config->multi_threaded)
5590 /* this is a switch () statement in the C preprocessor - ugh */
5591 #undef SELECTED_ONE_OPTION
5593 /* Use Pthreads in preference to native code */
5594 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
5595 #define SELECTED_ONE_OPTION
5597 pthread_t the_thread;
5600 ret = pthread_create(&the_thread, &attrs,
5601 (void * (*)(void *))serve, csp);
5602 child_id = ret ? -1 : 0;
5606 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
5607 #define SELECTED_ONE_OPTION
5608 child_id = _beginthread(
5609 (void (*)(void *))serve,
5614 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
5615 #define SELECTED_ONE_OPTION
5617 thread_id tid = spawn_thread
5618 (server_thread, "server", B_NORMAL_PRIORITY, csp);
5620 if ((tid >= 0) && (resume_thread(tid) == B_OK))
5622 child_id = (int) tid;
5631 #if !defined(SELECTED_ONE_OPTION)
5634 /* This block is only needed when using fork().
5635 * When using threads, the server thread was
5636 * created and run by the call to _beginthread().
5638 if (child_id == 0) /* child */
5641 #ifdef FEATURE_TOGGLE
5642 int inherited_toggle_state = global_toggle_state;
5643 #endif /* def FEATURE_TOGGLE */
5648 * If we've been toggled or we've blocked the request, tell Mom
5651 #ifdef FEATURE_TOGGLE
5652 if (inherited_toggle_state != global_toggle_state)
5654 rc |= RC_FLAG_TOGGLED;
5656 #endif /* def FEATURE_TOGGLE */
5658 #ifdef FEATURE_STATISTICS
5659 if (csp->flags & CSP_FLAG_REJECTED)
5661 rc |= RC_FLAG_BLOCKED;
5663 #endif /* ndef FEATURE_STATISTICS */
5667 else if (child_id > 0) /* parent */
5669 /* in a fork()'d environment, the parent's
5670 * copy of the client socket and the CSP
5674 #if !defined(_WIN32) && !defined(__CYGWIN__)
5676 wait(&child_status);
5679 * Evaluate child's return code: If the child has
5680 * - been toggled, toggle ourselves
5681 * - blocked its request, bump up the stats counter
5684 #ifdef FEATURE_TOGGLE
5685 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
5687 global_toggle_state = !global_toggle_state;
5689 #endif /* def FEATURE_TOGGLE */
5691 #ifdef FEATURE_STATISTICS
5693 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
5697 #endif /* def FEATURE_STATISTICS */
5699 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
5700 close_socket(csp->cfd);
5701 csp->flags &= ~CSP_FLAG_ACTIVE;
5705 #undef SELECTED_ONE_OPTION
5706 /* end of cpp switch () */
5711 * Spawning the child failed, assume it's because
5712 * there are too many children running already.
5713 * XXX: If you assume ...
5715 log_error(LOG_LEVEL_ERROR,
5716 "Unable to take any additional connections: %E. Active threads: %d",
5718 write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
5719 strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
5720 close_socket(csp->cfd);
5721 csp->flags &= ~CSP_FLAG_ACTIVE;
5730 #if defined(FEATURE_PTHREAD)
5731 pthread_attr_destroy(&attrs);
5734 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
5736 #ifdef FEATURE_HTTPS_INSPECTION
5737 /* Clean up. Aim: free all memory (no leaks) */
5741 #ifdef FEATURE_GRACEFUL_TERMINATION
5743 log_error(LOG_LEVEL_INFO, "Graceful termination requested");
5745 unload_current_config_file();
5746 unload_current_actions_file();
5747 unload_current_re_filterfile();
5748 #ifdef FEATURE_TRUST
5749 unload_current_trust_file();
5752 if (config->multi_threaded)
5759 } while ((clients->next != NULL) && (--i > 0));
5763 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
5773 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
5774 /* Cleanup - remove taskbar icon etc. */
5779 #endif /* FEATURE_GRACEFUL_TERMINATION */