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