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 */
65 # if !defined (__OS2__)
67 # include <sys/wait.h>
68 # endif /* ndef __OS2__ */
69 # include <sys/time.h>
70 # include <sys/stat.h>
71 # include <sys/ioctl.h>
74 #include <sys/termios.h>
85 # include <socket.h> /* BeOS has select() for sockets only. */
86 # include <OS.h> /* declarations for threads and stuff. */
89 # if defined(__EMX__) || defined(__OS2__)
90 # include <sys/select.h> /* OS/2/EMX needs a little help with select */
102 #endif /* def __GLIBC__ */
107 #warning poll() appears to be unavailable. Your platform will become unsupported in the future.
108 #endif /* HAVE_POLL */
115 #ifdef FEATURE_HTTPS_INSPECTION
121 #include "miscutil.h"
123 #include "jbsockets.h"
128 #include "urlmatch.h"
129 #ifdef FEATURE_CLIENT_TAGS
130 #include "client-tags.h"
134 struct client_states clients[1];
135 struct file_list files[1];
137 #ifdef FEATURE_STATISTICS
138 int urls_read = 0; /* total nr of urls read inc rejected */
139 int urls_rejected = 0; /* total nr of urls rejected */
140 #endif /* def FEATURE_STATISTICS */
142 #ifdef FEATURE_GRACEFUL_TERMINATION
146 #if !defined(_WIN32) && !defined(__OS2__)
147 static void sig_handler(int the_signal);
149 static int client_protocol_is_unsupported(const struct client_state *csp, char *req);
150 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers);
151 static jb_err get_server_headers(struct client_state *csp);
152 static const char *crunch_reason(const struct http_response *rsp);
153 static void send_crunch_response(struct client_state *csp, struct http_response *rsp);
154 static char *get_request_line(struct client_state *csp);
155 static jb_err receive_client_request(struct client_state *csp);
156 static jb_err parse_client_request(struct client_state *csp);
157 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line);
158 static jb_err change_request_destination(struct client_state *csp);
159 static void chat(struct client_state *csp);
160 static void serve(struct client_state *csp);
161 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
162 static void usage(const char *myname);
164 static void initialize_mutexes(void);
165 static jb_socket bind_port_helper(const char *haddr, int hport, int backlog);
166 static void bind_ports_helper(struct configuration_spec *config, jb_socket sockets[]);
167 static void close_ports_helper(jb_socket sockets[]);
168 static void listen_loop(void);
169 static void serve(struct client_state *csp);
172 static int32 server_thread(void *data);
173 #endif /* def __BEOS__ */
176 #define sleep(N) Sleep(((N) * 1000))
180 #define sleep(N) DosSleep(((N) * 100))
184 int process_fuzzed_input(char *fuzz_input_type, char *fuzz_input_file);
185 void show_fuzz_usage(const char *name);
188 #ifdef MUTEX_LOCKS_AVAILABLE
190 * XXX: Does the locking stuff really belong in this file?
192 privoxy_mutex_t log_mutex;
193 privoxy_mutex_t log_init_mutex;
194 privoxy_mutex_t connection_reuse_mutex;
196 #ifdef FEATURE_HTTPS_INSPECTION
197 privoxy_mutex_t certificate_mutex;
198 privoxy_mutex_t rng_mutex;
201 #ifdef FEATURE_EXTERNAL_FILTERS
202 privoxy_mutex_t external_filter_mutex;
204 #ifdef FEATURE_CLIENT_TAGS
205 privoxy_mutex_t client_tags_mutex;
208 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
209 privoxy_mutex_t resolver_mutex;
210 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
212 #ifndef HAVE_GMTIME_R
213 privoxy_mutex_t gmtime_mutex;
214 #endif /* ndef HAVE_GMTIME_R */
216 #ifndef HAVE_LOCALTIME_R
217 privoxy_mutex_t localtime_mutex;
218 #endif /* ndef HAVE_GMTIME_R */
220 #if !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM)
221 privoxy_mutex_t rand_mutex;
222 #endif /* !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM) */
224 #endif /* def MUTEX_LOCKS_AVAILABLE */
227 const char *basedir = NULL;
228 const char *pidfile = NULL;
229 static int received_hup_signal = 0;
230 #endif /* defined unix */
232 /* HTTP snipplets. */
233 static const char CSUCCEED[] =
234 "HTTP/1.1 200 Connection established\r\n\r\n";
236 static const char CHEADER[] =
237 "HTTP/1.1 400 Invalid header received from client\r\n"
238 "Content-Type: text/plain\r\n"
239 "Connection: close\r\n\r\n"
240 "Invalid header received from client.\r\n";
242 static const char FTP_RESPONSE[] =
243 "HTTP/1.1 400 Invalid request received from client\r\n"
244 "Content-Type: text/plain\r\n"
245 "Connection: close\r\n\r\n"
246 "Invalid request. Privoxy doesn't support FTP.\r\n";
248 static const char GOPHER_RESPONSE[] =
249 "HTTP/1.1 400 Invalid request received from client\r\n"
250 "Content-Type: text/plain\r\n"
251 "Connection: close\r\n\r\n"
252 "Invalid request. Privoxy doesn't support gopher.\r\n";
254 /* XXX: should be a template */
255 static const char MISSING_DESTINATION_RESPONSE[] =
256 "HTTP/1.1 400 Bad request received from client\r\n"
257 "Content-Type: text/plain\r\n"
258 "Connection: close\r\n\r\n"
259 "Bad request. Privoxy was unable to extract the destination.\r\n";
261 /* XXX: should be a template */
262 static const char INVALID_SERVER_HEADERS_RESPONSE[] =
263 "HTTP/1.1 502 Server or forwarder response invalid\r\n"
264 "Content-Type: text/plain\r\n"
265 "Connection: close\r\n\r\n"
266 "Bad response. The server or forwarder response doesn't look like HTTP.\r\n";
268 /* XXX: should be a template */
269 static const char MESSED_UP_REQUEST_RESPONSE[] =
270 "HTTP/1.1 400 Malformed request after rewriting\r\n"
271 "Content-Type: text/plain\r\n"
272 "Connection: close\r\n\r\n"
273 "Bad request. Messed up with header filters.\r\n";
275 static const char TOO_MANY_CONNECTIONS_RESPONSE[] =
276 "HTTP/1.1 503 Too many open connections\r\n"
277 "Content-Type: text/plain\r\n"
278 "Connection: close\r\n\r\n"
279 "Maximum number of open connections reached.\r\n";
281 static const char CLIENT_CONNECTION_TIMEOUT_RESPONSE[] =
282 "HTTP/1.1 504 Connection timeout\r\n"
283 "Content-Type: text/plain\r\n"
284 "Connection: close\r\n\r\n"
285 "The connection timed out because the client request didn't arrive in time.\r\n";
287 static const char CLIENT_BODY_PARSE_ERROR_RESPONSE[] =
288 "HTTP/1.1 400 Failed reading client body\r\n"
289 "Content-Type: text/plain\r\n"
290 "Connection: close\r\n\r\n"
291 "Failed parsing or buffering the chunk-encoded client body.\r\n";
293 static const char UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE[] =
294 "HTTP/1.1 417 Expecting too much\r\n"
295 "Content-Type: text/plain\r\n"
296 "Connection: close\r\n\r\n"
297 "Privoxy detected an unsupported Expect header value.\r\n";
299 /* A function to crunch a response */
300 typedef struct http_response *(*crunch_func_ptr)(struct client_state *);
302 /* Crunch function flags */
303 #define CF_NO_FLAGS 0
304 /* Cruncher applies to forced requests as well */
305 #define CF_IGNORE_FORCE 1
306 /* Crunched requests are counted for the block statistics */
307 #define CF_COUNT_AS_REJECT 2
309 /* A crunch function and its flags */
312 const crunch_func_ptr cruncher;
316 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[]);
318 /* Complete list of cruncher functions */
319 static const struct cruncher crunchers_all[] = {
320 { direct_response, CF_COUNT_AS_REJECT|CF_IGNORE_FORCE},
321 { block_url, CF_COUNT_AS_REJECT },
323 { trust_url, CF_COUNT_AS_REJECT },
324 #endif /* def FEATURE_TRUST */
325 { redirect_url, CF_NO_FLAGS },
326 { dispatch_cgi, CF_IGNORE_FORCE},
330 /* Light version, used after tags are applied */
331 static const struct cruncher crunchers_light[] = {
332 { block_url, CF_COUNT_AS_REJECT },
333 { redirect_url, CF_NO_FLAGS },
339 * XXX: Don't we really mean
345 #if !defined(_WIN32) && !defined(__OS2__)
346 /*********************************************************************
348 * Function : sig_handler
350 * Description : Signal handler for different signals.
351 * Exit gracefully on TERM and INT
352 * or set a flag that will cause the errlog
353 * to be reopened by the main thread on HUP.
356 * 1 : the_signal = the signal cause this function to call
360 *********************************************************************/
361 static void sig_handler(int the_signal)
367 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
379 received_hup_signal = 1;
385 * We shouldn't be here, unless we catch signals
386 * in main() that we can't handle here!
388 log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
396 /*********************************************************************
398 * Function : get_write_delay
400 * Description : Parse the delay-response parameter.
403 * 1 : csp = Current client state (buffers, headers, etc...)
405 * Returns : Number of milliseconds to delay writes.
407 *********************************************************************/
408 static unsigned int get_write_delay(const struct client_state *csp)
414 if ((csp->action->flags & ACTION_DELAY_RESPONSE) == 0)
418 newval = csp->action->string[ACTION_STRING_DELAY_RESPONSE];
420 delay = (unsigned)strtol(newval, &endptr, 0);
423 log_error(LOG_LEVEL_FATAL,
424 "Invalid delay-response{} parameter: '%s'", newval);
432 /*********************************************************************
434 * Function : client_protocol_is_unsupported
436 * Description : Checks if the client used a known unsupported
437 * protocol and deals with it by sending an error
441 * 1 : csp = Current client state (buffers, headers, etc...)
442 * 2 : req = the first request line send by the client
444 * Returns : TRUE if an error response has been generated, or
445 * FALSE if the request doesn't look invalid.
447 *********************************************************************/
448 static int client_protocol_is_unsupported(const struct client_state *csp, char *req)
451 * If it's a FTP or gopher request, we don't support it.
453 * These checks are better than nothing, but they might
454 * not work in all configurations and some clients might
455 * have problems digesting the answer.
457 * They should, however, never cause more problems than
458 * Privoxy's old behaviour (returning the misleading HTML
461 * "Could not resolve http://(ftp|gopher)://example.org").
463 if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
465 const char *response = NULL;
466 const char *protocol = NULL;
468 if (!strncmpic(req, "GET ftp://", 10))
470 response = FTP_RESPONSE;
475 response = GOPHER_RESPONSE;
478 log_error(LOG_LEVEL_ERROR,
479 "%s tried to use Privoxy as %s proxy: %s",
480 csp->ip_addr_str, protocol, req);
481 log_error(LOG_LEVEL_CLF,
482 "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, req);
484 write_socket_delayed(csp->cfd, response, strlen(response),
485 get_write_delay(csp));
494 /*********************************************************************
496 * Function : client_has_unsupported_expectations
498 * Description : Checks if the client used an unsupported expectation
499 * in which case an error message is delivered.
502 * 1 : csp = Current client state (buffers, headers, etc...)
504 * Returns : TRUE if an error response has been generated, or
505 * FALSE if the request doesn't look invalid.
507 *********************************************************************/
508 static int client_has_unsupported_expectations(const struct client_state *csp)
510 if ((csp->flags & CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION))
512 log_error(LOG_LEVEL_ERROR,
513 "Rejecting request from client %s with unsupported Expect header value",
515 log_error(LOG_LEVEL_CLF,
516 "%s - - [%T] \"%s\" 417 0", csp->ip_addr_str, csp->http->cmd);
517 write_socket_delayed(csp->cfd,
518 UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE,
519 strlen(UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE),
520 get_write_delay(csp));
530 /*********************************************************************
532 * Function : get_request_destination_elsewhere
534 * Description : If the client's request was redirected into
535 * Privoxy without the client's knowledge,
536 * the request line lacks the destination host.
538 * This function tries to get it elsewhere,
539 * provided accept-intercepted-requests is enabled.
541 * "Elsewhere" currently only means "Host: header",
542 * but in the future we may ask the redirecting
543 * packet filter to look the destination up.
545 * If the destination stays unknown, an error
546 * response is send to the client and headers
547 * are freed so that chat() can return directly.
550 * 1 : csp = Current client state (buffers, headers, etc...)
551 * 2 : headers = a header list
553 * Returns : JB_ERR_OK if the destination is now known, or
554 * JB_ERR_PARSE if it isn't.
556 *********************************************************************/
557 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
561 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
563 log_error(LOG_LEVEL_ERROR, "%s's request: \'%s\' is invalid."
564 " Privoxy isn't configured to accept intercepted requests.",
565 csp->ip_addr_str, csp->http->cmd);
566 /* XXX: Use correct size */
567 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
568 csp->ip_addr_str, csp->http->cmd);
570 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER),
571 get_write_delay(csp));
572 destroy_list(headers);
576 else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
578 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
579 /* Split the domain we just got for pattern matching */
580 init_domain_components(csp->http);
587 /* We can't work without destination. Go spread the news.*/
589 req = list_to_text(headers);
591 /* XXX: Use correct size */
592 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
593 csp->ip_addr_str, csp->http->cmd);
594 log_error(LOG_LEVEL_ERROR,
595 "Privoxy was unable to get the destination for %s's request:\n%s\n%s",
596 csp->ip_addr_str, csp->http->cmd, req);
599 write_socket_delayed(csp->cfd, MISSING_DESTINATION_RESPONSE,
600 strlen(MISSING_DESTINATION_RESPONSE), get_write_delay(csp));
601 destroy_list(headers);
606 * TODO: If available, use PF's ioctl DIOCNATLOOK as last resort
607 * to get the destination IP address, use it as host directly
608 * or do a reverse DNS lookup first.
613 /*********************************************************************
615 * Function : get_server_headers
617 * Description : Parses server headers in iob and fills them
618 * into csp->headers so that they can later be
622 * 1 : csp = Current client state (buffers, headers, etc...)
624 * Returns : JB_ERR_OK if everything went fine, or
625 * JB_ERR_PARSE if the headers were incomplete.
627 *********************************************************************/
628 static jb_err get_server_headers(struct client_state *csp)
630 int continue_hack_in_da_house = 0;
633 while (((header = get_header(csp->iob)) != NULL) || continue_hack_in_da_house)
638 * continue hack in da house. Ignore the ending of
639 * this head and continue enlisting header lines.
640 * The reason is described below.
642 enlist(csp->headers, "");
643 continue_hack_in_da_house = 0;
646 else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
649 * It's a bodyless continue response, don't
650 * stop header parsing after reaching its end.
652 * As a result Privoxy will concatenate the
653 * next response's head and parse and deliver
654 * the headers as if they belonged to one request.
656 * The client will separate them because of the
657 * empty line between them.
659 * XXX: What we're doing here is clearly against
660 * the intended purpose of the continue header,
661 * and under some conditions (HTTP/1.0 client request)
662 * it's a standard violation.
664 * Anyway, "sort of against the spec" is preferable
665 * to "always getting confused by Continue responses"
666 * (Privoxy's behaviour before this hack was added)
668 log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
669 continue_hack_in_da_house = 1;
671 else if (*header == '\0')
674 * If the header is empty, but the Continue hack
675 * isn't active, we can assume that we reached the
676 * end of the buffer before we hit the end of the
679 * Inform the caller an let it decide how to handle it.
684 if (JB_ERR_MEMORY == enlist(csp->headers, header))
687 * XXX: Should we quit the request and return a
688 * out of memory error page instead?
690 log_error(LOG_LEVEL_ERROR,
691 "Out of memory while enlisting server headers. %s lost.",
701 /*********************************************************************
703 * Function : crunch_reason
705 * Description : Translates the crunch reason code into a string.
708 * 1 : rsp = a http_response
710 * Returns : A string with the crunch reason or an error description.
712 *********************************************************************/
713 static const char *crunch_reason(const struct http_response *rsp)
715 char * reason = NULL;
720 return "Internal error while searching for crunch reason";
723 switch (rsp->crunch_reason)
726 reason = "Unsupported HTTP feature";
732 reason = "Untrusted";
735 reason = "Redirected";
741 reason = "DNS failure";
743 case FORWARDING_FAILED:
744 reason = "Forwarding failed";
747 reason = "Connection failure";
750 reason = "Out of memory (may mask other reasons)";
752 case CONNECTION_TIMEOUT:
753 reason = "Connection timeout";
756 reason = "No server data received";
759 reason = "No reason recorded";
767 /*********************************************************************
769 * Function : log_applied_actions
771 * Description : Logs the applied actions if LOG_LEVEL_ACTIONS is
775 * 1 : actions = Current action spec to log
779 *********************************************************************/
780 static void log_applied_actions(const struct current_action_spec *actions)
783 * The conversion to text requires lots of memory allocations so
784 * we only do the conversion if the user is actually interested.
786 if (debug_level_is_enabled(LOG_LEVEL_ACTIONS))
788 char *actions_as_text = actions_to_line_of_text(actions);
789 log_error(LOG_LEVEL_ACTIONS, "%s", actions_as_text);
790 freez(actions_as_text);
795 /*********************************************************************
797 * Function : send_crunch_response
799 * Description : Delivers already prepared response for
800 * intercepted requests, logs the interception
801 * and frees the response.
804 * 1 : csp = Current client state (buffers, headers, etc...)
805 * 2 : rsp = Fully prepared response. Will be freed on exit.
809 *********************************************************************/
810 static void send_crunch_response(struct client_state *csp, struct http_response *rsp)
812 const struct http_request *http = csp->http;
816 assert(rsp->head != NULL);
820 log_error(LOG_LEVEL_FATAL, "NULL response in send_crunch_response.");
824 * Extract the status code from the actual head
825 * that will be send to the client. It is the only
826 * way to get it right for all requests, including
827 * the fixed ones for out-of-memory problems.
829 * A head starts like this: 'HTTP/1.1 200...'
833 status_code[0] = rsp->head[9];
834 status_code[1] = rsp->head[10];
835 status_code[2] = rsp->head[11];
836 status_code[3] = '\0';
838 /* Log that the request was crunched and why. */
839 log_applied_actions(csp->action);
840 log_error(LOG_LEVEL_CRUNCH, "%s: %s", crunch_reason(rsp), http->url);
841 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" %s %u",
842 csp->ip_addr_str, http->ocmd, status_code, rsp->content_length);
844 /* Write the answer to the client */
845 #ifdef FEATURE_HTTPS_INSPECTION
846 if (client_use_ssl(csp))
848 if ((ssl_send_data(&(csp->mbedtls_client_attr.ssl),
849 (const unsigned char *)rsp->head, rsp->head_length) < 0)
850 || (ssl_send_data(&(csp->mbedtls_client_attr.ssl),
851 (const unsigned char *)rsp->body, rsp->content_length) < 0))
853 /* There is nothing we can do about it. */
854 log_error(LOG_LEVEL_CONNECT, "Couldn't deliver the error message "
855 "for %s through client socket %d using TLS/SSL",
856 http->url, csp->cfd);
862 if (write_socket_delayed(csp->cfd, rsp->head, rsp->head_length,
863 get_write_delay(csp))
864 || write_socket_delayed(csp->cfd, rsp->body, rsp->content_length,
865 get_write_delay(csp)))
867 /* There is nothing we can do about it. */
868 log_error(LOG_LEVEL_CONNECT,
869 "Couldn't deliver the error message for %s through client socket %d: %E",
870 http->url, csp->cfd);
874 /* Clean up and return */
875 if (cgi_error_memory() != rsp)
877 free_http_response(rsp);
883 /*********************************************************************
885 * Function : crunch_response_triggered
887 * Description : Checks if the request has to be crunched,
888 * and delivers the crunch response if necessary.
891 * 1 : csp = Current client state (buffers, headers, etc...)
892 * 2 : crunchers = list of cruncher functions to run
894 * Returns : TRUE if the request was answered with a crunch response
897 *********************************************************************/
898 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[])
900 struct http_response *rsp = NULL;
901 const struct cruncher *c;
904 * If CGI request crunching is disabled,
905 * check the CGI dispatcher out of order to
906 * prevent unintentional blocks or redirects.
908 if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_CRUNCHING)
909 && (NULL != (rsp = dispatch_cgi(csp))))
911 /* Deliver, log and free the interception response. */
912 send_crunch_response(csp, rsp);
913 csp->flags |= CSP_FLAG_CRUNCHED;
917 for (c = crunchers; c->cruncher != NULL; c++)
920 * Check the cruncher if either Privoxy is toggled
921 * on and the request isn't forced, or if the cruncher
922 * applies to forced requests as well.
924 if (((csp->flags & CSP_FLAG_TOGGLED_ON) &&
925 !(csp->flags & CSP_FLAG_FORCED)) ||
926 (c->flags & CF_IGNORE_FORCE))
928 rsp = c->cruncher(csp);
931 /* Deliver, log and free the interception response. */
932 send_crunch_response(csp, rsp);
933 csp->flags |= CSP_FLAG_CRUNCHED;
934 #ifdef FEATURE_STATISTICS
935 if (c->flags & CF_COUNT_AS_REJECT)
937 csp->flags |= CSP_FLAG_REJECTED;
939 #endif /* def FEATURE_STATISTICS */
950 /*********************************************************************
952 * Function : build_request_line
954 * Description : Builds the HTTP request line.
956 * If a HTTP forwarder is used it expects the whole URL,
957 * web servers only get the path.
960 * 1 : csp = Current client state (buffers, headers, etc...)
961 * 2 : fwd = The forwarding spec used for the request
962 * XXX: Should use http->fwd instead.
963 * 3 : request_line = The old request line which will be replaced.
965 * Returns : Nothing. Terminates in case of memory problems.
967 *********************************************************************/
968 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line)
970 struct http_request *http = csp->http;
973 * Downgrade http version from 1.1 to 1.0
974 * if +downgrade action applies.
976 if ((csp->action->flags & ACTION_DOWNGRADE)
977 && (!strcmpic(http->ver, "HTTP/1.1")))
980 http->ver = strdup_or_die("HTTP/1.0");
984 * Rebuild the request line.
986 freez(*request_line);
987 *request_line = strdup(http->gpc);
988 string_append(request_line, " ");
990 if (fwd->forward_host && fwd->type != FORWARD_WEBSERVER)
992 string_append(request_line, http->url);
996 string_append(request_line, http->path);
998 string_append(request_line, " ");
999 string_append(request_line, http->ver);
1001 if (*request_line == NULL)
1003 log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
1005 log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", *request_line);
1009 /*********************************************************************
1011 * Function : change_request_destination
1013 * Description : Parse a (rewritten) request line and regenerate
1014 * the http request data.
1017 * 1 : csp = Current client state (buffers, headers, etc...)
1019 * Returns : Forwards the parse_http_request() return code.
1020 * Terminates in case of memory problems.
1022 *********************************************************************/
1023 static jb_err change_request_destination(struct client_state *csp)
1025 struct http_request *http = csp->http;
1028 log_error(LOG_LEVEL_REDIRECTS, "Rewrite detected: %s",
1029 csp->headers->first->str);
1030 free_http_request(http);
1031 err = parse_http_request(csp->headers->first->str, http);
1032 if (JB_ERR_OK != err)
1034 log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
1035 jb_err_to_string(err));
1042 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1043 /*********************************************************************
1045 * Function : server_response_is_complete
1047 * Description : Determines whether we should stop reading
1048 * from the server socket.
1051 * 1 : csp = Current client state (buffers, headers, etc...)
1052 * 2 : content_length = Length of content received so far.
1054 * Returns : TRUE if the response is complete,
1057 *********************************************************************/
1058 static int server_response_is_complete(struct client_state *csp,
1059 unsigned long long content_length)
1061 int content_length_known = !!(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET);
1063 if (!strcmpic(csp->http->gpc, "HEAD"))
1066 * "HEAD" implies no body, we are thus expecting
1067 * no content. XXX: incomplete "list" of methods?
1069 csp->expected_content_length = 0;
1070 content_length_known = TRUE;
1071 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1074 if (csp->http->status == 204 || csp->http->status == 304)
1077 * Expect no body. XXX: incomplete "list" of status codes?
1079 csp->expected_content_length = 0;
1080 content_length_known = TRUE;
1081 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1084 return (content_length_known && ((0 == csp->expected_content_length)
1085 || (csp->expected_content_length <= content_length)));
1089 #ifdef FEATURE_CONNECTION_SHARING
1090 /*********************************************************************
1092 * Function : wait_for_alive_connections
1094 * Description : Waits for alive connections to timeout.
1100 *********************************************************************/
1101 static void wait_for_alive_connections(void)
1103 int connections_alive = close_unusable_connections();
1105 while (0 < connections_alive)
1107 log_error(LOG_LEVEL_CONNECT,
1108 "Waiting for %d connections to timeout.",
1111 connections_alive = close_unusable_connections();
1114 log_error(LOG_LEVEL_CONNECT, "No connections to wait for left.");
1117 #endif /* def FEATURE_CONNECTION_SHARING */
1120 /*********************************************************************
1122 * Function : save_connection_destination
1124 * Description : Remembers a connection for reuse later on.
1127 * 1 : sfd = Open socket to remember.
1128 * 2 : http = The destination for the connection.
1129 * 3 : fwd = The forwarder settings used.
1130 * 4 : server_connection = storage.
1134 *********************************************************************/
1135 void save_connection_destination(jb_socket sfd,
1136 const struct http_request *http,
1137 const struct forward_spec *fwd,
1138 struct reusable_connection *server_connection)
1140 assert(sfd != JB_INVALID_SOCKET);
1141 assert(NULL != http->host);
1143 server_connection->sfd = sfd;
1144 server_connection->host = strdup_or_die(http->host);
1145 server_connection->port = http->port;
1147 assert(NULL != fwd);
1148 assert(server_connection->gateway_host == NULL);
1149 assert(server_connection->gateway_port == 0);
1150 assert(server_connection->forwarder_type == 0);
1151 assert(server_connection->forward_host == NULL);
1152 assert(server_connection->forward_port == 0);
1154 server_connection->forwarder_type = fwd->type;
1155 if (NULL != fwd->gateway_host)
1157 server_connection->gateway_host = strdup_or_die(fwd->gateway_host);
1161 server_connection->gateway_host = NULL;
1163 server_connection->gateway_port = fwd->gateway_port;
1165 if (NULL != fwd->forward_host)
1167 server_connection->forward_host = strdup_or_die(fwd->forward_host);
1171 server_connection->forward_host = NULL;
1173 server_connection->forward_port = fwd->forward_port;
1177 /*********************************************************************
1179 * Function : verify_request_length
1181 * Description : Checks if we already got the whole client requests
1182 * and sets CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ if
1185 * Data that doesn't belong to the current request is
1186 * either thrown away to let the client retry on a clean
1187 * socket, or stashed to be dealt with after the current
1188 * request is served.
1191 * 1 : csp = Current client state (buffers, headers, etc...)
1195 *********************************************************************/
1196 static void verify_request_length(struct client_state *csp)
1198 unsigned long long buffered_request_bytes =
1199 (unsigned long long)(csp->client_iob->eod - csp->client_iob->cur);
1201 if ((csp->expected_client_content_length != 0)
1202 && (buffered_request_bytes != 0))
1204 if (csp->expected_client_content_length >= buffered_request_bytes)
1206 csp->expected_client_content_length -= buffered_request_bytes;
1207 log_error(LOG_LEVEL_CONNECT, "Reduced expected bytes to %llu "
1208 "to account for the %llu ones we already got.",
1209 csp->expected_client_content_length, buffered_request_bytes);
1213 assert(csp->client_iob->eod > csp->client_iob->cur + csp->expected_client_content_length);
1214 csp->client_iob->eod = csp->client_iob->cur + csp->expected_client_content_length;
1215 log_error(LOG_LEVEL_CONNECT, "Reducing expected bytes to 0. "
1216 "Marking the server socket tainted after throwing %llu bytes away.",
1217 buffered_request_bytes - csp->expected_client_content_length);
1218 csp->expected_client_content_length = 0;
1219 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1222 if (csp->expected_client_content_length == 0)
1224 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1228 if (!(csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ)
1229 && ((csp->client_iob->cur < csp->client_iob->eod)
1230 || (csp->expected_client_content_length != 0)))
1232 if (strcmpic(csp->http->gpc, "GET")
1233 && strcmpic(csp->http->gpc, "HEAD")
1234 && strcmpic(csp->http->gpc, "TRACE")
1235 && strcmpic(csp->http->gpc, "OPTIONS")
1236 && strcmpic(csp->http->gpc, "DELETE"))
1238 /* XXX: this is an incomplete hack */
1239 csp->flags &= ~CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1240 log_error(LOG_LEVEL_CONNECT, "There better be a request body.");
1244 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1246 if ((csp->config->feature_flags & RUNTIME_FEATURE_TOLERATE_PIPELINING) == 0)
1248 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1249 log_error(LOG_LEVEL_CONNECT,
1250 "Possible pipeline attempt detected. The connection will not "
1251 "be kept alive and we will only serve the first request.");
1252 /* Nuke the pipelined requests from orbit, just to be sure. */
1253 clear_iob(csp->client_iob);
1258 * Keep the pipelined data around for now, we'll deal with
1259 * it once we're done serving the current request.
1261 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
1262 assert(csp->client_iob->eod >= csp->client_iob->cur);
1263 log_error(LOG_LEVEL_CONNECT, "Complete client request followed by "
1264 "%d bytes of pipelined data received.",
1265 (int)(csp->client_iob->eod - csp->client_iob->cur));
1271 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1272 log_error(LOG_LEVEL_CONNECT, "Complete client request received.");
1275 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1278 /*********************************************************************
1280 * Function : mark_server_socket_tainted
1282 * Description : Makes sure we don't reuse a server socket
1283 * (if we didn't read everything the server sent
1284 * us reusing the socket would lead to garbage).
1287 * 1 : csp = Current client state (buffers, headers, etc...)
1291 *********************************************************************/
1292 static void mark_server_socket_tainted(struct client_state *csp)
1295 * For consistency we always mark the server socket
1296 * tainted, however, to reduce the log noise we only
1297 * emit a log message if the server socket could have
1298 * actually been reused.
1300 if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
1301 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED))
1303 log_error(LOG_LEVEL_CONNECT,
1304 "Marking the server socket %d tainted.",
1305 csp->server_connection.sfd);
1307 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1310 /*********************************************************************
1312 * Function : get_request_line
1314 * Description : Read the client request line.
1317 * 1 : csp = Current client state (buffers, headers, etc...)
1319 * Returns : Pointer to request line or NULL in case of errors.
1321 *********************************************************************/
1322 static char *get_request_line(struct client_state *csp)
1324 char buf[BUFFER_SIZE];
1325 char *request_line = NULL;
1328 memset(buf, 0, sizeof(buf));
1330 if ((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
1333 * If there are multiple pipelined requests waiting,
1334 * the flag will be set again once the next request
1337 csp->flags &= ~CSP_FLAG_PIPELINED_REQUEST_WAITING;
1339 request_line = get_header(csp->client_iob);
1340 if ((NULL != request_line) && ('\0' != *request_line))
1342 return request_line;
1346 log_error(LOG_LEVEL_CONNECT, "No complete request line "
1347 "received yet. Continuing reading from %d.", csp->cfd);
1355 0 == (csp->flags & CSP_FLAG_FUZZED_INPUT) &&
1357 !data_is_available(csp->cfd, csp->config->socket_timeout)
1360 if (socket_is_still_alive(csp->cfd))
1362 log_error(LOG_LEVEL_CONNECT,
1363 "No request line on socket %d received in time. Timeout: %d.",
1364 csp->cfd, csp->config->socket_timeout);
1365 write_socket_delayed(csp->cfd, CLIENT_CONNECTION_TIMEOUT_RESPONSE,
1366 strlen(CLIENT_CONNECTION_TIMEOUT_RESPONSE),
1367 get_write_delay(csp));
1371 log_error(LOG_LEVEL_CONNECT,
1372 "The client side of the connection on socket %d got "
1373 "closed without sending a complete request line.", csp->cfd);
1378 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1380 if (len <= 0) return NULL;
1383 * If there is no memory left for buffering the
1384 * request, there is nothing we can do but hang up
1386 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1391 request_line = get_header(csp->client_iob);
1393 } while ((NULL != request_line) && ('\0' == *request_line));
1395 return request_line;
1401 CHUNK_STATUS_MISSING_DATA,
1402 CHUNK_STATUS_BODY_COMPLETE,
1403 CHUNK_STATUS_PARSE_ERROR
1407 /*********************************************************************
1409 * Function : chunked_body_is_complete
1411 * Description : Figures out whether or not a chunked body is complete.
1413 * Currently it always starts at the beginning of the
1414 * buffer which is somewhat wasteful and prevents Privoxy
1415 * from starting to forward the correctly parsed chunks
1416 * as soon as theoretically possible.
1418 * Should be modified to work with a common buffer,
1419 * and allow the caller to skip already parsed chunks.
1421 * This would allow the function to be used for unbuffered
1422 * response bodies as well.
1425 * 1 : iob = Buffer with the body to check.
1426 * 2 : length = Length of complete body
1428 * Returns : Enum with the result of the check.
1430 *********************************************************************/
1431 static enum chunk_status chunked_body_is_complete(struct iob *iob, size_t *length)
1433 unsigned int chunksize;
1439 * We need at least a single digit, followed by "\r\n",
1440 * followed by an unknown amount of data, followed by "\r\n".
1442 if (p + 5 > iob->eod)
1444 return CHUNK_STATUS_MISSING_DATA;
1446 if (sscanf(p, "%x", &chunksize) != 1)
1448 return CHUNK_STATUS_PARSE_ERROR;
1452 * We want at least a single digit, followed by "\r\n",
1453 * followed by the specified amount of data, followed by "\r\n".
1455 if (p + chunksize + 5 > iob->eod)
1457 return CHUNK_STATUS_MISSING_DATA;
1460 /* Skip chunk-size. */
1461 p = strstr(p, "\r\n");
1464 return CHUNK_STATUS_PARSE_ERROR;
1466 /* Move beyond the chunkdata. */
1469 /* There should be another "\r\n" to skip */
1470 if (memcmp(p, "\r\n", 2))
1472 return CHUNK_STATUS_PARSE_ERROR;
1475 } while (chunksize > 0U);
1477 *length = (size_t)(p - iob->cur);
1478 assert(*length <= (size_t)(iob->eod - iob->cur));
1479 assert(p <= iob->eod);
1481 return CHUNK_STATUS_BODY_COMPLETE;
1486 /*********************************************************************
1488 * Function : receive_chunked_client_request_body
1490 * Description : Read the chunk-encoded client request body.
1491 * Failures are dealt with.
1494 * 1 : csp = Current client state (buffers, headers, etc...)
1496 * Returns : JB_ERR_OK or JB_ERR_PARSE
1498 *********************************************************************/
1499 static jb_err receive_chunked_client_request_body(struct client_state *csp)
1502 enum chunk_status status;
1504 while (CHUNK_STATUS_MISSING_DATA ==
1505 (status = chunked_body_is_complete(csp->client_iob, &body_length)))
1507 char buf[BUFFER_SIZE];
1510 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1512 log_error(LOG_LEVEL_ERROR,
1513 "Timeout while waiting for the client body.");
1516 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1519 log_error(LOG_LEVEL_ERROR, "Read the client body failed: %E");
1522 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1527 if (status != CHUNK_STATUS_BODY_COMPLETE)
1529 write_socket_delayed(csp->cfd, CLIENT_BODY_PARSE_ERROR_RESPONSE,
1530 strlen(CLIENT_BODY_PARSE_ERROR_RESPONSE), get_write_delay(csp));
1531 log_error(LOG_LEVEL_CLF,
1532 "%s - - [%T] \"Failed reading chunked client body\" 400 0", csp->ip_addr_str);
1533 return JB_ERR_PARSE;
1535 log_error(LOG_LEVEL_CONNECT,
1536 "Chunked client body completely read. Length: %d", body_length);
1537 csp->expected_client_content_length = body_length;
1545 /*********************************************************************
1547 * Function : fuzz_chunked_transfer_encoding
1549 * Description : Treat the fuzzed input as chunked transfer encoding
1550 * to check and dechunk.
1553 * 1 : csp = Used to store the data.
1554 * 2 : fuzz_input_file = File to read the input from.
1556 * Returns : Result of dechunking
1558 *********************************************************************/
1559 extern int fuzz_chunked_transfer_encoding(struct client_state *csp, char *fuzz_input_file)
1562 size_t size = (size_t)(csp->iob->eod - csp->iob->cur);
1563 enum chunk_status status;
1565 status = chunked_body_is_complete(csp->iob, &length);
1566 if (CHUNK_STATUS_BODY_COMPLETE != status)
1568 log_error(LOG_LEVEL_INFO, "Chunked body is incomplete or invalid");
1571 return (JB_ERR_OK == remove_chunked_transfer_coding(csp->iob->cur, &size));
1576 /*********************************************************************
1578 * Function : fuzz_client_request
1580 * Description : Try to get a client request from the fuzzed input.
1583 * 1 : csp = Current client state (buffers, headers, etc...)
1584 * 2 : fuzz_input_file = File to read the input from.
1586 * Returns : Result of fuzzing.
1588 *********************************************************************/
1589 extern int fuzz_client_request(struct client_state *csp, char *fuzz_input_file)
1594 csp->ip_addr_str = "fuzzer";
1596 if (strcmp(fuzz_input_file, "-") != 0)
1598 log_error(LOG_LEVEL_FATAL,
1599 "Fuzzed client requests can currenty only be read from stdin (-).");
1601 err = receive_client_request(csp);
1602 if (err != JB_ERR_OK)
1606 err = parse_client_request(csp);
1607 if (err != JB_ERR_OK)
1615 #endif /* def FUZZ */
1618 #ifdef FEATURE_FORCE_LOAD
1619 /*********************************************************************
1621 * Function : force_required
1623 * Description : Checks a request line to see if it contains
1624 * the FORCE_PREFIX. If it does, it is removed
1625 * unless enforcing requests has beend disabled.
1628 * 1 : request_line = HTTP request line
1630 * Returns : TRUE if force is required, FALSE otherwise.
1632 *********************************************************************/
1633 static int force_required(const struct client_state *csp, char *request_line)
1637 p = strstr(request_line, "http://");
1641 p += strlen("http://");
1645 /* Intercepted request usually don't specify the protocol. */
1649 /* Go to the beginning of the path */
1654 * If the path is missing the request line is invalid and we
1655 * are done here. The client-visible rejection happens later on.
1660 if (0 == strncmpic(p, FORCE_PREFIX, strlen(FORCE_PREFIX) - 1))
1662 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS))
1664 /* XXX: Should clean more carefully */
1665 strclean(request_line, FORCE_PREFIX);
1666 log_error(LOG_LEVEL_FORCE,
1667 "Enforcing request: \"%s\".", request_line);
1671 log_error(LOG_LEVEL_FORCE,
1672 "Ignored force prefix in request: \"%s\".", request_line);
1678 #endif /* def FEATURE_FORCE_LOAD */
1681 /*********************************************************************
1683 * Function : receive_client_request
1685 * Description : Read the client's request (more precisely the
1686 * client headers) and answer it if necessary.
1689 * 1 : csp = Current client state (buffers, headers, etc...)
1691 * Returns : JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
1693 *********************************************************************/
1694 static jb_err receive_client_request(struct client_state *csp)
1696 char buf[BUFFER_SIZE];
1699 struct http_request *http;
1703 /* Temporary copy of the client's headers before they get enlisted in csp->headers */
1704 struct list header_list;
1705 struct list *headers = &header_list;
1707 /* We don't care if the arriving data is a valid HTTP request or not. */
1708 csp->requests_received_total++;
1712 memset(buf, 0, sizeof(buf));
1714 req = get_request_line(csp);
1717 mark_server_socket_tainted(csp);
1718 return JB_ERR_PARSE;
1720 assert(*req != '\0');
1722 if (client_protocol_is_unsupported(csp, req))
1724 return JB_ERR_PARSE;
1727 #ifdef FEATURE_FORCE_LOAD
1728 if (force_required(csp, req))
1730 csp->flags |= CSP_FLAG_FORCED;
1732 #endif /* def FEATURE_FORCE_LOAD */
1734 err = parse_http_request(req, http);
1736 if (JB_ERR_OK != err)
1738 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER),
1739 get_write_delay(csp));
1740 /* XXX: Use correct size */
1741 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1742 log_error(LOG_LEVEL_ERROR,
1743 "Couldn't parse request line received from %s: %s",
1744 csp->ip_addr_str, jb_err_to_string(err));
1746 free_http_request(http);
1747 return JB_ERR_PARSE;
1750 /* grab the rest of the client's headers */
1754 p = get_header(csp->client_iob);
1758 /* There are no additional headers to read. */
1765 * We didn't receive a complete header
1766 * line yet, get the rest of it.
1768 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1770 log_error(LOG_LEVEL_ERROR,
1771 "Stopped grabbing the client headers.");
1772 destroy_list(headers);
1773 return JB_ERR_PARSE;
1776 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1779 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1780 destroy_list(headers);
1781 return JB_ERR_PARSE;
1784 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1787 * If there is no memory left for buffering the
1788 * request, there is nothing we can do but hang up
1790 destroy_list(headers);
1791 return JB_ERR_MEMORY;
1796 if (!strncmpic(p, "Transfer-Encoding:", 18))
1799 * XXX: should be called through sed()
1800 * but currently can't.
1802 client_transfer_encoding(csp, &p);
1805 * We were able to read a complete
1806 * header and can finally enlist it.
1813 if (http->host == NULL)
1816 * If we still don't know the request destination,
1817 * the request is invalid or the client uses
1818 * Privoxy without its knowledge.
1820 if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
1823 * Our attempts to get the request destination
1824 * elsewhere failed or Privoxy is configured
1825 * to only accept proxy requests.
1827 * An error response has already been send
1828 * and we're done here.
1830 return JB_ERR_PARSE;
1834 #ifdef FEATURE_CLIENT_TAGS
1835 /* XXX: If the headers were enlisted sooner, passing csp would do. */
1836 set_client_address(csp, headers);
1837 get_tag_list_for_client(csp->client_tags, csp->client_address);
1841 * Determine the actions for this URL
1843 #ifdef FEATURE_TOGGLE
1844 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
1846 /* Most compatible set of actions (i.e. none) */
1847 init_current_action(csp->action);
1850 #endif /* ndef FEATURE_TOGGLE */
1852 get_url_actions(csp, http);
1855 enlist(csp->headers, http->cmd);
1857 /* Append the previously read headers */
1858 err = list_append_list_unique(csp->headers, headers);
1859 destroy_list(headers);
1866 /*********************************************************************
1868 * Function : parse_client_request
1870 * Description : Parses the client's request and decides what to do
1873 * Note that since we're not using select() we could get
1874 * blocked here if a client connected, then didn't say
1878 * 1 : csp = Current client state (buffers, headers, etc...)
1880 * Returns : JB_ERR_OK or JB_ERR_PARSE
1882 *********************************************************************/
1883 static jb_err parse_client_request(struct client_state *csp)
1885 struct http_request *http = csp->http;
1888 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1889 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
1890 && (!strcmpic(csp->http->ver, "HTTP/1.1"))
1891 && (csp->http->ssl == 0))
1893 /* Assume persistence until further notice */
1894 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1897 if (csp->http->ssl == 0)
1900 * This whole block belongs to chat() but currently
1901 * has to be executed before sed().
1903 if (csp->flags & CSP_FLAG_CHUNKED_CLIENT_BODY)
1905 if (receive_chunked_client_request_body(csp) != JB_ERR_OK)
1907 return JB_ERR_PARSE;
1912 csp->expected_client_content_length = get_expected_content_length(csp->headers);
1914 verify_request_length(csp);
1918 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1920 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1922 err = sed(csp, FILTER_CLIENT_HEADERS);
1923 if (JB_ERR_OK != err)
1925 log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
1927 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
1928 csp->ip_addr_str, csp->http->cmd);
1929 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER), get_write_delay(csp));
1930 return JB_ERR_PARSE;
1932 csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
1934 /* Check request line for rewrites. */
1935 if ((NULL == csp->headers->first->str)
1936 || (strcmp(http->cmd, csp->headers->first->str) &&
1937 (JB_ERR_OK != change_request_destination(csp))))
1940 * A header filter broke the request line - bail out.
1942 write_socket_delayed(csp->cfd, MESSED_UP_REQUEST_RESPONSE,
1943 strlen(MESSED_UP_REQUEST_RESPONSE), get_write_delay(csp));
1944 /* XXX: Use correct size */
1945 log_error(LOG_LEVEL_CLF,
1946 "%s - - [%T] \"Invalid request generated\" 500 0", csp->ip_addr_str);
1947 log_error(LOG_LEVEL_ERROR,
1948 "Invalid request line after applying header filters.");
1949 free_http_request(http);
1951 return JB_ERR_PARSE;
1954 if (client_has_unsupported_expectations(csp))
1956 return JB_ERR_PARSE;
1964 /*********************************************************************
1966 * Function : send_http_request
1968 * Description : Sends the HTTP headers from the client request
1969 * and all the body data that has already been received.
1972 * 1 : csp = Current client state (buffers, headers, etc...)
1974 * Returns : 0 on success, anything else is an error.
1976 *********************************************************************/
1977 static int send_http_request(struct client_state *csp)
1982 hdr = list_to_text(csp->headers);
1985 /* FIXME Should handle error properly */
1986 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
1988 list_remove_all(csp->headers);
1991 * Write the client's (modified) header to the server
1992 * (along with anything else that may be in the buffer)
1994 write_failure = 0 != write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
1999 log_error(LOG_LEVEL_CONNECT, "Failed sending request headers to: %s: %E",
2000 csp->http->hostport);
2002 else if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
2003 && (flush_iob(csp->server_connection.sfd, csp->client_iob, 0) < 0))
2006 log_error(LOG_LEVEL_CONNECT, "Failed sending request body to: %s: %E",
2007 csp->http->hostport);
2010 return write_failure;
2015 #ifdef FEATURE_HTTPS_INSPECTION
2016 /*********************************************************************
2018 * Function : receive_and_send_encrypted_post_data
2020 * Description : Reads remaining POST data from the client and sends
2024 * 1 : csp = Current client state (buffers, headers, etc...)
2026 * Returns : 0 on success, anything else is an error.
2028 *********************************************************************/
2029 static jb_err receive_and_send_encrypted_post_data(struct client_state *csp)
2031 int content_length_known = csp->expected_client_content_length != 0;
2033 while (is_ssl_pending(&(csp->mbedtls_client_attr.ssl)))
2035 unsigned char buf[BUFFER_SIZE];
2037 int max_bytes_to_read = sizeof(buf);
2039 if (content_length_known && csp->expected_client_content_length < sizeof(buf))
2041 max_bytes_to_read = (int)csp->expected_client_content_length;
2043 log_error(LOG_LEVEL_CONNECT,
2044 "Waiting for up to %d bytes of POST data from the client.",
2046 len = ssl_recv_data(&(csp->mbedtls_client_attr.ssl), buf,
2047 (unsigned)max_bytes_to_read);
2054 /* XXX: Does this actually happen? */
2057 log_error(LOG_LEVEL_HEADER, "Forwarding %d bytes of encrypted POST data",
2059 len = ssl_send_data(&(csp->mbedtls_server_attr.ssl), buf, (size_t)len);
2064 if (csp->expected_client_content_length != 0)
2066 if (csp->expected_client_content_length >= len)
2068 csp->expected_client_content_length -= (unsigned)len;
2070 if (csp->expected_client_content_length == 0)
2072 log_error(LOG_LEVEL_HEADER, "Forwarded the last %d bytes", len);
2078 log_error(LOG_LEVEL_HEADER, "Done forwarding encrypted POST data");
2085 /*********************************************************************
2087 * Function : send_https_request
2089 * Description : Sends the HTTP headers from the client request
2090 * and all the body data that has already been received.
2093 * 1 : csp = Current client state (buffers, headers, etc...)
2095 * Returns : 0 on success, anything else is an error.
2097 *********************************************************************/
2098 static int send_https_request(struct client_state *csp)
2104 hdr = list_to_text(csp->https_headers);
2107 /* FIXME Should handle error properly */
2108 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
2110 list_remove_all(csp->https_headers);
2113 * Write the client's (modified) header to the server
2114 * (along with anything else that may be in the buffer)
2116 ret = ssl_send_data(&(csp->mbedtls_server_attr.ssl),
2117 (const unsigned char *)hdr, strlen(hdr));
2122 log_error(LOG_LEVEL_CONNECT,
2123 "Failed sending encrypted request headers to: %s: %E",
2124 csp->http->hostport);
2125 mark_server_socket_tainted(csp);
2126 close_client_and_server_ssl_connections(csp);
2130 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
2131 && ((flushed = ssl_flush_socket(&(csp->mbedtls_server_attr.ssl),
2132 csp->client_iob)) < 0))
2134 log_error(LOG_LEVEL_CONNECT, "Failed sending request body to: %s: %E",
2135 csp->http->hostport);
2140 if (csp->expected_client_content_length != 0)
2142 if (csp->expected_client_content_length < flushed)
2144 log_error(LOG_LEVEL_ERROR,
2145 "Flushed %d bytes of request body while only expecting %llu",
2146 flushed, csp->expected_client_content_length);
2147 csp->expected_client_content_length = 0;
2151 log_error(LOG_LEVEL_CONNECT,
2152 "Flushed %d bytes of request body while expecting %llu",
2153 flushed, csp->expected_client_content_length);
2154 csp->expected_client_content_length -= (unsigned)flushed;
2155 if (receive_and_send_encrypted_post_data(csp))
2163 log_error(LOG_LEVEL_CONNECT,
2164 "Flushed %d bytes of request body", flushed);
2168 log_error(LOG_LEVEL_CONNECT, "Encrypted request sent");
2175 /*********************************************************************
2177 * Function : receive_encrypted_request
2179 * Description : Receives an encrypted request.
2182 * 1 : csp = Current client state (buffers, headers, etc...)
2184 * Returns : JB_ERR_OK on success,
2185 * JB_ERR_PARSE or JB_ERR_MEMORY otherwise
2187 *********************************************************************/
2188 static jb_err receive_encrypted_request(struct client_state *csp)
2190 char buf[BUFFER_SIZE];
2196 log_error(LOG_LEVEL_HEADER, "Reading encrypted headers");
2197 if (!data_is_available(csp->cfd, (int)csp->config->keep_alive_timeout))
2199 log_error(LOG_LEVEL_CONNECT,
2200 "Socket %d timed out while waiting for client headers", csp->cfd);
2201 return JB_ERR_PARSE;
2203 len = ssl_recv_data(&(csp->mbedtls_client_attr.ssl),
2204 (unsigned char *)buf, sizeof(buf));
2207 return JB_ERR_PARSE;
2209 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
2211 return JB_ERR_MEMORY;
2213 p = strstr(csp->client_iob->cur, "\r\n\r\n");
2214 } while (p == NULL);
2216 log_error(LOG_LEVEL_HEADER, "Encrypted headers received completely");
2222 /*********************************************************************
2224 * Function : process_encrypted_request
2226 * Description : Receives and parses an encrypted request.
2229 * 1 : csp = Current client state (buffers, headers, etc...)
2231 * Returns : JB_ERR_OK on success,
2232 * JB_ERR_PARSE or JB_ERR_MEMORY otherwise
2234 *********************************************************************/
2235 static jb_err process_encrypted_request(struct client_state *csp)
2240 /* Temporary copy of the client's headers before they get enlisted in csp->https_headers */
2241 struct list header_list;
2242 struct list *headers = &header_list;
2244 err = receive_encrypted_request(csp);
2245 if (err != JB_ERR_OK)
2247 /* XXX: Also used for JB_ERR_MEMORY */
2248 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2249 (const unsigned char *)CHEADER, strlen(CHEADER));
2253 /* We don't need get_request_line() because the whole HTTP head is buffered. */
2254 request_line = get_header(csp->client_iob);
2255 if (request_line == NULL)
2257 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2258 (const unsigned char *)CHEADER, strlen(CHEADER));
2259 return JB_ERR_PARSE;
2261 assert(*request_line != '\0');
2263 if (client_protocol_is_unsupported(csp, request_line))
2265 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2266 (const unsigned char *)CHEADER, strlen(CHEADER));
2267 return JB_ERR_PARSE;
2270 #ifdef FEATURE_FORCE_LOAD
2271 if (force_required(csp, request_line))
2273 csp->flags |= CSP_FLAG_FORCED;
2275 #endif /* def FEATURE_FORCE_LOAD */
2277 free_http_request(csp->http);
2279 err = parse_http_request(request_line, csp->http);
2280 /* XXX: Restore ssl setting. This is ugly */
2281 csp->http->client_ssl = 1;
2282 csp->http->server_ssl = 1;
2284 freez(request_line);
2285 if (JB_ERR_OK != err)
2287 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2288 (const unsigned char *)CHEADER, strlen(CHEADER));
2289 /* XXX: Use correct size */
2290 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
2291 log_error(LOG_LEVEL_ERROR,
2292 "Couldn't parse request line received from %s: %s",
2293 csp->ip_addr_str, jb_err_to_string(err));
2295 free_http_request(csp->http);
2296 return JB_ERR_PARSE;
2299 /* Parse the rest of the client's headers. */
2303 p = get_header(csp->client_iob);
2307 /* There are no additional headers to read. */
2314 if (JB_ERR_OK != get_destination_from_https_headers(headers, csp->http))
2317 * Our attempts to get the request destination
2320 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2321 (const unsigned char *)CHEADER, strlen(CHEADER));
2322 return JB_ERR_PARSE;
2325 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
2326 /* Split the domain we just got for pattern matching */
2327 init_domain_components(csp->http);
2330 #ifdef FEATURE_TOGGLE
2331 if ((csp->flags & CSP_FLAG_TOGGLED_ON) != 0)
2334 /* Determine the actions for this URL */
2335 get_url_actions(csp, csp->http);
2338 enlist(csp->https_headers, csp->http->cmd);
2340 /* Append the previously read headers */
2341 err = list_append_list_unique(csp->https_headers, headers);
2342 destroy_list(headers);
2343 if (JB_ERR_OK != err)
2345 /* XXX: Send error message */
2349 /* XXX: Work around crash */
2350 csp->error_message = NULL;
2352 /* XXX: Why do this here? */
2355 err = sed_https(csp);
2356 if (JB_ERR_OK != err)
2358 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2359 (const unsigned char *)CHEADER, strlen(CHEADER));
2360 log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
2362 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
2363 csp->ip_addr_str, csp->http->cmd);
2364 return JB_ERR_PARSE;
2367 log_error(LOG_LEVEL_HEADER, "Encrypted request processed");
2368 log_applied_actions(csp->action);
2376 /*********************************************************************
2378 * Function : handle_established_connection
2380 * Description : Shuffle data between client and server once the
2381 * connection has been established.
2384 * 1 : csp = Current client state (buffers, headers, etc...)
2386 * Returns : Nothing.
2388 *********************************************************************/
2389 static void handle_established_connection(struct client_state *csp)
2395 struct pollfd poll_fds[2];
2399 struct timeval timeout;
2402 int ms_iis5_hack = 0;
2403 unsigned long long byte_count = 0;
2404 struct http_request *http;
2405 long len = 0; /* for buffer sizes (and negative error codes) */
2406 int buffer_and_filter_content = 0;
2407 unsigned int write_delay;
2408 #ifdef FEATURE_HTTPS_INSPECTION
2410 int use_ssl_tunnel = 0;
2411 csp->dont_verify_certificate = 0;
2413 if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION))
2415 /* Pass encrypted content without filtering. */
2420 /* Skeleton for HTTP response, if we should intercept the request */
2421 struct http_response *rsp;
2422 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2423 int watch_client_socket;
2426 csp->receive_buffer_size = csp->config->receive_buffer_size;
2427 csp->receive_buffer = zalloc(csp->receive_buffer_size + 1);
2428 if (csp->receive_buffer == NULL)
2430 log_error(LOG_LEVEL_ERROR,
2431 "Out of memory. Failed to allocate the receive buffer.");
2432 rsp = cgi_error_memory();
2433 send_crunch_response(csp, rsp);
2440 maxfd = (csp->cfd > csp->server_connection.sfd) ?
2441 csp->cfd : csp->server_connection.sfd;
2444 /* pass data between the client and server
2445 * until one or the other shuts down the connection.
2450 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2451 watch_client_socket = 0 == (csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING);
2453 write_delay = get_write_delay(csp);
2460 * FD_ZERO here seems to point to an errant macro which crashes.
2461 * So do this by hand for now...
2463 memset(&rfds,0x00,sizeof(fd_set));
2467 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2468 if (!watch_client_socket)
2470 maxfd = csp->server_connection.sfd;
2473 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2475 FD_SET(csp->cfd, &rfds);
2478 FD_SET(csp->server_connection.sfd, &rfds);
2479 #endif /* ndef HAVE_POLL */
2481 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2482 if ((csp->flags & CSP_FLAG_CHUNKED)
2483 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2484 && ((csp->iob->eod - csp->iob->cur) >= 5)
2485 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
2488 * XXX: This check should be obsolete now,
2489 * but let's wait a while to be sure.
2491 log_error(LOG_LEVEL_CONNECT,
2492 "Looks like we got the last chunk together with "
2493 "the server headers but didn't detect it earlier. "
2494 "We better stop reading.");
2495 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2496 csp->expected_content_length = byte_count;
2497 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2499 if (server_body && server_response_is_complete(csp, byte_count))
2501 if (csp->expected_content_length == byte_count)
2503 log_error(LOG_LEVEL_CONNECT,
2504 "Done reading from server. Content length: %llu as expected. "
2505 "Bytes most recently read: %d.",
2510 log_error(LOG_LEVEL_CONNECT,
2511 "Done reading from server. Expected content length: %llu. "
2512 "Actual content length: %llu. Bytes most recently read: %d.",
2513 csp->expected_content_length, byte_count, len);
2517 * XXX: Should not jump around, handle_established_connection()
2518 * is complicated enough already.
2522 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2526 poll_fds[0].fd = csp->cfd;
2527 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2528 if (!watch_client_socket)
2531 * Ignore incoming data, but still watch out
2532 * for disconnects etc. These flags are always
2533 * implied anyway but explicitly setting them
2536 poll_fds[0].events = POLLERR|POLLHUP;
2541 poll_fds[0].events = POLLIN;
2543 poll_fds[1].fd = csp->server_connection.sfd;
2544 poll_fds[1].events = POLLIN;
2545 n = poll(poll_fds, 2, csp->config->socket_timeout * 1000);
2547 timeout.tv_sec = csp->config->socket_timeout;
2548 timeout.tv_usec = 0;
2549 n = select((int)maxfd + 1, &rfds, NULL, NULL, &timeout);
2550 #endif /* def HAVE_POLL */
2552 /*server or client not responding in timeout */
2555 log_error(LOG_LEVEL_CONNECT, "Socket timeout %d reached: %s",
2556 csp->config->socket_timeout, http->url);
2557 if ((byte_count == 0) && (http->ssl == 0))
2559 send_crunch_response(csp, error_response(csp, "connection-timeout"));
2561 mark_server_socket_tainted(csp);
2562 #ifdef FEATURE_HTTPS_INSPECTION
2563 close_client_and_server_ssl_connections(csp);
2570 log_error(LOG_LEVEL_ERROR, "poll() failed!: %E");
2572 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
2574 mark_server_socket_tainted(csp);
2575 #ifdef FEATURE_HTTPS_INSPECTION
2576 close_client_and_server_ssl_connections(csp);
2583 * This is the body of the browser's request,
2584 * just read and write it.
2586 * Receives data from browser and sends it to server
2588 * XXX: Make sure the client doesn't use pipelining
2589 * behind Privoxy's back.
2592 if ((poll_fds[0].revents & (POLLERR|POLLHUP|POLLNVAL)) != 0)
2594 log_error(LOG_LEVEL_CONNECT,
2595 "The client socket %d has become unusable while "
2596 "the server socket %d is still open.",
2597 csp->cfd, csp->server_connection.sfd);
2598 mark_server_socket_tainted(csp);
2602 if (poll_fds[0].revents != 0)
2604 if (FD_ISSET(csp->cfd, &rfds))
2605 #endif /* def HAVE_POLL*/
2607 int max_bytes_to_read = (int)csp->receive_buffer_size;
2609 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2610 if ((csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ))
2612 if (data_is_available(csp->cfd, 0))
2615 * If the next request is already waiting, we have
2616 * to stop select()ing the client socket. Otherwise
2617 * we would always return right away and get nothing
2620 watch_client_socket = 0;
2621 log_error(LOG_LEVEL_CONNECT,
2622 "Stop watching client socket %d. "
2623 "There's already another request waiting.",
2628 * If the client socket is set, but there's no data
2629 * available on the socket, the client went fishing
2630 * and continuing talking to the server makes no sense.
2632 log_error(LOG_LEVEL_CONNECT,
2633 "The client closed socket %d while "
2634 "the server socket %d is still open.",
2635 csp->cfd, csp->server_connection.sfd);
2636 mark_server_socket_tainted(csp);
2639 if (csp->expected_client_content_length != 0)
2641 if (csp->expected_client_content_length < csp->receive_buffer_size)
2643 max_bytes_to_read = (int)csp->expected_client_content_length;
2645 log_error(LOG_LEVEL_CONNECT,
2646 "Waiting for up to %d bytes from the client.",
2649 assert(max_bytes_to_read <= csp->receive_buffer_size);
2650 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2652 #ifdef FEATURE_HTTPS_INSPECTION
2654 * Reading data from standard or secured connection (HTTP/HTTPS)
2656 if (client_use_ssl(csp))
2659 * Receiving HTTP request from client over TLS/SSL and sending
2660 * it to server over TLS/SSL.
2662 len = ssl_recv_data(&(csp->mbedtls_client_attr.ssl),
2663 (unsigned char *)csp->receive_buffer, (size_t)max_bytes_to_read);
2667 mark_server_socket_tainted(csp);
2671 ret = ssl_send_data(&(csp->mbedtls_server_attr.ssl),
2672 (const unsigned char *)csp->receive_buffer, (size_t)len);
2676 log_error(LOG_LEVEL_ERROR,
2677 "Send request over TLS/SSL to: %s failed", http->host);
2678 mark_server_socket_tainted(csp);
2679 close_client_and_server_ssl_connections(csp);
2684 #endif /* def FEATURE_HTTPS_INSPECTION */
2686 len = read_socket(csp->cfd, csp->receive_buffer, max_bytes_to_read);
2690 /* XXX: not sure if this is necessary. */
2691 mark_server_socket_tainted(csp);
2692 break; /* "game over, man" */
2695 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2696 if (csp->expected_client_content_length != 0)
2698 assert(len <= max_bytes_to_read);
2699 csp->expected_client_content_length -= (unsigned)len;
2700 log_error(LOG_LEVEL_CONNECT,
2701 "Expected client content length set to %llu "
2702 "after reading %d bytes.",
2703 csp->expected_client_content_length, len);
2704 if (csp->expected_client_content_length == 0)
2706 log_error(LOG_LEVEL_CONNECT,
2707 "Done reading from the client.");
2708 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
2711 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2713 if (write_socket(csp->server_connection.sfd, csp->receive_buffer, (size_t)len))
2715 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
2716 mark_server_socket_tainted(csp);
2717 #ifdef FEATURE_HTTPS_INSPECTION
2718 close_client_and_server_ssl_connections(csp);
2727 * The server wants to talk. It could be the header or the body.
2728 * If `hdr' is null, then it's the header otherwise it's the body.
2729 * FIXME: Does `hdr' really mean `host'? No.
2732 if (poll_fds[1].revents != 0)
2734 if (FD_ISSET(csp->server_connection.sfd, &rfds))
2735 #endif /* HAVE_POLL */
2737 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2739 * If we are buffering content, we don't want to eat up to
2740 * buffer-limit bytes if the client no longer cares about them.
2741 * If we aren't buffering, however, a dead client socket will be
2742 * noticed pretty much right away anyway, so we can reduce the
2743 * overhead by skipping the check.
2745 if (buffer_and_filter_content && !socket_is_still_alive(csp->cfd))
2748 log_error(LOG_LEVEL_CONNECT,
2749 "The server still wants to talk, but the client may already have hung up on us.");
2751 log_error(LOG_LEVEL_CONNECT,
2752 "The server still wants to talk, but the client hung up on us.");
2753 mark_server_socket_tainted(csp);
2754 #ifdef FEATURE_HTTPS_INSPECTION
2755 close_client_and_server_ssl_connections(csp);
2758 #endif /* def _WIN32 */
2760 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2762 #ifdef FEATURE_HTTPS_INSPECTION
2764 * Reading data from standard or secured connection (HTTP/HTTPS)
2766 if (server_use_ssl(csp))
2768 len = ssl_recv_data(&(csp->mbedtls_server_attr.ssl),
2769 (unsigned char *)csp->receive_buffer, csp->receive_buffer_size);
2774 len = read_socket(csp->server_connection.sfd, csp->receive_buffer,
2775 (int)csp->receive_buffer_size);
2780 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
2782 if ((http->ssl && (csp->fwd == NULL))
2783 #ifdef FEATURE_HTTPS_INSPECTION
2789 * Just hang up. We already confirmed the client's CONNECT
2790 * request with status code 200 and unencrypted content is
2791 * no longer welcome.
2793 log_error(LOG_LEVEL_ERROR,
2794 "CONNECT already confirmed. Unable to tell the client about the problem.");
2797 else if (byte_count)
2800 * Just hang up. We already transmitted the original headers
2801 * and parts of the original content and therefore missed the
2802 * chance to send an error message (without risking data corruption).
2804 * XXX: we could retry with a fancy range request here.
2806 log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
2807 "Unable to tell the client about the problem.");
2808 mark_server_socket_tainted(csp);
2809 #ifdef FEATURE_HTTPS_INSPECTION
2810 close_client_and_server_ssl_connections(csp);
2815 * XXX: Consider handling the cases above the same.
2817 mark_server_socket_tainted(csp);
2821 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2822 if (csp->flags & CSP_FLAG_CHUNKED)
2824 if ((len >= 5) && !memcmp(csp->receive_buffer+len-5, "0\r\n\r\n", 5))
2826 /* XXX: this is a temporary hack */
2827 log_error(LOG_LEVEL_CONNECT,
2828 "Looks like we reached the end of the last chunk. "
2829 "We better stop reading.");
2830 csp->expected_content_length = byte_count + (unsigned long long)len;
2831 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2835 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2838 * This is guaranteed by allocating with zalloc_or_die()
2839 * and never (intentionally) writing to the last byte.
2841 * csp->receive_buffer_size is the size of the part of the
2842 * buffer we intentionally write to, but we actually
2843 * allocated csp->receive_buffer_size+1 bytes so the assertion
2844 * stays within the allocated range.
2846 assert(csp->receive_buffer[csp->receive_buffer_size] == '\0');
2849 * Add a trailing zero to let be able to use string operations.
2850 * XXX: do we still need this with filter_popups gone?
2852 assert(len <= csp->receive_buffer_size);
2853 csp->receive_buffer[len] = '\0';
2856 * Normally, this would indicate that we've read
2857 * as much as the server has sent us and we can
2858 * close the client connection. However, Microsoft
2859 * in its wisdom has released IIS/5 with a bug that
2860 * prevents it from sending the trailing \r\n in
2861 * a 302 redirect header (and possibly other headers).
2862 * To work around this if we've haven't parsed
2863 * a full header we'll append a trailing \r\n
2864 * and see if this now generates a valid one.
2866 * This hack shouldn't have any impacts. If we've
2867 * already transmitted the header or if this is a
2868 * SSL connection, then we won't bother with this
2869 * hack. So we only work on partially received
2870 * headers. If we append a \r\n and this still
2871 * doesn't generate a valid header, then we won't
2872 * transmit anything to the client.
2877 if (server_body || (http->ssl
2878 #ifdef FEATURE_HTTPS_INSPECTION
2884 * If we have been buffering up the document,
2885 * now is the time to apply content modification
2886 * and send the result to the client.
2888 if (buffer_and_filter_content)
2890 p = execute_content_filters(csp);
2892 * If content filtering fails, use the original
2893 * buffer and length.
2894 * (see p != NULL ? p : csp->iob->cur below)
2898 csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
2900 #ifdef FEATURE_COMPRESSION
2901 else if ((csp->flags & CSP_FLAG_CLIENT_SUPPORTS_DEFLATE)
2902 && (csp->content_length > LOWER_LENGTH_LIMIT_FOR_COMPRESSION))
2904 char *compressed_content = compress_buffer(p,
2905 (size_t *)&csp->content_length, csp->config->compression_level);
2906 if (compressed_content != NULL)
2909 p = compressed_content;
2910 csp->flags |= CSP_FLAG_BUFFERED_CONTENT_DEFLATED;
2915 if (JB_ERR_OK != update_server_headers(csp))
2917 log_error(LOG_LEVEL_FATAL,
2918 "Failed to update server headers. after filtering.");
2921 hdr = list_to_text(csp->headers);
2924 /* FIXME Should handle error properly */
2925 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2928 #ifdef FEATURE_HTTPS_INSPECTION
2930 * Sending data with standard or secured connection (HTTP/HTTPS)
2932 if (client_use_ssl(csp))
2934 if ((ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2935 (const unsigned char *)hdr, strlen(hdr)) < 0)
2936 || (ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2937 (const unsigned char *) ((p != NULL) ? p : csp->iob->cur),
2938 csp->content_length) < 0))
2940 log_error(LOG_LEVEL_ERROR, "write modified content to "
2941 "client over TLS/SSL failed");
2944 mark_server_socket_tainted(csp);
2945 close_client_and_server_ssl_connections(csp);
2950 #endif /* def FEATURE_HTTPS_INSPECTION */
2952 if (write_socket_delayed(csp->cfd, hdr, strlen(hdr), write_delay)
2953 || write_socket_delayed(csp->cfd, ((p != NULL) ? p : csp->iob->cur),
2954 (size_t)csp->content_length, write_delay))
2956 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
2959 mark_server_socket_tainted(csp);
2960 #ifdef FEATURE_HTTPS_INSPECTION
2961 close_client_and_server_ssl_connections(csp);
2971 break; /* "game over, man" */
2975 * This is NOT the body, so
2976 * Let's pretend the server just sent us a blank line.
2978 snprintf(csp->receive_buffer, csp->receive_buffer_size, "\r\n");
2979 len = (int)strlen(csp->receive_buffer);
2982 * Now, let the normal header parsing algorithm below do its
2983 * job. If it fails, we'll exit instead of continuing.
2990 * If we're in the body of the server document, just write it to
2991 * the client, unless we need to buffer the body for later
2992 * content-filtering.
2994 if (server_body || (http->ssl
2995 #ifdef FEATURE_HTTPS_INSPECTION
3000 if (buffer_and_filter_content)
3003 * If there is no memory left for buffering the content, or the buffer limit
3004 * has been reached, switch to non-filtering mode, i.e. make & write the
3005 * header, flush the iob and buf, and get out of the way.
3007 if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3012 log_error(LOG_LEVEL_INFO,
3013 "Flushing header and buffers. Stepping back from filtering.");
3015 hdr = list_to_text(csp->headers);
3019 * Memory is too tight to even generate the header.
3020 * Send our static "Out-of-memory" page.
3022 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
3023 rsp = cgi_error_memory();
3024 send_crunch_response(csp, rsp);
3025 mark_server_socket_tainted(csp);
3026 #ifdef FEATURE_HTTPS_INSPECTION
3027 close_client_and_server_ssl_connections(csp);
3031 hdrlen = strlen(hdr);
3033 #ifdef FEATURE_HTTPS_INSPECTION
3035 * Sending data with standard or secured connection (HTTP/HTTPS)
3037 if (client_use_ssl(csp))
3039 if ((ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3040 (const unsigned char *)hdr, hdrlen) < 0)
3041 || ((flushed = ssl_flush_socket(&(csp->mbedtls_client_attr.ssl),
3043 || (ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3044 (const unsigned char *)csp->receive_buffer, (size_t)len) < 0))
3046 log_error(LOG_LEVEL_CONNECT,
3047 "Flush header and buffers to client failed");
3049 mark_server_socket_tainted(csp);
3050 close_client_and_server_ssl_connections(csp);
3055 #endif /* def FEATURE_HTTPS_INSPECTION */
3057 if (write_socket_delayed(csp->cfd, hdr, hdrlen, write_delay)
3058 || ((flushed = flush_iob(csp->cfd, csp->iob, write_delay)) < 0)
3059 || write_socket_delayed(csp->cfd, csp->receive_buffer, (size_t)len,
3062 log_error(LOG_LEVEL_CONNECT,
3063 "Flush header and buffers to client failed: %E");
3065 mark_server_socket_tainted(csp);
3066 #ifdef FEATURE_HTTPS_INSPECTION
3067 close_client_and_server_ssl_connections(csp);
3074 * Reset the byte_count to the amount of bytes
3075 * we just flushed. len will be added a few lines below,
3076 * hdrlen doesn't matter for LOG_LEVEL_CLF.
3078 byte_count = (unsigned long long)flushed;
3080 buffer_and_filter_content = 0;
3086 #ifdef FEATURE_HTTPS_INSPECTION
3088 * Sending data with standard or secured connection (HTTP/HTTPS)
3090 if (client_use_ssl(csp))
3092 ret = ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3093 (const unsigned char *)csp->receive_buffer, (size_t)len);
3096 log_error(LOG_LEVEL_ERROR,
3097 "Sending data to client failed");
3098 mark_server_socket_tainted(csp);
3099 close_client_and_server_ssl_connections(csp);
3104 #endif /* def FEATURE_HTTPS_INSPECTION */
3106 if (write_socket_delayed(csp->cfd, csp->receive_buffer,
3107 (size_t)len, write_delay))
3109 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
3110 mark_server_socket_tainted(csp);
3111 #ifdef FEATURE_HTTPS_INSPECTION
3112 close_client_and_server_ssl_connections(csp);
3118 byte_count += (unsigned long long)len;
3124 * We're still looking for the end of the server's header.
3125 * Buffer up the data we just read. If that fails, there's
3126 * little we can do but send our static out-of-memory page.
3128 if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3130 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
3131 rsp = cgi_error_memory();
3132 send_crunch_response(csp, rsp);
3133 mark_server_socket_tainted(csp);
3134 #ifdef FEATURE_HTTPS_INSPECTION
3135 close_client_and_server_ssl_connections(csp);
3140 /* Convert iob into something sed() can digest */
3141 if (JB_ERR_PARSE == get_server_headers(csp))
3146 * Well, we tried our MS IIS/5 hack and it didn't work.
3147 * The header is incomplete and there isn't anything
3148 * we can do about it.
3150 log_error(LOG_LEVEL_ERROR, "Invalid server headers. "
3151 "Applying the MS IIS5 hack didn't help.");
3152 log_error(LOG_LEVEL_CLF,
3153 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3154 #ifdef FEATURE_HTTPS_INSPECTION
3156 * Sending data with standard or secured connection (HTTP/HTTPS)
3158 if (client_use_ssl(csp))
3160 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3161 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3162 strlen(INVALID_SERVER_HEADERS_RESPONSE));
3165 #endif /* def FEATURE_HTTPS_INSPECTION */
3167 write_socket_delayed(csp->cfd,
3168 INVALID_SERVER_HEADERS_RESPONSE,
3169 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3171 mark_server_socket_tainted(csp);
3172 #ifdef FEATURE_HTTPS_INSPECTION
3173 close_client_and_server_ssl_connections(csp);
3180 * Since we have to wait for more from the server before
3181 * we can parse the headers we just continue here.
3183 log_error(LOG_LEVEL_CONNECT,
3184 "Continuing buffering server headers from socket %d. "
3185 "Bytes most recently read: %d.", csp->cfd, len);
3192 * Account for the content bytes we
3193 * might have gotten with the headers.
3195 assert(csp->iob->eod >= csp->iob->cur);
3196 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3199 /* Did we actually get anything? */
3200 if (NULL == csp->headers->first)
3202 if ((csp->flags & CSP_FLAG_REUSED_CLIENT_CONNECTION))
3204 log_error(LOG_LEVEL_ERROR,
3205 "No server or forwarder response received on socket %d. "
3206 "Closing client socket %d without sending data.",
3207 csp->server_connection.sfd, csp->cfd);
3208 log_error(LOG_LEVEL_CLF,
3209 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3213 log_error(LOG_LEVEL_ERROR,
3214 "No server or forwarder response received on socket %d.",
3215 csp->server_connection.sfd);
3216 send_crunch_response(csp, error_response(csp, "no-server-data"));
3218 free_http_request(http);
3219 mark_server_socket_tainted(csp);
3220 #ifdef FEATURE_HTTPS_INSPECTION
3221 close_client_and_server_ssl_connections(csp);
3226 if (!csp->headers->first->str)
3228 log_error(LOG_LEVEL_ERROR, "header search: csp->headers->first->str == NULL, assert will be called");
3230 assert(csp->headers->first->str);
3232 if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
3233 strncmpic(csp->headers->first->str, "ICY", 3))
3236 * It doesn't look like a HTTP (or Shoutcast) response:
3237 * tell the client and log the problem.
3239 if (strlen(csp->headers->first->str) > 30)
3241 csp->headers->first->str[30] = '\0';
3243 log_error(LOG_LEVEL_ERROR,
3244 "Invalid server or forwarder response. Starts with: %s",
3245 csp->headers->first->str);
3246 log_error(LOG_LEVEL_CLF,
3247 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3248 #ifdef FEATURE_HTTPS_INSPECTION
3250 * Sending data with standard or secured connection (HTTP/HTTPS)
3252 if (client_use_ssl(csp))
3254 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3255 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3256 strlen(INVALID_SERVER_HEADERS_RESPONSE));
3259 #endif /* def FEATURE_HTTPS_INSPECTION */
3261 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3262 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3264 free_http_request(http);
3265 mark_server_socket_tainted(csp);
3266 #ifdef FEATURE_HTTPS_INSPECTION
3267 close_client_and_server_ssl_connections(csp);
3273 * We have now received the entire server header,
3274 * filter it and send the result to the client
3276 if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
3278 log_error(LOG_LEVEL_CLF,
3279 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3280 #ifdef FEATURE_HTTPS_INSPECTION
3282 * Sending data with standard or secured connection (HTTP/HTTPS)
3284 if (client_use_ssl(csp))
3286 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3287 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3288 strlen(INVALID_SERVER_HEADERS_RESPONSE));
3293 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3294 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3296 free_http_request(http);
3297 mark_server_socket_tainted(csp);
3298 #ifdef FEATURE_HTTPS_INSPECTION
3299 close_client_and_server_ssl_connections(csp);
3303 hdr = list_to_text(csp->headers);
3306 /* FIXME Should handle error properly */
3307 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
3310 if ((csp->flags & CSP_FLAG_CHUNKED)
3311 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3312 && ((csp->iob->eod - csp->iob->cur) >= 5)
3313 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
3315 log_error(LOG_LEVEL_CONNECT,
3316 "Looks like we got the last chunk together with "
3317 "the server headers. We better stop reading.");
3318 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3319 csp->expected_content_length = byte_count;
3320 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
3323 csp->server_connection.response_received = time(NULL);
3325 if (crunch_response_triggered(csp, crunchers_light))
3328 * One of the tags created by a server-header
3329 * tagger triggered a crunch. We already
3330 * delivered the crunch response to the client
3331 * and are done here after cleaning up.
3334 mark_server_socket_tainted(csp);
3335 #ifdef FEATURE_HTTPS_INSPECTION
3336 close_client_and_server_ssl_connections(csp);
3341 /* Buffer and pcrs filter this if appropriate. */
3342 buffer_and_filter_content = content_requires_filtering(csp);
3344 if (!buffer_and_filter_content)
3347 * Write the server's (modified) header to
3348 * the client (along with anything else that
3349 * may be in the buffer). Use standard or secured
3352 #ifdef FEATURE_HTTPS_INSPECTION
3353 if (client_use_ssl(csp))
3355 if ((ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3356 (const unsigned char *)hdr, strlen(hdr)) < 0)
3357 || (len = ssl_flush_socket(&(csp->mbedtls_client_attr.ssl),
3360 log_error(LOG_LEVEL_CONNECT, "Write header to client failed");
3363 * The write failed, so don't bother mentioning it
3364 * to the client... it probably can't hear us anyway.
3367 mark_server_socket_tainted(csp);
3368 #ifdef FEATURE_HTTPS_INSPECTION
3369 close_client_and_server_ssl_connections(csp);
3375 #endif /* def FEATURE_HTTPS_INSPECTION */
3377 if (write_socket_delayed(csp->cfd, hdr, strlen(hdr), write_delay)
3378 || ((len = flush_iob(csp->cfd, csp->iob, write_delay)) < 0))
3380 log_error(LOG_LEVEL_ERROR,
3381 "write header to client failed");
3383 * The write failed, so don't bother mentioning it
3384 * to the client... it probably can't hear us anyway.
3387 mark_server_socket_tainted(csp);
3388 #ifdef FEATURE_HTTPS_INSPECTION
3389 close_client_and_server_ssl_connections(csp);
3396 /* we're finished with the server's header */
3402 * If this was a MS IIS/5 hack then it means the server
3403 * has already closed the connection. Nothing more to read.
3408 log_error(LOG_LEVEL_ERROR,
3409 "Closed server connection detected. "
3410 "Applying the MS IIS5 hack didn't help.");
3411 log_error(LOG_LEVEL_CLF,
3412 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3413 #ifdef FEATURE_HTTPS_INSPECTION
3415 * Sending data with standard or secured connection (HTTP/HTTPS)
3417 if (client_use_ssl(csp))
3419 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3420 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3421 strlen(INVALID_SERVER_HEADERS_RESPONSE));
3424 #endif /* def FEATURE_HTTPS_INSPECTION */
3426 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3427 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3429 mark_server_socket_tainted(csp);
3430 #ifdef FEATURE_HTTPS_INSPECTION
3431 close_client_and_server_ssl_connections(csp);
3438 mark_server_socket_tainted(csp);
3439 #ifdef FEATURE_HTTPS_INSPECTION
3440 close_client_and_server_ssl_connections(csp);
3442 return; /* huh? we should never get here */
3444 #ifdef FEATURE_HTTPS_INSPECTION
3445 close_client_and_server_ssl_connections(csp);
3447 if (csp->content_length == 0)
3450 * If Privoxy didn't recalculate the Content-Length,
3451 * byte_count is still correct.
3453 csp->content_length = byte_count;
3456 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3457 if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3458 && (csp->expected_content_length != byte_count))
3460 log_error(LOG_LEVEL_CONNECT,
3461 "Received %llu bytes while expecting %llu.",
3462 byte_count, csp->expected_content_length);
3463 mark_server_socket_tainted(csp);
3467 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %llu",
3468 csp->ip_addr_str, http->ocmd, csp->content_length);
3470 csp->server_connection.timestamp = time(NULL);
3474 /*********************************************************************
3478 * Description : Once a connection from the client has been accepted,
3479 * this function is called (via serve()) to handle the
3480 * main business of the communication. This function
3481 * returns after dealing with a single request. It can
3482 * be called multiple times with the same client socket
3483 * if the client is keeping the connection alive.
3485 * The decision whether or not a client connection will
3486 * be kept alive is up to the caller which also must
3487 * close the client socket when done.
3489 * FIXME: chat is nearly thousand lines long.
3493 * 1 : csp = Current client state (buffers, headers, etc...)
3495 * Returns : Nothing.
3497 *********************************************************************/
3498 static void chat(struct client_state *csp)
3500 const struct forward_spec *fwd;
3501 struct http_request *http;
3502 /* Skeleton for HTTP response, if we should intercept the request */
3503 struct http_response *rsp;
3504 #ifdef FEATURE_HTTPS_INSPECTION
3505 int use_ssl_tunnel = 0;
3510 if (receive_client_request(csp) != JB_ERR_OK)
3514 if (parse_client_request(csp) != JB_ERR_OK)
3519 /* decide how to route the HTTP request */
3520 fwd = forward_url(csp, http);
3523 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!? This can't happen!");
3524 /* Never get here - LOG_LEVEL_FATAL causes program exit */
3528 #ifdef FEATURE_HTTPS_INSPECTION
3530 * Setting flags to use old solution with SSL tunnel and to disable
3531 * certificates verification.
3533 if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION))
3538 if (http->ssl && csp->action->flags & ACTION_IGNORE_CERTIFICATE_ERRORS)
3540 csp->dont_verify_certificate = 1;
3545 * build the http request to send to the server
3546 * we have to do one of the following:
3548 * create = use the original HTTP request to create a new
3549 * HTTP request that has either the path component
3550 * without the http://domainspec (w/path) or the
3551 * full orininal URL (w/url)
3552 * Note that the path and/or the HTTP version may
3553 * have been altered by now.
3555 * SSL proxy = Open a socket to the host:port of the server
3556 * and create TLS/SSL connection with server and
3557 * with client. Then behave like mediator between
3558 * client and server over TLS/SSL.
3560 * SSL proxy = Pass the request unchanged if forwarding a CONNECT
3561 * with request to a parent proxy. Note that we'll be sending
3562 * forwarding the CFAIL message ourselves if connecting to the parent
3563 * fails, but we won't send a CSUCCEED message if it works,
3564 * since that would result in a double message (ours and the
3565 * parent's). After sending the request to the parent, we
3566 * must parse answer and send it to client. If connection
3567 * with server is established, we do TLS/SSL proxy. Otherwise
3568 * we send parent response to client and close connections.
3570 * here's the matrix:
3573 * +--------+--------+
3575 * 0 | create | SSL |
3576 * | w/path | proxy |
3577 * Forwarding +--------+--------+
3579 * 1 | create | proxy |
3580 * | w/url |+forward|
3581 * +--------+--------+
3585 #ifdef FEATURE_HTTPS_INSPECTION
3587 * Presetting SSL client and server flags
3589 if (http->ssl && !use_ssl_tunnel)
3591 http->client_ssl = 1;
3592 http->server_ssl = 1;
3596 http->client_ssl = 0;
3597 http->server_ssl = 0;
3601 if (http->ssl && connect_port_is_forbidden(csp))
3603 const char *acceptable_connect_ports =
3604 csp->action->string[ACTION_STRING_LIMIT_CONNECT];
3605 assert(NULL != acceptable_connect_ports);
3606 log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
3607 "limit-connect{%s} doesn't allow CONNECT requests to %s",
3608 csp->ip_addr_str, acceptable_connect_ports, csp->http->hostport);
3609 csp->action->flags |= ACTION_BLOCK;
3611 #ifdef FEATURE_HTTPS_INSPECTION
3612 http->client_ssl = 0;
3613 http->server_ssl = 0;
3618 freez(csp->headers->first->str);
3619 build_request_line(csp, fwd, &csp->headers->first->str);
3622 * We have a request. Check if one of the crunchers wants it
3623 * unless the client wants to use TLS/SSL in which case we
3624 * haven't setup the TLS context yet and will send the crunch
3628 #ifdef FEATURE_HTTPS_INSPECTION
3629 !client_use_ssl(csp) &&
3631 crunch_response_triggered(csp, crunchers_all))
3634 * Yes. The client got the crunch response and we're done here.
3639 log_applied_actions(csp->action);
3640 log_error(LOG_LEVEL_GPC, "%s%s", http->hostport, http->path);
3642 if (fwd->forward_host)
3644 log_error(LOG_LEVEL_CONNECT, "via [%s]:%d to: %s",
3645 fwd->forward_host, fwd->forward_port, http->hostport);
3649 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
3652 /* here we connect to the server, gateway, or the forwarder */
3654 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3655 if ((csp->server_connection.sfd != JB_INVALID_SOCKET)
3656 && socket_is_still_alive(csp->server_connection.sfd)
3657 && connection_destination_matches(&csp->server_connection, http, fwd))
3659 log_error(LOG_LEVEL_CONNECT,
3660 "Reusing server socket %d connected to %s. Total requests: %u.",
3661 csp->server_connection.sfd, csp->server_connection.host,
3662 csp->server_connection.requests_sent_total);
3666 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
3668 #ifdef FEATURE_CONNECTION_SHARING
3669 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
3671 remember_connection(&csp->server_connection);
3674 #endif /* def FEATURE_CONNECTION_SHARING */
3676 log_error(LOG_LEVEL_CONNECT,
3677 "Closing server socket %d connected to %s. Total requests: %u.",
3678 csp->server_connection.sfd, csp->server_connection.host,
3679 csp->server_connection.requests_sent_total);
3680 close_socket(csp->server_connection.sfd);
3682 mark_connection_closed(&csp->server_connection);
3684 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3685 #ifdef FEATURE_HTTPS_INSPECTION
3686 if (http->ssl && !use_ssl_tunnel)
3690 * Creating an SSL proxy. If forwarding is disabled, we must send
3691 * CSUCCEED mesage to client. Then TLS/SSL connection with client
3695 if (fwd->forward_host == NULL)
3698 * We're lying to the client as the connection hasn't actually
3699 * been established yet. We don't establish the connection until
3700 * we have seen and parsed the encrypted client headers.
3702 if (write_socket_delayed(csp->cfd, CSUCCEED,
3703 strlen(CSUCCEED), get_write_delay(csp)) != 0)
3705 log_error(LOG_LEVEL_ERROR, "Sending SUCCEED to client failed");
3710 ret = create_client_ssl_connection(csp);
3713 log_error(LOG_LEVEL_ERROR,
3714 "Can't open secure connection with client");
3715 close_client_ssl_connection(csp); /* XXX: Is this needed? */
3718 if (JB_ERR_OK != process_encrypted_request(csp))
3720 log_error(LOG_LEVEL_ERROR, "Failed to parse encrypted request.");
3721 close_client_ssl_connection(csp);
3725 * We have an encrypted request. Check if one of the crunchers now
3726 * wants it (for example because the previously invisible path was
3727 * required to match).
3729 if (crunch_response_triggered(csp, crunchers_all))
3732 * Yes. The client got the crunch response and we're done here.
3734 close_client_ssl_connection(csp);
3740 * Connecting to destination server
3742 csp->server_connection.sfd = forwarded_connect(fwd, http, csp);
3744 if (csp->server_connection.sfd == JB_INVALID_SOCKET)
3746 if (fwd->type != SOCKS_NONE)
3749 rsp = error_response(csp, "forwarding-failed");
3751 else if (errno == EINVAL)
3753 rsp = error_response(csp, "no-such-domain");
3757 rsp = error_response(csp, "connect-failed");
3760 /* Write the answer to the client */
3763 send_crunch_response(csp, rsp);
3767 * Temporary workaround to prevent already-read client
3768 * bodies from being parsed as new requests. For now we
3769 * err on the safe side and throw all the following
3770 * requests under the bus, even if no client body has been
3771 * buffered. A compliant client will repeat the dropped
3772 * requests on an untainted connection.
3774 * The proper fix is to discard the no longer needed
3775 * client body in the buffer (if there is one) and to
3776 * continue parsing the bytes that follow.
3778 drain_and_close_socket(csp->cfd);
3779 csp->cfd = JB_INVALID_SOCKET;
3784 #ifdef FEATURE_HTTPS_INSPECTION
3786 * Creating TLS/SSL connections with destination server or parent
3787 * proxy. If forwarding is enabled, we must send client request to
3788 * parent proxy and receive, parse and resend parent proxy answer.
3790 if (http->ssl && !use_ssl_tunnel)
3792 if (fwd->forward_host != NULL)
3794 char server_response[BUFFER_SIZE];
3797 char *hdr = list_to_text(csp->headers);
3798 memset(server_response, 0, sizeof(server_response));
3802 log_error(LOG_LEVEL_FATAL,
3803 "Out of memory parsing client header");
3805 list_remove_all(csp->headers);
3808 * Sending client's CONNECT request to the parent proxy
3810 ret = write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
3816 log_error(LOG_LEVEL_CONNECT,
3817 "Sending request headers to: %s failed", http->hostport);
3818 mark_server_socket_tainted(csp);
3819 close_client_ssl_connection(csp);
3823 /* Waiting for parent proxy server response */
3824 len = read_socket(csp->server_connection.sfd, server_response,
3825 sizeof(server_response)-1);
3829 log_error(LOG_LEVEL_ERROR, "No response from parent proxy "
3830 "server on socket %d.", csp->server_connection.sfd);
3832 rsp = error_response(csp, "no-server-data");
3835 send_crunch_response(csp, rsp);
3837 mark_server_socket_tainted(csp);
3838 close_client_ssl_connection(csp);
3843 * Test if connection with destination server was established
3844 * successfully by parent proxy. Then we can send response to
3845 * the client and continue or stop.
3847 if (!tunnel_established_successfully(server_response, (unsigned int)len))
3849 log_error(LOG_LEVEL_ERROR, "Forwarder hasn't established "
3850 "connection with destination server.");
3852 write_socket(csp->cfd, server_response, (size_t)len);
3853 mark_server_socket_tainted(csp);
3854 close_client_ssl_connection(csp);
3859 * Parent proxy has established connection with destination server.
3860 * Now we must create TLS/SSL connection with parent proxy.
3862 ret = create_server_ssl_connection(csp);
3865 * If TLS/SSL connection wasn't created and invalid certificate
3866 * wasn't detected, we can interrupt this function. Otherwise, we
3867 * must inform the client about invalid server certificate.
3870 && (csp->server_cert_verification_result == SSL_CERT_NOT_VERIFIED
3871 || csp->server_cert_verification_result == SSL_CERT_VALID))
3873 rsp = error_response(csp, "connect-failed");
3876 send_crunch_response(csp, rsp);
3882 * TLS/SSL connection with parent proxy is established, we can
3883 * inform client about success.
3885 ret = write_socket(csp->cfd, server_response, (size_t)len);
3888 log_error(LOG_LEVEL_ERROR,
3889 "Sending parent proxy response to client failed");
3890 mark_server_socket_tainted(csp);
3891 close_client_ssl_connection(csp);
3894 }/* -END- if (fwd->forward_host != NULL) */
3898 * Parent proxy is not used, we can just create TLS/SSL connection
3899 * with destination server
3901 int ret = create_server_ssl_connection(csp);
3904 if (csp->server_cert_verification_result != SSL_CERT_VALID &&
3905 csp->server_cert_verification_result != SSL_CERT_NOT_VERIFIED)
3908 * If the server certificate is invalid, we must inform
3909 * the client and then close connection to the client.
3911 ssl_send_certificate_error(csp);
3912 close_client_and_server_ssl_connections(csp);
3915 if (csp->server_cert_verification_result == SSL_CERT_NOT_VERIFIED
3916 || csp->server_cert_verification_result == SSL_CERT_VALID)
3919 * The TLS/SSL connection wasn't created but an invalid
3920 * certificate wasn't detected. Report it as connection
3923 rsp = error_response(csp, "connect-failed");
3926 send_crunch_response(csp, rsp);
3932 }/* -END- if (http->ssl) */
3933 #endif /* def FEATURE_HTTPS_INSPECTION */
3935 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3936 save_connection_destination(csp->server_connection.sfd,
3937 http, fwd, &csp->server_connection);
3938 csp->server_connection.keep_alive_timeout =
3939 (unsigned)csp->config->keep_alive_timeout;
3941 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3943 csp->server_connection.requests_sent_total++;
3945 if ((fwd->type == SOCKS_5T) && (NULL == csp->headers->first))
3947 /* Client headers have been sent optimistically */
3948 assert(csp->headers->last == NULL);
3950 else if (http->ssl == 0 || (fwd->forward_host
3951 #ifdef FEATURE_HTTPS_INSPECTION
3956 if (send_http_request(csp))
3958 rsp = error_response(csp, "connect-failed");
3961 send_crunch_response(csp, rsp);
3969 * Using old solution with SSL tunnel or new solution with SSL proxy
3971 list_remove_all(csp->headers);
3972 #ifdef FEATURE_HTTPS_INSPECTION
3977 * We're running an SSL tunnel and we're not forwarding,
3978 * so just ditch the client headers, send the "connect succeeded"
3979 * message to the client, flush the rest, and get out of the way.
3981 if (write_socket_delayed(csp->cfd, CSUCCEED,
3982 strlen(CSUCCEED), get_write_delay(csp)))
3987 #ifdef FEATURE_HTTPS_INSPECTION
3991 * If server certificate is invalid, we must inform client and then
3992 * close connection with client.
3994 if (csp->server_cert_verification_result != SSL_CERT_VALID)
3996 ssl_send_certificate_error(csp);
3997 close_client_and_server_ssl_connections(csp);
4000 if (send_https_request(csp))
4002 rsp = error_response(csp, "connect-failed");
4005 send_crunch_response(csp, rsp);
4007 close_client_and_server_ssl_connections(csp);
4011 #endif /* def FEATURE_HTTPS_INSPECTION */
4012 clear_iob(csp->client_iob);
4013 }/* -END- else ... if (http->ssl == 1) */
4015 log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
4017 /* XXX: should the time start earlier for optimistically sent data? */
4018 csp->server_connection.request_sent = time(NULL);
4020 handle_established_connection(csp);
4021 freez(csp->receive_buffer);
4026 /*********************************************************************
4028 * Function : fuzz_server_response
4030 * Description : Treat the input as a whole server response.
4033 * 1 : csp = Current client state (buffers, headers, etc...)
4034 * 2 : fuzz_input_file = File to read the input from.
4038 *********************************************************************/
4039 extern int fuzz_server_response(struct client_state *csp, char *fuzz_input_file)
4041 static struct forward_spec fwd; /* Zero'd due to being static */
4044 if (strcmp(fuzz_input_file, "-") == 0)
4046 /* XXX: Doesn'T work yet. */
4047 csp->server_connection.sfd = 0;
4051 csp->server_connection.sfd = open(fuzz_input_file, O_RDONLY);
4052 if (csp->server_connection.sfd == -1)
4054 log_error(LOG_LEVEL_FATAL, "Failed to open %s: %E",
4059 csp->content_type |= CT_GIF;
4060 csp->action->flags |= ACTION_DEANIMATE;
4061 csp->action->string[ACTION_STRING_DEANIMATE] = "last";
4063 csp->http->path = strdup_or_die("/");
4064 csp->http->host = strdup_or_die("fuzz.example.org");
4065 csp->http->hostport = strdup_or_die("fuzz.example.org:80");
4066 /* Prevent client socket monitoring */
4067 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
4068 csp->flags |= CSP_FLAG_CHUNKED;
4070 csp->config->feature_flags |= RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
4071 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
4073 csp->content_type |= CT_DECLARED|CT_GIF;
4075 csp->config->socket_timeout = 0;
4077 cgi_init_error_messages();
4079 handle_established_connection(csp);
4080 freez(csp->receive_buffer);
4087 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4088 /*********************************************************************
4090 * Function : prepare_csp_for_next_request
4092 * Description : Put the csp in a mostly vergin state.
4095 * 1 : csp = Current client state (buffers, headers, etc...)
4099 *********************************************************************/
4100 static void prepare_csp_for_next_request(struct client_state *csp)
4102 csp->content_type = 0;
4103 csp->content_length = 0;
4104 csp->expected_content_length = 0;
4105 csp->expected_client_content_length = 0;
4106 list_remove_all(csp->headers);
4107 clear_iob(csp->iob);
4108 freez(csp->error_message);
4109 free_http_request(csp->http);
4110 destroy_list(csp->headers);
4111 destroy_list(csp->tags);
4112 #ifdef FEATURE_CLIENT_TAGS
4113 destroy_list(csp->client_tags);
4114 freez(csp->client_address);
4116 free_current_action(csp->action);
4117 if (NULL != csp->fwd)
4119 unload_forward_spec(csp->fwd);
4122 /* XXX: Store per-connection flags someplace else. */
4123 csp->flags = (CSP_FLAG_ACTIVE | CSP_FLAG_REUSED_CLIENT_CONNECTION);
4124 #ifdef FEATURE_TOGGLE
4125 if (global_toggle_state)
4126 #endif /* def FEATURE_TOGGLE */
4128 csp->flags |= CSP_FLAG_TOGGLED_ON;
4131 if (csp->client_iob->eod > csp->client_iob->cur)
4133 long bytes_to_shift = csp->client_iob->cur - csp->client_iob->buf;
4134 size_t data_length = (size_t)(csp->client_iob->eod - csp->client_iob->cur);
4136 assert(bytes_to_shift > 0);
4137 assert(data_length > 0);
4139 log_error(LOG_LEVEL_CONNECT, "Shifting %d pipelined bytes by %d bytes",
4140 data_length, bytes_to_shift);
4141 memmove(csp->client_iob->buf, csp->client_iob->cur, data_length);
4142 csp->client_iob->cur = csp->client_iob->buf;
4143 assert(csp->client_iob->eod == csp->client_iob->buf + bytes_to_shift + data_length);
4144 csp->client_iob->eod = csp->client_iob->buf + data_length;
4145 memset(csp->client_iob->eod, '\0', (size_t)bytes_to_shift);
4147 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
4152 * We mainly care about resetting client_iob->cur so we don't
4153 * waste buffer space at the beginning and don't mess up the
4154 * request restoration done by cgi_show_request().
4156 * Freeing the buffer itself isn't technically necessary,
4157 * but makes debugging more convenient.
4159 clear_iob(csp->client_iob);
4162 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4165 /*********************************************************************
4169 * Description : This is little more than chat. We only "serve" to
4170 * to close (or remember) any socket that chat may have
4174 * 1 : csp = Current client state (buffers, headers, etc...)
4178 *********************************************************************/
4179 static void serve(struct client_state *csp)
4181 int config_file_change_detected = 0; /* Only used for debugging */
4182 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4183 #ifdef FEATURE_CONNECTION_SHARING
4184 static int monitor_thread_running = 0;
4185 #endif /* def FEATURE_CONNECTION_SHARING */
4186 int continue_chatting = 0;
4188 log_error(LOG_LEVEL_CONNECT, "Accepted connection from %s on socket %d",
4189 csp->ip_addr_str, csp->cfd);
4193 unsigned int latency;
4198 * If the request has been crunched,
4199 * the calculated latency is zero.
4201 latency = (unsigned)(csp->server_connection.response_received -
4202 csp->server_connection.request_sent) / 2;
4204 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4205 && (csp->flags & CSP_FLAG_CRUNCHED)
4206 && (csp->expected_client_content_length != 0))
4208 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
4209 log_error(LOG_LEVEL_CONNECT,
4210 "Tainting client socket %d due to unread data.", csp->cfd);
4213 continue_chatting = (csp->config->feature_flags
4214 & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
4215 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
4216 && (csp->cfd != JB_INVALID_SOCKET)
4217 && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4218 && ((csp->flags & CSP_FLAG_SERVER_CONTENT_LENGTH_SET)
4219 || (csp->flags & CSP_FLAG_CHUNKED));
4221 if (!(csp->flags & CSP_FLAG_CRUNCHED)
4222 && (csp->server_connection.sfd != JB_INVALID_SOCKET))
4224 if (!(csp->flags & CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET))
4226 csp->server_connection.keep_alive_timeout = csp->config->default_server_timeout;
4228 if (!(csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
4229 || (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
4230 || !socket_is_still_alive(csp->server_connection.sfd)
4231 || !(latency < csp->server_connection.keep_alive_timeout))
4233 log_error(LOG_LEVEL_CONNECT,
4234 "Closing server socket %d connected to %s. "
4235 "Keep-alive %u. Tainted: %u. Socket alive %u. Timeout: %u.",
4236 csp->server_connection.sfd, csp->server_connection.host,
4237 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
4238 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
4239 socket_is_still_alive(csp->server_connection.sfd),
4240 csp->server_connection.keep_alive_timeout);
4241 #ifdef FEATURE_CONNECTION_SHARING
4242 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4244 forget_connection(csp->server_connection.sfd);
4246 #endif /* def FEATURE_CONNECTION_SHARING */
4247 close_socket(csp->server_connection.sfd);
4248 mark_connection_closed(&csp->server_connection);
4252 if (continue_chatting && any_loaded_file_changed(csp))
4254 continue_chatting = 0;
4255 config_file_change_detected = 1;
4258 if (continue_chatting)
4260 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
4261 && socket_is_still_alive(csp->cfd))
4263 log_error(LOG_LEVEL_CONNECT, "Client request %d has been "
4264 "pipelined on socket %d and the socket is still alive.",
4265 csp->requests_received_total+1, csp->cfd);
4266 prepare_csp_for_next_request(csp);
4270 if (0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
4272 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4274 log_error(LOG_LEVEL_CONNECT,
4275 "Waiting for the next client request on socket %d. "
4276 "Keeping the server socket %d to %s open.",
4277 csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
4281 log_error(LOG_LEVEL_CONNECT,
4282 "Waiting for the next client request on socket %d. "
4283 "No server socket to keep open.", csp->cfd);
4287 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4288 && data_is_available(csp->cfd, (int)csp->config->keep_alive_timeout)
4289 && socket_is_still_alive(csp->cfd))
4291 log_error(LOG_LEVEL_CONNECT,
4292 "Client request %u arrived in time on socket %d.",
4293 csp->requests_received_total+1, csp->cfd);
4294 prepare_csp_for_next_request(csp);
4298 #ifdef FEATURE_CONNECTION_SHARING
4299 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4300 && (csp->server_connection.sfd != JB_INVALID_SOCKET)
4301 && (socket_is_still_alive(csp->server_connection.sfd)))
4303 time_t time_open = time(NULL) - csp->server_connection.timestamp;
4305 if (csp->server_connection.keep_alive_timeout < time_open - (time_t)latency)
4310 remember_connection(&csp->server_connection);
4311 csp->server_connection.sfd = JB_INVALID_SOCKET;
4312 drain_and_close_socket(csp->cfd);
4313 csp->cfd = JB_INVALID_SOCKET;
4314 privoxy_mutex_lock(&connection_reuse_mutex);
4315 if (!monitor_thread_running)
4317 monitor_thread_running = 1;
4318 privoxy_mutex_unlock(&connection_reuse_mutex);
4319 wait_for_alive_connections();
4320 privoxy_mutex_lock(&connection_reuse_mutex);
4321 monitor_thread_running = 0;
4323 privoxy_mutex_unlock(&connection_reuse_mutex);
4325 #endif /* def FEATURE_CONNECTION_SHARING */
4329 else if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4331 log_error(LOG_LEVEL_CONNECT,
4332 "Closing server socket %d connected to %s. Keep-alive: %u. "
4333 "Tainted: %u. Socket alive: %u. Timeout: %u. "
4334 "Configuration file change detected: %u",
4335 csp->server_connection.sfd, csp->server_connection.host,
4336 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
4337 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
4338 socket_is_still_alive(csp->server_connection.sfd),
4339 csp->server_connection.keep_alive_timeout,
4340 config_file_change_detected);
4342 } while (continue_chatting);
4346 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4348 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4350 #ifdef FEATURE_CONNECTION_SHARING
4351 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4353 forget_connection(csp->server_connection.sfd);
4355 #endif /* def FEATURE_CONNECTION_SHARING */
4356 close_socket(csp->server_connection.sfd);
4359 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4360 mark_connection_closed(&csp->server_connection);
4363 if (csp->cfd != JB_INVALID_SOCKET)
4365 log_error(LOG_LEVEL_CONNECT, "Closing client socket %d. "
4366 "Keep-alive: %u. Socket alive: %u. Data available: %u. "
4367 "Configuration file change detected: %u. Requests received: %u.",
4368 csp->cfd, 0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE),
4369 socket_is_still_alive(csp->cfd), data_is_available(csp->cfd, 0),
4370 config_file_change_detected, csp->requests_received_total);
4371 drain_and_close_socket(csp->cfd);
4374 free_csp_resources(csp);
4376 csp->flags &= ~CSP_FLAG_ACTIVE;
4382 /*********************************************************************
4384 * Function : server_thread
4386 * Description : We only exist to call `serve' in a threaded environment.
4389 * 1 : data = Current client state (buffers, headers, etc...)
4391 * Returns : Always 0.
4393 *********************************************************************/
4394 static int32 server_thread(void *data)
4396 serve((struct client_state *) data);
4403 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
4404 /*********************************************************************
4408 * Description : Print usage info & exit.
4410 * Parameters : Pointer to argv[0] for identifying ourselves
4414 *********************************************************************/
4415 static void usage(const char *name)
4417 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
4418 "Usage: %s [--config-test] "
4421 #endif /* defined(unix) */
4424 "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
4425 #endif /* defined(unix) */
4426 "[--version] [configfile]\n",
4430 show_fuzz_usage(name);
4433 printf("Aborting\n");
4438 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
4441 #ifdef MUTEX_LOCKS_AVAILABLE
4442 /*********************************************************************
4444 * Function : privoxy_mutex_lock
4446 * Description : Locks a mutex.
4449 * 1 : mutex = The mutex to lock.
4451 * Returns : Void. May exit in case of errors.
4453 *********************************************************************/
4454 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
4456 #ifdef FEATURE_PTHREAD
4457 int err = pthread_mutex_lock(mutex);
4460 if (mutex != &log_mutex)
4462 log_error(LOG_LEVEL_FATAL,
4463 "Mutex locking failed: %s.\n", strerror(err));
4468 EnterCriticalSection(mutex);
4469 #endif /* def FEATURE_PTHREAD */
4473 /*********************************************************************
4475 * Function : privoxy_mutex_unlock
4477 * Description : Unlocks a mutex.
4480 * 1 : mutex = The mutex to unlock.
4482 * Returns : Void. May exit in case of errors.
4484 *********************************************************************/
4485 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
4487 #ifdef FEATURE_PTHREAD
4488 int err = pthread_mutex_unlock(mutex);
4491 if (mutex != &log_mutex)
4493 log_error(LOG_LEVEL_FATAL,
4494 "Mutex unlocking failed: %s.\n", strerror(err));
4499 LeaveCriticalSection(mutex);
4500 #endif /* def FEATURE_PTHREAD */
4504 /*********************************************************************
4506 * Function : privoxy_mutex_init
4508 * Description : Prepares a mutex.
4511 * 1 : mutex = The mutex to initialize.
4513 * Returns : Void. May exit in case of errors.
4515 *********************************************************************/
4516 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
4518 #ifdef FEATURE_PTHREAD
4519 int err = pthread_mutex_init(mutex, 0);
4522 printf("Fatal error. Mutex initialization failed: %s.\n",
4527 InitializeCriticalSection(mutex);
4528 #endif /* def FEATURE_PTHREAD */
4530 #endif /* def MUTEX_LOCKS_AVAILABLE */
4532 /*********************************************************************
4534 * Function : initialize_mutexes
4536 * Description : Prepares mutexes if mutex support is available.
4540 * Returns : Void, exits in case of errors.
4542 *********************************************************************/
4543 static void initialize_mutexes(void)
4545 #ifdef MUTEX_LOCKS_AVAILABLE
4547 * Prepare global mutex semaphores
4550 #ifdef FEATURE_HTTPS_INSPECTION
4551 privoxy_mutex_init(&certificate_mutex);
4552 privoxy_mutex_init(&rng_mutex);
4555 privoxy_mutex_init(&log_mutex);
4556 privoxy_mutex_init(&log_init_mutex);
4557 privoxy_mutex_init(&connection_reuse_mutex);
4558 #ifdef FEATURE_EXTERNAL_FILTERS
4559 privoxy_mutex_init(&external_filter_mutex);
4561 #ifdef FEATURE_CLIENT_TAGS
4562 privoxy_mutex_init(&client_tags_mutex);
4566 * XXX: The assumptions below are a bit naive
4567 * and can cause locks that aren't necessary.
4569 * For example older FreeBSD versions (< 6.x?)
4570 * have no gethostbyname_r, but gethostbyname is
4573 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
4574 privoxy_mutex_init(&resolver_mutex);
4575 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
4577 * XXX: should we use a single mutex for
4578 * localtime() and gmtime() as well?
4580 #ifndef HAVE_GMTIME_R
4581 privoxy_mutex_init(&gmtime_mutex);
4582 #endif /* ndef HAVE_GMTIME_R */
4584 #ifndef HAVE_LOCALTIME_R
4585 privoxy_mutex_init(&localtime_mutex);
4586 #endif /* ndef HAVE_GMTIME_R */
4588 #if !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM)
4589 privoxy_mutex_init(&rand_mutex);
4590 #endif /* !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM) */
4592 #endif /* def MUTEX_LOCKS_AVAILABLE */
4595 /*********************************************************************
4599 * Description : Load the config file and start the listen loop.
4600 * This function is a lot more *sane* with the `load_config'
4601 * and `listen_loop' functions; although it stills does
4602 * a *little* too much for my taste.
4605 * 1 : argc = Number of parameters (including $0).
4606 * 2 : argv = Array of (char *)'s to the parameters.
4608 * Returns : 1 if : can't open config file, unrecognized directive,
4609 * stats requested in multi-thread mode, can't open the
4610 * log file, can't open the jar file, listen port is invalid,
4611 * any load fails, and can't bind port.
4613 * Else main never returns, the process must be signaled
4614 * to terminate execution. Or, on Windows, use the
4615 * "File", "Exit" menu option.
4617 *********************************************************************/
4619 int real_main(int argc, char **argv)
4621 int main(int argc, char **argv)
4625 int do_config_test = 0;
4626 #ifndef HAVE_ARC4RANDOM
4627 unsigned int random_seed;
4630 struct passwd *pw = NULL;
4631 struct group *grp = NULL;
4633 char *pre_chroot_nslookup_to_load_resolver = NULL;
4636 char *fuzz_input_type = NULL;
4637 char *fuzz_input_file = NULL;
4644 #if !defined(_WIN32)
4651 /* Prepare mutexes if supported and necessary. */
4652 initialize_mutexes();
4654 /* Enable logging until further notice. */
4658 * Parse the command line arguments
4660 * XXX: simply printing usage information in case of
4661 * invalid arguments isn't particularly user friendly.
4663 while (++argc_pos < argc)
4666 /* Check to see if the service must be installed or uninstalled */
4667 if (strncmp(argv[argc_pos], "--install", 9) == 0)
4669 const char *pName = argv[argc_pos] + 9;
4672 exit((install_service(pName)) ? 0 : 1);
4674 else if (strncmp(argv[argc_pos], "--uninstall", 11) == 0)
4676 const char *pName = argv[argc_pos] + 11;
4679 exit((uninstall_service(pName)) ? 0 : 1);
4681 else if (strcmp(argv[argc_pos], "--service") == 0)
4683 bRunAsService = TRUE;
4684 w32_set_service_cwd();
4685 atexit(w32_service_exit_notify);
4688 #endif /* defined(_WIN32) */
4691 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
4693 if (strcmp(argv[argc_pos], "--help") == 0)
4698 else if (strcmp(argv[argc_pos], "--version") == 0)
4700 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
4706 else if (strcmp(argv[argc_pos], "--no-daemon") == 0)
4708 set_debug_level(LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
4712 else if (strcmp(argv[argc_pos], "--pidfile") == 0)
4714 if (++argc_pos == argc) usage(argv[0]);
4715 pidfile = strdup_or_die(argv[argc_pos]);
4718 else if (strcmp(argv[argc_pos], "--user") == 0)
4723 if (++argc_pos == argc) usage(argv[argc_pos]);
4725 user_arg = strdup_or_die(argv[argc_pos]);
4726 group_name = strchr(user_arg, '.');
4727 if (NULL != group_name)
4729 /* Nul-terminate the user name */
4732 /* Skip the former delimiter to actually reach the group name */
4735 grp = getgrnam(group_name);
4738 log_error(LOG_LEVEL_FATAL, "Group '%s' not found.", group_name);
4741 pw = getpwnam(user_arg);
4744 log_error(LOG_LEVEL_FATAL, "User '%s' not found.", user_arg);
4750 else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup") == 0)
4752 if (++argc_pos == argc) usage(argv[0]);
4753 pre_chroot_nslookup_to_load_resolver = strdup_or_die(argv[argc_pos]);
4756 else if (strcmp(argv[argc_pos], "--chroot") == 0)
4760 #endif /* defined(unix) */
4762 else if (strcmp(argv[argc_pos], "--config-test") == 0)
4767 else if (strcmp(argv[argc_pos], "--fuzz") == 0)
4770 if (argc < argc_pos + 2) usage(argv[0]);
4771 fuzz_input_type = argv[argc_pos];
4773 fuzz_input_file = argv[argc_pos];
4775 else if (strcmp(argv[argc_pos], "--stfu") == 0)
4777 set_debug_level(LOG_LEVEL_STFU);
4780 else if (argc_pos + 1 != argc)
4783 * This is neither the last command line
4784 * option, nor was it recognized before,
4785 * therefore it must be invalid.
4791 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
4793 configfile = argv[argc_pos];
4796 } /* -END- while (more arguments) */
4798 show_version(Argv[0]);
4801 if (*configfile != '/')
4803 char cwd[BUFFER_SIZE];
4805 size_t abs_file_size;
4807 /* make config-filename absolute here */
4808 if (NULL == getcwd(cwd, sizeof(cwd)))
4810 perror("failed to get current working directory");
4814 basedir = strdup_or_die(cwd);
4816 abs_file_size = strlen(cwd) + strlen(configfile) + 5;
4817 abs_file = malloc_or_die(abs_file_size);
4818 strlcpy(abs_file, basedir, abs_file_size);
4819 strlcat(abs_file, "/", abs_file_size);
4820 strlcat(abs_file, configfile, abs_file_size);
4821 configfile = abs_file;
4823 #endif /* defined unix */
4827 clients->next = NULL;
4829 /* XXX: factor out initialising after the next stable release. */
4834 #ifndef HAVE_ARC4RANDOM
4835 random_seed = (unsigned int)time(NULL);
4837 srandom(random_seed);
4840 #endif /* ifdef HAVE_RANDOM */
4841 #endif /* ifndef HAVE_ARC4RANDOM */
4844 * Unix signal handling
4846 * Catch the abort, interrupt and terminate signals for a graceful exit
4847 * Catch the hangup signal so the errlog can be reopened.
4849 * Ignore the broken pipe signal as connection failures
4850 * are handled when and where they occur without relying
4853 #if !defined(_WIN32) && !defined(__OS2__)
4856 const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP };
4858 for (idx = 0; idx < SZ(catched_signals); idx++)
4860 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
4861 if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
4863 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
4864 #endif /* ifdef sun */
4866 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
4870 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
4872 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for SIGPIPE: %E");
4876 #else /* ifdef _WIN32 */
4877 # ifdef _WIN_CONSOLE
4879 * We *are* in a windows console app.
4880 * Print a verbose messages about FAQ's and such
4882 printf("%s", win32_blurb);
4883 # endif /* def _WIN_CONSOLE */
4884 #endif /* def _WIN32 */
4887 if (fuzz_input_type != NULL)
4889 exit(process_fuzzed_input(fuzz_input_type, fuzz_input_file));
4891 log_error(LOG_LEVEL_FATAL,
4892 "When compiled with fuzzing support, Privoxy should only be used for fuzzing. "
4893 "Various data structures are static which is unsafe when using threads.");
4898 exit(NULL == load_config());
4901 /* Initialize the CGI subsystem */
4902 cgi_init_error_messages();
4905 * If running on unix and without the --no-daemon
4906 * option, become a daemon. I.e. fork, detach
4907 * from tty and get process group leadership
4916 if (pid < 0) /* error */
4921 else if (pid != 0) /* parent */
4926 * must check for errors
4927 * child died due to missing files aso
4930 wpid = waitpid(pid, &status, WNOHANG);
4942 * stderr (fd 2) will be closed later on,
4943 * when the config file has been parsed.
4949 * Reserve fd 0 and 1 to prevent abort() and friends
4950 * from sending stuff to the clients or servers.
4952 fd = open("/dev/null", O_RDONLY);
4955 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
4959 if (dup2(fd, 0) == -1)
4961 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 0: %E");
4965 fd = open("/dev/null", O_WRONLY);
4968 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
4972 if (dup2(fd, 1) == -1)
4974 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 1: %E");
4979 #ifdef FEATURE_EXTERNAL_FILTERS
4980 for (fd = 0; fd < 3; fd++)
4982 mark_socket_for_close_on_execute(fd);
4988 } /* -END- if (daemon_mode) */
4991 * As soon as we have written the PID file, we can switch
4992 * to the user and group ID indicated by the --user option
4994 if (pidfile != NULL)
4996 write_pid_file(pidfile);
5000 if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
5002 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
5006 if (setgroups(1, &grp->gr_gid))
5008 log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
5011 else if (initgroups(pw->pw_name, pw->pw_gid))
5013 log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
5019 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
5021 /* Read the time zone file from /etc before doing chroot. */
5023 if (NULL != pre_chroot_nslookup_to_load_resolver
5024 && '\0' != pre_chroot_nslookup_to_load_resolver[0])
5026 /* Initialize resolver library. */
5027 (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
5029 if (chroot(pw->pw_dir) < 0)
5031 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
5035 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
5038 if (setuid(pw->pw_uid))
5040 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
5044 char putenv_dummy[64];
5046 strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
5047 if (putenv(putenv_dummy) != 0)
5049 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
5052 snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
5053 if (putenv(putenv_dummy) != 0)
5055 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
5061 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
5064 #endif /* defined unix */
5067 /* This will be FALSE unless the command line specified --service
5071 /* Yup, so now we must attempt to establish a connection
5072 * with the service dispatcher. This will only work if this
5073 * process was launched by the service control manager to
5074 * actually run as a service. If this isn't the case, i've
5075 * known it take around 30 seconds or so for the call to return.
5078 /* The StartServiceCtrlDispatcher won't return until the service is stopping */
5079 if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
5081 /* Service has run, and at this point is now being stopped, so just return */
5086 printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
5088 /* An error occurred. Usually it's because --service was wrongly specified
5089 * and we were unable to connect to the Service Control Dispatcher because
5090 * it wasn't expecting us and is therefore not listening.
5092 * For now, just continue below to call the listen_loop function.
5095 #endif /* def _WIN32 */
5105 /*********************************************************************
5107 * Function : bind_port_helper
5109 * Description : Bind the listen port. Handles logging, and aborts
5113 * 1 : haddr = Host address to bind to. Use NULL to bind to
5115 * 2 : hport = Specifies port to bind to.
5116 * 3 : backlog = Listen backlog.
5118 * Returns : Port that was opened.
5120 *********************************************************************/
5121 static jb_socket bind_port_helper(const char *haddr, int hport, int backlog)
5126 result = bind_port(haddr, hport, backlog, &bfd);
5130 const char *bind_address = (NULL != haddr) ? haddr : "INADDR_ANY";
5134 log_error(LOG_LEVEL_FATAL,
5135 "can't bind to %s:%d: There may be another Privoxy "
5136 "or some other proxy running on port %d",
5137 bind_address, hport, hport);
5140 log_error(LOG_LEVEL_FATAL,
5141 "can't bind to %s:%d: The hostname is not resolvable",
5142 bind_address, hport);
5145 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: %E",
5146 bind_address, hport);
5149 /* shouldn't get here */
5150 return JB_INVALID_SOCKET;
5155 if (bfd >= FD_SETSIZE)
5157 log_error(LOG_LEVEL_FATAL,
5158 "Bind socket number too high to use select(): %d >= %d",
5166 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
5171 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
5179 /*********************************************************************
5181 * Function : bind_ports_helper
5183 * Description : Bind the listen ports. Handles logging, and aborts
5187 * 1 : config = Privoxy configuration. Specifies ports
5189 * 2 : sockets = Preallocated array of opened sockets
5190 * corresponding to specification in config.
5191 * All non-opened sockets will be set to
5192 * JB_INVALID_SOCKET.
5194 * Returns : Nothing. Inspect sockets argument.
5196 *********************************************************************/
5197 static void bind_ports_helper(struct configuration_spec * config,
5198 jb_socket sockets[])
5202 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
5204 if (config->hport[i])
5206 sockets[i] = bind_port_helper(config->haddr[i],
5207 config->hport[i], config->listen_backlog);
5208 #if defined(FEATURE_ACCEPT_FILTER) && defined(SO_ACCEPTFILTER)
5209 if (config->enable_accept_filter && sockets[i] != JB_INVALID_SOCKET)
5211 struct accept_filter_arg af_options;
5212 bzero(&af_options, sizeof(af_options));
5213 strlcpy(af_options.af_name, "httpready", sizeof(af_options.af_name));
5214 if (setsockopt(sockets[i], SOL_SOCKET, SO_ACCEPTFILTER, &af_options,
5215 sizeof(af_options)))
5217 log_error(LOG_LEVEL_ERROR,
5218 "Enabling accept filter for socket %d failed: %E", sockets[i]);
5225 sockets[i] = JB_INVALID_SOCKET;
5228 config->need_bind = 0;
5232 /*********************************************************************
5234 * Function : close_ports_helper
5236 * Description : Close listenings ports.
5239 * 1 : sockets = Array of opened and non-opened sockets to
5240 * close. All sockets will be set to
5241 * JB_INVALID_SOCKET.
5243 * Returns : Nothing.
5245 *********************************************************************/
5246 static void close_ports_helper(jb_socket sockets[])
5250 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
5252 if (JB_INVALID_SOCKET != sockets[i])
5254 close_socket(sockets[i]);
5256 sockets[i] = JB_INVALID_SOCKET;
5262 /* Without this simple workaround we get this compiler warning from _beginthread
5263 * warning C4028: formal parameter 1 different from declaration
5265 void w32_service_listen_loop(void *p)
5269 #endif /* def _WIN32 */
5272 /*********************************************************************
5274 * Function : listen_loop
5276 * Description : bind the listen port and enter a "FOREVER" listening loop.
5282 *********************************************************************/
5283 static void listen_loop(void)
5285 struct client_states *csp_list = NULL;
5286 struct client_state *csp = NULL;
5287 jb_socket bfds[MAX_LISTENING_SOCKETS];
5288 struct configuration_spec *config;
5289 unsigned int active_threads = 0;
5290 #if defined(FEATURE_PTHREAD)
5291 pthread_attr_t attrs;
5293 pthread_attr_init(&attrs);
5294 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
5297 config = load_config();
5299 #ifdef FEATURE_CONNECTION_SHARING
5301 * XXX: Should be relocated once it no
5302 * longer needs to emit log messages.
5304 initialize_reusable_connections();
5305 #endif /* def FEATURE_CONNECTION_SHARING */
5307 bind_ports_helper(config, bfds);
5309 #ifdef FEATURE_GRACEFUL_TERMINATION
5310 while (!g_terminate)
5315 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(__OS2__)
5316 while (waitpid(-1, NULL, WNOHANG) > 0)
5318 /* zombie children */
5320 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) */
5323 * Free data that was used by died threads
5325 active_threads = sweep();
5329 * Re-open the errlog after HUP signal
5331 if (received_hup_signal)
5333 if (NULL != config->logfile)
5335 init_error_log(Argv[0], config->logfile);
5337 received_hup_signal = 0;
5341 csp_list = zalloc_or_die(sizeof(*csp_list));
5342 csp = &csp_list->csp;
5344 log_error(LOG_LEVEL_CONNECT,
5345 "Waiting for the next client connection. Currently active threads: %d",
5349 * This config may be outdated, but for accept_connection()
5350 * it's fresh enough.
5352 csp->config = config;
5354 if (!accept_connection(csp, bfds))
5356 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
5361 csp->flags |= CSP_FLAG_ACTIVE;
5362 csp->server_connection.sfd = JB_INVALID_SOCKET;
5364 csp->config = config = load_config();
5366 if (config->need_bind)
5369 * Since we were listening to the "old port", we will not see
5370 * a "listen" param change until the next request. So, at
5371 * least 1 more request must be made for us to find the new
5372 * setting. I am simply closing the old socket and binding the
5375 * Which-ever is correct, we will serve 1 more page via the
5376 * old settings. This should probably be a "show-status"
5377 * request. This should not be a so common of an operation
5378 * that this will hurt people's feelings.
5381 close_ports_helper(bfds);
5383 bind_ports_helper(config, bfds);
5386 #ifdef FEATURE_TOGGLE
5387 if (global_toggle_state)
5388 #endif /* def FEATURE_TOGGLE */
5390 csp->flags |= CSP_FLAG_TOGGLED_ON;
5393 if (run_loader(csp))
5395 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
5396 /* Never get here - LOG_LEVEL_FATAL causes program exit */
5400 if (block_acl(NULL,csp))
5402 log_error(LOG_LEVEL_CONNECT,
5403 "Connection from %s on %s (socket %d) dropped due to ACL",
5404 csp->ip_addr_str, csp->listen_addr_str, csp->cfd);
5405 close_socket(csp->cfd);
5406 freez(csp->ip_addr_str);
5407 freez(csp->listen_addr_str);
5411 #endif /* def FEATURE_ACL */
5413 if ((0 != config->max_client_connections)
5414 && (active_threads >= config->max_client_connections))
5416 log_error(LOG_LEVEL_CONNECT,
5417 "Rejecting connection from %s. Maximum number of connections reached.",
5419 write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
5420 strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
5421 close_socket(csp->cfd);
5422 freez(csp->ip_addr_str);
5423 freez(csp->listen_addr_str);
5428 /* add it to the list of clients */
5429 csp_list->next = clients->next;
5430 clients->next = csp_list;
5432 if (config->multi_threaded)
5436 /* this is a switch () statement in the C preprocessor - ugh */
5437 #undef SELECTED_ONE_OPTION
5439 /* Use Pthreads in preference to native code */
5440 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
5441 #define SELECTED_ONE_OPTION
5443 pthread_t the_thread;
5445 errno = pthread_create(&the_thread, &attrs,
5446 (void * (*)(void *))serve, csp);
5447 child_id = errno ? -1 : 0;
5451 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
5452 #define SELECTED_ONE_OPTION
5453 child_id = _beginthread(
5454 (void (*)(void *))serve,
5459 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
5460 #define SELECTED_ONE_OPTION
5461 child_id = _beginthread(
5462 (void(* _Optlink)(void*))serve,
5468 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
5469 #define SELECTED_ONE_OPTION
5471 thread_id tid = spawn_thread
5472 (server_thread, "server", B_NORMAL_PRIORITY, csp);
5474 if ((tid >= 0) && (resume_thread(tid) == B_OK))
5476 child_id = (int) tid;
5485 #if !defined(SELECTED_ONE_OPTION)
5488 /* This block is only needed when using fork().
5489 * When using threads, the server thread was
5490 * created and run by the call to _beginthread().
5492 if (child_id == 0) /* child */
5495 #ifdef FEATURE_TOGGLE
5496 int inherited_toggle_state = global_toggle_state;
5497 #endif /* def FEATURE_TOGGLE */
5502 * If we've been toggled or we've blocked the request, tell Mom
5505 #ifdef FEATURE_TOGGLE
5506 if (inherited_toggle_state != global_toggle_state)
5508 rc |= RC_FLAG_TOGGLED;
5510 #endif /* def FEATURE_TOGGLE */
5512 #ifdef FEATURE_STATISTICS
5513 if (csp->flags & CSP_FLAG_REJECTED)
5515 rc |= RC_FLAG_BLOCKED;
5517 #endif /* ndef FEATURE_STATISTICS */
5521 else if (child_id > 0) /* parent */
5523 /* in a fork()'d environment, the parent's
5524 * copy of the client socket and the CSP
5528 #if !defined(_WIN32) && !defined(__CYGWIN__)
5530 wait(&child_status);
5533 * Evaluate child's return code: If the child has
5534 * - been toggled, toggle ourselves
5535 * - blocked its request, bump up the stats counter
5538 #ifdef FEATURE_TOGGLE
5539 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
5541 global_toggle_state = !global_toggle_state;
5543 #endif /* def FEATURE_TOGGLE */
5545 #ifdef FEATURE_STATISTICS
5547 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
5551 #endif /* def FEATURE_STATISTICS */
5553 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
5554 close_socket(csp->cfd);
5555 csp->flags &= ~CSP_FLAG_ACTIVE;
5559 #undef SELECTED_ONE_OPTION
5560 /* end of cpp switch () */
5565 * Spawning the child failed, assume it's because
5566 * there are too many children running already.
5567 * XXX: If you assume ...
5569 log_error(LOG_LEVEL_ERROR,
5570 "Unable to take any additional connections: %E. Active threads: %d",
5572 write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
5573 strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
5574 close_socket(csp->cfd);
5575 csp->flags &= ~CSP_FLAG_ACTIVE;
5584 #if defined(FEATURE_PTHREAD)
5585 pthread_attr_destroy(&attrs);
5588 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
5590 #ifdef FEATURE_HTTPS_INSPECTION
5591 /* Clean up. Aim: free all memory (no leaks) */
5592 if (rng_seeded == 1)
5594 mbedtls_ctr_drbg_free(&ctr_drbg);
5595 mbedtls_entropy_free(&entropy);
5599 #ifdef FEATURE_GRACEFUL_TERMINATION
5601 log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
5603 unload_current_config_file();
5604 unload_current_actions_file();
5605 unload_current_re_filterfile();
5606 #ifdef FEATURE_TRUST
5607 unload_current_trust_file();
5610 if (config->multi_threaded)
5617 } while ((clients->next != NULL) && (--i > 0));
5621 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
5631 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
5632 /* Cleanup - remove taskbar icon etc. */
5637 #endif /* FEATURE_GRACEFUL_TERMINATION */