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