filter_header(): Break a couple of long lines
[privoxy.git] / jcc.c
1 /*********************************************************************
2  *
3  * File        :  $Source: /cvsroot/ijbswa/current/jcc.c,v $
4  *
5  * Purpose     :  Main file.  Contains main() method, main loop, and
6  *                the main connection-handling function.
7  *
8  * Copyright   :  Written by and Copyright (C) 2001-2021 the
9  *                Privoxy team. https://www.privoxy.org/
10  *
11  *                Based on the Internet Junkbuster originally written
12  *                by and Copyright (C) 1997 Anonymous Coders and
13  *                Junkbusters Corporation.  http://www.junkbusters.com
14  *
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.
20  *
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.
26  *
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.
32  *
33  *********************************************************************/
34
35
36 #include "config.h"
37
38 #include <stdio.h>
39 #include <sys/types.h>
40 #include <stdlib.h>
41 #include <string.h>
42 #include <signal.h>
43 #include <fcntl.h>
44 #include <errno.h>
45 #include <assert.h>
46
47 #ifdef _WIN32
48 # ifndef FEATURE_PTHREAD
49 #  ifndef STRICT
50 #   define STRICT
51 #  endif
52 #  include <winsock2.h>
53 #  include <windows.h>
54 #  include <process.h>
55 # endif /* ndef FEATURE_PTHREAD */
56
57 # include "win32.h"
58 # ifndef _WIN_CONSOLE
59 #  include "w32log.h"
60 # endif /* ndef _WIN_CONSOLE */
61 # include "w32svrapi.h"
62
63 #else /* ifndef _WIN32 */
64
65 # include <unistd.h>
66 # include <sys/wait.h>
67 # include <sys/time.h>
68 # include <sys/stat.h>
69 # include <sys/ioctl.h>
70
71 #ifdef sun
72 #include <sys/termios.h>
73 #endif /* sun */
74
75 #ifdef unix
76 #include <pwd.h>
77 #include <grp.h>
78 #endif
79
80 # include <signal.h>
81
82 # ifdef __BEOS__
83 #  include <socket.h>  /* BeOS has select() for sockets only. */
84 #  include <OS.h>      /* declarations for threads and stuff. */
85 # endif
86
87 #ifdef HAVE_POLL
88 #ifdef __GLIBC__
89 #include <sys/poll.h>
90 #else
91 #include <poll.h>
92 #endif /* def __GLIBC__ */
93 #else
94 # ifndef FD_ZERO
95 #  include <select.h>
96 # endif
97 #warning poll() appears to be unavailable. Your platform will become unsupported in the future.
98 #endif /* HAVE_POLL */
99
100 #endif
101
102 #include "project.h"
103 #include "list.h"
104 #include "jcc.h"
105 #ifdef FEATURE_HTTPS_INSPECTION
106 #include "ssl.h"
107 #endif
108 #include "filters.h"
109 #include "loaders.h"
110 #include "parsers.h"
111 #include "miscutil.h"
112 #include "errlog.h"
113 #include "jbsockets.h"
114 #include "gateway.h"
115 #include "actions.h"
116 #include "cgi.h"
117 #include "loadcfg.h"
118 #include "urlmatch.h"
119 #ifdef FEATURE_CLIENT_TAGS
120 #include "client-tags.h"
121 #endif
122
123 int daemon_mode = 1;
124 struct client_states clients[1];
125 struct file_list     files[1];
126
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 */
131
132 #ifdef FEATURE_GRACEFUL_TERMINATION
133 int g_terminate = 0;
134 #endif
135
136 #if !defined(_WIN32)
137 static void sig_handler(int the_signal);
138 #endif
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);
154 #endif
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);
161
162 #ifdef __BEOS__
163 static int32 server_thread(void *data);
164 #endif /* def __BEOS__ */
165
166 #ifdef _WIN32
167 #define sleep(N)  Sleep(((N) * 1000))
168 #endif
169
170 #ifdef FUZZ
171 int process_fuzzed_input(char *fuzz_input_type, char *fuzz_input_file);
172 void show_fuzz_usage(const char *name);
173 #endif
174
175 #ifdef MUTEX_LOCKS_AVAILABLE
176 /*
177  * XXX: Does the locking stuff really belong in this file?
178  */
179 privoxy_mutex_t log_mutex;
180 privoxy_mutex_t log_init_mutex;
181 privoxy_mutex_t connection_reuse_mutex;
182
183 #ifdef FEATURE_HTTPS_INSPECTION
184 privoxy_mutex_t certificate_mutex;
185 privoxy_mutex_t ssl_init_mutex;
186 #endif
187
188 #ifdef FEATURE_EXTERNAL_FILTERS
189 privoxy_mutex_t external_filter_mutex;
190 #endif
191 #ifdef FEATURE_CLIENT_TAGS
192 privoxy_mutex_t client_tags_mutex;
193 #endif
194 #ifdef FEATURE_EXTENDED_STATISTICS
195 privoxy_mutex_t filter_statistics_mutex;
196 privoxy_mutex_t block_statistics_mutex;
197 #endif
198
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) */
202
203 #ifndef HAVE_GMTIME_R
204 privoxy_mutex_t gmtime_mutex;
205 #endif /* ndef HAVE_GMTIME_R */
206
207 #ifndef HAVE_LOCALTIME_R
208 privoxy_mutex_t localtime_mutex;
209 #endif /* ndef HAVE_GMTIME_R */
210
211 #if !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM)
212 privoxy_mutex_t rand_mutex;
213 #endif /* !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM) */
214
215 #endif /* def MUTEX_LOCKS_AVAILABLE */
216
217 #if defined(unix)
218 const char *basedir = NULL;
219 const char *pidfile = NULL;
220 static int received_hup_signal = 0;
221 #endif /* defined unix */
222
223 /* HTTP snipplets. */
224 static const char CSUCCEED[] =
225    "HTTP/1.1 200 Connection established\r\n\r\n";
226
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";
232
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";
238
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";
244
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";
251
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";
258
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";
265
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";
271
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";
277
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";
283
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";
289
290 /* A function to crunch a response */
291 typedef struct http_response *(*crunch_func_ptr)(struct client_state *);
292
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
299
300 /* A crunch function and its flags */
301 struct cruncher
302 {
303    const crunch_func_ptr cruncher;
304    const int flags;
305 };
306
307 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[]);
308
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 },
313 #ifdef FEATURE_TRUST
314    { trust_url,       CF_COUNT_AS_REJECT },
315 #endif /* def FEATURE_TRUST */
316    { redirect_url,    CF_NO_FLAGS  },
317    { dispatch_cgi,    CF_IGNORE_FORCE},
318    { NULL,            0 }
319 };
320
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 },
325    { NULL,            0 }
326 };
327
328
329 /*
330  * XXX: Don't we really mean
331  *
332  * #if defined(unix)
333  *
334  * here?
335  */
336 #if !defined(_WIN32)
337 /*********************************************************************
338  *
339  * Function    :  sig_handler
340  *
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.
345  *
346  * Parameters  :
347  *          1  :  the_signal = the signal cause this function to call
348  *
349  * Returns     :  -
350  *
351  *********************************************************************/
352 static void sig_handler(int the_signal)
353 {
354    switch(the_signal)
355    {
356       case SIGTERM:
357       case SIGINT:
358          log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
359 #if defined(unix)
360          if (pidfile)
361          {
362             unlink(pidfile);
363          }
364 #endif /* unix */
365          exit(the_signal);
366          break;
367
368       case SIGHUP:
369 #if defined(unix)
370          received_hup_signal = 1;
371 #endif
372          break;
373
374       default:
375          /*
376           * We shouldn't be here, unless we catch signals
377           * in main() that we can't handle here!
378           */
379          log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
380    }
381    return;
382
383 }
384 #endif
385
386
387 /*********************************************************************
388  *
389  * Function    :  get_write_delay
390  *
391  * Description :  Parse the delay-response parameter.
392  *
393  * Parameters  :
394  *          1  :  csp = Current client state (buffers, headers, etc...)
395  *
396  * Returns     :  Number of milliseconds to delay writes.
397  *
398  *********************************************************************/
399 static unsigned int get_write_delay(const struct client_state *csp)
400 {
401    unsigned int delay;
402    char *endptr;
403    char *newval;
404
405    if ((csp->action->flags & ACTION_DELAY_RESPONSE) == 0)
406    {
407       return 0;
408    }
409    newval = csp->action->string[ACTION_STRING_DELAY_RESPONSE];
410
411    delay = (unsigned)strtol(newval, &endptr, 0);
412    if (*endptr != '\0')
413    {
414       log_error(LOG_LEVEL_FATAL,
415          "Invalid delay-response{} parameter: '%s'", newval);
416    }
417
418    return delay;
419
420 }
421
422
423 /*********************************************************************
424  *
425  * Function    :  client_protocol_is_unsupported
426  *
427  * Description :  Checks if the client used a known unsupported
428  *                protocol and deals with it by sending an error
429  *                response.
430  *
431  * Parameters  :
432  *          1  :  csp = Current client state (buffers, headers, etc...)
433  *          2  :  req = the first request line send by the client
434  *
435  * Returns     :  TRUE if an error response has been generated, or
436  *                FALSE if the request doesn't look invalid.
437  *
438  *********************************************************************/
439 static int client_protocol_is_unsupported(struct client_state *csp, char *req)
440 {
441    /*
442     * If it's a FTP or gopher request, we don't support it.
443     *
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.
447     *
448     * They should, however, never cause more problems than
449     * Privoxy's old behaviour (returning the misleading HTML
450     * error message:
451     *
452     * "Could not resolve http://(ftp|gopher)://example.org").
453     */
454    if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
455    {
456       const char *response = NULL;
457       const char *protocol = NULL;
458
459       if (!strncmpic(req, "GET ftp://", 10))
460       {
461          response = FTP_RESPONSE;
462          protocol = "FTP";
463       }
464       else
465       {
466          response = GOPHER_RESPONSE;
467          protocol = "GOPHER";
468       }
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);
474       freez(req);
475
476 #ifdef FEATURE_HTTPS_INSPECTION
477       if (client_use_ssl(csp))
478       {
479          ssl_send_data_delayed(&(csp->ssl_client_attr),
480             (const unsigned char *)response, strlen(response),
481             get_write_delay(csp));
482       }
483       else
484 #endif
485       {
486          write_socket_delayed(csp->cfd, response, strlen(response),
487             get_write_delay(csp));
488       }
489
490       return TRUE;
491    }
492
493    return FALSE;
494 }
495
496
497 /*********************************************************************
498  *
499  * Function    :  client_has_unsupported_expectations
500  *
501  * Description :  Checks if the client used an unsupported expectation
502  *                in which case an error message is delivered.
503  *
504  * Parameters  :
505  *          1  :  csp = Current client state (buffers, headers, etc...)
506  *
507  * Returns     :  TRUE if an error response has been generated, or
508  *                FALSE if the request doesn't look invalid.
509  *
510  *********************************************************************/
511 static int client_has_unsupported_expectations(const struct client_state *csp)
512 {
513    if ((csp->flags & CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION))
514    {
515       log_error(LOG_LEVEL_ERROR,
516          "Rejecting request from client %s with unsupported Expect header value",
517          csp->ip_addr_str);
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));
524
525       return TRUE;
526    }
527
528    return FALSE;
529
530 }
531
532
533 /*********************************************************************
534  *
535  * Function    :  get_request_destination_elsewhere
536  *
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.
540  *
541  *                This function tries to get it elsewhere,
542  *                provided accept-intercepted-requests is enabled.
543  *
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.
547  *
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.
551  *
552  * Parameters  :
553  *          1  :  csp = Current client state (buffers, headers, etc...)
554  *          2  :  headers = a header list
555  *
556  * Returns     :  JB_ERR_OK if the destination is now known, or
557  *                JB_ERR_PARSE if it isn't.
558  *
559  *********************************************************************/
560 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
561 {
562    if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
563    {
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);
570
571       write_socket_delayed(csp->cfd, CHEADER, strlen(CHEADER),
572          get_write_delay(csp));
573       destroy_list(headers);
574
575       return JB_ERR_PARSE;
576    }
577    else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
578    {
579       /* Split the domain we just got for pattern matching */
580       init_domain_components(csp->http);
581
582       return JB_ERR_OK;
583    }
584    else
585    {
586       /* We can't work without destination. Go spread the news.*/
587
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);
594
595       write_socket_delayed(csp->cfd, MISSING_DESTINATION_RESPONSE,
596          strlen(MISSING_DESTINATION_RESPONSE), get_write_delay(csp));
597       destroy_list(headers);
598
599       return JB_ERR_PARSE;
600    }
601    /*
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.
605     */
606 }
607
608
609 /*********************************************************************
610  *
611  * Function    :  get_server_headers
612  *
613  * Description :  Parses server headers in iob and fills them
614  *                into csp->headers so that they can later be
615  *                handled by sed().
616  *
617  * Parameters  :
618  *          1  :  csp = Current client state (buffers, headers, etc...)
619  *
620  * Returns     :  JB_ERR_OK if everything went fine, or
621  *                JB_ERR_PARSE if the headers were incomplete.
622  *
623  *********************************************************************/
624 static jb_err get_server_headers(struct client_state *csp)
625 {
626    int continue_hack_in_da_house = 0;
627    char * header;
628
629    while (((header = get_header(csp->iob)) != NULL) || continue_hack_in_da_house)
630    {
631       if (header == NULL)
632       {
633          /*
634           * continue hack in da house. Ignore the ending of
635           * this head and continue enlisting header lines.
636           * The reason is described below.
637           */
638          enlist(csp->headers, "");
639          continue_hack_in_da_house = 0;
640          continue;
641       }
642       else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
643       {
644          /*
645           * It's a bodyless continue response, don't
646           * stop header parsing after reaching its end.
647           *
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.
651           *
652           * The client will separate them because of the
653           * empty line between them.
654           *
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.
659           *
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)
663           */
664          log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
665          continue_hack_in_da_house = 1;
666       }
667       else if (*header == '\0')
668       {
669          /*
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
673           * head.
674           *
675           * Inform the caller an let it decide how to handle it.
676           */
677          return JB_ERR_PARSE;
678       }
679
680       if (JB_ERR_MEMORY == enlist(csp->headers, header))
681       {
682          /*
683           * XXX: Should we quit the request and return a
684           * out of memory error page instead?
685           */
686          log_error(LOG_LEVEL_ERROR,
687             "Out of memory while enlisting server headers. %s lost.",
688             header);
689       }
690       freez(header);
691    }
692
693    return JB_ERR_OK;
694 }
695
696
697 /*********************************************************************
698  *
699  * Function    :  crunch_reason
700  *
701  * Description :  Translates the crunch reason code into a string.
702  *
703  * Parameters  :
704  *          1  :  rsp = a http_response
705  *
706  * Returns     :  A string with the crunch reason or an error description.
707  *
708  *********************************************************************/
709 static const char *crunch_reason(const struct http_response *rsp)
710 {
711    char * reason = NULL;
712
713    assert(rsp != NULL);
714    if (rsp == NULL)
715    {
716       return "Internal error while searching for crunch reason";
717    }
718
719    switch (rsp->crunch_reason)
720    {
721       case UNSUPPORTED:
722          reason = "Unsupported HTTP feature";
723          break;
724       case BLOCKED:
725          reason = "Blocked";
726          break;
727       case UNTRUSTED:
728          reason = "Untrusted";
729          break;
730       case REDIRECTED:
731          reason = "Redirected";
732          break;
733       case CGI_CALL:
734          reason = "CGI Call";
735          break;
736       case NO_SUCH_DOMAIN:
737          reason = "DNS failure";
738          break;
739       case FORWARDING_FAILED:
740          reason = "Forwarding failed";
741          break;
742       case CONNECT_FAILED:
743          reason = "Connection failure";
744          break;
745       case OUT_OF_MEMORY:
746          reason = "Out of memory (may mask other reasons)";
747          break;
748       case CONNECTION_TIMEOUT:
749          reason = "Connection timeout";
750          break;
751       case NO_SERVER_DATA:
752          reason = "No server data received";
753          break;
754       default:
755          reason = "No reason recorded";
756          break;
757    }
758
759    return reason;
760 }
761
762
763 /*********************************************************************
764  *
765  * Function    :  log_applied_actions
766  *
767  * Description :  Logs the applied actions if LOG_LEVEL_ACTIONS is
768  *                enabled.
769  *
770  * Parameters  :
771  *          1  :  actions = Current action spec to log
772  *
773  * Returns     :  Nothing.
774  *
775  *********************************************************************/
776 static void log_applied_actions(const struct current_action_spec *actions)
777 {
778    /*
779     * The conversion to text requires lots of memory allocations so
780     * we only do the conversion if the user is actually interested.
781     */
782    if (debug_level_is_enabled(LOG_LEVEL_ACTIONS))
783    {
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);
787    }
788 }
789
790
791 /*********************************************************************
792  *
793  * Function    :  send_crunch_response
794  *
795  * Description :  Delivers already prepared response for
796  *                intercepted requests, logs the interception
797  *                and frees the response.
798  *
799  * Parameters  :
800  *          1  :  csp = Current client state (buffers, headers, etc...)
801  *          2  :  rsp = Fully prepared response. Will be freed on exit.
802  *
803  * Returns     :  Nothing.
804  *
805  *********************************************************************/
806 static void send_crunch_response(struct client_state *csp, struct http_response *rsp)
807 {
808       const struct http_request *http = csp->http;
809       char status_code[4];
810
811       assert(rsp != NULL);
812       assert(rsp->head != NULL);
813
814       if (rsp == NULL)
815       {
816          log_error(LOG_LEVEL_FATAL, "NULL response in send_crunch_response.");
817       }
818
819       /*
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.
824        *
825        * A head starts like this: 'HTTP/1.1 200...'
826        *                           0123456789|11
827        *                                     10
828        */
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';
833
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))
838       {
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);
844       }
845       else
846 #endif
847       {
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);
851       }
852       /* Write the answer to the client */
853 #ifdef FEATURE_HTTPS_INSPECTION
854       if (client_use_ssl(csp))
855       {
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))
862          {
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);
867          }
868       }
869       else
870 #endif
871       {
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)))
876          {
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);
881          }
882       }
883
884       /* Clean up and return */
885       if (cgi_error_memory() != rsp)
886       {
887          free_http_response(rsp);
888       }
889       return;
890 }
891
892
893 /*********************************************************************
894  *
895  * Function    :  crunch_response_triggered
896  *
897  * Description :  Checks if the request has to be crunched,
898  *                and delivers the crunch response if necessary.
899  *
900  * Parameters  :
901  *          1  :  csp = Current client state (buffers, headers, etc...)
902  *          2  :  crunchers = list of cruncher functions to run
903  *
904  * Returns     :  TRUE if the request was answered with a crunch response
905  *                FALSE otherwise.
906  *
907  *********************************************************************/
908 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[])
909 {
910    struct http_response *rsp = NULL;
911    const struct cruncher *c;
912
913    /*
914     * If CGI request crunching is disabled,
915     * check the CGI dispatcher out of order to
916     * prevent unintentional blocks or redirects.
917     */
918    if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_CRUNCHING)
919        && (NULL != (rsp = dispatch_cgi(csp))))
920    {
921       /* Deliver, log and free the interception response. */
922       send_crunch_response(csp, rsp);
923       csp->flags |= CSP_FLAG_CRUNCHED;
924       return TRUE;
925    }
926
927    for (c = crunchers; c->cruncher != NULL; c++)
928    {
929       /*
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.
933        */
934       if (((csp->flags & CSP_FLAG_TOGGLED_ON) &&
935           !(csp->flags & CSP_FLAG_FORCED)) ||
936           (c->flags & CF_IGNORE_FORCE))
937       {
938          rsp = c->cruncher(csp);
939          if (NULL != rsp)
940          {
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)
946             {
947                csp->flags |= CSP_FLAG_REJECTED;
948             }
949 #endif /* def FEATURE_STATISTICS */
950
951             return TRUE;
952          }
953       }
954    }
955
956    return FALSE;
957 }
958
959
960 /*********************************************************************
961  *
962  * Function    :  build_request_line
963  *
964  * Description :  Builds the HTTP request line.
965  *
966  *                If a HTTP forwarder is used it expects the whole URL,
967  *                web servers only get the path.
968  *
969  * Parameters  :
970  *          1  :  csp = Current client state (buffers, headers, etc...)
971  *          2  :  fwd = The forwarding spec used for the request.
972  *                      Can be NULL.
973  *          3  :  request_line = The old request line which will be replaced.
974  *
975  * Returns     :  Nothing. Terminates in case of memory problems.
976  *
977  *********************************************************************/
978 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line)
979 {
980    struct http_request *http = csp->http;
981
982    /*
983     * Downgrade http version from 1.1 to 1.0
984     * if +downgrade action applies.
985     */
986    if ((csp->action->flags & ACTION_DOWNGRADE)
987      && (!strcmpic(http->version, "HTTP/1.1")))
988    {
989       freez(http->version);
990       http->version = strdup_or_die("HTTP/1.0");
991    }
992
993    /*
994     * Rebuild the request line.
995     */
996    freez(*request_line);
997    *request_line = strdup(http->gpc);
998    string_append(request_line, " ");
999
1000    if (fwd != NULL && fwd->forward_host && fwd->type != FORWARD_WEBSERVER)
1001    {
1002       string_append(request_line, http->url);
1003    }
1004    else
1005    {
1006       string_append(request_line, http->path);
1007    }
1008    string_append(request_line, " ");
1009    string_append(request_line, http->version);
1010
1011    if (*request_line == NULL)
1012    {
1013       log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
1014    }
1015    log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", *request_line);
1016 }
1017
1018
1019 /*********************************************************************
1020  *
1021  * Function    :  change_request_destination
1022  *
1023  * Description :  Parse a (rewritten) request line and regenerate
1024  *                the http request data.
1025  *
1026  * Parameters  :
1027  *          1  :  csp = Current client state (buffers, headers, etc...)
1028  *
1029  * Returns     :  Forwards the parse_http_request() return code.
1030  *                Terminates in case of memory problems.
1031  *
1032  *********************************************************************/
1033 static jb_err change_request_destination(struct client_state *csp)
1034 {
1035    struct http_request *http = csp->http;
1036    jb_err err;
1037
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)
1043    {
1044       log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
1045          jb_err_to_string(err));
1046    }
1047    if (http->ssl && strcmpic(csp->http->gpc, "CONNECT"))
1048    {
1049       /*
1050        * A client header filter changed the request URL from
1051        * http:// to https:// which we currently don't support.
1052        */
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;
1056    }
1057
1058    return err;
1059 }
1060
1061
1062 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1063 /*********************************************************************
1064  *
1065  * Function    :  server_response_is_complete
1066  *
1067  * Description :  Determines whether we should stop reading
1068  *                from the server socket.
1069  *
1070  * Parameters  :
1071  *          1  :  csp = Current client state (buffers, headers, etc...)
1072  *          2  :  content_length = Length of content received so far.
1073  *
1074  * Returns     :  TRUE if the response is complete,
1075  *                FALSE otherwise.
1076  *
1077  *********************************************************************/
1078 static int server_response_is_complete(struct client_state *csp,
1079    unsigned long long content_length)
1080 {
1081    int content_length_known = !!(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET);
1082
1083    if (!strcmpic(csp->http->gpc, "HEAD"))
1084    {
1085       /*
1086        * "HEAD" implies no body, we are thus expecting
1087        * no content. XXX: incomplete "list" of methods?
1088        */
1089       csp->expected_content_length = 0;
1090       content_length_known = TRUE;
1091       csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1092    }
1093
1094    if (csp->http->status == 204 || csp->http->status == 304)
1095    {
1096       /*
1097        * Expect no body. XXX: incomplete "list" of status codes?
1098        */
1099       csp->expected_content_length = 0;
1100       content_length_known = TRUE;
1101       csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1102    }
1103
1104    return (content_length_known && ((0 == csp->expected_content_length)
1105             || (csp->expected_content_length <= content_length)));
1106 }
1107
1108
1109 #ifdef FEATURE_CONNECTION_SHARING
1110 /*********************************************************************
1111  *
1112  * Function    :  wait_for_alive_connections
1113  *
1114  * Description :  Waits for alive connections to timeout.
1115  *
1116  * Parameters  :  N/A
1117  *
1118  * Returns     :  N/A
1119  *
1120  *********************************************************************/
1121 static void wait_for_alive_connections(void)
1122 {
1123    int connections_alive = close_unusable_connections();
1124
1125    while (0 < connections_alive)
1126    {
1127       log_error(LOG_LEVEL_CONNECT,
1128          "Waiting for %d connections to timeout.",
1129          connections_alive);
1130       sleep(60);
1131       connections_alive = close_unusable_connections();
1132    }
1133
1134    log_error(LOG_LEVEL_CONNECT, "No connections to wait for left.");
1135
1136 }
1137 #endif /* def FEATURE_CONNECTION_SHARING */
1138
1139
1140 /*********************************************************************
1141  *
1142  * Function    :  save_connection_destination
1143  *
1144  * Description :  Remembers a connection for reuse later on.
1145  *
1146  * Parameters  :
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.
1151  *
1152  * Returns     : void
1153  *
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)
1159 {
1160    assert(sfd != JB_INVALID_SOCKET);
1161    assert(NULL != http->host);
1162
1163    server_connection->sfd = sfd;
1164    server_connection->host = strdup_or_die(http->host);
1165    server_connection->port = http->port;
1166
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);
1173
1174    server_connection->forwarder_type = fwd->type;
1175    if (NULL != fwd->gateway_host)
1176    {
1177       server_connection->gateway_host = strdup_or_die(fwd->gateway_host);
1178    }
1179    else
1180    {
1181       server_connection->gateway_host = NULL;
1182    }
1183    server_connection->gateway_port = fwd->gateway_port;
1184    if (NULL != fwd->auth_username)
1185    {
1186       server_connection->auth_username = strdup_or_die(fwd->auth_username);
1187    }
1188    else
1189    {
1190       server_connection->auth_username = NULL;
1191    }
1192    if (NULL != fwd->auth_password)
1193    {
1194       server_connection->auth_password = strdup_or_die(fwd->auth_password);
1195    }
1196    else
1197    {
1198       server_connection->auth_password = NULL;
1199    }
1200
1201    if (NULL != fwd->forward_host)
1202    {
1203       server_connection->forward_host = strdup_or_die(fwd->forward_host);
1204    }
1205    else
1206    {
1207       server_connection->forward_host = NULL;
1208    }
1209    server_connection->forward_port = fwd->forward_port;
1210 }
1211 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1212
1213
1214 /*********************************************************************
1215  *
1216  * Function    : verify_request_length
1217  *
1218  * Description : Checks if we already got the whole client requests
1219  *               and sets CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ if
1220  *               we do.
1221  *
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.
1226  *
1227  * Parameters  :
1228  *          1  :  csp = Current client state (buffers, headers, etc...)
1229  *
1230  * Returns     :  void
1231  *
1232  *********************************************************************/
1233 static void verify_request_length(struct client_state *csp)
1234 {
1235    unsigned long long buffered_request_bytes =
1236       (unsigned long long)(csp->client_iob->eod - csp->client_iob->cur);
1237
1238    if ((csp->expected_client_content_length != 0)
1239       && (buffered_request_bytes != 0))
1240    {
1241       if (csp->expected_client_content_length >= buffered_request_bytes)
1242       {
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);
1247       }
1248       else
1249       {
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;
1257       }
1258
1259       if (csp->expected_client_content_length == 0)
1260       {
1261          csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1262       }
1263    }
1264
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)))
1268    {
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"))
1274       {
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.");
1278       }
1279       else
1280       {
1281          csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1282
1283          if ((csp->config->feature_flags & RUNTIME_FEATURE_TOLERATE_PIPELINING) == 0)
1284          {
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);
1291          }
1292          else
1293          {
1294             /*
1295              * Keep the pipelined data around for now, we'll deal with
1296              * it once we're done serving the current request.
1297              */
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));
1303          }
1304       }
1305    }
1306    else
1307    {
1308       csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1309       log_error(LOG_LEVEL_CONNECT, "Complete client request received.");
1310    }
1311 }
1312
1313
1314 /*********************************************************************
1315  *
1316  * Function    :  mark_server_socket_tainted
1317  *
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).
1321  *
1322  * Parameters  :
1323  *          1  :  csp = Current client state (buffers, headers, etc...)
1324  *
1325  * Returns     :  void.
1326  *
1327  *********************************************************************/
1328 static void mark_server_socket_tainted(struct client_state *csp)
1329 {
1330    /*
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.
1335     */
1336    if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
1337       && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED))
1338    {
1339       log_error(LOG_LEVEL_CONNECT,
1340          "Marking the server socket %d tainted.",
1341          csp->server_connection.sfd);
1342    }
1343    csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1344 }
1345
1346 /*********************************************************************
1347  *
1348  * Function    :  get_request_line
1349  *
1350  * Description : Read the client request line.
1351  *
1352  * Parameters  :
1353  *          1  :  csp = Current client state (buffers, headers, etc...)
1354  *
1355  * Returns     :  Pointer to request line or NULL in case of errors.
1356  *
1357  *********************************************************************/
1358 static char *get_request_line(struct client_state *csp)
1359 {
1360    char buf[BUFFER_SIZE];
1361    char *request_line = NULL;
1362    int len;
1363
1364    memset(buf, 0, sizeof(buf));
1365
1366    if ((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
1367    {
1368       /*
1369        * If there are multiple pipelined requests waiting,
1370        * the flag will be set again once the next request
1371        * has been parsed.
1372        */
1373       csp->flags &= ~CSP_FLAG_PIPELINED_REQUEST_WAITING;
1374
1375       request_line = get_header(csp->client_iob);
1376       if ((NULL != request_line) && ('\0' != *request_line))
1377       {
1378          return request_line;
1379       }
1380       else
1381       {
1382          log_error(LOG_LEVEL_CONNECT, "No complete request line "
1383             "received yet. Continuing reading from %d.", csp->cfd);
1384       }
1385    }
1386
1387    do
1388    {
1389       if (
1390 #ifdef FUZZ
1391           0 == (csp->flags & CSP_FLAG_FUZZED_INPUT) &&
1392 #endif
1393           !data_is_available(csp->cfd, csp->config->socket_timeout)
1394           )
1395       {
1396          if (socket_is_still_alive(csp->cfd))
1397          {
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));
1404          }
1405          else
1406          {
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);
1410          }
1411          return NULL;
1412       }
1413
1414       len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1415
1416       if (len <= 0) return NULL;
1417
1418       /*
1419        * If there is no memory left for buffering the
1420        * request, there is nothing we can do but hang up
1421        */
1422       if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1423       {
1424          return NULL;
1425       }
1426
1427       request_line = get_header(csp->client_iob);
1428
1429    } while ((NULL != request_line) && ('\0' == *request_line));
1430
1431    return request_line;
1432
1433 }
1434
1435 enum chunk_status
1436 {
1437    CHUNK_STATUS_MISSING_DATA,
1438    CHUNK_STATUS_BODY_COMPLETE,
1439    CHUNK_STATUS_PARSE_ERROR
1440 };
1441
1442
1443 /*********************************************************************
1444  *
1445  * Function    :  chunked_body_is_complete
1446  *
1447  * Description :  Figures out whether or not a chunked body is complete.
1448  *
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.
1453  *
1454  *                Should be modified to work with a common buffer,
1455  *                and allow the caller to skip already parsed chunks.
1456  *
1457  *                This would allow the function to be used for unbuffered
1458  *                response bodies as well.
1459  *
1460  * Parameters  :
1461  *          1  :  iob = Buffer with the body to check.
1462  *          2  :  length = Length of complete body
1463  *
1464  * Returns     :  Enum with the result of the check.
1465  *
1466  *********************************************************************/
1467 static enum chunk_status chunked_body_is_complete(struct iob *iob, size_t *length)
1468 {
1469    unsigned int chunksize;
1470    char *p = iob->cur;
1471
1472    do
1473    {
1474       /*
1475        * We need at least a single digit, followed by "\r\n",
1476        * followed by an unknown amount of data, followed by "\r\n".
1477        */
1478       if (p + 5 > iob->eod)
1479       {
1480          return CHUNK_STATUS_MISSING_DATA;
1481       }
1482       if (sscanf(p, "%x", &chunksize) != 1)
1483       {
1484          return CHUNK_STATUS_PARSE_ERROR;
1485       }
1486
1487       /*
1488        * We want at least a single digit, followed by "\r\n",
1489        * followed by the specified amount of data, followed by "\r\n".
1490        */
1491       if (p + chunksize + 5 > iob->eod)
1492       {
1493          return CHUNK_STATUS_MISSING_DATA;
1494       }
1495
1496       /* Skip chunk-size. */
1497       p = strstr(p, "\r\n");
1498       if (NULL == p)
1499       {
1500          return CHUNK_STATUS_PARSE_ERROR;
1501       }
1502       /* Move beyond the chunkdata. */
1503       p += 2 + chunksize;
1504
1505       /* There should be another "\r\n" to skip */
1506       if (memcmp(p, "\r\n", 2))
1507       {
1508          return CHUNK_STATUS_PARSE_ERROR;
1509       }
1510       p += 2;
1511    } while (chunksize > 0U);
1512
1513    *length = (size_t)(p - iob->cur);
1514    assert(*length <= (size_t)(iob->eod - iob->cur));
1515    assert(p <= iob->eod);
1516
1517    return CHUNK_STATUS_BODY_COMPLETE;
1518
1519 }
1520
1521
1522 /*********************************************************************
1523  *
1524  * Function    : receive_chunked_client_request_body
1525  *
1526  * Description : Read the chunk-encoded client request body.
1527  *               Failures are dealt with.
1528  *
1529  * Parameters  :
1530  *          1  :  csp = Current client state (buffers, headers, etc...)
1531  *
1532  * Returns     :  JB_ERR_OK or JB_ERR_PARSE
1533  *
1534  *********************************************************************/
1535 static jb_err receive_chunked_client_request_body(struct client_state *csp)
1536 {
1537    size_t body_length;
1538    enum chunk_status status;
1539
1540    while (CHUNK_STATUS_MISSING_DATA ==
1541       (status = chunked_body_is_complete(csp->client_iob, &body_length)))
1542    {
1543       char buf[BUFFER_SIZE];
1544       int len;
1545
1546       if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1547       {
1548          log_error(LOG_LEVEL_ERROR,
1549             "Timeout while waiting for the client body.");
1550          break;
1551       }
1552       len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1553       if (len <= 0)
1554       {
1555          log_error(LOG_LEVEL_ERROR, "Read the client body failed: %E");
1556          break;
1557       }
1558       if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1559       {
1560          break;
1561       }
1562    }
1563    if (status != CHUNK_STATUS_BODY_COMPLETE)
1564    {
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;
1570    }
1571    log_error(LOG_LEVEL_CONNECT,
1572       "Chunked client body completely read. Length: %lu", body_length);
1573    csp->expected_client_content_length = body_length;
1574
1575    return JB_ERR_OK;
1576
1577 }
1578
1579
1580 #ifdef FUZZ
1581 /*********************************************************************
1582  *
1583  * Function    :  fuzz_chunked_transfer_encoding
1584  *
1585  * Description :  Treat the fuzzed input as chunked transfer encoding
1586  *                to check and dechunk.
1587  *
1588  * Parameters  :
1589  *          1  :  csp      = Used to store the data.
1590  *          2  :  fuzz_input_file = File to read the input from.
1591  *
1592  * Returns     : Result of dechunking
1593  *
1594  *********************************************************************/
1595 extern int fuzz_chunked_transfer_encoding(struct client_state *csp, char *fuzz_input_file)
1596 {
1597    size_t length;
1598    size_t size = (size_t)(csp->iob->eod - csp->iob->cur);
1599    enum chunk_status status;
1600
1601    status = chunked_body_is_complete(csp->iob, &length);
1602    if (CHUNK_STATUS_BODY_COMPLETE != status)
1603    {
1604       log_error(LOG_LEVEL_INFO, "Chunked body is incomplete or invalid");
1605    }
1606
1607    return (JB_ERR_OK == remove_chunked_transfer_coding(csp->iob->cur, &size));
1608
1609 }
1610
1611
1612 /*********************************************************************
1613  *
1614  * Function    : fuzz_client_request
1615  *
1616  * Description : Try to get a client request from the fuzzed input.
1617  *
1618  * Parameters  :
1619  *          1  :  csp = Current client state (buffers, headers, etc...)
1620  *          2  :  fuzz_input_file = File to read the input from.
1621  *
1622  * Returns     :  Result of fuzzing.
1623  *
1624  *********************************************************************/
1625 extern int fuzz_client_request(struct client_state *csp, char *fuzz_input_file)
1626 {
1627    jb_err err;
1628
1629    csp->cfd = 0;
1630    csp->ip_addr_str = "fuzzer";
1631
1632    if (strcmp(fuzz_input_file, "-") != 0)
1633    {
1634       log_error(LOG_LEVEL_FATAL,
1635          "Fuzzed client requests can currently only be read from stdin (-).");
1636    }
1637    err = receive_client_request(csp);
1638    if (err != JB_ERR_OK)
1639    {
1640       return 1;
1641    }
1642    err = parse_client_request(csp);
1643    if (err != JB_ERR_OK)
1644    {
1645       return 1;
1646    }
1647
1648    return 0;
1649
1650 }
1651 #endif  /* def FUZZ */
1652
1653
1654 #ifdef FEATURE_FORCE_LOAD
1655 /*********************************************************************
1656  *
1657  * Function    :  force_required
1658  *
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.
1662  *
1663  * Parameters  :
1664  *          1  :  request_line = HTTP request line
1665  *
1666  * Returns     :  TRUE if force is required, FALSE otherwise.
1667  *
1668  *********************************************************************/
1669 static int force_required(const struct client_state *csp, char *request_line)
1670 {
1671    char *p;
1672
1673    p = strstr(request_line, "http://");
1674    if (p != NULL)
1675    {
1676       /* Skip protocol */
1677       p += strlen("http://");
1678    }
1679    else
1680    {
1681       /* Intercepted request usually don't specify the protocol. */
1682       p = request_line;
1683    }
1684
1685    /* Go to the beginning of the path */
1686    p = strstr(p, "/");
1687    if (p == NULL)
1688    {
1689       /*
1690        * If the path is missing the request line is invalid and we
1691        * are done here. The client-visible rejection happens later on.
1692        */
1693       return 0;
1694    }
1695
1696    if (0 == strncmpic(p, FORCE_PREFIX, strlen(FORCE_PREFIX) - 1))
1697    {
1698       if (!(csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS))
1699       {
1700          /* XXX: Should clean more carefully */
1701          strclean(request_line, FORCE_PREFIX);
1702          log_error(LOG_LEVEL_FORCE,
1703             "Enforcing request: \"%s\".", request_line);
1704
1705          return 1;
1706       }
1707       log_error(LOG_LEVEL_FORCE,
1708          "Ignored force prefix in request: \"%s\".", request_line);
1709    }
1710
1711    return 0;
1712
1713 }
1714 #endif /* def FEATURE_FORCE_LOAD */
1715
1716
1717 /*********************************************************************
1718  *
1719  * Function    :  receive_client_request
1720  *
1721  * Description : Read the client's request (more precisely the
1722  *               client headers) and answer it if necessary.
1723  *
1724  * Parameters  :
1725  *          1  :  csp = Current client state (buffers, headers, etc...)
1726  *
1727  * Returns     :  JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
1728  *
1729  *********************************************************************/
1730 static jb_err receive_client_request(struct client_state *csp)
1731 {
1732    char buf[BUFFER_SIZE];
1733    char *p;
1734    char *req = NULL;
1735    struct http_request *http;
1736    int len;
1737    jb_err err;
1738
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;
1742
1743    /* We don't care if the arriving data is a valid HTTP request or not. */
1744    csp->requests_received_total++;
1745
1746    http = csp->http;
1747
1748    memset(buf, 0, sizeof(buf));
1749
1750    req = get_request_line(csp);
1751    if (req == NULL)
1752    {
1753       mark_server_socket_tainted(csp);
1754       return JB_ERR_PARSE;
1755    }
1756    assert(*req != '\0');
1757
1758    if (client_protocol_is_unsupported(csp, req))
1759    {
1760       return JB_ERR_PARSE;
1761    }
1762
1763 #ifdef FEATURE_FORCE_LOAD
1764    if (force_required(csp, req))
1765    {
1766       csp->flags |= CSP_FLAG_FORCED;
1767    }
1768 #endif /* def FEATURE_FORCE_LOAD */
1769
1770    err = parse_http_request(req, http);
1771    freez(req);
1772    if (JB_ERR_OK != err)
1773    {
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));
1781
1782       free_http_request(http);
1783       return JB_ERR_PARSE;
1784    }
1785
1786    /* grab the rest of the client's headers */
1787    init_list(headers);
1788    for (;;)
1789    {
1790       p = get_header(csp->client_iob);
1791
1792       if (p == NULL)
1793       {
1794          /* There are no additional headers to read. */
1795          break;
1796       }
1797
1798       if (*p == '\0')
1799       {
1800          /*
1801           * We didn't receive a complete header
1802           * line yet, get the rest of it.
1803           */
1804          if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1805          {
1806             log_error(LOG_LEVEL_ERROR,
1807                "Stopped grabbing the client headers.");
1808             destroy_list(headers);
1809             return JB_ERR_PARSE;
1810          }
1811
1812          len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1813          if (len <= 0)
1814          {
1815             log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1816             destroy_list(headers);
1817             return JB_ERR_PARSE;
1818          }
1819
1820          if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
1821          {
1822             /*
1823              * If there is no memory left for buffering the
1824              * request, there is nothing we can do but hang up
1825              */
1826             destroy_list(headers);
1827             return JB_ERR_MEMORY;
1828          }
1829       }
1830       else
1831       {
1832          if (!strncmpic(p, "Transfer-Encoding:", 18))
1833          {
1834             /*
1835              * XXX: should be called through sed()
1836              *      but currently can't.
1837              */
1838             client_transfer_encoding(csp, &p);
1839          }
1840          /*
1841           * We were able to read a complete
1842           * header and can finally enlist it.
1843           */
1844          enlist(headers, p);
1845          freez(p);
1846       }
1847    }
1848
1849    if (http->host == NULL)
1850    {
1851       /*
1852        * If we still don't know the request destination,
1853        * the request is invalid or the client uses
1854        * Privoxy without its knowledge.
1855        */
1856       if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
1857       {
1858          /*
1859           * Our attempts to get the request destination
1860           * elsewhere failed or Privoxy is configured
1861           * to only accept proxy requests.
1862           *
1863           * An error response has already been send
1864           * and we're done here.
1865           */
1866          return JB_ERR_PARSE;
1867       }
1868    }
1869
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);
1874 #endif
1875
1876    /*
1877     * Determine the actions for this URL
1878     */
1879 #ifdef FEATURE_TOGGLE
1880    if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
1881    {
1882       /* Most compatible set of actions (i.e. none) */
1883       init_current_action(csp->action);
1884    }
1885    else
1886 #endif /* ndef FEATURE_TOGGLE */
1887    {
1888       get_url_actions(csp, http);
1889    }
1890
1891    enlist(csp->headers, http->cmd);
1892
1893    /* Append the previously read headers */
1894    err = list_append_list_unique(csp->headers, headers);
1895    destroy_list(headers);
1896
1897    return err;
1898
1899 }
1900
1901
1902 /*********************************************************************
1903  *
1904  * Function    : parse_client_request
1905  *
1906  * Description : Parses the client's request and decides what to do
1907  *               with it.
1908  *
1909  *               Note that since we're not using select() we could get
1910  *               blocked here if a client connected, then didn't say
1911  *               anything!
1912  *
1913  * Parameters  :
1914  *          1  :  csp = Current client state (buffers, headers, etc...)
1915  *
1916  * Returns     :  JB_ERR_OK or JB_ERR_PARSE
1917  *
1918  *********************************************************************/
1919 static jb_err parse_client_request(struct client_state *csp)
1920 {
1921    struct http_request *http = csp->http;
1922    jb_err err;
1923
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))
1928    {
1929       /* Assume persistence until further notice */
1930       csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1931    }
1932 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1933
1934    if (csp->http->ssl == 0)
1935    {
1936       /*
1937        * This whole block belongs to chat() but currently
1938        * has to be executed before sed().
1939        */
1940       if (csp->flags & CSP_FLAG_CHUNKED_CLIENT_BODY)
1941       {
1942          if (receive_chunked_client_request_body(csp) != JB_ERR_OK)
1943          {
1944             return JB_ERR_PARSE;
1945          }
1946       }
1947       else
1948       {
1949          csp->expected_client_content_length = get_expected_content_length(csp->headers);
1950       }
1951       verify_request_length(csp);
1952    }
1953 #ifndef FEATURE_HTTPS_INSPECTION
1954    else
1955    {
1956       csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1957    }
1958 #endif
1959
1960    err = sed(csp, FILTER_CLIENT_HEADERS);
1961    if (JB_ERR_OK != err)
1962    {
1963       log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
1964          csp->ip_addr_str);
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;
1969    }
1970    csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
1971
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))))
1976    {
1977       /*
1978        * A header filter broke the request line - bail out.
1979        */
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\" 400 0", csp->ip_addr_str);
1985       log_error(LOG_LEVEL_ERROR,
1986          "Invalid request line after applying header filters.");
1987       free_http_request(http);
1988
1989       return JB_ERR_PARSE;
1990    }
1991
1992    if (client_has_unsupported_expectations(csp))
1993    {
1994       return JB_ERR_PARSE;
1995    }
1996
1997    return JB_ERR_OK;
1998
1999 }
2000
2001
2002 /*********************************************************************
2003  *
2004  * Function    : read_http_request_body
2005  *
2006  * Description : Reads remaining request body from the client.
2007  *
2008  * Parameters  :
2009  *          1  :  csp = Current client state (buffers, headers, etc...)
2010  *
2011  * Returns     :  0 on success, anything else is an error.
2012  *
2013  *********************************************************************/
2014 static int read_http_request_body(struct client_state *csp)
2015 {
2016    size_t to_read = csp->expected_client_content_length;
2017    int len;
2018
2019    assert(to_read != 0);
2020
2021    /* check if all data has been already read */
2022    if (to_read <= (csp->client_iob->eod - csp->client_iob->cur))
2023    {
2024       return 0;
2025    }
2026
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)
2030    {
2031       char buf[BUFFER_SIZE];
2032       size_t max_bytes_to_read = to_read < sizeof(buf) ? to_read : sizeof(buf);
2033
2034       log_error(LOG_LEVEL_CONNECT,
2035          "Waiting for up to %d bytes of request body from the client.",
2036          max_bytes_to_read);
2037       len = read_socket(csp->cfd, buf, (int)max_bytes_to_read);
2038       if (len <= -1)
2039       {
2040          log_error(LOG_LEVEL_CONNECT, "Failed receiving request body from %s: %E", csp->ip_addr_str);
2041          return 1;
2042       }
2043       if (add_to_iob(csp->client_iob, csp->config->buffer_limit, (char *)buf, len))
2044       {
2045          return 1;
2046       }
2047       assert(to_read >= len);
2048    }
2049
2050    if (to_read != 0)
2051    {
2052       log_error(LOG_LEVEL_CONNECT, "Not enough request body has been read: expected %d more bytes",
2053          csp->expected_client_content_length);
2054       return 1;
2055    }
2056    log_error(LOG_LEVEL_CONNECT, "The last %d bytes of the request body have been read",
2057       csp->expected_client_content_length);
2058    return 0;
2059 }
2060
2061
2062 /*********************************************************************
2063  *
2064  * Function    : update_client_headers
2065  *
2066  * Description : Updates the HTTP headers from the client request.
2067  *
2068  * Parameters  :
2069  *          1  :  csp = Current client state (buffers, headers, etc...)
2070  *          2  :  new_content_length = new content length value to set
2071  *
2072  * Returns     :  0 on success, anything else is an error.
2073  *
2074  *********************************************************************/
2075 static int update_client_headers(struct client_state *csp, size_t new_content_length)
2076 {
2077    static const char content_length[] = "Content-Length:";
2078    int updated = 0;
2079    struct list_entry *p;
2080
2081 #ifndef FEATURE_HTTPS_INSPECTION
2082    for (p = csp->headers->first;
2083 #else
2084    for (p = csp->http->client_ssl ? csp->https_headers->first : csp->headers->first;
2085 #endif
2086         !updated  && (p != NULL); p = p->next)
2087    {
2088       /* Header crunch()ed in previous run? -> ignore */
2089       if (p->str == NULL)
2090       {
2091          continue;
2092       }
2093
2094       /* Does the current parser handle this header? */
2095       if (0 == strncmpic(p->str, content_length, sizeof(content_length) - 1))
2096       {
2097          updated = (JB_ERR_OK == header_adjust_content_length((char **)&(p->str), new_content_length));
2098          if (!updated)
2099          {
2100             return 1;
2101          }
2102       }
2103    }
2104
2105    return !updated;
2106 }
2107
2108
2109 /*********************************************************************
2110  *
2111  * Function    : can_filter_request_body
2112  *
2113  * Description : Checks if the current request body can be stored in
2114  *               the client_iob without hitting buffer limit.
2115  *
2116  * Parameters  :
2117  *          1  : csp = Current client state (buffers, headers, etc...)
2118  *
2119  * Returns     : TRUE if the current request size do not exceed buffer limit
2120  *               FALSE otherwise.
2121  *
2122  *********************************************************************/
2123 static int can_filter_request_body(const struct client_state *csp)
2124 {
2125    if (!can_add_to_iob(csp->client_iob, csp->config->buffer_limit,
2126                        csp->expected_client_content_length))
2127    {
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);
2132       return FALSE;
2133    }
2134    return TRUE;
2135 }
2136
2137
2138 /*********************************************************************
2139  *
2140  * Function    : send_http_request
2141  *
2142  * Description : Sends the HTTP headers from the client request
2143  *               and all the body data that has already been received.
2144  *
2145  * Parameters  :
2146  *          1  :  csp = Current client state (buffers, headers, etc...)
2147  *
2148  * Returns     :  0 on success, anything else is an error.
2149  *
2150  *********************************************************************/
2151 static int send_http_request(struct client_state *csp)
2152 {
2153    char *hdr;
2154    int write_failure;
2155    const char *to_send;
2156    size_t to_send_len;
2157    int filter_client_body = csp->expected_client_content_length != 0 &&
2158       client_body_filters_enabled(csp->action) && can_filter_request_body(csp);
2159
2160    if (filter_client_body)
2161    {
2162       if (read_http_request_body(csp))
2163       {
2164          return 1;
2165       }
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)
2169       {
2170          /* just flush client_iob */
2171          filter_client_body = FALSE;
2172       }
2173       else if (to_send_len != csp->expected_client_content_length &&
2174          update_client_headers(csp, to_send_len))
2175       {
2176          log_error(LOG_LEVEL_HEADER, "Error updating client headers");
2177          return 1;
2178       }
2179       csp->expected_client_content_length = 0;
2180    }
2181
2182    hdr = list_to_text(csp->headers);
2183    if (hdr == NULL)
2184    {
2185       /* FIXME Should handle error properly */
2186       log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
2187    }
2188    list_remove_all(csp->headers);
2189
2190    /*
2191     * Write the client's (modified) header to the server
2192     * (along with anything else that may be in the buffer)
2193     */
2194    write_failure = 0 != write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
2195    freez(hdr);
2196
2197    if (write_failure)
2198    {
2199       log_error(LOG_LEVEL_CONNECT, "Failed sending request headers to: %s: %E",
2200          csp->http->hostport);
2201       return 1;
2202    }
2203
2204    if (filter_client_body)
2205    {
2206       write_failure = 0 != write_socket(csp->server_connection.sfd, to_send, to_send_len);
2207       freez(to_send);
2208       if (write_failure)
2209       {
2210          log_error(LOG_LEVEL_CONNECT, "Failed sending filtered request body to: %s: %E",
2211             csp->http->hostport);
2212          return 1;
2213       }
2214    }
2215
2216    if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
2217       && (flush_iob(csp->server_connection.sfd, csp->client_iob, 0) < 0))
2218    {
2219       log_error(LOG_LEVEL_CONNECT, "Failed sending request body to: %s: %E",
2220          csp->http->hostport);
2221       return 1;
2222    }
2223    return 0;
2224 }
2225
2226
2227 #ifdef FEATURE_HTTPS_INSPECTION
2228 /*********************************************************************
2229  *
2230  * Function    : read_https_request_body
2231  *
2232  * Description : Reads remaining request body from the client.
2233  *
2234  * Parameters  :
2235  *          1  :  csp = Current client state (buffers, headers, etc...)
2236  *
2237  * Returns     :  0 on success, anything else is an error.
2238  *
2239  *********************************************************************/
2240 static int read_https_request_body(struct client_state *csp)
2241 {
2242    size_t to_read = csp->expected_client_content_length;
2243    int len;
2244
2245    assert(to_read != 0);
2246
2247    /* check if all data has been already read */
2248    if (to_read <= (csp->client_iob->eod - csp->client_iob->cur))
2249    {
2250       return 0;
2251    }
2252
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)
2257    {
2258       unsigned char buf[BUFFER_SIZE];
2259       size_t max_bytes_to_read = to_read < sizeof(buf) ? to_read : sizeof(buf);
2260
2261       log_error(LOG_LEVEL_CONNECT,
2262          "Waiting for up to %d bytes of request body from the client.",
2263          max_bytes_to_read);
2264       len = ssl_recv_data(&(csp->ssl_client_attr), buf,
2265          (unsigned)max_bytes_to_read);
2266       if (len <= 0)
2267       {
2268          log_error(LOG_LEVEL_CONNECT, "Failed receiving request body from %s", csp->ip_addr_str);
2269          return 1;
2270       }
2271       if (add_to_iob(csp->client_iob, csp->config->buffer_limit, (char *)buf, len))
2272       {
2273          return 1;
2274       }
2275       assert(to_read >= len);
2276    }
2277
2278    if (to_read != 0)
2279    {
2280       log_error(LOG_LEVEL_CONNECT, "Not enough request body has been read: expected %d more bytes", to_read);
2281       return 1;
2282    }
2283
2284    log_error(LOG_LEVEL_CONNECT, "The last %d bytes of the request body have been read",
2285       csp->expected_client_content_length);
2286    return 0;
2287 }
2288
2289
2290 /*********************************************************************
2291  *
2292  * Function    : receive_and_send_encrypted_post_data
2293  *
2294  * Description : Reads remaining request body from the client and sends
2295  *               it to the server.
2296  *
2297  * Parameters  :
2298  *          1  :  csp = Current client state (buffers, headers, etc...)
2299  *
2300  * Returns     :  0 on success, anything else is an error.
2301  *
2302  *********************************************************************/
2303 static int receive_and_send_encrypted_post_data(struct client_state *csp)
2304 {
2305    int content_length_known = csp->expected_client_content_length != 0;
2306
2307    while (is_ssl_pending(&(csp->ssl_client_attr))
2308       || (content_length_known && csp->expected_client_content_length != 0))
2309    {
2310       unsigned char buf[BUFFER_SIZE];
2311       int len;
2312       int max_bytes_to_read = sizeof(buf);
2313
2314       if (content_length_known && csp->expected_client_content_length < sizeof(buf))
2315       {
2316          max_bytes_to_read = (int)csp->expected_client_content_length;
2317       }
2318       log_error(LOG_LEVEL_CONNECT,
2319          "Waiting for up to %d bytes of request body from the client.",
2320          max_bytes_to_read);
2321       len = ssl_recv_data(&(csp->ssl_client_attr), buf,
2322          (unsigned)max_bytes_to_read);
2323       if (len == -1)
2324       {
2325          return 1;
2326       }
2327       if (len == 0)
2328       {
2329          /* XXX: Does this actually happen? */
2330          break;
2331       }
2332       log_error(LOG_LEVEL_CONNECT, "Forwarding %d bytes of encrypted request body",
2333          len);
2334       len = ssl_send_data(&(csp->ssl_server_attr), buf, (size_t)len);
2335       if (len == -1)
2336       {
2337          return 1;
2338       }
2339       if (csp->expected_client_content_length != 0)
2340       {
2341          if (csp->expected_client_content_length >= len)
2342          {
2343             csp->expected_client_content_length -= (unsigned)len;
2344          }
2345          if (csp->expected_client_content_length == 0)
2346          {
2347             log_error(LOG_LEVEL_CONNECT, "Forwarded the last %d bytes", len);
2348             break;
2349          }
2350       }
2351    }
2352
2353    log_error(LOG_LEVEL_CONNECT, "Done forwarding encrypted request body");
2354
2355    return 0;
2356
2357 }
2358
2359
2360 /*********************************************************************
2361  *
2362  * Function    : send_https_request
2363  *
2364  * Description : Sends the HTTP headers from the client request
2365  *               and all the body data that has already been received.
2366  *
2367  * Parameters  :
2368  *          1  :  csp = Current client state (buffers, headers, etc...)
2369  *
2370  * Returns     :  0 on success, anything else is an error.
2371  *
2372  *********************************************************************/
2373 static int send_https_request(struct client_state *csp)
2374 {
2375    char *hdr;
2376    int ret;
2377    long flushed = 0;
2378    const char *to_send;
2379    size_t to_send_len;
2380    int filter_client_body = csp->expected_client_content_length != 0 &&
2381       client_body_filters_enabled(csp->action) && can_filter_request_body(csp);
2382
2383    if (filter_client_body)
2384    {
2385       if (read_https_request_body(csp))
2386       {
2387          return 1;
2388       }
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)
2392       {
2393          /* just flush client_iob */
2394          filter_client_body = FALSE;
2395       }
2396       else if (to_send_len != csp->expected_client_content_length &&
2397          update_client_headers(csp, to_send_len))
2398       {
2399          log_error(LOG_LEVEL_HEADER, "Error updating client headers");
2400          return 1;
2401       }
2402       csp->expected_client_content_length = 0;
2403    }
2404
2405    hdr = list_to_text(csp->https_headers);
2406    if (hdr == NULL)
2407    {
2408       /* FIXME Should handle error properly */
2409       log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
2410    }
2411    list_remove_all(csp->https_headers);
2412
2413    /*
2414     * Write the client's (modified) header to the server
2415     * (along with anything else that may be in the buffer)
2416     */
2417    ret = ssl_send_data(&(csp->ssl_server_attr),
2418       (const unsigned char *)hdr, strlen(hdr));
2419    freez(hdr);
2420
2421    if (ret < 0)
2422    {
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);
2427       return 1;
2428    }
2429
2430    if (filter_client_body)
2431    {
2432       ret = ssl_send_data(&(csp->ssl_server_attr), (const unsigned char *)to_send, to_send_len);
2433       freez(to_send);
2434       if (ret < 0)
2435       {
2436          log_error(LOG_LEVEL_CONNECT, "Failed sending filtered request body to: %s",
2437             csp->http->hostport);
2438          return 1;
2439       }
2440    }
2441
2442    if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) == 0)
2443       && ((flushed = ssl_flush_socket(&(csp->ssl_server_attr),
2444             csp->client_iob)) < 0))
2445    {
2446       log_error(LOG_LEVEL_CONNECT, "Failed sending request body to: %s: %E",
2447          csp->http->hostport);
2448       return 1;
2449    }
2450    if (flushed != 0 || csp->expected_client_content_length != 0)
2451    {
2452       if (csp->expected_client_content_length != 0)
2453       {
2454          if (csp->expected_client_content_length < flushed)
2455          {
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;
2460          }
2461          else
2462          {
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))
2468             {
2469                return 1;
2470             }
2471          }
2472       }
2473       else
2474       {
2475          log_error(LOG_LEVEL_CONNECT,
2476             "Flushed %ld bytes of request body", flushed);
2477       }
2478    }
2479
2480    log_error(LOG_LEVEL_CONNECT, "Encrypted request sent");
2481
2482    return 0;
2483
2484 }
2485
2486
2487 /*********************************************************************
2488  *
2489  * Function    :  receive_encrypted_request
2490  *
2491  * Description :  Receives an encrypted request.
2492  *
2493  * Parameters  :
2494  *          1  :  csp = Current client state (buffers, headers, etc...)
2495  *
2496  * Returns     :  JB_ERR_OK on success,
2497  *                JB_ERR_PARSE or JB_ERR_MEMORY otherwise
2498  *
2499  *********************************************************************/
2500 static jb_err receive_encrypted_request(struct client_state *csp)
2501 {
2502    char buf[BUFFER_SIZE];
2503    int len;
2504    char *p;
2505
2506    do
2507    {
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))
2511       {
2512          log_error(LOG_LEVEL_CONNECT,
2513             "Socket %d timed out while waiting for client headers", csp->cfd);
2514          return JB_ERR_PARSE;
2515       }
2516       len = ssl_recv_data(&(csp->ssl_client_attr),
2517          (unsigned char *)buf, sizeof(buf));
2518       if (len == 0)
2519       {
2520          log_error(LOG_LEVEL_CONNECT,
2521             "Socket %d closed while waiting for client headers", csp->cfd);
2522          return JB_ERR_PARSE;
2523       }
2524       if (len == -1)
2525       {
2526          return JB_ERR_PARSE;
2527       }
2528       if (add_to_iob(csp->client_iob, csp->config->buffer_limit, buf, len))
2529       {
2530          return JB_ERR_MEMORY;
2531       }
2532       p = strstr(csp->client_iob->cur, "\r\n\r\n");
2533    } while (p == NULL);
2534
2535    log_error(LOG_LEVEL_HEADER, "Encrypted headers received completely");
2536
2537    return JB_ERR_OK;
2538 }
2539
2540
2541 /*********************************************************************
2542  *
2543  * Function    :  change_encrypted_request_destination
2544  *
2545  * Description :  Parse a (rewritten) request line from an encrypted
2546  *                request and regenerate the http request data.
2547  *
2548  * Parameters  :
2549  *          1  :  csp = Current client state (buffers, headers, etc...)
2550  *
2551  * Returns     :  Forwards the parse_http_request() return code.
2552  *                Terminates in case of memory problems.
2553  *
2554  *********************************************************************/
2555 static jb_err change_encrypted_request_destination(struct client_state *csp)
2556 {
2557    jb_err err;
2558    char *original_host = csp->http->host;
2559
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)
2566    {
2567       log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
2568          jb_err_to_string(err));
2569       freez(original_host);
2570       return err;
2571    }
2572
2573    if (csp->http->host == NULL)
2574    {
2575       /*
2576        * The rewritten request line did not specify a host
2577        * which means we can use the original host specified
2578        * by the client.
2579        */
2580       csp->http->host = original_host;
2581       log_error(LOG_LEVEL_REDIRECTS, "Keeping the original host: %s",
2582          csp->http->host);
2583       /*
2584        * If the rewritten request line didn't contain a host
2585        * it also didn't contain a port so we can reuse the host
2586        * and set the port to 443.
2587        */
2588       freez(csp->http->hostport);
2589       csp->http->hostport = strdup_or_die(csp->http->host);
2590       csp->http->port = 443;
2591       /*
2592        * While the request line didn't mention it,
2593        * we're https-inspecting and want to speak TLS
2594        * with the server.
2595        */
2596       csp->http->server_ssl = 1;
2597       csp->http->ssl = 1;
2598    }
2599    else
2600    {
2601       /* The rewrite filter added a host so we can ditch the original */
2602       freez(original_host);
2603       csp->http->server_ssl = csp->http->ssl;
2604    }
2605
2606    csp->http->client_ssl = 1;
2607
2608    freez(csp->https_headers->first->str);
2609    build_request_line(csp, NULL, &csp->https_headers->first->str);
2610
2611    if (!server_use_ssl(csp))
2612    {
2613       log_error(LOG_LEVEL_REDIRECTS,
2614          "Rewritten request line results in downgrade to http");
2615       /*
2616        * Replace the unencryptd headers received with the
2617        * CONNECT request with the ones we received securely.
2618        */
2619       destroy_list(csp->headers);
2620       csp->headers->first = csp->https_headers->first;
2621       csp->headers->last  = csp->https_headers->last;
2622       csp->https_headers->first = NULL;
2623       csp->https_headers->last = NULL;
2624    }
2625
2626    return JB_ERR_OK;
2627
2628 }
2629
2630
2631 /*********************************************************************
2632  *
2633  * Function    :  process_encrypted_request
2634  *
2635  * Description :  Receives and parses an encrypted request.
2636  *
2637  * Parameters  :
2638  *          1  :  csp = Current client state (buffers, headers, etc...)
2639  *
2640  * Returns     :  JB_ERR_OK on success,
2641  *                JB_ERR_PARSE or JB_ERR_MEMORY otherwise
2642  *
2643  *********************************************************************/
2644 static jb_err process_encrypted_request(struct client_state *csp)
2645 {
2646    char *p;
2647    char *request_line;
2648    jb_err err;
2649    /* Temporary copy of the client's headers before they get enlisted in csp->https_headers */
2650    struct list header_list;
2651    struct list *headers = &header_list;
2652
2653    assert(csp->ssl_with_client_is_opened);
2654
2655 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2656    if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
2657    {
2658       csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
2659    }
2660 #endif
2661    err = receive_encrypted_request(csp);
2662    if (err != JB_ERR_OK)
2663    {
2664       if (csp->client_iob->cur == NULL ||
2665           csp->client_iob->cur == csp->client_iob->eod)
2666       {
2667          /*
2668           * We did not receive any data, most likely because the
2669           * client is done. Don't log this as a parse failure.
2670           */
2671          return JB_ERR_PARSE;
2672       }
2673       /* XXX: Also used for JB_ERR_MEMORY */
2674       log_error(LOG_LEVEL_ERROR, "Failed to receive encrypted request: %s",
2675          jb_err_to_string(err));
2676       ssl_send_data_delayed(&(csp->ssl_client_attr),
2677          (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2678       return err;
2679    }
2680
2681    /* We don't need get_request_line() because the whole HTTP head is buffered. */
2682    request_line = get_header(csp->client_iob);
2683    if (request_line == NULL)
2684    {
2685       log_error(LOG_LEVEL_ERROR, "Failed to get the encrypted request line");
2686       ssl_send_data_delayed(&(csp->ssl_client_attr),
2687          (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2688       return JB_ERR_PARSE;
2689    }
2690    assert(*request_line != '\0');
2691
2692    if (client_protocol_is_unsupported(csp, request_line))
2693    {
2694       /*
2695        * If the protocol is unsupported we're done here.
2696        * client_protocol_is_unsupported() took care of sending
2697        * the error response and logging the error message.
2698        */
2699       return JB_ERR_PARSE;
2700    }
2701
2702 #ifdef FEATURE_FORCE_LOAD
2703    if (force_required(csp, request_line))
2704    {
2705       csp->flags |= CSP_FLAG_FORCED;
2706    }
2707 #endif /* def FEATURE_FORCE_LOAD */
2708
2709    free_http_request(csp->http);
2710
2711    err = parse_http_request(request_line, csp->http);
2712    /* XXX: Restore ssl setting. This is ugly */
2713    csp->http->client_ssl = 1;
2714    csp->http->server_ssl = 1;
2715
2716    freez(request_line);
2717    if (JB_ERR_OK != err)
2718    {
2719       ssl_send_data_delayed(&(csp->ssl_client_attr),
2720          (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2721       /* XXX: Use correct size */
2722       log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
2723       log_error(LOG_LEVEL_ERROR,
2724          "Couldn't parse request line received from %s: %s",
2725          csp->ip_addr_str, jb_err_to_string(err));
2726
2727       free_http_request(csp->http);
2728       return JB_ERR_PARSE;
2729    }
2730
2731    /* Parse the rest of the client's headers. */
2732    init_list(headers);
2733    for (;;)
2734    {
2735       p = get_header(csp->client_iob);
2736
2737       if (p == NULL)
2738       {
2739          /* There are no additional headers to read. */
2740          break;
2741       }
2742       enlist(headers, p);
2743       freez(p);
2744    }
2745
2746    if (JB_ERR_OK != get_destination_from_https_headers(headers, csp->http))
2747    {
2748       /*
2749        * Our attempts to get the request destination
2750        * elsewhere failed.
2751        */
2752       log_error(LOG_LEVEL_ERROR,
2753          "Failed to get the encrypted request destination");
2754       ssl_send_data_delayed(&(csp->ssl_client_attr),
2755          (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2756       return JB_ERR_PARSE;
2757    }
2758
2759    /* Split the domain we just got for pattern matching */
2760    init_domain_components(csp->http);
2761
2762 #ifdef FEATURE_CLIENT_TAGS
2763    /* XXX: If the headers were enlisted sooner, passing csp would do. */
2764    if (csp->client_address == NULL)
2765    {
2766       set_client_address(csp, headers);
2767       get_tag_list_for_client(csp->client_tags, csp->client_address);
2768    }
2769 #endif
2770
2771 #ifdef FEATURE_TOGGLE
2772    if ((csp->flags & CSP_FLAG_TOGGLED_ON) != 0)
2773 #endif
2774    {
2775       /*
2776        * Determine the actions for this request after
2777        * clearing the ones from the previous one.
2778        */
2779       free_current_action(csp->action);
2780       get_url_actions(csp, csp->http);
2781    }
2782
2783    enlist(csp->https_headers, csp->http->cmd);
2784
2785    /* Append the previously read headers */
2786    err = list_append_list_unique(csp->https_headers, headers);
2787    destroy_list(headers);
2788    if (JB_ERR_OK != err)
2789    {
2790       /* XXX: Send error message */
2791       return err;
2792    }
2793
2794    /* XXX: Work around crash */
2795    csp->error_message = NULL;
2796
2797    /* XXX: Why do this here? */
2798    csp->http->ssl = 1;
2799
2800    err = sed_https(csp);
2801    if (JB_ERR_OK != err)
2802    {
2803       ssl_send_data_delayed(&(csp->ssl_client_attr),
2804          (const unsigned char *)CHEADER, strlen(CHEADER), get_write_delay(csp));
2805       log_error(LOG_LEVEL_ERROR, "Failed to parse client request from %s.",
2806          csp->ip_addr_str);
2807       log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
2808          csp->ip_addr_str, csp->http->cmd);
2809       return JB_ERR_PARSE;
2810    }
2811
2812    if ((NULL == csp->https_headers->first->str)
2813       || (strcmp(csp->http->cmd, csp->https_headers->first->str) &&
2814          (JB_ERR_OK != change_encrypted_request_destination(csp))))
2815    {
2816       ssl_send_data_delayed(&(csp->ssl_client_attr),
2817          (const unsigned char *)MESSED_UP_REQUEST_RESPONSE,
2818          strlen(MESSED_UP_REQUEST_RESPONSE), get_write_delay(csp));
2819       log_error(LOG_LEVEL_ERROR,
2820          "Invalid request line after applying header filters.");
2821       /* XXX: Use correct size */
2822       log_error(LOG_LEVEL_CLF,
2823          "%s - - [%T] \"Invalid request generated\" 400 0", csp->ip_addr_str);
2824
2825       return JB_ERR_PARSE;
2826    }
2827
2828    log_error(LOG_LEVEL_HEADER, "Encrypted request processed");
2829    log_applied_actions(csp->action);
2830    log_error(LOG_LEVEL_REQUEST, "https://%s%s", csp->http->hostport,
2831       csp->http->path);
2832
2833    return err;
2834
2835 }
2836
2837 /*********************************************************************
2838  *
2839  * Function    :  cgi_page_requested
2840  *
2841  * Description :  Checks if a request is for an internal CGI page.
2842  *
2843  * Parameters  :
2844  *          1  :  host = The host requested by the client.
2845  *
2846  * Returns     :  1 if a CGI page has been requested, 0 otherwise
2847  *
2848  *********************************************************************/
2849 static int cgi_page_requested(const char *host)
2850 {
2851    if ((0 == strcmpic(host, CGI_SITE_1_HOST))
2852     || (0 == strcmpic(host, CGI_SITE_1_HOST "."))
2853     || (0 == strcmpic(host, CGI_SITE_2_HOST))
2854     || (0 == strcmpic(host, CGI_SITE_2_HOST ".")))
2855    {
2856       return 1;
2857    }
2858
2859    return 0;
2860
2861 }
2862
2863
2864 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2865 /*********************************************************************
2866  *
2867  * Function    :  continue_https_chat
2868  *
2869  * Description :  Behaves similar to chat() but only deals with
2870  *                https-inspected requests that arrive on an already
2871  *                established connection. The first request is always
2872  *                served by chat() which is a lot more complex as it
2873  *                has to deal with forwarding settings and connection
2874  *                failures etc.
2875  *
2876  *                If a connection to the server has already been
2877  *                opened it is reused unless the request is blocked
2878  *                or the forwarder changed.
2879  *
2880  *                If a connection to the server has not yet been
2881  *                opened (because the previous request was crunched),
2882  *                or the forwarder changed, the connection is dropped
2883  *                so that the client retries on a fresh one.
2884  *
2885  * Parameters  :
2886  *          1  :  csp = Current client state (buffers, headers, etc...)
2887  *
2888  * Returns     :  Nothing.
2889  *
2890  *********************************************************************/
2891 static void continue_https_chat(struct client_state *csp)
2892 {
2893    const struct forward_spec *fwd;
2894
2895    if (JB_ERR_OK != process_encrypted_request(csp))
2896    {
2897       return;
2898    }
2899
2900    csp->requests_received_total++;
2901
2902    /*
2903     * We have an encrypted request. Check if one of the crunchers wants it.
2904     */
2905    if (crunch_response_triggered(csp, crunchers_all))
2906    {
2907       /*
2908        * Yes. The client got the crunch response and we're done here.
2909        */
2910       return;
2911    }
2912    if (csp->ssl_with_server_is_opened == 0)
2913    {
2914       log_error(LOG_LEVEL_CONNECT,
2915          "Dropping the client connection on socket %d. "
2916          "The server connection has not been established yet.",
2917          csp->cfd);
2918       csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
2919       return;
2920    }
2921    assert(csp->server_connection.sfd != JB_INVALID_SOCKET);
2922
2923    fwd = forward_url(csp, csp->http);
2924    if (!connection_destination_matches(&csp->server_connection, csp->http, fwd))
2925    {
2926       log_error(LOG_LEVEL_CONNECT,
2927          "Dropping the client connection on socket %d with "
2928          "server socket %d connected to %s. The forwarder has changed.",
2929          csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
2930       csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
2931       return;
2932    }
2933
2934    log_error(LOG_LEVEL_CONNECT,
2935       "Reusing server socket %d connected to %s. Requests already sent: %u.",
2936       csp->server_connection.sfd, csp->server_connection.host,
2937       csp->server_connection.requests_sent_total);
2938
2939    if (send_https_request(csp))
2940    {
2941       /*
2942        * Most likely the server connection timed out. We can't easily
2943        * create a new one so simply drop the client connection without a
2944        * error response to let the client retry.
2945        */
2946       log_error(LOG_LEVEL_CONNECT,
2947          "Dropping client connection on socket %d. "
2948          "Forwarding the encrypted client request failed.",
2949          csp->cfd);
2950       return;
2951    }
2952    csp->server_connection.requests_sent_total++;
2953    handle_established_connection(csp);
2954    freez(csp->receive_buffer);
2955 }
2956 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2957 #endif
2958
2959
2960 /*********************************************************************
2961  *
2962  * Function    :  handle_established_connection
2963  *
2964  * Description :  Shuffle data between client and server once the
2965  *                connection has been established.
2966  *
2967  * Parameters  :
2968  *          1  :  csp = Current client state (buffers, headers, etc...)
2969  *
2970  * Returns     :  Nothing.
2971  *
2972  *********************************************************************/
2973 static void handle_established_connection(struct client_state *csp)
2974 {
2975    char *hdr;
2976    char *p;
2977    int n;
2978 #ifdef HAVE_POLL
2979    struct pollfd poll_fds[2];
2980 #else
2981    fd_set rfds;
2982    jb_socket maxfd;
2983    struct timeval timeout;
2984 #endif
2985    int server_body;
2986    int ms_iis5_hack = 0;
2987    unsigned long long byte_count = 0;
2988    struct http_request *http;
2989    long len = 0; /* for buffer sizes (and negative error codes) */
2990    int buffer_and_filter_content = 0;
2991    unsigned int write_delay;
2992 #ifdef FEATURE_HTTPS_INSPECTION
2993    int ret = 0;
2994    int use_ssl_tunnel = 0;
2995    csp->dont_verify_certificate = 0;
2996
2997    if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION))
2998    {
2999       /* Pass encrypted content without filtering. */
3000       use_ssl_tunnel = 1;
3001    }
3002 #endif
3003
3004    /* Skeleton for HTTP response, if we should intercept the request */
3005    struct http_response *rsp;
3006 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3007    int watch_client_socket;
3008 #endif
3009
3010    csp->receive_buffer_size = csp->config->receive_buffer_size;
3011    csp->receive_buffer = zalloc(csp->receive_buffer_size + 1);
3012    if (csp->receive_buffer == NULL)
3013    {
3014       log_error(LOG_LEVEL_ERROR,
3015          "Out of memory. Failed to allocate the receive buffer.");
3016       rsp = cgi_error_memory();
3017       send_crunch_response(csp, rsp);
3018       return;
3019    }
3020
3021    http = csp->http;
3022
3023 #ifndef HAVE_POLL
3024    maxfd = (csp->cfd > csp->server_connection.sfd) ?
3025       csp->cfd : csp->server_connection.sfd;
3026 #endif
3027
3028    /* pass data between the client and server
3029     * until one or the other shuts down the connection.
3030     */
3031
3032    server_body = 0;
3033
3034 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3035    watch_client_socket = 0 == (csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING);
3036 #endif
3037    write_delay = get_write_delay(csp);
3038
3039    for (;;)
3040    {
3041 #ifndef HAVE_POLL
3042       FD_ZERO(&rfds);
3043 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3044       if (!watch_client_socket)
3045       {
3046          maxfd = csp->server_connection.sfd;
3047       }
3048       else
3049 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3050       {
3051          FD_SET(csp->cfd, &rfds);
3052       }
3053
3054       FD_SET(csp->server_connection.sfd, &rfds);
3055 #endif /* ndef HAVE_POLL */
3056
3057 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3058       if ((csp->flags & CSP_FLAG_CHUNKED)
3059          && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3060          && ((csp->iob->eod - csp->iob->cur) >= 5)
3061          && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
3062       {
3063          /*
3064           * XXX: This check should be obsolete now,
3065           *      but let's wait a while to be sure.
3066           */
3067          log_error(LOG_LEVEL_CONNECT,
3068             "Looks like we got the last chunk together with "
3069             "the server headers but didn't detect it earlier. "
3070             "We better stop reading.");
3071          byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3072          csp->expected_content_length = byte_count;
3073          csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
3074       }
3075       if (server_body && server_response_is_complete(csp, byte_count))
3076       {
3077          if (csp->expected_content_length == byte_count)
3078          {
3079             log_error(LOG_LEVEL_CONNECT,
3080                "Done reading from server. Content length: %llu as expected. "
3081                "Bytes most recently read: %ld.",
3082                byte_count, len);
3083          }
3084          else
3085          {
3086             log_error(LOG_LEVEL_CONNECT,
3087                "Done reading from server. Expected content length: %llu. "
3088                "Actual content length: %llu. Bytes most recently read: %ld.",
3089                csp->expected_content_length, byte_count, len);
3090          }
3091          len = 0;
3092          /*
3093           * XXX: Should not jump around, handle_established_connection()
3094           * is complicated enough already.
3095           */
3096          goto reading_done;
3097       }
3098 #endif  /* FEATURE_CONNECTION_KEEP_ALIVE */
3099
3100 #ifdef HAVE_POLL
3101       poll_fds[0].fd = csp->cfd;
3102 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3103       if (!watch_client_socket)
3104       {
3105          /*
3106           * Ignore incoming data, but still watch out
3107           * for disconnects etc. These flags are always
3108           * implied anyway but explicitly setting them
3109           * doesn't hurt.
3110           */
3111          poll_fds[0].events = POLLERR|POLLHUP;
3112       }
3113       else
3114 #endif
3115       {
3116          poll_fds[0].events = POLLIN;
3117       }
3118       poll_fds[1].fd = csp->server_connection.sfd;
3119       poll_fds[1].events = POLLIN;
3120       n = poll(poll_fds, 2, csp->config->socket_timeout * 1000);
3121 #else
3122       timeout.tv_sec = csp->config->socket_timeout;
3123       timeout.tv_usec = 0;
3124       n = select((int)maxfd + 1, &rfds, NULL, NULL, &timeout);
3125 #endif /* def HAVE_POLL */
3126
3127       /*server or client not responding in timeout */
3128       if (n == 0)
3129       {
3130          log_error(LOG_LEVEL_CONNECT, "Socket timeout %d reached: %s",
3131             csp->config->socket_timeout, http->url);
3132          if ((byte_count == 0) && (http->ssl == 0))
3133          {
3134             send_crunch_response(csp, error_response(csp, "connection-timeout"));
3135          }
3136          mark_server_socket_tainted(csp);
3137 #ifdef FEATURE_HTTPS_INSPECTION
3138          close_client_and_server_ssl_connections(csp);
3139 #endif
3140          return;
3141       }
3142       else if (n < 0)
3143       {
3144 #ifdef HAVE_POLL
3145          log_error(LOG_LEVEL_ERROR, "poll() failed!: %E");
3146 #else
3147          log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
3148 #endif
3149          mark_server_socket_tainted(csp);
3150 #ifdef FEATURE_HTTPS_INSPECTION
3151          close_client_and_server_ssl_connections(csp);
3152 #endif
3153          return;
3154       }
3155
3156       /*
3157        * This is the body of the browser's request,
3158        * just read and write it.
3159        *
3160        * Receives data from browser and sends it to server
3161        *
3162        * XXX: Make sure the client doesn't use pipelining
3163        * behind Privoxy's back.
3164        */
3165 #ifdef HAVE_POLL
3166       if ((poll_fds[0].revents & (POLLERR|POLLHUP|POLLNVAL)) != 0)
3167       {
3168          log_error(LOG_LEVEL_CONNECT,
3169             "The client socket %d has become unusable while "
3170             "the server socket %d is still open.",
3171             csp->cfd, csp->server_connection.sfd);
3172          mark_server_socket_tainted(csp);
3173          break;
3174       }
3175
3176       if (poll_fds[0].revents != 0)
3177 #else
3178       if (FD_ISSET(csp->cfd, &rfds))
3179 #endif /* def HAVE_POLL*/
3180       {
3181          int max_bytes_to_read = (int)csp->receive_buffer_size;
3182
3183 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3184          if ((csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ))
3185          {
3186             if (data_is_available(csp->cfd, 0))
3187             {
3188                /*
3189                 * If the next request is already waiting, we have
3190                 * to stop select()ing the client socket. Otherwise
3191                 * we would always return right away and get nothing
3192                 * else done.
3193                 */
3194                watch_client_socket = 0;
3195                log_error(LOG_LEVEL_CONNECT,
3196                   "Stop watching client socket %d. "
3197                   "There's already another request waiting.",
3198                   csp->cfd);
3199                continue;
3200             }
3201             /*
3202              * If the client socket is set, but there's no data
3203              * available on the socket, the client went fishing
3204              * and continuing talking to the server makes no sense.
3205              */
3206             log_error(LOG_LEVEL_CONNECT,
3207                "The client closed socket %d while "
3208                "the server socket %d is still open.",
3209                csp->cfd, csp->server_connection.sfd);
3210             mark_server_socket_tainted(csp);
3211             break;
3212          }
3213          if (csp->expected_client_content_length != 0)
3214          {
3215             if (csp->expected_client_content_length < csp->receive_buffer_size)
3216             {
3217                max_bytes_to_read = (int)csp->expected_client_content_length;
3218             }
3219             log_error(LOG_LEVEL_CONNECT,
3220                "Waiting for up to %d bytes from the client.",
3221                max_bytes_to_read);
3222          }
3223          assert(max_bytes_to_read <= csp->receive_buffer_size);
3224 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3225
3226 #ifdef FEATURE_HTTPS_INSPECTION
3227          if (client_use_ssl(csp))
3228          {
3229             if (csp->http->status == 101)
3230             {
3231                len = ssl_recv_data(&(csp->ssl_client_attr),
3232                   (unsigned char *)csp->receive_buffer,
3233                   (size_t)max_bytes_to_read);
3234                if (len == -1)
3235                {
3236                   log_error(LOG_LEVEL_ERROR, "Failed to receive data "
3237                      "on client socket %d for an upgraded connection",
3238                      csp->cfd);
3239                   break;
3240                }
3241                if (len == 0)
3242                {
3243                   log_error(LOG_LEVEL_CONNECT, "Done receiving data "
3244                      "on client socket %d for an upgraded connection",
3245                      csp->cfd);
3246                   break;
3247                }
3248                byte_count += (unsigned long long)len;
3249                len = ssl_send_data(&(csp->ssl_server_attr),
3250                   (unsigned char *)csp->receive_buffer, (size_t)len);
3251                if (len == -1)
3252                {
3253                   log_error(LOG_LEVEL_ERROR, "Failed to send data "
3254                      "on server socket %d for an upgraded connection",
3255                      csp->server_connection.sfd);
3256                   break;
3257                }
3258                continue;
3259             }
3260             log_error(LOG_LEVEL_CONNECT, "Breaking with TLS/SSL.");
3261             break;
3262          }
3263          else
3264 #endif /* def FEATURE_HTTPS_INSPECTION */
3265          {
3266             len = read_socket(csp->cfd, csp->receive_buffer, max_bytes_to_read);
3267
3268             if (len <= 0)
3269             {
3270                /* XXX: not sure if this is necessary. */
3271                mark_server_socket_tainted(csp);
3272                break; /* "game over, man" */
3273             }
3274
3275 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3276             if (csp->expected_client_content_length != 0)
3277             {
3278                assert(len <= max_bytes_to_read);
3279                csp->expected_client_content_length -= (unsigned)len;
3280                log_error(LOG_LEVEL_CONNECT,
3281                   "Expected client content length set to %llu "
3282                   "after reading %ld bytes.",
3283                   csp->expected_client_content_length, len);
3284                if (csp->expected_client_content_length == 0)
3285                {
3286                   log_error(LOG_LEVEL_CONNECT,
3287                      "Done reading from the client.");
3288                   csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
3289                }
3290             }
3291 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3292
3293             if (write_socket(csp->server_connection.sfd, csp->receive_buffer, (size_t)len))
3294             {
3295                log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
3296                mark_server_socket_tainted(csp);
3297                return;
3298             }
3299          }
3300          continue;
3301       }
3302
3303       /*
3304        * The server wants to talk. It could be the header or the body.
3305        * If `hdr' is null, then it's the header otherwise it's the body.
3306        * FIXME: Does `hdr' really mean `host'? No.
3307        */
3308 #ifdef HAVE_POLL
3309       if (poll_fds[1].revents != 0)
3310 #else
3311       if (FD_ISSET(csp->server_connection.sfd, &rfds))
3312 #endif /* HAVE_POLL */
3313       {
3314 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3315          /*
3316           * If we are buffering content, we don't want to eat up to
3317           * buffer-limit bytes if the client no longer cares about them.
3318           * If we aren't buffering, however, a dead client socket will be
3319           * noticed pretty much right away anyway, so we can reduce the
3320           * overhead by skipping the check.
3321           */
3322          if (buffer_and_filter_content && !socket_is_still_alive(csp->cfd))
3323          {
3324 #ifdef _WIN32
3325             log_error(LOG_LEVEL_CONNECT,
3326                "The server still wants to talk, but the client may already have hung up on us.");
3327 #else
3328             log_error(LOG_LEVEL_CONNECT,
3329                "The server still wants to talk, but the client hung up on us.");
3330             mark_server_socket_tainted(csp);
3331 #ifdef FEATURE_HTTPS_INSPECTION
3332             close_client_and_server_ssl_connections(csp);
3333 #endif
3334             return;
3335 #endif /* def _WIN32 */
3336          }
3337 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3338
3339 #ifdef FEATURE_HTTPS_INSPECTION
3340          /*
3341           * Reading data from standard or secured connection (HTTP/HTTPS)
3342           */
3343          if (server_use_ssl(csp))
3344          {
3345             len = ssl_recv_data(&(csp->ssl_server_attr),
3346                (unsigned char *)csp->receive_buffer, csp->receive_buffer_size);
3347          }
3348          else
3349 #endif
3350          {
3351             len = read_socket(csp->server_connection.sfd, csp->receive_buffer,
3352                (int)csp->receive_buffer_size);
3353          }
3354
3355          if (len < 0)
3356          {
3357             log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
3358
3359             if ((http->ssl && (csp->fwd == NULL))
3360 #ifdef FEATURE_HTTPS_INSPECTION
3361                && use_ssl_tunnel
3362 #endif
3363                 )
3364             {
3365                /*
3366                 * Just hang up. We already confirmed the client's CONNECT
3367                 * request with status code 200 and unencrypted content is
3368                 * no longer welcome.
3369                 */
3370                log_error(LOG_LEVEL_ERROR,
3371                   "CONNECT already confirmed. Unable to tell the client about the problem.");
3372                return;
3373             }
3374             else if (byte_count)
3375             {
3376                /*
3377                 * Just hang up. We already transmitted the original headers
3378                 * and parts of the original content and therefore missed the
3379                 * chance to send an error message (without risking data corruption).
3380                 *
3381                 * XXX: we could retry with a fancy range request here.
3382                 */
3383                log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
3384                   "Unable to tell the client about the problem.");
3385                mark_server_socket_tainted(csp);
3386 #ifdef FEATURE_HTTPS_INSPECTION
3387                close_client_and_server_ssl_connections(csp);
3388 #endif
3389                return;
3390             }
3391             /*
3392              * XXX: Consider handling the cases above the same.
3393              */
3394             mark_server_socket_tainted(csp);
3395             len = 0;
3396          }
3397
3398 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3399          if (csp->flags & CSP_FLAG_CHUNKED)
3400          {
3401             if ((len >= 5) && !memcmp(csp->receive_buffer+len-5, "0\r\n\r\n", 5))
3402             {
3403                /* XXX: this is a temporary hack */
3404                log_error(LOG_LEVEL_CONNECT,
3405                   "Looks like we reached the end of the last chunk. "
3406                   "We better stop reading.");
3407                csp->expected_content_length = byte_count + (unsigned long long)len;
3408                csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
3409             }
3410          }
3411          reading_done:
3412 #endif  /* FEATURE_CONNECTION_KEEP_ALIVE */
3413
3414          /*
3415           * This is guaranteed by allocating with zalloc_or_die()
3416           * and never (intentionally) writing to the last byte.
3417           *
3418           * csp->receive_buffer_size is the size of the part of the
3419           * buffer we intentionally write to, but we actually
3420           * allocated csp->receive_buffer_size+1 bytes so the assertion
3421           * stays within the allocated range.
3422           */
3423          assert(csp->receive_buffer[csp->receive_buffer_size] == '\0');
3424
3425          /*
3426           * Add a trailing zero to let be able to use string operations.
3427           * XXX: do we still need this with filter_popups gone?
3428           */
3429          assert(len <= csp->receive_buffer_size);
3430          csp->receive_buffer[len] = '\0';
3431
3432          /*
3433           * Normally, this would indicate that we've read
3434           * as much as the server has sent us and we can
3435           * close the client connection.  However, Microsoft
3436           * in its wisdom has released IIS/5 with a bug that
3437           * prevents it from sending the trailing \r\n in
3438           * a 302 redirect header (and possibly other headers).
3439           * To work around this if we've haven't parsed
3440           * a full header we'll append a trailing \r\n
3441           * and see if this now generates a valid one.
3442           *
3443           * This hack shouldn't have any impacts.  If we've
3444           * already transmitted the header or if this is a
3445           * SSL connection, then we won't bother with this
3446           * hack.  So we only work on partially received
3447           * headers.  If we append a \r\n and this still
3448           * doesn't generate a valid header, then we won't
3449           * transmit anything to the client.
3450           */
3451          if (len == 0)
3452          {
3453
3454             if (server_body || (http->ssl
3455 #ifdef FEATURE_HTTPS_INSPECTION
3456                   && use_ssl_tunnel
3457 #endif
3458                ))
3459             {
3460                /*
3461                 * If we have been buffering up the document,
3462                 * now is the time to apply content modification
3463                 * and send the result to the client.
3464                 */
3465                if (buffer_and_filter_content)
3466                {
3467                   p = execute_content_filters(csp);
3468                   /*
3469                    * If content filtering fails, use the original
3470                    * buffer and length.
3471                    * (see p != NULL ? p : csp->iob->cur below)
3472                    */
3473                   if (NULL == p)
3474                   {
3475                      csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
3476                   }
3477 #ifdef FEATURE_COMPRESSION
3478                   else if ((csp->flags & CSP_FLAG_CLIENT_SUPPORTS_DEFLATE)
3479                      && (csp->content_length > LOWER_LENGTH_LIMIT_FOR_COMPRESSION))
3480                   {
3481                      char *compressed_content = compress_buffer(p,
3482                         (size_t *)&csp->content_length, csp->config->compression_level);
3483                      if (compressed_content != NULL)
3484                      {
3485                         freez(p);
3486                         p = compressed_content;
3487                         csp->flags |= CSP_FLAG_BUFFERED_CONTENT_DEFLATED;
3488                      }
3489                   }
3490 #endif
3491
3492                   if (JB_ERR_OK != update_server_headers(csp))
3493                   {
3494                      log_error(LOG_LEVEL_FATAL,
3495                         "Failed to update server headers. after filtering.");
3496                   }
3497
3498                   hdr = list_to_text(csp->headers);
3499                   if (hdr == NULL)
3500                   {
3501                      /* FIXME Should handle error properly */
3502                      log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
3503                   }
3504
3505 #ifdef FEATURE_HTTPS_INSPECTION
3506                   /*
3507                    * Sending data with standard or secured connection (HTTP/HTTPS)
3508                    */
3509                   if (client_use_ssl(csp))
3510                   {
3511                      if ((ssl_send_data_delayed(&(csp->ssl_client_attr),
3512                               (const unsigned char *)hdr, strlen(hdr),
3513                               get_write_delay(csp)) < 0)
3514                         || (ssl_send_data_delayed(&(csp->ssl_client_attr),
3515                               (const unsigned char *) ((p != NULL) ? p : csp->iob->cur),
3516                               csp->content_length, get_write_delay(csp)) < 0))
3517                      {
3518                         log_error(LOG_LEVEL_ERROR, "write modified content to "
3519                            "client over TLS/SSL failed");
3520                         freez(hdr);
3521                         freez(p);
3522                         mark_server_socket_tainted(csp);
3523                         close_client_and_server_ssl_connections(csp);
3524                         return;
3525                      }
3526                   }
3527                   else
3528 #endif /* def FEATURE_HTTPS_INSPECTION */
3529                   {
3530                      if (write_socket_delayed(csp->cfd, hdr, strlen(hdr), write_delay)
3531                       || write_socket_delayed(csp->cfd, ((p != NULL) ? p : csp->iob->cur),
3532                          (size_t)csp->content_length, write_delay))
3533                      {
3534                         log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
3535                         freez(hdr);
3536                         freez(p);
3537                         mark_server_socket_tainted(csp);
3538                         return;
3539                      }
3540                   }
3541
3542                   freez(hdr);
3543                   freez(p);
3544                }
3545
3546                break; /* "game over, man" */
3547             }
3548
3549             /*
3550              * This is NOT the body, so
3551              * Let's pretend the server just sent us a blank line.
3552              */
3553             snprintf(csp->receive_buffer, csp->receive_buffer_size, "\r\n");
3554             len = (int)strlen(csp->receive_buffer);
3555
3556             /*
3557              * Now, let the normal header parsing algorithm below do its
3558              * job.  If it fails, we'll exit instead of continuing.
3559              */
3560
3561             ms_iis5_hack = 1;
3562          }
3563
3564          /*
3565           * If we're in the body of the server document, just write it to
3566           * the client, unless we need to buffer the body for later
3567           * content-filtering.
3568           */
3569          if (server_body || (http->ssl
3570 #ifdef FEATURE_HTTPS_INSPECTION
3571                && use_ssl_tunnel
3572 #endif
3573             ))
3574          {
3575             if (buffer_and_filter_content)
3576             {
3577                /*
3578                 * If there is no memory left for buffering the content, or the buffer limit
3579                 * has been reached, switch to non-filtering mode, i.e. make & write the
3580                 * header, flush the iob and buf, and get out of the way.
3581                 */
3582                if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3583                {
3584                   size_t hdrlen;
3585                   long flushed;
3586
3587                   log_error(LOG_LEVEL_INFO,
3588                      "Flushing header and buffers. Stepping back from filtering.");
3589
3590                   hdr = list_to_text(csp->headers);
3591                   if (hdr == NULL)
3592                   {
3593                      /*
3594                       * Memory is too tight to even generate the header.
3595                       * Send our static "Out-of-memory" page.
3596                       */
3597                      log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
3598                      rsp = cgi_error_memory();
3599                      send_crunch_response(csp, rsp);
3600                      mark_server_socket_tainted(csp);
3601 #ifdef FEATURE_HTTPS_INSPECTION
3602                      close_client_and_server_ssl_connections(csp);
3603 #endif
3604                      return;
3605                   }
3606                   hdrlen = strlen(hdr);
3607
3608 #ifdef FEATURE_HTTPS_INSPECTION
3609                   /*
3610                    * Sending data with standard or secured connection (HTTP/HTTPS)
3611                    */
3612                   if (client_use_ssl(csp))
3613                   {
3614                      if ((ssl_send_data_delayed(&(csp->ssl_client_attr),
3615                              (const unsigned char *)hdr, hdrlen, get_write_delay(csp)) < 0)
3616                         || ((flushed = ssl_flush_socket(&(csp->ssl_client_attr),
3617                                 csp->iob)) < 0)
3618                         || (ssl_send_data_delayed(&(csp->ssl_client_attr),
3619                               (const unsigned char *)csp->receive_buffer, (size_t)len,
3620                               get_write_delay(csp)) < 0))
3621                      {
3622                         log_error(LOG_LEVEL_CONNECT,
3623                            "Flush header and buffers to client failed");
3624                         freez(hdr);
3625                         mark_server_socket_tainted(csp);
3626                         close_client_and_server_ssl_connections(csp);
3627                         return;
3628                      }
3629                   }
3630                   else
3631 #endif /* def FEATURE_HTTPS_INSPECTION */
3632                   {
3633                      if (write_socket_delayed(csp->cfd, hdr, hdrlen, write_delay)
3634                       || ((flushed = flush_iob(csp->cfd, csp->iob, write_delay)) < 0)
3635                       || write_socket_delayed(csp->cfd, csp->receive_buffer, (size_t)len,
3636                             write_delay))
3637                      {
3638                         log_error(LOG_LEVEL_CONNECT,
3639                            "Flush header and buffers to client failed: %E");
3640                         freez(hdr);
3641                         mark_server_socket_tainted(csp);
3642                         return;
3643                      }
3644                   }
3645
3646                   /*
3647                    * Reset the byte_count to the amount of bytes
3648                    * we just flushed. len will be added a few lines below,
3649                    * hdrlen doesn't matter for LOG_LEVEL_CLF.
3650                    */
3651                   byte_count = (unsigned long long)flushed;
3652                   freez(hdr);
3653                   buffer_and_filter_content = 0;
3654                   server_body = 1;
3655                }
3656             }
3657             else
3658             {
3659 #ifdef FEATURE_HTTPS_INSPECTION
3660                /*
3661                 * Sending data with standard or secured connection (HTTP/HTTPS)
3662                 */
3663                if (client_use_ssl(csp))
3664                {
3665                   ret = ssl_send_data_delayed(&(csp->ssl_client_attr),
3666                      (const unsigned char *)csp->receive_buffer, (size_t)len,
3667                      get_write_delay(csp));
3668                   if (ret < 0)
3669                   {
3670                      log_error(LOG_LEVEL_ERROR,
3671                         "Sending data to client failed");
3672                      mark_server_socket_tainted(csp);
3673                      close_client_and_server_ssl_connections(csp);
3674                      return;
3675                   }
3676                }
3677                else
3678 #endif /* def FEATURE_HTTPS_INSPECTION */
3679                {
3680                   if (write_socket_delayed(csp->cfd, csp->receive_buffer,
3681                         (size_t)len, write_delay))
3682                   {
3683                      log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
3684                      mark_server_socket_tainted(csp);
3685                      return;
3686                   }
3687                }
3688             }
3689             byte_count += (unsigned long long)len;
3690             continue;
3691          }
3692          else
3693          {
3694             /*
3695              * We're still looking for the end of the server's header.
3696              * Buffer up the data we just read.  If that fails, there's
3697              * little we can do but send our static out-of-memory page.
3698              */
3699             if (add_to_iob(csp->iob, csp->config->buffer_limit, csp->receive_buffer, len))
3700             {
3701                log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
3702                rsp = cgi_error_memory();
3703                send_crunch_response(csp, rsp);
3704                mark_server_socket_tainted(csp);
3705 #ifdef FEATURE_HTTPS_INSPECTION
3706                close_client_and_server_ssl_connections(csp);
3707 #endif
3708                return;
3709             }
3710
3711             /* Convert iob into something sed() can digest */
3712             if (JB_ERR_PARSE == get_server_headers(csp))
3713             {
3714                if (ms_iis5_hack)
3715                {
3716                   /*
3717                    * Well, we tried our MS IIS/5 hack and it didn't work.
3718                    * The header is incomplete and there isn't anything
3719                    * we can do about it.
3720                    */
3721                   log_error(LOG_LEVEL_ERROR, "Invalid server headers. "
3722                      "Applying the MS IIS5 hack didn't help.");
3723                   log_error(LOG_LEVEL_CLF,
3724                      "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3725 #ifdef FEATURE_HTTPS_INSPECTION
3726                   /*
3727                    * Sending data with standard or secured connection (HTTP/HTTPS)
3728                    */
3729                   if (client_use_ssl(csp))
3730                   {
3731                      ssl_send_data_delayed(&(csp->ssl_client_attr),
3732                         (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3733                         strlen(INVALID_SERVER_HEADERS_RESPONSE), get_write_delay(csp));
3734                   }
3735                   else
3736 #endif /* def FEATURE_HTTPS_INSPECTION */
3737                   {
3738                      write_socket_delayed(csp->cfd,
3739                         INVALID_SERVER_HEADERS_RESPONSE,
3740                         strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3741                   }
3742                   mark_server_socket_tainted(csp);
3743 #ifdef FEATURE_HTTPS_INSPECTION
3744                   close_client_and_server_ssl_connections(csp);
3745 #endif
3746                   return;
3747                }
3748                else
3749                {
3750                   /*
3751                    * Since we have to wait for more from the server before
3752                    * we can parse the headers we just continue here.
3753                    */
3754                   log_error(LOG_LEVEL_CONNECT,
3755                      "Continuing buffering server headers from socket %d. "
3756                      "Bytes most recently read: %ld.", csp->cfd, len);
3757                   continue;
3758                }
3759             }
3760             else
3761             {
3762                /*
3763                 * Account for the content bytes we
3764                 * might have gotten with the headers.
3765                 */
3766                assert(csp->iob->eod >= csp->iob->cur);
3767                byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3768             }
3769
3770             /* Did we actually get anything? */
3771             if (NULL == csp->headers->first)
3772             {
3773                if ((csp->flags & CSP_FLAG_REUSED_CLIENT_CONNECTION))
3774                {
3775                   log_error(LOG_LEVEL_ERROR,
3776                      "No server or forwarder response received on socket %d. "
3777                      "Closing client socket %d without sending data.",
3778                      csp->server_connection.sfd, csp->cfd);
3779                   log_error(LOG_LEVEL_CLF,
3780                      "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3781                }
3782                else
3783                {
3784                   log_error(LOG_LEVEL_ERROR,
3785                      "No server or forwarder response received on socket %d.",
3786                      csp->server_connection.sfd);
3787                   send_crunch_response(csp, error_response(csp, "no-server-data"));
3788                }
3789                free_http_request(http);
3790                mark_server_socket_tainted(csp);
3791 #ifdef FEATURE_HTTPS_INSPECTION
3792                close_client_and_server_ssl_connections(csp);
3793 #endif
3794                return;
3795             }
3796
3797             if (!csp->headers->first->str)
3798             {
3799                log_error(LOG_LEVEL_ERROR, "header search: csp->headers->first->str == NULL, assert will be called");
3800             }
3801             assert(csp->headers->first->str);
3802
3803             if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
3804                 strncmpic(csp->headers->first->str, "ICY", 3))
3805             {
3806                /*
3807                 * It doesn't look like a HTTP (or Shoutcast) response:
3808                 * tell the client and log the problem.
3809                 */
3810                if (strlen(csp->headers->first->str) > 30)
3811                {
3812                   csp->headers->first->str[30] = '\0';
3813                }
3814                log_error(LOG_LEVEL_ERROR,
3815                   "Invalid server or forwarder response. Starts with: %s",
3816                   csp->headers->first->str);
3817                log_error(LOG_LEVEL_CLF,
3818                   "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3819 #ifdef FEATURE_HTTPS_INSPECTION
3820                /*
3821                 * Sending data with standard or secured connection (HTTP/HTTPS)
3822                 */
3823                if (client_use_ssl(csp))
3824                {
3825                   ssl_send_data_delayed(&(csp->ssl_client_attr),
3826                      (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3827                      strlen(INVALID_SERVER_HEADERS_RESPONSE),
3828                      get_write_delay(csp));
3829                }
3830                else
3831 #endif /* def FEATURE_HTTPS_INSPECTION */
3832                {
3833                   write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3834                      strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3835                }
3836                free_http_request(http);
3837                mark_server_socket_tainted(csp);
3838 #ifdef FEATURE_HTTPS_INSPECTION
3839                close_client_and_server_ssl_connections(csp);
3840 #endif
3841                return;
3842             }
3843
3844             /*
3845              * We have now received the entire server header,
3846              * filter it and send the result to the client
3847              */
3848             if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
3849             {
3850                log_error(LOG_LEVEL_CLF,
3851                   "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3852 #ifdef FEATURE_HTTPS_INSPECTION
3853                /*
3854                 * Sending data with standard or secured connection (HTTP/HTTPS)
3855                 */
3856                if (client_use_ssl(csp))
3857                {
3858                   ssl_send_data_delayed(&(csp->ssl_client_attr),
3859                      (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3860                      strlen(INVALID_SERVER_HEADERS_RESPONSE),
3861                      get_write_delay(csp));
3862                }
3863                else
3864 #endif
3865                {
3866                   write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3867                      strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
3868                }
3869                free_http_request(http);
3870                mark_server_socket_tainted(csp);
3871 #ifdef FEATURE_HTTPS_INSPECTION
3872                close_client_and_server_ssl_connections(csp);
3873 #endif
3874                return;
3875             }
3876             hdr = list_to_text(csp->headers);
3877             if (hdr == NULL)
3878             {
3879                /* FIXME Should handle error properly */
3880                log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
3881             }
3882
3883             if ((csp->flags & CSP_FLAG_CHUNKED)
3884                && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
3885                && ((csp->iob->eod - csp->iob->cur) >= 5)
3886                && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
3887             {
3888                log_error(LOG_LEVEL_CONNECT,
3889                   "Looks like we got the last chunk together with "
3890                   "the server headers. We better stop reading.");
3891                byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
3892                csp->expected_content_length = byte_count;
3893                csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
3894             }
3895
3896             csp->server_connection.response_received = time(NULL);
3897
3898             if (crunch_response_triggered(csp, crunchers_light))
3899             {
3900                /*
3901                 * One of the tags created by a server-header
3902                 * tagger triggered a crunch. We already
3903                 * delivered the crunch response to the client
3904                 * and are done here after cleaning up.
3905                 */
3906                freez(hdr);
3907                mark_server_socket_tainted(csp);
3908 #ifdef FEATURE_HTTPS_INSPECTION
3909                close_client_and_server_ssl_connections(csp);
3910 #endif
3911                return;
3912             }
3913
3914             /* Buffer and pcrs filter this if appropriate. */
3915             buffer_and_filter_content = content_requires_filtering(csp);
3916
3917             if (!buffer_and_filter_content)
3918             {
3919                /*
3920                 * Write the server's (modified) header to
3921                 * the client (along with anything else that
3922                 * may be in the buffer). Use standard or secured
3923                 * connection.
3924                 */
3925 #ifdef FEATURE_HTTPS_INSPECTION
3926                if (client_use_ssl(csp))
3927                {
3928                   if ((ssl_send_data_delayed(&(csp->ssl_client_attr),
3929                           (const unsigned char *)hdr, strlen(hdr),
3930                           get_write_delay(csp)) < 0)
3931                      || (len = ssl_flush_socket(&(csp->ssl_client_attr),
3932                             csp->iob) < 0))
3933                   {
3934                      log_error(LOG_LEVEL_CONNECT, "Write header to client failed");
3935
3936                      /*
3937                       * The write failed, so don't bother mentioning it
3938                       * to the client... it probably can't hear us anyway.
3939                       */
3940                      freez(hdr);
3941                      mark_server_socket_tainted(csp);
3942 #ifdef FEATURE_HTTPS_INSPECTION
3943                      close_client_and_server_ssl_connections(csp);
3944 #endif
3945                      return;
3946                   }
3947                }
3948                else
3949 #endif /* def FEATURE_HTTPS_INSPECTION */
3950                {
3951                   if (write_socket_delayed(csp->cfd, hdr, strlen(hdr), write_delay)
3952                      || ((len = flush_iob(csp->cfd, csp->iob, write_delay)) < 0))
3953                   {
3954                      log_error(LOG_LEVEL_ERROR,
3955                         "write header to client failed");
3956                      /*
3957                       * The write failed, so don't bother mentioning it
3958                       * to the client... it probably can't hear us anyway.
3959                       */
3960                      freez(hdr);
3961                      mark_server_socket_tainted(csp);
3962                      return;
3963                   }
3964                }
3965                                 }
3966
3967             /* we're finished with the server's header */
3968
3969             freez(hdr);
3970             server_body = 1;
3971
3972             /*
3973              * If this was a MS IIS/5 hack then it means the server
3974              * has already closed the connection. Nothing more to read.
3975              * Time to bail.
3976              */
3977             if (ms_iis5_hack)
3978             {
3979                log_error(LOG_LEVEL_ERROR,
3980                   "Closed server connection detected. "
3981                   "Applying the MS IIS5 hack didn't help.");
3982                log_error(LOG_LEVEL_CLF,
3983                   "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
3984 #ifdef FEATURE_HTTPS_INSPECTION
3985                /*
3986                 * Sending data with standard or secured connection (HTTP/HTTPS)
3987                 */
3988                if (client_use_ssl(csp))
3989                {
3990                   ssl_send_data_delayed(&(csp->ssl_client_attr),
3991                      (const unsigned char *)INVALID_SERVER_HEADERS_RESPONSE,
3992                      strlen(INVALID_SERVER_HEADERS_RESPONSE),
3993                      get_write_delay(csp));
3994                }
3995                else
3996 #endif /* def FEATURE_HTTPS_INSPECTION */
3997                {
3998                   write_socket_delayed(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
3999                      strlen(INVALID_SERVER_HEADERS_RESPONSE), write_delay);
4000                }
4001                mark_server_socket_tainted(csp);
4002 #ifdef FEATURE_HTTPS_INSPECTION
4003                close_client_and_server_ssl_connections(csp);
4004 #endif
4005                return;
4006             }
4007          }
4008          continue;
4009       }
4010       mark_server_socket_tainted(csp);
4011 #ifdef FEATURE_HTTPS_INSPECTION
4012       close_client_and_server_ssl_connections(csp);
4013 #endif
4014       return; /* huh? we should never get here */
4015    }
4016
4017    if (csp->content_length == 0)
4018    {
4019       /*
4020        * If Privoxy didn't recalculate the Content-Length,
4021        * byte_count is still correct.
4022        */
4023       csp->content_length = byte_count;
4024    }
4025
4026 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4027    if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
4028       && (csp->expected_content_length != byte_count))
4029    {
4030       log_error(LOG_LEVEL_CONNECT,
4031          "Received %llu bytes while expecting %llu.",
4032          byte_count, csp->expected_content_length);
4033       mark_server_socket_tainted(csp);
4034    }
4035 #endif
4036
4037 #ifdef FEATURE_HTTPS_INSPECTION
4038    if (client_use_ssl(csp))
4039    {
4040       log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s https://%s%s %s\" 200 %llu",
4041          csp->ip_addr_str, http->gpc, http->hostport, http->path,
4042          http->version, csp->content_length);
4043    }
4044    else
4045 #endif
4046    {
4047       log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %llu",
4048          csp->ip_addr_str, http->ocmd, csp->content_length);
4049    }
4050    csp->server_connection.timestamp = time(NULL);
4051 }
4052
4053
4054 /*********************************************************************
4055  *
4056  * Function    :  chat
4057  *
4058  * Description :  Once a connection from the client has been accepted,
4059  *                this function is called (via serve()) to handle the
4060  *                main business of the communication.  This function
4061  *                returns after dealing with a single request. It can
4062  *                be called multiple times with the same client socket
4063  *                if the client is keeping the connection alive.
4064  *
4065  *                The decision whether or not a client connection will
4066  *                be kept alive is up to the caller which also must
4067  *                close the client socket when done.
4068  *
4069  *                FIXME: chat is nearly thousand lines long.
4070  *                Ridiculous.
4071  *
4072  * Parameters  :
4073  *          1  :  csp = Current client state (buffers, headers, etc...)
4074  *
4075  * Returns     :  Nothing.
4076  *
4077  *********************************************************************/
4078 static void chat(struct client_state *csp)
4079 {
4080    const struct forward_spec *fwd;
4081    struct http_request *http;
4082    /* Skeleton for HTTP response, if we should intercept the request */
4083    struct http_response *rsp;
4084 #ifdef FEATURE_HTTPS_INSPECTION
4085    int use_ssl_tunnel = 0;
4086 #endif
4087
4088    http = csp->http;
4089
4090    if (receive_client_request(csp) != JB_ERR_OK)
4091    {
4092       return;
4093    }
4094    if (parse_client_request(csp) != JB_ERR_OK)
4095    {
4096       return;
4097    }
4098
4099    /* decide how to route the HTTP request */
4100    fwd = forward_url(csp, http);
4101
4102 #ifdef FEATURE_HTTPS_INSPECTION
4103    /*
4104     * Setting flags to use old solution with SSL tunnel and to disable
4105     * certificate verification.
4106     */
4107    if (csp->http->ssl && !(csp->action->flags & ACTION_HTTPS_INSPECTION)
4108       && !cgi_page_requested(csp->http->host))
4109    {
4110       use_ssl_tunnel = 1;
4111    }
4112
4113    if (http->ssl && (csp->action->flags & ACTION_IGNORE_CERTIFICATE_ERRORS))
4114    {
4115       csp->dont_verify_certificate = 1;
4116    }
4117 #endif
4118
4119    /*
4120     * build the http request to send to the server
4121     * we have to do one of the following:
4122     *
4123     * create =    use the original HTTP request to create a new
4124     *             HTTP request that has either the path component
4125     *             without the http://domainspec (w/path) or the
4126     *             full orininal URL (w/url)
4127     *             Note that the path and/or the HTTP version may
4128     *             have been altered by now.
4129     *
4130     * SSL proxy = Open a socket to the host:port of the server
4131     *             and create TLS/SSL connection with server and
4132     *             with client. Then behave like mediator between
4133     *             client and server over TLS/SSL.
4134     *
4135     * SSL proxy = Pass the request unchanged if forwarding a CONNECT
4136     *    with     request to a parent proxy. Note that we'll be sending
4137     * forwarding  the CFAIL message ourselves if connecting to the parent
4138     *             fails, but we won't send a CSUCCEED message if it works,
4139     *             since that would result in a double message (ours and the
4140     *             parent's). After sending the request to the parent, we
4141     *             must parse answer and send it to client. If connection
4142     *             with server is established, we do TLS/SSL proxy. Otherwise
4143     *             we send parent response to client and close connections.
4144     *
4145     * here's the matrix:
4146     *                        SSL
4147     *                    0        1
4148     *                +--------+--------+
4149     *                |        |        |
4150     *             0  | create |   SSL  |
4151     *                | w/path |  proxy |
4152     *  Forwarding    +--------+--------+
4153     *                |        |   SSL  |
4154     *             1  | create |  proxy |
4155     *                | w/url  |+forward|
4156     *                +--------+--------+
4157     *
4158     */
4159
4160 #ifdef FEATURE_HTTPS_INSPECTION
4161    /*
4162     * Presetting SSL client and server flags
4163     */
4164    if (http->ssl && !use_ssl_tunnel)
4165    {
4166       http->client_ssl = 1;
4167       http->server_ssl = 1;
4168    }
4169    else
4170    {
4171       http->client_ssl = 0;
4172       http->server_ssl = 0;
4173    }
4174 #endif
4175
4176 #ifdef FEATURE_HTTPS_INSPECTION
4177    /*
4178     * Log the request unless we're https inspecting
4179     * in which case we don't have the path yet and
4180     * will log the request later.
4181     */
4182    if (!client_use_ssl(csp))
4183 #endif
4184    {
4185       log_error(LOG_LEVEL_REQUEST, "%s%s", http->hostport, http->path);
4186    }
4187
4188    if (http->ssl && connect_port_is_forbidden(csp))
4189    {
4190       const char *acceptable_connect_ports =
4191          csp->action->string[ACTION_STRING_LIMIT_CONNECT];
4192       assert(NULL != acceptable_connect_ports);
4193       log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
4194          "limit-connect{%s} doesn't allow CONNECT requests to %s",
4195          csp->ip_addr_str, acceptable_connect_ports, csp->http->hostport);
4196       csp->action->flags |= ACTION_BLOCK;
4197       http->ssl = 0;
4198 #ifdef FEATURE_HTTPS_INSPECTION
4199       http->client_ssl = 0;
4200       http->server_ssl = 0;
4201 #endif
4202    }
4203
4204
4205    freez(csp->headers->first->str);
4206    build_request_line(csp, fwd, &csp->headers->first->str);
4207
4208    /*
4209     * We have a request. Check if one of the crunchers wants it
4210     * unless the client wants to use TLS/SSL in which case we
4211     * haven't setup the TLS context yet and will send the crunch
4212     * response later.
4213     */
4214    if (
4215 #ifdef FEATURE_HTTPS_INSPECTION
4216        !client_use_ssl(csp) &&
4217 #endif
4218        crunch_response_triggered(csp, crunchers_all))
4219    {
4220       /*
4221        * Yes. The client got the crunch response and we're done here.
4222        */
4223       return;
4224    }
4225
4226    log_applied_actions(csp->action);
4227    if (fwd->forward_host)
4228    {
4229       log_error(LOG_LEVEL_CONNECT, "via [%s]:%d to: %s",
4230          fwd->forward_host, fwd->forward_port, http->hostport);
4231    }
4232    else
4233    {
4234       log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
4235    }
4236
4237    /* here we connect to the server, gateway, or the forwarder */
4238
4239 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4240    if ((csp->server_connection.sfd != JB_INVALID_SOCKET)
4241       && socket_is_still_alive(csp->server_connection.sfd)
4242       && connection_destination_matches(&csp->server_connection, http, fwd))
4243    {
4244       log_error(LOG_LEVEL_CONNECT,
4245          "Reusing server socket %d connected to %s. Total requests: %u.",
4246          csp->server_connection.sfd, csp->server_connection.host,
4247          csp->server_connection.requests_sent_total);
4248    }
4249    else
4250    {
4251       if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4252       {
4253 #ifdef FEATURE_CONNECTION_SHARING
4254          if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING
4255 #ifdef FEATURE_HTTPS_INSPECTION
4256             && !server_use_ssl(csp)
4257 #endif
4258             )
4259          {
4260             remember_connection(&csp->server_connection);
4261          }
4262          else
4263 #endif /* def FEATURE_CONNECTION_SHARING */
4264          {
4265             log_error(LOG_LEVEL_CONNECT,
4266                "Closing server socket %d connected to %s. Total requests: %u.",
4267                csp->server_connection.sfd, csp->server_connection.host,
4268                csp->server_connection.requests_sent_total);
4269             close_socket(csp->server_connection.sfd);
4270          }
4271          mark_connection_closed(&csp->server_connection);
4272       }
4273 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4274 #ifdef FEATURE_HTTPS_INSPECTION
4275       if (client_use_ssl(csp) && !use_ssl_tunnel)
4276       {
4277          int ret;
4278          /*
4279           * Creating a SSL proxy.
4280           *
4281           * By sending the CSUCCEED message we're lying to the client as
4282           * the connection hasn't actually been established yet. We don't
4283           * establish the connection until we have seen and parsed the
4284           * encrypted client headers.
4285           */
4286          if (write_socket_delayed(csp->cfd, CSUCCEED,
4287                strlen(CSUCCEED), get_write_delay(csp)) != 0)
4288          {
4289             log_error(LOG_LEVEL_ERROR, "Sending SUCCEED to client failed");
4290             return;
4291          }
4292
4293          ret = create_client_ssl_connection(csp);
4294          if (ret != 0)
4295          {
4296             log_error(LOG_LEVEL_ERROR,
4297                "Failed to open a secure connection with the client");
4298             return;
4299          }
4300          if (JB_ERR_OK != process_encrypted_request(csp))
4301          {
4302             close_client_ssl_connection(csp);
4303             return;
4304          }
4305          /*
4306           * We have an encrypted request. Check if one of the crunchers now
4307           * wants it (for example because the previously invisible path was
4308           * required to match).
4309           */
4310          if (crunch_response_triggered(csp, crunchers_all))
4311          {
4312             /*
4313              * Yes. The client got the crunch response and we're done here.
4314              */
4315             return;
4316          }
4317       }
4318 #endif
4319       /*
4320        * Connecting to destination server
4321        */
4322       csp->server_connection.sfd = forwarded_connect(fwd, http, csp);
4323
4324       if (csp->server_connection.sfd == JB_INVALID_SOCKET)
4325       {
4326          if (fwd->type != SOCKS_NONE)
4327          {
4328             /* Socks error. */
4329             rsp = error_response(csp, "forwarding-failed");
4330          }
4331          else if (errno == EINVAL)
4332          {
4333             rsp = error_response(csp, "no-such-domain");
4334          }
4335          else
4336          {
4337             rsp = error_response(csp, "connect-failed");
4338          }
4339
4340          /* Write the answer to the client */
4341          if (rsp != NULL)
4342          {
4343             send_crunch_response(csp, rsp);
4344          }
4345
4346          /*
4347           * Temporary workaround to prevent already-read client
4348           * bodies from being parsed as new requests. For now we
4349           * err on the safe side and throw all the following
4350           * requests under the bus, even if no client body has been
4351           * buffered. A compliant client will repeat the dropped
4352           * requests on an untainted connection.
4353           *
4354           * The proper fix is to discard the no longer needed
4355           * client body in the buffer (if there is one) and to
4356           * continue parsing the bytes that follow.
4357           */
4358 #ifdef FEATURE_HTTPS_INSPECTION
4359          close_client_ssl_connection(csp);
4360 #endif
4361          drain_and_close_socket(csp->cfd);
4362          csp->cfd = JB_INVALID_SOCKET;
4363
4364          return;
4365       }
4366
4367 #ifdef FEATURE_HTTPS_INSPECTION
4368       /*
4369        * Creating TLS/SSL connections with destination server or parent
4370        * proxy. If forwarding is enabled, we must send client request to
4371        * parent proxy and receive, parse and resend parent proxy answer.
4372        */
4373       if (http->ssl && !use_ssl_tunnel)
4374       {
4375          if (fwd->forward_host != NULL)
4376          {
4377             char server_response[BUFFER_SIZE];
4378             int ret = 0;
4379             int len = 0;
4380             char *hdr = list_to_text(csp->headers);
4381             memset(server_response, 0, sizeof(server_response));
4382
4383             if (hdr == NULL)
4384             {
4385                log_error(LOG_LEVEL_FATAL,
4386                   "Out of memory parsing client header");
4387             }
4388             list_remove_all(csp->headers);
4389
4390             /*
4391              * Sending client's CONNECT request to the parent proxy
4392              */
4393             ret = write_socket(csp->server_connection.sfd, hdr, strlen(hdr));
4394
4395             freez(hdr);
4396
4397             if (ret != 0)
4398             {
4399                log_error(LOG_LEVEL_CONNECT,
4400                   "Sending request headers to: %s failed", http->hostport);
4401                mark_server_socket_tainted(csp);
4402                close_client_ssl_connection(csp);
4403                return;
4404             }
4405
4406             /* Waiting for parent proxy server response */
4407             len = read_socket(csp->server_connection.sfd, server_response,
4408                sizeof(server_response)-1);
4409
4410             if (len <= 0)
4411             {
4412                log_error(LOG_LEVEL_ERROR, "No response from parent proxy "
4413                   "server on socket %d.", csp->server_connection.sfd);
4414
4415                rsp = error_response(csp, "no-server-data");
4416                if (rsp)
4417                {
4418                   send_crunch_response(csp, rsp);
4419                }
4420                mark_server_socket_tainted(csp);
4421                close_client_ssl_connection(csp);
4422                return;
4423             }
4424
4425             /*
4426              * Test if the connection to the destination server was
4427              * established successfully by the parent proxy.
4428              */
4429             if (!tunnel_established_successfully(server_response, (unsigned int)len))
4430             {
4431                log_error(LOG_LEVEL_ERROR,
4432                   "The forwarder %s failed to establish a connection with %s",
4433                   fwd->forward_host, http->host);
4434                rsp = error_response(csp, "connect-failed");
4435                if (rsp)
4436                {
4437                   send_crunch_response(csp, rsp);
4438                }
4439                mark_server_socket_tainted(csp);
4440                close_client_ssl_connection(csp);
4441                return;
4442             }
4443          } /* -END- if (fwd->forward_host != NULL) */
4444
4445          /*
4446           * We can now create the TLS/SSL connection with the destination server.
4447           */
4448          int ret = create_server_ssl_connection(csp);
4449          if (ret != 0)
4450          {
4451             if (csp->server_cert_verification_result != SSL_CERT_VALID &&
4452                 csp->server_cert_verification_result != SSL_CERT_NOT_VERIFIED)
4453             {
4454                /*
4455                 * If the server certificate is invalid, we must inform
4456                 * the client and then close connection to the client.
4457                 */
4458                ssl_send_certificate_error(csp);
4459                close_client_and_server_ssl_connections(csp);
4460                return;
4461             }
4462             if (csp->server_cert_verification_result == SSL_CERT_NOT_VERIFIED
4463              || csp->server_cert_verification_result == SSL_CERT_VALID)
4464             {
4465                /*
4466                 * The TLS/SSL connection wasn't created but an invalid
4467                 * certificate wasn't detected. Report it as connection
4468                 * failure.
4469                 */
4470                rsp = error_response(csp, "connect-failed");
4471                if (rsp)
4472                {
4473                   send_crunch_response(csp, rsp);
4474                }
4475                close_client_and_server_ssl_connections(csp);
4476                return;
4477             }
4478          }
4479       }/* -END- if (http->ssl) */
4480 #endif /* def FEATURE_HTTPS_INSPECTION */
4481
4482 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4483       save_connection_destination(csp->server_connection.sfd,
4484          http, fwd, &csp->server_connection);
4485       csp->server_connection.keep_alive_timeout =
4486          (unsigned)csp->config->keep_alive_timeout;
4487    }
4488 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4489
4490    csp->server_connection.requests_sent_total++;
4491
4492    if ((fwd->type == SOCKS_5T) && (NULL == csp->headers->first))
4493    {
4494       /* Client headers have been sent optimistically */
4495       assert(csp->headers->last == NULL);
4496    }
4497    else if (http->ssl == 0 || (fwd->forward_host
4498 #ifdef FEATURE_HTTPS_INSPECTION
4499          && use_ssl_tunnel
4500 #endif
4501            ))
4502    {
4503       if (send_http_request(csp))
4504       {
4505          rsp = error_response(csp, "connect-failed");
4506          if (rsp)
4507          {
4508             send_crunch_response(csp, rsp);
4509          }
4510          return;
4511       }
4512    }
4513    else
4514    {
4515       /*
4516        * Using old solution with SSL tunnel or new solution with SSL proxy
4517        */
4518       list_remove_all(csp->headers);
4519 #ifdef FEATURE_HTTPS_INSPECTION
4520       if (use_ssl_tunnel)
4521 #endif
4522       {
4523          /*
4524          * We're running an SSL tunnel and we're not forwarding,
4525          * so just ditch the client headers, send the "connect succeeded"
4526          * message to the client, flush the rest, and get out of the way.
4527          */
4528          if (write_socket_delayed(csp->cfd, CSUCCEED,
4529                strlen(CSUCCEED), get_write_delay(csp)))
4530          {
4531             return;
4532          }
4533       }
4534 #ifdef FEATURE_HTTPS_INSPECTION
4535       else
4536       {
4537          /*
4538           * If server certificate has been verified and is invalid,
4539           * we must inform the client and then close the connection
4540           * with client and server.
4541           */
4542          if (csp->server_cert_verification_result != SSL_CERT_VALID &&
4543              csp->server_cert_verification_result != SSL_CERT_NOT_VERIFIED)
4544          {
4545             ssl_send_certificate_error(csp);
4546             close_client_and_server_ssl_connections(csp);
4547             return;
4548          }
4549          if (send_https_request(csp))
4550          {
4551             rsp = error_response(csp, "connect-failed");
4552             if (rsp)
4553             {
4554                send_crunch_response(csp, rsp);
4555             }
4556             close_client_and_server_ssl_connections(csp);
4557             return;
4558          }
4559       }
4560 #endif /* def FEATURE_HTTPS_INSPECTION */
4561       clear_iob(csp->client_iob);
4562    }/* -END- else ... if (http->ssl == 1) */
4563
4564    log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
4565
4566    /* XXX: should the time start earlier for optimistically sent data? */
4567    csp->server_connection.request_sent = time(NULL);
4568
4569    handle_established_connection(csp);
4570    freez(csp->receive_buffer);
4571 }
4572
4573
4574 #ifdef FUZZ
4575 /*********************************************************************
4576  *
4577  * Function    :  fuzz_server_response
4578  *
4579  * Description :  Treat the input as a whole server response.
4580  *
4581  * Parameters  :
4582  *          1  :  csp = Current client state (buffers, headers, etc...)
4583  *          2  :  fuzz_input_file = File to read the input from.
4584  *
4585  * Returns     :  0
4586  *
4587  *********************************************************************/
4588 extern int fuzz_server_response(struct client_state *csp, char *fuzz_input_file)
4589 {
4590    static struct forward_spec fwd; /* Zero'd due to being static */
4591    csp->cfd = 0;
4592
4593    if (strcmp(fuzz_input_file, "-") == 0)
4594    {
4595       /* XXX: Doesn't work yet. */
4596       csp->server_connection.sfd = 0;
4597    }
4598    else
4599    {
4600       csp->server_connection.sfd = open(fuzz_input_file, O_RDONLY);
4601       if (csp->server_connection.sfd == -1)
4602       {
4603          log_error(LOG_LEVEL_FATAL, "Failed to open %s: %E",
4604             fuzz_input_file);
4605       }
4606    }
4607    csp->fwd = &fwd;
4608    csp->content_type |= CT_GIF;
4609    csp->action->flags |= ACTION_DEANIMATE;
4610    csp->action->string[ACTION_STRING_DEANIMATE] = "last";
4611
4612    csp->http->path = strdup_or_die("/");
4613    csp->http->host = strdup_or_die("fuzz.example.org");
4614    csp->http->hostport = strdup_or_die("fuzz.example.org:80");
4615    /* Prevent client socket monitoring */
4616    csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
4617    csp->flags |= CSP_FLAG_CHUNKED;
4618
4619    csp->config->feature_flags |= RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE;
4620    csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
4621
4622    csp->content_type |= CT_DECLARED|CT_GIF;
4623
4624    csp->config->socket_timeout = 0;
4625
4626    cgi_init_error_messages();
4627
4628    handle_established_connection(csp);
4629    freez(csp->receive_buffer);
4630
4631    return 0;
4632 }
4633 #endif
4634
4635
4636 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4637 /*********************************************************************
4638  *
4639  * Function    :  prepare_csp_for_next_request
4640  *
4641  * Description :  Put the csp in a mostly vergin state.
4642  *
4643  * Parameters  :
4644  *          1  :  csp = Current client state (buffers, headers, etc...)
4645  *
4646  * Returns     :  N/A
4647  *
4648  *********************************************************************/
4649 static void prepare_csp_for_next_request(struct client_state *csp)
4650 {
4651    csp->content_type = 0;
4652    csp->content_length = 0;
4653    csp->expected_content_length = 0;
4654    csp->expected_client_content_length = 0;
4655    list_remove_all(csp->headers);
4656    clear_iob(csp->iob);
4657    freez(csp->error_message);
4658    free_http_request(csp->http);
4659    destroy_list(csp->headers);
4660 #ifdef FEATURE_HTTPS_INSPECTION
4661    destroy_list(csp->https_headers);
4662 #endif
4663    destroy_list(csp->tags);
4664 #ifdef FEATURE_CLIENT_TAGS
4665    destroy_list(csp->client_tags);
4666    freez(csp->client_address);
4667 #endif
4668    free_current_action(csp->action);
4669    if (NULL != csp->fwd)
4670    {
4671       unload_forward_spec(csp->fwd);
4672       csp->fwd = NULL;
4673    }
4674    /* XXX: Store per-connection flags someplace else. */
4675    csp->flags = (CSP_FLAG_ACTIVE | CSP_FLAG_REUSED_CLIENT_CONNECTION);
4676 #ifdef FEATURE_TOGGLE
4677    if (global_toggle_state)
4678 #endif /* def FEATURE_TOGGLE */
4679    {
4680       csp->flags |= CSP_FLAG_TOGGLED_ON;
4681    }
4682
4683    if (csp->client_iob->eod > csp->client_iob->cur)
4684    {
4685       long bytes_to_shift = csp->client_iob->cur - csp->client_iob->buf;
4686       size_t data_length  = (size_t)(csp->client_iob->eod - csp->client_iob->cur);
4687
4688       assert(bytes_to_shift > 0);
4689       assert(data_length > 0);
4690
4691       log_error(LOG_LEVEL_CONNECT, "Shifting %lu pipelined bytes by %ld bytes",
4692          data_length, bytes_to_shift);
4693       memmove(csp->client_iob->buf, csp->client_iob->cur, data_length);
4694       csp->client_iob->cur = csp->client_iob->buf;
4695       assert(csp->client_iob->eod == csp->client_iob->buf + bytes_to_shift + data_length);
4696       csp->client_iob->eod = csp->client_iob->buf + data_length;
4697       memset(csp->client_iob->eod, '\0', (size_t)bytes_to_shift);
4698
4699       csp->flags |= CSP_FLAG_PIPELINED_REQUEST_WAITING;
4700    }
4701    else
4702    {
4703       /*
4704        * We mainly care about resetting client_iob->cur so we don't
4705        * waste buffer space at the beginning and don't mess up the
4706        * request restoration done by cgi_show_request().
4707        *
4708        * Freeing the buffer itself isn't technically necessary,
4709        * but makes debugging more convenient.
4710        */
4711       clear_iob(csp->client_iob);
4712    }
4713 }
4714 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4715
4716
4717 /*********************************************************************
4718  *
4719  * Function    :  serve
4720  *
4721  * Description :  This is little more than chat.  We only "serve" to
4722  *                to close (or remember) any socket that chat may have
4723  *                opened.
4724  *
4725  * Parameters  :
4726  *          1  :  csp = Current client state (buffers, headers, etc...)
4727  *
4728  * Returns     :  N/A
4729  *
4730  *********************************************************************/
4731 static void serve(struct client_state *csp)
4732 {
4733    int config_file_change_detected = 0; /* Only used for debugging */
4734 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4735 #ifdef FEATURE_CONNECTION_SHARING
4736    static int monitor_thread_running = 0;
4737 #endif /* def FEATURE_CONNECTION_SHARING */
4738    int continue_chatting = 0;
4739
4740    log_error(LOG_LEVEL_CONNECT, "Accepted connection from %s on socket %d",
4741       csp->ip_addr_str, csp->cfd);
4742
4743    do
4744    {
4745       unsigned int latency;
4746
4747 #ifdef FEATURE_HTTPS_INSPECTION
4748       if (continue_chatting && client_use_ssl(csp))
4749       {
4750          continue_https_chat(csp);
4751       }
4752       else
4753 #endif
4754       {
4755          chat(csp);
4756       }
4757
4758       /*
4759        * If the request has been crunched,
4760        * the calculated latency is zero.
4761        */
4762       latency = (unsigned)(csp->server_connection.response_received -
4763          csp->server_connection.request_sent) / 2;
4764
4765       if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4766          && (csp->flags & CSP_FLAG_CRUNCHED)
4767          && (csp->expected_client_content_length != 0))
4768       {
4769          csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
4770          log_error(LOG_LEVEL_CONNECT,
4771             "Tainting client socket %d due to unread data.", csp->cfd);
4772       }
4773
4774       continue_chatting = (csp->config->feature_flags
4775          & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
4776          && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
4777          && (csp->cfd != JB_INVALID_SOCKET)
4778          && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4779          && ((csp->flags & CSP_FLAG_SERVER_CONTENT_LENGTH_SET)
4780             || (csp->flags & CSP_FLAG_CHUNKED));
4781
4782       if (!(csp->flags & CSP_FLAG_CRUNCHED)
4783          && (csp->server_connection.sfd != JB_INVALID_SOCKET))
4784       {
4785          if (!(csp->flags & CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET))
4786          {
4787             csp->server_connection.keep_alive_timeout = csp->config->default_server_timeout;
4788          }
4789          if (!(csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
4790             || (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
4791             || !socket_is_still_alive(csp->server_connection.sfd)
4792             || !(latency < csp->server_connection.keep_alive_timeout))
4793          {
4794             log_error(LOG_LEVEL_CONNECT,
4795                "Closing server socket %d connected to %s. "
4796                "Keep-alive: %u. Tainted: %u. Socket alive: %u. Timeout: %u.",
4797                csp->server_connection.sfd, csp->server_connection.host,
4798                0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
4799                0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
4800                socket_is_still_alive(csp->server_connection.sfd),
4801                csp->server_connection.keep_alive_timeout);
4802 #ifdef FEATURE_CONNECTION_SHARING
4803             if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4804             {
4805                forget_connection(csp->server_connection.sfd);
4806             }
4807 #endif /* def FEATURE_CONNECTION_SHARING */
4808 #ifdef FEATURE_HTTPS_INSPECTION
4809             close_server_ssl_connection(csp);
4810 #endif
4811             close_socket(csp->server_connection.sfd);
4812             mark_connection_closed(&csp->server_connection);
4813          }
4814       }
4815
4816       if (continue_chatting && any_loaded_file_changed(csp))
4817       {
4818          continue_chatting = 0;
4819          config_file_change_detected = 1;
4820       }
4821 #ifdef FEATURE_HTTPS_INSPECTION
4822       if (continue_chatting && client_use_ssl(csp) &&
4823          csp->ssl_with_client_is_opened == 0)
4824       {
4825          continue_chatting = 0;
4826          log_error(LOG_LEVEL_CONNECT, "Client socket %d is no longer usable. "
4827             "The TLS session has been terminated.", csp->cfd);
4828       }
4829 #endif
4830
4831       if (continue_chatting)
4832       {
4833          if (((csp->flags & CSP_FLAG_PIPELINED_REQUEST_WAITING) != 0)
4834             && socket_is_still_alive(csp->cfd))
4835          {
4836             log_error(LOG_LEVEL_CONNECT, "Client request %d has been "
4837                "pipelined on socket %d and the socket is still alive.",
4838                csp->requests_received_total+1, csp->cfd);
4839             prepare_csp_for_next_request(csp);
4840             continue;
4841          }
4842
4843          if (0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
4844          {
4845             if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4846             {
4847                log_error(LOG_LEVEL_CONNECT,
4848                   "Waiting for the next client request on socket %d. "
4849                   "Keeping the server socket %d to %s open.",
4850                   csp->cfd, csp->server_connection.sfd, csp->server_connection.host);
4851             }
4852             else
4853             {
4854                log_error(LOG_LEVEL_CONNECT,
4855                   "Waiting for the next client request on socket %d. "
4856                   "No server socket to keep open.", csp->cfd);
4857             }
4858          }
4859
4860          if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
4861             && data_is_available(csp->cfd, (int)csp->config->keep_alive_timeout)
4862             && socket_is_still_alive(csp->cfd))
4863          {
4864             log_error(LOG_LEVEL_CONNECT,
4865                "Data arrived in time on client socket %d. Requests so far: %u",
4866                csp->cfd, csp->requests_received_total);
4867             prepare_csp_for_next_request(csp);
4868          }
4869          else
4870          {
4871 #ifdef FEATURE_CONNECTION_SHARING
4872             if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4873                && (csp->server_connection.sfd != JB_INVALID_SOCKET)
4874                && (socket_is_still_alive(csp->server_connection.sfd))
4875 #ifdef FEATURE_HTTPS_INSPECTION
4876                && !server_use_ssl(csp)
4877 #endif
4878                 )
4879             {
4880                time_t time_open = time(NULL) - csp->server_connection.timestamp;
4881
4882                if (csp->server_connection.keep_alive_timeout < time_open - (time_t)latency)
4883                {
4884                   break;
4885                }
4886
4887                remember_connection(&csp->server_connection);
4888                csp->server_connection.sfd = JB_INVALID_SOCKET;
4889                drain_and_close_socket(csp->cfd);
4890                csp->cfd = JB_INVALID_SOCKET;
4891                privoxy_mutex_lock(&connection_reuse_mutex);
4892                if (!monitor_thread_running)
4893                {
4894                   monitor_thread_running = 1;
4895                   privoxy_mutex_unlock(&connection_reuse_mutex);
4896                   wait_for_alive_connections();
4897                   privoxy_mutex_lock(&connection_reuse_mutex);
4898                   monitor_thread_running = 0;
4899                }
4900                privoxy_mutex_unlock(&connection_reuse_mutex);
4901             }
4902 #endif /* def FEATURE_CONNECTION_SHARING */
4903             break;
4904          }
4905       }
4906       else if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4907       {
4908          log_error(LOG_LEVEL_CONNECT,
4909             "Closing server socket %d connected to %s. Keep-alive: %u. "
4910             "Tainted: %u. Socket alive: %u. Timeout: %u. "
4911             "Configuration file change detected: %u",
4912             csp->server_connection.sfd, csp->server_connection.host,
4913             0 != (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE),
4914             0 != (csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED),
4915             socket_is_still_alive(csp->server_connection.sfd),
4916             csp->server_connection.keep_alive_timeout,
4917             config_file_change_detected);
4918       }
4919    } while (continue_chatting);
4920
4921 #else
4922    chat(csp);
4923 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
4924
4925    if (csp->cfd != JB_INVALID_SOCKET)
4926    {
4927       log_error(LOG_LEVEL_CONNECT, "Closing client socket %d. "
4928          "Keep-alive: %u. Socket alive: %u. Data available: %u. "
4929          "Configuration file change detected: %u. Requests received: %u.",
4930          csp->cfd, 0 != (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE),
4931          socket_is_still_alive(csp->cfd), data_is_available(csp->cfd, 0),
4932          config_file_change_detected, csp->requests_received_total);
4933 #ifdef FEATURE_HTTPS_INSPECTION
4934       close_client_ssl_connection(csp);
4935 #endif
4936       drain_and_close_socket(csp->cfd);
4937    }
4938
4939    if (csp->server_connection.sfd != JB_INVALID_SOCKET)
4940    {
4941 #ifdef FEATURE_CONNECTION_SHARING
4942       if (csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
4943       {
4944          forget_connection(csp->server_connection.sfd);
4945       }
4946 #endif /* def FEATURE_CONNECTION_SHARING */
4947
4948 #ifdef FEATURE_HTTPS_INSPECTION
4949       close_server_ssl_connection(csp);
4950 #endif /* def FEATURE_HTTPS_INSPECTION */
4951
4952       close_socket(csp->server_connection.sfd);
4953    }
4954
4955 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4956    mark_connection_closed(&csp->server_connection);
4957 #endif
4958
4959    free_csp_resources(csp);
4960
4961    csp->flags &= ~CSP_FLAG_ACTIVE;
4962
4963 }
4964
4965
4966 #ifdef __BEOS__
4967 /*********************************************************************
4968  *
4969  * Function    :  server_thread
4970  *
4971  * Description :  We only exist to call `serve' in a threaded environment.
4972  *
4973  * Parameters  :
4974  *          1  :  data = Current client state (buffers, headers, etc...)
4975  *
4976  * Returns     :  Always 0.
4977  *
4978  *********************************************************************/
4979 static int32 server_thread(void *data)
4980 {
4981    serve((struct client_state *) data);
4982    return 0;
4983
4984 }
4985 #endif
4986
4987
4988 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
4989 /*********************************************************************
4990  *
4991  * Function    :  usage
4992  *
4993  * Description :  Print usage info & exit.
4994  *
4995  * Parameters  :  Pointer to argv[0] for identifying ourselves
4996  *
4997  * Returns     :  No. ,-)
4998  *
4999  *********************************************************************/
5000 static void usage(const char *name)
5001 {
5002    printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
5003           "Usage: %s [--config-test] "
5004 #if defined(unix)
5005           "[--chroot] "
5006 #endif /* defined(unix) */
5007           "[--help] "
5008 #if defined(unix)
5009           "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
5010 #endif /* defined(unix) */
5011          "[--version] [configfile]\n",
5012           name);
5013
5014 #ifdef FUZZ
5015    show_fuzz_usage(name);
5016 #endif
5017
5018    printf("Aborting\n");
5019
5020    exit(2);
5021
5022 }
5023 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
5024
5025
5026 #ifdef MUTEX_LOCKS_AVAILABLE
5027 /*********************************************************************
5028  *
5029  * Function    :  privoxy_mutex_lock
5030  *
5031  * Description :  Locks a mutex.
5032  *
5033  * Parameters  :
5034  *          1  :  mutex = The mutex to lock.
5035  *
5036  * Returns     :  Void. May exit in case of errors.
5037  *
5038  *********************************************************************/
5039 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
5040 {
5041 #ifdef FEATURE_PTHREAD
5042    int err = pthread_mutex_lock(mutex);
5043    if (err)
5044    {
5045       if (mutex != &log_mutex)
5046       {
5047          log_error(LOG_LEVEL_FATAL,
5048             "Mutex locking failed: %s.\n", strerror(err));
5049       }
5050       exit(1);
5051    }
5052 #else
5053    EnterCriticalSection(mutex);
5054 #endif /* def FEATURE_PTHREAD */
5055 }
5056
5057
5058 /*********************************************************************
5059  *
5060  * Function    :  privoxy_mutex_unlock
5061  *
5062  * Description :  Unlocks a mutex.
5063  *
5064  * Parameters  :
5065  *          1  :  mutex = The mutex to unlock.
5066  *
5067  * Returns     :  Void. May exit in case of errors.
5068  *
5069  *********************************************************************/
5070 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
5071 {
5072 #ifdef FEATURE_PTHREAD
5073    int err = pthread_mutex_unlock(mutex);
5074    if (err)
5075    {
5076       if (mutex != &log_mutex)
5077       {
5078          log_error(LOG_LEVEL_FATAL,
5079             "Mutex unlocking failed: %s.\n", strerror(err));
5080       }
5081       exit(1);
5082    }
5083 #else
5084    LeaveCriticalSection(mutex);
5085 #endif /* def FEATURE_PTHREAD */
5086 }
5087
5088
5089 /*********************************************************************
5090  *
5091  * Function    :  privoxy_mutex_init
5092  *
5093  * Description :  Prepares a mutex.
5094  *
5095  * Parameters  :
5096  *          1  :  mutex = The mutex to initialize.
5097  *
5098  * Returns     :  Void. May exit in case of errors.
5099  *
5100  *********************************************************************/
5101 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
5102 {
5103 #ifdef FEATURE_PTHREAD
5104    int err = pthread_mutex_init(mutex, 0);
5105    if (err)
5106    {
5107       printf("Fatal error. Mutex initialization failed: %s.\n",
5108          strerror(err));
5109       exit(1);
5110    }
5111 #else
5112    InitializeCriticalSection(mutex);
5113 #endif /* def FEATURE_PTHREAD */
5114 }
5115 #endif /* def MUTEX_LOCKS_AVAILABLE */
5116
5117 /*********************************************************************
5118  *
5119  * Function    :  initialize_mutexes
5120  *
5121  * Description :  Prepares mutexes if mutex support is available.
5122  *
5123  * Parameters  :  None
5124  *
5125  * Returns     :  Void, exits in case of errors.
5126  *
5127  *********************************************************************/
5128 static void initialize_mutexes(void)
5129 {
5130 #ifdef MUTEX_LOCKS_AVAILABLE
5131    /*
5132     * Prepare global mutex semaphores
5133     */
5134
5135 #ifdef FEATURE_HTTPS_INSPECTION
5136    privoxy_mutex_init(&certificate_mutex);
5137    privoxy_mutex_init(&ssl_init_mutex);
5138 #endif
5139
5140    privoxy_mutex_init(&log_mutex);
5141    privoxy_mutex_init(&log_init_mutex);
5142    privoxy_mutex_init(&connection_reuse_mutex);
5143 #ifdef FEATURE_EXTERNAL_FILTERS
5144    privoxy_mutex_init(&external_filter_mutex);
5145 #endif
5146 #ifdef FEATURE_CLIENT_TAGS
5147    privoxy_mutex_init(&client_tags_mutex);
5148 #endif
5149 #ifdef FEATURE_EXTENDED_STATISTICS
5150    privoxy_mutex_init(&filter_statistics_mutex);
5151    privoxy_mutex_init(&block_statistics_mutex);
5152 #endif
5153
5154    /*
5155     * XXX: The assumptions below are a bit naive
5156     * and can cause locks that aren't necessary.
5157     *
5158     * For example older FreeBSD versions (< 6.x?)
5159     * have no gethostbyname_r, but gethostbyname is
5160     * thread safe.
5161     */
5162 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
5163    privoxy_mutex_init(&resolver_mutex);
5164 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
5165    /*
5166     * XXX: should we use a single mutex for
5167     * localtime() and gmtime() as well?
5168     */
5169 #ifndef HAVE_GMTIME_R
5170    privoxy_mutex_init(&gmtime_mutex);
5171 #endif /* ndef HAVE_GMTIME_R */
5172
5173 #ifndef HAVE_LOCALTIME_R
5174    privoxy_mutex_init(&localtime_mutex);
5175 #endif /* ndef HAVE_GMTIME_R */
5176
5177 #if !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM)
5178    privoxy_mutex_init(&rand_mutex);
5179 #endif /* !defined(HAVE_ARC4RANDOM) && !defined(HAVE_RANDOM) */
5180
5181 #endif /* def MUTEX_LOCKS_AVAILABLE */
5182 }
5183
5184 /*********************************************************************
5185  *
5186  * Function    :  main
5187  *
5188  * Description :  Load the config file and start the listen loop.
5189  *                This function is a lot more *sane* with the `load_config'
5190  *                and `listen_loop' functions; although it stills does
5191  *                a *little* too much for my taste.
5192  *
5193  * Parameters  :
5194  *          1  :  argc = Number of parameters (including $0).
5195  *          2  :  argv = Array of (char *)'s to the parameters.
5196  *
5197  * Returns     :  1 if : can't open config file, unrecognized directive,
5198  *                stats requested in multi-thread mode, can't open the
5199  *                log file, can't open the jar file, listen port is invalid,
5200  *                any load fails, and can't bind port.
5201  *
5202  *                Else main never returns, the process must be signaled
5203  *                to terminate execution.  Or, on Windows, use the
5204  *                "File", "Exit" menu option.
5205  *
5206  *********************************************************************/
5207 #ifdef __MINGW32__
5208 int real_main(int argc, char **argv)
5209 #else
5210 int main(int argc, char **argv)
5211 #endif
5212 {
5213    int argc_pos = 0;
5214    int do_config_test = 0;
5215 #ifndef HAVE_ARC4RANDOM
5216    unsigned int random_seed;
5217 #endif
5218 #ifdef unix
5219    struct passwd *pw = NULL;
5220    struct group *grp = NULL;
5221    int do_chroot = 0;
5222    char *pre_chroot_nslookup_to_load_resolver = NULL;
5223 #endif
5224 #ifdef FUZZ
5225    char *fuzz_input_type = NULL;
5226    char *fuzz_input_file = NULL;
5227 #endif
5228
5229    Argc = argc;
5230    Argv = argv;
5231
5232    configfile =
5233 #if !defined(_WIN32)
5234    "config"
5235 #else
5236    "config.txt"
5237 #endif
5238       ;
5239
5240    /* Prepare mutexes if supported and necessary. */
5241    initialize_mutexes();
5242
5243    /* Enable logging until further notice. */
5244    init_log_module();
5245
5246    /*
5247     * Parse the command line arguments
5248     *
5249     * XXX: simply printing usage information in case of
5250     * invalid arguments isn't particularly user friendly.
5251     */
5252    while (++argc_pos < argc)
5253    {
5254 #ifdef _WIN32
5255       /* Check to see if the service must be installed or uninstalled */
5256       if (strncmp(argv[argc_pos], "--install", 9) == 0)
5257       {
5258          const char *pName = argv[argc_pos] + 9;
5259          if (*pName == ':')
5260             pName++;
5261          exit((install_service(pName)) ? 0 : 1);
5262       }
5263       else if (strncmp(argv[argc_pos], "--uninstall", 11) == 0)
5264       {
5265          const char *pName = argv[argc_pos] + 11;
5266          if (*pName == ':')
5267             pName++;
5268          exit((uninstall_service(pName)) ? 0 : 1);
5269       }
5270       else if (strcmp(argv[argc_pos], "--service") == 0)
5271       {
5272          bRunAsService = TRUE;
5273          w32_set_service_cwd();
5274          atexit(w32_service_exit_notify);
5275       }
5276       else
5277 #endif /* defined(_WIN32) */
5278
5279
5280 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
5281
5282       if (strcmp(argv[argc_pos], "--help") == 0)
5283       {
5284          usage(argv[0]);
5285       }
5286
5287       else if (strcmp(argv[argc_pos], "--version") == 0)
5288       {
5289          printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
5290          exit(0);
5291       }
5292
5293 #if defined(unix)
5294
5295       else if (strcmp(argv[argc_pos], "--no-daemon") == 0)
5296       {
5297          set_debug_level(LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
5298          daemon_mode = 0;
5299       }
5300
5301       else if (strcmp(argv[argc_pos], "--pidfile") == 0)
5302       {
5303          if (++argc_pos == argc) usage(argv[0]);
5304          pidfile = strdup_or_die(argv[argc_pos]);
5305       }
5306
5307       else if (strcmp(argv[argc_pos], "--user") == 0)
5308       {
5309          char *user_arg;
5310          char *group_name;
5311
5312          if (++argc_pos == argc) usage(argv[argc_pos]);
5313
5314          user_arg = strdup_or_die(argv[argc_pos]);
5315          group_name = strchr(user_arg, '.');
5316          if (NULL != group_name)
5317          {
5318             /* Nul-terminate the user name */
5319             *group_name = '\0';
5320
5321             /* Skip the former delimiter to actually reach the group name */
5322             group_name++;
5323
5324             grp = getgrnam(group_name);
5325             if (NULL == grp)
5326             {
5327                log_error(LOG_LEVEL_FATAL, "Group '%s' not found.", group_name);
5328             }
5329          }
5330          pw = getpwnam(user_arg);
5331          if (NULL == pw)
5332          {
5333             log_error(LOG_LEVEL_FATAL, "User '%s' not found.", user_arg);
5334          }
5335
5336          freez(user_arg);
5337       }
5338
5339       else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup") == 0)
5340       {
5341          if (++argc_pos == argc) usage(argv[0]);
5342          pre_chroot_nslookup_to_load_resolver = strdup_or_die(argv[argc_pos]);
5343       }
5344
5345       else if (strcmp(argv[argc_pos], "--chroot") == 0)
5346       {
5347          do_chroot = 1;
5348       }
5349 #endif /* defined(unix) */
5350
5351       else if (strcmp(argv[argc_pos], "--config-test") == 0)
5352       {
5353          do_config_test = 1;
5354       }
5355 #ifdef FUZZ
5356       else if (strcmp(argv[argc_pos], "--fuzz") == 0)
5357       {
5358          argc_pos++;
5359          if (argc < argc_pos + 2) usage(argv[0]);
5360          fuzz_input_type = argv[argc_pos];
5361          argc_pos++;
5362          fuzz_input_file = argv[argc_pos];
5363       }
5364       else if (strcmp(argv[argc_pos], "--stfu") == 0)
5365       {
5366          set_debug_level(LOG_LEVEL_STFU);
5367       }
5368 #endif
5369       else if (argc_pos + 1 != argc)
5370       {
5371          /*
5372           * This is neither the last command line
5373           * option, nor was it recognized before,
5374           * therefore it must be invalid.
5375           */
5376          usage(argv[0]);
5377       }
5378       else
5379
5380 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
5381       {
5382          configfile = argv[argc_pos];
5383       }
5384
5385    } /* -END- while (more arguments) */
5386
5387    show_version(Argv[0]);
5388
5389 #if defined(unix)
5390    if (*configfile != '/')
5391    {
5392       char cwd[BUFFER_SIZE];
5393       char *abs_file;
5394       size_t abs_file_size;
5395
5396       /* make config-filename absolute here */
5397       if (NULL == getcwd(cwd, sizeof(cwd)))
5398       {
5399          perror("failed to get current working directory");
5400          exit(1);
5401       }
5402
5403       basedir = strdup_or_die(cwd);
5404       /* XXX: why + 5? */
5405       abs_file_size = strlen(cwd) + strlen(configfile) + 5;
5406       abs_file = malloc_or_die(abs_file_size);
5407       strlcpy(abs_file, basedir, abs_file_size);
5408       strlcat(abs_file, "/", abs_file_size);
5409       strlcat(abs_file, configfile, abs_file_size);
5410       configfile = abs_file;
5411    }
5412 #endif /* defined unix */
5413
5414
5415    files->next = NULL;
5416    clients->next = NULL;
5417
5418    /* XXX: factor out initialising after the next stable release. */
5419 #ifdef _WIN32
5420    InitWin32();
5421 #endif
5422
5423 #ifndef HAVE_ARC4RANDOM
5424    random_seed = (unsigned int)time(NULL);
5425 #ifdef HAVE_RANDOM
5426    srandom(random_seed);
5427 #else
5428    srand(random_seed);
5429 #endif /* ifdef HAVE_RANDOM */
5430 #endif /* ifndef HAVE_ARC4RANDOM */
5431
5432    /*
5433     * Unix signal handling
5434     *
5435     * Catch the abort, interrupt and terminate signals for a graceful exit
5436     * Catch the hangup signal so the errlog can be reopened.
5437     *
5438     * Ignore the broken pipe signal as connection failures
5439     * are handled when and where they occur without relying
5440     * on a signal.
5441     */
5442 #if !defined(_WIN32)
5443 {
5444    int idx;
5445    const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP };
5446
5447    for (idx = 0; idx < SZ(catched_signals); idx++)
5448    {
5449 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
5450       if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
5451 #else
5452       if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
5453 #endif /* ifdef sun */
5454       {
5455          log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
5456       }
5457    }
5458
5459    if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
5460    {
5461       log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for SIGPIPE: %E");
5462    }
5463
5464 }
5465 #else /* ifdef _WIN32 */
5466 # ifdef _WIN_CONSOLE
5467    /*
5468     * We *are* in a windows console app.
5469     * Print a verbose messages about FAQ's and such
5470     */
5471    printf("%s", win32_blurb);
5472 # endif /* def _WIN_CONSOLE */
5473 #endif /* def _WIN32 */
5474
5475 #ifdef FUZZ
5476    if (fuzz_input_type != NULL)
5477    {
5478       exit(process_fuzzed_input(fuzz_input_type, fuzz_input_file));
5479    }
5480    log_error(LOG_LEVEL_FATAL,
5481       "When compiled with fuzzing support, Privoxy should only be used for fuzzing. "
5482       "Various data structures are static which is unsafe when using threads.");
5483 #endif
5484
5485    if (do_config_test)
5486    {
5487       exit(NULL == load_config());
5488    }
5489
5490    /* Initialize the CGI subsystem */
5491    cgi_init_error_messages();
5492
5493    /*
5494     * If running on unix and without the --no-daemon
5495     * option, become a daemon. I.e. fork, detach
5496     * from tty and get process group leadership
5497     */
5498 #if defined(unix)
5499 {
5500    if (daemon_mode)
5501    {
5502       int fd;
5503       pid_t pid = fork();
5504
5505       if (pid < 0) /* error */
5506       {
5507          perror("fork");
5508          exit(3);
5509       }
5510       else if (pid != 0) /* parent */
5511       {
5512          int status;
5513          pid_t wpid;
5514          /*
5515           * must check for errors
5516           * child died due to missing files aso
5517           */
5518          sleep(1);
5519          wpid = waitpid(pid, &status, WNOHANG);
5520          if (wpid != 0)
5521          {
5522             exit(1);
5523          }
5524          exit(0);
5525       }
5526       /* child */
5527
5528       setsid();
5529
5530       /*
5531        * stderr (fd 2) will be closed later on,
5532        * when the config file has been parsed.
5533        */
5534       close(0);
5535       close(1);
5536
5537       /*
5538        * Reserve fd 0 and 1 to prevent abort() and friends
5539        * from sending stuff to the clients or servers.
5540        */
5541       fd = open("/dev/null", O_RDONLY);
5542       if (fd == -1)
5543       {
5544          log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
5545       }
5546       else if (fd != 0)
5547       {
5548          if (dup2(fd, 0) == -1)
5549          {
5550             log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 0: %E");
5551          }
5552          close(fd);
5553       }
5554       fd = open("/dev/null", O_WRONLY);
5555       if (fd == -1)
5556       {
5557          log_error(LOG_LEVEL_FATAL, "Failed to open /dev/null: %E");
5558       }
5559       else if (fd != 1)
5560       {
5561          if (dup2(fd, 1) == -1)
5562          {
5563             log_error(LOG_LEVEL_FATAL, "Failed to reserve fd 1: %E");
5564          }
5565          close(fd);
5566       }
5567
5568 #ifdef FEATURE_EXTERNAL_FILTERS
5569       for (fd = 0; fd < 3; fd++)
5570       {
5571          mark_socket_for_close_on_execute(fd);
5572       }
5573 #endif
5574
5575       if (chdir("/") != 0)
5576       {
5577          log_error(LOG_LEVEL_FATAL, "Failed to cd into '/': %E");
5578       }
5579
5580    } /* -END- if (daemon_mode) */
5581
5582    /*
5583     * As soon as we have written the PID file, we can switch
5584     * to the user and group ID indicated by the --user option
5585     */
5586    if (pidfile != NULL)
5587    {
5588       write_pid_file(pidfile);
5589    }
5590    if (NULL != pw)
5591    {
5592       if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
5593       {
5594          log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
5595       }
5596       if (NULL != grp)
5597       {
5598          if (setgroups(1, &grp->gr_gid))
5599          {
5600             log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
5601          }
5602       }
5603       else if (initgroups(pw->pw_name, pw->pw_gid))
5604       {
5605          log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
5606       }
5607       if (do_chroot)
5608       {
5609          if (!pw->pw_dir)
5610          {
5611             log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
5612          }
5613          /* Read the time zone file from /etc before doing chroot. */
5614          tzset();
5615          if (NULL != pre_chroot_nslookup_to_load_resolver
5616              && '\0' != pre_chroot_nslookup_to_load_resolver[0])
5617          {
5618             /* Initialize resolver library. */
5619             (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
5620          }
5621          if (chroot(pw->pw_dir) < 0)
5622          {
5623             log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
5624          }
5625          if (chdir ("/"))
5626          {
5627             log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
5628          }
5629       }
5630       if (setuid(pw->pw_uid))
5631       {
5632          log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
5633       }
5634       if (do_chroot)
5635       {
5636          char putenv_dummy[64];
5637
5638          strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
5639          if (putenv(putenv_dummy) != 0)
5640          {
5641             log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
5642          }
5643
5644          snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
5645          if (putenv(putenv_dummy) != 0)
5646          {
5647             log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
5648          }
5649       }
5650    }
5651    else if (do_chroot)
5652    {
5653       log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
5654    }
5655 }
5656 #endif /* defined unix */
5657
5658 #ifdef _WIN32
5659    /* This will be FALSE unless the command line specified --service
5660     */
5661    if (bRunAsService)
5662    {
5663       /* Yup, so now we must attempt to establish a connection
5664        * with the service dispatcher. This will only work if this
5665        * process was launched by the service control manager to
5666        * actually run as a service. If this isn't the case, i've
5667        * known it take around 30 seconds or so for the call to return.
5668        */
5669
5670       /* The StartServiceCtrlDispatcher won't return until the service is stopping */
5671       if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
5672       {
5673          /* Service has run, and at this point is now being stopped, so just return */
5674          return 0;
5675       }
5676
5677 #ifdef _WIN_CONSOLE
5678       printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
5679 #endif
5680       /* An error occurred. Usually it's because --service was wrongly specified
5681        * and we were unable to connect to the Service Control Dispatcher because
5682        * it wasn't expecting us and is therefore not listening.
5683        *
5684        * For now, just continue below to call the listen_loop function.
5685        */
5686    }
5687 #endif /* def _WIN32 */
5688
5689    listen_loop();
5690
5691    /* NOTREACHED */
5692    return(-1);
5693
5694 }
5695
5696
5697 /*********************************************************************
5698  *
5699  * Function    :  bind_port_helper
5700  *
5701  * Description :  Bind the listen port.  Handles logging, and aborts
5702  *                on failure.
5703  *
5704  * Parameters  :
5705  *          1  :  haddr = Host address to bind to. Use NULL to bind to
5706  *                        INADDR_ANY.
5707  *          2  :  hport = Specifies port to bind to.
5708  *          3  :  backlog = Listen backlog.
5709  *
5710  * Returns     :  Port that was opened.
5711  *
5712  *********************************************************************/
5713 static jb_socket bind_port_helper(const char *haddr, int hport, int backlog)
5714 {
5715    int result;
5716    jb_socket bfd;
5717
5718    result = bind_port(haddr, hport, backlog, &bfd);
5719
5720    if (result < 0)
5721    {
5722       const char *bind_address = (NULL != haddr) ? haddr : "INADDR_ANY";
5723       switch(result)
5724       {
5725          case -3:
5726             log_error(LOG_LEVEL_FATAL,
5727                "can't bind to %s:%d: There may be another Privoxy "
5728                "or some other proxy running on port %d",
5729                bind_address, hport, hport);
5730
5731          case -2:
5732             log_error(LOG_LEVEL_FATAL,
5733                "can't bind to %s:%d: The hostname is not resolvable",
5734                bind_address, hport);
5735
5736          default:
5737             log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: %E",
5738                bind_address, hport);
5739       }
5740
5741       /* shouldn't get here */
5742       return JB_INVALID_SOCKET;
5743    }
5744
5745 #ifndef HAVE_POLL
5746 #ifndef _WIN32
5747    if (bfd >= FD_SETSIZE)
5748    {
5749       log_error(LOG_LEVEL_FATAL,
5750          "Bind socket number too high to use select(): %d >= %d",
5751          bfd, FD_SETSIZE);
5752    }
5753 #endif
5754 #endif
5755
5756    if (haddr == NULL)
5757    {
5758       log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
5759          hport);
5760    }
5761    else
5762    {
5763       log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
5764          hport, haddr);
5765    }
5766
5767    return bfd;
5768 }
5769
5770
5771 /*********************************************************************
5772  *
5773  * Function    :  bind_ports_helper
5774  *
5775  * Description :  Bind the listen ports.  Handles logging, and aborts
5776  *                on failure.
5777  *
5778  * Parameters  :
5779  *          1  :  config = Privoxy configuration.  Specifies ports
5780  *                         to bind to.
5781  *          2  :  sockets = Preallocated array of opened sockets
5782  *                          corresponding to specification in config.
5783  *                          All non-opened sockets will be set to
5784  *                          JB_INVALID_SOCKET.
5785  *
5786  * Returns     :  Nothing. Inspect sockets argument.
5787  *
5788  *********************************************************************/
5789 static void bind_ports_helper(struct configuration_spec * config,
5790                               jb_socket sockets[])
5791 {
5792    int i;
5793
5794    for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
5795    {
5796       if (config->hport[i])
5797       {
5798          sockets[i] = bind_port_helper(config->haddr[i],
5799             config->hport[i], config->listen_backlog);
5800 #if defined(FEATURE_ACCEPT_FILTER) && defined(SO_ACCEPTFILTER)
5801          if (config->enable_accept_filter && sockets[i] != JB_INVALID_SOCKET)
5802          {
5803             struct accept_filter_arg af_options;
5804             bzero(&af_options, sizeof(af_options));
5805             strlcpy(af_options.af_name, "httpready", sizeof(af_options.af_name));
5806             if (setsockopt(sockets[i], SOL_SOCKET, SO_ACCEPTFILTER, &af_options,
5807                   sizeof(af_options)))
5808             {
5809                log_error(LOG_LEVEL_ERROR,
5810                   "Enabling accept filter for socket %d failed: %E", sockets[i]);
5811             }
5812          }
5813 #endif
5814       }
5815       else
5816       {
5817          sockets[i] = JB_INVALID_SOCKET;
5818       }
5819    }
5820    config->need_bind = 0;
5821 }
5822
5823
5824 /*********************************************************************
5825  *
5826  * Function    :  close_ports_helper
5827  *
5828  * Description :  Close listenings ports.
5829  *
5830  * Parameters  :
5831  *          1  :  sockets = Array of opened and non-opened sockets to
5832  *                          close. All sockets will be set to
5833  *                          JB_INVALID_SOCKET.
5834  *
5835  * Returns     :  Nothing.
5836  *
5837  *********************************************************************/
5838 static void close_ports_helper(jb_socket sockets[])
5839 {
5840    int i;
5841
5842    for (i = 0; i < MAX_LISTENING_SOCKETS; i++)
5843    {
5844       if (JB_INVALID_SOCKET != sockets[i])
5845       {
5846          close_socket(sockets[i]);
5847       }
5848       sockets[i] = JB_INVALID_SOCKET;
5849    }
5850 }
5851
5852
5853 #ifdef _WIN32
5854 /* Without this simple workaround we get this compiler warning from _beginthread
5855  *     warning C4028: formal parameter 1 different from declaration
5856  */
5857 void w32_service_listen_loop(void *p)
5858 {
5859    listen_loop();
5860 }
5861 #endif /* def _WIN32 */
5862
5863
5864 /*********************************************************************
5865  *
5866  * Function    :  listen_loop
5867  *
5868  * Description :  bind the listen port and enter a "FOREVER" listening loop.
5869  *
5870  * Parameters  :  N/A
5871  *
5872  * Returns     :  Never.
5873  *
5874  *********************************************************************/
5875 static void listen_loop(void)
5876 {
5877    struct client_states *csp_list = NULL;
5878    struct client_state *csp = NULL;
5879    jb_socket bfds[MAX_LISTENING_SOCKETS];
5880    struct configuration_spec *config;
5881    unsigned int active_threads = 0;
5882 #if defined(FEATURE_PTHREAD)
5883    pthread_attr_t attrs;
5884
5885    pthread_attr_init(&attrs);
5886    pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
5887 #endif
5888
5889    config = load_config();
5890
5891 #ifdef FEATURE_CONNECTION_SHARING
5892    /*
5893     * XXX: Should be relocated once it no
5894     * longer needs to emit log messages.
5895     */
5896    initialize_reusable_connections();
5897 #endif /* def FEATURE_CONNECTION_SHARING */
5898
5899    bind_ports_helper(config, bfds);
5900
5901 #ifdef FEATURE_GRACEFUL_TERMINATION
5902    while (!g_terminate)
5903 #else
5904    for (;;)
5905 #endif
5906    {
5907 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__)
5908       while (waitpid(-1, NULL, WNOHANG) > 0)
5909       {
5910          /* zombie children */
5911       }
5912 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) */
5913
5914       /*
5915        * Free data that was used by died threads
5916        */
5917       active_threads = sweep();
5918
5919 #if defined(unix)
5920       /*
5921        * Re-open the errlog after HUP signal
5922        */
5923       if (received_hup_signal)
5924       {
5925          if (NULL != config->logfile)
5926          {
5927             init_error_log(Argv[0], config->logfile);
5928          }
5929          received_hup_signal = 0;
5930       }
5931 #endif
5932
5933       csp_list = zalloc_or_die(sizeof(*csp_list));
5934       csp = &csp_list->csp;
5935
5936       log_error(LOG_LEVEL_CONNECT,
5937          "Waiting for the next client connection. Currently active threads: %u",
5938          active_threads);
5939
5940       /*
5941        * This config may be outdated, but for accept_connection()
5942        * it's fresh enough.
5943        */
5944       csp->config = config;
5945
5946       if (!accept_connection(csp, bfds))
5947       {
5948          log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
5949          freez(csp_list);
5950          continue;
5951       }
5952
5953       csp->flags |= CSP_FLAG_ACTIVE;
5954       csp->server_connection.sfd = JB_INVALID_SOCKET;
5955
5956       csp->config = config = load_config();
5957
5958       if (config->need_bind)
5959       {
5960          /*
5961           * Since we were listening to the "old port", we will not see
5962           * a "listen" param change until the next request.  So, at
5963           * least 1 more request must be made for us to find the new
5964           * setting.  I am simply closing the old socket and binding the
5965           * new one.
5966           *
5967           * Which-ever is correct, we will serve 1 more page via the
5968           * old settings.  This should probably be a "show-status"
5969           * request.  This should not be a so common of an operation
5970           * that this will hurt people's feelings.
5971           */
5972
5973          close_ports_helper(bfds);
5974
5975          bind_ports_helper(config, bfds);
5976       }
5977
5978 #ifdef FEATURE_TOGGLE
5979       if (global_toggle_state)
5980 #endif /* def FEATURE_TOGGLE */
5981       {
5982          csp->flags |= CSP_FLAG_TOGGLED_ON;
5983       }
5984
5985       if (run_loader(csp))
5986       {
5987          log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
5988          /* Never get here - LOG_LEVEL_FATAL causes program exit */
5989       }
5990
5991 #ifdef FEATURE_ACL
5992       if (block_acl(NULL,csp))
5993       {
5994          log_error(LOG_LEVEL_CONNECT,
5995             "Connection from %s on %s (socket %d) dropped due to ACL",
5996             csp->ip_addr_str, csp->listen_addr_str, csp->cfd);
5997          close_socket(csp->cfd);
5998          freez(csp->ip_addr_str);
5999          freez(csp->listen_addr_str);
6000          freez(csp_list);
6001          continue;
6002       }
6003 #endif /* def FEATURE_ACL */
6004
6005       if ((0 != config->max_client_connections)
6006          && (active_threads >= config->max_client_connections))
6007       {
6008          log_error(LOG_LEVEL_CONNECT,
6009             "Rejecting connection from %s. Maximum number of connections reached.",
6010             csp->ip_addr_str);
6011          write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
6012             strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
6013          close_socket(csp->cfd);
6014          freez(csp->ip_addr_str);
6015          freez(csp->listen_addr_str);
6016          freez(csp_list);
6017          continue;
6018       }
6019
6020       /* add it to the list of clients */
6021       csp_list->next = clients->next;
6022       clients->next = csp_list;
6023
6024       if (config->multi_threaded)
6025       {
6026          int child_id;
6027
6028 /* this is a switch () statement in the C preprocessor - ugh */
6029 #undef SELECTED_ONE_OPTION
6030
6031 /* Use Pthreads in preference to native code */
6032 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
6033 #define SELECTED_ONE_OPTION
6034          {
6035             pthread_t the_thread;
6036             int ret;
6037
6038             ret = pthread_create(&the_thread, &attrs,
6039                (void * (*)(void *))serve, csp);
6040             child_id = ret ? -1 : 0;
6041          }
6042 #endif
6043
6044 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
6045 #define SELECTED_ONE_OPTION
6046          child_id = _beginthread(
6047             (void (*)(void *))serve,
6048             64 * 1024,
6049             csp);
6050 #endif
6051
6052 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
6053 #define SELECTED_ONE_OPTION
6054          {
6055             thread_id tid = spawn_thread
6056                (server_thread, "server", B_NORMAL_PRIORITY, csp);
6057
6058             if ((tid >= 0) && (resume_thread(tid) == B_OK))
6059             {
6060                child_id = (int) tid;
6061             }
6062             else
6063             {
6064                child_id = -1;
6065             }
6066          }
6067 #endif
6068
6069 #if !defined(SELECTED_ONE_OPTION)
6070          child_id = fork();
6071
6072          /* This block is only needed when using fork().
6073           * When using threads, the server thread was
6074           * created and run by the call to _beginthread().
6075           */
6076          if (child_id == 0)   /* child */
6077          {
6078             int rc = 0;
6079 #ifdef FEATURE_TOGGLE
6080             int inherited_toggle_state = global_toggle_state;
6081 #endif /* def FEATURE_TOGGLE */
6082
6083             serve(csp);
6084
6085             /*
6086              * If we've been toggled or we've blocked the request, tell Mom
6087              */
6088
6089 #ifdef FEATURE_TOGGLE
6090             if (inherited_toggle_state != global_toggle_state)
6091             {
6092                rc |= RC_FLAG_TOGGLED;
6093             }
6094 #endif /* def FEATURE_TOGGLE */
6095
6096 #ifdef FEATURE_STATISTICS
6097             if (csp->flags & CSP_FLAG_REJECTED)
6098             {
6099                rc |= RC_FLAG_BLOCKED;
6100             }
6101 #endif /* ndef FEATURE_STATISTICS */
6102
6103             _exit(rc);
6104          }
6105          else if (child_id > 0) /* parent */
6106          {
6107             /* in a fork()'d environment, the parent's
6108              * copy of the client socket and the CSP
6109              * are not used.
6110              */
6111             int child_status;
6112 #if !defined(_WIN32) && !defined(__CYGWIN__)
6113
6114             wait(&child_status);
6115
6116             /*
6117              * Evaluate child's return code: If the child has
6118              *  - been toggled, toggle ourselves
6119              *  - blocked its request, bump up the stats counter
6120              */
6121
6122 #ifdef FEATURE_TOGGLE
6123             if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
6124             {
6125                global_toggle_state = !global_toggle_state;
6126             }
6127 #endif /* def FEATURE_TOGGLE */
6128
6129 #ifdef FEATURE_STATISTICS
6130             urls_read++;
6131             if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
6132             {
6133                urls_rejected++;
6134             }
6135 #endif /* def FEATURE_STATISTICS */
6136
6137 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
6138             close_socket(csp->cfd);
6139             csp->flags &= ~CSP_FLAG_ACTIVE;
6140          }
6141 #endif
6142
6143 #undef SELECTED_ONE_OPTION
6144 /* end of cpp switch () */
6145
6146          if (child_id < 0)
6147          {
6148             /*
6149              * Spawning the child failed, assume it's because
6150              * there are too many children running already.
6151              * XXX: If you assume ...
6152              */
6153             log_error(LOG_LEVEL_ERROR,
6154                "Unable to take any additional connections: %E. Active threads: %u",
6155                active_threads);
6156             write_socket_delayed(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
6157                strlen(TOO_MANY_CONNECTIONS_RESPONSE), get_write_delay(csp));
6158             close_socket(csp->cfd);
6159             csp->flags &= ~CSP_FLAG_ACTIVE;
6160          }
6161       }
6162       else
6163       {
6164          serve(csp);
6165       }
6166    }
6167
6168 #if defined(FEATURE_PTHREAD)
6169    pthread_attr_destroy(&attrs);
6170 #endif
6171
6172    /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
6173
6174 #ifdef FEATURE_HTTPS_INSPECTION
6175    /* Clean up.  Aim: free all memory (no leaks) */
6176    ssl_release();
6177 #endif
6178
6179 #ifdef FEATURE_GRACEFUL_TERMINATION
6180
6181    log_error(LOG_LEVEL_INFO, "Graceful termination requested");
6182
6183    unload_current_config_file();
6184    unload_current_actions_file();
6185    unload_current_re_filterfile();
6186 #ifdef FEATURE_TRUST
6187    unload_current_trust_file();
6188 #endif
6189
6190    if (config->multi_threaded)
6191    {
6192       int i = 60;
6193       do
6194       {
6195          sleep(1);
6196          sweep();
6197       } while ((clients->next != NULL) && (--i > 0));
6198
6199       if (i <= 0)
6200       {
6201          log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
6202       }
6203    }
6204    sweep();
6205    sweep();
6206
6207 #if defined(unix)
6208    freez(basedir);
6209 #endif
6210
6211 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
6212    /* Cleanup - remove taskbar icon etc. */
6213    TermLogWindow();
6214 #endif
6215
6216    exit(0);
6217 #endif /* FEATURE_GRACEFUL_TERMINATION */
6218
6219 }
6220
6221
6222 /*
6223   Local Variables:
6224   tab-width: 3
6225   end:
6226 */