1 /*********************************************************************
3 * File : $Source: /cvsroot/ijbswa/current/jcc.c,v $
5 * Purpose : Main file. Contains main() method, main loop, and
6 * the main connection-handling function.
8 * Copyright : Written by and Copyright (C) 2001-2020 the
9 * Privoxy team. https://www.privoxy.org/
11 * Based on the Internet Junkbuster originally written
12 * by and Copyright (C) 1997 Anonymous Coders and
13 * Junkbusters Corporation. http://www.junkbusters.com
15 * This program is free software; you can redistribute it
16 * and/or modify it under the terms of the GNU General
17 * Public License as published by the Free Software
18 * Foundation; either version 2 of the License, or (at
19 * your option) any later version.
21 * This program is distributed in the hope that it will
22 * be useful, but WITHOUT ANY WARRANTY; without even the
23 * implied warranty of MERCHANTABILITY or FITNESS FOR A
24 * PARTICULAR PURPOSE. See the GNU General Public
25 * License for more details.
27 * The GNU General Public License should be included with
28 * this file. If not, you can view it at
29 * http://www.gnu.org/copyleft/gpl.html
30 * or write to the Free Software Foundation, Inc., 59
31 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
33 *********************************************************************/
39 #include <sys/types.h>
48 # ifndef FEATURE_PTHREAD
52 # include <winsock2.h>
55 # endif /* ndef FEATURE_PTHREAD */
60 # endif /* ndef _WIN_CONSOLE */
61 # include "w32svrapi.h"
63 #else /* ifndef _WIN32 */
65 # if !defined (__OS2__)
67 # include <sys/wait.h>
68 # endif /* ndef __OS2__ */
69 # include <sys/time.h>
70 # include <sys/stat.h>
71 # include <sys/ioctl.h>
74 #include <sys/termios.h>
85 # include <socket.h> /* BeOS has select() for sockets only. */
86 # include <OS.h> /* declarations for threads and stuff. */
89 # if defined(__EMX__) || defined(__OS2__)
90 # include <sys/select.h> /* OS/2/EMX needs a little help with select */
102 #endif /* def __GLIBC__ */
107 #warning poll() appears to be unavailable. Your platform will become unsupported in the future.
108 #endif /* HAVE_POLL */
115 #ifdef FEATURE_HTTPS_INSPECTION
121 #include "miscutil.h"
123 #include "jbsockets.h"
128 #include "urlmatch.h"
129 #ifdef FEATURE_CLIENT_TAGS
130 #include "client-tags.h"
134 struct client_states clients[1];
135 struct file_list files[1];
137 #ifdef FEATURE_STATISTICS
138 int urls_read = 0; /* total nr of urls read inc rejected */
139 int urls_rejected = 0; /* total nr of urls rejected */
140 #endif /* def FEATURE_STATISTICS */
142 #ifdef FEATURE_GRACEFUL_TERMINATION
146 #if !defined(_WIN32) && !defined(__OS2__)
147 static void sig_handler(int the_signal);
149 static int client_protocol_is_unsupported(const struct client_state *csp, char *req);
150 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers);
151 static jb_err get_server_headers(struct client_state *csp);
152 static const char *crunch_reason(const struct http_response *rsp);
153 static void send_crunch_response(struct client_state *csp, struct http_response *rsp);
154 static char *get_request_line(struct client_state *csp);
155 static jb_err receive_client_request(struct client_state *csp);
156 static jb_err parse_client_request(struct client_state *csp);
157 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line);
158 static jb_err change_request_destination(struct client_state *csp);
159 static void chat(struct client_state *csp);
160 static void serve(struct client_state *csp);
161 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
162 static void usage(const char *myname);
164 static void initialize_mutexes(void);
165 static jb_socket bind_port_helper(const char *haddr, int hport, int backlog);
166 static void bind_ports_helper(struct configuration_spec *config, jb_socket sockets[]);
167 static void close_ports_helper(jb_socket sockets[]);
168 static void listen_loop(void);
169 static void serve(struct client_state *csp);
172 static int32 server_thread(void *data);
173 #endif /* def __BEOS__ */
176 #define sleep(N) Sleep(((N) * 1000))
180 #define sleep(N) DosSleep(((N) * 100))
184 int process_fuzzed_input(char *fuzz_input_type, char *fuzz_input_file);
185 void show_fuzz_usage(const char *name);
188 #ifdef MUTEX_LOCKS_AVAILABLE
190 * XXX: Does the locking stuff really belong in this file?
192 privoxy_mutex_t log_mutex;
193 privoxy_mutex_t log_init_mutex;
194 privoxy_mutex_t connection_reuse_mutex;
196 #ifdef FEATURE_HTTPS_INSPECTION
197 privoxy_mutex_t certificate_mutex;
198 privoxy_mutex_t rng_mutex;
201 #ifdef FEATURE_EXTERNAL_FILTERS
202 privoxy_mutex_t external_filter_mutex;
204 #ifdef FEATURE_CLIENT_TAGS
205 privoxy_mutex_t client_tags_mutex;
208 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
209 privoxy_mutex_t resolver_mutex;
210 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
212 #ifndef HAVE_GMTIME_R
213 privoxy_mutex_t gmtime_mutex;
214 #endif /* ndef HAVE_GMTIME_R */
216 #ifndef HAVE_LOCALTIME_R
217 privoxy_mutex_t localtime_mutex;
218 #endif /* ndef HAVE_GMTIME_R */
220 #if !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM)
221 privoxy_mutex_t rand_mutex;
222 #endif /* !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM) */
224 #endif /* def MUTEX_LOCKS_AVAILABLE */
227 const char *basedir = NULL;
228 const char *pidfile = NULL;
229 static int received_hup_signal = 0;
230 #endif /* defined unix */
232 /* HTTP snipplets. */
233 static const char CSUCCEED[] =
234 "HTTP/1.1 200 Connection established\r\n\r\n";
236 static const char CHEADER[] =
237 "HTTP/1.1 400 Invalid header received from client\r\n"
238 "Content-Type: text/plain\r\n"
239 "Connection: close\r\n\r\n"
240 "Invalid header received from client.\r\n";
242 static const char FTP_RESPONSE[] =
243 "HTTP/1.1 400 Invalid request received from client\r\n"
244 "Content-Type: text/plain\r\n"
245 "Connection: close\r\n\r\n"
246 "Invalid request. Privoxy doesn't support FTP.\r\n";
248 static const char GOPHER_RESPONSE[] =
249 "HTTP/1.1 400 Invalid request received from client\r\n"
250 "Content-Type: text/plain\r\n"
251 "Connection: close\r\n\r\n"
252 "Invalid request. Privoxy doesn't support gopher.\r\n";
254 /* XXX: should be a template */
255 static const char MISSING_DESTINATION_RESPONSE[] =
256 "HTTP/1.1 400 Bad request received from client\r\n"
257 "Content-Type: text/plain\r\n"
258 "Connection: close\r\n\r\n"
259 "Bad request. Privoxy was unable to extract the destination.\r\n";
261 /* XXX: should be a template */
262 static const char INVALID_SERVER_HEADERS_RESPONSE[] =
263 "HTTP/1.1 502 Server or forwarder response invalid\r\n"
264 "Content-Type: text/plain\r\n"
265 "Connection: close\r\n\r\n"
266 "Bad response. The server or forwarder response doesn't look like HTTP.\r\n";
268 /* XXX: should be a template */
269 static const char MESSED_UP_REQUEST_RESPONSE[] =
270 "HTTP/1.1 400 Malformed request after rewriting\r\n"
271 "Content-Type: text/plain\r\n"
272 "Connection: close\r\n\r\n"
273 "Bad request. Messed up with header filters.\r\n";
275 static const char TOO_MANY_CONNECTIONS_RESPONSE[] =
276 "HTTP/1.1 503 Too many open connections\r\n"
277 "Content-Type: text/plain\r\n"
278 "Connection: close\r\n\r\n"
279 "Maximum number of open connections reached.\r\n";
281 static const char CLIENT_CONNECTION_TIMEOUT_RESPONSE[] =
282 "HTTP/1.1 504 Connection timeout\r\n"
283 "Content-Type: text/plain\r\n"
284 "Connection: close\r\n\r\n"
285 "The connection timed out because the client request didn't arrive in time.\r\n";
287 static const char CLIENT_BODY_PARSE_ERROR_RESPONSE[] =
288 "HTTP/1.1 400 Failed reading client body\r\n"
289 "Content-Type: text/plain\r\n"
290 "Connection: close\r\n\r\n"
291 "Failed parsing or buffering the chunk-encoded client body.\r\n";
293 static const char UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE[] =
294 "HTTP/1.1 417 Expecting too much\r\n"
295 "Content-Type: text/plain\r\n"
296 "Connection: close\r\n\r\n"
297 "Privoxy detected an unsupported Expect header value.\r\n";
299 /* A function to crunch a response */
300 typedef struct http_response *(*crunch_func_ptr)(struct client_state *);
302 /* Crunch function flags */
303 #define CF_NO_FLAGS 0
304 /* Cruncher applies to forced requests as well */
305 #define CF_IGNORE_FORCE 1
306 /* Crunched requests are counted for the block statistics */
307 #define CF_COUNT_AS_REJECT 2
309 /* A crunch function and its flags */
312 const crunch_func_ptr cruncher;
316 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[]);
318 /* Complete list of cruncher functions */
319 static const struct cruncher crunchers_all[] = {
320 { direct_response, CF_COUNT_AS_REJECT|CF_IGNORE_FORCE},
321 { block_url, CF_COUNT_AS_REJECT },
323 { trust_url, CF_COUNT_AS_REJECT },
324 #endif /* def FEATURE_TRUST */
325 { redirect_url, CF_NO_FLAGS },
326 { dispatch_cgi, CF_IGNORE_FORCE},
330 /* Light version, used after tags are applied */
331 static const struct cruncher crunchers_light[] = {
332 { block_url, CF_COUNT_AS_REJECT },
333 { redirect_url, CF_NO_FLAGS },
339 * XXX: Don't we really mean
345 #if !defined(_WIN32) && !defined(__OS2__)
346 /*********************************************************************
348 * Function : sig_handler
350 * Description : Signal handler for different signals.
351 * Exit gracefully on TERM and INT
352 * or set a flag that will cause the errlog
353 * to be reopened by the main thread on HUP.
356 * 1 : the_signal = the signal cause this function to call
360 *********************************************************************/
361 static void sig_handler(int the_signal)
367 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
379 received_hup_signal = 1;
385 * We shouldn't be here, unless we catch signals
386 * in main() that we can't handle here!
388 log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
396 /*********************************************************************
398 * Function : get_write_delay
400 * Description : Parse the delay-response parameter.
403 * 1 : csp = Current client state (buffers, headers, etc...)
405 * Returns : Number of milliseconds to delay writes.
407 *********************************************************************/
408 static unsigned int get_write_delay(const struct client_state *csp)
414 if ((csp->action->flags & ACTION_DELAY_RESPONSE) == 0)
418 newval = csp->action->string[ACTION_STRING_DELAY_RESPONSE];
420 delay = (unsigned)strtol(newval, &endptr, 0);
423 log_error(LOG_LEVEL_FATAL,
424 "Invalid delay-response{} parameter: '%s'", newval);
432 /*********************************************************************
434 * Function : client_protocol_is_unsupported
436 * Description : Checks if the client used a known unsupported
437 * protocol and deals with it by sending an error
441 * 1 : csp = Current client state (buffers, headers, etc...)
442 * 2 : req = the first request line send by the client
444 * Returns : TRUE if an error response has been generated, or
445 * FALSE if the request doesn't look invalid.
447 *********************************************************************/
448 static int client_protocol_is_unsupported(const struct client_state *csp, char *req)
451 * If it's a FTP or gopher request, we don't support it.
453 * These checks are better than nothing, but they might
454 * not work in all configurations and some clients might
455 * have problems digesting the answer.
457 * They should, however, never cause more problems than
458 * Privoxy's old behaviour (returning the misleading HTML
461 * "Could not resolve http://(ftp|gopher)://example.org").
463 if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
465 const char *response = NULL;
466 const char *protocol = NULL;
468 if (!strncmpic(req, "GET ftp://", 10))
470 response = FTP_RESPONSE;
475 response = GOPHER_RESPONSE;
478 log_error(LOG_LEVEL_ERROR,
479 "%s tried to use Privoxy as %s proxy: %s",
480 csp->ip_addr_str, protocol, req);
481 log_error(LOG_LEVEL_CLF,
482 "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, req);
484 write_socket_delayed(csp->cfd, response, strlen(response),
485 get_write_delay(csp));
494 /*********************************************************************
496 * Function : client_has_unsupported_expectations
498 * Description : Checks if the client used an unsupported expectation
499 * in which case an error message is delivered.
502 * 1 : csp = Current client state (buffers, headers, etc...)
504 * Returns : TRUE if an error response has been generated, or
505 * FALSE if the request doesn't look invalid.
507 *********************************************************************/
508 static int client_has_unsupported_expectations(const struct client_state *csp)
510 if ((csp->flags & CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION))
512 log_error(LOG_LEVEL_ERROR,
513 "Rejecting request from client %s with unsupported Expect header value",
515 log_error(LOG_LEVEL_CLF,
516 "%s - - [%T] \"%s\" 417 0", csp->ip_addr_str, csp->http->cmd);
517 write_socket_delayed(csp->cfd,
518 UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE,
519 strlen(UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE),
520 get_write_delay(csp));
530 /*********************************************************************
532 * Function : get_request_destination_elsewhere
534 * Description : If the client's request was redirected into
535 * Privoxy without the client's knowledge,
536 * the request line lacks the destination host.
538 * This function tries to get it elsewhere,
539 * provided accept-intercepted-requests is enabled.
541 * "Elsewhere" currently only means "Host: header",
542 * but in the future we may ask the redirecting
543 * packet filter to look the destination up.
545 * If the destination stays unknown, an error
546 * response is send to the client and headers
547 * are freed so that chat() can return directly.
550 * 1 : csp = Current client state (buffers, headers, etc...)
551 * 2 : headers = a header list
553 * Returns : JB_ERR_OK if the destination is now known, or
554 * JB_ERR_PARSE if it isn't.
556 *********************************************************************/
557 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
561 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
563 log_error(LOG_LEVEL_ERROR, "%s's request: \'%s\' is invalid."
564 " Privoxy isn't configured to accept intercepted requests.",
565 csp->ip_addr_str, csp->http->cmd);
566 /* XXX: Use correct size */
567 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
568 csp->ip_addr_str, csp->http->cmd);
570 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER),
571 get_write_delay(csp));
572 destroy_list(headers);
576 else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
578 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
579 /* Split the domain we just got for pattern matching */
580 init_domain_components(csp->http);
587 /* We can't work without destination. Go spread the news.*/
589 req = list_to_text(headers);
591 /* XXX: Use correct size */
592 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
593 csp->ip_addr_str, csp->http->cmd);
594 log_error(LOG_LEVEL_ERROR,
595 "Privoxy was unable to get the destination for %s's request:\n%s\n%s",
596 csp->ip_addr_str, csp->http->cmd, req);
599 write_socket_delayed(csp->cfd, MISSING_DESTINATION_RESPONSE,
600 strlen(MISSING_DESTINATION_RESPONSE), get_write_delay(csp));
601 destroy_list(headers);
606 * TODO: If available, use PF's ioctl DIOCNATLOOK as last resort
607 * to get the destination IP address, use it as host directly
608 * or do a reverse DNS lookup first.
613 /*********************************************************************
615 * Function : get_server_headers
617 * Description : Parses server headers in iob and fills them
618 * into csp->headers so that they can later be
622 * 1 : csp = Current client state (buffers, headers, etc...)
624 * Returns : JB_ERR_OK if everything went fine, or
625 * JB_ERR_PARSE if the headers were incomplete.
627 *********************************************************************/
628 static jb_err get_server_headers(struct client_state *csp)
630 int continue_hack_in_da_house = 0;
633 while (((header = get_header(csp->iob)) != NULL) || continue_hack_in_da_house)
638 * continue hack in da house. Ignore the ending of
639 * this head and continue enlisting header lines.
640 * The reason is described below.
642 enlist(csp->headers, "");
643 continue_hack_in_da_house = 0;
646 else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
649 * It's a bodyless continue response, don't
650 * stop header parsing after reaching its end.
652 * As a result Privoxy will concatenate the
653 * next response's head and parse and deliver
654 * the headers as if they belonged to one request.
656 * The client will separate them because of the
657 * empty line between them.
659 * XXX: What we're doing here is clearly against
660 * the intended purpose of the continue header,
661 * and under some conditions (HTTP/1.0 client request)
662 * it's a standard violation.
664 * Anyway, "sort of against the spec" is preferable
665 * to "always getting confused by Continue responses"
666 * (Privoxy's behaviour before this hack was added)
668 log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
669 continue_hack_in_da_house = 1;
671 else if (*header == '\0')
674 * If the header is empty, but the Continue hack
675 * isn't active, we can assume that we reached the
676 * end of the buffer before we hit the end of the
679 * Inform the caller an let it decide how to handle it.
684 if (JB_ERR_MEMORY == enlist(csp->headers, header))
687 * XXX: Should we quit the request and return a
688 * out of memory error page instead?
690 log_error(LOG_LEVEL_ERROR,
691 "Out of memory while enlisting server headers. %s lost.",
701 /*********************************************************************
703 * Function : crunch_reason
705 * Description : Translates the crunch reason code into a string.
708 * 1 : rsp = a http_response
710 * Returns : A string with the crunch reason or an error description.
712 *********************************************************************/
713 static const char *crunch_reason(const struct http_response *rsp)
715 char * reason = NULL;
720 return "Internal error while searching for crunch reason";
723 switch (rsp->crunch_reason)
726 reason = "Unsupported HTTP feature";
732 reason = "Untrusted";
735 reason = "Redirected";
741 reason = "DNS failure";
743 case FORWARDING_FAILED:
744 reason = "Forwarding failed";
747 reason = "Connection failure";
750 reason = "Out of memory (may mask other reasons)";
752 case CONNECTION_TIMEOUT:
753 reason = "Connection timeout";
756 reason = "No server data received";
759 reason = "No reason recorded";
767 /*********************************************************************
769 * Function : log_applied_actions
771 * Description : Logs the applied actions if LOG_LEVEL_ACTIONS is
775 * 1 : actions = Current action spec to log
779 *********************************************************************/
780 static void log_applied_actions(const struct current_action_spec *actions)
783 * The conversion to text requires lots of memory allocations so
784 * we only do the conversion if the user is actually interested.
786 if (debug_level_is_enabled(LOG_LEVEL_ACTIONS))
788 char *actions_as_text = actions_to_line_of_text(actions);
789 log_error(LOG_LEVEL_ACTIONS, "%s", actions_as_text);
790 freez(actions_as_text);
795 /*********************************************************************
797 * Function : send_crunch_response
799 * Description : Delivers already prepared response for
800 * intercepted requests, logs the interception
801 * and frees the response.
804 * 1 : csp = Current client state (buffers, headers, etc...)
805 * 2 : rsp = Fully prepared response. Will be freed on exit.
809 *********************************************************************/
810 static void send_crunch_response(struct client_state *csp, struct http_response *rsp)
812 const struct http_request *http = csp->http;
816 assert(rsp->head != NULL);
820 log_error(LOG_LEVEL_FATAL, "NULL response in send_crunch_response.");
824 * Extract the status code from the actual head
825 * that will be send to the client. It is the only
826 * way to get it right for all requests, including
827 * the fixed ones for out-of-memory problems.
829 * A head starts like this: 'HTTP/1.1 200...'
833 status_code[0] = rsp->head[9];
834 status_code[1] = rsp->head[10];
835 status_code[2] = rsp->head[11];
836 status_code[3] = '\0';
838 /* Log that the request was crunched and why. */
839 log_applied_actions(csp->action);
840 log_error(LOG_LEVEL_CRUNCH, "%s: %s", crunch_reason(rsp), http->url);
841 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" %s %u",
842 csp->ip_addr_str, http->ocmd, status_code, rsp->content_length);
844 /* Write the answer to the client */
845 #ifdef FEATURE_HTTPS_INSPECTION
846 if (client_use_ssl(csp))
848 if ((ssl_send_data(&(csp->mbedtls_client_attr.ssl),
849 (const unsigned char *)rsp->head, rsp->head_length) < 0)
850 || (ssl_send_data(&(csp->mbedtls_client_attr.ssl),
851 (const unsigned char *)rsp->body, rsp->content_length) < 0))
853 /* There is nothing we can do about it. */
854 log_error(LOG_LEVEL_CONNECT, "Couldn't deliver the error message "
855 "for %s through client socket %d using TLS/SSL",
856 http->url, csp->cfd);
862 if (write_socket_delayed(csp->cfd, rsp->head, rsp->head_length,
863 get_write_delay(csp))
864 || write_socket_delayed(csp->cfd, rsp->body, rsp->content_length,
865 get_write_delay(csp)))
867 /* There is nothing we can do about it. */
868 log_error(LOG_LEVEL_CONNECT,
869 "Couldn't deliver the error message for %s through client socket %d: %E",
870 http->url, csp->cfd);
874 /* Clean up and return */
875 if (cgi_error_memory() != rsp)
877 free_http_response(rsp);
883 /*********************************************************************
885 * Function : crunch_response_triggered
887 * Description : Checks if the request has to be crunched,
888 * and delivers the crunch response if necessary.
891 * 1 : csp = Current client state (buffers, headers, etc...)
892 * 2 : crunchers = list of cruncher functions to run
894 * Returns : TRUE if the request was answered with a crunch response
897 *********************************************************************/
898 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[])
900 struct http_response *rsp = NULL;
901 const struct cruncher *c;
904 * If CGI request crunching is disabled,
905 * check the CGI dispatcher out of order to
906 * prevent unintentional blocks or redirects.
908 if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_CRUNCHING)
909 && (NULL != (rsp = dispatch_cgi(csp))))
911 /* Deliver, log and free the interception response. */
912 send_crunch_response(csp, rsp);
913 csp->flags |= CSP_FLAG_CRUNCHED;
917 for (c = crunchers; c->cruncher != NULL; c++)
920 * Check the cruncher if either Privoxy is toggled
921 * on and the request isn't forced, or if the cruncher
922 * applies to forced requests as well.
924 if (((csp->flags & CSP_FLAG_TOGGLED_ON) &&
925 !(csp->flags & CSP_FLAG_FORCED)) ||
926 (c->flags & CF_IGNORE_FORCE))
928 rsp = c->cruncher(csp);
931 /* Deliver, log and free the interception response. */
932 send_crunch_response(csp, rsp);
933 csp->flags |= CSP_FLAG_CRUNCHED;
934 #ifdef FEATURE_STATISTICS
935 if (c->flags & CF_COUNT_AS_REJECT)
937 csp->flags |= CSP_FLAG_REJECTED;
939 #endif /* def FEATURE_STATISTICS */
950 /*********************************************************************
952 * Function : build_request_line
954 * Description : Builds the HTTP request line.
956 * If a HTTP forwarder is used it expects the whole URL,
957 * web servers only get the path.
960 * 1 : csp = Current client state (buffers, headers, etc...)
961 * 2 : fwd = The forwarding spec used for the request
962 * XXX: Should use http->fwd instead.
963 * 3 : request_line = The old request line which will be replaced.
965 * Returns : Nothing. Terminates in case of memory problems.
967 *********************************************************************/
968 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line)
970 struct http_request *http = csp->http;
973 * Downgrade http version from 1.1 to 1.0
974 * if +downgrade action applies.
976 if ((csp->action->flags & ACTION_DOWNGRADE)
977 && (!strcmpic(http->ver, "HTTP/1.1")))
980 http->ver = strdup_or_die("HTTP/1.0");
984 * Rebuild the request line.
986 freez(*request_line);
987 *request_line = strdup(http->gpc);
988 string_append(request_line, " ");
990 if (fwd->forward_host && fwd->type != FORWARD_WEBSERVER)
992 string_append(request_line, http->url);
996 string_append(request_line, http->path);
998 string_append(request_line, " ");
999 string_append(request_line, http->ver);
1001 if (*request_line == NULL)
1003 log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
1005 log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", *request_line);
1009 /*********************************************************************
1011 * Function : change_request_destination
1013 * Description : Parse a (rewritten) request line and regenerate
1014 * the http request data.
1017 * 1 : csp = Current client state (buffers, headers, etc...)
1019 * Returns : Forwards the parse_http_request() return code.
1020 * Terminates in case of memory problems.
1022 *********************************************************************/
1023 static jb_err change_request_destination(struct client_state *csp)
1025 struct http_request *http = csp->http;
1028 log_error(LOG_LEVEL_REDIRECTS, "Rewrite detected: %s",
1029 csp->headers->first->str);
1030 free_http_request(http);
1031 err = parse_http_request(csp->headers->first->str, http);
1032 if (JB_ERR_OK != err)
1034 log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
1035 jb_err_to_string(err));
1042 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1043 /*********************************************************************
1045 * Function : server_response_is_complete
1047 * Description : Determines whether we should stop reading
1048 * from the server socket.
1051 * 1 : csp = Current client state (buffers, headers, etc...)
1052 * 2 : content_length = Length of content received so far.
1054 * Returns : TRUE if the response is complete,
1057 *********************************************************************/
1058 static int server_response_is_complete(struct client_state *csp,
1059 unsigned long long content_length)
1061 int content_length_known = !!(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET);
1063 if (!strcmpic(csp->http->gpc, "HEAD"))
1066 * "HEAD" implies no body, we are thus expecting
1067 * no content. XXX: incomplete "list" of methods?
1069 csp->expected_content_length = 0;
1070 content_length_known = TRUE;
1071 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1074 if (csp->http->status == 204 || csp->http->status == 304)
1077 * Expect no body. XXX: incomplete "list" of status codes?
1079 csp->expected_content_length = 0;
1080 content_length_known = TRUE;
1081 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1084 return (content_length_known && ((0 == csp->expected_content_length)
1085 || (csp->expected_content_length <= content_length)));
1089 #ifdef FEATURE_CONNECTION_SHARING
1090 /*********************************************************************
1092 * Function : wait_for_alive_connections
1094 * Description : Waits for alive connections to timeout.
1100 *********************************************************************/
1101 static void wait_for_alive_connections(void)
1103 int connections_alive = close_unusable_connections();
1105 while (0 < connections_alive)
1107 log_error(LOG_LEVEL_CONNECT,
1108 "Waiting for %d connections to timeout.",
1111 connections_alive = close_unusable_connections();
1114 log_error(LOG_LEVEL_CONNECT, "No connections to wait for left.");
1117 #endif /* def FEATURE_CONNECTION_SHARING */
1120 /*********************************************************************
1122 * Function : save_connection_destination
1124 * Description : Remembers a connection for reuse later on.
1127 * 1 : sfd = Open socket to remember.
1128 * 2 : http = The destination for the connection.
1129 * 3 : fwd = The forwarder settings used.
1130 * 4 : server_connection = storage.
1134 *********************************************************************/
1135 void save_connection_destination(jb_socket sfd,
1136 const struct http_request *http,
1137 const struct forward_spec *fwd,
1138 struct reusable_connection *server_connection)
1140 assert(sfd != JB_INVALID_SOCKET);
1141 assert(NULL != http->host);
1143 server_connection->sfd = sfd;
1144 server_connection->host = strdup_or_die(http->host);
1145 server_connection->port = http->port;
1147 assert(NULL != fwd);
1148 assert(server_connection->gateway_host == NULL);
1149 assert(server_connection->gateway_port == 0);
1150 assert(server_connection->forwarder_type == 0);
1151 assert(server_connection->forward_host == NULL);
1152 assert(server_connection->forward_port == 0);
1154 server_connection->forwarder_type = fwd->type;
1155 if (NULL != fwd->gateway_host)
1157 server_connection->gateway_host = strdup_or_die(fwd->gateway_host);
1161 server_connection->gateway_host = NULL;
1163 server_connection->gateway_port = fwd->gateway_port;
1165 if (NULL != fwd->forward_host)
1167 server_connection->forward_host = strdup_or_die(fwd->forward_host);
1171 server_connection->forward_host = NULL;
1173 server_connection->forward_port = fwd->forward_port;
1177 /*********************************************************************
1179 * Function : verify_request_length
1181 * Description : Checks if we already got the whole client requests
1182 * and sets CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ if
1185 * Data that doesn't belong to the current request is
1186 * either thrown away to let the client retry on a clean
1187 * socket, or stashed to be dealt with after the current
1188 * request is served.
1191 * 1 : csp = Current client state (buffers, headers, etc...)
1195 *********************************************************************/
1196 static void verify_request_length(struct client_state *csp)
1198 unsigned long long buffered_request_bytes =
1199 (unsigned long long)(csp->client_iob->eod - csp->client_iob->cur);
1201 if ((csp->expected_client_content_length != 0)
1202 && (buffered_request_bytes != 0))
1204 if (csp->expected_client_content_length >= buffered_request_bytes)
1206 csp->expected_client_content_length -= buffered_request_bytes;
1207 log_error(LOG_LEVEL_CONNECT, "Reduced expected bytes to %llu "
1208 "to account for the %llu ones we already got.",
1209 csp->expected_client_content_length, buffered_request_bytes);
1213 assert(csp->client_iob->eod > csp->client_iob->cur + csp->expected_client_content_length);
1214 csp->client_iob->eod = csp->client_iob->cur + csp->expected_client_content_length;
1215 log_error(LOG_LEVEL_CONNECT, "Reducing expected bytes to 0. "
1216 "Marking the server socket tainted after throwing %llu bytes away.",
1217 buffered_request_bytes - csp->expected_client_content_length);
1218 csp->expected_client_content_length = 0;
1219 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1222 if (csp->expected_client_content_length == 0)
1224 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1228 if (!(csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ)
1229 && ((csp->client_iob->cur < csp->client_iob->eod)
1230 || (csp->expected_client_content_length != 0)))
1232 if (strcmpic(csp->http->gpc, "GET")
1233 && strcmpic(csp->http->gpc, "HEAD")
1234 && strcmpic(csp->http->gpc, "TRACE")
1235 && strcmpic(csp->http->gpc, "OPTIONS")
1236 && strcmpic(csp->http->gpc, "DELETE"))
1238 /* XXX: this is an incomplete hack */
1239 csp->flags &= ~CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1240 log_error(LOG_LEVEL_CONNECT, "There better be a request body.");
1244 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1246 if ((csp->config->feature_flags & RUNTIME_FEATURE_TOLERATE_PIPELINING) == 0)
1248 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1249 log_error(LOG_LEVEL_CONNECT,
1250 "Possible pipeline attempt detected. The connection will not "
1251 "be kept alive and we will only serve the first request.");
1252 /* Nuke the pipelined requests from orbit, just to be sure. */
1253 clear_iob(csp->client_iob);
1258 * Keep the pipelined data around for now, we'll deal with
1259 * it once we're done serving the current request.
1261 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
1262 assert(csp->client_iob->eod >= csp->client_iob->cur);
1263 log_error(LOG_LEVEL_CONNECT, "Complete client request followed by "
1264 "%d bytes of pipelined data received.",
1265 (int)(csp->client_iob->eod - csp->client_iob->cur));
1271 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1272 log_error(LOG_LEVEL_CONNECT, "Complete client request received.");
1275 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1278 /*********************************************************************
1280 * Function : mark_server_socket_tainted
1282 * Description : Makes sure we don't reuse a server socket
1283 * (if we didn't read everything the server sent
1284 * us reusing the socket would lead to garbage).
1287 * 1 : csp = Current client state (buffers, headers, etc...)
1291 *********************************************************************/
1292 static void mark_server_socket_tainted(struct client_state *csp)
1295 * For consistency we always mark the server socket
1296 * tainted, however, to reduce the log noise we only
1297 * emit a log message if the server socket could have
1298 * actually been reused.
1300 if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
1301 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED))
1303 log_error(LOG_LEVEL_CONNECT,
1304 "Marking the server socket %d tainted.",
1305 csp->server_connection.sfd);
1307 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1310 /*********************************************************************
1312 * Function : get_request_line
1314 * Description : Read the client request line.
1317 * 1 : csp = Current client state (buffers, headers, etc...)
1319 * Returns : Pointer to request line or NULL in case of errors.
1321 *********************************************************************/
1322 static char *get_request_line(struct client_state *csp)
1324 char buf[BUFFER_SIZE];
1325 char *request_line = NULL;
1328 memset(buf, 0, sizeof(buf));
1330 if ((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
1333 * If there are multiple pipelined requests waiting,
1334 * the flag will be set again once the next request
1337 csp->flags &= ~CSP_FLAG_PIPELINED_REQUEST_WAITING;
1339 request_line = get_header(csp->client_iob);
1340 if ((NULL != request_line) && ('\0' != *request_line))
1342 return request_line;
1346 log_error(LOG_LEVEL_CONNECT, "No complete request line "
1347 "received yet. Continuing reading from %d.", csp->cfd);
1355 0 == (csp->flags & CSP_FLAG_FUZZED_INPUT) &&
1357 !data_is_available(csp->cfd, csp->config->socket_timeout)
1360 if (socket_is_still_alive(csp->cfd))
1362 log_error(LOG_LEVEL_CONNECT,
1363 "No request line on socket %d received in time. Timeout: %d.",
1364 csp->cfd, csp->config->socket_timeout);
1365 write_socket_delayed(csp->cfd, CLIENT_CONNECTION_TIMEOUT_RESPONSE,
1366 strlen(CLIENT_CONNECTION_TIMEOUT_RESPONSE),
1367 get_write_delay(csp));
1371 log_error(LOG_LEVEL_CONNECT,
1372 "The client side of the connection on socket %d got "
1373 "closed without sending a complete request line.", csp->cfd);
1378 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1380 if (len <= 0) return NULL;
1383 * If there is no memory left for buffering the
1384 * request, there is nothing we can do but hang up
1386 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1391 request_line = get_header(csp->client_iob);
1393 } while ((NULL != request_line) && ('\0' == *request_line));
1395 return request_line;
1401 CHUNK_STATUS_MISSING_DATA,
1402 CHUNK_STATUS_BODY_COMPLETE,
1403 CHUNK_STATUS_PARSE_ERROR
1407 /*********************************************************************
1409 * Function : chunked_body_is_complete
1411 * Description : Figures out whether or not a chunked body is complete.
1413 * Currently it always starts at the beginning of the
1414 * buffer which is somewhat wasteful and prevents Privoxy
1415 * from starting to forward the correctly parsed chunks
1416 * as soon as theoretically possible.
1418 * Should be modified to work with a common buffer,
1419 * and allow the caller to skip already parsed chunks.
1421 * This would allow the function to be used for unbuffered
1422 * response bodies as well.
1425 * 1 : iob = Buffer with the body to check.
1426 * 2 : length = Length of complete body
1428 * Returns : Enum with the result of the check.
1430 *********************************************************************/
1431 static enum chunk_status chunked_body_is_complete(struct iob *iob, size_t *length)
1433 unsigned int chunksize;
1439 * We need at least a single digit, followed by "\r\n",
1440 * followed by an unknown amount of data, followed by "\r\n".
1442 if (p + 5 > iob->eod)
1444 return CHUNK_STATUS_MISSING_DATA;
1446 if (sscanf(p, "%x", &chunksize) != 1)
1448 return CHUNK_STATUS_PARSE_ERROR;
1452 * We want at least a single digit, followed by "\r\n",
1453 * followed by the specified amount of data, followed by "\r\n".
1455 if (p + chunksize + 5 > iob->eod)
1457 return CHUNK_STATUS_MISSING_DATA;
1460 /* Skip chunk-size. */
1461 p = strstr(p, "\r\n");
1464 return CHUNK_STATUS_PARSE_ERROR;
1466 /* Move beyond the chunkdata. */
1469 /* There should be another "\r\n" to skip */
1470 if (memcmp(p, "\r\n", 2))
1472 return CHUNK_STATUS_PARSE_ERROR;
1475 } while (chunksize > 0U);
1477 *length = (size_t)(p - iob->cur);
1478 assert(*length <= (size_t)(iob->eod - iob->cur));
1479 assert(p <= iob->eod);
1481 return CHUNK_STATUS_BODY_COMPLETE;
1486 /*********************************************************************
1488 * Function : receive_chunked_client_request_body
1490 * Description : Read the chunk-encoded client request body.
1491 * Failures are dealt with.
1494 * 1 : csp = Current client state (buffers, headers, etc...)
1496 * Returns : JB_ERR_OK or JB_ERR_PARSE
1498 *********************************************************************/
1499 static jb_err receive_chunked_client_request_body(struct client_state *csp)
1502 enum chunk_status status;
1504 while (CHUNK_STATUS_MISSING_DATA ==
1505 (status = chunked_body_is_complete(csp->client_iob, &body_length)))
1507 char buf[BUFFER_SIZE];
1510 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1512 log_error(LOG_LEVEL_ERROR,
1513 "Timeout while waiting for the client body.");
1516 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1519 log_error(LOG_LEVEL_ERROR, "Read the client body failed: %E");
1522 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1527 if (status != CHUNK_STATUS_BODY_COMPLETE)
1529 write_socket_delayed(csp->cfd, CLIENT_BODY_PARSE_ERROR_RESPONSE,
1530 strlen(CLIENT_BODY_PARSE_ERROR_RESPONSE), get_write_delay(csp));
1531 log_error(LOG_LEVEL_CLF,
1532 "%s - - [%T] \"Failed reading chunked client body\" 400 0", csp->ip_addr_str);
1533 return JB_ERR_PARSE;
1535 log_error(LOG_LEVEL_CONNECT,
1536 "Chunked client body completely read. Length: %d", body_length);
1537 csp->expected_client_content_length = body_length;
1545 /*********************************************************************
1547 * Function : fuzz_chunked_transfer_encoding
1549 * Description : Treat the fuzzed input as chunked transfer encoding
1550 * to check and dechunk.
1553 * 1 : csp = Used to store the data.
1554 * 2 : fuzz_input_file = File to read the input from.
1556 * Returns : Result of dechunking
1558 *********************************************************************/
1559 extern int fuzz_chunked_transfer_encoding(struct client_state *csp, char *fuzz_input_file)
1562 size_t size = (size_t)(csp->iob->eod - csp->iob->cur);
1563 enum chunk_status status;
1565 status = chunked_body_is_complete(csp->iob, &length);
1566 if (CHUNK_STATUS_BODY_COMPLETE != status)
1568 log_error(LOG_LEVEL_INFO, "Chunked body is incomplete or invalid");
1571 return (JB_ERR_OK == remove_chunked_transfer_coding(csp->iob->cur, &size));
1576 /*********************************************************************
1578 * Function : fuzz_client_request
1580 * Description : Try to get a client request from the fuzzed input.
1583 * 1 : csp = Current client state (buffers, headers, etc...)
1584 * 2 : fuzz_input_file = File to read the input from.
1586 * Returns : Result of fuzzing.
1588 *********************************************************************/
1589 extern int fuzz_client_request(struct client_state *csp, char *fuzz_input_file)
1594 csp->ip_addr_str = "fuzzer";
1596 if (strcmp(fuzz_input_file, "-") != 0)
1598 log_error(LOG_LEVEL_FATAL,
1599 "Fuzzed client requests can currenty only be read from stdin (-).");
1601 err = receive_client_request(csp);
1602 if (err != JB_ERR_OK)
1606 err = parse_client_request(csp);
1607 if (err != JB_ERR_OK)
1615 #endif /* def FUZZ */
1618 #ifdef FEATURE_FORCE_LOAD
1619 /*********************************************************************
1621 * Function : force_required
1623 * Description : Checks a request line to see if it contains
1624 * the FORCE_PREFIX. If it does, it is removed
1625 * unless enforcing requests has beend disabled.
1628 * 1 : request_line = HTTP request line
1630 * Returns : TRUE if force is required, FALSE otherwise.
1632 *********************************************************************/
1633 static int force_required(const struct client_state *csp, char *request_line)
1637 p = strstr(request_line, "http://");
1641 p += strlen("http://");
1645 /* Intercepted request usually don't specify the protocol. */
1649 /* Go to the beginning of the path */
1654 * If the path is missing the request line is invalid and we
1655 * are done here. The client-visible rejection happens later on.
1660 if (0 == strncmpic(p, FORCE_PREFIX, strlen(FORCE_PREFIX) - 1))
1662 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS))
1664 /* XXX: Should clean more carefully */
1665 strclean(request_line, FORCE_PREFIX);
1666 log_error(LOG_LEVEL_FORCE,
1667 "Enforcing request: \"%s\".", request_line);
1671 log_error(LOG_LEVEL_FORCE,
1672 "Ignored force prefix in request: \"%s\".", request_line);
1678 #endif /* def FEATURE_FORCE_LOAD */
1681 /*********************************************************************
1683 * Function : receive_client_request
1685 * Description : Read the client's request (more precisely the
1686 * client headers) and answer it if necessary.
1689 * 1 : csp = Current client state (buffers, headers, etc...)
1691 * Returns : JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
1693 *********************************************************************/
1694 static jb_err receive_client_request(struct client_state *csp)
1696 char buf[BUFFER_SIZE];
1699 struct http_request *http;
1703 /* Temporary copy of the client's headers before they get enlisted in csp->headers */
1704 struct list header_list;
1705 struct list *headers = &header_list;
1707 /* We don't care if the arriving data is a valid HTTP request or not. */
1708 csp->requests_received_total++;
1712 memset(buf, 0, sizeof(buf));
1714 req = get_request_line(csp);
1717 mark_server_socket_tainted(csp);
1718 return JB_ERR_PARSE;
1720 assert(*req != '\0');
1722 if (client_protocol_is_unsupported(csp, req))
1724 return JB_ERR_PARSE;
1727 #ifdef FEATURE_FORCE_LOAD
1728 if (force_required(csp, req))
1730 csp->flags |= CSP_FLAG_FORCED;
1732 #endif /* def FEATURE_FORCE_LOAD */
1734 err = parse_http_request(req, http);
1736 if (JB_ERR_OK != err)
1738 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER),
1739 get_write_delay(csp));
1740 /* XXX: Use correct size */
1741 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1742 log_error(LOG_LEVEL_ERROR,
1743 "Couldn't parse request line received from %s: %s",
1744 csp->ip_addr_str, jb_err_to_string(err));
1746 free_http_request(http);
1747 return JB_ERR_PARSE;
1750 /* grab the rest of the client's headers */
1754 p = get_header(csp->client_iob);
1758 /* There are no additional headers to read. */
1765 * We didn't receive a complete header
1766 * line yet, get the rest of it.
1768 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1770 log_error(LOG_LEVEL_ERROR,
1771 "Stopped grabbing the client headers.");
1772 destroy_list(headers);
1773 return JB_ERR_PARSE;
1776 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1779 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1780 destroy_list(headers);
1781 return JB_ERR_PARSE;
1784 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1787 * If there is no memory left for buffering the
1788 * request, there is nothing we can do but hang up
1790 destroy_list(headers);
1791 return JB_ERR_MEMORY;
1796 if (!strncmpic(p, "Transfer-Encoding:", 18))
1799 * XXX: should be called through sed()
1800 * but currently can't.
1802 client_transfer_encoding(csp, &p);
1805 * We were able to read a complete
1806 * header and can finally enlist it.
1813 if (http->host == NULL)
1816 * If we still don't know the request destination,
1817 * the request is invalid or the client uses
1818 * Privoxy without its knowledge.
1820 if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
1823 * Our attempts to get the request destination
1824 * elsewhere failed or Privoxy is configured
1825 * to only accept proxy requests.
1827 * An error response has already been send
1828 * and we're done here.
1830 return JB_ERR_PARSE;
1834 #ifdef FEATURE_CLIENT_TAGS
1835 /* XXX: If the headers were enlisted sooner, passing csp would do. */
1836 set_client_address(csp, headers);
1837 get_tag_list_for_client(csp->client_tags, csp->client_address);
1841 * Determine the actions for this URL
1843 #ifdef FEATURE_TOGGLE
1844 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
1846 /* Most compatible set of actions (i.e. none) */
1847 init_current_action(csp->action);
1850 #endif /* ndef FEATURE_TOGGLE */
1852 get_url_actions(csp, http);
1855 enlist(csp->headers, http->cmd);
1857 /* Append the previously read headers */
1858 err = list_append_list_unique(csp->headers, headers);
1859 destroy_list(headers);
1866 /*********************************************************************
1868 * Function : parse_client_request
1870 * Description : Parses the client's request and decides what to do
1873 * Note that since we're not using select() we could get
1874 * blocked here if a client connected, then didn't say
1878 * 1 : csp = Current client state (buffers, headers, etc...)
1880 * Returns : JB_ERR_OK or JB_ERR_PARSE
1882 *********************************************************************/
1883 static jb_err parse_client_request(struct client_state *csp)
1885 struct http_request *http = csp->http;
1888 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1889 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
1890 && (!strcmpic(csp->http->ver, "HTTP/1.1"))
1891 && (csp->http->ssl == 0))
1893 /* Assume persistence until further notice */
1894 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1897 if (csp->http->ssl == 0)
1900 * This whole block belongs to chat() but currently
1901 * has to be executed before sed().
1903 if (csp->flags & CSP_FLAG_CHUNKED_CLIENT_BODY)
1905 if (receive_chunked_client_request_body(csp) != JB_ERR_OK)
1907 return JB_ERR_PARSE;
1912 csp->expected_client_content_length = get_expected_content_length(csp->headers);
1914 verify_request_length(csp);
1918 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1920 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1922 err = sed(csp, FILTER_CLIENT_HEADERS);
1923 if (JB_ERR_OK != err)
1925 log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
1927 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
1928 csp->ip_addr_str, csp->http->cmd);
1929 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER), get_write_delay(csp));
1930 return JB_ERR_PARSE;
1932 csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
1934 /* Check request line for rewrites. */
1935 if ((NULL == csp->headers->first->str)
1936 || (strcmp(http->cmd, csp->headers->first->str) &&
1937 (JB_ERR_OK != change_request_destination(csp))))
1940 * A header filter broke the request line - bail out.
1942 write_socket_delayed(csp->cfd, MESSED_UP_REQUEST_RESPONSE,
1943 strlen(MESSED_UP_REQUEST_RESPONSE), get_write_delay(csp));
1944 /* XXX: Use correct size */
1945 log_error(LOG_LEVEL_CLF,
1946 "%s - - [%T] \"Invalid request generated\" 500 0", csp->ip_addr_str);
1947 log_error(LOG_LEVEL_ERROR,
1948 "Invalid request line after applying header filters.");
1949 free_http_request(http);
1951 return JB_ERR_PARSE;
1954 if (client_has_unsupported_expectations(csp))
1956 return JB_ERR_PARSE;
1964 /*********************************************************************
1966 * Function : send_http_request
1968 * Description : Sends the HTTP headers from the client request
1969 * and all the body data that has already been received.
1972 * 1 : csp = Current client state (buffers, headers, etc...)
1974 * Returns : 0 on success, anything else is an error.
1976 *********************************************************************/
1977 static int send_http_request(struct client_state *csp)
1982 hdr = list_to_text(csp->headers);
1985 /* FIXME Should handle error properly */
1986 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
1988 list_remove_all(csp->headers);
1991 * Write the client's (modified) header to the server
1992 * (along with anything else that may be in the buffer)
1994 write_failure = 0 != write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
1999 log_error(LOG_LEVEL_CONNECT, "Failed sending request headers to: %s: %E",
2000 csp->http->hostport);
2002 else if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
2003 && (flush_iob(csp->server_connection.sfd, csp->client_iob, 0) < 0))
2006 log_error(LOG_LEVEL_CONNECT, "Failed sending request body to: %s: %E",
2007 csp->http->hostport);
2010 return write_failure;
2015 #ifdef FEATURE_HTTPS_INSPECTION
2016 /*********************************************************************
2018 * Function : receive_and_send_encrypted_post_data
2020 * Description : Reads remaining POST data from the client and sends
2024 * 1 : csp = Current client state (buffers, headers, etc...)
2026 * Returns : 0 on success, anything else is an error.
2028 *********************************************************************/
2029 static jb_err receive_and_send_encrypted_post_data(struct client_state *csp)
2031 int content_length_known = csp->expected_client_content_length != 0;
2033 while (is_ssl_pending(&(csp->mbedtls_client_attr.ssl)))
2035 unsigned char buf[BUFFER_SIZE];
2037 int max_bytes_to_read = sizeof(buf);
2039 if (content_length_known && csp->expected_client_content_length < sizeof(buf))
2041 max_bytes_to_read = (int)csp->expected_client_content_length;
2043 log_error(LOG_LEVEL_CONNECT,
2044 "Waiting for up to %d bytes of POST data from the client.",
2046 len = ssl_recv_data(&(csp->mbedtls_client_attr.ssl), buf,
2047 (unsigned)max_bytes_to_read);
2054 /* XXX: Does this actually happen? */
2057 log_error(LOG_LEVEL_HEADER, "Forwarding %d bytes of encrypted POST data",
2059 len = ssl_send_data(&(csp->mbedtls_server_attr.ssl), buf, (size_t)len);
2064 if (csp->expected_client_content_length != 0)
2066 if (csp->expected_client_content_length >= len)
2068 csp->expected_client_content_length -= (unsigned)len;
2070 if (csp->expected_client_content_length == 0)
2072 log_error(LOG_LEVEL_HEADER, "Forwarded the last %d bytes", len);
2078 log_error(LOG_LEVEL_HEADER, "Done forwarding encrypted POST data");
2085 /*********************************************************************
2087 * Function : send_https_request
2089 * Description : Sends the HTTP headers from the client request
2090 * and all the body data that has already been received.
2093 * 1 : csp = Current client state (buffers, headers, etc...)
2095 * Returns : 0 on success, anything else is an error.
2097 *********************************************************************/
2098 static int send_https_request(struct client_state *csp)
2104 hdr = list_to_text(csp->https_headers);
2107 /* FIXME Should handle error properly */
2108 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
2110 list_remove_all(csp->https_headers);
2113 * Write the client's (modified) header to the server
2114 * (along with anything else that may be in the buffer)
2116 ret = ssl_send_data(&(csp->mbedtls_server_attr.ssl),
2117 (const unsigned char *)hdr, strlen(hdr));
2122 log_error(LOG_LEVEL_CONNECT,
2123 "Failed sending encrypted request headers to: %s: %E",
2124 csp->http->hostport);
2125 mark_server_socket_tainted(csp);
2129 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
2130 && ((flushed = ssl_flush_socket(&(csp->mbedtls_server_attr.ssl),
2131 csp->client_iob)) < 0))
2133 log_error(LOG_LEVEL_CONNECT, "Failed sending request body to: %s: %E",
2134 csp->http->hostport);
2139 if (csp->expected_client_content_length != 0)
2141 if (csp->expected_client_content_length < flushed)
2143 log_error(LOG_LEVEL_ERROR,
2144 "Flushed %d bytes of request body while only expecting %llu",
2145 flushed, csp->expected_client_content_length);
2146 csp->expected_client_content_length = 0;
2150 log_error(LOG_LEVEL_CONNECT,
2151 "Flushed %d bytes of request body while expecting %llu",
2152 flushed, csp->expected_client_content_length);
2153 csp->expected_client_content_length -= (unsigned)flushed;
2154 if (receive_and_send_encrypted_post_data(csp))
2162 log_error(LOG_LEVEL_CONNECT,
2163 "Flushed %d bytes of request body", flushed);
2167 log_error(LOG_LEVEL_CONNECT, "Encrypted request sent");
2174 /*********************************************************************
2176 * Function : receive_encrypted_request
2178 * Description : Receives an encrypted request.
2181 * 1 : csp = Current client state (buffers, headers, etc...)
2183 * Returns : JB_ERR_OK on success,
2184 * JB_ERR_PARSE or JB_ERR_MEMORY otherwise
2186 *********************************************************************/
2187 static jb_err receive_encrypted_request(struct client_state *csp)
2189 char buf[BUFFER_SIZE];
2195 log_error(LOG_LEVEL_HEADER, "Reading encrypted headers");
2196 if (!data_is_available(csp->cfd, (int)csp->config->keep_alive_timeout))
2198 log_error(LOG_LEVEL_CONNECT,
2199 "Socket %d timed out while waiting for client headers", csp->cfd);
2200 return JB_ERR_PARSE;
2202 len = ssl_recv_data(&(csp->mbedtls_client_attr.ssl),
2203 (unsigned char *)buf, sizeof(buf));
2206 return JB_ERR_PARSE;
2208 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
2210 return JB_ERR_MEMORY;
2212 p = strstr(csp->client_iob->cur, "\r\n\r\n");
2213 } while (p == NULL);
2215 log_error(LOG_LEVEL_HEADER, "Encrypted headers received completely");
2221 /*********************************************************************
2223 * Function : process_encrypted_request
2225 * Description : Receives and parses an encrypted request.
2228 * 1 : csp = Current client state (buffers, headers, etc...)
2230 * Returns : JB_ERR_OK on success,
2231 * JB_ERR_PARSE or JB_ERR_MEMORY otherwise
2233 *********************************************************************/
2234 static jb_err process_encrypted_request(struct client_state *csp)
2239 /* Temporary copy of the client's headers before they get enlisted in csp->https_headers */
2240 struct list header_list;
2241 struct list *headers = &header_list;
2243 err = receive_encrypted_request(csp);
2244 if (err != JB_ERR_OK)
2246 /* XXX: Also used for JB_ERR_MEMORY */
2247 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2248 (const unsigned char *)CHEADER, strlen(CHEADER));
2252 /* We don't need get_request_line() because the whole HTTP head is buffered. */
2253 request_line = get_header(csp->client_iob);
2254 if (request_line == NULL)
2256 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2257 (const unsigned char *)CHEADER, strlen(CHEADER));
2258 return JB_ERR_PARSE;
2260 assert(*request_line != '\0');
2262 if (client_protocol_is_unsupported(csp, request_line))
2264 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2265 (const unsigned char *)CHEADER, strlen(CHEADER));
2266 return JB_ERR_PARSE;
2269 #ifdef FEATURE_FORCE_LOAD
2270 if (force_required(csp, request_line))
2272 csp->flags |= CSP_FLAG_FORCED;
2274 #endif /* def FEATURE_FORCE_LOAD */
2276 free_http_request(csp->http);
2278 err = parse_http_request(request_line, csp->http);
2279 /* XXX: Restore ssl setting. This is ugly */
2280 csp->http->client_ssl = 1;
2281 csp->http->server_ssl = 1;
2283 freez(request_line);
2284 if (JB_ERR_OK != err)
2286 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2287 (const unsigned char *)CHEADER, strlen(CHEADER));
2288 /* XXX: Use correct size */
2289 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
2290 log_error(LOG_LEVEL_ERROR,
2291 "Couldn't parse request line received from %s: %s",
2292 csp->ip_addr_str, jb_err_to_string(err));
2294 free_http_request(csp->http);
2295 return JB_ERR_PARSE;
2298 /* Parse the rest of the client's headers. */
2302 p = get_header(csp->client_iob);
2306 /* There are no additional headers to read. */
2313 if (JB_ERR_OK != get_destination_from_https_headers(headers, csp->http))
2316 * Our attempts to get the request destination
2319 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2320 (const unsigned char *)CHEADER, strlen(CHEADER));
2321 return JB_ERR_PARSE;
2324 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
2325 /* Split the domain we just got for pattern matching */
2326 init_domain_components(csp->http);
2329 #ifdef FEATURE_TOGGLE
2330 if ((csp->flags & CSP_FLAG_TOGGLED_ON) != 0)
2333 /* Determine the actions for this URL */
2334 get_url_actions(csp, csp->http);
2337 enlist(csp->https_headers, csp->http->cmd);
2339 /* Append the previously read headers */
2340 err = list_append_list_unique(csp->https_headers, headers);
2341 destroy_list(headers);
2342 if (JB_ERR_OK != err)
2344 /* XXX: Send error message */
2348 /* XXX: Work around crash */
2349 csp->error_message = NULL;
2351 /* XXX: Why do this here? */
2354 err = sed_https(csp);
2355 if (JB_ERR_OK != err)
2357 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2358 (const unsigned char *)CHEADER, strlen(CHEADER));
2359 log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
2361 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
2362 csp->ip_addr_str, csp->http->cmd);
2363 return JB_ERR_PARSE;
2366 log_error(LOG_LEVEL_HEADER, "Encrypted request processed");
2367 log_applied_actions(csp->action);
2375 /*********************************************************************
2377 * Function : handle_established_connection
2379 * Description : Shuffle data between client and server once the
2380 * connection has been established.
2383 * 1 : csp = Current client state (buffers, headers, etc...)
2385 * Returns : Nothing.
2387 *********************************************************************/
2388 static void handle_established_connection(struct client_state *csp)
2394 struct pollfd poll_fds[2];
2398 struct timeval timeout;
2401 int ms_iis5_hack = 0;
2402 unsigned long long byte_count = 0;
2403 struct http_request *http;
2404 long len = 0; /* for buffer sizes (and negative error codes) */
2405 int buffer_and_filter_content = 0;
2406 unsigned int write_delay;
2407 #ifdef FEATURE_HTTPS_INSPECTION
2409 int use_ssl_tunnel = 0;
2410 csp->dont_verify_certificate = 0;
2412 if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION))
2414 /* Pass encrypted content without filtering. */
2419 /* Skeleton for HTTP response, if we should intercept the request */
2420 struct http_response *rsp;
2421 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2422 int watch_client_socket;
2425 csp->receive_buffer_size = csp->config->receive_buffer_size;
2426 csp->receive_buffer = zalloc(csp->receive_buffer_size + 1);
2427 if (csp->receive_buffer == NULL)
2429 log_error(LOG_LEVEL_ERROR,
2430 "Out of memory. Failed to allocate the receive buffer.");
2431 rsp = cgi_error_memory();
2432 send_crunch_response(csp, rsp);
2439 maxfd = (csp->cfd > csp->server_connection.sfd) ?
2440 csp->cfd : csp->server_connection.sfd;
2443 /* pass data between the client and server
2444 * until one or the other shuts down the connection.
2449 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2450 watch_client_socket = 0 == (csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING);
2452 write_delay = get_write_delay(csp);
2459 * FD_ZERO here seems to point to an errant macro which crashes.
2460 * So do this by hand for now...
2462 memset(&rfds,0x00,sizeof(fd_set));
2466 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2467 if (!watch_client_socket)
2469 maxfd = csp->server_connection.sfd;
2472 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2474 FD_SET(csp->cfd, &rfds);
2477 FD_SET(csp->server_connection.sfd, &rfds);
2478 #endif /* ndef HAVE_POLL */
2480 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2481 if ((csp->flags & CSP_FLAG_CHUNKED)
2482 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2483 && ((csp->iob->eod - csp->iob->cur) >= 5)
2484 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
2487 * XXX: This check should be obsolete now,
2488 * but let's wait a while to be sure.
2490 log_error(LOG_LEVEL_CONNECT,
2491 "Looks like we got the last chunk together with "
2492 "the server headers but didn't detect it earlier. "
2493 "We better stop reading.");
2494 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2495 csp->expected_content_length = byte_count;
2496 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2498 if (server_body && server_response_is_complete(csp, byte_count))
2500 if (csp->expected_content_length == byte_count)
2502 log_error(LOG_LEVEL_CONNECT,
2503 "Done reading from server. Content length: %llu as expected. "
2504 "Bytes most recently read: %d.",
2509 log_error(LOG_LEVEL_CONNECT,
2510 "Done reading from server. Expected content length: %llu. "
2511 "Actual content length: %llu. Bytes most recently read: %d.",
2512 csp->expected_content_length, byte_count, len);
2516 * XXX: Should not jump around, handle_established_connection()
2517 * is complicated enough already.
2521 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2524 poll_fds[0].fd = csp->cfd;
2525 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2526 if (!watch_client_socket)
2529 * Ignore incoming data, but still watch out
2530 * for disconnects etc. These flags are always
2531 * implied anyway but explicitly setting them
2534 poll_fds[0].events = POLLERR|POLLHUP;
2539 poll_fds[0].events = POLLIN;
2541 poll_fds[1].fd = csp->server_connection.sfd;
2542 poll_fds[1].events = POLLIN;
2543 n = poll(poll_fds, 2, csp->config->socket_timeout * 1000);
2545 timeout.tv_sec = csp->config->socket_timeout;
2546 timeout.tv_usec = 0;
2547 n = select((int)maxfd + 1, &rfds, NULL, NULL, &timeout);
2548 #endif /* def HAVE_POLL */
2550 /*server or client not responding in timeout */
2553 log_error(LOG_LEVEL_CONNECT, "Socket timeout %d reached: %s",
2554 csp->config->socket_timeout, http->url);
2555 if ((byte_count == 0) && (http->ssl == 0))
2557 send_crunch_response(csp, error_response(csp, "connection-timeout"));
2559 mark_server_socket_tainted(csp);
2560 #ifdef FEATURE_HTTPS_INSPECTION
2561 close_client_and_server_ssl_connections(csp);
2568 log_error(LOG_LEVEL_ERROR, "poll() failed!: %E");
2570 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
2572 mark_server_socket_tainted(csp);
2573 #ifdef FEATURE_HTTPS_INSPECTION
2574 close_client_and_server_ssl_connections(csp);
2580 * This is the body of the browser's request,
2581 * just read and write it.
2583 * Receives data from browser and sends it to server
2585 * XXX: Make sure the client doesn't use pipelining
2586 * behind Privoxy's back.
2589 if ((poll_fds[0].revents & (POLLERR|POLLHUP|POLLNVAL)) != 0)
2591 log_error(LOG_LEVEL_CONNECT,
2592 "The client socket %d has become unusable while "
2593 "the server socket %d is still open.",
2594 csp->cfd, csp->server_connection.sfd);
2595 mark_server_socket_tainted(csp);
2599 if (poll_fds[0].revents != 0)
2601 if (FD_ISSET(csp->cfd, &rfds))
2602 #endif /* def HAVE_POLL*/
2604 int max_bytes_to_read = (int)csp->receive_buffer_size;
2606 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2607 if ((csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ))
2609 if (data_is_available(csp->cfd, 0))
2612 * If the next request is already waiting, we have
2613 * to stop select()ing the client socket. Otherwise
2614 * we would always return right away and get nothing
2617 watch_client_socket = 0;
2618 log_error(LOG_LEVEL_CONNECT,
2619 "Stop watching client socket %d. "
2620 "There's already another request waiting.",
2625 * If the client socket is set, but there's no data
2626 * available on the socket, the client went fishing
2627 * and continuing talking to the server makes no sense.
2629 log_error(LOG_LEVEL_CONNECT,
2630 "The client closed socket %d while "
2631 "the server socket %d is still open.",
2632 csp->cfd, csp->server_connection.sfd);
2633 mark_server_socket_tainted(csp);
2636 if (csp->expected_client_content_length != 0)
2638 if (csp->expected_client_content_length < csp->receive_buffer_size)
2640 max_bytes_to_read = (int)csp->expected_client_content_length;
2642 log_error(LOG_LEVEL_CONNECT,
2643 "Waiting for up to %d bytes from the client.",
2646 assert(max_bytes_to_read <= csp->receive_buffer_size);
2647 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2649 #ifdef FEATURE_HTTPS_INSPECTION
2651 * Reading data from standard or secured connection (HTTP/HTTPS)
2653 if (client_use_ssl(csp))
2656 * Receiving HTTP request from client over TLS/SSL and sending
2657 * it to server over TLS/SSL.
2659 len = ssl_recv_data(&(csp->mbedtls_client_attr.ssl),
2660 (unsigned char *)csp->receive_buffer, (size_t)max_bytes_to_read);
2664 mark_server_socket_tainted(csp);
2668 ret = ssl_send_data(&(csp->mbedtls_server_attr.ssl),
2669 (const unsigned char *)csp->receive_buffer, (size_t)len);
2673 log_error(LOG_LEVEL_ERROR,
2674 "Send request over TLS/SSL to: %s failed", http->host);
2675 mark_server_socket_tainted(csp);
2676 close_client_and_server_ssl_connections(csp);
2681 #endif /* def FEATURE_HTTPS_INSPECTION */
2683 len = read_socket(csp->cfd, csp->receive_buffer, max_bytes_to_read);
2687 /* XXX: not sure if this is necessary. */
2688 mark_server_socket_tainted(csp);
2689 break; /* "game over, man" */
2692 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2693 if (csp->expected_client_content_length != 0)
2695 assert(len <= max_bytes_to_read);
2696 csp->expected_client_content_length -= (unsigned)len;
2697 log_error(LOG_LEVEL_CONNECT,
2698 "Expected client content length set to %llu "
2699 "after reading %d bytes.",
2700 csp->expected_client_content_length, len);
2701 if (csp->expected_client_content_length == 0)
2703 log_error(LOG_LEVEL_CONNECT,
2704 "Done reading from the client.");
2705 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
2708 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2710 if (write_socket(csp->server_connection.sfd, csp->receive_buffer, (size_t)len))
2712 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
2713 mark_server_socket_tainted(csp);
2721 * The server wants to talk. It could be the header or the body.
2722 * If `hdr' is null, then it's the header otherwise it's the body.
2723 * FIXME: Does `hdr' really mean `host'? No.
2726 if (poll_fds[1].revents != 0)
2728 if (FD_ISSET(csp->server_connection.sfd, &rfds))
2729 #endif /* HAVE_POLL */
2731 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2733 * If we are buffering content, we don't want to eat up to
2734 * buffer-limit bytes if the client no longer cares about them.
2735 * If we aren't buffering, however, a dead client socket will be
2736 * noticed pretty much right away anyway, so we can reduce the
2737 * overhead by skipping the check.
2739 if (buffer_and_filter_content && !socket_is_still_alive(csp->cfd))
2742 log_error(LOG_LEVEL_CONNECT,
2743 "The server still wants to talk, but the client may already have hung up on us.");
2745 log_error(LOG_LEVEL_CONNECT,
2746 "The server still wants to talk, but the client hung up on us.");
2747 mark_server_socket_tainted(csp);
2748 #ifdef FEATURE_HTTPS_INSPECTION
2749 close_client_and_server_ssl_connections(csp);
2752 #endif /* def _WIN32 */
2754 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2756 #ifdef FEATURE_HTTPS_INSPECTION
2758 * Reading data from standard or secured connection (HTTP/HTTPS)
2760 if (server_use_ssl(csp))
2762 len = ssl_recv_data(&(csp->mbedtls_server_attr.ssl),
2763 (unsigned char *)csp->receive_buffer, csp->receive_buffer_size);
2768 len = read_socket(csp->server_connection.sfd, csp->receive_buffer,
2769 (int)csp->receive_buffer_size);
2774 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
2776 if ((http->ssl && (csp->fwd == NULL))
2777 #ifdef FEATURE_HTTPS_INSPECTION
2783 * Just hang up. We already confirmed the client's CONNECT
2784 * request with status code 200 and unencrypted content is
2785 * no longer welcome.
2787 log_error(LOG_LEVEL_ERROR,
2788 "CONNECT already confirmed. Unable to tell the client about the problem.");
2791 else if (byte_count)
2794 * Just hang up. We already transmitted the original headers
2795 * and parts of the original content and therefore missed the
2796 * chance to send an error message (without risking data corruption).
2798 * XXX: we could retry with a fancy range request here.
2800 log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
2801 "Unable to tell the client about the problem.");
2802 mark_server_socket_tainted(csp);
2803 #ifdef FEATURE_HTTPS_INSPECTION
2804 close_client_and_server_ssl_connections(csp);
2809 * XXX: Consider handling the cases above the same.
2811 mark_server_socket_tainted(csp);
2815 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2816 if (csp->flags & CSP_FLAG_CHUNKED)
2818 if ((len >= 5) && !memcmp(csp->receive_buffer+len-5, "0\r\n\r\n", 5))
2820 /* XXX: this is a temporary hack */
2821 log_error(LOG_LEVEL_CONNECT,
2822 "Looks like we reached the end of the last chunk. "
2823 "We better stop reading.");
2824 csp->expected_content_length = byte_count + (unsigned long long)len;
2825 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2829 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2832 * This is guaranteed by allocating with zalloc_or_die()
2833 * and never (intentionally) writing to the last byte.
2835 * csp->receive_buffer_size is the size of the part of the
2836 * buffer we intentionally write to, but we actually
2837 * allocated csp->receive_buffer_size+1 bytes so the assertion
2838 * stays within the allocated range.
2840 assert(csp->receive_buffer[csp->receive_buffer_size] == '\0');
2843 * Add a trailing zero to let be able to use string operations.
2844 * XXX: do we still need this with filter_popups gone?
2846 assert(len <= csp->receive_buffer_size);
2847 csp->receive_buffer[len] = '\0';
2850 * Normally, this would indicate that we've read
2851 * as much as the server has sent us and we can
2852 * close the client connection. However, Microsoft
2853 * in its wisdom has released IIS/5 with a bug that
2854 * prevents it from sending the trailing \r\n in
2855 * a 302 redirect header (and possibly other headers).
2856 * To work around this if we've haven't parsed
2857 * a full header we'll append a trailing \r\n
2858 * and see if this now generates a valid one.
2860 * This hack shouldn't have any impacts. If we've
2861 * already transmitted the header or if this is a
2862 * SSL connection, then we won't bother with this
2863 * hack. So we only work on partially received
2864 * headers. If we append a \r\n and this still
2865 * doesn't generate a valid header, then we won't
2866 * transmit anything to the client.
2871 if (server_body || (http->ssl
2872 #ifdef FEATURE_HTTPS_INSPECTION
2878 * If we have been buffering up the document,
2879 * now is the time to apply content modification
2880 * and send the result to the client.
2882 if (buffer_and_filter_content)
2884 p = execute_content_filters(csp);
2886 * If content filtering fails, use the original
2887 * buffer and length.
2888 * (see p != NULL ? p : csp->iob->cur below)
2892 csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
2894 #ifdef FEATURE_COMPRESSION
2895 else if ((csp->flags & CSP_FLAG_CLIENT_SUPPORTS_DEFLATE)
2896 && (csp->content_length > LOWER_LENGTH_LIMIT_FOR_COMPRESSION))
2898 char *compressed_content = compress_buffer(p,
2899 (size_t *)&csp->content_length, csp->config->compression_level);
2900 if (compressed_content != NULL)
2903 p = compressed_content;
2904 csp->flags |= CSP_FLAG_BUFFERED_CONTENT_DEFLATED;
2909 if (JB_ERR_OK != update_server_headers(csp))
2911 log_error(LOG_LEVEL_FATAL,
2912 "Failed to update server headers. after filtering.");
2915 hdr = list_to_text(csp->headers);
2918 /* FIXME Should handle error properly */
2919 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2922 #ifdef FEATURE_HTTPS_INSPECTION
2924 * Sending data with standard or secured connection (HTTP/HTTPS)
2926 if (client_use_ssl(csp))
2928 if ((ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2929 (const unsigned char *)hdr, strlen(hdr)) < 0)
2930 || (ssl_send_data(&(csp->mbedtls_client_attr.ssl),
2931 (const unsigned char *) ((p != NULL) ? p : csp->iob->cur),
2932 csp->content_length) < 0))
2934 log_error(LOG_LEVEL_ERROR, "write modified content to "
2935 "client over TLS/SSL failed");
2938 mark_server_socket_tainted(csp);
2939 close_client_and_server_ssl_connections(csp);
2944 #endif /* def FEATURE_HTTPS_INSPECTION */
2946 if (write_socket_delayed(csp->cfd, hdr, strlen(hdr), write_delay)
2947 || write_socket_delayed(csp->cfd, ((p != NULL) ? p : csp->iob->cur),
2948 (size_t)csp->content_length, write_delay))
2950 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
2953 mark_server_socket_tainted(csp);
2962 break; /* "game over, man" */
2966 * This is NOT the body, so
2967 * Let's pretend the server just sent us a blank line.
2969 snprintf(csp->receive_buffer, csp->receive_buffer_size, "\r\n");
2970 len = (int)strlen(csp->receive_buffer);
2973 * Now, let the normal header parsing algorithm below do its
2974 * job. If it fails, we'll exit instead of continuing.
2981 * If we're in the body of the server document, just write it to
2982 * the client, unless we need to buffer the body for later
2983 * content-filtering.
2985 if (server_body || (http->ssl
2986 #ifdef FEATURE_HTTPS_INSPECTION
2991 if (buffer_and_filter_content)
2994 * If there is no memory left for buffering the content, or the buffer limit
2995 * has been reached, switch to non-filtering mode, i.e. make & write the
2996 * header, flush the iob and buf, and get out of the way.
2998 if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3003 log_error(LOG_LEVEL_INFO,
3004 "Flushing header and buffers. Stepping back from filtering.");
3006 hdr = list_to_text(csp->headers);
3010 * Memory is too tight to even generate the header.
3011 * Send our static "Out-of-memory" page.
3013 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
3014 rsp = cgi_error_memory();
3015 send_crunch_response(csp, rsp);
3016 mark_server_socket_tainted(csp);
3017 #ifdef FEATURE_HTTPS_INSPECTION
3018 close_client_and_server_ssl_connections(csp);
3022 hdrlen = strlen(hdr);
3024 #ifdef FEATURE_HTTPS_INSPECTION
3026 * Sending data with standard or secured connection (HTTP/HTTPS)
3028 if (client_use_ssl(csp))
3030 if ((ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3031 (const unsigned char *)hdr, hdrlen) < 0)
3032 || ((flushed = ssl_flush_socket(&(csp->mbedtls_client_attr.ssl),
3034 || (ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3035 (const unsigned char *)csp->receive_buffer, (size_t)len) < 0))
3037 log_error(LOG_LEVEL_CONNECT,
3038 "Flush header and buffers to client failed");
3040 mark_server_socket_tainted(csp);
3041 close_client_and_server_ssl_connections(csp);
3046 #endif /* def FEATURE_HTTPS_INSPECTION */
3048 if (write_socket_delayed(csp->cfd, hdr, hdrlen, write_delay)
3049 || ((flushed = flush_iob(csp->cfd, csp->iob, write_delay)) < 0)
3050 || write_socket_delayed(csp->cfd, csp->receive_buffer, (size_t)len,
3053 log_error(LOG_LEVEL_CONNECT,
3054 "Flush header and buffers to client failed: %E");
3056 mark_server_socket_tainted(csp);
3062 * Reset the byte_count to the amount of bytes
3063 * we just flushed. len will be added a few lines below,
3064 * hdrlen doesn't matter for LOG_LEVEL_CLF.
3066 byte_count = (unsigned long long)flushed;
3068 buffer_and_filter_content = 0;
3074 #ifdef FEATURE_HTTPS_INSPECTION
3076 * Sending data with standard or secured connection (HTTP/HTTPS)
3078 if (client_use_ssl(csp))
3080 ret = ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3081 (const unsigned char *)csp->receive_buffer, (size_t)len);
3084 log_error(LOG_LEVEL_ERROR,
3085 "Sending data to client failed");
3086 mark_server_socket_tainted(csp);
3087 close_client_and_server_ssl_connections(csp);
3092 #endif /* def FEATURE_HTTPS_INSPECTION */
3094 if (write_socket_delayed(csp->cfd, csp->receive_buffer,
3095 (size_t)len, write_delay))
3097 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
3098 mark_server_socket_tainted(csp);
3103 byte_count += (unsigned long long)len;
3109 * We're still looking for the end of the server's header.
3110 * Buffer up the data we just read. If that fails, there's
3111 * little we can do but send our static out-of-memory page.
3113 if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3115 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
3116 rsp = cgi_error_memory();
3117 send_crunch_response(csp, rsp);
3118 mark_server_socket_tainted(csp);
3119 #ifdef FEATURE_HTTPS_INSPECTION
3120 close_client_and_server_ssl_connections(csp);
3125 /* Convert iob into something sed() can digest */
3126 if (JB_ERR_PARSE == get_server_headers(csp))
3131 * Well, we tried our MS IIS/5 hack and it didn't work.
3132 * The header is incomplete and there isn't anything
3133 * we can do about it.
3135 log_error(LOG_LEVEL_ERROR, "Invalid server headers. "
3136 "Applying the MS IIS5 hack didn't help.");
3137 log_error(LOG_LEVEL_CLF,
3138 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3139 #ifdef FEATURE_HTTPS_INSPECTION
3141 * Sending data with standard or secured connection (HTTP/HTTPS)
3143 if (client_use_ssl(csp))
3145 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3146 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3147 strlen(INVALID_SERVER_HEADERS_RESPONSE));
3150 #endif /* def FEATURE_HTTPS_INSPECTION */
3152 write_socket_delayed(csp->cfd,
3153 INVALID_SERVER_HEADERS_RESPONSE,
3154 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3156 mark_server_socket_tainted(csp);
3157 #ifdef FEATURE_HTTPS_INSPECTION
3158 close_client_and_server_ssl_connections(csp);
3165 * Since we have to wait for more from the server before
3166 * we can parse the headers we just continue here.
3168 log_error(LOG_LEVEL_CONNECT,
3169 "Continuing buffering server headers from socket %d. "
3170 "Bytes most recently read: %d.", csp->cfd, len);
3177 * Account for the content bytes we
3178 * might have gotten with the headers.
3180 assert(csp->iob->eod >= csp->iob->cur);
3181 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3184 /* Did we actually get anything? */
3185 if (NULL == csp->headers->first)
3187 if ((csp->flags & CSP_FLAG_REUSED_CLIENT_CONNECTION))
3189 log_error(LOG_LEVEL_ERROR,
3190 "No server or forwarder response received on socket %d. "
3191 "Closing client socket %d without sending data.",
3192 csp->server_connection.sfd, csp->cfd);
3193 log_error(LOG_LEVEL_CLF,
3194 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3198 log_error(LOG_LEVEL_ERROR,
3199 "No server or forwarder response received on socket %d.",
3200 csp->server_connection.sfd);
3201 send_crunch_response(csp, error_response(csp, "no-server-data"));
3203 free_http_request(http);
3204 mark_server_socket_tainted(csp);
3205 #ifdef FEATURE_HTTPS_INSPECTION
3206 close_client_and_server_ssl_connections(csp);
3211 if (!csp->headers->first->str)
3213 log_error(LOG_LEVEL_ERROR, "header search: csp->headers->first->str == NULL, assert will be called");
3215 assert(csp->headers->first->str);
3217 if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
3218 strncmpic(csp->headers->first->str, "ICY", 3))
3221 * It doesn't look like a HTTP (or Shoutcast) response:
3222 * tell the client and log the problem.
3224 if (strlen(csp->headers->first->str) > 30)
3226 csp->headers->first->str[30] = '\0';
3228 log_error(LOG_LEVEL_ERROR,
3229 "Invalid server or forwarder response. Starts with: %s",
3230 csp->headers->first->str);
3231 log_error(LOG_LEVEL_CLF,
3232 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3233 #ifdef FEATURE_HTTPS_INSPECTION
3235 * Sending data with standard or secured connection (HTTP/HTTPS)
3237 if (client_use_ssl(csp))
3239 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3240 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3241 strlen(INVALID_SERVER_HEADERS_RESPONSE));
3244 #endif /* def FEATURE_HTTPS_INSPECTION */
3246 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3247 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3249 free_http_request(http);
3250 mark_server_socket_tainted(csp);
3251 #ifdef FEATURE_HTTPS_INSPECTION
3252 close_client_and_server_ssl_connections(csp);
3258 * We have now received the entire server header,
3259 * filter it and send the result to the client
3261 if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
3263 log_error(LOG_LEVEL_CLF,
3264 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3265 #ifdef FEATURE_HTTPS_INSPECTION
3267 * Sending data with standard or secured connection (HTTP/HTTPS)
3269 if (client_use_ssl(csp))
3271 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3272 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3273 strlen(INVALID_SERVER_HEADERS_RESPONSE));
3278 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3279 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3281 free_http_request(http);
3282 mark_server_socket_tainted(csp);
3283 #ifdef FEATURE_HTTPS_INSPECTION
3284 close_client_and_server_ssl_connections(csp);
3288 hdr = list_to_text(csp->headers);
3291 /* FIXME Should handle error properly */
3292 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
3295 if ((csp->flags & CSP_FLAG_CHUNKED)
3296 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3297 && ((csp->iob->eod - csp->iob->cur) >= 5)
3298 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
3300 log_error(LOG_LEVEL_CONNECT,
3301 "Looks like we got the last chunk together with "
3302 "the server headers. We better stop reading.");
3303 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3304 csp->expected_content_length = byte_count;
3305 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
3308 csp->server_connection.response_received = time(NULL);
3310 if (crunch_response_triggered(csp, crunchers_light))
3313 * One of the tags created by a server-header
3314 * tagger triggered a crunch. We already
3315 * delivered the crunch response to the client
3316 * and are done here after cleaning up.
3319 mark_server_socket_tainted(csp);
3320 #ifdef FEATURE_HTTPS_INSPECTION
3321 close_client_and_server_ssl_connections(csp);
3326 /* Buffer and pcrs filter this if appropriate. */
3327 buffer_and_filter_content = content_requires_filtering(csp);
3329 if (!buffer_and_filter_content)
3332 * Write the server's (modified) header to
3333 * the client (along with anything else that
3334 * may be in the buffer). Use standard or secured
3337 #ifdef FEATURE_HTTPS_INSPECTION
3338 if (client_use_ssl(csp))
3340 if ((ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3341 (const unsigned char *)hdr, strlen(hdr)) < 0)
3342 || (len = ssl_flush_socket(&(csp->mbedtls_client_attr.ssl),
3345 log_error(LOG_LEVEL_CONNECT, "Write header to client failed");
3348 * The write failed, so don't bother mentioning it
3349 * to the client... it probably can't hear us anyway.
3352 mark_server_socket_tainted(csp);
3353 #ifdef FEATURE_HTTPS_INSPECTION
3354 close_client_and_server_ssl_connections(csp);
3360 #endif /* def FEATURE_HTTPS_INSPECTION */
3362 if (write_socket_delayed(csp->cfd, hdr, strlen(hdr), write_delay)
3363 || ((len = flush_iob(csp->cfd, csp->iob, write_delay)) < 0))
3365 log_error(LOG_LEVEL_ERROR,
3366 "write header to client failed");
3368 * The write failed, so don't bother mentioning it
3369 * to the client... it probably can't hear us anyway.
3372 mark_server_socket_tainted(csp);
3378 /* we're finished with the server's header */
3384 * If this was a MS IIS/5 hack then it means the server
3385 * has already closed the connection. Nothing more to read.
3390 log_error(LOG_LEVEL_ERROR,
3391 "Closed server connection detected. "
3392 "Applying the MS IIS5 hack didn't help.");
3393 log_error(LOG_LEVEL_CLF,
3394 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3395 #ifdef FEATURE_HTTPS_INSPECTION
3397 * Sending data with standard or secured connection (HTTP/HTTPS)
3399 if (client_use_ssl(csp))
3401 ssl_send_data(&(csp->mbedtls_client_attr.ssl),
3402 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3403 strlen(INVALID_SERVER_HEADERS_RESPONSE));
3406 #endif /* def FEATURE_HTTPS_INSPECTION */
3408 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3409 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3411 mark_server_socket_tainted(csp);
3412 #ifdef FEATURE_HTTPS_INSPECTION
3413 close_client_and_server_ssl_connections(csp);
3420 mark_server_socket_tainted(csp);
3421 #ifdef FEATURE_HTTPS_INSPECTION
3422 close_client_and_server_ssl_connections(csp);
3424 return; /* huh? we should never get here */
3426 #ifdef FEATURE_HTTPS_INSPECTION
3427 close_client_and_server_ssl_connections(csp);
3429 if (csp->content_length == 0)
3432 * If Privoxy didn't recalculate the Content-Length,
3433 * byte_count is still correct.
3435 csp->content_length = byte_count;
3438 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3439 if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3440 && (csp->expected_content_length != byte_count))
3442 log_error(LOG_LEVEL_CONNECT,
3443 "Received %llu bytes while expecting %llu.",
3444 byte_count, csp->expected_content_length);
3445 mark_server_socket_tainted(csp);
3449 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %llu",
3450 csp->ip_addr_str, http->ocmd, csp->content_length);
3452 csp->server_connection.timestamp = time(NULL);
3456 /*********************************************************************
3460 * Description : Once a connection from the client has been accepted,
3461 * this function is called (via serve()) to handle the
3462 * main business of the communication. This function
3463 * returns after dealing with a single request. It can
3464 * be called multiple times with the same client socket
3465 * if the client is keeping the connection alive.
3467 * The decision whether or not a client connection will
3468 * be kept alive is up to the caller which also must
3469 * close the client socket when done.
3471 * FIXME: chat is nearly thousand lines long.
3475 * 1 : csp = Current client state (buffers, headers, etc...)
3477 * Returns : Nothing.
3479 *********************************************************************/
3480 static void chat(struct client_state *csp)
3482 const struct forward_spec *fwd;
3483 struct http_request *http;
3484 /* Skeleton for HTTP response, if we should intercept the request */
3485 struct http_response *rsp;
3486 #ifdef FEATURE_HTTPS_INSPECTION
3487 int use_ssl_tunnel = 0;
3492 if (receive_client_request(csp) != JB_ERR_OK)
3496 if (parse_client_request(csp) != JB_ERR_OK)
3501 /* decide how to route the HTTP request */
3502 fwd = forward_url(csp, http);
3505 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!? This can't happen!");
3506 /* Never get here - LOG_LEVEL_FATAL causes program exit */
3510 #ifdef FEATURE_HTTPS_INSPECTION
3512 * Setting flags to use old solution with SSL tunnel and to disable
3513 * certificates verification.
3515 if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION))
3520 if (http->ssl && csp->action->flags & ACTION_IGNORE_CERTIFICATE_ERRORS)
3522 csp->dont_verify_certificate = 1;
3527 * build the http request to send to the server
3528 * we have to do one of the following:
3530 * create = use the original HTTP request to create a new
3531 * HTTP request that has either the path component
3532 * without the http://domainspec (w/path) or the
3533 * full orininal URL (w/url)
3534 * Note that the path and/or the HTTP version may
3535 * have been altered by now.
3537 * SSL proxy = Open a socket to the host:port of the server
3538 * and create TLS/SSL connection with server and
3539 * with client. Then behave like mediator between
3540 * client and server over TLS/SSL.
3542 * SSL proxy = Pass the request unchanged if forwarding a CONNECT
3543 * with request to a parent proxy. Note that we'll be sending
3544 * forwarding the CFAIL message ourselves if connecting to the parent
3545 * fails, but we won't send a CSUCCEED message if it works,
3546 * since that would result in a double message (ours and the
3547 * parent's). After sending the request to the parent, we
3548 * must parse answer and send it to client. If connection
3549 * with server is established, we do TLS/SSL proxy. Otherwise
3550 * we send parent response to client and close connections.
3552 * here's the matrix:
3555 * +--------+--------+
3557 * 0 | create | SSL |
3558 * | w/path | proxy |
3559 * Forwarding +--------+--------+
3561 * 1 | create | proxy |
3562 * | w/url |+forward|
3563 * +--------+--------+
3567 #ifdef FEATURE_HTTPS_INSPECTION
3569 * Presetting SSL client and server flags
3571 if (http->ssl && !use_ssl_tunnel)
3573 http->client_ssl = 1;
3574 http->server_ssl = 1;
3578 http->client_ssl = 0;
3579 http->server_ssl = 0;
3583 if (http->ssl && connect_port_is_forbidden(csp))
3585 const char *acceptable_connect_ports =
3586 csp->action->string[ACTION_STRING_LIMIT_CONNECT];
3587 assert(NULL != acceptable_connect_ports);
3588 log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
3589 "limit-connect{%s} doesn't allow CONNECT requests to %s",
3590 csp->ip_addr_str, acceptable_connect_ports, csp->http->hostport);
3591 csp->action->flags |= ACTION_BLOCK;
3593 #ifdef FEATURE_HTTPS_INSPECTION
3594 http->client_ssl = 0;
3595 http->server_ssl = 0;
3600 freez(csp->headers->first->str);
3601 build_request_line(csp, fwd, &csp->headers->first->str);
3604 * We have a request. Check if one of the crunchers wants it
3605 * unless the client wants to use TLS/SSL in which case we
3606 * haven't setup the TLS context yet and will send the crunch
3610 #ifdef FEATURE_HTTPS_INSPECTION
3611 !client_use_ssl(csp) &&
3613 crunch_response_triggered(csp, crunchers_all))
3616 * Yes. The client got the crunch response and we're done here.
3621 log_applied_actions(csp->action);
3622 log_error(LOG_LEVEL_GPC, "%s%s", http->hostport, http->path);
3624 if (fwd->forward_host)
3626 log_error(LOG_LEVEL_CONNECT, "via [%s]:%d to: %s",
3627 fwd->forward_host, fwd->forward_port, http->hostport);
3631 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
3634 /* here we connect to the server, gateway, or the forwarder */
3636 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3637 if ((csp->server_connection.sfd != JB_INVALID_SOCKET)
3638 && socket_is_still_alive(csp->server_connection.sfd)
3639 && connection_destination_matches(&csp->server_connection, http, fwd))
3641 log_error(LOG_LEVEL_CONNECT,
3642 "Reusing server socket %d connected to %s. Total requests: %u.",
3643 csp->server_connection.sfd, csp->server_connection.host,
3644 csp->server_connection.requests_sent_total);
3648 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
3650 #ifdef FEATURE_CONNECTION_SHARING
3651 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
3653 remember_connection(&csp->server_connection);
3656 #endif /* def FEATURE_CONNECTION_SHARING */
3658 log_error(LOG_LEVEL_CONNECT,
3659 "Closing server socket %d connected to %s. Total requests: %u.",
3660 csp->server_connection.sfd, csp->server_connection.host,
3661 csp->server_connection.requests_sent_total);
3662 close_socket(csp->server_connection.sfd);
3664 mark_connection_closed(&csp->server_connection);
3666 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3667 #ifdef FEATURE_HTTPS_INSPECTION
3668 if (http->ssl && !use_ssl_tunnel)
3672 * Creating an SSL proxy. If forwarding is disabled, we must send
3673 * CSUCCEED mesage to client. Then TLS/SSL connection with client
3677 if (fwd->forward_host == NULL)
3680 * We're lying to the client as the connection hasn't actually
3681 * been established yet. We don't establish the connection until
3682 * we have seen and parsed the encrypted client headers.
3684 if (write_socket_delayed(csp->cfd, CSUCCEED,
3685 strlen(CSUCCEED), get_write_delay(csp)) != 0)
3687 log_error(LOG_LEVEL_ERROR, "Sending SUCCEED to client failed");
3692 ret = create_client_ssl_connection(csp);
3695 log_error(LOG_LEVEL_ERROR,
3696 "Can't open secure connection with client");
3697 close_client_ssl_connection(csp); /* XXX: Is this needed? */
3700 if (JB_ERR_OK != process_encrypted_request(csp))
3702 log_error(LOG_LEVEL_ERROR, "Failed to parse encrypted request.");
3703 close_client_ssl_connection(csp);
3707 * We have an encrypted request. Check if one of the crunchers now
3708 * wants it (for example because the previously invisible path was
3709 * required to match).
3711 if (crunch_response_triggered(csp, crunchers_all))
3714 * Yes. The client got the crunch response and we're done here.
3716 close_client_ssl_connection(csp);
3722 * Connecting to destination server
3724 csp->server_connection.sfd = forwarded_connect(fwd, http, csp);
3726 if (csp->server_connection.sfd == JB_INVALID_SOCKET)
3728 if (fwd->type != SOCKS_NONE)
3731 rsp = error_response(csp, "forwarding-failed");
3733 else if (errno == EINVAL)
3735 rsp = error_response(csp, "no-such-domain");
3739 rsp = error_response(csp, "connect-failed");
3742 /* Write the answer to the client */
3745 send_crunch_response(csp, rsp);
3749 * Temporary workaround to prevent already-read client
3750 * bodies from being parsed as new requests. For now we
3751 * err on the safe side and throw all the following
3752 * requests under the bus, even if no client body has been
3753 * buffered. A compliant client will repeat the dropped
3754 * requests on an untainted connection.
3756 * The proper fix is to discard the no longer needed
3757 * client body in the buffer (if there is one) and to
3758 * continue parsing the bytes that follow.
3760 drain_and_close_socket(csp->cfd);
3761 csp->cfd = JB_INVALID_SOCKET;
3766 #ifdef FEATURE_HTTPS_INSPECTION
3768 * Creating TLS/SSL connections with destination server or parent
3769 * proxy. If forwarding is enabled, we must send client request to
3770 * parent proxy and receive, parse and resend parent proxy answer.
3772 if (http->ssl && !use_ssl_tunnel)
3774 if (fwd->forward_host != NULL)
3776 char server_response[BUFFER_SIZE];
3779 char *hdr = list_to_text(csp->headers);
3780 memset(server_response, 0, sizeof(server_response));
3784 log_error(LOG_LEVEL_FATAL,
3785 "Out of memory parsing client header");
3787 list_remove_all(csp->headers);
3790 * Sending client's CONNECT request to the parent proxy
3792 ret = write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
3798 log_error(LOG_LEVEL_CONNECT,
3799 "Sending request headers to: %s failed", http->hostport);
3800 mark_server_socket_tainted(csp);
3801 close_client_ssl_connection(csp);
3805 /* Waiting for parent proxy server response */
3806 len = read_socket(csp->server_connection.sfd, server_response,
3807 sizeof(server_response)-1);
3811 log_error(LOG_LEVEL_ERROR, "No response from parent proxy "
3812 "server on socket %d.", csp->server_connection.sfd);
3814 rsp = error_response(csp, "no-server-data");
3817 send_crunch_response(csp, rsp);
3819 mark_server_socket_tainted(csp);
3820 close_client_ssl_connection(csp);
3825 * Test if connection with destination server was established
3826 * successfully by parent proxy. Then we can send response to
3827 * the client and continue or stop.
3829 if (!tunnel_established_successfully(server_response, (unsigned int)len))
3831 log_error(LOG_LEVEL_ERROR, "Forwarder hasn't established "
3832 "connection with destination server.");
3834 write_socket(csp->cfd, server_response, (size_t)len);
3835 mark_server_socket_tainted(csp);
3836 close_client_ssl_connection(csp);
3841 * Parent proxy has established connection with destination server.
3842 * Now we must create TLS/SSL connection with parent proxy.
3844 ret = create_server_ssl_connection(csp);
3847 * If TLS/SSL connection wasn't created and invalid certificate
3848 * wasn't detected, we can interrupt this function. Otherwise, we
3849 * must inform the client about invalid server certificate.
3852 && (csp->server_cert_verification_result == SSL_CERT_NOT_VERIFIED
3853 || csp->server_cert_verification_result == SSL_CERT_VALID))
3855 rsp = error_response(csp, "connect-failed");
3858 send_crunch_response(csp, rsp);
3864 * TLS/SSL connection with parent proxy is established, we can
3865 * inform client about success.
3867 ret = write_socket(csp->cfd, server_response, (size_t)len);
3870 log_error(LOG_LEVEL_ERROR,
3871 "Sending parent proxy response to client failed");
3872 mark_server_socket_tainted(csp);
3873 close_client_ssl_connection(csp);
3876 }/* -END- if (fwd->forward_host != NULL) */
3880 * Parent proxy is not used, we can just create TLS/SSL connection
3881 * with destination server
3883 int ret = create_server_ssl_connection(csp);
3886 if (csp->server_cert_verification_result != SSL_CERT_VALID &&
3887 csp->server_cert_verification_result != SSL_CERT_NOT_VERIFIED)
3890 * If the server certificate is invalid, we must inform
3891 * the client and then close connection to the client.
3893 ssl_send_certificate_error(csp);
3894 close_client_and_server_ssl_connections(csp);
3897 if (csp->server_cert_verification_result == SSL_CERT_NOT_VERIFIED
3898 || csp->server_cert_verification_result == SSL_CERT_VALID)
3901 * The TLS/SSL connection wasn't created but an invalid
3902 * certificate wasn't detected. Report it as connection
3905 rsp = error_response(csp, "connect-failed");
3908 send_crunch_response(csp, rsp);
3910 close_client_and_server_ssl_connections(csp);
3915 }/* -END- if (http->ssl) */
3916 #endif /* def FEATURE_HTTPS_INSPECTION */
3918 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3919 save_connection_destination(csp->server_connection.sfd,
3920 http, fwd, &csp->server_connection);
3921 csp->server_connection.keep_alive_timeout =
3922 (unsigned)csp->config->keep_alive_timeout;
3924 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3926 csp->server_connection.requests_sent_total++;
3928 if ((fwd->type == SOCKS_5T) && (NULL == csp->headers->first))
3930 /* Client headers have been sent optimistically */
3931 assert(csp->headers->last == NULL);
3933 else if (http->ssl == 0 || (fwd->forward_host
3934 #ifdef FEATURE_HTTPS_INSPECTION
3939 if (send_http_request(csp))
3941 rsp = error_response(csp, "connect-failed");
3944 send_crunch_response(csp, rsp);
3952 * Using old solution with SSL tunnel or new solution with SSL proxy
3954 list_remove_all(csp->headers);
3955 #ifdef FEATURE_HTTPS_INSPECTION
3960 * We're running an SSL tunnel and we're not forwarding,
3961 * so just ditch the client headers, send the "connect succeeded"
3962 * message to the client, flush the rest, and get out of the way.
3964 if (write_socket_delayed(csp->cfd, CSUCCEED,
3965 strlen(CSUCCEED), get_write_delay(csp)))
3970 #ifdef FEATURE_HTTPS_INSPECTION
3974 * If server certificate is invalid, we must inform client and then
3975 * close connection with client.
3977 if (csp->server_cert_verification_result != SSL_CERT_VALID)
3979 ssl_send_certificate_error(csp);
3980 close_client_and_server_ssl_connections(csp);
3983 if (send_https_request(csp))
3985 rsp = error_response(csp, "connect-failed");
3988 send_crunch_response(csp, rsp);
3990 close_client_and_server_ssl_connections(csp);
3994 #endif /* def FEATURE_HTTPS_INSPECTION */
3995 clear_iob(csp->client_iob);
3996 }/* -END- else ... if (http->ssl == 1) */
3998 log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
4000 /* XXX: should the time start earlier for optimistically sent data? */
4001 csp->server_connection.request_sent = time(NULL);
4003 handle_established_connection(csp);
4004 freez(csp->receive_buffer);
4009 /*********************************************************************
4011 * Function : fuzz_server_response
4013 * Description : Treat the input as a whole server response.
4016 * 1 : csp = Current client state (buffers, headers, etc...)
4017 * 2 : fuzz_input_file = File to read the input from.
4021 *********************************************************************/
4022 extern int fuzz_server_response(struct client_state *csp, char *fuzz_input_file)
4024 static struct forward_spec fwd; /* Zero'd due to being static */
4027 if (strcmp(fuzz_input_file, "-") == 0)
4029 /* XXX: Doesn'T work yet. */
4030 csp->server_connection.sfd = 0;
4034 csp->server_connection.sfd = open(fuzz_input_file, O_RDONLY);
4035 if (csp->server_connection.sfd == -1)
4037 log_error(LOG_LEVEL_FATAL, "Failed to open %s: %E",
4042 csp->content_type |= CT_GIF;
4043 csp->action->flags |= ACTION_DEANIMATE;
4044 csp->action->string[ACTION_STRING_DEANIMATE] = "last";
4046 csp->http->path = strdup_or_die("/");
4047 csp->http->host = strdup_or_die("fuzz.example.org");
4048 csp->http->hostport = strdup_or_die("fuzz.example.org:80");
4049 /* Prevent client socket monitoring */
4050 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
4051 csp->flags |= CSP_FLAG_CHUNKED;
4053 csp->config->feature_flags |= RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
4054 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
4056 csp->content_type |= CT_DECLARED|CT_GIF;
4058 csp->config->socket_timeout = 0;
4060 cgi_init_error_messages();
4062 handle_established_connection(csp);
4063 freez(csp->receive_buffer);
4070 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4071 /*********************************************************************
4073 * Function : prepare_csp_for_next_request
4075 * Description : Put the csp in a mostly vergin state.
4078 * 1 : csp = Current client state (buffers, headers, etc...)
4082 *********************************************************************/
4083 static void prepare_csp_for_next_request(struct client_state *csp)
4085 csp->content_type = 0;
4086 csp->content_length = 0;
4087 csp->expected_content_length = 0;
4088 csp->expected_client_content_length = 0;
4089 list_remove_all(csp->headers);
4090 clear_iob(csp->iob);
4091 freez(csp->error_message);
4092 free_http_request(csp->http);
4093 destroy_list(csp->headers);
4094 destroy_list(csp->tags);
4095 #ifdef FEATURE_CLIENT_TAGS
4096 destroy_list(csp->client_tags);
4097 freez(csp->client_address);
4099 free_current_action(csp->action);
4100 if (NULL != csp->fwd)
4102 unload_forward_spec(csp->fwd);
4105 /* XXX: Store per-connection flags someplace else. */
4106 csp->flags = (CSP_FLAG_ACTIVE | CSP_FLAG_REUSED_CLIENT_CONNECTION);
4107 #ifdef FEATURE_TOGGLE
4108 if (global_toggle_state)
4109 #endif /* def FEATURE_TOGGLE */
4111 csp->flags |= CSP_FLAG_TOGGLED_ON;
4114 if (csp->client_iob->eod > csp->client_iob->cur)
4116 long bytes_to_shift = csp->client_iob->cur - csp->client_iob->buf;
4117 size_t data_length = (size_t)(csp->client_iob->eod - csp->client_iob->cur);
4119 assert(bytes_to_shift > 0);
4120 assert(data_length > 0);
4122 log_error(LOG_LEVEL_CONNECT, "Shifting %d pipelined bytes by %d bytes",
4123 data_length, bytes_to_shift);
4124 memmove(csp->client_iob->buf, csp->client_iob->cur, data_length);
4125 csp->client_iob->cur = csp->client_iob->buf;
4126 assert(csp->client_iob->eod == csp->client_iob->buf + bytes_to_shift + data_length);
4127 csp->client_iob->eod = csp->client_iob->buf + data_length;
4128 memset(csp->client_iob->eod, '\0', (size_t)bytes_to_shift);
4130 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
4135 * We mainly care about resetting client_iob->cur so we don't
4136 * waste buffer space at the beginning and don't mess up the
4137 * request restoration done by cgi_show_request().
4139 * Freeing the buffer itself isn't technically necessary,
4140 * but makes debugging more convenient.
4142 clear_iob(csp->client_iob);
4145 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4148 /*********************************************************************
4152 * Description : This is little more than chat. We only "serve" to
4153 * to close (or remember) any socket that chat may have
4157 * 1 : csp = Current client state (buffers, headers, etc...)
4161 *********************************************************************/
4162 static void serve(struct client_state *csp)
4164 int config_file_change_detected = 0; /* Only used for debugging */
4165 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4166 #ifdef FEATURE_CONNECTION_SHARING
4167 static int monitor_thread_running = 0;
4168 #endif /* def FEATURE_CONNECTION_SHARING */
4169 int continue_chatting = 0;
4171 log_error(LOG_LEVEL_CONNECT, "Accepted connection from %s on socket %d",
4172 csp->ip_addr_str, csp->cfd);
4176 unsigned int latency;
4181 * If the request has been crunched,
4182 * the calculated latency is zero.
4184 latency = (unsigned)(csp->server_connection.response_received -
4185 csp->server_connection.request_sent) / 2;
4187 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4188 && (csp->flags & CSP_FLAG_CRUNCHED)
4189 && (csp->expected_client_content_length != 0))
4191 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
4192 log_error(LOG_LEVEL_CONNECT,
4193 "Tainting client socket %d due to unread data.", csp->cfd);
4196 continue_chatting = (csp->config->feature_flags
4197 & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
4198 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
4199 && (csp->cfd != JB_INVALID_SOCKET)
4200 && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4201 && ((csp->flags & CSP_FLAG_SERVER_CONTENT_LENGTH_SET)
4202 || (csp->flags & CSP_FLAG_CHUNKED));
4204 if (!(csp->flags & CSP_FLAG_CRUNCHED)
4205 && (csp->server_connection.sfd != JB_INVALID_SOCKET))
4207 if (!(csp->flags & CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET))
4209 csp->server_connection.keep_alive_timeout = csp->config->default_server_timeout;
4211 if (!(csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
4212 || (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
4213 || !socket_is_still_alive(csp->server_connection.sfd)
4214 || !(latency < csp->server_connection.keep_alive_timeout))
4216 log_error(LOG_LEVEL_CONNECT,
4217 "Closing server socket %d connected to %s. "
4218 "Keep-alive %u. Tainted: %u. Socket alive %u. Timeout: %u.",
4219 csp->server_connection.sfd, csp->server_connection.host,
4220 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
4221 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
4222 socket_is_still_alive(csp->server_connection.sfd),
4223 csp->server_connection.keep_alive_timeout);
4224 #ifdef FEATURE_CONNECTION_SHARING
4225 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4227 forget_connection(csp->server_connection.sfd);
4229 #endif /* def FEATURE_CONNECTION_SHARING */
4230 close_socket(csp->server_connection.sfd);
4231 mark_connection_closed(&csp->server_connection);
4235 if (continue_chatting && any_loaded_file_changed(csp))
4237 continue_chatting = 0;
4238 config_file_change_detected = 1;
4241 if (continue_chatting)
4243 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
4244 && socket_is_still_alive(csp->cfd))
4246 log_error(LOG_LEVEL_CONNECT, "Client request %d has been "
4247 "pipelined on socket %d and the socket is still alive.",
4248 csp->requests_received_total+1, csp->cfd);
4249 prepare_csp_for_next_request(csp);
4253 if (0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
4255 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4257 log_error(LOG_LEVEL_CONNECT,
4258 "Waiting for the next client request on socket %d. "
4259 "Keeping the server socket %d to %s open.",
4260 csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
4264 log_error(LOG_LEVEL_CONNECT,
4265 "Waiting for the next client request on socket %d. "
4266 "No server socket to keep open.", csp->cfd);
4270 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4271 && data_is_available(csp->cfd, (int)csp->config->keep_alive_timeout)
4272 && socket_is_still_alive(csp->cfd))
4274 log_error(LOG_LEVEL_CONNECT,
4275 "Client request %u arrived in time on socket %d.",
4276 csp->requests_received_total+1, csp->cfd);
4277 prepare_csp_for_next_request(csp);
4281 #ifdef FEATURE_CONNECTION_SHARING
4282 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4283 && (csp->server_connection.sfd != JB_INVALID_SOCKET)
4284 && (socket_is_still_alive(csp->server_connection.sfd)))
4286 time_t time_open = time(NULL) - csp->server_connection.timestamp;
4288 if (csp->server_connection.keep_alive_timeout < time_open - (time_t)latency)
4293 remember_connection(&csp->server_connection);
4294 csp->server_connection.sfd = JB_INVALID_SOCKET;
4295 drain_and_close_socket(csp->cfd);
4296 csp->cfd = JB_INVALID_SOCKET;
4297 privoxy_mutex_lock(&connection_reuse_mutex);
4298 if (!monitor_thread_running)
4300 monitor_thread_running = 1;
4301 privoxy_mutex_unlock(&connection_reuse_mutex);
4302 wait_for_alive_connections();
4303 privoxy_mutex_lock(&connection_reuse_mutex);
4304 monitor_thread_running = 0;
4306 privoxy_mutex_unlock(&connection_reuse_mutex);
4308 #endif /* def FEATURE_CONNECTION_SHARING */
4312 else if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4314 log_error(LOG_LEVEL_CONNECT,
4315 "Closing server socket %d connected to %s. Keep-alive: %u. "
4316 "Tainted: %u. Socket alive: %u. Timeout: %u. "
4317 "Configuration file change detected: %u",
4318 csp->server_connection.sfd, csp->server_connection.host,
4319 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
4320 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
4321 socket_is_still_alive(csp->server_connection.sfd),
4322 csp->server_connection.keep_alive_timeout,
4323 config_file_change_detected);
4325 } while (continue_chatting);
4329 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4331 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4333 #ifdef FEATURE_CONNECTION_SHARING
4334 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4336 forget_connection(csp->server_connection.sfd);
4338 #endif /* def FEATURE_CONNECTION_SHARING */
4339 close_socket(csp->server_connection.sfd);
4342 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4343 mark_connection_closed(&csp->server_connection);
4346 if (csp->cfd != JB_INVALID_SOCKET)
4348 log_error(LOG_LEVEL_CONNECT, "Closing client socket %d. "
4349 "Keep-alive: %u. Socket alive: %u. Data available: %u. "
4350 "Configuration file change detected: %u. Requests received: %u.",
4351 csp->cfd, 0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE),
4352 socket_is_still_alive(csp->cfd), data_is_available(csp->cfd, 0),
4353 config_file_change_detected, csp->requests_received_total);
4354 drain_and_close_socket(csp->cfd);
4357 free_csp_resources(csp);
4359 csp->flags &= ~CSP_FLAG_ACTIVE;
4365 /*********************************************************************
4367 * Function : server_thread
4369 * Description : We only exist to call `serve' in a threaded environment.
4372 * 1 : data = Current client state (buffers, headers, etc...)
4374 * Returns : Always 0.
4376 *********************************************************************/
4377 static int32 server_thread(void *data)
4379 serve((struct client_state *) data);
4386 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
4387 /*********************************************************************
4391 * Description : Print usage info & exit.
4393 * Parameters : Pointer to argv[0] for identifying ourselves
4397 *********************************************************************/
4398 static void usage(const char *name)
4400 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
4401 "Usage: %s [--config-test] "
4404 #endif /* defined(unix) */
4407 "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
4408 #endif /* defined(unix) */
4409 "[--version] [configfile]\n",
4413 show_fuzz_usage(name);
4416 printf("Aborting\n");
4421 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
4424 #ifdef MUTEX_LOCKS_AVAILABLE
4425 /*********************************************************************
4427 * Function : privoxy_mutex_lock
4429 * Description : Locks a mutex.
4432 * 1 : mutex = The mutex to lock.
4434 * Returns : Void. May exit in case of errors.
4436 *********************************************************************/
4437 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
4439 #ifdef FEATURE_PTHREAD
4440 int err = pthread_mutex_lock(mutex);
4443 if (mutex != &log_mutex)
4445 log_error(LOG_LEVEL_FATAL,
4446 "Mutex locking failed: %s.\n", strerror(err));
4451 EnterCriticalSection(mutex);
4452 #endif /* def FEATURE_PTHREAD */
4456 /*********************************************************************
4458 * Function : privoxy_mutex_unlock
4460 * Description : Unlocks a mutex.
4463 * 1 : mutex = The mutex to unlock.
4465 * Returns : Void. May exit in case of errors.
4467 *********************************************************************/
4468 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
4470 #ifdef FEATURE_PTHREAD
4471 int err = pthread_mutex_unlock(mutex);
4474 if (mutex != &log_mutex)
4476 log_error(LOG_LEVEL_FATAL,
4477 "Mutex unlocking failed: %s.\n", strerror(err));
4482 LeaveCriticalSection(mutex);
4483 #endif /* def FEATURE_PTHREAD */
4487 /*********************************************************************
4489 * Function : privoxy_mutex_init
4491 * Description : Prepares a mutex.
4494 * 1 : mutex = The mutex to initialize.
4496 * Returns : Void. May exit in case of errors.
4498 *********************************************************************/
4499 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
4501 #ifdef FEATURE_PTHREAD
4502 int err = pthread_mutex_init(mutex, 0);
4505 printf("Fatal error. Mutex initialization failed: %s.\n",
4510 InitializeCriticalSection(mutex);
4511 #endif /* def FEATURE_PTHREAD */
4513 #endif /* def MUTEX_LOCKS_AVAILABLE */
4515 /*********************************************************************
4517 * Function : initialize_mutexes
4519 * Description : Prepares mutexes if mutex support is available.
4523 * Returns : Void, exits in case of errors.
4525 *********************************************************************/
4526 static void initialize_mutexes(void)
4528 #ifdef MUTEX_LOCKS_AVAILABLE
4530 * Prepare global mutex semaphores
4533 #ifdef FEATURE_HTTPS_INSPECTION
4534 privoxy_mutex_init(&certificate_mutex);
4535 privoxy_mutex_init(&rng_mutex);
4538 privoxy_mutex_init(&log_mutex);
4539 privoxy_mutex_init(&log_init_mutex);
4540 privoxy_mutex_init(&connection_reuse_mutex);
4541 #ifdef FEATURE_EXTERNAL_FILTERS
4542 privoxy_mutex_init(&external_filter_mutex);
4544 #ifdef FEATURE_CLIENT_TAGS
4545 privoxy_mutex_init(&client_tags_mutex);
4549 * XXX: The assumptions below are a bit naive
4550 * and can cause locks that aren't necessary.
4552 * For example older FreeBSD versions (< 6.x?)
4553 * have no gethostbyname_r, but gethostbyname is
4556 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
4557 privoxy_mutex_init(&resolver_mutex);
4558 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
4560 * XXX: should we use a single mutex for
4561 * localtime() and gmtime() as well?
4563 #ifndef HAVE_GMTIME_R
4564 privoxy_mutex_init(&gmtime_mutex);
4565 #endif /* ndef HAVE_GMTIME_R */
4567 #ifndef HAVE_LOCALTIME_R
4568 privoxy_mutex_init(&localtime_mutex);
4569 #endif /* ndef HAVE_GMTIME_R */
4571 #if !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM)
4572 privoxy_mutex_init(&rand_mutex);
4573 #endif /* !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM) */
4575 #endif /* def MUTEX_LOCKS_AVAILABLE */
4578 /*********************************************************************
4582 * Description : Load the config file and start the listen loop.
4583 * This function is a lot more *sane* with the `load_config'
4584 * and `listen_loop' functions; although it stills does
4585 * a *little* too much for my taste.
4588 * 1 : argc = Number of parameters (including $0).
4589 * 2 : argv = Array of (char *)'s to the parameters.
4591 * Returns : 1 if : can't open config file, unrecognized directive,
4592 * stats requested in multi-thread mode, can't open the
4593 * log file, can't open the jar file, listen port is invalid,
4594 * any load fails, and can't bind port.
4596 * Else main never returns, the process must be signaled
4597 * to terminate execution. Or, on Windows, use the
4598 * "File", "Exit" menu option.
4600 *********************************************************************/
4602 int real_main(int argc, char **argv)
4604 int main(int argc, char **argv)
4608 int do_config_test = 0;
4609 #ifndef HAVE_ARC4RANDOM
4610 unsigned int random_seed;
4613 struct passwd *pw = NULL;
4614 struct group *grp = NULL;
4616 char *pre_chroot_nslookup_to_load_resolver = NULL;
4619 char *fuzz_input_type = NULL;
4620 char *fuzz_input_file = NULL;
4627 #if !defined(_WIN32)
4634 /* Prepare mutexes if supported and necessary. */
4635 initialize_mutexes();
4637 /* Enable logging until further notice. */
4641 * Parse the command line arguments
4643 * XXX: simply printing usage information in case of
4644 * invalid arguments isn't particularly user friendly.
4646 while (++argc_pos < argc)
4649 /* Check to see if the service must be installed or uninstalled */
4650 if (strncmp(argv[argc_pos], "--install", 9) == 0)
4652 const char *pName = argv[argc_pos] + 9;
4655 exit((install_service(pName)) ? 0 : 1);
4657 else if (strncmp(argv[argc_pos], "--uninstall", 11) == 0)
4659 const char *pName = argv[argc_pos] + 11;
4662 exit((uninstall_service(pName)) ? 0 : 1);
4664 else if (strcmp(argv[argc_pos], "--service") == 0)
4666 bRunAsService = TRUE;
4667 w32_set_service_cwd();
4668 atexit(w32_service_exit_notify);
4671 #endif /* defined(_WIN32) */
4674 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
4676 if (strcmp(argv[argc_pos], "--help") == 0)
4681 else if (strcmp(argv[argc_pos], "--version") == 0)
4683 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
4689 else if (strcmp(argv[argc_pos], "--no-daemon") == 0)
4691 set_debug_level(LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
4695 else if (strcmp(argv[argc_pos], "--pidfile") == 0)
4697 if (++argc_pos == argc) usage(argv[0]);
4698 pidfile = strdup_or_die(argv[argc_pos]);
4701 else if (strcmp(argv[argc_pos], "--user") == 0)
4706 if (++argc_pos == argc) usage(argv[argc_pos]);
4708 user_arg = strdup_or_die(argv[argc_pos]);
4709 group_name = strchr(user_arg, '.');
4710 if (NULL != group_name)
4712 /* Nul-terminate the user name */
4715 /* Skip the former delimiter to actually reach the group name */
4718 grp = getgrnam(group_name);
4721 log_error(LOG_LEVEL_FATAL, "Group '%s' not found.", group_name);
4724 pw = getpwnam(user_arg);
4727 log_error(LOG_LEVEL_FATAL, "User '%s' not found.", user_arg);
4733 else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup") == 0)
4735 if (++argc_pos == argc) usage(argv[0]);
4736 pre_chroot_nslookup_to_load_resolver = strdup_or_die(argv[argc_pos]);
4739 else if (strcmp(argv[argc_pos], "--chroot") == 0)
4743 #endif /* defined(unix) */
4745 else if (strcmp(argv[argc_pos], "--config-test") == 0)
4750 else if (strcmp(argv[argc_pos], "--fuzz") == 0)
4753 if (argc < argc_pos + 2) usage(argv[0]);
4754 fuzz_input_type = argv[argc_pos];
4756 fuzz_input_file = argv[argc_pos];
4758 else if (strcmp(argv[argc_pos], "--stfu") == 0)
4760 set_debug_level(LOG_LEVEL_STFU);
4763 else if (argc_pos + 1 != argc)
4766 * This is neither the last command line
4767 * option, nor was it recognized before,
4768 * therefore it must be invalid.
4774 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
4776 configfile = argv[argc_pos];
4779 } /* -END- while (more arguments) */
4781 show_version(Argv[0]);
4784 if (*configfile != '/')
4786 char cwd[BUFFER_SIZE];
4788 size_t abs_file_size;
4790 /* make config-filename absolute here */
4791 if (NULL == getcwd(cwd, sizeof(cwd)))
4793 perror("failed to get current working directory");
4797 basedir = strdup_or_die(cwd);
4799 abs_file_size = strlen(cwd) + strlen(configfile) + 5;
4800 abs_file = malloc_or_die(abs_file_size);
4801 strlcpy(abs_file, basedir, abs_file_size);
4802 strlcat(abs_file, "/", abs_file_size);
4803 strlcat(abs_file, configfile, abs_file_size);
4804 configfile = abs_file;
4806 #endif /* defined unix */
4810 clients->next = NULL;
4812 /* XXX: factor out initialising after the next stable release. */
4817 #ifndef HAVE_ARC4RANDOM
4818 random_seed = (unsigned int)time(NULL);
4820 srandom(random_seed);
4823 #endif /* ifdef HAVE_RANDOM */
4824 #endif /* ifndef HAVE_ARC4RANDOM */
4827 * Unix signal handling
4829 * Catch the abort, interrupt and terminate signals for a graceful exit
4830 * Catch the hangup signal so the errlog can be reopened.
4832 * Ignore the broken pipe signal as connection failures
4833 * are handled when and where they occur without relying
4836 #if !defined(_WIN32) && !defined(__OS2__)
4839 const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP };
4841 for (idx = 0; idx < SZ(catched_signals); idx++)
4843 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
4844 if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
4846 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
4847 #endif /* ifdef sun */
4849 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
4853 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
4855 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for SIGPIPE: %E");
4859 #else /* ifdef _WIN32 */
4860 # ifdef _WIN_CONSOLE
4862 * We *are* in a windows console app.
4863 * Print a verbose messages about FAQ's and such
4865 printf("%s", win32_blurb);
4866 # endif /* def _WIN_CONSOLE */
4867 #endif /* def _WIN32 */
4870 if (fuzz_input_type != NULL)
4872 exit(process_fuzzed_input(fuzz_input_type, fuzz_input_file));
4874 log_error(LOG_LEVEL_FATAL,
4875 "When compiled with fuzzing support, Privoxy should only be used for fuzzing. "
4876 "Various data structures are static which is unsafe when using threads.");
4881 exit(NULL == load_config());
4884 /* Initialize the CGI subsystem */
4885 cgi_init_error_messages();
4888 * If running on unix and without the --no-daemon
4889 * option, become a daemon. I.e. fork, detach
4890 * from tty and get process group leadership
4899 if (pid < 0) /* error */
4904 else if (pid != 0) /* parent */
4909 * must check for errors
4910 * child died due to missing files aso
4913 wpid = waitpid(pid, &status, WNOHANG);
4925 * stderr (fd 2) will be closed later on,
4926 * when the config file has been parsed.
4932 * Reserve fd 0 and 1 to prevent abort() and friends
4933 * from sending stuff to the clients or servers.
4935 fd = open("/dev/null", O_RDONLY);
4938 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
4942 if (dup2(fd, 0) == -1)
4944 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 0: %E");
4948 fd = open("/dev/null", O_WRONLY);
4951 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
4955 if (dup2(fd, 1) == -1)
4957 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 1: %E");
4962 #ifdef FEATURE_EXTERNAL_FILTERS
4963 for (fd = 0; fd < 3; fd++)
4965 mark_socket_for_close_on_execute(fd);
4971 } /* -END- if (daemon_mode) */
4974 * As soon as we have written the PID file, we can switch
4975 * to the user and group ID indicated by the --user option
4977 if (pidfile != NULL)
4979 write_pid_file(pidfile);
4983 if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
4985 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
4989 if (setgroups(1, &grp->gr_gid))
4991 log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
4994 else if (initgroups(pw->pw_name, pw->pw_gid))
4996 log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
5002 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
5004 /* Read the time zone file from /etc before doing chroot. */
5006 if (NULL != pre_chroot_nslookup_to_load_resolver
5007 && '\0' != pre_chroot_nslookup_to_load_resolver[0])
5009 /* Initialize resolver library. */
5010 (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
5012 if (chroot(pw->pw_dir) < 0)
5014 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
5018 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
5021 if (setuid(pw->pw_uid))
5023 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
5027 char putenv_dummy[64];
5029 strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
5030 if (putenv(putenv_dummy) != 0)
5032 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
5035 snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
5036 if (putenv(putenv_dummy) != 0)
5038 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
5044 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
5047 #endif /* defined unix */
5050 /* This will be FALSE unless the command line specified --service
5054 /* Yup, so now we must attempt to establish a connection
5055 * with the service dispatcher. This will only work if this
5056 * process was launched by the service control manager to
5057 * actually run as a service. If this isn't the case, i've
5058 * known it take around 30 seconds or so for the call to return.
5061 /* The StartServiceCtrlDispatcher won't return until the service is stopping */
5062 if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
5064 /* Service has run, and at this point is now being stopped, so just return */
5069 printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
5071 /* An error occurred. Usually it's because --service was wrongly specified
5072 * and we were unable to connect to the Service Control Dispatcher because
5073 * it wasn't expecting us and is therefore not listening.
5075 * For now, just continue below to call the listen_loop function.
5078 #endif /* def _WIN32 */
5088 /*********************************************************************
5090 * Function : bind_port_helper
5092 * Description : Bind the listen port. Handles logging, and aborts
5096 * 1 : haddr = Host address to bind to. Use NULL to bind to
5098 * 2 : hport = Specifies port to bind to.
5099 * 3 : backlog = Listen backlog.
5101 * Returns : Port that was opened.
5103 *********************************************************************/
5104 static jb_socket bind_port_helper(const char *haddr, int hport, int backlog)
5109 result = bind_port(haddr, hport, backlog, &bfd);
5113 const char *bind_address = (NULL != haddr) ? haddr : "INADDR_ANY";
5117 log_error(LOG_LEVEL_FATAL,
5118 "can't bind to %s:%d: There may be another Privoxy "
5119 "or some other proxy running on port %d",
5120 bind_address, hport, hport);
5123 log_error(LOG_LEVEL_FATAL,
5124 "can't bind to %s:%d: The hostname is not resolvable",
5125 bind_address, hport);
5128 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: %E",
5129 bind_address, hport);
5132 /* shouldn't get here */
5133 return JB_INVALID_SOCKET;
5138 if (bfd >= FD_SETSIZE)
5140 log_error(LOG_LEVEL_FATAL,
5141 "Bind socket number too high to use select(): %d >= %d",
5149 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
5154 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
5162 /*********************************************************************
5164 * Function : bind_ports_helper
5166 * Description : Bind the listen ports. Handles logging, and aborts
5170 * 1 : config = Privoxy configuration. Specifies ports
5172 * 2 : sockets = Preallocated array of opened sockets
5173 * corresponding to specification in config.
5174 * All non-opened sockets will be set to
5175 * JB_INVALID_SOCKET.
5177 * Returns : Nothing. Inspect sockets argument.
5179 *********************************************************************/
5180 static void bind_ports_helper(struct configuration_spec * config,
5181 jb_socket sockets[])
5185 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
5187 if (config->hport[i])
5189 sockets[i] = bind_port_helper(config->haddr[i],
5190 config->hport[i], config->listen_backlog);
5191 #if defined(FEATURE_ACCEPT_FILTER) && defined(SO_ACCEPTFILTER)
5192 if (config->enable_accept_filter && sockets[i] != JB_INVALID_SOCKET)
5194 struct accept_filter_arg af_options;
5195 bzero(&af_options, sizeof(af_options));
5196 strlcpy(af_options.af_name, "httpready", sizeof(af_options.af_name));
5197 if (setsockopt(sockets[i], SOL_SOCKET, SO_ACCEPTFILTER, &af_options,
5198 sizeof(af_options)))
5200 log_error(LOG_LEVEL_ERROR,
5201 "Enabling accept filter for socket %d failed: %E", sockets[i]);
5208 sockets[i] = JB_INVALID_SOCKET;
5211 config->need_bind = 0;
5215 /*********************************************************************
5217 * Function : close_ports_helper
5219 * Description : Close listenings ports.
5222 * 1 : sockets = Array of opened and non-opened sockets to
5223 * close. All sockets will be set to
5224 * JB_INVALID_SOCKET.
5226 * Returns : Nothing.
5228 *********************************************************************/
5229 static void close_ports_helper(jb_socket sockets[])
5233 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
5235 if (JB_INVALID_SOCKET != sockets[i])
5237 close_socket(sockets[i]);
5239 sockets[i] = JB_INVALID_SOCKET;
5245 /* Without this simple workaround we get this compiler warning from _beginthread
5246 * warning C4028: formal parameter 1 different from declaration
5248 void w32_service_listen_loop(void *p)
5252 #endif /* def _WIN32 */
5255 /*********************************************************************
5257 * Function : listen_loop
5259 * Description : bind the listen port and enter a "FOREVER" listening loop.
5265 *********************************************************************/
5266 static void listen_loop(void)
5268 struct client_states *csp_list = NULL;
5269 struct client_state *csp = NULL;
5270 jb_socket bfds[MAX_LISTENING_SOCKETS];
5271 struct configuration_spec *config;
5272 unsigned int active_threads = 0;
5273 #if defined(FEATURE_PTHREAD)
5274 pthread_attr_t attrs;
5276 pthread_attr_init(&attrs);
5277 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
5280 config = load_config();
5282 #ifdef FEATURE_CONNECTION_SHARING
5284 * XXX: Should be relocated once it no
5285 * longer needs to emit log messages.
5287 initialize_reusable_connections();
5288 #endif /* def FEATURE_CONNECTION_SHARING */
5290 bind_ports_helper(config, bfds);
5292 #ifdef FEATURE_GRACEFUL_TERMINATION
5293 while (!g_terminate)
5298 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(__OS2__)
5299 while (waitpid(-1, NULL, WNOHANG) > 0)
5301 /* zombie children */
5303 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) */
5306 * Free data that was used by died threads
5308 active_threads = sweep();
5312 * Re-open the errlog after HUP signal
5314 if (received_hup_signal)
5316 if (NULL != config->logfile)
5318 init_error_log(Argv[0], config->logfile);
5320 received_hup_signal = 0;
5324 csp_list = zalloc_or_die(sizeof(*csp_list));
5325 csp = &csp_list->csp;
5327 log_error(LOG_LEVEL_CONNECT,
5328 "Waiting for the next client connection. Currently active threads: %d",
5332 * This config may be outdated, but for accept_connection()
5333 * it's fresh enough.
5335 csp->config = config;
5337 if (!accept_connection(csp, bfds))
5339 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
5344 csp->flags |= CSP_FLAG_ACTIVE;
5345 csp->server_connection.sfd = JB_INVALID_SOCKET;
5347 csp->config = config = load_config();
5349 if (config->need_bind)
5352 * Since we were listening to the "old port", we will not see
5353 * a "listen" param change until the next request. So, at
5354 * least 1 more request must be made for us to find the new
5355 * setting. I am simply closing the old socket and binding the
5358 * Which-ever is correct, we will serve 1 more page via the
5359 * old settings. This should probably be a "show-status"
5360 * request. This should not be a so common of an operation
5361 * that this will hurt people's feelings.
5364 close_ports_helper(bfds);
5366 bind_ports_helper(config, bfds);
5369 #ifdef FEATURE_TOGGLE
5370 if (global_toggle_state)
5371 #endif /* def FEATURE_TOGGLE */
5373 csp->flags |= CSP_FLAG_TOGGLED_ON;
5376 if (run_loader(csp))
5378 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
5379 /* Never get here - LOG_LEVEL_FATAL causes program exit */
5383 if (block_acl(NULL,csp))
5385 log_error(LOG_LEVEL_CONNECT,
5386 "Connection from %s on %s (socket %d) dropped due to ACL",
5387 csp->ip_addr_str, csp->listen_addr_str, csp->cfd);
5388 close_socket(csp->cfd);
5389 freez(csp->ip_addr_str);
5390 freez(csp->listen_addr_str);
5394 #endif /* def FEATURE_ACL */
5396 if ((0 != config->max_client_connections)
5397 && (active_threads >= config->max_client_connections))
5399 log_error(LOG_LEVEL_CONNECT,
5400 "Rejecting connection from %s. Maximum number of connections reached.",
5402 write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
5403 strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
5404 close_socket(csp->cfd);
5405 freez(csp->ip_addr_str);
5406 freez(csp->listen_addr_str);
5411 /* add it to the list of clients */
5412 csp_list->next = clients->next;
5413 clients->next = csp_list;
5415 if (config->multi_threaded)
5419 /* this is a switch () statement in the C preprocessor - ugh */
5420 #undef SELECTED_ONE_OPTION
5422 /* Use Pthreads in preference to native code */
5423 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
5424 #define SELECTED_ONE_OPTION
5426 pthread_t the_thread;
5428 errno = pthread_create(&the_thread, &attrs,
5429 (void * (*)(void *))serve, csp);
5430 child_id = errno ? -1 : 0;
5434 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
5435 #define SELECTED_ONE_OPTION
5436 child_id = _beginthread(
5437 (void (*)(void *))serve,
5442 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
5443 #define SELECTED_ONE_OPTION
5444 child_id = _beginthread(
5445 (void(* _Optlink)(void*))serve,
5451 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
5452 #define SELECTED_ONE_OPTION
5454 thread_id tid = spawn_thread
5455 (server_thread, "server", B_NORMAL_PRIORITY, csp);
5457 if ((tid >= 0) && (resume_thread(tid) == B_OK))
5459 child_id = (int) tid;
5468 #if !defined(SELECTED_ONE_OPTION)
5471 /* This block is only needed when using fork().
5472 * When using threads, the server thread was
5473 * created and run by the call to _beginthread().
5475 if (child_id == 0) /* child */
5478 #ifdef FEATURE_TOGGLE
5479 int inherited_toggle_state = global_toggle_state;
5480 #endif /* def FEATURE_TOGGLE */
5485 * If we've been toggled or we've blocked the request, tell Mom
5488 #ifdef FEATURE_TOGGLE
5489 if (inherited_toggle_state != global_toggle_state)
5491 rc |= RC_FLAG_TOGGLED;
5493 #endif /* def FEATURE_TOGGLE */
5495 #ifdef FEATURE_STATISTICS
5496 if (csp->flags & CSP_FLAG_REJECTED)
5498 rc |= RC_FLAG_BLOCKED;
5500 #endif /* ndef FEATURE_STATISTICS */
5504 else if (child_id > 0) /* parent */
5506 /* in a fork()'d environment, the parent's
5507 * copy of the client socket and the CSP
5511 #if !defined(_WIN32) && !defined(__CYGWIN__)
5513 wait(&child_status);
5516 * Evaluate child's return code: If the child has
5517 * - been toggled, toggle ourselves
5518 * - blocked its request, bump up the stats counter
5521 #ifdef FEATURE_TOGGLE
5522 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
5524 global_toggle_state = !global_toggle_state;
5526 #endif /* def FEATURE_TOGGLE */
5528 #ifdef FEATURE_STATISTICS
5530 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
5534 #endif /* def FEATURE_STATISTICS */
5536 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
5537 close_socket(csp->cfd);
5538 csp->flags &= ~CSP_FLAG_ACTIVE;
5542 #undef SELECTED_ONE_OPTION
5543 /* end of cpp switch () */
5548 * Spawning the child failed, assume it's because
5549 * there are too many children running already.
5550 * XXX: If you assume ...
5552 log_error(LOG_LEVEL_ERROR,
5553 "Unable to take any additional connections: %E. Active threads: %d",
5555 write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
5556 strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
5557 close_socket(csp->cfd);
5558 csp->flags &= ~CSP_FLAG_ACTIVE;
5567 #if defined(FEATURE_PTHREAD)
5568 pthread_attr_destroy(&attrs);
5571 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
5573 #ifdef FEATURE_HTTPS_INSPECTION
5574 /* Clean up. Aim: free all memory (no leaks) */
5575 if (rng_seeded == 1)
5577 mbedtls_ctr_drbg_free(&ctr_drbg);
5578 mbedtls_entropy_free(&entropy);
5582 #ifdef FEATURE_GRACEFUL_TERMINATION
5584 log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
5586 unload_current_config_file();
5587 unload_current_actions_file();
5588 unload_current_re_filterfile();
5589 #ifdef FEATURE_TRUST
5590 unload_current_trust_file();
5593 if (config->multi_threaded)
5600 } while ((clients->next != NULL) && (--i > 0));
5604 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
5614 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
5615 /* Cleanup - remove taskbar icon etc. */
5620 #endif /* FEATURE_GRACEFUL_TERMINATION */