1 const char parsers_rcs[] = "$Id: parsers.c,v 1.210 2009/12/25 11:39:26 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 const size_t header_length = strlen(header);
1214 if (csp->flags & CSP_FLAG_CLIENT_HEADER_PARSING_DONE)
1216 wanted_filter_type = FT_SERVER_HEADER_TAGGER;
1217 multi_action_index = ACTION_MULTI_SERVER_HEADER_TAGGER;
1221 wanted_filter_type = FT_CLIENT_HEADER_TAGGER;
1222 multi_action_index = ACTION_MULTI_CLIENT_HEADER_TAGGER;
1225 if (filters_available(csp) == FALSE)
1227 log_error(LOG_LEVEL_ERROR, "Inconsistent configuration: "
1228 "tagging enabled, but no taggers available.");
1232 for (i = 0; i < MAX_AF_FILES; i++)
1235 if ((NULL == fl) || (NULL == fl->f))
1238 * Either there are no filter files
1239 * left, or this filter file just
1240 * contains no valid filters.
1242 * Continue to be sure we don't miss
1243 * valid filter files that are chained
1244 * after empty or invalid ones.
1249 /* For all filters, */
1250 for (b = fl->f; b; b = b->next)
1252 if (b->type != wanted_filter_type)
1254 /* skip the ones we don't care about, */
1257 /* leaving only taggers that could apply, of which we use the ones, */
1258 for (tag_name = csp->action->multi[multi_action_index]->first;
1259 NULL != tag_name; tag_name = tag_name->next)
1261 /* that do apply, and */
1262 if (strcmp(b->name, tag_name->str) == 0)
1264 char *modified_tag = NULL;
1266 size_t size = header_length;
1267 pcrs_job *joblist = b->joblist;
1269 if (b->dynamic) joblist = compile_dynamic_pcrs_job_list(csp, b);
1271 if (NULL == joblist)
1273 log_error(LOG_LEVEL_RE_FILTER,
1274 "Tagger %s has empty joblist. Nothing to do.", b->name);
1278 /* execute their pcrs_joblist on the header. */
1279 for (job = joblist; NULL != job; job = job->next)
1281 const int hits = pcrs_execute(job, tag, size, &modified_tag, &size);
1285 /* Success, continue with the modified version. */
1294 /* Tagger doesn't match */
1297 /* Regex failure, log it but continue anyway. */
1298 assert(NULL != header);
1299 log_error(LOG_LEVEL_ERROR,
1300 "Problems with tagger \'%s\' and header \'%s\': %s",
1301 b->name, *header, pcrs_strerror(hits));
1303 freez(modified_tag);
1307 if (b->dynamic) pcrs_free_joblist(joblist);
1309 /* If this tagger matched */
1315 * There is to technical limitation which makes
1316 * it impossible to use empty tags, but I assume
1317 * no one would do it intentionally.
1320 log_error(LOG_LEVEL_INFO,
1321 "Tagger \'%s\' created an empty tag. Ignored.",
1326 if (!list_contains_item(csp->tags, tag))
1328 if (JB_ERR_OK != enlist(csp->tags, tag))
1330 log_error(LOG_LEVEL_ERROR,
1331 "Insufficient memory to add tag \'%s\', "
1332 "based on tagger \'%s\' and header \'%s\'",
1333 tag, b->name, *header);
1337 char *action_message;
1339 * update the action bits right away, to make
1340 * tagging based on tags set by earlier taggers
1341 * of the same kind possible.
1343 if (update_action_bits_for_tag(csp, tag))
1345 action_message = "Action bits updated accordingly.";
1349 action_message = "No action bits update necessary.";
1352 log_error(LOG_LEVEL_HEADER,
1353 "Tagger \'%s\' added tag \'%s\'. %s",
1354 b->name, tag, action_message);
1359 /* XXX: Is this log-worthy? */
1360 log_error(LOG_LEVEL_HEADER,
1361 "Tagger \'%s\' didn't add tag \'%s\'. "
1362 "Tag already present", b->name, tag);
1365 } /* if the tagger matched */
1366 } /* if the tagger applies */
1367 } /* for every tagger that could apply */
1368 } /* for all filters */
1369 } /* for all filter files */
1374 /* here begins the family of parser functions that reformat header lines */
1376 /*********************************************************************
1378 * Function : filter_header
1380 * Description : Executes all text substitutions from all applying
1381 * +(server|client)-header-filter actions on the header.
1382 * Most of the code was copied from pcrs_filter_response,
1383 * including the rather short variable names
1386 * 1 : csp = Current client state (buffers, headers, etc...)
1387 * 2 : header = On input, pointer to header to modify.
1388 * On output, pointer to the modified header, or NULL
1389 * to remove the header. This function frees the
1390 * original string if necessary.
1392 * Returns : JB_ERR_OK on success and always succeeds
1394 *********************************************************************/
1395 static jb_err filter_header(struct client_state *csp, char **header)
1399 size_t size = strlen(*header);
1401 char *newheader = NULL;
1404 struct file_list *fl;
1405 struct re_filterfile_spec *b;
1406 struct list_entry *filtername;
1409 int wanted_filter_type;
1410 int multi_action_index;
1412 if (csp->flags & CSP_FLAG_NO_FILTERING)
1417 if (csp->flags & CSP_FLAG_CLIENT_HEADER_PARSING_DONE)
1419 wanted_filter_type = FT_SERVER_HEADER_FILTER;
1420 multi_action_index = ACTION_MULTI_SERVER_HEADER_FILTER;
1424 wanted_filter_type = FT_CLIENT_HEADER_FILTER;
1425 multi_action_index = ACTION_MULTI_CLIENT_HEADER_FILTER;
1428 if (filters_available(csp) == FALSE)
1430 log_error(LOG_LEVEL_ERROR, "Inconsistent configuration: "
1431 "header filtering enabled, but no matching filters available.");
1435 for (i = 0; i < MAX_AF_FILES; i++)
1438 if ((NULL == fl) || (NULL == fl->f))
1441 * Either there are no filter files
1442 * left, or this filter file just
1443 * contains no valid filters.
1445 * Continue to be sure we don't miss
1446 * valid filter files that are chained
1447 * after empty or invalid ones.
1452 * For all applying +filter actions, look if a filter by that
1453 * name exists and if yes, execute its pcrs_joblist on the
1456 for (b = fl->f; b; b = b->next)
1458 if (b->type != wanted_filter_type)
1460 /* Skip other filter types */
1464 for (filtername = csp->action->multi[multi_action_index]->first;
1465 filtername ; filtername = filtername->next)
1467 if (strcmp(b->name, filtername->str) == 0)
1469 int current_hits = 0;
1470 pcrs_job *joblist = b->joblist;
1472 if (b->dynamic) joblist = compile_dynamic_pcrs_job_list(csp, b);
1474 if (NULL == joblist)
1476 log_error(LOG_LEVEL_RE_FILTER, "Filter %s has empty joblist. Nothing to do.", b->name);
1480 log_error(LOG_LEVEL_RE_FILTER, "filtering \'%s\' (size %d) with \'%s\' ...",
1481 *header, size, b->name);
1483 /* Apply all jobs from the joblist */
1484 for (job = joblist; NULL != job; job = job->next)
1486 matches = pcrs_execute(job, *header, size, &newheader, &size);
1489 current_hits += matches;
1490 log_error(LOG_LEVEL_HEADER, "Transforming \"%s\" to \"%s\"", *header, newheader);
1492 *header = newheader;
1494 else if ( 0 == matches )
1496 /* Filter doesn't change header */
1502 log_error(LOG_LEVEL_ERROR, "Filtering \'%s\' with \'%s\' didn't work out: %s",
1503 *header, b->name, pcrs_strerror(matches));
1504 if (newheader != NULL)
1506 log_error(LOG_LEVEL_ERROR, "Freeing what's left: %s", newheader);
1512 if (b->dynamic) pcrs_free_joblist(joblist);
1514 log_error(LOG_LEVEL_RE_FILTER, "... produced %d hits (new size %d).", current_hits, size);
1515 hits += current_hits;
1522 * Additionally checking for hits is important because if
1523 * the continue hack is triggered, server headers can
1524 * arrive empty to separate multiple heads from each other.
1526 if ((0 == size) && hits)
1528 log_error(LOG_LEVEL_HEADER, "Removing empty header %s", *header);
1536 /*********************************************************************
1538 * Function : server_connection
1540 * Description : Makes sure a proper "Connection:" header is
1541 * set and signals connection_header_adder to
1545 * 1 : csp = Current client state (buffers, headers, etc...)
1546 * 2 : header = On input, pointer to header to modify.
1547 * On output, pointer to the modified header, or NULL
1548 * to remove the header. This function frees the
1549 * original string if necessary.
1551 * Returns : JB_ERR_OK on success, or
1552 * JB_ERR_MEMORY on out-of-memory error.
1554 *********************************************************************/
1555 static jb_err server_connection(struct client_state *csp, char **header)
1557 if (!strcmpic(*header, "Connection: keep-alive")
1558 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1559 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
1563 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1564 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE))
1566 csp->flags |= CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE;
1569 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
1571 log_error(LOG_LEVEL_HEADER,
1572 "Keeping the server header '%s' around.", *header);
1575 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1577 char *old_header = *header;
1579 *header = strdup("Connection: close");
1582 return JB_ERR_MEMORY;
1584 log_error(LOG_LEVEL_HEADER, "Replaced: \'%s\' with \'%s\'", old_header, *header);
1589 /* Signal server_connection_adder() to return early. */
1590 csp->flags |= CSP_FLAG_SERVER_CONNECTION_HEADER_SET;
1596 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1597 /*********************************************************************
1599 * Function : server_keep_alive
1601 * Description : Stores the server's keep alive timeout.
1604 * 1 : csp = Current client state (buffers, headers, etc...)
1605 * 2 : header = On input, pointer to header to modify.
1606 * On output, pointer to the modified header, or NULL
1607 * to remove the header. This function frees the
1608 * original string if necessary.
1610 * Returns : JB_ERR_OK.
1612 *********************************************************************/
1613 static jb_err server_keep_alive(struct client_state *csp, char **header)
1615 unsigned int keep_alive_timeout;
1616 const char *timeout_position = strstr(*header, "timeout=");
1618 if ((NULL == timeout_position)
1619 || (1 != sscanf(timeout_position, "timeout=%u", &keep_alive_timeout)))
1621 log_error(LOG_LEVEL_ERROR, "Couldn't parse: %s", *header);
1625 if (keep_alive_timeout < csp->server_connection.keep_alive_timeout)
1627 log_error(LOG_LEVEL_HEADER,
1628 "Reducing keep-alive timeout from %u to %u.",
1629 csp->server_connection.keep_alive_timeout, keep_alive_timeout);
1630 csp->server_connection.keep_alive_timeout = keep_alive_timeout;
1634 /* XXX: Is this log worthy? */
1635 log_error(LOG_LEVEL_HEADER,
1636 "Server keep-alive timeout is %u. Sticking with %u.",
1637 keep_alive_timeout, csp->server_connection.keep_alive_timeout);
1639 csp->flags |= CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET;
1646 /*********************************************************************
1648 * Function : server_proxy_connection
1650 * Description : Figures out whether or not we should add a
1651 * Proxy-Connection header.
1654 * 1 : csp = Current client state (buffers, headers, etc...)
1655 * 2 : header = On input, pointer to header to modify.
1656 * On output, pointer to the modified header, or NULL
1657 * to remove the header. This function frees the
1658 * original string if necessary.
1660 * Returns : JB_ERR_OK.
1662 *********************************************************************/
1663 static jb_err server_proxy_connection(struct client_state *csp, char **header)
1665 csp->flags |= CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET;
1670 /*********************************************************************
1672 * Function : client_keep_alive
1674 * Description : Stores the client's keep alive timeout.
1677 * 1 : csp = Current client state (buffers, headers, etc...)
1678 * 2 : header = On input, pointer to header to modify.
1679 * On output, pointer to the modified header, or NULL
1680 * to remove the header. This function frees the
1681 * original string if necessary.
1683 * Returns : JB_ERR_OK.
1685 *********************************************************************/
1686 static jb_err client_keep_alive(struct client_state *csp, char **header)
1688 unsigned int keep_alive_timeout;
1689 const char *timeout_position = strstr(*header, ": ");
1691 if (!(csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE))
1693 log_error(LOG_LEVEL_HEADER,
1694 "keep-alive support is disabled. Crunching: %s.", *header);
1699 if ((NULL == timeout_position)
1700 || (1 != sscanf(timeout_position, ": %u", &keep_alive_timeout)))
1702 log_error(LOG_LEVEL_ERROR, "Couldn't parse: %s", *header);
1706 if (keep_alive_timeout < csp->config->keep_alive_timeout)
1708 log_error(LOG_LEVEL_HEADER,
1709 "Reducing keep-alive timeout from %u to %u.",
1710 csp->config->keep_alive_timeout, keep_alive_timeout);
1711 csp->server_connection.keep_alive_timeout = keep_alive_timeout;
1715 /* XXX: Is this log worthy? */
1716 log_error(LOG_LEVEL_HEADER,
1717 "Client keep-alive timeout is %u. Sticking with %u.",
1718 keep_alive_timeout, csp->config->keep_alive_timeout);
1726 /*********************************************************************
1728 * Function : get_content_length
1730 * Description : Gets the content length specified in a
1731 * Content-Length header.
1734 * 1 : header = The Content-Length header.
1735 * 2 : length = Storage to return the value.
1737 * Returns : JB_ERR_OK on success, or
1738 * JB_ERR_PARSE if no value is recognized.
1740 *********************************************************************/
1741 static jb_err get_content_length(const char *header, unsigned long long *length)
1743 assert(header[14] == ':');
1746 assert(sizeof(unsigned long long) > 4);
1747 if (1 != sscanf(header+14, ": %I64u", length))
1749 if (1 != sscanf(header+14, ": %llu", length))
1752 return JB_ERR_PARSE;
1759 /*********************************************************************
1761 * Function : client_save_content_length
1763 * Description : Save the Content-Length sent by the client.
1766 * 1 : csp = Current client state (buffers, headers, etc...)
1767 * 2 : header = On input, pointer to header to modify.
1768 * On output, pointer to the modified header, or NULL
1769 * to remove the header. This function frees the
1770 * original string if necessary.
1772 * Returns : JB_ERR_OK on success, or
1773 * JB_ERR_MEMORY on out-of-memory error.
1775 *********************************************************************/
1776 static jb_err client_save_content_length(struct client_state *csp, char **header)
1778 unsigned long long content_length = 0;
1780 assert(*(*header+14) == ':');
1782 if (JB_ERR_OK != get_content_length(*header, &content_length))
1784 log_error(LOG_LEVEL_ERROR, "Crunching invalid header: %s", *header);
1789 csp->expected_client_content_length = content_length;
1794 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1798 /*********************************************************************
1800 * Function : client_connection
1802 * Description : Makes sure a proper "Connection:" header is
1803 * set and signals connection_header_adder
1807 * 1 : csp = Current client state (buffers, headers, etc...)
1808 * 2 : header = On input, pointer to header to modify.
1809 * On output, pointer to the modified header, or NULL
1810 * to remove the header. This function frees the
1811 * original string if necessary.
1813 * Returns : JB_ERR_OK on success, or
1814 * JB_ERR_MEMORY on out-of-memory error.
1816 *********************************************************************/
1817 static jb_err client_connection(struct client_state *csp, char **header)
1819 static const char connection_close[] = "Connection: close";
1821 if (!strcmpic(*header, connection_close))
1823 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1824 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING))
1826 if (!strcmpic(csp->http->ver, "HTTP/1.1"))
1828 log_error(LOG_LEVEL_HEADER,
1829 "Removing \'%s\' to imply keep-alive.", *header);
1834 char *old_header = *header;
1836 *header = strdup("Connection: keep-alive");
1839 return JB_ERR_MEMORY;
1841 log_error(LOG_LEVEL_HEADER,
1842 "Replaced: \'%s\' with \'%s\'", old_header, *header);
1848 log_error(LOG_LEVEL_HEADER,
1849 "Keeping the client header '%s' around. "
1850 "The connection will not be kept alive.",
1852 csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1855 else if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE))
1857 log_error(LOG_LEVEL_HEADER,
1858 "Keeping the client header '%s' around. "
1859 "The server connection will be kept alive if possible.",
1861 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1862 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1866 char *old_header = *header;
1868 *header = strdup(connection_close);
1871 return JB_ERR_MEMORY;
1873 log_error(LOG_LEVEL_HEADER,
1874 "Replaced: \'%s\' with \'%s\'", old_header, *header);
1878 /* Signal client_connection_adder() to return early. */
1879 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_HEADER_SET;
1885 /*********************************************************************
1887 * Function : crumble
1889 * Description : This is called if a header matches a pattern to "crunch"
1892 * 1 : csp = Current client state (buffers, headers, etc...)
1893 * 2 : header = On input, pointer to header to modify.
1894 * On output, pointer to the modified header, or NULL
1895 * to remove the header. This function frees the
1896 * original string if necessary.
1898 * Returns : JB_ERR_OK on success, or
1899 * JB_ERR_MEMORY on out-of-memory error.
1901 *********************************************************************/
1902 static jb_err crumble(struct client_state *csp, char **header)
1905 log_error(LOG_LEVEL_HEADER, "crumble crunched: %s!", *header);
1911 /*********************************************************************
1913 * Function : crunch_server_header
1915 * Description : Crunch server header if it matches a string supplied by the
1916 * user. Called from `sed'.
1919 * 1 : csp = Current client state (buffers, headers, etc...)
1920 * 2 : header = On input, pointer to header to modify.
1921 * On output, pointer to the modified header, or NULL
1922 * to remove the header. This function frees the
1923 * original string if necessary.
1925 * Returns : JB_ERR_OK on success and always succeeds
1927 *********************************************************************/
1928 static jb_err crunch_server_header(struct client_state *csp, char **header)
1930 const char *crunch_pattern;
1932 /* Do we feel like crunching? */
1933 if ((csp->action->flags & ACTION_CRUNCH_SERVER_HEADER))
1935 crunch_pattern = csp->action->string[ACTION_STRING_SERVER_HEADER];
1937 /* Is the current header the lucky one? */
1938 if (strstr(*header, crunch_pattern))
1940 log_error(LOG_LEVEL_HEADER, "Crunching server header: %s (contains: %s)", *header, crunch_pattern);
1949 /*********************************************************************
1951 * Function : server_content_type
1953 * Description : Set the content-type for filterable types (text/.*,
1954 * .*xml.*, javascript and image/gif) unless filtering has been
1955 * forbidden (CT_TABOO) while parsing earlier headers.
1956 * NOTE: Since text/plain is commonly used by web servers
1957 * for files whose correct type is unknown, we don't
1958 * set CT_TEXT for it.
1961 * 1 : csp = Current client state (buffers, headers, etc...)
1962 * 2 : header = On input, pointer to header to modify.
1963 * On output, pointer to the modified header, or NULL
1964 * to remove the header. This function frees the
1965 * original string if necessary.
1967 * Returns : JB_ERR_OK on success, or
1968 * JB_ERR_MEMORY on out-of-memory error.
1970 *********************************************************************/
1971 static jb_err server_content_type(struct client_state *csp, char **header)
1973 /* Remove header if it isn't the first Content-Type header */
1974 if ((csp->content_type & CT_DECLARED))
1977 * Another, slightly slower, way to see if
1978 * we already parsed another Content-Type header.
1980 assert(NULL != get_header_value(csp->headers, "Content-Type:"));
1982 log_error(LOG_LEVEL_ERROR,
1983 "Multiple Content-Type headers. Removing and ignoring: \'%s\'",
1991 * Signal that the Content-Type has been set.
1993 csp->content_type |= CT_DECLARED;
1995 if (!(csp->content_type & CT_TABOO))
1998 * XXX: The assumption that text/plain is a sign of
1999 * binary data seems to be somewhat unreasonable nowadays
2000 * and should be dropped after 3.0.8 is out.
2002 if ((strstr(*header, "text/") && !strstr(*header, "plain"))
2003 || strstr(*header, "xml")
2004 || strstr(*header, "application/x-javascript"))
2006 csp->content_type |= CT_TEXT;
2008 else if (strstr(*header, "image/gif"))
2010 csp->content_type |= CT_GIF;
2015 * Are we messing with the content type?
2017 if (csp->action->flags & ACTION_CONTENT_TYPE_OVERWRITE)
2020 * Make sure the user doesn't accidently
2021 * change the content type of binary documents.
2023 if ((csp->content_type & CT_TEXT) || (csp->action->flags & ACTION_FORCE_TEXT_MODE))
2026 *header = strdup("Content-Type: ");
2027 string_append(header, csp->action->string[ACTION_STRING_CONTENT_TYPE]);
2031 log_error(LOG_LEVEL_HEADER, "Insufficient memory to replace Content-Type!");
2032 return JB_ERR_MEMORY;
2034 log_error(LOG_LEVEL_HEADER, "Modified: %s!", *header);
2038 log_error(LOG_LEVEL_HEADER, "%s not replaced. "
2039 "It doesn't look like a content type that should be filtered. "
2040 "Enable force-text-mode if you know what you're doing.", *header);
2048 /*********************************************************************
2050 * Function : server_transfer_coding
2052 * Description : - Prohibit filtering (CT_TABOO) if transfer coding compresses
2053 * - Raise the CSP_FLAG_CHUNKED flag if coding is "chunked"
2054 * - Remove header if body was chunked but has been
2055 * de-chunked for filtering.
2058 * 1 : csp = Current client state (buffers, headers, etc...)
2059 * 2 : header = On input, pointer to header to modify.
2060 * On output, pointer to the modified header, or NULL
2061 * to remove the header. This function frees the
2062 * original string if necessary.
2064 * Returns : JB_ERR_OK on success, or
2065 * JB_ERR_MEMORY on out-of-memory error.
2067 *********************************************************************/
2068 static jb_err server_transfer_coding(struct client_state *csp, char **header)
2071 * Turn off pcrs and gif filtering if body compressed
2073 if (strstr(*header, "gzip") || strstr(*header, "compress") || strstr(*header, "deflate"))
2077 * XXX: Added to test if we could use CT_GZIP and CT_DEFLATE here.
2079 log_error(LOG_LEVEL_INFO, "Marking content type for %s as CT_TABOO because of %s.",
2080 csp->http->cmd, *header);
2081 #endif /* def FEATURE_ZLIB */
2082 csp->content_type = CT_TABOO;
2086 * Raise flag if body chunked
2088 if (strstr(*header, "chunked"))
2090 csp->flags |= CSP_FLAG_CHUNKED;
2093 * If the body was modified, it has been de-chunked first
2094 * and the header must be removed.
2096 * FIXME: If there is more than one transfer encoding,
2097 * only the "chunked" part should be removed here.
2099 if (csp->flags & CSP_FLAG_MODIFIED)
2101 log_error(LOG_LEVEL_HEADER, "Removing: %s", *header);
2110 /*********************************************************************
2112 * Function : server_content_encoding
2114 * Description : This function is run twice for each request,
2115 * unless FEATURE_ZLIB and filtering are disabled.
2117 * The first run is used to check if the content
2118 * is compressed, if FEATURE_ZLIB is disabled
2119 * filtering is then disabled as well, if FEATURE_ZLIB
2120 * is enabled the content is marked for decompression.
2122 * The second run is used to remove the Content-Encoding
2123 * header if the decompression was successful.
2126 * 1 : csp = Current client state (buffers, headers, etc...)
2127 * 2 : header = On input, pointer to header to modify.
2128 * On output, pointer to the modified header, or NULL
2129 * to remove the header. This function frees the
2130 * original string if necessary.
2132 * Returns : JB_ERR_OK on success, or
2133 * JB_ERR_MEMORY on out-of-memory error.
2135 *********************************************************************/
2136 static jb_err server_content_encoding(struct client_state *csp, char **header)
2139 if ((csp->flags & CSP_FLAG_MODIFIED)
2140 && (csp->content_type & (CT_GZIP | CT_DEFLATE)))
2143 * We successfully decompressed the content,
2144 * and have to clean the header now, so the
2145 * client no longer expects compressed data..
2147 * XXX: There is a difference between cleaning
2148 * and removing it completely.
2150 log_error(LOG_LEVEL_HEADER, "Crunching: %s", *header);
2153 else if (strstr(*header, "gzip"))
2155 /* Mark for gzip decompression */
2156 csp->content_type |= CT_GZIP;
2158 else if (strstr(*header, "deflate"))
2160 /* Mark for zlib decompression */
2161 csp->content_type |= CT_DEFLATE;
2163 else if (strstr(*header, "compress"))
2166 * We can't decompress this; therefore we can't filter
2169 csp->content_type |= CT_TABOO;
2171 #else /* !defined(FEATURE_ZLIB) */
2172 if (strstr(*header, "gzip") || strstr(*header, "compress") || strstr(*header, "deflate"))
2175 * Body is compressed, turn off pcrs and gif filtering.
2177 csp->content_type |= CT_TABOO;
2180 * Log a warning if the user expects the content to be filtered.
2182 if ((csp->rlist != NULL) &&
2183 (!list_is_empty(csp->action->multi[ACTION_MULTI_FILTER])))
2185 log_error(LOG_LEVEL_INFO,
2186 "Compressed content detected, content filtering disabled. "
2187 "Consider recompiling Privoxy with zlib support or "
2188 "enable the prevent-compression action.");
2191 #endif /* defined(FEATURE_ZLIB) */
2198 /*********************************************************************
2200 * Function : server_adjust_content_length
2202 * Description : Adjust Content-Length header if we modified
2206 * 1 : csp = Current client state (buffers, headers, etc...)
2207 * 2 : header = On input, pointer to header to modify.
2208 * On output, pointer to the modified header, or NULL
2209 * to remove the header. This function frees the
2210 * original string if necessary.
2212 * Returns : JB_ERR_OK on success, or
2213 * JB_ERR_MEMORY on out-of-memory error.
2215 *********************************************************************/
2216 static jb_err server_adjust_content_length(struct client_state *csp, char **header)
2218 /* Regenerate header if the content was modified. */
2219 if (csp->flags & CSP_FLAG_MODIFIED)
2221 const size_t header_length = 50;
2223 *header = malloc(header_length);
2224 if (*header == NULL)
2226 return JB_ERR_MEMORY;
2228 create_content_length_header(csp->content_length, *header, header_length);
2229 log_error(LOG_LEVEL_HEADER,
2230 "Adjusted Content-Length to %llu", csp->content_length);
2237 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2238 /*********************************************************************
2240 * Function : server_save_content_length
2242 * Description : Save the Content-Length sent by the server.
2245 * 1 : csp = Current client state (buffers, headers, etc...)
2246 * 2 : header = On input, pointer to header to modify.
2247 * On output, pointer to the modified header, or NULL
2248 * to remove the header. This function frees the
2249 * original string if necessary.
2251 * Returns : JB_ERR_OK on success, or
2252 * JB_ERR_MEMORY on out-of-memory error.
2254 *********************************************************************/
2255 static jb_err server_save_content_length(struct client_state *csp, char **header)
2257 unsigned long long content_length = 0;
2259 assert(*(*header+14) == ':');
2261 if (JB_ERR_OK != get_content_length(*header, &content_length))
2263 log_error(LOG_LEVEL_ERROR, "Crunching invalid header: %s", *header);
2268 csp->expected_content_length = content_length;
2269 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
2270 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2275 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2278 /*********************************************************************
2280 * Function : server_content_md5
2282 * Description : Crumble any Content-MD5 headers if the document was
2283 * modified. FIXME: Should we re-compute instead?
2286 * 1 : csp = Current client state (buffers, headers, etc...)
2287 * 2 : header = On input, pointer to header to modify.
2288 * On output, pointer to the modified header, or NULL
2289 * to remove the header. This function frees the
2290 * original string if necessary.
2292 * Returns : JB_ERR_OK on success, or
2293 * JB_ERR_MEMORY on out-of-memory error.
2295 *********************************************************************/
2296 static jb_err server_content_md5(struct client_state *csp, char **header)
2298 if (csp->flags & CSP_FLAG_MODIFIED)
2300 log_error(LOG_LEVEL_HEADER, "Crunching Content-MD5");
2308 /*********************************************************************
2310 * Function : server_content_disposition
2312 * Description : If enabled, blocks or modifies the "Content-Disposition" header.
2313 * Called from `sed'.
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_disposition(struct client_state *csp, char **header)
2331 * Are we messing with the Content-Disposition header?
2333 if ((csp->action->flags & ACTION_HIDE_CONTENT_DISPOSITION) == 0)
2339 newval = csp->action->string[ACTION_STRING_CONTENT_DISPOSITION];
2341 if ((newval == NULL) || (0 == strcmpic(newval, "block")))
2344 * Blocking content-disposition header
2346 log_error(LOG_LEVEL_HEADER, "Crunching %s!", *header);
2353 * Replacing Content-Disposition header
2356 *header = strdup("Content-Disposition: ");
2357 string_append(header, newval);
2359 if (*header != NULL)
2361 log_error(LOG_LEVEL_HEADER,
2362 "Content-Disposition header crunched and replaced with: %s", *header);
2365 return (*header == NULL) ? JB_ERR_MEMORY : JB_ERR_OK;
2369 /*********************************************************************
2371 * Function : server_last_modified
2373 * Description : Changes Last-Modified header to the actual date
2374 * to help hide-if-modified-since.
2375 * Called from `sed'.
2378 * 1 : csp = Current client state (buffers, headers, etc...)
2379 * 2 : header = On input, pointer to header to modify.
2380 * On output, pointer to the modified header, or NULL
2381 * to remove the header. This function frees the
2382 * original string if necessary.
2384 * Returns : JB_ERR_OK on success, or
2385 * JB_ERR_MEMORY on out-of-memory error.
2387 *********************************************************************/
2388 static jb_err server_last_modified(struct client_state *csp, char **header)
2391 char buf[BUFFER_SIZE];
2394 #ifdef HAVE_GMTIME_R
2397 struct tm *timeptr = NULL;
2398 time_t now, last_modified;
2399 long int days, hours, minutes, seconds;
2402 * Are we messing with the Last-Modified header?
2404 if ((csp->action->flags & ACTION_OVERWRITE_LAST_MODIFIED) == 0)
2410 newval = csp->action->string[ACTION_STRING_LAST_MODIFIED];
2412 if (0 == strcmpic(newval, "block") )
2415 * Blocking Last-Modified header. Useless but why not.
2417 log_error(LOG_LEVEL_HEADER, "Crunching %s!", *header);
2421 else if (0 == strcmpic(newval, "reset-to-request-time"))
2424 * Setting Last-Modified Header to now.
2426 get_http_time(0, buf, sizeof(buf));
2428 *header = strdup("Last-Modified: ");
2429 string_append(header, buf);
2431 if (*header == NULL)
2433 log_error(LOG_LEVEL_HEADER, "Insufficient memory. Last-Modified header got lost, boohoo.");
2437 log_error(LOG_LEVEL_HEADER, "Reset to present time: %s", *header);
2440 else if (0 == strcmpic(newval, "randomize"))
2442 const char *header_time = *header + sizeof("Last-Modified:");
2444 log_error(LOG_LEVEL_HEADER, "Randomizing: %s", *header);
2446 #ifdef HAVE_GMTIME_R
2447 gmtime_r(&now, &gmt);
2448 #elif defined(MUTEX_LOCKS_AVAILABLE)
2449 privoxy_mutex_lock(&gmtime_mutex);
2451 privoxy_mutex_unlock(&gmtime_mutex);
2455 if (JB_ERR_OK != parse_header_time(header_time, &last_modified))
2457 log_error(LOG_LEVEL_HEADER, "Couldn't parse: %s in %s (crunching!)", header_time, *header);
2462 long int rtime = (long int)difftime(now, last_modified);
2465 const int negative_delta = (rtime < 0);
2470 log_error(LOG_LEVEL_HEADER, "Server time in the future.");
2472 rtime = pick_from_range(rtime);
2477 last_modified += rtime;
2478 #ifdef HAVE_GMTIME_R
2479 timeptr = gmtime_r(&last_modified, &gmt);
2480 #elif defined(MUTEX_LOCKS_AVAILABLE)
2481 privoxy_mutex_lock(&gmtime_mutex);
2482 timeptr = gmtime(&last_modified);
2483 privoxy_mutex_unlock(&gmtime_mutex);
2485 timeptr = gmtime(&last_modified);
2487 if ((NULL == timeptr) || !strftime(newheader,
2488 sizeof(newheader), "%a, %d %b %Y %H:%M:%S GMT", timeptr))
2490 log_error(LOG_LEVEL_ERROR,
2491 "Randomizing '%s' failed. Crunching the header without replacement.",
2498 *header = strdup("Last-Modified: ");
2499 string_append(header, newheader);
2501 if (*header == NULL)
2503 log_error(LOG_LEVEL_ERROR, "Insufficient memory, header crunched without replacement.");
2504 return JB_ERR_MEMORY;
2507 days = rtime / (3600 * 24);
2508 hours = rtime / 3600 % 24;
2509 minutes = rtime / 60 % 60;
2510 seconds = rtime % 60;
2512 log_error(LOG_LEVEL_HEADER,
2513 "Randomized: %s (added %d da%s %d hou%s %d minut%s %d second%s",
2514 *header, days, (days == 1) ? "y" : "ys", hours, (hours == 1) ? "r" : "rs",
2515 minutes, (minutes == 1) ? "e" : "es", seconds, (seconds == 1) ? ")" : "s)");
2519 log_error(LOG_LEVEL_HEADER, "Randomized ... or not. No time difference to work with.");
2528 /*********************************************************************
2530 * Function : client_accept_encoding
2532 * Description : Rewrite the client's Accept-Encoding header so that
2533 * if doesn't allow compression, if the action applies.
2534 * Note: For HTTP/1.0 the absence of the header is enough.
2537 * 1 : csp = Current client state (buffers, headers, etc...)
2538 * 2 : header = On input, pointer to header to modify.
2539 * On output, pointer to the modified header, or NULL
2540 * to remove the header. This function frees the
2541 * original string if necessary.
2543 * Returns : JB_ERR_OK on success, or
2544 * JB_ERR_MEMORY on out-of-memory error.
2546 *********************************************************************/
2547 static jb_err client_accept_encoding(struct client_state *csp, char **header)
2549 if ((csp->action->flags & ACTION_NO_COMPRESSION) != 0)
2551 log_error(LOG_LEVEL_HEADER, "Suppressed offer to compress content");
2555 /* Temporarily disable the correct behaviour to
2556 * work around a PHP bug.
2558 * if (!strcmpic(csp->http->ver, "HTTP/1.1"))
2560 * *header = strdup("Accept-Encoding: identity;q=1.0, *;q=0");
2561 * if (*header == NULL)
2563 * return JB_ERR_MEMORY;
2574 /*********************************************************************
2576 * Function : client_te
2578 * Description : Rewrite the client's TE header so that
2579 * if doesn't allow compression, if the action applies.
2582 * 1 : csp = Current client state (buffers, headers, etc...)
2583 * 2 : header = On input, pointer to header to modify.
2584 * On output, pointer to the modified header, or NULL
2585 * to remove the header. This function frees the
2586 * original string if necessary.
2588 * Returns : JB_ERR_OK on success, or
2589 * JB_ERR_MEMORY on out-of-memory error.
2591 *********************************************************************/
2592 static jb_err client_te(struct client_state *csp, char **header)
2594 if ((csp->action->flags & ACTION_NO_COMPRESSION) != 0)
2597 log_error(LOG_LEVEL_HEADER, "Suppressed offer to compress transfer");
2604 /*********************************************************************
2606 * Function : client_referrer
2608 * Description : Handle the "referer" config setting properly.
2609 * Called from `sed'.
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_referrer(struct client_state *csp, char **header)
2624 const char *parameter;
2625 /* booleans for parameters we have to check multiple times */
2626 int parameter_conditional_block;
2627 int parameter_conditional_forge;
2629 #ifdef FEATURE_FORCE_LOAD
2631 * Since the referrer can include the prefix even
2632 * if the request itself is non-forced, we must
2633 * clean it unconditionally.
2635 * XXX: strclean is too broad
2637 strclean(*header, FORCE_PREFIX);
2638 #endif /* def FEATURE_FORCE_LOAD */
2640 if ((csp->action->flags & ACTION_HIDE_REFERER) == 0)
2642 /* Nothing left to do */
2646 parameter = csp->action->string[ACTION_STRING_REFERER];
2647 assert(parameter != NULL);
2648 parameter_conditional_block = (0 == strcmpic(parameter, "conditional-block"));
2649 parameter_conditional_forge = (0 == strcmpic(parameter, "conditional-forge"));
2651 if (!parameter_conditional_block && !parameter_conditional_forge)
2654 * As conditional-block and conditional-forge are the only
2655 * parameters that rely on the original referrer, we can
2656 * remove it now for all the others.
2661 if (0 == strcmpic(parameter, "block"))
2663 log_error(LOG_LEVEL_HEADER, "Referer crunched!");
2666 else if (parameter_conditional_block || parameter_conditional_forge)
2668 return handle_conditional_hide_referrer_parameter(header,
2669 csp->http->hostport, parameter_conditional_block);
2671 else if (0 == strcmpic(parameter, "forge"))
2673 return create_forged_referrer(header, csp->http->hostport);
2677 /* interpret parameter as user-supplied referer to fake */
2678 return create_fake_referrer(header, parameter);
2683 /*********************************************************************
2685 * Function : client_accept_language
2687 * Description : Handle the "Accept-Language" config setting properly.
2688 * Called from `sed'.
2691 * 1 : csp = Current client state (buffers, headers, etc...)
2692 * 2 : header = On input, pointer to header to modify.
2693 * On output, pointer to the modified header, or NULL
2694 * to remove the header. This function frees the
2695 * original string if necessary.
2697 * Returns : JB_ERR_OK on success, or
2698 * JB_ERR_MEMORY on out-of-memory error.
2700 *********************************************************************/
2701 static jb_err client_accept_language(struct client_state *csp, char **header)
2706 * Are we messing with the Accept-Language?
2708 if ((csp->action->flags & ACTION_HIDE_ACCEPT_LANGUAGE) == 0)
2710 /*I don't think so*/
2714 newval = csp->action->string[ACTION_STRING_LANGUAGE];
2716 if ((newval == NULL) || (0 == strcmpic(newval, "block")) )
2719 * Blocking Accept-Language header
2721 log_error(LOG_LEVEL_HEADER, "Crunching Accept-Language!");
2728 * Replacing Accept-Language header
2731 *header = strdup("Accept-Language: ");
2732 string_append(header, newval);
2734 if (*header == NULL)
2736 log_error(LOG_LEVEL_ERROR,
2737 "Insufficient memory. Accept-Language header crunched without replacement.");
2741 log_error(LOG_LEVEL_HEADER,
2742 "Accept-Language header crunched and replaced with: %s", *header);
2745 return (*header == NULL) ? JB_ERR_MEMORY : JB_ERR_OK;
2749 /*********************************************************************
2751 * Function : crunch_client_header
2753 * Description : Crunch client header if it matches a string supplied by the
2754 * user. Called from `sed'.
2757 * 1 : csp = Current client state (buffers, headers, etc...)
2758 * 2 : header = On input, pointer to header to modify.
2759 * On output, pointer to the modified header, or NULL
2760 * to remove the header. This function frees the
2761 * original string if necessary.
2763 * Returns : JB_ERR_OK on success and always succeeds
2765 *********************************************************************/
2766 static jb_err crunch_client_header(struct client_state *csp, char **header)
2768 const char *crunch_pattern;
2770 /* Do we feel like crunching? */
2771 if ((csp->action->flags & ACTION_CRUNCH_CLIENT_HEADER))
2773 crunch_pattern = csp->action->string[ACTION_STRING_CLIENT_HEADER];
2775 /* Is the current header the lucky one? */
2776 if (strstr(*header, crunch_pattern))
2778 log_error(LOG_LEVEL_HEADER, "Crunching client header: %s (contains: %s)", *header, crunch_pattern);
2786 /*********************************************************************
2788 * Function : client_uagent
2790 * Description : Handle the "user-agent" config setting properly
2791 * and remember its original value to enable browser
2792 * bug workarounds. Called from `sed'.
2795 * 1 : csp = Current client state (buffers, headers, etc...)
2796 * 2 : header = On input, pointer to header to modify.
2797 * On output, pointer to the modified header, or NULL
2798 * to remove the header. This function frees the
2799 * original string if necessary.
2801 * Returns : JB_ERR_OK on success, or
2802 * JB_ERR_MEMORY on out-of-memory error.
2804 *********************************************************************/
2805 static jb_err client_uagent(struct client_state *csp, char **header)
2809 if ((csp->action->flags & ACTION_HIDE_USER_AGENT) == 0)
2814 newval = csp->action->string[ACTION_STRING_USER_AGENT];
2821 *header = strdup("User-Agent: ");
2822 string_append(header, newval);
2824 log_error(LOG_LEVEL_HEADER, "Modified: %s", *header);
2826 return (*header == NULL) ? JB_ERR_MEMORY : JB_ERR_OK;
2830 /*********************************************************************
2832 * Function : client_ua
2834 * Description : Handle "ua-" headers properly. Called from `sed'.
2837 * 1 : csp = Current client state (buffers, headers, etc...)
2838 * 2 : header = On input, pointer to header to modify.
2839 * On output, pointer to the modified header, or NULL
2840 * to remove the header. This function frees the
2841 * original string if necessary.
2843 * Returns : JB_ERR_OK on success, or
2844 * JB_ERR_MEMORY on out-of-memory error.
2846 *********************************************************************/
2847 static jb_err client_ua(struct client_state *csp, char **header)
2849 if ((csp->action->flags & ACTION_HIDE_USER_AGENT) != 0)
2851 log_error(LOG_LEVEL_HEADER, "crunched User-Agent!");
2859 /*********************************************************************
2861 * Function : client_from
2863 * Description : Handle the "from" config setting properly.
2864 * 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_from(struct client_state *csp, char **header)
2881 if ((csp->action->flags & ACTION_HIDE_FROM) == 0)
2888 newval = csp->action->string[ACTION_STRING_FROM];
2891 * Are we blocking the e-mail address?
2893 if ((newval == NULL) || (0 == strcmpic(newval, "block")) )
2895 log_error(LOG_LEVEL_HEADER, "crunched From!");
2899 log_error(LOG_LEVEL_HEADER, " modified");
2901 *header = strdup("From: ");
2902 string_append(header, newval);
2904 return (*header == NULL) ? JB_ERR_MEMORY : JB_ERR_OK;
2908 /*********************************************************************
2910 * Function : client_send_cookie
2912 * Description : Crunches the "cookie" header if necessary.
2913 * Called from `sed'.
2915 * XXX: Stupid name, doesn't send squat.
2918 * 1 : csp = Current client state (buffers, headers, etc...)
2919 * 2 : header = On input, pointer to header to modify.
2920 * On output, pointer to the modified header, or NULL
2921 * to remove the header. This function frees the
2922 * original string if necessary.
2924 * Returns : JB_ERR_OK on success, or
2925 * JB_ERR_MEMORY on out-of-memory error.
2927 *********************************************************************/
2928 static jb_err client_send_cookie(struct client_state *csp, char **header)
2930 if (csp->action->flags & ACTION_NO_COOKIE_READ)
2932 log_error(LOG_LEVEL_HEADER, "Crunched outgoing cookie: %s", *header);
2940 /*********************************************************************
2942 * Function : client_x_forwarded
2944 * Description : Handle the "x-forwarded-for" config setting properly,
2945 * also used in the add_client_headers list. Called from `sed'.
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 jb_err client_x_forwarded(struct client_state *csp, char **header)
2960 if (0 != (csp->action->flags & ACTION_CHANGE_X_FORWARDED_FOR))
2962 const char *parameter = csp->action->string[ACTION_STRING_CHANGE_X_FORWARDED_FOR];
2964 if (0 == strcmpic(parameter, "block"))
2967 log_error(LOG_LEVEL_HEADER, "crunched x-forwarded-for!");
2969 else if (0 == strcmpic(parameter, "add"))
2971 string_append(header, ", ");
2972 string_append(header, csp->ip_addr_str);
2974 if (*header == NULL)
2976 return JB_ERR_MEMORY;
2978 log_error(LOG_LEVEL_HEADER,
2979 "Appended client IP address to %s", *header);
2980 csp->flags |= CSP_FLAG_X_FORWARDED_FOR_APPENDED;
2984 log_error(LOG_LEVEL_FATAL,
2985 "Invalid change-x-forwarded-for parameter: '%s'", parameter);
2993 /*********************************************************************
2995 * Function : client_max_forwards
2997 * Description : If the HTTP method is OPTIONS or TRACE, subtract one
2998 * from the value of the Max-Forwards header field.
3001 * 1 : csp = Current client state (buffers, headers, etc...)
3002 * 2 : header = On input, pointer to header to modify.
3003 * On output, pointer to the modified header, or NULL
3004 * to remove the header. This function frees the
3005 * original string if necessary.
3007 * Returns : JB_ERR_OK on success, or
3008 * JB_ERR_MEMORY on out-of-memory error.
3010 *********************************************************************/
3011 static jb_err client_max_forwards(struct client_state *csp, char **header)
3015 if ((0 == strcmpic(csp->http->gpc, "trace")) ||
3016 (0 == strcmpic(csp->http->gpc, "options")))
3018 assert(*(*header+12) == ':');
3019 if (1 == sscanf(*header+12, ": %d", &max_forwards))
3021 if (max_forwards > 0)
3023 snprintf(*header, strlen(*header)+1, "Max-Forwards: %d", --max_forwards);
3024 log_error(LOG_LEVEL_HEADER,
3025 "Max-Forwards value for %s request reduced to %d.",
3026 csp->http->gpc, max_forwards);
3028 else if (max_forwards < 0)
3030 log_error(LOG_LEVEL_ERROR, "Crunching invalid header: %s", *header);
3036 log_error(LOG_LEVEL_ERROR, "Crunching invalid header: %s", *header);
3045 /*********************************************************************
3047 * Function : client_host
3049 * Description : If the request URI did not contain host and
3050 * port information, parse and evaluate the Host
3053 * Also, kill ill-formed HOST: headers as sent by
3054 * Apple's iTunes software when used with a proxy.
3057 * 1 : csp = Current client state (buffers, headers, etc...)
3058 * 2 : header = On input, pointer to header to modify.
3059 * On output, pointer to the modified header, or NULL
3060 * to remove the header. This function frees the
3061 * original string if necessary.
3063 * Returns : JB_ERR_OK on success, or
3064 * JB_ERR_MEMORY on out-of-memory error.
3066 *********************************************************************/
3067 static jb_err client_host(struct client_state *csp, char **header)
3072 * If the header field name is all upper-case, chances are that it's
3073 * an ill-formed one from iTunes. BTW, killing innocent headers here is
3074 * not a problem -- they are regenerated later.
3076 if ((*header)[1] == 'O')
3078 log_error(LOG_LEVEL_HEADER, "Killed all-caps Host header line: %s", *header);
3083 if (!csp->http->hostport || (*csp->http->hostport == '*') ||
3084 *csp->http->hostport == ' ' || *csp->http->hostport == '\0')
3087 if (NULL == (p = strdup((*header)+6)))
3089 return JB_ERR_MEMORY;
3092 if (NULL == (q = strdup(p)))
3095 return JB_ERR_MEMORY;
3098 freez(csp->http->hostport);
3099 csp->http->hostport = p;
3100 freez(csp->http->host);
3101 csp->http->host = q;
3102 q = strchr(csp->http->host, ':');
3105 /* Terminate hostname and evaluate port string */
3107 csp->http->port = atoi(q);
3111 csp->http->port = csp->http->ssl ? 443 : 80;
3114 log_error(LOG_LEVEL_HEADER, "New host and port from Host field: %s = %s:%d",
3115 csp->http->hostport, csp->http->host, csp->http->port);
3118 /* Signal client_host_adder() to return right away */
3119 csp->flags |= CSP_FLAG_HOST_HEADER_IS_SET;
3125 /*********************************************************************
3127 * Function : client_if_modified_since
3129 * Description : Remove or modify the If-Modified-Since header.
3132 * 1 : csp = Current client state (buffers, headers, etc...)
3133 * 2 : header = On input, pointer to header to modify.
3134 * On output, pointer to the modified header, or NULL
3135 * to remove the header. This function frees the
3136 * original string if necessary.
3138 * Returns : JB_ERR_OK on success, or
3139 * JB_ERR_MEMORY on out-of-memory error.
3141 *********************************************************************/
3142 static jb_err client_if_modified_since(struct client_state *csp, char **header)
3145 #ifdef HAVE_GMTIME_R
3148 struct tm *timeptr = NULL;
3151 long int hours, minutes, seconds;
3154 if ( 0 == strcmpic(*header, "If-Modified-Since: Wed, 08 Jun 1955 12:00:00 GMT"))
3157 * The client got an error message because of a temporary problem,
3158 * the problem is gone and the client now tries to revalidate our
3159 * error message on the real server. The revalidation would always
3160 * end with the transmission of the whole document and there is
3161 * no need to expose the bogus If-Modified-Since header.
3163 log_error(LOG_LEVEL_HEADER, "Crunching useless If-Modified-Since header.");
3166 else if (csp->action->flags & ACTION_HIDE_IF_MODIFIED_SINCE)
3168 newval = csp->action->string[ACTION_STRING_IF_MODIFIED_SINCE];
3170 if ((0 == strcmpic(newval, "block")))
3172 log_error(LOG_LEVEL_HEADER, "Crunching %s", *header);
3175 else /* add random value */
3177 const char *header_time = *header + sizeof("If-Modified-Since:");
3179 if (JB_ERR_OK != parse_header_time(header_time, &tm))
3181 log_error(LOG_LEVEL_HEADER, "Couldn't parse: %s in %s (crunching!)", header_time, *header);
3186 long int rtime = strtol(newval, &endptr, 0);
3187 const int negative_range = (rtime < 0);
3191 log_error(LOG_LEVEL_HEADER, "Randomizing: %s (random range: %d minut%s)",
3192 *header, rtime, (rtime == 1 || rtime == -1) ? "e": "es");
3198 rtime = pick_from_range(rtime);
3202 log_error(LOG_LEVEL_ERROR, "Random range is 0. Assuming time transformation test.",
3205 tm += rtime * (negative_range ? -1 : 1);
3206 #ifdef HAVE_GMTIME_R
3207 timeptr = gmtime_r(&tm, &gmt);
3208 #elif defined(MUTEX_LOCKS_AVAILABLE)
3209 privoxy_mutex_lock(&gmtime_mutex);
3210 timeptr = gmtime(&tm);
3211 privoxy_mutex_unlock(&gmtime_mutex);
3213 timeptr = gmtime(&tm);
3215 if ((NULL == timeptr) || !strftime(newheader,
3216 sizeof(newheader), "%a, %d %b %Y %H:%M:%S GMT", timeptr))
3218 log_error(LOG_LEVEL_ERROR,
3219 "Randomizing '%s' failed. Crunching the header without replacement.",
3226 *header = strdup("If-Modified-Since: ");
3227 string_append(header, newheader);
3229 if (*header == NULL)
3231 log_error(LOG_LEVEL_HEADER, "Insufficient memory, header crunched without replacement.");
3232 return JB_ERR_MEMORY;
3235 hours = rtime / 3600;
3236 minutes = rtime / 60 % 60;
3237 seconds = rtime % 60;
3239 log_error(LOG_LEVEL_HEADER,
3240 "Randomized: %s (%s %d hou%s %d minut%s %d second%s",
3241 *header, (negative_range) ? "subtracted" : "added", hours,
3242 (hours == 1) ? "r" : "rs", minutes, (minutes == 1) ? "e" : "es",
3243 seconds, (seconds == 1) ? ")" : "s)");
3252 /*********************************************************************
3254 * Function : client_if_none_match
3256 * Description : Remove the If-None-Match header.
3259 * 1 : csp = Current client state (buffers, headers, etc...)
3260 * 2 : header = On input, pointer to header to modify.
3261 * On output, pointer to the modified header, or NULL
3262 * to remove the header. This function frees the
3263 * original string if necessary.
3265 * Returns : JB_ERR_OK on success, or
3266 * JB_ERR_MEMORY on out-of-memory error.
3268 *********************************************************************/
3269 static jb_err client_if_none_match(struct client_state *csp, char **header)
3271 if (csp->action->flags & ACTION_CRUNCH_IF_NONE_MATCH)
3273 log_error(LOG_LEVEL_HEADER, "Crunching %s", *header);
3281 /*********************************************************************
3283 * Function : client_x_filter
3285 * Description : Disables filtering if the client set "X-Filter: No".
3286 * Called from `sed'.
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
3297 *********************************************************************/
3298 jb_err client_x_filter(struct client_state *csp, char **header)
3300 if ( 0 == strcmpic(*header, "X-Filter: No"))
3302 if (!(csp->config->feature_flags & RUNTIME_FEATURE_HTTP_TOGGLE))
3304 log_error(LOG_LEVEL_INFO, "Ignored the client's request to fetch without filtering.");
3308 if (csp->action->flags & ACTION_FORCE_TEXT_MODE)
3310 log_error(LOG_LEVEL_HEADER,
3311 "force-text-mode overruled the client's request to fetch without filtering!");
3315 csp->content_type = CT_TABOO; /* XXX: This hack shouldn't be necessary */
3316 csp->flags |= CSP_FLAG_NO_FILTERING;
3317 log_error(LOG_LEVEL_HEADER, "Accepted the client's request to fetch without filtering.");
3319 log_error(LOG_LEVEL_HEADER, "Crunching %s", *header);
3327 /*********************************************************************
3329 * Function : client_range
3331 * Description : Removes Range, Request-Range and If-Range headers if
3332 * content filtering is enabled. If the client's version
3333 * of the document has been altered by Privoxy, the server
3334 * could interpret the range differently than the client
3335 * intended in which case the user could end up with
3336 * corrupted content.
3339 * 1 : csp = Current client state (buffers, headers, etc...)
3340 * 2 : header = On input, pointer to header to modify.
3341 * On output, pointer to the modified header, or NULL
3342 * to remove the header. This function frees the
3343 * original string if necessary.
3345 * Returns : JB_ERR_OK
3347 *********************************************************************/
3348 static jb_err client_range(struct client_state *csp, char **header)
3350 if (content_filters_enabled(csp->action))
3352 log_error(LOG_LEVEL_HEADER, "Content filtering is enabled."
3353 " Crunching: \'%s\' to prevent range-mismatch problems.", *header);
3360 /* the following functions add headers directly to the header list */
3362 /*********************************************************************
3364 * Function : client_host_adder
3366 * Description : Adds the Host: header field if it is missing.
3367 * Called from `sed'.
3370 * 1 : csp = Current client state (buffers, headers, etc...)
3372 * Returns : JB_ERR_OK on success, or
3373 * JB_ERR_MEMORY on out-of-memory error.
3375 *********************************************************************/
3376 static jb_err client_host_adder(struct client_state *csp)
3381 if (csp->flags & CSP_FLAG_HOST_HEADER_IS_SET)
3383 /* Header already set by the client, nothing to do. */
3387 if ( !csp->http->hostport || !*(csp->http->hostport))
3389 /* XXX: When does this happen and why is it OK? */
3390 log_error(LOG_LEVEL_INFO, "Weirdness in client_host_adder detected and ignored.");
3395 * remove 'user:pass@' from 'proto://user:pass@host'
3397 if ( (p = strchr( csp->http->hostport, '@')) != NULL )
3403 p = csp->http->hostport;
3406 /* XXX: Just add it, we already made sure that it will be unique */
3407 log_error(LOG_LEVEL_HEADER, "addh-unique: Host: %s", p);
3408 err = enlist_unique_header(csp->headers, "Host", p);
3415 /*********************************************************************
3417 * Function : client_accept_encoding_adder
3419 * Description : Add an Accept-Encoding header to the client's request
3420 * that disables compression if the action applies, and
3421 * the header is not already there. Called from `sed'.
3422 * Note: For HTTP/1.0, the absence of the header is enough.
3425 * 1 : csp = Current client state (buffers, headers, etc...)
3427 * Returns : JB_ERR_OK on success, or
3428 * JB_ERR_MEMORY on out-of-memory error.
3430 *********************************************************************/
3431 static jb_err client_accept_encoding_adder(struct client_state *csp)
3433 if ( ((csp->action->flags & ACTION_NO_COMPRESSION) != 0)
3434 && (!strcmpic(csp->http->ver, "HTTP/1.1")) )
3436 return enlist_unique(csp->headers, "Accept-Encoding: identity;q=1.0, *;q=0", 16);
3444 /*********************************************************************
3446 * Function : client_xtra_adder
3448 * Description : Used in the add_client_headers list. Called from `sed'.
3451 * 1 : csp = Current client state (buffers, headers, etc...)
3453 * Returns : JB_ERR_OK on success, or
3454 * JB_ERR_MEMORY on out-of-memory error.
3456 *********************************************************************/
3457 static jb_err client_xtra_adder(struct client_state *csp)
3459 struct list_entry *lst;
3462 for (lst = csp->action->multi[ACTION_MULTI_ADD_HEADER]->first;
3463 lst ; lst = lst->next)
3465 log_error(LOG_LEVEL_HEADER, "addh: %s", lst->str);
3466 err = enlist(csp->headers, lst->str);
3478 /*********************************************************************
3480 * Function : client_x_forwarded_for_adder
3482 * Description : Used in the add_client_headers list. Called from `sed'.
3485 * 1 : csp = Current client state (buffers, headers, etc...)
3487 * Returns : JB_ERR_OK on success, or
3488 * JB_ERR_MEMORY on out-of-memory error.
3490 *********************************************************************/
3491 static jb_err client_x_forwarded_for_adder(struct client_state *csp)
3493 char *header = NULL;
3496 if (!((csp->action->flags & ACTION_CHANGE_X_FORWARDED_FOR)
3497 && (0 == strcmpic(csp->action->string[ACTION_STRING_CHANGE_X_FORWARDED_FOR], "add")))
3498 || (csp->flags & CSP_FLAG_X_FORWARDED_FOR_APPENDED))
3501 * If we aren't adding X-Forwarded-For headers,
3502 * or we already appended an existing X-Forwarded-For
3503 * header, there's nothing left to do here.
3508 header = strdup("X-Forwarded-For: ");
3509 string_append(&header, csp->ip_addr_str);
3513 return JB_ERR_MEMORY;
3516 log_error(LOG_LEVEL_HEADER, "addh: %s", header);
3517 err = enlist(csp->headers, header);
3524 /*********************************************************************
3526 * Function : server_connection_adder
3528 * Description : Adds an appropiate "Connection:" header to csp->headers
3529 * unless the header was already present. Called from `sed'.
3532 * 1 : csp = Current client state (buffers, headers, etc...)
3534 * Returns : JB_ERR_OK on success, or
3535 * JB_ERR_MEMORY on out-of-memory error.
3537 *********************************************************************/
3538 static jb_err server_connection_adder(struct client_state *csp)
3540 const unsigned int flags = csp->flags;
3541 const char *response_status_line = csp->headers->first->str;
3542 static const char connection_close[] = "Connection: close";
3544 if ((flags & CSP_FLAG_CLIENT_HEADER_PARSING_DONE)
3545 && (flags & CSP_FLAG_SERVER_CONNECTION_HEADER_SET))
3551 * XXX: if we downgraded the response, this check will fail.
3553 if ((csp->config->feature_flags &
3554 RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
3555 && (NULL != response_status_line)
3556 && !strncmpic(response_status_line, "HTTP/1.1", 8)
3557 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3558 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
3562 log_error(LOG_LEVEL_HEADER, "A HTTP/1.1 response "
3563 "without Connection header implies keep-alive.");
3564 csp->flags |= CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE;
3568 log_error(LOG_LEVEL_HEADER, "Adding: %s", connection_close);
3570 return enlist(csp->headers, connection_close);
3574 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3575 /*********************************************************************
3577 * Function : server_proxy_connection_adder
3579 * Description : Adds a "Proxy-Connection: keep-alive" header to
3580 * csp->headers if the client asked for keep-alive.
3581 * XXX: We should reuse existant ones.
3584 * 1 : csp = Current client state (buffers, headers, etc...)
3586 * Returns : JB_ERR_OK on success, or
3587 * JB_ERR_MEMORY on out-of-memory error.
3589 *********************************************************************/
3590 static jb_err server_proxy_connection_adder(struct client_state *csp)
3592 static const char proxy_connection_header[] = "Proxy-Connection: keep-alive";
3593 jb_err err = JB_ERR_OK;
3595 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
3596 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
3597 && !(csp->flags & CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET))
3599 log_error(LOG_LEVEL_HEADER, "Adding: %s", proxy_connection_header);
3600 err = enlist(csp->headers, proxy_connection_header);
3605 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
3608 /*********************************************************************
3610 * Function : client_connection_header_adder
3612 * Description : Adds a proper "Connection:" header to csp->headers
3613 * unless the header was already present. Called from `sed'.
3616 * 1 : csp = Current client state (buffers, headers, etc...)
3618 * Returns : JB_ERR_OK on success, or
3619 * JB_ERR_MEMORY on out-of-memory error.
3621 *********************************************************************/
3622 static jb_err client_connection_header_adder(struct client_state *csp)
3624 static const char connection_close[] = "Connection: close";
3626 if (!(csp->flags & CSP_FLAG_CLIENT_HEADER_PARSING_DONE)
3627 && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_HEADER_SET))
3632 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3633 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
3634 && (csp->http->ssl == 0)
3635 && !strcmpic(csp->http->ver, "HTTP/1.1"))
3637 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
3640 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
3642 log_error(LOG_LEVEL_HEADER, "Adding: %s", connection_close);
3644 return enlist(csp->headers, connection_close);
3648 /*********************************************************************
3650 * Function : server_http
3652 * Description : - Save the HTTP Status into csp->http->status
3653 * - Set CT_TABOO to prevent filtering if the answer
3654 * is a partial range (HTTP status 206)
3655 * - Rewrite HTTP/1.1 answers to HTTP/1.0 if +downgrade
3659 * 1 : csp = Current client state (buffers, headers, etc...)
3660 * 2 : header = On input, pointer to header to modify.
3661 * On output, pointer to the modified header, or NULL
3662 * to remove the header. This function frees the
3663 * original string if necessary.
3665 * Returns : JB_ERR_OK on success, or
3666 * JB_ERR_MEMORY on out-of-memory error.
3668 *********************************************************************/
3669 static jb_err server_http(struct client_state *csp, char **header)
3671 sscanf(*header, "HTTP/%*d.%*d %d", &(csp->http->status));
3672 if (csp->http->status == 206)
3674 csp->content_type = CT_TABOO;
3677 if ((csp->action->flags & ACTION_DOWNGRADE) != 0)
3679 /* XXX: Should we do a real validity check here? */
3680 if (strlen(*header) > 8)
3683 log_error(LOG_LEVEL_HEADER, "Downgraded answer to HTTP/1.0");
3688 * XXX: Should we block the request or
3689 * enlist a valid status code line here?
3691 log_error(LOG_LEVEL_INFO, "Malformed server response detected. "
3692 "Downgrading to HTTP/1.0 impossible.");
3700 /*********************************************************************
3702 * Function : server_set_cookie
3704 * Description : Handle the server "cookie" header properly.
3705 * Crunch, accept or rewrite it to a session cookie.
3706 * Called from `sed'.
3708 * TODO: Allow the user to specify a new expiration
3709 * time to cause the cookie to expire even before the
3710 * browser is closed.
3713 * 1 : csp = Current client state (buffers, headers, etc...)
3714 * 2 : header = On input, pointer to header to modify.
3715 * On output, pointer to the modified header, or NULL
3716 * to remove the header. This function frees the
3717 * original string if necessary.
3719 * Returns : JB_ERR_OK on success, or
3720 * JB_ERR_MEMORY on out-of-memory error.
3722 *********************************************************************/
3723 static jb_err server_set_cookie(struct client_state *csp, char **header)
3730 if ((csp->action->flags & ACTION_NO_COOKIE_SET) != 0)
3732 log_error(LOG_LEVEL_HEADER, "Crunching incoming cookie: %s", *header);
3735 else if ((csp->action->flags & ACTION_NO_COOKIE_KEEP) != 0)
3737 /* Flag whether or not to log a message */
3740 /* A variable to store the tag we're working on */
3743 /* Skip "Set-Cookie:" (11 characters) in header */
3744 cur_tag = *header + 11;
3746 /* skip whitespace between "Set-Cookie:" and value */
3747 while (*cur_tag && ijb_isspace(*cur_tag))
3752 /* Loop through each tag in the cookie */
3756 char *next_tag = strchr(cur_tag, ';');
3757 if (next_tag != NULL)
3759 /* Skip the ';' character itself */
3762 /* skip whitespace ";" and start of tag */
3763 while (*next_tag && ijb_isspace(*next_tag))
3770 /* "Next tag" is the end of the string */
3771 next_tag = cur_tag + strlen(cur_tag);
3775 * Check the expiration date to see
3776 * if the cookie is still valid, if yes,
3777 * rewrite it to a session cookie.
3779 if ((strncmpic(cur_tag, "expires=", 8) == 0) && *(cur_tag + 8))
3781 char *expiration_date = cur_tag + 8; /* Skip "[Ee]xpires=" */
3783 if ((expiration_date[0] == '"')
3784 && (expiration_date[1] != '\0'))
3787 * Skip quotation mark. RFC 2109 10.1.2 seems to hint
3788 * that the expiration date isn't supposed to be quoted,
3789 * but some servers do it anyway.
3794 /* Did we detect the date properly? */
3795 if (JB_ERR_OK != parse_header_time(expiration_date, &cookie_time))
3798 * Nope, treat it as if it was still valid.
3800 * XXX: Should we remove the whole cookie instead?
3802 log_error(LOG_LEVEL_ERROR,
3803 "Can't parse \'%s\', send by %s. Unsupported time format?", cur_tag, csp->http->url);
3804 string_move(cur_tag, next_tag);
3810 * Yes. Check if the cookie is still valid.
3812 * If the cookie is already expired it's probably
3813 * a delete cookie and even if it isn't, the browser
3814 * will discard it anyway.
3818 * XXX: timegm() isn't available on some AmigaOS
3819 * versions and our replacement doesn't work.
3821 * Our options are to either:
3823 * - disable session-cookies-only completely if timegm
3826 * - to simply remove all expired tags, like it has
3827 * been done until Privoxy 3.0.6 and to live with
3828 * the consequence that it can cause login/logout
3829 * problems on servers that don't validate their
3830 * input properly, or
3832 * - to replace it with mktime in which
3833 * case there is a slight chance of valid cookies
3834 * passing as already expired.
3836 * This is the way it's currently done and it's not
3837 * as bad as it sounds. If the missing GMT offset is
3838 * enough to change the result of the expiration check
3839 * the cookie will be only valid for a few hours
3840 * anyway, which in many cases will be shorter
3841 * than a browser session.
3843 if (cookie_time - now < 0)
3845 log_error(LOG_LEVEL_HEADER,
3846 "Cookie \'%s\' is already expired and can pass unmodified.", *header);
3847 /* Just in case some clown sets more then one expiration date */
3853 * Still valid, delete expiration date by copying
3854 * the rest of the string over it.
3856 string_move(cur_tag, next_tag);
3858 /* That changed the header, need to issue a log message */
3862 * Note that the next tag has now been moved to *cur_tag,
3863 * so we do not need to update the cur_tag pointer.
3871 /* Move on to next cookie tag */
3878 assert(NULL != *header);
3879 log_error(LOG_LEVEL_HEADER, "Cookie rewritten to a temporary one: %s",
3888 #ifdef FEATURE_FORCE_LOAD
3889 /*********************************************************************
3891 * Function : strclean
3893 * Description : In-Situ-Eliminate all occurances of substring in
3897 * 1 : string = string to clean
3898 * 2 : substring = substring to eliminate
3900 * Returns : Number of eliminations
3902 *********************************************************************/
3903 int strclean(char *string, const char *substring)
3909 len = strlen(substring);
3911 while((pos = strstr(string, substring)) != NULL)
3918 while (*p++ != '\0');
3925 #endif /* def FEATURE_FORCE_LOAD */
3928 /*********************************************************************
3930 * Function : parse_header_time
3932 * Description : Parses time formats used in HTTP header strings
3933 * to get the numerical respresentation.
3936 * 1 : header_time = HTTP header time as string.
3937 * 2 : result = storage for header_time in seconds
3939 * Returns : JB_ERR_OK if the time format was recognized, or
3940 * JB_ERR_PARSE otherwise.
3942 *********************************************************************/
3943 static jb_err parse_header_time(const char *header_time, time_t *result)
3948 * Zero out gmt to prevent time zone offsets.
3950 * While this is only necessary on some platforms
3951 * (mingw32 for example), I don't know how to
3952 * detect these automatically and doing it everywhere
3955 memset(&gmt, 0, sizeof(gmt));
3957 /* Tue, 02 Jun 2037 20:00:00 */
3958 if ((NULL == strptime(header_time, "%a, %d %b %Y %H:%M:%S", &gmt))
3959 /* Tue, 02-Jun-2037 20:00:00 */
3960 && (NULL == strptime(header_time, "%a, %d-%b-%Y %H:%M:%S", &gmt))
3961 /* Tue, 02-Jun-37 20:00:00 */
3962 && (NULL == strptime(header_time, "%a, %d-%b-%y %H:%M:%S", &gmt))
3963 /* Tuesday, 02-Jun-2037 20:00:00 */
3964 && (NULL == strptime(header_time, "%A, %d-%b-%Y %H:%M:%S", &gmt))
3965 /* Tuesday Jun 02 20:00:00 2037 */
3966 && (NULL == strptime(header_time, "%A %b %d %H:%M:%S %Y", &gmt)))
3968 return JB_ERR_PARSE;
3971 *result = timegm(&gmt);
3978 /*********************************************************************
3980 * Function : get_destination_from_headers
3982 * Description : Parse the "Host:" header to get the request's destination.
3983 * Only needed if the client's request was forcefully
3984 * redirected into Privoxy.
3986 * Code mainly copied from client_host() which is currently
3987 * run too late for this purpose.
3990 * 1 : headers = List of headers (one of them hopefully being
3991 * the "Host:" header)
3992 * 2 : http = storage for the result (host, port and hostport).
3994 * Returns : JB_ERR_MEMORY in case of memory problems,
3995 * JB_ERR_PARSE if the host header couldn't be found,
3996 * JB_ERR_OK otherwise.
3998 *********************************************************************/
3999 jb_err get_destination_from_headers(const struct list *headers, struct http_request *http)
4005 host = get_header_value(headers, "Host:");
4009 log_error(LOG_LEVEL_ERROR, "No \"Host:\" header found.");
4010 return JB_ERR_PARSE;
4013 if (NULL == (p = strdup((host))))
4015 log_error(LOG_LEVEL_ERROR, "Out of memory while parsing \"Host:\" header");
4016 return JB_ERR_MEMORY;
4019 if (NULL == (q = strdup(p)))
4022 log_error(LOG_LEVEL_ERROR, "Out of memory while parsing \"Host:\" header");
4023 return JB_ERR_MEMORY;
4026 freez(http->hostport);
4030 q = strchr(http->host, ':');
4033 /* Terminate hostname and evaluate port string */
4035 http->port = atoi(q);
4039 http->port = http->ssl ? 443 : 80;
4042 /* Rebuild request URL */
4044 http->url = strdup(http->ssl ? "https://" : "http://");
4045 string_append(&http->url, http->hostport);
4046 string_append(&http->url, http->path);
4047 if (http->url == NULL)
4049 return JB_ERR_MEMORY;
4052 log_error(LOG_LEVEL_HEADER, "Destination extracted from \"Host:\" header. New request URL: %s",
4060 /*********************************************************************
4062 * Function : create_forged_referrer
4064 * Description : Helper for client_referrer to forge a referer as
4065 * 'http://[hostname:port/' to fool stupid
4066 * checks for in-site links
4069 * 1 : header = Pointer to header pointer
4070 * 2 : hostport = Host and optionally port as string
4072 * Returns : JB_ERR_OK in case of success, or
4073 * JB_ERR_MEMORY in case of memory problems.
4075 *********************************************************************/
4076 static jb_err create_forged_referrer(char **header, const char *hostport)
4078 assert(NULL == *header);
4080 *header = strdup("Referer: http://");
4081 string_append(header, hostport);
4082 string_append(header, "/");
4084 if (NULL == *header)
4086 return JB_ERR_MEMORY;
4089 log_error(LOG_LEVEL_HEADER, "Referer forged to: %s", *header);
4096 /*********************************************************************
4098 * Function : create_fake_referrer
4100 * Description : Helper for client_referrer to create a fake referrer
4101 * based on a string supplied by the user.
4104 * 1 : header = Pointer to header pointer
4105 * 2 : hosthost = Referrer to fake
4107 * Returns : JB_ERR_OK in case of success, or
4108 * JB_ERR_MEMORY in case of memory problems.
4110 *********************************************************************/
4111 static jb_err create_fake_referrer(char **header, const char *fake_referrer)
4113 assert(NULL == *header);
4115 if ((0 != strncmpic(fake_referrer, "http://", 7)) && (0 != strncmpic(fake_referrer, "https://", 8)))
4117 log_error(LOG_LEVEL_HEADER,
4118 "Parameter: +hide-referrer{%s} is a bad idea, but I don't care.", fake_referrer);
4120 *header = strdup("Referer: ");
4121 string_append(header, fake_referrer);
4123 if (NULL == *header)
4125 return JB_ERR_MEMORY;
4128 log_error(LOG_LEVEL_HEADER, "Referer replaced with: %s", *header);
4135 /*********************************************************************
4137 * Function : handle_conditional_hide_referrer_parameter
4139 * Description : Helper for client_referrer to crunch or forge
4140 * the referrer header if the host has changed.
4143 * 1 : header = Pointer to header pointer
4144 * 2 : host = The target host (may include the port)
4145 * 3 : parameter_conditional_block = Boolean to signal
4146 * if we're in conditional-block mode. If not set,
4147 * we're in conditional-forge mode.
4149 * Returns : JB_ERR_OK in case of success, or
4150 * JB_ERR_MEMORY in case of memory problems.
4152 *********************************************************************/
4153 static jb_err handle_conditional_hide_referrer_parameter(char **header,
4154 const char *host, const int parameter_conditional_block)
4156 char *referer = strdup(*header);
4157 const size_t hostlenght = strlen(host);
4158 const char *referer_url = NULL;
4160 if (NULL == referer)
4163 return JB_ERR_MEMORY;
4166 /* referer begins with 'Referer: http[s]://' */
4167 if ((hostlenght+17) < strlen(referer))
4170 * Shorten referer to make sure the referer is blocked
4171 * if www.example.org/www.example.com-shall-see-the-referer/
4172 * links to www.example.com/
4174 referer[hostlenght+17] = '\0';
4176 referer_url = strstr(referer, "http://");
4177 if ((NULL == referer_url) || (NULL == strstr(referer_url, host)))
4179 /* Host has changed, Referer is invalid or a https URL. */
4180 if (parameter_conditional_block)
4182 log_error(LOG_LEVEL_HEADER, "New host is: %s. Crunching %s!", host, *header);
4189 return create_forged_referrer(header, host);
4199 /*********************************************************************
4201 * Function : create_content_length_header
4203 * Description : Creates a Content-Length header.
4206 * 1 : content_length = The content length to be used in the header.
4207 * 2 : header = Allocated space to safe the header.
4208 * 3 : buffer_length = The length of the allocated space.
4212 *********************************************************************/
4213 static void create_content_length_header(unsigned long long content_length,
4214 char *header, size_t buffer_length)
4216 snprintf(header, buffer_length, "Content-Length: %llu", content_length);