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