1 const char parsers_rcs[] = "$Id: parsers.c,v 1.207 2009/08/20 15:27:03 fabiankeil Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/parsers.c,v $
6 * Purpose : Declares functions to parse/crunch headers and pages.
7 * Functions declared include:
8 * `add_to_iob', `client_cookie_adder', `client_from',
9 * `client_referrer', `client_send_cookie', `client_ua',
10 * `client_uagent', `client_x_forwarded',
11 * `client_x_forwarded_adder', `client_xtra_adder',
12 * `content_type', `crumble', `destroy_list', `enlist',
13 * `flush_socket', ``get_header', `sed', `filter_header'
14 * `server_content_encoding', `server_content_disposition',
15 * `server_last_modified', `client_accept_language',
16 * `crunch_client_header', `client_if_modified_since',
17 * `client_if_none_match', `get_destination_from_headers',
18 * `parse_header_time', `decompress_iob' and `server_set_cookie'.
20 * Copyright : Written by and Copyright (C) 2001-2009 the
21 * Privoxy team. http://www.privoxy.org/
23 * Based on the Internet Junkbuster originally written
24 * by and Copyright (C) 1997 Anonymous Coders and
25 * Junkbusters Corporation. http://www.junkbusters.com
27 * This program is free software; you can redistribute it
28 * and/or modify it under the terms of the GNU General
29 * Public License as published by the Free Software
30 * Foundation; either version 2 of the License, or (at
31 * your option) any later version.
33 * This program is distributed in the hope that it will
34 * be useful, but WITHOUT ANY WARRANTY; without even the
35 * implied warranty of MERCHANTABILITY or FITNESS FOR A
36 * PARTICULAR PURPOSE. See the GNU General Public
37 * License for more details.
39 * The GNU General Public License should be included with
40 * this file. If not, you can view it at
41 * http://www.gnu.org/copyleft/gpl.html
42 * or write to the Free Software Foundation, Inc., 59
43 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
45 *********************************************************************/
52 #include <sys/types.h>
62 * Convince GNU's libc to provide a strptime prototype.
71 #define GZIP_IDENTIFIER_1 0x1f
72 #define GZIP_IDENTIFIER_2 0x8b
74 #define GZIP_FLAG_CHECKSUM 0x02
75 #define GZIP_FLAG_EXTRA_FIELDS 0x04
76 #define GZIP_FLAG_FILE_NAME 0x08
77 #define GZIP_FLAG_COMMENT 0x10
78 #define GZIP_FLAG_RESERVED_BITS 0xe0
81 #if !defined(_WIN32) && !defined(__OS2__)
87 #ifdef FEATURE_PTHREAD
89 /* jcc.h is for mutex semapores only */
90 #endif /* def FEATURE_PTHREAD */
95 #include "jbsockets.h"
101 #ifndef HAVE_STRPTIME
102 #include "strptime.h"
105 const char parsers_h_rcs[] = PARSERS_H_VERSION;
107 /* Fix a problem with Solaris. There should be no effect on other
109 * Solaris's isspace() is a macro which uses its argument directly
110 * as an array index. Therefore we need to make sure that high-bit
111 * characters generate +ve values, and ideally we also want to make
112 * the argument match the declared parameter type of "int".
114 * Why did they write a character function that can't take a simple
115 * "char" argument? Doh!
117 #define ijb_isupper(__X) isupper((int)(unsigned char)(__X))
118 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
120 static char *get_header_line(struct iob *iob);
121 static jb_err scan_headers(struct client_state *csp);
122 static jb_err header_tagger(struct client_state *csp, char *header);
123 static jb_err parse_header_time(const char *header_time, time_t *result);
125 static jb_err crumble (struct client_state *csp, char **header);
126 static jb_err filter_header (struct client_state *csp, char **header);
127 static jb_err client_connection (struct client_state *csp, char **header);
128 static jb_err client_referrer (struct client_state *csp, char **header);
129 static jb_err client_uagent (struct client_state *csp, char **header);
130 static jb_err client_ua (struct client_state *csp, char **header);
131 static jb_err client_from (struct client_state *csp, char **header);
132 static jb_err client_send_cookie (struct client_state *csp, char **header);
133 static jb_err client_x_forwarded (struct client_state *csp, char **header);
134 static jb_err client_accept_encoding (struct client_state *csp, char **header);
135 static jb_err client_te (struct client_state *csp, char **header);
136 static jb_err client_max_forwards (struct client_state *csp, char **header);
137 static jb_err client_host (struct client_state *csp, char **header);
138 static jb_err client_if_modified_since (struct client_state *csp, char **header);
139 static jb_err client_accept_language (struct client_state *csp, char **header);
140 static jb_err client_if_none_match (struct client_state *csp, char **header);
141 static jb_err crunch_client_header (struct client_state *csp, char **header);
142 static jb_err client_x_filter (struct client_state *csp, char **header);
143 static jb_err client_range (struct client_state *csp, char **header);
144 static jb_err server_set_cookie (struct client_state *csp, char **header);
145 static jb_err server_connection (struct client_state *csp, char **header);
146 static jb_err server_content_type (struct client_state *csp, char **header);
147 static jb_err server_adjust_content_length(struct client_state *csp, char **header);
148 static jb_err server_content_md5 (struct client_state *csp, char **header);
149 static jb_err server_content_encoding (struct client_state *csp, char **header);
150 static jb_err server_transfer_coding (struct client_state *csp, char **header);
151 static jb_err server_http (struct client_state *csp, char **header);
152 static jb_err crunch_server_header (struct client_state *csp, char **header);
153 static jb_err server_last_modified (struct client_state *csp, char **header);
154 static jb_err server_content_disposition(struct client_state *csp, char **header);
156 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
157 static jb_err server_save_content_length(struct client_state *csp, char **header);
158 static jb_err server_keep_alive(struct client_state *csp, char **header);
159 static jb_err server_proxy_connection(struct client_state *csp, char **header);
160 static jb_err client_keep_alive(struct client_state *csp, char **header);
161 static jb_err client_save_content_length(struct client_state *csp, char **header);
162 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
164 static jb_err client_host_adder (struct client_state *csp);
165 static jb_err client_xtra_adder (struct client_state *csp);
166 static jb_err client_x_forwarded_for_adder(struct client_state *csp);
167 static jb_err client_connection_header_adder(struct client_state *csp);
168 static jb_err server_connection_adder(struct client_state *csp);
169 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
170 static jb_err server_proxy_connection_adder(struct client_state *csp);
171 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
173 static jb_err create_forged_referrer(char **header, const char *hostport);
174 static jb_err create_fake_referrer(char **header, const char *fake_referrer);
175 static jb_err handle_conditional_hide_referrer_parameter(char **header,
176 const char *host, const int parameter_conditional_block);
177 static void create_content_length_header(unsigned long long content_length,
178 char *header, size_t buffer_length);
181 * List of functions to run on a list of headers.
185 /** The header prefix to match */
188 /** The length of the prefix to match */
191 /** The function to apply to this line */
192 const parser_func_ptr parser;
195 static const struct parsers client_patterns[] = {
196 { "referer:", 8, client_referrer },
197 { "user-agent:", 11, client_uagent },
198 { "ua-", 3, client_ua },
199 { "from:", 5, client_from },
200 { "cookie:", 7, client_send_cookie },
201 { "x-forwarded-for:", 16, client_x_forwarded },
202 { "Accept-Encoding:", 16, client_accept_encoding },
203 { "TE:", 3, client_te },
204 { "Host:", 5, client_host },
205 { "if-modified-since:", 18, client_if_modified_since },
206 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
207 { "Keep-Alive:", 11, client_keep_alive },
208 { "Content-Length:", 15, client_save_content_length },
210 { "Keep-Alive:", 11, crumble },
212 { "connection:", 11, client_connection },
213 { "proxy-connection:", 17, crumble },
214 { "max-forwards:", 13, client_max_forwards },
215 { "Accept-Language:", 16, client_accept_language },
216 { "if-none-match:", 14, client_if_none_match },
217 { "Range:", 6, client_range },
218 { "Request-Range:", 14, client_range },
219 { "If-Range:", 9, client_range },
220 { "X-Filter:", 9, client_x_filter },
221 { "*", 0, crunch_client_header },
222 { "*", 0, filter_header },
226 static const struct parsers server_patterns[] = {
227 { "HTTP/", 5, server_http },
228 { "set-cookie:", 11, server_set_cookie },
229 { "connection:", 11, server_connection },
230 { "Content-Type:", 13, server_content_type },
231 { "Content-MD5:", 12, server_content_md5 },
232 { "Content-Encoding:", 17, server_content_encoding },
233 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
234 { "Content-Length:", 15, server_save_content_length },
235 { "Keep-Alive:", 11, server_keep_alive },
236 { "Proxy-Connection:", 17, server_proxy_connection },
238 { "Keep-Alive:", 11, crumble },
239 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
240 { "Transfer-Encoding:", 18, server_transfer_coding },
241 { "content-disposition:", 20, server_content_disposition },
242 { "Last-Modified:", 14, server_last_modified },
243 { "*", 0, crunch_server_header },
244 { "*", 0, filter_header },
248 static const add_header_func_ptr add_client_headers[] = {
250 client_x_forwarded_for_adder,
252 /* Temporarily disabled: client_accept_encoding_adder, */
253 client_connection_header_adder,
257 static const add_header_func_ptr add_server_headers[] = {
258 server_connection_adder,
259 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
260 server_proxy_connection_adder,
261 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
265 /*********************************************************************
267 * Function : flush_socket
269 * Description : Write any pending "buffered" content.
272 * 1 : fd = file descriptor of the socket to read
273 * 2 : iob = The I/O buffer to flush, usually csp->iob.
275 * Returns : On success, the number of bytes written are returned (zero
276 * indicates nothing was written). On error, -1 is returned,
277 * and errno is set appropriately. If count is zero and the
278 * file descriptor refers to a regular file, 0 will be
279 * returned without causing any other effect. For a special
280 * file, the results are not portable.
282 *********************************************************************/
283 long flush_socket(jb_socket fd, struct iob *iob)
285 long len = iob->eod - iob->cur;
292 if (write_socket(fd, iob->cur, (size_t)len))
296 iob->eod = iob->cur = iob->buf;
302 /*********************************************************************
304 * Function : add_to_iob
306 * Description : Add content to the buffered page, expanding the
307 * buffer if necessary.
310 * 1 : csp = Current client state (buffers, headers, etc...)
311 * 2 : buf = holds the content to be added to the page
312 * 3 : n = number of bytes to be added
314 * Returns : JB_ERR_OK on success, JB_ERR_MEMORY if out-of-memory
315 * or buffer limit reached.
317 *********************************************************************/
318 jb_err add_to_iob(struct client_state *csp, char *buf, long n)
320 struct iob *iob = csp->iob;
321 size_t used, offset, need, want;
324 if (n <= 0) return JB_ERR_OK;
326 used = (size_t)(iob->eod - iob->buf);
327 offset = (size_t)(iob->cur - iob->buf);
328 need = used + (size_t)n + 1;
331 * If the buffer can't hold the new data, extend it first.
332 * Use the next power of two if possible, else use the actual need.
334 if (need > csp->config->buffer_limit)
336 log_error(LOG_LEVEL_INFO,
337 "Buffer limit reached while extending the buffer (iob). Needed: %d. Limit: %d",
338 need, csp->config->buffer_limit);
339 return JB_ERR_MEMORY;
342 if (need > iob->size)
344 for (want = csp->iob->size ? csp->iob->size : 512; want <= need;) want *= 2;
346 if (want <= csp->config->buffer_limit && NULL != (p = (char *)realloc(iob->buf, want)))
350 else if (NULL != (p = (char *)realloc(iob->buf, need)))
356 log_error(LOG_LEVEL_ERROR, "Extending the buffer (iob) failed: %E");
357 return JB_ERR_MEMORY;
360 /* Update the iob pointers */
361 iob->cur = p + offset;
366 /* copy the new data into the iob buffer */
367 memcpy(iob->eod, buf, (size_t)n);
369 /* point to the end of the data */
372 /* null terminate == cheap insurance */
381 /*********************************************************************
383 * Function : decompress_iob
385 * Description : Decompress buffered page, expanding the
386 * buffer as necessary. csp->iob->cur
387 * should point to the the beginning of the
388 * compressed data block.
391 * 1 : csp = Current client state (buffers, headers, etc...)
393 * Returns : JB_ERR_OK on success,
394 * JB_ERR_MEMORY if out-of-memory limit reached, and
395 * JB_ERR_COMPRESS if error decompressing buffer.
397 *********************************************************************/
398 jb_err decompress_iob(struct client_state *csp)
400 char *buf; /* new, uncompressed buffer */
401 char *cur; /* Current iob position (to keep the original
402 * iob->cur unmodified if we return early) */
403 size_t bufsize; /* allocated size of the new buffer */
404 size_t old_size; /* Content size before decompression */
405 size_t skip_size; /* Number of bytes at the beginning of the iob
406 that we should NOT decompress. */
407 int status; /* return status of the inflate() call */
408 z_stream zstr; /* used by calls to zlib */
410 assert(csp->iob->cur - csp->iob->buf > 0);
411 assert(csp->iob->eod - csp->iob->cur > 0);
413 bufsize = csp->iob->size;
414 skip_size = (size_t)(csp->iob->cur - csp->iob->buf);
415 old_size = (size_t)(csp->iob->eod - csp->iob->cur);
419 if (bufsize < (size_t)10)
422 * This is to protect the parsing of gzipped data,
423 * but it should(?) be valid for deflated data also.
425 log_error(LOG_LEVEL_ERROR, "Buffer too small decompressing iob");
426 return JB_ERR_COMPRESS;
429 if (csp->content_type & CT_GZIP)
432 * Our task is slightly complicated by the facts that data
433 * compressed by gzip does not include a zlib header, and
434 * that there is no easily accessible interface in zlib to
435 * handle a gzip header. We strip off the gzip header by
436 * hand, and later inform zlib not to expect a header.
440 * Strip off the gzip header. Please see RFC 1952 for more
441 * explanation of the appropriate fields.
443 if (((*cur++ & 0xff) != GZIP_IDENTIFIER_1)
444 || ((*cur++ & 0xff) != GZIP_IDENTIFIER_2)
445 || (*cur++ != Z_DEFLATED))
447 log_error(LOG_LEVEL_ERROR, "Invalid gzip header when decompressing");
448 return JB_ERR_COMPRESS;
453 if (flags & GZIP_FLAG_RESERVED_BITS)
455 /* The gzip header has reserved bits set; bail out. */
456 log_error(LOG_LEVEL_ERROR, "Invalid gzip header flags when decompressing");
457 return JB_ERR_COMPRESS;
461 * Skip mtime (4 bytes), extra flags (1 byte)
462 * and OS type (1 byte).
466 /* Skip extra fields if necessary. */
467 if (flags & GZIP_FLAG_EXTRA_FIELDS)
470 * Skip a given number of bytes, specified
471 * as a 16-bit little-endian value.
473 * XXX: this code is untested and should probably be removed.
477 skip_bytes += *cur++ << 8;
480 * The number of bytes to skip should be positive
481 * and we'd like to stay in the buffer.
483 if ((skip_bytes < 0) || (skip_bytes >= (csp->iob->eod - cur)))
485 log_error(LOG_LEVEL_ERROR,
486 "Unreasonable amount of bytes to skip (%d). Stopping decompression",
488 return JB_ERR_COMPRESS;
490 log_error(LOG_LEVEL_INFO,
491 "Skipping %d bytes for gzip compression. Does this sound right?",
496 /* Skip the filename if necessary. */
497 if (flags & GZIP_FLAG_FILE_NAME)
499 /* A null-terminated string is supposed to follow. */
500 while (*cur++ && (cur < csp->iob->eod));
503 /* Skip the comment if necessary. */
504 if (flags & GZIP_FLAG_COMMENT)
506 /* A null-terminated string is supposed to follow. */
507 while (*cur++ && (cur < csp->iob->eod));
510 /* Skip the CRC if necessary. */
511 if (flags & GZIP_FLAG_CHECKSUM)
516 if (cur >= csp->iob->eod)
519 * If the current position pointer reached or passed
520 * the buffer end, we were obviously tricked to skip
523 log_error(LOG_LEVEL_ERROR,
524 "Malformed gzip header detected. Aborting decompression.");
525 return JB_ERR_COMPRESS;
529 else if (csp->content_type & CT_DEFLATE)
532 * XXX: The debug level should be lowered
533 * before the next stable release.
535 log_error(LOG_LEVEL_INFO, "Decompressing deflated iob: %d", *cur);
537 * In theory (that is, according to RFC 1950), deflate-compressed
538 * data should begin with a two-byte zlib header and have an
539 * adler32 checksum at the end. It seems that in practice only
540 * the raw compressed data is sent. Note that this means that
541 * we are not RFC 1950-compliant here, but the advantage is that
542 * this actually works. :)
544 * We add a dummy null byte to tell zlib where the data ends,
545 * and later inform it not to expect a header.
547 * Fortunately, add_to_iob() has thoughtfully null-terminated
548 * the buffer; we can just increment the end pointer to include
555 log_error(LOG_LEVEL_ERROR,
556 "Unable to determine compression format for decompression");
557 return JB_ERR_COMPRESS;
560 /* Set up the fields required by zlib. */
561 zstr.next_in = (Bytef *)cur;
562 zstr.avail_in = (unsigned int)(csp->iob->eod - cur);
563 zstr.zalloc = Z_NULL;
565 zstr.opaque = Z_NULL;
568 * Passing -MAX_WBITS to inflateInit2 tells the library
569 * that there is no zlib header.
571 if (inflateInit2(&zstr, -MAX_WBITS) != Z_OK)
573 log_error(LOG_LEVEL_ERROR, "Error initializing decompression");
574 return JB_ERR_COMPRESS;
578 * Next, we allocate new storage for the inflated data.
579 * We don't modify the existing iob yet, so in case there
580 * is error in decompression we can recover gracefully.
582 buf = zalloc(bufsize);
585 log_error(LOG_LEVEL_ERROR, "Out of memory decompressing iob");
586 return JB_ERR_MEMORY;
589 assert(bufsize >= skip_size);
590 memcpy(buf, csp->iob->buf, skip_size);
591 zstr.avail_out = (uInt)(bufsize - skip_size);
592 zstr.next_out = (Bytef *)buf + skip_size;
594 /* Try to decompress the whole stream in one shot. */
595 while (Z_BUF_ERROR == (status = inflate(&zstr, Z_FINISH)))
597 /* We need to allocate more memory for the output buffer. */
599 char *tmpbuf; /* used for realloc'ing the buffer */
600 size_t oldbufsize = bufsize; /* keep track of the old bufsize */
602 if (0 == zstr.avail_in)
605 * If zlib wants more data then there's a problem, because
606 * the complete compressed file should have been buffered.
608 log_error(LOG_LEVEL_ERROR,
609 "Unexpected end of compressed iob. Using what we got so far.");
614 * If we tried the limit and still didn't have enough
615 * memory, just give up.
617 if (bufsize == csp->config->buffer_limit)
619 log_error(LOG_LEVEL_ERROR, "Buffer limit reached while decompressing iob");
620 return JB_ERR_MEMORY;
623 /* Try doubling the buffer size each time. */
626 /* Don't exceed the buffer limit. */
627 if (bufsize > csp->config->buffer_limit)
629 bufsize = csp->config->buffer_limit;
632 /* Try to allocate the new buffer. */
633 tmpbuf = realloc(buf, bufsize);
636 log_error(LOG_LEVEL_ERROR, "Out of memory decompressing iob");
638 return JB_ERR_MEMORY;
642 char *oldnext_out = (char *)zstr.next_out;
645 * Update the fields for inflate() to use the new
646 * buffer, which may be in a location different from
649 zstr.avail_out += (uInt)(bufsize - oldbufsize);
650 zstr.next_out = (Bytef *)tmpbuf + bufsize - zstr.avail_out;
653 * Compare with an uglier method of calculating these values
654 * that doesn't require the extra oldbufsize variable.
656 assert(zstr.avail_out == tmpbuf + bufsize - (char *)zstr.next_out);
657 assert((char *)zstr.next_out == tmpbuf + ((char *)oldnext_out - buf));
663 if (Z_STREAM_ERROR == inflateEnd(&zstr))
665 log_error(LOG_LEVEL_ERROR,
666 "Inconsistent stream state after decompression: %s", zstr.msg);
668 * XXX: Intentionally no return.
670 * According to zlib.h, Z_STREAM_ERROR is returned
671 * "if the stream state was inconsistent".
673 * I assume in this case inflate()'s status
674 * would also be something different than Z_STREAM_END
675 * so this check should be redundant, but lets see.
679 if ((status != Z_STREAM_END) && (0 != zstr.avail_in))
682 * We failed to decompress the stream and it's
683 * not simply because of missing data.
685 log_error(LOG_LEVEL_ERROR,
686 "Unexpected error while decompressing to the buffer (iob): %s",
688 return JB_ERR_COMPRESS;
692 * Finally, we can actually update the iob, since the
693 * decompression was successful. First, free the old
696 freez(csp->iob->buf);
698 /* Now, update the iob to use the new buffer. */
700 csp->iob->cur = csp->iob->buf + skip_size;
701 csp->iob->eod = (char *)zstr.next_out;
702 csp->iob->size = bufsize;
705 * Make sure the new uncompressed iob obeys some minimal
706 * consistency conditions.
708 if ((csp->iob->buf < csp->iob->cur)
709 && (csp->iob->cur <= csp->iob->eod)
710 && (csp->iob->eod <= csp->iob->buf + csp->iob->size))
712 const size_t new_size = (size_t)(csp->iob->eod - csp->iob->cur);
713 if (new_size > (size_t)0)
715 log_error(LOG_LEVEL_RE_FILTER,
716 "Decompression successful. Old size: %d, new size: %d.",
721 /* zlib thinks this is OK, so lets do the same. */
722 log_error(LOG_LEVEL_INFO, "Decompression didn't result in any content.");
727 /* It seems that zlib did something weird. */
728 log_error(LOG_LEVEL_ERROR,
729 "Unexpected error decompressing the buffer (iob): %d==%d, %d>%d, %d<%d",
730 csp->iob->cur, csp->iob->buf + skip_size, csp->iob->eod, csp->iob->buf,
731 csp->iob->eod, csp->iob->buf + csp->iob->size);
732 return JB_ERR_COMPRESS;
738 #endif /* defined(FEATURE_ZLIB) */
741 /*********************************************************************
743 * Function : string_move
745 * Description : memmove wrapper to move the last part of a string
746 * towards the beginning, overwriting the part in
747 * the middle. strlcpy() can't be used here as the
751 * 1 : dst = Destination to overwrite
752 * 2 : src = Source to move.
756 *********************************************************************/
757 static void string_move(char *dst, char *src)
761 /* +1 to copy the terminating nul as well. */
762 memmove(dst, src, strlen(src)+1);
766 /*********************************************************************
768 * Function : normalize_lws
770 * Description : Reduces unquoted linear white space in headers
771 * to a single space in accordance with RFC 2616 2.2.
772 * This simplifies parsing and filtering later on.
774 * XXX: Remove log messages before
775 * the next stable release?
778 * 1 : header = A header with linear white space to reduce.
782 *********************************************************************/
783 static void normalize_lws(char *header)
789 if (ijb_isspace(*p) && ijb_isspace(*(p+1)))
793 while (ijb_isspace(*q))
797 log_error(LOG_LEVEL_HEADER, "Reducing white space in '%s'", header);
803 log_error(LOG_LEVEL_HEADER,
804 "Converting tab to space in '%s'", header);
809 char *end_of_token = strstr(p+1, "\"");
811 if (NULL != end_of_token)
813 /* Don't mess with quoted text. */
818 log_error(LOG_LEVEL_HEADER,
819 "Ignoring single quote in '%s'", header);
825 p = strchr(header, ':');
826 if ((p != NULL) && (p != header) && ijb_isspace(*(p-1)))
829 * There's still space before the colon.
837 /*********************************************************************
839 * Function : get_header
841 * Description : This (odd) routine will parse the csp->iob
842 * to get the next complete header.
845 * 1 : iob = The I/O buffer to parse, usually csp->iob.
847 * Returns : Any one of the following:
849 * 1) a pointer to a dynamically allocated string that contains a header line
850 * 2) NULL indicating that the end of the header was reached
851 * 3) "" indicating that the end of the iob was reached before finding
852 * a complete header line.
854 *********************************************************************/
855 char *get_header(struct iob *iob)
859 header = get_header_line(iob);
861 if ((header == NULL) || (*header == '\0'))
864 * No complete header read yet, tell the client.
869 while ((iob->cur[0] == ' ') || (iob->cur[0] == '\t'))
872 * Header spans multiple lines, append the next one.
874 char *continued_header;
876 continued_header = get_header_line(iob);
877 if ((continued_header == NULL) || (*continued_header == '\0'))
880 * No complete header read yet, return what we got.
881 * XXX: Should "unread" header instead.
883 log_error(LOG_LEVEL_INFO,
884 "Failed to read a multi-line header properly: '%s'",
889 if (JB_ERR_OK != string_join(&header, continued_header))
891 log_error(LOG_LEVEL_FATAL,
892 "Out of memory while appending multiple headers.");
896 /* XXX: remove before next stable release. */
897 log_error(LOG_LEVEL_HEADER,
898 "Merged multiple header lines to: '%s'",
903 normalize_lws(header);
910 /*********************************************************************
912 * Function : get_header_line
914 * Description : This (odd) routine will parse the csp->iob
915 * to get the next header line.
918 * 1 : iob = The I/O buffer to parse, usually csp->iob.
920 * Returns : Any one of the following:
922 * 1) a pointer to a dynamically allocated string that contains a header line
923 * 2) NULL indicating that the end of the header was reached
924 * 3) "" indicating that the end of the iob was reached before finding
925 * a complete header line.
927 *********************************************************************/
928 static char *get_header_line(struct iob *iob)
932 if ((iob->cur == NULL)
933 || ((p = strchr(iob->cur, '\n')) == NULL))
935 return(""); /* couldn't find a complete header */
940 ret = strdup(iob->cur);
943 /* FIXME No way to handle error properly */
944 log_error(LOG_LEVEL_FATAL, "Out of memory in get_header_line()");
950 if ((q = strchr(ret, '\r')) != NULL) *q = '\0';
952 /* is this a blank line (i.e. the end of the header) ? */
964 /*********************************************************************
966 * Function : get_header_value
968 * Description : Get the value of a given header from a chained list
969 * of header lines or return NULL if no such header is
970 * present in the list.
973 * 1 : header_list = pointer to list
974 * 2 : header_name = string with name of header to look for.
975 * Trailing colon required, capitalization
978 * Returns : NULL if not found, else value of header
980 *********************************************************************/
981 char *get_header_value(const struct list *header_list, const char *header_name)
983 struct list_entry *cur_entry;
989 length = strlen(header_name);
991 for (cur_entry = header_list->first; cur_entry ; cur_entry = cur_entry->next)
995 if (!strncmpic(cur_entry->str, header_name, length))
998 * Found: return pointer to start of value
1000 ret = cur_entry->str + length;
1001 while (*ret && ijb_isspace(*ret)) ret++;
1015 /*********************************************************************
1017 * Function : scan_headers
1019 * Description : Scans headers, applies tags and updates action bits.
1022 * 1 : csp = Current client state (buffers, headers, etc...)
1024 * Returns : JB_ERR_OK
1026 *********************************************************************/
1027 static jb_err scan_headers(struct client_state *csp)
1029 struct list_entry *h; /* Header */
1030 jb_err err = JB_ERR_OK;
1032 for (h = csp->headers->first; (err == JB_ERR_OK) && (h != NULL) ; h = h->next)
1034 /* Header crunch()ed in previous run? -> ignore */
1035 if (h->str == NULL) continue;
1036 log_error(LOG_LEVEL_HEADER, "scan: %s", h->str);
1037 err = header_tagger(csp, h->str);
1044 /*********************************************************************
1048 * Description : add, delete or modify lines in the HTTP header streams.
1049 * On entry, it receives a linked list of headers space
1050 * that was allocated dynamically (both the list nodes
1051 * and the header contents).
1053 * As a side effect it frees the space used by the original
1057 * 1 : csp = Current client state (buffers, headers, etc...)
1058 * 2 : filter_server_headers = Boolean to switch between
1059 * server and header filtering.
1061 * Returns : JB_ERR_OK in case off success, or
1062 * JB_ERR_MEMORY on out-of-memory error.
1064 *********************************************************************/
1065 jb_err sed(struct client_state *csp, int filter_server_headers)
1067 /* XXX: use more descriptive names. */
1068 struct list_entry *p;
1069 const struct parsers *v;
1070 const add_header_func_ptr *f;
1071 jb_err err = JB_ERR_OK;
1073 if (filter_server_headers)
1075 v = server_patterns;
1076 f = add_server_headers;
1080 v = client_patterns;
1081 f = add_client_headers;
1086 while ((err == JB_ERR_OK) && (v->str != NULL))
1088 for (p = csp->headers->first; (err == JB_ERR_OK) && (p != NULL); p = p->next)
1090 /* Header crunch()ed in previous run? -> ignore */
1091 if (p->str == NULL) continue;
1093 /* Does the current parser handle this header? */
1094 if ((strncmpic(p->str, v->str, v->len) == 0) ||
1095 (v->len == CHECK_EVERY_HEADER_REMAINING))
1097 err = v->parser(csp, &(p->str));
1103 /* place additional headers on the csp->headers list */
1104 while ((err == JB_ERR_OK) && (*f))
1114 /*********************************************************************
1116 * Function : update_server_headers
1118 * Description : Updates server headers after the body has been modified.
1121 * 1 : csp = Current client state (buffers, headers, etc...)
1123 * Returns : JB_ERR_OK in case off success, or
1124 * JB_ERR_MEMORY on out-of-memory error.
1126 *********************************************************************/
1127 jb_err update_server_headers(struct client_state *csp)
1129 jb_err err = JB_ERR_OK;
1131 static const struct parsers server_patterns_light[] = {
1132 { "Content-Length:", 15, server_adjust_content_length },
1133 { "Transfer-Encoding:", 18, server_transfer_coding },
1135 { "Content-Encoding:", 17, server_content_encoding },
1136 #endif /* def FEATURE_ZLIB */
1140 if (strncmpic(csp->http->cmd, "HEAD", 4))
1142 const struct parsers *v;
1143 struct list_entry *p;
1145 for (v = server_patterns_light; (err == JB_ERR_OK) && (v->str != NULL); v++)
1147 for (p = csp->headers->first; (err == JB_ERR_OK) && (p != NULL); p = p->next)
1149 /* Header crunch()ed in previous run? -> ignore */
1150 if (p->str == NULL) continue;
1152 /* Does the current parser handle this header? */
1153 if (strncmpic(p->str, v->str, v->len) == 0)
1155 err = v->parser(csp, (char **)&(p->str));
1161 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1162 if ((JB_ERR_OK == err)
1163 && (csp->flags & CSP_FLAG_MODIFIED)
1164 && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
1165 && !(csp->flags & CSP_FLAG_SERVER_CONTENT_LENGTH_SET))
1169 create_content_length_header(csp->content_length, header, sizeof(header));
1170 err = enlist(csp->headers, header);
1171 if (JB_ERR_OK == err)
1173 log_error(LOG_LEVEL_HEADER,
1174 "Content modified with no Content-Length header set. "
1175 "Created: %s.", header);
1178 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1184 /*********************************************************************
1186 * Function : header_tagger
1188 * Description : Executes all text substitutions from applying
1189 * tag actions and saves the result as tag.
1191 * XXX: Shares enough code with filter_header() and
1192 * pcrs_filter_response() to warrant some helper functions.
1195 * 1 : csp = Current client state (buffers, headers, etc...)
1196 * 2 : header = Header that is used as tagger input
1198 * Returns : JB_ERR_OK on success and always succeeds
1200 *********************************************************************/
1201 static jb_err header_tagger(struct client_state *csp, char *header)
1203 int wanted_filter_type;
1204 int multi_action_index;
1208 struct file_list *fl;
1209 struct re_filterfile_spec *b;
1210 struct list_entry *tag_name;
1212 int found_filters = 0;
1213 const size_t header_length = strlen(header);
1215 if (csp->flags & CSP_FLAG_CLIENT_HEADER_PARSING_DONE)
1217 wanted_filter_type = FT_SERVER_HEADER_TAGGER;
1218 multi_action_index = ACTION_MULTI_SERVER_HEADER_TAGGER;
1222 wanted_filter_type = FT_CLIENT_HEADER_TAGGER;
1223 multi_action_index = ACTION_MULTI_CLIENT_HEADER_TAGGER;
1226 /* Check if there are any filters */
1227 for (i = 0; i < MAX_AF_FILES; i++)
1240 if (0 == found_filters)
1242 log_error(LOG_LEVEL_ERROR, "Inconsistent configuration: "
1243 "tagging enabled, but no taggers available.");
1247 for (i = 0; i < MAX_AF_FILES; i++)
1250 if ((NULL == fl) || (NULL == fl->f))
1253 * Either there are no filter files
1254 * left, or this filter file just
1255 * contains no valid filters.
1257 * Continue to be sure we don't miss
1258 * valid filter files that are chained
1259 * after empty or invalid ones.
1264 /* For all filters, */
1265 for (b = fl->f; b; b = b->next)
1267 if (b->type != wanted_filter_type)
1269 /* skip the ones we don't care about, */
1272 /* leaving only taggers that could apply, of which we use the ones, */
1273 for (tag_name = csp->action->multi[multi_action_index]->first;
1274 NULL != tag_name; tag_name = tag_name->next)
1276 /* that do apply, and */
1277 if (strcmp(b->name, tag_name->str) == 0)
1279 char *modified_tag = NULL;
1281 size_t size = header_length;
1282 pcrs_job *joblist = b->joblist;
1284 if (b->dynamic) joblist = compile_dynamic_pcrs_job_list(csp, b);
1286 if (NULL == joblist)
1288 log_error(LOG_LEVEL_RE_FILTER,
1289 "Tagger %s has empty joblist. Nothing to do.", b->name);
1293 /* execute their pcrs_joblist on the header. */
1294 for (job = joblist; NULL != job; job = job->next)
1296 const int hits = pcrs_execute(job, tag, size, &modified_tag, &size);
1300 /* Success, continue with the modified version. */
1309 /* Tagger doesn't match */
1312 /* Regex failure, log it but continue anyway. */
1313 assert(NULL != header);
1314 log_error(LOG_LEVEL_ERROR,
1315 "Problems with tagger \'%s\' and header \'%s\': %s",
1316 b->name, *header, pcrs_strerror(hits));
1318 freez(modified_tag);
1322 if (b->dynamic) pcrs_free_joblist(joblist);
1324 /* If this tagger matched */
1330 * There is to technical limitation which makes
1331 * it impossible to use empty tags, but I assume
1332 * no one would do it intentionally.
1335 log_error(LOG_LEVEL_INFO,
1336 "Tagger \'%s\' created an empty tag. Ignored.",
1341 if (!list_contains_item(csp->tags, tag))
1343 if (JB_ERR_OK != enlist(csp->tags, tag))
1345 log_error(LOG_LEVEL_ERROR,
1346 "Insufficient memory to add tag \'%s\', "
1347 "based on tagger \'%s\' and header \'%s\'",
1348 tag, b->name, *header);
1352 char *action_message;
1354 * update the action bits right away, to make
1355 * tagging based on tags set by earlier taggers
1356 * of the same kind possible.
1358 if (update_action_bits_for_tag(csp, tag))
1360 action_message = "Action bits updated accordingly.";
1364 action_message = "No action bits update necessary.";
1367 log_error(LOG_LEVEL_HEADER,
1368 "Tagger \'%s\' added tag \'%s\'. %s",
1369 b->name, tag, action_message);
1374 /* XXX: Is this log-worthy? */
1375 log_error(LOG_LEVEL_HEADER,
1376 "Tagger \'%s\' didn't add tag \'%s\'. "
1377 "Tag already present", b->name, tag);
1380 } /* if the tagger matched */
1381 } /* if the tagger applies */
1382 } /* for every tagger that could apply */
1383 } /* for all filters */
1384 } /* for all filter files */
1389 /* here begins the family of parser functions that reformat header lines */
1391 /*********************************************************************
1393 * Function : filter_header
1395 * Description : Executes all text substitutions from all applying
1396 * +(server|client)-header-filter actions on the header.
1397 * Most of the code was copied from pcrs_filter_response,
1398 * including the rather short variable names
1401 * 1 : csp = Current client state (buffers, headers, etc...)
1402 * 2 : header = On input, pointer to header to modify.
1403 * On output, pointer to the modified header, or NULL
1404 * to remove the header. This function frees the
1405 * original string if necessary.
1407 * Returns : JB_ERR_OK on success and always succeeds
1409 *********************************************************************/
1410 static jb_err filter_header(struct client_state *csp, char **header)
1414 size_t size = strlen(*header);
1416 char *newheader = NULL;
1419 struct file_list *fl;
1420 struct re_filterfile_spec *b;
1421 struct list_entry *filtername;
1423 int i, found_filters = 0;
1424 int wanted_filter_type;
1425 int multi_action_index;
1427 if (csp->flags & CSP_FLAG_NO_FILTERING)
1432 if (csp->flags & CSP_FLAG_CLIENT_HEADER_PARSING_DONE)
1434 wanted_filter_type = FT_SERVER_HEADER_FILTER;
1435 multi_action_index = ACTION_MULTI_SERVER_HEADER_FILTER;
1439 wanted_filter_type = FT_CLIENT_HEADER_FILTER;
1440 multi_action_index = ACTION_MULTI_CLIENT_HEADER_FILTER;
1444 * Need to check the set of re_filterfiles...
1446 for (i = 0; i < MAX_AF_FILES; i++)
1459 if (0 == found_filters)
1461 log_error(LOG_LEVEL_ERROR, "Inconsistent configuration: "
1462 "header filtering enabled, but no matching filters available.");
1466 for (i = 0; i < MAX_AF_FILES; i++)
1469 if ((NULL == fl) || (NULL == fl->f))
1472 * Either there are no filter files
1473 * left, or this filter file just
1474 * contains no valid filters.
1476 * Continue to be sure we don't miss
1477 * valid filter files that are chained
1478 * after empty or invalid ones.
1483 * For all applying +filter actions, look if a filter by that
1484 * name exists and if yes, execute its pcrs_joblist on the
1487 for (b = fl->f; b; b = b->next)
1489 if (b->type != wanted_filter_type)
1491 /* Skip other filter types */
1495 for (filtername = csp->action->multi[multi_action_index]->first;
1496 filtername ; filtername = filtername->next)
1498 if (strcmp(b->name, filtername->str) == 0)
1500 int current_hits = 0;
1501 pcrs_job *joblist = b->joblist;
1503 if (b->dynamic) joblist = compile_dynamic_pcrs_job_list(csp, b);
1505 if (NULL == joblist)
1507 log_error(LOG_LEVEL_RE_FILTER, "Filter %s has empty joblist. Nothing to do.", b->name);
1511 log_error(LOG_LEVEL_RE_FILTER, "filtering \'%s\' (size %d) with \'%s\' ...",
1512 *header, size, b->name);
1514 /* Apply all jobs from the joblist */
1515 for (job = joblist; NULL != job; job = job->next)
1517 matches = pcrs_execute(job, *header, size, &newheader, &size);
1520 current_hits += matches;
1521 log_error(LOG_LEVEL_HEADER, "Transforming \"%s\" to \"%s\"", *header, newheader);
1523 *header = newheader;
1525 else if ( 0 == matches )
1527 /* Filter doesn't change header */
1533 log_error(LOG_LEVEL_ERROR, "Filtering \'%s\' with \'%s\' didn't work out: %s",
1534 *header, b->name, pcrs_strerror(matches));
1535 if (newheader != NULL)
1537 log_error(LOG_LEVEL_ERROR, "Freeing what's left: %s", newheader);
1543 if (b->dynamic) pcrs_free_joblist(joblist);
1545 log_error(LOG_LEVEL_RE_FILTER, "... produced %d hits (new size %d).", current_hits, size);
1546 hits += current_hits;
1553 * Additionally checking for hits is important because if
1554 * the continue hack is triggered, server headers can
1555 * arrive empty to separate multiple heads from each other.
1557 if ((0 == size) && hits)
1559 log_error(LOG_LEVEL_HEADER, "Removing empty header %s", *header);
1567 /*********************************************************************
1569 * Function : server_connection
1571 * Description : Makes sure a proper "Connection:" header is
1572 * set and signals connection_header_adder to
1576 * 1 : csp = Current client state (buffers, headers, etc...)
1577 * 2 : header = On input, pointer to header to modify.
1578 * On output, pointer to the modified header, or NULL
1579 * to remove the header. This function frees the
1580 * original string if necessary.
1582 * Returns : JB_ERR_OK on success, or
1583 * JB_ERR_MEMORY on out-of-memory error.
1585 *********************************************************************/
1586 static jb_err server_connection(struct client_state *csp, char **header)
1588 if (!strcmpic(*header, "Connection: keep-alive")
1589 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1590 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
1594 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1595 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE))
1597 csp->flags |= CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE;
1600 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
1602 log_error(LOG_LEVEL_HEADER,
1603 "Keeping the server header '%s' around.", *header);
1606 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1608 char *old_header = *header;
1610 *header = strdup("Connection: close");
1613 return JB_ERR_MEMORY;
1615 log_error(LOG_LEVEL_HEADER, "Replaced: \'%s\' with \'%s\'", old_header, *header);
1620 /* Signal server_connection_adder() to return early. */
1621 csp->flags |= CSP_FLAG_SERVER_CONNECTION_HEADER_SET;
1627 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1628 /*********************************************************************
1630 * Function : server_keep_alive
1632 * Description : Stores the server's keep alive timeout.
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.
1641 * Returns : JB_ERR_OK.
1643 *********************************************************************/
1644 static jb_err server_keep_alive(struct client_state *csp, char **header)
1646 unsigned int keep_alive_timeout;
1647 const char *timeout_position = strstr(*header, "timeout=");
1649 if ((NULL == timeout_position)
1650 || (1 != sscanf(timeout_position, "timeout=%u", &keep_alive_timeout)))
1652 log_error(LOG_LEVEL_ERROR, "Couldn't parse: %s", *header);
1656 if (keep_alive_timeout < csp->server_connection.keep_alive_timeout)
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;
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);
1670 csp->flags |= CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET;
1677 /*********************************************************************
1679 * Function : server_proxy_connection
1681 * Description : Figures out whether or not we should add a
1682 * Proxy-Connection header.
1685 * 1 : csp = Current client state (buffers, headers, etc...)
1686 * 2 : header = On input, pointer to header to modify.
1687 * On output, pointer to the modified header, or NULL
1688 * to remove the header. This function frees the
1689 * original string if necessary.
1691 * Returns : JB_ERR_OK.
1693 *********************************************************************/
1694 static jb_err server_proxy_connection(struct client_state *csp, char **header)
1696 csp->flags |= CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET;
1701 /*********************************************************************
1703 * Function : client_keep_alive
1705 * Description : Stores the client's keep alive timeout.
1708 * 1 : csp = Current client state (buffers, headers, etc...)
1709 * 2 : header = On input, pointer to header to modify.
1710 * On output, pointer to the modified header, or NULL
1711 * to remove the header. This function frees the
1712 * original string if necessary.
1714 * Returns : JB_ERR_OK.
1716 *********************************************************************/
1717 static jb_err client_keep_alive(struct client_state *csp, char **header)
1719 unsigned int keep_alive_timeout;
1720 const char *timeout_position = strstr(*header, ": ");
1722 if (!(csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE))
1724 log_error(LOG_LEVEL_HEADER,
1725 "keep-alive support is disabled. Crunching: %s.", *header);
1730 if ((NULL == timeout_position)
1731 || (1 != sscanf(timeout_position, ": %u", &keep_alive_timeout)))
1733 log_error(LOG_LEVEL_ERROR, "Couldn't parse: %s", *header);
1737 if (keep_alive_timeout < csp->config->keep_alive_timeout)
1739 log_error(LOG_LEVEL_HEADER,
1740 "Reducing keep-alive timeout from %u to %u.",
1741 csp->config->keep_alive_timeout, keep_alive_timeout);
1742 csp->server_connection.keep_alive_timeout = keep_alive_timeout;
1746 /* XXX: Is this log worthy? */
1747 log_error(LOG_LEVEL_HEADER,
1748 "Client keep-alive timeout is %u. Sticking with %u.",
1749 keep_alive_timeout, csp->config->keep_alive_timeout);
1757 /*********************************************************************
1759 * Function : get_content_length
1761 * Description : Gets the content length specified in a
1762 * Content-Length header.
1765 * 1 : header = The Content-Length header.
1766 * 2 : length = Storage to return the value.
1768 * Returns : JB_ERR_OK on success, or
1769 * JB_ERR_PARSE if no value is recognized.
1771 *********************************************************************/
1772 static jb_err get_content_length(const char *header, unsigned long long *length)
1774 assert(header[14] == ':');
1777 if (1 != sscanf(header+14, ": %I64u", length))
1779 if (1 != sscanf(header+14, ": %llu", length))
1782 return JB_ERR_PARSE;
1789 /*********************************************************************
1791 * Function : client_save_content_length
1793 * Description : Save the Content-Length sent by the client.
1796 * 1 : csp = Current client state (buffers, headers, etc...)
1797 * 2 : header = On input, pointer to header to modify.
1798 * On output, pointer to the modified header, or NULL
1799 * to remove the header. This function frees the
1800 * original string if necessary.
1802 * Returns : JB_ERR_OK on success, or
1803 * JB_ERR_MEMORY on out-of-memory error.
1805 *********************************************************************/
1806 static jb_err client_save_content_length(struct client_state *csp, char **header)
1808 unsigned long long content_length = 0;
1810 assert(*(*header+14) == ':');
1812 if (JB_ERR_OK != get_content_length(*header, &content_length))
1814 log_error(LOG_LEVEL_ERROR, "Crunching invalid header: %s", *header);
1819 csp->expected_client_content_length = content_length;
1824 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1828 /*********************************************************************
1830 * Function : client_connection
1832 * Description : Makes sure a proper "Connection:" header is
1833 * set and signals connection_header_adder
1837 * 1 : csp = Current client state (buffers, headers, etc...)
1838 * 2 : header = On input, pointer to header to modify.
1839 * On output, pointer to the modified header, or NULL
1840 * to remove the header. This function frees the
1841 * original string if necessary.
1843 * Returns : JB_ERR_OK on success, or
1844 * JB_ERR_MEMORY on out-of-memory error.
1846 *********************************************************************/
1847 static jb_err client_connection(struct client_state *csp, char **header)
1849 static const char connection_close[] = "Connection: close";
1851 if (!strcmpic(*header, connection_close))
1853 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1854 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING))
1856 if (!strcmpic(csp->http->ver, "HTTP/1.1"))
1858 log_error(LOG_LEVEL_HEADER,
1859 "Removing \'%s\' to imply keep-alive.", *header);
1864 char *old_header = *header;
1866 *header = strdup("Connection: keep-alive");
1869 return JB_ERR_MEMORY;
1871 log_error(LOG_LEVEL_HEADER,
1872 "Replaced: \'%s\' with \'%s\'", old_header, *header);
1878 log_error(LOG_LEVEL_HEADER,
1879 "Keeping the client header '%s' around. "
1880 "The connection will not be kept alive.",
1882 csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1885 else if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE))
1887 log_error(LOG_LEVEL_HEADER,
1888 "Keeping the client header '%s' around. "
1889 "The server connection will be kept alive if possible.",
1891 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1892 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1896 char *old_header = *header;
1898 *header = strdup(connection_close);
1901 return JB_ERR_MEMORY;
1903 log_error(LOG_LEVEL_HEADER,
1904 "Replaced: \'%s\' with \'%s\'", old_header, *header);
1908 /* Signal client_connection_adder() to return early. */
1909 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_HEADER_SET;
1915 /*********************************************************************
1917 * Function : crumble
1919 * Description : This is called if a header matches a pattern to "crunch"
1922 * 1 : csp = Current client state (buffers, headers, etc...)
1923 * 2 : header = On input, pointer to header to modify.
1924 * On output, pointer to the modified header, or NULL
1925 * to remove the header. This function frees the
1926 * original string if necessary.
1928 * Returns : JB_ERR_OK on success, or
1929 * JB_ERR_MEMORY on out-of-memory error.
1931 *********************************************************************/
1932 static jb_err crumble(struct client_state *csp, char **header)
1935 log_error(LOG_LEVEL_HEADER, "crumble crunched: %s!", *header);
1941 /*********************************************************************
1943 * Function : crunch_server_header
1945 * Description : Crunch server header if it matches a string supplied by the
1946 * user. Called from `sed'.
1949 * 1 : csp = Current client state (buffers, headers, etc...)
1950 * 2 : header = On input, pointer to header to modify.
1951 * On output, pointer to the modified header, or NULL
1952 * to remove the header. This function frees the
1953 * original string if necessary.
1955 * Returns : JB_ERR_OK on success and always succeeds
1957 *********************************************************************/
1958 static jb_err crunch_server_header(struct client_state *csp, char **header)
1960 const char *crunch_pattern;
1962 /* Do we feel like crunching? */
1963 if ((csp->action->flags & ACTION_CRUNCH_SERVER_HEADER))
1965 crunch_pattern = csp->action->string[ACTION_STRING_SERVER_HEADER];
1967 /* Is the current header the lucky one? */
1968 if (strstr(*header, crunch_pattern))
1970 log_error(LOG_LEVEL_HEADER, "Crunching server header: %s (contains: %s)", *header, crunch_pattern);
1979 /*********************************************************************
1981 * Function : server_content_type
1983 * Description : Set the content-type for filterable types (text/.*,
1984 * .*xml.*, javascript and image/gif) unless filtering has been
1985 * forbidden (CT_TABOO) while parsing earlier headers.
1986 * NOTE: Since text/plain is commonly used by web servers
1987 * for files whose correct type is unknown, we don't
1988 * set CT_TEXT for it.
1991 * 1 : csp = Current client state (buffers, headers, etc...)
1992 * 2 : header = On input, pointer to header to modify.
1993 * On output, pointer to the modified header, or NULL
1994 * to remove the header. This function frees the
1995 * original string if necessary.
1997 * Returns : JB_ERR_OK on success, or
1998 * JB_ERR_MEMORY on out-of-memory error.
2000 *********************************************************************/
2001 static jb_err server_content_type(struct client_state *csp, char **header)
2003 /* Remove header if it isn't the first Content-Type header */
2004 if ((csp->content_type & CT_DECLARED))
2007 * Another, slightly slower, way to see if
2008 * we already parsed another Content-Type header.
2010 assert(NULL != get_header_value(csp->headers, "Content-Type:"));
2012 log_error(LOG_LEVEL_ERROR,
2013 "Multiple Content-Type headers. Removing and ignoring: \'%s\'",
2021 * Signal that the Content-Type has been set.
2023 csp->content_type |= CT_DECLARED;
2025 if (!(csp->content_type & CT_TABOO))
2028 * XXX: The assumption that text/plain is a sign of
2029 * binary data seems to be somewhat unreasonable nowadays
2030 * and should be dropped after 3.0.8 is out.
2032 if ((strstr(*header, "text/") && !strstr(*header, "plain"))
2033 || strstr(*header, "xml")
2034 || strstr(*header, "application/x-javascript"))
2036 csp->content_type |= CT_TEXT;
2038 else if (strstr(*header, "image/gif"))
2040 csp->content_type |= CT_GIF;
2045 * Are we messing with the content type?
2047 if (csp->action->flags & ACTION_CONTENT_TYPE_OVERWRITE)
2050 * Make sure the user doesn't accidently
2051 * change the content type of binary documents.
2053 if ((csp->content_type & CT_TEXT) || (csp->action->flags & ACTION_FORCE_TEXT_MODE))
2056 *header = strdup("Content-Type: ");
2057 string_append(header, csp->action->string[ACTION_STRING_CONTENT_TYPE]);
2061 log_error(LOG_LEVEL_HEADER, "Insufficient memory to replace Content-Type!");
2062 return JB_ERR_MEMORY;
2064 log_error(LOG_LEVEL_HEADER, "Modified: %s!", *header);
2068 log_error(LOG_LEVEL_HEADER, "%s not replaced. "
2069 "It doesn't look like a content type that should be filtered. "
2070 "Enable force-text-mode if you know what you're doing.", *header);
2078 /*********************************************************************
2080 * Function : server_transfer_coding
2082 * Description : - Prohibit filtering (CT_TABOO) if transfer coding compresses
2083 * - Raise the CSP_FLAG_CHUNKED flag if coding is "chunked"
2084 * - Remove header if body was chunked but has been
2085 * de-chunked for filtering.
2088 * 1 : csp = Current client state (buffers, headers, etc...)
2089 * 2 : header = On input, pointer to header to modify.
2090 * On output, pointer to the modified header, or NULL
2091 * to remove the header. This function frees the
2092 * original string if necessary.
2094 * Returns : JB_ERR_OK on success, or
2095 * JB_ERR_MEMORY on out-of-memory error.
2097 *********************************************************************/
2098 static jb_err server_transfer_coding(struct client_state *csp, char **header)
2101 * Turn off pcrs and gif filtering if body compressed
2103 if (strstr(*header, "gzip") || strstr(*header, "compress") || strstr(*header, "deflate"))
2107 * XXX: Added to test if we could use CT_GZIP and CT_DEFLATE here.
2109 log_error(LOG_LEVEL_INFO, "Marking content type for %s as CT_TABOO because of %s.",
2110 csp->http->cmd, *header);
2111 #endif /* def FEATURE_ZLIB */
2112 csp->content_type = CT_TABOO;
2116 * Raise flag if body chunked
2118 if (strstr(*header, "chunked"))
2120 csp->flags |= CSP_FLAG_CHUNKED;
2123 * If the body was modified, it has been de-chunked first
2124 * and the header must be removed.
2126 * FIXME: If there is more than one transfer encoding,
2127 * only the "chunked" part should be removed here.
2129 if (csp->flags & CSP_FLAG_MODIFIED)
2131 log_error(LOG_LEVEL_HEADER, "Removing: %s", *header);
2140 /*********************************************************************
2142 * Function : server_content_encoding
2144 * Description : This function is run twice for each request,
2145 * unless FEATURE_ZLIB and filtering are disabled.
2147 * The first run is used to check if the content
2148 * is compressed, if FEATURE_ZLIB is disabled
2149 * filtering is then disabled as well, if FEATURE_ZLIB
2150 * is enabled the content is marked for decompression.
2152 * The second run is used to remove the Content-Encoding
2153 * header if the decompression was successful.
2156 * 1 : csp = Current client state (buffers, headers, etc...)
2157 * 2 : header = On input, pointer to header to modify.
2158 * On output, pointer to the modified header, or NULL
2159 * to remove the header. This function frees the
2160 * original string if necessary.
2162 * Returns : JB_ERR_OK on success, or
2163 * JB_ERR_MEMORY on out-of-memory error.
2165 *********************************************************************/
2166 static jb_err server_content_encoding(struct client_state *csp, char **header)
2169 if ((csp->flags & CSP_FLAG_MODIFIED)
2170 && (csp->content_type & (CT_GZIP | CT_DEFLATE)))
2173 * We successfully decompressed the content,
2174 * and have to clean the header now, so the
2175 * client no longer expects compressed data..
2177 * XXX: There is a difference between cleaning
2178 * and removing it completely.
2180 log_error(LOG_LEVEL_HEADER, "Crunching: %s", *header);
2183 else if (strstr(*header, "gzip"))
2185 /* Mark for gzip decompression */
2186 csp->content_type |= CT_GZIP;
2188 else if (strstr(*header, "deflate"))
2190 /* Mark for zlib decompression */
2191 csp->content_type |= CT_DEFLATE;
2193 else if (strstr(*header, "compress"))
2196 * We can't decompress this; therefore we can't filter
2199 csp->content_type |= CT_TABOO;
2201 #else /* !defined(FEATURE_ZLIB) */
2202 if (strstr(*header, "gzip") || strstr(*header, "compress") || strstr(*header, "deflate"))
2205 * Body is compressed, turn off pcrs and gif filtering.
2207 csp->content_type |= CT_TABOO;
2210 * Log a warning if the user expects the content to be filtered.
2212 if ((csp->rlist != NULL) &&
2213 (!list_is_empty(csp->action->multi[ACTION_MULTI_FILTER])))
2215 log_error(LOG_LEVEL_INFO,
2216 "Compressed content detected, content filtering disabled. "
2217 "Consider recompiling Privoxy with zlib support or "
2218 "enable the prevent-compression action.");
2221 #endif /* defined(FEATURE_ZLIB) */
2228 /*********************************************************************
2230 * Function : server_adjust_content_length
2232 * Description : Adjust Content-Length header if we modified
2236 * 1 : csp = Current client state (buffers, headers, etc...)
2237 * 2 : header = On input, pointer to header to modify.
2238 * On output, pointer to the modified header, or NULL
2239 * to remove the header. This function frees the
2240 * original string if necessary.
2242 * Returns : JB_ERR_OK on success, or
2243 * JB_ERR_MEMORY on out-of-memory error.
2245 *********************************************************************/
2246 static jb_err server_adjust_content_length(struct client_state *csp, char **header)
2248 /* Regenerate header if the content was modified. */
2249 if (csp->flags & CSP_FLAG_MODIFIED)
2251 const size_t header_length = 50;
2253 *header = malloc(header_length);
2254 if (*header == NULL)
2256 return JB_ERR_MEMORY;
2258 create_content_length_header(csp->content_length, *header, header_length);
2259 log_error(LOG_LEVEL_HEADER,
2260 "Adjusted Content-Length to %llu", csp->content_length);
2267 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2268 /*********************************************************************
2270 * Function : server_save_content_length
2272 * Description : Save the Content-Length sent by the server.
2275 * 1 : csp = Current client state (buffers, headers, etc...)
2276 * 2 : header = On input, pointer to header to modify.
2277 * On output, pointer to the modified header, or NULL
2278 * to remove the header. This function frees the
2279 * original string if necessary.
2281 * Returns : JB_ERR_OK on success, or
2282 * JB_ERR_MEMORY on out-of-memory error.
2284 *********************************************************************/
2285 static jb_err server_save_content_length(struct client_state *csp, char **header)
2287 unsigned long long content_length = 0;
2289 assert(*(*header+14) == ':');
2291 if (JB_ERR_OK != get_content_length(*header, &content_length))
2293 log_error(LOG_LEVEL_ERROR, "Crunching invalid header: %s", *header);
2298 csp->expected_content_length = content_length;
2299 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
2300 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2305 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2308 /*********************************************************************
2310 * Function : server_content_md5
2312 * Description : Crumble any Content-MD5 headers if the document was
2313 * modified. FIXME: Should we re-compute instead?
2316 * 1 : csp = Current client state (buffers, headers, etc...)
2317 * 2 : header = On input, pointer to header to modify.
2318 * On output, pointer to the modified header, or NULL
2319 * to remove the header. This function frees the
2320 * original string if necessary.
2322 * Returns : JB_ERR_OK on success, or
2323 * JB_ERR_MEMORY on out-of-memory error.
2325 *********************************************************************/
2326 static jb_err server_content_md5(struct client_state *csp, char **header)
2328 if (csp->flags & CSP_FLAG_MODIFIED)
2330 log_error(LOG_LEVEL_HEADER, "Crunching Content-MD5");
2338 /*********************************************************************
2340 * Function : server_content_disposition
2342 * Description : If enabled, blocks or modifies the "Content-Disposition" header.
2343 * Called from `sed'.
2346 * 1 : csp = Current client state (buffers, headers, etc...)
2347 * 2 : header = On input, pointer to header to modify.
2348 * On output, pointer to the modified header, or NULL
2349 * to remove the header. This function frees the
2350 * original string if necessary.
2352 * Returns : JB_ERR_OK on success, or
2353 * JB_ERR_MEMORY on out-of-memory error.
2355 *********************************************************************/
2356 static jb_err server_content_disposition(struct client_state *csp, char **header)
2361 * Are we messing with the Content-Disposition header?
2363 if ((csp->action->flags & ACTION_HIDE_CONTENT_DISPOSITION) == 0)
2369 newval = csp->action->string[ACTION_STRING_CONTENT_DISPOSITION];
2371 if ((newval == NULL) || (0 == strcmpic(newval, "block")))
2374 * Blocking content-disposition header
2376 log_error(LOG_LEVEL_HEADER, "Crunching %s!", *header);
2383 * Replacing Content-Disposition header
2386 *header = strdup("Content-Disposition: ");
2387 string_append(header, newval);
2389 if (*header != NULL)
2391 log_error(LOG_LEVEL_HEADER,
2392 "Content-Disposition header crunched and replaced with: %s", *header);
2395 return (*header == NULL) ? JB_ERR_MEMORY : JB_ERR_OK;
2399 /*********************************************************************
2401 * Function : server_last_modified
2403 * Description : Changes Last-Modified header to the actual date
2404 * to help hide-if-modified-since.
2405 * Called from `sed'.
2408 * 1 : csp = Current client state (buffers, headers, etc...)
2409 * 2 : header = On input, pointer to header to modify.
2410 * On output, pointer to the modified header, or NULL
2411 * to remove the header. This function frees the
2412 * original string if necessary.
2414 * Returns : JB_ERR_OK on success, or
2415 * JB_ERR_MEMORY on out-of-memory error.
2417 *********************************************************************/
2418 static jb_err server_last_modified(struct client_state *csp, char **header)
2421 char buf[BUFFER_SIZE];
2424 #ifdef HAVE_GMTIME_R
2427 struct tm *timeptr = NULL;
2428 time_t now, last_modified;
2429 long int days, hours, minutes, seconds;
2432 * Are we messing with the Last-Modified header?
2434 if ((csp->action->flags & ACTION_OVERWRITE_LAST_MODIFIED) == 0)
2440 newval = csp->action->string[ACTION_STRING_LAST_MODIFIED];
2442 if (0 == strcmpic(newval, "block") )
2445 * Blocking Last-Modified header. Useless but why not.
2447 log_error(LOG_LEVEL_HEADER, "Crunching %s!", *header);
2451 else if (0 == strcmpic(newval, "reset-to-request-time"))
2454 * Setting Last-Modified Header to now.
2456 get_http_time(0, buf, sizeof(buf));
2458 *header = strdup("Last-Modified: ");
2459 string_append(header, buf);
2461 if (*header == NULL)
2463 log_error(LOG_LEVEL_HEADER, "Insufficient memory. Last-Modified header got lost, boohoo.");
2467 log_error(LOG_LEVEL_HEADER, "Reset to present time: %s", *header);
2470 else if (0 == strcmpic(newval, "randomize"))
2472 const char *header_time = *header + sizeof("Last-Modified:");
2474 log_error(LOG_LEVEL_HEADER, "Randomizing: %s", *header);
2476 #ifdef HAVE_GMTIME_R
2477 gmtime_r(&now, &gmt);
2478 #elif defined(MUTEX_LOCKS_AVAILABLE)
2479 privoxy_mutex_lock(&gmtime_mutex);
2481 privoxy_mutex_unlock(&gmtime_mutex);
2485 if (JB_ERR_OK != parse_header_time(header_time, &last_modified))
2487 log_error(LOG_LEVEL_HEADER, "Couldn't parse: %s in %s (crunching!)", header_time, *header);
2492 long int rtime = (long int)difftime(now, last_modified);
2495 const int negative_delta = (rtime < 0);
2500 log_error(LOG_LEVEL_HEADER, "Server time in the future.");
2502 rtime = pick_from_range(rtime);
2507 last_modified += rtime;
2508 #ifdef HAVE_GMTIME_R
2509 timeptr = gmtime_r(&last_modified, &gmt);
2510 #elif defined(MUTEX_LOCKS_AVAILABLE)
2511 privoxy_mutex_lock(&gmtime_mutex);
2512 timeptr = gmtime(&last_modified);
2513 privoxy_mutex_unlock(&gmtime_mutex);
2515 timeptr = gmtime(&last_modified);
2517 if ((NULL == timeptr) || !strftime(newheader,
2518 sizeof(newheader), "%a, %d %b %Y %H:%M:%S GMT", timeptr))
2520 log_error(LOG_LEVEL_ERROR,
2521 "Randomizing '%s' failed. Crunching the header without replacement.",
2528 *header = strdup("Last-Modified: ");
2529 string_append(header, newheader);
2531 if (*header == NULL)
2533 log_error(LOG_LEVEL_ERROR, "Insufficient memory, header crunched without replacement.");
2534 return JB_ERR_MEMORY;
2537 days = rtime / (3600 * 24);
2538 hours = rtime / 3600 % 24;
2539 minutes = rtime / 60 % 60;
2540 seconds = rtime % 60;
2542 log_error(LOG_LEVEL_HEADER,
2543 "Randomized: %s (added %d da%s %d hou%s %d minut%s %d second%s",
2544 *header, days, (days == 1) ? "y" : "ys", hours, (hours == 1) ? "r" : "rs",
2545 minutes, (minutes == 1) ? "e" : "es", seconds, (seconds == 1) ? ")" : "s)");
2549 log_error(LOG_LEVEL_HEADER, "Randomized ... or not. No time difference to work with.");
2558 /*********************************************************************
2560 * Function : client_accept_encoding
2562 * Description : Rewrite the client's Accept-Encoding header so that
2563 * if doesn't allow compression, if the action applies.
2564 * Note: For HTTP/1.0 the absence of the header is enough.
2567 * 1 : csp = Current client state (buffers, headers, etc...)
2568 * 2 : header = On input, pointer to header to modify.
2569 * On output, pointer to the modified header, or NULL
2570 * to remove the header. This function frees the
2571 * original string if necessary.
2573 * Returns : JB_ERR_OK on success, or
2574 * JB_ERR_MEMORY on out-of-memory error.
2576 *********************************************************************/
2577 static jb_err client_accept_encoding(struct client_state *csp, char **header)
2579 if ((csp->action->flags & ACTION_NO_COMPRESSION) != 0)
2581 log_error(LOG_LEVEL_HEADER, "Suppressed offer to compress content");
2585 /* Temporarily disable the correct behaviour to
2586 * work around a PHP bug.
2588 * if (!strcmpic(csp->http->ver, "HTTP/1.1"))
2590 * *header = strdup("Accept-Encoding: identity;q=1.0, *;q=0");
2591 * if (*header == NULL)
2593 * return JB_ERR_MEMORY;
2604 /*********************************************************************
2606 * Function : client_te
2608 * Description : Rewrite the client's TE header so that
2609 * if doesn't allow compression, if the action applies.
2612 * 1 : csp = Current client state (buffers, headers, etc...)
2613 * 2 : header = On input, pointer to header to modify.
2614 * On output, pointer to the modified header, or NULL
2615 * to remove the header. This function frees the
2616 * original string if necessary.
2618 * Returns : JB_ERR_OK on success, or
2619 * JB_ERR_MEMORY on out-of-memory error.
2621 *********************************************************************/
2622 static jb_err client_te(struct client_state *csp, char **header)
2624 if ((csp->action->flags & ACTION_NO_COMPRESSION) != 0)
2627 log_error(LOG_LEVEL_HEADER, "Suppressed offer to compress transfer");
2634 /*********************************************************************
2636 * Function : client_referrer
2638 * Description : Handle the "referer" config setting properly.
2639 * Called from `sed'.
2642 * 1 : csp = Current client state (buffers, headers, etc...)
2643 * 2 : header = On input, pointer to header to modify.
2644 * On output, pointer to the modified header, or NULL
2645 * to remove the header. This function frees the
2646 * original string if necessary.
2648 * Returns : JB_ERR_OK on success, or
2649 * JB_ERR_MEMORY on out-of-memory error.
2651 *********************************************************************/
2652 static jb_err client_referrer(struct client_state *csp, char **header)
2654 const char *parameter;
2655 /* booleans for parameters we have to check multiple times */
2656 int parameter_conditional_block;
2657 int parameter_conditional_forge;
2659 #ifdef FEATURE_FORCE_LOAD
2661 * Since the referrer can include the prefix even
2662 * if the request itself is non-forced, we must
2663 * clean it unconditionally.
2665 * XXX: strclean is too broad
2667 strclean(*header, FORCE_PREFIX);
2668 #endif /* def FEATURE_FORCE_LOAD */
2670 if ((csp->action->flags & ACTION_HIDE_REFERER) == 0)
2672 /* Nothing left to do */
2676 parameter = csp->action->string[ACTION_STRING_REFERER];
2677 assert(parameter != NULL);
2678 parameter_conditional_block = (0 == strcmpic(parameter, "conditional-block"));
2679 parameter_conditional_forge = (0 == strcmpic(parameter, "conditional-forge"));
2681 if (!parameter_conditional_block && !parameter_conditional_forge)
2684 * As conditional-block and conditional-forge are the only
2685 * parameters that rely on the original referrer, we can
2686 * remove it now for all the others.
2691 if (0 == strcmpic(parameter, "block"))
2693 log_error(LOG_LEVEL_HEADER, "Referer crunched!");
2696 else if (parameter_conditional_block || parameter_conditional_forge)
2698 return handle_conditional_hide_referrer_parameter(header,
2699 csp->http->hostport, parameter_conditional_block);
2701 else if (0 == strcmpic(parameter, "forge"))
2703 return create_forged_referrer(header, csp->http->hostport);
2707 /* interpret parameter as user-supplied referer to fake */
2708 return create_fake_referrer(header, parameter);
2713 /*********************************************************************
2715 * Function : client_accept_language
2717 * Description : Handle the "Accept-Language" config setting properly.
2718 * Called from `sed'.
2721 * 1 : csp = Current client state (buffers, headers, etc...)
2722 * 2 : header = On input, pointer to header to modify.
2723 * On output, pointer to the modified header, or NULL
2724 * to remove the header. This function frees the
2725 * original string if necessary.
2727 * Returns : JB_ERR_OK on success, or
2728 * JB_ERR_MEMORY on out-of-memory error.
2730 *********************************************************************/
2731 static jb_err client_accept_language(struct client_state *csp, char **header)
2736 * Are we messing with the Accept-Language?
2738 if ((csp->action->flags & ACTION_HIDE_ACCEPT_LANGUAGE) == 0)
2740 /*I don't think so*/
2744 newval = csp->action->string[ACTION_STRING_LANGUAGE];
2746 if ((newval == NULL) || (0 == strcmpic(newval, "block")) )
2749 * Blocking Accept-Language header
2751 log_error(LOG_LEVEL_HEADER, "Crunching Accept-Language!");
2758 * Replacing Accept-Language header
2761 *header = strdup("Accept-Language: ");
2762 string_append(header, newval);
2764 if (*header == NULL)
2766 log_error(LOG_LEVEL_ERROR,
2767 "Insufficient memory. Accept-Language header crunched without replacement.");
2771 log_error(LOG_LEVEL_HEADER,
2772 "Accept-Language header crunched and replaced with: %s", *header);
2775 return (*header == NULL) ? JB_ERR_MEMORY : JB_ERR_OK;
2779 /*********************************************************************
2781 * Function : crunch_client_header
2783 * Description : Crunch client header if it matches a string supplied by the
2784 * user. Called from `sed'.
2787 * 1 : csp = Current client state (buffers, headers, etc...)
2788 * 2 : header = On input, pointer to header to modify.
2789 * On output, pointer to the modified header, or NULL
2790 * to remove the header. This function frees the
2791 * original string if necessary.
2793 * Returns : JB_ERR_OK on success and always succeeds
2795 *********************************************************************/
2796 static jb_err crunch_client_header(struct client_state *csp, char **header)
2798 const char *crunch_pattern;
2800 /* Do we feel like crunching? */
2801 if ((csp->action->flags & ACTION_CRUNCH_CLIENT_HEADER))
2803 crunch_pattern = csp->action->string[ACTION_STRING_CLIENT_HEADER];
2805 /* Is the current header the lucky one? */
2806 if (strstr(*header, crunch_pattern))
2808 log_error(LOG_LEVEL_HEADER, "Crunching client header: %s (contains: %s)", *header, crunch_pattern);
2816 /*********************************************************************
2818 * Function : client_uagent
2820 * Description : Handle the "user-agent" config setting properly
2821 * and remember its original value to enable browser
2822 * bug workarounds. Called from `sed'.
2825 * 1 : csp = Current client state (buffers, headers, etc...)
2826 * 2 : header = On input, pointer to header to modify.
2827 * On output, pointer to the modified header, or NULL
2828 * to remove the header. This function frees the
2829 * original string if necessary.
2831 * Returns : JB_ERR_OK on success, or
2832 * JB_ERR_MEMORY on out-of-memory error.
2834 *********************************************************************/
2835 static jb_err client_uagent(struct client_state *csp, char **header)
2839 if ((csp->action->flags & ACTION_HIDE_USER_AGENT) == 0)
2844 newval = csp->action->string[ACTION_STRING_USER_AGENT];
2851 *header = strdup("User-Agent: ");
2852 string_append(header, newval);
2854 log_error(LOG_LEVEL_HEADER, "Modified: %s", *header);
2856 return (*header == NULL) ? JB_ERR_MEMORY : JB_ERR_OK;
2860 /*********************************************************************
2862 * Function : client_ua
2864 * Description : Handle "ua-" headers properly. Called from `sed'.
2867 * 1 : csp = Current client state (buffers, headers, etc...)
2868 * 2 : header = On input, pointer to header to modify.
2869 * On output, pointer to the modified header, or NULL
2870 * to remove the header. This function frees the
2871 * original string if necessary.
2873 * Returns : JB_ERR_OK on success, or
2874 * JB_ERR_MEMORY on out-of-memory error.
2876 *********************************************************************/
2877 static jb_err client_ua(struct client_state *csp, char **header)
2879 if ((csp->action->flags & ACTION_HIDE_USER_AGENT) != 0)
2881 log_error(LOG_LEVEL_HEADER, "crunched User-Agent!");
2889 /*********************************************************************
2891 * Function : client_from
2893 * Description : Handle the "from" config setting properly.
2894 * Called from `sed'.
2897 * 1 : csp = Current client state (buffers, headers, etc...)
2898 * 2 : header = On input, pointer to header to modify.
2899 * On output, pointer to the modified header, or NULL
2900 * to remove the header. This function frees the
2901 * original string if necessary.
2903 * Returns : JB_ERR_OK on success, or
2904 * JB_ERR_MEMORY on out-of-memory error.
2906 *********************************************************************/
2907 static jb_err client_from(struct client_state *csp, char **header)
2911 if ((csp->action->flags & ACTION_HIDE_FROM) == 0)
2918 newval = csp->action->string[ACTION_STRING_FROM];
2921 * Are we blocking the e-mail address?
2923 if ((newval == NULL) || (0 == strcmpic(newval, "block")) )
2925 log_error(LOG_LEVEL_HEADER, "crunched From!");
2929 log_error(LOG_LEVEL_HEADER, " modified");
2931 *header = strdup("From: ");
2932 string_append(header, newval);
2934 return (*header == NULL) ? JB_ERR_MEMORY : JB_ERR_OK;
2938 /*********************************************************************
2940 * Function : client_send_cookie
2942 * Description : Crunches the "cookie" header if necessary.
2943 * Called from `sed'.
2945 * XXX: Stupid name, doesn't send squat.
2948 * 1 : csp = Current client state (buffers, headers, etc...)
2949 * 2 : header = On input, pointer to header to modify.
2950 * On output, pointer to the modified header, or NULL
2951 * to remove the header. This function frees the
2952 * original string if necessary.
2954 * Returns : JB_ERR_OK on success, or
2955 * JB_ERR_MEMORY on out-of-memory error.
2957 *********************************************************************/
2958 static jb_err client_send_cookie(struct client_state *csp, char **header)
2960 if (csp->action->flags & ACTION_NO_COOKIE_READ)
2962 log_error(LOG_LEVEL_HEADER, "Crunched outgoing cookie: %s", *header);
2970 /*********************************************************************
2972 * Function : client_x_forwarded
2974 * Description : Handle the "x-forwarded-for" config setting properly,
2975 * also used in the add_client_headers list. Called from `sed'.
2978 * 1 : csp = Current client state (buffers, headers, etc...)
2979 * 2 : header = On input, pointer to header to modify.
2980 * On output, pointer to the modified header, or NULL
2981 * to remove the header. This function frees the
2982 * original string if necessary.
2984 * Returns : JB_ERR_OK on success, or
2985 * JB_ERR_MEMORY on out-of-memory error.
2987 *********************************************************************/
2988 jb_err client_x_forwarded(struct client_state *csp, char **header)
2990 if (0 != (csp->action->flags & ACTION_CHANGE_X_FORWARDED_FOR))
2992 const char *parameter = csp->action->string[ACTION_STRING_CHANGE_X_FORWARDED_FOR];
2994 if (0 == strcmpic(parameter, "block"))
2997 log_error(LOG_LEVEL_HEADER, "crunched x-forwarded-for!");
2999 else if (0 == strcmpic(parameter, "add"))
3001 string_append(header, ", ");
3002 string_append(header, csp->ip_addr_str);
3004 if (*header == NULL)
3006 return JB_ERR_MEMORY;
3008 log_error(LOG_LEVEL_HEADER,
3009 "Appended client IP address to %s", *header);
3010 csp->flags |= CSP_FLAG_X_FORWARDED_FOR_APPENDED;
3014 log_error(LOG_LEVEL_FATAL,
3015 "Invalid change-x-forwarded-for parameter: '%s'", parameter);
3023 /*********************************************************************
3025 * Function : client_max_forwards
3027 * Description : If the HTTP method is OPTIONS or TRACE, subtract one
3028 * from the value of the Max-Forwards header field.
3031 * 1 : csp = Current client state (buffers, headers, etc...)
3032 * 2 : header = On input, pointer to header to modify.
3033 * On output, pointer to the modified header, or NULL
3034 * to remove the header. This function frees the
3035 * original string if necessary.
3037 * Returns : JB_ERR_OK on success, or
3038 * JB_ERR_MEMORY on out-of-memory error.
3040 *********************************************************************/
3041 static jb_err client_max_forwards(struct client_state *csp, char **header)
3045 if ((0 == strcmpic(csp->http->gpc, "trace")) ||
3046 (0 == strcmpic(csp->http->gpc, "options")))
3048 assert(*(*header+12) == ':');
3049 if (1 == sscanf(*header+12, ": %d", &max_forwards))
3051 if (max_forwards > 0)
3053 snprintf(*header, strlen(*header)+1, "Max-Forwards: %d", --max_forwards);
3054 log_error(LOG_LEVEL_HEADER,
3055 "Max-Forwards value for %s request reduced to %d.",
3056 csp->http->gpc, max_forwards);
3058 else if (max_forwards < 0)
3060 log_error(LOG_LEVEL_ERROR, "Crunching invalid header: %s", *header);
3066 log_error(LOG_LEVEL_ERROR, "Crunching invalid header: %s", *header);
3075 /*********************************************************************
3077 * Function : client_host
3079 * Description : If the request URI did not contain host and
3080 * port information, parse and evaluate the Host
3083 * Also, kill ill-formed HOST: headers as sent by
3084 * Apple's iTunes software when used with a proxy.
3087 * 1 : csp = Current client state (buffers, headers, etc...)
3088 * 2 : header = On input, pointer to header to modify.
3089 * On output, pointer to the modified header, or NULL
3090 * to remove the header. This function frees the
3091 * original string if necessary.
3093 * Returns : JB_ERR_OK on success, or
3094 * JB_ERR_MEMORY on out-of-memory error.
3096 *********************************************************************/
3097 static jb_err client_host(struct client_state *csp, char **header)
3102 * If the header field name is all upper-case, chances are that it's
3103 * an ill-formed one from iTunes. BTW, killing innocent headers here is
3104 * not a problem -- they are regenerated later.
3106 if ((*header)[1] == 'O')
3108 log_error(LOG_LEVEL_HEADER, "Killed all-caps Host header line: %s", *header);
3113 if (!csp->http->hostport || (*csp->http->hostport == '*') ||
3114 *csp->http->hostport == ' ' || *csp->http->hostport == '\0')
3117 if (NULL == (p = strdup((*header)+6)))
3119 return JB_ERR_MEMORY;
3122 if (NULL == (q = strdup(p)))
3125 return JB_ERR_MEMORY;
3128 freez(csp->http->hostport);
3129 csp->http->hostport = p;
3130 freez(csp->http->host);
3131 csp->http->host = q;
3132 q = strchr(csp->http->host, ':');
3135 /* Terminate hostname and evaluate port string */
3137 csp->http->port = atoi(q);
3141 csp->http->port = csp->http->ssl ? 443 : 80;
3144 log_error(LOG_LEVEL_HEADER, "New host and port from Host field: %s = %s:%d",
3145 csp->http->hostport, csp->http->host, csp->http->port);
3148 /* Signal client_host_adder() to return right away */
3149 csp->flags |= CSP_FLAG_HOST_HEADER_IS_SET;
3155 /*********************************************************************
3157 * Function : client_if_modified_since
3159 * Description : Remove or modify the If-Modified-Since header.
3162 * 1 : csp = Current client state (buffers, headers, etc...)
3163 * 2 : header = On input, pointer to header to modify.
3164 * On output, pointer to the modified header, or NULL
3165 * to remove the header. This function frees the
3166 * original string if necessary.
3168 * Returns : JB_ERR_OK on success, or
3169 * JB_ERR_MEMORY on out-of-memory error.
3171 *********************************************************************/
3172 static jb_err client_if_modified_since(struct client_state *csp, char **header)
3175 #ifdef HAVE_GMTIME_R
3178 struct tm *timeptr = NULL;
3181 long int hours, minutes, seconds;
3184 if ( 0 == strcmpic(*header, "If-Modified-Since: Wed, 08 Jun 1955 12:00:00 GMT"))
3187 * The client got an error message because of a temporary problem,
3188 * the problem is gone and the client now tries to revalidate our
3189 * error message on the real server. The revalidation would always
3190 * end with the transmission of the whole document and there is
3191 * no need to expose the bogus If-Modified-Since header.
3193 log_error(LOG_LEVEL_HEADER, "Crunching useless If-Modified-Since header.");
3196 else if (csp->action->flags & ACTION_HIDE_IF_MODIFIED_SINCE)
3198 newval = csp->action->string[ACTION_STRING_IF_MODIFIED_SINCE];
3200 if ((0 == strcmpic(newval, "block")))
3202 log_error(LOG_LEVEL_HEADER, "Crunching %s", *header);
3205 else /* add random value */
3207 const char *header_time = *header + sizeof("If-Modified-Since:");
3209 if (JB_ERR_OK != parse_header_time(header_time, &tm))
3211 log_error(LOG_LEVEL_HEADER, "Couldn't parse: %s in %s (crunching!)", header_time, *header);
3216 long int rtime = strtol(newval, &endptr, 0);
3217 const int negative_range = (rtime < 0);
3221 log_error(LOG_LEVEL_HEADER, "Randomizing: %s (random range: %d minut%s)",
3222 *header, rtime, (rtime == 1 || rtime == -1) ? "e": "es");
3228 rtime = pick_from_range(rtime);
3232 log_error(LOG_LEVEL_ERROR, "Random range is 0. Assuming time transformation test.",
3235 tm += rtime * (negative_range ? -1 : 1);
3236 #ifdef HAVE_GMTIME_R
3237 timeptr = gmtime_r(&tm, &gmt);
3238 #elif defined(MUTEX_LOCKS_AVAILABLE)
3239 privoxy_mutex_lock(&gmtime_mutex);
3240 timeptr = gmtime(&tm);
3241 privoxy_mutex_unlock(&gmtime_mutex);
3243 timeptr = gmtime(&tm);
3245 if ((NULL == timeptr) || !strftime(newheader,
3246 sizeof(newheader), "%a, %d %b %Y %H:%M:%S GMT", timeptr))
3248 log_error(LOG_LEVEL_ERROR,
3249 "Randomizing '%s' failed. Crunching the header without replacement.",
3256 *header = strdup("If-Modified-Since: ");
3257 string_append(header, newheader);
3259 if (*header == NULL)
3261 log_error(LOG_LEVEL_HEADER, "Insufficient memory, header crunched without replacement.");
3262 return JB_ERR_MEMORY;
3265 hours = rtime / 3600;
3266 minutes = rtime / 60 % 60;
3267 seconds = rtime % 60;
3269 log_error(LOG_LEVEL_HEADER,
3270 "Randomized: %s (%s %d hou%s %d minut%s %d second%s",
3271 *header, (negative_range) ? "subtracted" : "added", hours,
3272 (hours == 1) ? "r" : "rs", minutes, (minutes == 1) ? "e" : "es",
3273 seconds, (seconds == 1) ? ")" : "s)");
3282 /*********************************************************************
3284 * Function : client_if_none_match
3286 * Description : Remove the If-None-Match header.
3289 * 1 : csp = Current client state (buffers, headers, etc...)
3290 * 2 : header = On input, pointer to header to modify.
3291 * On output, pointer to the modified header, or NULL
3292 * to remove the header. This function frees the
3293 * original string if necessary.
3295 * Returns : JB_ERR_OK on success, or
3296 * JB_ERR_MEMORY on out-of-memory error.
3298 *********************************************************************/
3299 static jb_err client_if_none_match(struct client_state *csp, char **header)
3301 if (csp->action->flags & ACTION_CRUNCH_IF_NONE_MATCH)
3303 log_error(LOG_LEVEL_HEADER, "Crunching %s", *header);
3311 /*********************************************************************
3313 * Function : client_x_filter
3315 * Description : Disables filtering if the client set "X-Filter: No".
3316 * Called from `sed'.
3319 * 1 : csp = Current client state (buffers, headers, etc...)
3320 * 2 : header = On input, pointer to header to modify.
3321 * On output, pointer to the modified header, or NULL
3322 * to remove the header. This function frees the
3323 * original string if necessary.
3325 * Returns : JB_ERR_OK on success
3327 *********************************************************************/
3328 jb_err client_x_filter(struct client_state *csp, char **header)
3330 if ( 0 == strcmpic(*header, "X-Filter: No"))
3332 if (!(csp->config->feature_flags & RUNTIME_FEATURE_HTTP_TOGGLE))
3334 log_error(LOG_LEVEL_INFO, "Ignored the client's request to fetch without filtering.");
3338 if (csp->action->flags & ACTION_FORCE_TEXT_MODE)
3340 log_error(LOG_LEVEL_HEADER,
3341 "force-text-mode overruled the client's request to fetch without filtering!");
3345 csp->content_type = CT_TABOO; /* XXX: This hack shouldn't be necessary */
3346 csp->flags |= CSP_FLAG_NO_FILTERING;
3347 log_error(LOG_LEVEL_HEADER, "Accepted the client's request to fetch without filtering.");
3349 log_error(LOG_LEVEL_HEADER, "Crunching %s", *header);
3357 /*********************************************************************
3359 * Function : client_range
3361 * Description : Removes Range, Request-Range and If-Range headers if
3362 * content filtering is enabled. If the client's version
3363 * of the document has been altered by Privoxy, the server
3364 * could interpret the range differently than the client
3365 * intended in which case the user could end up with
3366 * corrupted content.
3369 * 1 : csp = Current client state (buffers, headers, etc...)
3370 * 2 : header = On input, pointer to header to modify.
3371 * On output, pointer to the modified header, or NULL
3372 * to remove the header. This function frees the
3373 * original string if necessary.
3375 * Returns : JB_ERR_OK
3377 *********************************************************************/
3378 static jb_err client_range(struct client_state *csp, char **header)
3380 if (content_filters_enabled(csp->action))
3382 log_error(LOG_LEVEL_HEADER, "Content filtering is enabled."
3383 " Crunching: \'%s\' to prevent range-mismatch problems.", *header);
3390 /* the following functions add headers directly to the header list */
3392 /*********************************************************************
3394 * Function : client_host_adder
3396 * Description : Adds the Host: header field if it is missing.
3397 * Called from `sed'.
3400 * 1 : csp = Current client state (buffers, headers, etc...)
3402 * Returns : JB_ERR_OK on success, or
3403 * JB_ERR_MEMORY on out-of-memory error.
3405 *********************************************************************/
3406 static jb_err client_host_adder(struct client_state *csp)
3411 if (csp->flags & CSP_FLAG_HOST_HEADER_IS_SET)
3413 /* Header already set by the client, nothing to do. */
3417 if ( !csp->http->hostport || !*(csp->http->hostport))
3419 /* XXX: When does this happen and why is it OK? */
3420 log_error(LOG_LEVEL_INFO, "Weirdness in client_host_adder detected and ignored.");
3425 * remove 'user:pass@' from 'proto://user:pass@host'
3427 if ( (p = strchr( csp->http->hostport, '@')) != NULL )
3433 p = csp->http->hostport;
3436 /* XXX: Just add it, we already made sure that it will be unique */
3437 log_error(LOG_LEVEL_HEADER, "addh-unique: Host: %s", p);
3438 err = enlist_unique_header(csp->headers, "Host", p);
3445 /*********************************************************************
3447 * Function : client_accept_encoding_adder
3449 * Description : Add an Accept-Encoding header to the client's request
3450 * that disables compression if the action applies, and
3451 * the header is not already there. Called from `sed'.
3452 * Note: For HTTP/1.0, the absence of the header is enough.
3455 * 1 : csp = Current client state (buffers, headers, etc...)
3457 * Returns : JB_ERR_OK on success, or
3458 * JB_ERR_MEMORY on out-of-memory error.
3460 *********************************************************************/
3461 static jb_err client_accept_encoding_adder(struct client_state *csp)
3463 if ( ((csp->action->flags & ACTION_NO_COMPRESSION) != 0)
3464 && (!strcmpic(csp->http->ver, "HTTP/1.1")) )
3466 return enlist_unique(csp->headers, "Accept-Encoding: identity;q=1.0, *;q=0", 16);
3474 /*********************************************************************
3476 * Function : client_xtra_adder
3478 * Description : Used in the add_client_headers list. Called from `sed'.
3481 * 1 : csp = Current client state (buffers, headers, etc...)
3483 * Returns : JB_ERR_OK on success, or
3484 * JB_ERR_MEMORY on out-of-memory error.
3486 *********************************************************************/
3487 static jb_err client_xtra_adder(struct client_state *csp)
3489 struct list_entry *lst;
3492 for (lst = csp->action->multi[ACTION_MULTI_ADD_HEADER]->first;
3493 lst ; lst = lst->next)
3495 log_error(LOG_LEVEL_HEADER, "addh: %s", lst->str);
3496 err = enlist(csp->headers, lst->str);
3508 /*********************************************************************
3510 * Function : client_x_forwarded_for_adder
3512 * Description : Used in the add_client_headers list. Called from `sed'.
3515 * 1 : csp = Current client state (buffers, headers, etc...)
3517 * Returns : JB_ERR_OK on success, or
3518 * JB_ERR_MEMORY on out-of-memory error.
3520 *********************************************************************/
3521 static jb_err client_x_forwarded_for_adder(struct client_state *csp)
3523 char *header = NULL;
3526 if (!((csp->action->flags & ACTION_CHANGE_X_FORWARDED_FOR)
3527 && (0 == strcmpic(csp->action->string[ACTION_STRING_CHANGE_X_FORWARDED_FOR], "add")))
3528 || (csp->flags & CSP_FLAG_X_FORWARDED_FOR_APPENDED))
3531 * If we aren't adding X-Forwarded-For headers,
3532 * or we already appended an existing X-Forwarded-For
3533 * header, there's nothing left to do here.
3538 header = strdup("X-Forwarded-For: ");
3539 string_append(&header, csp->ip_addr_str);
3543 return JB_ERR_MEMORY;
3546 log_error(LOG_LEVEL_HEADER, "addh: %s", header);
3547 err = enlist(csp->headers, header);
3554 /*********************************************************************
3556 * Function : server_connection_adder
3558 * Description : Adds an appropiate "Connection:" header to csp->headers
3559 * unless the header was already present. Called from `sed'.
3562 * 1 : csp = Current client state (buffers, headers, etc...)
3564 * Returns : JB_ERR_OK on success, or
3565 * JB_ERR_MEMORY on out-of-memory error.
3567 *********************************************************************/
3568 static jb_err server_connection_adder(struct client_state *csp)
3570 const unsigned int flags = csp->flags;
3571 const char *response_status_line = csp->headers->first->str;
3572 static const char connection_close[] = "Connection: close";
3574 if ((flags & CSP_FLAG_CLIENT_HEADER_PARSING_DONE)
3575 && (flags & CSP_FLAG_SERVER_CONNECTION_HEADER_SET))
3581 * XXX: if we downgraded the response, this check will fail.
3583 if ((csp->config->feature_flags &
3584 RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
3585 && (NULL != response_status_line)
3586 && !strncmpic(response_status_line, "HTTP/1.1", 8)
3587 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3588 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
3592 log_error(LOG_LEVEL_HEADER, "A HTTP/1.1 response "
3593 "without Connection header implies keep-alive.");
3594 csp->flags |= CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE;
3598 log_error(LOG_LEVEL_HEADER, "Adding: %s", connection_close);
3600 return enlist(csp->headers, connection_close);
3604 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3605 /*********************************************************************
3607 * Function : server_proxy_connection_adder
3609 * Description : Adds a "Proxy-Connection: keep-alive" header to
3610 * csp->headers if the client asked for keep-alive.
3611 * XXX: We should reuse existant ones.
3614 * 1 : csp = Current client state (buffers, headers, etc...)
3616 * Returns : JB_ERR_OK on success, or
3617 * JB_ERR_MEMORY on out-of-memory error.
3619 *********************************************************************/
3620 static jb_err server_proxy_connection_adder(struct client_state *csp)
3622 static const char proxy_connection_header[] = "Proxy-Connection: keep-alive";
3623 jb_err err = JB_ERR_OK;
3625 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
3626 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
3627 && !(csp->flags & CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET))
3629 log_error(LOG_LEVEL_HEADER, "Adding: %s", proxy_connection_header);
3630 err = enlist(csp->headers, proxy_connection_header);
3635 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
3638 /*********************************************************************
3640 * Function : client_connection_header_adder
3642 * Description : Adds a proper "Connection:" header to csp->headers
3643 * unless the header was already present. Called from `sed'.
3646 * 1 : csp = Current client state (buffers, headers, etc...)
3648 * Returns : JB_ERR_OK on success, or
3649 * JB_ERR_MEMORY on out-of-memory error.
3651 *********************************************************************/
3652 static jb_err client_connection_header_adder(struct client_state *csp)
3654 static const char connection_close[] = "Connection: close";
3656 if (!(csp->flags & CSP_FLAG_CLIENT_HEADER_PARSING_DONE)
3657 && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_HEADER_SET))
3662 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3663 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
3664 && (csp->http->ssl == 0)
3665 && !strcmpic(csp->http->ver, "HTTP/1.1"))
3667 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
3670 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
3672 log_error(LOG_LEVEL_HEADER, "Adding: %s", connection_close);
3674 return enlist(csp->headers, connection_close);
3678 /*********************************************************************
3680 * Function : server_http
3682 * Description : - Save the HTTP Status into csp->http->status
3683 * - Set CT_TABOO to prevent filtering if the answer
3684 * is a partial range (HTTP status 206)
3685 * - Rewrite HTTP/1.1 answers to HTTP/1.0 if +downgrade
3689 * 1 : csp = Current client state (buffers, headers, etc...)
3690 * 2 : header = On input, pointer to header to modify.
3691 * On output, pointer to the modified header, or NULL
3692 * to remove the header. This function frees the
3693 * original string if necessary.
3695 * Returns : JB_ERR_OK on success, or
3696 * JB_ERR_MEMORY on out-of-memory error.
3698 *********************************************************************/
3699 static jb_err server_http(struct client_state *csp, char **header)
3701 sscanf(*header, "HTTP/%*d.%*d %d", &(csp->http->status));
3702 if (csp->http->status == 206)
3704 csp->content_type = CT_TABOO;
3707 if ((csp->action->flags & ACTION_DOWNGRADE) != 0)
3709 /* XXX: Should we do a real validity check here? */
3710 if (strlen(*header) > 8)
3713 log_error(LOG_LEVEL_HEADER, "Downgraded answer to HTTP/1.0");
3718 * XXX: Should we block the request or
3719 * enlist a valid status code line here?
3721 log_error(LOG_LEVEL_INFO, "Malformed server response detected. "
3722 "Downgrading to HTTP/1.0 impossible.");
3730 /*********************************************************************
3732 * Function : server_set_cookie
3734 * Description : Handle the server "cookie" header properly.
3735 * Crunch, accept or rewrite it to a session cookie.
3736 * Called from `sed'.
3738 * TODO: Allow the user to specify a new expiration
3739 * time to cause the cookie to expire even before the
3740 * browser is closed.
3743 * 1 : csp = Current client state (buffers, headers, etc...)
3744 * 2 : header = On input, pointer to header to modify.
3745 * On output, pointer to the modified header, or NULL
3746 * to remove the header. This function frees the
3747 * original string if necessary.
3749 * Returns : JB_ERR_OK on success, or
3750 * JB_ERR_MEMORY on out-of-memory error.
3752 *********************************************************************/
3753 static jb_err server_set_cookie(struct client_state *csp, char **header)
3760 if ((csp->action->flags & ACTION_NO_COOKIE_SET) != 0)
3762 log_error(LOG_LEVEL_HEADER, "Crunching incoming cookie: %s", *header);
3765 else if ((csp->action->flags & ACTION_NO_COOKIE_KEEP) != 0)
3767 /* Flag whether or not to log a message */
3770 /* A variable to store the tag we're working on */
3773 /* Skip "Set-Cookie:" (11 characters) in header */
3774 cur_tag = *header + 11;
3776 /* skip whitespace between "Set-Cookie:" and value */
3777 while (*cur_tag && ijb_isspace(*cur_tag))
3782 /* Loop through each tag in the cookie */
3786 char *next_tag = strchr(cur_tag, ';');
3787 if (next_tag != NULL)
3789 /* Skip the ';' character itself */
3792 /* skip whitespace ";" and start of tag */
3793 while (*next_tag && ijb_isspace(*next_tag))
3800 /* "Next tag" is the end of the string */
3801 next_tag = cur_tag + strlen(cur_tag);
3805 * Check the expiration date to see
3806 * if the cookie is still valid, if yes,
3807 * rewrite it to a session cookie.
3809 if ((strncmpic(cur_tag, "expires=", 8) == 0) && *(cur_tag + 8))
3811 char *expiration_date = cur_tag + 8; /* Skip "[Ee]xpires=" */
3813 /* Did we detect the date properly? */
3814 if (JB_ERR_OK != parse_header_time(expiration_date, &cookie_time))
3817 * Nope, treat it as if it was still valid.
3819 * XXX: Should we remove the whole cookie instead?
3821 log_error(LOG_LEVEL_ERROR,
3822 "Can't parse \'%s\', send by %s. Unsupported time format?", cur_tag, csp->http->url);
3823 string_move(cur_tag, next_tag);
3829 * Yes. Check if the cookie is still valid.
3831 * If the cookie is already expired it's probably
3832 * a delete cookie and even if it isn't, the browser
3833 * will discard it anyway.
3837 * XXX: timegm() isn't available on some AmigaOS
3838 * versions and our replacement doesn't work.
3840 * Our options are to either:
3842 * - disable session-cookies-only completely if timegm
3845 * - to simply remove all expired tags, like it has
3846 * been done until Privoxy 3.0.6 and to live with
3847 * the consequence that it can cause login/logout
3848 * problems on servers that don't validate their
3849 * input properly, or
3851 * - to replace it with mktime in which
3852 * case there is a slight chance of valid cookies
3853 * passing as already expired.
3855 * This is the way it's currently done and it's not
3856 * as bad as it sounds. If the missing GMT offset is
3857 * enough to change the result of the expiration check
3858 * the cookie will be only valid for a few hours
3859 * anyway, which in many cases will be shorter
3860 * than a browser session.
3862 if (cookie_time - now < 0)
3864 log_error(LOG_LEVEL_HEADER,
3865 "Cookie \'%s\' is already expired and can pass unmodified.", *header);
3866 /* Just in case some clown sets more then one expiration date */
3872 * Still valid, delete expiration date by copying
3873 * the rest of the string over it.
3875 string_move(cur_tag, next_tag);
3877 /* That changed the header, need to issue a log message */
3881 * Note that the next tag has now been moved to *cur_tag,
3882 * so we do not need to update the cur_tag pointer.
3890 /* Move on to next cookie tag */
3897 assert(NULL != *header);
3898 log_error(LOG_LEVEL_HEADER, "Cookie rewritten to a temporary one: %s",
3907 #ifdef FEATURE_FORCE_LOAD
3908 /*********************************************************************
3910 * Function : strclean
3912 * Description : In-Situ-Eliminate all occurances of substring in
3916 * 1 : string = string to clean
3917 * 2 : substring = substring to eliminate
3919 * Returns : Number of eliminations
3921 *********************************************************************/
3922 int strclean(char *string, const char *substring)
3928 len = strlen(substring);
3930 while((pos = strstr(string, substring)) != NULL)
3937 while (*p++ != '\0');
3944 #endif /* def FEATURE_FORCE_LOAD */
3947 /*********************************************************************
3949 * Function : parse_header_time
3951 * Description : Parses time formats used in HTTP header strings
3952 * to get the numerical respresentation.
3955 * 1 : header_time = HTTP header time as string.
3956 * 2 : result = storage for header_time in seconds
3958 * Returns : JB_ERR_OK if the time format was recognized, or
3959 * JB_ERR_PARSE otherwise.
3961 *********************************************************************/
3962 static jb_err parse_header_time(const char *header_time, time_t *result)
3967 * Zero out gmt to prevent time zone offsets.
3969 * While this is only necessary on some platforms
3970 * (mingw32 for example), I don't know how to
3971 * detect these automatically and doing it everywhere
3974 memset(&gmt, 0, sizeof(gmt));
3976 /* Tue, 02 Jun 2037 20:00:00 */
3977 if ((NULL == strptime(header_time, "%a, %d %b %Y %H:%M:%S", &gmt))
3978 /* Tue, 02-Jun-2037 20:00:00 */
3979 && (NULL == strptime(header_time, "%a, %d-%b-%Y %H:%M:%S", &gmt))
3980 /* Tue, 02-Jun-37 20:00:00 */
3981 && (NULL == strptime(header_time, "%a, %d-%b-%y %H:%M:%S", &gmt))
3982 /* Tuesday, 02-Jun-2037 20:00:00 */
3983 && (NULL == strptime(header_time, "%A, %d-%b-%Y %H:%M:%S", &gmt))
3984 /* Tuesday Jun 02 20:00:00 2037 */
3985 && (NULL == strptime(header_time, "%A %b %d %H:%M:%S %Y", &gmt)))
3987 return JB_ERR_PARSE;
3990 *result = timegm(&gmt);
3997 /*********************************************************************
3999 * Function : get_destination_from_headers
4001 * Description : Parse the "Host:" header to get the request's destination.
4002 * Only needed if the client's request was forcefully
4003 * redirected into Privoxy.
4005 * Code mainly copied from client_host() which is currently
4006 * run too late for this purpose.
4009 * 1 : headers = List of headers (one of them hopefully being
4010 * the "Host:" header)
4011 * 2 : http = storage for the result (host, port and hostport).
4013 * Returns : JB_ERR_MEMORY in case of memory problems,
4014 * JB_ERR_PARSE if the host header couldn't be found,
4015 * JB_ERR_OK otherwise.
4017 *********************************************************************/
4018 jb_err get_destination_from_headers(const struct list *headers, struct http_request *http)
4024 host = get_header_value(headers, "Host:");
4028 log_error(LOG_LEVEL_ERROR, "No \"Host:\" header found.");
4029 return JB_ERR_PARSE;
4032 if (NULL == (p = strdup((host))))
4034 log_error(LOG_LEVEL_ERROR, "Out of memory while parsing \"Host:\" header");
4035 return JB_ERR_MEMORY;
4038 if (NULL == (q = strdup(p)))
4041 log_error(LOG_LEVEL_ERROR, "Out of memory while parsing \"Host:\" header");
4042 return JB_ERR_MEMORY;
4045 freez(http->hostport);
4049 q = strchr(http->host, ':');
4052 /* Terminate hostname and evaluate port string */
4054 http->port = atoi(q);
4058 http->port = http->ssl ? 443 : 80;
4061 /* Rebuild request URL */
4063 http->url = strdup(http->ssl ? "https://" : "http://");
4064 string_append(&http->url, http->hostport);
4065 string_append(&http->url, http->path);
4066 if (http->url == NULL)
4068 return JB_ERR_MEMORY;
4071 log_error(LOG_LEVEL_HEADER, "Destination extracted from \"Host:\" header. New request URL: %s",
4079 /*********************************************************************
4081 * Function : create_forged_referrer
4083 * Description : Helper for client_referrer to forge a referer as
4084 * 'http://[hostname:port/' to fool stupid
4085 * checks for in-site links
4088 * 1 : header = Pointer to header pointer
4089 * 2 : hostport = Host and optionally port as string
4091 * Returns : JB_ERR_OK in case of success, or
4092 * JB_ERR_MEMORY in case of memory problems.
4094 *********************************************************************/
4095 static jb_err create_forged_referrer(char **header, const char *hostport)
4097 assert(NULL == *header);
4099 *header = strdup("Referer: http://");
4100 string_append(header, hostport);
4101 string_append(header, "/");
4103 if (NULL == *header)
4105 return JB_ERR_MEMORY;
4108 log_error(LOG_LEVEL_HEADER, "Referer forged to: %s", *header);
4115 /*********************************************************************
4117 * Function : create_fake_referrer
4119 * Description : Helper for client_referrer to create a fake referrer
4120 * based on a string supplied by the user.
4123 * 1 : header = Pointer to header pointer
4124 * 2 : hosthost = Referrer to fake
4126 * Returns : JB_ERR_OK in case of success, or
4127 * JB_ERR_MEMORY in case of memory problems.
4129 *********************************************************************/
4130 static jb_err create_fake_referrer(char **header, const char *fake_referrer)
4132 assert(NULL == *header);
4134 if ((0 != strncmpic(fake_referrer, "http://", 7)) && (0 != strncmpic(fake_referrer, "https://", 8)))
4136 log_error(LOG_LEVEL_HEADER,
4137 "Parameter: +hide-referrer{%s} is a bad idea, but I don't care.", fake_referrer);
4139 *header = strdup("Referer: ");
4140 string_append(header, fake_referrer);
4142 if (NULL == *header)
4144 return JB_ERR_MEMORY;
4147 log_error(LOG_LEVEL_HEADER, "Referer replaced with: %s", *header);
4154 /*********************************************************************
4156 * Function : handle_conditional_hide_referrer_parameter
4158 * Description : Helper for client_referrer to crunch or forge
4159 * the referrer header if the host has changed.
4162 * 1 : header = Pointer to header pointer
4163 * 2 : host = The target host (may include the port)
4164 * 3 : parameter_conditional_block = Boolean to signal
4165 * if we're in conditional-block mode. If not set,
4166 * we're in conditional-forge mode.
4168 * Returns : JB_ERR_OK in case of success, or
4169 * JB_ERR_MEMORY in case of memory problems.
4171 *********************************************************************/
4172 static jb_err handle_conditional_hide_referrer_parameter(char **header,
4173 const char *host, const int parameter_conditional_block)
4175 char *referer = strdup(*header);
4176 const size_t hostlenght = strlen(host);
4177 const char *referer_url = NULL;
4179 if (NULL == referer)
4182 return JB_ERR_MEMORY;
4185 /* referer begins with 'Referer: http[s]://' */
4186 if ((hostlenght+17) < strlen(referer))
4189 * Shorten referer to make sure the referer is blocked
4190 * if www.example.org/www.example.com-shall-see-the-referer/
4191 * links to www.example.com/
4193 referer[hostlenght+17] = '\0';
4195 referer_url = strstr(referer, "http://");
4196 if ((NULL == referer_url) || (NULL == strstr(referer_url, host)))
4198 /* Host has changed, Referer is invalid or a https URL. */
4199 if (parameter_conditional_block)
4201 log_error(LOG_LEVEL_HEADER, "New host is: %s. Crunching %s!", host, *header);
4208 return create_forged_referrer(header, host);
4218 /*********************************************************************
4220 * Function : create_content_length_header
4222 * Description : Creates a Content-Length header.
4225 * 1 : content_length = The content length to be used in the header.
4226 * 2 : header = Allocated space to safe the header.
4227 * 3 : buffer_length = The length of the allocated space.
4231 *********************************************************************/
4232 static void create_content_length_header(unsigned long long content_length,
4233 char *header, size_t buffer_length)
4235 snprintf(header, buffer_length, "Content-Length: %llu", content_length);