1 /*********************************************************************
3 * File : $Source: /cvsroot/ijbswa/current/jcc.c,v $
5 * Purpose : Main file. Contains main() method, main loop, and
6 * the main connection-handling function.
8 * Copyright : Written by and Copyright (C) 2001-2020 the
9 * Privoxy team. https://www.privoxy.org/
11 * Based on the Internet Junkbuster originally written
12 * by and Copyright (C) 1997 Anonymous Coders and
13 * Junkbusters Corporation. http://www.junkbusters.com
15 * This program is free software; you can redistribute it
16 * and/or modify it under the terms of the GNU General
17 * Public License as published by the Free Software
18 * Foundation; either version 2 of the License, or (at
19 * your option) any later version.
21 * This program is distributed in the hope that it will
22 * be useful, but WITHOUT ANY WARRANTY; without even the
23 * implied warranty of MERCHANTABILITY or FITNESS FOR A
24 * PARTICULAR PURPOSE. See the GNU General Public
25 * License for more details.
27 * The GNU General Public License should be included with
28 * this file. If not, you can view it at
29 * http://www.gnu.org/copyleft/gpl.html
30 * or write to the Free Software Foundation, Inc., 59
31 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
33 *********************************************************************/
39 #include <sys/types.h>
48 # ifndef FEATURE_PTHREAD
52 # include <winsock2.h>
55 # endif /* ndef FEATURE_PTHREAD */
60 # endif /* ndef _WIN_CONSOLE */
61 # include "w32svrapi.h"
63 #else /* ifndef _WIN32 */
65 # if !defined (__OS2__)
67 # include <sys/wait.h>
68 # endif /* ndef __OS2__ */
69 # include <sys/time.h>
70 # include <sys/stat.h>
71 # include <sys/ioctl.h>
74 #include <sys/termios.h>
85 # include <socket.h> /* BeOS has select() for sockets only. */
86 # include <OS.h> /* declarations for threads and stuff. */
89 # if defined(__EMX__) || defined(__OS2__)
90 # include <sys/select.h> /* OS/2/EMX needs a little help with select */
102 #endif /* def __GLIBC__ */
107 #warning poll() appears to be unavailable. Your platform will become unsupported in the future.
108 #endif /* HAVE_POLL */
115 #ifdef FEATURE_HTTPS_INSPECTION
121 #include "miscutil.h"
123 #include "jbsockets.h"
128 #include "urlmatch.h"
129 #ifdef FEATURE_CLIENT_TAGS
130 #include "client-tags.h"
134 struct client_states clients[1];
135 struct file_list files[1];
137 #ifdef FEATURE_STATISTICS
138 int urls_read = 0; /* total nr of urls read inc rejected */
139 int urls_rejected = 0; /* total nr of urls rejected */
140 #endif /* def FEATURE_STATISTICS */
142 #ifdef FEATURE_GRACEFUL_TERMINATION
146 #if !defined(_WIN32) && !defined(__OS2__)
147 static void sig_handler(int the_signal);
149 static int client_protocol_is_unsupported(struct client_state *csp, char *req);
150 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers);
151 static jb_err get_server_headers(struct client_state *csp);
152 static const char *crunch_reason(const struct http_response *rsp);
153 static void send_crunch_response(struct client_state *csp, struct http_response *rsp);
154 static char *get_request_line(struct client_state *csp);
155 static jb_err receive_client_request(struct client_state *csp);
156 static jb_err parse_client_request(struct client_state *csp);
157 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line);
158 static jb_err change_request_destination(struct client_state *csp);
159 static void chat(struct client_state *csp);
160 static void serve(struct client_state *csp);
161 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
162 static void usage(const char *myname);
164 static void initialize_mutexes(void);
165 static jb_socket bind_port_helper(const char *haddr, int hport, int backlog);
166 static void bind_ports_helper(struct configuration_spec *config, jb_socket sockets[]);
167 static void close_ports_helper(jb_socket sockets[]);
168 static void listen_loop(void);
169 static void serve(struct client_state *csp);
172 static int32 server_thread(void *data);
173 #endif /* def __BEOS__ */
176 #define sleep(N) Sleep(((N) * 1000))
180 #define sleep(N) DosSleep(((N) * 100))
184 int process_fuzzed_input(char *fuzz_input_type, char *fuzz_input_file);
185 void show_fuzz_usage(const char *name);
188 #ifdef MUTEX_LOCKS_AVAILABLE
190 * XXX: Does the locking stuff really belong in this file?
192 privoxy_mutex_t log_mutex;
193 privoxy_mutex_t log_init_mutex;
194 privoxy_mutex_t connection_reuse_mutex;
196 #ifdef FEATURE_HTTPS_INSPECTION
197 privoxy_mutex_t certificate_mutex;
198 privoxy_mutex_t rng_mutex;
201 #ifdef FEATURE_EXTERNAL_FILTERS
202 privoxy_mutex_t external_filter_mutex;
204 #ifdef FEATURE_CLIENT_TAGS
205 privoxy_mutex_t client_tags_mutex;
208 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
209 privoxy_mutex_t resolver_mutex;
210 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
212 #ifndef HAVE_GMTIME_R
213 privoxy_mutex_t gmtime_mutex;
214 #endif /* ndef HAVE_GMTIME_R */
216 #ifndef HAVE_LOCALTIME_R
217 privoxy_mutex_t localtime_mutex;
218 #endif /* ndef HAVE_GMTIME_R */
220 #if !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM)
221 privoxy_mutex_t rand_mutex;
222 #endif /* !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM) */
224 #endif /* def MUTEX_LOCKS_AVAILABLE */
227 const char *basedir = NULL;
228 const char *pidfile = NULL;
229 static int received_hup_signal = 0;
230 #endif /* defined unix */
232 /* HTTP snipplets. */
233 static const char CSUCCEED[] =
234 "HTTP/1.1 200 Connection established\r\n\r\n";
236 static const char CHEADER[] =
237 "HTTP/1.1 400 Invalid header received from client\r\n"
238 "Content-Type: text/plain\r\n"
239 "Connection: close\r\n\r\n"
240 "Invalid header received from client.\r\n";
242 static const char FTP_RESPONSE[] =
243 "HTTP/1.1 400 Invalid request received from client\r\n"
244 "Content-Type: text/plain\r\n"
245 "Connection: close\r\n\r\n"
246 "Invalid request. Privoxy doesn't support FTP.\r\n";
248 static const char GOPHER_RESPONSE[] =
249 "HTTP/1.1 400 Invalid request received from client\r\n"
250 "Content-Type: text/plain\r\n"
251 "Connection: close\r\n\r\n"
252 "Invalid request. Privoxy doesn't support gopher.\r\n";
254 /* XXX: should be a template */
255 static const char MISSING_DESTINATION_RESPONSE[] =
256 "HTTP/1.1 400 Bad request received from client\r\n"
257 "Content-Type: text/plain\r\n"
258 "Connection: close\r\n\r\n"
259 "Bad request. Privoxy was unable to extract the destination.\r\n";
261 /* XXX: should be a template */
262 static const char INVALID_SERVER_HEADERS_RESPONSE[] =
263 "HTTP/1.1 502 Server or forwarder response invalid\r\n"
264 "Content-Type: text/plain\r\n"
265 "Connection: close\r\n\r\n"
266 "Bad response. The server or forwarder response doesn't look like HTTP.\r\n";
268 /* XXX: should be a template */
269 static const char MESSED_UP_REQUEST_RESPONSE[] =
270 "HTTP/1.1 400 Malformed request after rewriting\r\n"
271 "Content-Type: text/plain\r\n"
272 "Connection: close\r\n\r\n"
273 "Bad request. Messed up with header filters.\r\n";
275 static const char TOO_MANY_CONNECTIONS_RESPONSE[] =
276 "HTTP/1.1 503 Too many open connections\r\n"
277 "Content-Type: text/plain\r\n"
278 "Connection: close\r\n\r\n"
279 "Maximum number of open connections reached.\r\n";
281 static const char CLIENT_CONNECTION_TIMEOUT_RESPONSE[] =
282 "HTTP/1.1 504 Connection timeout\r\n"
283 "Content-Type: text/plain\r\n"
284 "Connection: close\r\n\r\n"
285 "The connection timed out because the client request didn't arrive in time.\r\n";
287 static const char CLIENT_BODY_PARSE_ERROR_RESPONSE[] =
288 "HTTP/1.1 400 Failed reading client body\r\n"
289 "Content-Type: text/plain\r\n"
290 "Connection: close\r\n\r\n"
291 "Failed parsing or buffering the chunk-encoded client body.\r\n";
293 static const char UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE[] =
294 "HTTP/1.1 417 Expecting too much\r\n"
295 "Content-Type: text/plain\r\n"
296 "Connection: close\r\n\r\n"
297 "Privoxy detected an unsupported Expect header value.\r\n";
299 /* A function to crunch a response */
300 typedef struct http_response *(*crunch_func_ptr)(struct client_state *);
302 /* Crunch function flags */
303 #define CF_NO_FLAGS 0
304 /* Cruncher applies to forced requests as well */
305 #define CF_IGNORE_FORCE 1
306 /* Crunched requests are counted for the block statistics */
307 #define CF_COUNT_AS_REJECT 2
309 /* A crunch function and its flags */
312 const crunch_func_ptr cruncher;
316 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[]);
318 /* Complete list of cruncher functions */
319 static const struct cruncher crunchers_all[] = {
320 { direct_response, CF_COUNT_AS_REJECT|CF_IGNORE_FORCE},
321 { block_url, CF_COUNT_AS_REJECT },
323 { trust_url, CF_COUNT_AS_REJECT },
324 #endif /* def FEATURE_TRUST */
325 { redirect_url, CF_NO_FLAGS },
326 { dispatch_cgi, CF_IGNORE_FORCE},
330 /* Light version, used after tags are applied */
331 static const struct cruncher crunchers_light[] = {
332 { block_url, CF_COUNT_AS_REJECT },
333 { redirect_url, CF_NO_FLAGS },
339 * XXX: Don't we really mean
345 #if !defined(_WIN32) && !defined(__OS2__)
346 /*********************************************************************
348 * Function : sig_handler
350 * Description : Signal handler for different signals.
351 * Exit gracefully on TERM and INT
352 * or set a flag that will cause the errlog
353 * to be reopened by the main thread on HUP.
356 * 1 : the_signal = the signal cause this function to call
360 *********************************************************************/
361 static void sig_handler(int the_signal)
367 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
379 received_hup_signal = 1;
385 * We shouldn't be here, unless we catch signals
386 * in main() that we can't handle here!
388 log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
396 /*********************************************************************
398 * Function : get_write_delay
400 * Description : Parse the delay-response parameter.
403 * 1 : csp = Current client state (buffers, headers, etc...)
405 * Returns : Number of milliseconds to delay writes.
407 *********************************************************************/
408 static unsigned int get_write_delay(const struct client_state *csp)
414 if ((csp->action->flags & ACTION_DELAY_RESPONSE) == 0)
418 newval = csp->action->string[ACTION_STRING_DELAY_RESPONSE];
420 delay = (unsigned)strtol(newval, &endptr, 0);
423 log_error(LOG_LEVEL_FATAL,
424 "Invalid delay-response{} parameter: '%s'", newval);
432 /*********************************************************************
434 * Function : client_protocol_is_unsupported
436 * Description : Checks if the client used a known unsupported
437 * protocol and deals with it by sending an error
441 * 1 : csp = Current client state (buffers, headers, etc...)
442 * 2 : req = the first request line send by the client
444 * Returns : TRUE if an error response has been generated, or
445 * FALSE if the request doesn't look invalid.
447 *********************************************************************/
448 static int client_protocol_is_unsupported(struct client_state *csp, char *req)
451 * If it's a FTP or gopher request, we don't support it.
453 * These checks are better than nothing, but they might
454 * not work in all configurations and some clients might
455 * have problems digesting the answer.
457 * They should, however, never cause more problems than
458 * Privoxy's old behaviour (returning the misleading HTML
461 * "Could not resolve http://(ftp|gopher)://example.org").
463 if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
465 const char *response = NULL;
466 const char *protocol = NULL;
468 if (!strncmpic(req, "GET ftp://", 10))
470 response = FTP_RESPONSE;
475 response = GOPHER_RESPONSE;
478 log_error(LOG_LEVEL_ERROR,
479 "%s tried to use Privoxy as %s proxy: %s",
480 csp->ip_addr_str, protocol, req);
481 log_error(LOG_LEVEL_CLF,
482 "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, req);
485 #ifdef FEATURE_HTTPS_INSPECTION
486 if (client_use_ssl(csp))
488 ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
489 (const unsigned char *)response, strlen(response),
490 get_write_delay(csp));
495 write_socket_delayed(csp->cfd, response, strlen(response),
496 get_write_delay(csp));
506 /*********************************************************************
508 * Function : client_has_unsupported_expectations
510 * Description : Checks if the client used an unsupported expectation
511 * in which case an error message is delivered.
514 * 1 : csp = Current client state (buffers, headers, etc...)
516 * Returns : TRUE if an error response has been generated, or
517 * FALSE if the request doesn't look invalid.
519 *********************************************************************/
520 static int client_has_unsupported_expectations(const struct client_state *csp)
522 if ((csp->flags & CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION))
524 log_error(LOG_LEVEL_ERROR,
525 "Rejecting request from client %s with unsupported Expect header value",
527 log_error(LOG_LEVEL_CLF,
528 "%s - - [%T] \"%s\" 417 0", csp->ip_addr_str, csp->http->cmd);
529 write_socket_delayed(csp->cfd,
530 UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE,
531 strlen(UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE),
532 get_write_delay(csp));
542 /*********************************************************************
544 * Function : get_request_destination_elsewhere
546 * Description : If the client's request was redirected into
547 * Privoxy without the client's knowledge,
548 * the request line lacks the destination host.
550 * This function tries to get it elsewhere,
551 * provided accept-intercepted-requests is enabled.
553 * "Elsewhere" currently only means "Host: header",
554 * but in the future we may ask the redirecting
555 * packet filter to look the destination up.
557 * If the destination stays unknown, an error
558 * response is send to the client and headers
559 * are freed so that chat() can return directly.
562 * 1 : csp = Current client state (buffers, headers, etc...)
563 * 2 : headers = a header list
565 * Returns : JB_ERR_OK if the destination is now known, or
566 * JB_ERR_PARSE if it isn't.
568 *********************************************************************/
569 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
573 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
575 log_error(LOG_LEVEL_ERROR, "%s's request: \'%s\' is invalid."
576 " Privoxy isn't configured to accept intercepted requests.",
577 csp->ip_addr_str, csp->http->cmd);
578 /* XXX: Use correct size */
579 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
580 csp->ip_addr_str, csp->http->cmd);
582 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER),
583 get_write_delay(csp));
584 destroy_list(headers);
588 else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
590 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
591 /* Split the domain we just got for pattern matching */
592 init_domain_components(csp->http);
599 /* We can't work without destination. Go spread the news.*/
601 req = list_to_text(headers);
603 /* XXX: Use correct size */
604 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
605 csp->ip_addr_str, csp->http->cmd);
606 log_error(LOG_LEVEL_ERROR,
607 "Privoxy was unable to get the destination for %s's request:\n%s\n%s",
608 csp->ip_addr_str, csp->http->cmd, req);
611 write_socket_delayed(csp->cfd, MISSING_DESTINATION_RESPONSE,
612 strlen(MISSING_DESTINATION_RESPONSE), get_write_delay(csp));
613 destroy_list(headers);
618 * TODO: If available, use PF's ioctl DIOCNATLOOK as last resort
619 * to get the destination IP address, use it as host directly
620 * or do a reverse DNS lookup first.
625 /*********************************************************************
627 * Function : get_server_headers
629 * Description : Parses server headers in iob and fills them
630 * into csp->headers so that they can later be
634 * 1 : csp = Current client state (buffers, headers, etc...)
636 * Returns : JB_ERR_OK if everything went fine, or
637 * JB_ERR_PARSE if the headers were incomplete.
639 *********************************************************************/
640 static jb_err get_server_headers(struct client_state *csp)
642 int continue_hack_in_da_house = 0;
645 while (((header = get_header(csp->iob)) != NULL) || continue_hack_in_da_house)
650 * continue hack in da house. Ignore the ending of
651 * this head and continue enlisting header lines.
652 * The reason is described below.
654 enlist(csp->headers, "");
655 continue_hack_in_da_house = 0;
658 else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
661 * It's a bodyless continue response, don't
662 * stop header parsing after reaching its end.
664 * As a result Privoxy will concatenate the
665 * next response's head and parse and deliver
666 * the headers as if they belonged to one request.
668 * The client will separate them because of the
669 * empty line between them.
671 * XXX: What we're doing here is clearly against
672 * the intended purpose of the continue header,
673 * and under some conditions (HTTP/1.0 client request)
674 * it's a standard violation.
676 * Anyway, "sort of against the spec" is preferable
677 * to "always getting confused by Continue responses"
678 * (Privoxy's behaviour before this hack was added)
680 log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
681 continue_hack_in_da_house = 1;
683 else if (*header == '\0')
686 * If the header is empty, but the Continue hack
687 * isn't active, we can assume that we reached the
688 * end of the buffer before we hit the end of the
691 * Inform the caller an let it decide how to handle it.
696 if (JB_ERR_MEMORY == enlist(csp->headers, header))
699 * XXX: Should we quit the request and return a
700 * out of memory error page instead?
702 log_error(LOG_LEVEL_ERROR,
703 "Out of memory while enlisting server headers. %s lost.",
713 /*********************************************************************
715 * Function : crunch_reason
717 * Description : Translates the crunch reason code into a string.
720 * 1 : rsp = a http_response
722 * Returns : A string with the crunch reason or an error description.
724 *********************************************************************/
725 static const char *crunch_reason(const struct http_response *rsp)
727 char * reason = NULL;
732 return "Internal error while searching for crunch reason";
735 switch (rsp->crunch_reason)
738 reason = "Unsupported HTTP feature";
744 reason = "Untrusted";
747 reason = "Redirected";
753 reason = "DNS failure";
755 case FORWARDING_FAILED:
756 reason = "Forwarding failed";
759 reason = "Connection failure";
762 reason = "Out of memory (may mask other reasons)";
764 case CONNECTION_TIMEOUT:
765 reason = "Connection timeout";
768 reason = "No server data received";
771 reason = "No reason recorded";
779 /*********************************************************************
781 * Function : log_applied_actions
783 * Description : Logs the applied actions if LOG_LEVEL_ACTIONS is
787 * 1 : actions = Current action spec to log
791 *********************************************************************/
792 static void log_applied_actions(const struct current_action_spec *actions)
795 * The conversion to text requires lots of memory allocations so
796 * we only do the conversion if the user is actually interested.
798 if (debug_level_is_enabled(LOG_LEVEL_ACTIONS))
800 char *actions_as_text = actions_to_line_of_text(actions);
801 log_error(LOG_LEVEL_ACTIONS, "%s", actions_as_text);
802 freez(actions_as_text);
807 /*********************************************************************
809 * Function : send_crunch_response
811 * Description : Delivers already prepared response for
812 * intercepted requests, logs the interception
813 * and frees the response.
816 * 1 : csp = Current client state (buffers, headers, etc...)
817 * 2 : rsp = Fully prepared response. Will be freed on exit.
821 *********************************************************************/
822 static void send_crunch_response(struct client_state *csp, struct http_response *rsp)
824 const struct http_request *http = csp->http;
828 assert(rsp->head != NULL);
832 log_error(LOG_LEVEL_FATAL, "NULL response in send_crunch_response.");
836 * Extract the status code from the actual head
837 * that will be send to the client. It is the only
838 * way to get it right for all requests, including
839 * the fixed ones for out-of-memory problems.
841 * A head starts like this: 'HTTP/1.1 200...'
845 status_code[0] = rsp->head[9];
846 status_code[1] = rsp->head[10];
847 status_code[2] = rsp->head[11];
848 status_code[3] = '\0';
850 /* Log that the request was crunched and why. */
851 log_applied_actions(csp->action);
852 #ifdef FEATURE_HTTPS_INSPECTION
853 if (client_use_ssl(csp))
855 log_error(LOG_LEVEL_CRUNCH, "%s: https://%s%s", crunch_reason(rsp),
856 http->hostport, http->path);
857 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s https://%s%s %s\" %s %llu",
858 csp->ip_addr_str, http->gpc, http->hostport, http->path,
859 http->version, status_code, rsp->content_length);
864 log_error(LOG_LEVEL_CRUNCH, "%s: %s", crunch_reason(rsp), http->url);
865 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" %s %u",
866 csp->ip_addr_str, http->ocmd, status_code, rsp->content_length);
868 /* Write the answer to the client */
869 #ifdef FEATURE_HTTPS_INSPECTION
870 if (client_use_ssl(csp))
872 if ((ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
873 (const unsigned char *)rsp->head, rsp->head_length,
874 get_write_delay(csp)) < 0)
875 || (ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
876 (const unsigned char *)rsp->body, rsp->content_length,
877 get_write_delay(csp)) < 0))
879 /* There is nothing we can do about it. */
880 log_error(LOG_LEVEL_CONNECT, "Couldn't deliver the error message "
881 "for %s through client socket %d using TLS/SSL",
882 http->url, csp->cfd);
888 if (write_socket_delayed(csp->cfd, rsp->head, rsp->head_length,
889 get_write_delay(csp))
890 || write_socket_delayed(csp->cfd, rsp->body, rsp->content_length,
891 get_write_delay(csp)))
893 /* There is nothing we can do about it. */
894 log_error(LOG_LEVEL_CONNECT,
895 "Couldn't deliver the error message for %s through client socket %d: %E",
896 http->url, csp->cfd);
900 /* Clean up and return */
901 if (cgi_error_memory() != rsp)
903 free_http_response(rsp);
909 /*********************************************************************
911 * Function : crunch_response_triggered
913 * Description : Checks if the request has to be crunched,
914 * and delivers the crunch response if necessary.
917 * 1 : csp = Current client state (buffers, headers, etc...)
918 * 2 : crunchers = list of cruncher functions to run
920 * Returns : TRUE if the request was answered with a crunch response
923 *********************************************************************/
924 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[])
926 struct http_response *rsp = NULL;
927 const struct cruncher *c;
930 * If CGI request crunching is disabled,
931 * check the CGI dispatcher out of order to
932 * prevent unintentional blocks or redirects.
934 if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_CRUNCHING)
935 && (NULL != (rsp = dispatch_cgi(csp))))
937 /* Deliver, log and free the interception response. */
938 send_crunch_response(csp, rsp);
939 csp->flags |= CSP_FLAG_CRUNCHED;
943 for (c = crunchers; c->cruncher != NULL; c++)
946 * Check the cruncher if either Privoxy is toggled
947 * on and the request isn't forced, or if the cruncher
948 * applies to forced requests as well.
950 if (((csp->flags & CSP_FLAG_TOGGLED_ON) &&
951 !(csp->flags & CSP_FLAG_FORCED)) ||
952 (c->flags & CF_IGNORE_FORCE))
954 rsp = c->cruncher(csp);
957 /* Deliver, log and free the interception response. */
958 send_crunch_response(csp, rsp);
959 csp->flags |= CSP_FLAG_CRUNCHED;
960 #ifdef FEATURE_STATISTICS
961 if (c->flags & CF_COUNT_AS_REJECT)
963 csp->flags |= CSP_FLAG_REJECTED;
965 #endif /* def FEATURE_STATISTICS */
976 /*********************************************************************
978 * Function : build_request_line
980 * Description : Builds the HTTP request line.
982 * If a HTTP forwarder is used it expects the whole URL,
983 * web servers only get the path.
986 * 1 : csp = Current client state (buffers, headers, etc...)
987 * 2 : fwd = The forwarding spec used for the request
988 * XXX: Should use http->fwd instead.
989 * 3 : request_line = The old request line which will be replaced.
991 * Returns : Nothing. Terminates in case of memory problems.
993 *********************************************************************/
994 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line)
996 struct http_request *http = csp->http;
999 * Downgrade http version from 1.1 to 1.0
1000 * if +downgrade action applies.
1002 if ((csp->action->flags & ACTION_DOWNGRADE)
1003 && (!strcmpic(http->version, "HTTP/1.1")))
1005 freez(http->version);
1006 http->version = strdup_or_die("HTTP/1.0");
1010 * Rebuild the request line.
1012 freez(*request_line);
1013 *request_line = strdup(http->gpc);
1014 string_append(request_line, " ");
1016 if (fwd->forward_host && fwd->type != FORWARD_WEBSERVER)
1018 string_append(request_line, http->url);
1022 string_append(request_line, http->path);
1024 string_append(request_line, " ");
1025 string_append(request_line, http->version);
1027 if (*request_line == NULL)
1029 log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
1031 log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", *request_line);
1035 /*********************************************************************
1037 * Function : change_request_destination
1039 * Description : Parse a (rewritten) request line and regenerate
1040 * the http request data.
1043 * 1 : csp = Current client state (buffers, headers, etc...)
1045 * Returns : Forwards the parse_http_request() return code.
1046 * Terminates in case of memory problems.
1048 *********************************************************************/
1049 static jb_err change_request_destination(struct client_state *csp)
1051 struct http_request *http = csp->http;
1054 log_error(LOG_LEVEL_REDIRECTS, "Rewrite detected: %s",
1055 csp->headers->first->str);
1056 free_http_request(http);
1057 err = parse_http_request(csp->headers->first->str, http);
1058 if (JB_ERR_OK != err)
1060 log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
1061 jb_err_to_string(err));
1068 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1069 /*********************************************************************
1071 * Function : server_response_is_complete
1073 * Description : Determines whether we should stop reading
1074 * from the server socket.
1077 * 1 : csp = Current client state (buffers, headers, etc...)
1078 * 2 : content_length = Length of content received so far.
1080 * Returns : TRUE if the response is complete,
1083 *********************************************************************/
1084 static int server_response_is_complete(struct client_state *csp,
1085 unsigned long long content_length)
1087 int content_length_known = !!(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET);
1089 if (!strcmpic(csp->http->gpc, "HEAD"))
1092 * "HEAD" implies no body, we are thus expecting
1093 * no content. XXX: incomplete "list" of methods?
1095 csp->expected_content_length = 0;
1096 content_length_known = TRUE;
1097 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1100 if (csp->http->status == 204 || csp->http->status == 304)
1103 * Expect no body. XXX: incomplete "list" of status codes?
1105 csp->expected_content_length = 0;
1106 content_length_known = TRUE;
1107 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1110 return (content_length_known && ((0 == csp->expected_content_length)
1111 || (csp->expected_content_length <= content_length)));
1115 #ifdef FEATURE_CONNECTION_SHARING
1116 /*********************************************************************
1118 * Function : wait_for_alive_connections
1120 * Description : Waits for alive connections to timeout.
1126 *********************************************************************/
1127 static void wait_for_alive_connections(void)
1129 int connections_alive = close_unusable_connections();
1131 while (0 < connections_alive)
1133 log_error(LOG_LEVEL_CONNECT,
1134 "Waiting for %d connections to timeout.",
1137 connections_alive = close_unusable_connections();
1140 log_error(LOG_LEVEL_CONNECT, "No connections to wait for left.");
1143 #endif /* def FEATURE_CONNECTION_SHARING */
1146 /*********************************************************************
1148 * Function : save_connection_destination
1150 * Description : Remembers a connection for reuse later on.
1153 * 1 : sfd = Open socket to remember.
1154 * 2 : http = The destination for the connection.
1155 * 3 : fwd = The forwarder settings used.
1156 * 4 : server_connection = storage.
1160 *********************************************************************/
1161 void save_connection_destination(jb_socket sfd,
1162 const struct http_request *http,
1163 const struct forward_spec *fwd,
1164 struct reusable_connection *server_connection)
1166 assert(sfd != JB_INVALID_SOCKET);
1167 assert(NULL != http->host);
1169 server_connection->sfd = sfd;
1170 server_connection->host = strdup_or_die(http->host);
1171 server_connection->port = http->port;
1173 assert(NULL != fwd);
1174 assert(server_connection->gateway_host == NULL);
1175 assert(server_connection->gateway_port == 0);
1176 assert(server_connection->forwarder_type == 0);
1177 assert(server_connection->forward_host == NULL);
1178 assert(server_connection->forward_port == 0);
1180 server_connection->forwarder_type = fwd->type;
1181 if (NULL != fwd->gateway_host)
1183 server_connection->gateway_host = strdup_or_die(fwd->gateway_host);
1187 server_connection->gateway_host = NULL;
1189 server_connection->gateway_port = fwd->gateway_port;
1191 if (NULL != fwd->forward_host)
1193 server_connection->forward_host = strdup_or_die(fwd->forward_host);
1197 server_connection->forward_host = NULL;
1199 server_connection->forward_port = fwd->forward_port;
1203 /*********************************************************************
1205 * Function : verify_request_length
1207 * Description : Checks if we already got the whole client requests
1208 * and sets CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ if
1211 * Data that doesn't belong to the current request is
1212 * either thrown away to let the client retry on a clean
1213 * socket, or stashed to be dealt with after the current
1214 * request is served.
1217 * 1 : csp = Current client state (buffers, headers, etc...)
1221 *********************************************************************/
1222 static void verify_request_length(struct client_state *csp)
1224 unsigned long long buffered_request_bytes =
1225 (unsigned long long)(csp->client_iob->eod - csp->client_iob->cur);
1227 if ((csp->expected_client_content_length != 0)
1228 && (buffered_request_bytes != 0))
1230 if (csp->expected_client_content_length >= buffered_request_bytes)
1232 csp->expected_client_content_length -= buffered_request_bytes;
1233 log_error(LOG_LEVEL_CONNECT, "Reduced expected bytes to %llu "
1234 "to account for the %llu ones we already got.",
1235 csp->expected_client_content_length, buffered_request_bytes);
1239 assert(csp->client_iob->eod > csp->client_iob->cur + csp->expected_client_content_length);
1240 csp->client_iob->eod = csp->client_iob->cur + csp->expected_client_content_length;
1241 log_error(LOG_LEVEL_CONNECT, "Reducing expected bytes to 0. "
1242 "Marking the server socket tainted after throwing %llu bytes away.",
1243 buffered_request_bytes - csp->expected_client_content_length);
1244 csp->expected_client_content_length = 0;
1245 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1248 if (csp->expected_client_content_length == 0)
1250 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1254 if (!(csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ)
1255 && ((csp->client_iob->cur < csp->client_iob->eod)
1256 || (csp->expected_client_content_length != 0)))
1258 if (strcmpic(csp->http->gpc, "GET")
1259 && strcmpic(csp->http->gpc, "HEAD")
1260 && strcmpic(csp->http->gpc, "TRACE")
1261 && strcmpic(csp->http->gpc, "OPTIONS")
1262 && strcmpic(csp->http->gpc, "DELETE"))
1264 /* XXX: this is an incomplete hack */
1265 csp->flags &= ~CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1266 log_error(LOG_LEVEL_CONNECT, "There better be a request body.");
1270 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1272 if ((csp->config->feature_flags & RUNTIME_FEATURE_TOLERATE_PIPELINING) == 0)
1274 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1275 log_error(LOG_LEVEL_CONNECT,
1276 "Possible pipeline attempt detected. The connection will not "
1277 "be kept alive and we will only serve the first request.");
1278 /* Nuke the pipelined requests from orbit, just to be sure. */
1279 clear_iob(csp->client_iob);
1284 * Keep the pipelined data around for now, we'll deal with
1285 * it once we're done serving the current request.
1287 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
1288 assert(csp->client_iob->eod >= csp->client_iob->cur);
1289 log_error(LOG_LEVEL_CONNECT, "Complete client request followed by "
1290 "%d bytes of pipelined data received.",
1291 (int)(csp->client_iob->eod - csp->client_iob->cur));
1297 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1298 log_error(LOG_LEVEL_CONNECT, "Complete client request received.");
1301 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1304 /*********************************************************************
1306 * Function : mark_server_socket_tainted
1308 * Description : Makes sure we don't reuse a server socket
1309 * (if we didn't read everything the server sent
1310 * us reusing the socket would lead to garbage).
1313 * 1 : csp = Current client state (buffers, headers, etc...)
1317 *********************************************************************/
1318 static void mark_server_socket_tainted(struct client_state *csp)
1321 * For consistency we always mark the server socket
1322 * tainted, however, to reduce the log noise we only
1323 * emit a log message if the server socket could have
1324 * actually been reused.
1326 if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
1327 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED))
1329 log_error(LOG_LEVEL_CONNECT,
1330 "Marking the server socket %d tainted.",
1331 csp->server_connection.sfd);
1333 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1336 /*********************************************************************
1338 * Function : get_request_line
1340 * Description : Read the client request line.
1343 * 1 : csp = Current client state (buffers, headers, etc...)
1345 * Returns : Pointer to request line or NULL in case of errors.
1347 *********************************************************************/
1348 static char *get_request_line(struct client_state *csp)
1350 char buf[BUFFER_SIZE];
1351 char *request_line = NULL;
1354 memset(buf, 0, sizeof(buf));
1356 if ((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
1359 * If there are multiple pipelined requests waiting,
1360 * the flag will be set again once the next request
1363 csp->flags &= ~CSP_FLAG_PIPELINED_REQUEST_WAITING;
1365 request_line = get_header(csp->client_iob);
1366 if ((NULL != request_line) && ('\0' != *request_line))
1368 return request_line;
1372 log_error(LOG_LEVEL_CONNECT, "No complete request line "
1373 "received yet. Continuing reading from %d.", csp->cfd);
1381 0 == (csp->flags & CSP_FLAG_FUZZED_INPUT) &&
1383 !data_is_available(csp->cfd, csp->config->socket_timeout)
1386 if (socket_is_still_alive(csp->cfd))
1388 log_error(LOG_LEVEL_CONNECT,
1389 "No request line on socket %d received in time. Timeout: %d.",
1390 csp->cfd, csp->config->socket_timeout);
1391 write_socket_delayed(csp->cfd, CLIENT_CONNECTION_TIMEOUT_RESPONSE,
1392 strlen(CLIENT_CONNECTION_TIMEOUT_RESPONSE),
1393 get_write_delay(csp));
1397 log_error(LOG_LEVEL_CONNECT,
1398 "The client side of the connection on socket %d got "
1399 "closed without sending a complete request line.", csp->cfd);
1404 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1406 if (len <= 0) return NULL;
1409 * If there is no memory left for buffering the
1410 * request, there is nothing we can do but hang up
1412 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1417 request_line = get_header(csp->client_iob);
1419 } while ((NULL != request_line) && ('\0' == *request_line));
1421 return request_line;
1427 CHUNK_STATUS_MISSING_DATA,
1428 CHUNK_STATUS_BODY_COMPLETE,
1429 CHUNK_STATUS_PARSE_ERROR
1433 /*********************************************************************
1435 * Function : chunked_body_is_complete
1437 * Description : Figures out whether or not a chunked body is complete.
1439 * Currently it always starts at the beginning of the
1440 * buffer which is somewhat wasteful and prevents Privoxy
1441 * from starting to forward the correctly parsed chunks
1442 * as soon as theoretically possible.
1444 * Should be modified to work with a common buffer,
1445 * and allow the caller to skip already parsed chunks.
1447 * This would allow the function to be used for unbuffered
1448 * response bodies as well.
1451 * 1 : iob = Buffer with the body to check.
1452 * 2 : length = Length of complete body
1454 * Returns : Enum with the result of the check.
1456 *********************************************************************/
1457 static enum chunk_status chunked_body_is_complete(struct iob *iob, size_t *length)
1459 unsigned int chunksize;
1465 * We need at least a single digit, followed by "\r\n",
1466 * followed by an unknown amount of data, followed by "\r\n".
1468 if (p + 5 > iob->eod)
1470 return CHUNK_STATUS_MISSING_DATA;
1472 if (sscanf(p, "%x", &chunksize) != 1)
1474 return CHUNK_STATUS_PARSE_ERROR;
1478 * We want at least a single digit, followed by "\r\n",
1479 * followed by the specified amount of data, followed by "\r\n".
1481 if (p + chunksize + 5 > iob->eod)
1483 return CHUNK_STATUS_MISSING_DATA;
1486 /* Skip chunk-size. */
1487 p = strstr(p, "\r\n");
1490 return CHUNK_STATUS_PARSE_ERROR;
1492 /* Move beyond the chunkdata. */
1495 /* There should be another "\r\n" to skip */
1496 if (memcmp(p, "\r\n", 2))
1498 return CHUNK_STATUS_PARSE_ERROR;
1501 } while (chunksize > 0U);
1503 *length = (size_t)(p - iob->cur);
1504 assert(*length <= (size_t)(iob->eod - iob->cur));
1505 assert(p <= iob->eod);
1507 return CHUNK_STATUS_BODY_COMPLETE;
1512 /*********************************************************************
1514 * Function : receive_chunked_client_request_body
1516 * Description : Read the chunk-encoded client request body.
1517 * Failures are dealt with.
1520 * 1 : csp = Current client state (buffers, headers, etc...)
1522 * Returns : JB_ERR_OK or JB_ERR_PARSE
1524 *********************************************************************/
1525 static jb_err receive_chunked_client_request_body(struct client_state *csp)
1528 enum chunk_status status;
1530 while (CHUNK_STATUS_MISSING_DATA ==
1531 (status = chunked_body_is_complete(csp->client_iob, &body_length)))
1533 char buf[BUFFER_SIZE];
1536 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1538 log_error(LOG_LEVEL_ERROR,
1539 "Timeout while waiting for the client body.");
1542 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1545 log_error(LOG_LEVEL_ERROR, "Read the client body failed: %E");
1548 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1553 if (status != CHUNK_STATUS_BODY_COMPLETE)
1555 write_socket_delayed(csp->cfd, CLIENT_BODY_PARSE_ERROR_RESPONSE,
1556 strlen(CLIENT_BODY_PARSE_ERROR_RESPONSE), get_write_delay(csp));
1557 log_error(LOG_LEVEL_CLF,
1558 "%s - - [%T] \"Failed reading chunked client body\" 400 0", csp->ip_addr_str);
1559 return JB_ERR_PARSE;
1561 log_error(LOG_LEVEL_CONNECT,
1562 "Chunked client body completely read. Length: %d", body_length);
1563 csp->expected_client_content_length = body_length;
1571 /*********************************************************************
1573 * Function : fuzz_chunked_transfer_encoding
1575 * Description : Treat the fuzzed input as chunked transfer encoding
1576 * to check and dechunk.
1579 * 1 : csp = Used to store the data.
1580 * 2 : fuzz_input_file = File to read the input from.
1582 * Returns : Result of dechunking
1584 *********************************************************************/
1585 extern int fuzz_chunked_transfer_encoding(struct client_state *csp, char *fuzz_input_file)
1588 size_t size = (size_t)(csp->iob->eod - csp->iob->cur);
1589 enum chunk_status status;
1591 status = chunked_body_is_complete(csp->iob, &length);
1592 if (CHUNK_STATUS_BODY_COMPLETE != status)
1594 log_error(LOG_LEVEL_INFO, "Chunked body is incomplete or invalid");
1597 return (JB_ERR_OK == remove_chunked_transfer_coding(csp->iob->cur, &size));
1602 /*********************************************************************
1604 * Function : fuzz_client_request
1606 * Description : Try to get a client request from the fuzzed input.
1609 * 1 : csp = Current client state (buffers, headers, etc...)
1610 * 2 : fuzz_input_file = File to read the input from.
1612 * Returns : Result of fuzzing.
1614 *********************************************************************/
1615 extern int fuzz_client_request(struct client_state *csp, char *fuzz_input_file)
1620 csp->ip_addr_str = "fuzzer";
1622 if (strcmp(fuzz_input_file, "-") != 0)
1624 log_error(LOG_LEVEL_FATAL,
1625 "Fuzzed client requests can currently only be read from stdin (-).");
1627 err = receive_client_request(csp);
1628 if (err != JB_ERR_OK)
1632 err = parse_client_request(csp);
1633 if (err != JB_ERR_OK)
1641 #endif /* def FUZZ */
1644 #ifdef FEATURE_FORCE_LOAD
1645 /*********************************************************************
1647 * Function : force_required
1649 * Description : Checks a request line to see if it contains
1650 * the FORCE_PREFIX. If it does, it is removed
1651 * unless enforcing requests has beend disabled.
1654 * 1 : request_line = HTTP request line
1656 * Returns : TRUE if force is required, FALSE otherwise.
1658 *********************************************************************/
1659 static int force_required(const struct client_state *csp, char *request_line)
1663 p = strstr(request_line, "http://");
1667 p += strlen("http://");
1671 /* Intercepted request usually don't specify the protocol. */
1675 /* Go to the beginning of the path */
1680 * If the path is missing the request line is invalid and we
1681 * are done here. The client-visible rejection happens later on.
1686 if (0 == strncmpic(p, FORCE_PREFIX, strlen(FORCE_PREFIX) - 1))
1688 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS))
1690 /* XXX: Should clean more carefully */
1691 strclean(request_line, FORCE_PREFIX);
1692 log_error(LOG_LEVEL_FORCE,
1693 "Enforcing request: \"%s\".", request_line);
1697 log_error(LOG_LEVEL_FORCE,
1698 "Ignored force prefix in request: \"%s\".", request_line);
1704 #endif /* def FEATURE_FORCE_LOAD */
1707 /*********************************************************************
1709 * Function : receive_client_request
1711 * Description : Read the client's request (more precisely the
1712 * client headers) and answer it if necessary.
1715 * 1 : csp = Current client state (buffers, headers, etc...)
1717 * Returns : JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
1719 *********************************************************************/
1720 static jb_err receive_client_request(struct client_state *csp)
1722 char buf[BUFFER_SIZE];
1725 struct http_request *http;
1729 /* Temporary copy of the client's headers before they get enlisted in csp->headers */
1730 struct list header_list;
1731 struct list *headers = &header_list;
1733 /* We don't care if the arriving data is a valid HTTP request or not. */
1734 csp->requests_received_total++;
1738 memset(buf, 0, sizeof(buf));
1740 req = get_request_line(csp);
1743 mark_server_socket_tainted(csp);
1744 return JB_ERR_PARSE;
1746 assert(*req != '\0');
1748 if (client_protocol_is_unsupported(csp, req))
1750 return JB_ERR_PARSE;
1753 #ifdef FEATURE_FORCE_LOAD
1754 if (force_required(csp, req))
1756 csp->flags |= CSP_FLAG_FORCED;
1758 #endif /* def FEATURE_FORCE_LOAD */
1760 err = parse_http_request(req, http);
1762 if (JB_ERR_OK != err)
1764 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER),
1765 get_write_delay(csp));
1766 /* XXX: Use correct size */
1767 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1768 log_error(LOG_LEVEL_ERROR,
1769 "Couldn't parse request line received from %s: %s",
1770 csp->ip_addr_str, jb_err_to_string(err));
1772 free_http_request(http);
1773 return JB_ERR_PARSE;
1776 /* grab the rest of the client's headers */
1780 p = get_header(csp->client_iob);
1784 /* There are no additional headers to read. */
1791 * We didn't receive a complete header
1792 * line yet, get the rest of it.
1794 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1796 log_error(LOG_LEVEL_ERROR,
1797 "Stopped grabbing the client headers.");
1798 destroy_list(headers);
1799 return JB_ERR_PARSE;
1802 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1805 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1806 destroy_list(headers);
1807 return JB_ERR_PARSE;
1810 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1813 * If there is no memory left for buffering the
1814 * request, there is nothing we can do but hang up
1816 destroy_list(headers);
1817 return JB_ERR_MEMORY;
1822 if (!strncmpic(p, "Transfer-Encoding:", 18))
1825 * XXX: should be called through sed()
1826 * but currently can't.
1828 client_transfer_encoding(csp, &p);
1831 * We were able to read a complete
1832 * header and can finally enlist it.
1839 if (http->host == NULL)
1842 * If we still don't know the request destination,
1843 * the request is invalid or the client uses
1844 * Privoxy without its knowledge.
1846 if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
1849 * Our attempts to get the request destination
1850 * elsewhere failed or Privoxy is configured
1851 * to only accept proxy requests.
1853 * An error response has already been send
1854 * and we're done here.
1856 return JB_ERR_PARSE;
1860 #ifdef FEATURE_CLIENT_TAGS
1861 /* XXX: If the headers were enlisted sooner, passing csp would do. */
1862 set_client_address(csp, headers);
1863 get_tag_list_for_client(csp->client_tags, csp->client_address);
1867 * Determine the actions for this URL
1869 #ifdef FEATURE_TOGGLE
1870 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
1872 /* Most compatible set of actions (i.e. none) */
1873 init_current_action(csp->action);
1876 #endif /* ndef FEATURE_TOGGLE */
1878 get_url_actions(csp, http);
1881 enlist(csp->headers, http->cmd);
1883 /* Append the previously read headers */
1884 err = list_append_list_unique(csp->headers, headers);
1885 destroy_list(headers);
1892 /*********************************************************************
1894 * Function : parse_client_request
1896 * Description : Parses the client's request and decides what to do
1899 * Note that since we're not using select() we could get
1900 * blocked here if a client connected, then didn't say
1904 * 1 : csp = Current client state (buffers, headers, etc...)
1906 * Returns : JB_ERR_OK or JB_ERR_PARSE
1908 *********************************************************************/
1909 static jb_err parse_client_request(struct client_state *csp)
1911 struct http_request *http = csp->http;
1914 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1915 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
1916 && (!strcmpic(csp->http->version, "HTTP/1.1"))
1917 && (csp->http->ssl == 0))
1919 /* Assume persistence until further notice */
1920 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1923 if (csp->http->ssl == 0)
1926 * This whole block belongs to chat() but currently
1927 * has to be executed before sed().
1929 if (csp->flags & CSP_FLAG_CHUNKED_CLIENT_BODY)
1931 if (receive_chunked_client_request_body(csp) != JB_ERR_OK)
1933 return JB_ERR_PARSE;
1938 csp->expected_client_content_length = get_expected_content_length(csp->headers);
1940 verify_request_length(csp);
1944 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1946 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1948 err = sed(csp, FILTER_CLIENT_HEADERS);
1949 if (JB_ERR_OK != err)
1951 log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
1953 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
1954 csp->ip_addr_str, csp->http->cmd);
1955 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER), get_write_delay(csp));
1956 return JB_ERR_PARSE;
1958 csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
1960 /* Check request line for rewrites. */
1961 if ((NULL == csp->headers->first->str)
1962 || (strcmp(http->cmd, csp->headers->first->str) &&
1963 (JB_ERR_OK != change_request_destination(csp))))
1966 * A header filter broke the request line - bail out.
1968 write_socket_delayed(csp->cfd, MESSED_UP_REQUEST_RESPONSE,
1969 strlen(MESSED_UP_REQUEST_RESPONSE), get_write_delay(csp));
1970 /* XXX: Use correct size */
1971 log_error(LOG_LEVEL_CLF,
1972 "%s - - [%T] \"Invalid request generated\" 500 0", csp->ip_addr_str);
1973 log_error(LOG_LEVEL_ERROR,
1974 "Invalid request line after applying header filters.");
1975 free_http_request(http);
1977 return JB_ERR_PARSE;
1980 if (client_has_unsupported_expectations(csp))
1982 return JB_ERR_PARSE;
1990 /*********************************************************************
1992 * Function : send_http_request
1994 * Description : Sends the HTTP headers from the client request
1995 * and all the body data that has already been received.
1998 * 1 : csp = Current client state (buffers, headers, etc...)
2000 * Returns : 0 on success, anything else is an error.
2002 *********************************************************************/
2003 static int send_http_request(struct client_state *csp)
2008 hdr = list_to_text(csp->headers);
2011 /* FIXME Should handle error properly */
2012 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
2014 list_remove_all(csp->headers);
2017 * Write the client's (modified) header to the server
2018 * (along with anything else that may be in the buffer)
2020 write_failure = 0 != write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
2025 log_error(LOG_LEVEL_CONNECT, "Failed sending request headers to: %s: %E",
2026 csp->http->hostport);
2028 else if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
2029 && (flush_iob(csp->server_connection.sfd, csp->client_iob, 0) < 0))
2032 log_error(LOG_LEVEL_CONNECT, "Failed sending request body to: %s: %E",
2033 csp->http->hostport);
2036 return write_failure;
2041 #ifdef FEATURE_HTTPS_INSPECTION
2042 /*********************************************************************
2044 * Function : receive_and_send_encrypted_post_data
2046 * Description : Reads remaining POST data from the client and sends
2050 * 1 : csp = Current client state (buffers, headers, etc...)
2052 * Returns : 0 on success, anything else is an error.
2054 *********************************************************************/
2055 static int receive_and_send_encrypted_post_data(struct client_state *csp)
2057 int content_length_known = csp->expected_client_content_length != 0;
2059 while (is_ssl_pending(&(csp->mbedtls_client_attr.ssl))
2060 || (content_length_known && csp->expected_client_content_length != 0))
2062 unsigned char buf[BUFFER_SIZE];
2064 int max_bytes_to_read = sizeof(buf);
2066 if (content_length_known && csp->expected_client_content_length < sizeof(buf))
2068 max_bytes_to_read = (int)csp->expected_client_content_length;
2070 log_error(LOG_LEVEL_CONNECT,
2071 "Waiting for up to %d bytes of POST data from the client.",
2073 len = ssl_recv_data(&(csp->mbedtls_client_attr.ssl), buf,
2074 (unsigned)max_bytes_to_read);
2081 /* XXX: Does this actually happen? */
2084 log_error(LOG_LEVEL_CONNECT, "Forwarding %d bytes of encrypted POST data",
2086 len = ssl_send_data(&(csp->mbedtls_server_attr.ssl), buf, (size_t)len);
2091 if (csp->expected_client_content_length != 0)
2093 if (csp->expected_client_content_length >= len)
2095 csp->expected_client_content_length -= (unsigned)len;
2097 if (csp->expected_client_content_length == 0)
2099 log_error(LOG_LEVEL_CONNECT, "Forwarded the last %d bytes", len);
2105 log_error(LOG_LEVEL_CONNECT, "Done forwarding encrypted POST data");
2112 /*********************************************************************
2114 * Function : send_https_request
2116 * Description : Sends the HTTP headers from the client request
2117 * and all the body data that has already been received.
2120 * 1 : csp = Current client state (buffers, headers, etc...)
2122 * Returns : 0 on success, anything else is an error.
2124 *********************************************************************/
2125 static int send_https_request(struct client_state *csp)
2131 hdr = list_to_text(csp->https_headers);
2134 /* FIXME Should handle error properly */
2135 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
2137 list_remove_all(csp->https_headers);
2140 * Write the client's (modified) header to the server
2141 * (along with anything else that may be in the buffer)
2143 ret = ssl_send_data(&(csp->mbedtls_server_attr.ssl),
2144 (const unsigned char *)hdr, strlen(hdr));
2149 log_error(LOG_LEVEL_CONNECT,
2150 "Failed sending encrypted request headers to: %s: %E",
2151 csp->http->hostport);
2152 mark_server_socket_tainted(csp);
2156 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
2157 && ((flushed = ssl_flush_socket(&(csp->mbedtls_server_attr.ssl),
2158 csp->client_iob)) < 0))
2160 log_error(LOG_LEVEL_CONNECT, "Failed sending request body to: %s: %E",
2161 csp->http->hostport);
2166 if (csp->expected_client_content_length != 0)
2168 if (csp->expected_client_content_length < flushed)
2170 log_error(LOG_LEVEL_ERROR,
2171 "Flushed %d bytes of request body while only expecting %llu",
2172 flushed, csp->expected_client_content_length);
2173 csp->expected_client_content_length = 0;
2177 log_error(LOG_LEVEL_CONNECT,
2178 "Flushed %d bytes of request body while expecting %llu",
2179 flushed, csp->expected_client_content_length);
2180 csp->expected_client_content_length -= (unsigned)flushed;
2181 if (receive_and_send_encrypted_post_data(csp))
2189 log_error(LOG_LEVEL_CONNECT,
2190 "Flushed %d bytes of request body", flushed);
2194 log_error(LOG_LEVEL_CONNECT, "Encrypted request sent");
2201 /*********************************************************************
2203 * Function : receive_encrypted_request
2205 * Description : Receives an encrypted request.
2208 * 1 : csp = Current client state (buffers, headers, etc...)
2210 * Returns : JB_ERR_OK on success,
2211 * JB_ERR_PARSE or JB_ERR_MEMORY otherwise
2213 *********************************************************************/
2214 static jb_err receive_encrypted_request(struct client_state *csp)
2216 char buf[BUFFER_SIZE];
2222 log_error(LOG_LEVEL_HEADER, "Reading encrypted headers");
2223 if (!data_is_available(csp->cfd, (int)csp->config->keep_alive_timeout))
2225 log_error(LOG_LEVEL_CONNECT,
2226 "Socket %d timed out while waiting for client headers", csp->cfd);
2227 return JB_ERR_PARSE;
2229 len = ssl_recv_data(&(csp->mbedtls_client_attr.ssl),
2230 (unsigned char *)buf, sizeof(buf));
2233 return JB_ERR_PARSE;
2235 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
2237 return JB_ERR_MEMORY;
2239 p = strstr(csp->client_iob->cur, "\r\n\r\n");
2240 } while (p == NULL);
2242 log_error(LOG_LEVEL_HEADER, "Encrypted headers received completely");
2248 /*********************************************************************
2250 * Function : process_encrypted_request
2252 * Description : Receives and parses an encrypted request.
2255 * 1 : csp = Current client state (buffers, headers, etc...)
2257 * Returns : JB_ERR_OK on success,
2258 * JB_ERR_PARSE or JB_ERR_MEMORY otherwise
2260 *********************************************************************/
2261 static jb_err process_encrypted_request(struct client_state *csp)
2266 /* Temporary copy of the client's headers before they get enlisted in csp->https_headers */
2267 struct list header_list;
2268 struct list *headers = &header_list;
2270 err = receive_encrypted_request(csp);
2271 if (err != JB_ERR_OK)
2273 /* XXX: Also used for JB_ERR_MEMORY */
2274 log_error(LOG_LEVEL_ERROR, "Failed to receive encrypted request: %s",
2275 jb_err_to_string(err));
2276 ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
2277 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2281 /* We don't need get_request_line() because the whole HTTP head is buffered. */
2282 request_line = get_header(csp->client_iob);
2283 if (request_line == NULL)
2285 log_error(LOG_LEVEL_ERROR, "Failed to get the encrypted request line");
2286 ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
2287 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2288 return JB_ERR_PARSE;
2290 assert(*request_line != '\0');
2292 if (client_protocol_is_unsupported(csp, request_line))
2295 * If the protocol is unsupported we're done here.
2296 * client_protocol_is_unsupported() took care of sending
2297 * the error response and logging the error message.
2299 return JB_ERR_PARSE;
2302 #ifdef FEATURE_FORCE_LOAD
2303 if (force_required(csp, request_line))
2305 csp->flags |= CSP_FLAG_FORCED;
2307 #endif /* def FEATURE_FORCE_LOAD */
2309 free_http_request(csp->http);
2311 err = parse_http_request(request_line, csp->http);
2312 /* XXX: Restore ssl setting. This is ugly */
2313 csp->http->client_ssl = 1;
2314 csp->http->server_ssl = 1;
2316 freez(request_line);
2317 if (JB_ERR_OK != err)
2319 ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
2320 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2321 /* XXX: Use correct size */
2322 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
2323 log_error(LOG_LEVEL_ERROR,
2324 "Couldn't parse request line received from %s: %s",
2325 csp->ip_addr_str, jb_err_to_string(err));
2327 free_http_request(csp->http);
2328 return JB_ERR_PARSE;
2331 /* Parse the rest of the client's headers. */
2335 p = get_header(csp->client_iob);
2339 /* There are no additional headers to read. */
2346 if (JB_ERR_OK != get_destination_from_https_headers(headers, csp->http))
2349 * Our attempts to get the request destination
2352 log_error(LOG_LEVEL_ERROR,
2353 "Failed to get the encrypted request destination");
2354 ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
2355 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2356 return JB_ERR_PARSE;
2359 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
2360 /* Split the domain we just got for pattern matching */
2361 init_domain_components(csp->http);
2364 #ifdef FEATURE_TOGGLE
2365 if ((csp->flags & CSP_FLAG_TOGGLED_ON) != 0)
2368 /* Determine the actions for this URL */
2369 get_url_actions(csp, csp->http);
2372 enlist(csp->https_headers, csp->http->cmd);
2374 /* Append the previously read headers */
2375 err = list_append_list_unique(csp->https_headers, headers);
2376 destroy_list(headers);
2377 if (JB_ERR_OK != err)
2379 /* XXX: Send error message */
2383 /* XXX: Work around crash */
2384 csp->error_message = NULL;
2386 /* XXX: Why do this here? */
2389 err = sed_https(csp);
2390 if (JB_ERR_OK != err)
2392 ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
2393 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2394 log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
2396 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
2397 csp->ip_addr_str, csp->http->cmd);
2398 return JB_ERR_PARSE;
2401 log_error(LOG_LEVEL_HEADER, "Encrypted request processed");
2402 log_applied_actions(csp->action);
2403 log_error(LOG_LEVEL_REQUEST, "https://%s%s", csp->http->hostport,
2410 /*********************************************************************
2412 * Function : cgi_page_requested
2414 * Description : Checks if a request is for an internal CGI page.
2417 * 1 : host = The host requested by the client.
2419 * Returns : 1 if a CGI page has been requested, 0 otherwise
2421 *********************************************************************/
2422 static int cgi_page_requested(const char *host)
2424 if ((0 == strcmpic(host, CGI_SITE_1_HOST))
2425 || (0 == strcmpic(host, CGI_SITE_1_HOST "."))
2426 || (0 == strcmpic(host, CGI_SITE_2_HOST))
2427 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")))
2439 /*********************************************************************
2441 * Function : handle_established_connection
2443 * Description : Shuffle data between client and server once the
2444 * connection has been established.
2447 * 1 : csp = Current client state (buffers, headers, etc...)
2449 * Returns : Nothing.
2451 *********************************************************************/
2452 static void handle_established_connection(struct client_state *csp)
2458 struct pollfd poll_fds[2];
2462 struct timeval timeout;
2465 int ms_iis5_hack = 0;
2466 unsigned long long byte_count = 0;
2467 struct http_request *http;
2468 long len = 0; /* for buffer sizes (and negative error codes) */
2469 int buffer_and_filter_content = 0;
2470 unsigned int write_delay;
2471 #ifdef FEATURE_HTTPS_INSPECTION
2473 int use_ssl_tunnel = 0;
2474 csp->dont_verify_certificate = 0;
2476 if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION))
2478 /* Pass encrypted content without filtering. */
2483 /* Skeleton for HTTP response, if we should intercept the request */
2484 struct http_response *rsp;
2485 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2486 int watch_client_socket;
2489 csp->receive_buffer_size = csp->config->receive_buffer_size;
2490 csp->receive_buffer = zalloc(csp->receive_buffer_size + 1);
2491 if (csp->receive_buffer == NULL)
2493 log_error(LOG_LEVEL_ERROR,
2494 "Out of memory. Failed to allocate the receive buffer.");
2495 rsp = cgi_error_memory();
2496 send_crunch_response(csp, rsp);
2503 maxfd = (csp->cfd > csp->server_connection.sfd) ?
2504 csp->cfd : csp->server_connection.sfd;
2507 /* pass data between the client and server
2508 * until one or the other shuts down the connection.
2513 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2514 watch_client_socket = 0 == (csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING);
2516 write_delay = get_write_delay(csp);
2523 * FD_ZERO here seems to point to an errant macro which crashes.
2524 * So do this by hand for now...
2526 memset(&rfds,0x00,sizeof(fd_set));
2530 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2531 if (!watch_client_socket)
2533 maxfd = csp->server_connection.sfd;
2536 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2538 FD_SET(csp->cfd, &rfds);
2541 FD_SET(csp->server_connection.sfd, &rfds);
2542 #endif /* ndef HAVE_POLL */
2544 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2545 if ((csp->flags & CSP_FLAG_CHUNKED)
2546 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2547 && ((csp->iob->eod - csp->iob->cur) >= 5)
2548 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
2551 * XXX: This check should be obsolete now,
2552 * but let's wait a while to be sure.
2554 log_error(LOG_LEVEL_CONNECT,
2555 "Looks like we got the last chunk together with "
2556 "the server headers but didn't detect it earlier. "
2557 "We better stop reading.");
2558 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
2559 csp->expected_content_length = byte_count;
2560 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2562 if (server_body && server_response_is_complete(csp, byte_count))
2564 if (csp->expected_content_length == byte_count)
2566 log_error(LOG_LEVEL_CONNECT,
2567 "Done reading from server. Content length: %llu as expected. "
2568 "Bytes most recently read: %d.",
2573 log_error(LOG_LEVEL_CONNECT,
2574 "Done reading from server. Expected content length: %llu. "
2575 "Actual content length: %llu. Bytes most recently read: %d.",
2576 csp->expected_content_length, byte_count, len);
2580 * XXX: Should not jump around, handle_established_connection()
2581 * is complicated enough already.
2585 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2588 poll_fds[0].fd = csp->cfd;
2589 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2590 if (!watch_client_socket)
2593 * Ignore incoming data, but still watch out
2594 * for disconnects etc. These flags are always
2595 * implied anyway but explicitly setting them
2598 poll_fds[0].events = POLLERR|POLLHUP;
2603 poll_fds[0].events = POLLIN;
2605 poll_fds[1].fd = csp->server_connection.sfd;
2606 poll_fds[1].events = POLLIN;
2607 n = poll(poll_fds, 2, csp->config->socket_timeout * 1000);
2609 timeout.tv_sec = csp->config->socket_timeout;
2610 timeout.tv_usec = 0;
2611 n = select((int)maxfd + 1, &rfds, NULL, NULL, &timeout);
2612 #endif /* def HAVE_POLL */
2614 /*server or client not responding in timeout */
2617 log_error(LOG_LEVEL_CONNECT, "Socket timeout %d reached: %s",
2618 csp->config->socket_timeout, http->url);
2619 if ((byte_count == 0) && (http->ssl == 0))
2621 send_crunch_response(csp, error_response(csp, "connection-timeout"));
2623 mark_server_socket_tainted(csp);
2624 #ifdef FEATURE_HTTPS_INSPECTION
2625 close_client_and_server_ssl_connections(csp);
2632 log_error(LOG_LEVEL_ERROR, "poll() failed!: %E");
2634 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
2636 mark_server_socket_tainted(csp);
2637 #ifdef FEATURE_HTTPS_INSPECTION
2638 close_client_and_server_ssl_connections(csp);
2644 * This is the body of the browser's request,
2645 * just read and write it.
2647 * Receives data from browser and sends it to server
2649 * XXX: Make sure the client doesn't use pipelining
2650 * behind Privoxy's back.
2653 if ((poll_fds[0].revents & (POLLERR|POLLHUP|POLLNVAL)) != 0)
2655 log_error(LOG_LEVEL_CONNECT,
2656 "The client socket %d has become unusable while "
2657 "the server socket %d is still open.",
2658 csp->cfd, csp->server_connection.sfd);
2659 mark_server_socket_tainted(csp);
2663 if (poll_fds[0].revents != 0)
2665 if (FD_ISSET(csp->cfd, &rfds))
2666 #endif /* def HAVE_POLL*/
2668 int max_bytes_to_read = (int)csp->receive_buffer_size;
2670 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2671 if ((csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ))
2673 if (data_is_available(csp->cfd, 0))
2676 * If the next request is already waiting, we have
2677 * to stop select()ing the client socket. Otherwise
2678 * we would always return right away and get nothing
2681 watch_client_socket = 0;
2682 log_error(LOG_LEVEL_CONNECT,
2683 "Stop watching client socket %d. "
2684 "There's already another request waiting.",
2689 * If the client socket is set, but there's no data
2690 * available on the socket, the client went fishing
2691 * and continuing talking to the server makes no sense.
2693 log_error(LOG_LEVEL_CONNECT,
2694 "The client closed socket %d while "
2695 "the server socket %d is still open.",
2696 csp->cfd, csp->server_connection.sfd);
2697 mark_server_socket_tainted(csp);
2700 if (csp->expected_client_content_length != 0)
2702 if (csp->expected_client_content_length < csp->receive_buffer_size)
2704 max_bytes_to_read = (int)csp->expected_client_content_length;
2706 log_error(LOG_LEVEL_CONNECT,
2707 "Waiting for up to %d bytes from the client.",
2710 assert(max_bytes_to_read <= csp->receive_buffer_size);
2711 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2713 #ifdef FEATURE_HTTPS_INSPECTION
2714 if (client_use_ssl(csp))
2716 log_error(LOG_LEVEL_CONNECT, "Breaking with TLS/SSL.");
2720 #endif /* def FEATURE_HTTPS_INSPECTION */
2722 len = read_socket(csp->cfd, csp->receive_buffer, max_bytes_to_read);
2726 /* XXX: not sure if this is necessary. */
2727 mark_server_socket_tainted(csp);
2728 break; /* "game over, man" */
2731 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2732 if (csp->expected_client_content_length != 0)
2734 assert(len <= max_bytes_to_read);
2735 csp->expected_client_content_length -= (unsigned)len;
2736 log_error(LOG_LEVEL_CONNECT,
2737 "Expected client content length set to %llu "
2738 "after reading %d bytes.",
2739 csp->expected_client_content_length, len);
2740 if (csp->expected_client_content_length == 0)
2742 log_error(LOG_LEVEL_CONNECT,
2743 "Done reading from the client.");
2744 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
2747 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2749 if (write_socket(csp->server_connection.sfd, csp->receive_buffer, (size_t)len))
2751 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
2752 mark_server_socket_tainted(csp);
2760 * The server wants to talk. It could be the header or the body.
2761 * If `hdr' is null, then it's the header otherwise it's the body.
2762 * FIXME: Does `hdr' really mean `host'? No.
2765 if (poll_fds[1].revents != 0)
2767 if (FD_ISSET(csp->server_connection.sfd, &rfds))
2768 #endif /* HAVE_POLL */
2770 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2772 * If we are buffering content, we don't want to eat up to
2773 * buffer-limit bytes if the client no longer cares about them.
2774 * If we aren't buffering, however, a dead client socket will be
2775 * noticed pretty much right away anyway, so we can reduce the
2776 * overhead by skipping the check.
2778 if (buffer_and_filter_content && !socket_is_still_alive(csp->cfd))
2781 log_error(LOG_LEVEL_CONNECT,
2782 "The server still wants to talk, but the client may already have hung up on us.");
2784 log_error(LOG_LEVEL_CONNECT,
2785 "The server still wants to talk, but the client hung up on us.");
2786 mark_server_socket_tainted(csp);
2787 #ifdef FEATURE_HTTPS_INSPECTION
2788 close_client_and_server_ssl_connections(csp);
2791 #endif /* def _WIN32 */
2793 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2795 #ifdef FEATURE_HTTPS_INSPECTION
2797 * Reading data from standard or secured connection (HTTP/HTTPS)
2799 if (server_use_ssl(csp))
2801 len = ssl_recv_data(&(csp->mbedtls_server_attr.ssl),
2802 (unsigned char *)csp->receive_buffer, csp->receive_buffer_size);
2807 len = read_socket(csp->server_connection.sfd, csp->receive_buffer,
2808 (int)csp->receive_buffer_size);
2813 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
2815 if ((http->ssl && (csp->fwd == NULL))
2816 #ifdef FEATURE_HTTPS_INSPECTION
2822 * Just hang up. We already confirmed the client's CONNECT
2823 * request with status code 200 and unencrypted content is
2824 * no longer welcome.
2826 log_error(LOG_LEVEL_ERROR,
2827 "CONNECT already confirmed. Unable to tell the client about the problem.");
2830 else if (byte_count)
2833 * Just hang up. We already transmitted the original headers
2834 * and parts of the original content and therefore missed the
2835 * chance to send an error message (without risking data corruption).
2837 * XXX: we could retry with a fancy range request here.
2839 log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
2840 "Unable to tell the client about the problem.");
2841 mark_server_socket_tainted(csp);
2842 #ifdef FEATURE_HTTPS_INSPECTION
2843 close_client_and_server_ssl_connections(csp);
2848 * XXX: Consider handling the cases above the same.
2850 mark_server_socket_tainted(csp);
2854 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2855 if (csp->flags & CSP_FLAG_CHUNKED)
2857 if ((len >= 5) && !memcmp(csp->receive_buffer+len-5, "0\r\n\r\n", 5))
2859 /* XXX: this is a temporary hack */
2860 log_error(LOG_LEVEL_CONNECT,
2861 "Looks like we reached the end of the last chunk. "
2862 "We better stop reading.");
2863 csp->expected_content_length = byte_count + (unsigned long long)len;
2864 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2868 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
2871 * This is guaranteed by allocating with zalloc_or_die()
2872 * and never (intentionally) writing to the last byte.
2874 * csp->receive_buffer_size is the size of the part of the
2875 * buffer we intentionally write to, but we actually
2876 * allocated csp->receive_buffer_size+1 bytes so the assertion
2877 * stays within the allocated range.
2879 assert(csp->receive_buffer[csp->receive_buffer_size] == '\0');
2882 * Add a trailing zero to let be able to use string operations.
2883 * XXX: do we still need this with filter_popups gone?
2885 assert(len <= csp->receive_buffer_size);
2886 csp->receive_buffer[len] = '\0';
2889 * Normally, this would indicate that we've read
2890 * as much as the server has sent us and we can
2891 * close the client connection. However, Microsoft
2892 * in its wisdom has released IIS/5 with a bug that
2893 * prevents it from sending the trailing \r\n in
2894 * a 302 redirect header (and possibly other headers).
2895 * To work around this if we've haven't parsed
2896 * a full header we'll append a trailing \r\n
2897 * and see if this now generates a valid one.
2899 * This hack shouldn't have any impacts. If we've
2900 * already transmitted the header or if this is a
2901 * SSL connection, then we won't bother with this
2902 * hack. So we only work on partially received
2903 * headers. If we append a \r\n and this still
2904 * doesn't generate a valid header, then we won't
2905 * transmit anything to the client.
2910 if (server_body || (http->ssl
2911 #ifdef FEATURE_HTTPS_INSPECTION
2917 * If we have been buffering up the document,
2918 * now is the time to apply content modification
2919 * and send the result to the client.
2921 if (buffer_and_filter_content)
2923 p = execute_content_filters(csp);
2925 * If content filtering fails, use the original
2926 * buffer and length.
2927 * (see p != NULL ? p : csp->iob->cur below)
2931 csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
2933 #ifdef FEATURE_COMPRESSION
2934 else if ((csp->flags & CSP_FLAG_CLIENT_SUPPORTS_DEFLATE)
2935 && (csp->content_length > LOWER_LENGTH_LIMIT_FOR_COMPRESSION))
2937 char *compressed_content = compress_buffer(p,
2938 (size_t *)&csp->content_length, csp->config->compression_level);
2939 if (compressed_content != NULL)
2942 p = compressed_content;
2943 csp->flags |= CSP_FLAG_BUFFERED_CONTENT_DEFLATED;
2948 if (JB_ERR_OK != update_server_headers(csp))
2950 log_error(LOG_LEVEL_FATAL,
2951 "Failed to update server headers. after filtering.");
2954 hdr = list_to_text(csp->headers);
2957 /* FIXME Should handle error properly */
2958 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2961 #ifdef FEATURE_HTTPS_INSPECTION
2963 * Sending data with standard or secured connection (HTTP/HTTPS)
2965 if (client_use_ssl(csp))
2967 if ((ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
2968 (const unsigned char *)hdr, strlen(hdr),
2969 get_write_delay(csp)) < 0)
2970 || (ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
2971 (const unsigned char *) ((p != NULL) ? p : csp->iob->cur),
2972 csp->content_length, get_write_delay(csp)) < 0))
2974 log_error(LOG_LEVEL_ERROR, "write modified content to "
2975 "client over TLS/SSL failed");
2978 mark_server_socket_tainted(csp);
2979 close_client_and_server_ssl_connections(csp);
2984 #endif /* def FEATURE_HTTPS_INSPECTION */
2986 if (write_socket_delayed(csp->cfd, hdr, strlen(hdr), write_delay)
2987 || write_socket_delayed(csp->cfd, ((p != NULL) ? p : csp->iob->cur),
2988 (size_t)csp->content_length, write_delay))
2990 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
2993 mark_server_socket_tainted(csp);
3002 break; /* "game over, man" */
3006 * This is NOT the body, so
3007 * Let's pretend the server just sent us a blank line.
3009 snprintf(csp->receive_buffer, csp->receive_buffer_size, "\r\n");
3010 len = (int)strlen(csp->receive_buffer);
3013 * Now, let the normal header parsing algorithm below do its
3014 * job. If it fails, we'll exit instead of continuing.
3021 * If we're in the body of the server document, just write it to
3022 * the client, unless we need to buffer the body for later
3023 * content-filtering.
3025 if (server_body || (http->ssl
3026 #ifdef FEATURE_HTTPS_INSPECTION
3031 if (buffer_and_filter_content)
3034 * If there is no memory left for buffering the content, or the buffer limit
3035 * has been reached, switch to non-filtering mode, i.e. make & write the
3036 * header, flush the iob and buf, and get out of the way.
3038 if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3043 log_error(LOG_LEVEL_INFO,
3044 "Flushing header and buffers. Stepping back from filtering.");
3046 hdr = list_to_text(csp->headers);
3050 * Memory is too tight to even generate the header.
3051 * Send our static "Out-of-memory" page.
3053 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
3054 rsp = cgi_error_memory();
3055 send_crunch_response(csp, rsp);
3056 mark_server_socket_tainted(csp);
3057 #ifdef FEATURE_HTTPS_INSPECTION
3058 close_client_and_server_ssl_connections(csp);
3062 hdrlen = strlen(hdr);
3064 #ifdef FEATURE_HTTPS_INSPECTION
3066 * Sending data with standard or secured connection (HTTP/HTTPS)
3068 if (client_use_ssl(csp))
3070 if ((ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
3071 (const unsigned char *)hdr, hdrlen, get_write_delay(csp)) < 0)
3072 || ((flushed = ssl_flush_socket(&(csp->mbedtls_client_attr.ssl),
3074 || (ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
3075 (const unsigned char *)csp->receive_buffer, (size_t)len,
3076 get_write_delay(csp)) < 0))
3078 log_error(LOG_LEVEL_CONNECT,
3079 "Flush header and buffers to client failed");
3081 mark_server_socket_tainted(csp);
3082 close_client_and_server_ssl_connections(csp);
3087 #endif /* def FEATURE_HTTPS_INSPECTION */
3089 if (write_socket_delayed(csp->cfd, hdr, hdrlen, write_delay)
3090 || ((flushed = flush_iob(csp->cfd, csp->iob, write_delay)) < 0)
3091 || write_socket_delayed(csp->cfd, csp->receive_buffer, (size_t)len,
3094 log_error(LOG_LEVEL_CONNECT,
3095 "Flush header and buffers to client failed: %E");
3097 mark_server_socket_tainted(csp);
3103 * Reset the byte_count to the amount of bytes
3104 * we just flushed. len will be added a few lines below,
3105 * hdrlen doesn't matter for LOG_LEVEL_CLF.
3107 byte_count = (unsigned long long)flushed;
3109 buffer_and_filter_content = 0;
3115 #ifdef FEATURE_HTTPS_INSPECTION
3117 * Sending data with standard or secured connection (HTTP/HTTPS)
3119 if (client_use_ssl(csp))
3121 ret = ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
3122 (const unsigned char *)csp->receive_buffer, (size_t)len,
3123 get_write_delay(csp));
3126 log_error(LOG_LEVEL_ERROR,
3127 "Sending data to client failed");
3128 mark_server_socket_tainted(csp);
3129 close_client_and_server_ssl_connections(csp);
3134 #endif /* def FEATURE_HTTPS_INSPECTION */
3136 if (write_socket_delayed(csp->cfd, csp->receive_buffer,
3137 (size_t)len, write_delay))
3139 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
3140 mark_server_socket_tainted(csp);
3145 byte_count += (unsigned long long)len;
3151 * We're still looking for the end of the server's header.
3152 * Buffer up the data we just read. If that fails, there's
3153 * little we can do but send our static out-of-memory page.
3155 if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3157 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
3158 rsp = cgi_error_memory();
3159 send_crunch_response(csp, rsp);
3160 mark_server_socket_tainted(csp);
3161 #ifdef FEATURE_HTTPS_INSPECTION
3162 close_client_and_server_ssl_connections(csp);
3167 /* Convert iob into something sed() can digest */
3168 if (JB_ERR_PARSE == get_server_headers(csp))
3173 * Well, we tried our MS IIS/5 hack and it didn't work.
3174 * The header is incomplete and there isn't anything
3175 * we can do about it.
3177 log_error(LOG_LEVEL_ERROR, "Invalid server headers. "
3178 "Applying the MS IIS5 hack didn't help.");
3179 log_error(LOG_LEVEL_CLF,
3180 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3181 #ifdef FEATURE_HTTPS_INSPECTION
3183 * Sending data with standard or secured connection (HTTP/HTTPS)
3185 if (client_use_ssl(csp))
3187 ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
3188 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3189 strlen(INVALID_SERVER_HEADERS_RESPONSE), get_write_delay(csp));
3192 #endif /* def FEATURE_HTTPS_INSPECTION */
3194 write_socket_delayed(csp->cfd,
3195 INVALID_SERVER_HEADERS_RESPONSE,
3196 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3198 mark_server_socket_tainted(csp);
3199 #ifdef FEATURE_HTTPS_INSPECTION
3200 close_client_and_server_ssl_connections(csp);
3207 * Since we have to wait for more from the server before
3208 * we can parse the headers we just continue here.
3210 log_error(LOG_LEVEL_CONNECT,
3211 "Continuing buffering server headers from socket %d. "
3212 "Bytes most recently read: %d.", csp->cfd, len);
3219 * Account for the content bytes we
3220 * might have gotten with the headers.
3222 assert(csp->iob->eod >= csp->iob->cur);
3223 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3226 /* Did we actually get anything? */
3227 if (NULL == csp->headers->first)
3229 if ((csp->flags & CSP_FLAG_REUSED_CLIENT_CONNECTION))
3231 log_error(LOG_LEVEL_ERROR,
3232 "No server or forwarder response received on socket %d. "
3233 "Closing client socket %d without sending data.",
3234 csp->server_connection.sfd, csp->cfd);
3235 log_error(LOG_LEVEL_CLF,
3236 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3240 log_error(LOG_LEVEL_ERROR,
3241 "No server or forwarder response received on socket %d.",
3242 csp->server_connection.sfd);
3243 send_crunch_response(csp, error_response(csp, "no-server-data"));
3245 free_http_request(http);
3246 mark_server_socket_tainted(csp);
3247 #ifdef FEATURE_HTTPS_INSPECTION
3248 close_client_and_server_ssl_connections(csp);
3253 if (!csp->headers->first->str)
3255 log_error(LOG_LEVEL_ERROR, "header search: csp->headers->first->str == NULL, assert will be called");
3257 assert(csp->headers->first->str);
3259 if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
3260 strncmpic(csp->headers->first->str, "ICY", 3))
3263 * It doesn't look like a HTTP (or Shoutcast) response:
3264 * tell the client and log the problem.
3266 if (strlen(csp->headers->first->str) > 30)
3268 csp->headers->first->str[30] = '\0';
3270 log_error(LOG_LEVEL_ERROR,
3271 "Invalid server or forwarder response. Starts with: %s",
3272 csp->headers->first->str);
3273 log_error(LOG_LEVEL_CLF,
3274 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3275 #ifdef FEATURE_HTTPS_INSPECTION
3277 * Sending data with standard or secured connection (HTTP/HTTPS)
3279 if (client_use_ssl(csp))
3281 ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
3282 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3283 strlen(INVALID_SERVER_HEADERS_RESPONSE),
3284 get_write_delay(csp));
3287 #endif /* def FEATURE_HTTPS_INSPECTION */
3289 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3290 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3292 free_http_request(http);
3293 mark_server_socket_tainted(csp);
3294 #ifdef FEATURE_HTTPS_INSPECTION
3295 close_client_and_server_ssl_connections(csp);
3301 * We have now received the entire server header,
3302 * filter it and send the result to the client
3304 if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
3306 log_error(LOG_LEVEL_CLF,
3307 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3308 #ifdef FEATURE_HTTPS_INSPECTION
3310 * Sending data with standard or secured connection (HTTP/HTTPS)
3312 if (client_use_ssl(csp))
3314 ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
3315 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3316 strlen(INVALID_SERVER_HEADERS_RESPONSE),
3317 get_write_delay(csp));
3322 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3323 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3325 free_http_request(http);
3326 mark_server_socket_tainted(csp);
3327 #ifdef FEATURE_HTTPS_INSPECTION
3328 close_client_and_server_ssl_connections(csp);
3332 hdr = list_to_text(csp->headers);
3335 /* FIXME Should handle error properly */
3336 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
3339 if ((csp->flags & CSP_FLAG_CHUNKED)
3340 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3341 && ((csp->iob->eod - csp->iob->cur) >= 5)
3342 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
3344 log_error(LOG_LEVEL_CONNECT,
3345 "Looks like we got the last chunk together with "
3346 "the server headers. We better stop reading.");
3347 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3348 csp->expected_content_length = byte_count;
3349 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
3352 csp->server_connection.response_received = time(NULL);
3354 if (crunch_response_triggered(csp, crunchers_light))
3357 * One of the tags created by a server-header
3358 * tagger triggered a crunch. We already
3359 * delivered the crunch response to the client
3360 * and are done here after cleaning up.
3363 mark_server_socket_tainted(csp);
3364 #ifdef FEATURE_HTTPS_INSPECTION
3365 close_client_and_server_ssl_connections(csp);
3370 /* Buffer and pcrs filter this if appropriate. */
3371 buffer_and_filter_content = content_requires_filtering(csp);
3373 if (!buffer_and_filter_content)
3376 * Write the server's (modified) header to
3377 * the client (along with anything else that
3378 * may be in the buffer). Use standard or secured
3381 #ifdef FEATURE_HTTPS_INSPECTION
3382 if (client_use_ssl(csp))
3384 if ((ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
3385 (const unsigned char *)hdr, strlen(hdr),
3386 get_write_delay(csp)) < 0)
3387 || (len = ssl_flush_socket(&(csp->mbedtls_client_attr.ssl),
3390 log_error(LOG_LEVEL_CONNECT, "Write header to client failed");
3393 * The write failed, so don't bother mentioning it
3394 * to the client... it probably can't hear us anyway.
3397 mark_server_socket_tainted(csp);
3398 #ifdef FEATURE_HTTPS_INSPECTION
3399 close_client_and_server_ssl_connections(csp);
3405 #endif /* def FEATURE_HTTPS_INSPECTION */
3407 if (write_socket_delayed(csp->cfd, hdr, strlen(hdr), write_delay)
3408 || ((len = flush_iob(csp->cfd, csp->iob, write_delay)) < 0))
3410 log_error(LOG_LEVEL_ERROR,
3411 "write header to client failed");
3413 * The write failed, so don't bother mentioning it
3414 * to the client... it probably can't hear us anyway.
3417 mark_server_socket_tainted(csp);
3423 /* we're finished with the server's header */
3429 * If this was a MS IIS/5 hack then it means the server
3430 * has already closed the connection. Nothing more to read.
3435 log_error(LOG_LEVEL_ERROR,
3436 "Closed server connection detected. "
3437 "Applying the MS IIS5 hack didn't help.");
3438 log_error(LOG_LEVEL_CLF,
3439 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3440 #ifdef FEATURE_HTTPS_INSPECTION
3442 * Sending data with standard or secured connection (HTTP/HTTPS)
3444 if (client_use_ssl(csp))
3446 ssl_send_data_delayed(&(csp->mbedtls_client_attr.ssl),
3447 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3448 strlen(INVALID_SERVER_HEADERS_RESPONSE),
3449 get_write_delay(csp));
3452 #endif /* def FEATURE_HTTPS_INSPECTION */
3454 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3455 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3457 mark_server_socket_tainted(csp);
3458 #ifdef FEATURE_HTTPS_INSPECTION
3459 close_client_and_server_ssl_connections(csp);
3466 mark_server_socket_tainted(csp);
3467 #ifdef FEATURE_HTTPS_INSPECTION
3468 close_client_and_server_ssl_connections(csp);
3470 return; /* huh? we should never get here */
3472 #ifdef FEATURE_HTTPS_INSPECTION
3473 close_client_and_server_ssl_connections(csp);
3475 if (csp->content_length == 0)
3478 * If Privoxy didn't recalculate the Content-Length,
3479 * byte_count is still correct.
3481 csp->content_length = byte_count;
3484 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3485 if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3486 && (csp->expected_content_length != byte_count))
3488 log_error(LOG_LEVEL_CONNECT,
3489 "Received %llu bytes while expecting %llu.",
3490 byte_count, csp->expected_content_length);
3491 mark_server_socket_tainted(csp);
3495 #ifdef FEATURE_HTTPS_INSPECTION
3496 if (client_use_ssl(csp))
3498 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s https://%s%s %s\" 200 %llu",
3499 csp->ip_addr_str, http->gpc, http->hostport, http->path,
3500 http->version, csp->content_length);
3505 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %llu",
3506 csp->ip_addr_str, http->ocmd, csp->content_length);
3508 csp->server_connection.timestamp = time(NULL);
3512 /*********************************************************************
3516 * Description : Once a connection from the client has been accepted,
3517 * this function is called (via serve()) to handle the
3518 * main business of the communication. This function
3519 * returns after dealing with a single request. It can
3520 * be called multiple times with the same client socket
3521 * if the client is keeping the connection alive.
3523 * The decision whether or not a client connection will
3524 * be kept alive is up to the caller which also must
3525 * close the client socket when done.
3527 * FIXME: chat is nearly thousand lines long.
3531 * 1 : csp = Current client state (buffers, headers, etc...)
3533 * Returns : Nothing.
3535 *********************************************************************/
3536 static void chat(struct client_state *csp)
3538 const struct forward_spec *fwd;
3539 struct http_request *http;
3540 /* Skeleton for HTTP response, if we should intercept the request */
3541 struct http_response *rsp;
3542 #ifdef FEATURE_HTTPS_INSPECTION
3543 int use_ssl_tunnel = 0;
3548 if (receive_client_request(csp) != JB_ERR_OK)
3552 if (parse_client_request(csp) != JB_ERR_OK)
3556 #ifdef FEATURE_HTTPS_INSPECTION
3558 * Log the request unless we're https inspecting
3559 * in which case we don't have the path yet and
3560 * will log the request later.
3562 if (!client_use_ssl(csp))
3565 log_error(LOG_LEVEL_REQUEST, "%s%s", http->hostport, http->path);
3568 /* decide how to route the HTTP request */
3569 fwd = forward_url(csp, http);
3572 log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!? This can't happen!");
3573 /* Never get here - LOG_LEVEL_FATAL causes program exit */
3577 #ifdef FEATURE_HTTPS_INSPECTION
3579 * Setting flags to use old solution with SSL tunnel and to disable
3580 * certificates verification.
3582 if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION)
3583 && !cgi_page_requested(csp->http->host))
3588 if (http->ssl && csp->action->flags & ACTION_IGNORE_CERTIFICATE_ERRORS)
3590 csp->dont_verify_certificate = 1;
3595 * build the http request to send to the server
3596 * we have to do one of the following:
3598 * create = use the original HTTP request to create a new
3599 * HTTP request that has either the path component
3600 * without the http://domainspec (w/path) or the
3601 * full orininal URL (w/url)
3602 * Note that the path and/or the HTTP version may
3603 * have been altered by now.
3605 * SSL proxy = Open a socket to the host:port of the server
3606 * and create TLS/SSL connection with server and
3607 * with client. Then behave like mediator between
3608 * client and server over TLS/SSL.
3610 * SSL proxy = Pass the request unchanged if forwarding a CONNECT
3611 * with request to a parent proxy. Note that we'll be sending
3612 * forwarding the CFAIL message ourselves if connecting to the parent
3613 * fails, but we won't send a CSUCCEED message if it works,
3614 * since that would result in a double message (ours and the
3615 * parent's). After sending the request to the parent, we
3616 * must parse answer and send it to client. If connection
3617 * with server is established, we do TLS/SSL proxy. Otherwise
3618 * we send parent response to client and close connections.
3620 * here's the matrix:
3623 * +--------+--------+
3625 * 0 | create | SSL |
3626 * | w/path | proxy |
3627 * Forwarding +--------+--------+
3629 * 1 | create | proxy |
3630 * | w/url |+forward|
3631 * +--------+--------+
3635 #ifdef FEATURE_HTTPS_INSPECTION
3637 * Presetting SSL client and server flags
3639 if (http->ssl && !use_ssl_tunnel)
3641 http->client_ssl = 1;
3642 http->server_ssl = 1;
3646 http->client_ssl = 0;
3647 http->server_ssl = 0;
3651 if (http->ssl && connect_port_is_forbidden(csp))
3653 const char *acceptable_connect_ports =
3654 csp->action->string[ACTION_STRING_LIMIT_CONNECT];
3655 assert(NULL != acceptable_connect_ports);
3656 log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
3657 "limit-connect{%s} doesn't allow CONNECT requests to %s",
3658 csp->ip_addr_str, acceptable_connect_ports, csp->http->hostport);
3659 csp->action->flags |= ACTION_BLOCK;
3661 #ifdef FEATURE_HTTPS_INSPECTION
3662 http->client_ssl = 0;
3663 http->server_ssl = 0;
3668 freez(csp->headers->first->str);
3669 build_request_line(csp, fwd, &csp->headers->first->str);
3672 * We have a request. Check if one of the crunchers wants it
3673 * unless the client wants to use TLS/SSL in which case we
3674 * haven't setup the TLS context yet and will send the crunch
3678 #ifdef FEATURE_HTTPS_INSPECTION
3679 !client_use_ssl(csp) &&
3681 crunch_response_triggered(csp, crunchers_all))
3684 * Yes. The client got the crunch response and we're done here.
3689 log_applied_actions(csp->action);
3690 if (fwd->forward_host)
3692 log_error(LOG_LEVEL_CONNECT, "via [%s]:%d to: %s",
3693 fwd->forward_host, fwd->forward_port, http->hostport);
3697 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
3700 /* here we connect to the server, gateway, or the forwarder */
3702 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3703 if ((csp->server_connection.sfd != JB_INVALID_SOCKET)
3704 && socket_is_still_alive(csp->server_connection.sfd)
3705 && connection_destination_matches(&csp->server_connection, http, fwd))
3707 log_error(LOG_LEVEL_CONNECT,
3708 "Reusing server socket %d connected to %s. Total requests: %u.",
3709 csp->server_connection.sfd, csp->server_connection.host,
3710 csp->server_connection.requests_sent_total);
3714 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
3716 #ifdef FEATURE_CONNECTION_SHARING
3717 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
3719 remember_connection(&csp->server_connection);
3722 #endif /* def FEATURE_CONNECTION_SHARING */
3724 log_error(LOG_LEVEL_CONNECT,
3725 "Closing server socket %d connected to %s. Total requests: %u.",
3726 csp->server_connection.sfd, csp->server_connection.host,
3727 csp->server_connection.requests_sent_total);
3728 close_socket(csp->server_connection.sfd);
3730 mark_connection_closed(&csp->server_connection);
3732 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3733 #ifdef FEATURE_HTTPS_INSPECTION
3734 if (http->ssl && !use_ssl_tunnel)
3738 * Creating an SSL proxy. If forwarding is disabled, we must send
3739 * CSUCCEED message to client. Then TLS/SSL connection with client
3743 if (fwd->forward_host == NULL)
3746 * We're lying to the client as the connection hasn't actually
3747 * been established yet. We don't establish the connection until
3748 * we have seen and parsed the encrypted client headers.
3750 if (write_socket_delayed(csp->cfd, CSUCCEED,
3751 strlen(CSUCCEED), get_write_delay(csp)) != 0)
3753 log_error(LOG_LEVEL_ERROR, "Sending SUCCEED to client failed");
3758 ret = create_client_ssl_connection(csp);
3761 log_error(LOG_LEVEL_ERROR,
3762 "Failed to open a secure connection with the client");
3765 if (JB_ERR_OK != process_encrypted_request(csp))
3767 log_error(LOG_LEVEL_ERROR, "Failed to parse encrypted request.");
3768 close_client_ssl_connection(csp);
3772 * We have an encrypted request. Check if one of the crunchers now
3773 * wants it (for example because the previously invisible path was
3774 * required to match).
3776 if (crunch_response_triggered(csp, crunchers_all))
3779 * Yes. The client got the crunch response and we're done here.
3781 close_client_ssl_connection(csp);
3787 * Connecting to destination server
3789 csp->server_connection.sfd = forwarded_connect(fwd, http, csp);
3791 if (csp->server_connection.sfd == JB_INVALID_SOCKET)
3793 if (fwd->type != SOCKS_NONE)
3796 rsp = error_response(csp, "forwarding-failed");
3798 else if (errno == EINVAL)
3800 rsp = error_response(csp, "no-such-domain");
3804 rsp = error_response(csp, "connect-failed");
3807 /* Write the answer to the client */
3810 send_crunch_response(csp, rsp);
3814 * Temporary workaround to prevent already-read client
3815 * bodies from being parsed as new requests. For now we
3816 * err on the safe side and throw all the following
3817 * requests under the bus, even if no client body has been
3818 * buffered. A compliant client will repeat the dropped
3819 * requests on an untainted connection.
3821 * The proper fix is to discard the no longer needed
3822 * client body in the buffer (if there is one) and to
3823 * continue parsing the bytes that follow.
3825 #ifdef FEATURE_HTTPS_INSPECTION
3826 close_client_ssl_connection(csp);
3828 drain_and_close_socket(csp->cfd);
3829 csp->cfd = JB_INVALID_SOCKET;
3834 #ifdef FEATURE_HTTPS_INSPECTION
3836 * Creating TLS/SSL connections with destination server or parent
3837 * proxy. If forwarding is enabled, we must send client request to
3838 * parent proxy and receive, parse and resend parent proxy answer.
3840 if (http->ssl && !use_ssl_tunnel)
3842 if (fwd->forward_host != NULL)
3844 char server_response[BUFFER_SIZE];
3847 char *hdr = list_to_text(csp->headers);
3848 memset(server_response, 0, sizeof(server_response));
3852 log_error(LOG_LEVEL_FATAL,
3853 "Out of memory parsing client header");
3855 list_remove_all(csp->headers);
3858 * Sending client's CONNECT request to the parent proxy
3860 ret = write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
3866 log_error(LOG_LEVEL_CONNECT,
3867 "Sending request headers to: %s failed", http->hostport);
3868 mark_server_socket_tainted(csp);
3869 close_client_ssl_connection(csp);
3873 /* Waiting for parent proxy server response */
3874 len = read_socket(csp->server_connection.sfd, server_response,
3875 sizeof(server_response)-1);
3879 log_error(LOG_LEVEL_ERROR, "No response from parent proxy "
3880 "server on socket %d.", csp->server_connection.sfd);
3882 rsp = error_response(csp, "no-server-data");
3885 send_crunch_response(csp, rsp);
3887 mark_server_socket_tainted(csp);
3888 close_client_ssl_connection(csp);
3893 * Test if connection with destination server was established
3894 * successfully by parent proxy. Then we can send response to
3895 * the client and continue or stop.
3897 if (!tunnel_established_successfully(server_response, (unsigned int)len))
3899 log_error(LOG_LEVEL_ERROR, "Forwarder hasn't established "
3900 "connection with destination server.");
3902 write_socket(csp->cfd, server_response, (size_t)len);
3903 mark_server_socket_tainted(csp);
3904 close_client_ssl_connection(csp);
3909 * Parent proxy has established connection with destination server.
3910 * Now we must create TLS/SSL connection with parent proxy.
3912 ret = create_server_ssl_connection(csp);
3915 * If TLS/SSL connection wasn't created and invalid certificate
3916 * wasn't detected, we can interrupt this function. Otherwise, we
3917 * must inform the client about invalid server certificate.
3920 && (csp->server_cert_verification_result == SSL_CERT_NOT_VERIFIED
3921 || csp->server_cert_verification_result == SSL_CERT_VALID))
3923 rsp = error_response(csp, "connect-failed");
3926 send_crunch_response(csp, rsp);
3932 * TLS/SSL connection with parent proxy is established, we can
3933 * inform client about success.
3935 ret = write_socket(csp->cfd, server_response, (size_t)len);
3938 log_error(LOG_LEVEL_ERROR,
3939 "Sending parent proxy response to client failed");
3940 mark_server_socket_tainted(csp);
3941 close_client_ssl_connection(csp);
3944 }/* -END- if (fwd->forward_host != NULL) */
3948 * Parent proxy is not used, we can just create TLS/SSL connection
3949 * with destination server
3951 int ret = create_server_ssl_connection(csp);
3954 if (csp->server_cert_verification_result != SSL_CERT_VALID &&
3955 csp->server_cert_verification_result != SSL_CERT_NOT_VERIFIED)
3958 * If the server certificate is invalid, we must inform
3959 * the client and then close connection to the client.
3961 ssl_send_certificate_error(csp);
3962 close_client_and_server_ssl_connections(csp);
3965 if (csp->server_cert_verification_result == SSL_CERT_NOT_VERIFIED
3966 || csp->server_cert_verification_result == SSL_CERT_VALID)
3969 * The TLS/SSL connection wasn't created but an invalid
3970 * certificate wasn't detected. Report it as connection
3973 rsp = error_response(csp, "connect-failed");
3976 send_crunch_response(csp, rsp);
3978 close_client_and_server_ssl_connections(csp);
3983 }/* -END- if (http->ssl) */
3984 #endif /* def FEATURE_HTTPS_INSPECTION */
3986 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3987 save_connection_destination(csp->server_connection.sfd,
3988 http, fwd, &csp->server_connection);
3989 csp->server_connection.keep_alive_timeout =
3990 (unsigned)csp->config->keep_alive_timeout;
3992 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3994 csp->server_connection.requests_sent_total++;
3996 if ((fwd->type == SOCKS_5T) && (NULL == csp->headers->first))
3998 /* Client headers have been sent optimistically */
3999 assert(csp->headers->last == NULL);
4001 else if (http->ssl == 0 || (fwd->forward_host
4002 #ifdef FEATURE_HTTPS_INSPECTION
4007 if (send_http_request(csp))
4009 rsp = error_response(csp, "connect-failed");
4012 send_crunch_response(csp, rsp);
4020 * Using old solution with SSL tunnel or new solution with SSL proxy
4022 list_remove_all(csp->headers);
4023 #ifdef FEATURE_HTTPS_INSPECTION
4028 * We're running an SSL tunnel and we're not forwarding,
4029 * so just ditch the client headers, send the "connect succeeded"
4030 * message to the client, flush the rest, and get out of the way.
4032 if (write_socket_delayed(csp->cfd, CSUCCEED,
4033 strlen(CSUCCEED), get_write_delay(csp)))
4038 #ifdef FEATURE_HTTPS_INSPECTION
4042 * If server certificate is invalid, we must inform client and then
4043 * close connection with client.
4045 if (csp->server_cert_verification_result != SSL_CERT_VALID)
4047 ssl_send_certificate_error(csp);
4048 close_client_and_server_ssl_connections(csp);
4051 if (send_https_request(csp))
4053 rsp = error_response(csp, "connect-failed");
4056 send_crunch_response(csp, rsp);
4058 close_client_and_server_ssl_connections(csp);
4062 #endif /* def FEATURE_HTTPS_INSPECTION */
4063 clear_iob(csp->client_iob);
4064 }/* -END- else ... if (http->ssl == 1) */
4066 log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
4068 /* XXX: should the time start earlier for optimistically sent data? */
4069 csp->server_connection.request_sent = time(NULL);
4071 handle_established_connection(csp);
4072 freez(csp->receive_buffer);
4077 /*********************************************************************
4079 * Function : fuzz_server_response
4081 * Description : Treat the input as a whole server response.
4084 * 1 : csp = Current client state (buffers, headers, etc...)
4085 * 2 : fuzz_input_file = File to read the input from.
4089 *********************************************************************/
4090 extern int fuzz_server_response(struct client_state *csp, char *fuzz_input_file)
4092 static struct forward_spec fwd; /* Zero'd due to being static */
4095 if (strcmp(fuzz_input_file, "-") == 0)
4097 /* XXX: Doesn'T work yet. */
4098 csp->server_connection.sfd = 0;
4102 csp->server_connection.sfd = open(fuzz_input_file, O_RDONLY);
4103 if (csp->server_connection.sfd == -1)
4105 log_error(LOG_LEVEL_FATAL, "Failed to open %s: %E",
4110 csp->content_type |= CT_GIF;
4111 csp->action->flags |= ACTION_DEANIMATE;
4112 csp->action->string[ACTION_STRING_DEANIMATE] = "last";
4114 csp->http->path = strdup_or_die("/");
4115 csp->http->host = strdup_or_die("fuzz.example.org");
4116 csp->http->hostport = strdup_or_die("fuzz.example.org:80");
4117 /* Prevent client socket monitoring */
4118 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
4119 csp->flags |= CSP_FLAG_CHUNKED;
4121 csp->config->feature_flags |= RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
4122 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
4124 csp->content_type |= CT_DECLARED|CT_GIF;
4126 csp->config->socket_timeout = 0;
4128 cgi_init_error_messages();
4130 handle_established_connection(csp);
4131 freez(csp->receive_buffer);
4138 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4139 /*********************************************************************
4141 * Function : prepare_csp_for_next_request
4143 * Description : Put the csp in a mostly vergin state.
4146 * 1 : csp = Current client state (buffers, headers, etc...)
4150 *********************************************************************/
4151 static void prepare_csp_for_next_request(struct client_state *csp)
4153 csp->content_type = 0;
4154 csp->content_length = 0;
4155 csp->expected_content_length = 0;
4156 csp->expected_client_content_length = 0;
4157 list_remove_all(csp->headers);
4158 clear_iob(csp->iob);
4159 freez(csp->error_message);
4160 free_http_request(csp->http);
4161 destroy_list(csp->headers);
4162 destroy_list(csp->tags);
4163 #ifdef FEATURE_CLIENT_TAGS
4164 destroy_list(csp->client_tags);
4165 freez(csp->client_address);
4167 free_current_action(csp->action);
4168 if (NULL != csp->fwd)
4170 unload_forward_spec(csp->fwd);
4173 /* XXX: Store per-connection flags someplace else. */
4174 csp->flags = (CSP_FLAG_ACTIVE | CSP_FLAG_REUSED_CLIENT_CONNECTION);
4175 #ifdef FEATURE_TOGGLE
4176 if (global_toggle_state)
4177 #endif /* def FEATURE_TOGGLE */
4179 csp->flags |= CSP_FLAG_TOGGLED_ON;
4182 if (csp->client_iob->eod > csp->client_iob->cur)
4184 long bytes_to_shift = csp->client_iob->cur - csp->client_iob->buf;
4185 size_t data_length = (size_t)(csp->client_iob->eod - csp->client_iob->cur);
4187 assert(bytes_to_shift > 0);
4188 assert(data_length > 0);
4190 log_error(LOG_LEVEL_CONNECT, "Shifting %d pipelined bytes by %d bytes",
4191 data_length, bytes_to_shift);
4192 memmove(csp->client_iob->buf, csp->client_iob->cur, data_length);
4193 csp->client_iob->cur = csp->client_iob->buf;
4194 assert(csp->client_iob->eod == csp->client_iob->buf + bytes_to_shift + data_length);
4195 csp->client_iob->eod = csp->client_iob->buf + data_length;
4196 memset(csp->client_iob->eod, '\0', (size_t)bytes_to_shift);
4198 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
4203 * We mainly care about resetting client_iob->cur so we don't
4204 * waste buffer space at the beginning and don't mess up the
4205 * request restoration done by cgi_show_request().
4207 * Freeing the buffer itself isn't technically necessary,
4208 * but makes debugging more convenient.
4210 clear_iob(csp->client_iob);
4213 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4216 /*********************************************************************
4220 * Description : This is little more than chat. We only "serve" to
4221 * to close (or remember) any socket that chat may have
4225 * 1 : csp = Current client state (buffers, headers, etc...)
4229 *********************************************************************/
4230 static void serve(struct client_state *csp)
4232 int config_file_change_detected = 0; /* Only used for debugging */
4233 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4234 #ifdef FEATURE_CONNECTION_SHARING
4235 static int monitor_thread_running = 0;
4236 #endif /* def FEATURE_CONNECTION_SHARING */
4237 int continue_chatting = 0;
4239 log_error(LOG_LEVEL_CONNECT, "Accepted connection from %s on socket %d",
4240 csp->ip_addr_str, csp->cfd);
4244 unsigned int latency;
4249 * If the request has been crunched,
4250 * the calculated latency is zero.
4252 latency = (unsigned)(csp->server_connection.response_received -
4253 csp->server_connection.request_sent) / 2;
4255 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4256 && (csp->flags & CSP_FLAG_CRUNCHED)
4257 && (csp->expected_client_content_length != 0))
4259 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
4260 log_error(LOG_LEVEL_CONNECT,
4261 "Tainting client socket %d due to unread data.", csp->cfd);
4264 continue_chatting = (csp->config->feature_flags
4265 & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
4266 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
4267 && (csp->cfd != JB_INVALID_SOCKET)
4268 && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4269 && ((csp->flags & CSP_FLAG_SERVER_CONTENT_LENGTH_SET)
4270 || (csp->flags & CSP_FLAG_CHUNKED));
4272 if (!(csp->flags & CSP_FLAG_CRUNCHED)
4273 && (csp->server_connection.sfd != JB_INVALID_SOCKET))
4275 if (!(csp->flags & CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET))
4277 csp->server_connection.keep_alive_timeout = csp->config->default_server_timeout;
4279 if (!(csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
4280 || (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
4281 || !socket_is_still_alive(csp->server_connection.sfd)
4282 || !(latency < csp->server_connection.keep_alive_timeout))
4284 log_error(LOG_LEVEL_CONNECT,
4285 "Closing server socket %d connected to %s. "
4286 "Keep-alive %u. Tainted: %u. Socket alive %u. Timeout: %u.",
4287 csp->server_connection.sfd, csp->server_connection.host,
4288 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
4289 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
4290 socket_is_still_alive(csp->server_connection.sfd),
4291 csp->server_connection.keep_alive_timeout);
4292 #ifdef FEATURE_CONNECTION_SHARING
4293 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4295 forget_connection(csp->server_connection.sfd);
4297 #endif /* def FEATURE_CONNECTION_SHARING */
4298 close_socket(csp->server_connection.sfd);
4299 mark_connection_closed(&csp->server_connection);
4303 if (continue_chatting && any_loaded_file_changed(csp))
4305 continue_chatting = 0;
4306 config_file_change_detected = 1;
4309 if (continue_chatting)
4311 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
4312 && socket_is_still_alive(csp->cfd))
4314 log_error(LOG_LEVEL_CONNECT, "Client request %d has been "
4315 "pipelined on socket %d and the socket is still alive.",
4316 csp->requests_received_total+1, csp->cfd);
4317 prepare_csp_for_next_request(csp);
4321 if (0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
4323 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4325 log_error(LOG_LEVEL_CONNECT,
4326 "Waiting for the next client request on socket %d. "
4327 "Keeping the server socket %d to %s open.",
4328 csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
4332 log_error(LOG_LEVEL_CONNECT,
4333 "Waiting for the next client request on socket %d. "
4334 "No server socket to keep open.", csp->cfd);
4338 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4339 && data_is_available(csp->cfd, (int)csp->config->keep_alive_timeout)
4340 && socket_is_still_alive(csp->cfd))
4342 log_error(LOG_LEVEL_CONNECT,
4343 "Client request %u arrived in time on socket %d.",
4344 csp->requests_received_total+1, csp->cfd);
4345 prepare_csp_for_next_request(csp);
4349 #ifdef FEATURE_CONNECTION_SHARING
4350 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4351 && (csp->server_connection.sfd != JB_INVALID_SOCKET)
4352 && (socket_is_still_alive(csp->server_connection.sfd)))
4354 time_t time_open = time(NULL) - csp->server_connection.timestamp;
4356 if (csp->server_connection.keep_alive_timeout < time_open - (time_t)latency)
4361 remember_connection(&csp->server_connection);
4362 csp->server_connection.sfd = JB_INVALID_SOCKET;
4363 drain_and_close_socket(csp->cfd);
4364 csp->cfd = JB_INVALID_SOCKET;
4365 privoxy_mutex_lock(&connection_reuse_mutex);
4366 if (!monitor_thread_running)
4368 monitor_thread_running = 1;
4369 privoxy_mutex_unlock(&connection_reuse_mutex);
4370 wait_for_alive_connections();
4371 privoxy_mutex_lock(&connection_reuse_mutex);
4372 monitor_thread_running = 0;
4374 privoxy_mutex_unlock(&connection_reuse_mutex);
4376 #endif /* def FEATURE_CONNECTION_SHARING */
4380 else if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4382 log_error(LOG_LEVEL_CONNECT,
4383 "Closing server socket %d connected to %s. Keep-alive: %u. "
4384 "Tainted: %u. Socket alive: %u. Timeout: %u. "
4385 "Configuration file change detected: %u",
4386 csp->server_connection.sfd, csp->server_connection.host,
4387 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
4388 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
4389 socket_is_still_alive(csp->server_connection.sfd),
4390 csp->server_connection.keep_alive_timeout,
4391 config_file_change_detected);
4393 } while (continue_chatting);
4397 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4399 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4401 #ifdef FEATURE_CONNECTION_SHARING
4402 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4404 forget_connection(csp->server_connection.sfd);
4406 #endif /* def FEATURE_CONNECTION_SHARING */
4407 close_socket(csp->server_connection.sfd);
4410 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4411 mark_connection_closed(&csp->server_connection);
4414 if (csp->cfd != JB_INVALID_SOCKET)
4416 log_error(LOG_LEVEL_CONNECT, "Closing client socket %d. "
4417 "Keep-alive: %u. Socket alive: %u. Data available: %u. "
4418 "Configuration file change detected: %u. Requests received: %u.",
4419 csp->cfd, 0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE),
4420 socket_is_still_alive(csp->cfd), data_is_available(csp->cfd, 0),
4421 config_file_change_detected, csp->requests_received_total);
4422 drain_and_close_socket(csp->cfd);
4425 free_csp_resources(csp);
4427 csp->flags &= ~CSP_FLAG_ACTIVE;
4433 /*********************************************************************
4435 * Function : server_thread
4437 * Description : We only exist to call `serve' in a threaded environment.
4440 * 1 : data = Current client state (buffers, headers, etc...)
4442 * Returns : Always 0.
4444 *********************************************************************/
4445 static int32 server_thread(void *data)
4447 serve((struct client_state *) data);
4454 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
4455 /*********************************************************************
4459 * Description : Print usage info & exit.
4461 * Parameters : Pointer to argv[0] for identifying ourselves
4465 *********************************************************************/
4466 static void usage(const char *name)
4468 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
4469 "Usage: %s [--config-test] "
4472 #endif /* defined(unix) */
4475 "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
4476 #endif /* defined(unix) */
4477 "[--version] [configfile]\n",
4481 show_fuzz_usage(name);
4484 printf("Aborting\n");
4489 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
4492 #ifdef MUTEX_LOCKS_AVAILABLE
4493 /*********************************************************************
4495 * Function : privoxy_mutex_lock
4497 * Description : Locks a mutex.
4500 * 1 : mutex = The mutex to lock.
4502 * Returns : Void. May exit in case of errors.
4504 *********************************************************************/
4505 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
4507 #ifdef FEATURE_PTHREAD
4508 int err = pthread_mutex_lock(mutex);
4511 if (mutex != &log_mutex)
4513 log_error(LOG_LEVEL_FATAL,
4514 "Mutex locking failed: %s.\n", strerror(err));
4519 EnterCriticalSection(mutex);
4520 #endif /* def FEATURE_PTHREAD */
4524 /*********************************************************************
4526 * Function : privoxy_mutex_unlock
4528 * Description : Unlocks a mutex.
4531 * 1 : mutex = The mutex to unlock.
4533 * Returns : Void. May exit in case of errors.
4535 *********************************************************************/
4536 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
4538 #ifdef FEATURE_PTHREAD
4539 int err = pthread_mutex_unlock(mutex);
4542 if (mutex != &log_mutex)
4544 log_error(LOG_LEVEL_FATAL,
4545 "Mutex unlocking failed: %s.\n", strerror(err));
4550 LeaveCriticalSection(mutex);
4551 #endif /* def FEATURE_PTHREAD */
4555 /*********************************************************************
4557 * Function : privoxy_mutex_init
4559 * Description : Prepares a mutex.
4562 * 1 : mutex = The mutex to initialize.
4564 * Returns : Void. May exit in case of errors.
4566 *********************************************************************/
4567 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
4569 #ifdef FEATURE_PTHREAD
4570 int err = pthread_mutex_init(mutex, 0);
4573 printf("Fatal error. Mutex initialization failed: %s.\n",
4578 InitializeCriticalSection(mutex);
4579 #endif /* def FEATURE_PTHREAD */
4581 #endif /* def MUTEX_LOCKS_AVAILABLE */
4583 /*********************************************************************
4585 * Function : initialize_mutexes
4587 * Description : Prepares mutexes if mutex support is available.
4591 * Returns : Void, exits in case of errors.
4593 *********************************************************************/
4594 static void initialize_mutexes(void)
4596 #ifdef MUTEX_LOCKS_AVAILABLE
4598 * Prepare global mutex semaphores
4601 #ifdef FEATURE_HTTPS_INSPECTION
4602 privoxy_mutex_init(&certificate_mutex);
4603 privoxy_mutex_init(&rng_mutex);
4606 privoxy_mutex_init(&log_mutex);
4607 privoxy_mutex_init(&log_init_mutex);
4608 privoxy_mutex_init(&connection_reuse_mutex);
4609 #ifdef FEATURE_EXTERNAL_FILTERS
4610 privoxy_mutex_init(&external_filter_mutex);
4612 #ifdef FEATURE_CLIENT_TAGS
4613 privoxy_mutex_init(&client_tags_mutex);
4617 * XXX: The assumptions below are a bit naive
4618 * and can cause locks that aren't necessary.
4620 * For example older FreeBSD versions (< 6.x?)
4621 * have no gethostbyname_r, but gethostbyname is
4624 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
4625 privoxy_mutex_init(&resolver_mutex);
4626 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
4628 * XXX: should we use a single mutex for
4629 * localtime() and gmtime() as well?
4631 #ifndef HAVE_GMTIME_R
4632 privoxy_mutex_init(&gmtime_mutex);
4633 #endif /* ndef HAVE_GMTIME_R */
4635 #ifndef HAVE_LOCALTIME_R
4636 privoxy_mutex_init(&localtime_mutex);
4637 #endif /* ndef HAVE_GMTIME_R */
4639 #if !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM)
4640 privoxy_mutex_init(&rand_mutex);
4641 #endif /* !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM) */
4643 #endif /* def MUTEX_LOCKS_AVAILABLE */
4646 /*********************************************************************
4650 * Description : Load the config file and start the listen loop.
4651 * This function is a lot more *sane* with the `load_config'
4652 * and `listen_loop' functions; although it stills does
4653 * a *little* too much for my taste.
4656 * 1 : argc = Number of parameters (including $0).
4657 * 2 : argv = Array of (char *)'s to the parameters.
4659 * Returns : 1 if : can't open config file, unrecognized directive,
4660 * stats requested in multi-thread mode, can't open the
4661 * log file, can't open the jar file, listen port is invalid,
4662 * any load fails, and can't bind port.
4664 * Else main never returns, the process must be signaled
4665 * to terminate execution. Or, on Windows, use the
4666 * "File", "Exit" menu option.
4668 *********************************************************************/
4670 int real_main(int argc, char **argv)
4672 int main(int argc, char **argv)
4676 int do_config_test = 0;
4677 #ifndef HAVE_ARC4RANDOM
4678 unsigned int random_seed;
4681 struct passwd *pw = NULL;
4682 struct group *grp = NULL;
4684 char *pre_chroot_nslookup_to_load_resolver = NULL;
4687 char *fuzz_input_type = NULL;
4688 char *fuzz_input_file = NULL;
4695 #if !defined(_WIN32)
4702 /* Prepare mutexes if supported and necessary. */
4703 initialize_mutexes();
4705 /* Enable logging until further notice. */
4709 * Parse the command line arguments
4711 * XXX: simply printing usage information in case of
4712 * invalid arguments isn't particularly user friendly.
4714 while (++argc_pos < argc)
4717 /* Check to see if the service must be installed or uninstalled */
4718 if (strncmp(argv[argc_pos], "--install", 9) == 0)
4720 const char *pName = argv[argc_pos] + 9;
4723 exit((install_service(pName)) ? 0 : 1);
4725 else if (strncmp(argv[argc_pos], "--uninstall", 11) == 0)
4727 const char *pName = argv[argc_pos] + 11;
4730 exit((uninstall_service(pName)) ? 0 : 1);
4732 else if (strcmp(argv[argc_pos], "--service") == 0)
4734 bRunAsService = TRUE;
4735 w32_set_service_cwd();
4736 atexit(w32_service_exit_notify);
4739 #endif /* defined(_WIN32) */
4742 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
4744 if (strcmp(argv[argc_pos], "--help") == 0)
4749 else if (strcmp(argv[argc_pos], "--version") == 0)
4751 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
4757 else if (strcmp(argv[argc_pos], "--no-daemon") == 0)
4759 set_debug_level(LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
4763 else if (strcmp(argv[argc_pos], "--pidfile") == 0)
4765 if (++argc_pos == argc) usage(argv[0]);
4766 pidfile = strdup_or_die(argv[argc_pos]);
4769 else if (strcmp(argv[argc_pos], "--user") == 0)
4774 if (++argc_pos == argc) usage(argv[argc_pos]);
4776 user_arg = strdup_or_die(argv[argc_pos]);
4777 group_name = strchr(user_arg, '.');
4778 if (NULL != group_name)
4780 /* Nul-terminate the user name */
4783 /* Skip the former delimiter to actually reach the group name */
4786 grp = getgrnam(group_name);
4789 log_error(LOG_LEVEL_FATAL, "Group '%s' not found.", group_name);
4792 pw = getpwnam(user_arg);
4795 log_error(LOG_LEVEL_FATAL, "User '%s' not found.", user_arg);
4801 else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup") == 0)
4803 if (++argc_pos == argc) usage(argv[0]);
4804 pre_chroot_nslookup_to_load_resolver = strdup_or_die(argv[argc_pos]);
4807 else if (strcmp(argv[argc_pos], "--chroot") == 0)
4811 #endif /* defined(unix) */
4813 else if (strcmp(argv[argc_pos], "--config-test") == 0)
4818 else if (strcmp(argv[argc_pos], "--fuzz") == 0)
4821 if (argc < argc_pos + 2) usage(argv[0]);
4822 fuzz_input_type = argv[argc_pos];
4824 fuzz_input_file = argv[argc_pos];
4826 else if (strcmp(argv[argc_pos], "--stfu") == 0)
4828 set_debug_level(LOG_LEVEL_STFU);
4831 else if (argc_pos + 1 != argc)
4834 * This is neither the last command line
4835 * option, nor was it recognized before,
4836 * therefore it must be invalid.
4842 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
4844 configfile = argv[argc_pos];
4847 } /* -END- while (more arguments) */
4849 show_version(Argv[0]);
4852 if (*configfile != '/')
4854 char cwd[BUFFER_SIZE];
4856 size_t abs_file_size;
4858 /* make config-filename absolute here */
4859 if (NULL == getcwd(cwd, sizeof(cwd)))
4861 perror("failed to get current working directory");
4865 basedir = strdup_or_die(cwd);
4867 abs_file_size = strlen(cwd) + strlen(configfile) + 5;
4868 abs_file = malloc_or_die(abs_file_size);
4869 strlcpy(abs_file, basedir, abs_file_size);
4870 strlcat(abs_file, "/", abs_file_size);
4871 strlcat(abs_file, configfile, abs_file_size);
4872 configfile = abs_file;
4874 #endif /* defined unix */
4878 clients->next = NULL;
4880 /* XXX: factor out initialising after the next stable release. */
4885 #ifndef HAVE_ARC4RANDOM
4886 random_seed = (unsigned int)time(NULL);
4888 srandom(random_seed);
4891 #endif /* ifdef HAVE_RANDOM */
4892 #endif /* ifndef HAVE_ARC4RANDOM */
4895 * Unix signal handling
4897 * Catch the abort, interrupt and terminate signals for a graceful exit
4898 * Catch the hangup signal so the errlog can be reopened.
4900 * Ignore the broken pipe signal as connection failures
4901 * are handled when and where they occur without relying
4904 #if !defined(_WIN32) && !defined(__OS2__)
4907 const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP };
4909 for (idx = 0; idx < SZ(catched_signals); idx++)
4911 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
4912 if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
4914 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
4915 #endif /* ifdef sun */
4917 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
4921 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
4923 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for SIGPIPE: %E");
4927 #else /* ifdef _WIN32 */
4928 # ifdef _WIN_CONSOLE
4930 * We *are* in a windows console app.
4931 * Print a verbose messages about FAQ's and such
4933 printf("%s", win32_blurb);
4934 # endif /* def _WIN_CONSOLE */
4935 #endif /* def _WIN32 */
4938 if (fuzz_input_type != NULL)
4940 exit(process_fuzzed_input(fuzz_input_type, fuzz_input_file));
4942 log_error(LOG_LEVEL_FATAL,
4943 "When compiled with fuzzing support, Privoxy should only be used for fuzzing. "
4944 "Various data structures are static which is unsafe when using threads.");
4949 exit(NULL == load_config());
4952 /* Initialize the CGI subsystem */
4953 cgi_init_error_messages();
4956 * If running on unix and without the --no-daemon
4957 * option, become a daemon. I.e. fork, detach
4958 * from tty and get process group leadership
4967 if (pid < 0) /* error */
4972 else if (pid != 0) /* parent */
4977 * must check for errors
4978 * child died due to missing files aso
4981 wpid = waitpid(pid, &status, WNOHANG);
4993 * stderr (fd 2) will be closed later on,
4994 * when the config file has been parsed.
5000 * Reserve fd 0 and 1 to prevent abort() and friends
5001 * from sending stuff to the clients or servers.
5003 fd = open("/dev/null", O_RDONLY);
5006 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
5010 if (dup2(fd, 0) == -1)
5012 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 0: %E");
5016 fd = open("/dev/null", O_WRONLY);
5019 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
5023 if (dup2(fd, 1) == -1)
5025 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 1: %E");
5030 #ifdef FEATURE_EXTERNAL_FILTERS
5031 for (fd = 0; fd < 3; fd++)
5033 mark_socket_for_close_on_execute(fd);
5039 } /* -END- if (daemon_mode) */
5042 * As soon as we have written the PID file, we can switch
5043 * to the user and group ID indicated by the --user option
5045 if (pidfile != NULL)
5047 write_pid_file(pidfile);
5051 if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
5053 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
5057 if (setgroups(1, &grp->gr_gid))
5059 log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
5062 else if (initgroups(pw->pw_name, pw->pw_gid))
5064 log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
5070 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
5072 /* Read the time zone file from /etc before doing chroot. */
5074 if (NULL != pre_chroot_nslookup_to_load_resolver
5075 && '\0' != pre_chroot_nslookup_to_load_resolver[0])
5077 /* Initialize resolver library. */
5078 (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
5080 if (chroot(pw->pw_dir) < 0)
5082 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
5086 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
5089 if (setuid(pw->pw_uid))
5091 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
5095 char putenv_dummy[64];
5097 strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
5098 if (putenv(putenv_dummy) != 0)
5100 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
5103 snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
5104 if (putenv(putenv_dummy) != 0)
5106 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
5112 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
5115 #endif /* defined unix */
5118 /* This will be FALSE unless the command line specified --service
5122 /* Yup, so now we must attempt to establish a connection
5123 * with the service dispatcher. This will only work if this
5124 * process was launched by the service control manager to
5125 * actually run as a service. If this isn't the case, i've
5126 * known it take around 30 seconds or so for the call to return.
5129 /* The StartServiceCtrlDispatcher won't return until the service is stopping */
5130 if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
5132 /* Service has run, and at this point is now being stopped, so just return */
5137 printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
5139 /* An error occurred. Usually it's because --service was wrongly specified
5140 * and we were unable to connect to the Service Control Dispatcher because
5141 * it wasn't expecting us and is therefore not listening.
5143 * For now, just continue below to call the listen_loop function.
5146 #endif /* def _WIN32 */
5156 /*********************************************************************
5158 * Function : bind_port_helper
5160 * Description : Bind the listen port. Handles logging, and aborts
5164 * 1 : haddr = Host address to bind to. Use NULL to bind to
5166 * 2 : hport = Specifies port to bind to.
5167 * 3 : backlog = Listen backlog.
5169 * Returns : Port that was opened.
5171 *********************************************************************/
5172 static jb_socket bind_port_helper(const char *haddr, int hport, int backlog)
5177 result = bind_port(haddr, hport, backlog, &bfd);
5181 const char *bind_address = (NULL != haddr) ? haddr : "INADDR_ANY";
5185 log_error(LOG_LEVEL_FATAL,
5186 "can't bind to %s:%d: There may be another Privoxy "
5187 "or some other proxy running on port %d",
5188 bind_address, hport, hport);
5191 log_error(LOG_LEVEL_FATAL,
5192 "can't bind to %s:%d: The hostname is not resolvable",
5193 bind_address, hport);
5196 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: %E",
5197 bind_address, hport);
5200 /* shouldn't get here */
5201 return JB_INVALID_SOCKET;
5206 if (bfd >= FD_SETSIZE)
5208 log_error(LOG_LEVEL_FATAL,
5209 "Bind socket number too high to use select(): %d >= %d",
5217 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
5222 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
5230 /*********************************************************************
5232 * Function : bind_ports_helper
5234 * Description : Bind the listen ports. Handles logging, and aborts
5238 * 1 : config = Privoxy configuration. Specifies ports
5240 * 2 : sockets = Preallocated array of opened sockets
5241 * corresponding to specification in config.
5242 * All non-opened sockets will be set to
5243 * JB_INVALID_SOCKET.
5245 * Returns : Nothing. Inspect sockets argument.
5247 *********************************************************************/
5248 static void bind_ports_helper(struct configuration_spec * config,
5249 jb_socket sockets[])
5253 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
5255 if (config->hport[i])
5257 sockets[i] = bind_port_helper(config->haddr[i],
5258 config->hport[i], config->listen_backlog);
5259 #if defined(FEATURE_ACCEPT_FILTER) && defined(SO_ACCEPTFILTER)
5260 if (config->enable_accept_filter && sockets[i] != JB_INVALID_SOCKET)
5262 struct accept_filter_arg af_options;
5263 bzero(&af_options, sizeof(af_options));
5264 strlcpy(af_options.af_name, "httpready", sizeof(af_options.af_name));
5265 if (setsockopt(sockets[i], SOL_SOCKET, SO_ACCEPTFILTER, &af_options,
5266 sizeof(af_options)))
5268 log_error(LOG_LEVEL_ERROR,
5269 "Enabling accept filter for socket %d failed: %E", sockets[i]);
5276 sockets[i] = JB_INVALID_SOCKET;
5279 config->need_bind = 0;
5283 /*********************************************************************
5285 * Function : close_ports_helper
5287 * Description : Close listenings ports.
5290 * 1 : sockets = Array of opened and non-opened sockets to
5291 * close. All sockets will be set to
5292 * JB_INVALID_SOCKET.
5294 * Returns : Nothing.
5296 *********************************************************************/
5297 static void close_ports_helper(jb_socket sockets[])
5301 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
5303 if (JB_INVALID_SOCKET != sockets[i])
5305 close_socket(sockets[i]);
5307 sockets[i] = JB_INVALID_SOCKET;
5313 /* Without this simple workaround we get this compiler warning from _beginthread
5314 * warning C4028: formal parameter 1 different from declaration
5316 void w32_service_listen_loop(void *p)
5320 #endif /* def _WIN32 */
5323 /*********************************************************************
5325 * Function : listen_loop
5327 * Description : bind the listen port and enter a "FOREVER" listening loop.
5333 *********************************************************************/
5334 static void listen_loop(void)
5336 struct client_states *csp_list = NULL;
5337 struct client_state *csp = NULL;
5338 jb_socket bfds[MAX_LISTENING_SOCKETS];
5339 struct configuration_spec *config;
5340 unsigned int active_threads = 0;
5341 #if defined(FEATURE_PTHREAD)
5342 pthread_attr_t attrs;
5344 pthread_attr_init(&attrs);
5345 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
5348 config = load_config();
5350 #ifdef FEATURE_CONNECTION_SHARING
5352 * XXX: Should be relocated once it no
5353 * longer needs to emit log messages.
5355 initialize_reusable_connections();
5356 #endif /* def FEATURE_CONNECTION_SHARING */
5358 bind_ports_helper(config, bfds);
5360 #ifdef FEATURE_GRACEFUL_TERMINATION
5361 while (!g_terminate)
5366 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(__OS2__)
5367 while (waitpid(-1, NULL, WNOHANG) > 0)
5369 /* zombie children */
5371 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) */
5374 * Free data that was used by died threads
5376 active_threads = sweep();
5380 * Re-open the errlog after HUP signal
5382 if (received_hup_signal)
5384 if (NULL != config->logfile)
5386 init_error_log(Argv[0], config->logfile);
5388 received_hup_signal = 0;
5392 csp_list = zalloc_or_die(sizeof(*csp_list));
5393 csp = &csp_list->csp;
5395 log_error(LOG_LEVEL_CONNECT,
5396 "Waiting for the next client connection. Currently active threads: %d",
5400 * This config may be outdated, but for accept_connection()
5401 * it's fresh enough.
5403 csp->config = config;
5405 if (!accept_connection(csp, bfds))
5407 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
5412 csp->flags |= CSP_FLAG_ACTIVE;
5413 csp->server_connection.sfd = JB_INVALID_SOCKET;
5415 csp->config = config = load_config();
5417 if (config->need_bind)
5420 * Since we were listening to the "old port", we will not see
5421 * a "listen" param change until the next request. So, at
5422 * least 1 more request must be made for us to find the new
5423 * setting. I am simply closing the old socket and binding the
5426 * Which-ever is correct, we will serve 1 more page via the
5427 * old settings. This should probably be a "show-status"
5428 * request. This should not be a so common of an operation
5429 * that this will hurt people's feelings.
5432 close_ports_helper(bfds);
5434 bind_ports_helper(config, bfds);
5437 #ifdef FEATURE_TOGGLE
5438 if (global_toggle_state)
5439 #endif /* def FEATURE_TOGGLE */
5441 csp->flags |= CSP_FLAG_TOGGLED_ON;
5444 if (run_loader(csp))
5446 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
5447 /* Never get here - LOG_LEVEL_FATAL causes program exit */
5451 if (block_acl(NULL,csp))
5453 log_error(LOG_LEVEL_CONNECT,
5454 "Connection from %s on %s (socket %d) dropped due to ACL",
5455 csp->ip_addr_str, csp->listen_addr_str, csp->cfd);
5456 close_socket(csp->cfd);
5457 freez(csp->ip_addr_str);
5458 freez(csp->listen_addr_str);
5462 #endif /* def FEATURE_ACL */
5464 if ((0 != config->max_client_connections)
5465 && (active_threads >= config->max_client_connections))
5467 log_error(LOG_LEVEL_CONNECT,
5468 "Rejecting connection from %s. Maximum number of connections reached.",
5470 write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
5471 strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
5472 close_socket(csp->cfd);
5473 freez(csp->ip_addr_str);
5474 freez(csp->listen_addr_str);
5479 /* add it to the list of clients */
5480 csp_list->next = clients->next;
5481 clients->next = csp_list;
5483 if (config->multi_threaded)
5487 /* this is a switch () statement in the C preprocessor - ugh */
5488 #undef SELECTED_ONE_OPTION
5490 /* Use Pthreads in preference to native code */
5491 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
5492 #define SELECTED_ONE_OPTION
5494 pthread_t the_thread;
5496 errno = pthread_create(&the_thread, &attrs,
5497 (void * (*)(void *))serve, csp);
5498 child_id = errno ? -1 : 0;
5502 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
5503 #define SELECTED_ONE_OPTION
5504 child_id = _beginthread(
5505 (void (*)(void *))serve,
5510 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
5511 #define SELECTED_ONE_OPTION
5512 child_id = _beginthread(
5513 (void(* _Optlink)(void*))serve,
5519 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
5520 #define SELECTED_ONE_OPTION
5522 thread_id tid = spawn_thread
5523 (server_thread, "server", B_NORMAL_PRIORITY, csp);
5525 if ((tid >= 0) && (resume_thread(tid) == B_OK))
5527 child_id = (int) tid;
5536 #if !defined(SELECTED_ONE_OPTION)
5539 /* This block is only needed when using fork().
5540 * When using threads, the server thread was
5541 * created and run by the call to _beginthread().
5543 if (child_id == 0) /* child */
5546 #ifdef FEATURE_TOGGLE
5547 int inherited_toggle_state = global_toggle_state;
5548 #endif /* def FEATURE_TOGGLE */
5553 * If we've been toggled or we've blocked the request, tell Mom
5556 #ifdef FEATURE_TOGGLE
5557 if (inherited_toggle_state != global_toggle_state)
5559 rc |= RC_FLAG_TOGGLED;
5561 #endif /* def FEATURE_TOGGLE */
5563 #ifdef FEATURE_STATISTICS
5564 if (csp->flags & CSP_FLAG_REJECTED)
5566 rc |= RC_FLAG_BLOCKED;
5568 #endif /* ndef FEATURE_STATISTICS */
5572 else if (child_id > 0) /* parent */
5574 /* in a fork()'d environment, the parent's
5575 * copy of the client socket and the CSP
5579 #if !defined(_WIN32) && !defined(__CYGWIN__)
5581 wait(&child_status);
5584 * Evaluate child's return code: If the child has
5585 * - been toggled, toggle ourselves
5586 * - blocked its request, bump up the stats counter
5589 #ifdef FEATURE_TOGGLE
5590 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
5592 global_toggle_state = !global_toggle_state;
5594 #endif /* def FEATURE_TOGGLE */
5596 #ifdef FEATURE_STATISTICS
5598 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
5602 #endif /* def FEATURE_STATISTICS */
5604 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
5605 close_socket(csp->cfd);
5606 csp->flags &= ~CSP_FLAG_ACTIVE;
5610 #undef SELECTED_ONE_OPTION
5611 /* end of cpp switch () */
5616 * Spawning the child failed, assume it's because
5617 * there are too many children running already.
5618 * XXX: If you assume ...
5620 log_error(LOG_LEVEL_ERROR,
5621 "Unable to take any additional connections: %E. Active threads: %d",
5623 write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
5624 strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
5625 close_socket(csp->cfd);
5626 csp->flags &= ~CSP_FLAG_ACTIVE;
5635 #if defined(FEATURE_PTHREAD)
5636 pthread_attr_destroy(&attrs);
5639 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
5641 #ifdef FEATURE_HTTPS_INSPECTION
5642 /* Clean up. Aim: free all memory (no leaks) */
5643 if (rng_seeded == 1)
5645 mbedtls_ctr_drbg_free(&ctr_drbg);
5646 mbedtls_entropy_free(&entropy);
5650 #ifdef FEATURE_GRACEFUL_TERMINATION
5652 log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
5654 unload_current_config_file();
5655 unload_current_actions_file();
5656 unload_current_re_filterfile();
5657 #ifdef FEATURE_TRUST
5658 unload_current_trust_file();
5661 if (config->multi_threaded)
5668 } while ((clients->next != NULL) && (--i > 0));
5672 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
5682 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
5683 /* Cleanup - remove taskbar icon etc. */
5688 #endif /* FEATURE_GRACEFUL_TERMINATION */