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