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-2023 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 */
66 # include <sys/wait.h>
67 # include <sys/time.h>
68 # include <sys/stat.h>
69 # include <sys/ioctl.h>
72 #include <sys/termios.h>
83 # include <socket.h> /* BeOS has select() for sockets only. */
84 # include <OS.h> /* declarations for threads and stuff. */
92 #endif /* def __GLIBC__ */
97 #warning poll() appears to be unavailable. Your platform will become unsupported in the future.
98 #endif /* HAVE_POLL */
105 #ifdef FEATURE_HTTPS_INSPECTION
111 #include "miscutil.h"
113 #include "jbsockets.h"
118 #include "urlmatch.h"
119 #ifdef FEATURE_CLIENT_TAGS
120 #include "client-tags.h"
124 struct client_states clients[1];
125 struct file_list files[1];
127 #ifdef FEATURE_STATISTICS
128 int urls_read = 0; /* total nr of urls read inc rejected */
129 int urls_rejected = 0; /* total nr of urls rejected */
130 #ifdef MUTEX_LOCKS_AVAILABLE
131 unsigned long long number_of_requests_received = 0;
132 unsigned long long number_of_requests_blocked = 0;
134 #endif /* def FEATURE_STATISTICS */
136 #ifdef FEATURE_GRACEFUL_TERMINATION
141 static void sig_handler(int the_signal);
143 static int client_protocol_is_unsupported(struct client_state *csp, char *req);
144 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers);
145 static jb_err get_server_headers(struct client_state *csp);
146 static const char *crunch_reason(const struct http_response *rsp);
147 static void send_crunch_response(struct client_state *csp, struct http_response *rsp);
148 static char *get_request_line(struct client_state *csp);
149 static jb_err receive_client_request(struct client_state *csp);
150 static jb_err parse_client_request(struct client_state *csp);
151 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line);
152 static jb_err change_request_destination(struct client_state *csp);
153 static void handle_established_connection(struct client_state *csp);
154 static void chat(struct client_state *csp);
155 static void serve(struct client_state *csp);
156 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
157 static void usage(const char *myname);
159 static void initialize_mutexes(void);
160 static jb_socket bind_port_helper(const char *haddr, int hport, int backlog);
161 static void bind_ports_helper(struct configuration_spec *config, jb_socket sockets[]);
162 static void close_ports_helper(jb_socket sockets[]);
163 static void listen_loop(void);
164 static void serve(struct client_state *csp);
167 static int32 server_thread(void *data);
168 #endif /* def __BEOS__ */
171 #define sleep(N) Sleep(((N) * 1000))
175 int process_fuzzed_input(char *fuzz_input_type, char *fuzz_input_file);
176 void show_fuzz_usage(const char *name);
179 #ifdef MUTEX_LOCKS_AVAILABLE
181 * XXX: Does the locking stuff really belong in this file?
183 privoxy_mutex_t log_mutex;
184 privoxy_mutex_t log_init_mutex;
185 privoxy_mutex_t connection_reuse_mutex;
187 #ifdef FEATURE_HTTPS_INSPECTION
188 privoxy_mutex_t certificate_mutex;
189 privoxy_mutex_t ssl_init_mutex;
192 #ifdef FEATURE_EXTERNAL_FILTERS
193 privoxy_mutex_t external_filter_mutex;
195 #ifdef FEATURE_CLIENT_TAGS
196 privoxy_mutex_t client_tags_mutex;
198 #ifdef FEATURE_STATISTICS
199 privoxy_mutex_t block_statistics_mutex;
201 #ifdef FEATURE_EXTENDED_STATISTICS
202 privoxy_mutex_t filter_statistics_mutex;
203 privoxy_mutex_t block_reason_statistics_mutex;
206 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
207 privoxy_mutex_t resolver_mutex;
208 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
210 #ifndef HAVE_GMTIME_R
211 privoxy_mutex_t gmtime_mutex;
212 #endif /* ndef HAVE_GMTIME_R */
214 #ifndef HAVE_LOCALTIME_R
215 privoxy_mutex_t localtime_mutex;
216 #endif /* ndef HAVE_GMTIME_R */
218 #if !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM)
219 privoxy_mutex_t rand_mutex;
220 #endif /* !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM) */
222 #endif /* def MUTEX_LOCKS_AVAILABLE */
225 const char *basedir = NULL;
226 const char *pidfile = NULL;
227 static int received_hup_signal = 0;
228 #endif /* defined unix */
230 /* HTTP snipplets. */
231 static const char CSUCCEED[] =
232 "HTTP/1.1 200 Connection established\r\n\r\n";
234 static const char CHEADER[] =
235 "HTTP/1.1 400 Invalid header received from client\r\n"
236 "Content-Type: text/plain\r\n"
237 "Connection: close\r\n\r\n"
238 "Invalid header received from client.\n";
240 static const char FTP_RESPONSE[] =
241 "HTTP/1.1 400 Invalid request received from client\r\n"
242 "Content-Type: text/plain\r\n"
243 "Connection: close\r\n\r\n"
244 "Invalid request. Privoxy doesn't support FTP.\n";
246 static const char GOPHER_RESPONSE[] =
247 "HTTP/1.1 400 Invalid request received from client\r\n"
248 "Content-Type: text/plain\r\n"
249 "Connection: close\r\n\r\n"
250 "Invalid request. Privoxy doesn't support gopher.\n";
252 /* XXX: should be a template */
253 static const char MISSING_DESTINATION_RESPONSE[] =
254 "HTTP/1.1 400 Bad request received from client\r\n"
255 "Content-Type: text/plain\r\n"
256 "Connection: close\r\n\r\n"
257 "Bad request. Privoxy was unable to extract the destination.\n";
259 /* XXX: should be a template */
260 static const char INVALID_SERVER_HEADERS_RESPONSE[] =
261 "HTTP/1.1 502 Server or forwarder response invalid\r\n"
262 "Content-Type: text/plain\r\n"
263 "Connection: close\r\n\r\n"
264 "Bad response. The server or forwarder response doesn't look like HTTP.\n";
266 /* XXX: should be a template */
267 static const char MESSED_UP_REQUEST_RESPONSE[] =
268 "HTTP/1.1 400 Malformed request after rewriting\r\n"
269 "Content-Type: text/plain\r\n"
270 "Connection: close\r\n\r\n"
271 "Bad request. Messed up with header filters.\n";
273 static const char TOO_MANY_CONNECTIONS_RESPONSE[] =
274 "HTTP/1.1 503 Too many open connections\r\n"
275 "Content-Type: text/plain\r\n"
276 "Connection: close\r\n\r\n"
277 "Maximum number of open connections reached.\n";
279 static const char CLIENT_CONNECTION_TIMEOUT_RESPONSE[] =
280 "HTTP/1.1 504 Connection timeout\r\n"
281 "Content-Type: text/plain\r\n"
282 "Connection: close\r\n\r\n"
283 "The connection timed out because the client request didn't arrive in time.\n";
285 static const char CLIENT_BODY_PARSE_ERROR_RESPONSE[] =
286 "HTTP/1.1 400 Failed reading client body\r\n"
287 "Content-Type: text/plain\r\n"
288 "Connection: close\r\n\r\n"
289 "Failed parsing or buffering the chunk-encoded client body.\n";
291 static const char CLIENT_BODY_BUFFER_ERROR_RESPONSE[] =
292 "HTTP/1.1 400 Failed reading client body\r\n"
293 "Content-Type: text/plain\r\n"
294 "Connection: close\r\n\r\n"
295 "Failed to buffer the client body to apply content filters.\n"
296 "Could be caused by a socket timeout\n";
298 static const char UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE[] =
299 "HTTP/1.1 417 Expecting too much\r\n"
300 "Content-Type: text/plain\r\n"
301 "Connection: close\r\n\r\n"
302 "Privoxy detected an unsupported Expect header value.\n";
304 /* A function to crunch a response */
305 typedef struct http_response *(*crunch_func_ptr)(struct client_state *);
307 /* Crunch function flags */
308 #define CF_NO_FLAGS 0
309 /* Cruncher applies to forced requests as well */
310 #define CF_IGNORE_FORCE 1
311 /* Crunched requests are counted for the block statistics */
312 #define CF_COUNT_AS_REJECT 2
314 /* A crunch function and its flags */
317 const crunch_func_ptr cruncher;
321 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[]);
323 /* Complete list of cruncher functions */
324 static const struct cruncher crunchers_all[] = {
325 { direct_response, CF_COUNT_AS_REJECT|CF_IGNORE_FORCE},
326 { block_url, CF_COUNT_AS_REJECT },
328 { trust_url, CF_COUNT_AS_REJECT },
329 #endif /* def FEATURE_TRUST */
330 { redirect_url, CF_NO_FLAGS },
331 { dispatch_cgi, CF_IGNORE_FORCE},
335 /* Light version, used after tags are applied */
336 static const struct cruncher crunchers_light[] = {
337 { block_url, CF_COUNT_AS_REJECT },
338 { redirect_url, CF_NO_FLAGS },
344 * XXX: Don't we really mean
351 /*********************************************************************
353 * Function : sig_handler
355 * Description : Signal handler for different signals.
356 * Exit gracefully on TERM and INT
357 * or set a flag that will cause the errlog
358 * to be reopened by the main thread on HUP.
361 * 1 : the_signal = the signal cause this function to call
365 *********************************************************************/
366 static void sig_handler(int the_signal)
372 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
384 received_hup_signal = 1;
390 * We shouldn't be here, unless we catch signals
391 * in main() that we can't handle here!
393 log_error(LOG_LEVEL_FATAL,
394 "sig_handler: exiting on unexpected signal %d", the_signal);
402 /*********************************************************************
404 * Function : get_write_delay
406 * Description : Parse the delay-response parameter.
409 * 1 : csp = Current client state (buffers, headers, etc...)
411 * Returns : Number of milliseconds to delay writes.
413 *********************************************************************/
414 static unsigned int get_write_delay(const struct client_state *csp)
420 if ((csp->action->flags & ACTION_DELAY_RESPONSE) == 0)
424 newval = csp->action->string[ACTION_STRING_DELAY_RESPONSE];
426 delay = (unsigned)strtol(newval, &endptr, 0);
429 log_error(LOG_LEVEL_FATAL,
430 "Invalid delay-response{} parameter: '%s'", newval);
438 /*********************************************************************
440 * Function : client_protocol_is_unsupported
442 * Description : Checks if the client used a known unsupported
443 * protocol and deals with it by sending an error
447 * 1 : csp = Current client state (buffers, headers, etc...)
448 * 2 : req = the first request line send by the client
450 * Returns : TRUE if an error response has been generated, or
451 * FALSE if the request doesn't look invalid.
453 *********************************************************************/
454 static int client_protocol_is_unsupported(struct client_state *csp, char *req)
457 * If it's a FTP or gopher request, we don't support it.
459 * These checks are better than nothing, but they might
460 * not work in all configurations and some clients might
461 * have problems digesting the answer.
463 * They should, however, never cause more problems than
464 * Privoxy's old behaviour (returning the misleading HTML
467 * "Could not resolve http://(ftp|gopher)://example.org").
469 if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
471 const char *response = NULL;
472 const char *protocol = NULL;
474 if (!strncmpic(req, "GET ftp://", 10))
476 response = FTP_RESPONSE;
481 response = GOPHER_RESPONSE;
484 log_error(LOG_LEVEL_ERROR,
485 "%s tried to use Privoxy as %s proxy: %s",
486 csp->ip_addr_str, protocol, req);
487 log_error(LOG_LEVEL_CLF,
488 "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, req);
491 #ifdef FEATURE_HTTPS_INSPECTION
492 if (client_use_ssl(csp))
494 ssl_send_data_delayed(&(csp->ssl_client_attr),
495 (const unsigned char *)response, strlen(response),
496 get_write_delay(csp));
501 write_socket_delayed(csp->cfd, response, strlen(response),
502 get_write_delay(csp));
512 /*********************************************************************
514 * Function : client_has_unsupported_expectations
516 * Description : Checks if the client used an unsupported expectation
517 * in which case an error message is delivered.
520 * 1 : csp = Current client state (buffers, headers, etc...)
522 * Returns : TRUE if an error response has been generated, or
523 * FALSE if the request doesn't look invalid.
525 *********************************************************************/
526 static int client_has_unsupported_expectations(const struct client_state *csp)
528 if ((csp->flags & CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION))
530 log_error(LOG_LEVEL_ERROR,
531 "Rejecting request from client %s with unsupported Expect header value",
533 log_error(LOG_LEVEL_CLF,
534 "%s - - [%T] \"%s\" 417 0", csp->ip_addr_str, csp->http->cmd);
535 write_socket_delayed(csp->cfd,
536 UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE,
537 strlen(UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE),
538 get_write_delay(csp));
548 /*********************************************************************
550 * Function : get_request_destination_elsewhere
552 * Description : If the client's request was redirected into
553 * Privoxy without the client's knowledge,
554 * the request line lacks the destination host.
556 * This function tries to get it elsewhere,
557 * provided accept-intercepted-requests is enabled.
559 * "Elsewhere" currently only means "Host: header",
560 * but in the future we may ask the redirecting
561 * packet filter to look the destination up.
563 * If the destination stays unknown, an error
564 * response is send to the client and headers
565 * are freed so that chat() can return directly.
568 * 1 : csp = Current client state (buffers, headers, etc...)
569 * 2 : headers = a header list
571 * Returns : JB_ERR_OK if the destination is now known, or
572 * JB_ERR_PARSE if it isn't.
574 *********************************************************************/
575 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
577 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
579 log_error(LOG_LEVEL_ERROR, "%s's request: \'%s\' is invalid."
580 " Privoxy isn't configured to accept intercepted requests.",
581 csp->ip_addr_str, csp->http->cmd);
582 /* XXX: Use correct size */
583 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
584 csp->ip_addr_str, csp->http->cmd);
586 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER),
587 get_write_delay(csp));
588 destroy_list(headers);
592 else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
594 /* Split the domain we just got for pattern matching */
595 init_domain_components(csp->http);
601 /* We can't work without destination. Go spread the news.*/
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: %s",
608 csp->ip_addr_str, csp->http->cmd);
610 write_socket_delayed(csp->cfd, MISSING_DESTINATION_RESPONSE,
611 strlen(MISSING_DESTINATION_RESPONSE), get_write_delay(csp));
612 destroy_list(headers);
617 * TODO: If available, use PF's ioctl DIOCNATLOOK as last resort
618 * to get the destination IP address, use it as host directly
619 * or do a reverse DNS lookup first.
624 /*********************************************************************
626 * Function : get_server_headers
628 * Description : Parses server headers in iob and fills them
629 * into csp->headers so that they can later be
633 * 1 : csp = Current client state (buffers, headers, etc...)
635 * Returns : JB_ERR_OK if everything went fine, or
636 * JB_ERR_PARSE if the headers were incomplete.
638 *********************************************************************/
639 static jb_err get_server_headers(struct client_state *csp)
641 int continue_hack_in_da_house = 0;
644 while (((header = get_header(csp->iob)) != NULL) || continue_hack_in_da_house)
649 * continue hack in da house. Ignore the ending of
650 * this head and continue enlisting header lines.
651 * The reason is described below.
653 enlist(csp->headers, "");
654 continue_hack_in_da_house = 0;
657 else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
660 * It's a bodyless continue response, don't
661 * stop header parsing after reaching its end.
663 * As a result Privoxy will concatenate the
664 * next response's head and parse and deliver
665 * the headers as if they belonged to one request.
667 * The client will separate them because of the
668 * empty line between them.
670 * XXX: What we're doing here is clearly against
671 * the intended purpose of the continue header,
672 * and under some conditions (HTTP/1.0 client request)
673 * it's a standard violation.
675 * Anyway, "sort of against the spec" is preferable
676 * to "always getting confused by Continue responses"
677 * (Privoxy's behaviour before this hack was added)
679 log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
680 continue_hack_in_da_house = 1;
682 else if (*header == '\0')
685 * If the header is empty, but the Continue hack
686 * isn't active, we can assume that we reached the
687 * end of the buffer before we hit the end of the
690 * Inform the caller an let it decide how to handle it.
695 if (JB_ERR_MEMORY == enlist(csp->headers, header))
698 * XXX: Should we quit the request and return a
699 * out of memory error page instead?
701 log_error(LOG_LEVEL_ERROR,
702 "Out of memory while enlisting server headers. %s lost.",
712 /*********************************************************************
714 * Function : crunch_reason
716 * Description : Translates the crunch reason code into a string.
719 * 1 : rsp = a http_response
721 * Returns : A string with the crunch reason or an error description.
723 *********************************************************************/
724 static const char *crunch_reason(const struct http_response *rsp)
726 char * reason = NULL;
731 return "Internal error while searching for crunch reason";
734 switch (rsp->crunch_reason)
737 reason = "Unsupported HTTP feature";
743 reason = "Untrusted";
746 reason = "Redirected";
752 reason = "DNS failure";
754 case FORWARDING_FAILED:
755 reason = "Forwarding failed";
758 reason = "Connection failure";
761 reason = "Out of memory (may mask other reasons)";
763 case CONNECTION_TIMEOUT:
764 reason = "Connection timeout";
767 reason = "No server data received";
770 reason = "No reason recorded";
778 /*********************************************************************
780 * Function : log_applied_actions
782 * Description : Logs the applied actions if LOG_LEVEL_ACTIONS is
786 * 1 : actions = Current action spec to log
790 *********************************************************************/
791 static void log_applied_actions(const struct current_action_spec *actions)
794 * The conversion to text requires lots of memory allocations so
795 * we only do the conversion if the user is actually interested.
797 if (debug_level_is_enabled(LOG_LEVEL_ACTIONS))
799 char *actions_as_text = actions_to_line_of_text(actions);
800 log_error(LOG_LEVEL_ACTIONS, "%s", actions_as_text);
801 freez(actions_as_text);
806 /*********************************************************************
808 * Function : send_crunch_response
810 * Description : Delivers already prepared response for
811 * intercepted requests, logs the interception
812 * and frees the response.
815 * 1 : csp = Current client state (buffers, headers, etc...)
816 * 2 : rsp = Fully prepared response. Will be freed on exit.
820 *********************************************************************/
821 static void send_crunch_response(struct client_state *csp, struct http_response *rsp)
823 const struct http_request *http = csp->http;
827 assert(rsp->head != NULL);
831 log_error(LOG_LEVEL_FATAL, "NULL response in send_crunch_response.");
835 * Extract the status code from the actual head
836 * that will be send to the client. It is the only
837 * way to get it right for all requests, including
838 * the fixed ones for out-of-memory problems.
840 * A head starts like this: 'HTTP/1.1 200...'
844 status_code[0] = rsp->head[9];
845 status_code[1] = rsp->head[10];
846 status_code[2] = rsp->head[11];
847 status_code[3] = '\0';
849 /* Log that the request was crunched and why. */
850 log_applied_actions(csp->action);
851 #ifdef FEATURE_HTTPS_INSPECTION
852 if (client_use_ssl(csp))
854 log_error(LOG_LEVEL_CRUNCH, "%s: https://%s%s", crunch_reason(rsp),
855 http->hostport, http->path);
856 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s https://%s%s %s\" %s %lu",
857 csp->ip_addr_str, http->gpc, http->hostport, http->path,
858 http->version, status_code, rsp->content_length);
863 log_error(LOG_LEVEL_CRUNCH, "%s: %s", crunch_reason(rsp), http->url);
864 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" %s %lu",
865 csp->ip_addr_str, http->ocmd, status_code, rsp->content_length);
867 /* Write the answer to the client */
868 #ifdef FEATURE_HTTPS_INSPECTION
869 if (client_use_ssl(csp))
871 if ((ssl_send_data_delayed(&(csp->ssl_client_attr),
872 (const unsigned char *)rsp->head, rsp->head_length,
873 get_write_delay(csp)) < 0)
874 || (ssl_send_data_delayed(&(csp->ssl_client_attr),
875 (const unsigned char *)rsp->body, rsp->content_length,
876 get_write_delay(csp)) < 0))
878 /* There is nothing we can do about it. */
879 log_error(LOG_LEVEL_CONNECT, "Couldn't deliver the error message "
880 "for https://%s%s through client socket %d using TLS/SSL",
881 http->hostport, http->url, csp->cfd);
887 if (write_socket_delayed(csp->cfd, rsp->head, rsp->head_length,
888 get_write_delay(csp))
889 || write_socket_delayed(csp->cfd, rsp->body, rsp->content_length,
890 get_write_delay(csp)))
892 /* There is nothing we can do about it. */
893 log_error(LOG_LEVEL_CONNECT,
894 "Couldn't deliver the error message for %s through client socket %d: %E",
895 http->url, csp->cfd);
899 /* Clean up and return */
900 if (cgi_error_memory() != rsp)
902 free_http_response(rsp);
908 /*********************************************************************
910 * Function : crunch_response_triggered
912 * Description : Checks if the request has to be crunched,
913 * and delivers the crunch response if necessary.
916 * 1 : csp = Current client state (buffers, headers, etc...)
917 * 2 : crunchers = list of cruncher functions to run
919 * Returns : TRUE if the request was answered with a crunch response
922 *********************************************************************/
923 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[])
925 struct http_response *rsp = NULL;
926 const struct cruncher *c;
929 * If CGI request crunching is disabled,
930 * check the CGI dispatcher out of order to
931 * prevent unintentional blocks or redirects.
933 if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_CRUNCHING)
934 && (NULL != (rsp = dispatch_cgi(csp))))
936 /* Deliver, log and free the interception response. */
937 send_crunch_response(csp, rsp);
938 csp->flags |= CSP_FLAG_CRUNCHED;
942 for (c = crunchers; c->cruncher != NULL; c++)
945 * Check the cruncher if either Privoxy is toggled
946 * on and the request isn't forced, or if the cruncher
947 * applies to forced requests as well.
949 if (((csp->flags & CSP_FLAG_TOGGLED_ON) &&
950 !(csp->flags & CSP_FLAG_FORCED)) ||
951 (c->flags & CF_IGNORE_FORCE))
953 rsp = c->cruncher(csp);
956 /* Deliver, log and free the interception response. */
957 send_crunch_response(csp, rsp);
958 csp->flags |= CSP_FLAG_CRUNCHED;
959 #ifdef FEATURE_STATISTICS
960 if (c->flags & CF_COUNT_AS_REJECT)
962 #ifdef MUTEX_LOCKS_AVAILABLE
963 privoxy_mutex_lock(&block_statistics_mutex);
964 number_of_requests_blocked++;
965 privoxy_mutex_unlock(&block_statistics_mutex);
967 csp->flags |= CSP_FLAG_REJECTED;
969 #endif /* def FEATURE_STATISTICS */
980 /*********************************************************************
982 * Function : build_request_line
984 * Description : Builds the HTTP request line.
986 * If a HTTP forwarder is used it expects the whole URL,
987 * web servers only get the path.
990 * 1 : csp = Current client state (buffers, headers, etc...)
991 * 2 : fwd = The forwarding spec used for the request.
993 * 3 : request_line = The old request line which will be replaced.
995 * Returns : Nothing. Terminates in case of memory problems.
997 *********************************************************************/
998 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line)
1000 struct http_request *http = csp->http;
1003 * Downgrade http version from 1.1 to 1.0
1004 * if +downgrade action applies.
1006 if ((csp->action->flags & ACTION_DOWNGRADE)
1007 && (!strcmpic(http->version, "HTTP/1.1")))
1009 freez(http->version);
1010 http->version = strdup_or_die("HTTP/1.0");
1014 * Rebuild the request line.
1016 freez(*request_line);
1017 #ifdef FEATURE_HTTPS_INSPECTION
1018 if (fwd != NULL && fwd->forward_host &&
1019 fwd->type != FORWARD_WEBSERVER && client_use_ssl(csp))
1021 *request_line = strdup("CONNECT ");
1026 *request_line = strdup(http->gpc);
1027 string_append(request_line, " ");
1030 if (fwd != NULL && fwd->forward_host && fwd->type != FORWARD_WEBSERVER)
1032 #ifdef FEATURE_HTTPS_INSPECTION
1033 if (client_use_ssl(csp))
1035 char port_string[10];
1037 string_append(request_line, http->host);
1038 snprintf(port_string, sizeof(port_string), ":%d", http->port);
1039 string_append(request_line, port_string);
1044 string_append(request_line, http->url);
1049 string_append(request_line, http->path);
1051 string_append(request_line, " ");
1052 string_append(request_line, http->version);
1054 if (*request_line == NULL)
1056 log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
1058 log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", *request_line);
1062 /*********************************************************************
1064 * Function : change_request_destination
1066 * Description : Parse a (rewritten) request line and regenerate
1067 * the http request data.
1070 * 1 : csp = Current client state (buffers, headers, etc...)
1072 * Returns : Forwards the parse_http_request() return code.
1073 * Terminates in case of memory problems.
1075 *********************************************************************/
1076 static jb_err change_request_destination(struct client_state *csp)
1078 struct http_request *http = csp->http;
1081 log_error(LOG_LEVEL_REDIRECTS, "Rewrite detected: %s",
1082 csp->headers->first->str);
1083 free_http_request(http);
1084 err = parse_http_request(csp->headers->first->str, http);
1085 if (JB_ERR_OK != err)
1087 log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
1088 jb_err_to_string(err));
1090 if (http->ssl && strcmpic(csp->http->gpc, "CONNECT"))
1093 * A client header filter changed the request URL from
1094 * http:// to https:// which we currently don't support.
1096 log_error(LOG_LEVEL_ERROR, "Changing the request destination from http "
1097 "to https behind the client's back currently isn't supported.");
1098 return JB_ERR_PARSE;
1105 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1106 /*********************************************************************
1108 * Function : server_response_is_complete
1110 * Description : Determines whether we should stop reading
1111 * from the server socket.
1114 * 1 : csp = Current client state (buffers, headers, etc...)
1115 * 2 : content_length = Length of content received so far.
1117 * Returns : TRUE if the response is complete,
1120 *********************************************************************/
1121 static int server_response_is_complete(struct client_state *csp,
1122 unsigned long long content_length)
1124 int content_length_known = !!(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET);
1126 if (!strcmpic(csp->http->gpc, "HEAD"))
1129 * "HEAD" implies no body, we are thus expecting
1130 * no content. XXX: incomplete "list" of methods?
1132 csp->expected_content_length = 0;
1133 content_length_known = TRUE;
1134 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1137 if (csp->http->status == 204 || csp->http->status == 304)
1140 * Expect no body. XXX: incomplete "list" of status codes?
1142 csp->expected_content_length = 0;
1143 content_length_known = TRUE;
1144 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1147 return (content_length_known && ((0 == csp->expected_content_length)
1148 || (csp->expected_content_length <= content_length)));
1152 #ifdef FEATURE_CONNECTION_SHARING
1153 /*********************************************************************
1155 * Function : wait_for_alive_connections
1157 * Description : Waits for alive connections to timeout.
1163 *********************************************************************/
1164 static void wait_for_alive_connections(void)
1166 int connections_alive = close_unusable_connections();
1168 while (0 < connections_alive)
1170 log_error(LOG_LEVEL_CONNECT,
1171 "Waiting for %d connections to timeout.",
1174 connections_alive = close_unusable_connections();
1177 log_error(LOG_LEVEL_CONNECT, "No connections to wait for left.");
1180 #endif /* def FEATURE_CONNECTION_SHARING */
1183 /*********************************************************************
1185 * Function : save_connection_destination
1187 * Description : Remembers a connection for reuse later on.
1190 * 1 : sfd = Open socket to remember.
1191 * 2 : http = The destination for the connection.
1192 * 3 : fwd = The forwarder settings used.
1193 * 4 : server_connection = storage.
1197 *********************************************************************/
1198 static void save_connection_destination(jb_socket sfd,
1199 const struct http_request *http,
1200 const struct forward_spec *fwd,
1201 struct reusable_connection *server_connection)
1203 assert(sfd != JB_INVALID_SOCKET);
1204 assert(NULL != http->host);
1206 server_connection->sfd = sfd;
1207 server_connection->host = strdup_or_die(http->host);
1208 server_connection->port = http->port;
1210 assert(NULL != fwd);
1211 assert(server_connection->gateway_host == NULL);
1212 assert(server_connection->gateway_port == 0);
1213 assert(server_connection->forwarder_type == 0);
1214 assert(server_connection->forward_host == NULL);
1215 assert(server_connection->forward_port == 0);
1217 server_connection->forwarder_type = fwd->type;
1218 if (NULL != fwd->gateway_host)
1220 server_connection->gateway_host = strdup_or_die(fwd->gateway_host);
1224 server_connection->gateway_host = NULL;
1226 server_connection->gateway_port = fwd->gateway_port;
1227 if (NULL != fwd->auth_username)
1229 server_connection->auth_username = strdup_or_die(fwd->auth_username);
1233 server_connection->auth_username = NULL;
1235 if (NULL != fwd->auth_password)
1237 server_connection->auth_password = strdup_or_die(fwd->auth_password);
1241 server_connection->auth_password = NULL;
1244 if (NULL != fwd->forward_host)
1246 server_connection->forward_host = strdup_or_die(fwd->forward_host);
1250 server_connection->forward_host = NULL;
1252 server_connection->forward_port = fwd->forward_port;
1254 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1257 /*********************************************************************
1259 * Function : verify_request_length
1261 * Description : Checks if we already got the whole client requests
1262 * and sets CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ if
1265 * Data that doesn't belong to the current request is
1266 * either thrown away to let the client retry on a clean
1267 * socket, or stashed to be dealt with after the current
1268 * request is served.
1271 * 1 : csp = Current client state (buffers, headers, etc...)
1275 *********************************************************************/
1276 static void verify_request_length(struct client_state *csp)
1278 unsigned long long buffered_request_bytes =
1279 (unsigned long long)(csp->client_iob->eod - csp->client_iob->cur);
1281 if ((csp->expected_client_content_length != 0)
1282 && (buffered_request_bytes != 0))
1284 if (csp->expected_client_content_length >= buffered_request_bytes)
1286 csp->expected_client_content_length -= buffered_request_bytes;
1287 log_error(LOG_LEVEL_CONNECT, "Reduced expected bytes to %llu "
1288 "to account for the %llu ones we already got.",
1289 csp->expected_client_content_length, buffered_request_bytes);
1293 assert(csp->client_iob->eod > csp->client_iob->cur + csp->expected_client_content_length);
1294 csp->client_iob->eod = csp->client_iob->cur + csp->expected_client_content_length;
1295 log_error(LOG_LEVEL_CONNECT, "Reducing expected bytes to 0. "
1296 "Marking the server socket tainted after throwing %llu bytes away.",
1297 buffered_request_bytes - csp->expected_client_content_length);
1298 csp->expected_client_content_length = 0;
1299 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1302 if (csp->expected_client_content_length == 0)
1304 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1308 if (!(csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ)
1309 && ((csp->client_iob->cur < csp->client_iob->eod)
1310 || (csp->expected_client_content_length != 0)))
1312 if (strcmpic(csp->http->gpc, "GET")
1313 && strcmpic(csp->http->gpc, "HEAD")
1314 && strcmpic(csp->http->gpc, "TRACE")
1315 && strcmpic(csp->http->gpc, "OPTIONS")
1316 && strcmpic(csp->http->gpc, "DELETE"))
1318 /* XXX: this is an incomplete hack */
1319 csp->flags &= ~CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1320 log_error(LOG_LEVEL_CONNECT, "There better be a request body.");
1324 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1326 if ((csp->config->feature_flags & RUNTIME_FEATURE_TOLERATE_PIPELINING) == 0)
1328 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1329 log_error(LOG_LEVEL_CONNECT,
1330 "Possible pipeline attempt detected. The connection will not "
1331 "be kept alive and we will only serve the first request.");
1332 /* Nuke the pipelined requests from orbit, just to be sure. */
1333 clear_iob(csp->client_iob);
1338 * Keep the pipelined data around for now, we'll deal with
1339 * it once we're done serving the current request.
1341 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
1342 assert(csp->client_iob->eod >= csp->client_iob->cur);
1343 log_error(LOG_LEVEL_CONNECT, "Complete client request followed by "
1344 "%d bytes of pipelined data received.",
1345 (int)(csp->client_iob->eod - csp->client_iob->cur));
1351 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1352 log_error(LOG_LEVEL_CONNECT, "Complete client request received.");
1357 /*********************************************************************
1359 * Function : mark_server_socket_tainted
1361 * Description : Makes sure we don't reuse a server socket
1362 * (if we didn't read everything the server sent
1363 * us reusing the socket would lead to garbage).
1366 * 1 : csp = Current client state (buffers, headers, etc...)
1370 *********************************************************************/
1371 static void mark_server_socket_tainted(struct client_state *csp)
1374 * For consistency we always mark the server socket
1375 * tainted, however, to reduce the log noise we only
1376 * emit a log message if the server socket could have
1377 * actually been reused.
1379 if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
1380 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED))
1382 log_error(LOG_LEVEL_CONNECT,
1383 "Marking the server socket %d tainted.",
1384 csp->server_connection.sfd);
1386 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1389 /*********************************************************************
1391 * Function : get_request_line
1393 * Description : Read the client request line.
1396 * 1 : csp = Current client state (buffers, headers, etc...)
1398 * Returns : Pointer to request line or NULL in case of errors.
1400 *********************************************************************/
1401 static char *get_request_line(struct client_state *csp)
1403 char buf[BUFFER_SIZE];
1404 char *request_line = NULL;
1407 memset(buf, 0, sizeof(buf));
1409 if ((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
1412 * If there are multiple pipelined requests waiting,
1413 * the flag will be set again once the next request
1416 csp->flags &= ~CSP_FLAG_PIPELINED_REQUEST_WAITING;
1418 request_line = get_header(csp->client_iob);
1419 if ((NULL != request_line) && ('\0' != *request_line))
1421 return request_line;
1425 log_error(LOG_LEVEL_CONNECT, "No complete request line "
1426 "received yet. Continuing reading from %d.", csp->cfd);
1434 0 == (csp->flags & CSP_FLAG_FUZZED_INPUT) &&
1436 !data_is_available(csp->cfd, csp->config->socket_timeout)
1439 if (socket_is_still_alive(csp->cfd))
1441 log_error(LOG_LEVEL_CONNECT,
1442 "No request line on socket %d received in time. Timeout: %d.",
1443 csp->cfd, csp->config->socket_timeout);
1444 write_socket_delayed(csp->cfd, CLIENT_CONNECTION_TIMEOUT_RESPONSE,
1445 strlen(CLIENT_CONNECTION_TIMEOUT_RESPONSE),
1446 get_write_delay(csp));
1450 log_error(LOG_LEVEL_CONNECT,
1451 "The client side of the connection on socket %d got "
1452 "closed without sending a complete request line.", csp->cfd);
1457 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1459 if (len <= 0) return NULL;
1462 * If there is no memory left for buffering the
1463 * request, there is nothing we can do but hang up
1465 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1470 request_line = get_header(csp->client_iob);
1472 } while ((NULL != request_line) && ('\0' == *request_line));
1474 return request_line;
1480 CHUNK_STATUS_MISSING_DATA,
1481 CHUNK_STATUS_BODY_COMPLETE,
1482 CHUNK_STATUS_PARSE_ERROR
1486 /*********************************************************************
1488 * Function : chunked_body_is_complete
1490 * Description : Figures out whether or not a chunked body is complete.
1492 * Currently it always starts at the beginning of the
1493 * buffer which is somewhat wasteful and prevents Privoxy
1494 * from starting to forward the correctly parsed chunks
1495 * as soon as theoretically possible.
1497 * Should be modified to work with a common buffer,
1498 * and allow the caller to skip already parsed chunks.
1500 * This would allow the function to be used for unbuffered
1501 * response bodies as well.
1504 * 1 : iob = Buffer with the body to check.
1505 * 2 : length = Length of complete body
1507 * Returns : Enum with the result of the check.
1509 *********************************************************************/
1510 static enum chunk_status chunked_body_is_complete(struct iob *iob, size_t *length)
1512 unsigned int chunksize;
1518 * We need at least a single digit, followed by "\r\n",
1519 * followed by an unknown amount of data, followed by "\r\n".
1521 if (p + 5 > iob->eod)
1523 return CHUNK_STATUS_MISSING_DATA;
1525 if (sscanf(p, "%x", &chunksize) != 1)
1527 return CHUNK_STATUS_PARSE_ERROR;
1531 * We want at least a single digit, followed by "\r\n",
1532 * followed by the specified amount of data, followed by "\r\n".
1534 if (p + chunksize + 5 > iob->eod)
1536 return CHUNK_STATUS_MISSING_DATA;
1539 /* Skip chunk-size. */
1540 p = strstr(p, "\r\n");
1543 return CHUNK_STATUS_PARSE_ERROR;
1545 /* Move beyond the chunkdata. */
1548 /* Make sure we're still within the buffer and have two bytes left */
1549 if (p + 2 > iob->eod)
1551 return CHUNK_STATUS_MISSING_DATA;
1554 /* There should be another "\r\n" to skip */
1555 if (memcmp(p, "\r\n", 2))
1557 return CHUNK_STATUS_PARSE_ERROR;
1560 } while (chunksize > 0U);
1562 *length = (size_t)(p - iob->cur);
1563 assert(*length <= (size_t)(iob->eod - iob->cur));
1564 assert(p <= iob->eod);
1566 return CHUNK_STATUS_BODY_COMPLETE;
1571 /*********************************************************************
1573 * Function : receive_chunked_client_request_body
1575 * Description : Read the chunk-encoded client request body.
1576 * Failures are dealt with.
1579 * 1 : csp = Current client state (buffers, headers, etc...)
1581 * Returns : JB_ERR_OK or JB_ERR_PARSE
1583 *********************************************************************/
1584 static jb_err receive_chunked_client_request_body(struct client_state *csp)
1587 enum chunk_status status;
1589 while (CHUNK_STATUS_MISSING_DATA ==
1590 (status = chunked_body_is_complete(csp->client_iob, &body_length)))
1592 char buf[BUFFER_SIZE];
1595 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1597 log_error(LOG_LEVEL_ERROR,
1598 "Timeout while waiting for the client body.");
1601 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1604 log_error(LOG_LEVEL_ERROR,
1605 "Reading the client body failed: %E");
1608 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1613 if (status != CHUNK_STATUS_BODY_COMPLETE)
1615 write_socket_delayed(csp->cfd, CLIENT_BODY_PARSE_ERROR_RESPONSE,
1616 strlen(CLIENT_BODY_PARSE_ERROR_RESPONSE), get_write_delay(csp));
1617 log_error(LOG_LEVEL_CLF,
1618 "%s - - [%T] \"Failed reading chunked client body\" 400 0", csp->ip_addr_str);
1619 return JB_ERR_PARSE;
1621 log_error(LOG_LEVEL_CONNECT,
1622 "Chunked client body completely read. Length: %lu", body_length);
1623 csp->expected_client_content_length = body_length;
1631 /*********************************************************************
1633 * Function : fuzz_chunked_transfer_encoding
1635 * Description : Treat the fuzzed input as chunked transfer encoding
1636 * to check and dechunk.
1639 * 1 : csp = Used to store the data.
1640 * 2 : fuzz_input_file = File to read the input from.
1642 * Returns : Result of dechunking
1644 *********************************************************************/
1645 extern int fuzz_chunked_transfer_encoding(struct client_state *csp, char *fuzz_input_file)
1648 size_t size = (size_t)(csp->iob->eod - csp->iob->cur);
1649 enum chunk_status status;
1651 status = chunked_body_is_complete(csp->iob, &length);
1652 if (CHUNK_STATUS_BODY_COMPLETE != status)
1654 log_error(LOG_LEVEL_INFO, "Chunked body is incomplete or invalid");
1656 if (get_bytes_missing_from_chunked_data(csp->iob->cur, size, 0) == 0)
1658 if (CHUNK_STATUS_BODY_COMPLETE != status)
1660 log_error(LOG_LEVEL_ERROR,
1661 "There's disagreement about whether or not the chunked body is complete.");
1665 return (JB_ERR_OK == remove_chunked_transfer_coding(csp->iob->cur, &size));
1670 /*********************************************************************
1672 * Function : fuzz_client_request
1674 * Description : Try to get a client request from the fuzzed input.
1677 * 1 : csp = Current client state (buffers, headers, etc...)
1678 * 2 : fuzz_input_file = File to read the input from.
1680 * Returns : Result of fuzzing.
1682 *********************************************************************/
1683 extern int fuzz_client_request(struct client_state *csp, char *fuzz_input_file)
1688 csp->ip_addr_str = "fuzzer";
1690 if (strcmp(fuzz_input_file, "-") != 0)
1692 log_error(LOG_LEVEL_FATAL,
1693 "Fuzzed client requests can currently only be read from stdin (-).");
1695 err = receive_client_request(csp);
1696 if (err != JB_ERR_OK)
1700 err = parse_client_request(csp);
1701 if (err != JB_ERR_OK)
1709 #endif /* def FUZZ */
1712 #ifdef FEATURE_FORCE_LOAD
1713 /*********************************************************************
1715 * Function : force_required
1717 * Description : Checks a request line to see if it contains
1718 * the FORCE_PREFIX. If it does, it is removed
1719 * unless enforcing requests has beend disabled.
1722 * 1 : request_line = HTTP request line
1724 * Returns : TRUE if force is required, FALSE otherwise.
1726 *********************************************************************/
1727 static int force_required(const struct client_state *csp, char *request_line)
1731 p = strstr(request_line, "http://");
1735 p += strlen("http://");
1739 /* Intercepted request usually don't specify the protocol. */
1743 /* Go to the beginning of the path */
1748 * If the path is missing the request line is invalid and we
1749 * are done here. The client-visible rejection happens later on.
1754 if (0 == strncmpic(p, FORCE_PREFIX, strlen(FORCE_PREFIX) - 1))
1756 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS))
1758 /* XXX: Should clean more carefully */
1759 strclean(request_line, FORCE_PREFIX);
1760 log_error(LOG_LEVEL_FORCE,
1761 "Enforcing request: \"%s\".", request_line);
1765 log_error(LOG_LEVEL_FORCE,
1766 "Ignored force prefix in request: \"%s\".", request_line);
1772 #endif /* def FEATURE_FORCE_LOAD */
1775 /*********************************************************************
1777 * Function : receive_client_request
1779 * Description : Read the client's request (more precisely the
1780 * client headers) and answer it if necessary.
1783 * 1 : csp = Current client state (buffers, headers, etc...)
1785 * Returns : JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
1787 *********************************************************************/
1788 static jb_err receive_client_request(struct client_state *csp)
1790 char buf[BUFFER_SIZE];
1793 struct http_request *http;
1797 /* Temporary copy of the client's headers before they get enlisted in csp->headers */
1798 struct list header_list;
1799 struct list *headers = &header_list;
1801 /* We don't care if the arriving data is a valid HTTP request or not. */
1802 csp->requests_received_total++;
1806 memset(buf, 0, sizeof(buf));
1808 req = get_request_line(csp);
1811 mark_server_socket_tainted(csp);
1812 return JB_ERR_PARSE;
1814 assert(*req != '\0');
1816 if (client_protocol_is_unsupported(csp, req))
1818 return JB_ERR_PARSE;
1821 #ifdef FEATURE_FORCE_LOAD
1822 if (force_required(csp, req))
1824 csp->flags |= CSP_FLAG_FORCED;
1826 #endif /* def FEATURE_FORCE_LOAD */
1828 err = parse_http_request(req, http);
1830 if (JB_ERR_OK != err)
1832 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER),
1833 get_write_delay(csp));
1834 /* XXX: Use correct size */
1835 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1836 log_error(LOG_LEVEL_ERROR,
1837 "Couldn't parse request line received from %s: %s",
1838 csp->ip_addr_str, jb_err_to_string(err));
1840 free_http_request(http);
1841 return JB_ERR_PARSE;
1843 if (http->ssl && strcmpic(http->gpc, "CONNECT"))
1845 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER),
1846 get_write_delay(csp));
1847 /* XXX: Use correct size */
1848 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0",
1850 log_error(LOG_LEVEL_ERROR, "Client %s tried to send a https "
1851 "URL without sending a CONNECT request first",
1853 free_http_request(http);
1854 return JB_ERR_PARSE;
1857 /* grab the rest of the client's headers */
1861 p = get_header(csp->client_iob);
1865 /* There are no additional headers to read. */
1872 * We didn't receive a complete header
1873 * line yet, get the rest of it.
1875 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1877 log_error(LOG_LEVEL_ERROR,
1878 "Client headers did not arrive in time. Timeout: %d",
1879 csp->config->socket_timeout);
1880 destroy_list(headers);
1881 return JB_ERR_PARSE;
1884 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1887 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1888 destroy_list(headers);
1889 return JB_ERR_PARSE;
1892 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1895 * If there is no memory left for buffering the
1896 * request, there is nothing we can do but hang up
1898 destroy_list(headers);
1899 return JB_ERR_MEMORY;
1904 if (!strncmpic(p, "Transfer-Encoding:", 18))
1907 * XXX: should be called through sed()
1908 * but currently can't.
1910 client_transfer_encoding(csp, &p);
1913 * We were able to read a complete
1914 * header and can finally enlist it.
1921 if (http->host == NULL)
1924 * If we still don't know the request destination,
1925 * the request is invalid or the client uses
1926 * Privoxy without its knowledge.
1928 if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
1931 * Our attempts to get the request destination
1932 * elsewhere failed or Privoxy is configured
1933 * to only accept proxy requests.
1935 * An error response has already been sent
1936 * and we're done here.
1938 return JB_ERR_PARSE;
1942 #ifdef FEATURE_CLIENT_TAGS
1943 /* XXX: If the headers were enlisted sooner, passing csp would do. */
1944 set_client_address(csp, headers);
1945 get_tag_list_for_client(csp->client_tags, csp->client_address);
1949 * Determine the actions for this URL
1951 #ifdef FEATURE_TOGGLE
1952 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
1954 /* Most compatible set of actions (i.e. none) */
1955 init_current_action(csp->action);
1958 #endif /* ndef FEATURE_TOGGLE */
1960 get_url_actions(csp, http);
1963 enlist(csp->headers, http->cmd);
1965 /* Append the previously read headers */
1966 err = list_append_list_unique(csp->headers, headers);
1967 destroy_list(headers);
1974 /*********************************************************************
1976 * Function : parse_client_request
1978 * Description : Parses the client's request and decides what to do
1981 * Note that since we're not using select() we could get
1982 * blocked here if a client connected, then didn't say
1986 * 1 : csp = Current client state (buffers, headers, etc...)
1988 * Returns : JB_ERR_OK or JB_ERR_PARSE
1990 *********************************************************************/
1991 static jb_err parse_client_request(struct client_state *csp)
1993 struct http_request *http = csp->http;
1996 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1997 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
1998 && (!strcmpic(csp->http->version, "HTTP/1.1"))
1999 && (csp->http->ssl == 0))
2001 /* Assume persistence until further notice */
2002 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
2004 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2006 if (csp->http->ssl == 0)
2009 * This whole block belongs to chat() but currently
2010 * has to be executed before sed().
2012 if (csp->flags & CSP_FLAG_CHUNKED_CLIENT_BODY)
2014 if (receive_chunked_client_request_body(csp) != JB_ERR_OK)
2016 return JB_ERR_PARSE;
2021 csp->expected_client_content_length = get_expected_content_length(csp->headers);
2023 verify_request_length(csp);
2025 #ifndef FEATURE_HTTPS_INSPECTION
2028 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
2032 err = sed(csp, FILTER_CLIENT_HEADERS);
2033 if (JB_ERR_OK != err)
2035 log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
2037 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
2038 csp->ip_addr_str, csp->http->cmd);
2039 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER), get_write_delay(csp));
2040 return JB_ERR_PARSE;
2042 csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
2044 /* Check request line for rewrites. */
2045 if ((NULL == csp->headers->first->str)
2046 || (strcmp(http->cmd, csp->headers->first->str) &&
2047 (JB_ERR_OK != change_request_destination(csp))))
2050 * A header filter broke the request line - bail out.
2052 write_socket_delayed(csp->cfd, MESSED_UP_REQUEST_RESPONSE,
2053 strlen(MESSED_UP_REQUEST_RESPONSE), get_write_delay(csp));
2054 /* XXX: Use correct size */
2055 log_error(LOG_LEVEL_CLF,
2056 "%s - - [%T] \"Invalid request generated\" 400 0", csp->ip_addr_str);
2057 log_error(LOG_LEVEL_ERROR,
2058 "Invalid request line after applying header filters.");
2059 free_http_request(http);
2061 return JB_ERR_PARSE;
2064 if (client_has_unsupported_expectations(csp))
2066 return JB_ERR_PARSE;
2074 /*********************************************************************
2076 * Function : read_http_request_body
2078 * Description : Reads remaining request body from the client.
2081 * 1 : csp = Current client state (buffers, headers, etc...)
2083 * Returns : 0 on success, anything else is an error.
2085 *********************************************************************/
2086 static int read_http_request_body(struct client_state *csp)
2088 size_t to_read = csp->expected_client_content_length;
2091 assert(to_read != 0);
2093 /* check if all data has been already read */
2094 if (to_read <= (csp->client_iob->eod - csp->client_iob->cur))
2099 for (to_read -= (size_t)(csp->client_iob->eod - csp->client_iob->cur);
2100 to_read > 0 && data_is_available(csp->cfd, csp->config->socket_timeout);
2101 to_read -= (unsigned)len)
2103 char buf[BUFFER_SIZE];
2104 size_t max_bytes_to_read = to_read < sizeof(buf) ? to_read : sizeof(buf);
2106 log_error(LOG_LEVEL_CONNECT,
2107 "Waiting for up to %lu bytes of request body from the client.",
2109 len = read_socket(csp->cfd, buf, (int)max_bytes_to_read);
2112 log_error(LOG_LEVEL_CONNECT, "Failed receiving request body from %s: %E", csp->ip_addr_str);
2115 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, (char *)buf, len))
2119 assert(to_read >= len);
2124 log_error(LOG_LEVEL_CONNECT,
2125 "Not enough request body has been read: expected %lu more bytes.",
2129 log_error(LOG_LEVEL_CONNECT,
2130 "The last %d bytes of the request body have been read.", len);
2135 /*********************************************************************
2137 * Function : update_client_headers
2139 * Description : Updates the HTTP headers from the client request.
2142 * 1 : csp = Current client state (buffers, headers, etc...)
2143 * 2 : new_content_length = new content length value to set
2145 * Returns : 0 on success, anything else is an error.
2147 *********************************************************************/
2148 static int update_client_headers(struct client_state *csp, size_t new_content_length)
2150 static const char content_length[] = "Content-Length:";
2152 struct list_entry *p;
2154 #ifndef FEATURE_HTTPS_INSPECTION
2155 for (p = csp->headers->first;
2157 for (p = csp->http->client_ssl ? csp->https_headers->first : csp->headers->first;
2159 !updated && (p != NULL); p = p->next)
2161 /* Header crunch()ed in previous run? -> ignore */
2167 /* Does the current parser handle this header? */
2168 if (0 == strncmpic(p->str, content_length, sizeof(content_length) - 1))
2170 updated = (JB_ERR_OK == header_adjust_content_length((char **)&(p->str), new_content_length));
2182 /*********************************************************************
2184 * Function : can_buffer_request_body
2186 * Description : Checks if the current request body can be stored in
2187 * the client_iob without hitting buffer limit.
2190 * 1 : csp = Current client state (buffers, headers, etc...)
2192 * Returns : TRUE if the current request size do not exceed buffer limit
2195 *********************************************************************/
2196 static int can_buffer_request_body(const struct client_state *csp)
2198 if (!can_add_to_iob(csp->client_iob, csp->config->buffer_limit,
2199 csp->expected_client_content_length))
2201 log_error(LOG_LEVEL_INFO,
2202 "Not filtering request body from %s: buffer limit %lu will be exceeded "
2203 "(content length %llu)", csp->ip_addr_str, csp->config->buffer_limit,
2204 csp->expected_client_content_length);
2211 /*********************************************************************
2213 * Function : send_http_request
2215 * Description : Sends the HTTP headers from the client request
2216 * and all the body data that has already been received.
2219 * 1 : csp = Current client state (buffers, headers, etc...)
2221 * Returns : 0 on success, 1 on error, 2 if the request got crunched.
2223 *********************************************************************/
2224 static int send_http_request(struct client_state *csp)
2229 hdr = list_to_text(csp->headers);
2232 /* FIXME Should handle error properly */
2233 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
2235 list_remove_all(csp->headers);
2238 * Write the client's (modified) header to the server
2239 * (along with anything else that may be in the buffer)
2241 write_failure = 0 != write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
2246 log_error(LOG_LEVEL_CONNECT, "Failed sending request headers to: %s: %E",
2247 csp->http->hostport);
2251 /* XXX: Filtered data is not sent if there's a pipelined request? */
2252 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
2253 && (flush_iob(csp->server_connection.sfd, csp->client_iob, 0) < 0))
2255 log_error(LOG_LEVEL_CONNECT, "Failed sending request body to: %s: %E",
2256 csp->http->hostport);
2263 #ifdef FEATURE_HTTPS_INSPECTION
2264 /*********************************************************************
2266 * Function : read_https_request_body
2268 * Description : Reads remaining request body from the client.
2271 * 1 : csp = Current client state (buffers, headers, etc...)
2273 * Returns : 0 on success, anything else is an error.
2275 *********************************************************************/
2276 static int read_https_request_body(struct client_state *csp)
2278 size_t to_read = csp->expected_client_content_length;
2281 assert(to_read != 0);
2283 /* check if all data has been already read */
2284 if (to_read <= (csp->client_iob->eod - csp->client_iob->cur))
2289 for (to_read -= (size_t)(csp->client_iob->eod - csp->client_iob->cur);
2290 to_read > 0 && (is_ssl_pending(&(csp->ssl_client_attr)) ||
2291 data_is_available(csp->cfd, csp->config->socket_timeout));
2292 to_read -= (unsigned)len)
2294 unsigned char buf[BUFFER_SIZE];
2295 size_t max_bytes_to_read = to_read < sizeof(buf) ? to_read : sizeof(buf);
2297 log_error(LOG_LEVEL_CONNECT,
2298 "Buffering encrypted client body. Prepared to read up to %lu bytes.",
2300 len = ssl_recv_data(&(csp->ssl_client_attr), buf,
2301 (unsigned)max_bytes_to_read);
2304 log_error(LOG_LEVEL_CONNECT,
2305 "Did not receive the whole encrypted request body from %s.",
2309 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, (char *)buf, len))
2313 assert(to_read >= len);
2318 log_error(LOG_LEVEL_CONNECT,
2319 "Not enough encrypted request body has been read: expected %lu more bytes.",
2324 log_error(LOG_LEVEL_CONNECT,
2325 "The last %llu bytes of the encrypted request body have been read.",
2326 csp->expected_client_content_length);
2331 /*********************************************************************
2333 * Function : receive_and_send_encrypted_post_data
2335 * Description : Reads remaining request body from the client and sends
2339 * 1 : csp = Current client state (buffers, headers, etc...)
2341 * Returns : 0 on success, anything else is an error.
2343 *********************************************************************/
2344 static int receive_and_send_encrypted_post_data(struct client_state *csp)
2346 int content_length_known = csp->expected_client_content_length != 0;
2348 while (is_ssl_pending(&(csp->ssl_client_attr))
2349 || (content_length_known && csp->expected_client_content_length != 0))
2351 unsigned char buf[BUFFER_SIZE];
2353 int max_bytes_to_read = sizeof(buf);
2355 if (content_length_known && csp->expected_client_content_length < sizeof(buf))
2357 max_bytes_to_read = (int)csp->expected_client_content_length;
2359 log_error(LOG_LEVEL_CONNECT,
2360 "Prepared to read up to %d bytes of encrypted request body from the client.",
2362 len = ssl_recv_data(&(csp->ssl_client_attr), buf,
2363 (unsigned)max_bytes_to_read);
2370 /* XXX: Does this actually happen? */
2373 log_error(LOG_LEVEL_CONNECT, "Forwarding %d bytes of encrypted request body.",
2375 len = ssl_send_data(&(csp->ssl_server_attr), buf, (size_t)len);
2380 if (csp->expected_client_content_length != 0)
2382 if (csp->expected_client_content_length >= len)
2384 csp->expected_client_content_length -= (unsigned)len;
2386 if (csp->expected_client_content_length == 0)
2388 log_error(LOG_LEVEL_CONNECT, "Forwarded the last %d bytes.", len);
2394 log_error(LOG_LEVEL_CONNECT, "Done forwarding encrypted request body.");
2401 /*********************************************************************
2403 * Function : send_https_request
2405 * Description : Sends the HTTP headers from the client request
2406 * and all the body data that has already been received.
2409 * 1 : csp = Current client state (buffers, headers, etc...)
2411 * Returns : 0 on success, anything else is an error.
2413 *********************************************************************/
2414 static int send_https_request(struct client_state *csp)
2420 hdr = list_to_text(csp->https_headers);
2423 /* FIXME Should handle error properly */
2424 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header.");
2426 list_remove_all(csp->https_headers);
2429 * Write the client's (modified) header to the server
2430 * (along with anything else that may be in the buffer)
2432 ret = ssl_send_data(&(csp->ssl_server_attr),
2433 (const unsigned char *)hdr, strlen(hdr));
2438 log_error(LOG_LEVEL_CONNECT,
2439 "Failed sending encrypted request headers to: %s: %E",
2440 csp->http->hostport);
2441 mark_server_socket_tainted(csp);
2445 /* XXX: Client body isn't sent if there's pipelined data? */
2446 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
2447 && ((flushed = ssl_flush_socket(&(csp->ssl_server_attr),
2448 csp->client_iob)) < 0))
2450 log_error(LOG_LEVEL_CONNECT, "Failed sending request body to: %s: %E",
2451 csp->http->hostport);
2454 if (flushed != 0 || csp->expected_client_content_length != 0)
2456 if (csp->expected_client_content_length != 0)
2458 if (csp->expected_client_content_length < flushed)
2460 log_error(LOG_LEVEL_ERROR,
2461 "Flushed %ld bytes of request body while only expecting %llu.",
2462 flushed, csp->expected_client_content_length);
2463 csp->expected_client_content_length = 0;
2467 log_error(LOG_LEVEL_CONNECT,
2468 "Flushed %ld bytes of request body while expecting %llu.",
2469 flushed, csp->expected_client_content_length);
2470 csp->expected_client_content_length -= (unsigned)flushed;
2471 if (receive_and_send_encrypted_post_data(csp))
2479 log_error(LOG_LEVEL_CONNECT,
2480 "Flushed %ld bytes of request body.", flushed);
2484 log_error(LOG_LEVEL_CONNECT, "Encrypted request sent.");
2491 /*********************************************************************
2493 * Function : receive_encrypted_request_headers
2495 * Description : Receives the encrypted request headers when
2499 * 1 : csp = Current client state (buffers, headers, etc...)
2501 * Returns : JB_ERR_OK on success,
2502 * JB_ERR_PARSE or JB_ERR_MEMORY otherwise
2504 *********************************************************************/
2505 static jb_err receive_encrypted_request_headers(struct client_state *csp)
2507 char buf[BUFFER_SIZE];
2513 log_error(LOG_LEVEL_HEADER, "Waiting for encrypted client headers.");
2514 if (!is_ssl_pending(&(csp->ssl_client_attr)) &&
2515 !data_is_available(csp->cfd, csp->config->socket_timeout))
2517 log_error(LOG_LEVEL_CONNECT,
2518 "Socket %d timed out while waiting for client headers.", csp->cfd);
2519 return JB_ERR_PARSE;
2521 len = ssl_recv_data(&(csp->ssl_client_attr),
2522 (unsigned char *)buf, sizeof(buf));
2525 log_error(LOG_LEVEL_CONNECT,
2526 "Socket %d closed while waiting for client headers.", csp->cfd);
2527 return JB_ERR_PARSE;
2531 return JB_ERR_PARSE;
2533 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
2535 return JB_ERR_MEMORY;
2537 p = strstr(csp->client_iob->cur, "\r\n\r\n");
2538 } while (p == NULL);
2540 log_error(LOG_LEVEL_HEADER, "Encrypted headers received completely.");
2546 /*********************************************************************
2548 * Function : change_encrypted_request_destination
2550 * Description : Parse a (rewritten) request line from an encrypted
2551 * request and regenerate the http request data.
2554 * 1 : csp = Current client state (buffers, headers, etc...)
2556 * Returns : Forwards the parse_http_request() return code.
2557 * Terminates in case of memory problems.
2559 *********************************************************************/
2560 static jb_err change_encrypted_request_destination(struct client_state *csp)
2563 char *original_host = csp->http->host;
2564 int original_port = csp->http->port;
2566 log_error(LOG_LEVEL_REDIRECTS, "Rewrite detected: %s",
2567 csp->https_headers->first->str);
2568 csp->http->host = NULL;
2569 free_http_request(csp->http);
2570 err = parse_http_request(csp->https_headers->first->str, csp->http);
2571 if (JB_ERR_OK != err)
2573 log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
2574 jb_err_to_string(err));
2575 freez(original_host);
2579 if (csp->http->host == NULL)
2581 char port_string[10];
2583 * The rewritten request line did not specify a host
2584 * which means we can use the original host specified
2587 csp->http->host = original_host;
2588 csp->http->port = original_port;
2589 log_error(LOG_LEVEL_REDIRECTS, "Keeping the original host: %s",
2592 * If the rewritten request line didn't contain a host
2593 * it also didn't contain a port so we can reuse the host
2596 freez(csp->http->hostport);
2597 csp->http->hostport = strdup_or_die(csp->http->host);
2598 snprintf(port_string, sizeof(port_string), ":%d", original_port);
2599 err = string_append(&csp->http->hostport, port_string);
2600 if (err != JB_ERR_OK)
2602 log_error(LOG_LEVEL_ERROR, "Failed to rebuild hostport: %s.",
2603 jb_err_to_string(err));
2608 * While the request line didn't mention it,
2609 * we're https-inspecting and want to speak TLS
2612 csp->http->server_ssl = 1;
2617 /* The rewrite filter added a host so we can ditch the original */
2618 freez(original_host);
2619 csp->http->server_ssl = csp->http->ssl;
2622 csp->http->client_ssl = 1;
2624 freez(csp->https_headers->first->str);
2625 build_request_line(csp, NULL, &csp->https_headers->first->str);
2627 if (!server_use_ssl(csp))
2629 log_error(LOG_LEVEL_REDIRECTS,
2630 "Rewritten request line results in downgrade to http");
2632 * Replace the unencryptd headers received with the
2633 * CONNECT request with the ones we received securely.
2635 destroy_list(csp->headers);
2636 csp->headers->first = csp->https_headers->first;
2637 csp->headers->last = csp->https_headers->last;
2638 csp->https_headers->first = NULL;
2639 csp->https_headers->last = NULL;
2647 /*********************************************************************
2649 * Function : process_encrypted_request_headers
2651 * Description : Receives and parses the encrypted headers send
2652 * by the client when https-inspecting.
2655 * 1 : csp = Current client state (buffers, headers, etc...)
2657 * Returns : JB_ERR_OK on success,
2658 * JB_ERR_PARSE or JB_ERR_MEMORY otherwise
2660 *********************************************************************/
2661 static jb_err process_encrypted_request_headers(struct client_state *csp)
2666 /* Temporary copy of the client's headers before they get enlisted in csp->https_headers */
2667 struct list header_list;
2668 struct list *headers = &header_list;
2670 assert(csp->ssl_with_client_is_opened);
2672 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2673 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
2675 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
2678 err = receive_encrypted_request_headers(csp);
2679 if (err != JB_ERR_OK)
2681 if (csp->client_iob->cur == NULL ||
2682 csp->client_iob->cur == csp->client_iob->eod)
2685 * We did not receive any data, most likely because the
2686 * client is done. Don't log this as a parse failure.
2688 return JB_ERR_PARSE;
2690 /* XXX: Also used for JB_ERR_MEMORY */
2691 log_error(LOG_LEVEL_ERROR, "Failed to receive encrypted request: %s",
2692 jb_err_to_string(err));
2693 ssl_send_data_delayed(&(csp->ssl_client_attr),
2694 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2698 /* We don't need get_request_line() because the whole HTTP head is buffered. */
2699 request_line = get_header(csp->client_iob);
2700 if (request_line == NULL)
2702 log_error(LOG_LEVEL_ERROR, "Failed to get the encrypted request line");
2703 ssl_send_data_delayed(&(csp->ssl_client_attr),
2704 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2705 return JB_ERR_PARSE;
2707 assert(*request_line != '\0');
2709 if (client_protocol_is_unsupported(csp, request_line))
2712 * If the protocol is unsupported we're done here.
2713 * client_protocol_is_unsupported() took care of sending
2714 * the error response and logging the error message.
2716 return JB_ERR_PARSE;
2719 #ifdef FEATURE_FORCE_LOAD
2720 if (force_required(csp, request_line))
2722 csp->flags |= CSP_FLAG_FORCED;
2724 #endif /* def FEATURE_FORCE_LOAD */
2726 free_http_request(csp->http);
2728 err = parse_http_request(request_line, csp->http);
2729 /* XXX: Restore ssl setting. This is ugly */
2730 csp->http->client_ssl = 1;
2731 csp->http->server_ssl = 1;
2733 freez(request_line);
2734 if (JB_ERR_OK != err)
2736 ssl_send_data_delayed(&(csp->ssl_client_attr),
2737 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2738 /* XXX: Use correct size */
2739 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
2740 log_error(LOG_LEVEL_ERROR,
2741 "Couldn't parse request line received from %s: %s",
2742 csp->ip_addr_str, jb_err_to_string(err));
2744 free_http_request(csp->http);
2745 return JB_ERR_PARSE;
2748 /* Parse the rest of the client's headers. */
2752 p = get_header(csp->client_iob);
2756 /* There are no additional headers to read. */
2763 if (JB_ERR_OK != get_destination_from_https_headers(headers, csp->http))
2766 * Our attempts to get the request destination
2769 log_error(LOG_LEVEL_ERROR,
2770 "Failed to get the encrypted request destination");
2771 ssl_send_data_delayed(&(csp->ssl_client_attr),
2772 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2773 destroy_list(headers);
2775 return JB_ERR_PARSE;
2778 /* Split the domain we just got for pattern matching */
2779 init_domain_components(csp->http);
2781 #ifdef FEATURE_CLIENT_TAGS
2782 /* XXX: If the headers were enlisted sooner, passing csp would do. */
2783 if (csp->client_address == NULL)
2785 set_client_address(csp, headers);
2786 get_tag_list_for_client(csp->client_tags, csp->client_address);
2790 #ifdef FEATURE_TOGGLE
2791 if ((csp->flags & CSP_FLAG_TOGGLED_ON) != 0)
2795 * Determine the actions for this request after
2796 * clearing the ones from the previous one.
2798 free_current_action(csp->action);
2799 get_url_actions(csp, csp->http);
2802 enlist(csp->https_headers, csp->http->cmd);
2804 /* Append the previously read headers */
2805 err = list_append_list_unique(csp->https_headers, headers);
2806 destroy_list(headers);
2807 if (JB_ERR_OK != err)
2809 /* XXX: Send error message */
2813 /* XXX: Work around crash */
2814 csp->error_message = NULL;
2816 /* XXX: Why do this here? */
2819 err = sed_https(csp);
2820 if (JB_ERR_OK != err)
2822 ssl_send_data_delayed(&(csp->ssl_client_attr),
2823 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2824 log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
2826 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
2827 csp->ip_addr_str, csp->http->cmd);
2828 return JB_ERR_PARSE;
2831 if ((NULL == csp->https_headers->first->str)
2832 || (strcmp(csp->http->cmd, csp->https_headers->first->str) &&
2833 (JB_ERR_OK != change_encrypted_request_destination(csp))))
2835 ssl_send_data_delayed(&(csp->ssl_client_attr),
2836 (const unsigned char *)MESSED_UP_REQUEST_RESPONSE,
2837 strlen(MESSED_UP_REQUEST_RESPONSE), get_write_delay(csp));
2838 log_error(LOG_LEVEL_ERROR,
2839 "Invalid request line after applying header filters.");
2840 /* XXX: Use correct size */
2841 log_error(LOG_LEVEL_CLF,
2842 "%s - - [%T] \"Invalid request generated\" 400 0", csp->ip_addr_str);
2844 return JB_ERR_PARSE;
2847 log_error(LOG_LEVEL_HEADER, "Encrypted request headers processed");
2848 log_error(LOG_LEVEL_REQUEST, "https://%s%s", csp->http->hostport,
2855 /*********************************************************************
2857 * Function : cgi_page_requested
2859 * Description : Checks if a request is for an internal CGI page.
2862 * 1 : host = The host requested by the client.
2864 * Returns : 1 if a CGI page has been requested, 0 otherwise
2866 *********************************************************************/
2867 static int cgi_page_requested(const char *host)
2869 if ((0 == strcmpic(host, CGI_SITE_1_HOST))
2870 || (0 == strcmpic(host, CGI_SITE_1_HOST "."))
2871 || (0 == strcmpic(host, CGI_SITE_2_HOST))
2872 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")))
2882 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2883 /*********************************************************************
2885 * Function : continue_https_chat
2887 * Description : Behaves similar to chat() but only deals with
2888 * https-inspected requests that arrive on an already
2889 * established connection. The first request is always
2890 * served by chat() which is a lot more complex as it
2891 * has to deal with forwarding settings and connection
2894 * If a connection to the server has already been
2895 * opened it is reused unless the request is blocked
2896 * or the forwarder changed.
2898 * If a connection to the server has not yet been
2899 * opened (because the previous request was crunched),
2900 * or the forwarder changed, the connection is dropped
2901 * so that the client retries on a fresh one.
2904 * 1 : csp = Current client state (buffers, headers, etc...)
2906 * Returns : Nothing.
2908 *********************************************************************/
2909 static void continue_https_chat(struct client_state *csp)
2911 const struct forward_spec *fwd;
2913 if (JB_ERR_OK != process_encrypted_request_headers(csp))
2915 csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
2919 #if defined(FEATURE_STATISTICS) && defined(MUTEX_LOCKS_AVAILABLE)
2920 privoxy_mutex_lock(&block_statistics_mutex);
2921 number_of_requests_received++;
2922 privoxy_mutex_unlock(&block_statistics_mutex);
2925 csp->requests_received_total++;
2928 * We have an encrypted request. Check if one of the crunchers wants it.
2930 if (crunch_response_triggered(csp, crunchers_all))
2933 * Yes. The client got the crunch response and we're done here.
2937 if (csp->ssl_with_server_is_opened == 0)
2939 log_error(LOG_LEVEL_CONNECT,
2940 "Dropping the client connection on socket %d. "
2941 "The server connection has not been established yet.",
2943 csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
2946 assert(csp->server_connection.sfd != JB_INVALID_SOCKET);
2948 if (csp->expected_client_content_length != 0 &&
2949 (client_body_filters_enabled(csp->action) ||
2950 client_body_taggers_enabled(csp->action)) &&
2951 can_buffer_request_body(csp))
2953 int content_modified;
2955 if (read_https_request_body(csp))
2960 if (client_body_taggers_enabled(csp->action))
2962 execute_client_body_taggers(csp, csp->expected_client_content_length);
2963 if (crunch_response_triggered(csp, crunchers_all))
2966 * Yes. The client got the crunch response and we're done here.
2971 if (client_body_filters_enabled(csp->action))
2973 size_t modified_content_length = csp->expected_client_content_length;
2974 content_modified = execute_client_body_filters(csp,
2975 &modified_content_length);
2976 if ((content_modified == 1) &&
2977 (modified_content_length != csp->expected_client_content_length) &&
2978 update_client_headers(csp, modified_content_length))
2980 /* XXX: Send error response */
2981 log_error(LOG_LEVEL_HEADER, "Error updating client headers");
2985 csp->expected_client_content_length = 0;
2988 fwd = forward_url(csp, csp->http);
2989 if (!connection_destination_matches(&csp->server_connection, csp->http, fwd))
2991 log_error(LOG_LEVEL_CONNECT,
2992 "Dropping the client connection on socket %d with "
2993 "server socket %d connected to %s. The forwarder has changed.",
2994 csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
2995 csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
2999 log_applied_actions(csp->action);
3001 log_error(LOG_LEVEL_CONNECT,
3002 "Reusing server socket %d connected to %s. Requests already sent: %u.",
3003 csp->server_connection.sfd, csp->server_connection.host,
3004 csp->server_connection.requests_sent_total);
3006 if (send_https_request(csp))
3009 * Most likely the server connection timed out. We can't easily
3010 * create a new one so simply drop the client connection without a
3011 * error response to let the client retry.
3013 log_error(LOG_LEVEL_CONNECT,
3014 "Dropping client connection on socket %d. "
3015 "Forwarding the encrypted client request failed.",
3019 csp->server_connection.request_sent = time(NULL);
3020 csp->server_connection.requests_sent_total++;
3021 handle_established_connection(csp);
3022 freez(csp->receive_buffer);
3024 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3028 /*********************************************************************
3030 * Function : send_server_headers
3032 * Description : Sends the server headers to the client.
3035 * 1 : csp = Current client state (buffers, headers, etc...)
3037 * Returns : 0 on succes, -1 on error.
3039 *********************************************************************/
3040 static int send_server_headers(struct client_state *csp)
3042 char *server_headers;
3045 server_headers = list_to_text(csp->headers);
3046 if (server_headers == NULL)
3049 * Memory is too tight to even generate the header.
3050 * Send our static "Out-of-memory" page.
3052 log_error(LOG_LEVEL_ERROR,
3053 "Out of memory while trying to send server headers.");
3054 send_crunch_response(csp, cgi_error_memory());
3055 mark_server_socket_tainted(csp);
3056 #ifdef FEATURE_HTTPS_INSPECTION
3057 close_client_and_server_ssl_connections(csp);
3061 #ifdef FEATURE_HTTPS_INSPECTION
3062 if (client_use_ssl(csp))
3064 ret = ssl_send_data_delayed(&(csp->ssl_client_attr),
3065 (const unsigned char *)server_headers, strlen(server_headers),
3066 get_write_delay(csp));
3071 ret = write_socket_delayed(csp->cfd, server_headers, strlen(server_headers),
3072 get_write_delay(csp));
3074 freez(server_headers);
3077 log_error(LOG_LEVEL_ERROR, "Failed to send server headers to the client.");
3078 mark_server_socket_tainted(csp);
3079 #ifdef FEATURE_HTTPS_INSPECTION
3080 close_client_and_server_ssl_connections(csp);
3089 /*********************************************************************
3091 * Function : handle_established_connection
3093 * Description : Shuffle data between client and server once the
3094 * connection has been established and the request
3098 * 1 : csp = Current client state (buffers, headers, etc...)
3100 * Returns : Nothing.
3102 *********************************************************************/
3103 static void handle_established_connection(struct client_state *csp)
3108 struct pollfd poll_fds[2];
3112 struct timeval timeout;
3115 int ms_iis5_hack = 0;
3116 unsigned long long byte_count = 0;
3117 struct http_request *http;
3118 long len = 0; /* for buffer sizes (and negative error codes) */
3119 int buffer_and_filter_content = 0;
3120 unsigned int write_delay;
3121 size_t chunk_offset = 0;
3122 #ifdef FEATURE_HTTPS_INSPECTION
3124 int use_ssl_tunnel = 0;
3125 csp->dont_verify_certificate = 0;
3127 if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION))
3129 /* Pass encrypted content without filtering. */
3134 /* Skeleton for HTTP response, if we should intercept the request */
3135 struct http_response *rsp;
3136 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3137 int watch_client_socket;
3140 csp->receive_buffer_size = csp->config->receive_buffer_size;
3141 csp->receive_buffer = zalloc(csp->receive_buffer_size + 1);
3142 if (csp->receive_buffer == NULL)
3144 log_error(LOG_LEVEL_ERROR,
3145 "Out of memory. Failed to allocate the receive buffer.");
3146 rsp = cgi_error_memory();
3147 send_crunch_response(csp, rsp);
3154 maxfd = (csp->cfd > csp->server_connection.sfd) ?
3155 csp->cfd : csp->server_connection.sfd;
3158 /* pass data between the client and server
3159 * until one or the other shuts down the connection.
3164 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3165 watch_client_socket = 0 == (csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING);
3167 write_delay = get_write_delay(csp);
3171 #ifdef FEATURE_HTTPS_INSPECTION
3172 if (server_use_ssl(csp) && is_ssl_pending(&(csp->ssl_server_attr)))
3175 * It's possible that the TLS library already consumed all the
3176 * data the server intends to send. If that happens poll() and
3177 * select() will no longer see the data as available so we have
3178 * to skip the calls.
3180 goto server_wants_to_talk;
3182 if (watch_client_socket && client_use_ssl(csp) &&
3183 is_ssl_pending(&(csp->ssl_client_attr)))
3186 * The TLS libray may also consume all of the remaining data
3187 * from the client when we're shuffling the data from an
3188 * unbuffered request body to the server.
3190 goto client_wants_to_talk;
3195 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3196 if (!watch_client_socket)
3198 maxfd = csp->server_connection.sfd;
3201 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3203 FD_SET(csp->cfd, &rfds);
3206 FD_SET(csp->server_connection.sfd, &rfds);
3207 #endif /* ndef HAVE_POLL */
3209 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3210 if (server_body && server_response_is_complete(csp, byte_count))
3212 if (csp->expected_content_length == byte_count)
3214 log_error(LOG_LEVEL_CONNECT,
3215 "Done reading from server. Content length: %llu as expected. "
3216 "Bytes most recently read: %ld.",
3221 log_error(LOG_LEVEL_CONNECT,
3222 "Done reading from server. Expected content length: %llu. "
3223 "Actual content length: %llu. Bytes most recently read: %ld.",
3224 csp->expected_content_length, byte_count, len);
3228 * XXX: Should not jump around, handle_established_connection()
3229 * is complicated enough already.
3233 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
3236 poll_fds[0].fd = csp->cfd;
3237 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3238 if (!watch_client_socket)
3241 * Ignore incoming data, but still watch out
3242 * for disconnects etc. These flags are always
3243 * implied anyway but explicitly setting them
3246 poll_fds[0].events = POLLERR|POLLHUP;
3251 poll_fds[0].events = POLLIN;
3253 poll_fds[1].fd = csp->server_connection.sfd;
3254 poll_fds[1].events = POLLIN;
3255 n = poll(poll_fds, 2, csp->config->socket_timeout * 1000);
3257 timeout.tv_sec = csp->config->socket_timeout;
3258 timeout.tv_usec = 0;
3259 n = select((int)maxfd + 1, &rfds, NULL, NULL, &timeout);
3260 #endif /* def HAVE_POLL */
3262 /* Server or client not responding in timeout */
3265 log_error(LOG_LEVEL_CONNECT, "Socket timeout %d reached: %s",
3266 csp->config->socket_timeout, http->url);
3267 if ((byte_count == 0) && (http->ssl == 0))
3269 send_crunch_response(csp, error_response(csp, "connection-timeout"));
3271 mark_server_socket_tainted(csp);
3272 #ifdef FEATURE_HTTPS_INSPECTION
3273 close_client_and_server_ssl_connections(csp);
3280 log_error(LOG_LEVEL_ERROR, "poll() failed!: %E");
3282 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
3284 mark_server_socket_tainted(csp);
3285 #ifdef FEATURE_HTTPS_INSPECTION
3286 close_client_and_server_ssl_connections(csp);
3292 * This is the body of the browser's request,
3293 * just read and write it.
3295 * Receives data from browser and sends it to server
3297 * XXX: Make sure the client doesn't use pipelining
3298 * behind Privoxy's back.
3301 if ((poll_fds[0].revents & (POLLERR|POLLHUP|POLLNVAL)) != 0)
3303 log_error(LOG_LEVEL_CONNECT,
3304 "The client socket %d has become unusable while "
3305 "the server socket %d is still open.",
3306 csp->cfd, csp->server_connection.sfd);
3307 mark_server_socket_tainted(csp);
3311 if (poll_fds[0].revents != 0)
3313 if (FD_ISSET(csp->cfd, &rfds))
3314 #endif /* def HAVE_POLL*/
3316 int max_bytes_to_read;
3318 #ifdef FEATURE_HTTPS_INSPECTION
3319 client_wants_to_talk:
3322 max_bytes_to_read = (int)csp->receive_buffer_size;
3324 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3325 if ((csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ))
3327 if (data_is_available(csp->cfd, 0))
3330 * If the next request is already waiting, we have
3331 * to stop select()ing the client socket. Otherwise
3332 * we would always return right away and get nothing
3335 watch_client_socket = 0;
3336 log_error(LOG_LEVEL_CONNECT,
3337 "Stop watching client socket %d. "
3338 "There's already another request waiting.",
3343 * If the client socket is set, but there's no data
3344 * available on the socket, the client went fishing
3345 * and continuing talking to the server makes no sense.
3347 log_error(LOG_LEVEL_CONNECT,
3348 "The client closed socket %d while "
3349 "the server socket %d is still open.",
3350 csp->cfd, csp->server_connection.sfd);
3351 mark_server_socket_tainted(csp);
3354 if (csp->expected_client_content_length != 0)
3356 if (csp->expected_client_content_length < csp->receive_buffer_size)
3358 max_bytes_to_read = (int)csp->expected_client_content_length;
3360 log_error(LOG_LEVEL_CONNECT,
3361 "Waiting for up to %d bytes from the client.",
3364 assert(max_bytes_to_read <= csp->receive_buffer_size);
3365 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3367 #ifdef FEATURE_HTTPS_INSPECTION
3368 if (client_use_ssl(csp))
3370 if (csp->http->status == 101)
3372 len = ssl_recv_data(&(csp->ssl_client_attr),
3373 (unsigned char *)csp->receive_buffer,
3374 (size_t)max_bytes_to_read);
3377 log_error(LOG_LEVEL_ERROR, "Failed to receive data "
3378 "on client socket %d for an upgraded connection",
3384 log_error(LOG_LEVEL_CONNECT, "Done receiving data "
3385 "on client socket %d for an upgraded connection",
3389 byte_count += (unsigned long long)len;
3390 len = ssl_send_data(&(csp->ssl_server_attr),
3391 (unsigned char *)csp->receive_buffer, (size_t)len);
3394 log_error(LOG_LEVEL_ERROR, "Failed to send data "
3395 "on server socket %d for an upgraded connection",
3396 csp->server_connection.sfd);
3401 log_error(LOG_LEVEL_CONNECT, "Breaking with TLS/SSL.");
3405 #endif /* def FEATURE_HTTPS_INSPECTION */
3407 len = read_socket(csp->cfd, csp->receive_buffer, max_bytes_to_read);
3411 /* XXX: not sure if this is necessary. */
3412 mark_server_socket_tainted(csp);
3413 break; /* "game over, man" */
3416 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3417 if (csp->expected_client_content_length != 0)
3419 assert(len <= max_bytes_to_read);
3420 csp->expected_client_content_length -= (unsigned)len;
3421 log_error(LOG_LEVEL_CONNECT,
3422 "Expected client content length set to %llu "
3423 "after reading %ld bytes.",
3424 csp->expected_client_content_length, len);
3425 if (csp->expected_client_content_length == 0)
3427 log_error(LOG_LEVEL_CONNECT,
3428 "Done reading from the client.");
3429 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
3432 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3434 if (write_socket(csp->server_connection.sfd, csp->receive_buffer, (size_t)len))
3436 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
3437 mark_server_socket_tainted(csp);
3445 * The server wants to talk. It could be the header or the body.
3448 if (poll_fds[1].revents != 0)
3450 if (FD_ISSET(csp->server_connection.sfd, &rfds))
3451 #endif /* HAVE_POLL */
3453 #ifdef FEATURE_HTTPS_INSPECTION
3454 server_wants_to_talk:
3456 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3458 * If we are buffering content, we don't want to eat up to
3459 * buffer-limit bytes if the client no longer cares about them.
3460 * If we aren't buffering, however, a dead client socket will be
3461 * noticed pretty much right away anyway, so we can reduce the
3462 * overhead by skipping the check.
3464 if (buffer_and_filter_content && !socket_is_still_alive(csp->cfd))
3467 log_error(LOG_LEVEL_CONNECT,
3468 "The server still wants to talk, but the client may already have hung up on us.");
3470 log_error(LOG_LEVEL_CONNECT,
3471 "The server still wants to talk, but the client hung up on us.");
3472 mark_server_socket_tainted(csp);
3473 #ifdef FEATURE_HTTPS_INSPECTION
3474 close_client_and_server_ssl_connections(csp);
3477 #endif /* def _WIN32 */
3479 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3481 #ifdef FEATURE_HTTPS_INSPECTION
3483 * Reading data from standard or secured connection (HTTP/HTTPS)
3485 if (server_use_ssl(csp))
3487 len = ssl_recv_data(&(csp->ssl_server_attr),
3488 (unsigned char *)csp->receive_buffer, csp->receive_buffer_size);
3493 len = read_socket(csp->server_connection.sfd, csp->receive_buffer,
3494 (int)csp->receive_buffer_size);
3499 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
3501 if ((http->ssl && (csp->fwd == NULL))
3502 #ifdef FEATURE_HTTPS_INSPECTION
3508 * Just hang up. We already confirmed the client's CONNECT
3509 * request with status code 200 and unencrypted content is
3510 * no longer welcome.
3512 log_error(LOG_LEVEL_ERROR,
3513 "CONNECT already confirmed. Unable to tell the client about the problem.");
3516 else if (byte_count)
3519 * Just hang up. We already transmitted the original headers
3520 * and parts of the original content and therefore missed the
3521 * chance to send an error message (without risking data corruption).
3523 * XXX: we could retry with a fancy range request here.
3525 log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
3526 "Unable to tell the client about the problem.");
3527 mark_server_socket_tainted(csp);
3528 #ifdef FEATURE_HTTPS_INSPECTION
3529 close_client_and_server_ssl_connections(csp);
3534 * XXX: Consider handling the cases above the same.
3536 mark_server_socket_tainted(csp);
3540 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3542 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
3545 * This is guaranteed by allocating with zalloc_or_die()
3546 * and never (intentionally) writing to the last byte.
3548 * csp->receive_buffer_size is the size of the part of the
3549 * buffer we intentionally write to, but we actually
3550 * allocated csp->receive_buffer_size+1 bytes so the assertion
3551 * stays within the allocated range.
3553 assert(csp->receive_buffer[csp->receive_buffer_size] == '\0');
3556 * Add a trailing zero to let be able to use string operations.
3557 * XXX: do we still need this with filter_popups gone?
3559 assert(len <= csp->receive_buffer_size);
3560 csp->receive_buffer[len] = '\0';
3563 * Normally, this would indicate that we've read
3564 * as much as the server has sent us and we can
3565 * close the client connection. However, Microsoft
3566 * in its wisdom has released IIS/5 with a bug that
3567 * prevents it from sending the trailing \r\n in
3568 * a 302 redirect header (and possibly other headers).
3569 * To work around this if we've haven't parsed
3570 * a full header we'll append a trailing \r\n
3571 * and see if this now generates a valid one.
3573 * This hack shouldn't have any impacts. If we've
3574 * already transmitted the header or if this is a
3575 * SSL connection, then we won't bother with this
3576 * hack. So we only work on partially received
3577 * headers. If we append a \r\n and this still
3578 * doesn't generate a valid header, then we won't
3579 * transmit anything to the client.
3584 if (server_body || (http->ssl
3585 #ifdef FEATURE_HTTPS_INSPECTION
3591 * If we have been buffering up the document,
3592 * now is the time to apply content modification
3593 * and send the result to the client.
3595 if (buffer_and_filter_content)
3597 p = execute_content_filters(csp);
3599 * If content filtering fails, use the original
3600 * buffer and length.
3601 * (see p != NULL ? p : csp->iob->cur below)
3605 csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
3607 #ifdef FEATURE_COMPRESSION
3608 else if ((csp->flags & CSP_FLAG_CLIENT_SUPPORTS_DEFLATE)
3609 && (csp->content_length > LOWER_LENGTH_LIMIT_FOR_COMPRESSION))
3611 char *compressed_content = compress_buffer(p,
3612 (size_t *)&csp->content_length, csp->config->compression_level);
3613 if (compressed_content != NULL)
3616 p = compressed_content;
3617 csp->flags |= CSP_FLAG_BUFFERED_CONTENT_DEFLATED;
3622 if (JB_ERR_OK != update_server_headers(csp))
3624 log_error(LOG_LEVEL_FATAL,
3625 "Failed to update server headers. after filtering.");
3628 if (send_server_headers(csp))
3633 #ifdef FEATURE_HTTPS_INSPECTION
3635 * Sending data with standard or secured connection (HTTP/HTTPS)
3637 if (client_use_ssl(csp))
3639 if (ssl_send_data_delayed(&(csp->ssl_client_attr),
3640 (const unsigned char *) ((p != NULL) ? p : csp->iob->cur),
3641 csp->content_length, get_write_delay(csp)) < 0)
3643 log_error(LOG_LEVEL_ERROR,
3644 "Failed to send the modified content to the client over TLS");
3646 mark_server_socket_tainted(csp);
3647 close_client_and_server_ssl_connections(csp);
3652 #endif /* def FEATURE_HTTPS_INSPECTION */
3654 if (write_socket_delayed(csp->cfd, ((p != NULL) ? p : csp->iob->cur),
3655 (size_t)csp->content_length, write_delay))
3657 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
3659 mark_server_socket_tainted(csp);
3667 break; /* "game over, man" */
3671 * This is not the body, so let's pretend the server just sent
3674 snprintf(csp->receive_buffer, csp->receive_buffer_size, "\r\n");
3675 len = (int)strlen(csp->receive_buffer);
3678 * Now, let the normal header parsing algorithm below do its
3679 * job. If it fails, we'll exit instead of continuing.
3686 * If we're in the body of the server document, just write it to
3687 * the client, unless we need to buffer the body for later
3688 * content-filtering.
3690 if (server_body || (http->ssl
3691 #ifdef FEATURE_HTTPS_INSPECTION
3696 if (buffer_and_filter_content)
3699 * If there is no memory left for buffering the content, or the buffer limit
3700 * has been reached, switch to non-filtering mode, i.e. make & write the
3701 * header, flush the iob and buf, and get out of the way.
3703 if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3707 log_error(LOG_LEVEL_INFO,
3708 "Flushing header and buffers. Stepping back from filtering.");
3710 if (send_server_headers(csp))
3715 #ifdef FEATURE_HTTPS_INSPECTION
3717 * Sending data with standard or secured connection (HTTP/HTTPS)
3719 if (client_use_ssl(csp))
3721 if (((flushed = ssl_flush_socket(&(csp->ssl_client_attr),
3723 || (ssl_send_data_delayed(&(csp->ssl_client_attr),
3724 (const unsigned char *)csp->receive_buffer, (size_t)len,
3725 get_write_delay(csp)) < 0))
3727 log_error(LOG_LEVEL_CONNECT,
3728 "Flush header and buffers to client failed");
3729 mark_server_socket_tainted(csp);
3730 close_client_and_server_ssl_connections(csp);
3735 #endif /* def FEATURE_HTTPS_INSPECTION */
3737 if (((flushed = flush_iob(csp->cfd, csp->iob, write_delay)) < 0)
3738 || write_socket_delayed(csp->cfd, csp->receive_buffer, (size_t)len,
3741 log_error(LOG_LEVEL_CONNECT,
3742 "Flush header and buffers to client failed: %E");
3743 mark_server_socket_tainted(csp);
3749 * Reset the byte_count to the amount of bytes we just
3750 * flushed. len will be added a few lines below.
3752 byte_count = (unsigned long long)flushed;
3753 if ((csp->flags & CSP_FLAG_CHUNKED) && (chunk_offset != 0))
3755 log_error(LOG_LEVEL_CONNECT,
3756 "Reducing chunk offset %lu by %ld to %lu.", chunk_offset, flushed,
3757 (chunk_offset - (unsigned)flushed));
3758 assert(chunk_offset >= flushed); /* XXX: Reachable with malicious input? */
3759 chunk_offset -= (unsigned)flushed;
3761 /* Make room in the iob. */
3762 csp->iob->cur = csp->iob->eod = csp->iob->buf;
3764 if (add_to_iob(csp->iob, csp->config->buffer_limit,
3765 csp->receive_buffer, len))
3767 /* This is not supposed to happen but ... */
3768 csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
3769 log_error(LOG_LEVEL_ERROR, "Failed to buffer %ld bytes of "
3770 "chunk-encoded data after resetting the buffer.", len);
3774 buffer_and_filter_content = 0;
3780 #ifdef FEATURE_HTTPS_INSPECTION
3782 * Sending data with standard or secured connection (HTTP/HTTPS)
3784 if (client_use_ssl(csp))
3786 ret = ssl_send_data_delayed(&(csp->ssl_client_attr),
3787 (const unsigned char *)csp->receive_buffer, (size_t)len,
3788 get_write_delay(csp));
3791 log_error(LOG_LEVEL_ERROR,
3792 "Sending data to client failed");
3793 mark_server_socket_tainted(csp);
3794 close_client_and_server_ssl_connections(csp);
3799 #endif /* def FEATURE_HTTPS_INSPECTION */
3801 if (write_socket_delayed(csp->cfd, csp->receive_buffer,
3802 (size_t)len, write_delay))
3804 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
3805 mark_server_socket_tainted(csp);
3809 if (csp->flags & CSP_FLAG_CHUNKED)
3812 * While we don't need the data to filter it, put it in the
3813 * buffer so we can keep track of the offset to the start of
3814 * the next chunk and detect when the response is finished.
3816 size_t encoded_bytes = (size_t)(csp->iob->eod - csp->iob->cur);
3818 if (csp->config->buffer_limit / 4 < encoded_bytes)
3821 * Reset the buffer to reduce the memory footprint.
3823 log_error(LOG_LEVEL_CONNECT,
3824 "Reducing the chunk offset from %lu to %lu after "
3825 "discarding %lu bytes to make room in the buffer.",
3826 chunk_offset, (chunk_offset - encoded_bytes),
3828 chunk_offset -= encoded_bytes;
3829 csp->iob->cur = csp->iob->eod = csp->iob->buf;
3831 if (add_to_iob(csp->iob, csp->config->buffer_limit,
3832 csp->receive_buffer, len))
3834 /* This is not supposed to happen but ... */
3835 csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
3836 log_error(LOG_LEVEL_ERROR,
3837 "Failed to buffer %ld bytes of chunk-encoded data.",
3843 byte_count += (unsigned long long)len;
3845 if (csp->flags & CSP_FLAG_CHUNKED)
3848 size_t encoded_bytes = (size_t)(csp->iob->eod - csp->iob->cur);
3850 rc = get_bytes_missing_from_chunked_data(csp->iob->cur, encoded_bytes,
3856 chunk_offset = (size_t)rc;
3859 if (chunked_data_is_complete(csp->iob->cur, encoded_bytes, chunk_offset))
3861 log_error(LOG_LEVEL_CONNECT,
3862 "We buffered the last chunk of the response.");
3863 csp->expected_content_length = byte_count;
3864 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
3874 * We're still looking for the end of the server's header.
3875 * Buffer up the data we just read. If that fails, there's
3876 * little we can do but send our static out-of-memory page.
3878 if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3880 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
3881 rsp = cgi_error_memory();
3882 send_crunch_response(csp, rsp);
3883 mark_server_socket_tainted(csp);
3884 #ifdef FEATURE_HTTPS_INSPECTION
3885 close_client_and_server_ssl_connections(csp);
3890 /* Convert iob into something sed() can digest */
3891 if (JB_ERR_PARSE == get_server_headers(csp))
3896 * Well, we tried our MS IIS/5 hack and it didn't work.
3897 * The header is incomplete and there isn't anything
3898 * we can do about it.
3900 log_error(LOG_LEVEL_ERROR, "Invalid server headers. "
3901 "Applying the MS IIS5 hack didn't help.");
3902 log_error(LOG_LEVEL_CLF,
3903 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3904 #ifdef FEATURE_HTTPS_INSPECTION
3906 * Sending data with standard or secured connection (HTTP/HTTPS)
3908 if (client_use_ssl(csp))
3910 ssl_send_data_delayed(&(csp->ssl_client_attr),
3911 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3912 strlen(INVALID_SERVER_HEADERS_RESPONSE), get_write_delay(csp));
3915 #endif /* def FEATURE_HTTPS_INSPECTION */
3917 write_socket_delayed(csp->cfd,
3918 INVALID_SERVER_HEADERS_RESPONSE,
3919 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3921 mark_server_socket_tainted(csp);
3922 #ifdef FEATURE_HTTPS_INSPECTION
3923 close_client_and_server_ssl_connections(csp);
3930 * Since we have to wait for more from the server before
3931 * we can parse the headers we just continue here.
3933 log_error(LOG_LEVEL_CONNECT,
3934 "Continuing buffering server headers from socket %d. "
3935 "Bytes most recently read: %ld.", csp->cfd, len);
3942 * Account for the content bytes we
3943 * might have gotten with the headers.
3945 assert(csp->iob->eod >= csp->iob->cur);
3946 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3949 /* Did we actually get anything? */
3950 if (NULL == csp->headers->first)
3952 if ((csp->flags & CSP_FLAG_REUSED_CLIENT_CONNECTION))
3954 log_error(LOG_LEVEL_ERROR,
3955 "No server or forwarder response received on socket %d. "
3956 "Closing client socket %d without sending data.",
3957 csp->server_connection.sfd, csp->cfd);
3958 log_error(LOG_LEVEL_CLF,
3959 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3963 log_error(LOG_LEVEL_ERROR,
3964 "No server or forwarder response received on socket %d.",
3965 csp->server_connection.sfd);
3966 send_crunch_response(csp, error_response(csp, "no-server-data"));
3968 free_http_request(http);
3969 mark_server_socket_tainted(csp);
3970 #ifdef FEATURE_HTTPS_INSPECTION
3971 close_client_and_server_ssl_connections(csp);
3976 if (!csp->headers->first->str)
3978 log_error(LOG_LEVEL_ERROR, "header search: csp->headers->first->str == NULL, assert will be called");
3980 assert(csp->headers->first->str);
3982 if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
3983 strncmpic(csp->headers->first->str, "ICY", 3))
3986 * It doesn't look like a HTTP (or Shoutcast) response:
3987 * tell the client and log the problem.
3989 if (strlen(csp->headers->first->str) > 30)
3991 csp->headers->first->str[30] = '\0';
3993 log_error(LOG_LEVEL_ERROR,
3994 "Invalid server or forwarder response. Starts with: %s",
3995 csp->headers->first->str);
3996 log_error(LOG_LEVEL_CLF,
3997 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3998 #ifdef FEATURE_HTTPS_INSPECTION
4000 * Sending data with standard or secured connection (HTTP/HTTPS)
4002 if (client_use_ssl(csp))
4004 ssl_send_data_delayed(&(csp->ssl_client_attr),
4005 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
4006 strlen(INVALID_SERVER_HEADERS_RESPONSE),
4007 get_write_delay(csp));
4010 #endif /* def FEATURE_HTTPS_INSPECTION */
4012 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
4013 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
4015 free_http_request(http);
4016 mark_server_socket_tainted(csp);
4017 #ifdef FEATURE_HTTPS_INSPECTION
4018 close_client_and_server_ssl_connections(csp);
4024 * Disable redirect checkers, so that they will be only run
4025 * again if the user also enables them through tags.
4027 * From a performance point of view it doesn't matter,
4028 * but it prevents duplicated log messages.
4030 #ifdef FEATURE_FAST_REDIRECTS
4031 csp->action->flags &= ~ACTION_FAST_REDIRECTS;
4033 csp->action->flags &= ~ACTION_REDIRECT;
4036 * We have now received the entire server header,
4037 * filter it and send the result to the client
4039 if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
4041 log_error(LOG_LEVEL_CLF,
4042 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
4043 #ifdef FEATURE_HTTPS_INSPECTION
4045 * Sending data with standard or secured connection (HTTP/HTTPS)
4047 if (client_use_ssl(csp))
4049 ssl_send_data_delayed(&(csp->ssl_client_attr),
4050 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
4051 strlen(INVALID_SERVER_HEADERS_RESPONSE),
4052 get_write_delay(csp));
4057 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
4058 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
4060 free_http_request(http);
4061 mark_server_socket_tainted(csp);
4062 #ifdef FEATURE_HTTPS_INSPECTION
4063 close_client_and_server_ssl_connections(csp);
4068 if ((csp->flags & CSP_FLAG_CHUNKED)
4069 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET))
4072 size_t encoded_size = (size_t)(csp->iob->eod - csp->iob->cur);
4074 rc = get_bytes_missing_from_chunked_data(csp->iob->cur, encoded_size,
4080 chunk_offset = (size_t)rc;
4082 if (chunked_data_is_complete(csp->iob->cur, encoded_size, chunk_offset))
4084 log_error(LOG_LEVEL_CONNECT,
4085 "Looks like we got the last chunk together with "
4086 "the server headers. We better stop reading.");
4087 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
4088 csp->expected_content_length = byte_count;
4089 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
4093 csp->server_connection.response_received = time(NULL);
4095 if (crunch_response_triggered(csp, crunchers_light))
4098 * One of the tags created by a server-header
4099 * tagger triggered a crunch. We already
4100 * delivered the crunch response to the client
4101 * and are done here after cleaning up.
4103 mark_server_socket_tainted(csp);
4104 #ifdef FEATURE_HTTPS_INSPECTION
4105 close_client_and_server_ssl_connections(csp);
4110 /* Buffer and pcrs filter this if appropriate. */
4111 buffer_and_filter_content = content_requires_filtering(csp);
4113 if (!buffer_and_filter_content)
4116 * Write the server's (modified) header to
4117 * the client (along with anything else that
4118 * may be in the buffer). Use standard or secured
4121 if (send_server_headers(csp))
4125 #ifdef FEATURE_HTTPS_INSPECTION
4126 if (client_use_ssl(csp))
4128 if ((len = ssl_flush_socket(&(csp->ssl_client_attr),
4131 log_error(LOG_LEVEL_CONNECT,
4132 "Sending buffered bytes to the client failed");
4135 * The write failed, so don't bother mentioning it
4136 * to the client... it probably can't hear us anyway.
4138 mark_server_socket_tainted(csp);
4139 #ifdef FEATURE_HTTPS_INSPECTION
4140 close_client_and_server_ssl_connections(csp);
4146 #endif /* def FEATURE_HTTPS_INSPECTION */
4148 if ((len = flush_iob(csp->cfd, csp->iob, write_delay)) < 0)
4150 log_error(LOG_LEVEL_ERROR,
4151 "Sending buffered bytes to the client failed.");
4153 * The write failed, so don't bother mentioning it
4154 * to the client... it probably can't hear us anyway.
4156 mark_server_socket_tainted(csp);
4160 if (csp->flags & CSP_FLAG_CHUNKED &&
4161 !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET))
4164 * In case of valid data we shouldn't flush more
4165 * data than chunk_offset but the data may be invalid.
4167 if (chunk_offset >= len)
4169 log_error(LOG_LEVEL_CONNECT, "Reducing the chunk offset "
4170 "from %lu to %lu after flushing %ld bytes.",
4171 chunk_offset, (chunk_offset - (unsigned)len), len);
4172 chunk_offset = chunk_offset - (unsigned)len;
4176 log_error(LOG_LEVEL_CONNECT,
4177 "Keeping chunk offset at %lu despite flushing %ld bytes.",
4180 * If we can't parse the chunk-encoded data we should
4181 * not reuse the server connection.
4183 mark_server_socket_tainted(csp);
4188 /* we're finished with the server's header */
4193 * If this was a MS IIS/5 hack then it means the server
4194 * has already closed the connection. Nothing more to read.
4199 log_error(LOG_LEVEL_ERROR,
4200 "Closed server connection detected. "
4201 "Applying the MS IIS5 hack didn't help.");
4202 log_error(LOG_LEVEL_CLF,
4203 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
4204 #ifdef FEATURE_HTTPS_INSPECTION
4206 * Sending data with standard or secured connection (HTTP/HTTPS)
4208 if (client_use_ssl(csp))
4210 ssl_send_data_delayed(&(csp->ssl_client_attr),
4211 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
4212 strlen(INVALID_SERVER_HEADERS_RESPONSE),
4213 get_write_delay(csp));
4216 #endif /* def FEATURE_HTTPS_INSPECTION */
4218 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
4219 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
4221 mark_server_socket_tainted(csp);
4222 #ifdef FEATURE_HTTPS_INSPECTION
4223 close_client_and_server_ssl_connections(csp);
4230 mark_server_socket_tainted(csp);
4231 #ifdef FEATURE_HTTPS_INSPECTION
4232 close_client_and_server_ssl_connections(csp);
4234 return; /* huh? we should never get here */
4237 if (csp->content_length == 0)
4240 * If Privoxy didn't recalculate the Content-Length,
4241 * byte_count is still correct.
4243 csp->content_length = byte_count;
4246 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4247 if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
4248 && (csp->expected_content_length != byte_count))
4250 log_error(LOG_LEVEL_CONNECT,
4251 "Received %llu bytes while expecting %llu.",
4252 byte_count, csp->expected_content_length);
4253 mark_server_socket_tainted(csp);
4257 #ifdef FEATURE_HTTPS_INSPECTION
4258 if (client_use_ssl(csp))
4260 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s https://%s%s %s\" 200 %llu",
4261 csp->ip_addr_str, http->gpc, http->hostport, http->path,
4262 http->version, csp->content_length);
4267 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %llu",
4268 csp->ip_addr_str, http->ocmd, csp->content_length);
4270 csp->server_connection.timestamp = time(NULL);
4274 /*********************************************************************
4278 * Description : Once a connection from the client has been accepted,
4279 * this function is called (via serve()) to handle the
4280 * main business of the communication. This function
4281 * returns after dealing with a single request. It can
4282 * be called multiple times with the same client socket
4283 * if the client is keeping the connection alive.
4285 * The decision whether or not a client connection will
4286 * be kept alive is up to the caller which also must
4287 * close the client socket when done.
4289 * FIXME: chat is nearly thousand lines long.
4293 * 1 : csp = Current client state (buffers, headers, etc...)
4295 * Returns : Nothing.
4297 *********************************************************************/
4298 static void chat(struct client_state *csp)
4300 const struct forward_spec *fwd;
4301 struct http_request *http;
4302 /* Skeleton for HTTP response, if we should intercept the request */
4303 struct http_response *rsp;
4304 #ifdef FEATURE_HTTPS_INSPECTION
4305 int use_ssl_tunnel = 0;
4310 if (receive_client_request(csp) != JB_ERR_OK)
4315 #if defined(FEATURE_STATISTICS) && defined(MUTEX_LOCKS_AVAILABLE)
4316 privoxy_mutex_lock(&block_statistics_mutex);
4317 number_of_requests_received++;
4318 privoxy_mutex_unlock(&block_statistics_mutex);
4321 if (parse_client_request(csp) != JB_ERR_OK)
4326 #ifdef FEATURE_HTTPS_INSPECTION
4328 * Setting flags to use old solution with SSL tunnel and to disable
4329 * certificate verification.
4331 if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION)
4332 && !cgi_page_requested(csp->http->host))
4337 if (http->ssl && (csp->action->flags & ACTION_IGNORE_CERTIFICATE_ERRORS))
4339 csp->dont_verify_certificate = 1;
4344 * build the http request to send to the server
4345 * we have to do one of the following:
4347 * create = use the original HTTP request to create a new
4348 * HTTP request that has either the path component
4349 * without the http://domainspec (w/path) or the
4350 * full orininal URL (w/url)
4351 * Note that the path and/or the HTTP version may
4352 * have been altered by now.
4354 * SSL proxy = Open a socket to the host:port of the server
4355 * and create TLS/SSL connection with server and
4356 * with client. Then behave like mediator between
4357 * client and server over TLS/SSL.
4359 * SSL proxy = Pass the request unchanged if forwarding a CONNECT
4360 * with request to a parent proxy. Note that we'll be sending
4361 * forwarding the CFAIL message ourselves if connecting to the parent
4362 * fails, but we won't send a CSUCCEED message if it works,
4363 * since that would result in a double message (ours and the
4364 * parent's). After sending the request to the parent, we
4365 * must parse answer and send it to client. If connection
4366 * with server is established, we do TLS/SSL proxy. Otherwise
4367 * we send parent response to client and close connections.
4369 * here's the matrix:
4372 * +--------+--------+
4374 * 0 | create | SSL |
4375 * | w/path | proxy |
4376 * Forwarding +--------+--------+
4378 * 1 | create | proxy |
4379 * | w/url |+forward|
4380 * +--------+--------+
4384 #ifdef FEATURE_HTTPS_INSPECTION
4386 * Presetting SSL client and server flags
4388 if (http->ssl && !use_ssl_tunnel)
4390 http->client_ssl = 1;
4391 http->server_ssl = 1;
4395 http->client_ssl = 0;
4396 http->server_ssl = 0;
4400 #ifdef FEATURE_HTTPS_INSPECTION
4402 * Log the request unless we're https inspecting
4403 * in which case we don't have the path yet and
4404 * will log the request later.
4406 if (!client_use_ssl(csp))
4409 log_error(LOG_LEVEL_REQUEST, "%s%s", http->hostport, http->path);
4412 if (http->ssl && connect_port_is_forbidden(csp))
4414 const char *acceptable_connect_ports =
4415 csp->action->string[ACTION_STRING_LIMIT_CONNECT];
4416 assert(NULL != acceptable_connect_ports);
4417 log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
4418 "limit-connect{%s} doesn't allow CONNECT requests to %s",
4419 csp->ip_addr_str, acceptable_connect_ports, csp->http->hostport);
4420 csp->action->flags |= ACTION_BLOCK;
4422 #ifdef FEATURE_HTTPS_INSPECTION
4423 http->client_ssl = 0;
4424 http->server_ssl = 0;
4429 * We have a request. Check if one of the crunchers wants it
4430 * unless the client wants to use TLS/SSL in which case we
4431 * haven't setup the TLS context yet and will send the crunch
4435 #ifdef FEATURE_HTTPS_INSPECTION
4436 !client_use_ssl(csp) &&
4438 crunch_response_triggered(csp, crunchers_all))
4441 * Yes. The client got the crunch response and we're done here.
4446 #ifdef FEATURE_HTTPS_INSPECTION
4447 if (client_use_ssl(csp) && !use_ssl_tunnel)
4451 * Creating a SSL proxy.
4453 * By sending the CSUCCEED message we're lying to the client as
4454 * the connection hasn't actually been established yet. We don't
4455 * establish the connection until we have seen and parsed the
4456 * encrypted client headers.
4458 if (write_socket_delayed(csp->cfd, CSUCCEED,
4459 strlen(CSUCCEED), get_write_delay(csp)) != 0)
4461 log_error(LOG_LEVEL_ERROR, "Sending SUCCEED to client failed");
4465 ret = create_client_ssl_connection(csp);
4468 log_error(LOG_LEVEL_ERROR,
4469 "Failed to open a secure connection with the client");
4472 if (JB_ERR_OK != process_encrypted_request_headers(csp))
4474 close_client_ssl_connection(csp);
4478 * We have an encrypted request. Check if one of the crunchers now
4479 * wants it (for example because the previously invisible path was
4480 * required to match).
4482 if (crunch_response_triggered(csp, crunchers_all))
4485 * Yes. The client got the crunch response and we're done here.
4492 /* If we need to apply client body filters, buffer the whole request now. */
4493 if (csp->expected_client_content_length != 0 &&
4494 (client_body_filters_enabled(csp->action) ||
4495 client_body_taggers_enabled(csp->action)) &&
4496 can_buffer_request_body(csp))
4498 int content_modified;
4499 size_t modified_content_length;
4501 #ifdef FEATURE_HTTPS_INSPECTION
4502 if (client_use_ssl(csp) && read_https_request_body(csp))
4504 log_error(LOG_LEVEL_ERROR, "Failed to buffer the encrypted "
4505 "request body to apply filters or taggers.");
4506 log_error(LOG_LEVEL_CLF,
4507 "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, csp->http->cmd);
4509 ssl_send_data_delayed(&(csp->ssl_client_attr),
4510 (const unsigned char *)CLIENT_BODY_BUFFER_ERROR_RESPONSE,
4511 strlen(CLIENT_BODY_BUFFER_ERROR_RESPONSE),
4512 get_write_delay(csp));
4518 if (read_http_request_body(csp))
4520 log_error(LOG_LEVEL_ERROR,
4521 "Failed to buffer the request body to apply filters or taggers,");
4522 log_error(LOG_LEVEL_CLF,
4523 "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, csp->http->cmd);
4525 write_socket_delayed(csp->cfd, CLIENT_BODY_BUFFER_ERROR_RESPONSE,
4526 strlen(CLIENT_BODY_BUFFER_ERROR_RESPONSE), get_write_delay(csp));
4530 if (client_body_taggers_enabled(csp->action))
4532 execute_client_body_taggers(csp, csp->expected_client_content_length);
4533 if (crunch_response_triggered(csp, crunchers_all))
4536 * Yes. The client got the crunch response and we're done here.
4541 if (client_body_filters_enabled(csp->action))
4543 modified_content_length = csp->expected_client_content_length;
4544 content_modified = execute_client_body_filters(csp,
4545 &modified_content_length);
4546 if ((content_modified == 1) &&
4547 (modified_content_length != csp->expected_client_content_length) &&
4548 update_client_headers(csp, modified_content_length))
4550 /* XXX: Send error response */
4551 log_error(LOG_LEVEL_HEADER, "Error updating client headers");
4555 csp->expected_client_content_length = 0;
4558 log_applied_actions(csp->action);
4560 /* decide how to route the HTTP request */
4561 fwd = forward_url(csp, http);
4563 freez(csp->headers->first->str);
4564 build_request_line(csp, fwd, &csp->headers->first->str);
4566 if (fwd->forward_host)
4568 log_error(LOG_LEVEL_CONNECT, "via [%s]:%d to: %s",
4569 fwd->forward_host, fwd->forward_port, http->hostport);
4573 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
4576 /* here we connect to the server, gateway, or the forwarder */
4578 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4579 if ((csp->server_connection.sfd != JB_INVALID_SOCKET)
4580 && socket_is_still_alive(csp->server_connection.sfd)
4581 && connection_destination_matches(&csp->server_connection, http, fwd))
4583 log_error(LOG_LEVEL_CONNECT,
4584 "Reusing server socket %d connected to %s. Total requests: %u.",
4585 csp->server_connection.sfd, csp->server_connection.host,
4586 csp->server_connection.requests_sent_total);
4590 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4592 #ifdef FEATURE_CONNECTION_SHARING
4593 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING
4594 #ifdef FEATURE_HTTPS_INSPECTION
4595 && !server_use_ssl(csp)
4599 remember_connection(&csp->server_connection);
4602 #endif /* def FEATURE_CONNECTION_SHARING */
4604 log_error(LOG_LEVEL_CONNECT,
4605 "Closing server socket %d connected to %s. Total requests: %u.",
4606 csp->server_connection.sfd, csp->server_connection.host,
4607 csp->server_connection.requests_sent_total);
4608 close_socket(csp->server_connection.sfd);
4610 mark_connection_closed(&csp->server_connection);
4612 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4615 * Connecting to destination server
4617 csp->server_connection.sfd = forwarded_connect(fwd, http, csp);
4619 if (csp->server_connection.sfd == JB_INVALID_SOCKET)
4621 if (fwd->type != SOCKS_NONE)
4624 rsp = error_response(csp, "forwarding-failed");
4626 else if (errno == EINVAL)
4628 rsp = error_response(csp, "no-such-domain");
4632 rsp = error_response(csp, "connect-failed");
4635 /* Write the answer to the client */
4638 send_crunch_response(csp, rsp);
4642 * Temporary workaround to prevent already-read client
4643 * bodies from being parsed as new requests. For now we
4644 * err on the safe side and throw all the following
4645 * requests under the bus, even if no client body has been
4646 * buffered. A compliant client will repeat the dropped
4647 * requests on an untainted connection.
4649 * The proper fix is to discard the no longer needed
4650 * client body in the buffer (if there is one) and to
4651 * continue parsing the bytes that follow.
4653 #ifdef FEATURE_HTTPS_INSPECTION
4654 close_client_ssl_connection(csp);
4656 drain_and_close_socket(csp->cfd);
4657 csp->cfd = JB_INVALID_SOCKET;
4662 #ifdef FEATURE_HTTPS_INSPECTION
4664 * Creating TLS/SSL connections with destination server or parent
4665 * proxy. If forwarding is enabled, we must send client request to
4666 * parent proxy and receive, parse and resend parent proxy answer.
4668 if (http->ssl && !use_ssl_tunnel)
4670 if (fwd->forward_host != NULL)
4672 char server_response[BUFFER_SIZE];
4675 char *hdr = list_to_text(csp->headers);
4676 memset(server_response, 0, sizeof(server_response));
4680 log_error(LOG_LEVEL_FATAL,
4681 "Out of memory parsing client header");
4683 list_remove_all(csp->headers);
4686 * Sending client's CONNECT request to the parent proxy
4688 ret = write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
4694 log_error(LOG_LEVEL_CONNECT,
4695 "Sending request headers to: %s failed", http->hostport);
4696 mark_server_socket_tainted(csp);
4697 close_client_ssl_connection(csp);
4701 /* Waiting for parent proxy server response */
4702 len = read_socket(csp->server_connection.sfd, server_response,
4703 sizeof(server_response)-1);
4707 log_error(LOG_LEVEL_ERROR, "No response from parent proxy "
4708 "server on socket %d.", csp->server_connection.sfd);
4710 rsp = error_response(csp, "no-server-data");
4713 send_crunch_response(csp, rsp);
4715 mark_server_socket_tainted(csp);
4716 close_client_ssl_connection(csp);
4721 * Test if the connection to the destination server was
4722 * established successfully by the parent proxy.
4724 if (!tunnel_established_successfully(server_response, (unsigned int)len))
4726 log_error(LOG_LEVEL_ERROR,
4727 "The forwarder %s failed to establish a connection with %s",
4728 fwd->forward_host, http->host);
4729 rsp = error_response(csp, "connect-failed");
4732 send_crunch_response(csp, rsp);
4734 mark_server_socket_tainted(csp);
4735 close_client_ssl_connection(csp);
4738 } /* -END- if (fwd->forward_host != NULL) */
4741 * We can now create the TLS/SSL connection with the destination server.
4743 int ret = create_server_ssl_connection(csp);
4746 if (csp->server_cert_verification_result != SSL_CERT_VALID &&
4747 csp->server_cert_verification_result != SSL_CERT_NOT_VERIFIED)
4750 * If the server certificate is invalid, we must inform
4751 * the client and then close connection to the client.
4753 ssl_send_certificate_error(csp);
4754 close_client_and_server_ssl_connections(csp);
4757 if (csp->server_cert_verification_result == SSL_CERT_NOT_VERIFIED
4758 || csp->server_cert_verification_result == SSL_CERT_VALID)
4761 * The TLS/SSL connection wasn't created but an invalid
4762 * certificate wasn't detected. Report it as connection
4765 rsp = error_response(csp, "connect-failed");
4768 send_crunch_response(csp, rsp);
4770 close_client_and_server_ssl_connections(csp);
4774 }/* -END- if (http->ssl) */
4775 #endif /* def FEATURE_HTTPS_INSPECTION */
4777 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4778 save_connection_destination(csp->server_connection.sfd,
4779 http, fwd, &csp->server_connection);
4780 csp->server_connection.keep_alive_timeout =
4781 (unsigned)csp->config->keep_alive_timeout;
4783 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4785 csp->server_connection.requests_sent_total++;
4787 if ((fwd->type == SOCKS_5T) && (NULL == csp->headers->first))
4789 /* Client headers have been sent optimistically */
4790 assert(csp->headers->last == NULL);
4792 else if (http->ssl == 0 || (fwd->forward_host
4793 #ifdef FEATURE_HTTPS_INSPECTION
4798 int status = send_http_request(csp);
4801 /* The request got crunched, a response has been delivered. */
4806 rsp = error_response(csp, "connect-failed");
4809 send_crunch_response(csp, rsp);
4817 * Using old solution with SSL tunnel or new solution with SSL proxy
4819 list_remove_all(csp->headers);
4820 #ifdef FEATURE_HTTPS_INSPECTION
4825 * We're running an SSL tunnel and we're not forwarding,
4826 * so just ditch the client headers, send the "connect succeeded"
4827 * message to the client, flush the rest, and get out of the way.
4829 if (write_socket_delayed(csp->cfd, CSUCCEED,
4830 strlen(CSUCCEED), get_write_delay(csp)))
4835 #ifdef FEATURE_HTTPS_INSPECTION
4839 * If server certificate has been verified and is invalid,
4840 * we must inform the client and then close the connection
4841 * with client and server.
4843 if (csp->server_cert_verification_result != SSL_CERT_VALID &&
4844 csp->server_cert_verification_result != SSL_CERT_NOT_VERIFIED)
4846 ssl_send_certificate_error(csp);
4847 close_client_and_server_ssl_connections(csp);
4850 if (send_https_request(csp))
4852 rsp = error_response(csp, "connect-failed");
4855 send_crunch_response(csp, rsp);
4857 close_client_and_server_ssl_connections(csp);
4861 #endif /* def FEATURE_HTTPS_INSPECTION */
4862 clear_iob(csp->client_iob);
4863 }/* -END- else ... if (http->ssl == 1) */
4865 log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
4867 /* XXX: should the time start earlier for optimistically sent data? */
4868 csp->server_connection.request_sent = time(NULL);
4870 handle_established_connection(csp);
4871 freez(csp->receive_buffer);
4876 /*********************************************************************
4878 * Function : fuzz_server_response
4880 * Description : Treat the input as a whole server response.
4883 * 1 : csp = Current client state (buffers, headers, etc...)
4884 * 2 : fuzz_input_file = File to read the input from.
4888 *********************************************************************/
4889 extern int fuzz_server_response(struct client_state *csp, char *fuzz_input_file)
4891 static struct forward_spec fwd; /* Zero'd due to being static */
4894 if (strcmp(fuzz_input_file, "-") == 0)
4896 /* XXX: Doesn't work yet. */
4897 csp->server_connection.sfd = 0;
4901 csp->server_connection.sfd = open(fuzz_input_file, O_RDONLY);
4902 if (csp->server_connection.sfd == -1)
4904 log_error(LOG_LEVEL_FATAL, "Failed to open %s: %E",
4909 csp->content_type |= CT_GIF;
4910 csp->action->flags |= ACTION_DEANIMATE;
4911 csp->action->string[ACTION_STRING_DEANIMATE] = "last";
4913 csp->http->path = strdup_or_die("/");
4914 csp->http->host = strdup_or_die("fuzz.example.org");
4915 csp->http->hostport = strdup_or_die("fuzz.example.org:80");
4916 /* Prevent client socket monitoring */
4917 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
4918 csp->flags |= CSP_FLAG_CHUNKED;
4920 csp->config->feature_flags |= RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
4921 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
4923 csp->content_type |= CT_DECLARED|CT_GIF;
4925 csp->config->socket_timeout = 0;
4927 cgi_init_error_messages();
4929 handle_established_connection(csp);
4930 freez(csp->receive_buffer);
4937 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4938 /*********************************************************************
4940 * Function : prepare_csp_for_next_request
4942 * Description : Put the csp in a mostly vergin state.
4945 * 1 : csp = Current client state (buffers, headers, etc...)
4949 *********************************************************************/
4950 static void prepare_csp_for_next_request(struct client_state *csp)
4952 csp->content_type = 0;
4953 csp->content_length = 0;
4954 csp->expected_content_length = 0;
4955 csp->expected_client_content_length = 0;
4956 list_remove_all(csp->headers);
4957 clear_iob(csp->iob);
4958 freez(csp->error_message);
4959 free_http_request(csp->http);
4960 destroy_list(csp->headers);
4961 #ifdef FEATURE_HTTPS_INSPECTION
4962 destroy_list(csp->https_headers);
4964 destroy_list(csp->tags);
4965 #ifdef FEATURE_CLIENT_TAGS
4966 destroy_list(csp->client_tags);
4967 freez(csp->client_address);
4969 free_current_action(csp->action);
4970 if (NULL != csp->fwd)
4972 unload_forward_spec(csp->fwd);
4975 /* XXX: Store per-connection flags someplace else. */
4976 csp->flags = (CSP_FLAG_ACTIVE | CSP_FLAG_REUSED_CLIENT_CONNECTION);
4977 #ifdef FEATURE_TOGGLE
4978 if (global_toggle_state)
4979 #endif /* def FEATURE_TOGGLE */
4981 csp->flags |= CSP_FLAG_TOGGLED_ON;
4984 if (csp->client_iob->eod > csp->client_iob->cur)
4986 long bytes_to_shift = csp->client_iob->cur - csp->client_iob->buf;
4987 size_t data_length = (size_t)(csp->client_iob->eod - csp->client_iob->cur);
4989 assert(bytes_to_shift > 0);
4990 assert(data_length > 0);
4992 log_error(LOG_LEVEL_CONNECT, "Shifting %lu pipelined bytes by %ld bytes",
4993 data_length, bytes_to_shift);
4994 memmove(csp->client_iob->buf, csp->client_iob->cur, data_length);
4995 csp->client_iob->cur = csp->client_iob->buf;
4996 assert(csp->client_iob->eod == csp->client_iob->buf + bytes_to_shift + data_length);
4997 csp->client_iob->eod = csp->client_iob->buf + data_length;
4998 memset(csp->client_iob->eod, '\0', (size_t)bytes_to_shift);
5000 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
5005 * We mainly care about resetting client_iob->cur so we don't
5006 * waste buffer space at the beginning and don't mess up the
5007 * request restoration done by cgi_show_request().
5009 * Freeing the buffer itself isn't technically necessary,
5010 * but makes debugging more convenient.
5012 clear_iob(csp->client_iob);
5015 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
5018 /*********************************************************************
5022 * Description : This is little more than chat. We only "serve" to
5023 * to close (or remember) any socket that chat may have
5027 * 1 : csp = Current client state (buffers, headers, etc...)
5031 *********************************************************************/
5032 static void serve(struct client_state *csp)
5034 int config_file_change_detected = 0; /* Only used for debugging */
5035 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
5036 #ifdef FEATURE_CONNECTION_SHARING
5037 static int monitor_thread_running = 0;
5038 #endif /* def FEATURE_CONNECTION_SHARING */
5039 int continue_chatting = 0;
5041 log_error(LOG_LEVEL_CONNECT, "Accepted connection from %s on socket %d",
5042 csp->ip_addr_str, csp->cfd);
5046 unsigned int latency;
5048 #ifdef FEATURE_HTTPS_INSPECTION
5049 if (continue_chatting && client_use_ssl(csp))
5051 continue_https_chat(csp);
5060 * If the request has been crunched,
5061 * the calculated latency is zero.
5063 latency = (unsigned)(csp->server_connection.response_received -
5064 csp->server_connection.request_sent) / 2;
5066 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
5067 && (csp->flags & CSP_FLAG_CRUNCHED)
5068 && (csp->expected_client_content_length != 0))
5070 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
5071 log_error(LOG_LEVEL_CONNECT,
5072 "Tainting client socket %d due to unread data.", csp->cfd);
5075 continue_chatting = (csp->config->feature_flags
5076 & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
5077 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
5078 && (csp->cfd != JB_INVALID_SOCKET)
5079 && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
5080 && ((csp->flags & CSP_FLAG_SERVER_CONTENT_LENGTH_SET)
5081 || (csp->flags & CSP_FLAG_CHUNKED));
5083 if (!(csp->flags & CSP_FLAG_CRUNCHED)
5084 && (csp->server_connection.sfd != JB_INVALID_SOCKET))
5086 if (!(csp->flags & CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET))
5088 csp->server_connection.keep_alive_timeout = csp->config->default_server_timeout;
5090 if (!(csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
5091 || (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
5092 || !socket_is_still_alive(csp->server_connection.sfd)
5093 || !(latency < csp->server_connection.keep_alive_timeout))
5095 log_error(LOG_LEVEL_CONNECT,
5096 "Closing server socket %d connected to %s. "
5097 "Keep-alive: %u. Tainted: %u. Socket alive: %u. Timeout: %u.",
5098 csp->server_connection.sfd, (csp->server_connection.host != NULL) ?
5099 csp->server_connection.host : csp->http->host,
5100 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
5101 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
5102 socket_is_still_alive(csp->server_connection.sfd),
5103 csp->server_connection.keep_alive_timeout);
5104 #ifdef FEATURE_CONNECTION_SHARING
5105 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
5107 forget_connection(csp->server_connection.sfd);
5109 #endif /* def FEATURE_CONNECTION_SHARING */
5110 #ifdef FEATURE_HTTPS_INSPECTION
5111 close_server_ssl_connection(csp);
5113 close_socket(csp->server_connection.sfd);
5114 mark_connection_closed(&csp->server_connection);
5115 #ifdef FEATURE_HTTPS_INSPECTION
5116 if (continue_chatting && client_use_ssl(csp))
5119 * Close the client socket as well as Privoxy currently
5120 * can't establish a new server connection when the client
5121 * socket is reused and would drop the connection in
5122 * continue_https_chat() anyway.
5124 continue_chatting = 0;
5125 csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
5126 log_error(LOG_LEVEL_CONNECT,
5127 "Client socket %d is no longer usable. "
5128 "The server socket has been closed.", csp->cfd);
5134 if (continue_chatting && any_loaded_file_changed(csp))
5136 continue_chatting = 0;
5137 config_file_change_detected = 1;
5139 #ifdef FEATURE_HTTPS_INSPECTION
5140 if (continue_chatting && client_use_ssl(csp) &&
5141 csp->ssl_with_client_is_opened == 0)
5143 continue_chatting = 0;
5144 log_error(LOG_LEVEL_CONNECT, "Client socket %d is no longer usable. "
5145 "The TLS session has been terminated.", csp->cfd);
5149 if (continue_chatting)
5151 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
5152 && socket_is_still_alive(csp->cfd))
5154 log_error(LOG_LEVEL_CONNECT, "Client request %d has been "
5155 "pipelined on socket %d and the socket is still alive.",
5156 csp->requests_received_total+1, csp->cfd);
5157 prepare_csp_for_next_request(csp);
5161 if (0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
5163 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
5165 log_error(LOG_LEVEL_CONNECT,
5166 "Waiting for the next client request on socket %d. "
5167 "Keeping the server socket %d to %s open.",
5168 csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
5172 log_error(LOG_LEVEL_CONNECT,
5173 "Waiting for the next client request on socket %d. "
5174 "No server socket to keep open.", csp->cfd);
5178 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
5179 && data_is_available(csp->cfd, (int)csp->config->keep_alive_timeout)
5180 && socket_is_still_alive(csp->cfd))
5182 log_error(LOG_LEVEL_CONNECT,
5183 "Data arrived in time on client socket %d. Requests so far: %u",
5184 csp->cfd, csp->requests_received_total);
5185 prepare_csp_for_next_request(csp);
5189 #ifdef FEATURE_CONNECTION_SHARING
5190 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
5191 && (csp->server_connection.sfd != JB_INVALID_SOCKET)
5192 && (socket_is_still_alive(csp->server_connection.sfd))
5193 #ifdef FEATURE_HTTPS_INSPECTION
5194 && !server_use_ssl(csp)
5198 time_t time_open = time(NULL) - csp->server_connection.timestamp;
5200 if (csp->server_connection.keep_alive_timeout < time_open - (time_t)latency)
5205 remember_connection(&csp->server_connection);
5206 csp->server_connection.sfd = JB_INVALID_SOCKET;
5207 drain_and_close_socket(csp->cfd);
5208 csp->cfd = JB_INVALID_SOCKET;
5209 privoxy_mutex_lock(&connection_reuse_mutex);
5210 if (!monitor_thread_running)
5212 monitor_thread_running = 1;
5213 privoxy_mutex_unlock(&connection_reuse_mutex);
5214 wait_for_alive_connections();
5215 privoxy_mutex_lock(&connection_reuse_mutex);
5216 monitor_thread_running = 0;
5218 privoxy_mutex_unlock(&connection_reuse_mutex);
5220 #endif /* def FEATURE_CONNECTION_SHARING */
5224 else if (csp->server_connection.sfd != JB_INVALID_SOCKET)
5226 log_error(LOG_LEVEL_CONNECT,
5227 "Closing server socket %d connected to %s. Keep-alive: %u. "
5228 "Tainted: %u. Socket alive: %u. Timeout: %u. "
5229 "Configuration file change detected: %u",
5230 csp->server_connection.sfd, csp->server_connection.host,
5231 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
5232 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
5233 socket_is_still_alive(csp->server_connection.sfd),
5234 csp->server_connection.keep_alive_timeout,
5235 config_file_change_detected);
5237 } while (continue_chatting);
5241 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
5243 if (csp->cfd != JB_INVALID_SOCKET)
5245 log_error(LOG_LEVEL_CONNECT, "Closing client socket %d. "
5246 "Keep-alive: %u. Socket alive: %u. Data available: %u. "
5247 "Configuration file change detected: %u. Requests received: %u.",
5248 csp->cfd, 0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE),
5249 socket_is_still_alive(csp->cfd), data_is_available(csp->cfd, 0),
5250 config_file_change_detected, csp->requests_received_total);
5251 #ifdef FEATURE_HTTPS_INSPECTION
5252 close_client_ssl_connection(csp);
5254 drain_and_close_socket(csp->cfd);
5257 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
5259 #ifdef FEATURE_CONNECTION_SHARING
5260 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
5262 forget_connection(csp->server_connection.sfd);
5264 #endif /* def FEATURE_CONNECTION_SHARING */
5266 #ifdef FEATURE_HTTPS_INSPECTION
5267 close_server_ssl_connection(csp);
5268 #endif /* def FEATURE_HTTPS_INSPECTION */
5270 close_socket(csp->server_connection.sfd);
5273 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
5274 mark_connection_closed(&csp->server_connection);
5277 free_csp_resources(csp);
5279 csp->flags &= ~CSP_FLAG_ACTIVE;
5285 /*********************************************************************
5287 * Function : server_thread
5289 * Description : We only exist to call `serve' in a threaded environment.
5292 * 1 : data = Current client state (buffers, headers, etc...)
5294 * Returns : Always 0.
5296 *********************************************************************/
5297 static int32 server_thread(void *data)
5299 serve((struct client_state *) data);
5306 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
5307 /*********************************************************************
5311 * Description : Print usage info & exit.
5313 * Parameters : Pointer to argv[0] for identifying ourselves
5317 *********************************************************************/
5318 static void usage(const char *name)
5320 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
5321 "Usage: %s [--config-test] "
5324 #endif /* defined(unix) */
5327 "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
5328 #endif /* defined(unix) */
5329 "[--version] [configfile]\n",
5333 show_fuzz_usage(name);
5336 printf("Aborting\n");
5341 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
5344 #ifdef MUTEX_LOCKS_AVAILABLE
5345 /*********************************************************************
5347 * Function : privoxy_mutex_lock
5349 * Description : Locks a mutex.
5352 * 1 : mutex = The mutex to lock.
5354 * Returns : Void. May exit in case of errors.
5356 *********************************************************************/
5357 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
5359 #ifdef FEATURE_PTHREAD
5360 int err = pthread_mutex_lock(mutex);
5363 if (mutex != &log_mutex)
5365 log_error(LOG_LEVEL_FATAL,
5366 "Mutex locking failed: %s.\n", strerror(err));
5371 EnterCriticalSection(mutex);
5372 #endif /* def FEATURE_PTHREAD */
5376 /*********************************************************************
5378 * Function : privoxy_mutex_unlock
5380 * Description : Unlocks a mutex.
5383 * 1 : mutex = The mutex to unlock.
5385 * Returns : Void. May exit in case of errors.
5387 *********************************************************************/
5388 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
5390 #ifdef FEATURE_PTHREAD
5391 int err = pthread_mutex_unlock(mutex);
5394 if (mutex != &log_mutex)
5396 log_error(LOG_LEVEL_FATAL,
5397 "Mutex unlocking failed: %s.\n", strerror(err));
5402 LeaveCriticalSection(mutex);
5403 #endif /* def FEATURE_PTHREAD */
5407 /*********************************************************************
5409 * Function : privoxy_mutex_init
5411 * Description : Prepares a mutex.
5414 * 1 : mutex = The mutex to initialize.
5416 * Returns : Void. May exit in case of errors.
5418 *********************************************************************/
5419 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
5421 #ifdef FEATURE_PTHREAD
5422 int err = pthread_mutex_init(mutex, 0);
5425 printf("Fatal error. Mutex initialization failed: %s.\n",
5430 InitializeCriticalSection(mutex);
5431 #endif /* def FEATURE_PTHREAD */
5433 #endif /* def MUTEX_LOCKS_AVAILABLE */
5435 /*********************************************************************
5437 * Function : initialize_mutexes
5439 * Description : Prepares mutexes if mutex support is available.
5443 * Returns : Void, exits in case of errors.
5445 *********************************************************************/
5446 static void initialize_mutexes(void)
5448 #ifdef MUTEX_LOCKS_AVAILABLE
5450 * Prepare global mutex semaphores
5453 #ifdef FEATURE_HTTPS_INSPECTION
5454 privoxy_mutex_init(&certificate_mutex);
5455 privoxy_mutex_init(&ssl_init_mutex);
5458 privoxy_mutex_init(&log_mutex);
5459 privoxy_mutex_init(&log_init_mutex);
5460 privoxy_mutex_init(&connection_reuse_mutex);
5461 #ifdef FEATURE_EXTERNAL_FILTERS
5462 privoxy_mutex_init(&external_filter_mutex);
5464 #ifdef FEATURE_CLIENT_TAGS
5465 privoxy_mutex_init(&client_tags_mutex);
5467 #ifdef FEATURE_STATISTICS
5468 privoxy_mutex_init(&block_statistics_mutex);
5470 #ifdef FEATURE_EXTENDED_STATISTICS
5471 privoxy_mutex_init(&filter_statistics_mutex);
5472 privoxy_mutex_init(&block_reason_statistics_mutex);
5476 * XXX: The assumptions below are a bit naive
5477 * and can cause locks that aren't necessary.
5479 * For example older FreeBSD versions (< 6.x?)
5480 * have no gethostbyname_r, but gethostbyname is
5483 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
5484 privoxy_mutex_init(&resolver_mutex);
5485 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
5487 * XXX: should we use a single mutex for
5488 * localtime() and gmtime() as well?
5490 #ifndef HAVE_GMTIME_R
5491 privoxy_mutex_init(&gmtime_mutex);
5492 #endif /* ndef HAVE_GMTIME_R */
5494 #ifndef HAVE_LOCALTIME_R
5495 privoxy_mutex_init(&localtime_mutex);
5496 #endif /* ndef HAVE_GMTIME_R */
5498 #if !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM)
5499 privoxy_mutex_init(&rand_mutex);
5500 #endif /* !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM) */
5502 #endif /* def MUTEX_LOCKS_AVAILABLE */
5505 /*********************************************************************
5509 * Description : Load the config file and start the listen loop.
5510 * This function is a lot more *sane* with the `load_config'
5511 * and `listen_loop' functions; although it stills does
5512 * a *little* too much for my taste.
5515 * 1 : argc = Number of parameters (including $0).
5516 * 2 : argv = Array of (char *)'s to the parameters.
5518 * Returns : 1 if : can't open config file, unrecognized directive,
5519 * stats requested in multi-thread mode, can't open the
5520 * log file, can't open the jar file, listen port is invalid,
5521 * any load fails, and can't bind port.
5523 * Else main never returns, the process must be signaled
5524 * to terminate execution. Or, on Windows, use the
5525 * "File", "Exit" menu option.
5527 *********************************************************************/
5529 int real_main(int argc, char **argv)
5531 int main(int argc, char **argv)
5535 int do_config_test = 0;
5536 #ifndef HAVE_ARC4RANDOM
5537 unsigned int random_seed;
5540 struct passwd *pw = NULL;
5541 struct group *grp = NULL;
5543 char *pre_chroot_nslookup_to_load_resolver = NULL;
5546 char *fuzz_input_type = NULL;
5547 char *fuzz_input_file = NULL;
5554 #if !defined(_WIN32)
5561 /* Prepare mutexes if supported and necessary. */
5562 initialize_mutexes();
5564 /* Enable logging until further notice. */
5568 * Parse the command line arguments
5570 * XXX: simply printing usage information in case of
5571 * invalid arguments isn't particularly user friendly.
5573 while (++argc_pos < argc)
5576 /* Check to see if the service must be installed or uninstalled */
5577 if (strncmp(argv[argc_pos], "--install", 9) == 0)
5579 const char *pName = argv[argc_pos] + 9;
5582 exit((install_service(pName)) ? 0 : 1);
5584 else if (strncmp(argv[argc_pos], "--uninstall", 11) == 0)
5586 const char *pName = argv[argc_pos] + 11;
5589 exit((uninstall_service(pName)) ? 0 : 1);
5591 else if (strcmp(argv[argc_pos], "--service") == 0)
5593 bRunAsService = TRUE;
5594 w32_set_service_cwd();
5595 atexit(w32_service_exit_notify);
5598 #endif /* defined(_WIN32) */
5601 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
5603 if (strcmp(argv[argc_pos], "--help") == 0)
5608 else if (strcmp(argv[argc_pos], "--version") == 0)
5610 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
5616 else if (strcmp(argv[argc_pos], "--no-daemon") == 0)
5618 set_debug_level(LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
5622 else if (strcmp(argv[argc_pos], "--pidfile") == 0)
5624 if (++argc_pos == argc) usage(argv[0]);
5625 pidfile = strdup_or_die(argv[argc_pos]);
5628 else if (strcmp(argv[argc_pos], "--user") == 0)
5633 if (++argc_pos == argc) usage(argv[argc_pos]);
5635 user_arg = strdup_or_die(argv[argc_pos]);
5636 group_name = strchr(user_arg, '.');
5637 if (NULL != group_name)
5639 /* Nul-terminate the user name */
5642 /* Skip the former delimiter to actually reach the group name */
5645 grp = getgrnam(group_name);
5648 log_error(LOG_LEVEL_FATAL, "Group '%s' not found.", group_name);
5651 pw = getpwnam(user_arg);
5654 log_error(LOG_LEVEL_FATAL, "User '%s' not found.", user_arg);
5660 else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup") == 0)
5662 if (++argc_pos == argc) usage(argv[0]);
5663 pre_chroot_nslookup_to_load_resolver = strdup_or_die(argv[argc_pos]);
5666 else if (strcmp(argv[argc_pos], "--chroot") == 0)
5670 #endif /* defined(unix) */
5672 else if (strcmp(argv[argc_pos], "--config-test") == 0)
5677 else if (strcmp(argv[argc_pos], "--fuzz") == 0)
5680 if (argc < argc_pos + 2) usage(argv[0]);
5681 fuzz_input_type = argv[argc_pos];
5683 fuzz_input_file = argv[argc_pos];
5685 else if (strcmp(argv[argc_pos], "--stfu") == 0)
5687 set_debug_level(LOG_LEVEL_STFU);
5690 else if (argc_pos + 1 != argc)
5693 * This is neither the last command line
5694 * option, nor was it recognized before,
5695 * therefore it must be invalid.
5701 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
5703 configfile = argv[argc_pos];
5706 } /* -END- while (more arguments) */
5708 show_version(Argv[0]);
5711 if (*configfile != '/')
5713 char cwd[BUFFER_SIZE];
5715 size_t abs_file_size;
5717 /* make config-filename absolute here */
5718 if (NULL == getcwd(cwd, sizeof(cwd)))
5720 perror("failed to get current working directory");
5724 basedir = strdup_or_die(cwd);
5726 abs_file_size = strlen(cwd) + strlen(configfile) + 5;
5727 abs_file = malloc_or_die(abs_file_size);
5728 strlcpy(abs_file, basedir, abs_file_size);
5729 strlcat(abs_file, "/", abs_file_size);
5730 strlcat(abs_file, configfile, abs_file_size);
5731 configfile = abs_file;
5733 #endif /* defined unix */
5737 clients->next = NULL;
5739 /* XXX: factor out initialising after the next stable release. */
5744 #ifndef HAVE_ARC4RANDOM
5745 random_seed = (unsigned int)time(NULL);
5747 srandom(random_seed);
5750 #endif /* ifdef HAVE_RANDOM */
5751 #endif /* ifndef HAVE_ARC4RANDOM */
5754 * Unix signal handling
5756 * Catch the abort, interrupt and terminate signals for a graceful exit
5757 * Catch the hangup signal so the errlog can be reopened.
5759 * Ignore the broken pipe signal as connection failures
5760 * are handled when and where they occur without relying
5763 #if !defined(_WIN32)
5766 const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP };
5768 for (idx = 0; idx < SZ(catched_signals); idx++)
5770 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
5771 if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
5773 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
5774 #endif /* ifdef sun */
5776 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
5780 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
5782 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for SIGPIPE: %E");
5786 #else /* ifdef _WIN32 */
5787 # ifdef _WIN_CONSOLE
5789 * We *are* in a windows console app.
5790 * Print a verbose messages about FAQ's and such
5792 printf("%s", win32_blurb);
5793 # endif /* def _WIN_CONSOLE */
5794 #endif /* def _WIN32 */
5797 if (fuzz_input_type != NULL)
5799 exit(process_fuzzed_input(fuzz_input_type, fuzz_input_file));
5801 log_error(LOG_LEVEL_FATAL,
5802 "When compiled with fuzzing support, Privoxy should only be used for fuzzing. "
5803 "Various data structures are static which is unsafe when using threads.");
5808 exit(NULL == load_config());
5811 /* Initialize the CGI subsystem */
5812 cgi_init_error_messages();
5815 * If running on unix and without the --no-daemon
5816 * option, become a daemon. I.e. fork, detach
5817 * from tty and get process group leadership
5826 if (pid < 0) /* error */
5831 else if (pid != 0) /* parent */
5836 * must check for errors
5837 * child died due to missing files aso
5840 wpid = waitpid(pid, &status, WNOHANG);
5852 * stderr (fd 2) will be closed later on,
5853 * when the config file has been parsed.
5859 * Reserve fd 0 and 1 to prevent abort() and friends
5860 * from sending stuff to the clients or servers.
5862 fd = open("/dev/null", O_RDONLY);
5865 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
5869 if (dup2(fd, 0) == -1)
5871 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 0: %E");
5875 fd = open("/dev/null", O_WRONLY);
5878 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
5882 if (dup2(fd, 1) == -1)
5884 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 1: %E");
5889 #ifdef FEATURE_EXTERNAL_FILTERS
5890 for (fd = 0; fd < 3; fd++)
5892 mark_socket_for_close_on_execute(fd);
5896 if (chdir("/") != 0)
5898 log_error(LOG_LEVEL_FATAL, "Failed to cd into '/': %E");
5901 } /* -END- if (daemon_mode) */
5904 * As soon as we have written the PID file, we can switch
5905 * to the user and group ID indicated by the --user option
5907 if (pidfile != NULL)
5909 write_pid_file(pidfile);
5913 if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
5915 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
5919 if (setgroups(1, &grp->gr_gid))
5921 log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
5924 else if (initgroups(pw->pw_name, pw->pw_gid))
5926 log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
5932 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
5934 /* Read the time zone file from /etc before doing chroot. */
5936 if (NULL != pre_chroot_nslookup_to_load_resolver
5937 && '\0' != pre_chroot_nslookup_to_load_resolver[0])
5939 /* Initialize resolver library. */
5940 (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
5942 if (chroot(pw->pw_dir) < 0)
5944 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
5948 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
5951 if (setuid(pw->pw_uid))
5953 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
5957 char putenv_dummy[64];
5959 strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
5960 if (putenv(putenv_dummy) != 0)
5962 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
5965 snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
5966 if (putenv(putenv_dummy) != 0)
5968 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
5974 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
5977 #endif /* defined unix */
5980 /* This will be FALSE unless the command line specified --service
5984 /* Yup, so now we must attempt to establish a connection
5985 * with the service dispatcher. This will only work if this
5986 * process was launched by the service control manager to
5987 * actually run as a service. If this isn't the case, i've
5988 * known it take around 30 seconds or so for the call to return.
5991 /* The StartServiceCtrlDispatcher won't return until the service is stopping */
5992 if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
5994 /* Service has run, and at this point is now being stopped, so just return */
5999 printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
6001 /* An error occurred. Usually it's because --service was wrongly specified
6002 * and we were unable to connect to the Service Control Dispatcher because
6003 * it wasn't expecting us and is therefore not listening.
6005 * For now, just continue below to call the listen_loop function.
6008 #endif /* def _WIN32 */
6018 /*********************************************************************
6020 * Function : bind_port_helper
6022 * Description : Bind the listen port. Handles logging, and aborts
6026 * 1 : haddr = Host address to bind to. Use NULL to bind to
6028 * 2 : hport = Specifies port to bind to.
6029 * 3 : backlog = Listen backlog.
6031 * Returns : Port that was opened.
6033 *********************************************************************/
6034 static jb_socket bind_port_helper(const char *haddr, int hport, int backlog)
6039 result = bind_port(haddr, hport, backlog, &bfd);
6043 const char *bind_address = (NULL != haddr) ? haddr : "INADDR_ANY";
6047 log_error(LOG_LEVEL_FATAL,
6048 "can't bind to %s:%d: There may be another Privoxy "
6049 "or some other proxy running on port %d",
6050 bind_address, hport, hport);
6054 log_error(LOG_LEVEL_FATAL,
6055 "can't bind to %s:%d: The hostname is not resolvable",
6056 bind_address, hport);
6060 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: %E",
6061 bind_address, hport);
6065 /* shouldn't get here */
6066 return JB_INVALID_SOCKET;
6071 if (bfd >= FD_SETSIZE)
6073 log_error(LOG_LEVEL_FATAL,
6074 "Bind socket number too high to use select(): %d >= %d",
6082 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
6087 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
6095 /*********************************************************************
6097 * Function : bind_ports_helper
6099 * Description : Bind the listen ports. Handles logging, and aborts
6103 * 1 : config = Privoxy configuration. Specifies ports
6105 * 2 : sockets = Preallocated array of opened sockets
6106 * corresponding to specification in config.
6107 * All non-opened sockets will be set to
6108 * JB_INVALID_SOCKET.
6110 * Returns : Nothing. Inspect sockets argument.
6112 *********************************************************************/
6113 static void bind_ports_helper(struct configuration_spec * config,
6114 jb_socket sockets[])
6118 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
6120 if (config->hport[i])
6122 sockets[i] = bind_port_helper(config->haddr[i],
6123 config->hport[i], config->listen_backlog);
6124 #if defined(FEATURE_ACCEPT_FILTER) && defined(SO_ACCEPTFILTER)
6125 if (config->enable_accept_filter && sockets[i] != JB_INVALID_SOCKET)
6127 struct accept_filter_arg af_options;
6128 bzero(&af_options, sizeof(af_options));
6129 strlcpy(af_options.af_name, "httpready", sizeof(af_options.af_name));
6130 if (setsockopt(sockets[i], SOL_SOCKET, SO_ACCEPTFILTER, &af_options,
6131 sizeof(af_options)))
6133 log_error(LOG_LEVEL_ERROR,
6134 "Enabling accept filter for socket %d failed: %E", sockets[i]);
6141 sockets[i] = JB_INVALID_SOCKET;
6144 config->need_bind = 0;
6148 /*********************************************************************
6150 * Function : close_ports_helper
6152 * Description : Close listenings ports.
6155 * 1 : sockets = Array of opened and non-opened sockets to
6156 * close. All sockets will be set to
6157 * JB_INVALID_SOCKET.
6159 * Returns : Nothing.
6161 *********************************************************************/
6162 static void close_ports_helper(jb_socket sockets[])
6166 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
6168 if (JB_INVALID_SOCKET != sockets[i])
6170 close_socket(sockets[i]);
6172 sockets[i] = JB_INVALID_SOCKET;
6178 /* Without this simple workaround we get this compiler warning from _beginthread
6179 * warning C4028: formal parameter 1 different from declaration
6181 void w32_service_listen_loop(void *p)
6185 #endif /* def _WIN32 */
6188 /*********************************************************************
6190 * Function : listen_loop
6192 * Description : bind the listen port and enter a "FOREVER" listening loop.
6198 *********************************************************************/
6199 static void listen_loop(void)
6201 struct client_states *csp_list = NULL;
6202 struct client_state *csp = NULL;
6203 jb_socket bfds[MAX_LISTENING_SOCKETS];
6204 struct configuration_spec *config;
6205 unsigned int active_threads = 0;
6206 #if defined(FEATURE_PTHREAD)
6207 pthread_attr_t attrs;
6209 pthread_attr_init(&attrs);
6210 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
6213 config = load_config();
6215 #ifdef FEATURE_CONNECTION_SHARING
6217 * XXX: Should be relocated once it no
6218 * longer needs to emit log messages.
6220 initialize_reusable_connections();
6221 #endif /* def FEATURE_CONNECTION_SHARING */
6223 bind_ports_helper(config, bfds);
6225 #ifdef FEATURE_GRACEFUL_TERMINATION
6226 while (!g_terminate)
6231 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__)
6232 while (waitpid(-1, NULL, WNOHANG) > 0)
6234 /* zombie children */
6236 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) */
6239 * Free data that was used by died threads
6241 active_threads = sweep();
6245 * Re-open the errlog after HUP signal
6247 if (received_hup_signal)
6249 if (NULL != config->logfile)
6251 init_error_log(Argv[0], config->logfile);
6253 received_hup_signal = 0;
6257 csp_list = zalloc_or_die(sizeof(*csp_list));
6258 csp = &csp_list->csp;
6260 log_error(LOG_LEVEL_CONNECT,
6261 "Waiting for the next client connection. Currently active threads: %u",
6265 * This config may be outdated, but for accept_connection()
6266 * it's fresh enough.
6268 csp->config = config;
6270 if (!accept_connection(csp, bfds))
6272 log_error(LOG_LEVEL_CONNECT,
6273 "Failed to accept() incoming connection: %E");
6278 csp->flags |= CSP_FLAG_ACTIVE;
6279 csp->server_connection.sfd = JB_INVALID_SOCKET;
6281 csp->config = config = load_config();
6283 if (config->need_bind)
6286 * Since we were listening to the "old port", we will not see
6287 * a "listen" param change until the next request. So, at
6288 * least 1 more request must be made for us to find the new
6289 * setting. I am simply closing the old socket and binding the
6292 * Which-ever is correct, we will serve 1 more page via the
6293 * old settings. This should probably be a "show-status"
6294 * request. This should not be a so common of an operation
6295 * that this will hurt people's feelings.
6298 close_ports_helper(bfds);
6300 bind_ports_helper(config, bfds);
6303 #ifdef FEATURE_TOGGLE
6304 if (global_toggle_state)
6305 #endif /* def FEATURE_TOGGLE */
6307 csp->flags |= CSP_FLAG_TOGGLED_ON;
6310 if (run_loader(csp))
6312 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
6313 /* Never get here - LOG_LEVEL_FATAL causes program exit */
6317 if (block_acl(NULL,csp))
6319 log_error(LOG_LEVEL_CONNECT,
6320 "Connection from %s on %s (socket %d) dropped due to ACL",
6321 csp->ip_addr_str, csp->listen_addr_str, csp->cfd);
6322 close_socket(csp->cfd);
6323 freez(csp->ip_addr_str);
6324 freez(csp->listen_addr_str);
6328 #endif /* def FEATURE_ACL */
6330 if ((0 != config->max_client_connections)
6331 && (active_threads >= config->max_client_connections))
6333 log_error(LOG_LEVEL_ERROR,
6334 "Rejecting connection from %s. Maximum number of connections reached.",
6336 write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
6337 strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
6338 close_socket(csp->cfd);
6339 freez(csp->ip_addr_str);
6340 freez(csp->listen_addr_str);
6345 /* add it to the list of clients */
6346 csp_list->next = clients->next;
6347 clients->next = csp_list;
6349 if (config->multi_threaded)
6353 /* this is a switch () statement in the C preprocessor - ugh */
6354 #undef SELECTED_ONE_OPTION
6356 /* Use Pthreads in preference to native code */
6357 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
6358 #define SELECTED_ONE_OPTION
6360 pthread_t the_thread;
6363 ret = pthread_create(&the_thread, &attrs,
6364 (void * (*)(void *))serve, csp);
6365 child_id = ret ? -1 : 0;
6369 #if defined(_WIN32) && !defined(SELECTED_ONE_OPTION)
6370 #define SELECTED_ONE_OPTION
6371 child_id = _beginthread(
6372 (void (*)(void *))serve,
6377 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
6378 #define SELECTED_ONE_OPTION
6380 thread_id tid = spawn_thread
6381 (server_thread, "server", B_NORMAL_PRIORITY, csp);
6383 if ((tid >= 0) && (resume_thread(tid) == B_OK))
6385 child_id = (int) tid;
6394 #if !defined(SELECTED_ONE_OPTION)
6397 /* This block is only needed when using fork().
6398 * When using threads, the server thread was
6399 * created and run by the call to _beginthread().
6401 if (child_id == 0) /* child */
6404 #ifdef FEATURE_TOGGLE
6405 int inherited_toggle_state = global_toggle_state;
6406 #endif /* def FEATURE_TOGGLE */
6411 * If we've been toggled or we've blocked the request, tell Mom
6414 #ifdef FEATURE_TOGGLE
6415 if (inherited_toggle_state != global_toggle_state)
6417 rc |= RC_FLAG_TOGGLED;
6419 #endif /* def FEATURE_TOGGLE */
6421 #ifdef FEATURE_STATISTICS
6422 if (csp->flags & CSP_FLAG_REJECTED)
6424 rc |= RC_FLAG_BLOCKED;
6426 #endif /* ndef FEATURE_STATISTICS */
6430 else if (child_id > 0) /* parent */
6432 /* in a fork()'d environment, the parent's
6433 * copy of the client socket and the CSP
6437 #if !defined(_WIN32) && !defined(__CYGWIN__)
6439 wait(&child_status);
6442 * Evaluate child's return code: If the child has
6443 * - been toggled, toggle ourselves
6444 * - blocked its request, bump up the stats counter
6447 #ifdef FEATURE_TOGGLE
6448 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
6450 global_toggle_state = !global_toggle_state;
6452 #endif /* def FEATURE_TOGGLE */
6454 #ifdef FEATURE_STATISTICS
6456 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
6460 #endif /* def FEATURE_STATISTICS */
6462 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
6463 close_socket(csp->cfd);
6464 csp->flags &= ~CSP_FLAG_ACTIVE;
6468 #undef SELECTED_ONE_OPTION
6469 /* end of cpp switch () */
6474 * Spawning the child failed, assume it's because
6475 * there are too many children running already.
6476 * XXX: If you assume ...
6478 log_error(LOG_LEVEL_ERROR,
6479 "Unable to take any additional connections: %E. Active threads: %u",
6481 write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
6482 strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
6483 close_socket(csp->cfd);
6484 csp->flags &= ~CSP_FLAG_ACTIVE;
6493 #if defined(FEATURE_PTHREAD)
6494 pthread_attr_destroy(&attrs);
6497 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
6499 #ifdef FEATURE_GRACEFUL_TERMINATION
6501 log_error(LOG_LEVEL_INFO, "Graceful termination requested.");
6503 close_ports_helper(bfds);
6505 unload_current_config_file();
6506 unload_current_actions_file();
6507 unload_current_re_filterfile();
6508 #ifdef FEATURE_TRUST
6509 unload_current_trust_file();
6512 if (config->multi_threaded)
6519 } while ((clients->next != NULL) && (--i > 0));
6523 log_error(LOG_LEVEL_ERROR, "Graceful termination failed "
6524 "- still some live clients after 1 minute wait.");
6534 #ifdef FEATURE_HTTPS_INSPECTION
6536 * Only release TLS backed resources if there
6537 * are no active connections left.
6539 if (clients->next == NULL)
6545 log_error(LOG_LEVEL_INFO, "Exiting gracefully.");
6547 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
6548 /* Cleanup - remove taskbar icon etc. */
6553 #endif /* FEATURE_GRACEFUL_TERMINATION */