jcc.c

   1 const char jcc_rcs[] = "$Id: jcc.c,v 1.268 2009/07/13 17:05:36 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-2009 the SourceForge
  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 <windows.h>
  54 #  include <process.h>
  55 # endif /* ndef FEATURE_PTHREAD */
  56
  57 # include "win32.h"
  58 # ifndef _WIN_CONSOLE
  59 #  include "w32log.h"
  60 # endif /* ndef _WIN_CONSOLE */
  61 # include "w32svrapi.h"
  62
  63 #else /* ifndef _WIN32 */
  64
  65 # if !defined (__OS2__)
  66 # include <unistd.h>
  67 # include <sys/wait.h>
  68 # endif /* ndef __OS2__ */
  69 # include <sys/time.h>
  70 # include <sys/stat.h>
  71 # include <sys/ioctl.h>
  72
  73 #ifdef sun
  74 #include <sys/termios.h>
  75 #endif /* sun */
  76
  77 #ifdef unix
  78 #include <pwd.h>
  79 #include <grp.h>
  80 #endif
  81
  82 # include <signal.h>
  83
  84 # ifdef __BEOS__
  85 #  include <socket.h>  /* BeOS has select() for sockets only. */
  86 #  include <OS.h>      /* declarations for threads and stuff. */
  87 # endif
  88
  89 # if defined(__EMX__) || defined(__OS2__)
  90 #  include <sys/select.h>  /* OS/2/EMX needs a little help with select */
  91 # endif
  92 # ifdef __OS2__
  93 #define INCL_DOS
  94 # include <os2.h>
  95 #define bzero(B,N) memset(B,0x00,n)
  96 # endif
  97
  98 # ifndef FD_ZERO
  99 #  include <select.h>
 100 # endif
 101
 102 #endif
 103
 104 #include "project.h"
 105 #include "list.h"
 106 #include "jcc.h"
 107 #include "filters.h"
 108 #include "loaders.h"
 109 #include "parsers.h"
 110 #include "miscutil.h"
 111 #include "errlog.h"
 112 #include "jbsockets.h"
 113 #include "gateway.h"
 114 #include "actions.h"
 115 #include "cgi.h"
 116 #include "loadcfg.h"
 117 #include "urlmatch.h"
 118
 119 const char jcc_h_rcs[] = JCC_H_VERSION;
 120 const char project_h_rcs[] = PROJECT_H_VERSION;
 121
 122 int no_daemon = 0;
 123 struct client_state  clients[1];
 124 struct file_list     files[1];
 125
 126 #ifdef FEATURE_STATISTICS
 127 int urls_read     = 0;     /* total nr of urls read inc rejected */
 128 int urls_rejected = 0;     /* total nr of urls rejected */
 129 #endif /* def FEATURE_STATISTICS */
 130
 131 #ifdef FEATURE_GRACEFUL_TERMINATION
 132 int g_terminate = 0;
 133 #endif
 134
 135 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
 136 static void sig_handler(int the_signal);
 137 #endif
 138 static int client_protocol_is_unsupported(const struct client_state *csp, char *req);
 139 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers);
 140 static jb_err get_server_headers(struct client_state *csp);
 141 static const char *crunch_reason(const struct http_response *rsp);
 142 static void send_crunch_response(const struct client_state *csp, struct http_response *rsp);
 143 static char *get_request_line(struct client_state *csp);
 144 static jb_err receive_client_request(struct client_state *csp);
 145 static jb_err parse_client_request(struct client_state *csp);
 146 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line);
 147 static jb_err change_request_destination(struct client_state *csp);
 148 static void chat(struct client_state *csp);
 149 static void serve(struct client_state *csp);
 150 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
 151 static void usage(const char *myname);
 152 #endif
 153 static void initialize_mutexes(void);
 154 static jb_socket bind_port_helper(struct configuration_spec *config);
 155 static void listen_loop(void);
 156
 157 #ifdef AMIGA
 158 void serve(struct client_state *csp);
 159 #else /* ifndef AMIGA */
 160 static void serve(struct client_state *csp);
 161 #endif /* def AMIGA */
 162
 163 #ifdef __BEOS__
 164 static int32 server_thread(void *data);
 165 #endif /* def __BEOS__ */
 166
 167 #ifdef _WIN32
 168 #define sleep(N)  Sleep(((N) * 1000))
 169 #endif
 170
 171 #ifdef __OS2__
 172 #define sleep(N)  DosSleep(((N) * 100))
 173 #endif
 174
 175 #ifdef MUTEX_LOCKS_AVAILABLE
 176 /*
 177  * XXX: Does the locking stuff really belong in this file?
 178  */
 179 privoxy_mutex_t log_mutex;
 180 privoxy_mutex_t log_init_mutex;
 181 privoxy_mutex_t connection_reuse_mutex;
 182
 183 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
 184 privoxy_mutex_t resolver_mutex;
 185 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
 186
 187 #ifndef HAVE_GMTIME_R
 188 privoxy_mutex_t gmtime_mutex;
 189 #endif /* ndef HAVE_GMTIME_R */
 190
 191 #ifndef HAVE_LOCALTIME_R
 192 privoxy_mutex_t localtime_mutex;
 193 #endif /* ndef HAVE_GMTIME_R */
 194
 195 #ifndef HAVE_RANDOM
 196 privoxy_mutex_t rand_mutex;
 197 #endif /* ndef HAVE_RANDOM */
 198
 199 #endif /* def MUTEX_LOCKS_AVAILABLE */
 200
 201 #if defined(unix)
 202 const char *basedir = NULL;
 203 const char *pidfile = NULL;
 204 static int received_hup_signal = 0;
 205 #endif /* defined unix */
 206
 207 /* HTTP snipplets. */
 208 static const char CSUCCEED[] =
 209    "HTTP/1.0 200 Connection established\r\n"
 210    "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
 211
 212 static const char CHEADER[] =
 213    "HTTP/1.0 400 Invalid header received from client\r\n"
 214    "Proxy-Agent: Privoxy " VERSION "\r\n"
 215    "Content-Type: text/plain\r\n"
 216    "Connection: close\r\n\r\n"
 217    "Invalid header received from client.\r\n";
 218
 219 static const char FTP_RESPONSE[] =
 220    "HTTP/1.0 400 Invalid request received from client\r\n"
 221    "Content-Type: text/plain\r\n"
 222    "Connection: close\r\n\r\n"
 223    "Invalid request. Privoxy doesn't support FTP.\r\n";
 224
 225 static const char GOPHER_RESPONSE[] =
 226    "HTTP/1.0 400 Invalid request received from client\r\n"
 227    "Content-Type: text/plain\r\n"
 228    "Connection: close\r\n\r\n"
 229    "Invalid request. Privoxy doesn't support gopher.\r\n";
 230
 231 /* XXX: should be a template */
 232 static const char MISSING_DESTINATION_RESPONSE[] =
 233    "HTTP/1.0 400 Bad request received from client\r\n"
 234    "Proxy-Agent: Privoxy " VERSION "\r\n"
 235    "Content-Type: text/plain\r\n"
 236    "Connection: close\r\n\r\n"
 237    "Bad request. Privoxy was unable to extract the destination.\r\n";
 238
 239 /* XXX: should be a template */
 240 static const char INVALID_SERVER_HEADERS_RESPONSE[] =
 241    "HTTP/1.0 502 Server or forwarder response invalid\r\n"
 242    "Proxy-Agent: Privoxy " VERSION "\r\n"
 243    "Content-Type: text/plain\r\n"
 244    "Connection: close\r\n\r\n"
 245    "Bad response. The server or forwarder response doesn't look like HTTP.\r\n";
 246
 247 #if 0
 248 /* XXX: should be a template */
 249 static const char NULL_BYTE_RESPONSE[] =
 250    "HTTP/1.0 400 Bad request received from client\r\n"
 251    "Proxy-Agent: Privoxy " VERSION "\r\n"
 252    "Content-Type: text/plain\r\n"
 253    "Connection: close\r\n\r\n"
 254    "Bad request. Null byte(s) before end of request.\r\n";
 255 #endif
 256
 257 /* XXX: should be a template */
 258 static const char MESSED_UP_REQUEST_RESPONSE[] =
 259    "HTTP/1.0 400 Malformed request after rewriting\r\n"
 260    "Proxy-Agent: Privoxy " VERSION "\r\n"
 261    "Content-Type: text/plain\r\n"
 262    "Connection: close\r\n\r\n"
 263    "Bad request. Messed up with header filters.\r\n";
 264
 265 static const char TOO_MANY_CONNECTIONS_RESPONSE[] =
 266    "HTTP/1.0 503 Too many open connections\r\n"
 267    "Proxy-Agent: Privoxy " VERSION "\r\n"
 268    "Content-Type: text/plain\r\n"
 269    "Connection: close\r\n\r\n"
 270    "Maximum number of open connections reached.\r\n";
 271
 272 static const char CLIENT_CONNECTION_TIMEOUT_RESPONSE[] =
 273    "HTTP/1.0 504 Connection timeout\r\n"
 274    "Proxy-Agent: Privoxy " VERSION "\r\n"
 275    "Content-Type: text/plain\r\n"
 276    "Connection: close\r\n\r\n"
 277    "The connection timed out because the client request didn't arrive in time.\r\n";
 278
 279 /* A function to crunch a response */
 280 typedef struct http_response *(*crunch_func_ptr)(struct client_state *);
 281
 282 /* Crunch function flags */
 283 #define CF_NO_FLAGS        0
 284 /* Cruncher applies to forced requests as well */
 285 #define CF_IGNORE_FORCE    1
 286 /* Crunched requests are counted for the block statistics */
 287 #define CF_COUNT_AS_REJECT 2
 288
 289 /* A crunch function and its flags */
 290 struct cruncher
 291 {
 292    const crunch_func_ptr cruncher;
 293    const int flags;
 294 };
 295
 296 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[]);
 297
 298 /* Complete list of cruncher functions */
 299 static const struct cruncher crunchers_all[] = {
 300    { direct_response, CF_COUNT_AS_REJECT|CF_IGNORE_FORCE},
 301    { block_url,       CF_COUNT_AS_REJECT },
 302 #ifdef FEATURE_TRUST
 303    { trust_url,       CF_COUNT_AS_REJECT },
 304 #endif /* def FEATURE_TRUST */
 305    { redirect_url,    CF_NO_FLAGS  },
 306    { dispatch_cgi,    CF_IGNORE_FORCE},
 307    { NULL,            0 }
 308 };
 309
 310 /* Light version, used after tags are applied */
 311 static const struct cruncher crunchers_light[] = {
 312    { block_url,       CF_COUNT_AS_REJECT },
 313    { redirect_url,    CF_NO_FLAGS },
 314    { NULL,            0 }
 315 };
 316
 317
 318 /*
 319  * XXX: Don't we really mean
 320  *
 321  * #if defined(unix)
 322  *
 323  * here?
 324  */
 325 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
 326 /*********************************************************************
 327  *
 328  * Function    :  sig_handler
 329  *
 330  * Description :  Signal handler for different signals.
 331  *                Exit gracefully on TERM and INT
 332  *                or set a flag that will cause the errlog
 333  *                to be reopened by the main thread on HUP.
 334  *
 335  * Parameters  :
 336  *          1  :  the_signal = the signal cause this function to call
 337  *
 338  * Returns     :  -
 339  *
 340  *********************************************************************/
 341 static void sig_handler(int the_signal)
 342 {
 343    switch(the_signal)
 344    {
 345       case SIGTERM:
 346       case SIGINT:
 347          log_error(LOG_LEVEL_INFO, "exiting by signal %d .. bye", the_signal);
 348 #if defined(unix)
 349          if(pidfile)
 350          {
 351             unlink(pidfile);
 352          }
 353 #endif /* unix */
 354          exit(the_signal);
 355          break;
 356
 357       case SIGHUP:
 358 #if defined(unix)
 359          received_hup_signal = 1;
 360 #endif
 361          break;
 362
 363       default:
 364          /*
 365           * We shouldn't be here, unless we catch signals
 366           * in main() that we can't handle here!
 367           */
 368          log_error(LOG_LEVEL_FATAL, "sig_handler: exiting on unexpected signal %d", the_signal);
 369    }
 370    return;
 371
 372 }
 373 #endif
 374
 375
 376 /*********************************************************************
 377  *
 378  * Function    :  client_protocol_is_unsupported
 379  *
 380  * Description :  Checks if the client used a known unsupported
 381  *                protocol and deals with it by sending an error
 382  *                response.
 383  *
 384  * Parameters  :
 385  *          1  :  csp = Current client state (buffers, headers, etc...)
 386  *          2  :  req = the first request line send by the client
 387  *
 388  * Returns     :  TRUE if an error response has been generated, or
 389  *                FALSE if the request doesn't look invalid.
 390  *
 391  *********************************************************************/
 392 static int client_protocol_is_unsupported(const struct client_state *csp, char *req)
 393 {
 394    /*
 395     * If it's a FTP or gopher request, we don't support it.
 396     *
 397     * These checks are better than nothing, but they might
 398     * not work in all configurations and some clients might
 399     * have problems digesting the answer.
 400     *
 401     * They should, however, never cause more problems than
 402     * Privoxy's old behaviour (returning the misleading HTML
 403     * error message:
 404     *
 405     * "Could not resolve http://(ftp|gopher)://example.org").
 406     */
 407    if (!strncmpic(req, "GET ftp://", 10) || !strncmpic(req, "GET gopher://", 13))
 408    {
 409       const char *response = NULL;
 410       const char *protocol = NULL;
 411
 412       if (!strncmpic(req, "GET ftp://", 10))
 413       {
 414          response = FTP_RESPONSE;
 415          protocol = "FTP";
 416       }
 417       else
 418       {
 419          response = GOPHER_RESPONSE;
 420          protocol = "GOPHER";
 421       }
 422       log_error(LOG_LEVEL_ERROR,
 423          "%s tried to use Privoxy as %s proxy: %s",
 424          csp->ip_addr_str, protocol, req);
 425       log_error(LOG_LEVEL_CLF,
 426          "%s - - [%T] \"%s\" 400 0", csp->ip_addr_str, req);
 427       freez(req);
 428       write_socket(csp->cfd, response, strlen(response));
 429
 430       return TRUE;
 431    }
 432
 433    return FALSE;
 434 }
 435
 436
 437 /*********************************************************************
 438  *
 439  * Function    :  get_request_destination_elsewhere
 440  *
 441  * Description :  If the client's request was redirected into
 442  *                Privoxy without the client's knowledge,
 443  *                the request line lacks the destination host.
 444  *
 445  *                This function tries to get it elsewhere,
 446  *                provided accept-intercepted-requests is enabled.
 447  *
 448  *                "Elsewhere" currently only means "Host: header",
 449  *                but in the future we may ask the redirecting
 450  *                packet filter to look the destination up.
 451  *
 452  *                If the destination stays unknown, an error
 453  *                response is send to the client and headers
 454  *                are freed so that chat() can return directly.
 455  *
 456  * Parameters  :
 457  *          1  :  csp = Current client state (buffers, headers, etc...)
 458  *          2  :  headers = a header list
 459  *
 460  * Returns     :  JB_ERR_OK if the destination is now known, or
 461  *                JB_ERR_PARSE if it isn't.
 462  *
 463  *********************************************************************/
 464 static jb_err get_request_destination_elsewhere(struct client_state *csp, struct list *headers)
 465 {
 466    char *req;
 467
 468    if (!(csp->config->feature_flags & RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS))
 469    {
 470       log_error(LOG_LEVEL_ERROR, "%s's request: \'%s\' is invalid."
 471          " Privoxy isn't configured to accept intercepted requests.",
 472          csp->ip_addr_str, csp->http->cmd);
 473       /* XXX: Use correct size */
 474       log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
 475          csp->ip_addr_str, csp->http->cmd);
 476
 477       write_socket(csp->cfd, CHEADER, strlen(CHEADER));
 478       destroy_list(headers);
 479
 480       return JB_ERR_PARSE;
 481    }
 482    else if (JB_ERR_OK == get_destination_from_headers(headers, csp->http))
 483    {
 484 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
 485       /* Split the domain we just got for pattern matching */
 486       init_domain_components(csp->http);
 487 #endif
 488
 489       return JB_ERR_OK;
 490    }
 491    else
 492    {
 493       /* We can't work without destination. Go spread the news.*/
 494
 495       req = list_to_text(headers);
 496       chomp(req);
 497       /* XXX: Use correct size */
 498       log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 400 0",
 499          csp->ip_addr_str, csp->http->cmd);
 500       log_error(LOG_LEVEL_ERROR,
 501          "Privoxy was unable to get the destination for %s's request:\n%s\n%s",
 502          csp->ip_addr_str, csp->http->cmd, req);
 503       freez(req);
 504
 505       write_socket(csp->cfd, MISSING_DESTINATION_RESPONSE, strlen(MISSING_DESTINATION_RESPONSE));
 506       destroy_list(headers);
 507
 508       return JB_ERR_PARSE;
 509    }
 510    /*
 511     * TODO: If available, use PF's ioctl DIOCNATLOOK as last resort
 512     * to get the destination IP address, use it as host directly
 513     * or do a reverse DNS lookup first.
 514     */
 515 }
 516
 517
 518 /*********************************************************************
 519  *
 520  * Function    :  get_server_headers
 521  *
 522  * Description :  Parses server headers in iob and fills them
 523  *                into csp->headers so that they can later be
 524  *                handled by sed().
 525  *
 526  * Parameters  :
 527  *          1  :  csp = Current client state (buffers, headers, etc...)
 528  *
 529  * Returns     :  JB_ERR_OK if everything went fine, or
 530  *                JB_ERR_PARSE if the headers were incomplete.
 531  *
 532  *********************************************************************/
 533 static jb_err get_server_headers(struct client_state *csp)
 534 {
 535    int continue_hack_in_da_house = 0;
 536    char * header;
 537
 538    while (((header = get_header(csp->iob)) != NULL) || continue_hack_in_da_house)
 539    {
 540       if (header == NULL)
 541       {
 542          /*
 543           * continue hack in da house. Ignore the ending of
 544           * this head and continue enlisting header lines.
 545           * The reason is described below.
 546           */
 547          enlist(csp->headers, "");
 548          continue_hack_in_da_house = 0;
 549          continue;
 550       }
 551       else if (0 == strncmpic(header, "HTTP/1.1 100", 12))
 552       {
 553          /*
 554           * It's a bodyless continue response, don't
 555           * stop header parsing after reaching its end.
 556           *
 557           * As a result Privoxy will concatenate the
 558           * next response's head and parse and deliver
 559           * the headers as if they belonged to one request.
 560           *
 561           * The client will separate them because of the
 562           * empty line between them.
 563           *
 564           * XXX: What we're doing here is clearly against
 565           * the intended purpose of the continue header,
 566           * and under some conditions (HTTP/1.0 client request)
 567           * it's a standard violation.
 568           *
 569           * Anyway, "sort of against the spec" is preferable
 570           * to "always getting confused by Continue responses"
 571           * (Privoxy's behaviour before this hack was added)
 572           */
 573          log_error(LOG_LEVEL_HEADER, "Continue hack in da house.");
 574          continue_hack_in_da_house = 1;
 575       }
 576       else if (*header == '\0')
 577       {
 578          /*
 579           * If the header is empty, but the Continue hack
 580           * isn't active, we can assume that we reached the
 581           * end of the buffer before we hit the end of the
 582           * head.
 583           *
 584           * Inform the caller an let it decide how to handle it.
 585           */
 586          return JB_ERR_PARSE;
 587       }
 588
 589       if (JB_ERR_MEMORY == enlist(csp->headers, header))
 590       {
 591          /*
 592           * XXX: Should we quit the request and return a
 593           * out of memory error page instead?
 594           */
 595          log_error(LOG_LEVEL_ERROR,
 596             "Out of memory while enlisting server headers. %s lost.",
 597             header);
 598       }
 599       freez(header);
 600    }
 601
 602    return JB_ERR_OK;
 603 }
 604
 605
 606 /*********************************************************************
 607  *
 608  * Function    :  crunch_reason
 609  *
 610  * Description :  Translates the crunch reason code into a string.
 611  *
 612  * Parameters  :
 613  *          1  :  rsp = a http_response
 614  *
 615  * Returns     :  A string with the crunch reason or an error description.
 616  *
 617  *********************************************************************/
 618 static const char *crunch_reason(const struct http_response *rsp)
 619 {
 620    char * reason = NULL;
 621
 622    assert(rsp != NULL);
 623    if (rsp == NULL)
 624    {
 625       return "Internal error while searching for crunch reason";
 626    }
 627
 628    switch (rsp->reason)
 629    {
 630       case RSP_REASON_UNSUPPORTED:
 631          reason = "Unsupported HTTP feature";
 632          break;
 633       case RSP_REASON_BLOCKED:
 634          reason = "Blocked";
 635          break;
 636       case RSP_REASON_UNTRUSTED:
 637          reason = "Untrusted";
 638          break;
 639       case RSP_REASON_REDIRECTED:
 640          reason = "Redirected";
 641          break;
 642       case RSP_REASON_CGI_CALL:
 643          reason = "CGI Call";
 644          break;
 645       case RSP_REASON_NO_SUCH_DOMAIN:
 646          reason = "DNS failure";
 647          break;
 648       case RSP_REASON_FORWARDING_FAILED:
 649          reason = "Forwarding failed";
 650          break;
 651       case RSP_REASON_CONNECT_FAILED:
 652          reason = "Connection failure";
 653          break;
 654       case RSP_REASON_OUT_OF_MEMORY:
 655          reason = "Out of memory (may mask other reasons)";
 656          break;
 657       case RSP_REASON_CONNECTION_TIMEOUT:
 658          reason = "Connection timeout";
 659          break;
 660       case RSP_REASON_NO_SERVER_DATA:
 661          reason = "No server data received";
 662          break;
 663       default:
 664          reason = "No reason recorded";
 665          break;
 666    }
 667
 668    return reason;
 669 }
 670
 671
 672 /*********************************************************************
 673  *
 674  * Function    :  send_crunch_response
 675  *
 676  * Description :  Delivers already prepared response for
 677  *                intercepted requests, logs the interception
 678  *                and frees the response.
 679  *
 680  * Parameters  :
 681  *          1  :  csp = Current client state (buffers, headers, etc...)
 682  *          1  :  rsp = Fully prepared response. Will be freed on exit.
 683  *
 684  * Returns     :  Nothing.
 685  *
 686  *********************************************************************/
 687 static void send_crunch_response(const struct client_state *csp, struct http_response *rsp)
 688 {
 689       const struct http_request *http = csp->http;
 690       char status_code[4];
 691
 692       assert(rsp != NULL);
 693       assert(rsp->head != NULL);
 694
 695       if (rsp == NULL)
 696       {
 697          /*
 698           * Not supposed to happen. If it does
 699           * anyway, treat it as an unknown error.
 700           */
 701          cgi_error_unknown(csp, rsp, RSP_REASON_INTERNAL_ERROR);
 702          /* return code doesn't matter */
 703       }
 704
 705       if (rsp == NULL)
 706       {
 707          /* If rsp is still NULL, we have serious internal problems. */
 708          log_error(LOG_LEVEL_FATAL,
 709             "NULL response in send_crunch_response and cgi_error_unknown failed as well.");
 710       }
 711
 712       /*
 713        * Extract the status code from the actual head
 714        * that was send to the client. It is the only
 715        * way to get it right for all requests, including
 716        * the fixed ones for out-of-memory problems.
 717        *
 718        * A head starts like this: 'HTTP/1.1 200...'
 719        *                           0123456789|11
 720        *                                     10
 721        */
 722       status_code[0] = rsp->head[9];
 723       status_code[1] = rsp->head[10];
 724       status_code[2] = rsp->head[11];
 725       status_code[3] = '\0';
 726
 727       /* Write the answer to the client */
 728       if (write_socket(csp->cfd, rsp->head, rsp->head_length)
 729        || write_socket(csp->cfd, rsp->body, rsp->content_length))
 730       {
 731          /* There is nothing we can do about it. */
 732          log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", csp->http->host);
 733       }
 734
 735       /* Log that the request was crunched and why. */
 736       log_error(LOG_LEVEL_CRUNCH, "%s: %s", crunch_reason(rsp), http->url);
 737       log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" %s %u",
 738          csp->ip_addr_str, http->ocmd, status_code, rsp->content_length);
 739
 740       /* Clean up and return */
 741       if (cgi_error_memory() != rsp)
 742       {
 743          free_http_response(rsp);
 744       }
 745       return;
 746 }
 747
 748
 749 #if 0
 750 /*********************************************************************
 751  *
 752  * Function    :  request_contains_null_bytes
 753  *
 754  * Description :  Checks for NULL bytes in the request and sends
 755  *                an error message to the client if any were found.
 756  *
 757  *                XXX: currently not used, see comment in chat().
 758  *
 759  * Parameters  :
 760  *          1  :  csp = Current client state (buffers, headers, etc...)
 761  *          2  :  buf = Data from the client's request to check.
 762  *          3  :  len = The data length.
 763  *
 764  * Returns     :  TRUE if the request contained one or more NULL bytes, or
 765  *                FALSE otherwise.
 766  *
 767  *********************************************************************/
 768 static int request_contains_null_bytes(const struct client_state *csp, char *buf, int len)
 769 {
 770    size_t c_len; /* Request lenght when treated as C string */
 771
 772    c_len = strlen(buf);
 773
 774    if (c_len < len)
 775    {
 776       /*
 777        * Null byte(s) found. Log the request,
 778        * return an error response and hang up.
 779        */
 780       size_t tmp_len = c_len;
 781
 782       do
 783       {
 784         /*
 785          * Replace NULL byte(s) with '°' characters
 786          * so the request can be logged as string.
 787          * XXX: Is there a better replacement character?
 788          */
 789          buf[tmp_len]='°';
 790          tmp_len += strlen(buf+tmp_len);
 791       } while (tmp_len < len);
 792
 793       log_error(LOG_LEVEL_ERROR, "%s\'s request contains at least one NULL byte "
 794          "(length=%d, strlen=%u).", csp->ip_addr_str, len, c_len);
 795       log_error(LOG_LEVEL_HEADER,
 796          "Offending request data with NULL bytes turned into \'°\' characters: %s", buf);
 797
 798       write_socket(csp->cfd, NULL_BYTE_RESPONSE, strlen(NULL_BYTE_RESPONSE));
 799
 800       /* XXX: Log correct size */
 801       log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
 802
 803       return TRUE;
 804    }
 805
 806    return FALSE;
 807 }
 808 #endif
 809
 810
 811 /*********************************************************************
 812  *
 813  * Function    :  crunch_response_triggered
 814  *
 815  * Description :  Checks if the request has to be crunched,
 816  *                and delivers the crunch response if necessary.
 817  *
 818  * Parameters  :
 819  *          1  :  csp = Current client state (buffers, headers, etc...)
 820  *          2  :  crunchers = list of cruncher functions to run
 821  *
 822  * Returns     :  TRUE if the request was answered with a crunch response
 823  *                FALSE otherwise.
 824  *
 825  *********************************************************************/
 826 static int crunch_response_triggered(struct client_state *csp, const struct cruncher crunchers[])
 827 {
 828    struct http_response *rsp = NULL;
 829    const struct cruncher *c;
 830
 831    /*
 832     * If CGI request crunching is disabled,
 833     * check the CGI dispatcher out of order to
 834     * prevent unintentional blocks or redirects.
 835     */
 836    if (!(csp->config->feature_flags & RUNTIME_FEATURE_CGI_CRUNCHING)
 837        && (NULL != (rsp = dispatch_cgi(csp))))
 838    {
 839       /* Deliver, log and free the interception response. */
 840       send_crunch_response(csp, rsp);
 841       return TRUE;
 842    }
 843
 844    for (c = crunchers; c->cruncher != NULL; c++)
 845    {
 846       /*
 847        * Check the cruncher if either Privoxy is toggled
 848        * on and the request isn't forced, or if the cruncher
 849        * applies to forced requests as well.
 850        */
 851       if (((csp->flags & CSP_FLAG_TOGGLED_ON) &&
 852           !(csp->flags & CSP_FLAG_FORCED)) ||
 853           (c->flags & CF_IGNORE_FORCE))
 854       {
 855          rsp = c->cruncher(csp);
 856          if (NULL != rsp)
 857          {
 858             /* Deliver, log and free the interception response. */
 859             send_crunch_response(csp, rsp);
 860 #ifdef FEATURE_STATISTICS
 861             if (c->flags & CF_COUNT_AS_REJECT)
 862             {
 863                csp->flags |= CSP_FLAG_REJECTED;
 864             }
 865 #endif /* def FEATURE_STATISTICS */
 866
 867             return TRUE;
 868          }
 869       }
 870    }
 871
 872    return FALSE;
 873 }
 874
 875
 876 /*********************************************************************
 877  *
 878  * Function    :  build_request_line
 879  *
 880  * Description :  Builds the HTTP request line.
 881  *
 882  *                If a HTTP forwarder is used it expects the whole URL,
 883  *                web servers only get the path.
 884  *
 885  * Parameters  :
 886  *          1  :  csp = Current client state (buffers, headers, etc...)
 887  *          2  :  fwd = The forwarding spec used for the request
 888  *                XXX: Should use http->fwd instead.
 889  *          3  :  request_line = The old request line which will be replaced.
 890  *
 891  * Returns     :  Nothing. Terminates in case of memory problems.
 892  *
 893  *********************************************************************/
 894 static void build_request_line(struct client_state *csp, const struct forward_spec *fwd, char **request_line)
 895 {
 896    struct http_request *http = csp->http;
 897
 898    assert(http->ssl == 0);
 899
 900    /*
 901     * Downgrade http version from 1.1 to 1.0
 902     * if +downgrade action applies.
 903     */
 904    if ( (csp->action->flags & ACTION_DOWNGRADE)
 905      && (!strcmpic(http->ver, "HTTP/1.1")))
 906    {
 907       freez(http->ver);
 908       http->ver = strdup("HTTP/1.0");
 909
 910       if (http->ver == NULL)
 911       {
 912          log_error(LOG_LEVEL_FATAL, "Out of memory downgrading HTTP version");
 913       }
 914    }
 915
 916    /*
 917     * Rebuild the request line.
 918     */
 919    freez(*request_line);
 920    *request_line = strdup(http->gpc);
 921    string_append(request_line, " ");
 922
 923    if (fwd->forward_host)
 924    {
 925       string_append(request_line, http->url);
 926    }
 927    else
 928    {
 929       string_append(request_line, http->path);
 930    }
 931    string_append(request_line, " ");
 932    string_append(request_line, http->ver);
 933
 934    if (*request_line == NULL)
 935    {
 936       log_error(LOG_LEVEL_FATAL, "Out of memory writing HTTP command");
 937    }
 938    log_error(LOG_LEVEL_HEADER, "New HTTP Request-Line: %s", *request_line);
 939 }
 940
 941
 942 /*********************************************************************
 943  *
 944  * Function    :  change_request_destination
 945  *
 946  * Description :  Parse a (rewritten) request line and regenerate
 947  *                the http request data.
 948  *
 949  * Parameters  :
 950  *          1  :  csp = Current client state (buffers, headers, etc...)
 951  *
 952  * Returns     :  Forwards the parse_http_request() return code.
 953  *                Terminates in case of memory problems.
 954  *
 955  *********************************************************************/
 956 static jb_err change_request_destination(struct client_state *csp)
 957 {
 958    struct http_request *http = csp->http;
 959    jb_err err;
 960
 961    log_error(LOG_LEVEL_INFO, "Rewrite detected: %s", csp->headers->first->str);
 962    free_http_request(http);
 963    err = parse_http_request(csp->headers->first->str, http);
 964    if (JB_ERR_OK != err)
 965    {
 966       log_error(LOG_LEVEL_ERROR, "Couldn't parse rewritten request: %s.",
 967          jb_err_to_string(err));
 968    }
 969    else
 970    {
 971       /* XXX: ocmd is a misleading name */
 972       http->ocmd = strdup(http->cmd);
 973       if (http->ocmd == NULL)
 974       {
 975          log_error(LOG_LEVEL_FATAL,
 976             "Out of memory copying rewritten HTTP request line");
 977       }
 978    }
 979
 980    return err;
 981 }
 982
 983
 984 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
 985 /*********************************************************************
 986  *
 987  * Function    :  server_response_is_complete
 988  *
 989  * Description :  Determines whether we should stop reading
 990  *                from the server socket.
 991  *
 992  * Parameters  :
 993  *          1  :  csp = Current client state (buffers, headers, etc...)
 994  *          2  :  content_length = Length of content received so far.
 995  *
 996  * Returns     :  TRUE if the response is complete,
 997  *                FALSE otherwise.
 998  *
 999  *********************************************************************/
