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