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