parsers.c

   1 const char parsers_rcs[] = "$Id: parsers.c,v 1.311 2016/12/24 16:00:49 fabiankeil Exp $";
   2 /*********************************************************************
   3  *
   4  * File        :  $Source: /cvsroot/ijbswa/current/parsers.c,v $
   5  *
   6  * Purpose     :  Declares functions to parse/crunch headers and pages.
   7  *
   8  * Copyright   :  Written by and Copyright (C) 2001-2016 the
   9  *                Privoxy team. http://www.privoxy.org/
  10  *
  11  *                Based on the Internet Junkbuster originally written
  12  *                by and Copyright (C) 1997 Anonymous Coders and
  13  *                Junkbusters Corporation.  http://www.junkbusters.com
  14  *
  15  *                This program is free software; you can redistribute it
  16  *                and/or modify it under the terms of the GNU General
  17  *                Public License as published by the Free Software
  18  *                Foundation; either version 2 of the License, or (at
  19  *                your option) any later version.
  20  *
  21  *                This program is distributed in the hope that it will
  22  *                be useful, but WITHOUT ANY WARRANTY; without even the
  23  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  24  *                PARTICULAR PURPOSE.  See the GNU General Public
  25  *                License for more details.
  26  *
  27  *                The GNU General Public License should be included with
  28  *                this file.  If not, you can view it at
  29  *                http://www.gnu.org/copyleft/gpl.html
  30  *                or write to the Free Software Foundation, Inc., 59
  31  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  32  *
  33  *********************************************************************/
  34
  35
  36 #include "config.h"
  37
  38 #ifndef _WIN32
  39 #include <stdio.h>
  40 #include <sys/types.h>
  41 #endif
  42
  43 #include <stdlib.h>
  44 #include <ctype.h>
  45 #include <assert.h>
  46 #include <string.h>
  47
  48 #ifdef __GLIBC__
  49 /*
  50  * Convince GNU's libc to provide a strptime prototype.
  51  */
  52 #define __USE_XOPEN
  53 #endif /*__GLIBC__ */
  54 #include <time.h>
  55
  56 #ifdef FEATURE_ZLIB
  57 #include <zlib.h>
  58
  59 #define GZIP_IDENTIFIER_1       0x1f
  60 #define GZIP_IDENTIFIER_2       0x8b
  61
  62 #define GZIP_FLAG_CHECKSUM      0x02
  63 #define GZIP_FLAG_EXTRA_FIELDS  0x04
  64 #define GZIP_FLAG_FILE_NAME     0x08
  65 #define GZIP_FLAG_COMMENT       0x10
  66 #define GZIP_FLAG_RESERVED_BITS 0xe0
  67 #endif
  68
  69 #if !defined(_WIN32) && !defined(__OS2__)
  70 #include <unistd.h>
  71 #endif
  72
  73 #include "project.h"
  74
  75 #ifdef FEATURE_PTHREAD
  76 #include "jcc.h"
  77 /* jcc.h is for mutex semapores only */
  78 #endif /* def FEATURE_PTHREAD */
  79 #include "list.h"
  80 #include "parsers.h"
  81 #include "ssplit.h"
  82 #include "errlog.h"
  83 #include "jbsockets.h"
  84 #include "miscutil.h"
  85 #include "list.h"
  86 #include "actions.h"
  87 #include "filters.h"
  88
  89 #ifndef HAVE_STRPTIME
  90 #include "strptime.h"
  91 #endif
  92
  93 const char parsers_h_rcs[] = PARSERS_H_VERSION;
  94
  95 static char *get_header_line(struct iob *iob);
  96 static jb_err scan_headers(struct client_state *csp);
  97 static jb_err header_tagger(struct client_state *csp, char *header);
  98 static jb_err parse_header_time(const char *header_time, time_t *result);
  99 static jb_err parse_time_header(const char *header, time_t *result);
 100
 101 static jb_err crumble                   (struct client_state *csp, char **header);
 102 static jb_err filter_header             (struct client_state *csp, char **header);
 103 static jb_err client_connection         (struct client_state *csp, char **header);
 104 static jb_err client_referrer           (struct client_state *csp, char **header);
 105 static jb_err client_uagent             (struct client_state *csp, char **header);
 106 static jb_err client_ua                 (struct client_state *csp, char **header);
 107 static jb_err client_from               (struct client_state *csp, char **header);
 108 static jb_err client_send_cookie        (struct client_state *csp, char **header);
 109 static jb_err client_x_forwarded        (struct client_state *csp, char **header);
 110 static jb_err client_accept_encoding    (struct client_state *csp, char **header);
 111 static jb_err client_te                 (struct client_state *csp, char **header);
 112 static jb_err client_max_forwards       (struct client_state *csp, char **header);
 113 static jb_err client_host               (struct client_state *csp, char **header);
 114 static jb_err client_if_modified_since  (struct client_state *csp, char **header);
 115 static jb_err client_accept_language    (struct client_state *csp, char **header);
 116 static jb_err client_if_none_match      (struct client_state *csp, char **header);
 117 static jb_err crunch_client_header      (struct client_state *csp, char **header);
 118 static jb_err client_x_filter           (struct client_state *csp, char **header);
 119 static jb_err client_range              (struct client_state *csp, char **header);
 120 static jb_err client_expect             (struct client_state *csp, char **header);
 121 static jb_err server_set_cookie         (struct client_state *csp, char **header);
 122 static jb_err server_connection         (struct client_state *csp, char **header);
 123 static jb_err server_content_type       (struct client_state *csp, char **header);
 124 static jb_err server_adjust_content_length(struct client_state *csp, char **header);
 125 static jb_err server_content_md5        (struct client_state *csp, char **header);
 126 static jb_err server_content_encoding   (struct client_state *csp, char **header);
 127 static jb_err server_transfer_coding    (struct client_state *csp, char **header);
 128 static jb_err server_http               (struct client_state *csp, char **header);
 129 static jb_err crunch_server_header      (struct client_state *csp, char **header);
 130 static jb_err server_last_modified      (struct client_state *csp, char **header);
 131 static jb_err server_content_disposition(struct client_state *csp, char **header);
 132 #ifdef FEATURE_ZLIB
 133 static jb_err server_adjust_content_encoding(struct client_state *csp, char **header);
 134 #endif
 135
 136 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
 137 static jb_err server_save_content_length(struct client_state *csp, char **header);
 138 static jb_err server_keep_alive(struct client_state *csp, char **header);
 139 static jb_err server_proxy_connection(struct client_state *csp, char **header);
 140 static jb_err client_keep_alive(struct client_state *csp, char **header);
 141 static jb_err client_save_content_length(struct client_state *csp, char **header);
 142 static jb_err client_proxy_connection(struct client_state *csp, char **header);
 143 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
 144
 145 static jb_err client_host_adder       (struct client_state *csp);
 146 static jb_err client_xtra_adder       (struct client_state *csp);
 147 static jb_err client_x_forwarded_for_adder(struct client_state *csp);
 148 static jb_err client_connection_header_adder(struct client_state *csp);
 149 static jb_err server_connection_adder(struct client_state *csp);
 150 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
 151 static jb_err server_proxy_connection_adder(struct client_state *csp);
 152 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
 153 static jb_err proxy_authentication(struct client_state *csp, char **header);
 154
 155 static jb_err create_forged_referrer(char **header, const char *hostport);
 156 static jb_err create_fake_referrer(char **header, const char *fake_referrer);
 157 static jb_err handle_conditional_hide_referrer_parameter(char **header,
 158    const char *host, const int parameter_conditional_block);
 159 static void create_content_length_header(unsigned long long content_length,
 160                                          char *header, size_t buffer_length);
 161
 162 /*
 163  * List of functions to run on a list of headers.
 164  */
 165 struct parsers
 166 {
 167    /** The header prefix to match */
 168    const char *str;
 169
 170    /** The length of the prefix to match */
 171    const size_t len;
 172
 173    /** The function to apply to this line */
 174    const parser_func_ptr parser;
 175 };
 176
 177 static const struct parsers client_patterns[] = {
 178    { "referer:",                  8,   client_referrer },
 179    { "user-agent:",              11,   client_uagent },
 180    { "ua-",                       3,   client_ua },
 181    { "from:",                     5,   client_from },
 182    { "cookie:",                   7,   client_send_cookie },
 183    { "x-forwarded-for:",         16,   client_x_forwarded },
 184    { "Accept-Encoding:",         16,   client_accept_encoding },
 185    { "TE:",                       3,   client_te },
 186    { "Host:",                     5,   client_host },
 187    { "if-modified-since:",       18,   client_if_modified_since },
 188 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
 189    { "Keep-Alive:",              11,   client_keep_alive },
 190    { "Content-Length:",          15,   client_save_content_length },
 191    { "Proxy-Connection:",        17,   client_proxy_connection },
 192 #else
 193    { "Keep-Alive:",              11,   crumble },
 194    { "Proxy-Connection:",        17,   crumble },
 195 #endif
 196    { "connection:",              11,   client_connection },
 197    { "max-forwards:",            13,   client_max_forwards },
 198    { "Accept-Language:",         16,   client_accept_language },
 199    { "if-none-match:",           14,   client_if_none_match },
 200    { "Range:",                    6,   client_range },
 201    { "Request-Range:",           14,   client_range },
 202    { "If-Range:",                 9,   client_range },
 203    { "X-Filter:",                 9,   client_x_filter },
 204    { "Proxy-Authorization:",     20,   proxy_authentication },
 205 #if 0
 206    { "Transfer-Encoding:",       18,   client_transfer_encoding },
 207 #endif
 208    { "Expect:",                   7,   client_expect },
 209    { "*",                         0,   crunch_client_header },
 210    { "*",                         0,   filter_header },
 211    { NULL,                        0,   NULL }
 212 };
 213
 214 static const struct parsers server_patterns[] = {
 215    { "HTTP/",                     5, server_http },
 216    { "set-cookie:",              11, server_set_cookie },
 217    { "connection:",              11, server_connection },
 218    { "Content-Type:",            13, server_content_type },
 219    { "Content-MD5:",             12, server_content_md5 },
 220    { "Content-Encoding:",        17, server_content_encoding },
 221 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
 222    { "Content-Length:",          15, server_save_content_length },
 223    { "Keep-Alive:",              11, server_keep_alive },
 224    { "Proxy-Connection:",        17, server_proxy_connection },
 225 #else
 226    { "Keep-Alive:",              11, crumble },
 227 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
 228    { "Transfer-Encoding:",       18, server_transfer_coding },
 229    { "content-disposition:",     20, server_content_disposition },
 230    { "Last-Modified:",           14, server_last_modified },
 231    { "Proxy-Authenticate:",      19, proxy_authentication },
 232    { "*",                         0, crunch_server_header },
 233    { "*",                         0, filter_header },
 234    { NULL,                        0, NULL }
 235 };
 236
 237 static const add_header_func_ptr add_client_headers[] = {
 238    client_host_adder,
 239    client_x_forwarded_for_adder,
 240    client_xtra_adder,
 241    client_connection_header_adder,
 242    NULL
 243 };
 244
 245 static const add_header_func_ptr add_server_headers[] = {
 246    server_connection_adder,
 247 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
 248    server_proxy_connection_adder,
 249 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
 250    NULL
 251 };
 252
 253 /*********************************************************************
 254  *
 255  * Function    :  flush_socket
 256  *
 257  * Description :  Write any pending "buffered" content.
 258  *
 259  * Parameters  :
 260  *          1  :  fd = file descriptor of the socket to read
 261  *          2  :  iob = The I/O buffer to flush, usually csp->iob.
 262  *
 263  * Returns     :  On success, the number of bytes written are returned (zero
 264  *                indicates nothing was written).  On error, -1 is returned,
 265  *                and errno is set appropriately.  If count is zero and the
 266  *                file descriptor refers to a regular file, 0 will be
 267  *                returned without causing any other effect.  For a special
 268  *                file, the results are not portable.
 269  *
 270  *********************************************************************/
 271 long flush_socket(jb_socket fd, struct iob *iob)
 272 {
 273    long len = iob->eod - iob->cur;
 274
 275    if (len <= 0)
 276    {
 277       return(0);
 278    }
 279
 280    if (write_socket(fd, iob->cur, (size_t)len))
 281    {
 282       return(-1);
 283    }
 284    iob->eod = iob->cur = iob->buf;
 285    return(len);
 286
 287 }
 288
 289
 290 /*********************************************************************
 291  *
 292  * Function    :  add_to_iob
 293  *
 294  * Description :  Add content to the buffer, expanding the
 295  *                buffer if necessary.
 296  *
 297  * Parameters  :
 298  *          1  :  iob = Destination buffer.
 299  *          2  :  buffer_limit = Limit to which the destination may grow
 300  *          3  :  src = holds the content to be added
 301  *          4  :  n = number of bytes to be added
 302  *
 303  * Returns     :  JB_ERR_OK on success, JB_ERR_MEMORY if out-of-memory
 304  *                or buffer limit reached.
 305  *
 306  *********************************************************************/
 307 jb_err add_to_iob(struct iob *iob, const size_t buffer_limit, char *src, long n)
 308 {
 309    size_t used, offset, need;
 310    char *p;
 311
 312    if (n <= 0) return JB_ERR_OK;
 313
 314    used   = (size_t)(iob->eod - iob->buf);
 315    offset = (size_t)(iob->cur - iob->buf);
 316    need   = used + (size_t)n + 1;
 317
 318    /*
 319     * If the buffer can't hold the new data, extend it first.
 320     * Use the next power of two if possible, else use the actual need.
 321     */
 322    if (need > buffer_limit)
 323    {
 324       log_error(LOG_LEVEL_INFO,
 325          "Buffer limit reached while extending the buffer (iob). Needed: %d. Limit: %d",
 326          need, buffer_limit);
 327       return JB_ERR_MEMORY;
 328    }
 329
 330    if (need > iob->size)
 331    {
 332       size_t want = iob->size ? iob->size : 512;
 333
 334       while (want <= need)
 335       {
 336          want *= 2;
 337       }
 338
 339       if (want <= buffer_limit && NULL != (p = (char *)realloc(iob->buf, want)))
 340       {
 341          iob->size = want;
 342       }
 343       else if (NULL != (p = (char *)realloc(iob->buf, need)))
 344       {
 345          iob->size = need;
 346       }
 347       else
 348       {
 349          log_error(LOG_LEVEL_ERROR, "Extending the buffer (iob) failed: %E");
 350          return JB_ERR_MEMORY;
 351       }
 352
 353       /* Update the iob pointers */
 354       iob->cur = p + offset;
 355       iob->eod = p + used;
 356       iob->buf = p;
 357    }
 358
 359    /* copy the new data into the iob buffer */
 360    memcpy(iob->eod, src, (size_t)n);
 361
 362    /* point to the end of the data */
 363    iob->eod += n;
 364
 365    /* null terminate == cheap insurance */
 366    *iob->eod = '\0';
 367
 368    return JB_ERR_OK;
 369
 370 }
 371
 372
 373 /*********************************************************************
 374  *
 375  * Function    :  clear_iob
 376  *
 377  * Description :  Frees the memory allocated for an I/O buffer and
 378  *                resets the structure.
 379  *
 380  * Parameters  :
 381  *          1  :  iob = I/O buffer to clear.
 382  *
 383  * Returns     :  JB_ERR_OK on success, JB_ERR_MEMORY if out-of-memory
 384  *                or buffer limit reached.
 385  *
 386  *********************************************************************/
 387 void clear_iob(struct iob *iob)
 388 {
 389    free(iob->buf);
 390    memset(iob, '\0', sizeof(*iob));
 391 }
 392
 393
 394 #ifdef FEATURE_ZLIB
 395 /*********************************************************************
 396  *
 397  * Function    :  decompress_iob
 398  *
 399  * Description :  Decompress buffered page, expanding the
 400  *                buffer as necessary.  csp->iob->cur
 401  *                should point to the the beginning of the
 402  *                compressed data block.
 403  *
 404  * Parameters  :
 405  *          1  :  csp = Current client state (buffers, headers, etc...)
 406  *
 407  * Returns     :  JB_ERR_OK on success,
 408  *                JB_ERR_MEMORY if out-of-memory limit reached, and
 409  *                JB_ERR_COMPRESS if error decompressing buffer.
 410  *
 411  *********************************************************************/
 412 jb_err decompress_iob(struct client_state *csp)
 413 {
 414    char  *buf;       /* new, uncompressed buffer */
 415    char  *cur;       /* Current iob position (to keep the original
 416                       * iob->cur unmodified if we return early) */
 417    size_t bufsize;   /* allocated size of the new buffer */
 418    size_t old_size;  /* Content size before decompression */
 419    size_t skip_size; /* Number of bytes at the beginning of the iob
 420                         that we should NOT decompress. */
 421    int status;       /* return status of the inflate() call */
 422    z_stream zstr;    /* used by calls to zlib */
 423
 424 #ifdef FUZZ
 425    assert(csp->iob->cur - csp->iob->buf >= 0);
 426    assert(csp->iob->eod - csp->iob->cur >= 0);
 427 #else
 428    assert(csp->iob->cur - csp->iob->buf > 0);
 429    assert(csp->iob->eod - csp->iob->cur > 0);
 430 #endif
 431
 432    bufsize = csp->iob->size;
 433    skip_size = (size_t)(csp->iob->cur - csp->iob->buf);
 434    old_size = (size_t)(csp->iob->eod - csp->iob->cur);
 435
 436    cur = csp->iob->cur;
 437
 438    if (bufsize < (size_t)10)
 439    {
 440       /*
 441        * This is to protect the parsing of gzipped data,
 442        * but it should(?) be valid for deflated data also.
 443        */
 444       log_error(LOG_LEVEL_ERROR,
 445          "Insufficient data to start decompression. Bytes in buffer: %d",
 446          csp->iob->eod - csp->iob->cur);
 447       return JB_ERR_COMPRESS;
 448    }
 449
 450    if (csp->content_type & CT_GZIP)
 451    {
 452       /*
 453        * Our task is slightly complicated by the facts that data
 454        * compressed by gzip does not include a zlib header, and
 455        * that there is no easily accessible interface in zlib to
 456        * handle a gzip header. We strip off the gzip header by
 457        * hand, and later inform zlib not to expect a header.
 458        */
 459
 460       /*
 461        * Strip off the gzip header. Please see RFC 1952 for more
 462        * explanation of the appropriate fields.
 463        */
 464       if (((*cur++ & 0xff) != GZIP_IDENTIFIER_1)
 465        || ((*cur++ & 0xff) != GZIP_IDENTIFIER_2)
 466        || (*cur++ != Z_DEFLATED))
 467       {
 468          log_error(LOG_LEVEL_ERROR, "Invalid gzip header when decompressing");
 469          return JB_ERR_COMPRESS;
 470       }
 471       else
 472       {
 473          int flags = *cur++;
 474          if (flags & GZIP_FLAG_RESERVED_BITS)
 475          {
 476             /* The gzip header has reserved bits set; bail out. */
 477             log_error(LOG_LEVEL_ERROR, "Invalid gzip header flags when decompressing");
 478             return JB_ERR_COMPRESS;
 479          }
 480
 481          /*
 482           * Skip mtime (4 bytes), extra flags (1 byte)
 483           * and OS type (1 byte).
 484           */
 485          cur += 6;
 486
 487          /* Skip extra fields if necessary. */
 488          if (flags & GZIP_FLAG_EXTRA_FIELDS)
 489          {
 490             /*
 491              * Skip a given number of bytes, specified
 492              * as a 16-bit little-endian value.
 493              *
 494              * XXX: this code is untested and should probably be removed.
 495              */
 496             int skip_bytes;
 497             skip_bytes = *cur++;
 498             skip_bytes += *cur++ << 8;
 499
 500             /*
 501              * The number of bytes to skip should be positive
 502              * and we'd like to stay in the buffer.
 503              */
 504             if ((skip_bytes < 0) || (skip_bytes >= (csp->iob->eod - cur)))
 505             {
 506                log_error(LOG_LEVEL_ERROR,
 507                   "Unreasonable amount of bytes to skip (%d). Stopping decompression",
 508                   skip_bytes);
 509                return JB_ERR_COMPRESS;
 510             }
 511             log_error(LOG_LEVEL_INFO,
 512                "Skipping %d bytes for gzip compression. Does this sound right?",
 513                skip_bytes);
 514             cur += skip_bytes;
 515          }
 516
 517          /* Skip the filename if necessary. */
 518          if (flags & GZIP_FLAG_FILE_NAME)
 519          {
 520             /* A null-terminated string is supposed to follow. */
 521             while (*cur++ && (cur < csp->iob->eod));
 522          }
 523
 524          /* Skip the comment if necessary. */
 525          if (flags & GZIP_FLAG_COMMENT)
 526          {
 527             /* A null-terminated string is supposed to follow. */
 528             while (*cur++ && (cur < csp->iob->eod));
 529          }
 530
 531          /* Skip the CRC if necessary. */
 532          if (flags & GZIP_FLAG_CHECKSUM)
 533          {
 534             cur += 2;
 535          }
 536
 537          if (cur >= csp->iob->eod)
 538          {
 539             /*
 540              * If the current position pointer reached or passed
 541              * the buffer end, we were obviously tricked to skip
 542              * too much.
 543              */
 544             log_error(LOG_LEVEL_ERROR,
 545                "Malformed gzip header detected. Aborting decompression.");
 546             return JB_ERR_COMPRESS;
 547          }
 548       }
 549    }
 550    else if (csp->content_type & CT_DEFLATE)
 551    {
 552       /*
 553        * In theory (that is, according to RFC 1950), deflate-compressed
 554        * data should begin with a two-byte zlib header and have an
 555        * adler32 checksum at the end. It seems that in practice only
 556        * the raw compressed data is sent. Note that this means that
 557        * we are not RFC 1950-compliant here, but the advantage is that
 558        * this actually works. :)
 559        *
 560        * We add a dummy null byte to tell zlib where the data ends,
 561        * and later inform it not to expect a header.
 562        *
 563        * Fortunately, add_to_iob() has thoughtfully null-terminated
 564        * the buffer; we can just increment the end pointer to include
 565        * the dummy byte.
 566        */
 567       csp->iob->eod++;
 568    }
 569    else
 570    {
 571       log_error(LOG_LEVEL_ERROR,
 572          "Unable to determine compression format for decompression");
 573       return JB_ERR_COMPRESS;
 574    }
 575
 576    /* Set up the fields required by zlib. */
 577    zstr.next_in  = (Bytef *)cur;
 578    zstr.avail_in = (unsigned int)(csp->iob->eod - cur);
 579    zstr.zalloc   = Z_NULL;
 580    zstr.zfree    = Z_NULL;
 581    zstr.opaque   = Z_NULL;
 582
 583    /*
 584     * Passing -MAX_WBITS to inflateInit2 tells the library
 585     * that there is no zlib header.
 586     */
 587    if (inflateInit2(&zstr, -MAX_WBITS) != Z_OK)
 588    {
 589       log_error(LOG_LEVEL_ERROR, "Error initializing decompression");
 590       return JB_ERR_COMPRESS;
 591    }
 592
 593    /*
 594     * Next, we allocate new storage for the inflated data.
 595     * We don't modify the existing iob yet, so in case there
 596     * is error in decompression we can recover gracefully.
 597     */
 598    buf = zalloc(bufsize);
 599    if (NULL == buf)
 600    {
 601       log_error(LOG_LEVEL_ERROR, "Out of memory decompressing iob");
 602       return JB_ERR_MEMORY;
 603    }
 604
 605    assert(bufsize >= skip_size);
 606    memcpy(buf, csp->iob->buf, skip_size);
 607    zstr.avail_out = (uInt)(bufsize - skip_size);
 608    zstr.next_out  = (Bytef *)buf + skip_size;
 609
 610    /* Try to decompress the whole stream in one shot. */
 611    while (Z_BUF_ERROR == (status = inflate(&zstr, Z_FINISH)))
 612    {
 613       /* We need to allocate more memory for the output buffer. */
 614
 615       char *tmpbuf;                /* used for realloc'ing the buffer */
 616       size_t oldbufsize = bufsize; /* keep track of the old bufsize */
 617
 618       if (0 == zstr.avail_in)
 619       {
 620          /*
 621           * If zlib wants more data then there's a problem, because
 622           * the complete compressed file should have been buffered.
 623           */
 624          log_error(LOG_LEVEL_ERROR,
 625             "Unexpected end of compressed iob. Using what we got so far.");
 626          break;
 627       }
 628
 629       /*
 630        * If we reached the buffer limit and still didn't have enough
 631        * memory, just give up. Due to the ceiling enforced by the next
 632        * if block we could actually check for equality here, but as it
 633        * can be easily mistaken for a bug we don't.
 634        */
 635       if (bufsize >= csp->config->buffer_limit)
 636       {
 637          log_error(LOG_LEVEL_ERROR, "Buffer limit reached while decompressing iob");
 638          return JB_ERR_MEMORY;
 639       }
 640
 641       /* Try doubling the buffer size each time. */
 642       bufsize *= 2;
 643
 644       /* Don't exceed the buffer limit. */
 645       if (bufsize > csp->config->buffer_limit)
 646       {
 647          bufsize = csp->config->buffer_limit;
 648       }
 649
 650       /* Try to allocate the new buffer. */
 651       tmpbuf = realloc(buf, bufsize);
 652       if (NULL == tmpbuf)
 653       {
 654          log_error(LOG_LEVEL_ERROR, "Out of memory decompressing iob");
 655          freez(buf);
 656          return JB_ERR_MEMORY;
 657       }
 658       else
 659       {
 660          char *oldnext_out = (char *)zstr.next_out;
 661
 662          /*
 663           * Update the fields for inflate() to use the new
 664           * buffer, which may be in a location different from
 665           * the old one.
 666           */
 667          zstr.avail_out += (uInt)(bufsize - oldbufsize);
 668          zstr.next_out   = (Bytef *)tmpbuf + bufsize - zstr.avail_out;
 669
 670          /*
 671           * Compare with an uglier method of calculating these values
 672           * that doesn't require the extra oldbufsize variable.
 673           */
 674          assert(zstr.avail_out == tmpbuf + bufsize - (char *)zstr.next_out);
 675          assert((char *)zstr.next_out == tmpbuf + ((char *)oldnext_out - buf));
 676
 677          buf = tmpbuf;
 678       }
 679    }
 680
 681    if (Z_STREAM_ERROR == inflateEnd(&zstr))
 682    {
 683       log_error(LOG_LEVEL_ERROR,
 684          "Inconsistent stream state after decompression: %s", zstr.msg);
 685       /*
 686        * XXX: Intentionally no return.
 687        *
 688        * According to zlib.h, Z_STREAM_ERROR is returned
 689        * "if the stream state was inconsistent".
 690        *
 691        * I assume in this case inflate()'s status
 692        * would also be something different than Z_STREAM_END
 693        * so this check should be redundant, but lets see.
 694        */
 695    }
 696
 697    if ((status != Z_STREAM_END) && (0 != zstr.avail_in))
 698    {
 699       /*
 700        * We failed to decompress the stream and it's
 701        * not simply because of missing data.
 702        */
 703       log_error(LOG_LEVEL_ERROR,
 704          "Unexpected error while decompressing to the buffer (iob): %s",
 705          zstr.msg);
 706       return JB_ERR_COMPRESS;
 707    }
 708
 709    /*
 710     * Finally, we can actually update the iob, since the
 711     * decompression was successful. First, free the old
 712     * buffer.
 713     */
 714    freez(csp->iob->buf);
 715
 716    /* Now, update the iob to use the new buffer. */
 717    csp->iob->buf  = buf;
 718    csp->iob->cur  = csp->iob->buf + skip_size;
 719    csp->iob->eod  = (char *)zstr.next_out;
 720    csp->iob->size = bufsize;
 721
 722    /*
 723     * Make sure the new uncompressed iob obeys some minimal
 724     * consistency conditions.
 725     */
 726    if ((csp->iob->buf <=  csp->iob->cur)
 727     && (csp->iob->cur <= csp->iob->eod)
 728     && (csp->iob->eod <= csp->iob->buf + csp->iob->size))
 729    {
 730       const size_t new_size = (size_t)(csp->iob->eod - csp->iob->cur);
 731       if (new_size > (size_t)0)
 732       {
 733          log_error(LOG_LEVEL_RE_FILTER,
 734             "Decompression successful. Old size: %d, new size: %d.",
 735             old_size, new_size);
 736       }
 737       else
 738       {
 739          /* zlib thinks this is OK, so lets do the same. */
 740          log_error(LOG_LEVEL_INFO, "Decompression didn't result in any content.");
 741       }
 742    }
 743    else
 744    {
 745       /* It seems that zlib did something weird. */
 746       log_error(LOG_LEVEL_ERROR,
 747          "Unexpected error decompressing the buffer (iob): %d==%d, %d>%d, %d<%d",
 748          csp->iob->cur, csp->iob->buf + skip_size, csp->iob->eod, csp->iob->buf,
 749          csp->iob->eod, csp->iob->buf + csp->iob->size);
 750       return JB_ERR_COMPRESS;
 751    }
 752
 753    return JB_ERR_OK;
 754
 755 }
 756 #endif /* defined(FEATURE_ZLIB) */
 757
 758
 759 /*********************************************************************
 760  *
 761  * Function    :  normalize_lws
 762  *
 763  * Description :  Reduces unquoted linear whitespace in headers to
 764  *                a single space in accordance with RFC 7230 3.2.4.
 765  *                This simplifies parsing and filtering later on.
 766  *
 767  * Parameters  :
 768  *          1  :  header = A header with linear whitespace to reduce.
 769  *
 770  * Returns     :  N/A
 771  *
 772  *********************************************************************/
 773 static void normalize_lws(char *header)
 774 {
 775    char *p = header;
 776
 777    while (*p != '\0')
 778    {
 779       if (privoxy_isspace(*p) && privoxy_isspace(*(p+1)))
 780       {
 781          char *q = p+1;
 782
 783          while (privoxy_isspace(*q))
 784          {
 785             q++;
 786          }
 787          log_error(LOG_LEVEL_HEADER, "Reducing whitespace in '%s'", header);
 788          string_move(p+1, q);
 789       }
 790
 791       if (*p == '\t')
 792       {
 793          log_error(LOG_LEVEL_HEADER,
 794             "Converting tab to space in '%s'", header);
 795          *p = ' ';
 796       }
 797       else if (*p == '"')
 798       {
 799          char *end_of_token = strstr(p+1, "\"");
 800
 801          if (NULL != end_of_token)
 802          {
 803             /* Don't mess with quoted text. */
 804             p = end_of_token;
 805          }
 806          else
 807          {
 808             log_error(LOG_LEVEL_HEADER,
 809                "Ignoring single quote in '%s'", header);
 810          }
 811       }
 812       p++;
 813    }
 814
 815    p = strchr(header, ':');
 816    if ((p != NULL) && (p != header) && privoxy_isspace(*(p-1)))
 817    {
 818       /*
 819        * There's still space before the colon.
 820        * We don't want it.
 821        */
 822       string_move(p-1, p);
 823    }
 824 }
 825
 826
 827 /*********************************************************************
 828  *
 829  * Function    :  get_header
 830  *
 831  * Description :  This (odd) routine will parse the csp->iob
 832  *                to get the next complete header.
 833  *
 834  * Parameters  :
 835  *          1  :  iob = The I/O buffer to parse, usually csp->iob.
 836  *
 837  * Returns     :  Any one of the following:
 838  *
 839  * 1) a pointer to a dynamically allocated string that contains a header line
 840  * 2) NULL  indicating that the end of the header was reached
 841  * 3) ""    indicating that the end of the iob was reached before finding
 842  *          a complete header line.
 843  *
 844  *********************************************************************/
 845 char *get_header(struct iob *iob)
 846 {
 847    char *header;
 848
 849    header = get_header_line(iob);
 850
 851    if ((header == NULL) || (*header == '\0'))
 852    {
 853       /*
 854        * No complete header read yet, tell the client.
 855        */
 856       return header;
 857    }
 858
 859    while ((iob->cur[0] == ' ') || (iob->cur[0] == '\t'))
 860    {
 861       /*
 862        * Header spans multiple lines, append the next one.
 863        */
 864       char *continued_header;
 865
 866       continued_header = get_header_line(iob);
 867       if ((continued_header == NULL) || (*continued_header == '\0'))
 868       {
 869          /*
 870           * No complete header read yet, return what we got.
 871           * XXX: Should "unread" header instead.
 872           */
 873          log_error(LOG_LEVEL_INFO,
 874             "Failed to read a multi-line header properly: '%s'",
 875             header);
 876          break;
 877       }
 878
 879       if (JB_ERR_OK != string_join(&header, continued_header))
 880       {
 881          log_error(LOG_LEVEL_FATAL,
 882             "Out of memory while appending multiple headers.");
 883       }
 884       else
 885       {
 886          /* XXX: remove before next stable release. */
 887          log_error(LOG_LEVEL_HEADER,
 888             "Merged multiple header lines to: '%s'",
 889             header);
 890       }
 891    }
 892
 893    normalize_lws(header);
 894
 895    return header;
 896
 897 }
 898
 899
 900 /*********************************************************************
 901  *
 902  * Function    :  get_header_line
 903  *
 904  * Description :  This (odd) routine will parse the csp->iob
 905  *                to get the next header line.
 906  *
 907  * Parameters  :
 908  *          1  :  iob = The I/O buffer to parse, usually csp->iob.
 909  *
 910  * Returns     :  Any one of the following:
 911  *
 912  * 1) a pointer to a dynamically allocated string that contains a header line
 913  * 2) NULL  indicating that the end of the header was reached
 914  * 3) ""    indicating that the end of the iob was reached before finding
 915  *          a complete header line.
 916  *
 917  *********************************************************************/
 918 static char *get_header_line(struct iob *iob)
 919 {
 920    char *p, *q, *ret;
 921
 922    if ((iob->cur == NULL)
 923       || ((p = strchr(iob->cur, '\n')) == NULL))
 924    {
 925       return(""); /* couldn't find a complete header */
 926    }
 927
 928    *p = '\0';
 929
 930    ret = strdup(iob->cur);
 931    if (ret == NULL)
 932    {
 933       /* FIXME No way to handle error properly */
 934       log_error(LOG_LEVEL_FATAL, "Out of memory in get_header_line()");
 935    }
 936    assert(ret != NULL);
 937
 938    iob->cur = p+1;
 939
 940    if ((q = strchr(ret, '\r')) != NULL) *q = '\0';
 941
 942    /* is this a blank line (i.e. the end of the header) ? */
 943    if (*ret == '\0')
 944    {
 945       freez(ret);
 946       return NULL;
 947    }
 948
 949    return ret;
 950
 951 }
 952
 953
 954 /*********************************************************************
 955  *
 956  * Function    :  get_header_value
 957  *
 958  * Description :  Get the value of a given header from a chained list
 959  *                of header lines or return NULL if no such header is
 960  *                present in the list.
 961  *
 962  * Parameters  :
 963  *          1  :  header_list = pointer to list
 964  *          2  :  header_name = string with name of header to look for.
 965  *                              Trailing colon required, capitalization
 966  *                              doesn't matter.
 967  *
 968  * Returns     :  NULL if not found, else value of header
 969  *
 970  *********************************************************************/
 971 char *get_header_value(const struct list *header_list, const char *header_name)
 972 {
 973    struct list_entry *cur_entry;
 974    char *ret = NULL;
 975    size_t length = 0;
 976
 977    assert(header_list);
 978    assert(header_name);
 979    length = strlen(header_name);
 980
 981    for (cur_entry = header_list->first; cur_entry ; cur_entry = cur_entry->next)
 982    {
 983       if (cur_entry->str)
 984       {
 985          if (!strncmpic(cur_entry->str, header_name, length))
 986          {
 987             /*
 988              * Found: return pointer to start of value
 989              */
 990             ret = cur_entry->str + length;
 991             while (*ret && privoxy_isspace(*ret)) ret++;
 992             return ret;
 993          }
 994       }
 995    }
 996
 997    /*
 998     * Not found
 999     */
1000    return NULL;
1001
1002 }
1003
1004
1005 /*********************************************************************
1006  *
1007  * Function    :  scan_headers
1008  *
1009  * Description :  Scans headers, applies tags and updates action bits.
1010  *
1011  * Parameters  :
1012  *          1  :  csp = Current client state (buffers, headers, etc...)
1013  *
1014  * Returns     :  JB_ERR_OK
1015  *
1016  *********************************************************************/
1017 static jb_err scan_headers(struct client_state *csp)
1018 {
1019    struct list_entry *h; /* Header */
1020    jb_err err = JB_ERR_OK;
1021
1022    for (h = csp->headers->first; (err == JB_ERR_OK) && (h != NULL) ; h = h->next)
1023    {
1024       /* Header crunch()ed in previous run? -> ignore */
1025       if (h->str == NULL) continue;
1026       log_error(LOG_LEVEL_HEADER, "scan: %s", h->str);
1027       err = header_tagger(csp, h->str);
1028    }
1029
1030    return err;
1031 }
1032
1033
1034 /*********************************************************************
1035  *
1036  * Function    :  enforce_header_order
1037  *
1038  * Description :  Enforces a given header order.
1039  *
1040  * Parameters  :
1041  *          1  :  headers         = List of headers to order.
1042  *          2  :  ordered_headers = List of ordered header names.
1043  *
1044  * Returns     :  N/A
1045  *
1046  *********************************************************************/
1047 static void enforce_header_order(struct list *headers, const struct list *ordered_headers)
1048 {
1049    struct list_entry *sorted_header;
1050    struct list new_headers[1];
1051    struct list_entry *header;
1052
1053    init_list(new_headers);
1054
1055    /* The request line is always the first "header" */
1056
1057    assert(NULL != headers->first->str);
1058    enlist(new_headers, headers->first->str);
1059    freez(headers->first->str)
1060
1061    /* Enlist the specified headers in the given order */
1062
1063    for (sorted_header = ordered_headers->first; sorted_header != NULL;
1064         sorted_header = sorted_header->next)
1065    {
1066       const size_t sorted_header_length = strlen(sorted_header->str);
1067       for (header = headers->first; header != NULL; header = header->next)
1068       {
1069          /* Header enlisted in previous run? -> ignore */
1070          if (header->str == NULL) continue;
1071
1072          if (0 == strncmpic(sorted_header->str, header->str, sorted_header_length)
1073             && (header->str[sorted_header_length] == ':'))
1074          {
1075             log_error(LOG_LEVEL_HEADER, "Enlisting sorted header %s", header->str);
1076             if (JB_ERR_OK != enlist(new_headers, header->str))
1077             {
1078                log_error(LOG_LEVEL_HEADER, "Failed to enlist %s", header->str);
1079             }
1080             freez(header->str);
1081          }
1082       }
1083    }
1084
1085    /* Enlist the rest of the headers behind the ordered ones */
1086    for (header = headers->first; header != NULL; header = header->next)
1087    {
1088       /* Header enlisted in previous run? -> ignore */
1089       if (header->str == NULL) continue;
1090
1091       log_error(LOG_LEVEL_HEADER,
1092          "Enlisting left-over header %s", header->str);
1093       if (JB_ERR_OK != enlist(new_headers, header->str))
1094       {
1095          log_error(LOG_LEVEL_HEADER, "Failed to enlist %s", header->str);
1096       }
1097       freez(header->str);
1098    }
1099
1100    list_remove_all(headers);
1101    list_duplicate(headers, new_headers);
1102    list_remove_all(new_headers);
1103
1104    return;
1105 }
1106
1107
1108 /*********************************************************************
1109  *
1110  * Function    :  sed
1111  *
1112  * Description :  add, delete or modify lines in the HTTP header streams.
1113  *                On entry, it receives a linked list of headers space
1114  *                that was allocated dynamically (both the list nodes
1115  *                and the header contents).
1116  *
1117  *                As a side effect it frees the space used by the original
1118  *                header lines.
1119  *
1120  * Parameters  :
1121  *          1  :  csp = Current client state (buffers, headers, etc...)
1122  *          2  :  filter_server_headers = Boolean to switch between
1123  *                                        server and header filtering.
1124  *
1125  * Returns     :  JB_ERR_OK in case off success, or
1126  *                JB_ERR_MEMORY on some out-of-memory errors, or
1127  *                JB_ERR_PARSE in case of fatal parse errors.
1128  *
1129  *********************************************************************/
1130 jb_err sed(struct client_state *csp, int filter_server_headers)
1131 {
1132    /* XXX: use more descriptive names. */
1133    struct list_entry *p;
1134    const struct parsers *v;
1135    const add_header_func_ptr *f;
1136    jb_err err = JB_ERR_OK;
1137
1138    scan_headers(csp);
1139
1140    if (filter_server_headers)
1141    {
1142       v = server_patterns;
1143       f = add_server_headers;
1144       check_negative_tag_patterns(csp, PATTERN_SPEC_NO_RESPONSE_TAG_PATTERN);
1145    }
1146    else
1147    {
1148       v = client_patterns;
1149       f = add_client_headers;
1150       check_negative_tag_patterns(csp, PATTERN_SPEC_NO_REQUEST_TAG_PATTERN);
1151    }
1152
1153    while (v->str != NULL)
1154    {
1155       for (p = csp->headers->first; p != NULL; p = p->next)
1156       {
1157          /* Header crunch()ed in previous run? -> ignore */
1158          if (p->str == NULL) continue;
1159
1160          /* Does the current parser handle this header? */
1161          if ((strncmpic(p->str, v->str, v->len) == 0) ||
1162              (v->len == CHECK_EVERY_HEADER_REMAINING))
1163          {
1164             err = v->parser(csp, &(p->str));
1165             if (err != JB_ERR_OK)
1166             {
1167                return err;
1168             }
1169          }
1170       }
1171       v++;
1172    }
1173
1174    /* place additional headers on the csp->headers list */
1175    while ((err == JB_ERR_OK) && (*f))
1176    {
1177       err = (*f)(csp);
1178       f++;
1179    }
1180
1181    if (!filter_server_headers && !list_is_empty(csp->config->ordered_client_headers))
1182    {
1183       enforce_header_order(csp->headers, csp->config->ordered_client_headers);
1184    }
1185
1186    return err;
1187 }
1188
1189
1190 /*********************************************************************
1191  *
1192  * Function    :  update_server_headers
1193  *
1194  * Description :  Updates server headers after the body has been modified.
1195  *
1196  * Parameters  :
1197  *          1  :  csp = Current client state (buffers, headers, etc...)
1198  *
1199  * Returns     :  JB_ERR_OK in case off success, or
1200  *                JB_ERR_MEMORY on out-of-memory error.
1201  *
1202  *********************************************************************/
1203 jb_err update_server_headers(struct client_state *csp)
1204 {
1205    jb_err err = JB_ERR_OK;
1206
1207    static const struct parsers server_patterns_light[] = {
1208       { "Content-Length:",    15, server_adjust_content_length },
1209       { "Transfer-Encoding:", 18, server_transfer_coding },
1210 #ifdef FEATURE_ZLIB
1211       { "Content-Encoding:",  17, server_adjust_content_encoding },
1212 #endif /* def FEATURE_ZLIB */
1213       { NULL,                  0, NULL }
1214    };
1215
1216    if (strncmpic(csp->http->cmd, "HEAD", 4))
1217    {
1218       const struct parsers *v;
1219       struct list_entry *p;
1220
1221       for (v = server_patterns_light; (err == JB_ERR_OK) && (v->str != NULL); v++)
1222       {
1223          for (p = csp->headers->first; (err == JB_ERR_OK) && (p != NULL); p = p->next)
1224          {
1225             /* Header crunch()ed in previous run? -> ignore */
1226             if (p->str == NULL) continue;
1227
1228             /* Does the current parser handle this header? */
1229             if (strncmpic(p->str, v->str, v->len) == 0)
1230             {
1231                err = v->parser(csp, (char **)&(p->str));
1232             }
1233          }
1234       }
1235    }
1236
1237 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1238    if ((JB_ERR_OK == err)
1239     && (csp->flags & CSP_FLAG_MODIFIED)
1240     && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
1241     && !(csp->flags & CSP_FLAG_SERVER_CONTENT_LENGTH_SET))
1242    {
1243       char header[50];
1244
1245       create_content_length_header(csp->content_length, header, sizeof(header));
1246       err = enlist(csp->headers, header);
1247       if (JB_ERR_OK == err)
1248       {
1249          log_error(LOG_LEVEL_HEADER,
1250             "Content modified with no Content-Length header set. "
1251             "Created: %s.", header);
1252          csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1253       }
1254    }
1255 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1256
1257 #ifdef FEATURE_COMPRESSION
1258    if ((JB_ERR_OK == err)
1259       && (csp->flags & CSP_FLAG_BUFFERED_CONTENT_DEFLATED))
1260    {
1261       err = enlist_unique_header(csp->headers, "Content-Encoding", "deflate");
1262       if (JB_ERR_OK == err)
1263       {
1264          log_error(LOG_LEVEL_HEADER, "Added header: Content-Encoding: deflate");
1265       }
1266    }
1267 #endif
1268
1269    return err;
1270 }
1271
1272
1273 /*********************************************************************
1274  *
1275  * Function    :  header_tagger
1276  *
1277  * Description :  Executes all text substitutions from applying
1278  *                tag actions and saves the result as tag.
1279  *
1280  *                XXX: Shares enough code with filter_header() and
1281  *                pcrs_filter_response() to warrant some helper functions.
1282  *
1283  * Parameters  :
1284  *          1  :  csp = Current client state (buffers, headers, etc...)
1285  *          2  :  header = Header that is used as tagger input
1286  *
1287  * Returns     :  JB_ERR_OK on success and always succeeds
1288  *
1289  *********************************************************************/
1290 static jb_err header_tagger(struct client_state *csp, char *header)
1291 {
1292    enum filter_type wanted_filter_type;
1293    int multi_action_index;
1294    pcrs_job *job;
1295
1296    struct re_filterfile_spec *b;
1297    struct list_entry *tag_name;
1298
1299    const size_t header_length = strlen(header);
1300
1301    if (csp->flags & CSP_FLAG_CLIENT_HEADER_PARSING_DONE)
1302    {
1303       wanted_filter_type = FT_SERVER_HEADER_TAGGER;
1304       multi_action_index = ACTION_MULTI_SERVER_HEADER_TAGGER;
1305    }
1306    else
1307    {
1308       wanted_filter_type = FT_CLIENT_HEADER_TAGGER;
1309       multi_action_index = ACTION_MULTI_CLIENT_HEADER_TAGGER;
1310    }
1311
1312    if (list_is_empty(csp->action->multi[multi_action_index])
1313       || filters_available(csp) == FALSE)
1314    {
1315       /* Return early if no taggers apply or if none are available. */
1316       return JB_ERR_OK;
1317    }
1318
1319    /* Execute all applying taggers */
1320    for (tag_name = csp->action->multi[multi_action_index]->first;
1321         NULL != tag_name; tag_name = tag_name->next)
1322    {
1323       char *modified_tag = NULL;
1324       char *tag = header;
1325       size_t size = header_length;
1326       pcrs_job *joblist;
1327
1328       b = get_filter(csp, tag_name->str, wanted_filter_type);
1329       if (b == NULL)
1330       {
1331          continue;
1332       }
1333
1334       joblist = b->joblist;
1335
1336       if (b->dynamic) joblist = compile_dynamic_pcrs_job_list(csp, b);
1337
1338       if (NULL == joblist)
1339       {
1340          log_error(LOG_LEVEL_RE_FILTER,
1341             "Tagger %s has empty joblist. Nothing to do.", b->name);
1342          continue;
1343       }
1344
1345       /* execute their pcrs_joblist on the header. */
1346       for (job = joblist; NULL != job; job = job->next)
1347       {
1348          const int hits = pcrs_execute(job, tag, size, &modified_tag, &size);
1349
1350          if (0 < hits)
1351          {
1352             /* Success, continue with the modified version. */
1353             if (tag != header)
1354             {
1355                freez(tag);
1356             }
1357             tag = modified_tag;
1358          }
1359          else
1360          {
1361             /* Tagger doesn't match */
1362             if (0 > hits)
1363             {
1364                /* Regex failure, log it but continue anyway. */
1365                assert(NULL != header);
1366                log_error(LOG_LEVEL_ERROR,
1367                   "Problems with tagger \'%s\' and header \'%s\': %s",
1368                   b->name, *header, pcrs_strerror(hits));
1369             }
1370             freez(modified_tag);
1371          }
1372       }
1373
1374       if (b->dynamic) pcrs_free_joblist(joblist);
1375
1376       /* If this tagger matched */
1377       if (tag != header)
1378       {
1379          if (0 == size)
1380          {
1381             /*
1382              * There is no technical limitation which makes
1383              * it impossible to use empty tags, but I assume
1384              * no one would do it intentionally.
1385              */
1386             freez(tag);
1387             log_error(LOG_LEVEL_INFO,
1388                "Tagger \'%s\' created an empty tag. Ignored.", b->name);
1389             continue;
1390          }
1391
1392          if (!list_contains_item(csp->tags, tag))
1393          {
1394             if (JB_ERR_OK != enlist(csp->tags, tag))
1395             {
1396                log_error(LOG_LEVEL_ERROR,
1397                   "Insufficient memory to add tag \'%s\', "
1398                   "based on tagger \'%s\' and header \'%s\'",
1399                   tag, b->name, *header);
1400             }
1401             else
1402             {
1403                char *action_message;
1404                /*
1405                 * update the action bits right away, to make
1406                 * tagging based on tags set by earlier taggers
1407                 * of the same kind possible.
1408                 */
1409                if (update_action_bits_for_tag(csp, tag))
1410                {
1411                   action_message = "Action bits updated accordingly.";
1412                }
1413                else
1414                {
1415                   action_message = "No action bits update necessary.";
1416                }
1417
1418                log_error(LOG_LEVEL_HEADER,
1419                   "Tagger \'%s\' added tag \'%s\'. %s",
1420                   b->name, tag, action_message);
1421             }
1422          }
1423          else
1424          {
1425             /* XXX: Is this log-worthy? */
1426             log_error(LOG_LEVEL_HEADER,
1427                "Tagger \'%s\' didn't add tag \'%s\'. Tag already present",
1428                b->name, tag);
1429          }
1430          freez(tag);
1431       }
1432    }
1433
1434    return JB_ERR_OK;
1435 }
1436
1437 /* here begins the family of parser functions that reformat header lines */
1438
1439 /*********************************************************************
1440  *
1441  * Function    :  filter_header
1442  *
1443  * Description :  Executes all text substitutions from all applying
1444  *                +(server|client)-header-filter actions on the header.
1445  *                Most of the code was copied from pcrs_filter_response,
1446  *                including the rather short variable names
1447  *
1448  * Parameters  :
1449  *          1  :  csp = Current client state (buffers, headers, etc...)
1450  *          2  :  header = On input, pointer to header to modify.
1451  *                On output, pointer to the modified header, or NULL
1452  *                to remove the header.  This function frees the
1453  *                original string if necessary.
1454  *
1455  * Returns     :  JB_ERR_OK on success and always succeeds
1456  *
1457  *********************************************************************/
1458 static jb_err filter_header(struct client_state *csp, char **header)
1459 {
1460    int hits=0;
1461    int matches;
1462    size_t size = strlen(*header);
1463
1464    char *newheader = NULL;
1465    pcrs_job *job;
1466
1467    struct re_filterfile_spec *b;
1468    struct list_entry *filtername;
1469
1470    enum filter_type wanted_filter_type;
1471    int multi_action_index;
1472
1473    if (csp->flags & CSP_FLAG_NO_FILTERING)
1474    {
1475       return JB_ERR_OK;
1476    }
1477
1478    if (csp->flags & CSP_FLAG_CLIENT_HEADER_PARSING_DONE)
1479    {
1480       wanted_filter_type = FT_SERVER_HEADER_FILTER;
1481       multi_action_index = ACTION_MULTI_SERVER_HEADER_FILTER;
1482    }
1483    else
1484    {
1485       wanted_filter_type = FT_CLIENT_HEADER_FILTER;
1486       multi_action_index = ACTION_MULTI_CLIENT_HEADER_FILTER;
1487    }
1488
1489    if (list_is_empty(csp->action->multi[multi_action_index])
1490       || filters_available(csp) == FALSE)
1491    {
1492       /* Return early if no filters apply or if none are available. */
1493       return JB_ERR_OK;
1494    }
1495
1496    /* Execute all applying header filters */
1497    for (filtername = csp->action->multi[multi_action_index]->first;
1498         filtername != NULL; filtername = filtername->next)
1499    {
1500       int current_hits = 0;
1501       pcrs_job *joblist;
1502
1503       b = get_filter(csp, filtername->str, wanted_filter_type);
1504       if (b == NULL)
1505       {
1506          continue;
1507       }
1508
1509       joblist = b->joblist;
1510
1511       if (b->dynamic) joblist = compile_dynamic_pcrs_job_list(csp, b);
1512
1513       if (NULL == joblist)
1514       {
1515          log_error(LOG_LEVEL_RE_FILTER, "Filter %s has empty joblist. Nothing to do.", b->name);
1516          continue;
1517       }
1518
1519       log_error(LOG_LEVEL_RE_FILTER, "filtering \'%s\' (size %d) with \'%s\' ...",
1520          *header, size, b->name);
1521
1522       /* Apply all jobs from the joblist */
1523       for (job = joblist; NULL != job; job = job->next)
1524       {
1525          matches = pcrs_execute(job, *header, size, &newheader, &size);
1526          if (0 < matches)
1527          {
1528             current_hits += matches;
1529             log_error(LOG_LEVEL_HEADER, "Transforming \"%s\" to \"%s\"", *header, newheader);
1530             freez(*header);
1531             *header = newheader;
1532          }
1533          else if (0 == matches)
1534          {
1535             /* Filter doesn't change header */
1536             freez(newheader);
1537          }
1538          else
1539          {
1540             /* RegEx failure */
1541             log_error(LOG_LEVEL_ERROR, "Filtering \'%s\' with \'%s\' didn't work out: %s",
1542                *header, b->name, pcrs_strerror(matches));
1543             if (newheader != NULL)
1544             {
1545                log_error(LOG_LEVEL_ERROR, "Freeing what's left: %s", newheader);
1546                freez(newheader);
1547             }
1548          }
1549       }
1550
1551       if (b->dynamic) pcrs_free_joblist(joblist);
1552
1553       log_error(LOG_LEVEL_RE_FILTER, "... produced %d hits (new size %d).", current_hits, size);
1554       hits += current_hits;
1555    }
1556
1557    /*
1558     * Additionally checking for hits is important because if
1559     * the continue hack is triggered, server headers can
1560     * arrive empty to separate multiple heads from each other.
1561     */
1562    if ((0 == size) && hits)
1563    {
1564       log_error(LOG_LEVEL_HEADER, "Removing empty header %s", *header);
1565       freez(*header);
1566    }
1567
1568    return JB_ERR_OK;
1569 }
1570
1571
1572 /*********************************************************************
1573  *
1574  * Function    :  server_connection
1575  *
1576  * Description :  Makes sure a proper "Connection:" header is
1577  *                set and signals connection_header_adder to
1578  *                do nothing.
1579  *
1580  * Parameters  :
1581  *          1  :  csp = Current client state (buffers, headers, etc...)
1582  *          2  :  header = On input, pointer to header to modify.
1583  *                On output, pointer to the modified header, or NULL
1584  *                to remove the header.  This function frees the
1585  *                original string if necessary.
1586  *
1587  * Returns     :  JB_ERR_OK on success.
1588  *
1589  *********************************************************************/
1590 static jb_err server_connection(struct client_state *csp, char **header)
1591 {
1592    if (!strcmpic(*header, "Connection: keep-alive")
1593 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1594     && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
1595 #endif
1596      )
1597    {
1598 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1599       if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE))
1600       {
1601          csp->flags |= CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE;
1602       }
1603
1604       if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
1605       {
1606          log_error(LOG_LEVEL_HEADER,
1607             "Keeping the server header '%s' around.", *header);
1608       }
1609       else
1610 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1611       {
1612          char *old_header = *header;
1613
1614          *header = strdup_or_die("Connection: close");
1615          log_error(LOG_LEVEL_HEADER, "Replaced: \'%s\' with \'%s\'", old_header, *header);
1616          freez(old_header);
1617       }
1618    }
1619
1620    /* Signal server_connection_adder() to return early. */
1621    csp->flags |= CSP_FLAG_SERVER_CONNECTION_HEADER_SET;
1622
1623    return JB_ERR_OK;
1624 }
1625
1626
1627 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1628 /*********************************************************************
1629  *
1630  * Function    :  server_keep_alive
1631  *
1632  * Description :  Stores the server's keep alive timeout.
1633  *
1634  * Parameters  :
1635  *          1  :  csp = Current client state (buffers, headers, etc...)
1636  *          2  :  header = On input, pointer to header to modify.
1637  *                On output, pointer to the modified header, or NULL
1638  *                to remove the header.  This function frees the
1639  *                original string if necessary.
1640  *
1641  * Returns     :  JB_ERR_OK.
1642  *
1643  *********************************************************************/
1644 static jb_err server_keep_alive(struct client_state *csp, char **header)
1645 {
1646    unsigned int keep_alive_timeout;
1647    const char *timeout_position = strstr(*header, "timeout=");
1648
1649    if ((NULL == timeout_position)
1650     || (1 != sscanf(timeout_position, "timeout=%u", &keep_alive_timeout)))
1651    {
1652       log_error(LOG_LEVEL_ERROR, "Couldn't parse: %s", *header);
1653    }
1654    else
1655    {
1656       if (keep_alive_timeout < csp->server_connection.keep_alive_timeout)
1657       {
1658          log_error(LOG_LEVEL_HEADER,
1659             "Reducing keep-alive timeout from %u to %u.",
1660             csp->server_connection.keep_alive_timeout, keep_alive_timeout);
1661          csp->server_connection.keep_alive_timeout = keep_alive_timeout;
1662       }
1663       else
1664       {
1665          /* XXX: Is this log worthy? */
1666          log_error(LOG_LEVEL_HEADER,
1667             "Server keep-alive timeout is %u. Sticking with %u.",
1668             keep_alive_timeout, csp->server_connection.keep_alive_timeout);
1669       }
1670       csp->flags |= CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET;
1671    }
1672
1673    freez(*header);
1674
1675    return JB_ERR_OK;
1676 }
1677
1678
1679 /*********************************************************************
1680  *
1681  * Function    :  server_proxy_connection
1682  *
1683  * Description :  Figures out whether or not we should add a
1684  *                Proxy-Connection header.
1685  *
1686  * Parameters  :
1687  *          1  :  csp = Current client state (buffers, headers, etc...)
1688  *          2  :  header = On input, pointer to header to modify.
1689  *                On output, pointer to the modified header, or NULL
1690  *                to remove the header.  This function frees the
1691  *                original string if necessary.
1692  *
1693  * Returns     :  JB_ERR_OK.
1694  *
1695  *********************************************************************/
1696 static jb_err server_proxy_connection(struct client_state *csp, char **header)
1697 {
1698    csp->flags |= CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET;
1699    return JB_ERR_OK;
1700 }
1701
1702
1703 /*********************************************************************
1704  *
1705  * Function    :  proxy_authentication
1706  *
1707  * Description :  Removes headers that are relevant for proxy
1708  *                authentication unless forwarding them has
1709  *                been explicitly requested.
1710  *
1711  * Parameters  :
1712  *          1  :  csp = Current client state (buffers, headers, etc...)
1713  *          2  :  header = On input, pointer to header to modify.
1714  *                On output, pointer to the modified header, or NULL
1715  *                to remove the header.  This function frees the
1716  *                original string if necessary.
1717  *
1718  * Returns     :  JB_ERR_OK.
1719  *
1720  *********************************************************************/
1721 static jb_err proxy_authentication(struct client_state *csp, char **header)
1722 {
1723    if ((csp->config->feature_flags &
1724       RUNTIME_FEATURE_FORWARD_PROXY_AUTHENTICATION_HEADERS) == 0) {
1725       log_error(LOG_LEVEL_HEADER,
1726          "Forwarding proxy authentication headers is disabled. Crunching: %s", *header);
1727       freez(*header);
1728    }
1729    return JB_ERR_OK;
1730 }
1731
1732
1733 /*********************************************************************
1734  *
1735  * Function    :  client_keep_alive
1736  *
1737  * Description :  Stores the client's keep alive timeout.
1738  *
1739  * Parameters  :
1740  *          1  :  csp = Current client state (buffers, headers, etc...)
1741  *          2  :  header = On input, pointer to header to modify.
1742  *                On output, pointer to the modified header, or NULL
1743  *                to remove the header.  This function frees the
1744  *                original string if necessary.
1745  *
1746  * Returns     :  JB_ERR_OK.
1747  *
1748  *********************************************************************/
1749 static jb_err client_keep_alive(struct client_state *csp, char **header)
1750 {
1751    unsigned int keep_alive_timeout;
1752    char *timeout_position;
1753
1754    if (!(csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE))
1755    {
1756       log_error(LOG_LEVEL_HEADER,
1757          "keep-alive support is disabled. Crunching: %s.", *header);
1758       freez(*header);
1759       return JB_ERR_OK;
1760    }
1761
1762    /* Check for parameter-less format "Keep-Alive: 100" */
1763    timeout_position = strstr(*header, ": ");
1764    if ((NULL == timeout_position)
1765     || (1 != sscanf(timeout_position, ": %u", &keep_alive_timeout)))
1766    {
1767       /* Assume parameter format "Keep-Alive: timeout=100" */
1768       timeout_position = strstr(*header, "timeout=");
1769       if ((NULL == timeout_position)
1770          || (1 != sscanf(timeout_position, "timeout=%u", &keep_alive_timeout)))
1771       {
1772          log_error(LOG_LEVEL_HEADER,
1773             "Couldn't parse: '%s'. Using default timeout %u",
1774             *header, csp->config->keep_alive_timeout);
1775          freez(*header);
1776
1777          return JB_ERR_OK;
1778       }
1779    }
1780
1781    if (keep_alive_timeout < csp->config->keep_alive_timeout)
1782    {
1783       log_error(LOG_LEVEL_HEADER,
1784          "Reducing keep-alive timeout from %u to %u.",
1785          csp->config->keep_alive_timeout, keep_alive_timeout);
1786       csp->server_connection.keep_alive_timeout = keep_alive_timeout;
1787    }
1788    else
1789    {
1790       /* XXX: Is this log worthy? */
1791       log_error(LOG_LEVEL_HEADER,
1792          "Client keep-alive timeout is %u. Sticking with %u.",
1793          keep_alive_timeout, csp->config->keep_alive_timeout);
1794       freez(*header);
1795    }
1796
1797    return JB_ERR_OK;
1798 }
1799
1800
1801 /*********************************************************************
1802  *
1803  * Function    :  get_content_length
1804  *
1805  * Description :  Gets the content length specified in a
1806  *                Content-Length header.
1807  *
1808  * Parameters  :
1809  *          1  :  header_value = The Content-Length header value.
1810  *          2  :  length = Storage to return the value.
1811  *
1812  * Returns     :  JB_ERR_OK on success, or
1813  *                JB_ERR_PARSE if no value is recognized.
1814  *
1815  *********************************************************************/
1816 static jb_err get_content_length(const char *header_value, unsigned long long *length)
1817 {
1818 #ifdef _WIN32
1819 #if SIZEOF_LONG_LONG < 8
1820 #error sizeof(unsigned long long) too small
1821 #endif
1822    if (1 != sscanf(header_value, "%I64u", length))
1823 #else
1824    if (1 != sscanf(header_value, "%llu", length))
1825 #endif
1826    {
1827       return JB_ERR_PARSE;
1828    }
1829
1830    return JB_ERR_OK;
1831 }
1832
1833
1834 /*********************************************************************
1835  *
1836  * Function    :  client_save_content_length
1837  *
1838  * Description :  Save the Content-Length sent by the client.
1839  *
1840  * Parameters  :
1841  *          1  :  csp = Current client state (buffers, headers, etc...)
1842  *          2  :  header = On input, pointer to header to modify.
1843  *                On output, pointer to the modified header, or NULL
1844  *                to remove the header.  This function frees the
1845  *                original string if necessary.
1846  *
1847  * Returns     :  JB_ERR_OK on success, or
1848  *                JB_ERR_MEMORY on out-of-memory error.
1849  *
1850  *********************************************************************/
1851 static jb_err client_save_content_length(struct client_state *csp, char **header)
1852 {
1853    unsigned long long content_length = 0;
1854    const char *header_value;
1855
1856    assert(*(*header+14) == ':');
1857
1858    header_value = *header + 15;
1859    if (JB_ERR_OK != get_content_length(header_value, &content_length))
1860    {
1861       log_error(LOG_LEVEL_ERROR, "Crunching invalid header: %s", *header);
1862       freez(*header);
1863    }
1864    else
1865    {
1866       csp->expected_client_content_length = content_length;
1867    }
1868
1869    return JB_ERR_OK;
1870 }
1871 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1872
1873
1874
1875 /*********************************************************************
1876  *
1877  * Function    :  client_connection
1878  *
1879  * Description :  Makes sure a proper "Connection:" header is
1880  *                set and signals connection_header_adder
1881  *                to do nothing.
1882  *
1883  * Parameters  :
1884  *          1  :  csp = Current client state (buffers, headers, etc...)
1885  *          2  :  header = On input, pointer to header to modify.
1886  *                On output, pointer to the modified header, or NULL
1887  *                to remove the header.  This function frees the
1888  *                original string if necessary.
1889  *
1890  * Returns     :  JB_ERR_OK on success.
1891  *
1892  *********************************************************************/
1893 static jb_err client_connection(struct client_state *csp, char **header)
1894 {
1895    static const char connection_close[] = "Connection: close";
1896
1897    if (!strcmpic(*header, connection_close))
1898    {
1899 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1900       if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
1901         && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED))
1902       {
1903           if (!strcmpic(csp->http->ver, "HTTP/1.1"))
1904           {
1905              log_error(LOG_LEVEL_HEADER,
1906                 "Removing \'%s\' to imply keep-alive.", *header);
1907              freez(*header);
1908              /*
1909               * While we imply keep-alive to the server,
1910               * we have to remember that the client didn't.
1911               */
1912              csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1913           }
1914           else
1915           {
1916              char *old_header = *header;
1917
1918              *header = strdup_or_die("Connection: keep-alive");
1919              log_error(LOG_LEVEL_HEADER,
1920                 "Replaced: \'%s\' with \'%s\'", old_header, *header);
1921              freez(old_header);
1922           }
1923       }
1924       else
1925       {
1926          log_error(LOG_LEVEL_HEADER,
1927             "Keeping the client header '%s' around. "
1928             "The connection will not be kept alive.",
1929             *header);
1930          csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1931       }
1932    }
1933    else if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
1934         && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED))
1935    {
1936       log_error(LOG_LEVEL_HEADER,
1937          "Keeping the client header '%s' around. "
1938          "The server connection will be kept alive if possible.",
1939          *header);
1940       csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1941 #endif  /* def FEATURE_CONNECTION_KEEP_ALIVE */
1942    }
1943    else
1944    {
1945       char *old_header = *header;
1946
1947       *header = strdup_or_die(connection_close);
1948       log_error(LOG_LEVEL_HEADER,
1949          "Replaced: \'%s\' with \'%s\'", old_header, *header);
1950       freez(old_header);
1951    }
1952
1953    /* Signal client_connection_header_adder() to return early. */
1954    csp->flags |= CSP_FLAG_CLIENT_CONNECTION_HEADER_SET;
1955
1956    return JB_ERR_OK;
1957 }
1958
1959
1960 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1961 /*********************************************************************
1962  *
1963  * Function    :  client_proxy_connection
1964  *
1965  * Description :  Sets the CLIENT_CONNECTION_KEEP_ALIVE flag when
1966  *                appropriate and removes the Proxy-Connection
1967  *                header.
1968  *
1969  * Parameters  :
1970  *          1  :  csp = Current client state (buffers, headers, etc...)
1971  *          2  :  header = On input, pointer to header to modify.
1972  *                On output, pointer to the modified header, or NULL
1973  *                to remove the header.  This function frees the
1974  *                original string if necessary.
1975  *
1976  * Returns     :  JB_ERR_OK
1977  *
1978  *********************************************************************/
1979 static jb_err client_proxy_connection(struct client_state *csp, char **header)
1980 {
1981    if (0 == (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
1982       && (csp->http->ssl == 0)
1983       && (NULL == strstr(*header, "close")))
1984    {
1985       log_error(LOG_LEVEL_HEADER,
1986          "The client connection can be kept alive due to: %s", *header);
1987       csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1988    }
1989    crumble(csp, header);
1990
1991    return JB_ERR_OK;
1992 }
1993 #endif  /* def FEATURE_CONNECTION_KEEP_ALIVE */
1994
1995
1996 /*********************************************************************
1997  *
1998  * Function    :  client_transfer_encoding
1999  *
2000  * Description :  Raise the CSP_FLAG_CHUNKED_CLIENT_BODY flag if
2001  *                the request body is "chunked"
2002  *
2003  *                XXX: Currently not called through sed() as we
2004  *                     need the flag earlier on. Should be fixed.
2005  *
2006  * Parameters  :
2007  *          1  :  csp = Current client state (buffers, headers, etc...)
2008  *          2  :  header = On input, pointer to header to modify.
2009  *                On output, pointer to the modified header, or NULL
2010  *                to remove the header.  This function frees the
2011  *                original string if necessary.
2012  *
2013  * Returns     :  JB_ERR_OK on success, or
2014  *
2015  *********************************************************************/
2016 jb_err client_transfer_encoding(struct client_state *csp, char **header)
2017 {
2018    if (strstr(*header, "chunked"))
2019    {
2020       csp->flags |= CSP_FLAG_CHUNKED_CLIENT_BODY;
2021       log_error(LOG_LEVEL_HEADER, "Expecting chunked client body");
2022    }
2023
2024    return JB_ERR_OK;
2025 }
2026
2027
2028 /*********************************************************************
2029  *
2030  * Function    :  client_expect
2031  *
2032  * Description :  Raise the CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION
2033  *                if the Expect header value is unsupported.
2034  *
2035  *                Rejecting unsupported expectations is a RFC 7231 5.1.1
2036  *                MAY and a RFC 2616 (obsolete) MUST.
2037  *
2038  * Parameters  :
2039  *          1  :  csp = Current client state (buffers, headers, etc...)
2040  *          2  :  header = On input, pointer to header to modify.
2041  *                On output, pointer to the modified header, or NULL
2042  *                to remove the header.  This function frees the
2043  *                original string if necessary.
2044  *
2045  * Returns     :  JB_ERR_OK on success, or
2046  *
2047  *********************************************************************/
2048 jb_err client_expect(struct client_state *csp, char **header)
2049 {
2050    if (0 != strcmpic(*header, "Expect: 100-continue"))
2051    {
2052       csp->flags |= CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION;
2053       log_error(LOG_LEVEL_HEADER,
2054          "Unsupported client expectaction: %s", *header);
2055    }
2056
2057    return JB_ERR_OK;
2058
2059 }
2060
2061
2062 /*********************************************************************
2063  *
2064  * Function    :  crumble
2065  *
2066  * Description :  This is called if a header matches a pattern to "crunch"
2067  *
2068  * Parameters  :
2069  *          1  :  csp = Current client state (buffers, headers, etc...)
2070  *          2  :  header = On input, pointer to header to modify.
2071  *                On output, pointer to the modified header, or NULL
2072  *                to remove the header.  This function frees the
2073  *                original string if necessary.
2074  *
2075  * Returns     :  JB_ERR_OK on success, or
2076  *                JB_ERR_MEMORY on out-of-memory error.
2077  *
2078  *********************************************************************/
2079 static jb_err crumble(struct client_state *csp, char **header)
2080 {
2081    (void)csp;
2082    log_error(LOG_LEVEL_HEADER, "crumble crunched: %s!", *header);
2083    freez(*header);
2084    return JB_ERR_OK;
2085 }
2086
2087
2088 /*********************************************************************
2089  *
2090  * Function    :  crunch_server_header
2091  *
2092  * Description :  Crunch server header if it matches a string supplied by the
2093  *                user. Called from `sed'.
2094  *
2095  * Parameters  :
2096  *          1  :  csp = Current client state (buffers, headers, etc...)
2097  *          2  :  header = On input, pointer to header to modify.
2098  *                On output, pointer to the modified header, or NULL
2099  *                to remove the header.  This function frees the
2100  *                original string if necessary.
2101  *
2102  * Returns     :  JB_ERR_OK on success and always succeeds
2103  *
2104  *********************************************************************/
2105 static jb_err crunch_server_header(struct client_state *csp, char **header)
2106 {
2107    const char *crunch_pattern;
2108
2109    /* Do we feel like crunching? */
2110    if ((csp->action->flags & ACTION_CRUNCH_SERVER_HEADER))
2111    {
2112       crunch_pattern = csp->action->string[ACTION_STRING_SERVER_HEADER];
2113
2114       /* Is the current header the lucky one? */
2115       if (strstr(*header, crunch_pattern))
2116       {
2117          log_error(LOG_LEVEL_HEADER, "Crunching server header: %s (contains: %s)", *header, crunch_pattern);
2118          freez(*header);
2119       }
2120    }
2121
2122    return JB_ERR_OK;
2123 }
2124
2125
2126 /*********************************************************************
2127  *
2128  * Function    :  server_content_type
2129  *
2130  * Description :  Set the content-type for filterable types (text/.*,
2131  *                .*xml.*, .*script.* and image/gif) unless filtering has been
2132  *                forbidden (CT_TABOO) while parsing earlier headers.
2133  *                NOTE: Since text/plain is commonly used by web servers
2134  *                      for files whose correct type is unknown, we don't
2135  *                      set CT_TEXT for it.
2136  *
2137  * Parameters  :
2138  *          1  :  csp = Current client state (buffers, headers, etc...)
2139  *          2  :  header = On input, pointer to header to modify.
2140  *                On output, pointer to the modified header, or NULL
2141  *                to remove the header.  This function frees the
2142  *                original string if necessary.
2143  *
2144  * Returns     :  JB_ERR_OK on success, or
2145  *                JB_ERR_MEMORY on out-of-memory error.
2146  *
2147  *********************************************************************/
2148 static jb_err server_content_type(struct client_state *csp, char **header)
2149 {
2150    /* Remove header if it isn't the first Content-Type header */
2151    if ((csp->content_type & CT_DECLARED))
2152    {
2153       if (content_filters_enabled(csp->action))
2154       {
2155          /*
2156           * Making sure the client interprets the content the same way
2157           * Privoxy did is only relevant if Privoxy modified it.
2158           *
2159           * Checking for this is "hard" as it's not yet known when
2160           * this function is called, thus go shopping and and just
2161           * check if Privoxy could filter it.
2162           *
2163           * The main thing is that we don't mess with the headers
2164           * unless the user signalled that it's acceptable.
2165           */
2166          log_error(LOG_LEVEL_HEADER,
2167             "Multiple Content-Type headers detected. "
2168             "Removing and ignoring: %s",
2169             *header);
2170          freez(*header);
2171       }
2172       return JB_ERR_OK;
2173    }
2174
2175    /*
2176     * Signal that the Content-Type has been set.
2177     */
2178    csp->content_type |= CT_DECLARED;
2179
2180    if (!(csp->content_type & CT_TABOO))
2181    {
2182       /*
2183        * XXX: The assumption that text/plain is a sign of
2184        * binary data seems to be somewhat unreasonable nowadays
2185        * and should be dropped after 3.0.8 is out.
2186        */
2187       if ((strstr(*header, "text/") && !strstr(*header, "plain"))
2188         || strstr(*header, "xml")
2189         || strstr(*header, "script"))
2190       {
2191          csp->content_type |= CT_TEXT;
2192       }
2193       else if (strstr(*header, "image/gif"))
2194       {
2195          csp->content_type |= CT_GIF;
2196       }
2197    }
2198
2199    /*
2200     * Are we messing with the content type?
2201     */
2202    if (csp->action->flags & ACTION_CONTENT_TYPE_OVERWRITE)
2203    {
2204       /*
2205        * Make sure the user doesn't accidentally
2206        * change the content type of binary documents.
2207        */
2208       if ((csp->content_type & CT_TEXT) || (csp->action->flags & ACTION_FORCE_TEXT_MODE))
2209       {
2210          jb_err err;
2211          freez(*header);
2212          *header = strdup_or_die("Content-Type: ");
2213
2214          err = string_append(header, csp->action->string[ACTION_STRING_CONTENT_TYPE]);
2215          if (JB_ERR_OK != err)
2216          {
2217             log_error(LOG_LEVEL_HEADER, "Insufficient memory to replace Content-Type!");
2218             return JB_ERR_MEMORY;
2219          }
2220          log_error(LOG_LEVEL_HEADER, "Modified: %s!", *header);
2221       }
2222       else
2223       {
2224          log_error(LOG_LEVEL_HEADER, "%s not replaced. "
2225             "It doesn't look like a content type that should be filtered. "
2226             "Enable force-text-mode if you know what you're doing.", *header);
2227       }
2228    }
2229
2230    return JB_ERR_OK;
2231 }
2232
2233
2234 /*********************************************************************
2235  *
2236  * Function    :  server_transfer_coding
2237  *
2238  * Description :  - Prohibit filtering (CT_TABOO) if transfer coding compresses
2239  *                - Raise the CSP_FLAG_CHUNKED flag if coding is "chunked"
2240  *                - Remove header if body was chunked but has been
2241  *                  de-chunked for filtering.
2242  *
2243  * Parameters  :
2244  *          1  :  csp = Current client state (buffers, headers, etc...)
2245  *          2  :  header = On input, pointer to header to modify.
2246  *                On output, pointer to the modified header, or NULL
2247  *                to remove the header.  This function frees the
2248  *                original string if necessary.
2249  *
2250  * Returns     :  JB_ERR_OK on success, or
2251  *                JB_ERR_MEMORY on out-of-memory error.
2252  *
2253  *********************************************************************/
2254 static jb_err server_transfer_coding(struct client_state *csp, char **header)
2255 {
2256    /*
2257     * Turn off pcrs and gif filtering if body compressed
2258     */
2259    if (strstr(*header, "gzip") || strstr(*header, "compress") || strstr(*header, "deflate"))
2260    {
2261 #ifdef FEATURE_ZLIB
2262       /*
2263        * XXX: Added to test if we could use CT_GZIP and CT_DEFLATE here.
2264        */
2265       log_error(LOG_LEVEL_INFO, "Marking content type for %s as CT_TABOO because of %s.",
2266          csp->http->cmd, *header);
2267 #endif /* def FEATURE_ZLIB */
2268       csp->content_type = CT_TABOO;
2269    }
2270
2271    /*
2272     * Raise flag if body chunked
2273     */
2274    if (strstr(*header, "chunked"))
2275    {
2276       csp->flags |= CSP_FLAG_CHUNKED;
2277
2278       /*
2279        * If the body was modified, it has been de-chunked first
2280        * and the header must be removed.
2281        *
2282        * FIXME: If there is more than one transfer encoding,
2283        * only the "chunked" part should be removed here.
2284        */
2285       if (csp->flags & CSP_FLAG_MODIFIED)
2286       {
2287          log_error(LOG_LEVEL_HEADER, "Removing: %s", *header);
2288          freez(*header);
2289       }
2290    }
2291
2292    return JB_ERR_OK;
2293 }
2294
2295
2296 /*********************************************************************
2297  *
2298  * Function    :  server_content_encoding
2299  *
2300  * Description :  Used to check if the content is compressed, and if
2301  *                FEATURE_ZLIB is disabled, filtering is disabled as
2302  *                well.
2303  *
2304  *                If FEATURE_ZLIB is enabled and the compression type
2305  *                supported, the content is marked for decompression.
2306  *
2307  *                XXX: Doesn't properly deal with multiple or with
2308  *                     unsupported but unknown encodings.
2309  *                     Is case-sensitive but shouldn't be.
2310  *
2311  * Parameters  :
2312  *          1  :  csp = Current client state (buffers, headers, etc...)
2313  *          2  :  header = On input, pointer to header to modify.
2314  *                On output, pointer to the modified header, or NULL
2315  *                to remove the header.  This function frees the
2316  *                original string if necessary.
2317  *
2318  * Returns     :  JB_ERR_OK on success, or
2319  *                JB_ERR_MEMORY on out-of-memory error.
2320  *
2321  *********************************************************************/
2322 static jb_err server_content_encoding(struct client_state *csp, char **header)
2323 {
2324 #ifdef FEATURE_ZLIB
2325    if (strstr(*header, "sdch"))
2326    {
2327       /*
2328        * Shared Dictionary Compression over HTTP isn't supported,
2329        * filtering it anyway is pretty much guaranteed to mess up
2330        * the encoding.
2331        */
2332       csp->content_type |= CT_TABOO;
2333
2334       /*
2335        * Log a warning if the user expects the content to be filtered.
2336        */
2337       if (content_filters_enabled(csp->action))
2338       {
2339          log_error(LOG_LEVEL_INFO,
2340             "SDCH-compressed content detected, content filtering disabled. "
2341             "Consider suppressing SDCH offers made by the client.");
2342       }
2343    }
2344    else if (strstr(*header, "gzip"))
2345    {
2346       /* Mark for gzip decompression */
2347       csp->content_type |= CT_GZIP;
2348    }
2349    else if (strstr(*header, "deflate"))
2350    {
2351       /* Mark for zlib decompression */
2352       csp->content_type |= CT_DEFLATE;
2353    }
2354    else if (strstr(*header, "compress"))
2355    {
2356       /*
2357        * We can't decompress this; therefore we can't filter
2358        * it either.
2359        */
2360       csp->content_type |= CT_TABOO;
2361    }
2362 #else /* !defined(FEATURE_ZLIB) */
2363    /*
2364     * XXX: Using a black list here isn't the right approach.
2365     *
2366     *      In case of SDCH, building with zlib support isn't
2367     *      going to help.
2368     */
2369    if (strstr(*header, "gzip") ||
2370        strstr(*header, "compress") ||
2371        strstr(*header, "deflate") ||
2372        strstr(*header, "sdch"))
2373    {
2374       /*
2375        * Body is compressed, turn off pcrs and gif filtering.
2376        */
2377       csp->content_type |= CT_TABOO;
2378
2379       /*
2380        * Log a warning if the user expects the content to be filtered.
2381        */
2382       if (content_filters_enabled(csp->action))
2383       {
2384          log_error(LOG_LEVEL_INFO,
2385             "Compressed content detected, content filtering disabled. "
2386             "Consider recompiling Privoxy with zlib support or "
2387             "enable the prevent-compression action.");
2388       }
2389    }
2390 #endif /* defined(FEATURE_ZLIB) */
2391
2392    return JB_ERR_OK;
2393
2394 }
2395
2396
2397 #ifdef FEATURE_ZLIB
2398 /*********************************************************************
2399  *
2400  * Function    :  server_adjust_content_encoding
2401  *
2402  * Description :  Remove the Content-Encoding header if the
2403  *                decompression was successful and the content
2404  *                has been modifed.
2405  *
2406  * Parameters  :
2407  *          1  :  csp = Current client state (buffers, headers, etc...)
2408  *          2  :  header = On input, pointer to header to modify.
2409  *                On output, pointer to the modified header, or NULL
2410  *                to remove the header.  This function frees the
2411  *                original string if necessary.
2412  *
2413  * Returns     :  JB_ERR_OK on success, or
2414  *                JB_ERR_MEMORY on out-of-memory error.
2415  *
2416  *********************************************************************/
2417 static jb_err server_adjust_content_encoding(struct client_state *csp, char **header)
2418 {
2419    if ((csp->flags & CSP_FLAG_MODIFIED)
2420     && (csp->content_type & (CT_GZIP | CT_DEFLATE)))
2421    {
2422       /*
2423        * We successfully decompressed the content,
2424        * and have to clean the header now, so the
2425        * client no longer expects compressed data.
2426        *
2427        * XXX: There is a difference between cleaning
2428        * and removing it completely.
2429        */
2430       log_error(LOG_LEVEL_HEADER, "Crunching: %s", *header);
2431       freez(*header);
2432    }
2433
2434    return JB_ERR_OK;
2435
2436 }
2437 #endif /* defined(FEATURE_ZLIB) */
2438
2439
2440 /*********************************************************************
2441  *
2442  * Function    :  server_adjust_content_length
2443  *
2444  * Description :  Adjust Content-Length header if we modified
2445  *                the body.
2446  *
2447  * Parameters  :
2448  *          1  :  csp = Current client state (buffers, headers, etc...)
2449  *          2  :  header = On input, pointer to header to modify.
2450  *                On output, pointer to the modified header, or NULL
2451  *                to remove the header.  This function frees the
2452  *                original string if necessary.
2453  *
2454  * Returns     :  JB_ERR_OK on success, or
2455  *                JB_ERR_MEMORY on out-of-memory error.
2456  *
2457  *********************************************************************/
2458 static jb_err server_adjust_content_length(struct client_state *csp, char **header)
2459 {
2460    /* Regenerate header if the content was modified. */
2461    if (csp->flags & CSP_FLAG_MODIFIED)
2462    {
2463       const size_t header_length = 50;
2464       freez(*header);
2465       *header = malloc(header_length);
2466       if (*header == NULL)
2467       {
2468          return JB_ERR_MEMORY;
2469       }
2470       create_content_length_header(csp->content_length, *header, header_length);
2471       log_error(LOG_LEVEL_HEADER,
2472          "Adjusted Content-Length to %llu", csp->content_length);
2473    }
2474
2475    return JB_ERR_OK;
2476 }
2477
2478
2479 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2480 /*********************************************************************
2481  *
2482  * Function    :  server_save_content_length
2483  *
2484  * Description :  Save the Content-Length sent by the server.
2485  *
2486  * Parameters  :
2487  *          1  :  csp = Current client state (buffers, headers, etc...)
2488  *          2  :  header = On input, pointer to header to modify.
2489  *                On output, pointer to the modified header, or NULL
2490  *                to remove the header.  This function frees the
2491  *                original string if necessary.
2492  *
2493  * Returns     :  JB_ERR_OK on success, or
2494  *                JB_ERR_MEMORY on out-of-memory error.
2495  *
2496  *********************************************************************/
2497 static jb_err server_save_content_length(struct client_state *csp, char **header)
2498 {
2499    unsigned long long content_length = 0;
2500    const char *header_value;
2501
2502    assert(*(*header+14) == ':');
2503
2504    header_value = *header + 15;
2505    if (JB_ERR_OK != get_content_length(header_value, &content_length))
2506    {
2507       log_error(LOG_LEVEL_ERROR, "Crunching invalid header: %s", *header);
2508       freez(*header);
2509    }
2510    else
2511    {
2512       csp->expected_content_length = content_length;
2513       csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
2514       csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2515    }
2516
2517    return JB_ERR_OK;
2518 }
2519 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2520
2521
2522 /*********************************************************************
2523  *
2524  * Function    :  server_content_md5
2525  *
2526  * Description :  Crumble any Content-MD5 headers if the document was
2527  *                modified. FIXME: Should we re-compute instead?
2528  *
2529  * Parameters  :
2530  *          1  :  csp = Current client state (buffers, headers, etc...)
2531  *          2  :  header = On input, pointer to header to modify.
2532  *                On output, pointer to the modified header, or NULL
2533  *                to remove the header.  This function frees the
2534  *                original string if necessary.
2535  *
2536  * Returns     :  JB_ERR_OK on success, or
2537  *                JB_ERR_MEMORY on out-of-memory error.
2538  *
2539  *********************************************************************/
2540 static jb_err server_content_md5(struct client_state *csp, char **header)
2541 {
2542    if (csp->flags & CSP_FLAG_MODIFIED)
2543    {
2544       log_error(LOG_LEVEL_HEADER, "Crunching Content-MD5");
2545       freez(*header);
2546    }
2547
2548    return JB_ERR_OK;
2549 }
2550
2551
2552 /*********************************************************************
2553  *
2554  * Function    :  server_content_disposition
2555  *
2556  * Description :  If enabled, blocks or modifies the "Content-Disposition" header.
2557  *                Called from `sed'.
2558  *
2559  * Parameters  :
2560  *          1  :  csp = Current client state (buffers, headers, etc...)
2561  *          2  :  header = On input, pointer to header to modify.
2562  *                On output, pointer to the modified header, or NULL
2563  *                to remove the header.  This function frees the
2564  *                original string if necessary.
2565  *
2566  * Returns     :  JB_ERR_OK on success, or
2567  *                JB_ERR_MEMORY on out-of-memory error.
2568  *
2569  *********************************************************************/
2570 static jb_err server_content_disposition(struct client_state *csp, char **header)
2571 {
2572    const char *newval;
2573
2574    /*
2575     * Are we messing with the Content-Disposition header?
2576     */
2577    if ((csp->action->flags & ACTION_HIDE_CONTENT_DISPOSITION) == 0)
2578    {
2579       /* Me tinks not */
2580       return JB_ERR_OK;
2581    }
2582
2583    newval = csp->action->string[ACTION_STRING_CONTENT_DISPOSITION];
2584
2585    if ((newval == NULL) || (0 == strcmpic(newval, "block")))
2586    {
2587       /*
2588        * Blocking content-disposition header
2589        */
2590       log_error(LOG_LEVEL_HEADER, "Crunching %s!", *header);
2591       freez(*header);
2592       return JB_ERR_OK;
2593    }
2594    else
2595    {
2596       /*
2597        * Replacing Content-Disposition header
2598        */
2599       freez(*header);
2600       *header = strdup("Content-Disposition: ");
2601       string_append(header, newval);
2602
2603       if (*header != NULL)
2604       {
2605          log_error(LOG_LEVEL_HEADER,
2606             "Content-Disposition header crunched and replaced with: %s", *header);
2607       }
2608    }
2609    return (*header == NULL) ? JB_ERR_MEMORY : JB_ERR_OK;
2610 }
2611
2612
2613 /*********************************************************************
2614  *
2615  * Function    :  server_last_modified
2616  *
2617  * Description :  Changes Last-Modified header to the actual date
2618  *                to help hide-if-modified-since.
2619  *                Called from `sed'.
2620  *
2621  * Parameters  :
2622  *          1  :  csp = Current client state (buffers, headers, etc...)
2623  *          2  :  header = On input, pointer to header to modify.
2624  *                On output, pointer to the modified header, or NULL
2625  *                to remove the header.  This function frees the
2626  *                original string if necessary.
2627  *
2628  * Returns     :  JB_ERR_OK on success, or
2629  *                JB_ERR_MEMORY on out-of-memory error.
2630  *
2631  *********************************************************************/
2632 static jb_err server_last_modified(struct client_state *csp, char **header)
2633 {
2634    const char *newval;
2635    time_t last_modified;
2636    char newheader[50];
2637
2638    /*
2639     * Are we messing with the Last-Modified header?
2640     */
2641    if ((csp->action->flags & ACTION_OVERWRITE_LAST_MODIFIED) == 0)
2642    {
2643       /*Nope*/
2644       return JB_ERR_OK;
2645    }
2646
2647    newval = csp->action->string[ACTION_STRING_LAST_MODIFIED];
2648
2649    if (0 == strcmpic(newval, "block"))
2650    {
2651       /*
2652        * Blocking Last-Modified header. Useless but why not.
2653        */
2654       log_error(LOG_LEVEL_HEADER, "Crunching %s!", *header);
2655       freez(*header);
2656       return JB_ERR_OK;
2657    }
2658    else if (0 == strcmpic(newval, "reset-to-request-time"))
2659    {
2660       /*
2661        * Setting Last-Modified Header to now.
2662        */
2663       char buf[30];
2664       get_http_time(0, buf, sizeof(buf));
2665       freez(*header);
2666       *header = strdup("Last-Modified: ");
2667       string_append(header, buf);
2668
2669       if (*header == NULL)
2670       {
2671          log_error(LOG_LEVEL_HEADER, "Insufficient memory. Last-Modified header got lost, boohoo.");
2672       }
2673       else
2674       {
2675          log_error(LOG_LEVEL_HEADER, "Reset to present time: %s", *header);
2676       }
2677    }
2678    else if (0 == strcmpic(newval, "randomize"))
2679    {
2680       log_error(LOG_LEVEL_HEADER, "Randomizing: %s", *header);
2681
2682       if (JB_ERR_OK != parse_time_header(*header, &last_modified))
2683       {
2684          log_error(LOG_LEVEL_HEADER,
2685             "Couldn't parse time in %s (crunching!)", *header);
2686          freez(*header);
2687       }
2688       else
2689       {
2690          time_t now;
2691          struct tm *timeptr = NULL;
2692          long int rtime;
2693 #ifdef HAVE_GMTIME_R
2694          struct tm gmt;
2695 #endif
2696          now = time(NULL);
2697          rtime = (long int)difftime(now, last_modified);
2698          if (rtime)
2699          {
2700             long int days, hours, minutes, seconds;
2701             const int negative_delta = (rtime < 0);
2702
2703             if (negative_delta)
2704             {
2705                rtime *= -1;
2706                log_error(LOG_LEVEL_HEADER, "Server time in the future.");
2707             }
2708             rtime = pick_from_range(rtime);
2709             if (negative_delta)
2710             {
2711                rtime *= -1;
2712             }
2713             last_modified += rtime;
2714 #ifdef HAVE_GMTIME_R
2715             timeptr = gmtime_r(&last_modified, &gmt);
2716 #elif defined(MUTEX_LOCKS_AVAILABLE)
2717             privoxy_mutex_lock(&gmtime_mutex);
2718             timeptr = gmtime(&last_modified);
2719             privoxy_mutex_unlock(&gmtime_mutex);
2720 #else
2721             timeptr = gmtime(&last_modified);
2722 #endif
2723             if ((NULL == timeptr) || !strftime(newheader,
2724                   sizeof(newheader), "%a, %d %b %Y %H:%M:%S GMT", timeptr))
2725             {
2726                log_error(LOG_LEVEL_ERROR,
2727                   "Randomizing '%s' failed. Crunching the header without replacement.",
2728                   *header);
2729                freez(*header);
2730                return JB_ERR_OK;
2731             }
2732
2733             freez(*header);
2734             *header = strdup("Last-Modified: ");
2735             string_append(header, newheader);
2736
2737             if (*header == NULL)
2738             {
2739                log_error(LOG_LEVEL_ERROR, "Insufficient memory, header crunched without replacement.");
2740                return JB_ERR_MEMORY;
2741             }
2742
2743             days    = rtime / (3600 * 24);
2744             hours   = rtime / 3600 % 24;
2745             minutes = rtime / 60 % 60;
2746             seconds = rtime % 60;
2747
2748             log_error(LOG_LEVEL_HEADER,
2749                "Randomized:  %s (added %d da%s %d hou%s %d minut%s %d second%s",
2750                *header, days, (days == 1) ? "y" : "ys", hours, (hours == 1) ? "r" : "rs",
2751                minutes, (minutes == 1) ? "e" : "es", seconds, (seconds == 1) ? ")" : "s)");
2752          }
2753          else
2754          {
2755             log_error(LOG_LEVEL_HEADER, "Randomized ... or not. No time difference to work with.");
2756          }
2757       }
2758    }
2759
2760    return JB_ERR_OK;
2761 }
2762
2763
2764 /*********************************************************************
2765  *
2766  * Function    :  client_accept_encoding
2767  *
2768  * Description :  Rewrite the client's Accept-Encoding header so that
2769  *                if doesn't allow compression, if the action applies.
2770  *                Note: For HTTP/1.0 the absence of the header is enough.
2771  *
2772  * Parameters  :
2773  *          1  :  csp = Current client state (buffers, headers, etc...)
2774  *          2  :  header = On input, pointer to header to modify.
2775  *                On output, pointer to the modified header, or NULL
2776  *                to remove the header.  This function frees the
2777  *                original string if necessary.
2778  *
2779  * Returns     :  JB_ERR_OK on success, or
2780  *                JB_ERR_MEMORY on out-of-memory error.
2781  *
2782  *********************************************************************/
2783 static jb_err client_accept_encoding(struct client_state *csp, char **header)
2784 {
2785 #ifdef FEATURE_COMPRESSION
2786    if ((csp->config->feature_flags & RUNTIME_FEATURE_COMPRESSION)
2787       && strstr(*header, "deflate"))
2788    {
2789       csp->flags |= CSP_FLAG_CLIENT_SUPPORTS_DEFLATE;
2790    }
2791 #endif
2792    if ((csp->action->flags & ACTION_NO_COMPRESSION) != 0)
2793    {
2794       log_error(LOG_LEVEL_HEADER, "Suppressed offer to compress content");
2795       freez(*header);
2796    }
2797
2798    return JB_ERR_OK;
2799 }
2800
2801
2802 /*********************************************************************
2803  *
2804  * Function    :  client_te
2805  *
2806  * Description :  Rewrite the client's TE header so that
2807  *                if doesn't allow compression, if the action applies.
2808  *
2809  * Parameters  :
2810  *          1  :  csp = Current client state (buffers, headers, etc...)
2811  *          2  :  header = On input, pointer to header to modify.
2812  *                On output, pointer to the modified header, or NULL
2813  *                to remove the header.  This function frees the
2814  *                original string if necessary.
2815  *
2816  * Returns     :  JB_ERR_OK on success, or
2817  *                JB_ERR_MEMORY on out-of-memory error.
2818  *
2819  *********************************************************************/
2820 static jb_err client_te(struct client_state *csp, char **header)
2821 {
2822    if ((csp->action->flags & ACTION_NO_COMPRESSION) != 0)
2823    {
2824       freez(*header);
2825       log_error(LOG_LEVEL_HEADER, "Suppressed offer to compress transfer");
2826    }
2827
2828    return JB_ERR_OK;
2829 }
2830
2831
2832 /*********************************************************************
2833  *
2834  * Function    :  client_referrer
2835  *
2836  * Description :  Handle the "referer" config setting properly.
2837  *                Called from `sed'.
2838  *
2839  * Parameters  :
2840  *          1  :  csp = Current client state (buffers, headers, etc...)
2841  *          2  :  header = On input, pointer to header to modify.
2842  *                On output, pointer to the modified header, or NULL
2843  *                to remove the header.  This function frees the
2844  *                original string if necessary.
2845  *
2846  * Returns     :  JB_ERR_OK on success, or
2847  *                JB_ERR_MEMORY on out-of-memory error.
2848  *
2849  *********************************************************************/
2850 static jb_err client_referrer(struct client_state *csp, char **header)
2851 {
2852    const char *parameter;
2853    /* booleans for parameters we have to check multiple times */
2854    int parameter_conditional_block;
2855    int parameter_conditional_forge;
2856
2857 #ifdef FEATURE_FORCE_LOAD
2858    /*
2859     * Since the referrer can include the prefix even
2860     * if the request itself is non-forced, we must
2861     * clean it unconditionally.
2862     *
2863     * XXX: strclean is too broad
2864     */
2865    strclean(*header, FORCE_PREFIX);
2866 #endif /* def FEATURE_FORCE_LOAD */
2867
2868    if ((csp->action->flags & ACTION_HIDE_REFERER) == 0)
2869    {
2870       /* Nothing left to do */
2871       return JB_ERR_OK;
2872    }
2873
2874    parameter = csp->action->string[ACTION_STRING_REFERER];
2875    assert(parameter != NULL);
2876    parameter_conditional_block = (0 == strcmpic(parameter, "conditional-block"));
2877    parameter_conditional_forge = (0 == strcmpic(parameter, "conditional-forge"));
2878
2879    if (!parameter_conditional_block && !parameter_conditional_forge)
2880    {
2881       /*
2882        * As conditional-block and conditional-forge are the only
2883        * parameters that rely on the original referrer, we can
2884        * remove it now for all the others.
2885        */
2886       freez(*header);
2887    }
2888
2889    if (0 == strcmpic(parameter, "block"))
2890    {
2891       log_error(LOG_LEVEL_HEADER, "Referer crunched!");
2892       return JB_ERR_OK;
2893    }
2894    else if (parameter_conditional_block || parameter_conditional_forge)
2895    {
2896       return handle_conditional_hide_referrer_parameter(header,
2897          csp->http->hostport, parameter_conditional_block);
2898    }
2899    else if (0 == strcmpic(parameter, "forge"))
2900    {
2901       return create_forged_referrer(header, csp->http->hostport);
2902    }
2903    else
2904    {
2905       /* interpret parameter as user-supplied referer to fake */
2906       return create_fake_referrer(header, parameter);
2907    }
2908 }
2909
2910
2911 /*********************************************************************
2912  *
2913  * Function    :  client_accept_language
2914  *
2915  * Description :  Handle the "Accept-Language" config setting properly.
2916  *                Called from `sed'.
2917  *
2918  * Parameters  :
2919  *          1  :  csp = Current client state (buffers, headers, etc...)
2920  *          2  :  header = On input, pointer to header to modify.
2921  *                On output, pointer to the modified header, or NULL
2922  *                to remove the header.  This function frees the
2923  *                original string if necessary.
2924  *
2925  * Returns     :  JB_ERR_OK on success, or
2926  *                JB_ERR_MEMORY on out-of-memory error.
2927  *
2928  *********************************************************************/
2929 static jb_err client_accept_language(struct client_state *csp, char **header)
2930 {
2931    const char *newval;
2932
2933    /*
2934     * Are we messing with the Accept-Language?
2935     */
2936    if ((csp->action->flags & ACTION_HIDE_ACCEPT_LANGUAGE) == 0)
2937    {
2938       /*I don't think so*/
2939       return JB_ERR_OK;
2940    }
2941
2942    newval = csp->action->string[ACTION_STRING_LANGUAGE];
2943
2944    if ((newval == NULL) || (0 == strcmpic(newval, "block")))
2945    {
2946       /*
2947        * Blocking Accept-Language header
2948        */
2949       log_error(LOG_LEVEL_HEADER, "Crunching Accept-Language!");
2950       freez(*header);
2951       return JB_ERR_OK;
2952    }
2953    else
2954    {
2955       /*
2956        * Replacing Accept-Language header
2957        */
2958       freez(*header);
2959       *header = strdup("Accept-Language: ");
2960       string_append(header, newval);
2961
2962       if (*header == NULL)
2963       {
2964          log_error(LOG_LEVEL_ERROR,
2965             "Insufficient memory. Accept-Language header crunched without replacement.");
2966       }
2967       else
2968       {
2969          log_error(LOG_LEVEL_HEADER,
2970             "Accept-Language header crunched and replaced with: %s", *header);
2971       }
2972    }
2973    return (*header == NULL) ? JB_ERR_MEMORY : JB_ERR_OK;
2974 }
2975
2976
2977 /*********************************************************************
2978  *
2979  * Function    :  crunch_client_header
2980  *
2981  * Description :  Crunch client header if it matches a string supplied by the
2982  *                user. Called from `sed'.
2983  *
2984  * Parameters  :
2985  *          1  :  csp = Current client state (buffers, headers, etc...)
2986  *          2  :  header = On input, pointer to header to modify.
2987  *                On output, pointer to the modified header, or NULL
2988  *                to remove the header.  This function frees the
2989  *                original string if necessary.
2990  *
2991  * Returns     :  JB_ERR_OK on success and always succeeds
2992  *
2993  *********************************************************************/
2994 static jb_err crunch_client_header(struct client_state *csp, char **header)
2995 {
2996    const char *crunch_pattern;
2997
2998    /* Do we feel like crunching? */
2999    if ((csp->action->flags & ACTION_CRUNCH_CLIENT_HEADER))
3000    {
3001       crunch_pattern = csp->action->string[ACTION_STRING_CLIENT_HEADER];
3002
3003       /* Is the current header the lucky one? */
3004       if (strstr(*header, crunch_pattern))
3005       {
3006          log_error(LOG_LEVEL_HEADER, "Crunching client header: %s (contains: %s)", *header, crunch_pattern);
3007          freez(*header);
3008       }
3009    }
3010    return JB_ERR_OK;
3011 }
3012
3013
3014 /*********************************************************************
3015  *
3016  * Function    :  client_uagent
3017  *
3018  * Description :  Handle the "user-agent" config setting properly
3019  *                and remember its original value to enable browser
3020  *                bug workarounds. Called from `sed'.
3021  *
3022  * Parameters  :
3023  *          1  :  csp = Current client state (buffers, headers, etc...)
3024  *          2  :  header = On input, pointer to header to modify.
3025  *                On output, pointer to the modified header, or NULL
3026  *                to remove the header.  This function frees the
3027  *                original string if necessary.
3028  *
3029  * Returns     :  JB_ERR_OK on success, or
3030  *                JB_ERR_MEMORY on out-of-memory error.
3031  *
3032  *********************************************************************/
3033 static jb_err client_uagent(struct client_state *csp, char **header)
3034 {
3035    const char *newval;
3036
3037    if ((csp->action->flags & ACTION_HIDE_USER_AGENT) == 0)
3038    {
3039       return JB_ERR_OK;
3040    }
3041
3042    newval = csp->action->string[ACTION_STRING_USER_AGENT];
3043    if (newval == NULL)
3044    {
3045       return JB_ERR_OK;
3046    }
3047
3048    freez(*header);
3049    *header = strdup("User-Agent: ");
3050    string_append(header, newval);
3051
3052    log_error(LOG_LEVEL_HEADER, "Modified: %s", *header);
3053
3054    return (*header == NULL) ? JB_ERR_MEMORY : JB_ERR_OK;
3055 }
3056
3057
3058 /*********************************************************************
3059  *
3060  * Function    :  client_ua
3061  *
3062  * Description :  Handle "ua-" headers properly.  Called from `sed'.
3063  *
3064  * Parameters  :
3065  *          1  :  csp = Current client state (buffers, headers, etc...)
3066  *          2  :  header = On input, pointer to header to modify.
3067  *                On output, pointer to the modified header, or NULL
3068  *                to remove the header.  This function frees the
3069  *                original string if necessary.
3070  *
3071  * Returns     :  JB_ERR_OK on success, or
3072  *                JB_ERR_MEMORY on out-of-memory error.
3073  *
3074  *********************************************************************/
3075 static jb_err client_ua(struct client_state *csp, char **header)
3076 {
3077    if ((csp->action->flags & ACTION_HIDE_USER_AGENT) != 0)
3078    {
3079       log_error(LOG_LEVEL_HEADER, "crunched User-Agent!");
3080       freez(*header);
3081    }
3082
3083    return JB_ERR_OK;
3084 }
3085
3086
3087 /*********************************************************************
3088  *
3089  * Function    :  client_from
3090  *
3091  * Description :  Handle the "from" config setting properly.
3092  *                Called from `sed'.
3093  *
3094  * Parameters  :
3095  *          1  :  csp = Current client state (buffers, headers, etc...)
3096  *          2  :  header = On input, pointer to header to modify.
3097  *                On output, pointer to the modified header, or NULL
3098  *                to remove the header.  This function frees the
3099  *                original string if necessary.
3100  *
3101  * Returns     :  JB_ERR_OK on success, or
3102  *                JB_ERR_MEMORY on out-of-memory error.
3103  *
3104  *********************************************************************/
3105 static jb_err client_from(struct client_state *csp, char **header)
3106 {
3107    const char *newval;
3108
3109    if ((csp->action->flags & ACTION_HIDE_FROM) == 0)
3110    {
3111       return JB_ERR_OK;
3112    }
3113
3114    freez(*header);
3115
3116    newval = csp->action->string[ACTION_STRING_FROM];
3117
3118    /*
3119     * Are we blocking the e-mail address?
3120     */
3121    if ((newval == NULL) || (0 == strcmpic(newval, "block")))
3122    {
3123       log_error(LOG_LEVEL_HEADER, "crunched From!");
3124       return JB_ERR_OK;
3125    }
3126
3127    log_error(LOG_LEVEL_HEADER, " modified");
3128
3129    *header = strdup("From: ");
3130    string_append(header, newval);
3131
3132    return (*header == NULL) ? JB_ERR_MEMORY : JB_ERR_OK;
3133 }
3134
3135
3136 /*********************************************************************
3137  *
3138  * Function    :  client_send_cookie
3139  *
3140  * Description :  Crunches the "cookie" header if necessary.
3141  *                Called from `sed'.
3142  *
3143  *                XXX: Stupid name, doesn't send squat.
3144  *
3145  * Parameters  :
3146  *          1  :  csp = Current client state (buffers, headers, etc...)
3147  *          2  :  header = On input, pointer to header to modify.
3148  *                On output, pointer to the modified header, or NULL
3149  *                to remove the header.  This function frees the
3150  *                original string if necessary.
3151  *
3152  * Returns     :  JB_ERR_OK on success, or
3153  *                JB_ERR_MEMORY on out-of-memory error.
3154  *
3155  *********************************************************************/
3156 static jb_err client_send_cookie(struct client_state *csp, char **header)
3157 {
3158    if (csp->action->flags & ACTION_CRUNCH_OUTGOING_COOKIES)
3159    {
3160       log_error(LOG_LEVEL_HEADER, "Crunched outgoing cookie: %s", *header);
3161       freez(*header);
3162    }
3163
3164    return JB_ERR_OK;
3165 }
3166
3167
3168 /*********************************************************************
3169  *
3170  * Function    :  client_x_forwarded
3171  *
3172  * Description :  Handle the "x-forwarded-for" config setting properly,
3173  *                also used in the add_client_headers list.  Called from `sed'.
3174  *
3175  * Parameters  :
3176  *          1  :  csp = Current client state (buffers, headers, etc...)
3177  *          2  :  header = On input, pointer to header to modify.
3178  *                On output, pointer to the modified header, or NULL
3179  *                to remove the header.  This function frees the
3180  *                original string if necessary.
3181  *
3182  * Returns     :  JB_ERR_OK on success, or
3183  *                JB_ERR_MEMORY on out-of-memory error.
3184  *
3185  *********************************************************************/
3186 jb_err client_x_forwarded(struct client_state *csp, char **header)
3187 {
3188    if (0 != (csp->action->flags & ACTION_CHANGE_X_FORWARDED_FOR))
3189    {
3190       const char *parameter = csp->action->string[ACTION_STRING_CHANGE_X_FORWARDED_FOR];
3191
3192       if (0 == strcmpic(parameter, "block"))
3193       {
3194          freez(*header);
3195          log_error(LOG_LEVEL_HEADER, "crunched x-forwarded-for!");
3196       }
3197       else if (0 == strcmpic(parameter, "add"))
3198       {
3199          string_append(header, ", ");
3200          string_append(header, csp->ip_addr_str);
3201
3202          if (*header == NULL)
3203          {
3204             return JB_ERR_MEMORY;
3205          }
3206          log_error(LOG_LEVEL_HEADER,
3207             "Appended client IP address to %s", *header);
3208          csp->flags |= CSP_FLAG_X_FORWARDED_FOR_APPENDED;
3209       }
3210       else
3211       {
3212          log_error(LOG_LEVEL_FATAL,
3213             "Invalid change-x-forwarded-for parameter: '%s'", parameter);
3214       }
3215    }
3216
3217    return JB_ERR_OK;
3218 }
3219
3220
3221 /*********************************************************************
3222  *
3223  * Function    :  client_max_forwards
3224  *
3225  * Description :  If the HTTP method is OPTIONS or TRACE, subtract one
3226  *                from the value of the Max-Forwards header field.
3227  *
3228  * Parameters  :
3229  *          1  :  csp = Current client state (buffers, headers, etc...)
3230  *          2  :  header = On input, pointer to header to modify.
3231  *                On output, pointer to the modified header, or NULL
3232  *                to remove the header.  This function frees the
3233  *                original string if necessary.
3234  *
3235  * Returns     :  JB_ERR_OK on success, or
3236  *                JB_ERR_MEMORY on out-of-memory error.
3237  *
3238  *********************************************************************/
3239 static jb_err client_max_forwards(struct client_state *csp, char **header)
3240 {
3241    int max_forwards;
3242
3243    if ((0 == strcmpic(csp->http->gpc, "trace")) ||
3244        (0 == strcmpic(csp->http->gpc, "options")))
3245    {
3246       assert(*(*header+12) == ':');
3247       if (1 == sscanf(*header+12, ": %d", &max_forwards))
3248       {
3249          if (max_forwards > 0)
3250          {
3251             snprintf(*header, strlen(*header)+1, "Max-Forwards: %d", --max_forwards);
3252             log_error(LOG_LEVEL_HEADER,
3253                "Max-Forwards value for %s request reduced to %d.",
3254                csp->http->gpc, max_forwards);
3255          }
3256          else if (max_forwards < 0)
3257          {
3258             log_error(LOG_LEVEL_ERROR, "Crunching invalid header: %s", *header);
3259             freez(*header);
3260          }
3261       }
3262       else
3263       {
3264          log_error(LOG_LEVEL_ERROR, "Crunching invalid header: %s", *header);
3265          freez(*header);
3266       }
3267    }
3268
3269    return JB_ERR_OK;
3270 }
3271
3272
3273 /*********************************************************************
3274  *
3275  * Function    :  client_host
3276  *
3277  * Description :  If the request URI did not contain host and
3278  *                port information, parse and evaluate the Host
3279  *                header field.
3280  *
3281  * Parameters  :
3282  *          1  :  csp = Current client state (buffers, headers, etc...)
3283  *          2  :  header = On input, pointer to header to modify.
3284  *                On output, pointer to the modified header, or NULL
3285  *                to remove the header.  This function frees the
3286  *                original string if necessary.
3287  *
3288  * Returns     :  JB_ERR_OK on success, or
3289  *                JB_ERR_MEMORY on out-of-memory error.
3290  *
3291  *********************************************************************/
3292 static jb_err client_host(struct client_state *csp, char **header)
3293 {
3294    char *p, *q;
3295
3296    if (strlen(*header) < 7)
3297    {
3298       log_error(LOG_LEVEL_HEADER, "Removing empty Host header");
3299       freez(*header);
3300       return JB_ERR_OK;
3301    }
3302
3303    if (!csp->http->hostport || (*csp->http->hostport == '*') ||
3304        *csp->http->hostport == ' ' || *csp->http->hostport == '\0')
3305    {
3306
3307       p = strdup_or_die((*header)+6);
3308       chomp(p);
3309       q = strdup_or_die(p);
3310
3311       freez(csp->http->hostport);
3312       csp->http->hostport = p;
3313       freez(csp->http->host);
3314       csp->http->host = q;
3315       q = strchr(csp->http->host, ':');
3316       if (q != NULL)
3317       {
3318          /* Terminate hostname and evaluate port string */
3319          *q++ = '\0';
3320          csp->http->port = atoi(q);
3321       }
3322       else
3323       {
3324          csp->http->port = csp->http->ssl ? 443 : 80;
3325       }
3326
3327       log_error(LOG_LEVEL_HEADER, "New host and port from Host field: %s = %s:%d",
3328                 csp->http->hostport, csp->http->host, csp->http->port);
3329    }
3330
3331    /* Signal client_host_adder() to return right away */
3332    csp->flags |= CSP_FLAG_HOST_HEADER_IS_SET;
3333
3334    return JB_ERR_OK;
3335 }
3336
3337
3338 /*********************************************************************
3339  *
3340  * Function    :  client_if_modified_since
3341  *
3342  * Description :  Remove or modify the If-Modified-Since header.
3343  *
3344  * Parameters  :
3345  *          1  :  csp = Current client state (buffers, headers, etc...)
3346  *          2  :  header = On input, pointer to header to modify.
3347  *                On output, pointer to the modified header, or NULL
3348  *                to remove the header.  This function frees the
3349  *                original string if necessary.
3350  *
3351  * Returns     :  JB_ERR_OK on success, or
3352  *                JB_ERR_MEMORY on out-of-memory error.
3353  *
3354  *********************************************************************/
3355 static jb_err client_if_modified_since(struct client_state *csp, char **header)
3356 {
3357    char newheader[50];
3358 #ifdef HAVE_GMTIME_R
3359    struct tm gmt;
3360 #endif
3361    struct tm *timeptr = NULL;
3362    time_t tm = 0;
3363    const char *newval;
3364    char * endptr;
3365
3366    if (0 == strcmpic(*header, "If-Modified-Since: Wed, 08 Jun 1955 12:00:00 GMT"))
3367    {
3368       /*
3369        * The client got an error message because of a temporary problem,
3370        * the problem is gone and the client now tries to revalidate our
3371        * error message on the real server. The revalidation would always
3372        * end with the transmission of the whole document and there is
3373        * no need to expose the bogus If-Modified-Since header.
3374        */
3375       log_error(LOG_LEVEL_HEADER, "Crunching useless If-Modified-Since header.");
3376       freez(*header);
3377    }
3378    else if (csp->action->flags & ACTION_HIDE_IF_MODIFIED_SINCE)
3379    {
3380       newval = csp->action->string[ACTION_STRING_IF_MODIFIED_SINCE];
3381
3382       if ((0 == strcmpic(newval, "block")))
3383       {
3384          log_error(LOG_LEVEL_HEADER, "Crunching %s", *header);
3385          freez(*header);
3386       }
3387       else /* add random value */
3388       {
3389          if (JB_ERR_OK != parse_time_header(*header, &tm))
3390          {
3391             log_error(LOG_LEVEL_HEADER,
3392                "Couldn't parse time in %s (crunching!)", *header);
3393             freez(*header);
3394          }
3395          else
3396          {
3397             long int hours, minutes, seconds;
3398             long int rtime = strtol(newval, &endptr, 0);
3399             const int negative_range = (rtime < 0);
3400
3401             if (rtime)
3402             {
3403                log_error(LOG_LEVEL_HEADER, "Randomizing: %s (random range: %d minut%s)",
3404                   *header, rtime, (rtime == 1 || rtime == -1) ? "e": "es");
3405                if (negative_range)
3406                {
3407                   rtime *= -1;
3408                }
3409                rtime *= 60;
3410                rtime = pick_from_range(rtime);
3411             }
3412             else
3413             {
3414                log_error(LOG_LEVEL_ERROR, "Random range is 0. Assuming time transformation test.",
3415                   *header);
3416             }
3417             tm += rtime * (negative_range ? -1 : 1);
3418 #ifdef HAVE_GMTIME_R
3419             timeptr = gmtime_r(&tm, &gmt);
3420 #elif defined(MUTEX_LOCKS_AVAILABLE)
3421             privoxy_mutex_lock(&gmtime_mutex);
3422             timeptr = gmtime(&tm);
3423             privoxy_mutex_unlock(&gmtime_mutex);
3424 #else
3425             timeptr = gmtime(&tm);
3426 #endif
3427             if ((NULL == timeptr) || !strftime(newheader,
3428                   sizeof(newheader), "%a, %d %b %Y %H:%M:%S GMT", timeptr))
3429             {
3430                log_error(LOG_LEVEL_ERROR,
3431                   "Randomizing '%s' failed. Crunching the header without replacement.",
3432                   *header);
3433                freez(*header);
3434                return JB_ERR_OK;
3435             }
3436
3437             freez(*header);
3438             *header = strdup("If-Modified-Since: ");
3439             string_append(header, newheader);
3440
3441             if (*header == NULL)
3442             {
3443                log_error(LOG_LEVEL_HEADER, "Insufficient memory, header crunched without replacement.");
3444                return JB_ERR_MEMORY;
3445             }
3446
3447             hours   = rtime / 3600;
3448             minutes = rtime / 60 % 60;
3449             seconds = rtime % 60;
3450
3451             log_error(LOG_LEVEL_HEADER,
3452                "Randomized:  %s (%s %d hou%s %d minut%s %d second%s",
3453                *header, (negative_range) ? "subtracted" : "added", hours,
3454                (hours == 1) ? "r" : "rs", minutes, (minutes == 1) ? "e" : "es",
3455                seconds, (seconds == 1) ? ")" : "s)");
3456          }
3457       }
3458    }
3459
3460    return JB_ERR_OK;
3461 }
3462
3463
3464 /*********************************************************************
3465  *
3466  * Function    :  client_if_none_match
3467  *
3468  * Description :  Remove the If-None-Match header.
3469  *
3470  * Parameters  :
3471  *          1  :  csp = Current client state (buffers, headers, etc...)
3472  *          2  :  header = On input, pointer to header to modify.
3473  *                On output, pointer to the modified header, or NULL
3474  *                to remove the header.  This function frees the
3475  *                original string if necessary.
3476  *
3477  * Returns     :  JB_ERR_OK on success, or
3478  *                JB_ERR_MEMORY on out-of-memory error.
3479  *
3480  *********************************************************************/
3481 static jb_err client_if_none_match(struct client_state *csp, char **header)
3482 {
3483    if (csp->action->flags & ACTION_CRUNCH_IF_NONE_MATCH)
3484    {
3485       log_error(LOG_LEVEL_HEADER, "Crunching %s", *header);
3486       freez(*header);
3487    }
3488
3489    return JB_ERR_OK;
3490 }
3491
3492
3493 /*********************************************************************
3494  *
3495  * Function    :  client_x_filter
3496  *
3497  * Description :  Disables filtering if the client set "X-Filter: No".
3498  *                Called from `sed'.
3499  *
3500  * Parameters  :
3501  *          1  :  csp = Current client state (buffers, headers, etc...)
3502  *          2  :  header = On input, pointer to header to modify.
3503  *                On output, pointer to the modified header, or NULL
3504  *                to remove the header.  This function frees the
3505  *                original string if necessary.
3506  *
3507  * Returns     :  JB_ERR_OK on success
3508  *
3509  *********************************************************************/
3510 jb_err client_x_filter(struct client_state *csp, char **header)
3511 {
3512    if (0 == strcmpic(*header, "X-Filter: No"))
3513    {
3514       if (!(csp->config->feature_flags & RUNTIME_FEATURE_HTTP_TOGGLE))
3515       {
3516          log_error(LOG_LEVEL_INFO, "Ignored the client's request to fetch without filtering.");
3517       }
3518       else
3519       {
3520          if (csp->action->flags & ACTION_FORCE_TEXT_MODE)
3521          {
3522             log_error(LOG_LEVEL_HEADER,
3523                "force-text-mode overruled the client's request to fetch without filtering!");
3524          }
3525          else
3526          {
3527             csp->content_type = CT_TABOO; /* XXX: This hack shouldn't be necessary */
3528             csp->flags |= CSP_FLAG_NO_FILTERING;
3529             log_error(LOG_LEVEL_HEADER, "Accepted the client's request to fetch without filtering.");
3530          }
3531          log_error(LOG_LEVEL_HEADER, "Crunching %s", *header);
3532          freez(*header);
3533       }
3534    }
3535    return JB_ERR_OK;
3536 }
3537
3538
3539 /*********************************************************************
3540  *
3541  * Function    :  client_range
3542  *
3543  * Description :  Removes Range, Request-Range and If-Range headers if
3544  *                content filtering is enabled and the range doesn't
3545  *                start at byte 0.
3546  *
3547  *                If the client's version of the document has been
3548  *                altered by Privoxy, the server could interpret the
3549  *                range differently than the client intended in which
3550  *                case the user could end up with corrupted content.
3551  *
3552  *                If the range starts at byte 0 this isn't an issue
3553  *                so the header can pass. Partial requests like this
3554  *                are used to render preview images for videos without
3555  *                downloading the whole video.
3556  *
3557  *                While HTTP doesn't require that range requests are
3558  *                honoured and the client could simply abort the download
3559  *                after receiving a sufficient amount of data, various
3560  *                clients don't handle complete responses to range
3561  *                requests gracefully and emit misleading error messages
3562  *                instead.
3563  *
3564  * Parameters  :
3565  *          1  :  csp = Current client state (buffers, headers, etc...)
3566  *          2  :  header = On input, pointer to header to modify.
3567  *                On output, pointer to the modified header, or NULL
3568  *                to remove the header.  This function frees the
3569  *                original string if necessary.
3570  *
3571  * Returns     :  JB_ERR_OK
3572  *
3573  *********************************************************************/
3574 static jb_err client_range(struct client_state *csp, char **header)
3575 {
3576    if (content_filters_enabled(csp->action)
3577       && (0 != strncmpic(strstr(*header, ":"), ": bytes=0-", 10)))
3578    {
3579       log_error(LOG_LEVEL_HEADER, "Content filtering is enabled."
3580          " Crunching: \'%s\' to prevent range-mismatch problems.", *header);
3581       freez(*header);
3582    }
3583
3584    return JB_ERR_OK;
3585 }
3586
3587 /* the following functions add headers directly to the header list */
3588
3589 /*********************************************************************
3590  *
3591  * Function    :  client_host_adder
3592  *
3593  * Description :  Adds the Host: header field if it is missing.
3594  *                Called from `sed'.
3595  *
3596  * Parameters  :
3597  *          1  :  csp = Current client state (buffers, headers, etc...)
3598  *
3599  * Returns     :  JB_ERR_OK on success, or
3600  *                JB_ERR_MEMORY on out-of-memory error.
3601  *
3602  *********************************************************************/
3603 static jb_err client_host_adder(struct client_state *csp)
3604 {
3605    char *p;
3606    jb_err err;
3607
3608    if (csp->flags & CSP_FLAG_HOST_HEADER_IS_SET)
3609    {
3610       /* Header already set by the client, nothing to do. */
3611       return JB_ERR_OK;
3612    }
3613
3614    if (!csp->http->hostport || !*(csp->http->hostport))
3615    {
3616       log_error(LOG_LEVEL_ERROR, "Destination host unknown.");
3617       return JB_ERR_PARSE;
3618    }
3619
3620    /*
3621     * remove 'user:pass@' from 'proto://user:pass@host'
3622     */
3623    if ((p = strchr( csp->http->hostport, '@')) != NULL)
3624    {
3625       p++;
3626    }
3627    else
3628    {
3629       p = csp->http->hostport;
3630    }
3631
3632    /* XXX: Just add it, we already made sure that it will be unique */
3633    log_error(LOG_LEVEL_HEADER, "addh-unique: Host: %s", p);
3634    err = enlist_unique_header(csp->headers, "Host", p);
3635    return err;
3636
3637 }
3638
3639
3640 /*********************************************************************
3641  *
3642  * Function    :  client_xtra_adder
3643  *
3644  * Description :  Used in the add_client_headers list.  Called from `sed'.
3645  *
3646  * Parameters  :
3647  *          1  :  csp = Current client state (buffers, headers, etc...)
3648  *
3649  * Returns     :  JB_ERR_OK on success, or
3650  *                JB_ERR_MEMORY on out-of-memory error.
3651  *
3652  *********************************************************************/
3653 static jb_err client_xtra_adder(struct client_state *csp)
3654 {
3655    struct list_entry *lst;
3656    jb_err err;
3657
3658    for (lst = csp->action->multi[ACTION_MULTI_ADD_HEADER]->first;
3659         lst ; lst = lst->next)
3660    {
3661       log_error(LOG_LEVEL_HEADER, "addh: %s", lst->str);
3662       err = enlist(csp->headers, lst->str);
3663       if (err)
3664       {
3665          return err;
3666       }
3667
3668    }
3669
3670    return JB_ERR_OK;
3671 }
3672
3673
3674 /*********************************************************************
3675  *
3676  * Function    :  client_x_forwarded_for_adder
3677  *
3678  * Description :  Used in the add_client_headers list.  Called from `sed'.
3679  *
3680  * Parameters  :
3681  *          1  :  csp = Current client state (buffers, headers, etc...)
3682  *
3683  * Returns     :  JB_ERR_OK on success, or
3684  *                JB_ERR_MEMORY on out-of-memory error.
3685  *
3686  *********************************************************************/
3687 static jb_err client_x_forwarded_for_adder(struct client_state *csp)
3688 {
3689    char *header = NULL;
3690    jb_err err;
3691
3692    if (!((csp->action->flags & ACTION_CHANGE_X_FORWARDED_FOR)
3693          && (0 == strcmpic(csp->action->string[ACTION_STRING_CHANGE_X_FORWARDED_FOR], "add")))
3694       || (csp->flags & CSP_FLAG_X_FORWARDED_FOR_APPENDED))
3695    {
3696       /*
3697        * If we aren't adding X-Forwarded-For headers,
3698        * or we already appended an existing X-Forwarded-For
3699        * header, there's nothing left to do here.
3700        */
3701       return JB_ERR_OK;
3702    }
3703
3704    header = strdup("X-Forwarded-For: ");
3705    string_append(&header, csp->ip_addr_str);
3706
3707    if (header == NULL)
3708    {
3709       return JB_ERR_MEMORY;
3710    }
3711
3712    log_error(LOG_LEVEL_HEADER, "addh: %s", header);
3713    err = enlist(csp->headers, header);
3714    freez(header);
3715
3716    return err;
3717 }
3718
3719
3720 /*********************************************************************
3721  *
3722  * Function    :  server_connection_adder
3723  *
3724  * Description :  Adds an appropriate "Connection:" header to csp->headers
3725  *                unless the header was already present. Called from `sed'.
3726  *
3727  * Parameters  :
3728  *          1  :  csp = Current client state (buffers, headers, etc...)
3729  *
3730  * Returns     :  JB_ERR_OK on success, or
3731  *                JB_ERR_MEMORY on out-of-memory error.
3732  *
3733  *********************************************************************/
3734 static jb_err server_connection_adder(struct client_state *csp)
3735 {
3736    const unsigned int flags = csp->flags;
3737    const char *response_status_line = csp->headers->first->str;
3738    static const char connection_close[] = "Connection: close";
3739
3740    if ((flags & CSP_FLAG_CLIENT_HEADER_PARSING_DONE)
3741     && (flags & CSP_FLAG_SERVER_CONNECTION_HEADER_SET))
3742    {
3743       return JB_ERR_OK;
3744    }
3745
3746    /*
3747     * XXX: if we downgraded the response, this check will fail.
3748     */
3749    if ((csp->config->feature_flags &
3750         RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
3751     && (NULL != response_status_line)
3752     && !strncmpic(response_status_line, "HTTP/1.1", 8)
3753 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3754     && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
3755 #endif
3756       )
3757    {
3758       log_error(LOG_LEVEL_HEADER, "A HTTP/1.1 response "
3759          "without Connection header implies keep-alive.");
3760       csp->flags |= CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE;
3761       return JB_ERR_OK;
3762    }
3763
3764    log_error(LOG_LEVEL_HEADER, "Adding: %s", connection_close);
3765
3766    return enlist(csp->headers, connection_close);
3767 }
3768
3769
3770 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3771 /*********************************************************************
3772  *
3773  * Function    :  server_proxy_connection_adder
3774  *
3775  * Description :  Adds a "Proxy-Connection: keep-alive" header to
3776  *                csp->headers when appropriate.
3777  *
3778  * Parameters  :
3779  *          1  :  csp = Current client state (buffers, headers, etc...)
3780  *
3781  * Returns     :  JB_ERR_OK on success, or
3782  *                JB_ERR_MEMORY on out-of-memory error.
3783  *
3784  *********************************************************************/
3785 static jb_err server_proxy_connection_adder(struct client_state *csp)
3786 {
3787    static const char proxy_connection_header[] = "Proxy-Connection: keep-alive";
3788    jb_err err = JB_ERR_OK;
3789
3790    if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
3791     && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
3792     && !(csp->flags & CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET)
3793     && ((csp->flags & CSP_FLAG_SERVER_CONTENT_LENGTH_SET)
3794        || (csp->flags & CSP_FLAG_CHUNKED)))
3795    {
3796       log_error(LOG_LEVEL_HEADER, "Adding: %s", proxy_connection_header);
3797       err = enlist(csp->headers, proxy_connection_header);
3798    }
3799
3800    return err;
3801 }
3802 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
3803
3804
3805 /*********************************************************************
3806  *
3807  * Function    :  client_connection_header_adder
3808  *
3809  * Description :  Adds a proper "Connection:" header to csp->headers
3810  *                unless the header was already present or it's a
3811  *                CONNECT request. Called from `sed'.
3812  *
3813  * Parameters  :
3814  *          1  :  csp = Current client state (buffers, headers, etc...)
3815  *
3816  * Returns     :  JB_ERR_OK on success, or
3817  *                JB_ERR_MEMORY on out-of-memory error.
3818  *
3819  *********************************************************************/
3820 static jb_err client_connection_header_adder(struct client_state *csp)
3821 {
3822    static const char connection_close[] = "Connection: close";
3823
3824    if (!(csp->flags & CSP_FLAG_CLIENT_HEADER_PARSING_DONE)
3825      && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_HEADER_SET))
3826    {
3827       return JB_ERR_OK;
3828    }
3829
3830    /*
3831     * In case of CONNECT requests "Connection: close" is implied,
3832     * but actually setting the header has been reported to cause
3833     * problems with some forwarding proxies that close the
3834     * connection prematurely.
3835     */
3836    if (csp->http->ssl != 0)
3837    {
3838       return JB_ERR_OK;
3839    }
3840
3841 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3842    if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
3843       && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
3844       && !strcmpic(csp->http->ver, "HTTP/1.1"))
3845    {
3846       csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
3847       return JB_ERR_OK;
3848    }
3849 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
3850
3851    log_error(LOG_LEVEL_HEADER, "Adding: %s", connection_close);
3852
3853    return enlist(csp->headers, connection_close);
3854 }
3855
3856
3857 /*********************************************************************
3858  *
3859  * Function    :  server_http
3860  *
3861  * Description :  - Save the HTTP Status into csp->http->status
3862  *                - Set CT_TABOO to prevent filtering if the answer
3863  *                  is a partial range (HTTP status 206)
3864  *                - Rewrite HTTP/1.1 answers to HTTP/1.0 if +downgrade
3865  *                  action applies.
3866  *                - Normalize the HTTP-version.
3867  *
3868  * Parameters  :
3869  *          1  :  csp = Current client state (buffers, headers, etc...)
3870  *          2  :  header = On input, pointer to header to modify.
3871  *                On output, pointer to the modified header, or NULL
3872  *                to remove the header.  This function frees the
3873  *                original string if necessary.
3874  *
3875  * Returns     :  JB_ERR_OK on success, or
3876  *                JB_ERR_PARSE on fatal parse errors.
3877  *
3878  *********************************************************************/
3879 static jb_err server_http(struct client_state *csp, char **header)
3880 {
3881    char *reason_phrase = NULL;
3882    char *new_response_line;
3883    char *p;
3884    size_t length;
3885    unsigned int major_version;
3886    unsigned int minor_version;
3887
3888    /* Get the reason phrase which start after the second whitespace */
3889    p = strchr(*header, ' ');
3890    if (NULL != p)
3891    {
3892       p++;
3893       reason_phrase = strchr(p, ' ');
3894    }
3895
3896    if (reason_phrase != NULL)
3897    {
3898       reason_phrase++;
3899    }
3900    else
3901    {
3902       log_error(LOG_LEVEL_ERROR,
3903          "Response line lacks reason phrase: %s", *header);
3904       reason_phrase="";
3905    }
3906
3907    if (3 != sscanf(*header, "HTTP/%u.%u %d", &major_version,
3908          &minor_version, &(csp->http->status)))
3909    {
3910       log_error(LOG_LEVEL_ERROR,
3911          "Failed to parse the response line: %s", *header);
3912       return JB_ERR_PARSE;
3913    }
3914
3915    if (csp->http->status == 206)
3916    {
3917       csp->content_type = CT_TABOO;
3918    }
3919
3920    if (major_version != 1 || (minor_version != 0 && minor_version != 1))
3921    {
3922       /*
3923        * According to RFC 7230 2.6 intermediaries MUST send
3924        * their own HTTP-version in forwarded messages.
3925        */
3926       log_error(LOG_LEVEL_ERROR,
3927          "Unsupported HTTP version. Downgrading to 1.1.");
3928       major_version = 1;
3929       minor_version = 1;
3930    }
3931
3932    if (((csp->action->flags & ACTION_DOWNGRADE) != 0) && (minor_version == 1))
3933    {
3934       log_error(LOG_LEVEL_HEADER, "Downgrading answer to HTTP/1.0");
3935       minor_version = 0;
3936    }
3937
3938    /* Rebuild response line. */
3939    length = sizeof("HTTP/1.1 200 ") + strlen(reason_phrase) + 1;
3940    new_response_line = malloc_or_die(length);
3941
3942    snprintf(new_response_line, length, "HTTP/%u.%u %d %s",
3943       major_version, minor_version, csp->http->status, reason_phrase);
3944
3945    if (0 != strcmp(*header, new_response_line))
3946    {
3947       log_error(LOG_LEVEL_HEADER, "Response line '%s' changed to '%s'",
3948          *header, new_response_line);
3949    }
3950
3951    freez(*header);
3952    *header = new_response_line;
3953
3954    return JB_ERR_OK;
3955 }
3956
3957 /*********************************************************************
3958  *
3959  * Function    :  add_cooky_expiry_date
3960  *
3961  * Description :  Adds a cookie expiry date to a string.
3962  *
3963  * Parameters  :
3964  *          1  :  cookie = On input, pointer to cookie to modify.
3965  *                         On output, pointer to the modified header.
3966  *                         The original string is freed.
3967  *          2  :  lifetime = Seconds the cookie should be valid
3968  *
3969  * Returns     :  N/A
3970  *
3971  *********************************************************************/
3972 static void add_cookie_expiry_date(char **cookie, time_t lifetime)
3973 {
3974    char tmp[50];
3975    struct tm *timeptr = NULL;
3976    time_t expiry_date = time(NULL) + lifetime;
3977 #ifdef HAVE_GMTIME_R
3978    struct tm gmt;
3979
3980    timeptr = gmtime_r(&expiry_date, &gmt);
3981 #elif defined(MUTEX_LOCKS_AVAILABLE)
3982    privoxy_mutex_lock(&gmtime_mutex);
3983    timeptr = gmtime(&expiry_date);
3984    privoxy_mutex_unlock(&gmtime_mutex);
3985 #else
3986    timeptr = gmtime(&expiry_date);
3987 #endif
3988
3989    if (NULL == timeptr)
3990    {
3991       log_error(LOG_LEVEL_FATAL,
3992          "Failed to get the time in add_cooky_expiry_date()");
3993    }
3994    strftime(tmp, sizeof(tmp), "; expires=%a, %d-%b-%Y %H:%M:%S GMT", timeptr);
3995    if (JB_ERR_OK != string_append(cookie, tmp))
3996    {
3997       log_error(LOG_LEVEL_FATAL, "Out of memory in add_cooky_expiry()");
3998    }
3999 }
4000
4001
4002 /*********************************************************************
4003  *
4004  * Function    :  server_set_cookie
4005  *
4006  * Description :  Handle the server "cookie" header properly.
4007  *                Crunch, accept or rewrite it to a session cookie.
4008  *                Called from `sed'.
4009  *
4010  * Parameters  :
4011  *          1  :  csp = Current client state (buffers, headers, etc...)
4012  *          2  :  header = On input, pointer to header to modify.
4013  *                On output, pointer to the modified header, or NULL
4014  *                to remove the header.  This function frees the
4015  *                original string if necessary.
4016  *
4017  * Returns     :  JB_ERR_OK on success, or
4018  *                JB_ERR_MEMORY on out-of-memory error.
4019  *
4020  *********************************************************************/
4021 static jb_err server_set_cookie(struct client_state *csp, char **header)
4022 {
4023    if ((csp->action->flags & ACTION_CRUNCH_INCOMING_COOKIES) != 0)
4024    {
4025       log_error(LOG_LEVEL_HEADER, "Crunching incoming cookie: %s", *header);
4026       freez(*header);
4027    }
4028    else if ((0 != (csp->action->flags & ACTION_SESSION_COOKIES_ONLY))
4029          || (0 != (csp->action->flags & ACTION_LIMIT_COOKIE_LIFETIME)))
4030    {
4031       time_t now;
4032       time_t cookie_time;
4033       long cookie_lifetime = 0;
4034       enum
4035       {
4036          NO_EXPIRY_DATE_SPECIFIED,
4037          EXPIRY_DATE_ACCEPTABLE,
4038          EXPIRY_DATE_UNACCEPTABLE
4039       } expiry_date_status = NO_EXPIRY_DATE_SPECIFIED;
4040
4041       /* A variable to store the tag we're working on */
4042       char *cur_tag;
4043
4044       /* Skip "Set-Cookie:" (11 characters) in header */
4045       cur_tag = *header + 11;
4046
4047       /* skip whitespace between "Set-Cookie:" and value */
4048       while (*cur_tag && privoxy_isspace(*cur_tag))
4049       {
4050          cur_tag++;
4051       }
4052
4053       time(&now);
4054
4055       if ((csp->action->flags & ACTION_LIMIT_COOKIE_LIFETIME) != 0)
4056       {
4057          const char *param = csp->action->string[ACTION_STRING_LIMIT_COOKIE_LIFETIME];
4058
4059          cookie_lifetime = strtol(param, NULL, 0);
4060          if (cookie_lifetime < 0)
4061          {
4062             log_error(LOG_LEVEL_FATAL, "Invalid cookie lifetime limit: %s", param);
4063          }
4064          cookie_lifetime *= 60;
4065       }
4066
4067       /* Loop through each tag in the cookie */
4068       while (*cur_tag)
4069       {
4070          /* Find next tag */
4071          char *next_tag = strchr(cur_tag, ';');
4072          if (next_tag != NULL)
4073          {
4074             /* Skip the ';' character itself */
4075             next_tag++;
4076
4077             /* skip whitespace ";" and start of tag */
4078             while (*next_tag && privoxy_isspace(*next_tag))
4079             {
4080                next_tag++;
4081             }
4082          }
4083          else
4084          {
4085             /* "Next tag" is the end of the string */
4086             next_tag = cur_tag + strlen(cur_tag);
4087          }
4088
4089          /*
4090           * Check the expiration date to see
4091           * if the cookie is still valid, if yes,
4092           * rewrite it to a session cookie.
4093           */
4094          if ((strncmpic(cur_tag, "expires=", 8) == 0) && *(cur_tag + 8))
4095          {
4096             char *expiration_date = cur_tag + 8; /* Skip "[Ee]xpires=" */
4097
4098             if ((expiration_date[0] == '"')
4099              && (expiration_date[1] != '\0'))
4100             {
4101                /*
4102                 * Skip quotation mark. RFC 2109 10.1.2 seems to hint
4103                 * that the expiration date isn't supposed to be quoted,
4104                 * but some servers do it anyway.
4105                 */
4106                expiration_date++;
4107             }
4108
4109             /* Did we detect the date properly? */
4110             if (JB_ERR_OK != parse_header_time(expiration_date, &cookie_time))
4111             {
4112                /*
4113                 * Nope, treat it as if it was still valid.
4114                 *
4115                 * XXX: Should we remove the whole cookie instead?
4116                 */
4117                log_error(LOG_LEVEL_ERROR,
4118                   "Can't parse \'%s\', send by %s. Unsupported time format?", cur_tag, csp->http->url);
4119                string_move(cur_tag, next_tag);
4120                expiry_date_status = EXPIRY_DATE_UNACCEPTABLE;
4121             }
4122             else
4123             {
4124                /*
4125                 * Yes. Check if the cookie is still valid.
4126                 *
4127                 * If the cookie is already expired it's probably
4128                 * a delete cookie and even if it isn't, the browser
4129                 * will discard it anyway.
4130                 */
4131
4132                /*
4133                 * XXX: timegm() isn't available on some AmigaOS
4134                 * versions and our replacement doesn't work.
4135                 *
4136                 * Our options are to either:
4137                 *
4138                 * - disable session-cookies-only completely if timegm
4139                 *   is missing,
4140                 *
4141                 * - to simply remove all expired tags, like it has
4142                 *   been done until Privoxy 3.0.6 and to live with
4143                 *    the consequence that it can cause login/logout
4144                 *   problems on servers that don't validate their
4145                 *   input properly, or
4146                 *
4147                 * - to replace it with mktime in which
4148                 *   case there is a slight chance of valid cookies
4149                 *   passing as already expired.
4150                 *
4151                 *   This is the way it's currently done and it's not
4152                 *   as bad as it sounds. If the missing GMT offset is
4153                 *   enough to change the result of the expiration check
4154                 *   the cookie will be only valid for a few hours
4155                 *   anyway, which in many cases will be shorter
4156                 *   than a browser session.
4157                 */
4158                if (cookie_time < now)
4159                {
4160                   log_error(LOG_LEVEL_HEADER,
4161                      "Cookie \'%s\' is already expired and can pass unmodified.", *header);
4162                   /* Just in case some clown sets more then one expiration date */
4163                   cur_tag = next_tag;
4164                   expiry_date_status = EXPIRY_DATE_ACCEPTABLE;
4165                }
4166                else if ((cookie_lifetime != 0) && (cookie_time < (now + cookie_lifetime)))
4167                {
4168                   log_error(LOG_LEVEL_HEADER, "Cookie \'%s\' can pass unmodified. "
4169                      "Its lifetime is below the limit.", *header);
4170                   /* Just in case some clown sets more then one expiration date */
4171                   cur_tag = next_tag;
4172                   expiry_date_status = EXPIRY_DATE_ACCEPTABLE;
4173                }
4174                else
4175                {
4176                   /*
4177                    * Still valid, delete expiration date by copying
4178                    * the rest of the string over it.
4179                    */
4180                   string_move(cur_tag, next_tag);
4181
4182                   /* That changed the header, need to issue a log message */
4183                   expiry_date_status = EXPIRY_DATE_UNACCEPTABLE;
4184
4185                   /*
4186                    * Note that the next tag has now been moved to *cur_tag,
4187                    * so we do not need to update the cur_tag pointer.
4188                    */
4189                }
4190             }
4191
4192          }
4193          else
4194          {
4195             /* Move on to next cookie tag */
4196             cur_tag = next_tag;
4197          }
4198       }
4199
4200       if (expiry_date_status != EXPIRY_DATE_ACCEPTABLE)
4201       {
4202          assert(NULL != *header);
4203          if (cookie_lifetime != 0)
4204          {
4205             add_cookie_expiry_date(header, cookie_lifetime);
4206             log_error(LOG_LEVEL_HEADER, "Cookie rewritten to: %s", *header);
4207          }
4208          else if (expiry_date_status != NO_EXPIRY_DATE_SPECIFIED)
4209          {
4210             log_error(LOG_LEVEL_HEADER,
4211                "Cookie rewritten to a temporary one: %s", *header);
4212          }
4213       }
4214    }
4215
4216    return JB_ERR_OK;
4217 }
4218
4219
4220 #ifdef FEATURE_FORCE_LOAD
4221 /*********************************************************************
4222  *
4223  * Function    :  strclean
4224  *
4225  * Description :  In-Situ-Eliminate all occurrences of substring in
4226  *                string
4227  *
4228  * Parameters  :
4229  *          1  :  string = string to clean
4230  *          2  :  substring = substring to eliminate
4231  *
4232  * Returns     :  Number of eliminations
4233  *
4234  *********************************************************************/
4235 int strclean(char *string, const char *substring)
4236 {
4237    int hits = 0;
4238    size_t len;
4239    char *pos, *p;
4240
4241    len = strlen(substring);
4242
4243    while((pos = strstr(string, substring)) != NULL)
4244    {
4245       p = pos + len;
4246       do
4247       {
4248          *(p - len) = *p;
4249       }
4250       while (*p++ != '\0');
4251
4252       hits++;
4253    }
4254
4255    return(hits);
4256 }
4257 #endif /* def FEATURE_FORCE_LOAD */
4258
4259
4260 /*********************************************************************
4261  *
4262  * Function    :  parse_header_time
4263  *
4264  * Description :  Parses time formats used in HTTP header strings
4265  *                to get the numerical respresentation.
4266  *
4267  * Parameters  :
4268  *          1  :  header_time = HTTP header time as string.
4269  *          2  :  result = storage for header_time in seconds
4270  *
4271  * Returns     :  JB_ERR_OK if the time format was recognized, or
4272  *                JB_ERR_PARSE otherwise.
4273  *
4274  *********************************************************************/
4275 static jb_err parse_header_time(const char *header_time, time_t *result)
4276 {
4277    struct tm gmt;
4278    /*
4279     * Checking for two-digit years first in an
4280     * attempt to work around GNU libc's strptime()
4281     * reporting negative year values when using %Y.
4282     */
4283    static const char time_formats[][22] = {
4284       /* Tue, 02-Jun-37 20:00:00 */
4285       "%a, %d-%b-%y %H:%M:%S",
4286       /* Tue, 02 Jun 2037 20:00:00 */
4287       "%a, %d %b %Y %H:%M:%S",
4288       /* Tue, 02-Jun-2037 20:00:00 */
4289       "%a, %d-%b-%Y %H:%M:%S",
4290       /* Tuesday, 02-Jun-2037 20:00:00 */
4291       "%A, %d-%b-%Y %H:%M:%S",
4292       /* Tuesday Jun 02 20:00:00 2037 */
4293       "%A %b %d %H:%M:%S %Y"
4294    };
4295    unsigned int i;
4296
4297    for (i = 0; i < SZ(time_formats); i++)
4298    {
4299       /*
4300        * Zero out gmt to prevent time zone offsets.
4301        * Documented to be required for GNU libc.
4302        */
4303       memset(&gmt, 0, sizeof(gmt));
4304
4305       if (NULL != strptime(header_time, time_formats[i], &gmt))
4306       {
4307          /* Sanity check for GNU libc. */
4308          if (gmt.tm_year < 0)
4309          {
4310             log_error(LOG_LEVEL_HEADER,
4311                "Failed to parse '%s' using '%s'. Moving on.",
4312                header_time, time_formats[i]);
4313             continue;
4314          }
4315          *result = timegm(&gmt);
4316
4317 #ifdef FEATURE_STRPTIME_SANITY_CHECKS
4318          /*
4319           * Verify that parsing the date recreated from the first
4320           * parse operation gets the previous result. If it doesn't,
4321           * either strptime() or strftime() are malfunctioning.
4322           *
4323           * We could string-compare the recreated date with the original
4324           * header date, but this leads to false positives as strptime()
4325           * may let %a accept all day formats while strftime() will only
4326           * create one.
4327           */
4328          {
4329             char recreated_date[100];
4330             struct tm *tm;
4331             time_t result2;
4332
4333             tm = gmtime(result);
4334             if (!strftime(recreated_date, sizeof(recreated_date),
4335                time_formats[i], tm))
4336             {
4337                log_error(LOG_LEVEL_ERROR, "Failed to recreate date '%s' with '%s'.",
4338                   header_time, time_formats[i]);
4339                continue;
4340             }
4341             memset(&gmt, 0, sizeof(gmt));
4342             if (NULL == strptime(recreated_date, time_formats[i], &gmt))
4343             {
4344                log_error(LOG_LEVEL_ERROR,
4345                   "Failed to parse '%s' generated with '%s' to recreate '%s'.",
4346                   recreated_date, time_formats[i], header_time);
4347                continue;
4348             }
4349             result2 = timegm(&gmt);
4350             if (*result != result2)
4351             {
4352                log_error(LOG_LEVEL_ERROR, "strftime() and strptime() disagree. "
4353                   "Format: '%s'. In: '%s', out: '%s'. %d != %d. Rejecting.",
4354                   time_formats[i], header_time, recreated_date, *result, result2);
4355                continue;
4356             }
4357          }
4358 #endif
4359
4360          return JB_ERR_OK;
4361       }
4362    }
4363
4364    return JB_ERR_PARSE;
4365
4366 }
4367
4368 /*********************************************************************
4369  *
4370  * Function    :  parse_time_header
4371  *
4372  * Description :  Parses the time in an HTTP time header to get
4373  *                the numerical respresentation.
4374  *
4375  * Parameters  :
4376  *          1  :  header = HTTP header with a time value
4377  *          2  :  result = storage for header_time in seconds
4378  *
4379  * Returns     :  JB_ERR_OK if the time format was recognized, or
4380  *                JB_ERR_PARSE otherwise.
4381  *
4382  *********************************************************************/
4383 static jb_err parse_time_header(const char *header, time_t *result)
4384 {
4385    const char *header_time;
4386
4387    header_time = strchr(header, ':');
4388
4389    /*
4390     * Currently this can't happen as all callers are called
4391     * through sed() which requires a header name followed by
4392     * a colon.
4393     */
4394    assert(header_time != NULL);
4395
4396    header_time++;
4397    if (*header_time == ' ')
4398    {
4399       header_time++;
4400    }
4401
4402    return parse_header_time(header_time, result);
4403
4404 }
4405
4406
4407 /*********************************************************************
4408  *
4409  * Function    :  get_destination_from_headers
4410  *
4411  * Description :  Parse the "Host:" header to get the request's destination.
4412  *                Only needed if the client's request was forcefully
4413  *                redirected into Privoxy.
4414  *
4415  *                Code mainly copied from client_host() which is currently
4416  *                run too late for this purpose.
4417  *
4418  * Parameters  :
4419  *          1  :  headers = List of headers (one of them hopefully being
4420  *                the "Host:" header)
4421  *          2  :  http = storage for the result (host, port and hostport).
4422  *
4423  * Returns     :  JB_ERR_MEMORY (or terminates) in case of memory problems,
4424  *                JB_ERR_PARSE if the host header couldn't be found,
4425  *                JB_ERR_OK otherwise.
4426  *
4427  *********************************************************************/
4428 jb_err get_destination_from_headers(const struct list *headers, struct http_request *http)
4429 {
4430    char *q;
4431    char *p;
4432    char *host;
4433
4434    assert(!http->ssl);
4435
4436    host = get_header_value(headers, "Host:");
4437
4438    if (NULL == host)
4439    {
4440       log_error(LOG_LEVEL_ERROR, "No \"Host:\" header found.");
4441       return JB_ERR_PARSE;
4442    }
4443
4444    p = strdup_or_die(host);
4445    chomp(p);
4446    q = strdup_or_die(p);
4447
4448    freez(http->hostport);
4449    http->hostport = p;
4450    freez(http->host);
4451    http->host = q;
4452    q = strchr(http->host, ':');
4453    if (q != NULL)
4454    {
4455       /* Terminate hostname and evaluate port string */
4456       *q++ = '\0';
4457       http->port = atoi(q);
4458    }
4459    else
4460    {
4461       http->port = 80;
4462    }
4463
4464    /* Rebuild request URL */
4465    freez(http->url);
4466    http->url = strdup("http://");
4467    string_append(&http->url, http->hostport);
4468    string_append(&http->url, http->path);
4469    if (http->url == NULL)
4470    {
4471       return JB_ERR_MEMORY;
4472    }
4473
4474    log_error(LOG_LEVEL_HEADER,
4475       "Destination extracted from \"Host\" header. New request URL: %s",
4476       http->url);
4477
4478    /*
4479     * Regenerate request line in "proxy format"
4480     * to make rewrites more convenient.
4481     */
4482    assert(http->cmd != NULL);
4483    freez(http->cmd);
4484    http->cmd = strdup_or_die(http->gpc);
4485    string_append(&http->cmd, " ");
4486    string_append(&http->cmd, http->url);
4487    string_append(&http->cmd, " ");
4488    string_append(&http->cmd, http->ver);
4489    if (http->cmd == NULL)
4490    {
4491       return JB_ERR_MEMORY;
4492    }
4493
4494    return JB_ERR_OK;
4495
4496 }
4497
4498
4499 /*********************************************************************
4500  *
4501  * Function    :  create_forged_referrer
4502  *
4503  * Description :  Helper for client_referrer to forge a referer as
4504  *                'http://hostname[:port]/' to fool stupid
4505  *                checks for in-site links
4506  *
4507  * Parameters  :
4508  *          1  :  header   = Pointer to header pointer
4509  *          2  :  hostport = Host and optionally port as string
4510  *
4511  * Returns     :  JB_ERR_OK in case of success, or
4512  *                JB_ERR_MEMORY in case of memory problems.
4513  *
4514  *********************************************************************/
4515 static jb_err create_forged_referrer(char **header, const char *hostport)
4516 {
4517     assert(NULL == *header);
4518
4519     *header = strdup("Referer: http://");
4520     string_append(header, hostport);
4521     string_append(header, "/");
4522
4523     if (NULL == *header)
4524     {
4525        return JB_ERR_MEMORY;
4526     }
4527
4528     log_error(LOG_LEVEL_HEADER, "Referer forged to: %s", *header);
4529
4530     return JB_ERR_OK;
4531
4532 }
4533
4534
4535 /*********************************************************************
4536  *
4537  * Function    :  create_fake_referrer
4538  *
4539  * Description :  Helper for client_referrer to create a fake referrer
4540  *                based on a string supplied by the user.
4541  *
4542  * Parameters  :
4543  *          1  :  header   = Pointer to header pointer
4544  *          2  :  hosthost = Referrer to fake
4545  *
4546  * Returns     :  JB_ERR_OK in case of success, or
4547  *                JB_ERR_MEMORY in case of memory problems.
4548  *
4549  *********************************************************************/
4550 static jb_err create_fake_referrer(char **header, const char *fake_referrer)
4551 {
4552    assert(NULL == *header);
4553
4554    if ((0 != strncmpic(fake_referrer, "http://", 7)) && (0 != strncmpic(fake_referrer, "https://", 8)))
4555    {
4556       log_error(LOG_LEVEL_HEADER,
4557          "Parameter: +hide-referrer{%s} is a bad idea, but I don't care.", fake_referrer);
4558    }
4559    *header = strdup("Referer: ");
4560    string_append(header, fake_referrer);
4561
4562    if (NULL == *header)
4563    {
4564       return JB_ERR_MEMORY;
4565    }
4566
4567    log_error(LOG_LEVEL_HEADER, "Referer replaced with: %s", *header);
4568
4569    return JB_ERR_OK;
4570
4571 }
4572
4573
4574 /*********************************************************************
4575  *
4576  * Function    :  handle_conditional_hide_referrer_parameter
4577  *
4578  * Description :  Helper for client_referrer to crunch or forge
4579  *                the referrer header if the host has changed.
4580  *
4581  * Parameters  :
4582  *          1  :  header = Pointer to header pointer
4583  *          2  :  host   = The target host (may include the port)
4584  *          3  :  parameter_conditional_block = Boolean to signal
4585  *                if we're in conditional-block mode. If not set,
4586  *                we're in conditional-forge mode.
4587  *
4588  * Returns     :  JB_ERR_OK in case of success, or
4589  *                JB_ERR_MEMORY in case of memory problems.
4590  *
4591  *********************************************************************/
4592 static jb_err handle_conditional_hide_referrer_parameter(char **header,
4593    const char *host, const int parameter_conditional_block)
4594 {
4595    char *referer = strdup_or_die(*header);
4596    const size_t hostlength = strlen(host);
4597    const char *referer_url = NULL;
4598
4599    /* referer begins with 'Referer: http[s]://' */
4600    if ((hostlength+17) < strlen(referer))
4601    {
4602       /*
4603        * Shorten referer to make sure the referer is blocked
4604        * if www.example.org/www.example.com-shall-see-the-referer/
4605        * links to www.example.com/
4606        */
4607       referer[hostlength+17] = '\0';
4608    }
4609    referer_url = strstr(referer, "http://");
4610    if ((NULL == referer_url) || (NULL == strstr(referer_url, host)))
4611    {
4612       /* Host has changed, Referer is invalid or a https URL. */
4613       if (parameter_conditional_block)
4614       {
4615          log_error(LOG_LEVEL_HEADER, "New host is: %s. Crunching %s!", host, *header);
4616          freez(*header);
4617       }
4618       else
4619       {
4620          freez(*header);
4621          freez(referer);
4622          return create_forged_referrer(header, host);
4623       }
4624    }
4625    freez(referer);
4626
4627    return JB_ERR_OK;
4628
4629 }
4630
4631
4632 /*********************************************************************
4633  *
4634  * Function    :  create_content_length_header
4635  *
4636  * Description :  Creates a Content-Length header.
4637  *
4638  * Parameters  :
4639  *          1  :  content_length = The content length to be used in the header.
4640  *          2  :  header = Allocated space to safe the header.
4641  *          3  :  buffer_length = The length of the allocated space.
4642  *
4643  * Returns     :  void
4644  *
4645  *********************************************************************/
4646 static void create_content_length_header(unsigned long long content_length,
4647                                          char *header, size_t buffer_length)
4648 {
4649    snprintf(header, buffer_length, "Content-Length: %llu", content_length);
4650 }
4651
4652
4653 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
4654 /*********************************************************************
4655  *
4656  * Function    :  get_expected_content_length
4657  *
4658  * Description :  Figures out the content length from a list of headers.
4659  *
4660  * Parameters  :
4661  *          1  :  headers = List of headers
4662  *
4663  * Returns     :  Number of bytes to expect
4664  *
4665  *********************************************************************/
4666 unsigned long long get_expected_content_length(struct list *headers)
4667 {
4668    const char *content_length_header;
4669    unsigned long long content_length = 0;
4670
4671    content_length_header = get_header_value(headers, "Content-Length:");
4672    if (content_length_header != NULL)
4673    {
4674       if (JB_ERR_OK != get_content_length(content_length_header, &content_length))
4675       {
4676          log_error(LOG_LEVEL_ERROR,
4677             "Failed to get the Content-Length in %s", content_length_header);
4678          /* XXX: The header will be removed later on */
4679          return 0;
4680       }
4681    }
4682
4683    return content_length;
4684 }
4685 #endif
4686
4687 /*
4688   Local Variables:
4689   tab-width: 3
4690   end:
4691 */