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