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