1000 static int server_response_is_complete(struct client_state *csp,
1001    unsigned long long content_length)
1002 {
1003    int content_length_known = !!(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET);
1004
1005    if (!strcmpic(csp->http->gpc, "HEAD"))
1006    {
1007       /*
1008        * "HEAD" implies no body, we are thus expecting
1009        * no content. XXX: incomplete "list" of methods?
1010        */
1011       csp->expected_content_length = 0;
1012       content_length_known = TRUE;
1013    }
1014
1015    if (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    }
1023
1024    return (content_length_known && ((0 == csp->expected_content_length)
1025             || (csp->expected_content_length <= content_length)));
1026 }
1027
1028
1029 /*********************************************************************
1030  *
1031  * Function    :  wait_for_alive_connections
1032  *
1033  * Description :  Waits for alive connections to timeout.
1034  *
1035  * Parameters  :  N/A
1036  *
1037  * Returns     :  N/A
1038  *
1039  *********************************************************************/
1040 static void wait_for_alive_connections(void)
1041 {
1042    int connections_alive = close_unusable_connections();
1043
1044    while (0 < connections_alive)
1045    {
1046       log_error(LOG_LEVEL_CONNECT,
1047          "Waiting for %d connections to timeout.",
1048          connections_alive);
1049       sleep(60);
1050       connections_alive = close_unusable_connections();
1051    }
1052
1053    log_error(LOG_LEVEL_CONNECT, "No connections to wait for left.");
1054
1055 }
1056
1057
1058 /*********************************************************************
1059  *
1060  * Function    :  save_connection_destination
1061  *
1062  * Description :  Remembers a connection for reuse later on.
1063  *
1064  * Parameters  :
1065  *          1  :  sfd  = Open socket to remember.
1066  *          2  :  http = The destination for the connection.
1067  *          3  :  fwd  = The forwarder settings used.
1068  *          3  :  server_connection  = storage.
1069  *
1070  * Returns     : void
1071  *
1072  *********************************************************************/
1073 void save_connection_destination(jb_socket sfd,
1074                                  const struct http_request *http,
1075                                  const struct forward_spec *fwd,
1076                                  struct reusable_connection *server_connection)
1077 {
1078    assert(sfd != JB_INVALID_SOCKET);
1079    assert(NULL != http->host);
1080
1081    server_connection->sfd = sfd;
1082    server_connection->host = strdup(http->host);
1083    if (NULL == server_connection->host)
1084    {
1085       log_error(LOG_LEVEL_FATAL, "Out of memory saving socket.");
1086    }
1087    server_connection->port = http->port;
1088
1089    assert(NULL != fwd);
1090    assert(server_connection->gateway_host == NULL);
1091    assert(server_connection->gateway_port == 0);
1092    assert(server_connection->forwarder_type == 0);
1093    assert(server_connection->forward_host == NULL);
1094    assert(server_connection->forward_port == 0);
1095
1096    server_connection->forwarder_type = fwd->type;
1097    if (NULL != fwd->gateway_host)
1098    {
1099       server_connection->gateway_host = strdup(fwd->gateway_host);
1100       if (NULL == server_connection->gateway_host)
1101       {
1102          log_error(LOG_LEVEL_FATAL, "Out of memory saving gateway_host.");
1103       }
1104    }
1105    else
1106    {
1107       server_connection->gateway_host = NULL;
1108    }
1109    server_connection->gateway_port = fwd->gateway_port;
1110
1111    if (NULL != fwd->forward_host)
1112    {
1113       server_connection->forward_host = strdup(fwd->forward_host);
1114       if (NULL == server_connection->forward_host)
1115       {
1116          log_error(LOG_LEVEL_FATAL, "Out of memory saving forward_host.");
1117       }
1118    }
1119    else
1120    {
1121       server_connection->forward_host = NULL;
1122    }
1123    server_connection->forward_port = fwd->forward_port;
1124 }
1125 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1126
1127
1128 /*********************************************************************
1129  *
1130  * Function    :  mark_server_socket_tainted
1131  *
1132  * Description :  Makes sure we don't reuse a server socket
1133  *                (if we didn't read everything the server sent
1134  *                us reusing the socket would lead to garbage).
1135  *
1136  * Parameters  :
1137  *          1  :  csp = Current client state (buffers, headers, etc...)
1138  *
1139  * Returns     :  void.
1140  *
1141  *********************************************************************/
1142 static void mark_server_socket_tainted(struct client_state *csp)
1143 {
1144    if ((csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE))
1145    {
1146       log_error(LOG_LEVEL_CONNECT,
1147          "Marking the server socket %d tainted.", csp->sfd);
1148       csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1149    }
1150 }
1151
1152 /*********************************************************************
1153  *
1154  * Function    :  get_request_line
1155  *
1156  * Description : Read the client request line.
1157  *
1158  * Parameters  :
1159  *          1  :  csp = Current client state (buffers, headers, etc...)
1160  *
1161  * Returns     :  Pointer to request line or NULL in case of errors.
1162  *
1163  *********************************************************************/
1164 static char *get_request_line(struct client_state *csp)
1165 {
1166    char buf[BUFFER_SIZE];
1167    char *request_line = NULL;
1168    int len;
1169
1170    memset(buf, 0, sizeof(buf));
1171
1172    do
1173    {
1174       if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1175       {
1176          log_error(LOG_LEVEL_ERROR,
1177             "Stopped waiting for the request line.");
1178          write_socket(csp->cfd, CLIENT_CONNECTION_TIMEOUT_RESPONSE,
1179             strlen(CLIENT_CONNECTION_TIMEOUT_RESPONSE));
1180          return NULL;
1181       }
1182
1183       len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1184
1185       if (len <= 0) return NULL;
1186
1187       /*
1188        * If there is no memory left for buffering the
1189        * request, there is nothing we can do but hang up
1190        */
1191       if (add_to_iob(csp, buf, len))
1192       {
1193          return NULL;
1194       }
1195
1196       request_line = get_header(csp->iob);
1197
1198    } while ((NULL != request_line) && ('\0' == *request_line));
1199
1200    return request_line;
1201
1202 }
1203
1204
1205 /*********************************************************************
1206  *
1207  * Function    :  receive_client_request
1208  *
1209  * Description : Read the client's request (more precisely the
1210  *               client headers) and answer it if necessary.
1211  *
1212  *               Note that since we're not using select() we could get
1213  *               blocked here if a client connected, then didn't say
1214  *               anything!
1215  *
1216  * Parameters  :
1217  *          1  :  csp = Current client state (buffers, headers, etc...)
1218  *
1219  * Returns     :  JB_ERR_OK, JB_ERR_PARSE or JB_ERR_MEMORY
1220  *
1221  *********************************************************************/
1222 static jb_err receive_client_request(struct client_state *csp)
1223 {
1224    char buf[BUFFER_SIZE];
1225    char *p;
1226    char *req = NULL;
1227    struct http_request *http;
1228    int len;
1229    jb_err err;
1230
1231    /* Temporary copy of the client's headers before they get enlisted in csp->headers */
1232    struct list header_list;
1233    struct list *headers = &header_list;
1234
1235    http = csp->http;
1236
1237    memset(buf, 0, sizeof(buf));
1238
1239    req = get_request_line(csp);
1240    if (req == NULL)
1241    {
1242       return JB_ERR_PARSE;
1243    }
1244    assert(*req != '\0');
1245
1246    if (client_protocol_is_unsupported(csp, req))
1247    {
1248       return JB_ERR_PARSE;
1249    }
1250
1251 #ifdef FEATURE_FORCE_LOAD
1252    /*
1253     * If this request contains the FORCE_PREFIX and blocks
1254     * aren't enforced, get rid of it and set the force flag.
1255     */
1256    if (strstr(req, FORCE_PREFIX))
1257    {
1258       if (csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS)
1259       {
1260          log_error(LOG_LEVEL_FORCE,
1261             "Ignored force prefix in request: \"%s\".", req);
1262       }
1263       else
1264       {
1265          strclean(req, FORCE_PREFIX);
1266          log_error(LOG_LEVEL_FORCE, "Enforcing request: \"%s\".", req);
1267          csp->flags |= CSP_FLAG_FORCED;
1268       }
1269    }
1270 #endif /* def FEATURE_FORCE_LOAD */
1271
1272    err = parse_http_request(req, http);
1273    freez(req);
1274    if (JB_ERR_OK != err)
1275    {
1276       write_socket(csp->cfd, CHEADER, strlen(CHEADER));
1277       /* XXX: Use correct size */
1278       log_error(LOG_LEVEL_CLF, "%s - - [%T] \"Invalid request\" 400 0", csp->ip_addr_str);
1279       log_error(LOG_LEVEL_ERROR,
1280          "Couldn't parse request line received from %s: %s",
1281          csp->ip_addr_str, jb_err_to_string(err));
1282
1283       free_http_request(http);
1284       return JB_ERR_PARSE;
1285    }
1286
1287    /* grab the rest of the client's headers */
1288    init_list(headers);
1289    for (;;)
1290    {
1291       p = get_header(csp->iob);
1292
1293       if (p == NULL)
1294       {
1295          /* There are no additional headers to read. */
1296          break;
1297       }
1298
1299       if (*p == '\0')
1300       {
1301          /*
1302           * We didn't receive a complete header
1303           * line yet, get the rest of it.
1304           */
1305          if (!data_is_available(csp->cfd, csp->config->socket_timeout))
1306          {
1307             log_error(LOG_LEVEL_ERROR,
1308                "Stopped grabbing the client headers.");
1309             destroy_list(headers);
1310             return JB_ERR_PARSE;
1311          }
1312
1313          len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1314          if (len <= 0)
1315          {
1316             log_error(LOG_LEVEL_ERROR, "read from client failed: %E");
1317             destroy_list(headers);
1318             return JB_ERR_PARSE;
1319          }
1320
1321          if (add_to_iob(csp, buf, len))
1322          {
1323             /*
1324              * If there is no memory left for buffering the
1325              * request, there is nothing we can do but hang up
1326              */
1327             destroy_list(headers);
1328             return JB_ERR_MEMORY;
1329          }
1330       }
1331       else
1332       {
1333          /*
1334           * We were able to read a complete
1335           * header and can finaly enlist it.
1336           */
1337          enlist(headers, p);
1338          freez(p);
1339       }
1340    }
1341
1342    if (http->host == NULL)
1343    {
1344       /*
1345        * If we still don't know the request destination,
1346        * the request is invalid or the client uses
1347        * Privoxy without its knowledge.
1348        */
1349       if (JB_ERR_OK != get_request_destination_elsewhere(csp, headers))
1350       {
1351          /*
1352           * Our attempts to get the request destination
1353           * elsewhere failed or Privoxy is configured
1354           * to only accept proxy requests.
1355           *
1356           * An error response has already been send
1357           * and we're done here.
1358           */
1359          return JB_ERR_PARSE;
1360       }
1361    }
1362
1363    /*
1364     * Determine the actions for this URL
1365     */
1366 #ifdef FEATURE_TOGGLE
1367    if (!(csp->flags & CSP_FLAG_TOGGLED_ON))
1368    {
1369       /* Most compatible set of actions (i.e. none) */
1370       init_current_action(csp->action);
1371    }
1372    else
1373 #endif /* ndef FEATURE_TOGGLE */
1374    {
1375       get_url_actions(csp, http);
1376    }
1377
1378    /*
1379     * Save a copy of the original request for logging
1380     */
1381    http->ocmd = strdup(http->cmd);
1382    if (http->ocmd == NULL)
1383    {
1384       log_error(LOG_LEVEL_FATAL,
1385          "Out of memory copying HTTP request line");
1386    }
1387    enlist(csp->headers, http->cmd);
1388
1389    /* Append the previously read headers */
1390    list_append_list_unique(csp->headers, headers);
1391    destroy_list(headers);
1392
1393    return JB_ERR_OK;
1394
1395 }
1396
1397
1398 /*********************************************************************
1399  *
1400  * Function    : parse_client_request
1401  *
1402  * Description : Parses the client's request and decides what to do
1403  *               with it.
1404  *
1405  *               Note that since we're not using select() we could get
1406  *               blocked here if a client connected, then didn't say
1407  *               anything!
1408  *
1409  * Parameters  :
1410  *          1  :  csp = Current client state (buffers, headers, etc...)
1411  *
1412  * Returns     :  JB_ERR_OK or JB_ERR_PARSE
1413  *
1414  *********************************************************************/
1415 static jb_err parse_client_request(struct client_state *csp)
1416 {
1417    struct http_request *http = csp->http;
1418    jb_err err;
1419
1420 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1421    if ((!strcmpic(csp->http->ver, "HTTP/1.1"))
1422     && (csp->http->ssl == 0))
1423    {
1424       /* Assume persistence until further notice */
1425       csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1426    }
1427 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1428
1429    err = sed(csp, FILTER_CLIENT_HEADERS);
1430    if (JB_ERR_OK != err)
1431    {
1432       /* XXX: Should be handled in sed(). */
1433       assert(err == JB_ERR_PARSE);
1434       log_error(LOG_LEVEL_FATAL, "Failed to parse client headers.");
1435    }
1436    csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
1437
1438    /* Check request line for rewrites. */
1439    if ((NULL == csp->headers->first->str)
1440       || (strcmp(http->cmd, csp->headers->first->str) &&
1441          (JB_ERR_OK != change_request_destination(csp))))
1442    {
1443       /*
1444        * A header filter broke the request line - bail out.
1445        */
1446       write_socket(csp->cfd, MESSED_UP_REQUEST_RESPONSE, strlen(MESSED_UP_REQUEST_RESPONSE));
1447       /* XXX: Use correct size */
1448       log_error(LOG_LEVEL_CLF,
1449          "%s - - [%T] \"Invalid request generated\" 500 0", csp->ip_addr_str);
1450       log_error(LOG_LEVEL_ERROR,
1451          "Invalid request line after applying header filters.");
1452       free_http_request(http);
1453
1454       return JB_ERR_PARSE;
1455    }
1456
1457 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1458    if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
1459    {
1460       if (csp->iob->cur[0] != '\0')
1461       {
1462          csp->flags |= CSP_FLAG_SERVER_SOCKET_TAINTED;
1463          if (!strcmpic(csp->http->gpc, "POST"))
1464          {
1465             /* XXX: this is an incomplete hack */
1466             csp->flags &= ~CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1467             log_error(LOG_LEVEL_CONNECT,
1468                "POST request detected. The connection will not be kept alive.");
1469          }
1470          else
1471          {
1472             /* XXX: and so is this */
1473             csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1474             log_error(LOG_LEVEL_CONNECT,
1475                "Possible pipeline attempt detected. The connection will not "
1476                "be kept alive and we will only serve the first request.");
1477             /* Nuke the pipelined requests from orbit, just to be sure. */
1478             csp->iob->buf[0] = '\0';
1479             csp->iob->eod = csp->iob->cur = csp->iob->buf;
1480          }
1481       }
1482       else
1483       {
1484          csp->flags |= CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ;
1485          log_error(LOG_LEVEL_CONNECT, "Complete client request received.");
1486       }
1487    }
1488 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1489
1490    return JB_ERR_OK;
1491
1492 }
1493
1494
1495 /*********************************************************************
1496  *
1497  * Function    :  chat
1498  *
1499  * Description :  Once a connection to the client has been accepted,
1500  *                this function is called (via serve()) to handle the
1501  *                main business of the communication.  When this
1502  *                function returns, the caller must close the client
1503  *                socket handle.
1504  *
1505  *                FIXME: chat is nearly thousand lines long.
1506  *                Ridiculous.
1507  *
1508  * Parameters  :
1509  *          1  :  csp = Current client state (buffers, headers, etc...)
1510  *
1511  * Returns     :  Nothing.
1512  *
1513  *********************************************************************/
1514 static void chat(struct client_state *csp)
1515 {
1516    char buf[BUFFER_SIZE];
1517    char *hdr;
1518    char *p;
1519    fd_set rfds;
1520    int n;
1521    jb_socket maxfd;
1522    int server_body;
1523    int ms_iis5_hack = 0;
1524    unsigned long long byte_count = 0;
1525    int forwarded_connect_retries = 0;
1526    int max_forwarded_connect_retries = csp->config->forwarded_connect_retries;
1527    const struct forward_spec *fwd;
1528    struct http_request *http;
1529    long len = 0; /* for buffer sizes (and negative error codes) */
1530
1531    /* Function that does the content filtering for the current request */
1532    filter_function_ptr content_filter = NULL;
1533
1534    /* Skeleton for HTTP response, if we should intercept the request */
1535    struct http_response *rsp;
1536    struct timeval timeout;
1537
1538    memset(buf, 0, sizeof(buf));
1539
1540    http = csp->http;
1541
1542    if (receive_client_request(csp) != JB_ERR_OK)
1543    {
1544       return;
1545    }
1546    if (parse_client_request(csp) != JB_ERR_OK)
1547    {
1548       return;
1549    }
1550
1551    /* decide how to route the HTTP request */
1552    fwd = forward_url(csp, http);
1553    if (NULL == fwd)
1554    {
1555       log_error(LOG_LEVEL_FATAL, "gateway spec is NULL!?!?  This can't happen!");
1556       /* Never get here - LOG_LEVEL_FATAL causes program exit */
1557       return;
1558    }
1559
1560    /*
1561     * build the http request to send to the server
1562     * we have to do one of the following:
1563     *
1564     * create = use the original HTTP request to create a new
1565     *          HTTP request that has either the path component
1566     *          without the http://domainspec (w/path) or the
1567     *          full orininal URL (w/url)
1568     *          Note that the path and/or the HTTP version may
1569     *          have been altered by now.
1570     *
1571     * connect = Open a socket to the host:port of the server
1572     *           and short-circuit server and client socket.
1573     *
1574     * pass =  Pass the request unchanged if forwarding a CONNECT
1575     *         request to a parent proxy. Note that we'll be sending
1576     *         the CFAIL message ourselves if connecting to the parent
1577     *         fails, but we won't send a CSUCCEED message if it works,
1578     *         since that would result in a double message (ours and the
1579     *         parent's). After sending the request to the parent, we simply
1580     *         tunnel.
1581     *
1582     * here's the matrix:
1583     *                        SSL
1584     *                    0        1
1585     *                +--------+--------+
1586     *                |        |        |
1587     *             0  | create | connect|
1588     *                | w/path |        |
1589     *  Forwarding    +--------+--------+
1590     *                |        |        |
1591     *             1  | create | pass   |
1592     *                | w/url  |        |
1593     *                +--------+--------+
1594     *
1595     */
1596
1597    if (http->ssl && connect_port_is_forbidden(csp))
1598    {
1599       const char *acceptable_connect_ports =
1600          csp->action->string[ACTION_STRING_LIMIT_CONNECT];
1601       assert(NULL != acceptable_connect_ports);
1602       log_error(LOG_LEVEL_INFO, "Request from %s marked for blocking. "
1603          "limit-connect{%s} doesn't allow CONNECT requests to port %d.",
1604          csp->ip_addr_str, acceptable_connect_ports, csp->http->port);
1605       csp->action->flags |= ACTION_BLOCK;
1606       http->ssl = 0;
1607    }
1608
1609    if (http->ssl == 0)
1610    {
1611       freez(csp->headers->first->str);
1612       build_request_line(csp, fwd, &csp->headers->first->str);
1613    }
1614
1615    /*
1616     * We have a request. Check if one of the crunchers wants it.
1617     */
1618    if (crunch_response_triggered(csp, crunchers_all))
1619    {
1620       /*
1621        * Yes. The client got the crunch response
1622        * and we are done here after cleaning up.
1623        */
1624       /* XXX: why list_remove_all()? */
1625       list_remove_all(csp->headers);
1626
1627       return;
1628    }
1629
1630    log_error(LOG_LEVEL_GPC, "%s%s", http->hostport, http->path);
1631
1632    if (fwd->forward_host)
1633    {
1634       log_error(LOG_LEVEL_CONNECT, "via [%s]:%d to: %s",
1635          fwd->forward_host, fwd->forward_port, http->hostport);
1636    }
1637    else
1638    {
1639       log_error(LOG_LEVEL_CONNECT, "to %s", http->hostport);
1640    }
1641
1642    /* here we connect to the server, gateway, or the forwarder */
1643
1644 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1645    if ((csp->sfd != JB_INVALID_SOCKET)
1646       && socket_is_still_usable(csp->sfd)
1647       && connection_destination_matches(&csp->server_connection, http, fwd))
1648    {
1649       log_error(LOG_LEVEL_CONNECT,
1650          "Reusing server socket %u. Opened for %s.",
1651          csp->sfd, csp->server_connection.host);
1652    }
1653    else
1654    {
1655       if (csp->sfd != JB_INVALID_SOCKET)
1656       {
1657          log_error(LOG_LEVEL_CONNECT,
1658             "Closing server socket %u. Opened for %s.",
1659             csp->sfd, csp->server_connection.host);
1660          close_socket(csp->sfd);
1661          mark_connection_closed(&csp->server_connection);
1662       }
1663 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1664
1665       while ((csp->sfd = forwarded_connect(fwd, http, csp))
1666          && (errno == EINVAL)
1667          && (forwarded_connect_retries++ < max_forwarded_connect_retries))
1668       {
1669          log_error(LOG_LEVEL_ERROR,
1670             "failed request #%u to connect to %s. Trying again.",
1671             forwarded_connect_retries, http->hostport);
1672       }
1673
1674       if (csp->sfd == JB_INVALID_SOCKET)
1675       {
1676          if (fwd->type != SOCKS_NONE)
1677          {
1678             /* Socks error. */
1679             rsp = error_response(csp, "forwarding-failed");
1680          }
1681          else if (errno == EINVAL)
1682          {
1683             rsp = error_response(csp, "no-such-domain");
1684          }
1685          else
1686          {
1687             rsp = error_response(csp, "connect-failed");
1688             log_error(LOG_LEVEL_CONNECT, "connect to: %s failed: %E",
1689                http->hostport);
1690          }
1691
1692          /* Write the answer to the client */
1693          if (rsp != NULL)
1694          {
1695             send_crunch_response(csp, rsp);
1696          }
1697
1698          return;
1699       }
1700 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1701       save_connection_destination(csp->sfd, http, fwd, &csp->server_connection);
1702       csp->server_connection.keep_alive_timeout = (unsigned)csp->config->keep_alive_timeout;
1703    }
1704 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1705
1706    hdr = list_to_text(csp->headers);
1707    if (hdr == NULL)
1708    {
1709       /* FIXME Should handle error properly */
1710       log_error(LOG_LEVEL_FATAL, "Out of memory parsing client header");
1711    }
1712    list_remove_all(csp->headers);
1713
1714    if (fwd->forward_host || (http->ssl == 0))
1715    {
1716       /*
1717        * Write the client's (modified) header to the server
1718        * (along with anything else that may be in the buffer)
1719        */
1720       if (write_socket(csp->sfd, hdr, strlen(hdr))
1721        || (flush_socket(csp->sfd, csp->iob) <  0))
1722       {
1723          log_error(LOG_LEVEL_CONNECT,
1724             "write header to: %s failed: %E", http->hostport);
1725
1726          rsp = error_response(csp, "connect-failed");
1727          if (rsp)
1728          {
1729             send_crunch_response(csp, rsp);
1730          }
1731
1732          freez(hdr);
1733          return;
1734       }
1735    }
1736    else
1737    {
1738       /*
1739        * We're running an SSL tunnel and we're not forwarding,
1740        * so just send the "connect succeeded" message to the
1741        * client, flush the rest, and get out of the way.
1742        */
1743       if (write_socket(csp->cfd, CSUCCEED, strlen(CSUCCEED)))
1744       {
1745          freez(hdr);
1746          return;
1747       }
1748       IOB_RESET(csp);
1749    }
1750
1751    log_error(LOG_LEVEL_CONNECT, "to %s successful", http->hostport);
1752
1753    /* we're finished with the client's header */
1754    freez(hdr);
1755
1756    maxfd = (csp->cfd > csp->sfd) ? csp->cfd : csp->sfd;
1757
1758    /* pass data between the client and server
1759     * until one or the other shuts down the connection.
1760     */
1761
1762    server_body = 0;
1763
1764    for (;;)
1765    {
1766 #ifdef __OS2__
1767       /*
1768        * FD_ZERO here seems to point to an errant macro which crashes.
1769        * So do this by hand for now...
1770        */
1771       memset(&rfds,0x00,sizeof(fd_set));
1772 #else
1773       FD_ZERO(&rfds);
1774 #endif
1775 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1776       if ((csp->flags & CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ))
1777       {
1778          maxfd = csp->sfd;
1779       }
1780       else
1781 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1782       {
1783          FD_SET(csp->cfd, &rfds);
1784       }
1785
1786       FD_SET(csp->sfd, &rfds);
1787
1788 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1789       if ((csp->flags & CSP_FLAG_CHUNKED)
1790          && !(csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
1791          && ((csp->iob->eod - csp->iob->cur) >= 5)
1792          && !memcmp(csp->iob->eod-5, "0\r\n\r\n", 5))
1793       {
1794          log_error(LOG_LEVEL_CONNECT,
1795             "Looks like we read the last chunk together with "
1796             "the server headers. We better stop reading.");
1797          byte_count = (unsigned long long)(csp->iob->eod - csp->iob->cur);
1798          csp->expected_content_length = byte_count;
1799          csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
1800       }
1801       if (server_body && server_response_is_complete(csp, byte_count))
1802       {
1803          log_error(LOG_LEVEL_CONNECT,
1804             "Done reading from server. Expected content length: %llu. "
1805             "Actual content length: %llu. Most recently received: %d.",
1806             csp->expected_content_length, byte_count, len);
1807          len = 0;
1808          /*
1809           * XXX: should not jump around,
1810           * chat() is complicated enough already.
1811           */
1812          goto reading_done;
1813       }
1814 #endif  /* FEATURE_CONNECTION_KEEP_ALIVE */
1815
1816       timeout.tv_sec = csp->config->socket_timeout;
1817       timeout.tv_usec = 0;
1818       n = select((int)maxfd+1, &rfds, NULL, NULL, &timeout);
1819
1820       if (n == 0)
1821       {
1822          log_error(LOG_LEVEL_ERROR,
1823             "Didn't receive data in time: %s", http->url);
1824          if ((byte_count == 0) && (http->ssl == 0))
1825          {
1826             send_crunch_response(csp, error_response(csp, "connection-timeout"));
1827          }
1828          mark_server_socket_tainted(csp);
1829          return;
1830       }
1831       else if (n < 0)
1832       {
1833          log_error(LOG_LEVEL_ERROR, "select() failed!: %E");
1834          mark_server_socket_tainted(csp);
1835          return;
1836       }
1837
1838       /*
1839        * This is the body of the browser's request,
1840        * just read and write it.
1841        *
1842        * XXX: Make sure the client doesn't use pipelining
1843        * behind Privoxy's back.
1844        */
1845       if (FD_ISSET(csp->cfd, &rfds))
1846       {
1847          len = read_socket(csp->cfd, buf, sizeof(buf) - 1);
1848
1849          if (len <= 0)
1850          {
1851             /* XXX: not sure if this is necessary. */
1852             mark_server_socket_tainted(csp);
1853             break; /* "game over, man" */
1854          }
1855
1856          if (write_socket(csp->sfd, buf, (size_t)len))
1857          {
1858             log_error(LOG_LEVEL_ERROR, "write to: %s failed: %E", http->host);
1859             mark_server_socket_tainted(csp);
1860             return;
1861          }
1862          continue;
1863       }
1864
1865       /*
1866        * The server wants to talk. It could be the header or the body.
1867        * If `hdr' is null, then it's the header otherwise it's the body.
1868        * FIXME: Does `hdr' really mean `host'? No.
1869        */
1870       if (FD_ISSET(csp->sfd, &rfds))
1871       {
1872 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1873          if (!socket_is_still_usable(csp->cfd))
1874          {
1875             log_error(LOG_LEVEL_CONNECT,
1876                "The server still wants to talk, but the client hung up on us.");
1877             mark_server_socket_tainted(csp);
1878             return;
1879          }
1880 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1881
1882          fflush(NULL);
1883          len = read_socket(csp->sfd, buf, sizeof(buf) - 1);
1884
1885          if (len < 0)
1886          {
1887             log_error(LOG_LEVEL_ERROR, "read from: %s failed: %E", http->host);
1888
1889             if (http->ssl && (fwd->forward_host == NULL))
1890             {
1891                /*
1892                 * Just hang up. We already confirmed the client's CONNECT
1893                 * request with status code 200 and unencrypted content is
1894                 * no longer welcome.
1895                 */
1896                log_error(LOG_LEVEL_ERROR,
1897                   "CONNECT already confirmed. Unable to tell the client about the problem.");
1898                return;
1899             }
1900             else if (byte_count)
1901             {
1902                /*
1903                 * Just hang up. We already transmitted the original headers
1904                 * and parts of the original content and therefore missed the
1905                 * chance to send an error message (without risking data corruption).
1906                 *
1907                 * XXX: we could retry with a fancy range request here.
1908                 */
1909                log_error(LOG_LEVEL_ERROR, "Already forwarded the original headers. "
1910                   "Unable to tell the client about the problem.");
1911                mark_server_socket_tainted(csp);
1912                return;
1913             }
1914             /*
1915              * XXX: Consider handling the cases above the same.
1916              */
1917             mark_server_socket_tainted(csp);
1918             len = 0;
1919          }
1920
1921 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1922          if (csp->flags & CSP_FLAG_CHUNKED)
1923          {
1924             if ((len >= 5) && !memcmp(buf+len-5, "0\r\n\r\n", 5))
1925             {
1926                /* XXX: this is a temporary hack */
1927                log_error(LOG_LEVEL_CONNECT,
1928                   "Looks like we reached the end of the last chunk. "
1929                   "We better stop reading.");
1930                csp->expected_content_length = byte_count + (unsigned long long)len;
1931                csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
1932             }
1933          }
1934          reading_done:
1935 #endif  /* FEATURE_CONNECTION_KEEP_ALIVE */
1936
1937          /*
1938           * Add a trailing zero to let be able to use string operations.
1939           * XXX: do we still need this with filter_popups gone?
1940           */
1941          buf[len] = '\0';
1942
1943          /*
1944           * Normally, this would indicate that we've read
1945           * as much as the server has sent us and we can
1946           * close the client connection.  However, Microsoft
1947           * in its wisdom has released IIS/5 with a bug that
1948           * prevents it from sending the trailing \r\n in
1949           * a 302 redirect header (and possibly other headers).
1950           * To work around this if we've haven't parsed
1951           * a full header we'll append a trailing \r\n
1952           * and see if this now generates a valid one.
1953           *
1954           * This hack shouldn't have any impacts.  If we've
1955           * already transmitted the header or if this is a
1956           * SSL connection, then we won't bother with this
1957           * hack.  So we only work on partially received
1958           * headers.  If we append a \r\n and this still
1959           * doesn't generate a valid header, then we won't
1960           * transmit anything to the client.
1961           */
1962          if (len == 0)
1963          {
1964
1965             if (server_body || http->ssl)
1966             {
1967                /*
1968                 * If we have been buffering up the document,
1969                 * now is the time to apply content modification
1970                 * and send the result to the client.
1971                 */
1972                if (content_filter)
1973                {
1974                   p = execute_content_filter(csp, content_filter);
1975                   /*
1976                    * If the content filter fails, use the original
1977                    * buffer and length.
1978                    * (see p != NULL ? p : csp->iob->cur below)
1979                    */
1980                   if (NULL == p)
1981                   {
1982                      csp->content_length = (size_t)(csp->iob->eod - csp->iob->cur);
1983                   }
1984
1985                   if (JB_ERR_OK != update_server_headers(csp))
1986                   {
1987                      log_error(LOG_LEVEL_FATAL,
1988                         "Failed to update server headers. after filtering.");
1989                   }
1990
1991                   hdr = list_to_text(csp->headers);
1992                   if (hdr == NULL)
1993                   {
1994                      /* FIXME Should handle error properly */
1995                      log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
1996                   }
1997
1998                   if (write_socket(csp->cfd, hdr, strlen(hdr))
1999                    || write_socket(csp->cfd,
2000                          ((p != NULL) ? p : csp->iob->cur), (size_t)csp->content_length))
2001                   {
2002                      log_error(LOG_LEVEL_ERROR, "write modified content to client failed: %E");
2003                      freez(hdr);
2004                      freez(p);
2005                      mark_server_socket_tainted(csp);
2006                      return;
2007                   }
2008
2009                   freez(hdr);
2010                   freez(p);
2011                }
2012
2013                break; /* "game over, man" */
2014             }
2015
2016             /*
2017              * This is NOT the body, so
2018              * Let's pretend the server just sent us a blank line.
2019              */
2020             snprintf(buf, sizeof(buf), "\r\n");
2021             len = (int)strlen(buf);
2022
2023             /*
2024              * Now, let the normal header parsing algorithm below do its
2025              * job.  If it fails, we'll exit instead of continuing.
2026              */
2027
2028             ms_iis5_hack = 1;
2029          }
2030
2031          /*
2032           * If this is an SSL connection or we're in the body
2033           * of the server document, just write it to the client,
2034           * unless we need to buffer the body for later content-filtering
2035           */
2036          if (server_body || http->ssl)
2037          {
2038             if (content_filter)
2039             {
2040                /*
2041                 * If there is no memory left for buffering the content, or the buffer limit
2042                 * has been reached, switch to non-filtering mode, i.e. make & write the
2043                 * header, flush the iob and buf, and get out of the way.
2044                 */
2045                if (add_to_iob(csp, buf, len))
2046                {
2047                   size_t hdrlen;
2048                   long flushed;
2049
2050                   log_error(LOG_LEVEL_INFO,
2051                      "Flushing header and buffers. Stepping back from filtering.");
2052
2053                   hdr = list_to_text(csp->headers);
2054                   if (hdr == NULL)
2055                   {
2056                      /*
2057                       * Memory is too tight to even generate the header.
2058                       * Send our static "Out-of-memory" page.
2059                       */
2060                      log_error(LOG_LEVEL_ERROR, "Out of memory while trying to flush.");
2061                      rsp = cgi_error_memory();
2062                      send_crunch_response(csp, rsp);
2063                      mark_server_socket_tainted(csp);
2064                      return;
2065                   }
2066                   hdrlen = strlen(hdr);
2067
2068                   if (write_socket(csp->cfd, hdr, hdrlen)
2069                    || ((flushed = flush_socket(csp->cfd, csp->iob)) < 0)
2070                    || (write_socket(csp->cfd, buf, (size_t)len)))
2071                   {
2072                      log_error(LOG_LEVEL_CONNECT,
2073                         "Flush header and buffers to client failed: %E");
2074                      freez(hdr);
2075                      mark_server_socket_tainted(csp);
2076                      return;
2077                   }
2078
2079                   /*
2080                    * Reset the byte_count to the amount of bytes
2081                    * we just flushed. len will be added a few lines below,
2082                    * hdrlen doesn't matter for LOG_LEVEL_CLF.
2083                    */
2084                   byte_count = (unsigned long long)flushed;
2085                   freez(hdr);
2086                   content_filter = NULL;
2087                   server_body = 1;
2088                }
2089             }
2090             else
2091             {
2092                if (write_socket(csp->cfd, buf, (size_t)len))
2093                {
2094                   log_error(LOG_LEVEL_ERROR, "write to client failed: %E");
2095                   mark_server_socket_tainted(csp);
2096                   return;
2097                }
2098             }
2099             byte_count += (unsigned long long)len;
2100             continue;
2101          }
2102          else
2103          {
2104             const char *header_start;
2105             /*
2106              * We're still looking for the end of the server's header.
2107              * Buffer up the data we just read.  If that fails, there's
2108              * little we can do but send our static out-of-memory page.
2109              */
2110             if (add_to_iob(csp, buf, len))
2111             {
2112                log_error(LOG_LEVEL_ERROR, "Out of memory while looking for end of server headers.");
2113                rsp = cgi_error_memory();
2114                send_crunch_response(csp, rsp);
2115                mark_server_socket_tainted(csp);
2116                return;
2117             }
2118
2119             header_start = csp->iob->cur;
2120
2121             /* Convert iob into something sed() can digest */
2122             if (JB_ERR_PARSE == get_server_headers(csp))
2123             {
2124                if (ms_iis5_hack)
2125                {
2126                   /*
2127                    * Well, we tried our MS IIS/5 hack and it didn't work.
2128                    * The header is incomplete and there isn't anything
2129                    * we can do about it.
2130                    */
2131                   log_error(LOG_LEVEL_ERROR, "Invalid server headers. "
2132                      "Applying the MS IIS5 hack didn't help.");
2133                   log_error(LOG_LEVEL_CLF,
2134                      "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2135                   write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2136                      strlen(INVALID_SERVER_HEADERS_RESPONSE));
2137                   mark_server_socket_tainted(csp);
2138                   return;
2139                }
2140                else
2141                {
2142                   /*
2143                    * Since we have to wait for more from the server before
2144                    * we can parse the headers we just continue here.
2145                    */
2146                   long header_offset = csp->iob->cur - header_start;
2147                   assert(csp->iob->cur >= header_start);
2148                   byte_count += (unsigned long long)(len - header_offset);
2149                   log_error(LOG_LEVEL_CONNECT, "Continuing buffering headers. "
2150                      "byte_count: %llu. header_offset: %d. len: %d.",
2151                      byte_count, header_offset, len);
2152                   continue;
2153                }
2154             }
2155
2156             /* Did we actually get anything? */
2157             if (NULL == csp->headers->first)
2158             {
2159                log_error(LOG_LEVEL_ERROR,
2160                   "Empty server or forwarder response received on socket %d.", csp->sfd);
2161                log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2162                send_crunch_response(csp, error_response(csp, "no-server-data"));
2163                free_http_request(http);
2164                mark_server_socket_tainted(csp);
2165                return;
2166             }
2167
2168             assert(csp->headers->first->str);
2169             assert(!http->ssl);
2170             if (strncmpic(csp->headers->first->str, "HTTP", 4) &&
2171                 strncmpic(csp->headers->first->str, "ICY", 3))
2172             {
2173                /*
2174                 * It doesn't look like a HTTP (or Shoutcast) response:
2175                 * tell the client and log the problem.
2176                 */
2177                if (strlen(csp->headers->first->str) > 30)
2178                {
2179                   csp->headers->first->str[30] = '\0';
2180                }
2181                log_error(LOG_LEVEL_ERROR,
2182                   "Invalid server or forwarder response. Starts with: %s",
2183                   csp->headers->first->str);
2184                log_error(LOG_LEVEL_CLF,
2185                   "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2186                write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2187                   strlen(INVALID_SERVER_HEADERS_RESPONSE));
2188                free_http_request(http);
2189                mark_server_socket_tainted(csp);
2190                return;
2191             }
2192
2193             /*
2194              * We have now received the entire server header,
2195              * filter it and send the result to the client
2196              */
2197             if (JB_ERR_OK != sed(csp, FILTER_SERVER_HEADERS))
2198             {
2199                log_error(LOG_LEVEL_FATAL, "Failed to parse server headers.");
2200             }
2201             hdr = list_to_text(csp->headers);
2202             if (hdr == NULL)
2203             {
2204                /* FIXME Should handle error properly */
2205                log_error(LOG_LEVEL_FATAL, "Out of memory parsing server header");
2206             }
2207
2208             if (crunch_response_triggered(csp, crunchers_light))
2209             {
2210                /*
2211                 * One of the tags created by a server-header
2212                 * tagger triggered a crunch. We already
2213                 * delivered the crunch response to the client
2214                 * and are done here after cleaning up.
2215                 */
2216                 freez(hdr);
2217                 mark_server_socket_tainted(csp);
2218                 return;
2219             }
2220             /* Buffer and pcrs filter this if appropriate. */
2221
2222             if (!http->ssl) /* We talk plaintext */
2223             {
2224                content_filter = get_filter_function(csp);
2225             }
2226             /*
2227              * Only write if we're not buffering for content modification
2228              */
2229             if (!content_filter)
2230             {
2231                /*
2232                 * Write the server's (modified) header to
2233                 * the client (along with anything else that
2234                 * may be in the buffer)
2235                 */
2236
2237                if (write_socket(csp->cfd, hdr, strlen(hdr))
2238                 || ((len = flush_socket(csp->cfd, csp->iob)) < 0))
2239                {
2240                   log_error(LOG_LEVEL_CONNECT, "write header to client failed: %E");
2241
2242                   /*
2243                    * The write failed, so don't bother mentioning it
2244                    * to the client... it probably can't hear us anyway.
2245                    */
2246                   freez(hdr);
2247                   mark_server_socket_tainted(csp);
2248                   return;
2249                }
2250
2251                byte_count += (unsigned long long)len;
2252             }
2253             else
2254             {
2255                /*
2256                 * XXX: the header lenght should probably
2257                 * be calculated by get_server_headers().
2258                 */
2259                long header_length = csp->iob->cur - header_start;
2260                assert(csp->iob->cur > header_start);
2261                byte_count += (unsigned long long)(len - header_length);
2262             }
2263
2264             /* we're finished with the server's header */
2265
2266             freez(hdr);
2267             server_body = 1;
2268
2269             /*
2270              * If this was a MS IIS/5 hack then it means the server
2271              * has already closed the connection. Nothing more to read.
2272              * Time to bail.
2273              */
2274             if (ms_iis5_hack)
2275             {
2276                log_error(LOG_LEVEL_ERROR,
2277                   "Closed server connection detected. "
2278                   "Applying the MS IIS5 hack didn't help.");
2279                log_error(LOG_LEVEL_CLF,
2280                   "%s - - [%T] \"%s\" 502 0", csp->ip_addr_str, http->cmd);
2281                write_socket(csp->cfd, INVALID_SERVER_HEADERS_RESPONSE,
2282                   strlen(INVALID_SERVER_HEADERS_RESPONSE));
2283                mark_server_socket_tainted(csp);
2284                return;
2285             }
2286          }
2287          continue;
2288       }
2289       mark_server_socket_tainted(csp);
2290       return; /* huh? we should never get here */
2291    }
2292
2293    if (csp->content_length == 0)
2294    {
2295       /*
2296        * If Privoxy didn't recalculate the Content-Lenght,
2297        * byte_count is still correct.
2298        */
2299       csp->content_length = byte_count;
2300    }
2301
2302 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2303    if ((csp->flags & CSP_FLAG_CONTENT_LENGTH_SET)
2304       && (csp->expected_content_length != byte_count))
2305    {
2306       log_error(LOG_LEVEL_CONNECT,
2307          "Received %llu bytes while expecting %llu.",
2308          byte_count, csp->expected_content_length);
2309       mark_server_socket_tainted(csp);
2310    }
2311 #endif
2312
2313    log_error(LOG_LEVEL_CLF, "%s - - [%T] \"%s\" 200 %llu",
2314       csp->ip_addr_str, http->ocmd, csp->content_length);
2315
2316    csp->server_connection.timestamp = time(NULL);
2317 }
2318
2319
2320 /*********************************************************************
2321  *
2322  * Function    :  serve
2323  *
2324  * Description :  This is little more than chat.  We only "serve" to
2325  *                to close (or remember) any socket that chat may have
2326  *                opened.
2327  *
2328  * Parameters  :
2329  *          1  :  csp = Current client state (buffers, headers, etc...)
2330  *
2331  * Returns     :  N/A
2332  *
2333  *********************************************************************/
2334 #ifdef AMIGA
2335 void serve(struct client_state *csp)
2336 #else /* ifndef AMIGA */
2337 static void serve(struct client_state *csp)
2338 #endif /* def AMIGA */
2339 {
2340 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2341    static int monitor_thread_running = 0;
2342    int continue_chatting = 0;
2343    do
2344    {
2345       chat(csp);
2346
2347       continue_chatting = (csp->config->feature_flags
2348          & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
2349          && (csp->flags & CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE)
2350          && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
2351          && (csp->cfd != JB_INVALID_SOCKET)
2352          && (csp->sfd != JB_INVALID_SOCKET)
2353          && socket_is_still_usable(csp->sfd);
2354
2355       if (continue_chatting)
2356       {
2357          log_error(LOG_LEVEL_CONNECT,
2358             "Waiting for the next client request. "
2359             "Keeping the server socket %d to %s open.",
2360             csp->sfd, csp->server_connection.host);
2361
2362          if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
2363             && data_is_available(csp->cfd, (int)csp->server_connection.keep_alive_timeout)
2364             && socket_is_still_usable(csp->cfd))
2365          {
2366             log_error(LOG_LEVEL_CONNECT, "Client request arrived in "
2367                "time or the client closed the connection.");
2368             /*
2369              * Get the csp in a mostly vergin state again.
2370              * XXX: Should be done elsewhere.
2371              */
2372             csp->content_type = 0;
2373             csp->content_length = 0;
2374             csp->expected_content_length = 0;
2375             list_remove_all(csp->headers);
2376             freez(csp->iob->buf);
2377             memset(csp->iob, 0, sizeof(csp->iob));
2378             freez(csp->error_message);
2379             free_http_request(csp->http);
2380             destroy_list(csp->headers);
2381             destroy_list(csp->tags);
2382             free_current_action(csp->action);
2383             if (NULL != csp->fwd)
2384             {
2385                unload_forward_spec(csp->fwd);
2386                csp->fwd = NULL;
2387             }
2388
2389             /* XXX: Store per-connection flags someplace else. */
2390             csp->flags = CSP_FLAG_ACTIVE | (csp->flags & CSP_FLAG_TOGGLED_ON);
2391          }
2392          else
2393          {
2394             log_error(LOG_LEVEL_CONNECT,
2395                "No additional client request received in time.");
2396             if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
2397                && (socket_is_still_usable(csp->sfd)))
2398             {
2399                remember_connection(csp, forward_url(csp, csp->http));
2400                csp->sfd = JB_INVALID_SOCKET;
2401                close_socket(csp->cfd);
2402                csp->cfd = JB_INVALID_SOCKET;
2403                privoxy_mutex_lock(&connection_reuse_mutex);
2404                if (!monitor_thread_running)
2405                {
2406                   monitor_thread_running = 1;
2407                   privoxy_mutex_unlock(&connection_reuse_mutex);
2408                   wait_for_alive_connections();
2409                   privoxy_mutex_lock(&connection_reuse_mutex);
2410                   monitor_thread_running = 0;
2411                }
2412                privoxy_mutex_unlock(&connection_reuse_mutex);
2413             }
2414             break;
2415          }
2416       }
2417       else if (csp->sfd != JB_INVALID_SOCKET)
2418       {
2419          log_error(LOG_LEVEL_CONNECT,
2420             "The connection on server socket %d to %s isn't reusable. "
2421             "Closing.", csp->sfd, csp->server_connection.host);
2422       }
2423    } while (continue_chatting);
2424
2425    mark_connection_closed(&csp->server_connection);
2426 #else
2427    chat(csp);
2428 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2429
2430    if (csp->sfd != JB_INVALID_SOCKET)
2431    {
2432 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2433       forget_connection(csp->sfd);
2434 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2435       close_socket(csp->sfd);
2436    }
2437
2438    if (csp->cfd != JB_INVALID_SOCKET)
2439    {
2440       close_socket(csp->cfd);
2441    }
2442
2443    csp->flags &= ~CSP_FLAG_ACTIVE;
2444
2445 }
2446
2447
2448 #ifdef __BEOS__
2449 /*********************************************************************
2450  *
2451  * Function    :  server_thread
2452  *
2453  * Description :  We only exist to call `serve' in a threaded environment.
2454  *
2455  * Parameters  :
2456  *          1  :  data = Current client state (buffers, headers, etc...)
2457  *
2458  * Returns     :  Always 0.
2459  *
2460  *********************************************************************/
2461 static int32 server_thread(void *data)
2462 {
2463    serve((struct client_state *) data);
2464    return 0;
2465
2466 }
2467 #endif
2468
2469
2470 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
2471 /*********************************************************************
2472  *
2473  * Function    :  usage
2474  *
2475  * Description :  Print usage info & exit.
2476  *
2477  * Parameters  :  Pointer to argv[0] for identifying ourselves
2478  *
2479  * Returns     :  No. ,-)
2480  *
2481  *********************************************************************/
2482 static void usage(const char *myname)
2483 {
2484    printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n"
2485           "Usage: %s "
2486 #if defined(unix)
2487           "[--chroot] "
2488 #endif /* defined(unix) */
2489           "[--help] "
2490 #if defined(unix)
2491           "[--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] "
2492 #endif /* defined(unix) */
2493           "[--version] [configfile]\n"
2494           "Aborting\n", myname);
2495
2496    exit(2);
2497
2498 }
2499 #endif /* #if !defined(_WIN32) || defined(_WIN_CONSOLE) */
2500
2501
2502 #ifdef MUTEX_LOCKS_AVAILABLE
2503 /*********************************************************************
2504  *
2505  * Function    :  privoxy_mutex_lock
2506  *
2507  * Description :  Locks a mutex.
2508  *
2509  * Parameters  :
2510  *          1  :  mutex = The mutex to lock.
2511  *
2512  * Returns     :  Void. May exit in case of errors.
2513  *
2514  *********************************************************************/
2515 void privoxy_mutex_lock(privoxy_mutex_t *mutex)
2516 {
2517 #ifdef FEATURE_PTHREAD
2518    int err = pthread_mutex_lock(mutex);
2519    if (err)
2520    {
2521       if (mutex != &log_mutex)
2522       {
2523          log_error(LOG_LEVEL_FATAL,
2524             "Mutex locking failed: %s.\n", strerror(err));
2525       }
2526       exit(1);
2527    }
2528 #else
2529    EnterCriticalSection(mutex);
2530 #endif /* def FEATURE_PTHREAD */
2531 }
2532
2533
2534 /*********************************************************************
2535  *
2536  * Function    :  privoxy_mutex_unlock
2537  *
2538  * Description :  Unlocks a mutex.
2539  *
2540  * Parameters  :
2541  *          1  :  mutex = The mutex to unlock.
2542  *
2543  * Returns     :  Void. May exit in case of errors.
2544  *
2545  *********************************************************************/
2546 void privoxy_mutex_unlock(privoxy_mutex_t *mutex)
2547 {
2548 #ifdef FEATURE_PTHREAD
2549    int err = pthread_mutex_unlock(mutex);
2550    if (err)
2551    {
2552       if (mutex != &log_mutex)
2553       {
2554          log_error(LOG_LEVEL_FATAL,
2555             "Mutex unlocking failed: %s.\n", strerror(err));
2556       }
2557       exit(1);
2558    }
2559 #else
2560    LeaveCriticalSection(mutex);
2561 #endif /* def FEATURE_PTHREAD */
2562 }
2563
2564
2565 /*********************************************************************
2566  *
2567  * Function    :  privoxy_mutex_init
2568  *
2569  * Description :  Prepares a mutex.
2570  *
2571  * Parameters  :
2572  *          1  :  mutex = The mutex to initialize.
2573  *
2574  * Returns     :  Void. May exit in case of errors.
2575  *
2576  *********************************************************************/
2577 static void privoxy_mutex_init(privoxy_mutex_t *mutex)
2578 {
2579 #ifdef FEATURE_PTHREAD
2580    int err = pthread_mutex_init(mutex, 0);
2581    if (err)
2582    {
2583       printf("Fatal error. Mutex initialization failed: %s.\n",
2584          strerror(err));
2585       exit(1);
2586    }
2587 #else
2588    InitializeCriticalSection(mutex);
2589 #endif /* def FEATURE_PTHREAD */
2590 }
2591 #endif /* def MUTEX_LOCKS_AVAILABLE */
2592
2593 /*********************************************************************
2594  *
2595  * Function    :  initialize_mutexes
2596  *
2597  * Description :  Prepares mutexes if mutex support is available.
2598  *
2599  * Parameters  :  None
2600  *
2601  * Returns     :  Void, exits in case of errors.
2602  *
2603  *********************************************************************/
2604 static void initialize_mutexes(void)
2605 {
2606 #ifdef MUTEX_LOCKS_AVAILABLE
2607    /*
2608     * Prepare global mutex semaphores
2609     */
2610    privoxy_mutex_init(&log_mutex);
2611    privoxy_mutex_init(&log_init_mutex);
2612    privoxy_mutex_init(&connection_reuse_mutex);
2613
2614    /*
2615     * XXX: The assumptions below are a bit naive
2616     * and can cause locks that aren't necessary.
2617     *
2618     * For example older FreeBSD versions (< 6.x?)
2619     * have no gethostbyname_r, but gethostbyname is
2620     * thread safe.
2621     */
2622 #if !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R)
2623    privoxy_mutex_init(&resolver_mutex);
2624 #endif /* !defined(HAVE_GETHOSTBYADDR_R) || !defined(HAVE_GETHOSTBYNAME_R) */
2625    /*
2626     * XXX: should we use a single mutex for
2627     * localtime() and gmtime() as well?
2628     */
2629 #ifndef HAVE_GMTIME_R
2630    privoxy_mutex_init(&gmtime_mutex);
2631 #endif /* ndef HAVE_GMTIME_R */
2632
2633 #ifndef HAVE_LOCALTIME_R
2634    privoxy_mutex_init(&localtime_mutex);
2635 #endif /* ndef HAVE_GMTIME_R */
2636
2637 #ifndef HAVE_RANDOM
2638    privoxy_mutex_init(&rand_mutex);
2639 #endif /* ndef HAVE_RANDOM */
2640 #endif /* def MUTEX_LOCKS_AVAILABLE */
2641 }
2642
2643
2644 /*********************************************************************
2645  *
2646  * Function    :  main
2647  *
2648  * Description :  Load the config file and start the listen loop.
2649  *                This function is a lot more *sane* with the `load_config'
2650  *                and `listen_loop' functions; although it stills does
2651  *                a *little* too much for my taste.
2652  *
2653  * Parameters  :
2654  *          1  :  argc = Number of parameters (including $0).
2655  *          2  :  argv = Array of (char *)'s to the parameters.
2656  *
2657  * Returns     :  1 if : can't open config file, unrecognized directive,
2658  *                stats requested in multi-thread mode, can't open the
2659  *                log file, can't open the jar file, listen port is invalid,
2660  *                any load fails, and can't bind port.
2661  *
2662  *                Else main never returns, the process must be signaled
2663  *                to terminate execution.  Or, on Windows, use the
2664  *                "File", "Exit" menu option.
2665  *
2666  *********************************************************************/
2667 #ifdef __MINGW32__
2668 int real_main(int argc, const char *argv[])
2669 #else
2670 int main(int argc, const char *argv[])
2671 #endif
2672 {
2673    int argc_pos = 0;
2674    unsigned int random_seed;
2675 #ifdef unix
2676    struct passwd *pw = NULL;
2677    struct group *grp = NULL;
2678    char *p;
2679    int do_chroot = 0;
2680    char *pre_chroot_nslookup_to_load_resolver = NULL;
2681 #endif
2682
2683    Argc = argc;
2684    Argv = argv;
2685
2686    configfile =
2687 #if !defined(_WIN32)
2688    "config"
2689 #else
2690    "config.txt"
2691 #endif
2692       ;
2693
2694    /* Prepare mutexes if supported and necessary. */
2695    initialize_mutexes();
2696
2697    /* Enable logging until further notice. */
2698    init_log_module();
2699
2700    /*
2701     * Parse the command line arguments
2702     *
2703     * XXX: simply printing usage information in case of
2704     * invalid arguments isn't particularly user friendly.
2705     */
2706    while (++argc_pos < argc)
2707    {
2708 #ifdef _WIN32
2709       /* Check to see if the service must be installed or uninstalled */
2710       if (strncmp(argv[argc_pos], "--install", 9) == 0)
2711       {
2712          const char *pName = argv[argc_pos] + 9;
2713          if (*pName == ':')
2714             pName++;
2715          exit( (install_service(pName)) ? 0 : 1 );
2716       }
2717       else if (strncmp(argv[argc_pos], "--uninstall", + 11) == 0)
2718       {
2719          const char *pName = argv[argc_pos] + 11;
2720          if (*pName == ':')
2721             pName++;
2722          exit((uninstall_service(pName)) ? 0 : 1);
2723       }
2724       else if (strcmp(argv[argc_pos], "--service" ) == 0)
2725       {
2726          bRunAsService = TRUE;
2727          w32_set_service_cwd();
2728          atexit(w32_service_exit_notify);
2729       }
2730       else
2731 #endif /* defined(_WIN32) */
2732
2733
2734 #if !defined(_WIN32) || defined(_WIN_CONSOLE)
2735
2736       if (strcmp(argv[argc_pos], "--help") == 0)
2737       {
2738          usage(argv[0]);
2739       }
2740
2741       else if(strcmp(argv[argc_pos], "--version") == 0)
2742       {
2743          printf("Privoxy version " VERSION " (" HOME_PAGE_URL ")\n");
2744          exit(0);
2745       }
2746
2747 #if defined(unix)
2748
2749       else if (strcmp(argv[argc_pos], "--no-daemon" ) == 0)
2750       {
2751          set_debug_level(LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
2752          no_daemon = 1;
2753       }
2754
2755       else if (strcmp(argv[argc_pos], "--pidfile" ) == 0)
2756       {
2757          if (++argc_pos == argc) usage(argv[0]);
2758          pidfile = strdup(argv[argc_pos]);
2759       }
2760
2761       else if (strcmp(argv[argc_pos], "--user" ) == 0)
2762       {
2763          if (++argc_pos == argc) usage(argv[argc_pos]);
2764
2765          if ((NULL != (p = strchr(argv[argc_pos], '.'))) && *(p + 1) != '0')
2766          {
2767             *p++ = '\0';
2768             if (NULL == (grp = getgrnam(p)))
2769             {
2770                log_error(LOG_LEVEL_FATAL, "Group %s not found.", p);
2771             }
2772          }
2773
2774          if (NULL == (pw = getpwnam(argv[argc_pos])))
2775          {
2776             log_error(LOG_LEVEL_FATAL, "User %s not found.", argv[argc_pos]);
2777          }
2778
2779          if (p != NULL) *--p = '\0';
2780       }
2781
2782       else if (strcmp(argv[argc_pos], "--pre-chroot-nslookup" ) == 0)
2783       {
2784          if (++argc_pos == argc) usage(argv[0]);
2785          pre_chroot_nslookup_to_load_resolver = strdup(argv[argc_pos]);
2786       }
2787
2788       else if (strcmp(argv[argc_pos], "--chroot" ) == 0)
2789       {
2790          do_chroot = 1;
2791       }
2792 #endif /* defined(unix) */
2793
2794       else if (argc_pos + 1 != argc)
2795       {
2796          /*
2797           * This is neither the last command line
2798           * option, nor was it recognized before,
2799           * therefore it must be invalid.
2800           */
2801          usage(argv[0]);
2802       }
2803       else
2804
2805 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
2806       {
2807          configfile = argv[argc_pos];
2808       }
2809
2810    } /* -END- while (more arguments) */
2811
2812    show_version(Argv[0]);
2813
2814 #if defined(unix)
2815    if ( *configfile != '/' )
2816    {
2817       char cwd[BUFFER_SIZE];
2818       char *abs_file;
2819       size_t abs_file_size;
2820
2821       /* make config-filename absolute here */
2822       if (NULL == getcwd(cwd, sizeof(cwd)))
2823       {
2824          perror("failed to get current working directory");
2825          exit( 1 );
2826       }
2827
2828       /* XXX: why + 5? */
2829       abs_file_size = strlen(cwd) + strlen(configfile) + 5;
2830       basedir = strdup(cwd);
2831
2832       if (NULL == basedir ||
2833           NULL == (abs_file = malloc(abs_file_size)))
2834       {
2835          perror("malloc failed");
2836          exit( 1 );
2837       }
2838       strlcpy(abs_file, basedir, abs_file_size);
2839       strlcat(abs_file, "/", abs_file_size );
2840       strlcat(abs_file, configfile, abs_file_size);
2841       configfile = abs_file;
2842    }
2843 #endif /* defined unix */
2844
2845
2846    files->next = NULL;
2847    clients->next = NULL;
2848
2849    /* XXX: factor out initialising after the next stable release. */
2850 #ifdef AMIGA
2851    InitAmiga();
2852 #elif defined(_WIN32)
2853    InitWin32();
2854 #endif
2855
2856    random_seed = (unsigned int)time(NULL);
2857 #ifdef HAVE_RANDOM
2858    srandom(random_seed);
2859 #else
2860    srand(random_seed);
2861 #endif /* ifdef HAVE_RANDOM */
2862
2863    /*
2864     * Unix signal handling
2865     *
2866     * Catch the abort, interrupt and terminate signals for a graceful exit
2867     * Catch the hangup signal so the errlog can be reopened.
2868     * Ignore the broken pipe signals (FIXME: Why?)
2869     */
2870 #if !defined(_WIN32) && !defined(__OS2__) && !defined(AMIGA)
2871 {
2872    int idx;
2873    const int catched_signals[] = { SIGTERM, SIGINT, SIGHUP, 0 };
2874    const int ignored_signals[] = { SIGPIPE, 0 };
2875
2876    for (idx = 0; catched_signals[idx] != 0; idx++)
2877    {
2878 #ifdef sun /* FIXME: Is it safe to check for HAVE_SIGSET instead? */
2879       if (sigset(catched_signals[idx], sig_handler) == SIG_ERR)
2880 #else
2881       if (signal(catched_signals[idx], sig_handler) == SIG_ERR)
2882 #endif /* ifdef sun */
2883       {
2884          log_error(LOG_LEVEL_FATAL, "Can't set signal-handler for signal %d: %E", catched_signals[idx]);
2885       }
2886    }
2887
2888    for (idx = 0; ignored_signals[idx] != 0; idx++)
2889    {
2890       if (signal(ignored_signals[idx], SIG_IGN) == SIG_ERR)
2891       {
2892          log_error(LOG_LEVEL_FATAL, "Can't set ignore-handler for signal %d: %E", ignored_signals[idx]);
2893       }
2894    }
2895
2896 }
2897 #else /* ifdef _WIN32 */
2898 # ifdef _WIN_CONSOLE
2899    /*
2900     * We *are* in a windows console app.
2901     * Print a verbose messages about FAQ's and such
2902     */
2903    printf("%s", win32_blurb);
2904 # endif /* def _WIN_CONSOLE */
2905 #endif /* def _WIN32 */
2906
2907
2908    /* Initialize the CGI subsystem */
2909    cgi_init_error_messages();
2910
2911    /*
2912     * If runnig on unix and without the --nodaemon
2913     * option, become a daemon. I.e. fork, detach
2914     * from tty and get process group leadership
2915     */
2916 #if defined(unix)
2917 {
2918    pid_t pid = 0;
2919 #if 0
2920    int   fd;
2921 #endif
2922
2923    if (!no_daemon)
2924    {
2925       pid  = fork();
2926
2927       if ( pid < 0 ) /* error */
2928       {
2929          perror("fork");
2930          exit( 3 );
2931       }
2932       else if ( pid != 0 ) /* parent */
2933       {
2934          int status;
2935          pid_t wpid;
2936          /*
2937           * must check for errors
2938           * child died due to missing files aso
2939           */
2940          sleep( 1 );
2941          wpid = waitpid( pid, &status, WNOHANG );
2942          if ( wpid != 0 )
2943          {
2944             exit( 1 );
2945          }
2946          exit( 0 );
2947       }
2948       /* child */
2949 #if 1
2950       /* Should be more portable, but not as well tested */
2951       setsid();
2952 #else /* !1 */
2953 #ifdef __FreeBSD__
2954       setpgrp(0,0);
2955 #else /* ndef __FreeBSD__ */
2956       setpgrp();
2957 #endif /* ndef __FreeBSD__ */
2958       fd = open("/dev/tty", O_RDONLY);
2959       if ( fd )
2960       {
2961          /* no error check here */
2962          ioctl( fd, TIOCNOTTY,0 );
2963          close ( fd );
2964       }
2965 #endif /* 1 */
2966       /*
2967        * stderr (fd 2) will be closed later on,
2968        * when the config file has been parsed.
2969        */
2970
2971       close( 0 );
2972       close( 1 );
2973       chdir("/");
2974
2975    } /* -END- if (!no_daemon) */
2976
2977    /*
2978     * As soon as we have written the PID file, we can switch
2979     * to the user and group ID indicated by the --user option
2980     */
2981    write_pid_file();
2982
2983    if (NULL != pw)
2984    {
2985       if (setgid((NULL != grp) ? grp->gr_gid : pw->pw_gid))
2986       {
2987          log_error(LOG_LEVEL_FATAL, "Cannot setgid(): Insufficient permissions.");
2988       }
2989       if (NULL != grp)
2990       {
2991          if (setgroups(1, &grp->gr_gid))
2992          {
2993             log_error(LOG_LEVEL_FATAL, "setgroups() failed: %E");
2994          }
2995       }
2996       else if (initgroups(pw->pw_name, pw->pw_gid))
2997       {
2998          log_error(LOG_LEVEL_FATAL, "initgroups() failed: %E");
2999       }
3000       if (do_chroot)
3001       {
3002          if (!pw->pw_dir)
3003          {
3004             log_error(LOG_LEVEL_FATAL, "Home directory for %s undefined", pw->pw_name);
3005          }
3006          /* Read the time zone file from /etc before doing chroot. */
3007          tzset();
3008          if (NULL != pre_chroot_nslookup_to_load_resolver
3009              && '\0' != pre_chroot_nslookup_to_load_resolver[0])
3010          {
3011             /* Initialize resolver library. */
3012             (void) resolve_hostname_to_ip(pre_chroot_nslookup_to_load_resolver);
3013          }
3014          if (chroot(pw->pw_dir) < 0)
3015          {
3016             log_error(LOG_LEVEL_FATAL, "Cannot chroot to %s", pw->pw_dir);
3017          }
3018          if (chdir ("/"))
3019          {
3020             log_error(LOG_LEVEL_FATAL, "Cannot chdir /");
3021          }
3022       }
3023       if (setuid(pw->pw_uid))
3024       {
3025          log_error(LOG_LEVEL_FATAL, "Cannot setuid(): Insufficient permissions.");
3026       }
3027       if (do_chroot)
3028       {
3029          char putenv_dummy[64];
3030
3031          strlcpy(putenv_dummy, "HOME=/", sizeof(putenv_dummy));
3032          if (putenv(putenv_dummy) != 0)
3033          {
3034             log_error(LOG_LEVEL_FATAL, "Cannot putenv(): HOME");
3035          }
3036
3037          snprintf(putenv_dummy, sizeof(putenv_dummy), "USER=%s", pw->pw_name);
3038          if (putenv(putenv_dummy) != 0)
3039          {
3040             log_error(LOG_LEVEL_FATAL, "Cannot putenv(): USER");
3041          }
3042       }
3043    }
3044    else if (do_chroot)
3045    {
3046       log_error(LOG_LEVEL_FATAL, "Cannot chroot without --user argument.");
3047    }
3048 }
3049 #endif /* defined unix */
3050
3051 #ifdef _WIN32
3052    /* This will be FALSE unless the command line specified --service
3053     */
3054    if (bRunAsService)
3055    {
3056       /* Yup, so now we must attempt to establish a connection
3057        * with the service dispatcher. This will only work if this
3058        * process was launched by the service control manager to
3059        * actually run as a service. If this isn't the case, i've
3060        * known it take around 30 seconds or so for the call to return.
3061        */
3062
3063       /* The StartServiceCtrlDispatcher won't return until the service is stopping */
3064       if (w32_start_service_ctrl_dispatcher(w32ServiceDispatchTable))
3065       {
3066          /* Service has run, and at this point is now being stopped, so just return */
3067          return 0;
3068       }
3069
3070 #ifdef _WIN_CONSOLE
3071       printf("Warning: Failed to connect to Service Control Dispatcher\nwhen starting as a service!\n");
3072 #endif
3073       /* An error occurred. Usually it's because --service was wrongly specified
3074        * and we were unable to connect to the Service Control Dispatcher because
3075        * it wasn't expecting us and is therefore not listening.
3076        *
3077        * For now, just continue below to call the listen_loop function.
3078        */
3079    }
3080 #endif /* def _WIN32 */
3081
3082    listen_loop();
3083
3084    /* NOTREACHED */
3085    return(-1);
3086
3087 }
3088
3089
3090 /*********************************************************************
3091  *
3092  * Function    :  bind_port_helper
3093  *
3094  * Description :  Bind the listen port.  Handles logging, and aborts
3095  *                on failure.
3096  *
3097  * Parameters  :
3098  *          1  :  config = Privoxy configuration.  Specifies port
3099  *                         to bind to.
3100  *
3101  * Returns     :  Port that was opened.
3102  *
3103  *********************************************************************/
3104 static jb_socket bind_port_helper(struct configuration_spec * config)
3105 {
3106    int result;
3107    jb_socket bfd;
3108
3109    if (config->haddr == NULL)
3110    {
3111       log_error(LOG_LEVEL_INFO, "Listening on port %d on all IP addresses",
3112                 config->hport);
3113    }
3114    else
3115    {
3116       log_error(LOG_LEVEL_INFO, "Listening on port %d on IP address %s",
3117                 config->hport, config->haddr);
3118    }
3119
3120    result = bind_port(config->haddr, config->hport, &bfd);
3121
3122    if (result < 0)
3123    {
3124       switch(result)
3125       {
3126          case -3 :
3127             log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
3128                "There may be another Privoxy or some other "
3129                "proxy running on port %d",
3130                (NULL != config->haddr) ? config->haddr : "INADDR_ANY",
3131                       config->hport, config->hport);
3132
3133          case -2 :
3134             log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: "
3135                "The hostname is not resolvable",
3136                (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
3137
3138          default :
3139             log_error(LOG_LEVEL_FATAL, "can't bind to %s:%d: %E",
3140                (NULL != config->haddr) ? config->haddr : "INADDR_ANY", config->hport);
3141       }
3142
3143       /* shouldn't get here */
3144       return JB_INVALID_SOCKET;
3145    }
3146
3147    config->need_bind = 0;
3148
3149    return bfd;
3150 }
3151
3152
3153 #ifdef _WIN32
3154 /* Without this simple workaround we get this compiler warning from _beginthread
3155  *     warning C4028: formal parameter 1 different from declaration
3156  */
3157 void w32_service_listen_loop(void *p)
3158 {
3159    listen_loop();
3160 }
3161 #endif /* def _WIN32 */
3162
3163
3164 /*********************************************************************
3165  *
3166  * Function    :  listen_loop
3167  *
3168  * Description :  bind the listen port and enter a "FOREVER" listening loop.
3169  *
3170  * Parameters  :  N/A
3171  *
3172  * Returns     :  Never.
3173  *
3174  *********************************************************************/
3175 static void listen_loop(void)
3176 {
3177    struct client_state *csp = NULL;
3178    jb_socket bfd;
3179    struct configuration_spec *config;
3180    unsigned int active_threads = 0;
3181
3182    config = load_config();
3183
3184 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3185    /*
3186     * XXX: Should be relocated once it no
3187     * longer needs to emit log messages.
3188     */
3189    initialize_reusable_connections();
3190 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
3191
3192    bfd = bind_port_helper(config);
3193
3194 #ifdef FEATURE_GRACEFUL_TERMINATION
3195    while (!g_terminate)
3196 #else
3197    for (;;)
3198 #endif
3199    {
3200 #if !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
3201       while (waitpid(-1, NULL, WNOHANG) > 0)
3202       {
3203          /* zombie children */
3204       }
3205 #endif /* !defined(FEATURE_PTHREAD) && !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
3206
3207       /*
3208        * Free data that was used by died threads
3209        */
3210       active_threads = sweep();
3211
3212 #if defined(unix)
3213       /*
3214        * Re-open the errlog after HUP signal
3215        */
3216       if (received_hup_signal)
3217       {
3218          if (NULL != config->logfile)
3219          {
3220             init_error_log(Argv[0], config->logfile);
3221          }
3222          received_hup_signal = 0;
3223       }
3224 #endif
3225
3226       if ( NULL == (csp = (struct client_state *) zalloc(sizeof(*csp))) )
3227       {
3228          log_error(LOG_LEVEL_FATAL, "malloc(%d) for csp failed: %E", sizeof(*csp));
3229          continue;
3230       }
3231
3232       csp->flags |= CSP_FLAG_ACTIVE;
3233       csp->sfd    = JB_INVALID_SOCKET;
3234
3235       csp->config = config = load_config();
3236
3237       if ( config->need_bind )
3238       {
3239          /*
3240           * Since we were listening to the "old port", we will not see
3241           * a "listen" param change until the next request.  So, at
3242           * least 1 more request must be made for us to find the new
3243           * setting.  I am simply closing the old socket and binding the
3244           * new one.
3245           *
3246           * Which-ever is correct, we will serve 1 more page via the
3247           * old settings.  This should probably be a "show-proxy-args"
3248           * request.  This should not be a so common of an operation
3249           * that this will hurt people's feelings.
3250           */
3251
3252          close_socket(bfd);
3253
3254          bfd = bind_port_helper(config);
3255       }
3256
3257       log_error(LOG_LEVEL_CONNECT, "Listening for new connections ... ");
3258
3259       if (!accept_connection(csp, bfd))
3260       {
3261          log_error(LOG_LEVEL_CONNECT, "accept failed: %E");
3262
3263 #ifdef AMIGA
3264          if(!childs)
3265          {
3266             exit(1);
3267          }
3268 #endif
3269          freez(csp);
3270          continue;
3271       }
3272       else
3273       {
3274          log_error(LOG_LEVEL_CONNECT, "accepted connection from %s", csp->ip_addr_str);
3275       }
3276
3277 #ifdef FEATURE_TOGGLE
3278       if (global_toggle_state)
3279 #endif /* def FEATURE_TOGGLE */
3280       {
3281          csp->flags |= CSP_FLAG_TOGGLED_ON;
3282       }
3283
3284       if (run_loader(csp))
3285       {
3286          log_error(LOG_LEVEL_FATAL, "a loader failed - must exit");
3287          /* Never get here - LOG_LEVEL_FATAL causes program exit */
3288       }
3289
3290 #ifdef FEATURE_ACL
3291       if (block_acl(NULL,csp))
3292       {
3293          log_error(LOG_LEVEL_CONNECT, "Connection from %s dropped due to ACL", csp->ip_addr_str);
3294          close_socket(csp->cfd);
3295          freez(csp->ip_addr_str);
3296          freez(csp);
3297          continue;
3298       }
3299 #endif /* def FEATURE_ACL */
3300
3301       if ((0 != config->max_client_connections)
3302          && (active_threads >= config->max_client_connections))
3303       {
3304          log_error(LOG_LEVEL_CONNECT,
3305             "Rejecting connection from %s. Maximum number of connections reached.",
3306             csp->ip_addr_str);
3307          write_socket(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
3308             strlen(TOO_MANY_CONNECTIONS_RESPONSE));
3309          close_socket(csp->cfd);
3310          freez(csp->ip_addr_str);
3311          freez(csp);
3312          continue;
3313       }
3314
3315       /* add it to the list of clients */
3316       csp->next = clients->next;
3317       clients->next = csp;
3318
3319       if (config->multi_threaded)
3320       {
3321          int child_id;
3322
3323 /* this is a switch () statment in the C preprocessor - ugh */
3324 #undef SELECTED_ONE_OPTION
3325
3326 /* Use Pthreads in preference to native code */
3327 #if defined(FEATURE_PTHREAD) && !defined(SELECTED_ONE_OPTION)
3328 #define SELECTED_ONE_OPTION
3329          {
3330             pthread_t the_thread;
3331             pthread_attr_t attrs;
3332
3333             pthread_attr_init(&attrs);
3334             pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED);
3335             errno = pthread_create(&the_thread, &attrs,
3336                (void * (*)(void *))serve, csp);
3337             child_id = errno ? -1 : 0;
3338             pthread_attr_destroy(&attrs);
3339          }
3340 #endif
3341
3342 #if defined(_WIN32) && !defined(_CYGWIN) && !defined(SELECTED_ONE_OPTION)
3343 #define SELECTED_ONE_OPTION
3344          child_id = _beginthread(
3345             (void (*)(void *))serve,
3346             64 * 1024,
3347             csp);
3348 #endif
3349
3350 #if defined(__OS2__) && !defined(SELECTED_ONE_OPTION)
3351 #define SELECTED_ONE_OPTION
3352          child_id = _beginthread(
3353             (void(* _Optlink)(void*))serve,
3354             NULL,
3355             64 * 1024,
3356             csp);
3357 #endif
3358
3359 #if defined(__BEOS__) && !defined(SELECTED_ONE_OPTION)
3360 #define SELECTED_ONE_OPTION
3361          {
3362             thread_id tid = spawn_thread
3363                (server_thread, "server", B_NORMAL_PRIORITY, csp);
3364
3365             if ((tid >= 0) && (resume_thread(tid) == B_OK))
3366             {
3367                child_id = (int) tid;
3368             }
3369             else
3370             {
3371                child_id = -1;
3372             }
3373          }
3374 #endif
3375
3376 #if defined(AMIGA) && !defined(SELECTED_ONE_OPTION)
3377 #define SELECTED_ONE_OPTION
3378          csp->cfd = ReleaseSocket(csp->cfd, -1);
3379
3380 #ifdef __amigaos4__
3381          child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
3382                                            NP_Output, Output(),
3383                                            NP_CloseOutput, FALSE,
3384                                            NP_Name, (ULONG)"privoxy child",
3385                                            NP_Child, TRUE,
3386                                            TAG_DONE);
3387 #else
3388          child_id = (int)CreateNewProcTags(NP_Entry, (ULONG)server_thread,
3389                                            NP_Output, Output(),
3390                                            NP_CloseOutput, FALSE,
3391                                            NP_Name, (ULONG)"privoxy child",
3392                                            NP_StackSize, 200*1024,
3393                                            TAG_DONE);
3394 #endif
3395          if(0 != child_id)
3396          {
3397             childs++;
3398             ((struct Task *)child_id)->tc_UserData = csp;
3399             Signal((struct Task *)child_id, SIGF_SINGLE);
3400             Wait(SIGF_SINGLE);
3401          }
3402 #endif
3403
3404 #if !defined(SELECTED_ONE_OPTION)
3405          child_id = fork();
3406
3407          /* This block is only needed when using fork().
3408           * When using threads, the server thread was
3409           * created and run by the call to _beginthread().
3410           */
3411          if (child_id == 0)   /* child */
3412          {
3413             int rc = 0;
3414 #ifdef FEATURE_TOGGLE
3415             int inherited_toggle_state = global_toggle_state;
3416 #endif /* def FEATURE_TOGGLE */
3417
3418             serve(csp);
3419
3420             /*
3421              * If we've been toggled or we've blocked the request, tell Mom
3422              */
3423
3424 #ifdef FEATURE_TOGGLE
3425             if (inherited_toggle_state != global_toggle_state)
3426             {
3427                rc |= RC_FLAG_TOGGLED;
3428             }
3429 #endif /* def FEATURE_TOGGLE */
3430
3431 #ifdef FEATURE_STATISTICS
3432             if (csp->flags & CSP_FLAG_REJECTED)
3433             {
3434                rc |= RC_FLAG_BLOCKED;
3435             }
3436 #endif /* ndef FEATURE_STATISTICS */
3437
3438             _exit(rc);
3439          }
3440          else if (child_id > 0) /* parent */
3441          {
3442             /* in a fork()'d environment, the parent's
3443              * copy of the client socket and the CSP
3444              * are not used.
3445              */
3446             int child_status;
3447 #if !defined(_WIN32) && !defined(__CYGWIN__)
3448
3449             wait( &child_status );
3450
3451             /*
3452              * Evaluate child's return code: If the child has
3453              *  - been toggled, toggle ourselves
3454              *  - blocked its request, bump up the stats counter
3455              */
3456
3457 #ifdef FEATURE_TOGGLE
3458             if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_TOGGLED))
3459             {
3460                global_toggle_state = !global_toggle_state;
3461             }
3462 #endif /* def FEATURE_TOGGLE */
3463
3464 #ifdef FEATURE_STATISTICS
3465             urls_read++;
3466             if (WIFEXITED(child_status) && (WEXITSTATUS(child_status) & RC_FLAG_BLOCKED))
3467             {
3468                urls_rejected++;
3469             }
3470 #endif /* def FEATURE_STATISTICS */
3471
3472 #endif /* !defined(_WIN32) && defined(__CYGWIN__) */
3473             close_socket(csp->cfd);
3474             csp->flags &= ~CSP_FLAG_ACTIVE;
3475          }
3476 #endif
3477
3478 #undef SELECTED_ONE_OPTION
3479 /* end of cpp switch () */
3480
3481          if (child_id < 0)
3482          {
3483             /*
3484              * Spawning the child failed, assume it's because
3485              * there are too many children running already.
3486              * XXX: If you assume ...
3487              */
3488             log_error(LOG_LEVEL_ERROR,
3489                "Unable to take any additional connections: %E");
3490             write_socket(csp->cfd, TOO_MANY_CONNECTIONS_RESPONSE,
3491                strlen(TOO_MANY_CONNECTIONS_RESPONSE));
3492             close_socket(csp->cfd);
3493             csp->flags &= ~CSP_FLAG_ACTIVE;
3494          }
3495       }
3496       else
3497       {
3498          serve(csp);
3499       }
3500    }
3501
3502    /* NOTREACHED unless FEATURE_GRACEFUL_TERMINATION is defined */
3503
3504    /* Clean up.  Aim: free all memory (no leaks) */
3505 #ifdef FEATURE_GRACEFUL_TERMINATION
3506
3507    log_error(LOG_LEVEL_ERROR, "Graceful termination requested");
3508
3509    unload_current_config_file();
3510    unload_current_actions_file();
3511    unload_current_re_filterfile();
3512 #ifdef FEATURE_TRUST
3513    unload_current_trust_file();
3514 #endif
3515
3516    if (config->multi_threaded)
3517    {
3518       int i = 60;
3519       do
3520       {
3521          sleep(1);
3522          sweep();
3523       } while ((clients->next != NULL) && (--i > 0));
3524
3525       if (i <= 0)
3526       {
3527          log_error(LOG_LEVEL_ERROR, "Graceful termination failed - still some live clients after 1 minute wait.");
3528       }
3529    }
3530    sweep();
3531    sweep();
3532
3533 #if defined(unix)
3534    freez(basedir);
3535 #endif
3536    freez(configfile);
3537
3538 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
3539    /* Cleanup - remove taskbar icon etc. */
3540    TermLogWindow();
3541 #endif
3542
3543    exit(0);
3544 #endif /* FEATURE_GRACEFUL_TERMINATION */
3545
3546 }
3547
3548
3549 /*
3550   Local Variables:
3551   tab-width: 3
3552   end:
3553 */