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(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;
207 #ifdef FEATURE_EXTENDED_STATISTICS
208 privoxy_mutex_t filter_statistics_mutex;
211 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
212 privoxy_mutex_t resolver_mutex;
213 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
215 #ifndef HAVE_GMTIME_R
216 privoxy_mutex_t gmtime_mutex;
217 #endif /* ndef HAVE_GMTIME_R */
219 #ifndef HAVE_LOCALTIME_R
220 privoxy_mutex_t localtime_mutex;
221 #endif /* ndef HAVE_GMTIME_R */
223 #if !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM)
224 privoxy_mutex_t rand_mutex;
225 #endif /* !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM) */
227 #endif /* def MUTEX_LOCKS_AVAILABLE */
230 const char *basedir = NULL;
231 const char *pidfile = NULL;
232 static int received_hup_signal = 0;
233 #endif /* defined unix */
235 /* HTTP snipplets. */
236 static const char CSUCCEED[] =
237 "HTTP/1.1 200 Connection established\r\n\r\n";
239 static const char CHEADER[] =
240 "HTTP/1.1 400 Invalid header received from client\r\n"
241 "Content-Type: text/plain\r\n"
242 "Connection: close\r\n\r\n"
243 "Invalid header received from client.\r\n";
245 static const char FTP_RESPONSE[] =
246 "HTTP/1.1 400 Invalid request received from client\r\n"
247 "Content-Type: text/plain\r\n"
248 "Connection: close\r\n\r\n"
249 "Invalid request. Privoxy doesn't support FTP.\r\n";
251 static const char GOPHER_RESPONSE[] =
252 "HTTP/1.1 400 Invalid request received from client\r\n"
253 "Content-Type: text/plain\r\n"
254 "Connection: close\r\n\r\n"
255 "Invalid request. Privoxy doesn't support gopher.\r\n";
257 /* XXX: should be a template */
258 static const char MISSING_DESTINATION_RESPONSE[] =
259 "HTTP/1.1 400 Bad request received from client\r\n"
260 "Content-Type: text/plain\r\n"
261 "Connection: close\r\n\r\n"
262 "Bad request. Privoxy was unable to extract the destination.\r\n";
264 /* XXX: should be a template */
265 static const char INVALID_SERVER_HEADERS_RESPONSE[] =
266 "HTTP/1.1 502 Server or forwarder response invalid\r\n"
267 "Content-Type: text/plain\r\n"
268 "Connection: close\r\n\r\n"
269 "Bad response. The server or forwarder response doesn't look like HTTP.\r\n";
271 /* XXX: should be a template */
272 static const char MESSED_UP_REQUEST_RESPONSE[] =
273 "HTTP/1.1 400 Malformed request after rewriting\r\n"
274 "Content-Type: text/plain\r\n"
275 "Connection: close\r\n\r\n"
276 "Bad request. Messed up with header filters.\r\n";
278 static const char TOO_MANY_CONNECTIONS_RESPONSE[] =
279 "HTTP/1.1 503 Too many open connections\r\n"
280 "Content-Type: text/plain\r\n"
281 "Connection: close\r\n\r\n"
282 "Maximum number of open connections reached.\r\n";
284 static const char CLIENT_CONNECTION_TIMEOUT_RESPONSE[] =
285 "HTTP/1.1 504 Connection timeout\r\n"
286 "Content-Type: text/plain\r\n"
287 "Connection: close\r\n\r\n"
288 "The connection timed out because the client request didn't arrive in time.\r\n";
290 static const char CLIENT_BODY_PARSE_ERROR_RESPONSE[] =
291 "HTTP/1.1 400 Failed reading client body\r\n"
292 "Content-Type: text/plain\r\n"
293 "Connection: close\r\n\r\n"
294 "Failed parsing or buffering the chunk-encoded client body.\r\n";
296 static const char UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE[] =
297 "HTTP/1.1 417 Expecting too much\r\n"
298 "Content-Type: text/plain\r\n"
299 "Connection: close\r\n\r\n"
300 "Privoxy detected an unsupported Expect header value.\r\n";
302 /* A function to crunch a response */
303 typedef struct http_response *(*crunch_func_ptr)(struct client_state *);
305 /* Crunch function flags */
306 #define CF_NO_FLAGS 0
307 /* Cruncher applies to forced requests as well */
308 #define CF_IGNORE_FORCE 1
309 /* Crunched requests are counted for the block statistics */
310 #define CF_COUNT_AS_REJECT 2
312 /* A crunch function and its flags */
315 const crunch_func_ptr cruncher;
319 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[]);
321 /* Complete list of cruncher functions */
322 static const struct cruncher crunchers_all[] = {
323 { direct_response, CF_COUNT_AS_REJECT|CF_IGNORE_FORCE},
324 { block_url, CF_COUNT_AS_REJECT },
326 { trust_url, CF_COUNT_AS_REJECT },
327 #endif /* def FEATURE_TRUST */
328 { redirect_url, CF_NO_FLAGS },
329 { dispatch_cgi, CF_IGNORE_FORCE},
333 /* Light version, used after tags are applied */
334 static const struct cruncher crunchers_light[] = {
335 { block_url, CF_COUNT_AS_REJECT },
336 { redirect_url, CF_NO_FLAGS },
342 * XXX: Don't we really mean
348 #if !defined(_WIN32) && !defined(__OS2__)
349 /*********************************************************************
351 * Function : sig_handler
353 * Description : Signal handler for different signals.
354 * Exit gracefully on TERM and INT
355 * or set a flag that will cause the errlog
356 * to be reopened by the main thread on HUP.
359 * 1 : the_signal = the signal cause this function to call
363 *********************************************************************/
364 static void sig_handler(int the_signal)
370 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
382 received_hup_signal = 1;
388 * We shouldn't be here, unless we catch signals
389 * in main() that we can't handle here!
391 log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
399 /*********************************************************************
401 * Function : get_write_delay
403 * Description : Parse the delay-response parameter.
406 * 1 : csp = Current client state (buffers, headers, etc...)
408 * Returns : Number of milliseconds to delay writes.
410 *********************************************************************/
411 static unsigned int get_write_delay(const struct client_state *csp)
417 if ((csp->action->flags & ACTION_DELAY_RESPONSE) == 0)
421 newval = csp->action->string[ACTION_STRING_DELAY_RESPONSE];
423 delay = (unsigned)strtol(newval, &endptr, 0);
426 log_error(LOG_LEVEL_FATAL,
427 "Invalid delay-response{} parameter: '%s'", newval);
435 /*********************************************************************
437 * Function : client_protocol_is_unsupported
439 * Description : Checks if the client used a known unsupported
440 * protocol and deals with it by sending an error
444 * 1 : csp = Current client state (buffers, headers, etc...)
445 * 2 : req = the first request line send by the client
447 * Returns : TRUE if an error response has been generated, or
448 * FALSE if the request doesn't look invalid.
450 *********************************************************************/
451 static int client_protocol_is_unsupported(struct client_state *csp, char *req)
454 * If it's a FTP or gopher request, we don't support it.
456 * These checks are better than nothing, but they might
457 * not work in all configurations and some clients might
458 * have problems digesting the answer.
460 * They should, however, never cause more problems than
461 * Privoxy's old behaviour (returning the misleading HTML
464 * "Could not resolve http://(ftp|gopher)://example.org").
466 if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
468 const char *response = NULL;
469 const char *protocol = NULL;
471 if (!strncmpic(req, "GET ftp://", 10))
473 response = FTP_RESPONSE;
478 response = GOPHER_RESPONSE;
481 log_error(LOG_LEVEL_ERROR,
482 "%s tried to use Privoxy as %s proxy: %s",
483 csp->ip_addr_str, protocol, req);
484 log_error(LOG_LEVEL_CLF,
485 "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, req);
488 #ifdef FEATURE_HTTPS_INSPECTION
489 if (client_use_ssl(csp))
491 ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
492 (const unsigned char *)response, strlen(response),
493 get_write_delay(csp));
498 write_socket_delayed(csp->cfd, response, strlen(response),
499 get_write_delay(csp));
509 /*********************************************************************
511 * Function : client_has_unsupported_expectations
513 * Description : Checks if the client used an unsupported expectation
514 * in which case an error message is delivered.
517 * 1 : csp = Current client state (buffers, headers, etc...)
519 * Returns : TRUE if an error response has been generated, or
520 * FALSE if the request doesn't look invalid.
522 *********************************************************************/
523 static int client_has_unsupported_expectations(const struct client_state *csp)
525 if ((csp->flags & CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION))
527 log_error(LOG_LEVEL_ERROR,
528 "Rejecting request from client %s with unsupported Expect header value",
530 log_error(LOG_LEVEL_CLF,
531 "%s - - [%T] \"%s\" 417 0", csp->ip_addr_str, csp->http->cmd);
532 write_socket_delayed(csp->cfd,
533 UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE,
534 strlen(UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE),
535 get_write_delay(csp));
545 /*********************************************************************
547 * Function : get_request_destination_elsewhere
549 * Description : If the client's request was redirected into
550 * Privoxy without the client's knowledge,
551 * the request line lacks the destination host.
553 * This function tries to get it elsewhere,
554 * provided accept-intercepted-requests is enabled.
556 * "Elsewhere" currently only means "Host: header",
557 * but in the future we may ask the redirecting
558 * packet filter to look the destination up.
560 * If the destination stays unknown, an error
561 * response is send to the client and headers
562 * are freed so that chat() can return directly.
565 * 1 : csp = Current client state (buffers, headers, etc...)
566 * 2 : headers = a header list
568 * Returns : JB_ERR_OK if the destination is now known, or
569 * JB_ERR_PARSE if it isn't.
571 *********************************************************************/
572 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
576 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
578 log_error(LOG_LEVEL_ERROR, "%s's request: \'%s\' is invalid."
579 " Privoxy isn't configured to accept intercepted requests.",
580 csp->ip_addr_str, csp->http->cmd);
581 /* XXX: Use correct size */
582 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
583 csp->ip_addr_str, csp->http->cmd);
585 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER),
586 get_write_delay(csp));
587 destroy_list(headers);
591 else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
593 /* Split the domain we just got for pattern matching */
594 init_domain_components(csp->http);
600 /* We can't work without destination. Go spread the news.*/
602 req = list_to_text(headers);
604 /* XXX: Use correct size */
605 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
606 csp->ip_addr_str, csp->http->cmd);
607 log_error(LOG_LEVEL_ERROR,
608 "Privoxy was unable to get the destination for %s's request:\n%s\n%s",
609 csp->ip_addr_str, csp->http->cmd, req);
612 write_socket_delayed(csp->cfd, MISSING_DESTINATION_RESPONSE,
613 strlen(MISSING_DESTINATION_RESPONSE), get_write_delay(csp));
614 destroy_list(headers);
619 * TODO: If available, use PF's ioctl DIOCNATLOOK as last resort
620 * to get the destination IP address, use it as host directly
621 * or do a reverse DNS lookup first.
626 /*********************************************************************
628 * Function : get_server_headers
630 * Description : Parses server headers in iob and fills them
631 * into csp->headers so that they can later be
635 * 1 : csp = Current client state (buffers, headers, etc...)
637 * Returns : JB_ERR_OK if everything went fine, or
638 * JB_ERR_PARSE if the headers were incomplete.
640 *********************************************************************/
641 static jb_err get_server_headers(struct client_state *csp)
643 int continue_hack_in_da_house = 0;
646 while (((header = get_header(csp->iob)) != NULL) || continue_hack_in_da_house)
651 * continue hack in da house. Ignore the ending of
652 * this head and continue enlisting header lines.
653 * The reason is described below.
655 enlist(csp->headers, "");
656 continue_hack_in_da_house = 0;
659 else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
662 * It's a bodyless continue response, don't
663 * stop header parsing after reaching its end.
665 * As a result Privoxy will concatenate the
666 * next response's head and parse and deliver
667 * the headers as if they belonged to one request.
669 * The client will separate them because of the
670 * empty line between them.
672 * XXX: What we're doing here is clearly against
673 * the intended purpose of the continue header,
674 * and under some conditions (HTTP/1.0 client request)
675 * it's a standard violation.
677 * Anyway, "sort of against the spec" is preferable
678 * to "always getting confused by Continue responses"
679 * (Privoxy's behaviour before this hack was added)
681 log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
682 continue_hack_in_da_house = 1;
684 else if (*header == '\0')
687 * If the header is empty, but the Continue hack
688 * isn't active, we can assume that we reached the
689 * end of the buffer before we hit the end of the
692 * Inform the caller an let it decide how to handle it.
697 if (JB_ERR_MEMORY == enlist(csp->headers, header))
700 * XXX: Should we quit the request and return a
701 * out of memory error page instead?
703 log_error(LOG_LEVEL_ERROR,
704 "Out of memory while enlisting server headers. %s lost.",
714 /*********************************************************************
716 * Function : crunch_reason
718 * Description : Translates the crunch reason code into a string.
721 * 1 : rsp = a http_response
723 * Returns : A string with the crunch reason or an error description.
725 *********************************************************************/
726 static const char *crunch_reason(const struct http_response *rsp)
728 char * reason = NULL;
733 return "Internal error while searching for crunch reason";
736 switch (rsp->crunch_reason)
739 reason = "Unsupported HTTP feature";
745 reason = "Untrusted";
748 reason = "Redirected";
754 reason = "DNS failure";
756 case FORWARDING_FAILED:
757 reason = "Forwarding failed";
760 reason = "Connection failure";
763 reason = "Out of memory (may mask other reasons)";
765 case CONNECTION_TIMEOUT:
766 reason = "Connection timeout";
769 reason = "No server data received";
772 reason = "No reason recorded";
780 /*********************************************************************
782 * Function : log_applied_actions
784 * Description : Logs the applied actions if LOG_LEVEL_ACTIONS is
788 * 1 : actions = Current action spec to log
792 *********************************************************************/
793 static void log_applied_actions(const struct current_action_spec *actions)
796 * The conversion to text requires lots of memory allocations so
797 * we only do the conversion if the user is actually interested.
799 if (debug_level_is_enabled(LOG_LEVEL_ACTIONS))
801 char *actions_as_text = actions_to_line_of_text(actions);
802 log_error(LOG_LEVEL_ACTIONS, "%s", actions_as_text);
803 freez(actions_as_text);
808 /*********************************************************************
810 * Function : send_crunch_response
812 * Description : Delivers already prepared response for
813 * intercepted requests, logs the interception
814 * and frees the response.
817 * 1 : csp = Current client state (buffers, headers, etc...)
818 * 2 : rsp = Fully prepared response. Will be freed on exit.
822 *********************************************************************/
823 static void send_crunch_response(struct client_state *csp, struct http_response *rsp)
825 const struct http_request *http = csp->http;
829 assert(rsp->head != NULL);
833 log_error(LOG_LEVEL_FATAL, "NULL response in send_crunch_response.");
837 * Extract the status code from the actual head
838 * that will be send to the client. It is the only
839 * way to get it right for all requests, including
840 * the fixed ones for out-of-memory problems.
842 * A head starts like this: 'HTTP/1.1 200...'
846 status_code[0] = rsp->head[9];
847 status_code[1] = rsp->head[10];
848 status_code[2] = rsp->head[11];
849 status_code[3] = '\0';
851 /* Log that the request was crunched and why. */
852 log_applied_actions(csp->action);
853 #ifdef FEATURE_HTTPS_INSPECTION
854 if (client_use_ssl(csp))
856 log_error(LOG_LEVEL_CRUNCH, "%s: https://%s%s", crunch_reason(rsp),
857 http->hostport, http->path);
858 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s https://%s%s %s\" %s %llu",
859 csp->ip_addr_str, http->gpc, http->hostport, http->path,
860 http->version, status_code, rsp->content_length);
865 log_error(LOG_LEVEL_CRUNCH, "%s: %s", crunch_reason(rsp), http->url);
866 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" %s %u",
867 csp->ip_addr_str, http->ocmd, status_code, rsp->content_length);
869 /* Write the answer to the client */
870 #ifdef FEATURE_HTTPS_INSPECTION
871 if (client_use_ssl(csp))
873 if ((ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
874 (const unsigned char *)rsp->head, rsp->head_length,
875 get_write_delay(csp)) < 0)
876 || (ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
877 (const unsigned char *)rsp->body, rsp->content_length,
878 get_write_delay(csp)) < 0))
880 /* There is nothing we can do about it. */
881 log_error(LOG_LEVEL_CONNECT, "Couldn't deliver the error message "
882 "for %s through client socket %d using TLS/SSL",
883 http->url, csp->cfd);
889 if (write_socket_delayed(csp->cfd, rsp->head, rsp->head_length,
890 get_write_delay(csp))
891 || write_socket_delayed(csp->cfd, rsp->body, rsp->content_length,
892 get_write_delay(csp)))
894 /* There is nothing we can do about it. */
895 log_error(LOG_LEVEL_CONNECT,
896 "Couldn't deliver the error message for %s through client socket %d: %E",
897 http->url, csp->cfd);
901 /* Clean up and return */
902 if (cgi_error_memory() != rsp)
904 free_http_response(rsp);
910 /*********************************************************************
912 * Function : crunch_response_triggered
914 * Description : Checks if the request has to be crunched,
915 * and delivers the crunch response if necessary.
918 * 1 : csp = Current client state (buffers, headers, etc...)
919 * 2 : crunchers = list of cruncher functions to run
921 * Returns : TRUE if the request was answered with a crunch response
924 *********************************************************************/
925 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[])
927 struct http_response *rsp = NULL;
928 const struct cruncher *c;
931 * If CGI request crunching is disabled,
932 * check the CGI dispatcher out of order to
933 * prevent unintentional blocks or redirects.
935 if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_CRUNCHING)
936 && (NULL != (rsp = dispatch_cgi(csp))))
938 /* Deliver, log and free the interception response. */
939 send_crunch_response(csp, rsp);
940 csp->flags |= CSP_FLAG_CRUNCHED;
944 for (c = crunchers; c->cruncher != NULL; c++)
947 * Check the cruncher if either Privoxy is toggled
948 * on and the request isn't forced, or if the cruncher
949 * applies to forced requests as well.
951 if (((csp->flags & CSP_FLAG_TOGGLED_ON) &&
952 !(csp->flags & CSP_FLAG_FORCED)) ||
953 (c->flags & CF_IGNORE_FORCE))
955 rsp = c->cruncher(csp);
958 /* Deliver, log and free the interception response. */
959 send_crunch_response(csp, rsp);
960 csp->flags |= CSP_FLAG_CRUNCHED;
961 #ifdef FEATURE_STATISTICS
962 if (c->flags & CF_COUNT_AS_REJECT)
964 csp->flags |= CSP_FLAG_REJECTED;
966 #endif /* def FEATURE_STATISTICS */
977 /*********************************************************************
979 * Function : build_request_line
981 * Description : Builds the HTTP request line.
983 * If a HTTP forwarder is used it expects the whole URL,
984 * web servers only get the path.
987 * 1 : csp = Current client state (buffers, headers, etc...)
988 * 2 : fwd = The forwarding spec used for the request
989 * XXX: Should use http->fwd instead.
990 * 3 : request_line = The old request line which will be replaced.
992 * Returns : Nothing. Terminates in case of memory problems.
994 *********************************************************************/
995 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line)
997 struct http_request *http = csp->http;
1000 * Downgrade http version from 1.1 to 1.0
1001 * if +downgrade action applies.
1003 if ((csp->action->flags & ACTION_DOWNGRADE)
1004 && (!strcmpic(http->version, "HTTP/1.1")))
1006 freez(http->version);
1007 http->version = strdup_or_die("HTTP/1.0");
1011 * Rebuild the request line.
1013 freez(*request_line);
1014 *request_line = strdup(http->gpc);
1015 string_append(request_line, " ");
1017 if (fwd->forward_host && fwd->type != FORWARD_WEBSERVER)
1019 string_append(request_line, http->url);
1023 string_append(request_line, http->path);
1025 string_append(request_line, " ");
1026 string_append(request_line, http->version);
1028 if (*request_line == NULL)
1030 log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
1032 log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", *request_line);
1036 /*********************************************************************
1038 * Function : change_request_destination
1040 * Description : Parse a (rewritten) request line and regenerate
1041 * the http request data.
1044 * 1 : csp = Current client state (buffers, headers, etc...)
1046 * Returns : Forwards the parse_http_request() return code.
1047 * Terminates in case of memory problems.
1049 *********************************************************************/
1050 static jb_err change_request_destination(struct client_state *csp)
1052 struct http_request *http = csp->http;
1055 log_error(LOG_LEVEL_REDIRECTS, "Rewrite detected: %s",
1056 csp->headers->first->str);
1057 free_http_request(http);
1058 err = parse_http_request(csp->headers->first->str, http);
1059 if (JB_ERR_OK != err)
1061 log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
1062 jb_err_to_string(err));
1069 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1070 /*********************************************************************
1072 * Function : server_response_is_complete
1074 * Description : Determines whether we should stop reading
1075 * from the server socket.
1078 * 1 : csp = Current client state (buffers, headers, etc...)
1079 * 2 : content_length = Length of content received so far.
1081 * Returns : TRUE if the response is complete,
1084 *********************************************************************/
1085 static int server_response_is_complete(struct client_state *csp,
1086 unsigned long long content_length)
1088 int content_length_known = !!(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET);
1090 if (!strcmpic(csp->http->gpc, "HEAD"))
1093 * "HEAD" implies no body, we are thus expecting
1094 * no content. XXX: incomplete "list" of methods?
1096 csp->expected_content_length = 0;
1097 content_length_known = TRUE;
1098 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1101 if (csp->http->status == 204 || csp->http->status == 304)
1104 * Expect no body. XXX: incomplete "list" of status codes?
1106 csp->expected_content_length = 0;
1107 content_length_known = TRUE;
1108 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1111 return (content_length_known && ((0 == csp->expected_content_length)
1112 || (csp->expected_content_length <= content_length)));
1116 #ifdef FEATURE_CONNECTION_SHARING
1117 /*********************************************************************
1119 * Function : wait_for_alive_connections
1121 * Description : Waits for alive connections to timeout.
1127 *********************************************************************/
1128 static void wait_for_alive_connections(void)
1130 int connections_alive = close_unusable_connections();
1132 while (0 < connections_alive)
1134 log_error(LOG_LEVEL_CONNECT,
1135 "Waiting for %d connections to timeout.",
1138 connections_alive = close_unusable_connections();
1141 log_error(LOG_LEVEL_CONNECT, "No connections to wait for left.");
1144 #endif /* def FEATURE_CONNECTION_SHARING */
1147 /*********************************************************************
1149 * Function : save_connection_destination
1151 * Description : Remembers a connection for reuse later on.
1154 * 1 : sfd = Open socket to remember.
1155 * 2 : http = The destination for the connection.
1156 * 3 : fwd = The forwarder settings used.
1157 * 4 : server_connection = storage.
1161 *********************************************************************/
1162 void save_connection_destination(jb_socket sfd,
1163 const struct http_request *http,
1164 const struct forward_spec *fwd,
1165 struct reusable_connection *server_connection)
1167 assert(sfd != JB_INVALID_SOCKET);
1168 assert(NULL != http->host);
1170 server_connection->sfd = sfd;
1171 server_connection->host = strdup_or_die(http->host);
1172 server_connection->port = http->port;
1174 assert(NULL != fwd);
1175 assert(server_connection->gateway_host == NULL);
1176 assert(server_connection->gateway_port == 0);
1177 assert(server_connection->forwarder_type == 0);
1178 assert(server_connection->forward_host == NULL);
1179 assert(server_connection->forward_port == 0);
1181 server_connection->forwarder_type = fwd->type;
1182 if (NULL != fwd->gateway_host)
1184 server_connection->gateway_host = strdup_or_die(fwd->gateway_host);
1188 server_connection->gateway_host = NULL;
1190 server_connection->gateway_port = fwd->gateway_port;
1192 if (NULL != fwd->forward_host)
1194 server_connection->forward_host = strdup_or_die(fwd->forward_host);
1198 server_connection->forward_host = NULL;
1200 server_connection->forward_port = fwd->forward_port;
1204 /*********************************************************************
1206 * Function : verify_request_length
1208 * Description : Checks if we already got the whole client requests
1209 * and sets CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ if
1212 * Data that doesn't belong to the current request is
1213 * either thrown away to let the client retry on a clean
1214 * socket, or stashed to be dealt with after the current
1215 * request is served.
1218 * 1 : csp = Current client state (buffers, headers, etc...)
1222 *********************************************************************/
1223 static void verify_request_length(struct client_state *csp)
1225 unsigned long long buffered_request_bytes =
1226 (unsigned long long)(csp->client_iob->eod - csp->client_iob->cur);
1228 if ((csp->expected_client_content_length != 0)
1229 && (buffered_request_bytes != 0))
1231 if (csp->expected_client_content_length >= buffered_request_bytes)
1233 csp->expected_client_content_length -= buffered_request_bytes;
1234 log_error(LOG_LEVEL_CONNECT, "Reduced expected bytes to %llu "
1235 "to account for the %llu ones we already got.",
1236 csp->expected_client_content_length, buffered_request_bytes);
1240 assert(csp->client_iob->eod > csp->client_iob->cur + csp->expected_client_content_length);
1241 csp->client_iob->eod = csp->client_iob->cur + csp->expected_client_content_length;
1242 log_error(LOG_LEVEL_CONNECT, "Reducing expected bytes to 0. "
1243 "Marking the server socket tainted after throwing %llu bytes away.",
1244 buffered_request_bytes - csp->expected_client_content_length);
1245 csp->expected_client_content_length = 0;
1246 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1249 if (csp->expected_client_content_length == 0)
1251 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1255 if (!(csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ)
1256 && ((csp->client_iob->cur < csp->client_iob->eod)
1257 || (csp->expected_client_content_length != 0)))
1259 if (strcmpic(csp->http->gpc, "GET")
1260 && strcmpic(csp->http->gpc, "HEAD")
1261 && strcmpic(csp->http->gpc, "TRACE")
1262 && strcmpic(csp->http->gpc, "OPTIONS")
1263 && strcmpic(csp->http->gpc, "DELETE"))
1265 /* XXX: this is an incomplete hack */
1266 csp->flags &= ~CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1267 log_error(LOG_LEVEL_CONNECT, "There better be a request body.");
1271 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1273 if ((csp->config->feature_flags & RUNTIME_FEATURE_TOLERATE_PIPELINING) == 0)
1275 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1276 log_error(LOG_LEVEL_CONNECT,
1277 "Possible pipeline attempt detected. The connection will not "
1278 "be kept alive and we will only serve the first request.");
1279 /* Nuke the pipelined requests from orbit, just to be sure. */
1280 clear_iob(csp->client_iob);
1285 * Keep the pipelined data around for now, we'll deal with
1286 * it once we're done serving the current request.
1288 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
1289 assert(csp->client_iob->eod >= csp->client_iob->cur);
1290 log_error(LOG_LEVEL_CONNECT, "Complete client request followed by "
1291 "%d bytes of pipelined data received.",
1292 (int)(csp->client_iob->eod - csp->client_iob->cur));
1298 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1299 log_error(LOG_LEVEL_CONNECT, "Complete client request received.");
1302 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1305 /*********************************************************************
1307 * Function : mark_server_socket_tainted
1309 * Description : Makes sure we don't reuse a server socket
1310 * (if we didn't read everything the server sent
1311 * us reusing the socket would lead to garbage).
1314 * 1 : csp = Current client state (buffers, headers, etc...)
1318 *********************************************************************/
1319 static void mark_server_socket_tainted(struct client_state *csp)
1322 * For consistency we always mark the server socket
1323 * tainted, however, to reduce the log noise we only
1324 * emit a log message if the server socket could have
1325 * actually been reused.
1327 if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
1328 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED))
1330 log_error(LOG_LEVEL_CONNECT,
1331 "Marking the server socket %d tainted.",
1332 csp->server_connection.sfd);
1334 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1337 /*********************************************************************
1339 * Function : get_request_line
1341 * Description : Read the client request line.
1344 * 1 : csp = Current client state (buffers, headers, etc...)
1346 * Returns : Pointer to request line or NULL in case of errors.
1348 *********************************************************************/
1349 static char *get_request_line(struct client_state *csp)
1351 char buf[BUFFER_SIZE];
1352 char *request_line = NULL;
1355 memset(buf, 0, sizeof(buf));
1357 if ((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
1360 * If there are multiple pipelined requests waiting,
1361 * the flag will be set again once the next request
1364 csp->flags &= ~CSP_FLAG_PIPELINED_REQUEST_WAITING;
1366 request_line = get_header(csp->client_iob);
1367 if ((NULL != request_line) && ('\0' != *request_line))
1369 return request_line;
1373 log_error(LOG_LEVEL_CONNECT, "No complete request line "
1374 "received yet. Continuing reading from %d.", csp->cfd);
1382 0 == (csp->flags & CSP_FLAG_FUZZED_INPUT) &&
1384 !data_is_available(csp->cfd, csp->config->socket_timeout)
1387 if (socket_is_still_alive(csp->cfd))
1389 log_error(LOG_LEVEL_CONNECT,
1390 "No request line on socket %d received in time. Timeout: %d.",
1391 csp->cfd, csp->config->socket_timeout);
1392 write_socket_delayed(csp->cfd, CLIENT_CONNECTION_TIMEOUT_RESPONSE,
1393 strlen(CLIENT_CONNECTION_TIMEOUT_RESPONSE),
1394 get_write_delay(csp));
1398 log_error(LOG_LEVEL_CONNECT,
1399 "The client side of the connection on socket %d got "
1400 "closed without sending a complete request line.", csp->cfd);
1405 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1407 if (len <= 0) return NULL;
1410 * If there is no memory left for buffering the
1411 * request, there is nothing we can do but hang up
1413 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1418 request_line = get_header(csp->client_iob);
1420 } while ((NULL != request_line) && ('\0' == *request_line));
1422 return request_line;
1428 CHUNK_STATUS_MISSING_DATA,
1429 CHUNK_STATUS_BODY_COMPLETE,
1430 CHUNK_STATUS_PARSE_ERROR
1434 /*********************************************************************
1436 * Function : chunked_body_is_complete
1438 * Description : Figures out whether or not a chunked body is complete.
1440 * Currently it always starts at the beginning of the
1441 * buffer which is somewhat wasteful and prevents Privoxy
1442 * from starting to forward the correctly parsed chunks
1443 * as soon as theoretically possible.
1445 * Should be modified to work with a common buffer,
1446 * and allow the caller to skip already parsed chunks.
1448 * This would allow the function to be used for unbuffered
1449 * response bodies as well.
1452 * 1 : iob = Buffer with the body to check.
1453 * 2 : length = Length of complete body
1455 * Returns : Enum with the result of the check.
1457 *********************************************************************/
1458 static enum chunk_status chunked_body_is_complete(struct iob *iob, size_t *length)
1460 unsigned int chunksize;
1466 * We need at least a single digit, followed by "\r\n",
1467 * followed by an unknown amount of data, followed by "\r\n".
1469 if (p + 5 > iob->eod)
1471 return CHUNK_STATUS_MISSING_DATA;
1473 if (sscanf(p, "%x", &chunksize) != 1)
1475 return CHUNK_STATUS_PARSE_ERROR;
1479 * We want at least a single digit, followed by "\r\n",
1480 * followed by the specified amount of data, followed by "\r\n".
1482 if (p + chunksize + 5 > iob->eod)
1484 return CHUNK_STATUS_MISSING_DATA;
1487 /* Skip chunk-size. */
1488 p = strstr(p, "\r\n");
1491 return CHUNK_STATUS_PARSE_ERROR;
1493 /* Move beyond the chunkdata. */
1496 /* There should be another "\r\n" to skip */
1497 if (memcmp(p, "\r\n", 2))
1499 return CHUNK_STATUS_PARSE_ERROR;
1502 } while (chunksize > 0U);
1504 *length = (size_t)(p - iob->cur);
1505 assert(*length <= (size_t)(iob->eod - iob->cur));
1506 assert(p <= iob->eod);
1508 return CHUNK_STATUS_BODY_COMPLETE;
1513 /*********************************************************************
1515 * Function : receive_chunked_client_request_body
1517 * Description : Read the chunk-encoded client request body.
1518 * Failures are dealt with.
1521 * 1 : csp = Current client state (buffers, headers, etc...)
1523 * Returns : JB_ERR_OK or JB_ERR_PARSE
1525 *********************************************************************/
1526 static jb_err receive_chunked_client_request_body(struct client_state *csp)
1529 enum chunk_status status;
1531 while (CHUNK_STATUS_MISSING_DATA ==
1532 (status = chunked_body_is_complete(csp->client_iob, &body_length)))
1534 char buf[BUFFER_SIZE];
1537 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1539 log_error(LOG_LEVEL_ERROR,
1540 "Timeout while waiting for the client body.");
1543 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1546 log_error(LOG_LEVEL_ERROR, "Read the client body failed: %E");
1549 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1554 if (status != CHUNK_STATUS_BODY_COMPLETE)
1556 write_socket_delayed(csp->cfd, CLIENT_BODY_PARSE_ERROR_RESPONSE,
1557 strlen(CLIENT_BODY_PARSE_ERROR_RESPONSE), get_write_delay(csp));
1558 log_error(LOG_LEVEL_CLF,
1559 "%s - - [%T] \"Failed reading chunked client body\" 400 0", csp->ip_addr_str);
1560 return JB_ERR_PARSE;
1562 log_error(LOG_LEVEL_CONNECT,
1563 "Chunked client body completely read. Length: %d", body_length);
1564 csp->expected_client_content_length = body_length;
1572 /*********************************************************************
1574 * Function : fuzz_chunked_transfer_encoding
1576 * Description : Treat the fuzzed input as chunked transfer encoding
1577 * to check and dechunk.
1580 * 1 : csp = Used to store the data.
1581 * 2 : fuzz_input_file = File to read the input from.
1583 * Returns : Result of dechunking
1585 *********************************************************************/
1586 extern int fuzz_chunked_transfer_encoding(struct client_state *csp, char *fuzz_input_file)
1589 size_t size = (size_t)(csp->iob->eod - csp->iob->cur);
1590 enum chunk_status status;
1592 status = chunked_body_is_complete(csp->iob, &length);
1593 if (CHUNK_STATUS_BODY_COMPLETE != status)
1595 log_error(LOG_LEVEL_INFO, "Chunked body is incomplete or invalid");
1598 return (JB_ERR_OK == remove_chunked_transfer_coding(csp->iob->cur, &size));
1603 /*********************************************************************
1605 * Function : fuzz_client_request
1607 * Description : Try to get a client request from the fuzzed input.
1610 * 1 : csp = Current client state (buffers, headers, etc...)
1611 * 2 : fuzz_input_file = File to read the input from.
1613 * Returns : Result of fuzzing.
1615 *********************************************************************/
1616 extern int fuzz_client_request(struct client_state *csp, char *fuzz_input_file)
1621 csp->ip_addr_str = "fuzzer";
1623 if (strcmp(fuzz_input_file, "-") != 0)
1625 log_error(LOG_LEVEL_FATAL,
1626 "Fuzzed client requests can currently only be read from stdin (-).");
1628 err = receive_client_request(csp);
1629 if (err != JB_ERR_OK)
1633 err = parse_client_request(csp);
1634 if (err != JB_ERR_OK)
1642 #endif /* def FUZZ */
1645 #ifdef FEATURE_FORCE_LOAD
1646 /*********************************************************************
1648 * Function : force_required
1650 * Description : Checks a request line to see if it contains
1651 * the FORCE_PREFIX. If it does, it is removed
1652 * unless enforcing requests has beend disabled.
1655 * 1 : request_line = HTTP request line
1657 * Returns : TRUE if force is required, FALSE otherwise.
1659 *********************************************************************/
1660 static int force_required(const struct client_state *csp, char *request_line)
1664 p = strstr(request_line, "http://");
1668 p += strlen("http://");
1672 /* Intercepted request usually don't specify the protocol. */
1676 /* Go to the beginning of the path */
1681 * If the path is missing the request line is invalid and we
1682 * are done here. The client-visible rejection happens later on.
1687 if (0 == strncmpic(p, FORCE_PREFIX, strlen(FORCE_PREFIX) - 1))
1689 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS))
1691 /* XXX: Should clean more carefully */
1692 strclean(request_line, FORCE_PREFIX);
1693 log_error(LOG_LEVEL_FORCE,
1694 "Enforcing request: \"%s\".", request_line);
1698 log_error(LOG_LEVEL_FORCE,
1699 "Ignored force prefix in request: \"%s\".", request_line);
1705 #endif /* def FEATURE_FORCE_LOAD */
1708 /*********************************************************************
1710 * Function : receive_client_request
1712 * Description : Read the client's request (more precisely the
1713 * client headers) and answer it if necessary.
1716 * 1 : csp = Current client state (buffers, headers, etc...)
1718 * Returns : JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
1720 *********************************************************************/
1721 static jb_err receive_client_request(struct client_state *csp)
1723 char buf[BUFFER_SIZE];
1726 struct http_request *http;
1730 /* Temporary copy of the client's headers before they get enlisted in csp->headers */
1731 struct list header_list;
1732 struct list *headers = &header_list;
1734 /* We don't care if the arriving data is a valid HTTP request or not. */
1735 csp->requests_received_total++;
1739 memset(buf, 0, sizeof(buf));
1741 req = get_request_line(csp);
1744 mark_server_socket_tainted(csp);
1745 return JB_ERR_PARSE;
1747 assert(*req != '\0');
1749 if (client_protocol_is_unsupported(csp, req))
1751 return JB_ERR_PARSE;
1754 #ifdef FEATURE_FORCE_LOAD
1755 if (force_required(csp, req))
1757 csp->flags |= CSP_FLAG_FORCED;
1759 #endif /* def FEATURE_FORCE_LOAD */
1761 err = parse_http_request(req, http);
1763 if (JB_ERR_OK != err)
1765 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER),
1766 get_write_delay(csp));
1767 /* XXX: Use correct size */
1768 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1769 log_error(LOG_LEVEL_ERROR,
1770 "Couldn't parse request line received from %s: %s",
1771 csp->ip_addr_str, jb_err_to_string(err));
1773 free_http_request(http);
1774 return JB_ERR_PARSE;
1777 /* grab the rest of the client's headers */
1781 p = get_header(csp->client_iob);
1785 /* There are no additional headers to read. */
1792 * We didn't receive a complete header
1793 * line yet, get the rest of it.
1795 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1797 log_error(LOG_LEVEL_ERROR,
1798 "Stopped grabbing the client headers.");
1799 destroy_list(headers);
1800 return JB_ERR_PARSE;
1803 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1806 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1807 destroy_list(headers);
1808 return JB_ERR_PARSE;
1811 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1814 * If there is no memory left for buffering the
1815 * request, there is nothing we can do but hang up
1817 destroy_list(headers);
1818 return JB_ERR_MEMORY;
1823 if (!strncmpic(p, "Transfer-Encoding:", 18))
1826 * XXX: should be called through sed()
1827 * but currently can't.
1829 client_transfer_encoding(csp, &p);
1832 * We were able to read a complete
1833 * header and can finally enlist it.
1840 if (http->host == NULL)
1843 * If we still don't know the request destination,
1844 * the request is invalid or the client uses
1845 * Privoxy without its knowledge.
1847 if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
1850 * Our attempts to get the request destination
1851 * elsewhere failed or Privoxy is configured
1852 * to only accept proxy requests.
1854 * An error response has already been send
1855 * and we're done here.
1857 return JB_ERR_PARSE;
1861 #ifdef FEATURE_CLIENT_TAGS
1862 /* XXX: If the headers were enlisted sooner, passing csp would do. */
1863 set_client_address(csp, headers);
1864 get_tag_list_for_client(csp->client_tags, csp->client_address);
1868 * Determine the actions for this URL
1870 #ifdef FEATURE_TOGGLE
1871 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
1873 /* Most compatible set of actions (i.e. none) */
1874 init_current_action(csp->action);
1877 #endif /* ndef FEATURE_TOGGLE */
1879 get_url_actions(csp, http);
1882 enlist(csp->headers, http->cmd);
1884 /* Append the previously read headers */
1885 err = list_append_list_unique(csp->headers, headers);
1886 destroy_list(headers);
1893 /*********************************************************************
1895 * Function : parse_client_request
1897 * Description : Parses the client's request and decides what to do
1900 * Note that since we're not using select() we could get
1901 * blocked here if a client connected, then didn't say
1905 * 1 : csp = Current client state (buffers, headers, etc...)
1907 * Returns : JB_ERR_OK or JB_ERR_PARSE
1909 *********************************************************************/
1910 static jb_err parse_client_request(struct client_state *csp)
1912 struct http_request *http = csp->http;
1915 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1916 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
1917 && (!strcmpic(csp->http->version, "HTTP/1.1"))
1918 && (csp->http->ssl == 0))
1920 /* Assume persistence until further notice */
1921 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1924 if (csp->http->ssl == 0)
1927 * This whole block belongs to chat() but currently
1928 * has to be executed before sed().
1930 if (csp->flags & CSP_FLAG_CHUNKED_CLIENT_BODY)
1932 if (receive_chunked_client_request_body(csp) != JB_ERR_OK)
1934 return JB_ERR_PARSE;
1939 csp->expected_client_content_length = get_expected_content_length(csp->headers);
1941 verify_request_length(csp);
1945 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1947 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1949 err = sed(csp, FILTER_CLIENT_HEADERS);
1950 if (JB_ERR_OK != err)
1952 log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
1954 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
1955 csp->ip_addr_str, csp->http->cmd);
1956 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER), get_write_delay(csp));
1957 return JB_ERR_PARSE;
1959 csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
1961 /* Check request line for rewrites. */
1962 if ((NULL == csp->headers->first->str)
1963 || (strcmp(http->cmd, csp->headers->first->str) &&
1964 (JB_ERR_OK != change_request_destination(csp))))
1967 * A header filter broke the request line - bail out.
1969 write_socket_delayed(csp->cfd, MESSED_UP_REQUEST_RESPONSE,
1970 strlen(MESSED_UP_REQUEST_RESPONSE), get_write_delay(csp));
1971 /* XXX: Use correct size */
1972 log_error(LOG_LEVEL_CLF,
1973 "%s - - [%T] \"Invalid request generated\" 500 0", csp->ip_addr_str);
1974 log_error(LOG_LEVEL_ERROR,
1975 "Invalid request line after applying header filters.");
1976 free_http_request(http);
1978 return JB_ERR_PARSE;
1981 if (client_has_unsupported_expectations(csp))
1983 return JB_ERR_PARSE;
1991 /*********************************************************************
1993 * Function : send_http_request
1995 * Description : Sends the HTTP headers from the client request
1996 * and all the body data that has already been received.
1999 * 1 : csp = Current client state (buffers, headers, etc...)
2001 * Returns : 0 on success, anything else is an error.
2003 *********************************************************************/
2004 static int send_http_request(struct client_state *csp)
2009 hdr = list_to_text(csp->headers);
2012 /* FIXME Should handle error properly */
2013 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
2015 list_remove_all(csp->headers);
2018 * Write the client's (modified) header to the server
2019 * (along with anything else that may be in the buffer)
2021 write_failure = 0 != write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
2026 log_error(LOG_LEVEL_CONNECT, "Failed sending request headers to: %s: %E",
2027 csp->http->hostport);
2029 else if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
2030 && (flush_iob(csp->server_connection.sfd, csp->client_iob, 0) < 0))
2033 log_error(LOG_LEVEL_CONNECT, "Failed sending request body to: %s: %E",
2034 csp->http->hostport);
2037 return write_failure;
2042 #ifdef FEATURE_HTTPS_INSPECTION
2043 /*********************************************************************
2045 * Function : receive_and_send_encrypted_post_data
2047 * Description : Reads remaining POST data from the client and sends
2051 * 1 : csp = Current client state (buffers, headers, etc...)
2053 * Returns : 0 on success, anything else is an error.
2055 *********************************************************************/
2056 static int receive_and_send_encrypted_post_data(struct client_state *csp)
2058 int content_length_known = csp->expected_client_content_length != 0;
2060 while (is_ssl_pending(&(csp->mbedtls_client_attr.ssl))
2061 || (content_length_known && csp->expected_client_content_length != 0))
2063 unsigned char buf[BUFFER_SIZE];
2065 int max_bytes_to_read = sizeof(buf);
2067 if (content_length_known && csp->expected_client_content_length < sizeof(buf))
2069 max_bytes_to_read = (int)csp->expected_client_content_length;
2071 log_error(LOG_LEVEL_CONNECT,
2072 "Waiting for up to %d bytes of POST data from the client.",
2074 len = ssl_recv_data(&(csp->mbedtls_client_attr.ssl), buf,
2075 (unsigned)max_bytes_to_read);
2082 /* XXX: Does this actually happen? */
2085 log_error(LOG_LEVEL_CONNECT, "Forwarding %d bytes of encrypted POST data",
2087 len = ssl_send_data(&(csp->mbedtls_server_attr.ssl), buf, (size_t)len);
2092 if (csp->expected_client_content_length != 0)
2094 if (csp->expected_client_content_length >= len)
2096 csp->expected_client_content_length -= (unsigned)len;
2098 if (csp->expected_client_content_length == 0)
2100 log_error(LOG_LEVEL_CONNECT, "Forwarded the last %d bytes", len);
2106 log_error(LOG_LEVEL_CONNECT, "Done forwarding encrypted POST data");
2113 /*********************************************************************
2115 * Function : send_https_request
2117 * Description : Sends the HTTP headers from the client request
2118 * and all the body data that has already been received.
2121 * 1 : csp = Current client state (buffers, headers, etc...)
2123 * Returns : 0 on success, anything else is an error.
2125 *********************************************************************/
2126 static int send_https_request(struct client_state *csp)
2132 hdr = list_to_text(csp->https_headers);
2135 /* FIXME Should handle error properly */
2136 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
2138 list_remove_all(csp->https_headers);
2141 * Write the client's (modified) header to the server
2142 * (along with anything else that may be in the buffer)
2144 ret = ssl_send_data(&(csp->mbedtls_server_attr.ssl),
2145 (const unsigned char *)hdr, strlen(hdr));
2150 log_error(LOG_LEVEL_CONNECT,
2151 "Failed sending encrypted request headers to: %s: %E",
2152 csp->http->hostport);
2153 mark_server_socket_tainted(csp);
2157 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
2158 && ((flushed = ssl_flush_socket(&(csp->mbedtls_server_attr.ssl),
2159 csp->client_iob)) < 0))
2161 log_error(LOG_LEVEL_CONNECT, "Failed sending request body to: %s: %E",
2162 csp->http->hostport);
2167 if (csp->expected_client_content_length != 0)
2169 if (csp->expected_client_content_length < flushed)
2171 log_error(LOG_LEVEL_ERROR,
2172 "Flushed %d bytes of request body while only expecting %llu",
2173 flushed, csp->expected_client_content_length);
2174 csp->expected_client_content_length = 0;
2178 log_error(LOG_LEVEL_CONNECT,
2179 "Flushed %d bytes of request body while expecting %llu",
2180 flushed, csp->expected_client_content_length);
2181 csp->expected_client_content_length -= (unsigned)flushed;
2182 if (receive_and_send_encrypted_post_data(csp))
2190 log_error(LOG_LEVEL_CONNECT,
2191 "Flushed %d bytes of request body", flushed);
2195 log_error(LOG_LEVEL_CONNECT, "Encrypted request sent");
2202 /*********************************************************************
2204 * Function : receive_encrypted_request
2206 * Description : Receives an encrypted request.
2209 * 1 : csp = Current client state (buffers, headers, etc...)
2211 * Returns : JB_ERR_OK on success,
2212 * JB_ERR_PARSE or JB_ERR_MEMORY otherwise
2214 *********************************************************************/
2215 static jb_err receive_encrypted_request(struct client_state *csp)
2217 char buf[BUFFER_SIZE];
2223 log_error(LOG_LEVEL_HEADER, "Reading encrypted headers");
2224 if (!is_ssl_pending(&(csp->mbedtls_client_attr.ssl)) &&
2225 !data_is_available(csp->cfd, csp->config->socket_timeout))
2227 log_error(LOG_LEVEL_CONNECT,
2228 "Socket %d timed out while waiting for client headers", csp->cfd);
2229 return JB_ERR_PARSE;
2231 len = ssl_recv_data(&(csp->mbedtls_client_attr.ssl),
2232 (unsigned char *)buf, sizeof(buf));
2235 return JB_ERR_PARSE;
2237 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
2239 return JB_ERR_MEMORY;
2241 p = strstr(csp->client_iob->cur, "\r\n\r\n");
2242 } while (p == NULL);
2244 log_error(LOG_LEVEL_HEADER, "Encrypted headers received completely");
2250 /*********************************************************************
2252 * Function : process_encrypted_request
2254 * Description : Receives and parses an encrypted request.
2257 * 1 : csp = Current client state (buffers, headers, etc...)
2259 * Returns : JB_ERR_OK on success,
2260 * JB_ERR_PARSE or JB_ERR_MEMORY otherwise
2262 *********************************************************************/
2263 static jb_err process_encrypted_request(struct client_state *csp)
2268 /* Temporary copy of the client's headers before they get enlisted in csp->https_headers */
2269 struct list header_list;
2270 struct list *headers = &header_list;
2272 err = receive_encrypted_request(csp);
2273 if (err != JB_ERR_OK)
2275 /* XXX: Also used for JB_ERR_MEMORY */
2276 log_error(LOG_LEVEL_ERROR, "Failed to receive encrypted request: %s",
2277 jb_err_to_string(err));
2278 ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
2279 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2283 /* We don't need get_request_line() because the whole HTTP head is buffered. */
2284 request_line = get_header(csp->client_iob);
2285 if (request_line == NULL)
2287 log_error(LOG_LEVEL_ERROR, "Failed to get the encrypted request line");
2288 ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
2289 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2290 return JB_ERR_PARSE;
2292 assert(*request_line != '\0');
2294 if (client_protocol_is_unsupported(csp, request_line))
2297 * If the protocol is unsupported we're done here.
2298 * client_protocol_is_unsupported() took care of sending
2299 * the error response and logging the error message.
2301 return JB_ERR_PARSE;
2304 #ifdef FEATURE_FORCE_LOAD
2305 if (force_required(csp, request_line))
2307 csp->flags |= CSP_FLAG_FORCED;
2309 #endif /* def FEATURE_FORCE_LOAD */
2311 free_http_request(csp->http);
2313 err = parse_http_request(request_line, csp->http);
2314 /* XXX: Restore ssl setting. This is ugly */
2315 csp->http->client_ssl = 1;
2316 csp->http->server_ssl = 1;
2318 freez(request_line);
2319 if (JB_ERR_OK != err)
2321 ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
2322 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2323 /* XXX: Use correct size */
2324 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
2325 log_error(LOG_LEVEL_ERROR,
2326 "Couldn't parse request line received from %s: %s",
2327 csp->ip_addr_str, jb_err_to_string(err));
2329 free_http_request(csp->http);
2330 return JB_ERR_PARSE;
2333 /* Parse the rest of the client's headers. */
2337 p = get_header(csp->client_iob);
2341 /* There are no additional headers to read. */
2348 if (JB_ERR_OK != get_destination_from_https_headers(headers, csp->http))
2351 * Our attempts to get the request destination
2354 log_error(LOG_LEVEL_ERROR,
2355 "Failed to get the encrypted request destination");
2356 ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
2357 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2358 return JB_ERR_PARSE;
2361 /* Split the domain we just got for pattern matching */
2362 init_domain_components(csp->http);
2364 #ifdef FEATURE_TOGGLE
2365 if ((csp->flags & CSP_FLAG_TOGGLED_ON) != 0)
2368 /* Determine the actions for this URL */
2369 get_url_actions(csp, csp->http);
2372 enlist(csp->https_headers, csp->http->cmd);
2374 /* Append the previously read headers */
2375 err = list_append_list_unique(csp->https_headers, headers);
2376 destroy_list(headers);
2377 if (JB_ERR_OK != err)
2379 /* XXX: Send error message */
2383 /* XXX: Work around crash */
2384 csp->error_message = NULL;
2386 /* XXX: Why do this here? */
2389 err = sed_https(csp);
2390 if (JB_ERR_OK != err)
2392 ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
2393 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2394 log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
2396 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
2397 csp->ip_addr_str, csp->http->cmd);
2398 return JB_ERR_PARSE;
2401 log_error(LOG_LEVEL_HEADER, "Encrypted request processed");
2402 log_applied_actions(csp->action);
2403 log_error(LOG_LEVEL_REQUEST, "https://%s%s", csp->http->hostport,
2410 /*********************************************************************
2412 * Function : cgi_page_requested
2414 * Description : Checks if a request is for an internal CGI page.
2417 * 1 : host = The host requested by the client.
2419 * Returns : 1 if a CGI page has been requested, 0 otherwise
2421 *********************************************************************/
2422 static int cgi_page_requested(const char *host)
2424 if ((0 == strcmpic(host, CGI_SITE_1_HOST))
2425 || (0 == strcmpic(host, CGI_SITE_1_HOST "."))
2426 || (0 == strcmpic(host, CGI_SITE_2_HOST))
2427 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")))
2439 /*********************************************************************
2441 * Function : handle_established_connection
2443 * Description : Shuffle data between client and server once the
2444 * connection has been established.
2447 * 1 : csp = Current client state (buffers, headers, etc...)
2449 * Returns : Nothing.
2451 *********************************************************************/
2452 static void handle_established_connection(struct client_state *csp)
2458 struct pollfd poll_fds[2];
2462 struct timeval timeout;
2465 int ms_iis5_hack = 0;
2466 unsigned long long byte_count = 0;
2467 struct http_request *http;
2468 long len = 0; /* for buffer sizes (and negative error codes) */
2469 int buffer_and_filter_content = 0;
2470 unsigned int write_delay;
2471 #ifdef FEATURE_HTTPS_INSPECTION
2473 int use_ssl_tunnel = 0;
2474 csp->dont_verify_certificate = 0;
2476 if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION))
2478 /* Pass encrypted content without filtering. */
2483 /* Skeleton for HTTP response, if we should intercept the request */
2484 struct http_response *rsp;
2485 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2486 int watch_client_socket;
2489 csp->receive_buffer_size = csp->config->receive_buffer_size;
2490 csp->receive_buffer = zalloc(csp->receive_buffer_size + 1);
2491 if (csp->receive_buffer == NULL)
2493 log_error(LOG_LEVEL_ERROR,
2494 "Out of memory. Failed to allocate the receive buffer.");
2495 rsp = cgi_error_memory();
2496 send_crunch_response(csp, rsp);
2503 maxfd = (csp->cfd > csp->server_connection.sfd) ?
2504 csp->cfd : csp->server_connection.sfd;
2507 /* pass data between the client and server
2508 * until one or the other shuts down the connection.
2513 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2514 watch_client_socket = 0 == (csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING);
2516 write_delay = get_write_delay(csp);
2523 * FD_ZERO here seems to point to an errant macro which crashes.
2524 * So do this by hand for now...
2526 memset(&rfds,0x00,sizeof(fd_set));
2530 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2531 if (!watch_client_socket)
2533 maxfd = csp->server_connection.sfd;
2536 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2538 FD_SET(csp->cfd, &rfds);
2541 FD_SET(csp->server_connection.sfd, &rfds);
2542 #endif /* ndef HAVE_POLL */
2544 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2545 if ((csp->flags & CSP_FLAG_CHUNKED)
2546 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2547 && ((csp->iob->eod - csp->iob->cur) >= 5)
2548 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
2551 * XXX: This check should be obsolete now,
2552 * but let's wait a while to be sure.
2554 log_error(LOG_LEVEL_CONNECT,
2555 "Looks like we got the last chunk together with "
2556 "the server headers but didn't detect it earlier. "
2557 "We better stop reading.");
2558 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2559 csp->expected_content_length = byte_count;
2560 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2562 if (server_body && server_response_is_complete(csp, byte_count))
2564 if (csp->expected_content_length == byte_count)
2566 log_error(LOG_LEVEL_CONNECT,
2567 "Done reading from server. Content length: %llu as expected. "
2568 "Bytes most recently read: %d.",
2573 log_error(LOG_LEVEL_CONNECT,
2574 "Done reading from server. Expected content length: %llu. "
2575 "Actual content length: %llu. Bytes most recently read: %d.",
2576 csp->expected_content_length, byte_count, len);
2580 * XXX: Should not jump around, handle_established_connection()
2581 * is complicated enough already.
2585 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2588 poll_fds[0].fd = csp->cfd;
2589 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2590 if (!watch_client_socket)
2593 * Ignore incoming data, but still watch out
2594 * for disconnects etc. These flags are always
2595 * implied anyway but explicitly setting them
2598 poll_fds[0].events = POLLERR|POLLHUP;
2603 poll_fds[0].events = POLLIN;
2605 poll_fds[1].fd = csp->server_connection.sfd;
2606 poll_fds[1].events = POLLIN;
2607 n = poll(poll_fds, 2, csp->config->socket_timeout * 1000);
2609 timeout.tv_sec = csp->config->socket_timeout;
2610 timeout.tv_usec = 0;
2611 n = select((int)maxfd + 1, &rfds, NULL, NULL, &timeout);
2612 #endif /* def HAVE_POLL */
2614 /*server or client not responding in timeout */
2617 log_error(LOG_LEVEL_CONNECT, "Socket timeout %d reached: %s",
2618 csp->config->socket_timeout, http->url);
2619 if ((byte_count == 0) && (http->ssl == 0))
2621 send_crunch_response(csp, error_response(csp, "connection-timeout"));
2623 mark_server_socket_tainted(csp);
2624 #ifdef FEATURE_HTTPS_INSPECTION
2625 close_client_and_server_ssl_connections(csp);
2632 log_error(LOG_LEVEL_ERROR, "poll() failed!: %E");
2634 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
2636 mark_server_socket_tainted(csp);
2637 #ifdef FEATURE_HTTPS_INSPECTION
2638 close_client_and_server_ssl_connections(csp);
2644 * This is the body of the browser's request,
2645 * just read and write it.
2647 * Receives data from browser and sends it to server
2649 * XXX: Make sure the client doesn't use pipelining
2650 * behind Privoxy's back.
2653 if ((poll_fds[0].revents & (POLLERR|POLLHUP|POLLNVAL)) != 0)
2655 log_error(LOG_LEVEL_CONNECT,
2656 "The client socket %d has become unusable while "
2657 "the server socket %d is still open.",
2658 csp->cfd, csp->server_connection.sfd);
2659 mark_server_socket_tainted(csp);
2663 if (poll_fds[0].revents != 0)
2665 if (FD_ISSET(csp->cfd, &rfds))
2666 #endif /* def HAVE_POLL*/
2668 int max_bytes_to_read = (int)csp->receive_buffer_size;
2670 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2671 if ((csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ))
2673 if (data_is_available(csp->cfd, 0))
2676 * If the next request is already waiting, we have
2677 * to stop select()ing the client socket. Otherwise
2678 * we would always return right away and get nothing
2681 watch_client_socket = 0;
2682 log_error(LOG_LEVEL_CONNECT,
2683 "Stop watching client socket %d. "
2684 "There's already another request waiting.",
2689 * If the client socket is set, but there's no data
2690 * available on the socket, the client went fishing
2691 * and continuing talking to the server makes no sense.
2693 log_error(LOG_LEVEL_CONNECT,
2694 "The client closed socket %d while "
2695 "the server socket %d is still open.",
2696 csp->cfd, csp->server_connection.sfd);
2697 mark_server_socket_tainted(csp);
2700 if (csp->expected_client_content_length != 0)
2702 if (csp->expected_client_content_length < csp->receive_buffer_size)
2704 max_bytes_to_read = (int)csp->expected_client_content_length;
2706 log_error(LOG_LEVEL_CONNECT,
2707 "Waiting for up to %d bytes from the client.",
2710 assert(max_bytes_to_read <= csp->receive_buffer_size);
2711 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2713 #ifdef FEATURE_HTTPS_INSPECTION
2714 if (client_use_ssl(csp))
2716 log_error(LOG_LEVEL_CONNECT, "Breaking with TLS/SSL.");
2720 #endif /* def FEATURE_HTTPS_INSPECTION */
2722 len = read_socket(csp->cfd, csp->receive_buffer, max_bytes_to_read);
2726 /* XXX: not sure if this is necessary. */
2727 mark_server_socket_tainted(csp);
2728 break; /* "game over, man" */
2731 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2732 if (csp->expected_client_content_length != 0)
2734 assert(len <= max_bytes_to_read);
2735 csp->expected_client_content_length -= (unsigned)len;
2736 log_error(LOG_LEVEL_CONNECT,
2737 "Expected client content length set to %llu "
2738 "after reading %d bytes.",
2739 csp->expected_client_content_length, len);
2740 if (csp->expected_client_content_length == 0)
2742 log_error(LOG_LEVEL_CONNECT,
2743 "Done reading from the client.");
2744 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
2747 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2749 if (write_socket(csp->server_connection.sfd, csp->receive_buffer, (size_t)len))
2751 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
2752 mark_server_socket_tainted(csp);
2760 * The server wants to talk. It could be the header or the body.
2761 * If `hdr' is null, then it's the header otherwise it's the body.
2762 * FIXME: Does `hdr' really mean `host'? No.
2765 if (poll_fds[1].revents != 0)
2767 if (FD_ISSET(csp->server_connection.sfd, &rfds))
2768 #endif /* HAVE_POLL */
2770 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2772 * If we are buffering content, we don't want to eat up to
2773 * buffer-limit bytes if the client no longer cares about them.
2774 * If we aren't buffering, however, a dead client socket will be
2775 * noticed pretty much right away anyway, so we can reduce the
2776 * overhead by skipping the check.
2778 if (buffer_and_filter_content && !socket_is_still_alive(csp->cfd))
2781 log_error(LOG_LEVEL_CONNECT,
2782 "The server still wants to talk, but the client may already have hung up on us.");
2784 log_error(LOG_LEVEL_CONNECT,
2785 "The server still wants to talk, but the client hung up on us.");
2786 mark_server_socket_tainted(csp);
2787 #ifdef FEATURE_HTTPS_INSPECTION
2788 close_client_and_server_ssl_connections(csp);
2791 #endif /* def _WIN32 */
2793 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2795 #ifdef FEATURE_HTTPS_INSPECTION
2797 * Reading data from standard or secured connection (HTTP/HTTPS)
2799 if (server_use_ssl(csp))
2801 len = ssl_recv_data(&(csp->mbedtls_server_attr.ssl),
2802 (unsigned char *)csp->receive_buffer, csp->receive_buffer_size);
2807 len = read_socket(csp->server_connection.sfd, csp->receive_buffer,
2808 (int)csp->receive_buffer_size);
2813 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
2815 if ((http->ssl && (csp->fwd == NULL))
2816 #ifdef FEATURE_HTTPS_INSPECTION
2822 * Just hang up. We already confirmed the client's CONNECT
2823 * request with status code 200 and unencrypted content is
2824 * no longer welcome.
2826 log_error(LOG_LEVEL_ERROR,
2827 "CONNECT already confirmed. Unable to tell the client about the problem.");
2830 else if (byte_count)
2833 * Just hang up. We already transmitted the original headers
2834 * and parts of the original content and therefore missed the
2835 * chance to send an error message (without risking data corruption).
2837 * XXX: we could retry with a fancy range request here.
2839 log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
2840 "Unable to tell the client about the problem.");
2841 mark_server_socket_tainted(csp);
2842 #ifdef FEATURE_HTTPS_INSPECTION
2843 close_client_and_server_ssl_connections(csp);
2848 * XXX: Consider handling the cases above the same.
2850 mark_server_socket_tainted(csp);
2854 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2855 if (csp->flags & CSP_FLAG_CHUNKED)
2857 if ((len >= 5) && !memcmp(csp->receive_buffer+len-5, "0\r\n\r\n", 5))
2859 /* XXX: this is a temporary hack */
2860 log_error(LOG_LEVEL_CONNECT,
2861 "Looks like we reached the end of the last chunk. "
2862 "We better stop reading.");
2863 csp->expected_content_length = byte_count + (unsigned long long)len;
2864 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2868 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2871 * This is guaranteed by allocating with zalloc_or_die()
2872 * and never (intentionally) writing to the last byte.
2874 * csp->receive_buffer_size is the size of the part of the
2875 * buffer we intentionally write to, but we actually
2876 * allocated csp->receive_buffer_size+1 bytes so the assertion
2877 * stays within the allocated range.
2879 assert(csp->receive_buffer[csp->receive_buffer_size] == '\0');
2882 * Add a trailing zero to let be able to use string operations.
2883 * XXX: do we still need this with filter_popups gone?
2885 assert(len <= csp->receive_buffer_size);
2886 csp->receive_buffer[len] = '\0';
2889 * Normally, this would indicate that we've read
2890 * as much as the server has sent us and we can
2891 * close the client connection. However, Microsoft
2892 * in its wisdom has released IIS/5 with a bug that
2893 * prevents it from sending the trailing \r\n in
2894 * a 302 redirect header (and possibly other headers).
2895 * To work around this if we've haven't parsed
2896 * a full header we'll append a trailing \r\n
2897 * and see if this now generates a valid one.
2899 * This hack shouldn't have any impacts. If we've
2900 * already transmitted the header or if this is a
2901 * SSL connection, then we won't bother with this
2902 * hack. So we only work on partially received
2903 * headers. If we append a \r\n and this still
2904 * doesn't generate a valid header, then we won't
2905 * transmit anything to the client.
2910 if (server_body || (http->ssl
2911 #ifdef FEATURE_HTTPS_INSPECTION
2917 * If we have been buffering up the document,
2918 * now is the time to apply content modification
2919 * and send the result to the client.
2921 if (buffer_and_filter_content)
2923 p = execute_content_filters(csp);
2925 * If content filtering fails, use the original
2926 * buffer and length.
2927 * (see p != NULL ? p : csp->iob->cur below)
2931 csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
2933 #ifdef FEATURE_COMPRESSION
2934 else if ((csp->flags & CSP_FLAG_CLIENT_SUPPORTS_DEFLATE)
2935 && (csp->content_length > LOWER_LENGTH_LIMIT_FOR_COMPRESSION))
2937 char *compressed_content = compress_buffer(p,
2938 (size_t *)&csp->content_length, csp->config->compression_level);
2939 if (compressed_content != NULL)
2942 p = compressed_content;
2943 csp->flags |= CSP_FLAG_BUFFERED_CONTENT_DEFLATED;
2948 if (JB_ERR_OK != update_server_headers(csp))
2950 log_error(LOG_LEVEL_FATAL,
2951 "Failed to update server headers. after filtering.");
2954 hdr = list_to_text(csp->headers);
2957 /* FIXME Should handle error properly */
2958 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2961 #ifdef FEATURE_HTTPS_INSPECTION
2963 * Sending data with standard or secured connection (HTTP/HTTPS)
2965 if (client_use_ssl(csp))
2967 if ((ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
2968 (const unsigned char *)hdr, strlen(hdr),
2969 get_write_delay(csp)) < 0)
2970 || (ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
2971 (const unsigned char *) ((p != NULL) ? p : csp->iob->cur),
2972 csp->content_length, get_write_delay(csp)) < 0))
2974 log_error(LOG_LEVEL_ERROR, "write modified content to "
2975 "client over TLS/SSL failed");
2978 mark_server_socket_tainted(csp);
2979 close_client_and_server_ssl_connections(csp);
2984 #endif /* def FEATURE_HTTPS_INSPECTION */
2986 if (write_socket_delayed(csp->cfd, hdr, strlen(hdr), write_delay)
2987 || write_socket_delayed(csp->cfd, ((p != NULL) ? p : csp->iob->cur),
2988 (size_t)csp->content_length, write_delay))
2990 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
2993 mark_server_socket_tainted(csp);
3002 break; /* "game over, man" */
3006 * This is NOT the body, so
3007 * Let's pretend the server just sent us a blank line.
3009 snprintf(csp->receive_buffer, csp->receive_buffer_size, "\r\n");
3010 len = (int)strlen(csp->receive_buffer);
3013 * Now, let the normal header parsing algorithm below do its
3014 * job. If it fails, we'll exit instead of continuing.
3021 * If we're in the body of the server document, just write it to
3022 * the client, unless we need to buffer the body for later
3023 * content-filtering.
3025 if (server_body || (http->ssl
3026 #ifdef FEATURE_HTTPS_INSPECTION
3031 if (buffer_and_filter_content)
3034 * If there is no memory left for buffering the content, or the buffer limit
3035 * has been reached, switch to non-filtering mode, i.e. make & write the
3036 * header, flush the iob and buf, and get out of the way.
3038 if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3043 log_error(LOG_LEVEL_INFO,
3044 "Flushing header and buffers. Stepping back from filtering.");
3046 hdr = list_to_text(csp->headers);
3050 * Memory is too tight to even generate the header.
3051 * Send our static "Out-of-memory" page.
3053 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
3054 rsp = cgi_error_memory();
3055 send_crunch_response(csp, rsp);
3056 mark_server_socket_tainted(csp);
3057 #ifdef FEATURE_HTTPS_INSPECTION
3058 close_client_and_server_ssl_connections(csp);
3062 hdrlen = strlen(hdr);
3064 #ifdef FEATURE_HTTPS_INSPECTION
3066 * Sending data with standard or secured connection (HTTP/HTTPS)
3068 if (client_use_ssl(csp))
3070 if ((ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
3071 (const unsigned char *)hdr, hdrlen, get_write_delay(csp)) < 0)
3072 || ((flushed = ssl_flush_socket(&(csp->mbedtls_client_attr.ssl),
3074 || (ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
3075 (const unsigned char *)csp->receive_buffer, (size_t)len,
3076 get_write_delay(csp)) < 0))
3078 log_error(LOG_LEVEL_CONNECT,
3079 "Flush header and buffers to client failed");
3081 mark_server_socket_tainted(csp);
3082 close_client_and_server_ssl_connections(csp);
3087 #endif /* def FEATURE_HTTPS_INSPECTION */
3089 if (write_socket_delayed(csp->cfd, hdr, hdrlen, write_delay)
3090 || ((flushed = flush_iob(csp->cfd, csp->iob, write_delay)) < 0)
3091 || write_socket_delayed(csp->cfd, csp->receive_buffer, (size_t)len,
3094 log_error(LOG_LEVEL_CONNECT,
3095 "Flush header and buffers to client failed: %E");
3097 mark_server_socket_tainted(csp);
3103 * Reset the byte_count to the amount of bytes
3104 * we just flushed. len will be added a few lines below,
3105 * hdrlen doesn't matter for LOG_LEVEL_CLF.
3107 byte_count = (unsigned long long)flushed;
3109 buffer_and_filter_content = 0;
3115 #ifdef FEATURE_HTTPS_INSPECTION
3117 * Sending data with standard or secured connection (HTTP/HTTPS)
3119 if (client_use_ssl(csp))
3121 ret = ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
3122 (const unsigned char *)csp->receive_buffer, (size_t)len,
3123 get_write_delay(csp));
3126 log_error(LOG_LEVEL_ERROR,
3127 "Sending data to client failed");
3128 mark_server_socket_tainted(csp);
3129 close_client_and_server_ssl_connections(csp);
3134 #endif /* def FEATURE_HTTPS_INSPECTION */
3136 if (write_socket_delayed(csp->cfd, csp->receive_buffer,
3137 (size_t)len, write_delay))
3139 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
3140 mark_server_socket_tainted(csp);
3145 byte_count += (unsigned long long)len;
3151 * We're still looking for the end of the server's header.
3152 * Buffer up the data we just read. If that fails, there's
3153 * little we can do but send our static out-of-memory page.
3155 if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3157 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
3158 rsp = cgi_error_memory();
3159 send_crunch_response(csp, rsp);
3160 mark_server_socket_tainted(csp);
3161 #ifdef FEATURE_HTTPS_INSPECTION
3162 close_client_and_server_ssl_connections(csp);
3167 /* Convert iob into something sed() can digest */
3168 if (JB_ERR_PARSE == get_server_headers(csp))
3173 * Well, we tried our MS IIS/5 hack and it didn't work.
3174 * The header is incomplete and there isn't anything
3175 * we can do about it.
3177 log_error(LOG_LEVEL_ERROR, "Invalid server headers. "
3178 "Applying the MS IIS5 hack didn't help.");
3179 log_error(LOG_LEVEL_CLF,
3180 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3181 #ifdef FEATURE_HTTPS_INSPECTION
3183 * Sending data with standard or secured connection (HTTP/HTTPS)
3185 if (client_use_ssl(csp))
3187 ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
3188 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3189 strlen(INVALID_SERVER_HEADERS_RESPONSE), get_write_delay(csp));
3192 #endif /* def FEATURE_HTTPS_INSPECTION */
3194 write_socket_delayed(csp->cfd,
3195 INVALID_SERVER_HEADERS_RESPONSE,
3196 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3198 mark_server_socket_tainted(csp);
3199 #ifdef FEATURE_HTTPS_INSPECTION
3200 close_client_and_server_ssl_connections(csp);
3207 * Since we have to wait for more from the server before
3208 * we can parse the headers we just continue here.
3210 log_error(LOG_LEVEL_CONNECT,
3211 "Continuing buffering server headers from socket %d. "
3212 "Bytes most recently read: %d.", csp->cfd, len);
3219 * Account for the content bytes we
3220 * might have gotten with the headers.
3222 assert(csp->iob->eod >= csp->iob->cur);
3223 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3226 /* Did we actually get anything? */
3227 if (NULL == csp->headers->first)
3229 if ((csp->flags & CSP_FLAG_REUSED_CLIENT_CONNECTION))
3231 log_error(LOG_LEVEL_ERROR,
3232 "No server or forwarder response received on socket %d. "
3233 "Closing client socket %d without sending data.",
3234 csp->server_connection.sfd, csp->cfd);
3235 log_error(LOG_LEVEL_CLF,
3236 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3240 log_error(LOG_LEVEL_ERROR,
3241 "No server or forwarder response received on socket %d.",
3242 csp->server_connection.sfd);
3243 send_crunch_response(csp, error_response(csp, "no-server-data"));
3245 free_http_request(http);
3246 mark_server_socket_tainted(csp);
3247 #ifdef FEATURE_HTTPS_INSPECTION
3248 close_client_and_server_ssl_connections(csp);
3253 if (!csp->headers->first->str)
3255 log_error(LOG_LEVEL_ERROR, "header search: csp->headers->first->str == NULL, assert will be called");
3257 assert(csp->headers->first->str);
3259 if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
3260 strncmpic(csp->headers->first->str, "ICY", 3))
3263 * It doesn't look like a HTTP (or Shoutcast) response:
3264 * tell the client and log the problem.
3266 if (strlen(csp->headers->first->str) > 30)
3268 csp->headers->first->str[30] = '\0';
3270 log_error(LOG_LEVEL_ERROR,
3271 "Invalid server or forwarder response. Starts with: %s",
3272 csp->headers->first->str);
3273 log_error(LOG_LEVEL_CLF,
3274 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3275 #ifdef FEATURE_HTTPS_INSPECTION
3277 * Sending data with standard or secured connection (HTTP/HTTPS)
3279 if (client_use_ssl(csp))
3281 ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
3282 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3283 strlen(INVALID_SERVER_HEADERS_RESPONSE),
3284 get_write_delay(csp));
3287 #endif /* def FEATURE_HTTPS_INSPECTION */
3289 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3290 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3292 free_http_request(http);
3293 mark_server_socket_tainted(csp);
3294 #ifdef FEATURE_HTTPS_INSPECTION
3295 close_client_and_server_ssl_connections(csp);
3301 * We have now received the entire server header,
3302 * filter it and send the result to the client
3304 if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
3306 log_error(LOG_LEVEL_CLF,
3307 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3308 #ifdef FEATURE_HTTPS_INSPECTION
3310 * Sending data with standard or secured connection (HTTP/HTTPS)
3312 if (client_use_ssl(csp))
3314 ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
3315 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3316 strlen(INVALID_SERVER_HEADERS_RESPONSE),
3317 get_write_delay(csp));
3322 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3323 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3325 free_http_request(http);
3326 mark_server_socket_tainted(csp);
3327 #ifdef FEATURE_HTTPS_INSPECTION
3328 close_client_and_server_ssl_connections(csp);
3332 hdr = list_to_text(csp->headers);
3335 /* FIXME Should handle error properly */
3336 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
3339 if ((csp->flags & CSP_FLAG_CHUNKED)
3340 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3341 && ((csp->iob->eod - csp->iob->cur) >= 5)
3342 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
3344 log_error(LOG_LEVEL_CONNECT,
3345 "Looks like we got the last chunk together with "
3346 "the server headers. We better stop reading.");
3347 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3348 csp->expected_content_length = byte_count;
3349 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
3352 csp->server_connection.response_received = time(NULL);
3354 if (crunch_response_triggered(csp, crunchers_light))
3357 * One of the tags created by a server-header
3358 * tagger triggered a crunch. We already
3359 * delivered the crunch response to the client
3360 * and are done here after cleaning up.
3363 mark_server_socket_tainted(csp);
3364 #ifdef FEATURE_HTTPS_INSPECTION
3365 close_client_and_server_ssl_connections(csp);
3370 /* Buffer and pcrs filter this if appropriate. */
3371 buffer_and_filter_content = content_requires_filtering(csp);
3373 if (!buffer_and_filter_content)
3376 * Write the server's (modified) header to
3377 * the client (along with anything else that
3378 * may be in the buffer). Use standard or secured
3381 #ifdef FEATURE_HTTPS_INSPECTION
3382 if (client_use_ssl(csp))
3384 if ((ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
3385 (const unsigned char *)hdr, strlen(hdr),
3386 get_write_delay(csp)) < 0)
3387 || (len = ssl_flush_socket(&(csp->mbedtls_client_attr.ssl),
3390 log_error(LOG_LEVEL_CONNECT, "Write header to client failed");
3393 * The write failed, so don't bother mentioning it
3394 * to the client... it probably can't hear us anyway.
3397 mark_server_socket_tainted(csp);
3398 #ifdef FEATURE_HTTPS_INSPECTION
3399 close_client_and_server_ssl_connections(csp);
3405 #endif /* def FEATURE_HTTPS_INSPECTION */
3407 if (write_socket_delayed(csp->cfd, hdr, strlen(hdr), write_delay)
3408 || ((len = flush_iob(csp->cfd, csp->iob, write_delay)) < 0))
3410 log_error(LOG_LEVEL_ERROR,
3411 "write header to client failed");
3413 * The write failed, so don't bother mentioning it
3414 * to the client... it probably can't hear us anyway.
3417 mark_server_socket_tainted(csp);
3423 /* we're finished with the server's header */
3429 * If this was a MS IIS/5 hack then it means the server
3430 * has already closed the connection. Nothing more to read.
3435 log_error(LOG_LEVEL_ERROR,
3436 "Closed server connection detected. "
3437 "Applying the MS IIS5 hack didn't help.");
3438 log_error(LOG_LEVEL_CLF,
3439 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3440 #ifdef FEATURE_HTTPS_INSPECTION
3442 * Sending data with standard or secured connection (HTTP/HTTPS)
3444 if (client_use_ssl(csp))
3446 ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
3447 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3448 strlen(INVALID_SERVER_HEADERS_RESPONSE),
3449 get_write_delay(csp));
3452 #endif /* def FEATURE_HTTPS_INSPECTION */
3454 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3455 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3457 mark_server_socket_tainted(csp);
3458 #ifdef FEATURE_HTTPS_INSPECTION
3459 close_client_and_server_ssl_connections(csp);
3466 mark_server_socket_tainted(csp);
3467 #ifdef FEATURE_HTTPS_INSPECTION
3468 close_client_and_server_ssl_connections(csp);
3470 return; /* huh? we should never get here */
3472 #ifdef FEATURE_HTTPS_INSPECTION
3473 close_client_and_server_ssl_connections(csp);
3475 if (csp->content_length == 0)
3478 * If Privoxy didn't recalculate the Content-Length,
3479 * byte_count is still correct.
3481 csp->content_length = byte_count;
3484 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3485 if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3486 && (csp->expected_content_length != byte_count))
3488 log_error(LOG_LEVEL_CONNECT,
3489 "Received %llu bytes while expecting %llu.",
3490 byte_count, csp->expected_content_length);
3491 mark_server_socket_tainted(csp);
3495 #ifdef FEATURE_HTTPS_INSPECTION
3496 if (client_use_ssl(csp))
3498 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s https://%s%s %s\" 200 %llu",
3499 csp->ip_addr_str, http->gpc, http->hostport, http->path,
3500 http->version, csp->content_length);
3505 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %llu",
3506 csp->ip_addr_str, http->ocmd, csp->content_length);
3508 csp->server_connection.timestamp = time(NULL);
3512 /*********************************************************************
3516 * Description : Once a connection from the client has been accepted,
3517 * this function is called (via serve()) to handle the
3518 * main business of the communication. This function
3519 * returns after dealing with a single request. It can
3520 * be called multiple times with the same client socket
3521 * if the client is keeping the connection alive.
3523 * The decision whether or not a client connection will
3524 * be kept alive is up to the caller which also must
3525 * close the client socket when done.
3527 * FIXME: chat is nearly thousand lines long.
3531 * 1 : csp = Current client state (buffers, headers, etc...)
3533 * Returns : Nothing.
3535 *********************************************************************/
3536 static void chat(struct client_state *csp)
3538 const struct forward_spec *fwd;
3539 struct http_request *http;
3540 /* Skeleton for HTTP response, if we should intercept the request */
3541 struct http_response *rsp;
3542 #ifdef FEATURE_HTTPS_INSPECTION
3543 int use_ssl_tunnel = 0;
3548 if (receive_client_request(csp) != JB_ERR_OK)
3552 if (parse_client_request(csp) != JB_ERR_OK)
3557 /* decide how to route the HTTP request */
3558 fwd = forward_url(csp, http);
3561 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!? This can't happen!");
3562 /* Never get here - LOG_LEVEL_FATAL causes program exit */
3566 #ifdef FEATURE_HTTPS_INSPECTION
3568 * Setting flags to use old solution with SSL tunnel and to disable
3569 * certificate verification.
3571 if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION)
3572 && !cgi_page_requested(csp->http->host))
3577 if (http->ssl && csp->action->flags & ACTION_IGNORE_CERTIFICATE_ERRORS)
3579 csp->dont_verify_certificate = 1;
3584 * build the http request to send to the server
3585 * we have to do one of the following:
3587 * create = use the original HTTP request to create a new
3588 * HTTP request that has either the path component
3589 * without the http://domainspec (w/path) or the
3590 * full orininal URL (w/url)
3591 * Note that the path and/or the HTTP version may
3592 * have been altered by now.
3594 * SSL proxy = Open a socket to the host:port of the server
3595 * and create TLS/SSL connection with server and
3596 * with client. Then behave like mediator between
3597 * client and server over TLS/SSL.
3599 * SSL proxy = Pass the request unchanged if forwarding a CONNECT
3600 * with request to a parent proxy. Note that we'll be sending
3601 * forwarding the CFAIL message ourselves if connecting to the parent
3602 * fails, but we won't send a CSUCCEED message if it works,
3603 * since that would result in a double message (ours and the
3604 * parent's). After sending the request to the parent, we
3605 * must parse answer and send it to client. If connection
3606 * with server is established, we do TLS/SSL proxy. Otherwise
3607 * we send parent response to client and close connections.
3609 * here's the matrix:
3612 * +--------+--------+
3614 * 0 | create | SSL |
3615 * | w/path | proxy |
3616 * Forwarding +--------+--------+
3618 * 1 | create | proxy |
3619 * | w/url |+forward|
3620 * +--------+--------+
3624 #ifdef FEATURE_HTTPS_INSPECTION
3626 * Presetting SSL client and server flags
3628 if (http->ssl && !use_ssl_tunnel)
3630 http->client_ssl = 1;
3631 http->server_ssl = 1;
3635 http->client_ssl = 0;
3636 http->server_ssl = 0;
3640 #ifdef FEATURE_HTTPS_INSPECTION
3642 * Log the request unless we're https inspecting
3643 * in which case we don't have the path yet and
3644 * will log the request later.
3646 if (!client_use_ssl(csp))
3649 log_error(LOG_LEVEL_REQUEST, "%s%s", http->hostport, http->path);
3652 if (http->ssl && connect_port_is_forbidden(csp))
3654 const char *acceptable_connect_ports =
3655 csp->action->string[ACTION_STRING_LIMIT_CONNECT];
3656 assert(NULL != acceptable_connect_ports);
3657 log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
3658 "limit-connect{%s} doesn't allow CONNECT requests to %s",
3659 csp->ip_addr_str, acceptable_connect_ports, csp->http->hostport);
3660 csp->action->flags |= ACTION_BLOCK;
3662 #ifdef FEATURE_HTTPS_INSPECTION
3663 http->client_ssl = 0;
3664 http->server_ssl = 0;
3669 freez(csp->headers->first->str);
3670 build_request_line(csp, fwd, &csp->headers->first->str);
3673 * We have a request. Check if one of the crunchers wants it
3674 * unless the client wants to use TLS/SSL in which case we
3675 * haven't setup the TLS context yet and will send the crunch
3679 #ifdef FEATURE_HTTPS_INSPECTION
3680 !client_use_ssl(csp) &&
3682 crunch_response_triggered(csp, crunchers_all))
3685 * Yes. The client got the crunch response and we're done here.
3690 log_applied_actions(csp->action);
3691 if (fwd->forward_host)
3693 log_error(LOG_LEVEL_CONNECT, "via [%s]:%d to: %s",
3694 fwd->forward_host, fwd->forward_port, http->hostport);
3698 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
3701 /* here we connect to the server, gateway, or the forwarder */
3703 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3704 if ((csp->server_connection.sfd != JB_INVALID_SOCKET)
3705 && socket_is_still_alive(csp->server_connection.sfd)
3706 && connection_destination_matches(&csp->server_connection, http, fwd))
3708 log_error(LOG_LEVEL_CONNECT,
3709 "Reusing server socket %d connected to %s. Total requests: %u.",
3710 csp->server_connection.sfd, csp->server_connection.host,
3711 csp->server_connection.requests_sent_total);
3715 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
3717 #ifdef FEATURE_CONNECTION_SHARING
3718 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
3720 remember_connection(&csp->server_connection);
3723 #endif /* def FEATURE_CONNECTION_SHARING */
3725 log_error(LOG_LEVEL_CONNECT,
3726 "Closing server socket %d connected to %s. Total requests: %u.",
3727 csp->server_connection.sfd, csp->server_connection.host,
3728 csp->server_connection.requests_sent_total);
3729 close_socket(csp->server_connection.sfd);
3731 mark_connection_closed(&csp->server_connection);
3733 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3734 #ifdef FEATURE_HTTPS_INSPECTION
3735 if (http->ssl && !use_ssl_tunnel)
3739 * Creating a SSL proxy.
3741 * By sending the CSUCCEED message we're lying to the client as
3742 * the connection hasn't actually been established yet. We don't
3743 * establish the connection until we have seen and parsed the
3744 * encrypted client headers.
3746 if (write_socket_delayed(csp->cfd, CSUCCEED,
3747 strlen(CSUCCEED), get_write_delay(csp)) != 0)
3749 log_error(LOG_LEVEL_ERROR, "Sending SUCCEED to client failed");
3753 ret = create_client_ssl_connection(csp);
3756 log_error(LOG_LEVEL_ERROR,
3757 "Failed to open a secure connection with the client");
3760 if (JB_ERR_OK != process_encrypted_request(csp))
3762 log_error(LOG_LEVEL_ERROR, "Failed to parse encrypted request.");
3763 close_client_ssl_connection(csp);
3767 * We have an encrypted request. Check if one of the crunchers now
3768 * wants it (for example because the previously invisible path was
3769 * required to match).
3771 if (crunch_response_triggered(csp, crunchers_all))
3774 * Yes. The client got the crunch response and we're done here.
3776 close_client_ssl_connection(csp);
3782 * Connecting to destination server
3784 csp->server_connection.sfd = forwarded_connect(fwd, http, csp);
3786 if (csp->server_connection.sfd == JB_INVALID_SOCKET)
3788 if (fwd->type != SOCKS_NONE)
3791 rsp = error_response(csp, "forwarding-failed");
3793 else if (errno == EINVAL)
3795 rsp = error_response(csp, "no-such-domain");
3799 rsp = error_response(csp, "connect-failed");
3802 /* Write the answer to the client */
3805 send_crunch_response(csp, rsp);
3809 * Temporary workaround to prevent already-read client
3810 * bodies from being parsed as new requests. For now we
3811 * err on the safe side and throw all the following
3812 * requests under the bus, even if no client body has been
3813 * buffered. A compliant client will repeat the dropped
3814 * requests on an untainted connection.
3816 * The proper fix is to discard the no longer needed
3817 * client body in the buffer (if there is one) and to
3818 * continue parsing the bytes that follow.
3820 #ifdef FEATURE_HTTPS_INSPECTION
3821 close_client_ssl_connection(csp);
3823 drain_and_close_socket(csp->cfd);
3824 csp->cfd = JB_INVALID_SOCKET;
3829 #ifdef FEATURE_HTTPS_INSPECTION
3831 * Creating TLS/SSL connections with destination server or parent
3832 * proxy. If forwarding is enabled, we must send client request to
3833 * parent proxy and receive, parse and resend parent proxy answer.
3835 if (http->ssl && !use_ssl_tunnel)
3837 if (fwd->forward_host != NULL)
3839 char server_response[BUFFER_SIZE];
3842 char *hdr = list_to_text(csp->headers);
3843 memset(server_response, 0, sizeof(server_response));
3847 log_error(LOG_LEVEL_FATAL,
3848 "Out of memory parsing client header");
3850 list_remove_all(csp->headers);
3853 * Sending client's CONNECT request to the parent proxy
3855 ret = write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
3861 log_error(LOG_LEVEL_CONNECT,
3862 "Sending request headers to: %s failed", http->hostport);
3863 mark_server_socket_tainted(csp);
3864 close_client_ssl_connection(csp);
3868 /* Waiting for parent proxy server response */
3869 len = read_socket(csp->server_connection.sfd, server_response,
3870 sizeof(server_response)-1);
3874 log_error(LOG_LEVEL_ERROR, "No response from parent proxy "
3875 "server on socket %d.", csp->server_connection.sfd);
3877 rsp = error_response(csp, "no-server-data");
3880 send_crunch_response(csp, rsp);
3882 mark_server_socket_tainted(csp);
3883 close_client_ssl_connection(csp);
3888 * Test if the connection to the destination server was
3889 * established successfully by the parent proxy.
3891 if (!tunnel_established_successfully(server_response, (unsigned int)len))
3893 log_error(LOG_LEVEL_ERROR,
3894 "The forwarder %s failed to establish a connection with %s",
3895 fwd->forward_host, http->host);
3896 rsp = error_response(csp, "connect-failed");
3899 send_crunch_response(csp, rsp);
3901 mark_server_socket_tainted(csp);
3902 close_client_ssl_connection(csp);
3905 } /* -END- if (fwd->forward_host != NULL) */
3908 * We can now create the TLS/SSL connection with the destination server.
3910 int ret = create_server_ssl_connection(csp);
3913 if (csp->server_cert_verification_result != SSL_CERT_VALID &&
3914 csp->server_cert_verification_result != SSL_CERT_NOT_VERIFIED)
3917 * If the server certificate is invalid, we must inform
3918 * the client and then close connection to the client.
3920 ssl_send_certificate_error(csp);
3921 close_client_and_server_ssl_connections(csp);
3924 if (csp->server_cert_verification_result == SSL_CERT_NOT_VERIFIED
3925 || csp->server_cert_verification_result == SSL_CERT_VALID)
3928 * The TLS/SSL connection wasn't created but an invalid
3929 * certificate wasn't detected. Report it as connection
3932 rsp = error_response(csp, "connect-failed");
3935 send_crunch_response(csp, rsp);
3937 close_client_and_server_ssl_connections(csp);
3941 }/* -END- if (http->ssl) */
3942 #endif /* def FEATURE_HTTPS_INSPECTION */
3944 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3945 save_connection_destination(csp->server_connection.sfd,
3946 http, fwd, &csp->server_connection);
3947 csp->server_connection.keep_alive_timeout =
3948 (unsigned)csp->config->keep_alive_timeout;
3950 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3952 csp->server_connection.requests_sent_total++;
3954 if ((fwd->type == SOCKS_5T) && (NULL == csp->headers->first))
3956 /* Client headers have been sent optimistically */
3957 assert(csp->headers->last == NULL);
3959 else if (http->ssl == 0 || (fwd->forward_host
3960 #ifdef FEATURE_HTTPS_INSPECTION
3965 if (send_http_request(csp))
3967 rsp = error_response(csp, "connect-failed");
3970 send_crunch_response(csp, rsp);
3978 * Using old solution with SSL tunnel or new solution with SSL proxy
3980 list_remove_all(csp->headers);
3981 #ifdef FEATURE_HTTPS_INSPECTION
3986 * We're running an SSL tunnel and we're not forwarding,
3987 * so just ditch the client headers, send the "connect succeeded"
3988 * message to the client, flush the rest, and get out of the way.
3990 if (write_socket_delayed(csp->cfd, CSUCCEED,
3991 strlen(CSUCCEED), get_write_delay(csp)))
3996 #ifdef FEATURE_HTTPS_INSPECTION
4000 * If server certificate is invalid, we must inform client and then
4001 * close connection with client.
4003 if (csp->server_cert_verification_result != SSL_CERT_VALID)
4005 ssl_send_certificate_error(csp);
4006 close_client_and_server_ssl_connections(csp);
4009 if (send_https_request(csp))
4011 rsp = error_response(csp, "connect-failed");
4014 send_crunch_response(csp, rsp);
4016 close_client_and_server_ssl_connections(csp);
4020 #endif /* def FEATURE_HTTPS_INSPECTION */
4021 clear_iob(csp->client_iob);
4022 }/* -END- else ... if (http->ssl == 1) */
4024 log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
4026 /* XXX: should the time start earlier for optimistically sent data? */
4027 csp->server_connection.request_sent = time(NULL);
4029 handle_established_connection(csp);
4030 freez(csp->receive_buffer);
4035 /*********************************************************************
4037 * Function : fuzz_server_response
4039 * Description : Treat the input as a whole server response.
4042 * 1 : csp = Current client state (buffers, headers, etc...)
4043 * 2 : fuzz_input_file = File to read the input from.
4047 *********************************************************************/
4048 extern int fuzz_server_response(struct client_state *csp, char *fuzz_input_file)
4050 static struct forward_spec fwd; /* Zero'd due to being static */
4053 if (strcmp(fuzz_input_file, "-") == 0)
4055 /* XXX: Doesn'T work yet. */
4056 csp->server_connection.sfd = 0;
4060 csp->server_connection.sfd = open(fuzz_input_file, O_RDONLY);
4061 if (csp->server_connection.sfd == -1)
4063 log_error(LOG_LEVEL_FATAL, "Failed to open %s: %E",
4068 csp->content_type |= CT_GIF;
4069 csp->action->flags |= ACTION_DEANIMATE;
4070 csp->action->string[ACTION_STRING_DEANIMATE] = "last";
4072 csp->http->path = strdup_or_die("/");
4073 csp->http->host = strdup_or_die("fuzz.example.org");
4074 csp->http->hostport = strdup_or_die("fuzz.example.org:80");
4075 /* Prevent client socket monitoring */
4076 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
4077 csp->flags |= CSP_FLAG_CHUNKED;
4079 csp->config->feature_flags |= RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
4080 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
4082 csp->content_type |= CT_DECLARED|CT_GIF;
4084 csp->config->socket_timeout = 0;
4086 cgi_init_error_messages();
4088 handle_established_connection(csp);
4089 freez(csp->receive_buffer);
4096 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4097 /*********************************************************************
4099 * Function : prepare_csp_for_next_request
4101 * Description : Put the csp in a mostly vergin state.
4104 * 1 : csp = Current client state (buffers, headers, etc...)
4108 *********************************************************************/
4109 static void prepare_csp_for_next_request(struct client_state *csp)
4111 csp->content_type = 0;
4112 csp->content_length = 0;
4113 csp->expected_content_length = 0;
4114 csp->expected_client_content_length = 0;
4115 list_remove_all(csp->headers);
4116 clear_iob(csp->iob);
4117 freez(csp->error_message);
4118 free_http_request(csp->http);
4119 destroy_list(csp->headers);
4120 destroy_list(csp->tags);
4121 #ifdef FEATURE_CLIENT_TAGS
4122 destroy_list(csp->client_tags);
4123 freez(csp->client_address);
4125 free_current_action(csp->action);
4126 if (NULL != csp->fwd)
4128 unload_forward_spec(csp->fwd);
4131 /* XXX: Store per-connection flags someplace else. */
4132 csp->flags = (CSP_FLAG_ACTIVE | CSP_FLAG_REUSED_CLIENT_CONNECTION);
4133 #ifdef FEATURE_TOGGLE
4134 if (global_toggle_state)
4135 #endif /* def FEATURE_TOGGLE */
4137 csp->flags |= CSP_FLAG_TOGGLED_ON;
4140 if (csp->client_iob->eod > csp->client_iob->cur)
4142 long bytes_to_shift = csp->client_iob->cur - csp->client_iob->buf;
4143 size_t data_length = (size_t)(csp->client_iob->eod - csp->client_iob->cur);
4145 assert(bytes_to_shift > 0);
4146 assert(data_length > 0);
4148 log_error(LOG_LEVEL_CONNECT, "Shifting %d pipelined bytes by %d bytes",
4149 data_length, bytes_to_shift);
4150 memmove(csp->client_iob->buf, csp->client_iob->cur, data_length);
4151 csp->client_iob->cur = csp->client_iob->buf;
4152 assert(csp->client_iob->eod == csp->client_iob->buf + bytes_to_shift + data_length);
4153 csp->client_iob->eod = csp->client_iob->buf + data_length;
4154 memset(csp->client_iob->eod, '\0', (size_t)bytes_to_shift);
4156 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
4161 * We mainly care about resetting client_iob->cur so we don't
4162 * waste buffer space at the beginning and don't mess up the
4163 * request restoration done by cgi_show_request().
4165 * Freeing the buffer itself isn't technically necessary,
4166 * but makes debugging more convenient.
4168 clear_iob(csp->client_iob);
4171 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4174 /*********************************************************************
4178 * Description : This is little more than chat. We only "serve" to
4179 * to close (or remember) any socket that chat may have
4183 * 1 : csp = Current client state (buffers, headers, etc...)
4187 *********************************************************************/
4188 static void serve(struct client_state *csp)
4190 int config_file_change_detected = 0; /* Only used for debugging */
4191 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4192 #ifdef FEATURE_CONNECTION_SHARING
4193 static int monitor_thread_running = 0;
4194 #endif /* def FEATURE_CONNECTION_SHARING */
4195 int continue_chatting = 0;
4197 log_error(LOG_LEVEL_CONNECT, "Accepted connection from %s on socket %d",
4198 csp->ip_addr_str, csp->cfd);
4202 unsigned int latency;
4207 * If the request has been crunched,
4208 * the calculated latency is zero.
4210 latency = (unsigned)(csp->server_connection.response_received -
4211 csp->server_connection.request_sent) / 2;
4213 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4214 && (csp->flags & CSP_FLAG_CRUNCHED)
4215 && (csp->expected_client_content_length != 0))
4217 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
4218 log_error(LOG_LEVEL_CONNECT,
4219 "Tainting client socket %d due to unread data.", csp->cfd);
4222 continue_chatting = (csp->config->feature_flags
4223 & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
4224 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
4225 && (csp->cfd != JB_INVALID_SOCKET)
4226 && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4227 && ((csp->flags & CSP_FLAG_SERVER_CONTENT_LENGTH_SET)
4228 || (csp->flags & CSP_FLAG_CHUNKED));
4230 if (!(csp->flags & CSP_FLAG_CRUNCHED)
4231 && (csp->server_connection.sfd != JB_INVALID_SOCKET))
4233 if (!(csp->flags & CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET))
4235 csp->server_connection.keep_alive_timeout = csp->config->default_server_timeout;
4237 if (!(csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
4238 || (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
4239 || !socket_is_still_alive(csp->server_connection.sfd)
4240 || !(latency < csp->server_connection.keep_alive_timeout))
4242 log_error(LOG_LEVEL_CONNECT,
4243 "Closing server socket %d connected to %s. "
4244 "Keep-alive: %u. Tainted: %u. Socket alive: %u. Timeout: %u.",
4245 csp->server_connection.sfd, csp->server_connection.host,
4246 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
4247 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
4248 socket_is_still_alive(csp->server_connection.sfd),
4249 csp->server_connection.keep_alive_timeout);
4250 #ifdef FEATURE_CONNECTION_SHARING
4251 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4253 forget_connection(csp->server_connection.sfd);
4255 #endif /* def FEATURE_CONNECTION_SHARING */
4256 close_socket(csp->server_connection.sfd);
4257 mark_connection_closed(&csp->server_connection);
4261 if (continue_chatting && any_loaded_file_changed(csp))
4263 continue_chatting = 0;
4264 config_file_change_detected = 1;
4267 if (continue_chatting)
4269 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
4270 && socket_is_still_alive(csp->cfd))
4272 log_error(LOG_LEVEL_CONNECT, "Client request %d has been "
4273 "pipelined on socket %d and the socket is still alive.",
4274 csp->requests_received_total+1, csp->cfd);
4275 prepare_csp_for_next_request(csp);
4279 if (0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
4281 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4283 log_error(LOG_LEVEL_CONNECT,
4284 "Waiting for the next client request on socket %d. "
4285 "Keeping the server socket %d to %s open.",
4286 csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
4290 log_error(LOG_LEVEL_CONNECT,
4291 "Waiting for the next client request on socket %d. "
4292 "No server socket to keep open.", csp->cfd);
4296 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4297 && data_is_available(csp->cfd, (int)csp->config->keep_alive_timeout)
4298 && socket_is_still_alive(csp->cfd))
4300 log_error(LOG_LEVEL_CONNECT,
4301 "Client request %u arrived in time on socket %d.",
4302 csp->requests_received_total+1, csp->cfd);
4303 prepare_csp_for_next_request(csp);
4307 #ifdef FEATURE_CONNECTION_SHARING
4308 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4309 && (csp->server_connection.sfd != JB_INVALID_SOCKET)
4310 && (socket_is_still_alive(csp->server_connection.sfd)))
4312 time_t time_open = time(NULL) - csp->server_connection.timestamp;
4314 if (csp->server_connection.keep_alive_timeout < time_open - (time_t)latency)
4319 remember_connection(&csp->server_connection);
4320 csp->server_connection.sfd = JB_INVALID_SOCKET;
4321 drain_and_close_socket(csp->cfd);
4322 csp->cfd = JB_INVALID_SOCKET;
4323 privoxy_mutex_lock(&connection_reuse_mutex);
4324 if (!monitor_thread_running)
4326 monitor_thread_running = 1;
4327 privoxy_mutex_unlock(&connection_reuse_mutex);
4328 wait_for_alive_connections();
4329 privoxy_mutex_lock(&connection_reuse_mutex);
4330 monitor_thread_running = 0;
4332 privoxy_mutex_unlock(&connection_reuse_mutex);
4334 #endif /* def FEATURE_CONNECTION_SHARING */
4338 else if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4340 log_error(LOG_LEVEL_CONNECT,
4341 "Closing server socket %d connected to %s. Keep-alive: %u. "
4342 "Tainted: %u. Socket alive: %u. Timeout: %u. "
4343 "Configuration file change detected: %u",
4344 csp->server_connection.sfd, csp->server_connection.host,
4345 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
4346 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
4347 socket_is_still_alive(csp->server_connection.sfd),
4348 csp->server_connection.keep_alive_timeout,
4349 config_file_change_detected);
4351 } while (continue_chatting);
4355 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4357 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4359 #ifdef FEATURE_CONNECTION_SHARING
4360 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4362 forget_connection(csp->server_connection.sfd);
4364 #endif /* def FEATURE_CONNECTION_SHARING */
4365 close_socket(csp->server_connection.sfd);
4368 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4369 mark_connection_closed(&csp->server_connection);
4372 if (csp->cfd != JB_INVALID_SOCKET)
4374 log_error(LOG_LEVEL_CONNECT, "Closing client socket %d. "
4375 "Keep-alive: %u. Socket alive: %u. Data available: %u. "
4376 "Configuration file change detected: %u. Requests received: %u.",
4377 csp->cfd, 0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE),
4378 socket_is_still_alive(csp->cfd), data_is_available(csp->cfd, 0),
4379 config_file_change_detected, csp->requests_received_total);
4380 drain_and_close_socket(csp->cfd);
4383 free_csp_resources(csp);
4385 csp->flags &= ~CSP_FLAG_ACTIVE;
4391 /*********************************************************************
4393 * Function : server_thread
4395 * Description : We only exist to call `serve' in a threaded environment.
4398 * 1 : data = Current client state (buffers, headers, etc...)
4400 * Returns : Always 0.
4402 *********************************************************************/
4403 static int32 server_thread(void *data)
4405 serve((struct client_state *) data);
4412 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
4413 /*********************************************************************
4417 * Description : Print usage info & exit.
4419 * Parameters : Pointer to argv[0] for identifying ourselves
4423 *********************************************************************/
4424 static void usage(const char *name)
4426 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
4427 "Usage: %s [--config-test] "
4430 #endif /* defined(unix) */
4433 "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
4434 #endif /* defined(unix) */
4435 "[--version] [configfile]\n",
4439 show_fuzz_usage(name);
4442 printf("Aborting\n");
4447 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
4450 #ifdef MUTEX_LOCKS_AVAILABLE
4451 /*********************************************************************
4453 * Function : privoxy_mutex_lock
4455 * Description : Locks a mutex.
4458 * 1 : mutex = The mutex to lock.
4460 * Returns : Void. May exit in case of errors.
4462 *********************************************************************/
4463 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
4465 #ifdef FEATURE_PTHREAD
4466 int err = pthread_mutex_lock(mutex);
4469 if (mutex != &log_mutex)
4471 log_error(LOG_LEVEL_FATAL,
4472 "Mutex locking failed: %s.\n", strerror(err));
4477 EnterCriticalSection(mutex);
4478 #endif /* def FEATURE_PTHREAD */
4482 /*********************************************************************
4484 * Function : privoxy_mutex_unlock
4486 * Description : Unlocks a mutex.
4489 * 1 : mutex = The mutex to unlock.
4491 * Returns : Void. May exit in case of errors.
4493 *********************************************************************/
4494 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
4496 #ifdef FEATURE_PTHREAD
4497 int err = pthread_mutex_unlock(mutex);
4500 if (mutex != &log_mutex)
4502 log_error(LOG_LEVEL_FATAL,
4503 "Mutex unlocking failed: %s.\n", strerror(err));
4508 LeaveCriticalSection(mutex);
4509 #endif /* def FEATURE_PTHREAD */
4513 /*********************************************************************
4515 * Function : privoxy_mutex_init
4517 * Description : Prepares a mutex.
4520 * 1 : mutex = The mutex to initialize.
4522 * Returns : Void. May exit in case of errors.
4524 *********************************************************************/
4525 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
4527 #ifdef FEATURE_PTHREAD
4528 int err = pthread_mutex_init(mutex, 0);
4531 printf("Fatal error. Mutex initialization failed: %s.\n",
4536 InitializeCriticalSection(mutex);
4537 #endif /* def FEATURE_PTHREAD */
4539 #endif /* def MUTEX_LOCKS_AVAILABLE */
4541 /*********************************************************************
4543 * Function : initialize_mutexes
4545 * Description : Prepares mutexes if mutex support is available.
4549 * Returns : Void, exits in case of errors.
4551 *********************************************************************/
4552 static void initialize_mutexes(void)
4554 #ifdef MUTEX_LOCKS_AVAILABLE
4556 * Prepare global mutex semaphores
4559 #ifdef FEATURE_HTTPS_INSPECTION
4560 privoxy_mutex_init(&certificate_mutex);
4561 privoxy_mutex_init(&rng_mutex);
4564 privoxy_mutex_init(&log_mutex);
4565 privoxy_mutex_init(&log_init_mutex);
4566 privoxy_mutex_init(&connection_reuse_mutex);
4567 #ifdef FEATURE_EXTERNAL_FILTERS
4568 privoxy_mutex_init(&external_filter_mutex);
4570 #ifdef FEATURE_CLIENT_TAGS
4571 privoxy_mutex_init(&client_tags_mutex);
4573 #ifdef FEATURE_EXTENDED_STATISTICS
4574 privoxy_mutex_init(&filter_statistics_mutex);
4578 * XXX: The assumptions below are a bit naive
4579 * and can cause locks that aren't necessary.
4581 * For example older FreeBSD versions (< 6.x?)
4582 * have no gethostbyname_r, but gethostbyname is
4585 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
4586 privoxy_mutex_init(&resolver_mutex);
4587 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
4589 * XXX: should we use a single mutex for
4590 * localtime() and gmtime() as well?
4592 #ifndef HAVE_GMTIME_R
4593 privoxy_mutex_init(&gmtime_mutex);
4594 #endif /* ndef HAVE_GMTIME_R */
4596 #ifndef HAVE_LOCALTIME_R
4597 privoxy_mutex_init(&localtime_mutex);
4598 #endif /* ndef HAVE_GMTIME_R */
4600 #if !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM)
4601 privoxy_mutex_init(&rand_mutex);
4602 #endif /* !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM) */
4604 #endif /* def MUTEX_LOCKS_AVAILABLE */
4607 /*********************************************************************
4611 * Description : Load the config file and start the listen loop.
4612 * This function is a lot more *sane* with the `load_config'
4613 * and `listen_loop' functions; although it stills does
4614 * a *little* too much for my taste.
4617 * 1 : argc = Number of parameters (including $0).
4618 * 2 : argv = Array of (char *)'s to the parameters.
4620 * Returns : 1 if : can't open config file, unrecognized directive,
4621 * stats requested in multi-thread mode, can't open the
4622 * log file, can't open the jar file, listen port is invalid,
4623 * any load fails, and can't bind port.
4625 * Else main never returns, the process must be signaled
4626 * to terminate execution. Or, on Windows, use the
4627 * "File", "Exit" menu option.
4629 *********************************************************************/
4631 int real_main(int argc, char **argv)
4633 int main(int argc, char **argv)
4637 int do_config_test = 0;
4638 #ifndef HAVE_ARC4RANDOM
4639 unsigned int random_seed;
4642 struct passwd *pw = NULL;
4643 struct group *grp = NULL;
4645 char *pre_chroot_nslookup_to_load_resolver = NULL;
4648 char *fuzz_input_type = NULL;
4649 char *fuzz_input_file = NULL;
4656 #if !defined(_WIN32)
4663 /* Prepare mutexes if supported and necessary. */
4664 initialize_mutexes();
4666 /* Enable logging until further notice. */
4670 * Parse the command line arguments
4672 * XXX: simply printing usage information in case of
4673 * invalid arguments isn't particularly user friendly.
4675 while (++argc_pos < argc)
4678 /* Check to see if the service must be installed or uninstalled */
4679 if (strncmp(argv[argc_pos], "--install", 9) == 0)
4681 const char *pName = argv[argc_pos] + 9;
4684 exit((install_service(pName)) ? 0 : 1);
4686 else if (strncmp(argv[argc_pos], "--uninstall", 11) == 0)
4688 const char *pName = argv[argc_pos] + 11;
4691 exit((uninstall_service(pName)) ? 0 : 1);
4693 else if (strcmp(argv[argc_pos], "--service") == 0)
4695 bRunAsService = TRUE;
4696 w32_set_service_cwd();
4697 atexit(w32_service_exit_notify);
4700 #endif /* defined(_WIN32) */
4703 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
4705 if (strcmp(argv[argc_pos], "--help") == 0)
4710 else if (strcmp(argv[argc_pos], "--version") == 0)
4712 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
4718 else if (strcmp(argv[argc_pos], "--no-daemon") == 0)
4720 set_debug_level(LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
4724 else if (strcmp(argv[argc_pos], "--pidfile") == 0)
4726 if (++argc_pos == argc) usage(argv[0]);
4727 pidfile = strdup_or_die(argv[argc_pos]);
4730 else if (strcmp(argv[argc_pos], "--user") == 0)
4735 if (++argc_pos == argc) usage(argv[argc_pos]);
4737 user_arg = strdup_or_die(argv[argc_pos]);
4738 group_name = strchr(user_arg, '.');
4739 if (NULL != group_name)
4741 /* Nul-terminate the user name */
4744 /* Skip the former delimiter to actually reach the group name */
4747 grp = getgrnam(group_name);
4750 log_error(LOG_LEVEL_FATAL, "Group '%s' not found.", group_name);
4753 pw = getpwnam(user_arg);
4756 log_error(LOG_LEVEL_FATAL, "User '%s' not found.", user_arg);
4762 else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup") == 0)
4764 if (++argc_pos == argc) usage(argv[0]);
4765 pre_chroot_nslookup_to_load_resolver = strdup_or_die(argv[argc_pos]);
4768 else if (strcmp(argv[argc_pos], "--chroot") == 0)
4772 #endif /* defined(unix) */
4774 else if (strcmp(argv[argc_pos], "--config-test") == 0)
4779 else if (strcmp(argv[argc_pos], "--fuzz") == 0)
4782 if (argc < argc_pos + 2) usage(argv[0]);
4783 fuzz_input_type = argv[argc_pos];
4785 fuzz_input_file = argv[argc_pos];
4787 else if (strcmp(argv[argc_pos], "--stfu") == 0)
4789 set_debug_level(LOG_LEVEL_STFU);
4792 else if (argc_pos + 1 != argc)
4795 * This is neither the last command line
4796 * option, nor was it recognized before,
4797 * therefore it must be invalid.
4803 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
4805 configfile = argv[argc_pos];
4808 } /* -END- while (more arguments) */
4810 show_version(Argv[0]);
4813 if (*configfile != '/')
4815 char cwd[BUFFER_SIZE];
4817 size_t abs_file_size;
4819 /* make config-filename absolute here */
4820 if (NULL == getcwd(cwd, sizeof(cwd)))
4822 perror("failed to get current working directory");
4826 basedir = strdup_or_die(cwd);
4828 abs_file_size = strlen(cwd) + strlen(configfile) + 5;
4829 abs_file = malloc_or_die(abs_file_size);
4830 strlcpy(abs_file, basedir, abs_file_size);
4831 strlcat(abs_file, "/", abs_file_size);
4832 strlcat(abs_file, configfile, abs_file_size);
4833 configfile = abs_file;
4835 #endif /* defined unix */
4839 clients->next = NULL;
4841 /* XXX: factor out initialising after the next stable release. */
4846 #ifndef HAVE_ARC4RANDOM
4847 random_seed = (unsigned int)time(NULL);
4849 srandom(random_seed);
4852 #endif /* ifdef HAVE_RANDOM */
4853 #endif /* ifndef HAVE_ARC4RANDOM */
4856 * Unix signal handling
4858 * Catch the abort, interrupt and terminate signals for a graceful exit
4859 * Catch the hangup signal so the errlog can be reopened.
4861 * Ignore the broken pipe signal as connection failures
4862 * are handled when and where they occur without relying
4865 #if !defined(_WIN32) && !defined(__OS2__)
4868 const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP };
4870 for (idx = 0; idx < SZ(catched_signals); idx++)
4872 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
4873 if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
4875 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
4876 #endif /* ifdef sun */
4878 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
4882 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
4884 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for SIGPIPE: %E");
4888 #else /* ifdef _WIN32 */
4889 # ifdef _WIN_CONSOLE
4891 * We *are* in a windows console app.
4892 * Print a verbose messages about FAQ's and such
4894 printf("%s", win32_blurb);
4895 # endif /* def _WIN_CONSOLE */
4896 #endif /* def _WIN32 */
4899 if (fuzz_input_type != NULL)
4901 exit(process_fuzzed_input(fuzz_input_type, fuzz_input_file));
4903 log_error(LOG_LEVEL_FATAL,
4904 "When compiled with fuzzing support, Privoxy should only be used for fuzzing. "
4905 "Various data structures are static which is unsafe when using threads.");
4910 exit(NULL == load_config());
4913 /* Initialize the CGI subsystem */
4914 cgi_init_error_messages();
4917 * If running on unix and without the --no-daemon
4918 * option, become a daemon. I.e. fork, detach
4919 * from tty and get process group leadership
4928 if (pid < 0) /* error */
4933 else if (pid != 0) /* parent */
4938 * must check for errors
4939 * child died due to missing files aso
4942 wpid = waitpid(pid, &status, WNOHANG);
4954 * stderr (fd 2) will be closed later on,
4955 * when the config file has been parsed.
4961 * Reserve fd 0 and 1 to prevent abort() and friends
4962 * from sending stuff to the clients or servers.
4964 fd = open("/dev/null", O_RDONLY);
4967 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
4971 if (dup2(fd, 0) == -1)
4973 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 0: %E");
4977 fd = open("/dev/null", O_WRONLY);
4980 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
4984 if (dup2(fd, 1) == -1)
4986 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 1: %E");
4991 #ifdef FEATURE_EXTERNAL_FILTERS
4992 for (fd = 0; fd < 3; fd++)
4994 mark_socket_for_close_on_execute(fd);
5000 } /* -END- if (daemon_mode) */
5003 * As soon as we have written the PID file, we can switch
5004 * to the user and group ID indicated by the --user option
5006 if (pidfile != NULL)
5008 write_pid_file(pidfile);
5012 if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
5014 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
5018 if (setgroups(1, &grp->gr_gid))
5020 log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
5023 else if (initgroups(pw->pw_name, pw->pw_gid))
5025 log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
5031 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
5033 /* Read the time zone file from /etc before doing chroot. */
5035 if (NULL != pre_chroot_nslookup_to_load_resolver
5036 && '\0' != pre_chroot_nslookup_to_load_resolver[0])
5038 /* Initialize resolver library. */
5039 (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
5041 if (chroot(pw->pw_dir) < 0)
5043 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
5047 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
5050 if (setuid(pw->pw_uid))
5052 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
5056 char putenv_dummy[64];
5058 strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
5059 if (putenv(putenv_dummy) != 0)
5061 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
5064 snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
5065 if (putenv(putenv_dummy) != 0)
5067 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
5073 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
5076 #endif /* defined unix */
5079 /* This will be FALSE unless the command line specified --service
5083 /* Yup, so now we must attempt to establish a connection
5084 * with the service dispatcher. This will only work if this
5085 * process was launched by the service control manager to
5086 * actually run as a service. If this isn't the case, i've
5087 * known it take around 30 seconds or so for the call to return.
5090 /* The StartServiceCtrlDispatcher won't return until the service is stopping */
5091 if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
5093 /* Service has run, and at this point is now being stopped, so just return */
5098 printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
5100 /* An error occurred. Usually it's because --service was wrongly specified
5101 * and we were unable to connect to the Service Control Dispatcher because
5102 * it wasn't expecting us and is therefore not listening.
5104 * For now, just continue below to call the listen_loop function.
5107 #endif /* def _WIN32 */
5117 /*********************************************************************
5119 * Function : bind_port_helper
5121 * Description : Bind the listen port. Handles logging, and aborts
5125 * 1 : haddr = Host address to bind to. Use NULL to bind to
5127 * 2 : hport = Specifies port to bind to.
5128 * 3 : backlog = Listen backlog.
5130 * Returns : Port that was opened.
5132 *********************************************************************/
5133 static jb_socket bind_port_helper(const char *haddr, int hport, int backlog)
5138 result = bind_port(haddr, hport, backlog, &bfd);
5142 const char *bind_address = (NULL != haddr) ? haddr : "INADDR_ANY";
5146 log_error(LOG_LEVEL_FATAL,
5147 "can't bind to %s:%d: There may be another Privoxy "
5148 "or some other proxy running on port %d",
5149 bind_address, hport, hport);
5152 log_error(LOG_LEVEL_FATAL,
5153 "can't bind to %s:%d: The hostname is not resolvable",
5154 bind_address, hport);
5157 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: %E",
5158 bind_address, hport);
5161 /* shouldn't get here */
5162 return JB_INVALID_SOCKET;
5167 if (bfd >= FD_SETSIZE)
5169 log_error(LOG_LEVEL_FATAL,
5170 "Bind socket number too high to use select(): %d >= %d",
5178 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
5183 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
5191 /*********************************************************************
5193 * Function : bind_ports_helper
5195 * Description : Bind the listen ports. Handles logging, and aborts
5199 * 1 : config = Privoxy configuration. Specifies ports
5201 * 2 : sockets = Preallocated array of opened sockets
5202 * corresponding to specification in config.
5203 * All non-opened sockets will be set to
5204 * JB_INVALID_SOCKET.
5206 * Returns : Nothing. Inspect sockets argument.
5208 *********************************************************************/
5209 static void bind_ports_helper(struct configuration_spec * config,
5210 jb_socket sockets[])
5214 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
5216 if (config->hport[i])
5218 sockets[i] = bind_port_helper(config->haddr[i],
5219 config->hport[i], config->listen_backlog);
5220 #if defined(FEATURE_ACCEPT_FILTER) && defined(SO_ACCEPTFILTER)
5221 if (config->enable_accept_filter && sockets[i] != JB_INVALID_SOCKET)
5223 struct accept_filter_arg af_options;
5224 bzero(&af_options, sizeof(af_options));
5225 strlcpy(af_options.af_name, "httpready", sizeof(af_options.af_name));
5226 if (setsockopt(sockets[i], SOL_SOCKET, SO_ACCEPTFILTER, &af_options,
5227 sizeof(af_options)))
5229 log_error(LOG_LEVEL_ERROR,
5230 "Enabling accept filter for socket %d failed: %E", sockets[i]);
5237 sockets[i] = JB_INVALID_SOCKET;
5240 config->need_bind = 0;
5244 /*********************************************************************
5246 * Function : close_ports_helper
5248 * Description : Close listenings ports.
5251 * 1 : sockets = Array of opened and non-opened sockets to
5252 * close. All sockets will be set to
5253 * JB_INVALID_SOCKET.
5255 * Returns : Nothing.
5257 *********************************************************************/
5258 static void close_ports_helper(jb_socket sockets[])
5262 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
5264 if (JB_INVALID_SOCKET != sockets[i])
5266 close_socket(sockets[i]);
5268 sockets[i] = JB_INVALID_SOCKET;
5274 /* Without this simple workaround we get this compiler warning from _beginthread
5275 * warning C4028: formal parameter 1 different from declaration
5277 void w32_service_listen_loop(void *p)
5281 #endif /* def _WIN32 */
5284 /*********************************************************************
5286 * Function : listen_loop
5288 * Description : bind the listen port and enter a "FOREVER" listening loop.
5294 *********************************************************************/
5295 static void listen_loop(void)
5297 struct client_states *csp_list = NULL;
5298 struct client_state *csp = NULL;
5299 jb_socket bfds[MAX_LISTENING_SOCKETS];
5300 struct configuration_spec *config;
5301 unsigned int active_threads = 0;
5302 #if defined(FEATURE_PTHREAD)
5303 pthread_attr_t attrs;
5305 pthread_attr_init(&attrs);
5306 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
5309 config = load_config();
5311 #ifdef FEATURE_CONNECTION_SHARING
5313 * XXX: Should be relocated once it no
5314 * longer needs to emit log messages.
5316 initialize_reusable_connections();
5317 #endif /* def FEATURE_CONNECTION_SHARING */
5319 bind_ports_helper(config, bfds);
5321 #ifdef FEATURE_GRACEFUL_TERMINATION
5322 while (!g_terminate)
5327 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(__OS2__)
5328 while (waitpid(-1, NULL, WNOHANG) > 0)
5330 /* zombie children */
5332 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) */
5335 * Free data that was used by died threads
5337 active_threads = sweep();
5341 * Re-open the errlog after HUP signal
5343 if (received_hup_signal)
5345 if (NULL != config->logfile)
5347 init_error_log(Argv[0], config->logfile);
5349 received_hup_signal = 0;
5353 csp_list = zalloc_or_die(sizeof(*csp_list));
5354 csp = &csp_list->csp;
5356 log_error(LOG_LEVEL_CONNECT,
5357 "Waiting for the next client connection. Currently active threads: %d",
5361 * This config may be outdated, but for accept_connection()
5362 * it's fresh enough.
5364 csp->config = config;
5366 if (!accept_connection(csp, bfds))
5368 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
5373 csp->flags |= CSP_FLAG_ACTIVE;
5374 csp->server_connection.sfd = JB_INVALID_SOCKET;
5376 csp->config = config = load_config();
5378 if (config->need_bind)
5381 * Since we were listening to the "old port", we will not see
5382 * a "listen" param change until the next request. So, at
5383 * least 1 more request must be made for us to find the new
5384 * setting. I am simply closing the old socket and binding the
5387 * Which-ever is correct, we will serve 1 more page via the
5388 * old settings. This should probably be a "show-status"
5389 * request. This should not be a so common of an operation
5390 * that this will hurt people's feelings.
5393 close_ports_helper(bfds);
5395 bind_ports_helper(config, bfds);
5398 #ifdef FEATURE_TOGGLE
5399 if (global_toggle_state)
5400 #endif /* def FEATURE_TOGGLE */
5402 csp->flags |= CSP_FLAG_TOGGLED_ON;
5405 if (run_loader(csp))
5407 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
5408 /* Never get here - LOG_LEVEL_FATAL causes program exit */
5412 if (block_acl(NULL,csp))
5414 log_error(LOG_LEVEL_CONNECT,
5415 "Connection from %s on %s (socket %d) dropped due to ACL",
5416 csp->ip_addr_str, csp->listen_addr_str, csp->cfd);
5417 close_socket(csp->cfd);
5418 freez(csp->ip_addr_str);
5419 freez(csp->listen_addr_str);
5423 #endif /* def FEATURE_ACL */
5425 if ((0 != config->max_client_connections)
5426 && (active_threads >= config->max_client_connections))
5428 log_error(LOG_LEVEL_CONNECT,
5429 "Rejecting connection from %s. Maximum number of connections reached.",
5431 write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
5432 strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
5433 close_socket(csp->cfd);
5434 freez(csp->ip_addr_str);
5435 freez(csp->listen_addr_str);
5440 /* add it to the list of clients */
5441 csp_list->next = clients->next;
5442 clients->next = csp_list;
5444 if (config->multi_threaded)
5448 /* this is a switch () statement in the C preprocessor - ugh */
5449 #undef SELECTED_ONE_OPTION
5451 /* Use Pthreads in preference to native code */
5452 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
5453 #define SELECTED_ONE_OPTION
5455 pthread_t the_thread;
5457 errno = pthread_create(&the_thread, &attrs,
5458 (void * (*)(void *))serve, csp);
5459 child_id = errno ? -1 : 0;
5463 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
5464 #define SELECTED_ONE_OPTION
5465 child_id = _beginthread(
5466 (void (*)(void *))serve,
5471 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
5472 #define SELECTED_ONE_OPTION
5473 child_id = _beginthread(
5474 (void(* _Optlink)(void*))serve,
5480 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
5481 #define SELECTED_ONE_OPTION
5483 thread_id tid = spawn_thread
5484 (server_thread, "server", B_NORMAL_PRIORITY, csp);
5486 if ((tid >= 0) && (resume_thread(tid) == B_OK))
5488 child_id = (int) tid;
5497 #if !defined(SELECTED_ONE_OPTION)
5500 /* This block is only needed when using fork().
5501 * When using threads, the server thread was
5502 * created and run by the call to _beginthread().
5504 if (child_id == 0) /* child */
5507 #ifdef FEATURE_TOGGLE
5508 int inherited_toggle_state = global_toggle_state;
5509 #endif /* def FEATURE_TOGGLE */
5514 * If we've been toggled or we've blocked the request, tell Mom
5517 #ifdef FEATURE_TOGGLE
5518 if (inherited_toggle_state != global_toggle_state)
5520 rc |= RC_FLAG_TOGGLED;
5522 #endif /* def FEATURE_TOGGLE */
5524 #ifdef FEATURE_STATISTICS
5525 if (csp->flags & CSP_FLAG_REJECTED)
5527 rc |= RC_FLAG_BLOCKED;
5529 #endif /* ndef FEATURE_STATISTICS */
5533 else if (child_id > 0) /* parent */
5535 /* in a fork()'d environment, the parent's
5536 * copy of the client socket and the CSP
5540 #if !defined(_WIN32) && !defined(__CYGWIN__)
5542 wait(&child_status);
5545 * Evaluate child's return code: If the child has
5546 * - been toggled, toggle ourselves
5547 * - blocked its request, bump up the stats counter
5550 #ifdef FEATURE_TOGGLE
5551 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
5553 global_toggle_state = !global_toggle_state;
5555 #endif /* def FEATURE_TOGGLE */
5557 #ifdef FEATURE_STATISTICS
5559 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
5563 #endif /* def FEATURE_STATISTICS */
5565 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
5566 close_socket(csp->cfd);
5567 csp->flags &= ~CSP_FLAG_ACTIVE;
5571 #undef SELECTED_ONE_OPTION
5572 /* end of cpp switch () */
5577 * Spawning the child failed, assume it's because
5578 * there are too many children running already.
5579 * XXX: If you assume ...
5581 log_error(LOG_LEVEL_ERROR,
5582 "Unable to take any additional connections: %E. Active threads: %d",
5584 write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
5585 strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
5586 close_socket(csp->cfd);
5587 csp->flags &= ~CSP_FLAG_ACTIVE;
5596 #if defined(FEATURE_PTHREAD)
5597 pthread_attr_destroy(&attrs);
5600 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
5602 #ifdef FEATURE_HTTPS_INSPECTION
5603 /* Clean up. Aim: free all memory (no leaks) */
5604 if (rng_seeded == 1)
5606 mbedtls_ctr_drbg_free(&ctr_drbg);
5607 mbedtls_entropy_free(&entropy);
5611 #ifdef FEATURE_GRACEFUL_TERMINATION
5613 log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
5615 unload_current_config_file();
5616 unload_current_actions_file();
5617 unload_current_re_filterfile();
5618 #ifdef FEATURE_TRUST
5619 unload_current_trust_file();
5622 if (config->multi_threaded)
5629 } while ((clients->next != NULL) && (--i > 0));
5633 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
5643 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
5644 /* Cleanup - remove taskbar icon etc. */
5649 #endif /* FEATURE_GRACEFUL_TERMINATION */