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