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