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;
208 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
209 privoxy_mutex_t resolver_mutex;
210 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
212 #ifndef HAVE_GMTIME_R
213 privoxy_mutex_t gmtime_mutex;
214 #endif /* ndef HAVE_GMTIME_R */
216 #ifndef HAVE_LOCALTIME_R
217 privoxy_mutex_t localtime_mutex;
218 #endif /* ndef HAVE_GMTIME_R */
220 #if !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM)
221 privoxy_mutex_t rand_mutex;
222 #endif /* !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM) */
224 #endif /* def MUTEX_LOCKS_AVAILABLE */
227 const char *basedir = NULL;
228 const char *pidfile = NULL;
229 static int received_hup_signal = 0;
230 #endif /* defined unix */
232 /* HTTP snipplets. */
233 static const char CSUCCEED[] =
234 "HTTP/1.1 200 Connection established\r\n\r\n";
236 static const char CHEADER[] =
237 "HTTP/1.1 400 Invalid header received from client\r\n"
238 "Content-Type: text/plain\r\n"
239 "Connection: close\r\n\r\n"
240 "Invalid header received from client.\r\n";
242 static const char FTP_RESPONSE[] =
243 "HTTP/1.1 400 Invalid request received from client\r\n"
244 "Content-Type: text/plain\r\n"
245 "Connection: close\r\n\r\n"
246 "Invalid request. Privoxy doesn't support FTP.\r\n";
248 static const char GOPHER_RESPONSE[] =
249 "HTTP/1.1 400 Invalid request received from client\r\n"
250 "Content-Type: text/plain\r\n"
251 "Connection: close\r\n\r\n"
252 "Invalid request. Privoxy doesn't support gopher.\r\n";
254 /* XXX: should be a template */
255 static const char MISSING_DESTINATION_RESPONSE[] =
256 "HTTP/1.1 400 Bad request received from client\r\n"
257 "Content-Type: text/plain\r\n"
258 "Connection: close\r\n\r\n"
259 "Bad request. Privoxy was unable to extract the destination.\r\n";
261 /* XXX: should be a template */
262 static const char INVALID_SERVER_HEADERS_RESPONSE[] =
263 "HTTP/1.1 502 Server or forwarder response invalid\r\n"
264 "Content-Type: text/plain\r\n"
265 "Connection: close\r\n\r\n"
266 "Bad response. The server or forwarder response doesn't look like HTTP.\r\n";
268 /* XXX: should be a template */
269 static const char MESSED_UP_REQUEST_RESPONSE[] =
270 "HTTP/1.1 400 Malformed request after rewriting\r\n"
271 "Content-Type: text/plain\r\n"
272 "Connection: close\r\n\r\n"
273 "Bad request. Messed up with header filters.\r\n";
275 static const char TOO_MANY_CONNECTIONS_RESPONSE[] =
276 "HTTP/1.1 503 Too many open connections\r\n"
277 "Content-Type: text/plain\r\n"
278 "Connection: close\r\n\r\n"
279 "Maximum number of open connections reached.\r\n";
281 static const char CLIENT_CONNECTION_TIMEOUT_RESPONSE[] =
282 "HTTP/1.1 504 Connection timeout\r\n"
283 "Content-Type: text/plain\r\n"
284 "Connection: close\r\n\r\n"
285 "The connection timed out because the client request didn't arrive in time.\r\n";
287 static const char CLIENT_BODY_PARSE_ERROR_RESPONSE[] =
288 "HTTP/1.1 400 Failed reading client body\r\n"
289 "Content-Type: text/plain\r\n"
290 "Connection: close\r\n\r\n"
291 "Failed parsing or buffering the chunk-encoded client body.\r\n";
293 static const char UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE[] =
294 "HTTP/1.1 417 Expecting too much\r\n"
295 "Content-Type: text/plain\r\n"
296 "Connection: close\r\n\r\n"
297 "Privoxy detected an unsupported Expect header value.\r\n";
299 /* A function to crunch a response */
300 typedef struct http_response *(*crunch_func_ptr)(struct client_state *);
302 /* Crunch function flags */
303 #define CF_NO_FLAGS 0
304 /* Cruncher applies to forced requests as well */
305 #define CF_IGNORE_FORCE 1
306 /* Crunched requests are counted for the block statistics */
307 #define CF_COUNT_AS_REJECT 2
309 /* A crunch function and its flags */
312 const crunch_func_ptr cruncher;
316 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[]);
318 /* Complete list of cruncher functions */
319 static const struct cruncher crunchers_all[] = {
320 { direct_response, CF_COUNT_AS_REJECT|CF_IGNORE_FORCE},
321 { block_url, CF_COUNT_AS_REJECT },
323 { trust_url, CF_COUNT_AS_REJECT },
324 #endif /* def FEATURE_TRUST */
325 { redirect_url, CF_NO_FLAGS },
326 { dispatch_cgi, CF_IGNORE_FORCE},
330 /* Light version, used after tags are applied */
331 static const struct cruncher crunchers_light[] = {
332 { block_url, CF_COUNT_AS_REJECT },
333 { redirect_url, CF_NO_FLAGS },
339 * XXX: Don't we really mean
345 #if !defined(_WIN32) && !defined(__OS2__)
346 /*********************************************************************
348 * Function : sig_handler
350 * Description : Signal handler for different signals.
351 * Exit gracefully on TERM and INT
352 * or set a flag that will cause the errlog
353 * to be reopened by the main thread on HUP.
356 * 1 : the_signal = the signal cause this function to call
360 *********************************************************************/
361 static void sig_handler(int the_signal)
367 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
379 received_hup_signal = 1;
385 * We shouldn't be here, unless we catch signals
386 * in main() that we can't handle here!
388 log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
396 /*********************************************************************
398 * Function : get_write_delay
400 * Description : Parse the delay-response parameter.
403 * 1 : csp = Current client state (buffers, headers, etc...)
405 * Returns : Number of milliseconds to delay writes.
407 *********************************************************************/
408 static unsigned int get_write_delay(const struct client_state *csp)
414 if ((csp->action->flags & ACTION_DELAY_RESPONSE) == 0)
418 newval = csp->action->string[ACTION_STRING_DELAY_RESPONSE];
420 delay = (unsigned)strtol(newval, &endptr, 0);
423 log_error(LOG_LEVEL_FATAL,
424 "Invalid delay-response{} parameter: '%s'", newval);
432 /*********************************************************************
434 * Function : client_protocol_is_unsupported
436 * Description : Checks if the client used a known unsupported
437 * protocol and deals with it by sending an error
441 * 1 : csp = Current client state (buffers, headers, etc...)
442 * 2 : req = the first request line send by the client
444 * Returns : TRUE if an error response has been generated, or
445 * FALSE if the request doesn't look invalid.
447 *********************************************************************/
448 static int client_protocol_is_unsupported(struct client_state *csp, char *req)
451 * If it's a FTP or gopher request, we don't support it.
453 * These checks are better than nothing, but they might
454 * not work in all configurations and some clients might
455 * have problems digesting the answer.
457 * They should, however, never cause more problems than
458 * Privoxy's old behaviour (returning the misleading HTML
461 * "Could not resolve http://(ftp|gopher)://example.org").
463 if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
465 const char *response = NULL;
466 const char *protocol = NULL;
468 if (!strncmpic(req, "GET ftp://", 10))
470 response = FTP_RESPONSE;
475 response = GOPHER_RESPONSE;
478 log_error(LOG_LEVEL_ERROR,
479 "%s tried to use Privoxy as %s proxy: %s",
480 csp->ip_addr_str, protocol, req);
481 log_error(LOG_LEVEL_CLF,
482 "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, req);
485 #ifdef FEATURE_HTTPS_INSPECTION
486 if (client_use_ssl(csp))
488 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
489 (const unsigned char *)response, strlen(response));
494 write_socket_delayed(csp->cfd, response, strlen(response),
495 get_write_delay(csp));
505 /*********************************************************************
507 * Function : client_has_unsupported_expectations
509 * Description : Checks if the client used an unsupported expectation
510 * in which case an error message is delivered.
513 * 1 : csp = Current client state (buffers, headers, etc...)
515 * Returns : TRUE if an error response has been generated, or
516 * FALSE if the request doesn't look invalid.
518 *********************************************************************/
519 static int client_has_unsupported_expectations(const struct client_state *csp)
521 if ((csp->flags & CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION))
523 log_error(LOG_LEVEL_ERROR,
524 "Rejecting request from client %s with unsupported Expect header value",
526 log_error(LOG_LEVEL_CLF,
527 "%s - - [%T] \"%s\" 417 0", csp->ip_addr_str, csp->http->cmd);
528 write_socket_delayed(csp->cfd,
529 UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE,
530 strlen(UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE),
531 get_write_delay(csp));
541 /*********************************************************************
543 * Function : get_request_destination_elsewhere
545 * Description : If the client's request was redirected into
546 * Privoxy without the client's knowledge,
547 * the request line lacks the destination host.
549 * This function tries to get it elsewhere,
550 * provided accept-intercepted-requests is enabled.
552 * "Elsewhere" currently only means "Host: header",
553 * but in the future we may ask the redirecting
554 * packet filter to look the destination up.
556 * If the destination stays unknown, an error
557 * response is send to the client and headers
558 * are freed so that chat() can return directly.
561 * 1 : csp = Current client state (buffers, headers, etc...)
562 * 2 : headers = a header list
564 * Returns : JB_ERR_OK if the destination is now known, or
565 * JB_ERR_PARSE if it isn't.
567 *********************************************************************/
568 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
572 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
574 log_error(LOG_LEVEL_ERROR, "%s's request: \'%s\' is invalid."
575 " Privoxy isn't configured to accept intercepted requests.",
576 csp->ip_addr_str, csp->http->cmd);
577 /* XXX: Use correct size */
578 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
579 csp->ip_addr_str, csp->http->cmd);
581 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER),
582 get_write_delay(csp));
583 destroy_list(headers);
587 else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
589 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
590 /* Split the domain we just got for pattern matching */
591 init_domain_components(csp->http);
598 /* We can't work without destination. Go spread the news.*/
600 req = list_to_text(headers);
602 /* XXX: Use correct size */
603 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
604 csp->ip_addr_str, csp->http->cmd);
605 log_error(LOG_LEVEL_ERROR,
606 "Privoxy was unable to get the destination for %s's request:\n%s\n%s",
607 csp->ip_addr_str, csp->http->cmd, req);
610 write_socket_delayed(csp->cfd, MISSING_DESTINATION_RESPONSE,
611 strlen(MISSING_DESTINATION_RESPONSE), get_write_delay(csp));
612 destroy_list(headers);
617 * TODO: If available, use PF's ioctl DIOCNATLOOK as last resort
618 * to get the destination IP address, use it as host directly
619 * or do a reverse DNS lookup first.
624 /*********************************************************************
626 * Function : get_server_headers
628 * Description : Parses server headers in iob and fills them
629 * into csp->headers so that they can later be
633 * 1 : csp = Current client state (buffers, headers, etc...)
635 * Returns : JB_ERR_OK if everything went fine, or
636 * JB_ERR_PARSE if the headers were incomplete.
638 *********************************************************************/
639 static jb_err get_server_headers(struct client_state *csp)
641 int continue_hack_in_da_house = 0;
644 while (((header = get_header(csp->iob)) != NULL) || continue_hack_in_da_house)
649 * continue hack in da house. Ignore the ending of
650 * this head and continue enlisting header lines.
651 * The reason is described below.
653 enlist(csp->headers, "");
654 continue_hack_in_da_house = 0;
657 else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
660 * It's a bodyless continue response, don't
661 * stop header parsing after reaching its end.
663 * As a result Privoxy will concatenate the
664 * next response's head and parse and deliver
665 * the headers as if they belonged to one request.
667 * The client will separate them because of the
668 * empty line between them.
670 * XXX: What we're doing here is clearly against
671 * the intended purpose of the continue header,
672 * and under some conditions (HTTP/1.0 client request)
673 * it's a standard violation.
675 * Anyway, "sort of against the spec" is preferable
676 * to "always getting confused by Continue responses"
677 * (Privoxy's behaviour before this hack was added)
679 log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
680 continue_hack_in_da_house = 1;
682 else if (*header == '\0')
685 * If the header is empty, but the Continue hack
686 * isn't active, we can assume that we reached the
687 * end of the buffer before we hit the end of the
690 * Inform the caller an let it decide how to handle it.
695 if (JB_ERR_MEMORY == enlist(csp->headers, header))
698 * XXX: Should we quit the request and return a
699 * out of memory error page instead?
701 log_error(LOG_LEVEL_ERROR,
702 "Out of memory while enlisting server headers. %s lost.",
712 /*********************************************************************
714 * Function : crunch_reason
716 * Description : Translates the crunch reason code into a string.
719 * 1 : rsp = a http_response
721 * Returns : A string with the crunch reason or an error description.
723 *********************************************************************/
724 static const char *crunch_reason(const struct http_response *rsp)
726 char * reason = NULL;
731 return "Internal error while searching for crunch reason";
734 switch (rsp->crunch_reason)
737 reason = "Unsupported HTTP feature";
743 reason = "Untrusted";
746 reason = "Redirected";
752 reason = "DNS failure";
754 case FORWARDING_FAILED:
755 reason = "Forwarding failed";
758 reason = "Connection failure";
761 reason = "Out of memory (may mask other reasons)";
763 case CONNECTION_TIMEOUT:
764 reason = "Connection timeout";
767 reason = "No server data received";
770 reason = "No reason recorded";
778 /*********************************************************************
780 * Function : log_applied_actions
782 * Description : Logs the applied actions if LOG_LEVEL_ACTIONS is
786 * 1 : actions = Current action spec to log
790 *********************************************************************/
791 static void log_applied_actions(const struct current_action_spec *actions)
794 * The conversion to text requires lots of memory allocations so
795 * we only do the conversion if the user is actually interested.
797 if (debug_level_is_enabled(LOG_LEVEL_ACTIONS))
799 char *actions_as_text = actions_to_line_of_text(actions);
800 log_error(LOG_LEVEL_ACTIONS, "%s", actions_as_text);
801 freez(actions_as_text);
806 /*********************************************************************
808 * Function : send_crunch_response
810 * Description : Delivers already prepared response for
811 * intercepted requests, logs the interception
812 * and frees the response.
815 * 1 : csp = Current client state (buffers, headers, etc...)
816 * 2 : rsp = Fully prepared response. Will be freed on exit.
820 *********************************************************************/
821 static void send_crunch_response(struct client_state *csp, struct http_response *rsp)
823 const struct http_request *http = csp->http;
827 assert(rsp->head != NULL);
831 log_error(LOG_LEVEL_FATAL, "NULL response in send_crunch_response.");
835 * Extract the status code from the actual head
836 * that will be send to the client. It is the only
837 * way to get it right for all requests, including
838 * the fixed ones for out-of-memory problems.
840 * A head starts like this: 'HTTP/1.1 200...'
844 status_code[0] = rsp->head[9];
845 status_code[1] = rsp->head[10];
846 status_code[2] = rsp->head[11];
847 status_code[3] = '\0';
849 /* Log that the request was crunched and why. */
850 log_applied_actions(csp->action);
851 #ifdef FEATURE_HTTPS_INSPECTION
852 if (client_use_ssl(csp))
854 log_error(LOG_LEVEL_CRUNCH, "%s: https://%s%s", crunch_reason(rsp),
855 http->hostport, http->path);
856 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s https://%s%s %s\" %s %llu",
857 csp->ip_addr_str, http->gpc, http->hostport, http->path,
858 http->version, status_code, rsp->content_length);
863 log_error(LOG_LEVEL_CRUNCH, "%s: %s", crunch_reason(rsp), http->url);
864 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" %s %u",
865 csp->ip_addr_str, http->ocmd, status_code, rsp->content_length);
867 /* Write the answer to the client */
868 #ifdef FEATURE_HTTPS_INSPECTION
869 if (client_use_ssl(csp))
871 if ((ssl_send_data(&(csp->mbedtls_client_attr.ssl),
872 (const unsigned char *)rsp->head, rsp->head_length) < 0)
873 || (ssl_send_data(&(csp->mbedtls_client_attr.ssl),
874 (const unsigned char *)rsp->body, rsp->content_length) < 0))
876 /* There is nothing we can do about it. */
877 log_error(LOG_LEVEL_CONNECT, "Couldn't deliver the error message "
878 "for %s through client socket %d using TLS/SSL",
879 http->url, csp->cfd);
885 if (write_socket_delayed(csp->cfd, rsp->head, rsp->head_length,
886 get_write_delay(csp))
887 || write_socket_delayed(csp->cfd, rsp->body, rsp->content_length,
888 get_write_delay(csp)))
890 /* There is nothing we can do about it. */
891 log_error(LOG_LEVEL_CONNECT,
892 "Couldn't deliver the error message for %s through client socket %d: %E",
893 http->url, csp->cfd);
897 /* Clean up and return */
898 if (cgi_error_memory() != rsp)
900 free_http_response(rsp);
906 /*********************************************************************
908 * Function : crunch_response_triggered
910 * Description : Checks if the request has to be crunched,
911 * and delivers the crunch response if necessary.
914 * 1 : csp = Current client state (buffers, headers, etc...)
915 * 2 : crunchers = list of cruncher functions to run
917 * Returns : TRUE if the request was answered with a crunch response
920 *********************************************************************/
921 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[])
923 struct http_response *rsp = NULL;
924 const struct cruncher *c;
927 * If CGI request crunching is disabled,
928 * check the CGI dispatcher out of order to
929 * prevent unintentional blocks or redirects.
931 if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_CRUNCHING)
932 && (NULL != (rsp = dispatch_cgi(csp))))
934 /* Deliver, log and free the interception response. */
935 send_crunch_response(csp, rsp);
936 csp->flags |= CSP_FLAG_CRUNCHED;
940 for (c = crunchers; c->cruncher != NULL; c++)
943 * Check the cruncher if either Privoxy is toggled
944 * on and the request isn't forced, or if the cruncher
945 * applies to forced requests as well.
947 if (((csp->flags & CSP_FLAG_TOGGLED_ON) &&
948 !(csp->flags & CSP_FLAG_FORCED)) ||
949 (c->flags & CF_IGNORE_FORCE))
951 rsp = c->cruncher(csp);
954 /* Deliver, log and free the interception response. */
955 send_crunch_response(csp, rsp);
956 csp->flags |= CSP_FLAG_CRUNCHED;
957 #ifdef FEATURE_STATISTICS
958 if (c->flags & CF_COUNT_AS_REJECT)
960 csp->flags |= CSP_FLAG_REJECTED;
962 #endif /* def FEATURE_STATISTICS */
973 /*********************************************************************
975 * Function : build_request_line
977 * Description : Builds the HTTP request line.
979 * If a HTTP forwarder is used it expects the whole URL,
980 * web servers only get the path.
983 * 1 : csp = Current client state (buffers, headers, etc...)
984 * 2 : fwd = The forwarding spec used for the request
985 * XXX: Should use http->fwd instead.
986 * 3 : request_line = The old request line which will be replaced.
988 * Returns : Nothing. Terminates in case of memory problems.
990 *********************************************************************/
991 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line)
993 struct http_request *http = csp->http;
996 * Downgrade http version from 1.1 to 1.0
997 * if +downgrade action applies.
999 if ((csp->action->flags & ACTION_DOWNGRADE)
1000 && (!strcmpic(http->version, "HTTP/1.1")))
1002 freez(http->version);
1003 http->version = strdup_or_die("HTTP/1.0");
1007 * Rebuild the request line.
1009 freez(*request_line);
1010 *request_line = strdup(http->gpc);
1011 string_append(request_line, " ");
1013 if (fwd->forward_host && fwd->type != FORWARD_WEBSERVER)
1015 string_append(request_line, http->url);
1019 string_append(request_line, http->path);
1021 string_append(request_line, " ");
1022 string_append(request_line, http->version);
1024 if (*request_line == NULL)
1026 log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
1028 log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", *request_line);
1032 /*********************************************************************
1034 * Function : change_request_destination
1036 * Description : Parse a (rewritten) request line and regenerate
1037 * the http request data.
1040 * 1 : csp = Current client state (buffers, headers, etc...)
1042 * Returns : Forwards the parse_http_request() return code.
1043 * Terminates in case of memory problems.
1045 *********************************************************************/
1046 static jb_err change_request_destination(struct client_state *csp)
1048 struct http_request *http = csp->http;
1051 log_error(LOG_LEVEL_REDIRECTS, "Rewrite detected: %s",
1052 csp->headers->first->str);
1053 free_http_request(http);
1054 err = parse_http_request(csp->headers->first->str, http);
1055 if (JB_ERR_OK != err)
1057 log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
1058 jb_err_to_string(err));
1065 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1066 /*********************************************************************
1068 * Function : server_response_is_complete
1070 * Description : Determines whether we should stop reading
1071 * from the server socket.
1074 * 1 : csp = Current client state (buffers, headers, etc...)
1075 * 2 : content_length = Length of content received so far.
1077 * Returns : TRUE if the response is complete,
1080 *********************************************************************/
1081 static int server_response_is_complete(struct client_state *csp,
1082 unsigned long long content_length)
1084 int content_length_known = !!(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET);
1086 if (!strcmpic(csp->http->gpc, "HEAD"))
1089 * "HEAD" implies no body, we are thus expecting
1090 * no content. XXX: incomplete "list" of methods?
1092 csp->expected_content_length = 0;
1093 content_length_known = TRUE;
1094 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1097 if (csp->http->status == 204 || csp->http->status == 304)
1100 * Expect no body. XXX: incomplete "list" of status codes?
1102 csp->expected_content_length = 0;
1103 content_length_known = TRUE;
1104 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1107 return (content_length_known && ((0 == csp->expected_content_length)
1108 || (csp->expected_content_length <= content_length)));
1112 #ifdef FEATURE_CONNECTION_SHARING
1113 /*********************************************************************
1115 * Function : wait_for_alive_connections
1117 * Description : Waits for alive connections to timeout.
1123 *********************************************************************/
1124 static void wait_for_alive_connections(void)
1126 int connections_alive = close_unusable_connections();
1128 while (0 < connections_alive)
1130 log_error(LOG_LEVEL_CONNECT,
1131 "Waiting for %d connections to timeout.",
1134 connections_alive = close_unusable_connections();
1137 log_error(LOG_LEVEL_CONNECT, "No connections to wait for left.");
1140 #endif /* def FEATURE_CONNECTION_SHARING */
1143 /*********************************************************************
1145 * Function : save_connection_destination
1147 * Description : Remembers a connection for reuse later on.
1150 * 1 : sfd = Open socket to remember.
1151 * 2 : http = The destination for the connection.
1152 * 3 : fwd = The forwarder settings used.
1153 * 4 : server_connection = storage.
1157 *********************************************************************/
1158 void save_connection_destination(jb_socket sfd,
1159 const struct http_request *http,
1160 const struct forward_spec *fwd,
1161 struct reusable_connection *server_connection)
1163 assert(sfd != JB_INVALID_SOCKET);
1164 assert(NULL != http->host);
1166 server_connection->sfd = sfd;
1167 server_connection->host = strdup_or_die(http->host);
1168 server_connection->port = http->port;
1170 assert(NULL != fwd);
1171 assert(server_connection->gateway_host == NULL);
1172 assert(server_connection->gateway_port == 0);
1173 assert(server_connection->forwarder_type == 0);
1174 assert(server_connection->forward_host == NULL);
1175 assert(server_connection->forward_port == 0);
1177 server_connection->forwarder_type = fwd->type;
1178 if (NULL != fwd->gateway_host)
1180 server_connection->gateway_host = strdup_or_die(fwd->gateway_host);
1184 server_connection->gateway_host = NULL;
1186 server_connection->gateway_port = fwd->gateway_port;
1188 if (NULL != fwd->forward_host)
1190 server_connection->forward_host = strdup_or_die(fwd->forward_host);
1194 server_connection->forward_host = NULL;
1196 server_connection->forward_port = fwd->forward_port;
1200 /*********************************************************************
1202 * Function : verify_request_length
1204 * Description : Checks if we already got the whole client requests
1205 * and sets CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ if
1208 * Data that doesn't belong to the current request is
1209 * either thrown away to let the client retry on a clean
1210 * socket, or stashed to be dealt with after the current
1211 * request is served.
1214 * 1 : csp = Current client state (buffers, headers, etc...)
1218 *********************************************************************/
1219 static void verify_request_length(struct client_state *csp)
1221 unsigned long long buffered_request_bytes =
1222 (unsigned long long)(csp->client_iob->eod - csp->client_iob->cur);
1224 if ((csp->expected_client_content_length != 0)
1225 && (buffered_request_bytes != 0))
1227 if (csp->expected_client_content_length >= buffered_request_bytes)
1229 csp->expected_client_content_length -= buffered_request_bytes;
1230 log_error(LOG_LEVEL_CONNECT, "Reduced expected bytes to %llu "
1231 "to account for the %llu ones we already got.",
1232 csp->expected_client_content_length, buffered_request_bytes);
1236 assert(csp->client_iob->eod > csp->client_iob->cur + csp->expected_client_content_length);
1237 csp->client_iob->eod = csp->client_iob->cur + csp->expected_client_content_length;
1238 log_error(LOG_LEVEL_CONNECT, "Reducing expected bytes to 0. "
1239 "Marking the server socket tainted after throwing %llu bytes away.",
1240 buffered_request_bytes - csp->expected_client_content_length);
1241 csp->expected_client_content_length = 0;
1242 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1245 if (csp->expected_client_content_length == 0)
1247 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1251 if (!(csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ)
1252 && ((csp->client_iob->cur < csp->client_iob->eod)
1253 || (csp->expected_client_content_length != 0)))
1255 if (strcmpic(csp->http->gpc, "GET")
1256 && strcmpic(csp->http->gpc, "HEAD")
1257 && strcmpic(csp->http->gpc, "TRACE")
1258 && strcmpic(csp->http->gpc, "OPTIONS")
1259 && strcmpic(csp->http->gpc, "DELETE"))
1261 /* XXX: this is an incomplete hack */
1262 csp->flags &= ~CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1263 log_error(LOG_LEVEL_CONNECT, "There better be a request body.");
1267 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1269 if ((csp->config->feature_flags & RUNTIME_FEATURE_TOLERATE_PIPELINING) == 0)
1271 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1272 log_error(LOG_LEVEL_CONNECT,
1273 "Possible pipeline attempt detected. The connection will not "
1274 "be kept alive and we will only serve the first request.");
1275 /* Nuke the pipelined requests from orbit, just to be sure. */
1276 clear_iob(csp->client_iob);
1281 * Keep the pipelined data around for now, we'll deal with
1282 * it once we're done serving the current request.
1284 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
1285 assert(csp->client_iob->eod >= csp->client_iob->cur);
1286 log_error(LOG_LEVEL_CONNECT, "Complete client request followed by "
1287 "%d bytes of pipelined data received.",
1288 (int)(csp->client_iob->eod - csp->client_iob->cur));
1294 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1295 log_error(LOG_LEVEL_CONNECT, "Complete client request received.");
1298 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1301 /*********************************************************************
1303 * Function : mark_server_socket_tainted
1305 * Description : Makes sure we don't reuse a server socket
1306 * (if we didn't read everything the server sent
1307 * us reusing the socket would lead to garbage).
1310 * 1 : csp = Current client state (buffers, headers, etc...)
1314 *********************************************************************/
1315 static void mark_server_socket_tainted(struct client_state *csp)
1318 * For consistency we always mark the server socket
1319 * tainted, however, to reduce the log noise we only
1320 * emit a log message if the server socket could have
1321 * actually been reused.
1323 if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
1324 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED))
1326 log_error(LOG_LEVEL_CONNECT,
1327 "Marking the server socket %d tainted.",
1328 csp->server_connection.sfd);
1330 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1333 /*********************************************************************
1335 * Function : get_request_line
1337 * Description : Read the client request line.
1340 * 1 : csp = Current client state (buffers, headers, etc...)
1342 * Returns : Pointer to request line or NULL in case of errors.
1344 *********************************************************************/
1345 static char *get_request_line(struct client_state *csp)
1347 char buf[BUFFER_SIZE];
1348 char *request_line = NULL;
1351 memset(buf, 0, sizeof(buf));
1353 if ((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
1356 * If there are multiple pipelined requests waiting,
1357 * the flag will be set again once the next request
1360 csp->flags &= ~CSP_FLAG_PIPELINED_REQUEST_WAITING;
1362 request_line = get_header(csp->client_iob);
1363 if ((NULL != request_line) && ('\0' != *request_line))
1365 return request_line;
1369 log_error(LOG_LEVEL_CONNECT, "No complete request line "
1370 "received yet. Continuing reading from %d.", csp->cfd);
1378 0 == (csp->flags & CSP_FLAG_FUZZED_INPUT) &&
1380 !data_is_available(csp->cfd, csp->config->socket_timeout)
1383 if (socket_is_still_alive(csp->cfd))
1385 log_error(LOG_LEVEL_CONNECT,
1386 "No request line on socket %d received in time. Timeout: %d.",
1387 csp->cfd, csp->config->socket_timeout);
1388 write_socket_delayed(csp->cfd, CLIENT_CONNECTION_TIMEOUT_RESPONSE,
1389 strlen(CLIENT_CONNECTION_TIMEOUT_RESPONSE),
1390 get_write_delay(csp));
1394 log_error(LOG_LEVEL_CONNECT,
1395 "The client side of the connection on socket %d got "
1396 "closed without sending a complete request line.", csp->cfd);
1401 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1403 if (len <= 0) return NULL;
1406 * If there is no memory left for buffering the
1407 * request, there is nothing we can do but hang up
1409 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1414 request_line = get_header(csp->client_iob);
1416 } while ((NULL != request_line) && ('\0' == *request_line));
1418 return request_line;
1424 CHUNK_STATUS_MISSING_DATA,
1425 CHUNK_STATUS_BODY_COMPLETE,
1426 CHUNK_STATUS_PARSE_ERROR
1430 /*********************************************************************
1432 * Function : chunked_body_is_complete
1434 * Description : Figures out whether or not a chunked body is complete.
1436 * Currently it always starts at the beginning of the
1437 * buffer which is somewhat wasteful and prevents Privoxy
1438 * from starting to forward the correctly parsed chunks
1439 * as soon as theoretically possible.
1441 * Should be modified to work with a common buffer,
1442 * and allow the caller to skip already parsed chunks.
1444 * This would allow the function to be used for unbuffered
1445 * response bodies as well.
1448 * 1 : iob = Buffer with the body to check.
1449 * 2 : length = Length of complete body
1451 * Returns : Enum with the result of the check.
1453 *********************************************************************/
1454 static enum chunk_status chunked_body_is_complete(struct iob *iob, size_t *length)
1456 unsigned int chunksize;
1462 * We need at least a single digit, followed by "\r\n",
1463 * followed by an unknown amount of data, followed by "\r\n".
1465 if (p + 5 > iob->eod)
1467 return CHUNK_STATUS_MISSING_DATA;
1469 if (sscanf(p, "%x", &chunksize) != 1)
1471 return CHUNK_STATUS_PARSE_ERROR;
1475 * We want at least a single digit, followed by "\r\n",
1476 * followed by the specified amount of data, followed by "\r\n".
1478 if (p + chunksize + 5 > iob->eod)
1480 return CHUNK_STATUS_MISSING_DATA;
1483 /* Skip chunk-size. */
1484 p = strstr(p, "\r\n");
1487 return CHUNK_STATUS_PARSE_ERROR;
1489 /* Move beyond the chunkdata. */
1492 /* There should be another "\r\n" to skip */
1493 if (memcmp(p, "\r\n", 2))
1495 return CHUNK_STATUS_PARSE_ERROR;
1498 } while (chunksize > 0U);
1500 *length = (size_t)(p - iob->cur);
1501 assert(*length <= (size_t)(iob->eod - iob->cur));
1502 assert(p <= iob->eod);
1504 return CHUNK_STATUS_BODY_COMPLETE;
1509 /*********************************************************************
1511 * Function : receive_chunked_client_request_body
1513 * Description : Read the chunk-encoded client request body.
1514 * Failures are dealt with.
1517 * 1 : csp = Current client state (buffers, headers, etc...)
1519 * Returns : JB_ERR_OK or JB_ERR_PARSE
1521 *********************************************************************/
1522 static jb_err receive_chunked_client_request_body(struct client_state *csp)
1525 enum chunk_status status;
1527 while (CHUNK_STATUS_MISSING_DATA ==
1528 (status = chunked_body_is_complete(csp->client_iob, &body_length)))
1530 char buf[BUFFER_SIZE];
1533 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1535 log_error(LOG_LEVEL_ERROR,
1536 "Timeout while waiting for the client body.");
1539 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1542 log_error(LOG_LEVEL_ERROR, "Read the client body failed: %E");
1545 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1550 if (status != CHUNK_STATUS_BODY_COMPLETE)
1552 write_socket_delayed(csp->cfd, CLIENT_BODY_PARSE_ERROR_RESPONSE,
1553 strlen(CLIENT_BODY_PARSE_ERROR_RESPONSE), get_write_delay(csp));
1554 log_error(LOG_LEVEL_CLF,
1555 "%s - - [%T] \"Failed reading chunked client body\" 400 0", csp->ip_addr_str);
1556 return JB_ERR_PARSE;
1558 log_error(LOG_LEVEL_CONNECT,
1559 "Chunked client body completely read. Length: %d", body_length);
1560 csp->expected_client_content_length = body_length;
1568 /*********************************************************************
1570 * Function : fuzz_chunked_transfer_encoding
1572 * Description : Treat the fuzzed input as chunked transfer encoding
1573 * to check and dechunk.
1576 * 1 : csp = Used to store the data.
1577 * 2 : fuzz_input_file = File to read the input from.
1579 * Returns : Result of dechunking
1581 *********************************************************************/
1582 extern int fuzz_chunked_transfer_encoding(struct client_state *csp, char *fuzz_input_file)
1585 size_t size = (size_t)(csp->iob->eod - csp->iob->cur);
1586 enum chunk_status status;
1588 status = chunked_body_is_complete(csp->iob, &length);
1589 if (CHUNK_STATUS_BODY_COMPLETE != status)
1591 log_error(LOG_LEVEL_INFO, "Chunked body is incomplete or invalid");
1594 return (JB_ERR_OK == remove_chunked_transfer_coding(csp->iob->cur, &size));
1599 /*********************************************************************
1601 * Function : fuzz_client_request
1603 * Description : Try to get a client request from the fuzzed input.
1606 * 1 : csp = Current client state (buffers, headers, etc...)
1607 * 2 : fuzz_input_file = File to read the input from.
1609 * Returns : Result of fuzzing.
1611 *********************************************************************/
1612 extern int fuzz_client_request(struct client_state *csp, char *fuzz_input_file)
1617 csp->ip_addr_str = "fuzzer";
1619 if (strcmp(fuzz_input_file, "-") != 0)
1621 log_error(LOG_LEVEL_FATAL,
1622 "Fuzzed client requests can currently only be read from stdin (-).");
1624 err = receive_client_request(csp);
1625 if (err != JB_ERR_OK)
1629 err = parse_client_request(csp);
1630 if (err != JB_ERR_OK)
1638 #endif /* def FUZZ */
1641 #ifdef FEATURE_FORCE_LOAD
1642 /*********************************************************************
1644 * Function : force_required
1646 * Description : Checks a request line to see if it contains
1647 * the FORCE_PREFIX. If it does, it is removed
1648 * unless enforcing requests has beend disabled.
1651 * 1 : request_line = HTTP request line
1653 * Returns : TRUE if force is required, FALSE otherwise.
1655 *********************************************************************/
1656 static int force_required(const struct client_state *csp, char *request_line)
1660 p = strstr(request_line, "http://");
1664 p += strlen("http://");
1668 /* Intercepted request usually don't specify the protocol. */
1672 /* Go to the beginning of the path */
1677 * If the path is missing the request line is invalid and we
1678 * are done here. The client-visible rejection happens later on.
1683 if (0 == strncmpic(p, FORCE_PREFIX, strlen(FORCE_PREFIX) - 1))
1685 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS))
1687 /* XXX: Should clean more carefully */
1688 strclean(request_line, FORCE_PREFIX);
1689 log_error(LOG_LEVEL_FORCE,
1690 "Enforcing request: \"%s\".", request_line);
1694 log_error(LOG_LEVEL_FORCE,
1695 "Ignored force prefix in request: \"%s\".", request_line);
1701 #endif /* def FEATURE_FORCE_LOAD */
1704 /*********************************************************************
1706 * Function : receive_client_request
1708 * Description : Read the client's request (more precisely the
1709 * client headers) and answer it if necessary.
1712 * 1 : csp = Current client state (buffers, headers, etc...)
1714 * Returns : JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
1716 *********************************************************************/
1717 static jb_err receive_client_request(struct client_state *csp)
1719 char buf[BUFFER_SIZE];
1722 struct http_request *http;
1726 /* Temporary copy of the client's headers before they get enlisted in csp->headers */
1727 struct list header_list;
1728 struct list *headers = &header_list;
1730 /* We don't care if the arriving data is a valid HTTP request or not. */
1731 csp->requests_received_total++;
1735 memset(buf, 0, sizeof(buf));
1737 req = get_request_line(csp);
1740 mark_server_socket_tainted(csp);
1741 return JB_ERR_PARSE;
1743 assert(*req != '\0');
1745 if (client_protocol_is_unsupported(csp, req))
1747 return JB_ERR_PARSE;
1750 #ifdef FEATURE_FORCE_LOAD
1751 if (force_required(csp, req))
1753 csp->flags |= CSP_FLAG_FORCED;
1755 #endif /* def FEATURE_FORCE_LOAD */
1757 err = parse_http_request(req, http);
1759 if (JB_ERR_OK != err)
1761 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER),
1762 get_write_delay(csp));
1763 /* XXX: Use correct size */
1764 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1765 log_error(LOG_LEVEL_ERROR,
1766 "Couldn't parse request line received from %s: %s",
1767 csp->ip_addr_str, jb_err_to_string(err));
1769 free_http_request(http);
1770 return JB_ERR_PARSE;
1773 /* grab the rest of the client's headers */
1777 p = get_header(csp->client_iob);
1781 /* There are no additional headers to read. */
1788 * We didn't receive a complete header
1789 * line yet, get the rest of it.
1791 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1793 log_error(LOG_LEVEL_ERROR,
1794 "Stopped grabbing the client headers.");
1795 destroy_list(headers);
1796 return JB_ERR_PARSE;
1799 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1802 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1803 destroy_list(headers);
1804 return JB_ERR_PARSE;
1807 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1810 * If there is no memory left for buffering the
1811 * request, there is nothing we can do but hang up
1813 destroy_list(headers);
1814 return JB_ERR_MEMORY;
1819 if (!strncmpic(p, "Transfer-Encoding:", 18))
1822 * XXX: should be called through sed()
1823 * but currently can't.
1825 client_transfer_encoding(csp, &p);
1828 * We were able to read a complete
1829 * header and can finally enlist it.
1836 if (http->host == NULL)
1839 * If we still don't know the request destination,
1840 * the request is invalid or the client uses
1841 * Privoxy without its knowledge.
1843 if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
1846 * Our attempts to get the request destination
1847 * elsewhere failed or Privoxy is configured
1848 * to only accept proxy requests.
1850 * An error response has already been send
1851 * and we're done here.
1853 return JB_ERR_PARSE;
1857 #ifdef FEATURE_CLIENT_TAGS
1858 /* XXX: If the headers were enlisted sooner, passing csp would do. */
1859 set_client_address(csp, headers);
1860 get_tag_list_for_client(csp->client_tags, csp->client_address);
1864 * Determine the actions for this URL
1866 #ifdef FEATURE_TOGGLE
1867 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
1869 /* Most compatible set of actions (i.e. none) */
1870 init_current_action(csp->action);
1873 #endif /* ndef FEATURE_TOGGLE */
1875 get_url_actions(csp, http);
1878 enlist(csp->headers, http->cmd);
1880 /* Append the previously read headers */
1881 err = list_append_list_unique(csp->headers, headers);
1882 destroy_list(headers);
1889 /*********************************************************************
1891 * Function : parse_client_request
1893 * Description : Parses the client's request and decides what to do
1896 * Note that since we're not using select() we could get
1897 * blocked here if a client connected, then didn't say
1901 * 1 : csp = Current client state (buffers, headers, etc...)
1903 * Returns : JB_ERR_OK or JB_ERR_PARSE
1905 *********************************************************************/
1906 static jb_err parse_client_request(struct client_state *csp)
1908 struct http_request *http = csp->http;
1911 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1912 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
1913 && (!strcmpic(csp->http->version, "HTTP/1.1"))
1914 && (csp->http->ssl == 0))
1916 /* Assume persistence until further notice */
1917 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1920 if (csp->http->ssl == 0)
1923 * This whole block belongs to chat() but currently
1924 * has to be executed before sed().
1926 if (csp->flags & CSP_FLAG_CHUNKED_CLIENT_BODY)
1928 if (receive_chunked_client_request_body(csp) != JB_ERR_OK)
1930 return JB_ERR_PARSE;
1935 csp->expected_client_content_length = get_expected_content_length(csp->headers);
1937 verify_request_length(csp);
1941 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1943 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1945 err = sed(csp, FILTER_CLIENT_HEADERS);
1946 if (JB_ERR_OK != err)
1948 log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
1950 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
1951 csp->ip_addr_str, csp->http->cmd);
1952 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER), get_write_delay(csp));
1953 return JB_ERR_PARSE;
1955 csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
1957 /* Check request line for rewrites. */
1958 if ((NULL == csp->headers->first->str)
1959 || (strcmp(http->cmd, csp->headers->first->str) &&
1960 (JB_ERR_OK != change_request_destination(csp))))
1963 * A header filter broke the request line - bail out.
1965 write_socket_delayed(csp->cfd, MESSED_UP_REQUEST_RESPONSE,
1966 strlen(MESSED_UP_REQUEST_RESPONSE), get_write_delay(csp));
1967 /* XXX: Use correct size */
1968 log_error(LOG_LEVEL_CLF,
1969 "%s - - [%T] \"Invalid request generated\" 500 0", csp->ip_addr_str);
1970 log_error(LOG_LEVEL_ERROR,
1971 "Invalid request line after applying header filters.");
1972 free_http_request(http);
1974 return JB_ERR_PARSE;
1977 if (client_has_unsupported_expectations(csp))
1979 return JB_ERR_PARSE;
1987 /*********************************************************************
1989 * Function : send_http_request
1991 * Description : Sends the HTTP headers from the client request
1992 * and all the body data that has already been received.
1995 * 1 : csp = Current client state (buffers, headers, etc...)
1997 * Returns : 0 on success, anything else is an error.
1999 *********************************************************************/
2000 static int send_http_request(struct client_state *csp)
2005 hdr = list_to_text(csp->headers);
2008 /* FIXME Should handle error properly */
2009 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
2011 list_remove_all(csp->headers);
2014 * Write the client's (modified) header to the server
2015 * (along with anything else that may be in the buffer)
2017 write_failure = 0 != write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
2022 log_error(LOG_LEVEL_CONNECT, "Failed sending request headers to: %s: %E",
2023 csp->http->hostport);
2025 else if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
2026 && (flush_iob(csp->server_connection.sfd, csp->client_iob, 0) < 0))
2029 log_error(LOG_LEVEL_CONNECT, "Failed sending request body to: %s: %E",
2030 csp->http->hostport);
2033 return write_failure;
2038 #ifdef FEATURE_HTTPS_INSPECTION
2039 /*********************************************************************
2041 * Function : receive_and_send_encrypted_post_data
2043 * Description : Reads remaining POST data from the client and sends
2047 * 1 : csp = Current client state (buffers, headers, etc...)
2049 * Returns : 0 on success, anything else is an error.
2051 *********************************************************************/
2052 static int receive_and_send_encrypted_post_data(struct client_state *csp)
2054 int content_length_known = csp->expected_client_content_length != 0;
2056 while (is_ssl_pending(&(csp->mbedtls_client_attr.ssl))
2057 || (content_length_known && csp->expected_client_content_length != 0))
2059 unsigned char buf[BUFFER_SIZE];
2061 int max_bytes_to_read = sizeof(buf);
2063 if (content_length_known && csp->expected_client_content_length < sizeof(buf))
2065 max_bytes_to_read = (int)csp->expected_client_content_length;
2067 log_error(LOG_LEVEL_CONNECT,
2068 "Waiting for up to %d bytes of POST data from the client.",
2070 len = ssl_recv_data(&(csp->mbedtls_client_attr.ssl), buf,
2071 (unsigned)max_bytes_to_read);
2078 /* XXX: Does this actually happen? */
2081 log_error(LOG_LEVEL_CONNECT, "Forwarding %d bytes of encrypted POST data",
2083 len = ssl_send_data(&(csp->mbedtls_server_attr.ssl), buf, (size_t)len);
2088 if (csp->expected_client_content_length != 0)
2090 if (csp->expected_client_content_length >= len)
2092 csp->expected_client_content_length -= (unsigned)len;
2094 if (csp->expected_client_content_length == 0)
2096 log_error(LOG_LEVEL_CONNECT, "Forwarded the last %d bytes", len);
2102 log_error(LOG_LEVEL_CONNECT, "Done forwarding encrypted POST data");
2109 /*********************************************************************
2111 * Function : send_https_request
2113 * Description : Sends the HTTP headers from the client request
2114 * and all the body data that has already been received.
2117 * 1 : csp = Current client state (buffers, headers, etc...)
2119 * Returns : 0 on success, anything else is an error.
2121 *********************************************************************/
2122 static int send_https_request(struct client_state *csp)
2128 hdr = list_to_text(csp->https_headers);
2131 /* FIXME Should handle error properly */
2132 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
2134 list_remove_all(csp->https_headers);
2137 * Write the client's (modified) header to the server
2138 * (along with anything else that may be in the buffer)
2140 ret = ssl_send_data(&(csp->mbedtls_server_attr.ssl),
2141 (const unsigned char *)hdr, strlen(hdr));
2146 log_error(LOG_LEVEL_CONNECT,
2147 "Failed sending encrypted request headers to: %s: %E",
2148 csp->http->hostport);
2149 mark_server_socket_tainted(csp);
2153 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
2154 && ((flushed = ssl_flush_socket(&(csp->mbedtls_server_attr.ssl),
2155 csp->client_iob)) < 0))
2157 log_error(LOG_LEVEL_CONNECT, "Failed sending request body to: %s: %E",
2158 csp->http->hostport);
2163 if (csp->expected_client_content_length != 0)
2165 if (csp->expected_client_content_length < flushed)
2167 log_error(LOG_LEVEL_ERROR,
2168 "Flushed %d bytes of request body while only expecting %llu",
2169 flushed, csp->expected_client_content_length);
2170 csp->expected_client_content_length = 0;
2174 log_error(LOG_LEVEL_CONNECT,
2175 "Flushed %d bytes of request body while expecting %llu",
2176 flushed, csp->expected_client_content_length);
2177 csp->expected_client_content_length -= (unsigned)flushed;
2178 if (receive_and_send_encrypted_post_data(csp))
2186 log_error(LOG_LEVEL_CONNECT,
2187 "Flushed %d bytes of request body", flushed);
2191 log_error(LOG_LEVEL_CONNECT, "Encrypted request sent");
2198 /*********************************************************************
2200 * Function : receive_encrypted_request
2202 * Description : Receives an encrypted request.
2205 * 1 : csp = Current client state (buffers, headers, etc...)
2207 * Returns : JB_ERR_OK on success,
2208 * JB_ERR_PARSE or JB_ERR_MEMORY otherwise
2210 *********************************************************************/
2211 static jb_err receive_encrypted_request(struct client_state *csp)
2213 char buf[BUFFER_SIZE];
2219 log_error(LOG_LEVEL_HEADER, "Reading encrypted headers");
2220 if (!data_is_available(csp->cfd, (int)csp->config->keep_alive_timeout))
2222 log_error(LOG_LEVEL_CONNECT,
2223 "Socket %d timed out while waiting for client headers", csp->cfd);
2224 return JB_ERR_PARSE;
2226 len = ssl_recv_data(&(csp->mbedtls_client_attr.ssl),
2227 (unsigned char *)buf, sizeof(buf));
2230 return JB_ERR_PARSE;
2232 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
2234 return JB_ERR_MEMORY;
2236 p = strstr(csp->client_iob->cur, "\r\n\r\n");
2237 } while (p == NULL);
2239 log_error(LOG_LEVEL_HEADER, "Encrypted headers received completely");
2245 /*********************************************************************
2247 * Function : process_encrypted_request
2249 * Description : Receives and parses an encrypted request.
2252 * 1 : csp = Current client state (buffers, headers, etc...)
2254 * Returns : JB_ERR_OK on success,
2255 * JB_ERR_PARSE or JB_ERR_MEMORY otherwise
2257 *********************************************************************/
2258 static jb_err process_encrypted_request(struct client_state *csp)
2263 /* Temporary copy of the client's headers before they get enlisted in csp->https_headers */
2264 struct list header_list;
2265 struct list *headers = &header_list;
2267 err = receive_encrypted_request(csp);
2268 if (err != JB_ERR_OK)
2270 /* XXX: Also used for JB_ERR_MEMORY */
2271 log_error(LOG_LEVEL_ERROR, "Failed to receive encrypted request: %s",
2272 jb_err_to_string(err));
2273 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2274 (const unsigned char *)CHEADER, strlen(CHEADER));
2278 /* We don't need get_request_line() because the whole HTTP head is buffered. */
2279 request_line = get_header(csp->client_iob);
2280 if (request_line == NULL)
2282 log_error(LOG_LEVEL_ERROR, "Failed to get the encrypted request line");
2283 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2284 (const unsigned char *)CHEADER, strlen(CHEADER));
2285 return JB_ERR_PARSE;
2287 assert(*request_line != '\0');
2289 if (client_protocol_is_unsupported(csp, request_line))
2292 * If the protocol is unsupported we're done here.
2293 * client_protocol_is_unsupported() took care of sending
2294 * the error response and logging the error message.
2296 return JB_ERR_PARSE;
2299 #ifdef FEATURE_FORCE_LOAD
2300 if (force_required(csp, request_line))
2302 csp->flags |= CSP_FLAG_FORCED;
2304 #endif /* def FEATURE_FORCE_LOAD */
2306 free_http_request(csp->http);
2308 err = parse_http_request(request_line, csp->http);
2309 /* XXX: Restore ssl setting. This is ugly */
2310 csp->http->client_ssl = 1;
2311 csp->http->server_ssl = 1;
2313 freez(request_line);
2314 if (JB_ERR_OK != err)
2316 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2317 (const unsigned char *)CHEADER, strlen(CHEADER));
2318 /* XXX: Use correct size */
2319 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
2320 log_error(LOG_LEVEL_ERROR,
2321 "Couldn't parse request line received from %s: %s",
2322 csp->ip_addr_str, jb_err_to_string(err));
2324 free_http_request(csp->http);
2325 return JB_ERR_PARSE;
2328 /* Parse the rest of the client's headers. */
2332 p = get_header(csp->client_iob);
2336 /* There are no additional headers to read. */
2343 if (JB_ERR_OK != get_destination_from_https_headers(headers, csp->http))
2346 * Our attempts to get the request destination
2349 log_error(LOG_LEVEL_ERROR,
2350 "Failed to get the encrypted request destination");
2351 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2352 (const unsigned char *)CHEADER, strlen(CHEADER));
2353 return JB_ERR_PARSE;
2356 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
2357 /* Split the domain we just got for pattern matching */
2358 init_domain_components(csp->http);
2361 #ifdef FEATURE_TOGGLE
2362 if ((csp->flags & CSP_FLAG_TOGGLED_ON) != 0)
2365 /* Determine the actions for this URL */
2366 get_url_actions(csp, csp->http);
2369 enlist(csp->https_headers, csp->http->cmd);
2371 /* Append the previously read headers */
2372 err = list_append_list_unique(csp->https_headers, headers);
2373 destroy_list(headers);
2374 if (JB_ERR_OK != err)
2376 /* XXX: Send error message */
2380 /* XXX: Work around crash */
2381 csp->error_message = NULL;
2383 /* XXX: Why do this here? */
2386 err = sed_https(csp);
2387 if (JB_ERR_OK != err)
2389 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2390 (const unsigned char *)CHEADER, strlen(CHEADER));
2391 log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
2393 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
2394 csp->ip_addr_str, csp->http->cmd);
2395 return JB_ERR_PARSE;
2398 log_error(LOG_LEVEL_HEADER, "Encrypted request processed");
2399 log_applied_actions(csp->action);
2400 log_error(LOG_LEVEL_GPC, "https://%s%s", csp->http->hostport,
2407 /*********************************************************************
2409 * Function : cgi_page_requested
2411 * Description : Checks if a request is for an internal CGI page.
2414 * 1 : host = The host requested by the client.
2416 * Returns : 1 if a CGI page has been requested, 0 otherwise
2418 *********************************************************************/
2419 static int cgi_page_requested(const char *host)
2421 if ((0 == strcmpic(host, CGI_SITE_1_HOST))
2422 || (0 == strcmpic(host, CGI_SITE_1_HOST "."))
2423 || (0 == strcmpic(host, CGI_SITE_2_HOST))
2424 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")))
2436 /*********************************************************************
2438 * Function : handle_established_connection
2440 * Description : Shuffle data between client and server once the
2441 * connection has been established.
2444 * 1 : csp = Current client state (buffers, headers, etc...)
2446 * Returns : Nothing.
2448 *********************************************************************/
2449 static void handle_established_connection(struct client_state *csp)
2455 struct pollfd poll_fds[2];
2459 struct timeval timeout;
2462 int ms_iis5_hack = 0;
2463 unsigned long long byte_count = 0;
2464 struct http_request *http;
2465 long len = 0; /* for buffer sizes (and negative error codes) */
2466 int buffer_and_filter_content = 0;
2467 unsigned int write_delay;
2468 #ifdef FEATURE_HTTPS_INSPECTION
2470 int use_ssl_tunnel = 0;
2471 csp->dont_verify_certificate = 0;
2473 if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION))
2475 /* Pass encrypted content without filtering. */
2480 /* Skeleton for HTTP response, if we should intercept the request */
2481 struct http_response *rsp;
2482 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2483 int watch_client_socket;
2486 csp->receive_buffer_size = csp->config->receive_buffer_size;
2487 csp->receive_buffer = zalloc(csp->receive_buffer_size + 1);
2488 if (csp->receive_buffer == NULL)
2490 log_error(LOG_LEVEL_ERROR,
2491 "Out of memory. Failed to allocate the receive buffer.");
2492 rsp = cgi_error_memory();
2493 send_crunch_response(csp, rsp);
2500 maxfd = (csp->cfd > csp->server_connection.sfd) ?
2501 csp->cfd : csp->server_connection.sfd;
2504 /* pass data between the client and server
2505 * until one or the other shuts down the connection.
2510 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2511 watch_client_socket = 0 == (csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING);
2513 write_delay = get_write_delay(csp);
2520 * FD_ZERO here seems to point to an errant macro which crashes.
2521 * So do this by hand for now...
2523 memset(&rfds,0x00,sizeof(fd_set));
2527 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2528 if (!watch_client_socket)
2530 maxfd = csp->server_connection.sfd;
2533 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2535 FD_SET(csp->cfd, &rfds);
2538 FD_SET(csp->server_connection.sfd, &rfds);
2539 #endif /* ndef HAVE_POLL */
2541 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2542 if ((csp->flags & CSP_FLAG_CHUNKED)
2543 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2544 && ((csp->iob->eod - csp->iob->cur) >= 5)
2545 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
2548 * XXX: This check should be obsolete now,
2549 * but let's wait a while to be sure.
2551 log_error(LOG_LEVEL_CONNECT,
2552 "Looks like we got the last chunk together with "
2553 "the server headers but didn't detect it earlier. "
2554 "We better stop reading.");
2555 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2556 csp->expected_content_length = byte_count;
2557 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2559 if (server_body && server_response_is_complete(csp, byte_count))
2561 if (csp->expected_content_length == byte_count)
2563 log_error(LOG_LEVEL_CONNECT,
2564 "Done reading from server. Content length: %llu as expected. "
2565 "Bytes most recently read: %d.",
2570 log_error(LOG_LEVEL_CONNECT,
2571 "Done reading from server. Expected content length: %llu. "
2572 "Actual content length: %llu. Bytes most recently read: %d.",
2573 csp->expected_content_length, byte_count, len);
2577 * XXX: Should not jump around, handle_established_connection()
2578 * is complicated enough already.
2582 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2585 poll_fds[0].fd = csp->cfd;
2586 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2587 if (!watch_client_socket)
2590 * Ignore incoming data, but still watch out
2591 * for disconnects etc. These flags are always
2592 * implied anyway but explicitly setting them
2595 poll_fds[0].events = POLLERR|POLLHUP;
2600 poll_fds[0].events = POLLIN;
2602 poll_fds[1].fd = csp->server_connection.sfd;
2603 poll_fds[1].events = POLLIN;
2604 n = poll(poll_fds, 2, csp->config->socket_timeout * 1000);
2606 timeout.tv_sec = csp->config->socket_timeout;
2607 timeout.tv_usec = 0;
2608 n = select((int)maxfd + 1, &rfds, NULL, NULL, &timeout);
2609 #endif /* def HAVE_POLL */
2611 /*server or client not responding in timeout */
2614 log_error(LOG_LEVEL_CONNECT, "Socket timeout %d reached: %s",
2615 csp->config->socket_timeout, http->url);
2616 if ((byte_count == 0) && (http->ssl == 0))
2618 send_crunch_response(csp, error_response(csp, "connection-timeout"));
2620 mark_server_socket_tainted(csp);
2621 #ifdef FEATURE_HTTPS_INSPECTION
2622 close_client_and_server_ssl_connections(csp);
2629 log_error(LOG_LEVEL_ERROR, "poll() failed!: %E");
2631 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
2633 mark_server_socket_tainted(csp);
2634 #ifdef FEATURE_HTTPS_INSPECTION
2635 close_client_and_server_ssl_connections(csp);
2641 * This is the body of the browser's request,
2642 * just read and write it.
2644 * Receives data from browser and sends it to server
2646 * XXX: Make sure the client doesn't use pipelining
2647 * behind Privoxy's back.
2650 if ((poll_fds[0].revents & (POLLERR|POLLHUP|POLLNVAL)) != 0)
2652 log_error(LOG_LEVEL_CONNECT,
2653 "The client socket %d has become unusable while "
2654 "the server socket %d is still open.",
2655 csp->cfd, csp->server_connection.sfd);
2656 mark_server_socket_tainted(csp);
2660 if (poll_fds[0].revents != 0)
2662 if (FD_ISSET(csp->cfd, &rfds))
2663 #endif /* def HAVE_POLL*/
2665 int max_bytes_to_read = (int)csp->receive_buffer_size;
2667 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2668 if ((csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ))
2670 if (data_is_available(csp->cfd, 0))
2673 * If the next request is already waiting, we have
2674 * to stop select()ing the client socket. Otherwise
2675 * we would always return right away and get nothing
2678 watch_client_socket = 0;
2679 log_error(LOG_LEVEL_CONNECT,
2680 "Stop watching client socket %d. "
2681 "There's already another request waiting.",
2686 * If the client socket is set, but there's no data
2687 * available on the socket, the client went fishing
2688 * and continuing talking to the server makes no sense.
2690 log_error(LOG_LEVEL_CONNECT,
2691 "The client closed socket %d while "
2692 "the server socket %d is still open.",
2693 csp->cfd, csp->server_connection.sfd);
2694 mark_server_socket_tainted(csp);
2697 if (csp->expected_client_content_length != 0)
2699 if (csp->expected_client_content_length < csp->receive_buffer_size)
2701 max_bytes_to_read = (int)csp->expected_client_content_length;
2703 log_error(LOG_LEVEL_CONNECT,
2704 "Waiting for up to %d bytes from the client.",
2707 assert(max_bytes_to_read <= csp->receive_buffer_size);
2708 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2710 #ifdef FEATURE_HTTPS_INSPECTION
2711 if (client_use_ssl(csp))
2713 log_error(LOG_LEVEL_CONNECT, "Breaking with TLS/SSL.");
2717 #endif /* def FEATURE_HTTPS_INSPECTION */
2719 len = read_socket(csp->cfd, csp->receive_buffer, max_bytes_to_read);
2723 /* XXX: not sure if this is necessary. */
2724 mark_server_socket_tainted(csp);
2725 break; /* "game over, man" */
2728 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2729 if (csp->expected_client_content_length != 0)
2731 assert(len <= max_bytes_to_read);
2732 csp->expected_client_content_length -= (unsigned)len;
2733 log_error(LOG_LEVEL_CONNECT,
2734 "Expected client content length set to %llu "
2735 "after reading %d bytes.",
2736 csp->expected_client_content_length, len);
2737 if (csp->expected_client_content_length == 0)
2739 log_error(LOG_LEVEL_CONNECT,
2740 "Done reading from the client.");
2741 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
2744 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2746 if (write_socket(csp->server_connection.sfd, csp->receive_buffer, (size_t)len))
2748 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
2749 mark_server_socket_tainted(csp);
2757 * The server wants to talk. It could be the header or the body.
2758 * If `hdr' is null, then it's the header otherwise it's the body.
2759 * FIXME: Does `hdr' really mean `host'? No.
2762 if (poll_fds[1].revents != 0)
2764 if (FD_ISSET(csp->server_connection.sfd, &rfds))
2765 #endif /* HAVE_POLL */
2767 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2769 * If we are buffering content, we don't want to eat up to
2770 * buffer-limit bytes if the client no longer cares about them.
2771 * If we aren't buffering, however, a dead client socket will be
2772 * noticed pretty much right away anyway, so we can reduce the
2773 * overhead by skipping the check.
2775 if (buffer_and_filter_content && !socket_is_still_alive(csp->cfd))
2778 log_error(LOG_LEVEL_CONNECT,
2779 "The server still wants to talk, but the client may already have hung up on us.");
2781 log_error(LOG_LEVEL_CONNECT,
2782 "The server still wants to talk, but the client hung up on us.");
2783 mark_server_socket_tainted(csp);
2784 #ifdef FEATURE_HTTPS_INSPECTION
2785 close_client_and_server_ssl_connections(csp);
2788 #endif /* def _WIN32 */
2790 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2792 #ifdef FEATURE_HTTPS_INSPECTION
2794 * Reading data from standard or secured connection (HTTP/HTTPS)
2796 if (server_use_ssl(csp))
2798 len = ssl_recv_data(&(csp->mbedtls_server_attr.ssl),
2799 (unsigned char *)csp->receive_buffer, csp->receive_buffer_size);
2804 len = read_socket(csp->server_connection.sfd, csp->receive_buffer,
2805 (int)csp->receive_buffer_size);
2810 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
2812 if ((http->ssl && (csp->fwd == NULL))
2813 #ifdef FEATURE_HTTPS_INSPECTION
2819 * Just hang up. We already confirmed the client's CONNECT
2820 * request with status code 200 and unencrypted content is
2821 * no longer welcome.
2823 log_error(LOG_LEVEL_ERROR,
2824 "CONNECT already confirmed. Unable to tell the client about the problem.");
2827 else if (byte_count)
2830 * Just hang up. We already transmitted the original headers
2831 * and parts of the original content and therefore missed the
2832 * chance to send an error message (without risking data corruption).
2834 * XXX: we could retry with a fancy range request here.
2836 log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
2837 "Unable to tell the client about the problem.");
2838 mark_server_socket_tainted(csp);
2839 #ifdef FEATURE_HTTPS_INSPECTION
2840 close_client_and_server_ssl_connections(csp);
2845 * XXX: Consider handling the cases above the same.
2847 mark_server_socket_tainted(csp);
2851 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2852 if (csp->flags & CSP_FLAG_CHUNKED)
2854 if ((len >= 5) && !memcmp(csp->receive_buffer+len-5, "0\r\n\r\n", 5))
2856 /* XXX: this is a temporary hack */
2857 log_error(LOG_LEVEL_CONNECT,
2858 "Looks like we reached the end of the last chunk. "
2859 "We better stop reading.");
2860 csp->expected_content_length = byte_count + (unsigned long long)len;
2861 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2865 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2868 * This is guaranteed by allocating with zalloc_or_die()
2869 * and never (intentionally) writing to the last byte.
2871 * csp->receive_buffer_size is the size of the part of the
2872 * buffer we intentionally write to, but we actually
2873 * allocated csp->receive_buffer_size+1 bytes so the assertion
2874 * stays within the allocated range.
2876 assert(csp->receive_buffer[csp->receive_buffer_size] == '\0');
2879 * Add a trailing zero to let be able to use string operations.
2880 * XXX: do we still need this with filter_popups gone?
2882 assert(len <= csp->receive_buffer_size);
2883 csp->receive_buffer[len] = '\0';
2886 * Normally, this would indicate that we've read
2887 * as much as the server has sent us and we can
2888 * close the client connection. However, Microsoft
2889 * in its wisdom has released IIS/5 with a bug that
2890 * prevents it from sending the trailing \r\n in
2891 * a 302 redirect header (and possibly other headers).
2892 * To work around this if we've haven't parsed
2893 * a full header we'll append a trailing \r\n
2894 * and see if this now generates a valid one.
2896 * This hack shouldn't have any impacts. If we've
2897 * already transmitted the header or if this is a
2898 * SSL connection, then we won't bother with this
2899 * hack. So we only work on partially received
2900 * headers. If we append a \r\n and this still
2901 * doesn't generate a valid header, then we won't
2902 * transmit anything to the client.
2907 if (server_body || (http->ssl
2908 #ifdef FEATURE_HTTPS_INSPECTION
2914 * If we have been buffering up the document,
2915 * now is the time to apply content modification
2916 * and send the result to the client.
2918 if (buffer_and_filter_content)
2920 p = execute_content_filters(csp);
2922 * If content filtering fails, use the original
2923 * buffer and length.
2924 * (see p != NULL ? p : csp->iob->cur below)
2928 csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
2930 #ifdef FEATURE_COMPRESSION
2931 else if ((csp->flags & CSP_FLAG_CLIENT_SUPPORTS_DEFLATE)
2932 && (csp->content_length > LOWER_LENGTH_LIMIT_FOR_COMPRESSION))
2934 char *compressed_content = compress_buffer(p,
2935 (size_t *)&csp->content_length, csp->config->compression_level);
2936 if (compressed_content != NULL)
2939 p = compressed_content;
2940 csp->flags |= CSP_FLAG_BUFFERED_CONTENT_DEFLATED;
2945 if (JB_ERR_OK != update_server_headers(csp))
2947 log_error(LOG_LEVEL_FATAL,
2948 "Failed to update server headers. after filtering.");
2951 hdr = list_to_text(csp->headers);
2954 /* FIXME Should handle error properly */
2955 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2958 #ifdef FEATURE_HTTPS_INSPECTION
2960 * Sending data with standard or secured connection (HTTP/HTTPS)
2962 if (client_use_ssl(csp))
2964 if ((ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2965 (const unsigned char *)hdr, strlen(hdr)) < 0)
2966 || (ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2967 (const unsigned char *) ((p != NULL) ? p : csp->iob->cur),
2968 csp->content_length) < 0))
2970 log_error(LOG_LEVEL_ERROR, "write modified content to "
2971 "client over TLS/SSL failed");
2974 mark_server_socket_tainted(csp);
2975 close_client_and_server_ssl_connections(csp);
2980 #endif /* def FEATURE_HTTPS_INSPECTION */
2982 if (write_socket_delayed(csp->cfd, hdr, strlen(hdr), write_delay)
2983 || write_socket_delayed(csp->cfd, ((p != NULL) ? p : csp->iob->cur),
2984 (size_t)csp->content_length, write_delay))
2986 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
2989 mark_server_socket_tainted(csp);
2998 break; /* "game over, man" */
3002 * This is NOT the body, so
3003 * Let's pretend the server just sent us a blank line.
3005 snprintf(csp->receive_buffer, csp->receive_buffer_size, "\r\n");
3006 len = (int)strlen(csp->receive_buffer);
3009 * Now, let the normal header parsing algorithm below do its
3010 * job. If it fails, we'll exit instead of continuing.
3017 * If we're in the body of the server document, just write it to
3018 * the client, unless we need to buffer the body for later
3019 * content-filtering.
3021 if (server_body || (http->ssl
3022 #ifdef FEATURE_HTTPS_INSPECTION
3027 if (buffer_and_filter_content)
3030 * If there is no memory left for buffering the content, or the buffer limit
3031 * has been reached, switch to non-filtering mode, i.e. make & write the
3032 * header, flush the iob and buf, and get out of the way.
3034 if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3039 log_error(LOG_LEVEL_INFO,
3040 "Flushing header and buffers. Stepping back from filtering.");
3042 hdr = list_to_text(csp->headers);
3046 * Memory is too tight to even generate the header.
3047 * Send our static "Out-of-memory" page.
3049 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
3050 rsp = cgi_error_memory();
3051 send_crunch_response(csp, rsp);
3052 mark_server_socket_tainted(csp);
3053 #ifdef FEATURE_HTTPS_INSPECTION
3054 close_client_and_server_ssl_connections(csp);
3058 hdrlen = strlen(hdr);
3060 #ifdef FEATURE_HTTPS_INSPECTION
3062 * Sending data with standard or secured connection (HTTP/HTTPS)
3064 if (client_use_ssl(csp))
3066 if ((ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3067 (const unsigned char *)hdr, hdrlen) < 0)
3068 || ((flushed = ssl_flush_socket(&(csp->mbedtls_client_attr.ssl),
3070 || (ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3071 (const unsigned char *)csp->receive_buffer, (size_t)len) < 0))
3073 log_error(LOG_LEVEL_CONNECT,
3074 "Flush header and buffers to client failed");
3076 mark_server_socket_tainted(csp);
3077 close_client_and_server_ssl_connections(csp);
3082 #endif /* def FEATURE_HTTPS_INSPECTION */
3084 if (write_socket_delayed(csp->cfd, hdr, hdrlen, write_delay)
3085 || ((flushed = flush_iob(csp->cfd, csp->iob, write_delay)) < 0)
3086 || write_socket_delayed(csp->cfd, csp->receive_buffer, (size_t)len,
3089 log_error(LOG_LEVEL_CONNECT,
3090 "Flush header and buffers to client failed: %E");
3092 mark_server_socket_tainted(csp);
3098 * Reset the byte_count to the amount of bytes
3099 * we just flushed. len will be added a few lines below,
3100 * hdrlen doesn't matter for LOG_LEVEL_CLF.
3102 byte_count = (unsigned long long)flushed;
3104 buffer_and_filter_content = 0;
3110 #ifdef FEATURE_HTTPS_INSPECTION
3112 * Sending data with standard or secured connection (HTTP/HTTPS)
3114 if (client_use_ssl(csp))
3116 ret = ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3117 (const unsigned char *)csp->receive_buffer, (size_t)len);
3120 log_error(LOG_LEVEL_ERROR,
3121 "Sending data to client failed");
3122 mark_server_socket_tainted(csp);
3123 close_client_and_server_ssl_connections(csp);
3128 #endif /* def FEATURE_HTTPS_INSPECTION */
3130 if (write_socket_delayed(csp->cfd, csp->receive_buffer,
3131 (size_t)len, write_delay))
3133 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
3134 mark_server_socket_tainted(csp);
3139 byte_count += (unsigned long long)len;
3145 * We're still looking for the end of the server's header.
3146 * Buffer up the data we just read. If that fails, there's
3147 * little we can do but send our static out-of-memory page.
3149 if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3151 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
3152 rsp = cgi_error_memory();
3153 send_crunch_response(csp, rsp);
3154 mark_server_socket_tainted(csp);
3155 #ifdef FEATURE_HTTPS_INSPECTION
3156 close_client_and_server_ssl_connections(csp);
3161 /* Convert iob into something sed() can digest */
3162 if (JB_ERR_PARSE == get_server_headers(csp))
3167 * Well, we tried our MS IIS/5 hack and it didn't work.
3168 * The header is incomplete and there isn't anything
3169 * we can do about it.
3171 log_error(LOG_LEVEL_ERROR, "Invalid server headers. "
3172 "Applying the MS IIS5 hack didn't help.");
3173 log_error(LOG_LEVEL_CLF,
3174 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3175 #ifdef FEATURE_HTTPS_INSPECTION
3177 * Sending data with standard or secured connection (HTTP/HTTPS)
3179 if (client_use_ssl(csp))
3181 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3182 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3183 strlen(INVALID_SERVER_HEADERS_RESPONSE));
3186 #endif /* def FEATURE_HTTPS_INSPECTION */
3188 write_socket_delayed(csp->cfd,
3189 INVALID_SERVER_HEADERS_RESPONSE,
3190 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3192 mark_server_socket_tainted(csp);
3193 #ifdef FEATURE_HTTPS_INSPECTION
3194 close_client_and_server_ssl_connections(csp);
3201 * Since we have to wait for more from the server before
3202 * we can parse the headers we just continue here.
3204 log_error(LOG_LEVEL_CONNECT,
3205 "Continuing buffering server headers from socket %d. "
3206 "Bytes most recently read: %d.", csp->cfd, len);
3213 * Account for the content bytes we
3214 * might have gotten with the headers.
3216 assert(csp->iob->eod >= csp->iob->cur);
3217 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3220 /* Did we actually get anything? */
3221 if (NULL == csp->headers->first)
3223 if ((csp->flags & CSP_FLAG_REUSED_CLIENT_CONNECTION))
3225 log_error(LOG_LEVEL_ERROR,
3226 "No server or forwarder response received on socket %d. "
3227 "Closing client socket %d without sending data.",
3228 csp->server_connection.sfd, csp->cfd);
3229 log_error(LOG_LEVEL_CLF,
3230 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3234 log_error(LOG_LEVEL_ERROR,
3235 "No server or forwarder response received on socket %d.",
3236 csp->server_connection.sfd);
3237 send_crunch_response(csp, error_response(csp, "no-server-data"));
3239 free_http_request(http);
3240 mark_server_socket_tainted(csp);
3241 #ifdef FEATURE_HTTPS_INSPECTION
3242 close_client_and_server_ssl_connections(csp);
3247 if (!csp->headers->first->str)
3249 log_error(LOG_LEVEL_ERROR, "header search: csp->headers->first->str == NULL, assert will be called");
3251 assert(csp->headers->first->str);
3253 if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
3254 strncmpic(csp->headers->first->str, "ICY", 3))
3257 * It doesn't look like a HTTP (or Shoutcast) response:
3258 * tell the client and log the problem.
3260 if (strlen(csp->headers->first->str) > 30)
3262 csp->headers->first->str[30] = '\0';
3264 log_error(LOG_LEVEL_ERROR,
3265 "Invalid server or forwarder response. Starts with: %s",
3266 csp->headers->first->str);
3267 log_error(LOG_LEVEL_CLF,
3268 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3269 #ifdef FEATURE_HTTPS_INSPECTION
3271 * Sending data with standard or secured connection (HTTP/HTTPS)
3273 if (client_use_ssl(csp))
3275 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3276 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3277 strlen(INVALID_SERVER_HEADERS_RESPONSE));
3280 #endif /* def FEATURE_HTTPS_INSPECTION */
3282 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3283 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3285 free_http_request(http);
3286 mark_server_socket_tainted(csp);
3287 #ifdef FEATURE_HTTPS_INSPECTION
3288 close_client_and_server_ssl_connections(csp);
3294 * We have now received the entire server header,
3295 * filter it and send the result to the client
3297 if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
3299 log_error(LOG_LEVEL_CLF,
3300 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3301 #ifdef FEATURE_HTTPS_INSPECTION
3303 * Sending data with standard or secured connection (HTTP/HTTPS)
3305 if (client_use_ssl(csp))
3307 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3308 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3309 strlen(INVALID_SERVER_HEADERS_RESPONSE));
3314 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3315 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3317 free_http_request(http);
3318 mark_server_socket_tainted(csp);
3319 #ifdef FEATURE_HTTPS_INSPECTION
3320 close_client_and_server_ssl_connections(csp);
3324 hdr = list_to_text(csp->headers);
3327 /* FIXME Should handle error properly */
3328 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
3331 if ((csp->flags & CSP_FLAG_CHUNKED)
3332 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3333 && ((csp->iob->eod - csp->iob->cur) >= 5)
3334 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
3336 log_error(LOG_LEVEL_CONNECT,
3337 "Looks like we got the last chunk together with "
3338 "the server headers. We better stop reading.");
3339 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3340 csp->expected_content_length = byte_count;
3341 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
3344 csp->server_connection.response_received = time(NULL);
3346 if (crunch_response_triggered(csp, crunchers_light))
3349 * One of the tags created by a server-header
3350 * tagger triggered a crunch. We already
3351 * delivered the crunch response to the client
3352 * and are done here after cleaning up.
3355 mark_server_socket_tainted(csp);
3356 #ifdef FEATURE_HTTPS_INSPECTION
3357 close_client_and_server_ssl_connections(csp);
3362 /* Buffer and pcrs filter this if appropriate. */
3363 buffer_and_filter_content = content_requires_filtering(csp);
3365 if (!buffer_and_filter_content)
3368 * Write the server's (modified) header to
3369 * the client (along with anything else that
3370 * may be in the buffer). Use standard or secured
3373 #ifdef FEATURE_HTTPS_INSPECTION
3374 if (client_use_ssl(csp))
3376 if ((ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3377 (const unsigned char *)hdr, strlen(hdr)) < 0)
3378 || (len = ssl_flush_socket(&(csp->mbedtls_client_attr.ssl),
3381 log_error(LOG_LEVEL_CONNECT, "Write header to client failed");
3384 * The write failed, so don't bother mentioning it
3385 * to the client... it probably can't hear us anyway.
3388 mark_server_socket_tainted(csp);
3389 #ifdef FEATURE_HTTPS_INSPECTION
3390 close_client_and_server_ssl_connections(csp);
3396 #endif /* def FEATURE_HTTPS_INSPECTION */
3398 if (write_socket_delayed(csp->cfd, hdr, strlen(hdr), write_delay)
3399 || ((len = flush_iob(csp->cfd, csp->iob, write_delay)) < 0))
3401 log_error(LOG_LEVEL_ERROR,
3402 "write header to client failed");
3404 * The write failed, so don't bother mentioning it
3405 * to the client... it probably can't hear us anyway.
3408 mark_server_socket_tainted(csp);
3414 /* we're finished with the server's header */
3420 * If this was a MS IIS/5 hack then it means the server
3421 * has already closed the connection. Nothing more to read.
3426 log_error(LOG_LEVEL_ERROR,
3427 "Closed server connection detected. "
3428 "Applying the MS IIS5 hack didn't help.");
3429 log_error(LOG_LEVEL_CLF,
3430 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3431 #ifdef FEATURE_HTTPS_INSPECTION
3433 * Sending data with standard or secured connection (HTTP/HTTPS)
3435 if (client_use_ssl(csp))
3437 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3438 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3439 strlen(INVALID_SERVER_HEADERS_RESPONSE));
3442 #endif /* def FEATURE_HTTPS_INSPECTION */
3444 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3445 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3447 mark_server_socket_tainted(csp);
3448 #ifdef FEATURE_HTTPS_INSPECTION
3449 close_client_and_server_ssl_connections(csp);
3456 mark_server_socket_tainted(csp);
3457 #ifdef FEATURE_HTTPS_INSPECTION
3458 close_client_and_server_ssl_connections(csp);
3460 return; /* huh? we should never get here */
3462 #ifdef FEATURE_HTTPS_INSPECTION
3463 close_client_and_server_ssl_connections(csp);
3465 if (csp->content_length == 0)
3468 * If Privoxy didn't recalculate the Content-Length,
3469 * byte_count is still correct.
3471 csp->content_length = byte_count;
3474 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3475 if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3476 && (csp->expected_content_length != byte_count))
3478 log_error(LOG_LEVEL_CONNECT,
3479 "Received %llu bytes while expecting %llu.",
3480 byte_count, csp->expected_content_length);
3481 mark_server_socket_tainted(csp);
3485 #ifdef FEATURE_HTTPS_INSPECTION
3486 if (client_use_ssl(csp))
3488 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s https://%s%s %s\" 200 %llu",
3489 csp->ip_addr_str, http->gpc, http->hostport, http->path,
3490 http->version, csp->content_length);
3495 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %llu",
3496 csp->ip_addr_str, http->ocmd, csp->content_length);
3498 csp->server_connection.timestamp = time(NULL);
3502 /*********************************************************************
3506 * Description : Once a connection from the client has been accepted,
3507 * this function is called (via serve()) to handle the
3508 * main business of the communication. This function
3509 * returns after dealing with a single request. It can
3510 * be called multiple times with the same client socket
3511 * if the client is keeping the connection alive.
3513 * The decision whether or not a client connection will
3514 * be kept alive is up to the caller which also must
3515 * close the client socket when done.
3517 * FIXME: chat is nearly thousand lines long.
3521 * 1 : csp = Current client state (buffers, headers, etc...)
3523 * Returns : Nothing.
3525 *********************************************************************/
3526 static void chat(struct client_state *csp)
3528 const struct forward_spec *fwd;
3529 struct http_request *http;
3530 /* Skeleton for HTTP response, if we should intercept the request */
3531 struct http_response *rsp;
3532 #ifdef FEATURE_HTTPS_INSPECTION
3533 int use_ssl_tunnel = 0;
3538 if (receive_client_request(csp) != JB_ERR_OK)
3542 if (parse_client_request(csp) != JB_ERR_OK)
3547 /* decide how to route the HTTP request */
3548 fwd = forward_url(csp, http);
3551 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!? This can't happen!");
3552 /* Never get here - LOG_LEVEL_FATAL causes program exit */
3556 #ifdef FEATURE_HTTPS_INSPECTION
3558 * Setting flags to use old solution with SSL tunnel and to disable
3559 * certificates verification.
3561 if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION)
3562 && !cgi_page_requested(csp->http->host))
3567 if (http->ssl && csp->action->flags & ACTION_IGNORE_CERTIFICATE_ERRORS)
3569 csp->dont_verify_certificate = 1;
3574 * build the http request to send to the server
3575 * we have to do one of the following:
3577 * create = use the original HTTP request to create a new
3578 * HTTP request that has either the path component
3579 * without the http://domainspec (w/path) or the
3580 * full orininal URL (w/url)
3581 * Note that the path and/or the HTTP version may
3582 * have been altered by now.
3584 * SSL proxy = Open a socket to the host:port of the server
3585 * and create TLS/SSL connection with server and
3586 * with client. Then behave like mediator between
3587 * client and server over TLS/SSL.
3589 * SSL proxy = Pass the request unchanged if forwarding a CONNECT
3590 * with request to a parent proxy. Note that we'll be sending
3591 * forwarding the CFAIL message ourselves if connecting to the parent
3592 * fails, but we won't send a CSUCCEED message if it works,
3593 * since that would result in a double message (ours and the
3594 * parent's). After sending the request to the parent, we
3595 * must parse answer and send it to client. If connection
3596 * with server is established, we do TLS/SSL proxy. Otherwise
3597 * we send parent response to client and close connections.
3599 * here's the matrix:
3602 * +--------+--------+
3604 * 0 | create | SSL |
3605 * | w/path | proxy |
3606 * Forwarding +--------+--------+
3608 * 1 | create | proxy |
3609 * | w/url |+forward|
3610 * +--------+--------+
3614 #ifdef FEATURE_HTTPS_INSPECTION
3616 * Presetting SSL client and server flags
3618 if (http->ssl && !use_ssl_tunnel)
3620 http->client_ssl = 1;
3621 http->server_ssl = 1;
3625 http->client_ssl = 0;
3626 http->server_ssl = 0;
3630 if (http->ssl && connect_port_is_forbidden(csp))
3632 const char *acceptable_connect_ports =
3633 csp->action->string[ACTION_STRING_LIMIT_CONNECT];
3634 assert(NULL != acceptable_connect_ports);
3635 log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
3636 "limit-connect{%s} doesn't allow CONNECT requests to %s",
3637 csp->ip_addr_str, acceptable_connect_ports, csp->http->hostport);
3638 csp->action->flags |= ACTION_BLOCK;
3640 #ifdef FEATURE_HTTPS_INSPECTION
3641 http->client_ssl = 0;
3642 http->server_ssl = 0;
3647 freez(csp->headers->first->str);
3648 build_request_line(csp, fwd, &csp->headers->first->str);
3651 * We have a request. Check if one of the crunchers wants it
3652 * unless the client wants to use TLS/SSL in which case we
3653 * haven't setup the TLS context yet and will send the crunch
3657 #ifdef FEATURE_HTTPS_INSPECTION
3658 !client_use_ssl(csp) &&
3660 crunch_response_triggered(csp, crunchers_all))
3663 * Yes. The client got the crunch response and we're done here.
3668 log_applied_actions(csp->action);
3669 #ifdef FEATURE_HTTPS_INSPECTION
3671 * Log the request unless we're https inspecting
3672 * in which case we don't have the path yet and
3673 * will log the request later.
3675 if (!client_use_ssl(csp))
3678 log_error(LOG_LEVEL_GPC, "%s%s", http->hostport, http->path);
3680 if (fwd->forward_host)
3682 log_error(LOG_LEVEL_CONNECT, "via [%s]:%d to: %s",
3683 fwd->forward_host, fwd->forward_port, http->hostport);
3687 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
3690 /* here we connect to the server, gateway, or the forwarder */
3692 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3693 if ((csp->server_connection.sfd != JB_INVALID_SOCKET)
3694 && socket_is_still_alive(csp->server_connection.sfd)
3695 && connection_destination_matches(&csp->server_connection, http, fwd))
3697 log_error(LOG_LEVEL_CONNECT,
3698 "Reusing server socket %d connected to %s. Total requests: %u.",
3699 csp->server_connection.sfd, csp->server_connection.host,
3700 csp->server_connection.requests_sent_total);
3704 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
3706 #ifdef FEATURE_CONNECTION_SHARING
3707 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
3709 remember_connection(&csp->server_connection);
3712 #endif /* def FEATURE_CONNECTION_SHARING */
3714 log_error(LOG_LEVEL_CONNECT,
3715 "Closing server socket %d connected to %s. Total requests: %u.",
3716 csp->server_connection.sfd, csp->server_connection.host,
3717 csp->server_connection.requests_sent_total);
3718 close_socket(csp->server_connection.sfd);
3720 mark_connection_closed(&csp->server_connection);
3722 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3723 #ifdef FEATURE_HTTPS_INSPECTION
3724 if (http->ssl && !use_ssl_tunnel)
3728 * Creating an SSL proxy. If forwarding is disabled, we must send
3729 * CSUCCEED message to client. Then TLS/SSL connection with client
3733 if (fwd->forward_host == NULL)
3736 * We're lying to the client as the connection hasn't actually
3737 * been established yet. We don't establish the connection until
3738 * we have seen and parsed the encrypted client headers.
3740 if (write_socket_delayed(csp->cfd, CSUCCEED,
3741 strlen(CSUCCEED), get_write_delay(csp)) != 0)
3743 log_error(LOG_LEVEL_ERROR, "Sending SUCCEED to client failed");
3748 ret = create_client_ssl_connection(csp);
3751 log_error(LOG_LEVEL_ERROR,
3752 "Can't open secure connection with client");
3753 close_client_ssl_connection(csp); /* XXX: Is this needed? */
3756 if (JB_ERR_OK != process_encrypted_request(csp))
3758 log_error(LOG_LEVEL_ERROR, "Failed to parse encrypted request.");
3759 close_client_ssl_connection(csp);
3763 * We have an encrypted request. Check if one of the crunchers now
3764 * wants it (for example because the previously invisible path was
3765 * required to match).
3767 if (crunch_response_triggered(csp, crunchers_all))
3770 * Yes. The client got the crunch response and we're done here.
3772 close_client_ssl_connection(csp);
3778 * Connecting to destination server
3780 csp->server_connection.sfd = forwarded_connect(fwd, http, csp);
3782 if (csp->server_connection.sfd == JB_INVALID_SOCKET)
3784 if (fwd->type != SOCKS_NONE)
3787 rsp = error_response(csp, "forwarding-failed");
3789 else if (errno == EINVAL)
3791 rsp = error_response(csp, "no-such-domain");
3795 rsp = error_response(csp, "connect-failed");
3798 /* Write the answer to the client */
3801 send_crunch_response(csp, rsp);
3805 * Temporary workaround to prevent already-read client
3806 * bodies from being parsed as new requests. For now we
3807 * err on the safe side and throw all the following
3808 * requests under the bus, even if no client body has been
3809 * buffered. A compliant client will repeat the dropped
3810 * requests on an untainted connection.
3812 * The proper fix is to discard the no longer needed
3813 * client body in the buffer (if there is one) and to
3814 * continue parsing the bytes that follow.
3816 #ifdef FEATURE_HTTPS_INSPECTION
3817 close_client_ssl_connection(csp);
3819 drain_and_close_socket(csp->cfd);
3820 csp->cfd = JB_INVALID_SOCKET;
3825 #ifdef FEATURE_HTTPS_INSPECTION
3827 * Creating TLS/SSL connections with destination server or parent
3828 * proxy. If forwarding is enabled, we must send client request to
3829 * parent proxy and receive, parse and resend parent proxy answer.
3831 if (http->ssl && !use_ssl_tunnel)
3833 if (fwd->forward_host != NULL)
3835 char server_response[BUFFER_SIZE];
3838 char *hdr = list_to_text(csp->headers);
3839 memset(server_response, 0, sizeof(server_response));
3843 log_error(LOG_LEVEL_FATAL,
3844 "Out of memory parsing client header");
3846 list_remove_all(csp->headers);
3849 * Sending client's CONNECT request to the parent proxy
3851 ret = write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
3857 log_error(LOG_LEVEL_CONNECT,
3858 "Sending request headers to: %s failed", http->hostport);
3859 mark_server_socket_tainted(csp);
3860 close_client_ssl_connection(csp);
3864 /* Waiting for parent proxy server response */
3865 len = read_socket(csp->server_connection.sfd, server_response,
3866 sizeof(server_response)-1);
3870 log_error(LOG_LEVEL_ERROR, "No response from parent proxy "
3871 "server on socket %d.", csp->server_connection.sfd);
3873 rsp = error_response(csp, "no-server-data");
3876 send_crunch_response(csp, rsp);
3878 mark_server_socket_tainted(csp);
3879 close_client_ssl_connection(csp);
3884 * Test if connection with destination server was established
3885 * successfully by parent proxy. Then we can send response to
3886 * the client and continue or stop.
3888 if (!tunnel_established_successfully(server_response, (unsigned int)len))
3890 log_error(LOG_LEVEL_ERROR, "Forwarder hasn't established "
3891 "connection with destination server.");
3893 write_socket(csp->cfd, server_response, (size_t)len);
3894 mark_server_socket_tainted(csp);
3895 close_client_ssl_connection(csp);
3900 * Parent proxy has established connection with destination server.
3901 * Now we must create TLS/SSL connection with parent proxy.
3903 ret = create_server_ssl_connection(csp);
3906 * If TLS/SSL connection wasn't created and invalid certificate
3907 * wasn't detected, we can interrupt this function. Otherwise, we
3908 * must inform the client about invalid server certificate.
3911 && (csp->server_cert_verification_result == SSL_CERT_NOT_VERIFIED
3912 || csp->server_cert_verification_result == SSL_CERT_VALID))
3914 rsp = error_response(csp, "connect-failed");
3917 send_crunch_response(csp, rsp);
3923 * TLS/SSL connection with parent proxy is established, we can
3924 * inform client about success.
3926 ret = write_socket(csp->cfd, server_response, (size_t)len);
3929 log_error(LOG_LEVEL_ERROR,
3930 "Sending parent proxy response to client failed");
3931 mark_server_socket_tainted(csp);
3932 close_client_ssl_connection(csp);
3935 }/* -END- if (fwd->forward_host != NULL) */
3939 * Parent proxy is not used, we can just create TLS/SSL connection
3940 * with destination server
3942 int ret = create_server_ssl_connection(csp);
3945 if (csp->server_cert_verification_result != SSL_CERT_VALID &&
3946 csp->server_cert_verification_result != SSL_CERT_NOT_VERIFIED)
3949 * If the server certificate is invalid, we must inform
3950 * the client and then close connection to the client.
3952 ssl_send_certificate_error(csp);
3953 close_client_and_server_ssl_connections(csp);
3956 if (csp->server_cert_verification_result == SSL_CERT_NOT_VERIFIED
3957 || csp->server_cert_verification_result == SSL_CERT_VALID)
3960 * The TLS/SSL connection wasn't created but an invalid
3961 * certificate wasn't detected. Report it as connection
3964 rsp = error_response(csp, "connect-failed");
3967 send_crunch_response(csp, rsp);
3969 close_client_and_server_ssl_connections(csp);
3974 }/* -END- if (http->ssl) */
3975 #endif /* def FEATURE_HTTPS_INSPECTION */
3977 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3978 save_connection_destination(csp->server_connection.sfd,
3979 http, fwd, &csp->server_connection);
3980 csp->server_connection.keep_alive_timeout =
3981 (unsigned)csp->config->keep_alive_timeout;
3983 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3985 csp->server_connection.requests_sent_total++;
3987 if ((fwd->type == SOCKS_5T) && (NULL == csp->headers->first))
3989 /* Client headers have been sent optimistically */
3990 assert(csp->headers->last == NULL);
3992 else if (http->ssl == 0 || (fwd->forward_host
3993 #ifdef FEATURE_HTTPS_INSPECTION
3998 if (send_http_request(csp))
4000 rsp = error_response(csp, "connect-failed");
4003 send_crunch_response(csp, rsp);
4011 * Using old solution with SSL tunnel or new solution with SSL proxy
4013 list_remove_all(csp->headers);
4014 #ifdef FEATURE_HTTPS_INSPECTION
4019 * We're running an SSL tunnel and we're not forwarding,
4020 * so just ditch the client headers, send the "connect succeeded"
4021 * message to the client, flush the rest, and get out of the way.
4023 if (write_socket_delayed(csp->cfd, CSUCCEED,
4024 strlen(CSUCCEED), get_write_delay(csp)))
4029 #ifdef FEATURE_HTTPS_INSPECTION
4033 * If server certificate is invalid, we must inform client and then
4034 * close connection with client.
4036 if (csp->server_cert_verification_result != SSL_CERT_VALID)
4038 ssl_send_certificate_error(csp);
4039 close_client_and_server_ssl_connections(csp);
4042 if (send_https_request(csp))
4044 rsp = error_response(csp, "connect-failed");
4047 send_crunch_response(csp, rsp);
4049 close_client_and_server_ssl_connections(csp);
4053 #endif /* def FEATURE_HTTPS_INSPECTION */
4054 clear_iob(csp->client_iob);
4055 }/* -END- else ... if (http->ssl == 1) */
4057 log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
4059 /* XXX: should the time start earlier for optimistically sent data? */
4060 csp->server_connection.request_sent = time(NULL);
4062 handle_established_connection(csp);
4063 freez(csp->receive_buffer);
4068 /*********************************************************************
4070 * Function : fuzz_server_response
4072 * Description : Treat the input as a whole server response.
4075 * 1 : csp = Current client state (buffers, headers, etc...)
4076 * 2 : fuzz_input_file = File to read the input from.
4080 *********************************************************************/
4081 extern int fuzz_server_response(struct client_state *csp, char *fuzz_input_file)
4083 static struct forward_spec fwd; /* Zero'd due to being static */
4086 if (strcmp(fuzz_input_file, "-") == 0)
4088 /* XXX: Doesn'T work yet. */
4089 csp->server_connection.sfd = 0;
4093 csp->server_connection.sfd = open(fuzz_input_file, O_RDONLY);
4094 if (csp->server_connection.sfd == -1)
4096 log_error(LOG_LEVEL_FATAL, "Failed to open %s: %E",
4101 csp->content_type |= CT_GIF;
4102 csp->action->flags |= ACTION_DEANIMATE;
4103 csp->action->string[ACTION_STRING_DEANIMATE] = "last";
4105 csp->http->path = strdup_or_die("/");
4106 csp->http->host = strdup_or_die("fuzz.example.org");
4107 csp->http->hostport = strdup_or_die("fuzz.example.org:80");
4108 /* Prevent client socket monitoring */
4109 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
4110 csp->flags |= CSP_FLAG_CHUNKED;
4112 csp->config->feature_flags |= RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
4113 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
4115 csp->content_type |= CT_DECLARED|CT_GIF;
4117 csp->config->socket_timeout = 0;
4119 cgi_init_error_messages();
4121 handle_established_connection(csp);
4122 freez(csp->receive_buffer);
4129 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4130 /*********************************************************************
4132 * Function : prepare_csp_for_next_request
4134 * Description : Put the csp in a mostly vergin state.
4137 * 1 : csp = Current client state (buffers, headers, etc...)
4141 *********************************************************************/
4142 static void prepare_csp_for_next_request(struct client_state *csp)
4144 csp->content_type = 0;
4145 csp->content_length = 0;
4146 csp->expected_content_length = 0;
4147 csp->expected_client_content_length = 0;
4148 list_remove_all(csp->headers);
4149 clear_iob(csp->iob);
4150 freez(csp->error_message);
4151 free_http_request(csp->http);
4152 destroy_list(csp->headers);
4153 destroy_list(csp->tags);
4154 #ifdef FEATURE_CLIENT_TAGS
4155 destroy_list(csp->client_tags);
4156 freez(csp->client_address);
4158 free_current_action(csp->action);
4159 if (NULL != csp->fwd)
4161 unload_forward_spec(csp->fwd);
4164 /* XXX: Store per-connection flags someplace else. */
4165 csp->flags = (CSP_FLAG_ACTIVE | CSP_FLAG_REUSED_CLIENT_CONNECTION);
4166 #ifdef FEATURE_TOGGLE
4167 if (global_toggle_state)
4168 #endif /* def FEATURE_TOGGLE */
4170 csp->flags |= CSP_FLAG_TOGGLED_ON;
4173 if (csp->client_iob->eod > csp->client_iob->cur)
4175 long bytes_to_shift = csp->client_iob->cur - csp->client_iob->buf;
4176 size_t data_length = (size_t)(csp->client_iob->eod - csp->client_iob->cur);
4178 assert(bytes_to_shift > 0);
4179 assert(data_length > 0);
4181 log_error(LOG_LEVEL_CONNECT, "Shifting %d pipelined bytes by %d bytes",
4182 data_length, bytes_to_shift);
4183 memmove(csp->client_iob->buf, csp->client_iob->cur, data_length);
4184 csp->client_iob->cur = csp->client_iob->buf;
4185 assert(csp->client_iob->eod == csp->client_iob->buf + bytes_to_shift + data_length);
4186 csp->client_iob->eod = csp->client_iob->buf + data_length;
4187 memset(csp->client_iob->eod, '\0', (size_t)bytes_to_shift);
4189 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
4194 * We mainly care about resetting client_iob->cur so we don't
4195 * waste buffer space at the beginning and don't mess up the
4196 * request restoration done by cgi_show_request().
4198 * Freeing the buffer itself isn't technically necessary,
4199 * but makes debugging more convenient.
4201 clear_iob(csp->client_iob);
4204 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4207 /*********************************************************************
4211 * Description : This is little more than chat. We only "serve" to
4212 * to close (or remember) any socket that chat may have
4216 * 1 : csp = Current client state (buffers, headers, etc...)
4220 *********************************************************************/
4221 static void serve(struct client_state *csp)
4223 int config_file_change_detected = 0; /* Only used for debugging */
4224 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4225 #ifdef FEATURE_CONNECTION_SHARING
4226 static int monitor_thread_running = 0;
4227 #endif /* def FEATURE_CONNECTION_SHARING */
4228 int continue_chatting = 0;
4230 log_error(LOG_LEVEL_CONNECT, "Accepted connection from %s on socket %d",
4231 csp->ip_addr_str, csp->cfd);
4235 unsigned int latency;
4240 * If the request has been crunched,
4241 * the calculated latency is zero.
4243 latency = (unsigned)(csp->server_connection.response_received -
4244 csp->server_connection.request_sent) / 2;
4246 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4247 && (csp->flags & CSP_FLAG_CRUNCHED)
4248 && (csp->expected_client_content_length != 0))
4250 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
4251 log_error(LOG_LEVEL_CONNECT,
4252 "Tainting client socket %d due to unread data.", csp->cfd);
4255 continue_chatting = (csp->config->feature_flags
4256 & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
4257 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
4258 && (csp->cfd != JB_INVALID_SOCKET)
4259 && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4260 && ((csp->flags & CSP_FLAG_SERVER_CONTENT_LENGTH_SET)
4261 || (csp->flags & CSP_FLAG_CHUNKED));
4263 if (!(csp->flags & CSP_FLAG_CRUNCHED)
4264 && (csp->server_connection.sfd != JB_INVALID_SOCKET))
4266 if (!(csp->flags & CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET))
4268 csp->server_connection.keep_alive_timeout = csp->config->default_server_timeout;
4270 if (!(csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
4271 || (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
4272 || !socket_is_still_alive(csp->server_connection.sfd)
4273 || !(latency < csp->server_connection.keep_alive_timeout))
4275 log_error(LOG_LEVEL_CONNECT,
4276 "Closing server socket %d connected to %s. "
4277 "Keep-alive %u. Tainted: %u. Socket alive %u. Timeout: %u.",
4278 csp->server_connection.sfd, csp->server_connection.host,
4279 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
4280 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
4281 socket_is_still_alive(csp->server_connection.sfd),
4282 csp->server_connection.keep_alive_timeout);
4283 #ifdef FEATURE_CONNECTION_SHARING
4284 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4286 forget_connection(csp->server_connection.sfd);
4288 #endif /* def FEATURE_CONNECTION_SHARING */
4289 close_socket(csp->server_connection.sfd);
4290 mark_connection_closed(&csp->server_connection);
4294 if (continue_chatting && any_loaded_file_changed(csp))
4296 continue_chatting = 0;
4297 config_file_change_detected = 1;
4300 if (continue_chatting)
4302 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
4303 && socket_is_still_alive(csp->cfd))
4305 log_error(LOG_LEVEL_CONNECT, "Client request %d has been "
4306 "pipelined on socket %d and the socket is still alive.",
4307 csp->requests_received_total+1, csp->cfd);
4308 prepare_csp_for_next_request(csp);
4312 if (0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
4314 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4316 log_error(LOG_LEVEL_CONNECT,
4317 "Waiting for the next client request on socket %d. "
4318 "Keeping the server socket %d to %s open.",
4319 csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
4323 log_error(LOG_LEVEL_CONNECT,
4324 "Waiting for the next client request on socket %d. "
4325 "No server socket to keep open.", csp->cfd);
4329 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4330 && data_is_available(csp->cfd, (int)csp->config->keep_alive_timeout)
4331 && socket_is_still_alive(csp->cfd))
4333 log_error(LOG_LEVEL_CONNECT,
4334 "Client request %u arrived in time on socket %d.",
4335 csp->requests_received_total+1, csp->cfd);
4336 prepare_csp_for_next_request(csp);
4340 #ifdef FEATURE_CONNECTION_SHARING
4341 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4342 && (csp->server_connection.sfd != JB_INVALID_SOCKET)
4343 && (socket_is_still_alive(csp->server_connection.sfd)))
4345 time_t time_open = time(NULL) - csp->server_connection.timestamp;
4347 if (csp->server_connection.keep_alive_timeout < time_open - (time_t)latency)
4352 remember_connection(&csp->server_connection);
4353 csp->server_connection.sfd = JB_INVALID_SOCKET;
4354 drain_and_close_socket(csp->cfd);
4355 csp->cfd = JB_INVALID_SOCKET;
4356 privoxy_mutex_lock(&connection_reuse_mutex);
4357 if (!monitor_thread_running)
4359 monitor_thread_running = 1;
4360 privoxy_mutex_unlock(&connection_reuse_mutex);
4361 wait_for_alive_connections();
4362 privoxy_mutex_lock(&connection_reuse_mutex);
4363 monitor_thread_running = 0;
4365 privoxy_mutex_unlock(&connection_reuse_mutex);
4367 #endif /* def FEATURE_CONNECTION_SHARING */
4371 else if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4373 log_error(LOG_LEVEL_CONNECT,
4374 "Closing server socket %d connected to %s. Keep-alive: %u. "
4375 "Tainted: %u. Socket alive: %u. Timeout: %u. "
4376 "Configuration file change detected: %u",
4377 csp->server_connection.sfd, csp->server_connection.host,
4378 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
4379 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
4380 socket_is_still_alive(csp->server_connection.sfd),
4381 csp->server_connection.keep_alive_timeout,
4382 config_file_change_detected);
4384 } while (continue_chatting);
4388 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4390 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4392 #ifdef FEATURE_CONNECTION_SHARING
4393 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4395 forget_connection(csp->server_connection.sfd);
4397 #endif /* def FEATURE_CONNECTION_SHARING */
4398 close_socket(csp->server_connection.sfd);
4401 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4402 mark_connection_closed(&csp->server_connection);
4405 if (csp->cfd != JB_INVALID_SOCKET)
4407 log_error(LOG_LEVEL_CONNECT, "Closing client socket %d. "
4408 "Keep-alive: %u. Socket alive: %u. Data available: %u. "
4409 "Configuration file change detected: %u. Requests received: %u.",
4410 csp->cfd, 0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE),
4411 socket_is_still_alive(csp->cfd), data_is_available(csp->cfd, 0),
4412 config_file_change_detected, csp->requests_received_total);
4413 drain_and_close_socket(csp->cfd);
4416 free_csp_resources(csp);
4418 csp->flags &= ~CSP_FLAG_ACTIVE;
4424 /*********************************************************************
4426 * Function : server_thread
4428 * Description : We only exist to call `serve' in a threaded environment.
4431 * 1 : data = Current client state (buffers, headers, etc...)
4433 * Returns : Always 0.
4435 *********************************************************************/
4436 static int32 server_thread(void *data)
4438 serve((struct client_state *) data);
4445 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
4446 /*********************************************************************
4450 * Description : Print usage info & exit.
4452 * Parameters : Pointer to argv[0] for identifying ourselves
4456 *********************************************************************/
4457 static void usage(const char *name)
4459 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
4460 "Usage: %s [--config-test] "
4463 #endif /* defined(unix) */
4466 "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
4467 #endif /* defined(unix) */
4468 "[--version] [configfile]\n",
4472 show_fuzz_usage(name);
4475 printf("Aborting\n");
4480 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
4483 #ifdef MUTEX_LOCKS_AVAILABLE
4484 /*********************************************************************
4486 * Function : privoxy_mutex_lock
4488 * Description : Locks a mutex.
4491 * 1 : mutex = The mutex to lock.
4493 * Returns : Void. May exit in case of errors.
4495 *********************************************************************/
4496 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
4498 #ifdef FEATURE_PTHREAD
4499 int err = pthread_mutex_lock(mutex);
4502 if (mutex != &log_mutex)
4504 log_error(LOG_LEVEL_FATAL,
4505 "Mutex locking failed: %s.\n", strerror(err));
4510 EnterCriticalSection(mutex);
4511 #endif /* def FEATURE_PTHREAD */
4515 /*********************************************************************
4517 * Function : privoxy_mutex_unlock
4519 * Description : Unlocks a mutex.
4522 * 1 : mutex = The mutex to unlock.
4524 * Returns : Void. May exit in case of errors.
4526 *********************************************************************/
4527 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
4529 #ifdef FEATURE_PTHREAD
4530 int err = pthread_mutex_unlock(mutex);
4533 if (mutex != &log_mutex)
4535 log_error(LOG_LEVEL_FATAL,
4536 "Mutex unlocking failed: %s.\n", strerror(err));
4541 LeaveCriticalSection(mutex);
4542 #endif /* def FEATURE_PTHREAD */
4546 /*********************************************************************
4548 * Function : privoxy_mutex_init
4550 * Description : Prepares a mutex.
4553 * 1 : mutex = The mutex to initialize.
4555 * Returns : Void. May exit in case of errors.
4557 *********************************************************************/
4558 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
4560 #ifdef FEATURE_PTHREAD
4561 int err = pthread_mutex_init(mutex, 0);
4564 printf("Fatal error. Mutex initialization failed: %s.\n",
4569 InitializeCriticalSection(mutex);
4570 #endif /* def FEATURE_PTHREAD */
4572 #endif /* def MUTEX_LOCKS_AVAILABLE */
4574 /*********************************************************************
4576 * Function : initialize_mutexes
4578 * Description : Prepares mutexes if mutex support is available.
4582 * Returns : Void, exits in case of errors.
4584 *********************************************************************/
4585 static void initialize_mutexes(void)
4587 #ifdef MUTEX_LOCKS_AVAILABLE
4589 * Prepare global mutex semaphores
4592 #ifdef FEATURE_HTTPS_INSPECTION
4593 privoxy_mutex_init(&certificate_mutex);
4594 privoxy_mutex_init(&rng_mutex);
4597 privoxy_mutex_init(&log_mutex);
4598 privoxy_mutex_init(&log_init_mutex);
4599 privoxy_mutex_init(&connection_reuse_mutex);
4600 #ifdef FEATURE_EXTERNAL_FILTERS
4601 privoxy_mutex_init(&external_filter_mutex);
4603 #ifdef FEATURE_CLIENT_TAGS
4604 privoxy_mutex_init(&client_tags_mutex);
4608 * XXX: The assumptions below are a bit naive
4609 * and can cause locks that aren't necessary.
4611 * For example older FreeBSD versions (< 6.x?)
4612 * have no gethostbyname_r, but gethostbyname is
4615 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
4616 privoxy_mutex_init(&resolver_mutex);
4617 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
4619 * XXX: should we use a single mutex for
4620 * localtime() and gmtime() as well?
4622 #ifndef HAVE_GMTIME_R
4623 privoxy_mutex_init(&gmtime_mutex);
4624 #endif /* ndef HAVE_GMTIME_R */
4626 #ifndef HAVE_LOCALTIME_R
4627 privoxy_mutex_init(&localtime_mutex);
4628 #endif /* ndef HAVE_GMTIME_R */
4630 #if !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM)
4631 privoxy_mutex_init(&rand_mutex);
4632 #endif /* !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM) */
4634 #endif /* def MUTEX_LOCKS_AVAILABLE */
4637 /*********************************************************************
4641 * Description : Load the config file and start the listen loop.
4642 * This function is a lot more *sane* with the `load_config'
4643 * and `listen_loop' functions; although it stills does
4644 * a *little* too much for my taste.
4647 * 1 : argc = Number of parameters (including $0).
4648 * 2 : argv = Array of (char *)'s to the parameters.
4650 * Returns : 1 if : can't open config file, unrecognized directive,
4651 * stats requested in multi-thread mode, can't open the
4652 * log file, can't open the jar file, listen port is invalid,
4653 * any load fails, and can't bind port.
4655 * Else main never returns, the process must be signaled
4656 * to terminate execution. Or, on Windows, use the
4657 * "File", "Exit" menu option.
4659 *********************************************************************/
4661 int real_main(int argc, char **argv)
4663 int main(int argc, char **argv)
4667 int do_config_test = 0;
4668 #ifndef HAVE_ARC4RANDOM
4669 unsigned int random_seed;
4672 struct passwd *pw = NULL;
4673 struct group *grp = NULL;
4675 char *pre_chroot_nslookup_to_load_resolver = NULL;
4678 char *fuzz_input_type = NULL;
4679 char *fuzz_input_file = NULL;
4686 #if !defined(_WIN32)
4693 /* Prepare mutexes if supported and necessary. */
4694 initialize_mutexes();
4696 /* Enable logging until further notice. */
4700 * Parse the command line arguments
4702 * XXX: simply printing usage information in case of
4703 * invalid arguments isn't particularly user friendly.
4705 while (++argc_pos < argc)
4708 /* Check to see if the service must be installed or uninstalled */
4709 if (strncmp(argv[argc_pos], "--install", 9) == 0)
4711 const char *pName = argv[argc_pos] + 9;
4714 exit((install_service(pName)) ? 0 : 1);
4716 else if (strncmp(argv[argc_pos], "--uninstall", 11) == 0)
4718 const char *pName = argv[argc_pos] + 11;
4721 exit((uninstall_service(pName)) ? 0 : 1);
4723 else if (strcmp(argv[argc_pos], "--service") == 0)
4725 bRunAsService = TRUE;
4726 w32_set_service_cwd();
4727 atexit(w32_service_exit_notify);
4730 #endif /* defined(_WIN32) */
4733 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
4735 if (strcmp(argv[argc_pos], "--help") == 0)
4740 else if (strcmp(argv[argc_pos], "--version") == 0)
4742 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
4748 else if (strcmp(argv[argc_pos], "--no-daemon") == 0)
4750 set_debug_level(LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
4754 else if (strcmp(argv[argc_pos], "--pidfile") == 0)
4756 if (++argc_pos == argc) usage(argv[0]);
4757 pidfile = strdup_or_die(argv[argc_pos]);
4760 else if (strcmp(argv[argc_pos], "--user") == 0)
4765 if (++argc_pos == argc) usage(argv[argc_pos]);
4767 user_arg = strdup_or_die(argv[argc_pos]);
4768 group_name = strchr(user_arg, '.');
4769 if (NULL != group_name)
4771 /* Nul-terminate the user name */
4774 /* Skip the former delimiter to actually reach the group name */
4777 grp = getgrnam(group_name);
4780 log_error(LOG_LEVEL_FATAL, "Group '%s' not found.", group_name);
4783 pw = getpwnam(user_arg);
4786 log_error(LOG_LEVEL_FATAL, "User '%s' not found.", user_arg);
4792 else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup") == 0)
4794 if (++argc_pos == argc) usage(argv[0]);
4795 pre_chroot_nslookup_to_load_resolver = strdup_or_die(argv[argc_pos]);
4798 else if (strcmp(argv[argc_pos], "--chroot") == 0)
4802 #endif /* defined(unix) */
4804 else if (strcmp(argv[argc_pos], "--config-test") == 0)
4809 else if (strcmp(argv[argc_pos], "--fuzz") == 0)
4812 if (argc < argc_pos + 2) usage(argv[0]);
4813 fuzz_input_type = argv[argc_pos];
4815 fuzz_input_file = argv[argc_pos];
4817 else if (strcmp(argv[argc_pos], "--stfu") == 0)
4819 set_debug_level(LOG_LEVEL_STFU);
4822 else if (argc_pos + 1 != argc)
4825 * This is neither the last command line
4826 * option, nor was it recognized before,
4827 * therefore it must be invalid.
4833 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
4835 configfile = argv[argc_pos];
4838 } /* -END- while (more arguments) */
4840 show_version(Argv[0]);
4843 if (*configfile != '/')
4845 char cwd[BUFFER_SIZE];
4847 size_t abs_file_size;
4849 /* make config-filename absolute here */
4850 if (NULL == getcwd(cwd, sizeof(cwd)))
4852 perror("failed to get current working directory");
4856 basedir = strdup_or_die(cwd);
4858 abs_file_size = strlen(cwd) + strlen(configfile) + 5;
4859 abs_file = malloc_or_die(abs_file_size);
4860 strlcpy(abs_file, basedir, abs_file_size);
4861 strlcat(abs_file, "/", abs_file_size);
4862 strlcat(abs_file, configfile, abs_file_size);
4863 configfile = abs_file;
4865 #endif /* defined unix */
4869 clients->next = NULL;
4871 /* XXX: factor out initialising after the next stable release. */
4876 #ifndef HAVE_ARC4RANDOM
4877 random_seed = (unsigned int)time(NULL);
4879 srandom(random_seed);
4882 #endif /* ifdef HAVE_RANDOM */
4883 #endif /* ifndef HAVE_ARC4RANDOM */
4886 * Unix signal handling
4888 * Catch the abort, interrupt and terminate signals for a graceful exit
4889 * Catch the hangup signal so the errlog can be reopened.
4891 * Ignore the broken pipe signal as connection failures
4892 * are handled when and where they occur without relying
4895 #if !defined(_WIN32) && !defined(__OS2__)
4898 const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP };
4900 for (idx = 0; idx < SZ(catched_signals); idx++)
4902 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
4903 if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
4905 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
4906 #endif /* ifdef sun */
4908 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
4912 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
4914 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for SIGPIPE: %E");
4918 #else /* ifdef _WIN32 */
4919 # ifdef _WIN_CONSOLE
4921 * We *are* in a windows console app.
4922 * Print a verbose messages about FAQ's and such
4924 printf("%s", win32_blurb);
4925 # endif /* def _WIN_CONSOLE */
4926 #endif /* def _WIN32 */
4929 if (fuzz_input_type != NULL)
4931 exit(process_fuzzed_input(fuzz_input_type, fuzz_input_file));
4933 log_error(LOG_LEVEL_FATAL,
4934 "When compiled with fuzzing support, Privoxy should only be used for fuzzing. "
4935 "Various data structures are static which is unsafe when using threads.");
4940 exit(NULL == load_config());
4943 /* Initialize the CGI subsystem */
4944 cgi_init_error_messages();
4947 * If running on unix and without the --no-daemon
4948 * option, become a daemon. I.e. fork, detach
4949 * from tty and get process group leadership
4958 if (pid < 0) /* error */
4963 else if (pid != 0) /* parent */
4968 * must check for errors
4969 * child died due to missing files aso
4972 wpid = waitpid(pid, &status, WNOHANG);
4984 * stderr (fd 2) will be closed later on,
4985 * when the config file has been parsed.
4991 * Reserve fd 0 and 1 to prevent abort() and friends
4992 * from sending stuff to the clients or servers.
4994 fd = open("/dev/null", O_RDONLY);
4997 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
5001 if (dup2(fd, 0) == -1)
5003 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 0: %E");
5007 fd = open("/dev/null", O_WRONLY);
5010 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
5014 if (dup2(fd, 1) == -1)
5016 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 1: %E");
5021 #ifdef FEATURE_EXTERNAL_FILTERS
5022 for (fd = 0; fd < 3; fd++)
5024 mark_socket_for_close_on_execute(fd);
5030 } /* -END- if (daemon_mode) */
5033 * As soon as we have written the PID file, we can switch
5034 * to the user and group ID indicated by the --user option
5036 if (pidfile != NULL)
5038 write_pid_file(pidfile);
5042 if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
5044 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
5048 if (setgroups(1, &grp->gr_gid))
5050 log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
5053 else if (initgroups(pw->pw_name, pw->pw_gid))
5055 log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
5061 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
5063 /* Read the time zone file from /etc before doing chroot. */
5065 if (NULL != pre_chroot_nslookup_to_load_resolver
5066 && '\0' != pre_chroot_nslookup_to_load_resolver[0])
5068 /* Initialize resolver library. */
5069 (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
5071 if (chroot(pw->pw_dir) < 0)
5073 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
5077 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
5080 if (setuid(pw->pw_uid))
5082 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
5086 char putenv_dummy[64];
5088 strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
5089 if (putenv(putenv_dummy) != 0)
5091 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
5094 snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
5095 if (putenv(putenv_dummy) != 0)
5097 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
5103 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
5106 #endif /* defined unix */
5109 /* This will be FALSE unless the command line specified --service
5113 /* Yup, so now we must attempt to establish a connection
5114 * with the service dispatcher. This will only work if this
5115 * process was launched by the service control manager to
5116 * actually run as a service. If this isn't the case, i've
5117 * known it take around 30 seconds or so for the call to return.
5120 /* The StartServiceCtrlDispatcher won't return until the service is stopping */
5121 if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
5123 /* Service has run, and at this point is now being stopped, so just return */
5128 printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
5130 /* An error occurred. Usually it's because --service was wrongly specified
5131 * and we were unable to connect to the Service Control Dispatcher because
5132 * it wasn't expecting us and is therefore not listening.
5134 * For now, just continue below to call the listen_loop function.
5137 #endif /* def _WIN32 */
5147 /*********************************************************************
5149 * Function : bind_port_helper
5151 * Description : Bind the listen port. Handles logging, and aborts
5155 * 1 : haddr = Host address to bind to. Use NULL to bind to
5157 * 2 : hport = Specifies port to bind to.
5158 * 3 : backlog = Listen backlog.
5160 * Returns : Port that was opened.
5162 *********************************************************************/
5163 static jb_socket bind_port_helper(const char *haddr, int hport, int backlog)
5168 result = bind_port(haddr, hport, backlog, &bfd);
5172 const char *bind_address = (NULL != haddr) ? haddr : "INADDR_ANY";
5176 log_error(LOG_LEVEL_FATAL,
5177 "can't bind to %s:%d: There may be another Privoxy "
5178 "or some other proxy running on port %d",
5179 bind_address, hport, hport);
5182 log_error(LOG_LEVEL_FATAL,
5183 "can't bind to %s:%d: The hostname is not resolvable",
5184 bind_address, hport);
5187 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: %E",
5188 bind_address, hport);
5191 /* shouldn't get here */
5192 return JB_INVALID_SOCKET;
5197 if (bfd >= FD_SETSIZE)
5199 log_error(LOG_LEVEL_FATAL,
5200 "Bind socket number too high to use select(): %d >= %d",
5208 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
5213 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
5221 /*********************************************************************
5223 * Function : bind_ports_helper
5225 * Description : Bind the listen ports. Handles logging, and aborts
5229 * 1 : config = Privoxy configuration. Specifies ports
5231 * 2 : sockets = Preallocated array of opened sockets
5232 * corresponding to specification in config.
5233 * All non-opened sockets will be set to
5234 * JB_INVALID_SOCKET.
5236 * Returns : Nothing. Inspect sockets argument.
5238 *********************************************************************/
5239 static void bind_ports_helper(struct configuration_spec * config,
5240 jb_socket sockets[])
5244 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
5246 if (config->hport[i])
5248 sockets[i] = bind_port_helper(config->haddr[i],
5249 config->hport[i], config->listen_backlog);
5250 #if defined(FEATURE_ACCEPT_FILTER) && defined(SO_ACCEPTFILTER)
5251 if (config->enable_accept_filter && sockets[i] != JB_INVALID_SOCKET)
5253 struct accept_filter_arg af_options;
5254 bzero(&af_options, sizeof(af_options));
5255 strlcpy(af_options.af_name, "httpready", sizeof(af_options.af_name));
5256 if (setsockopt(sockets[i], SOL_SOCKET, SO_ACCEPTFILTER, &af_options,
5257 sizeof(af_options)))
5259 log_error(LOG_LEVEL_ERROR,
5260 "Enabling accept filter for socket %d failed: %E", sockets[i]);
5267 sockets[i] = JB_INVALID_SOCKET;
5270 config->need_bind = 0;
5274 /*********************************************************************
5276 * Function : close_ports_helper
5278 * Description : Close listenings ports.
5281 * 1 : sockets = Array of opened and non-opened sockets to
5282 * close. All sockets will be set to
5283 * JB_INVALID_SOCKET.
5285 * Returns : Nothing.
5287 *********************************************************************/
5288 static void close_ports_helper(jb_socket sockets[])
5292 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
5294 if (JB_INVALID_SOCKET != sockets[i])
5296 close_socket(sockets[i]);
5298 sockets[i] = JB_INVALID_SOCKET;
5304 /* Without this simple workaround we get this compiler warning from _beginthread
5305 * warning C4028: formal parameter 1 different from declaration
5307 void w32_service_listen_loop(void *p)
5311 #endif /* def _WIN32 */
5314 /*********************************************************************
5316 * Function : listen_loop
5318 * Description : bind the listen port and enter a "FOREVER" listening loop.
5324 *********************************************************************/
5325 static void listen_loop(void)
5327 struct client_states *csp_list = NULL;
5328 struct client_state *csp = NULL;
5329 jb_socket bfds[MAX_LISTENING_SOCKETS];
5330 struct configuration_spec *config;
5331 unsigned int active_threads = 0;
5332 #if defined(FEATURE_PTHREAD)
5333 pthread_attr_t attrs;
5335 pthread_attr_init(&attrs);
5336 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
5339 config = load_config();
5341 #ifdef FEATURE_CONNECTION_SHARING
5343 * XXX: Should be relocated once it no
5344 * longer needs to emit log messages.
5346 initialize_reusable_connections();
5347 #endif /* def FEATURE_CONNECTION_SHARING */
5349 bind_ports_helper(config, bfds);
5351 #ifdef FEATURE_GRACEFUL_TERMINATION
5352 while (!g_terminate)
5357 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(__OS2__)
5358 while (waitpid(-1, NULL, WNOHANG) > 0)
5360 /* zombie children */
5362 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) */
5365 * Free data that was used by died threads
5367 active_threads = sweep();
5371 * Re-open the errlog after HUP signal
5373 if (received_hup_signal)
5375 if (NULL != config->logfile)
5377 init_error_log(Argv[0], config->logfile);
5379 received_hup_signal = 0;
5383 csp_list = zalloc_or_die(sizeof(*csp_list));
5384 csp = &csp_list->csp;
5386 log_error(LOG_LEVEL_CONNECT,
5387 "Waiting for the next client connection. Currently active threads: %d",
5391 * This config may be outdated, but for accept_connection()
5392 * it's fresh enough.
5394 csp->config = config;
5396 if (!accept_connection(csp, bfds))
5398 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
5403 csp->flags |= CSP_FLAG_ACTIVE;
5404 csp->server_connection.sfd = JB_INVALID_SOCKET;
5406 csp->config = config = load_config();
5408 if (config->need_bind)
5411 * Since we were listening to the "old port", we will not see
5412 * a "listen" param change until the next request. So, at
5413 * least 1 more request must be made for us to find the new
5414 * setting. I am simply closing the old socket and binding the
5417 * Which-ever is correct, we will serve 1 more page via the
5418 * old settings. This should probably be a "show-status"
5419 * request. This should not be a so common of an operation
5420 * that this will hurt people's feelings.
5423 close_ports_helper(bfds);
5425 bind_ports_helper(config, bfds);
5428 #ifdef FEATURE_TOGGLE
5429 if (global_toggle_state)
5430 #endif /* def FEATURE_TOGGLE */
5432 csp->flags |= CSP_FLAG_TOGGLED_ON;
5435 if (run_loader(csp))
5437 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
5438 /* Never get here - LOG_LEVEL_FATAL causes program exit */
5442 if (block_acl(NULL,csp))
5444 log_error(LOG_LEVEL_CONNECT,
5445 "Connection from %s on %s (socket %d) dropped due to ACL",
5446 csp->ip_addr_str, csp->listen_addr_str, csp->cfd);
5447 close_socket(csp->cfd);
5448 freez(csp->ip_addr_str);
5449 freez(csp->listen_addr_str);
5453 #endif /* def FEATURE_ACL */
5455 if ((0 != config->max_client_connections)
5456 && (active_threads >= config->max_client_connections))
5458 log_error(LOG_LEVEL_CONNECT,
5459 "Rejecting connection from %s. Maximum number of connections reached.",
5461 write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
5462 strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
5463 close_socket(csp->cfd);
5464 freez(csp->ip_addr_str);
5465 freez(csp->listen_addr_str);
5470 /* add it to the list of clients */
5471 csp_list->next = clients->next;
5472 clients->next = csp_list;
5474 if (config->multi_threaded)
5478 /* this is a switch () statement in the C preprocessor - ugh */
5479 #undef SELECTED_ONE_OPTION
5481 /* Use Pthreads in preference to native code */
5482 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
5483 #define SELECTED_ONE_OPTION
5485 pthread_t the_thread;
5487 errno = pthread_create(&the_thread, &attrs,
5488 (void * (*)(void *))serve, csp);
5489 child_id = errno ? -1 : 0;
5493 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
5494 #define SELECTED_ONE_OPTION
5495 child_id = _beginthread(
5496 (void (*)(void *))serve,
5501 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
5502 #define SELECTED_ONE_OPTION
5503 child_id = _beginthread(
5504 (void(* _Optlink)(void*))serve,
5510 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
5511 #define SELECTED_ONE_OPTION
5513 thread_id tid = spawn_thread
5514 (server_thread, "server", B_NORMAL_PRIORITY, csp);
5516 if ((tid >= 0) && (resume_thread(tid) == B_OK))
5518 child_id = (int) tid;
5527 #if !defined(SELECTED_ONE_OPTION)
5530 /* This block is only needed when using fork().
5531 * When using threads, the server thread was
5532 * created and run by the call to _beginthread().
5534 if (child_id == 0) /* child */
5537 #ifdef FEATURE_TOGGLE
5538 int inherited_toggle_state = global_toggle_state;
5539 #endif /* def FEATURE_TOGGLE */
5544 * If we've been toggled or we've blocked the request, tell Mom
5547 #ifdef FEATURE_TOGGLE
5548 if (inherited_toggle_state != global_toggle_state)
5550 rc |= RC_FLAG_TOGGLED;
5552 #endif /* def FEATURE_TOGGLE */
5554 #ifdef FEATURE_STATISTICS
5555 if (csp->flags & CSP_FLAG_REJECTED)
5557 rc |= RC_FLAG_BLOCKED;
5559 #endif /* ndef FEATURE_STATISTICS */
5563 else if (child_id > 0) /* parent */
5565 /* in a fork()'d environment, the parent's
5566 * copy of the client socket and the CSP
5570 #if !defined(_WIN32) && !defined(__CYGWIN__)
5572 wait(&child_status);
5575 * Evaluate child's return code: If the child has
5576 * - been toggled, toggle ourselves
5577 * - blocked its request, bump up the stats counter
5580 #ifdef FEATURE_TOGGLE
5581 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
5583 global_toggle_state = !global_toggle_state;
5585 #endif /* def FEATURE_TOGGLE */
5587 #ifdef FEATURE_STATISTICS
5589 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
5593 #endif /* def FEATURE_STATISTICS */
5595 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
5596 close_socket(csp->cfd);
5597 csp->flags &= ~CSP_FLAG_ACTIVE;
5601 #undef SELECTED_ONE_OPTION
5602 /* end of cpp switch () */
5607 * Spawning the child failed, assume it's because
5608 * there are too many children running already.
5609 * XXX: If you assume ...
5611 log_error(LOG_LEVEL_ERROR,
5612 "Unable to take any additional connections: %E. Active threads: %d",
5614 write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
5615 strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
5616 close_socket(csp->cfd);
5617 csp->flags &= ~CSP_FLAG_ACTIVE;
5626 #if defined(FEATURE_PTHREAD)
5627 pthread_attr_destroy(&attrs);
5630 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
5632 #ifdef FEATURE_HTTPS_INSPECTION
5633 /* Clean up. Aim: free all memory (no leaks) */
5634 if (rng_seeded == 1)
5636 mbedtls_ctr_drbg_free(&ctr_drbg);
5637 mbedtls_entropy_free(&entropy);
5641 #ifdef FEATURE_GRACEFUL_TERMINATION
5643 log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
5645 unload_current_config_file();
5646 unload_current_actions_file();
5647 unload_current_re_filterfile();
5648 #ifdef FEATURE_TRUST
5649 unload_current_trust_file();
5652 if (config->multi_threaded)
5659 } while ((clients->next != NULL) && (--i > 0));
5663 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
5673 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
5674 /* Cleanup - remove taskbar icon etc. */
5679 #endif /* FEATURE_GRACEFUL_TERMINATION */