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-2021 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 #endif /* def FEATURE_STATISTICS */
132 #ifdef FEATURE_GRACEFUL_TERMINATION
137 static void sig_handler(int the_signal);
139 static int client_protocol_is_unsupported(struct client_state *csp, char *req);
140 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers);
141 static jb_err get_server_headers(struct client_state *csp);
142 static const char *crunch_reason(const struct http_response *rsp);
143 static void send_crunch_response(struct client_state *csp, struct http_response *rsp);
144 static char *get_request_line(struct client_state *csp);
145 static jb_err receive_client_request(struct client_state *csp);
146 static jb_err parse_client_request(struct client_state *csp);
147 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line);
148 static jb_err change_request_destination(struct client_state *csp);
149 static void handle_established_connection(struct client_state *csp);
150 static void chat(struct client_state *csp);
151 static void serve(struct client_state *csp);
152 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
153 static void usage(const char *myname);
155 static void initialize_mutexes(void);
156 static jb_socket bind_port_helper(const char *haddr, int hport, int backlog);
157 static void bind_ports_helper(struct configuration_spec *config, jb_socket sockets[]);
158 static void close_ports_helper(jb_socket sockets[]);
159 static void listen_loop(void);
160 static void serve(struct client_state *csp);
163 static int32 server_thread(void *data);
164 #endif /* def __BEOS__ */
167 #define sleep(N) Sleep(((N) * 1000))
171 int process_fuzzed_input(char *fuzz_input_type, char *fuzz_input_file);
172 void show_fuzz_usage(const char *name);
175 #ifdef MUTEX_LOCKS_AVAILABLE
177 * XXX: Does the locking stuff really belong in this file?
179 privoxy_mutex_t log_mutex;
180 privoxy_mutex_t log_init_mutex;
181 privoxy_mutex_t connection_reuse_mutex;
183 #ifdef FEATURE_HTTPS_INSPECTION
184 privoxy_mutex_t certificate_mutex;
185 privoxy_mutex_t ssl_init_mutex;
188 #ifdef FEATURE_EXTERNAL_FILTERS
189 privoxy_mutex_t external_filter_mutex;
191 #ifdef FEATURE_CLIENT_TAGS
192 privoxy_mutex_t client_tags_mutex;
194 #ifdef FEATURE_EXTENDED_STATISTICS
195 privoxy_mutex_t filter_statistics_mutex;
196 privoxy_mutex_t block_statistics_mutex;
199 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
200 privoxy_mutex_t resolver_mutex;
201 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
203 #ifndef HAVE_GMTIME_R
204 privoxy_mutex_t gmtime_mutex;
205 #endif /* ndef HAVE_GMTIME_R */
207 #ifndef HAVE_LOCALTIME_R
208 privoxy_mutex_t localtime_mutex;
209 #endif /* ndef HAVE_GMTIME_R */
211 #if !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM)
212 privoxy_mutex_t rand_mutex;
213 #endif /* !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM) */
215 #endif /* def MUTEX_LOCKS_AVAILABLE */
218 const char *basedir = NULL;
219 const char *pidfile = NULL;
220 static int received_hup_signal = 0;
221 #endif /* defined unix */
223 /* HTTP snipplets. */
224 static const char CSUCCEED[] =
225 "HTTP/1.1 200 Connection established\r\n\r\n";
227 static const char CHEADER[] =
228 "HTTP/1.1 400 Invalid header received from client\r\n"
229 "Content-Type: text/plain\r\n"
230 "Connection: close\r\n\r\n"
231 "Invalid header received from client.\r\n";
233 static const char FTP_RESPONSE[] =
234 "HTTP/1.1 400 Invalid request received from client\r\n"
235 "Content-Type: text/plain\r\n"
236 "Connection: close\r\n\r\n"
237 "Invalid request. Privoxy doesn't support FTP.\r\n";
239 static const char GOPHER_RESPONSE[] =
240 "HTTP/1.1 400 Invalid request received from client\r\n"
241 "Content-Type: text/plain\r\n"
242 "Connection: close\r\n\r\n"
243 "Invalid request. Privoxy doesn't support gopher.\r\n";
245 /* XXX: should be a template */
246 static const char MISSING_DESTINATION_RESPONSE[] =
247 "HTTP/1.1 400 Bad request received from client\r\n"
248 "Content-Type: text/plain\r\n"
249 "Connection: close\r\n\r\n"
250 "Bad request. Privoxy was unable to extract the destination.\r\n";
252 /* XXX: should be a template */
253 static const char INVALID_SERVER_HEADERS_RESPONSE[] =
254 "HTTP/1.1 502 Server or forwarder response invalid\r\n"
255 "Content-Type: text/plain\r\n"
256 "Connection: close\r\n\r\n"
257 "Bad response. The server or forwarder response doesn't look like HTTP.\r\n";
259 /* XXX: should be a template */
260 static const char MESSED_UP_REQUEST_RESPONSE[] =
261 "HTTP/1.1 400 Malformed request after rewriting\r\n"
262 "Content-Type: text/plain\r\n"
263 "Connection: close\r\n\r\n"
264 "Bad request. Messed up with header filters.\r\n";
266 static const char TOO_MANY_CONNECTIONS_RESPONSE[] =
267 "HTTP/1.1 503 Too many open connections\r\n"
268 "Content-Type: text/plain\r\n"
269 "Connection: close\r\n\r\n"
270 "Maximum number of open connections reached.\r\n";
272 static const char CLIENT_CONNECTION_TIMEOUT_RESPONSE[] =
273 "HTTP/1.1 504 Connection timeout\r\n"
274 "Content-Type: text/plain\r\n"
275 "Connection: close\r\n\r\n"
276 "The connection timed out because the client request didn't arrive in time.\r\n";
278 static const char CLIENT_BODY_PARSE_ERROR_RESPONSE[] =
279 "HTTP/1.1 400 Failed reading client body\r\n"
280 "Content-Type: text/plain\r\n"
281 "Connection: close\r\n\r\n"
282 "Failed parsing or buffering the chunk-encoded client body.\r\n";
284 static const char UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE[] =
285 "HTTP/1.1 417 Expecting too much\r\n"
286 "Content-Type: text/plain\r\n"
287 "Connection: close\r\n\r\n"
288 "Privoxy detected an unsupported Expect header value.\r\n";
290 /* A function to crunch a response */
291 typedef struct http_response *(*crunch_func_ptr)(struct client_state *);
293 /* Crunch function flags */
294 #define CF_NO_FLAGS 0
295 /* Cruncher applies to forced requests as well */
296 #define CF_IGNORE_FORCE 1
297 /* Crunched requests are counted for the block statistics */
298 #define CF_COUNT_AS_REJECT 2
300 /* A crunch function and its flags */
303 const crunch_func_ptr cruncher;
307 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[]);
309 /* Complete list of cruncher functions */
310 static const struct cruncher crunchers_all[] = {
311 { direct_response, CF_COUNT_AS_REJECT|CF_IGNORE_FORCE},
312 { block_url, CF_COUNT_AS_REJECT },
314 { trust_url, CF_COUNT_AS_REJECT },
315 #endif /* def FEATURE_TRUST */
316 { redirect_url, CF_NO_FLAGS },
317 { dispatch_cgi, CF_IGNORE_FORCE},
321 /* Light version, used after tags are applied */
322 static const struct cruncher crunchers_light[] = {
323 { block_url, CF_COUNT_AS_REJECT },
324 { redirect_url, CF_NO_FLAGS },
330 * XXX: Don't we really mean
337 /*********************************************************************
339 * Function : sig_handler
341 * Description : Signal handler for different signals.
342 * Exit gracefully on TERM and INT
343 * or set a flag that will cause the errlog
344 * to be reopened by the main thread on HUP.
347 * 1 : the_signal = the signal cause this function to call
351 *********************************************************************/
352 static void sig_handler(int the_signal)
358 log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
370 received_hup_signal = 1;
376 * We shouldn't be here, unless we catch signals
377 * in main() that we can't handle here!
379 log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
387 /*********************************************************************
389 * Function : get_write_delay
391 * Description : Parse the delay-response parameter.
394 * 1 : csp = Current client state (buffers, headers, etc...)
396 * Returns : Number of milliseconds to delay writes.
398 *********************************************************************/
399 static unsigned int get_write_delay(const struct client_state *csp)
405 if ((csp->action->flags & ACTION_DELAY_RESPONSE) == 0)
409 newval = csp->action->string[ACTION_STRING_DELAY_RESPONSE];
411 delay = (unsigned)strtol(newval, &endptr, 0);
414 log_error(LOG_LEVEL_FATAL,
415 "Invalid delay-response{} parameter: '%s'", newval);
423 /*********************************************************************
425 * Function : client_protocol_is_unsupported
427 * Description : Checks if the client used a known unsupported
428 * protocol and deals with it by sending an error
432 * 1 : csp = Current client state (buffers, headers, etc...)
433 * 2 : req = the first request line send by the client
435 * Returns : TRUE if an error response has been generated, or
436 * FALSE if the request doesn't look invalid.
438 *********************************************************************/
439 static int client_protocol_is_unsupported(struct client_state *csp, char *req)
442 * If it's a FTP or gopher request, we don't support it.
444 * These checks are better than nothing, but they might
445 * not work in all configurations and some clients might
446 * have problems digesting the answer.
448 * They should, however, never cause more problems than
449 * Privoxy's old behaviour (returning the misleading HTML
452 * "Could not resolve http://(ftp|gopher)://example.org").
454 if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
456 const char *response = NULL;
457 const char *protocol = NULL;
459 if (!strncmpic(req, "GET ftp://", 10))
461 response = FTP_RESPONSE;
466 response = GOPHER_RESPONSE;
469 log_error(LOG_LEVEL_ERROR,
470 "%s tried to use Privoxy as %s proxy: %s",
471 csp->ip_addr_str, protocol, req);
472 log_error(LOG_LEVEL_CLF,
473 "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, req);
476 #ifdef FEATURE_HTTPS_INSPECTION
477 if (client_use_ssl(csp))
479 ssl_send_data_delayed(&(csp->ssl_client_attr),
480 (const unsigned char *)response, strlen(response),
481 get_write_delay(csp));
486 write_socket_delayed(csp->cfd, response, strlen(response),
487 get_write_delay(csp));
497 /*********************************************************************
499 * Function : client_has_unsupported_expectations
501 * Description : Checks if the client used an unsupported expectation
502 * in which case an error message is delivered.
505 * 1 : csp = Current client state (buffers, headers, etc...)
507 * Returns : TRUE if an error response has been generated, or
508 * FALSE if the request doesn't look invalid.
510 *********************************************************************/
511 static int client_has_unsupported_expectations(const struct client_state *csp)
513 if ((csp->flags & CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION))
515 log_error(LOG_LEVEL_ERROR,
516 "Rejecting request from client %s with unsupported Expect header value",
518 log_error(LOG_LEVEL_CLF,
519 "%s - - [%T] \"%s\" 417 0", csp->ip_addr_str, csp->http->cmd);
520 write_socket_delayed(csp->cfd,
521 UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE,
522 strlen(UNSUPPORTED_CLIENT_EXPECTATION_ERROR_RESPONSE),
523 get_write_delay(csp));
533 /*********************************************************************
535 * Function : get_request_destination_elsewhere
537 * Description : If the client's request was redirected into
538 * Privoxy without the client's knowledge,
539 * the request line lacks the destination host.
541 * This function tries to get it elsewhere,
542 * provided accept-intercepted-requests is enabled.
544 * "Elsewhere" currently only means "Host: header",
545 * but in the future we may ask the redirecting
546 * packet filter to look the destination up.
548 * If the destination stays unknown, an error
549 * response is send to the client and headers
550 * are freed so that chat() can return directly.
553 * 1 : csp = Current client state (buffers, headers, etc...)
554 * 2 : headers = a header list
556 * Returns : JB_ERR_OK if the destination is now known, or
557 * JB_ERR_PARSE if it isn't.
559 *********************************************************************/
560 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
562 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
564 log_error(LOG_LEVEL_ERROR, "%s's request: \'%s\' is invalid."
565 " Privoxy isn't configured to accept intercepted requests.",
566 csp->ip_addr_str, csp->http->cmd);
567 /* XXX: Use correct size */
568 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
569 csp->ip_addr_str, csp->http->cmd);
571 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER),
572 get_write_delay(csp));
573 destroy_list(headers);
577 else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
579 /* Split the domain we just got for pattern matching */
580 init_domain_components(csp->http);
586 /* We can't work without destination. Go spread the news.*/
588 /* XXX: Use correct size */
589 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
590 csp->ip_addr_str, csp->http->cmd);
591 log_error(LOG_LEVEL_ERROR,
592 "Privoxy was unable to get the destination for %s's request: %s",
593 csp->ip_addr_str, csp->http->cmd);
595 write_socket_delayed(csp->cfd, MISSING_DESTINATION_RESPONSE,
596 strlen(MISSING_DESTINATION_RESPONSE), get_write_delay(csp));
597 destroy_list(headers);
602 * TODO: If available, use PF's ioctl DIOCNATLOOK as last resort
603 * to get the destination IP address, use it as host directly
604 * or do a reverse DNS lookup first.
609 /*********************************************************************
611 * Function : get_server_headers
613 * Description : Parses server headers in iob and fills them
614 * into csp->headers so that they can later be
618 * 1 : csp = Current client state (buffers, headers, etc...)
620 * Returns : JB_ERR_OK if everything went fine, or
621 * JB_ERR_PARSE if the headers were incomplete.
623 *********************************************************************/
624 static jb_err get_server_headers(struct client_state *csp)
626 int continue_hack_in_da_house = 0;
629 while (((header = get_header(csp->iob)) != NULL) || continue_hack_in_da_house)
634 * continue hack in da house. Ignore the ending of
635 * this head and continue enlisting header lines.
636 * The reason is described below.
638 enlist(csp->headers, "");
639 continue_hack_in_da_house = 0;
642 else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
645 * It's a bodyless continue response, don't
646 * stop header parsing after reaching its end.
648 * As a result Privoxy will concatenate the
649 * next response's head and parse and deliver
650 * the headers as if they belonged to one request.
652 * The client will separate them because of the
653 * empty line between them.
655 * XXX: What we're doing here is clearly against
656 * the intended purpose of the continue header,
657 * and under some conditions (HTTP/1.0 client request)
658 * it's a standard violation.
660 * Anyway, "sort of against the spec" is preferable
661 * to "always getting confused by Continue responses"
662 * (Privoxy's behaviour before this hack was added)
664 log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
665 continue_hack_in_da_house = 1;
667 else if (*header == '\0')
670 * If the header is empty, but the Continue hack
671 * isn't active, we can assume that we reached the
672 * end of the buffer before we hit the end of the
675 * Inform the caller an let it decide how to handle it.
680 if (JB_ERR_MEMORY == enlist(csp->headers, header))
683 * XXX: Should we quit the request and return a
684 * out of memory error page instead?
686 log_error(LOG_LEVEL_ERROR,
687 "Out of memory while enlisting server headers. %s lost.",
697 /*********************************************************************
699 * Function : crunch_reason
701 * Description : Translates the crunch reason code into a string.
704 * 1 : rsp = a http_response
706 * Returns : A string with the crunch reason or an error description.
708 *********************************************************************/
709 static const char *crunch_reason(const struct http_response *rsp)
711 char * reason = NULL;
716 return "Internal error while searching for crunch reason";
719 switch (rsp->crunch_reason)
722 reason = "Unsupported HTTP feature";
728 reason = "Untrusted";
731 reason = "Redirected";
737 reason = "DNS failure";
739 case FORWARDING_FAILED:
740 reason = "Forwarding failed";
743 reason = "Connection failure";
746 reason = "Out of memory (may mask other reasons)";
748 case CONNECTION_TIMEOUT:
749 reason = "Connection timeout";
752 reason = "No server data received";
755 reason = "No reason recorded";
763 /*********************************************************************
765 * Function : log_applied_actions
767 * Description : Logs the applied actions if LOG_LEVEL_ACTIONS is
771 * 1 : actions = Current action spec to log
775 *********************************************************************/
776 static void log_applied_actions(const struct current_action_spec *actions)
779 * The conversion to text requires lots of memory allocations so
780 * we only do the conversion if the user is actually interested.
782 if (debug_level_is_enabled(LOG_LEVEL_ACTIONS))
784 char *actions_as_text = actions_to_line_of_text(actions);
785 log_error(LOG_LEVEL_ACTIONS, "%s", actions_as_text);
786 freez(actions_as_text);
791 /*********************************************************************
793 * Function : send_crunch_response
795 * Description : Delivers already prepared response for
796 * intercepted requests, logs the interception
797 * and frees the response.
800 * 1 : csp = Current client state (buffers, headers, etc...)
801 * 2 : rsp = Fully prepared response. Will be freed on exit.
805 *********************************************************************/
806 static void send_crunch_response(struct client_state *csp, struct http_response *rsp)
808 const struct http_request *http = csp->http;
812 assert(rsp->head != NULL);
816 log_error(LOG_LEVEL_FATAL, "NULL response in send_crunch_response.");
820 * Extract the status code from the actual head
821 * that will be send to the client. It is the only
822 * way to get it right for all requests, including
823 * the fixed ones for out-of-memory problems.
825 * A head starts like this: 'HTTP/1.1 200...'
829 status_code[0] = rsp->head[9];
830 status_code[1] = rsp->head[10];
831 status_code[2] = rsp->head[11];
832 status_code[3] = '\0';
834 /* Log that the request was crunched and why. */
835 log_applied_actions(csp->action);
836 #ifdef FEATURE_HTTPS_INSPECTION
837 if (client_use_ssl(csp))
839 log_error(LOG_LEVEL_CRUNCH, "%s: https://%s%s", crunch_reason(rsp),
840 http->hostport, http->path);
841 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s https://%s%s %s\" %s %lu",
842 csp->ip_addr_str, http->gpc, http->hostport, http->path,
843 http->version, status_code, rsp->content_length);
848 log_error(LOG_LEVEL_CRUNCH, "%s: %s", crunch_reason(rsp), http->url);
849 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" %s %lu",
850 csp->ip_addr_str, http->ocmd, status_code, rsp->content_length);
852 /* Write the answer to the client */
853 #ifdef FEATURE_HTTPS_INSPECTION
854 if (client_use_ssl(csp))
856 if ((ssl_send_data_delayed(&(csp->ssl_client_attr),
857 (const unsigned char *)rsp->head, rsp->head_length,
858 get_write_delay(csp)) < 0)
859 || (ssl_send_data_delayed(&(csp->ssl_client_attr),
860 (const unsigned char *)rsp->body, rsp->content_length,
861 get_write_delay(csp)) < 0))
863 /* There is nothing we can do about it. */
864 log_error(LOG_LEVEL_CONNECT, "Couldn't deliver the error message "
865 "for https://%s%s through client socket %d using TLS/SSL",
866 http->hostport, http->url, csp->cfd);
872 if (write_socket_delayed(csp->cfd, rsp->head, rsp->head_length,
873 get_write_delay(csp))
874 || write_socket_delayed(csp->cfd, rsp->body, rsp->content_length,
875 get_write_delay(csp)))
877 /* There is nothing we can do about it. */
878 log_error(LOG_LEVEL_CONNECT,
879 "Couldn't deliver the error message for %s through client socket %d: %E",
880 http->url, csp->cfd);
884 /* Clean up and return */
885 if (cgi_error_memory() != rsp)
887 free_http_response(rsp);
893 /*********************************************************************
895 * Function : crunch_response_triggered
897 * Description : Checks if the request has to be crunched,
898 * and delivers the crunch response if necessary.
901 * 1 : csp = Current client state (buffers, headers, etc...)
902 * 2 : crunchers = list of cruncher functions to run
904 * Returns : TRUE if the request was answered with a crunch response
907 *********************************************************************/
908 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[])
910 struct http_response *rsp = NULL;
911 const struct cruncher *c;
914 * If CGI request crunching is disabled,
915 * check the CGI dispatcher out of order to
916 * prevent unintentional blocks or redirects.
918 if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_CRUNCHING)
919 && (NULL != (rsp = dispatch_cgi(csp))))
921 /* Deliver, log and free the interception response. */
922 send_crunch_response(csp, rsp);
923 csp->flags |= CSP_FLAG_CRUNCHED;
927 for (c = crunchers; c->cruncher != NULL; c++)
930 * Check the cruncher if either Privoxy is toggled
931 * on and the request isn't forced, or if the cruncher
932 * applies to forced requests as well.
934 if (((csp->flags & CSP_FLAG_TOGGLED_ON) &&
935 !(csp->flags & CSP_FLAG_FORCED)) ||
936 (c->flags & CF_IGNORE_FORCE))
938 rsp = c->cruncher(csp);
941 /* Deliver, log and free the interception response. */
942 send_crunch_response(csp, rsp);
943 csp->flags |= CSP_FLAG_CRUNCHED;
944 #ifdef FEATURE_STATISTICS
945 if (c->flags & CF_COUNT_AS_REJECT)
947 csp->flags |= CSP_FLAG_REJECTED;
949 #endif /* def FEATURE_STATISTICS */
960 /*********************************************************************
962 * Function : build_request_line
964 * Description : Builds the HTTP request line.
966 * If a HTTP forwarder is used it expects the whole URL,
967 * web servers only get the path.
970 * 1 : csp = Current client state (buffers, headers, etc...)
971 * 2 : fwd = The forwarding spec used for the request.
973 * 3 : request_line = The old request line which will be replaced.
975 * Returns : Nothing. Terminates in case of memory problems.
977 *********************************************************************/
978 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line)
980 struct http_request *http = csp->http;
983 * Downgrade http version from 1.1 to 1.0
984 * if +downgrade action applies.
986 if ((csp->action->flags & ACTION_DOWNGRADE)
987 && (!strcmpic(http->version, "HTTP/1.1")))
989 freez(http->version);
990 http->version = strdup_or_die("HTTP/1.0");
994 * Rebuild the request line.
996 freez(*request_line);
997 *request_line = strdup(http->gpc);
998 string_append(request_line, " ");
1000 if (fwd != NULL && fwd->forward_host && fwd->type != FORWARD_WEBSERVER)
1002 string_append(request_line, http->url);
1006 string_append(request_line, http->path);
1008 string_append(request_line, " ");
1009 string_append(request_line, http->version);
1011 if (*request_line == NULL)
1013 log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
1015 log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", *request_line);
1019 /*********************************************************************
1021 * Function : change_request_destination
1023 * Description : Parse a (rewritten) request line and regenerate
1024 * the http request data.
1027 * 1 : csp = Current client state (buffers, headers, etc...)
1029 * Returns : Forwards the parse_http_request() return code.
1030 * Terminates in case of memory problems.
1032 *********************************************************************/
1033 static jb_err change_request_destination(struct client_state *csp)
1035 struct http_request *http = csp->http;
1038 log_error(LOG_LEVEL_REDIRECTS, "Rewrite detected: %s",
1039 csp->headers->first->str);
1040 free_http_request(http);
1041 err = parse_http_request(csp->headers->first->str, http);
1042 if (JB_ERR_OK != err)
1044 log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
1045 jb_err_to_string(err));
1047 if (http->ssl && strcmpic(csp->http->gpc, "CONNECT"))
1050 * A client header filter changed the request URL from
1051 * http:// to https:// which we currently don't support.
1053 log_error(LOG_LEVEL_ERROR, "Changing the request destination from http "
1054 "to https behind the client's back currently isn't supported.");
1055 return JB_ERR_PARSE;
1062 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1063 /*********************************************************************
1065 * Function : server_response_is_complete
1067 * Description : Determines whether we should stop reading
1068 * from the server socket.
1071 * 1 : csp = Current client state (buffers, headers, etc...)
1072 * 2 : content_length = Length of content received so far.
1074 * Returns : TRUE if the response is complete,
1077 *********************************************************************/
1078 static int server_response_is_complete(struct client_state *csp,
1079 unsigned long long content_length)
1081 int content_length_known = !!(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET);
1083 if (!strcmpic(csp->http->gpc, "HEAD"))
1086 * "HEAD" implies no body, we are thus expecting
1087 * no content. XXX: incomplete "list" of methods?
1089 csp->expected_content_length = 0;
1090 content_length_known = TRUE;
1091 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1094 if (csp->http->status == 204 || csp->http->status == 304)
1097 * Expect no body. XXX: incomplete "list" of status codes?
1099 csp->expected_content_length = 0;
1100 content_length_known = TRUE;
1101 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1104 return (content_length_known && ((0 == csp->expected_content_length)
1105 || (csp->expected_content_length <= content_length)));
1109 #ifdef FEATURE_CONNECTION_SHARING
1110 /*********************************************************************
1112 * Function : wait_for_alive_connections
1114 * Description : Waits for alive connections to timeout.
1120 *********************************************************************/
1121 static void wait_for_alive_connections(void)
1123 int connections_alive = close_unusable_connections();
1125 while (0 < connections_alive)
1127 log_error(LOG_LEVEL_CONNECT,
1128 "Waiting for %d connections to timeout.",
1131 connections_alive = close_unusable_connections();
1134 log_error(LOG_LEVEL_CONNECT, "No connections to wait for left.");
1137 #endif /* def FEATURE_CONNECTION_SHARING */
1140 /*********************************************************************
1142 * Function : save_connection_destination
1144 * Description : Remembers a connection for reuse later on.
1147 * 1 : sfd = Open socket to remember.
1148 * 2 : http = The destination for the connection.
1149 * 3 : fwd = The forwarder settings used.
1150 * 4 : server_connection = storage.
1154 *********************************************************************/
1155 void save_connection_destination(jb_socket sfd,
1156 const struct http_request *http,
1157 const struct forward_spec *fwd,
1158 struct reusable_connection *server_connection)
1160 assert(sfd != JB_INVALID_SOCKET);
1161 assert(NULL != http->host);
1163 server_connection->sfd = sfd;
1164 server_connection->host = strdup_or_die(http->host);
1165 server_connection->port = http->port;
1167 assert(NULL != fwd);
1168 assert(server_connection->gateway_host == NULL);
1169 assert(server_connection->gateway_port == 0);
1170 assert(server_connection->forwarder_type == 0);
1171 assert(server_connection->forward_host == NULL);
1172 assert(server_connection->forward_port == 0);
1174 server_connection->forwarder_type = fwd->type;
1175 if (NULL != fwd->gateway_host)
1177 server_connection->gateway_host = strdup_or_die(fwd->gateway_host);
1181 server_connection->gateway_host = NULL;
1183 server_connection->gateway_port = fwd->gateway_port;
1184 if (NULL != fwd->auth_username)
1186 server_connection->auth_username = strdup_or_die(fwd->auth_username);
1190 server_connection->auth_username = NULL;
1192 if (NULL != fwd->auth_password)
1194 server_connection->auth_password = strdup_or_die(fwd->auth_password);
1198 server_connection->auth_password = NULL;
1201 if (NULL != fwd->forward_host)
1203 server_connection->forward_host = strdup_or_die(fwd->forward_host);
1207 server_connection->forward_host = NULL;
1209 server_connection->forward_port = fwd->forward_port;
1211 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1214 /*********************************************************************
1216 * Function : verify_request_length
1218 * Description : Checks if we already got the whole client requests
1219 * and sets CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ if
1222 * Data that doesn't belong to the current request is
1223 * either thrown away to let the client retry on a clean
1224 * socket, or stashed to be dealt with after the current
1225 * request is served.
1228 * 1 : csp = Current client state (buffers, headers, etc...)
1232 *********************************************************************/
1233 static void verify_request_length(struct client_state *csp)
1235 unsigned long long buffered_request_bytes =
1236 (unsigned long long)(csp->client_iob->eod - csp->client_iob->cur);
1238 if ((csp->expected_client_content_length != 0)
1239 && (buffered_request_bytes != 0))
1241 if (csp->expected_client_content_length >= buffered_request_bytes)
1243 csp->expected_client_content_length -= buffered_request_bytes;
1244 log_error(LOG_LEVEL_CONNECT, "Reduced expected bytes to %llu "
1245 "to account for the %llu ones we already got.",
1246 csp->expected_client_content_length, buffered_request_bytes);
1250 assert(csp->client_iob->eod > csp->client_iob->cur + csp->expected_client_content_length);
1251 csp->client_iob->eod = csp->client_iob->cur + csp->expected_client_content_length;
1252 log_error(LOG_LEVEL_CONNECT, "Reducing expected bytes to 0. "
1253 "Marking the server socket tainted after throwing %llu bytes away.",
1254 buffered_request_bytes - csp->expected_client_content_length);
1255 csp->expected_client_content_length = 0;
1256 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1259 if (csp->expected_client_content_length == 0)
1261 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1265 if (!(csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ)
1266 && ((csp->client_iob->cur < csp->client_iob->eod)
1267 || (csp->expected_client_content_length != 0)))
1269 if (strcmpic(csp->http->gpc, "GET")
1270 && strcmpic(csp->http->gpc, "HEAD")
1271 && strcmpic(csp->http->gpc, "TRACE")
1272 && strcmpic(csp->http->gpc, "OPTIONS")
1273 && strcmpic(csp->http->gpc, "DELETE"))
1275 /* XXX: this is an incomplete hack */
1276 csp->flags &= ~CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1277 log_error(LOG_LEVEL_CONNECT, "There better be a request body.");
1281 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1283 if ((csp->config->feature_flags & RUNTIME_FEATURE_TOLERATE_PIPELINING) == 0)
1285 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1286 log_error(LOG_LEVEL_CONNECT,
1287 "Possible pipeline attempt detected. The connection will not "
1288 "be kept alive and we will only serve the first request.");
1289 /* Nuke the pipelined requests from orbit, just to be sure. */
1290 clear_iob(csp->client_iob);
1295 * Keep the pipelined data around for now, we'll deal with
1296 * it once we're done serving the current request.
1298 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
1299 assert(csp->client_iob->eod >= csp->client_iob->cur);
1300 log_error(LOG_LEVEL_CONNECT, "Complete client request followed by "
1301 "%d bytes of pipelined data received.",
1302 (int)(csp->client_iob->eod - csp->client_iob->cur));
1308 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1309 log_error(LOG_LEVEL_CONNECT, "Complete client request received.");
1314 /*********************************************************************
1316 * Function : mark_server_socket_tainted
1318 * Description : Makes sure we don't reuse a server socket
1319 * (if we didn't read everything the server sent
1320 * us reusing the socket would lead to garbage).
1323 * 1 : csp = Current client state (buffers, headers, etc...)
1327 *********************************************************************/
1328 static void mark_server_socket_tainted(struct client_state *csp)
1331 * For consistency we always mark the server socket
1332 * tainted, however, to reduce the log noise we only
1333 * emit a log message if the server socket could have
1334 * actually been reused.
1336 if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
1337 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED))
1339 log_error(LOG_LEVEL_CONNECT,
1340 "Marking the server socket %d tainted.",
1341 csp->server_connection.sfd);
1343 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1346 /*********************************************************************
1348 * Function : get_request_line
1350 * Description : Read the client request line.
1353 * 1 : csp = Current client state (buffers, headers, etc...)
1355 * Returns : Pointer to request line or NULL in case of errors.
1357 *********************************************************************/
1358 static char *get_request_line(struct client_state *csp)
1360 char buf[BUFFER_SIZE];
1361 char *request_line = NULL;
1364 memset(buf, 0, sizeof(buf));
1366 if ((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
1369 * If there are multiple pipelined requests waiting,
1370 * the flag will be set again once the next request
1373 csp->flags &= ~CSP_FLAG_PIPELINED_REQUEST_WAITING;
1375 request_line = get_header(csp->client_iob);
1376 if ((NULL != request_line) && ('\0' != *request_line))
1378 return request_line;
1382 log_error(LOG_LEVEL_CONNECT, "No complete request line "
1383 "received yet. Continuing reading from %d.", csp->cfd);
1391 0 == (csp->flags & CSP_FLAG_FUZZED_INPUT) &&
1393 !data_is_available(csp->cfd, csp->config->socket_timeout)
1396 if (socket_is_still_alive(csp->cfd))
1398 log_error(LOG_LEVEL_CONNECT,
1399 "No request line on socket %d received in time. Timeout: %d.",
1400 csp->cfd, csp->config->socket_timeout);
1401 write_socket_delayed(csp->cfd, CLIENT_CONNECTION_TIMEOUT_RESPONSE,
1402 strlen(CLIENT_CONNECTION_TIMEOUT_RESPONSE),
1403 get_write_delay(csp));
1407 log_error(LOG_LEVEL_CONNECT,
1408 "The client side of the connection on socket %d got "
1409 "closed without sending a complete request line.", csp->cfd);
1414 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1416 if (len <= 0) return NULL;
1419 * If there is no memory left for buffering the
1420 * request, there is nothing we can do but hang up
1422 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1427 request_line = get_header(csp->client_iob);
1429 } while ((NULL != request_line) && ('\0' == *request_line));
1431 return request_line;
1437 CHUNK_STATUS_MISSING_DATA,
1438 CHUNK_STATUS_BODY_COMPLETE,
1439 CHUNK_STATUS_PARSE_ERROR
1443 /*********************************************************************
1445 * Function : chunked_body_is_complete
1447 * Description : Figures out whether or not a chunked body is complete.
1449 * Currently it always starts at the beginning of the
1450 * buffer which is somewhat wasteful and prevents Privoxy
1451 * from starting to forward the correctly parsed chunks
1452 * as soon as theoretically possible.
1454 * Should be modified to work with a common buffer,
1455 * and allow the caller to skip already parsed chunks.
1457 * This would allow the function to be used for unbuffered
1458 * response bodies as well.
1461 * 1 : iob = Buffer with the body to check.
1462 * 2 : length = Length of complete body
1464 * Returns : Enum with the result of the check.
1466 *********************************************************************/
1467 static enum chunk_status chunked_body_is_complete(struct iob *iob, size_t *length)
1469 unsigned int chunksize;
1475 * We need at least a single digit, followed by "\r\n",
1476 * followed by an unknown amount of data, followed by "\r\n".
1478 if (p + 5 > iob->eod)
1480 return CHUNK_STATUS_MISSING_DATA;
1482 if (sscanf(p, "%x", &chunksize) != 1)
1484 return CHUNK_STATUS_PARSE_ERROR;
1488 * We want at least a single digit, followed by "\r\n",
1489 * followed by the specified amount of data, followed by "\r\n".
1491 if (p + chunksize + 5 > iob->eod)
1493 return CHUNK_STATUS_MISSING_DATA;
1496 /* Skip chunk-size. */
1497 p = strstr(p, "\r\n");
1500 return CHUNK_STATUS_PARSE_ERROR;
1502 /* Move beyond the chunkdata. */
1505 /* There should be another "\r\n" to skip */
1506 if (memcmp(p, "\r\n", 2))
1508 return CHUNK_STATUS_PARSE_ERROR;
1511 } while (chunksize > 0U);
1513 *length = (size_t)(p - iob->cur);
1514 assert(*length <= (size_t)(iob->eod - iob->cur));
1515 assert(p <= iob->eod);
1517 return CHUNK_STATUS_BODY_COMPLETE;
1522 /*********************************************************************
1524 * Function : receive_chunked_client_request_body
1526 * Description : Read the chunk-encoded client request body.
1527 * Failures are dealt with.
1530 * 1 : csp = Current client state (buffers, headers, etc...)
1532 * Returns : JB_ERR_OK or JB_ERR_PARSE
1534 *********************************************************************/
1535 static jb_err receive_chunked_client_request_body(struct client_state *csp)
1538 enum chunk_status status;
1540 while (CHUNK_STATUS_MISSING_DATA ==
1541 (status = chunked_body_is_complete(csp->client_iob, &body_length)))
1543 char buf[BUFFER_SIZE];
1546 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1548 log_error(LOG_LEVEL_ERROR,
1549 "Timeout while waiting for the client body.");
1552 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1555 log_error(LOG_LEVEL_ERROR, "Read the client body failed: %E");
1558 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1563 if (status != CHUNK_STATUS_BODY_COMPLETE)
1565 write_socket_delayed(csp->cfd, CLIENT_BODY_PARSE_ERROR_RESPONSE,
1566 strlen(CLIENT_BODY_PARSE_ERROR_RESPONSE), get_write_delay(csp));
1567 log_error(LOG_LEVEL_CLF,
1568 "%s - - [%T] \"Failed reading chunked client body\" 400 0", csp->ip_addr_str);
1569 return JB_ERR_PARSE;
1571 log_error(LOG_LEVEL_CONNECT,
1572 "Chunked client body completely read. Length: %lu", body_length);
1573 csp->expected_client_content_length = body_length;
1581 /*********************************************************************
1583 * Function : fuzz_chunked_transfer_encoding
1585 * Description : Treat the fuzzed input as chunked transfer encoding
1586 * to check and dechunk.
1589 * 1 : csp = Used to store the data.
1590 * 2 : fuzz_input_file = File to read the input from.
1592 * Returns : Result of dechunking
1594 *********************************************************************/
1595 extern int fuzz_chunked_transfer_encoding(struct client_state *csp, char *fuzz_input_file)
1598 size_t size = (size_t)(csp->iob->eod - csp->iob->cur);
1599 enum chunk_status status;
1601 status = chunked_body_is_complete(csp->iob, &length);
1602 if (CHUNK_STATUS_BODY_COMPLETE != status)
1604 log_error(LOG_LEVEL_INFO, "Chunked body is incomplete or invalid");
1607 return (JB_ERR_OK == remove_chunked_transfer_coding(csp->iob->cur, &size));
1612 /*********************************************************************
1614 * Function : fuzz_client_request
1616 * Description : Try to get a client request from the fuzzed input.
1619 * 1 : csp = Current client state (buffers, headers, etc...)
1620 * 2 : fuzz_input_file = File to read the input from.
1622 * Returns : Result of fuzzing.
1624 *********************************************************************/
1625 extern int fuzz_client_request(struct client_state *csp, char *fuzz_input_file)
1630 csp->ip_addr_str = "fuzzer";
1632 if (strcmp(fuzz_input_file, "-") != 0)
1634 log_error(LOG_LEVEL_FATAL,
1635 "Fuzzed client requests can currently only be read from stdin (-).");
1637 err = receive_client_request(csp);
1638 if (err != JB_ERR_OK)
1642 err = parse_client_request(csp);
1643 if (err != JB_ERR_OK)
1651 #endif /* def FUZZ */
1654 #ifdef FEATURE_FORCE_LOAD
1655 /*********************************************************************
1657 * Function : force_required
1659 * Description : Checks a request line to see if it contains
1660 * the FORCE_PREFIX. If it does, it is removed
1661 * unless enforcing requests has beend disabled.
1664 * 1 : request_line = HTTP request line
1666 * Returns : TRUE if force is required, FALSE otherwise.
1668 *********************************************************************/
1669 static int force_required(const struct client_state *csp, char *request_line)
1673 p = strstr(request_line, "http://");
1677 p += strlen("http://");
1681 /* Intercepted request usually don't specify the protocol. */
1685 /* Go to the beginning of the path */
1690 * If the path is missing the request line is invalid and we
1691 * are done here. The client-visible rejection happens later on.
1696 if (0 == strncmpic(p, FORCE_PREFIX, strlen(FORCE_PREFIX) - 1))
1698 if (!(csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS))
1700 /* XXX: Should clean more carefully */
1701 strclean(request_line, FORCE_PREFIX);
1702 log_error(LOG_LEVEL_FORCE,
1703 "Enforcing request: \"%s\".", request_line);
1707 log_error(LOG_LEVEL_FORCE,
1708 "Ignored force prefix in request: \"%s\".", request_line);
1714 #endif /* def FEATURE_FORCE_LOAD */
1717 /*********************************************************************
1719 * Function : receive_client_request
1721 * Description : Read the client's request (more precisely the
1722 * client headers) and answer it if necessary.
1725 * 1 : csp = Current client state (buffers, headers, etc...)
1727 * Returns : JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
1729 *********************************************************************/
1730 static jb_err receive_client_request(struct client_state *csp)
1732 char buf[BUFFER_SIZE];
1735 struct http_request *http;
1739 /* Temporary copy of the client's headers before they get enlisted in csp->headers */
1740 struct list header_list;
1741 struct list *headers = &header_list;
1743 /* We don't care if the arriving data is a valid HTTP request or not. */
1744 csp->requests_received_total++;
1748 memset(buf, 0, sizeof(buf));
1750 req = get_request_line(csp);
1753 mark_server_socket_tainted(csp);
1754 return JB_ERR_PARSE;
1756 assert(*req != '\0');
1758 if (client_protocol_is_unsupported(csp, req))
1760 return JB_ERR_PARSE;
1763 #ifdef FEATURE_FORCE_LOAD
1764 if (force_required(csp, req))
1766 csp->flags |= CSP_FLAG_FORCED;
1768 #endif /* def FEATURE_FORCE_LOAD */
1770 err = parse_http_request(req, http);
1772 if (JB_ERR_OK != err)
1774 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER),
1775 get_write_delay(csp));
1776 /* XXX: Use correct size */
1777 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1778 log_error(LOG_LEVEL_ERROR,
1779 "Couldn't parse request line received from %s: %s",
1780 csp->ip_addr_str, jb_err_to_string(err));
1782 free_http_request(http);
1783 return JB_ERR_PARSE;
1786 /* grab the rest of the client's headers */
1790 p = get_header(csp->client_iob);
1794 /* There are no additional headers to read. */
1801 * We didn't receive a complete header
1802 * line yet, get the rest of it.
1804 if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1806 log_error(LOG_LEVEL_ERROR,
1807 "Stopped grabbing the client headers.");
1808 destroy_list(headers);
1809 return JB_ERR_PARSE;
1812 len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1815 log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1816 destroy_list(headers);
1817 return JB_ERR_PARSE;
1820 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1823 * If there is no memory left for buffering the
1824 * request, there is nothing we can do but hang up
1826 destroy_list(headers);
1827 return JB_ERR_MEMORY;
1832 if (!strncmpic(p, "Transfer-Encoding:", 18))
1835 * XXX: should be called through sed()
1836 * but currently can't.
1838 client_transfer_encoding(csp, &p);
1841 * We were able to read a complete
1842 * header and can finally enlist it.
1849 if (http->host == NULL)
1852 * If we still don't know the request destination,
1853 * the request is invalid or the client uses
1854 * Privoxy without its knowledge.
1856 if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
1859 * Our attempts to get the request destination
1860 * elsewhere failed or Privoxy is configured
1861 * to only accept proxy requests.
1863 * An error response has already been send
1864 * and we're done here.
1866 return JB_ERR_PARSE;
1870 #ifdef FEATURE_CLIENT_TAGS
1871 /* XXX: If the headers were enlisted sooner, passing csp would do. */
1872 set_client_address(csp, headers);
1873 get_tag_list_for_client(csp->client_tags, csp->client_address);
1877 * Determine the actions for this URL
1879 #ifdef FEATURE_TOGGLE
1880 if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
1882 /* Most compatible set of actions (i.e. none) */
1883 init_current_action(csp->action);
1886 #endif /* ndef FEATURE_TOGGLE */
1888 get_url_actions(csp, http);
1891 enlist(csp->headers, http->cmd);
1893 /* Append the previously read headers */
1894 err = list_append_list_unique(csp->headers, headers);
1895 destroy_list(headers);
1902 /*********************************************************************
1904 * Function : parse_client_request
1906 * Description : Parses the client's request and decides what to do
1909 * Note that since we're not using select() we could get
1910 * blocked here if a client connected, then didn't say
1914 * 1 : csp = Current client state (buffers, headers, etc...)
1916 * Returns : JB_ERR_OK or JB_ERR_PARSE
1918 *********************************************************************/
1919 static jb_err parse_client_request(struct client_state *csp)
1921 struct http_request *http = csp->http;
1924 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1925 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
1926 && (!strcmpic(csp->http->version, "HTTP/1.1"))
1927 && (csp->http->ssl == 0))
1929 /* Assume persistence until further notice */
1930 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1932 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1934 if (csp->http->ssl == 0)
1937 * This whole block belongs to chat() but currently
1938 * has to be executed before sed().
1940 if (csp->flags & CSP_FLAG_CHUNKED_CLIENT_BODY)
1942 if (receive_chunked_client_request_body(csp) != JB_ERR_OK)
1944 return JB_ERR_PARSE;
1949 csp->expected_client_content_length = get_expected_content_length(csp->headers);
1951 verify_request_length(csp);
1953 #ifndef FEATURE_HTTPS_INSPECTION
1956 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1960 err = sed(csp, FILTER_CLIENT_HEADERS);
1961 if (JB_ERR_OK != err)
1963 log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
1965 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
1966 csp->ip_addr_str, csp->http->cmd);
1967 write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER), get_write_delay(csp));
1968 return JB_ERR_PARSE;
1970 csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
1972 /* Check request line for rewrites. */
1973 if ((NULL == csp->headers->first->str)
1974 || (strcmp(http->cmd, csp->headers->first->str) &&
1975 (JB_ERR_OK != change_request_destination(csp))))
1978 * A header filter broke the request line - bail out.
1980 write_socket_delayed(csp->cfd, MESSED_UP_REQUEST_RESPONSE,
1981 strlen(MESSED_UP_REQUEST_RESPONSE), get_write_delay(csp));
1982 /* XXX: Use correct size */
1983 log_error(LOG_LEVEL_CLF,
1984 "%s - - [%T] \"Invalid request generated\" 500 0", csp->ip_addr_str);
1985 log_error(LOG_LEVEL_ERROR,
1986 "Invalid request line after applying header filters.");
1987 free_http_request(http);
1989 return JB_ERR_PARSE;
1992 if (client_has_unsupported_expectations(csp))
1994 return JB_ERR_PARSE;
2002 /*********************************************************************
2004 * Function : read_http_request_body
2006 * Description : Reads remaining request body from the client.
2009 * 1 : csp = Current client state (buffers, headers, etc...)
2011 * Returns : 0 on success, anything else is an error.
2013 *********************************************************************/
2014 static int read_http_request_body(struct client_state *csp)
2016 size_t to_read = csp->expected_client_content_length;
2019 assert(to_read != 0);
2021 /* check if all data has been already read */
2022 if (to_read <= (csp->client_iob->eod - csp->client_iob->cur))
2027 for (to_read -= (size_t)(csp->client_iob->eod - csp->client_iob->cur);
2028 to_read > 0 && data_is_available(csp->cfd, csp->config->socket_timeout);
2029 to_read -= (unsigned)len)
2031 char buf[BUFFER_SIZE];
2032 size_t max_bytes_to_read = to_read < sizeof(buf) ? to_read : sizeof(buf);
2034 log_error(LOG_LEVEL_CONNECT,
2035 "Waiting for up to %d bytes of request body from the client.",
2037 len = read_socket(csp->cfd, buf, (int)max_bytes_to_read);
2040 log_error(LOG_LEVEL_CONNECT, "Failed receiving request body from %s: %E", csp->ip_addr_str);
2043 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, (char *)buf, len))
2047 assert(to_read >= len);
2052 log_error(LOG_LEVEL_CONNECT, "Not enough request body has been read: expected %d more bytes",
2053 csp->expected_client_content_length);
2056 log_error(LOG_LEVEL_CONNECT, "The last %d bytes of the request body have been read",
2057 csp->expected_client_content_length);
2062 /*********************************************************************
2064 * Function : update_client_headers
2066 * Description : Updates the HTTP headers from the client request.
2069 * 1 : csp = Current client state (buffers, headers, etc...)
2070 * 2 : new_content_length = new content length value to set
2072 * Returns : 0 on success, anything else is an error.
2074 *********************************************************************/
2075 static int update_client_headers(struct client_state *csp, size_t new_content_length)
2077 static const char content_length[] = "Content-Length:";
2079 struct list_entry *p;
2081 #ifndef FEATURE_HTTPS_INSPECTION
2082 for (p = csp->headers->first;
2084 for (p = csp->http->client_ssl ? csp->https_headers->first : csp->headers->first;
2086 !updated && (p != NULL); p = p->next)
2088 /* Header crunch()ed in previous run? -> ignore */
2094 /* Does the current parser handle this header? */
2095 if (0 == strncmpic(p->str, content_length, sizeof(content_length) - 1))
2097 updated = (JB_ERR_OK == header_adjust_content_length((char **)&(p->str), new_content_length));
2109 /*********************************************************************
2111 * Function : can_filter_request_body
2113 * Description : Checks if the current request body can be stored in
2114 * the client_iob without hitting buffer limit.
2117 * 1 : csp = Current client state (buffers, headers, etc...)
2119 * Returns : TRUE if the current request size do not exceed buffer limit
2122 *********************************************************************/
2123 static int can_filter_request_body(const struct client_state *csp)
2125 if (!can_add_to_iob(csp->client_iob, csp->config->buffer_limit,
2126 csp->expected_client_content_length))
2128 log_error(LOG_LEVEL_INFO,
2129 "Not filtering request body from %s: buffer limit %d will be exceeded "
2130 "(content length %d)", csp->ip_addr_str, csp->config->buffer_limit,
2131 csp->expected_client_content_length);
2138 /*********************************************************************
2140 * Function : send_http_request
2142 * Description : Sends the HTTP headers from the client request
2143 * and all the body data that has already been received.
2146 * 1 : csp = Current client state (buffers, headers, etc...)
2148 * Returns : 0 on success, anything else is an error.
2150 *********************************************************************/
2151 static int send_http_request(struct client_state *csp)
2155 const char *to_send;
2157 int filter_client_body = csp->expected_client_content_length != 0 &&
2158 client_body_filters_enabled(csp->action) && can_filter_request_body(csp);
2160 if (filter_client_body)
2162 if (read_http_request_body(csp))
2166 to_send_len = csp->expected_client_content_length;
2167 to_send = execute_client_body_filters(csp, &to_send_len);
2168 if (to_send == NULL)
2170 /* just flush client_iob */
2171 filter_client_body = FALSE;
2173 else if (to_send_len != csp->expected_client_content_length &&
2174 update_client_headers(csp, to_send_len))
2176 log_error(LOG_LEVEL_HEADER, "Error updating client headers");
2179 csp->expected_client_content_length = 0;
2182 hdr = list_to_text(csp->headers);
2185 /* FIXME Should handle error properly */
2186 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
2188 list_remove_all(csp->headers);
2191 * Write the client's (modified) header to the server
2192 * (along with anything else that may be in the buffer)
2194 write_failure = 0 != write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
2199 log_error(LOG_LEVEL_CONNECT, "Failed sending request headers to: %s: %E",
2200 csp->http->hostport);
2204 if (filter_client_body)
2206 write_failure = 0 != write_socket(csp->server_connection.sfd, to_send, to_send_len);
2210 log_error(LOG_LEVEL_CONNECT, "Failed sending filtered request body to: %s: %E",
2211 csp->http->hostport);
2216 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
2217 && (flush_iob(csp->server_connection.sfd, csp->client_iob, 0) < 0))
2219 log_error(LOG_LEVEL_CONNECT, "Failed sending request body to: %s: %E",
2220 csp->http->hostport);
2227 #ifdef FEATURE_HTTPS_INSPECTION
2228 /*********************************************************************
2230 * Function : read_https_request_body
2232 * Description : Reads remaining request body from the client.
2235 * 1 : csp = Current client state (buffers, headers, etc...)
2237 * Returns : 0 on success, anything else is an error.
2239 *********************************************************************/
2240 static int read_https_request_body(struct client_state *csp)
2242 size_t to_read = csp->expected_client_content_length;
2245 assert(to_read != 0);
2247 /* check if all data has been already read */
2248 if (to_read <= (csp->client_iob->eod - csp->client_iob->cur))
2253 for (to_read -= (size_t)(csp->client_iob->eod - csp->client_iob->cur);
2254 to_read > 0 && (is_ssl_pending(&(csp->ssl_client_attr)) ||
2255 data_is_available(csp->cfd, csp->config->socket_timeout));
2256 to_read -= (unsigned)len)
2258 unsigned char buf[BUFFER_SIZE];
2259 size_t max_bytes_to_read = to_read < sizeof(buf) ? to_read : sizeof(buf);
2261 log_error(LOG_LEVEL_CONNECT,
2262 "Waiting for up to %d bytes of request body from the client.",
2264 len = ssl_recv_data(&(csp->ssl_client_attr), buf,
2265 (unsigned)max_bytes_to_read);
2268 log_error(LOG_LEVEL_CONNECT, "Failed receiving request body from %s", csp->ip_addr_str);
2271 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, (char *)buf, len))
2275 assert(to_read >= len);
2280 log_error(LOG_LEVEL_CONNECT, "Not enough request body has been read: expected %d more bytes", to_read);
2284 log_error(LOG_LEVEL_CONNECT, "The last %d bytes of the request body have been read",
2285 csp->expected_client_content_length);
2290 /*********************************************************************
2292 * Function : receive_and_send_encrypted_post_data
2294 * Description : Reads remaining request body from the client and sends
2298 * 1 : csp = Current client state (buffers, headers, etc...)
2300 * Returns : 0 on success, anything else is an error.
2302 *********************************************************************/
2303 static int receive_and_send_encrypted_post_data(struct client_state *csp)
2305 int content_length_known = csp->expected_client_content_length != 0;
2307 while (is_ssl_pending(&(csp->ssl_client_attr))
2308 || (content_length_known && csp->expected_client_content_length != 0))
2310 unsigned char buf[BUFFER_SIZE];
2312 int max_bytes_to_read = sizeof(buf);
2314 if (content_length_known && csp->expected_client_content_length < sizeof(buf))
2316 max_bytes_to_read = (int)csp->expected_client_content_length;
2318 log_error(LOG_LEVEL_CONNECT,
2319 "Waiting for up to %d bytes of request body from the client.",
2321 len = ssl_recv_data(&(csp->ssl_client_attr), buf,
2322 (unsigned)max_bytes_to_read);
2329 /* XXX: Does this actually happen? */
2332 log_error(LOG_LEVEL_CONNECT, "Forwarding %d bytes of encrypted request body",
2334 len = ssl_send_data(&(csp->ssl_server_attr), buf, (size_t)len);
2339 if (csp->expected_client_content_length != 0)
2341 if (csp->expected_client_content_length >= len)
2343 csp->expected_client_content_length -= (unsigned)len;
2345 if (csp->expected_client_content_length == 0)
2347 log_error(LOG_LEVEL_CONNECT, "Forwarded the last %d bytes", len);
2353 log_error(LOG_LEVEL_CONNECT, "Done forwarding encrypted request body");
2360 /*********************************************************************
2362 * Function : send_https_request
2364 * Description : Sends the HTTP headers from the client request
2365 * and all the body data that has already been received.
2368 * 1 : csp = Current client state (buffers, headers, etc...)
2370 * Returns : 0 on success, anything else is an error.
2372 *********************************************************************/
2373 static int send_https_request(struct client_state *csp)
2378 const char *to_send;
2380 int filter_client_body = csp->expected_client_content_length != 0 &&
2381 client_body_filters_enabled(csp->action) && can_filter_request_body(csp);
2383 if (filter_client_body)
2385 if (read_https_request_body(csp))
2389 to_send_len = csp->expected_client_content_length;
2390 to_send = execute_client_body_filters(csp, &to_send_len);
2391 if (to_send == NULL)
2393 /* just flush client_iob */
2394 filter_client_body = FALSE;
2396 else if (to_send_len != csp->expected_client_content_length &&
2397 update_client_headers(csp, to_send_len))
2399 log_error(LOG_LEVEL_HEADER, "Error updating client headers");
2402 csp->expected_client_content_length = 0;
2405 hdr = list_to_text(csp->https_headers);
2408 /* FIXME Should handle error properly */
2409 log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
2411 list_remove_all(csp->https_headers);
2414 * Write the client's (modified) header to the server
2415 * (along with anything else that may be in the buffer)
2417 ret = ssl_send_data(&(csp->ssl_server_attr),
2418 (const unsigned char *)hdr, strlen(hdr));
2423 log_error(LOG_LEVEL_CONNECT,
2424 "Failed sending encrypted request headers to: %s: %E",
2425 csp->http->hostport);
2426 mark_server_socket_tainted(csp);
2430 if (filter_client_body)
2432 ret = ssl_send_data(&(csp->ssl_server_attr), (const unsigned char *)to_send, to_send_len);
2436 log_error(LOG_LEVEL_CONNECT, "Failed sending filtered request body to: %s",
2437 csp->http->hostport);
2442 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
2443 && ((flushed = ssl_flush_socket(&(csp->ssl_server_attr),
2444 csp->client_iob)) < 0))
2446 log_error(LOG_LEVEL_CONNECT, "Failed sending request body to: %s: %E",
2447 csp->http->hostport);
2450 if (flushed != 0 || csp->expected_client_content_length != 0)
2452 if (csp->expected_client_content_length != 0)
2454 if (csp->expected_client_content_length < flushed)
2456 log_error(LOG_LEVEL_ERROR,
2457 "Flushed %ld bytes of request body while only expecting %llu",
2458 flushed, csp->expected_client_content_length);
2459 csp->expected_client_content_length = 0;
2463 log_error(LOG_LEVEL_CONNECT,
2464 "Flushed %ld bytes of request body while expecting %llu",
2465 flushed, csp->expected_client_content_length);
2466 csp->expected_client_content_length -= (unsigned)flushed;
2467 if (receive_and_send_encrypted_post_data(csp))
2475 log_error(LOG_LEVEL_CONNECT,
2476 "Flushed %ld bytes of request body", flushed);
2480 log_error(LOG_LEVEL_CONNECT, "Encrypted request sent");
2487 /*********************************************************************
2489 * Function : receive_encrypted_request
2491 * Description : Receives an encrypted request.
2494 * 1 : csp = Current client state (buffers, headers, etc...)
2496 * Returns : JB_ERR_OK on success,
2497 * JB_ERR_PARSE or JB_ERR_MEMORY otherwise
2499 *********************************************************************/
2500 static jb_err receive_encrypted_request(struct client_state *csp)
2502 char buf[BUFFER_SIZE];
2508 log_error(LOG_LEVEL_HEADER, "Reading encrypted headers");
2509 if (!is_ssl_pending(&(csp->ssl_client_attr)) &&
2510 !data_is_available(csp->cfd, csp->config->socket_timeout))
2512 log_error(LOG_LEVEL_CONNECT,
2513 "Socket %d timed out while waiting for client headers", csp->cfd);
2514 return JB_ERR_PARSE;
2516 len = ssl_recv_data(&(csp->ssl_client_attr),
2517 (unsigned char *)buf, sizeof(buf));
2520 log_error(LOG_LEVEL_CONNECT,
2521 "Socket %d closed while waiting for client headers", csp->cfd);
2522 return JB_ERR_PARSE;
2526 return JB_ERR_PARSE;
2528 if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
2530 return JB_ERR_MEMORY;
2532 p = strstr(csp->client_iob->cur, "\r\n\r\n");
2533 } while (p == NULL);
2535 log_error(LOG_LEVEL_HEADER, "Encrypted headers received completely");
2541 /*********************************************************************
2543 * Function : change_encrypted_request_destination
2545 * Description : Parse a (rewritten) request line from an encrypted
2546 * request and regenerate the http request data.
2549 * 1 : csp = Current client state (buffers, headers, etc...)
2551 * Returns : Forwards the parse_http_request() return code.
2552 * Terminates in case of memory problems.
2554 *********************************************************************/
2555 static jb_err change_encrypted_request_destination(struct client_state *csp)
2558 char *original_host = csp->http->host;
2560 log_error(LOG_LEVEL_REDIRECTS, "Rewrite detected: %s",
2561 csp->https_headers->first->str);
2562 csp->http->host = NULL;
2563 free_http_request(csp->http);
2564 err = parse_http_request(csp->https_headers->first->str, csp->http);
2565 if (JB_ERR_OK != err)
2567 log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
2568 jb_err_to_string(err));
2572 if (csp->http->host == NULL)
2575 * The rewritten request line did not specify a host
2576 * which means we can use the original host specified
2579 csp->http->host = original_host;
2580 log_error(LOG_LEVEL_REDIRECTS, "Keeping the original host: %s",
2583 * If the rewritten request line didn't contain a host
2584 * it also didn't contain a port so we can reuse the host
2585 * and set the port to 443.
2587 freez(csp->http->hostport);
2588 csp->http->hostport = strdup_or_die(csp->http->host);
2589 csp->http->port = 443;
2591 * While the request line didn't mention it,
2592 * we're https-inspecting and want to speak TLS
2595 csp->http->server_ssl = 1;
2600 /* The rewrite filter added a host so we can ditch the original */
2601 freez(original_host);
2602 csp->http->server_ssl = csp->http->ssl;
2605 csp->http->client_ssl = 1;
2607 freez(csp->https_headers->first->str);
2608 build_request_line(csp, NULL, &csp->https_headers->first->str);
2610 if (!server_use_ssl(csp))
2612 log_error(LOG_LEVEL_REDIRECTS,
2613 "Rewritten request line results in downgrade to http");
2615 * Replace the unencryptd headers received with the
2616 * CONNECT request with the ones we received securely.
2618 destroy_list(csp->headers);
2619 csp->headers->first = csp->https_headers->first;
2620 csp->headers->last = csp->https_headers->last;
2621 csp->https_headers->first = NULL;
2622 csp->https_headers->last = NULL;
2630 /*********************************************************************
2632 * Function : process_encrypted_request
2634 * Description : Receives and parses an encrypted request.
2637 * 1 : csp = Current client state (buffers, headers, etc...)
2639 * Returns : JB_ERR_OK on success,
2640 * JB_ERR_PARSE or JB_ERR_MEMORY otherwise
2642 *********************************************************************/
2643 static jb_err process_encrypted_request(struct client_state *csp)
2648 /* Temporary copy of the client's headers before they get enlisted in csp->https_headers */
2649 struct list header_list;
2650 struct list *headers = &header_list;
2652 assert(csp->ssl_with_client_is_opened);
2654 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2655 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
2657 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
2660 err = receive_encrypted_request(csp);
2661 if (err != JB_ERR_OK)
2663 if (csp->client_iob->cur == NULL ||
2664 csp->client_iob->cur == csp->client_iob->eod)
2667 * We did not receive any data, most likely because the
2668 * client is done. Don't log this as a parse failure.
2670 return JB_ERR_PARSE;
2672 /* XXX: Also used for JB_ERR_MEMORY */
2673 log_error(LOG_LEVEL_ERROR, "Failed to receive encrypted request: %s",
2674 jb_err_to_string(err));
2675 ssl_send_data_delayed(&(csp->ssl_client_attr),
2676 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2680 /* We don't need get_request_line() because the whole HTTP head is buffered. */
2681 request_line = get_header(csp->client_iob);
2682 if (request_line == NULL)
2684 log_error(LOG_LEVEL_ERROR, "Failed to get the encrypted request line");
2685 ssl_send_data_delayed(&(csp->ssl_client_attr),
2686 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2687 return JB_ERR_PARSE;
2689 assert(*request_line != '\0');
2691 if (client_protocol_is_unsupported(csp, request_line))
2694 * If the protocol is unsupported we're done here.
2695 * client_protocol_is_unsupported() took care of sending
2696 * the error response and logging the error message.
2698 return JB_ERR_PARSE;
2701 #ifdef FEATURE_FORCE_LOAD
2702 if (force_required(csp, request_line))
2704 csp->flags |= CSP_FLAG_FORCED;
2706 #endif /* def FEATURE_FORCE_LOAD */
2708 free_http_request(csp->http);
2710 err = parse_http_request(request_line, csp->http);
2711 /* XXX: Restore ssl setting. This is ugly */
2712 csp->http->client_ssl = 1;
2713 csp->http->server_ssl = 1;
2715 freez(request_line);
2716 if (JB_ERR_OK != err)
2718 ssl_send_data_delayed(&(csp->ssl_client_attr),
2719 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2720 /* XXX: Use correct size */
2721 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
2722 log_error(LOG_LEVEL_ERROR,
2723 "Couldn't parse request line received from %s: %s",
2724 csp->ip_addr_str, jb_err_to_string(err));
2726 free_http_request(csp->http);
2727 return JB_ERR_PARSE;
2730 /* Parse the rest of the client's headers. */
2734 p = get_header(csp->client_iob);
2738 /* There are no additional headers to read. */
2745 if (JB_ERR_OK != get_destination_from_https_headers(headers, csp->http))
2748 * Our attempts to get the request destination
2751 log_error(LOG_LEVEL_ERROR,
2752 "Failed to get the encrypted request destination");
2753 ssl_send_data_delayed(&(csp->ssl_client_attr),
2754 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2755 return JB_ERR_PARSE;
2758 /* Split the domain we just got for pattern matching */
2759 init_domain_components(csp->http);
2761 #ifdef FEATURE_CLIENT_TAGS
2762 /* XXX: If the headers were enlisted sooner, passing csp would do. */
2763 if (csp->client_address == NULL)
2765 set_client_address(csp, headers);
2766 get_tag_list_for_client(csp->client_tags, csp->client_address);
2770 #ifdef FEATURE_TOGGLE
2771 if ((csp->flags & CSP_FLAG_TOGGLED_ON) != 0)
2775 * Determine the actions for this request after
2776 * clearing the ones from the previous one.
2778 free_current_action(csp->action);
2779 get_url_actions(csp, csp->http);
2782 enlist(csp->https_headers, csp->http->cmd);
2784 /* Append the previously read headers */
2785 err = list_append_list_unique(csp->https_headers, headers);
2786 destroy_list(headers);
2787 if (JB_ERR_OK != err)
2789 /* XXX: Send error message */
2793 /* XXX: Work around crash */
2794 csp->error_message = NULL;
2796 /* XXX: Why do this here? */
2799 err = sed_https(csp);
2800 if (JB_ERR_OK != err)
2802 ssl_send_data_delayed(&(csp->ssl_client_attr),
2803 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2804 log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
2806 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
2807 csp->ip_addr_str, csp->http->cmd);
2808 return JB_ERR_PARSE;
2811 if ((NULL == csp->https_headers->first->str)
2812 || (strcmp(csp->http->cmd, csp->https_headers->first->str) &&
2813 (JB_ERR_OK != change_encrypted_request_destination(csp))))
2815 log_error(LOG_LEVEL_ERROR,
2816 "Failed to get the request destination in the rewritten headers");
2817 ssl_send_data_delayed(&(csp->ssl_client_attr),
2818 (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2819 return JB_ERR_PARSE;
2822 log_error(LOG_LEVEL_HEADER, "Encrypted request processed");
2823 log_applied_actions(csp->action);
2824 log_error(LOG_LEVEL_REQUEST, "https://%s%s", csp->http->hostport,
2831 /*********************************************************************
2833 * Function : cgi_page_requested
2835 * Description : Checks if a request is for an internal CGI page.
2838 * 1 : host = The host requested by the client.
2840 * Returns : 1 if a CGI page has been requested, 0 otherwise
2842 *********************************************************************/
2843 static int cgi_page_requested(const char *host)
2845 if ((0 == strcmpic(host, CGI_SITE_1_HOST))
2846 || (0 == strcmpic(host, CGI_SITE_1_HOST "."))
2847 || (0 == strcmpic(host, CGI_SITE_2_HOST))
2848 || (0 == strcmpic(host, CGI_SITE_2_HOST ".")))
2858 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2859 /*********************************************************************
2861 * Function : continue_https_chat
2863 * Description : Behaves similar to chat() but only deals with
2864 * https-inspected requests that arrive on an already
2865 * established connection. The first request is always
2866 * served by chat() which is a lot more complex as it
2867 * has to deal with forwarding settings and connection
2870 * If a connection to the server has already been
2871 * opened it is reused unless the request is blocked
2872 * or the forwarder changed.
2874 * If a connection to the server has not yet been
2875 * opened (because the previous request was crunched),
2876 * or the forwarder changed, the connection is dropped
2877 * so that the client retries on a fresh one.
2880 * 1 : csp = Current client state (buffers, headers, etc...)
2882 * Returns : Nothing.
2884 *********************************************************************/
2885 static void continue_https_chat(struct client_state *csp)
2887 const struct forward_spec *fwd;
2889 if (JB_ERR_OK != process_encrypted_request(csp))
2894 csp->requests_received_total++;
2897 * We have an encrypted request. Check if one of the crunchers wants it.
2899 if (crunch_response_triggered(csp, crunchers_all))
2902 * Yes. The client got the crunch response and we're done here.
2906 if (csp->ssl_with_server_is_opened == 0)
2908 log_error(LOG_LEVEL_CONNECT,
2909 "Dropping the client connection on socket %d. "
2910 "The server connection has not been established yet.",
2912 csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
2915 assert(csp->server_connection.sfd != JB_INVALID_SOCKET);
2917 fwd = forward_url(csp, csp->http);
2918 if (!connection_destination_matches(&csp->server_connection, csp->http, fwd))
2920 log_error(LOG_LEVEL_CONNECT,
2921 "Dropping the client connection on socket %d with "
2922 "server socket %d connected to %s. The forwarder has changed.",
2923 csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
2924 csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
2928 log_error(LOG_LEVEL_CONNECT,
2929 "Reusing server socket %d connected to %s. Requests already sent: %u.",
2930 csp->server_connection.sfd, csp->server_connection.host,
2931 csp->server_connection.requests_sent_total);
2933 if (send_https_request(csp))
2936 * Most likely the server connection timed out. We can't easily
2937 * create a new one so simply drop the client connection without a
2938 * error response to let the client retry.
2940 log_error(LOG_LEVEL_CONNECT,
2941 "Dropping client connection on socket %d. "
2942 "Forwarding the encrypted client request failed.",
2946 csp->server_connection.requests_sent_total++;
2947 handle_established_connection(csp);
2948 freez(csp->receive_buffer);
2950 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2954 /*********************************************************************
2956 * Function : handle_established_connection
2958 * Description : Shuffle data between client and server once the
2959 * connection has been established.
2962 * 1 : csp = Current client state (buffers, headers, etc...)
2964 * Returns : Nothing.
2966 *********************************************************************/
2967 static void handle_established_connection(struct client_state *csp)
2973 struct pollfd poll_fds[2];
2977 struct timeval timeout;
2980 int ms_iis5_hack = 0;
2981 unsigned long long byte_count = 0;
2982 struct http_request *http;
2983 long len = 0; /* for buffer sizes (and negative error codes) */
2984 int buffer_and_filter_content = 0;
2985 unsigned int write_delay;
2986 #ifdef FEATURE_HTTPS_INSPECTION
2988 int use_ssl_tunnel = 0;
2989 csp->dont_verify_certificate = 0;
2991 if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION))
2993 /* Pass encrypted content without filtering. */
2998 /* Skeleton for HTTP response, if we should intercept the request */
2999 struct http_response *rsp;
3000 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3001 int watch_client_socket;
3004 csp->receive_buffer_size = csp->config->receive_buffer_size;
3005 csp->receive_buffer = zalloc(csp->receive_buffer_size + 1);
3006 if (csp->receive_buffer == NULL)
3008 log_error(LOG_LEVEL_ERROR,
3009 "Out of memory. Failed to allocate the receive buffer.");
3010 rsp = cgi_error_memory();
3011 send_crunch_response(csp, rsp);
3018 maxfd = (csp->cfd > csp->server_connection.sfd) ?
3019 csp->cfd : csp->server_connection.sfd;
3022 /* pass data between the client and server
3023 * until one or the other shuts down the connection.
3028 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3029 watch_client_socket = 0 == (csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING);
3031 write_delay = get_write_delay(csp);
3037 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3038 if (!watch_client_socket)
3040 maxfd = csp->server_connection.sfd;
3043 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3045 FD_SET(csp->cfd, &rfds);
3048 FD_SET(csp->server_connection.sfd, &rfds);
3049 #endif /* ndef HAVE_POLL */
3051 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3052 if ((csp->flags & CSP_FLAG_CHUNKED)
3053 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3054 && ((csp->iob->eod - csp->iob->cur) >= 5)
3055 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
3058 * XXX: This check should be obsolete now,
3059 * but let's wait a while to be sure.
3061 log_error(LOG_LEVEL_CONNECT,
3062 "Looks like we got the last chunk together with "
3063 "the server headers but didn't detect it earlier. "
3064 "We better stop reading.");
3065 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3066 csp->expected_content_length = byte_count;
3067 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
3069 if (server_body && server_response_is_complete(csp, byte_count))
3071 if (csp->expected_content_length == byte_count)
3073 log_error(LOG_LEVEL_CONNECT,
3074 "Done reading from server. Content length: %llu as expected. "
3075 "Bytes most recently read: %ld.",
3080 log_error(LOG_LEVEL_CONNECT,
3081 "Done reading from server. Expected content length: %llu. "
3082 "Actual content length: %llu. Bytes most recently read: %ld.",
3083 csp->expected_content_length, byte_count, len);
3087 * XXX: Should not jump around, handle_established_connection()
3088 * is complicated enough already.
3092 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
3095 poll_fds[0].fd = csp->cfd;
3096 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3097 if (!watch_client_socket)
3100 * Ignore incoming data, but still watch out
3101 * for disconnects etc. These flags are always
3102 * implied anyway but explicitly setting them
3105 poll_fds[0].events = POLLERR|POLLHUP;
3110 poll_fds[0].events = POLLIN;
3112 poll_fds[1].fd = csp->server_connection.sfd;
3113 poll_fds[1].events = POLLIN;
3114 n = poll(poll_fds, 2, csp->config->socket_timeout * 1000);
3116 timeout.tv_sec = csp->config->socket_timeout;
3117 timeout.tv_usec = 0;
3118 n = select((int)maxfd + 1, &rfds, NULL, NULL, &timeout);
3119 #endif /* def HAVE_POLL */
3121 /*server or client not responding in timeout */
3124 log_error(LOG_LEVEL_CONNECT, "Socket timeout %d reached: %s",
3125 csp->config->socket_timeout, http->url);
3126 if ((byte_count == 0) && (http->ssl == 0))
3128 send_crunch_response(csp, error_response(csp, "connection-timeout"));
3130 mark_server_socket_tainted(csp);
3131 #ifdef FEATURE_HTTPS_INSPECTION
3132 close_client_and_server_ssl_connections(csp);
3139 log_error(LOG_LEVEL_ERROR, "poll() failed!: %E");
3141 log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
3143 mark_server_socket_tainted(csp);
3144 #ifdef FEATURE_HTTPS_INSPECTION
3145 close_client_and_server_ssl_connections(csp);
3151 * This is the body of the browser's request,
3152 * just read and write it.
3154 * Receives data from browser and sends it to server
3156 * XXX: Make sure the client doesn't use pipelining
3157 * behind Privoxy's back.
3160 if ((poll_fds[0].revents & (POLLERR|POLLHUP|POLLNVAL)) != 0)
3162 log_error(LOG_LEVEL_CONNECT,
3163 "The client socket %d has become unusable while "
3164 "the server socket %d is still open.",
3165 csp->cfd, csp->server_connection.sfd);
3166 mark_server_socket_tainted(csp);
3170 if (poll_fds[0].revents != 0)
3172 if (FD_ISSET(csp->cfd, &rfds))
3173 #endif /* def HAVE_POLL*/
3175 int max_bytes_to_read = (int)csp->receive_buffer_size;
3177 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3178 if ((csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ))
3180 if (data_is_available(csp->cfd, 0))
3183 * If the next request is already waiting, we have
3184 * to stop select()ing the client socket. Otherwise
3185 * we would always return right away and get nothing
3188 watch_client_socket = 0;
3189 log_error(LOG_LEVEL_CONNECT,
3190 "Stop watching client socket %d. "
3191 "There's already another request waiting.",
3196 * If the client socket is set, but there's no data
3197 * available on the socket, the client went fishing
3198 * and continuing talking to the server makes no sense.
3200 log_error(LOG_LEVEL_CONNECT,
3201 "The client closed socket %d while "
3202 "the server socket %d is still open.",
3203 csp->cfd, csp->server_connection.sfd);
3204 mark_server_socket_tainted(csp);
3207 if (csp->expected_client_content_length != 0)
3209 if (csp->expected_client_content_length < csp->receive_buffer_size)
3211 max_bytes_to_read = (int)csp->expected_client_content_length;
3213 log_error(LOG_LEVEL_CONNECT,
3214 "Waiting for up to %d bytes from the client.",
3217 assert(max_bytes_to_read <= csp->receive_buffer_size);
3218 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3220 #ifdef FEATURE_HTTPS_INSPECTION
3221 if (client_use_ssl(csp))
3223 if (csp->http->status == 101)
3225 len = ssl_recv_data(&(csp->ssl_client_attr),
3226 (unsigned char *)csp->receive_buffer,
3227 (size_t)max_bytes_to_read);
3230 log_error(LOG_LEVEL_ERROR, "Failed to receive data "
3231 "on client socket %d for an upgraded connection",
3237 log_error(LOG_LEVEL_CONNECT, "Done receiving data "
3238 "on client socket %d for an upgraded connection",
3242 byte_count += (unsigned long long)len;
3243 len = ssl_send_data(&(csp->ssl_server_attr),
3244 (unsigned char *)csp->receive_buffer, (size_t)len);
3247 log_error(LOG_LEVEL_ERROR, "Failed to send data "
3248 "on server socket %d for an upgraded connection",
3249 csp->server_connection.sfd);
3254 log_error(LOG_LEVEL_CONNECT, "Breaking with TLS/SSL.");
3258 #endif /* def FEATURE_HTTPS_INSPECTION */
3260 len = read_socket(csp->cfd, csp->receive_buffer, max_bytes_to_read);
3264 /* XXX: not sure if this is necessary. */
3265 mark_server_socket_tainted(csp);
3266 break; /* "game over, man" */
3269 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3270 if (csp->expected_client_content_length != 0)
3272 assert(len <= max_bytes_to_read);
3273 csp->expected_client_content_length -= (unsigned)len;
3274 log_error(LOG_LEVEL_CONNECT,
3275 "Expected client content length set to %llu "
3276 "after reading %ld bytes.",
3277 csp->expected_client_content_length, len);
3278 if (csp->expected_client_content_length == 0)
3280 log_error(LOG_LEVEL_CONNECT,
3281 "Done reading from the client.");
3282 csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
3285 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3287 if (write_socket(csp->server_connection.sfd, csp->receive_buffer, (size_t)len))
3289 log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
3290 mark_server_socket_tainted(csp);
3298 * The server wants to talk. It could be the header or the body.
3299 * If `hdr' is null, then it's the header otherwise it's the body.
3300 * FIXME: Does `hdr' really mean `host'? No.
3303 if (poll_fds[1].revents != 0)
3305 if (FD_ISSET(csp->server_connection.sfd, &rfds))
3306 #endif /* HAVE_POLL */
3308 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3310 * If we are buffering content, we don't want to eat up to
3311 * buffer-limit bytes if the client no longer cares about them.
3312 * If we aren't buffering, however, a dead client socket will be
3313 * noticed pretty much right away anyway, so we can reduce the
3314 * overhead by skipping the check.
3316 if (buffer_and_filter_content && !socket_is_still_alive(csp->cfd))
3319 log_error(LOG_LEVEL_CONNECT,
3320 "The server still wants to talk, but the client may already have hung up on us.");
3322 log_error(LOG_LEVEL_CONNECT,
3323 "The server still wants to talk, but the client hung up on us.");
3324 mark_server_socket_tainted(csp);
3325 #ifdef FEATURE_HTTPS_INSPECTION
3326 close_client_and_server_ssl_connections(csp);
3329 #endif /* def _WIN32 */
3331 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3333 #ifdef FEATURE_HTTPS_INSPECTION
3335 * Reading data from standard or secured connection (HTTP/HTTPS)
3337 if (server_use_ssl(csp))
3339 len = ssl_recv_data(&(csp->ssl_server_attr),
3340 (unsigned char *)csp->receive_buffer, csp->receive_buffer_size);
3345 len = read_socket(csp->server_connection.sfd, csp->receive_buffer,
3346 (int)csp->receive_buffer_size);
3351 log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
3353 if ((http->ssl && (csp->fwd == NULL))
3354 #ifdef FEATURE_HTTPS_INSPECTION
3360 * Just hang up. We already confirmed the client's CONNECT
3361 * request with status code 200 and unencrypted content is
3362 * no longer welcome.
3364 log_error(LOG_LEVEL_ERROR,
3365 "CONNECT already confirmed. Unable to tell the client about the problem.");
3368 else if (byte_count)
3371 * Just hang up. We already transmitted the original headers
3372 * and parts of the original content and therefore missed the
3373 * chance to send an error message (without risking data corruption).
3375 * XXX: we could retry with a fancy range request here.
3377 log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
3378 "Unable to tell the client about the problem.");
3379 mark_server_socket_tainted(csp);
3380 #ifdef FEATURE_HTTPS_INSPECTION
3381 close_client_and_server_ssl_connections(csp);
3386 * XXX: Consider handling the cases above the same.
3388 mark_server_socket_tainted(csp);
3392 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3393 if (csp->flags & CSP_FLAG_CHUNKED)
3395 if ((len >= 5) && !memcmp(csp->receive_buffer+len-5, "0\r\n\r\n", 5))
3397 /* XXX: this is a temporary hack */
3398 log_error(LOG_LEVEL_CONNECT,
3399 "Looks like we reached the end of the last chunk. "
3400 "We better stop reading.");
3401 csp->expected_content_length = byte_count + (unsigned long long)len;
3402 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
3406 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
3409 * This is guaranteed by allocating with zalloc_or_die()
3410 * and never (intentionally) writing to the last byte.
3412 * csp->receive_buffer_size is the size of the part of the
3413 * buffer we intentionally write to, but we actually
3414 * allocated csp->receive_buffer_size+1 bytes so the assertion
3415 * stays within the allocated range.
3417 assert(csp->receive_buffer[csp->receive_buffer_size] == '\0');
3420 * Add a trailing zero to let be able to use string operations.
3421 * XXX: do we still need this with filter_popups gone?
3423 assert(len <= csp->receive_buffer_size);
3424 csp->receive_buffer[len] = '\0';
3427 * Normally, this would indicate that we've read
3428 * as much as the server has sent us and we can
3429 * close the client connection. However, Microsoft
3430 * in its wisdom has released IIS/5 with a bug that
3431 * prevents it from sending the trailing \r\n in
3432 * a 302 redirect header (and possibly other headers).
3433 * To work around this if we've haven't parsed
3434 * a full header we'll append a trailing \r\n
3435 * and see if this now generates a valid one.
3437 * This hack shouldn't have any impacts. If we've
3438 * already transmitted the header or if this is a
3439 * SSL connection, then we won't bother with this
3440 * hack. So we only work on partially received
3441 * headers. If we append a \r\n and this still
3442 * doesn't generate a valid header, then we won't
3443 * transmit anything to the client.
3448 if (server_body || (http->ssl
3449 #ifdef FEATURE_HTTPS_INSPECTION
3455 * If we have been buffering up the document,
3456 * now is the time to apply content modification
3457 * and send the result to the client.
3459 if (buffer_and_filter_content)
3461 p = execute_content_filters(csp);
3463 * If content filtering fails, use the original
3464 * buffer and length.
3465 * (see p != NULL ? p : csp->iob->cur below)
3469 csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
3471 #ifdef FEATURE_COMPRESSION
3472 else if ((csp->flags & CSP_FLAG_CLIENT_SUPPORTS_DEFLATE)
3473 && (csp->content_length > LOWER_LENGTH_LIMIT_FOR_COMPRESSION))
3475 char *compressed_content = compress_buffer(p,
3476 (size_t *)&csp->content_length, csp->config->compression_level);
3477 if (compressed_content != NULL)
3480 p = compressed_content;
3481 csp->flags |= CSP_FLAG_BUFFERED_CONTENT_DEFLATED;
3486 if (JB_ERR_OK != update_server_headers(csp))
3488 log_error(LOG_LEVEL_FATAL,
3489 "Failed to update server headers. after filtering.");
3492 hdr = list_to_text(csp->headers);
3495 /* FIXME Should handle error properly */
3496 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
3499 #ifdef FEATURE_HTTPS_INSPECTION
3501 * Sending data with standard or secured connection (HTTP/HTTPS)
3503 if (client_use_ssl(csp))
3505 if ((ssl_send_data_delayed(&(csp->ssl_client_attr),
3506 (const unsigned char *)hdr, strlen(hdr),
3507 get_write_delay(csp)) < 0)
3508 || (ssl_send_data_delayed(&(csp->ssl_client_attr),
3509 (const unsigned char *) ((p != NULL) ? p : csp->iob->cur),
3510 csp->content_length, get_write_delay(csp)) < 0))
3512 log_error(LOG_LEVEL_ERROR, "write modified content to "
3513 "client over TLS/SSL failed");
3516 mark_server_socket_tainted(csp);
3517 close_client_and_server_ssl_connections(csp);
3522 #endif /* def FEATURE_HTTPS_INSPECTION */
3524 if (write_socket_delayed(csp->cfd, hdr, strlen(hdr), write_delay)
3525 || write_socket_delayed(csp->cfd, ((p != NULL) ? p : csp->iob->cur),
3526 (size_t)csp->content_length, write_delay))
3528 log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
3531 mark_server_socket_tainted(csp);
3540 break; /* "game over, man" */
3544 * This is NOT the body, so
3545 * Let's pretend the server just sent us a blank line.
3547 snprintf(csp->receive_buffer, csp->receive_buffer_size, "\r\n");
3548 len = (int)strlen(csp->receive_buffer);
3551 * Now, let the normal header parsing algorithm below do its
3552 * job. If it fails, we'll exit instead of continuing.
3559 * If we're in the body of the server document, just write it to
3560 * the client, unless we need to buffer the body for later
3561 * content-filtering.
3563 if (server_body || (http->ssl
3564 #ifdef FEATURE_HTTPS_INSPECTION
3569 if (buffer_and_filter_content)
3572 * If there is no memory left for buffering the content, or the buffer limit
3573 * has been reached, switch to non-filtering mode, i.e. make & write the
3574 * header, flush the iob and buf, and get out of the way.
3576 if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3581 log_error(LOG_LEVEL_INFO,
3582 "Flushing header and buffers. Stepping back from filtering.");
3584 hdr = list_to_text(csp->headers);
3588 * Memory is too tight to even generate the header.
3589 * Send our static "Out-of-memory" page.
3591 log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
3592 rsp = cgi_error_memory();
3593 send_crunch_response(csp, rsp);
3594 mark_server_socket_tainted(csp);
3595 #ifdef FEATURE_HTTPS_INSPECTION
3596 close_client_and_server_ssl_connections(csp);
3600 hdrlen = strlen(hdr);
3602 #ifdef FEATURE_HTTPS_INSPECTION
3604 * Sending data with standard or secured connection (HTTP/HTTPS)
3606 if (client_use_ssl(csp))
3608 if ((ssl_send_data_delayed(&(csp->ssl_client_attr),
3609 (const unsigned char *)hdr, hdrlen, get_write_delay(csp)) < 0)
3610 || ((flushed = ssl_flush_socket(&(csp->ssl_client_attr),
3612 || (ssl_send_data_delayed(&(csp->ssl_client_attr),
3613 (const unsigned char *)csp->receive_buffer, (size_t)len,
3614 get_write_delay(csp)) < 0))
3616 log_error(LOG_LEVEL_CONNECT,
3617 "Flush header and buffers to client failed");
3619 mark_server_socket_tainted(csp);
3620 close_client_and_server_ssl_connections(csp);
3625 #endif /* def FEATURE_HTTPS_INSPECTION */
3627 if (write_socket_delayed(csp->cfd, hdr, hdrlen, write_delay)
3628 || ((flushed = flush_iob(csp->cfd, csp->iob, write_delay)) < 0)
3629 || write_socket_delayed(csp->cfd, csp->receive_buffer, (size_t)len,
3632 log_error(LOG_LEVEL_CONNECT,
3633 "Flush header and buffers to client failed: %E");
3635 mark_server_socket_tainted(csp);
3641 * Reset the byte_count to the amount of bytes
3642 * we just flushed. len will be added a few lines below,
3643 * hdrlen doesn't matter for LOG_LEVEL_CLF.
3645 byte_count = (unsigned long long)flushed;
3647 buffer_and_filter_content = 0;
3653 #ifdef FEATURE_HTTPS_INSPECTION
3655 * Sending data with standard or secured connection (HTTP/HTTPS)
3657 if (client_use_ssl(csp))
3659 ret = ssl_send_data_delayed(&(csp->ssl_client_attr),
3660 (const unsigned char *)csp->receive_buffer, (size_t)len,
3661 get_write_delay(csp));
3664 log_error(LOG_LEVEL_ERROR,
3665 "Sending data to client failed");
3666 mark_server_socket_tainted(csp);
3667 close_client_and_server_ssl_connections(csp);
3672 #endif /* def FEATURE_HTTPS_INSPECTION */
3674 if (write_socket_delayed(csp->cfd, csp->receive_buffer,
3675 (size_t)len, write_delay))
3677 log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
3678 mark_server_socket_tainted(csp);
3683 byte_count += (unsigned long long)len;
3689 * We're still looking for the end of the server's header.
3690 * Buffer up the data we just read. If that fails, there's
3691 * little we can do but send our static out-of-memory page.
3693 if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3695 log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
3696 rsp = cgi_error_memory();
3697 send_crunch_response(csp, rsp);
3698 mark_server_socket_tainted(csp);
3699 #ifdef FEATURE_HTTPS_INSPECTION
3700 close_client_and_server_ssl_connections(csp);
3705 /* Convert iob into something sed() can digest */
3706 if (JB_ERR_PARSE == get_server_headers(csp))
3711 * Well, we tried our MS IIS/5 hack and it didn't work.
3712 * The header is incomplete and there isn't anything
3713 * we can do about it.
3715 log_error(LOG_LEVEL_ERROR, "Invalid server headers. "
3716 "Applying the MS IIS5 hack didn't help.");
3717 log_error(LOG_LEVEL_CLF,
3718 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3719 #ifdef FEATURE_HTTPS_INSPECTION
3721 * Sending data with standard or secured connection (HTTP/HTTPS)
3723 if (client_use_ssl(csp))
3725 ssl_send_data_delayed(&(csp->ssl_client_attr),
3726 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3727 strlen(INVALID_SERVER_HEADERS_RESPONSE), get_write_delay(csp));
3730 #endif /* def FEATURE_HTTPS_INSPECTION */
3732 write_socket_delayed(csp->cfd,
3733 INVALID_SERVER_HEADERS_RESPONSE,
3734 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3736 mark_server_socket_tainted(csp);
3737 #ifdef FEATURE_HTTPS_INSPECTION
3738 close_client_and_server_ssl_connections(csp);
3745 * Since we have to wait for more from the server before
3746 * we can parse the headers we just continue here.
3748 log_error(LOG_LEVEL_CONNECT,
3749 "Continuing buffering server headers from socket %d. "
3750 "Bytes most recently read: %ld.", csp->cfd, len);
3757 * Account for the content bytes we
3758 * might have gotten with the headers.
3760 assert(csp->iob->eod >= csp->iob->cur);
3761 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3764 /* Did we actually get anything? */
3765 if (NULL == csp->headers->first)
3767 if ((csp->flags & CSP_FLAG_REUSED_CLIENT_CONNECTION))
3769 log_error(LOG_LEVEL_ERROR,
3770 "No server or forwarder response received on socket %d. "
3771 "Closing client socket %d without sending data.",
3772 csp->server_connection.sfd, csp->cfd);
3773 log_error(LOG_LEVEL_CLF,
3774 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3778 log_error(LOG_LEVEL_ERROR,
3779 "No server or forwarder response received on socket %d.",
3780 csp->server_connection.sfd);
3781 send_crunch_response(csp, error_response(csp, "no-server-data"));
3783 free_http_request(http);
3784 mark_server_socket_tainted(csp);
3785 #ifdef FEATURE_HTTPS_INSPECTION
3786 close_client_and_server_ssl_connections(csp);
3791 if (!csp->headers->first->str)
3793 log_error(LOG_LEVEL_ERROR, "header search: csp->headers->first->str == NULL, assert will be called");
3795 assert(csp->headers->first->str);
3797 if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
3798 strncmpic(csp->headers->first->str, "ICY", 3))
3801 * It doesn't look like a HTTP (or Shoutcast) response:
3802 * tell the client and log the problem.
3804 if (strlen(csp->headers->first->str) > 30)
3806 csp->headers->first->str[30] = '\0';
3808 log_error(LOG_LEVEL_ERROR,
3809 "Invalid server or forwarder response. Starts with: %s",
3810 csp->headers->first->str);
3811 log_error(LOG_LEVEL_CLF,
3812 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3813 #ifdef FEATURE_HTTPS_INSPECTION
3815 * Sending data with standard or secured connection (HTTP/HTTPS)
3817 if (client_use_ssl(csp))
3819 ssl_send_data_delayed(&(csp->ssl_client_attr),
3820 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3821 strlen(INVALID_SERVER_HEADERS_RESPONSE),
3822 get_write_delay(csp));
3825 #endif /* def FEATURE_HTTPS_INSPECTION */
3827 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3828 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3830 free_http_request(http);
3831 mark_server_socket_tainted(csp);
3832 #ifdef FEATURE_HTTPS_INSPECTION
3833 close_client_and_server_ssl_connections(csp);
3839 * We have now received the entire server header,
3840 * filter it and send the result to the client
3842 if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
3844 log_error(LOG_LEVEL_CLF,
3845 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3846 #ifdef FEATURE_HTTPS_INSPECTION
3848 * Sending data with standard or secured connection (HTTP/HTTPS)
3850 if (client_use_ssl(csp))
3852 ssl_send_data_delayed(&(csp->ssl_client_attr),
3853 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3854 strlen(INVALID_SERVER_HEADERS_RESPONSE),
3855 get_write_delay(csp));
3860 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3861 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3863 free_http_request(http);
3864 mark_server_socket_tainted(csp);
3865 #ifdef FEATURE_HTTPS_INSPECTION
3866 close_client_and_server_ssl_connections(csp);
3870 hdr = list_to_text(csp->headers);
3873 /* FIXME Should handle error properly */
3874 log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
3877 if ((csp->flags & CSP_FLAG_CHUNKED)
3878 && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3879 && ((csp->iob->eod - csp->iob->cur) >= 5)
3880 && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
3882 log_error(LOG_LEVEL_CONNECT,
3883 "Looks like we got the last chunk together with "
3884 "the server headers. We better stop reading.");
3885 byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3886 csp->expected_content_length = byte_count;
3887 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
3890 csp->server_connection.response_received = time(NULL);
3892 if (crunch_response_triggered(csp, crunchers_light))
3895 * One of the tags created by a server-header
3896 * tagger triggered a crunch. We already
3897 * delivered the crunch response to the client
3898 * and are done here after cleaning up.
3901 mark_server_socket_tainted(csp);
3902 #ifdef FEATURE_HTTPS_INSPECTION
3903 close_client_and_server_ssl_connections(csp);
3908 /* Buffer and pcrs filter this if appropriate. */
3909 buffer_and_filter_content = content_requires_filtering(csp);
3911 if (!buffer_and_filter_content)
3914 * Write the server's (modified) header to
3915 * the client (along with anything else that
3916 * may be in the buffer). Use standard or secured
3919 #ifdef FEATURE_HTTPS_INSPECTION
3920 if (client_use_ssl(csp))
3922 if ((ssl_send_data_delayed(&(csp->ssl_client_attr),
3923 (const unsigned char *)hdr, strlen(hdr),
3924 get_write_delay(csp)) < 0)
3925 || (len = ssl_flush_socket(&(csp->ssl_client_attr),
3928 log_error(LOG_LEVEL_CONNECT, "Write header to client failed");
3931 * The write failed, so don't bother mentioning it
3932 * to the client... it probably can't hear us anyway.
3935 mark_server_socket_tainted(csp);
3936 #ifdef FEATURE_HTTPS_INSPECTION
3937 close_client_and_server_ssl_connections(csp);
3943 #endif /* def FEATURE_HTTPS_INSPECTION */
3945 if (write_socket_delayed(csp->cfd, hdr, strlen(hdr), write_delay)
3946 || ((len = flush_iob(csp->cfd, csp->iob, write_delay)) < 0))
3948 log_error(LOG_LEVEL_ERROR,
3949 "write header to client failed");
3951 * The write failed, so don't bother mentioning it
3952 * to the client... it probably can't hear us anyway.
3955 mark_server_socket_tainted(csp);
3961 /* we're finished with the server's header */
3967 * If this was a MS IIS/5 hack then it means the server
3968 * has already closed the connection. Nothing more to read.
3973 log_error(LOG_LEVEL_ERROR,
3974 "Closed server connection detected. "
3975 "Applying the MS IIS5 hack didn't help.");
3976 log_error(LOG_LEVEL_CLF,
3977 "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3978 #ifdef FEATURE_HTTPS_INSPECTION
3980 * Sending data with standard or secured connection (HTTP/HTTPS)
3982 if (client_use_ssl(csp))
3984 ssl_send_data_delayed(&(csp->ssl_client_attr),
3985 (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3986 strlen(INVALID_SERVER_HEADERS_RESPONSE),
3987 get_write_delay(csp));
3990 #endif /* def FEATURE_HTTPS_INSPECTION */
3992 write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3993 strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3995 mark_server_socket_tainted(csp);
3996 #ifdef FEATURE_HTTPS_INSPECTION
3997 close_client_and_server_ssl_connections(csp);
4004 mark_server_socket_tainted(csp);
4005 #ifdef FEATURE_HTTPS_INSPECTION
4006 close_client_and_server_ssl_connections(csp);
4008 return; /* huh? we should never get here */
4011 if (csp->content_length == 0)
4014 * If Privoxy didn't recalculate the Content-Length,
4015 * byte_count is still correct.
4017 csp->content_length = byte_count;
4020 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4021 if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
4022 && (csp->expected_content_length != byte_count))
4024 log_error(LOG_LEVEL_CONNECT,
4025 "Received %llu bytes while expecting %llu.",
4026 byte_count, csp->expected_content_length);
4027 mark_server_socket_tainted(csp);
4031 #ifdef FEATURE_HTTPS_INSPECTION
4032 if (client_use_ssl(csp))
4034 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s https://%s%s %s\" 200 %llu",
4035 csp->ip_addr_str, http->gpc, http->hostport, http->path,
4036 http->version, csp->content_length);
4041 log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %llu",
4042 csp->ip_addr_str, http->ocmd, csp->content_length);
4044 csp->server_connection.timestamp = time(NULL);
4048 /*********************************************************************
4052 * Description : Once a connection from the client has been accepted,
4053 * this function is called (via serve()) to handle the
4054 * main business of the communication. This function
4055 * returns after dealing with a single request. It can
4056 * be called multiple times with the same client socket
4057 * if the client is keeping the connection alive.
4059 * The decision whether or not a client connection will
4060 * be kept alive is up to the caller which also must
4061 * close the client socket when done.
4063 * FIXME: chat is nearly thousand lines long.
4067 * 1 : csp = Current client state (buffers, headers, etc...)
4069 * Returns : Nothing.
4071 *********************************************************************/
4072 static void chat(struct client_state *csp)
4074 const struct forward_spec *fwd;
4075 struct http_request *http;
4076 /* Skeleton for HTTP response, if we should intercept the request */
4077 struct http_response *rsp;
4078 #ifdef FEATURE_HTTPS_INSPECTION
4079 int use_ssl_tunnel = 0;
4084 if (receive_client_request(csp) != JB_ERR_OK)
4088 if (parse_client_request(csp) != JB_ERR_OK)
4093 /* decide how to route the HTTP request */
4094 fwd = forward_url(csp, http);
4096 #ifdef FEATURE_HTTPS_INSPECTION
4098 * Setting flags to use old solution with SSL tunnel and to disable
4099 * certificate verification.
4101 if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION)
4102 && !cgi_page_requested(csp->http->host))
4107 if (http->ssl && (csp->action->flags & ACTION_IGNORE_CERTIFICATE_ERRORS))
4109 csp->dont_verify_certificate = 1;
4114 * build the http request to send to the server
4115 * we have to do one of the following:
4117 * create = use the original HTTP request to create a new
4118 * HTTP request that has either the path component
4119 * without the http://domainspec (w/path) or the
4120 * full orininal URL (w/url)
4121 * Note that the path and/or the HTTP version may
4122 * have been altered by now.
4124 * SSL proxy = Open a socket to the host:port of the server
4125 * and create TLS/SSL connection with server and
4126 * with client. Then behave like mediator between
4127 * client and server over TLS/SSL.
4129 * SSL proxy = Pass the request unchanged if forwarding a CONNECT
4130 * with request to a parent proxy. Note that we'll be sending
4131 * forwarding the CFAIL message ourselves if connecting to the parent
4132 * fails, but we won't send a CSUCCEED message if it works,
4133 * since that would result in a double message (ours and the
4134 * parent's). After sending the request to the parent, we
4135 * must parse answer and send it to client. If connection
4136 * with server is established, we do TLS/SSL proxy. Otherwise
4137 * we send parent response to client and close connections.
4139 * here's the matrix:
4142 * +--------+--------+
4144 * 0 | create | SSL |
4145 * | w/path | proxy |
4146 * Forwarding +--------+--------+
4148 * 1 | create | proxy |
4149 * | w/url |+forward|
4150 * +--------+--------+
4154 #ifdef FEATURE_HTTPS_INSPECTION
4156 * Presetting SSL client and server flags
4158 if (http->ssl && !use_ssl_tunnel)
4160 http->client_ssl = 1;
4161 http->server_ssl = 1;
4165 http->client_ssl = 0;
4166 http->server_ssl = 0;
4170 #ifdef FEATURE_HTTPS_INSPECTION
4172 * Log the request unless we're https inspecting
4173 * in which case we don't have the path yet and
4174 * will log the request later.
4176 if (!client_use_ssl(csp))
4179 log_error(LOG_LEVEL_REQUEST, "%s%s", http->hostport, http->path);
4182 if (http->ssl && connect_port_is_forbidden(csp))
4184 const char *acceptable_connect_ports =
4185 csp->action->string[ACTION_STRING_LIMIT_CONNECT];
4186 assert(NULL != acceptable_connect_ports);
4187 log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
4188 "limit-connect{%s} doesn't allow CONNECT requests to %s",
4189 csp->ip_addr_str, acceptable_connect_ports, csp->http->hostport);
4190 csp->action->flags |= ACTION_BLOCK;
4192 #ifdef FEATURE_HTTPS_INSPECTION
4193 http->client_ssl = 0;
4194 http->server_ssl = 0;
4199 freez(csp->headers->first->str);
4200 build_request_line(csp, fwd, &csp->headers->first->str);
4203 * We have a request. Check if one of the crunchers wants it
4204 * unless the client wants to use TLS/SSL in which case we
4205 * haven't setup the TLS context yet and will send the crunch
4209 #ifdef FEATURE_HTTPS_INSPECTION
4210 !client_use_ssl(csp) &&
4212 crunch_response_triggered(csp, crunchers_all))
4215 * Yes. The client got the crunch response and we're done here.
4220 log_applied_actions(csp->action);
4221 if (fwd->forward_host)
4223 log_error(LOG_LEVEL_CONNECT, "via [%s]:%d to: %s",
4224 fwd->forward_host, fwd->forward_port, http->hostport);
4228 log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
4231 /* here we connect to the server, gateway, or the forwarder */
4233 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4234 if ((csp->server_connection.sfd != JB_INVALID_SOCKET)
4235 && socket_is_still_alive(csp->server_connection.sfd)
4236 && connection_destination_matches(&csp->server_connection, http, fwd))
4238 log_error(LOG_LEVEL_CONNECT,
4239 "Reusing server socket %d connected to %s. Total requests: %u.",
4240 csp->server_connection.sfd, csp->server_connection.host,
4241 csp->server_connection.requests_sent_total);
4245 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4247 #ifdef FEATURE_CONNECTION_SHARING
4248 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING
4249 #ifdef FEATURE_HTTPS_INSPECTION
4250 && !server_use_ssl(csp)
4254 remember_connection(&csp->server_connection);
4257 #endif /* def FEATURE_CONNECTION_SHARING */
4259 log_error(LOG_LEVEL_CONNECT,
4260 "Closing server socket %d connected to %s. Total requests: %u.",
4261 csp->server_connection.sfd, csp->server_connection.host,
4262 csp->server_connection.requests_sent_total);
4263 close_socket(csp->server_connection.sfd);
4265 mark_connection_closed(&csp->server_connection);
4267 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4268 #ifdef FEATURE_HTTPS_INSPECTION
4269 if (client_use_ssl(csp) && !use_ssl_tunnel)
4273 * Creating a SSL proxy.
4275 * By sending the CSUCCEED message we're lying to the client as
4276 * the connection hasn't actually been established yet. We don't
4277 * establish the connection until we have seen and parsed the
4278 * encrypted client headers.
4280 if (write_socket_delayed(csp->cfd, CSUCCEED,
4281 strlen(CSUCCEED), get_write_delay(csp)) != 0)
4283 log_error(LOG_LEVEL_ERROR, "Sending SUCCEED to client failed");
4287 ret = create_client_ssl_connection(csp);
4290 log_error(LOG_LEVEL_ERROR,
4291 "Failed to open a secure connection with the client");
4294 if (JB_ERR_OK != process_encrypted_request(csp))
4296 close_client_ssl_connection(csp);
4300 * We have an encrypted request. Check if one of the crunchers now
4301 * wants it (for example because the previously invisible path was
4302 * required to match).
4304 if (crunch_response_triggered(csp, crunchers_all))
4307 * Yes. The client got the crunch response and we're done here.
4314 * Connecting to destination server
4316 csp->server_connection.sfd = forwarded_connect(fwd, http, csp);
4318 if (csp->server_connection.sfd == JB_INVALID_SOCKET)
4320 if (fwd->type != SOCKS_NONE)
4323 rsp = error_response(csp, "forwarding-failed");
4325 else if (errno == EINVAL)
4327 rsp = error_response(csp, "no-such-domain");
4331 rsp = error_response(csp, "connect-failed");
4334 /* Write the answer to the client */
4337 send_crunch_response(csp, rsp);
4341 * Temporary workaround to prevent already-read client
4342 * bodies from being parsed as new requests. For now we
4343 * err on the safe side and throw all the following
4344 * requests under the bus, even if no client body has been
4345 * buffered. A compliant client will repeat the dropped
4346 * requests on an untainted connection.
4348 * The proper fix is to discard the no longer needed
4349 * client body in the buffer (if there is one) and to
4350 * continue parsing the bytes that follow.
4352 #ifdef FEATURE_HTTPS_INSPECTION
4353 close_client_ssl_connection(csp);
4355 drain_and_close_socket(csp->cfd);
4356 csp->cfd = JB_INVALID_SOCKET;
4361 #ifdef FEATURE_HTTPS_INSPECTION
4363 * Creating TLS/SSL connections with destination server or parent
4364 * proxy. If forwarding is enabled, we must send client request to
4365 * parent proxy and receive, parse and resend parent proxy answer.
4367 if (http->ssl && !use_ssl_tunnel)
4369 if (fwd->forward_host != NULL)
4371 char server_response[BUFFER_SIZE];
4374 char *hdr = list_to_text(csp->headers);
4375 memset(server_response, 0, sizeof(server_response));
4379 log_error(LOG_LEVEL_FATAL,
4380 "Out of memory parsing client header");
4382 list_remove_all(csp->headers);
4385 * Sending client's CONNECT request to the parent proxy
4387 ret = write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
4393 log_error(LOG_LEVEL_CONNECT,
4394 "Sending request headers to: %s failed", http->hostport);
4395 mark_server_socket_tainted(csp);
4396 close_client_ssl_connection(csp);
4400 /* Waiting for parent proxy server response */
4401 len = read_socket(csp->server_connection.sfd, server_response,
4402 sizeof(server_response)-1);
4406 log_error(LOG_LEVEL_ERROR, "No response from parent proxy "
4407 "server on socket %d.", csp->server_connection.sfd);
4409 rsp = error_response(csp, "no-server-data");
4412 send_crunch_response(csp, rsp);
4414 mark_server_socket_tainted(csp);
4415 close_client_ssl_connection(csp);
4420 * Test if the connection to the destination server was
4421 * established successfully by the parent proxy.
4423 if (!tunnel_established_successfully(server_response, (unsigned int)len))
4425 log_error(LOG_LEVEL_ERROR,
4426 "The forwarder %s failed to establish a connection with %s",
4427 fwd->forward_host, http->host);
4428 rsp = error_response(csp, "connect-failed");
4431 send_crunch_response(csp, rsp);
4433 mark_server_socket_tainted(csp);
4434 close_client_ssl_connection(csp);
4437 } /* -END- if (fwd->forward_host != NULL) */
4440 * We can now create the TLS/SSL connection with the destination server.
4442 int ret = create_server_ssl_connection(csp);
4445 if (csp->server_cert_verification_result != SSL_CERT_VALID &&
4446 csp->server_cert_verification_result != SSL_CERT_NOT_VERIFIED)
4449 * If the server certificate is invalid, we must inform
4450 * the client and then close connection to the client.
4452 ssl_send_certificate_error(csp);
4453 close_client_and_server_ssl_connections(csp);
4456 if (csp->server_cert_verification_result == SSL_CERT_NOT_VERIFIED
4457 || csp->server_cert_verification_result == SSL_CERT_VALID)
4460 * The TLS/SSL connection wasn't created but an invalid
4461 * certificate wasn't detected. Report it as connection
4464 rsp = error_response(csp, "connect-failed");
4467 send_crunch_response(csp, rsp);
4469 close_client_and_server_ssl_connections(csp);
4473 }/* -END- if (http->ssl) */
4474 #endif /* def FEATURE_HTTPS_INSPECTION */
4476 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4477 save_connection_destination(csp->server_connection.sfd,
4478 http, fwd, &csp->server_connection);
4479 csp->server_connection.keep_alive_timeout =
4480 (unsigned)csp->config->keep_alive_timeout;
4482 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4484 csp->server_connection.requests_sent_total++;
4486 if ((fwd->type == SOCKS_5T) && (NULL == csp->headers->first))
4488 /* Client headers have been sent optimistically */
4489 assert(csp->headers->last == NULL);
4491 else if (http->ssl == 0 || (fwd->forward_host
4492 #ifdef FEATURE_HTTPS_INSPECTION
4497 if (send_http_request(csp))
4499 rsp = error_response(csp, "connect-failed");
4502 send_crunch_response(csp, rsp);
4510 * Using old solution with SSL tunnel or new solution with SSL proxy
4512 list_remove_all(csp->headers);
4513 #ifdef FEATURE_HTTPS_INSPECTION
4518 * We're running an SSL tunnel and we're not forwarding,
4519 * so just ditch the client headers, send the "connect succeeded"
4520 * message to the client, flush the rest, and get out of the way.
4522 if (write_socket_delayed(csp->cfd, CSUCCEED,
4523 strlen(CSUCCEED), get_write_delay(csp)))
4528 #ifdef FEATURE_HTTPS_INSPECTION
4532 * If server certificate has been verified and is invalid,
4533 * we must inform the client and then close the connection
4534 * with client and server.
4536 if (csp->server_cert_verification_result != SSL_CERT_VALID &&
4537 csp->server_cert_verification_result != SSL_CERT_NOT_VERIFIED)
4539 ssl_send_certificate_error(csp);
4540 close_client_and_server_ssl_connections(csp);
4543 if (send_https_request(csp))
4545 rsp = error_response(csp, "connect-failed");
4548 send_crunch_response(csp, rsp);
4550 close_client_and_server_ssl_connections(csp);
4554 #endif /* def FEATURE_HTTPS_INSPECTION */
4555 clear_iob(csp->client_iob);
4556 }/* -END- else ... if (http->ssl == 1) */
4558 log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
4560 /* XXX: should the time start earlier for optimistically sent data? */
4561 csp->server_connection.request_sent = time(NULL);
4563 handle_established_connection(csp);
4564 freez(csp->receive_buffer);
4569 /*********************************************************************
4571 * Function : fuzz_server_response
4573 * Description : Treat the input as a whole server response.
4576 * 1 : csp = Current client state (buffers, headers, etc...)
4577 * 2 : fuzz_input_file = File to read the input from.
4581 *********************************************************************/
4582 extern int fuzz_server_response(struct client_state *csp, char *fuzz_input_file)
4584 static struct forward_spec fwd; /* Zero'd due to being static */
4587 if (strcmp(fuzz_input_file, "-") == 0)
4589 /* XXX: Doesn't work yet. */
4590 csp->server_connection.sfd = 0;
4594 csp->server_connection.sfd = open(fuzz_input_file, O_RDONLY);
4595 if (csp->server_connection.sfd == -1)
4597 log_error(LOG_LEVEL_FATAL, "Failed to open %s: %E",
4602 csp->content_type |= CT_GIF;
4603 csp->action->flags |= ACTION_DEANIMATE;
4604 csp->action->string[ACTION_STRING_DEANIMATE] = "last";
4606 csp->http->path = strdup_or_die("/");
4607 csp->http->host = strdup_or_die("fuzz.example.org");
4608 csp->http->hostport = strdup_or_die("fuzz.example.org:80");
4609 /* Prevent client socket monitoring */
4610 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
4611 csp->flags |= CSP_FLAG_CHUNKED;
4613 csp->config->feature_flags |= RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
4614 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
4616 csp->content_type |= CT_DECLARED|CT_GIF;
4618 csp->config->socket_timeout = 0;
4620 cgi_init_error_messages();
4622 handle_established_connection(csp);
4623 freez(csp->receive_buffer);
4630 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4631 /*********************************************************************
4633 * Function : prepare_csp_for_next_request
4635 * Description : Put the csp in a mostly vergin state.
4638 * 1 : csp = Current client state (buffers, headers, etc...)
4642 *********************************************************************/
4643 static void prepare_csp_for_next_request(struct client_state *csp)
4645 csp->content_type = 0;
4646 csp->content_length = 0;
4647 csp->expected_content_length = 0;
4648 csp->expected_client_content_length = 0;
4649 list_remove_all(csp->headers);
4650 clear_iob(csp->iob);
4651 freez(csp->error_message);
4652 free_http_request(csp->http);
4653 destroy_list(csp->headers);
4654 #ifdef FEATURE_HTTPS_INSPECTION
4655 destroy_list(csp->https_headers);
4657 destroy_list(csp->tags);
4658 #ifdef FEATURE_CLIENT_TAGS
4659 destroy_list(csp->client_tags);
4660 freez(csp->client_address);
4662 free_current_action(csp->action);
4663 if (NULL != csp->fwd)
4665 unload_forward_spec(csp->fwd);
4668 /* XXX: Store per-connection flags someplace else. */
4669 csp->flags = (CSP_FLAG_ACTIVE | CSP_FLAG_REUSED_CLIENT_CONNECTION);
4670 #ifdef FEATURE_TOGGLE
4671 if (global_toggle_state)
4672 #endif /* def FEATURE_TOGGLE */
4674 csp->flags |= CSP_FLAG_TOGGLED_ON;
4677 if (csp->client_iob->eod > csp->client_iob->cur)
4679 long bytes_to_shift = csp->client_iob->cur - csp->client_iob->buf;
4680 size_t data_length = (size_t)(csp->client_iob->eod - csp->client_iob->cur);
4682 assert(bytes_to_shift > 0);
4683 assert(data_length > 0);
4685 log_error(LOG_LEVEL_CONNECT, "Shifting %lu pipelined bytes by %ld bytes",
4686 data_length, bytes_to_shift);
4687 memmove(csp->client_iob->buf, csp->client_iob->cur, data_length);
4688 csp->client_iob->cur = csp->client_iob->buf;
4689 assert(csp->client_iob->eod == csp->client_iob->buf + bytes_to_shift + data_length);
4690 csp->client_iob->eod = csp->client_iob->buf + data_length;
4691 memset(csp->client_iob->eod, '\0', (size_t)bytes_to_shift);
4693 csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
4698 * We mainly care about resetting client_iob->cur so we don't
4699 * waste buffer space at the beginning and don't mess up the
4700 * request restoration done by cgi_show_request().
4702 * Freeing the buffer itself isn't technically necessary,
4703 * but makes debugging more convenient.
4705 clear_iob(csp->client_iob);
4708 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4711 /*********************************************************************
4715 * Description : This is little more than chat. We only "serve" to
4716 * to close (or remember) any socket that chat may have
4720 * 1 : csp = Current client state (buffers, headers, etc...)
4724 *********************************************************************/
4725 static void serve(struct client_state *csp)
4727 int config_file_change_detected = 0; /* Only used for debugging */
4728 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4729 #ifdef FEATURE_CONNECTION_SHARING
4730 static int monitor_thread_running = 0;
4731 #endif /* def FEATURE_CONNECTION_SHARING */
4732 int continue_chatting = 0;
4734 log_error(LOG_LEVEL_CONNECT, "Accepted connection from %s on socket %d",
4735 csp->ip_addr_str, csp->cfd);
4739 unsigned int latency;
4741 #ifdef FEATURE_HTTPS_INSPECTION
4742 if (continue_chatting && client_use_ssl(csp))
4744 continue_https_chat(csp);
4753 * If the request has been crunched,
4754 * the calculated latency is zero.
4756 latency = (unsigned)(csp->server_connection.response_received -
4757 csp->server_connection.request_sent) / 2;
4759 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4760 && (csp->flags & CSP_FLAG_CRUNCHED)
4761 && (csp->expected_client_content_length != 0))
4763 csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
4764 log_error(LOG_LEVEL_CONNECT,
4765 "Tainting client socket %d due to unread data.", csp->cfd);
4768 continue_chatting = (csp->config->feature_flags
4769 & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
4770 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
4771 && (csp->cfd != JB_INVALID_SOCKET)
4772 && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4773 && ((csp->flags & CSP_FLAG_SERVER_CONTENT_LENGTH_SET)
4774 || (csp->flags & CSP_FLAG_CHUNKED));
4776 if (!(csp->flags & CSP_FLAG_CRUNCHED)
4777 && (csp->server_connection.sfd != JB_INVALID_SOCKET))
4779 if (!(csp->flags & CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET))
4781 csp->server_connection.keep_alive_timeout = csp->config->default_server_timeout;
4783 if (!(csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
4784 || (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
4785 || !socket_is_still_alive(csp->server_connection.sfd)
4786 || !(latency < csp->server_connection.keep_alive_timeout))
4788 log_error(LOG_LEVEL_CONNECT,
4789 "Closing server socket %d connected to %s. "
4790 "Keep-alive: %u. Tainted: %u. Socket alive: %u. Timeout: %u.",
4791 csp->server_connection.sfd, csp->server_connection.host,
4792 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
4793 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
4794 socket_is_still_alive(csp->server_connection.sfd),
4795 csp->server_connection.keep_alive_timeout);
4796 #ifdef FEATURE_CONNECTION_SHARING
4797 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4799 forget_connection(csp->server_connection.sfd);
4801 #endif /* def FEATURE_CONNECTION_SHARING */
4802 #ifdef FEATURE_HTTPS_INSPECTION
4803 close_server_ssl_connection(csp);
4805 close_socket(csp->server_connection.sfd);
4806 mark_connection_closed(&csp->server_connection);
4810 if (continue_chatting && any_loaded_file_changed(csp))
4812 continue_chatting = 0;
4813 config_file_change_detected = 1;
4815 #ifdef FEATURE_HTTPS_INSPECTION
4816 if (continue_chatting && client_use_ssl(csp) &&
4817 csp->ssl_with_client_is_opened == 0)
4819 continue_chatting = 0;
4820 log_error(LOG_LEVEL_CONNECT, "Client socket %d is no longer usable. "
4821 "The TLS session has been terminated.", csp->cfd);
4825 if (continue_chatting)
4827 if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
4828 && socket_is_still_alive(csp->cfd))
4830 log_error(LOG_LEVEL_CONNECT, "Client request %d has been "
4831 "pipelined on socket %d and the socket is still alive.",
4832 csp->requests_received_total+1, csp->cfd);
4833 prepare_csp_for_next_request(csp);
4837 if (0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
4839 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4841 log_error(LOG_LEVEL_CONNECT,
4842 "Waiting for the next client request on socket %d. "
4843 "Keeping the server socket %d to %s open.",
4844 csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
4848 log_error(LOG_LEVEL_CONNECT,
4849 "Waiting for the next client request on socket %d. "
4850 "No server socket to keep open.", csp->cfd);
4854 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4855 && data_is_available(csp->cfd, (int)csp->config->keep_alive_timeout)
4856 && socket_is_still_alive(csp->cfd))
4858 log_error(LOG_LEVEL_CONNECT,
4859 "Data arrived in time on client socket %d. Requests so far: %u",
4860 csp->cfd, csp->requests_received_total);
4861 prepare_csp_for_next_request(csp);
4865 #ifdef FEATURE_CONNECTION_SHARING
4866 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4867 && (csp->server_connection.sfd != JB_INVALID_SOCKET)
4868 && (socket_is_still_alive(csp->server_connection.sfd))
4869 #ifdef FEATURE_HTTPS_INSPECTION
4870 && !server_use_ssl(csp)
4874 time_t time_open = time(NULL) - csp->server_connection.timestamp;
4876 if (csp->server_connection.keep_alive_timeout < time_open - (time_t)latency)
4881 remember_connection(&csp->server_connection);
4882 csp->server_connection.sfd = JB_INVALID_SOCKET;
4883 drain_and_close_socket(csp->cfd);
4884 csp->cfd = JB_INVALID_SOCKET;
4885 privoxy_mutex_lock(&connection_reuse_mutex);
4886 if (!monitor_thread_running)
4888 monitor_thread_running = 1;
4889 privoxy_mutex_unlock(&connection_reuse_mutex);
4890 wait_for_alive_connections();
4891 privoxy_mutex_lock(&connection_reuse_mutex);
4892 monitor_thread_running = 0;
4894 privoxy_mutex_unlock(&connection_reuse_mutex);
4896 #endif /* def FEATURE_CONNECTION_SHARING */
4900 else if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4902 log_error(LOG_LEVEL_CONNECT,
4903 "Closing server socket %d connected to %s. Keep-alive: %u. "
4904 "Tainted: %u. Socket alive: %u. Timeout: %u. "
4905 "Configuration file change detected: %u",
4906 csp->server_connection.sfd, csp->server_connection.host,
4907 0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
4908 0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
4909 socket_is_still_alive(csp->server_connection.sfd),
4910 csp->server_connection.keep_alive_timeout,
4911 config_file_change_detected);
4913 } while (continue_chatting);
4917 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4919 if (csp->cfd != JB_INVALID_SOCKET)
4921 log_error(LOG_LEVEL_CONNECT, "Closing client socket %d. "
4922 "Keep-alive: %u. Socket alive: %u. Data available: %u. "
4923 "Configuration file change detected: %u. Requests received: %u.",
4924 csp->cfd, 0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE),
4925 socket_is_still_alive(csp->cfd), data_is_available(csp->cfd, 0),
4926 config_file_change_detected, csp->requests_received_total);
4927 #ifdef FEATURE_HTTPS_INSPECTION
4928 close_client_ssl_connection(csp);
4930 drain_and_close_socket(csp->cfd);
4933 if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4935 #ifdef FEATURE_CONNECTION_SHARING
4936 if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4938 forget_connection(csp->server_connection.sfd);
4940 #endif /* def FEATURE_CONNECTION_SHARING */
4942 #ifdef FEATURE_HTTPS_INSPECTION
4943 close_server_ssl_connection(csp);
4944 #endif /* def FEATURE_HTTPS_INSPECTION */
4946 close_socket(csp->server_connection.sfd);
4949 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4950 mark_connection_closed(&csp->server_connection);
4953 free_csp_resources(csp);
4955 csp->flags &= ~CSP_FLAG_ACTIVE;
4961 /*********************************************************************
4963 * Function : server_thread
4965 * Description : We only exist to call `serve' in a threaded environment.
4968 * 1 : data = Current client state (buffers, headers, etc...)
4970 * Returns : Always 0.
4972 *********************************************************************/
4973 static int32 server_thread(void *data)
4975 serve((struct client_state *) data);
4982 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
4983 /*********************************************************************
4987 * Description : Print usage info & exit.
4989 * Parameters : Pointer to argv[0] for identifying ourselves
4993 *********************************************************************/
4994 static void usage(const char *name)
4996 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
4997 "Usage: %s [--config-test] "
5000 #endif /* defined(unix) */
5003 "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
5004 #endif /* defined(unix) */
5005 "[--version] [configfile]\n",
5009 show_fuzz_usage(name);
5012 printf("Aborting\n");
5017 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
5020 #ifdef MUTEX_LOCKS_AVAILABLE
5021 /*********************************************************************
5023 * Function : privoxy_mutex_lock
5025 * Description : Locks a mutex.
5028 * 1 : mutex = The mutex to lock.
5030 * Returns : Void. May exit in case of errors.
5032 *********************************************************************/
5033 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
5035 #ifdef FEATURE_PTHREAD
5036 int err = pthread_mutex_lock(mutex);
5039 if (mutex != &log_mutex)
5041 log_error(LOG_LEVEL_FATAL,
5042 "Mutex locking failed: %s.\n", strerror(err));
5047 EnterCriticalSection(mutex);
5048 #endif /* def FEATURE_PTHREAD */
5052 /*********************************************************************
5054 * Function : privoxy_mutex_unlock
5056 * Description : Unlocks a mutex.
5059 * 1 : mutex = The mutex to unlock.
5061 * Returns : Void. May exit in case of errors.
5063 *********************************************************************/
5064 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
5066 #ifdef FEATURE_PTHREAD
5067 int err = pthread_mutex_unlock(mutex);
5070 if (mutex != &log_mutex)
5072 log_error(LOG_LEVEL_FATAL,
5073 "Mutex unlocking failed: %s.\n", strerror(err));
5078 LeaveCriticalSection(mutex);
5079 #endif /* def FEATURE_PTHREAD */
5083 /*********************************************************************
5085 * Function : privoxy_mutex_init
5087 * Description : Prepares a mutex.
5090 * 1 : mutex = The mutex to initialize.
5092 * Returns : Void. May exit in case of errors.
5094 *********************************************************************/
5095 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
5097 #ifdef FEATURE_PTHREAD
5098 int err = pthread_mutex_init(mutex, 0);
5101 printf("Fatal error. Mutex initialization failed: %s.\n",
5106 InitializeCriticalSection(mutex);
5107 #endif /* def FEATURE_PTHREAD */
5109 #endif /* def MUTEX_LOCKS_AVAILABLE */
5111 /*********************************************************************
5113 * Function : initialize_mutexes
5115 * Description : Prepares mutexes if mutex support is available.
5119 * Returns : Void, exits in case of errors.
5121 *********************************************************************/
5122 static void initialize_mutexes(void)
5124 #ifdef MUTEX_LOCKS_AVAILABLE
5126 * Prepare global mutex semaphores
5129 #ifdef FEATURE_HTTPS_INSPECTION
5130 privoxy_mutex_init(&certificate_mutex);
5131 privoxy_mutex_init(&ssl_init_mutex);
5134 privoxy_mutex_init(&log_mutex);
5135 privoxy_mutex_init(&log_init_mutex);
5136 privoxy_mutex_init(&connection_reuse_mutex);
5137 #ifdef FEATURE_EXTERNAL_FILTERS
5138 privoxy_mutex_init(&external_filter_mutex);
5140 #ifdef FEATURE_CLIENT_TAGS
5141 privoxy_mutex_init(&client_tags_mutex);
5143 #ifdef FEATURE_EXTENDED_STATISTICS
5144 privoxy_mutex_init(&filter_statistics_mutex);
5145 privoxy_mutex_init(&block_statistics_mutex);
5149 * XXX: The assumptions below are a bit naive
5150 * and can cause locks that aren't necessary.
5152 * For example older FreeBSD versions (< 6.x?)
5153 * have no gethostbyname_r, but gethostbyname is
5156 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
5157 privoxy_mutex_init(&resolver_mutex);
5158 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
5160 * XXX: should we use a single mutex for
5161 * localtime() and gmtime() as well?
5163 #ifndef HAVE_GMTIME_R
5164 privoxy_mutex_init(&gmtime_mutex);
5165 #endif /* ndef HAVE_GMTIME_R */
5167 #ifndef HAVE_LOCALTIME_R
5168 privoxy_mutex_init(&localtime_mutex);
5169 #endif /* ndef HAVE_GMTIME_R */
5171 #if !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM)
5172 privoxy_mutex_init(&rand_mutex);
5173 #endif /* !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM) */
5175 #endif /* def MUTEX_LOCKS_AVAILABLE */
5178 /*********************************************************************
5182 * Description : Load the config file and start the listen loop.
5183 * This function is a lot more *sane* with the `load_config'
5184 * and `listen_loop' functions; although it stills does
5185 * a *little* too much for my taste.
5188 * 1 : argc = Number of parameters (including $0).
5189 * 2 : argv = Array of (char *)'s to the parameters.
5191 * Returns : 1 if : can't open config file, unrecognized directive,
5192 * stats requested in multi-thread mode, can't open the
5193 * log file, can't open the jar file, listen port is invalid,
5194 * any load fails, and can't bind port.
5196 * Else main never returns, the process must be signaled
5197 * to terminate execution. Or, on Windows, use the
5198 * "File", "Exit" menu option.
5200 *********************************************************************/
5202 int real_main(int argc, char **argv)
5204 int main(int argc, char **argv)
5208 int do_config_test = 0;
5209 #ifndef HAVE_ARC4RANDOM
5210 unsigned int random_seed;
5213 struct passwd *pw = NULL;
5214 struct group *grp = NULL;
5216 char *pre_chroot_nslookup_to_load_resolver = NULL;
5219 char *fuzz_input_type = NULL;
5220 char *fuzz_input_file = NULL;
5227 #if !defined(_WIN32)
5234 /* Prepare mutexes if supported and necessary. */
5235 initialize_mutexes();
5237 /* Enable logging until further notice. */
5241 * Parse the command line arguments
5243 * XXX: simply printing usage information in case of
5244 * invalid arguments isn't particularly user friendly.
5246 while (++argc_pos < argc)
5249 /* Check to see if the service must be installed or uninstalled */
5250 if (strncmp(argv[argc_pos], "--install", 9) == 0)
5252 const char *pName = argv[argc_pos] + 9;
5255 exit((install_service(pName)) ? 0 : 1);
5257 else if (strncmp(argv[argc_pos], "--uninstall", 11) == 0)
5259 const char *pName = argv[argc_pos] + 11;
5262 exit((uninstall_service(pName)) ? 0 : 1);
5264 else if (strcmp(argv[argc_pos], "--service") == 0)
5266 bRunAsService = TRUE;
5267 w32_set_service_cwd();
5268 atexit(w32_service_exit_notify);
5271 #endif /* defined(_WIN32) */
5274 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
5276 if (strcmp(argv[argc_pos], "--help") == 0)
5281 else if (strcmp(argv[argc_pos], "--version") == 0)
5283 printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
5289 else if (strcmp(argv[argc_pos], "--no-daemon") == 0)
5291 set_debug_level(LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
5295 else if (strcmp(argv[argc_pos], "--pidfile") == 0)
5297 if (++argc_pos == argc) usage(argv[0]);
5298 pidfile = strdup_or_die(argv[argc_pos]);
5301 else if (strcmp(argv[argc_pos], "--user") == 0)
5306 if (++argc_pos == argc) usage(argv[argc_pos]);
5308 user_arg = strdup_or_die(argv[argc_pos]);
5309 group_name = strchr(user_arg, '.');
5310 if (NULL != group_name)
5312 /* Nul-terminate the user name */
5315 /* Skip the former delimiter to actually reach the group name */
5318 grp = getgrnam(group_name);
5321 log_error(LOG_LEVEL_FATAL, "Group '%s' not found.", group_name);
5324 pw = getpwnam(user_arg);
5327 log_error(LOG_LEVEL_FATAL, "User '%s' not found.", user_arg);
5333 else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup") == 0)
5335 if (++argc_pos == argc) usage(argv[0]);
5336 pre_chroot_nslookup_to_load_resolver = strdup_or_die(argv[argc_pos]);
5339 else if (strcmp(argv[argc_pos], "--chroot") == 0)
5343 #endif /* defined(unix) */
5345 else if (strcmp(argv[argc_pos], "--config-test") == 0)
5350 else if (strcmp(argv[argc_pos], "--fuzz") == 0)
5353 if (argc < argc_pos + 2) usage(argv[0]);
5354 fuzz_input_type = argv[argc_pos];
5356 fuzz_input_file = argv[argc_pos];
5358 else if (strcmp(argv[argc_pos], "--stfu") == 0)
5360 set_debug_level(LOG_LEVEL_STFU);
5363 else if (argc_pos + 1 != argc)
5366 * This is neither the last command line
5367 * option, nor was it recognized before,
5368 * therefore it must be invalid.
5374 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
5376 configfile = argv[argc_pos];
5379 } /* -END- while (more arguments) */
5381 show_version(Argv[0]);
5384 if (*configfile != '/')
5386 char cwd[BUFFER_SIZE];
5388 size_t abs_file_size;
5390 /* make config-filename absolute here */
5391 if (NULL == getcwd(cwd, sizeof(cwd)))
5393 perror("failed to get current working directory");
5397 basedir = strdup_or_die(cwd);
5399 abs_file_size = strlen(cwd) + strlen(configfile) + 5;
5400 abs_file = malloc_or_die(abs_file_size);
5401 strlcpy(abs_file, basedir, abs_file_size);
5402 strlcat(abs_file, "/", abs_file_size);
5403 strlcat(abs_file, configfile, abs_file_size);
5404 configfile = abs_file;
5406 #endif /* defined unix */
5410 clients->next = NULL;
5412 /* XXX: factor out initialising after the next stable release. */
5417 #ifndef HAVE_ARC4RANDOM
5418 random_seed = (unsigned int)time(NULL);
5420 srandom(random_seed);
5423 #endif /* ifdef HAVE_RANDOM */
5424 #endif /* ifndef HAVE_ARC4RANDOM */
5427 * Unix signal handling
5429 * Catch the abort, interrupt and terminate signals for a graceful exit
5430 * Catch the hangup signal so the errlog can be reopened.
5432 * Ignore the broken pipe signal as connection failures
5433 * are handled when and where they occur without relying
5436 #if !defined(_WIN32)
5439 const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP };
5441 for (idx = 0; idx < SZ(catched_signals); idx++)
5443 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
5444 if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
5446 if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
5447 #endif /* ifdef sun */
5449 log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
5453 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
5455 log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for SIGPIPE: %E");
5459 #else /* ifdef _WIN32 */
5460 # ifdef _WIN_CONSOLE
5462 * We *are* in a windows console app.
5463 * Print a verbose messages about FAQ's and such
5465 printf("%s", win32_blurb);
5466 # endif /* def _WIN_CONSOLE */
5467 #endif /* def _WIN32 */
5470 if (fuzz_input_type != NULL)
5472 exit(process_fuzzed_input(fuzz_input_type, fuzz_input_file));
5474 log_error(LOG_LEVEL_FATAL,
5475 "When compiled with fuzzing support, Privoxy should only be used for fuzzing. "
5476 "Various data structures are static which is unsafe when using threads.");
5481 exit(NULL == load_config());
5484 /* Initialize the CGI subsystem */
5485 cgi_init_error_messages();
5488 * If running on unix and without the --no-daemon
5489 * option, become a daemon. I.e. fork, detach
5490 * from tty and get process group leadership
5499 if (pid < 0) /* error */
5504 else if (pid != 0) /* parent */
5509 * must check for errors
5510 * child died due to missing files aso
5513 wpid = waitpid(pid, &status, WNOHANG);
5525 * stderr (fd 2) will be closed later on,
5526 * when the config file has been parsed.
5532 * Reserve fd 0 and 1 to prevent abort() and friends
5533 * from sending stuff to the clients or servers.
5535 fd = open("/dev/null", O_RDONLY);
5538 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
5542 if (dup2(fd, 0) == -1)
5544 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 0: %E");
5548 fd = open("/dev/null", O_WRONLY);
5551 log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
5555 if (dup2(fd, 1) == -1)
5557 log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 1: %E");
5562 #ifdef FEATURE_EXTERNAL_FILTERS
5563 for (fd = 0; fd < 3; fd++)
5565 mark_socket_for_close_on_execute(fd);
5569 if (chdir("/") != 0)
5571 log_error(LOG_LEVEL_FATAL, "Failed to cd into '/': %E");
5574 } /* -END- if (daemon_mode) */
5577 * As soon as we have written the PID file, we can switch
5578 * to the user and group ID indicated by the --user option
5580 if (pidfile != NULL)
5582 write_pid_file(pidfile);
5586 if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
5588 log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
5592 if (setgroups(1, &grp->gr_gid))
5594 log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
5597 else if (initgroups(pw->pw_name, pw->pw_gid))
5599 log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
5605 log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
5607 /* Read the time zone file from /etc before doing chroot. */
5609 if (NULL != pre_chroot_nslookup_to_load_resolver
5610 && '\0' != pre_chroot_nslookup_to_load_resolver[0])
5612 /* Initialize resolver library. */
5613 (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
5615 if (chroot(pw->pw_dir) < 0)
5617 log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
5621 log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
5624 if (setuid(pw->pw_uid))
5626 log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
5630 char putenv_dummy[64];
5632 strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
5633 if (putenv(putenv_dummy) != 0)
5635 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
5638 snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
5639 if (putenv(putenv_dummy) != 0)
5641 log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
5647 log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
5650 #endif /* defined unix */
5653 /* This will be FALSE unless the command line specified --service
5657 /* Yup, so now we must attempt to establish a connection
5658 * with the service dispatcher. This will only work if this
5659 * process was launched by the service control manager to
5660 * actually run as a service. If this isn't the case, i've
5661 * known it take around 30 seconds or so for the call to return.
5664 /* The StartServiceCtrlDispatcher won't return until the service is stopping */
5665 if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
5667 /* Service has run, and at this point is now being stopped, so just return */
5672 printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
5674 /* An error occurred. Usually it's because --service was wrongly specified
5675 * and we were unable to connect to the Service Control Dispatcher because
5676 * it wasn't expecting us and is therefore not listening.
5678 * For now, just continue below to call the listen_loop function.
5681 #endif /* def _WIN32 */
5691 /*********************************************************************
5693 * Function : bind_port_helper
5695 * Description : Bind the listen port. Handles logging, and aborts
5699 * 1 : haddr = Host address to bind to. Use NULL to bind to
5701 * 2 : hport = Specifies port to bind to.
5702 * 3 : backlog = Listen backlog.
5704 * Returns : Port that was opened.
5706 *********************************************************************/
5707 static jb_socket bind_port_helper(const char *haddr, int hport, int backlog)
5712 result = bind_port(haddr, hport, backlog, &bfd);
5716 const char *bind_address = (NULL != haddr) ? haddr : "INADDR_ANY";
5720 log_error(LOG_LEVEL_FATAL,
5721 "can't bind to %s:%d: There may be another Privoxy "
5722 "or some other proxy running on port %d",
5723 bind_address, hport, hport);
5726 log_error(LOG_LEVEL_FATAL,
5727 "can't bind to %s:%d: The hostname is not resolvable",
5728 bind_address, hport);
5731 log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: %E",
5732 bind_address, hport);
5735 /* shouldn't get here */
5736 return JB_INVALID_SOCKET;
5741 if (bfd >= FD_SETSIZE)
5743 log_error(LOG_LEVEL_FATAL,
5744 "Bind socket number too high to use select(): %d >= %d",
5752 log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
5757 log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
5765 /*********************************************************************
5767 * Function : bind_ports_helper
5769 * Description : Bind the listen ports. Handles logging, and aborts
5773 * 1 : config = Privoxy configuration. Specifies ports
5775 * 2 : sockets = Preallocated array of opened sockets
5776 * corresponding to specification in config.
5777 * All non-opened sockets will be set to
5778 * JB_INVALID_SOCKET.
5780 * Returns : Nothing. Inspect sockets argument.
5782 *********************************************************************/
5783 static void bind_ports_helper(struct configuration_spec * config,
5784 jb_socket sockets[])
5788 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
5790 if (config->hport[i])
5792 sockets[i] = bind_port_helper(config->haddr[i],
5793 config->hport[i], config->listen_backlog);
5794 #if defined(FEATURE_ACCEPT_FILTER) && defined(SO_ACCEPTFILTER)
5795 if (config->enable_accept_filter && sockets[i] != JB_INVALID_SOCKET)
5797 struct accept_filter_arg af_options;
5798 bzero(&af_options, sizeof(af_options));
5799 strlcpy(af_options.af_name, "httpready", sizeof(af_options.af_name));
5800 if (setsockopt(sockets[i], SOL_SOCKET, SO_ACCEPTFILTER, &af_options,
5801 sizeof(af_options)))
5803 log_error(LOG_LEVEL_ERROR,
5804 "Enabling accept filter for socket %d failed: %E", sockets[i]);
5811 sockets[i] = JB_INVALID_SOCKET;
5814 config->need_bind = 0;
5818 /*********************************************************************
5820 * Function : close_ports_helper
5822 * Description : Close listenings ports.
5825 * 1 : sockets = Array of opened and non-opened sockets to
5826 * close. All sockets will be set to
5827 * JB_INVALID_SOCKET.
5829 * Returns : Nothing.
5831 *********************************************************************/
5832 static void close_ports_helper(jb_socket sockets[])
5836 for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
5838 if (JB_INVALID_SOCKET != sockets[i])
5840 close_socket(sockets[i]);
5842 sockets[i] = JB_INVALID_SOCKET;
5848 /* Without this simple workaround we get this compiler warning from _beginthread
5849 * warning C4028: formal parameter 1 different from declaration
5851 void w32_service_listen_loop(void *p)
5855 #endif /* def _WIN32 */
5858 /*********************************************************************
5860 * Function : listen_loop
5862 * Description : bind the listen port and enter a "FOREVER" listening loop.
5868 *********************************************************************/
5869 static void listen_loop(void)
5871 struct client_states *csp_list = NULL;
5872 struct client_state *csp = NULL;
5873 jb_socket bfds[MAX_LISTENING_SOCKETS];
5874 struct configuration_spec *config;
5875 unsigned int active_threads = 0;
5876 #if defined(FEATURE_PTHREAD)
5877 pthread_attr_t attrs;
5879 pthread_attr_init(&attrs);
5880 pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
5883 config = load_config();
5885 #ifdef FEATURE_CONNECTION_SHARING
5887 * XXX: Should be relocated once it no
5888 * longer needs to emit log messages.
5890 initialize_reusable_connections();
5891 #endif /* def FEATURE_CONNECTION_SHARING */
5893 bind_ports_helper(config, bfds);
5895 #ifdef FEATURE_GRACEFUL_TERMINATION
5896 while (!g_terminate)
5901 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__)
5902 while (waitpid(-1, NULL, WNOHANG) > 0)
5904 /* zombie children */
5906 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) */
5909 * Free data that was used by died threads
5911 active_threads = sweep();
5915 * Re-open the errlog after HUP signal
5917 if (received_hup_signal)
5919 if (NULL != config->logfile)
5921 init_error_log(Argv[0], config->logfile);
5923 received_hup_signal = 0;
5927 csp_list = zalloc_or_die(sizeof(*csp_list));
5928 csp = &csp_list->csp;
5930 log_error(LOG_LEVEL_CONNECT,
5931 "Waiting for the next client connection. Currently active threads: %u",
5935 * This config may be outdated, but for accept_connection()
5936 * it's fresh enough.
5938 csp->config = config;
5940 if (!accept_connection(csp, bfds))
5942 log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
5947 csp->flags |= CSP_FLAG_ACTIVE;
5948 csp->server_connection.sfd = JB_INVALID_SOCKET;
5950 csp->config = config = load_config();
5952 if (config->need_bind)
5955 * Since we were listening to the "old port", we will not see
5956 * a "listen" param change until the next request. So, at
5957 * least 1 more request must be made for us to find the new
5958 * setting. I am simply closing the old socket and binding the
5961 * Which-ever is correct, we will serve 1 more page via the
5962 * old settings. This should probably be a "show-status"
5963 * request. This should not be a so common of an operation
5964 * that this will hurt people's feelings.
5967 close_ports_helper(bfds);
5969 bind_ports_helper(config, bfds);
5972 #ifdef FEATURE_TOGGLE
5973 if (global_toggle_state)
5974 #endif /* def FEATURE_TOGGLE */
5976 csp->flags |= CSP_FLAG_TOGGLED_ON;
5979 if (run_loader(csp))
5981 log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
5982 /* Never get here - LOG_LEVEL_FATAL causes program exit */
5986 if (block_acl(NULL,csp))
5988 log_error(LOG_LEVEL_CONNECT,
5989 "Connection from %s on %s (socket %d) dropped due to ACL",
5990 csp->ip_addr_str, csp->listen_addr_str, csp->cfd);
5991 close_socket(csp->cfd);
5992 freez(csp->ip_addr_str);
5993 freez(csp->listen_addr_str);
5997 #endif /* def FEATURE_ACL */
5999 if ((0 != config->max_client_connections)
6000 && (active_threads >= config->max_client_connections))
6002 log_error(LOG_LEVEL_CONNECT,
6003 "Rejecting connection from %s. Maximum number of connections reached.",
6005 write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
6006 strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
6007 close_socket(csp->cfd);
6008 freez(csp->ip_addr_str);
6009 freez(csp->listen_addr_str);
6014 /* add it to the list of clients */
6015 csp_list->next = clients->next;
6016 clients->next = csp_list;
6018 if (config->multi_threaded)
6022 /* this is a switch () statement in the C preprocessor - ugh */
6023 #undef SELECTED_ONE_OPTION
6025 /* Use Pthreads in preference to native code */
6026 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
6027 #define SELECTED_ONE_OPTION
6029 pthread_t the_thread;
6032 ret = pthread_create(&the_thread, &attrs,
6033 (void * (*)(void *))serve, csp);
6034 child_id = ret ? -1 : 0;
6038 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
6039 #define SELECTED_ONE_OPTION
6040 child_id = _beginthread(
6041 (void (*)(void *))serve,
6046 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
6047 #define SELECTED_ONE_OPTION
6049 thread_id tid = spawn_thread
6050 (server_thread, "server", B_NORMAL_PRIORITY, csp);
6052 if ((tid >= 0) && (resume_thread(tid) == B_OK))
6054 child_id = (int) tid;
6063 #if !defined(SELECTED_ONE_OPTION)
6066 /* This block is only needed when using fork().
6067 * When using threads, the server thread was
6068 * created and run by the call to _beginthread().
6070 if (child_id == 0) /* child */
6073 #ifdef FEATURE_TOGGLE
6074 int inherited_toggle_state = global_toggle_state;
6075 #endif /* def FEATURE_TOGGLE */
6080 * If we've been toggled or we've blocked the request, tell Mom
6083 #ifdef FEATURE_TOGGLE
6084 if (inherited_toggle_state != global_toggle_state)
6086 rc |= RC_FLAG_TOGGLED;
6088 #endif /* def FEATURE_TOGGLE */
6090 #ifdef FEATURE_STATISTICS
6091 if (csp->flags & CSP_FLAG_REJECTED)
6093 rc |= RC_FLAG_BLOCKED;
6095 #endif /* ndef FEATURE_STATISTICS */
6099 else if (child_id > 0) /* parent */
6101 /* in a fork()'d environment, the parent's
6102 * copy of the client socket and the CSP
6106 #if !defined(_WIN32) && !defined(__CYGWIN__)
6108 wait(&child_status);
6111 * Evaluate child's return code: If the child has
6112 * - been toggled, toggle ourselves
6113 * - blocked its request, bump up the stats counter
6116 #ifdef FEATURE_TOGGLE
6117 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
6119 global_toggle_state = !global_toggle_state;
6121 #endif /* def FEATURE_TOGGLE */
6123 #ifdef FEATURE_STATISTICS
6125 if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
6129 #endif /* def FEATURE_STATISTICS */
6131 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
6132 close_socket(csp->cfd);
6133 csp->flags &= ~CSP_FLAG_ACTIVE;
6137 #undef SELECTED_ONE_OPTION
6138 /* end of cpp switch () */
6143 * Spawning the child failed, assume it's because
6144 * there are too many children running already.
6145 * XXX: If you assume ...
6147 log_error(LOG_LEVEL_ERROR,
6148 "Unable to take any additional connections: %E. Active threads: %u",
6150 write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
6151 strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
6152 close_socket(csp->cfd);
6153 csp->flags &= ~CSP_FLAG_ACTIVE;
6162 #if defined(FEATURE_PTHREAD)
6163 pthread_attr_destroy(&attrs);
6166 /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
6168 #ifdef FEATURE_HTTPS_INSPECTION
6169 /* Clean up. Aim: free all memory (no leaks) */
6173 #ifdef FEATURE_GRACEFUL_TERMINATION
6175 log_error(LOG_LEVEL_INFO, "Graceful termination requested");
6177 unload_current_config_file();
6178 unload_current_actions_file();
6179 unload_current_re_filterfile();
6180 #ifdef FEATURE_TRUST
6181 unload_current_trust_file();
6184 if (config->multi_threaded)
6191 } while ((clients->next != NULL) && (--i > 0));
6195 log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
6205 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
6206 /* Cleanup - remove taskbar icon etc. */
6211 #endif /* FEATURE_GRACEFUL_TERMINATION */