1 /*********************************************************************
3 * File : $Source: /cvsroot/ijbswa/current/parsers.c,v $
5 * Purpose : Declares functions to parse/crunch headers and pages.
7 * Copyright : Written by and Copyright (C) 2001-2020 the
8 * Privoxy team. https://www.privoxy.org/
10 * Based on the Internet Junkbuster originally written
11 * by and Copyright (C) 1997 Anonymous Coders and
12 * Junkbusters Corporation. http://www.junkbusters.com
14 * This program is free software; you can redistribute it
15 * and/or modify it under the terms of the GNU General
16 * Public License as published by the Free Software
17 * Foundation; either version 2 of the License, or (at
18 * your option) any later version.
20 * This program is distributed in the hope that it will
21 * be useful, but WITHOUT ANY WARRANTY; without even the
22 * implied warranty of MERCHANTABILITY or FITNESS FOR A
23 * PARTICULAR PURPOSE. See the GNU General Public
24 * License for more details.
26 * The GNU General Public License should be included with
27 * this file. If not, you can view it at
28 * http://www.gnu.org/copyleft/gpl.html
29 * or write to the Free Software Foundation, Inc., 59
30 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
32 *********************************************************************/
39 #include <sys/types.h>
49 * Convince GNU's libc to provide a strptime prototype.
58 #define GZIP_IDENTIFIER_1 0x1f
59 #define GZIP_IDENTIFIER_2 0x8b
61 #define GZIP_FLAG_CHECKSUM 0x02
62 #define GZIP_FLAG_EXTRA_FIELDS 0x04
63 #define GZIP_FLAG_FILE_NAME 0x08
64 #define GZIP_FLAG_COMMENT 0x10
65 #define GZIP_FLAG_RESERVED_BITS 0xe0
68 #if !defined(_WIN32) && !defined(__OS2__)
74 #ifdef FEATURE_PTHREAD
76 /* jcc.h is for mutex semapores only */
77 #endif /* def FEATURE_PTHREAD */
82 #include "jbsockets.h"
92 static char *get_header_line(struct iob *iob);
93 static jb_err scan_headers(struct client_state *csp);
94 static jb_err header_tagger(struct client_state *csp, char *header);
95 static jb_err parse_header_time(const char *header_time, time_t *result);
96 static jb_err parse_time_header(const char *header, time_t *result);
98 static jb_err crumble (struct client_state *csp, char **header);
99 static jb_err filter_header (struct client_state *csp, char **header);
100 static jb_err client_connection (struct client_state *csp, char **header);
101 static jb_err client_referrer (struct client_state *csp, char **header);
102 static jb_err client_uagent (struct client_state *csp, char **header);
103 static jb_err client_ua (struct client_state *csp, char **header);
104 static jb_err client_from (struct client_state *csp, char **header);
105 static jb_err client_send_cookie (struct client_state *csp, char **header);
106 static jb_err client_x_forwarded (struct client_state *csp, char **header);
107 static jb_err client_accept_encoding (struct client_state *csp, char **header);
108 static jb_err client_te (struct client_state *csp, char **header);
109 static jb_err client_max_forwards (struct client_state *csp, char **header);
110 static jb_err client_host (struct client_state *csp, char **header);
111 static jb_err client_if_modified_since (struct client_state *csp, char **header);
112 static jb_err client_accept_language (struct client_state *csp, char **header);
113 static jb_err client_if_none_match (struct client_state *csp, char **header);
114 static jb_err crunch_client_header (struct client_state *csp, char **header);
115 static jb_err client_x_filter (struct client_state *csp, char **header);
116 static jb_err client_range (struct client_state *csp, char **header);
117 static jb_err client_expect (struct client_state *csp, char **header);
118 static jb_err server_set_cookie (struct client_state *csp, char **header);
119 static jb_err server_connection (struct client_state *csp, char **header);
120 static jb_err server_content_type (struct client_state *csp, char **header);
121 static jb_err server_adjust_content_length(struct client_state *csp, char **header);
122 static jb_err server_content_md5 (struct client_state *csp, char **header);
123 static jb_err server_content_encoding (struct client_state *csp, char **header);
124 static jb_err server_transfer_coding (struct client_state *csp, char **header);
125 static jb_err server_http (struct client_state *csp, char **header);
126 static jb_err crunch_server_header (struct client_state *csp, char **header);
127 static jb_err server_last_modified (struct client_state *csp, char **header);
128 static jb_err server_content_disposition(struct client_state *csp, char **header);
130 static jb_err server_adjust_content_encoding(struct client_state *csp, char **header);
133 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
134 static jb_err server_save_content_length(struct client_state *csp, char **header);
135 static jb_err server_keep_alive(struct client_state *csp, char **header);
136 static jb_err server_proxy_connection(struct client_state *csp, char **header);
137 static jb_err client_keep_alive(struct client_state *csp, char **header);
138 static jb_err client_save_content_length(struct client_state *csp, char **header);
139 static jb_err client_proxy_connection(struct client_state *csp, char **header);
140 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
142 static jb_err client_host_adder (struct client_state *csp);
143 static jb_err client_xtra_adder (struct client_state *csp);
144 static jb_err client_x_forwarded_for_adder(struct client_state *csp);
145 static jb_err client_connection_header_adder(struct client_state *csp);
146 static jb_err server_connection_adder(struct client_state *csp);
147 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
148 static jb_err server_proxy_connection_adder(struct client_state *csp);
149 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
150 static jb_err proxy_authentication(struct client_state *csp, char **header);
152 static jb_err create_forged_referrer(char **header, const char *hostport);
153 static jb_err create_fake_referrer(char **header, const char *fake_referrer);
154 static jb_err handle_conditional_hide_referrer_parameter(char **header,
155 const char *host, const int parameter_conditional_block);
156 static void create_content_length_header(unsigned long long content_length,
157 char *header, size_t buffer_length);
160 * List of functions to run on a list of headers.
164 /** The header prefix to match */
167 /** The length of the prefix to match */
170 /** The function to apply to this line */
171 const parser_func_ptr parser;
174 static const struct parsers client_patterns[] = {
175 { "referer:", 8, client_referrer },
176 { "user-agent:", 11, client_uagent },
177 { "ua-", 3, client_ua },
178 { "from:", 5, client_from },
179 { "cookie:", 7, client_send_cookie },
180 { "x-forwarded-for:", 16, client_x_forwarded },
181 { "Accept-Encoding:", 16, client_accept_encoding },
182 { "TE:", 3, client_te },
183 { "Host:", 5, client_host },
184 { "if-modified-since:", 18, client_if_modified_since },
185 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
186 { "Keep-Alive:", 11, client_keep_alive },
187 { "Content-Length:", 15, client_save_content_length },
188 { "Proxy-Connection:", 17, client_proxy_connection },
190 { "Keep-Alive:", 11, crumble },
191 { "Proxy-Connection:", 17, crumble },
193 { "connection:", 11, client_connection },
194 { "max-forwards:", 13, client_max_forwards },
195 { "Accept-Language:", 16, client_accept_language },
196 { "if-none-match:", 14, client_if_none_match },
197 { "Range:", 6, client_range },
198 { "Request-Range:", 14, client_range },
199 { "If-Range:", 9, client_range },
200 { "X-Filter:", 9, client_x_filter },
201 { "Proxy-Authorization:", 20, proxy_authentication },
203 { "Transfer-Encoding:", 18, client_transfer_encoding },
205 { "Expect:", 7, client_expect },
206 { "*", 0, crunch_client_header },
207 { "*", 0, filter_header },
211 static const struct parsers server_patterns[] = {
212 { "HTTP/", 5, server_http },
213 { "set-cookie:", 11, server_set_cookie },
214 { "connection:", 11, server_connection },
215 { "Content-Type:", 13, server_content_type },
216 { "Content-MD5:", 12, server_content_md5 },
217 { "Content-Encoding:", 17, server_content_encoding },
218 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
219 { "Content-Length:", 15, server_save_content_length },
220 { "Keep-Alive:", 11, server_keep_alive },
221 { "Proxy-Connection:", 17, server_proxy_connection },
223 { "Keep-Alive:", 11, crumble },
224 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
225 { "Transfer-Encoding:", 18, server_transfer_coding },
226 { "content-disposition:", 20, server_content_disposition },
227 { "Last-Modified:", 14, server_last_modified },
228 { "Proxy-Authenticate:", 19, proxy_authentication },
229 { "*", 0, crunch_server_header },
230 { "*", 0, filter_header },
234 static const add_header_func_ptr add_client_headers[] = {
236 client_x_forwarded_for_adder,
238 client_connection_header_adder,
242 static const add_header_func_ptr add_server_headers[] = {
243 server_connection_adder,
244 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
245 server_proxy_connection_adder,
246 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
250 /*********************************************************************
252 * Function : flush_iob
254 * Description : Write any pending "buffered" content.
257 * 1 : fd = file descriptor of the socket to read
258 * 2 : iob = The I/O buffer to flush, usually csp->iob.
259 * 3 : delay = Number of milliseconds to delay the writes
261 * Returns : On success, the number of bytes written are returned (zero
262 * indicates nothing was written). On error, -1 is returned,
263 * and errno is set appropriately. If count is zero and the
264 * file descriptor refers to a regular file, 0 will be
265 * returned without causing any other effect. For a special
266 * file, the results are not portable.
268 *********************************************************************/
269 long flush_iob(jb_socket fd, struct iob *iob, unsigned int delay)
271 long len = iob->eod - iob->cur;
278 if (write_socket_delayed(fd, iob->cur, (size_t)len, delay))
282 iob->eod = iob->cur = iob->buf;
288 /*********************************************************************
290 * Function : add_to_iob
292 * Description : Add content to the buffer, expanding the
293 * buffer if necessary.
296 * 1 : iob = Destination buffer.
297 * 2 : buffer_limit = Limit to which the destination may grow
298 * 3 : src = holds the content to be added
299 * 4 : n = number of bytes to be added
301 * Returns : JB_ERR_OK on success, JB_ERR_MEMORY if out-of-memory
302 * or buffer limit reached.
304 *********************************************************************/
305 jb_err add_to_iob(struct iob *iob, const size_t buffer_limit, char *src, long n)
307 size_t used, offset, need;
310 if (n <= 0) return JB_ERR_OK;
312 used = (size_t)(iob->eod - iob->buf);
313 offset = (size_t)(iob->cur - iob->buf);
314 need = used + (size_t)n + 1;
317 * If the buffer can't hold the new data, extend it first.
318 * Use the next power of two if possible, else use the actual need.
320 if (need > buffer_limit)
322 log_error(LOG_LEVEL_INFO,
323 "Buffer limit reached while extending the buffer (iob). Needed: %d. Limit: %d",
325 return JB_ERR_MEMORY;
328 if (need > iob->size)
330 size_t want = iob->size ? iob->size : 512;
337 if (want <= buffer_limit && NULL != (p = (char *)realloc(iob->buf, want)))
341 else if (NULL != (p = (char *)realloc(iob->buf, need)))
347 log_error(LOG_LEVEL_ERROR, "Extending the buffer (iob) failed: %E");
348 return JB_ERR_MEMORY;
351 /* Update the iob pointers */
352 iob->cur = p + offset;
357 /* copy the new data into the iob buffer */
358 memcpy(iob->eod, src, (size_t)n);
360 /* point to the end of the data */
363 /* null terminate == cheap insurance */
371 /*********************************************************************
373 * Function : clear_iob
375 * Description : Frees the memory allocated for an I/O buffer and
376 * resets the structure.
379 * 1 : iob = I/O buffer to clear.
381 * Returns : JB_ERR_OK on success, JB_ERR_MEMORY if out-of-memory
382 * or buffer limit reached.
384 *********************************************************************/
385 void clear_iob(struct iob *iob)
388 memset(iob, '\0', sizeof(*iob));
393 /*********************************************************************
395 * Function : decompress_iob
397 * Description : Decompress buffered page, expanding the
398 * buffer as necessary. csp->iob->cur
399 * should point to the the beginning of the
400 * compressed data block.
403 * 1 : csp = Current client state (buffers, headers, etc...)
405 * Returns : JB_ERR_OK on success,
406 * JB_ERR_MEMORY if out-of-memory limit reached, and
407 * JB_ERR_COMPRESS if error decompressing buffer.
409 *********************************************************************/
410 jb_err decompress_iob(struct client_state *csp)
412 char *buf; /* new, uncompressed buffer */
413 char *cur; /* Current iob position (to keep the original
414 * iob->cur unmodified if we return early) */
415 size_t bufsize; /* allocated size of the new buffer */
416 size_t old_size; /* Content size before decompression */
417 size_t skip_size; /* Number of bytes at the beginning of the iob
418 that we should NOT decompress. */
419 int status; /* return status of the inflate() call */
420 z_stream zstr; /* used by calls to zlib */
423 assert(csp->iob->cur - csp->iob->buf >= 0);
424 assert(csp->iob->eod - csp->iob->cur >= 0);
426 assert(csp->iob->cur - csp->iob->buf > 0);
427 assert(csp->iob->eod - csp->iob->cur > 0);
430 bufsize = csp->iob->size;
431 skip_size = (size_t)(csp->iob->cur - csp->iob->buf);
432 old_size = (size_t)(csp->iob->eod - csp->iob->cur);
436 if (bufsize < (size_t)10)
439 * This is to protect the parsing of gzipped data,
440 * but it should(?) be valid for deflated data also.
442 log_error(LOG_LEVEL_ERROR,
443 "Insufficient data to start decompression. Bytes in buffer: %d",
444 csp->iob->eod - csp->iob->cur);
445 return JB_ERR_COMPRESS;
448 if (csp->content_type & CT_GZIP)
451 * Our task is slightly complicated by the facts that data
452 * compressed by gzip does not include a zlib header, and
453 * that there is no easily accessible interface in zlib to
454 * handle a gzip header. We strip off the gzip header by
455 * hand, and later inform zlib not to expect a header.
459 * Strip off the gzip header. Please see RFC 1952 for more
460 * explanation of the appropriate fields.
462 if (((*cur++ & 0xff) != GZIP_IDENTIFIER_1)
463 || ((*cur++ & 0xff) != GZIP_IDENTIFIER_2)
464 || (*cur++ != Z_DEFLATED))
466 log_error(LOG_LEVEL_ERROR, "Invalid gzip header when decompressing");
467 return JB_ERR_COMPRESS;
472 if (flags & GZIP_FLAG_RESERVED_BITS)
474 /* The gzip header has reserved bits set; bail out. */
475 log_error(LOG_LEVEL_ERROR, "Invalid gzip header flags when decompressing");
476 return JB_ERR_COMPRESS;
480 * Skip mtime (4 bytes), extra flags (1 byte)
481 * and OS type (1 byte).
485 /* Skip extra fields if necessary. */
486 if (flags & GZIP_FLAG_EXTRA_FIELDS)
489 * Skip a given number of bytes, specified
490 * as a 16-bit little-endian value.
492 * XXX: this code is untested and should probably be removed.
496 skip_bytes += *cur++ << 8;
499 * The number of bytes to skip should be positive
500 * and we'd like to stay in the buffer.
502 if ((skip_bytes < 0) || (skip_bytes >= (csp->iob->eod - cur)))
504 log_error(LOG_LEVEL_ERROR,
505 "Unreasonable amount of bytes to skip (%d). Stopping decompression",
507 return JB_ERR_COMPRESS;
509 log_error(LOG_LEVEL_INFO,
510 "Skipping %d bytes for gzip compression. Does this sound right?",
515 /* Skip the filename if necessary. */
516 if (flags & GZIP_FLAG_FILE_NAME)
518 /* A null-terminated string is supposed to follow. */
519 while (*cur++ && (cur < csp->iob->eod));
522 /* Skip the comment if necessary. */
523 if (flags & GZIP_FLAG_COMMENT)
525 /* A null-terminated string is supposed to follow. */
526 while (*cur++ && (cur < csp->iob->eod));
529 /* Skip the CRC if necessary. */
530 if (flags & GZIP_FLAG_CHECKSUM)
535 if (cur >= csp->iob->eod)
538 * If the current position pointer reached or passed
539 * the buffer end, we were obviously tricked to skip
542 log_error(LOG_LEVEL_ERROR,
543 "Malformed gzip header detected. Aborting decompression.");
544 return JB_ERR_COMPRESS;
548 else if (csp->content_type & CT_DEFLATE)
551 * In theory (that is, according to RFC 1950), deflate-compressed
552 * data should begin with a two-byte zlib header and have an
553 * adler32 checksum at the end. It seems that in practice only
554 * the raw compressed data is sent. Note that this means that
555 * we are not RFC 1950-compliant here, but the advantage is that
556 * this actually works. :)
558 * We add a dummy null byte to tell zlib where the data ends,
559 * and later inform it not to expect a header.
561 * Fortunately, add_to_iob() has thoughtfully null-terminated
562 * the buffer; we can just increment the end pointer to include
569 log_error(LOG_LEVEL_ERROR,
570 "Unable to determine compression format for decompression");
571 return JB_ERR_COMPRESS;
574 /* Set up the fields required by zlib. */
575 zstr.next_in = (Bytef *)cur;
576 zstr.avail_in = (unsigned int)(csp->iob->eod - cur);
577 zstr.zalloc = Z_NULL;
579 zstr.opaque = Z_NULL;
582 * Passing -MAX_WBITS to inflateInit2 tells the library
583 * that there is no zlib header.
585 if (inflateInit2(&zstr, -MAX_WBITS) != Z_OK)
587 log_error(LOG_LEVEL_ERROR, "Error initializing decompression");
588 return JB_ERR_COMPRESS;
592 * Next, we allocate new storage for the inflated data.
593 * We don't modify the existing iob yet, so in case there
594 * is error in decompression we can recover gracefully.
596 buf = zalloc(bufsize);
599 log_error(LOG_LEVEL_ERROR, "Out of memory decompressing iob");
600 return JB_ERR_MEMORY;
603 assert(bufsize >= skip_size);
604 memcpy(buf, csp->iob->buf, skip_size);
605 zstr.avail_out = (uInt)(bufsize - skip_size);
606 zstr.next_out = (Bytef *)buf + skip_size;
608 /* Try to decompress the whole stream in one shot. */
609 while (Z_BUF_ERROR == (status = inflate(&zstr, Z_FINISH)))
611 /* We need to allocate more memory for the output buffer. */
613 char *tmpbuf; /* used for realloc'ing the buffer */
614 size_t oldbufsize = bufsize; /* keep track of the old bufsize */
616 if (0 == zstr.avail_in)
619 * If zlib wants more data then there's a problem, because
620 * the complete compressed file should have been buffered.
622 log_error(LOG_LEVEL_ERROR,
623 "Unexpected end of compressed iob. Using what we got so far.");
628 * If we reached the buffer limit and still didn't have enough
629 * memory, just give up. Due to the ceiling enforced by the next
630 * if block we could actually check for equality here, but as it
631 * can be easily mistaken for a bug we don't.
633 if (bufsize >= csp->config->buffer_limit)
635 log_error(LOG_LEVEL_ERROR, "Buffer limit reached while decompressing iob");
637 return JB_ERR_MEMORY;
640 /* Try doubling the buffer size each time. */
643 /* Don't exceed the buffer limit. */
644 if (bufsize > csp->config->buffer_limit)
646 bufsize = csp->config->buffer_limit;
649 /* Try to allocate the new buffer. */
650 tmpbuf = realloc(buf, bufsize);
653 log_error(LOG_LEVEL_ERROR, "Out of memory decompressing iob");
655 return JB_ERR_MEMORY;
659 char *oldnext_out = (char *)zstr.next_out;
662 * Update the fields for inflate() to use the new
663 * buffer, which may be in a location different from
666 zstr.avail_out += (uInt)(bufsize - oldbufsize);
667 zstr.next_out = (Bytef *)tmpbuf + bufsize - zstr.avail_out;
670 * Compare with an uglier method of calculating these values
671 * that doesn't require the extra oldbufsize variable.
673 assert(zstr.avail_out == tmpbuf + bufsize - (char *)zstr.next_out);
674 assert((char *)zstr.next_out == tmpbuf + ((char *)oldnext_out - buf));
680 if (Z_STREAM_ERROR == inflateEnd(&zstr))
682 log_error(LOG_LEVEL_ERROR,
683 "Inconsistent stream state after decompression: %s", zstr.msg);
685 * XXX: Intentionally no return.
687 * According to zlib.h, Z_STREAM_ERROR is returned
688 * "if the stream state was inconsistent".
690 * I assume in this case inflate()'s status
691 * would also be something different than Z_STREAM_END
692 * so this check should be redundant, but lets see.
696 if ((status != Z_STREAM_END) && (0 != zstr.avail_in))
699 * We failed to decompress the stream and it's
700 * not simply because of missing data.
702 log_error(LOG_LEVEL_ERROR,
703 "Unexpected error while decompressing to the buffer (iob): %s",
705 return JB_ERR_COMPRESS;
709 * Finally, we can actually update the iob, since the
710 * decompression was successful. First, free the old
713 freez(csp->iob->buf);
715 /* Now, update the iob to use the new buffer. */
717 csp->iob->cur = csp->iob->buf + skip_size;
718 csp->iob->eod = (char *)zstr.next_out;
719 csp->iob->size = bufsize;
722 * Make sure the new uncompressed iob obeys some minimal
723 * consistency conditions.
725 if ((csp->iob->buf <= csp->iob->cur)
726 && (csp->iob->cur <= csp->iob->eod)
727 && (csp->iob->eod <= csp->iob->buf + csp->iob->size))
729 const size_t new_size = (size_t)(csp->iob->eod - csp->iob->cur);
730 if (new_size > (size_t)0)
732 log_error(LOG_LEVEL_RE_FILTER,
733 "Decompression successful. Old size: %d, new size: %d.",
738 /* zlib thinks this is OK, so lets do the same. */
739 log_error(LOG_LEVEL_INFO, "Decompression didn't result in any content.");
744 /* It seems that zlib did something weird. */
745 log_error(LOG_LEVEL_ERROR,
746 "Unexpected error decompressing the buffer (iob): %d==%d, %d>%d, %d<%d",
747 csp->iob->cur, csp->iob->buf + skip_size, csp->iob->eod, csp->iob->buf,
748 csp->iob->eod, csp->iob->buf + csp->iob->size);
749 return JB_ERR_COMPRESS;
755 #endif /* defined(FEATURE_ZLIB) */
758 /*********************************************************************
760 * Function : normalize_lws
762 * Description : Reduces unquoted linear whitespace in headers to
763 * a single space in accordance with RFC 7230 3.2.4.
764 * This simplifies parsing and filtering later on.
767 * 1 : header = A header with linear whitespace to reduce.
771 *********************************************************************/
772 static void normalize_lws(char *header)
778 if (privoxy_isspace(*p) && privoxy_isspace(*(p+1)))
782 while (privoxy_isspace(*q))
786 log_error(LOG_LEVEL_HEADER, "Reducing whitespace in '%s'", header);
792 log_error(LOG_LEVEL_HEADER,
793 "Converting tab to space in '%s'", header);
798 char *end_of_token = strstr(p+1, "\"");
800 if (NULL != end_of_token)
802 /* Don't mess with quoted text. */
807 log_error(LOG_LEVEL_HEADER,
808 "Ignoring single quote in '%s'", header);
814 p = strchr(header, ':');
815 if ((p != NULL) && (p != header) && privoxy_isspace(*(p-1)))
818 * There's still space before the colon.
826 /*********************************************************************
828 * Function : get_header
830 * Description : This (odd) routine will parse the csp->iob
831 * to get the next complete header.
834 * 1 : iob = The I/O buffer to parse, usually csp->iob.
836 * Returns : Any one of the following:
838 * 1) a pointer to a dynamically allocated string that contains a header line
839 * 2) NULL indicating that the end of the header was reached
840 * 3) "" indicating that the end of the iob was reached before finding
841 * a complete header line.
843 *********************************************************************/
844 char *get_header(struct iob *iob)
848 header = get_header_line(iob);
850 if ((header == NULL) || (*header == '\0'))
853 * No complete header read yet, tell the client.
858 while ((iob->cur[0] == ' ') || (iob->cur[0] == '\t'))
861 * Header spans multiple lines, append the next one.
863 char *continued_header;
865 continued_header = get_header_line(iob);
866 if ((continued_header == NULL) || (*continued_header == '\0'))
869 * No complete header read yet, return what we got.
870 * XXX: Should "unread" header instead.
872 log_error(LOG_LEVEL_INFO,
873 "Failed to read a multi-line header properly: '%s'",
878 if (JB_ERR_OK != string_join(&header, continued_header))
880 log_error(LOG_LEVEL_FATAL,
881 "Out of memory while appending multiple headers.");
885 /* XXX: remove before next stable release. */
886 log_error(LOG_LEVEL_HEADER,
887 "Merged multiple header lines to: '%s'",
892 normalize_lws(header);
899 /*********************************************************************
901 * Function : get_header_line
903 * Description : This (odd) routine will parse the csp->iob
904 * to get the next header line.
907 * 1 : iob = The I/O buffer to parse, usually csp->iob.
909 * Returns : Any one of the following:
911 * 1) a pointer to a dynamically allocated string that contains a header line
912 * 2) NULL indicating that the end of the header was reached
913 * 3) "" indicating that the end of the iob was reached before finding
914 * a complete header line.
916 *********************************************************************/
917 static char *get_header_line(struct iob *iob)
921 if ((iob->cur == NULL)
922 || ((p = strchr(iob->cur, '\n')) == NULL))
924 return(""); /* couldn't find a complete header */
929 ret = strdup(iob->cur);
932 /* FIXME No way to handle error properly */
933 log_error(LOG_LEVEL_FATAL, "Out of memory in get_header_line()");
939 if ((q = strchr(ret, '\r')) != NULL) *q = '\0';
941 /* is this a blank line (i.e. the end of the header) ? */
953 /*********************************************************************
955 * Function : get_header_value
957 * Description : Get the value of a given header from a chained list
958 * of header lines or return NULL if no such header is
959 * present in the list.
962 * 1 : header_list = pointer to list
963 * 2 : header_name = string with name of header to look for.
964 * Trailing colon required, capitalization
967 * Returns : NULL if not found, else value of header
969 *********************************************************************/
970 char *get_header_value(const struct list *header_list, const char *header_name)
972 struct list_entry *cur_entry;
978 length = strlen(header_name);
980 for (cur_entry = header_list->first; cur_entry ; cur_entry = cur_entry->next)
984 if (!strncmpic(cur_entry->str, header_name, length))
987 * Found: return pointer to start of value
989 ret = cur_entry->str + length;
990 while (*ret && privoxy_isspace(*ret)) ret++;
1004 /*********************************************************************
1006 * Function : scan_headers
1008 * Description : Scans headers, applies tags and updates action bits.
1011 * 1 : csp = Current client state (buffers, headers, etc...)
1013 * Returns : JB_ERR_OK
1015 *********************************************************************/
1016 static jb_err scan_headers(struct client_state *csp)
1018 struct list_entry *h; /* Header */
1019 jb_err err = JB_ERR_OK;
1021 for (h = csp->headers->first; (err == JB_ERR_OK) && (h != NULL) ; h = h->next)
1023 /* Header crunch()ed in previous run? -> ignore */
1024 if (h->str == NULL) continue;
1025 log_error(LOG_LEVEL_HEADER, "scan: %s", h->str);
1026 err = header_tagger(csp, h->str);
1033 /*********************************************************************
1035 * Function : enforce_header_order
1037 * Description : Enforces a given header order.
1040 * 1 : headers = List of headers to order.
1041 * 2 : ordered_headers = List of ordered header names.
1045 *********************************************************************/
1046 static void enforce_header_order(struct list *headers, const struct list *ordered_headers)
1048 struct list_entry *sorted_header;
1049 struct list new_headers[1];
1050 struct list_entry *header;
1052 init_list(new_headers);
1054 /* The request line is always the first "header" */
1056 assert(NULL != headers->first->str);
1057 enlist(new_headers, headers->first->str);
1058 freez(headers->first->str)
1060 /* Enlist the specified headers in the given order */
1062 for (sorted_header = ordered_headers->first; sorted_header != NULL;
1063 sorted_header = sorted_header->next)
1065 const size_t sorted_header_length = strlen(sorted_header->str);
1066 for (header = headers->first; header != NULL; header = header->next)
1068 /* Header enlisted in previous run? -> ignore */
1069 if (header->str == NULL) continue;
1071 if (0 == strncmpic(sorted_header->str, header->str, sorted_header_length)
1072 && (header->str[sorted_header_length] == ':'))
1074 log_error(LOG_LEVEL_HEADER, "Enlisting sorted header %s", header->str);
1075 if (JB_ERR_OK != enlist(new_headers, header->str))
1077 log_error(LOG_LEVEL_HEADER, "Failed to enlist %s", header->str);
1084 /* Enlist the rest of the headers behind the ordered ones */
1085 for (header = headers->first; header != NULL; header = header->next)
1087 /* Header enlisted in previous run? -> ignore */
1088 if (header->str == NULL) continue;
1090 log_error(LOG_LEVEL_HEADER,
1091 "Enlisting left-over header %s", header->str);
1092 if (JB_ERR_OK != enlist(new_headers, header->str))
1094 log_error(LOG_LEVEL_HEADER, "Failed to enlist %s", header->str);
1099 list_remove_all(headers);
1100 list_duplicate(headers, new_headers);
1101 list_remove_all(new_headers);
1107 /*********************************************************************
1111 * Description : add, delete or modify lines in the HTTP header streams.
1112 * On entry, it receives a linked list of headers space
1113 * that was allocated dynamically (both the list nodes
1114 * and the header contents).
1116 * As a side effect it frees the space used by the original
1120 * 1 : csp = Current client state (buffers, headers, etc...)
1121 * 2 : filter_server_headers = Boolean to switch between
1122 * server and header filtering.
1124 * Returns : JB_ERR_OK in case off success, or
1125 * JB_ERR_MEMORY on some out-of-memory errors, or
1126 * JB_ERR_PARSE in case of fatal parse errors.
1128 *********************************************************************/
1129 jb_err sed(struct client_state *csp, int filter_server_headers)
1131 /* XXX: use more descriptive names. */
1132 struct list_entry *p;
1133 const struct parsers *v;
1134 const add_header_func_ptr *f;
1135 jb_err err = JB_ERR_OK;
1139 if (filter_server_headers)
1141 v = server_patterns;
1142 f = add_server_headers;
1143 check_negative_tag_patterns(csp, PATTERN_SPEC_NO_RESPONSE_TAG_PATTERN);
1147 v = client_patterns;
1148 f = add_client_headers;
1149 check_negative_tag_patterns(csp, PATTERN_SPEC_NO_REQUEST_TAG_PATTERN);
1152 while (v->str != NULL)
1154 for (p = csp->headers->first; p != NULL; p = p->next)
1156 /* Header crunch()ed in previous run? -> ignore */
1157 if (p->str == NULL) continue;
1159 /* Does the current parser handle this header? */
1160 if ((strncmpic(p->str, v->str, v->len) == 0) ||
1161 (v->len == CHECK_EVERY_HEADER_REMAINING))
1163 err = v->parser(csp, &(p->str));
1164 if (err != JB_ERR_OK)
1173 /* place additional headers on the csp->headers list */
1174 while ((err == JB_ERR_OK) && (*f))
1180 if (!filter_server_headers && !list_is_empty(csp->config->ordered_client_headers))
1182 enforce_header_order(csp->headers, csp->config->ordered_client_headers);
1189 #ifdef FEATURE_HTTPS_INSPECTION
1190 /*********************************************************************
1192 * Function : sed_https
1194 * Description : add, delete or modify lines in the HTTPS client
1195 * header streams. Wrapper around sed().
1198 * 1 : csp = Current client state (buffers, headers, etc...)
1200 * Returns : JB_ERR_OK in case off success, or
1201 * JB_ERR_MEMORY on some out-of-memory errors, or
1202 * JB_ERR_PARSE in case of fatal parse errors.
1204 *********************************************************************/
1205 jb_err sed_https(struct client_state *csp)
1208 struct list headers;
1211 * Temporarily replace csp->headers with csp->https_headers
1212 * to trick sed() into filtering the https headers.
1214 headers.first = csp->headers->first;
1215 headers.last = csp->headers->last;
1216 csp->headers->first = csp->https_headers->first;
1217 csp->headers->last = csp->https_headers->last;
1220 * Start with fresh tags. Already existing tags may
1221 * be set again. This is necessary to overrule
1222 * URL-based patterns.
1224 destroy_list(csp->tags);
1227 * We want client header filters and taggers
1228 * so temporarily remove the flag.
1230 csp->flags &= ~CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
1231 err = sed(csp, FILTER_CLIENT_HEADERS);
1232 csp->flags |= CSP_FLAG_CLIENT_HEADER_PARSING_DONE;
1235 * Update the last header which may have changed
1236 * due to header additions,
1238 csp->https_headers->last = csp->headers->last;
1240 csp->headers->first = headers.first;
1241 csp->headers->last = headers.last;
1245 #endif /* def FEATURE_HTTPS_INSPECTION */
1248 /*********************************************************************
1250 * Function : update_server_headers
1252 * Description : Updates server headers after the body has been modified.
1255 * 1 : csp = Current client state (buffers, headers, etc...)
1257 * Returns : JB_ERR_OK in case off success, or
1258 * JB_ERR_MEMORY on out-of-memory error.
1260 *********************************************************************/
1261 jb_err update_server_headers(struct client_state *csp)
1263 jb_err err = JB_ERR_OK;
1265 static const struct parsers server_patterns_light[] = {
1266 { "Content-Length:", 15, server_adjust_content_length },
1267 { "Transfer-Encoding:", 18, server_transfer_coding },
1269 { "Content-Encoding:", 17, server_adjust_content_encoding },
1270 #endif /* def FEATURE_ZLIB */
1274 if (strncmpic(csp->http->cmd, "HEAD", 4))
1276 const struct parsers *v;
1277 struct list_entry *p;
1279 for (v = server_patterns_light; (err == JB_ERR_OK) && (v->str != NULL); v++)
1281 for (p = csp->headers->first; (err == JB_ERR_OK) && (p != NULL); p = p->next)
1283 /* Header crunch()ed in previous run? -> ignore */
1284 if (p->str == NULL) continue;
1286 /* Does the current parser handle this header? */
1287 if (strncmpic(p->str, v->str, v->len) == 0)
1289 err = v->parser(csp, (char **)&(p->str));
1295 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1296 if ((JB_ERR_OK == err)
1297 && (csp->flags & CSP_FLAG_MODIFIED)
1298 && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
1299 && !(csp->flags & CSP_FLAG_SERVER_CONTENT_LENGTH_SET))
1303 create_content_length_header(csp->content_length, header, sizeof(header));
1304 err = enlist(csp->headers, header);
1305 if (JB_ERR_OK == err)
1307 log_error(LOG_LEVEL_HEADER,
1308 "Content modified with no Content-Length header set. "
1309 "Created: %s.", header);
1310 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
1313 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1315 #ifdef FEATURE_COMPRESSION
1316 if ((JB_ERR_OK == err)
1317 && (csp->flags & CSP_FLAG_BUFFERED_CONTENT_DEFLATED))
1319 err = enlist_unique_header(csp->headers, "Content-Encoding", "deflate");
1320 if (JB_ERR_OK == err)
1322 log_error(LOG_LEVEL_HEADER, "Added header: Content-Encoding: deflate");
1331 /*********************************************************************
1333 * Function : header_tagger
1335 * Description : Executes all text substitutions from applying
1336 * tag actions and saves the result as tag.
1338 * XXX: Shares enough code with filter_header() and
1339 * pcrs_filter_response() to warrant some helper functions.
1342 * 1 : csp = Current client state (buffers, headers, etc...)
1343 * 2 : header = Header that is used as tagger input
1345 * Returns : JB_ERR_OK on success and always succeeds
1347 *********************************************************************/
1348 static jb_err header_tagger(struct client_state *csp, char *header)
1350 enum filter_type wanted_filter_type;
1351 int multi_action_index;
1354 struct re_filterfile_spec *b;
1355 struct list_entry *tag_name;
1357 const size_t header_length = strlen(header);
1359 if (csp->flags & CSP_FLAG_CLIENT_HEADER_PARSING_DONE)
1361 wanted_filter_type = FT_SERVER_HEADER_TAGGER;
1362 multi_action_index = ACTION_MULTI_SERVER_HEADER_TAGGER;
1366 wanted_filter_type = FT_CLIENT_HEADER_TAGGER;
1367 multi_action_index = ACTION_MULTI_CLIENT_HEADER_TAGGER;
1370 if (list_is_empty(csp->action->multi[multi_action_index])
1371 || filters_available(csp) == FALSE)
1373 /* Return early if no taggers apply or if none are available. */
1377 /* Execute all applying taggers */
1378 for (tag_name = csp->action->multi[multi_action_index]->first;
1379 NULL != tag_name; tag_name = tag_name->next)
1381 char *modified_tag = NULL;
1383 size_t size = header_length;
1386 b = get_filter(csp, tag_name->str, wanted_filter_type);
1392 joblist = b->joblist;
1394 if (b->dynamic) joblist = compile_dynamic_pcrs_job_list(csp, b);
1396 if (NULL == joblist)
1398 log_error(LOG_LEVEL_RE_FILTER,
1399 "Tagger %s has empty joblist. Nothing to do.", b->name);
1403 /* execute their pcrs_joblist on the header. */
1404 for (job = joblist; NULL != job; job = job->next)
1406 const int hits = pcrs_execute(job, tag, size, &modified_tag, &size);
1410 /* Success, continue with the modified version. */
1419 /* Tagger doesn't match */
1422 /* Regex failure, log it but continue anyway. */
1423 assert(NULL != header);
1424 log_error(LOG_LEVEL_ERROR,
1425 "Problems with tagger \'%s\' and header \'%s\': %s",
1426 b->name, *header, pcrs_strerror(hits));
1428 freez(modified_tag);
1432 if (b->dynamic) pcrs_free_joblist(joblist);
1434 /* If this tagger matched */
1440 * There is no technical limitation which makes
1441 * it impossible to use empty tags, but I assume
1442 * no one would do it intentionally.
1445 log_error(LOG_LEVEL_INFO,
1446 "Tagger \'%s\' created an empty tag. Ignored.", b->name);
1450 if (!list_contains_item(csp->tags, tag))
1452 if (JB_ERR_OK != enlist(csp->tags, tag))
1454 log_error(LOG_LEVEL_ERROR,
1455 "Insufficient memory to add tag \'%s\', "
1456 "based on tagger \'%s\' and header \'%s\'",
1457 tag, b->name, *header);
1461 char *action_message;
1463 * update the action bits right away, to make
1464 * tagging based on tags set by earlier taggers
1465 * of the same kind possible.
1467 if (update_action_bits_for_tag(csp, tag))
1469 action_message = "Action bits updated accordingly.";
1473 action_message = "No action bits update necessary.";
1476 log_error(LOG_LEVEL_HEADER,
1477 "Tagger \'%s\' added tag \'%s\'. %s",
1478 b->name, tag, action_message);
1483 /* XXX: Is this log-worthy? */
1484 log_error(LOG_LEVEL_HEADER,
1485 "Tagger \'%s\' didn't add tag \'%s\'. Tag already present",
1495 /* here begins the family of parser functions that reformat header lines */
1497 /*********************************************************************
1499 * Function : filter_header
1501 * Description : Executes all text substitutions from all applying
1502 * +(server|client)-header-filter actions on the header.
1503 * Most of the code was copied from pcrs_filter_response,
1504 * including the rather short variable names
1507 * 1 : csp = Current client state (buffers, headers, etc...)
1508 * 2 : header = On input, pointer to header to modify.
1509 * On output, pointer to the modified header, or NULL
1510 * to remove the header. This function frees the
1511 * original string if necessary.
1513 * Returns : JB_ERR_OK on success and always succeeds
1515 *********************************************************************/
1516 static jb_err filter_header(struct client_state *csp, char **header)
1520 size_t size = strlen(*header);
1522 char *newheader = NULL;
1525 struct re_filterfile_spec *b;
1526 struct list_entry *filtername;
1528 enum filter_type wanted_filter_type;
1529 int multi_action_index;
1531 if (csp->flags & CSP_FLAG_NO_FILTERING)
1536 if (csp->flags & CSP_FLAG_CLIENT_HEADER_PARSING_DONE)
1538 wanted_filter_type = FT_SERVER_HEADER_FILTER;
1539 multi_action_index = ACTION_MULTI_SERVER_HEADER_FILTER;
1543 wanted_filter_type = FT_CLIENT_HEADER_FILTER;
1544 multi_action_index = ACTION_MULTI_CLIENT_HEADER_FILTER;
1547 if (list_is_empty(csp->action->multi[multi_action_index])
1548 || filters_available(csp) == FALSE)
1550 /* Return early if no filters apply or if none are available. */
1554 /* Execute all applying header filters */
1555 for (filtername = csp->action->multi[multi_action_index]->first;
1556 filtername != NULL; filtername = filtername->next)
1558 int current_hits = 0;
1561 b = get_filter(csp, filtername->str, wanted_filter_type);
1567 joblist = b->joblist;
1569 if (b->dynamic) joblist = compile_dynamic_pcrs_job_list(csp, b);
1571 if (NULL == joblist)
1573 log_error(LOG_LEVEL_RE_FILTER, "Filter %s has empty joblist. Nothing to do.", b->name);
1577 log_error(LOG_LEVEL_RE_FILTER, "filtering \'%s\' (size %d) with \'%s\' ...",
1578 *header, size, b->name);
1580 /* Apply all jobs from the joblist */
1581 for (job = joblist; NULL != job; job = job->next)
1583 matches = pcrs_execute(job, *header, size, &newheader, &size);
1586 current_hits += matches;
1587 log_error(LOG_LEVEL_HEADER, "Transforming \"%s\" to \"%s\"", *header, newheader);
1589 *header = newheader;
1591 else if (0 == matches)
1593 /* Filter doesn't change header */
1599 log_error(LOG_LEVEL_ERROR, "Filtering \'%s\' with \'%s\' didn't work out: %s",
1600 *header, b->name, pcrs_strerror(matches));
1601 if (newheader != NULL)
1603 log_error(LOG_LEVEL_ERROR, "Freeing what's left: %s", newheader);
1609 if (b->dynamic) pcrs_free_joblist(joblist);
1611 log_error(LOG_LEVEL_RE_FILTER, "... produced %d hits (new size %d).", current_hits, size);
1612 hits += current_hits;
1616 * Additionally checking for hits is important because if
1617 * the continue hack is triggered, server headers can
1618 * arrive empty to separate multiple heads from each other.
1620 if ((0 == size) && hits)
1622 log_error(LOG_LEVEL_HEADER, "Removing empty header %s", *header);
1630 /*********************************************************************
1632 * Function : server_connection
1634 * Description : Makes sure a proper "Connection:" header is
1635 * set and signals connection_header_adder to
1639 * 1 : csp = Current client state (buffers, headers, etc...)
1640 * 2 : header = On input, pointer to header to modify.
1641 * On output, pointer to the modified header, or NULL
1642 * to remove the header. This function frees the
1643 * original string if necessary.
1645 * Returns : JB_ERR_OK on success.
1647 *********************************************************************/
1648 static jb_err server_connection(struct client_state *csp, char **header)
1650 if (!strcmpic(*header, "Connection: keep-alive")
1651 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1652 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
1656 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1657 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE))
1659 csp->flags |= CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE;
1662 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE))
1664 log_error(LOG_LEVEL_HEADER,
1665 "Keeping the server header '%s' around.", *header);
1668 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
1670 char *old_header = *header;
1672 *header = strdup_or_die("Connection: close");
1673 log_error(LOG_LEVEL_HEADER, "Replaced: \'%s\' with \'%s\'", old_header, *header);
1678 /* Signal server_connection_adder() to return early. */
1679 csp->flags |= CSP_FLAG_SERVER_CONNECTION_HEADER_SET;
1685 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1686 /*********************************************************************
1688 * Function : server_keep_alive
1690 * Description : Stores the server's keep alive timeout.
1693 * 1 : csp = Current client state (buffers, headers, etc...)
1694 * 2 : header = On input, pointer to header to modify.
1695 * On output, pointer to the modified header, or NULL
1696 * to remove the header. This function frees the
1697 * original string if necessary.
1699 * Returns : JB_ERR_OK.
1701 *********************************************************************/
1702 static jb_err server_keep_alive(struct client_state *csp, char **header)
1704 unsigned int keep_alive_timeout;
1705 const char *timeout_position = strstr(*header, "timeout=");
1707 if ((NULL == timeout_position)
1708 || (1 != sscanf(timeout_position, "timeout=%u", &keep_alive_timeout)))
1710 log_error(LOG_LEVEL_ERROR, "Couldn't parse: %s", *header);
1714 if (keep_alive_timeout < csp->server_connection.keep_alive_timeout)
1716 log_error(LOG_LEVEL_HEADER,
1717 "Reducing keep-alive timeout from %u to %u.",
1718 csp->server_connection.keep_alive_timeout, keep_alive_timeout);
1719 csp->server_connection.keep_alive_timeout = keep_alive_timeout;
1723 /* XXX: Is this log worthy? */
1724 log_error(LOG_LEVEL_HEADER,
1725 "Server keep-alive timeout is %u. Sticking with %u.",
1726 keep_alive_timeout, csp->server_connection.keep_alive_timeout);
1728 csp->flags |= CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET;
1737 /*********************************************************************
1739 * Function : server_proxy_connection
1741 * Description : Figures out whether or not we should add a
1742 * Proxy-Connection header.
1745 * 1 : csp = Current client state (buffers, headers, etc...)
1746 * 2 : header = On input, pointer to header to modify.
1747 * On output, pointer to the modified header, or NULL
1748 * to remove the header. This function frees the
1749 * original string if necessary.
1751 * Returns : JB_ERR_OK.
1753 *********************************************************************/
1754 static jb_err server_proxy_connection(struct client_state *csp, char **header)
1756 csp->flags |= CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET;
1761 /*********************************************************************
1763 * Function : proxy_authentication
1765 * Description : Removes headers that are relevant for proxy
1766 * authentication unless forwarding them has
1767 * been explicitly requested.
1770 * 1 : csp = Current client state (buffers, headers, etc...)
1771 * 2 : header = On input, pointer to header to modify.
1772 * On output, pointer to the modified header, or NULL
1773 * to remove the header. This function frees the
1774 * original string if necessary.
1776 * Returns : JB_ERR_OK.
1778 *********************************************************************/
1779 static jb_err proxy_authentication(struct client_state *csp, char **header)
1781 if ((csp->config->feature_flags &
1782 RUNTIME_FEATURE_FORWARD_PROXY_AUTHENTICATION_HEADERS) == 0) {
1783 log_error(LOG_LEVEL_HEADER,
1784 "Forwarding proxy authentication headers is disabled. Crunching: %s", *header);
1791 /*********************************************************************
1793 * Function : client_keep_alive
1795 * Description : Stores the client's keep alive timeout.
1798 * 1 : csp = Current client state (buffers, headers, etc...)
1799 * 2 : header = On input, pointer to header to modify.
1800 * On output, pointer to the modified header, or NULL
1801 * to remove the header. This function frees the
1802 * original string if necessary.
1804 * Returns : JB_ERR_OK.
1806 *********************************************************************/
1807 static jb_err client_keep_alive(struct client_state *csp, char **header)
1809 unsigned int keep_alive_timeout;
1810 char *timeout_position;
1812 if (!(csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE))
1814 log_error(LOG_LEVEL_HEADER,
1815 "keep-alive support is disabled. Crunching: %s.", *header);
1820 /* Check for parameter-less format "Keep-Alive: 100" */
1821 timeout_position = strstr(*header, ": ");
1822 if ((NULL == timeout_position)
1823 || (1 != sscanf(timeout_position, ": %u", &keep_alive_timeout)))
1825 /* Assume parameter format "Keep-Alive: timeout=100" */
1826 timeout_position = strstr(*header, "timeout=");
1827 if ((NULL == timeout_position)
1828 || (1 != sscanf(timeout_position, "timeout=%u", &keep_alive_timeout)))
1830 log_error(LOG_LEVEL_HEADER,
1831 "Couldn't parse: '%s'. Using default timeout %u",
1832 *header, csp->config->keep_alive_timeout);
1839 if (keep_alive_timeout < csp->config->keep_alive_timeout)
1841 log_error(LOG_LEVEL_HEADER,
1842 "Reducing keep-alive timeout from %u to %u.",
1843 csp->config->keep_alive_timeout, keep_alive_timeout);
1844 csp->server_connection.keep_alive_timeout = keep_alive_timeout;
1848 /* XXX: Is this log worthy? */
1849 log_error(LOG_LEVEL_HEADER,
1850 "Client keep-alive timeout is %u. Sticking with %u.",
1851 keep_alive_timeout, csp->config->keep_alive_timeout);
1859 /*********************************************************************
1861 * Function : get_content_length
1863 * Description : Gets the content length specified in a
1864 * Content-Length header.
1867 * 1 : header_value = The Content-Length header value.
1868 * 2 : length = Storage to return the value.
1870 * Returns : JB_ERR_OK on success, or
1871 * JB_ERR_PARSE if no value is recognized.
1873 *********************************************************************/
1874 static jb_err get_content_length(const char *header_value, unsigned long long *length)
1877 #if SIZEOF_LONG_LONG < 8
1878 #error sizeof(unsigned long long) too small
1880 if (1 != sscanf(header_value, "%I64u", length))
1882 if (1 != sscanf(header_value, "%llu", length))
1885 return JB_ERR_PARSE;
1892 /*********************************************************************
1894 * Function : client_save_content_length
1896 * Description : Save the Content-Length sent by the client.
1899 * 1 : csp = Current client state (buffers, headers, etc...)
1900 * 2 : header = On input, pointer to header to modify.
1901 * On output, pointer to the modified header, or NULL
1902 * to remove the header. This function frees the
1903 * original string if necessary.
1905 * Returns : JB_ERR_OK on success, or
1906 * JB_ERR_MEMORY on out-of-memory error.
1908 *********************************************************************/
1909 static jb_err client_save_content_length(struct client_state *csp, char **header)
1911 unsigned long long content_length = 0;
1912 const char *header_value;
1914 assert(*(*header+14) == ':');
1916 header_value = *header + 15;
1917 if (JB_ERR_OK != get_content_length(header_value, &content_length))
1919 log_error(LOG_LEVEL_ERROR, "Crunching invalid header: %s", *header);
1924 csp->expected_client_content_length = content_length;
1929 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
1933 /*********************************************************************
1935 * Function : client_connection
1937 * Description : Makes sure a proper "Connection:" header is
1938 * set and signals connection_header_adder
1942 * 1 : csp = Current client state (buffers, headers, etc...)
1943 * 2 : header = On input, pointer to header to modify.
1944 * On output, pointer to the modified header, or NULL
1945 * to remove the header. This function frees the
1946 * original string if necessary.
1948 * Returns : JB_ERR_OK on success.
1950 *********************************************************************/
1951 static jb_err client_connection(struct client_state *csp, char **header)
1953 static const char connection_close[] = "Connection: close";
1955 if (!strcmpic(*header, connection_close))
1957 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1958 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_SHARING)
1959 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED))
1961 if (!strcmpic(csp->http->version, "HTTP/1.1"))
1963 log_error(LOG_LEVEL_HEADER,
1964 "Removing \'%s\' to imply keep-alive.", *header);
1967 * While we imply keep-alive to the server,
1968 * we have to remember that the client didn't.
1970 csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1974 char *old_header = *header;
1976 *header = strdup_or_die("Connection: keep-alive");
1977 log_error(LOG_LEVEL_HEADER,
1978 "Replaced: \'%s\' with \'%s\'", old_header, *header);
1984 log_error(LOG_LEVEL_HEADER,
1985 "Keeping the client header '%s' around. "
1986 "The connection will not be kept alive.",
1988 csp->flags &= ~CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1991 else if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
1992 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED))
1994 log_error(LOG_LEVEL_HEADER,
1995 "Keeping the client header '%s' around. "
1996 "The server connection will be kept alive if possible.",
1998 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
1999 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2003 char *old_header = *header;
2005 *header = strdup_or_die(connection_close);
2006 log_error(LOG_LEVEL_HEADER,
2007 "Replaced: \'%s\' with \'%s\'", old_header, *header);
2011 /* Signal client_connection_header_adder() to return early. */
2012 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_HEADER_SET;
2018 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2019 /*********************************************************************
2021 * Function : client_proxy_connection
2023 * Description : Sets the CLIENT_CONNECTION_KEEP_ALIVE flag when
2024 * appropriate and removes the Proxy-Connection
2028 * 1 : csp = Current client state (buffers, headers, etc...)
2029 * 2 : header = On input, pointer to header to modify.
2030 * On output, pointer to the modified header, or NULL
2031 * to remove the header. This function frees the
2032 * original string if necessary.
2034 * Returns : JB_ERR_OK
2036 *********************************************************************/
2037 static jb_err client_proxy_connection(struct client_state *csp, char **header)
2039 if (0 == (csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
2040 && (csp->http->ssl == 0)
2041 && (NULL == strstr(*header, "close")))
2043 log_error(LOG_LEVEL_HEADER,
2044 "The client connection can be kept alive due to: %s", *header);
2045 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
2047 crumble(csp, header);
2051 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2054 /*********************************************************************
2056 * Function : client_transfer_encoding
2058 * Description : Raise the CSP_FLAG_CHUNKED_CLIENT_BODY flag if
2059 * the request body is "chunked"
2061 * XXX: Currently not called through sed() as we
2062 * need the flag earlier on. Should be fixed.
2065 * 1 : csp = Current client state (buffers, headers, etc...)
2066 * 2 : header = On input, pointer to header to modify.
2067 * On output, pointer to the modified header, or NULL
2068 * to remove the header. This function frees the
2069 * original string if necessary.
2071 * Returns : JB_ERR_OK on success, or
2073 *********************************************************************/
2074 jb_err client_transfer_encoding(struct client_state *csp, char **header)
2076 if (strstr(*header, "chunked"))
2078 csp->flags |= CSP_FLAG_CHUNKED_CLIENT_BODY;
2079 log_error(LOG_LEVEL_HEADER, "Expecting chunked client body");
2086 /*********************************************************************
2088 * Function : client_expect
2090 * Description : Raise the CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION
2091 * if the Expect header value is unsupported.
2093 * Rejecting unsupported expectations is a RFC 7231 5.1.1
2094 * MAY and a RFC 2616 (obsolete) MUST.
2097 * 1 : csp = Current client state (buffers, headers, etc...)
2098 * 2 : header = On input, pointer to header to modify.
2099 * On output, pointer to the modified header, or NULL
2100 * to remove the header. This function frees the
2101 * original string if necessary.
2103 * Returns : JB_ERR_OK on success, or
2105 *********************************************************************/
2106 jb_err client_expect(struct client_state *csp, char **header)
2108 if (0 != strcmpic(*header, "Expect: 100-continue"))
2110 csp->flags |= CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION;
2111 log_error(LOG_LEVEL_HEADER,
2112 "Unsupported client expectaction: %s", *header);
2120 /*********************************************************************
2122 * Function : crumble
2124 * Description : This is called if a header matches a pattern to "crunch"
2127 * 1 : csp = Current client state (buffers, headers, etc...)
2128 * 2 : header = On input, pointer to header to modify.
2129 * On output, pointer to the modified header, or NULL
2130 * to remove the header. This function frees the
2131 * original string if necessary.
2133 * Returns : JB_ERR_OK on success, or
2134 * JB_ERR_MEMORY on out-of-memory error.
2136 *********************************************************************/
2137 static jb_err crumble(struct client_state *csp, char **header)
2140 log_error(LOG_LEVEL_HEADER, "crumble crunched: %s!", *header);
2146 /*********************************************************************
2148 * Function : crunch_server_header
2150 * Description : Crunch server header if it matches a string supplied by the
2151 * user. Called from `sed'.
2154 * 1 : csp = Current client state (buffers, headers, etc...)
2155 * 2 : header = On input, pointer to header to modify.
2156 * On output, pointer to the modified header, or NULL
2157 * to remove the header. This function frees the
2158 * original string if necessary.
2160 * Returns : JB_ERR_OK on success and always succeeds
2162 *********************************************************************/
2163 static jb_err crunch_server_header(struct client_state *csp, char **header)
2165 const char *crunch_pattern;
2167 /* Do we feel like crunching? */
2168 if ((csp->action->flags & ACTION_CRUNCH_SERVER_HEADER))
2170 crunch_pattern = csp->action->string[ACTION_STRING_SERVER_HEADER];
2172 /* Is the current header the lucky one? */
2173 if (strstr(*header, crunch_pattern))
2175 log_error(LOG_LEVEL_HEADER, "Crunching server header: %s (contains: %s)", *header, crunch_pattern);
2184 /*********************************************************************
2186 * Function : server_content_type
2188 * Description : Set the content-type for filterable types (text/.*,
2189 * .*xml.*, .*script.* and image/gif) unless filtering has been
2190 * forbidden (CT_TABOO) while parsing earlier headers.
2191 * NOTE: Since text/plain is commonly used by web servers
2192 * for files whose correct type is unknown, we don't
2193 * set CT_TEXT for it.
2196 * 1 : csp = Current client state (buffers, headers, etc...)
2197 * 2 : header = On input, pointer to header to modify.
2198 * On output, pointer to the modified header, or NULL
2199 * to remove the header. This function frees the
2200 * original string if necessary.
2202 * Returns : JB_ERR_OK on success, or
2203 * JB_ERR_MEMORY on out-of-memory error.
2205 *********************************************************************/
2206 static jb_err server_content_type(struct client_state *csp, char **header)
2208 /* Remove header if it isn't the first Content-Type header */
2209 if ((csp->content_type & CT_DECLARED))
2211 if (content_filters_enabled(csp->action))
2214 * Making sure the client interprets the content the same way
2215 * Privoxy did is only relevant if Privoxy modified it.
2217 * Checking for this is "hard" as it's not yet known when
2218 * this function is called, thus go shopping and and just
2219 * check if Privoxy could filter it.
2221 * The main thing is that we don't mess with the headers
2222 * unless the user signalled that it's acceptable.
2224 log_error(LOG_LEVEL_HEADER,
2225 "Multiple Content-Type headers detected. "
2226 "Removing and ignoring: %s",
2234 * Signal that the Content-Type has been set.
2236 csp->content_type |= CT_DECLARED;
2238 if (!(csp->content_type & CT_TABOO))
2241 * XXX: The assumption that text/plain is a sign of
2242 * binary data seems to be somewhat unreasonable nowadays
2243 * and should be dropped after 3.0.8 is out.
2245 if ((strstr(*header, "text/") && !strstr(*header, "plain"))
2246 || strstr(*header, "xml")
2247 || strstr(*header, "script"))
2249 csp->content_type |= CT_TEXT;
2251 else if (strstr(*header, "image/gif"))
2253 csp->content_type |= CT_GIF;
2258 * Are we messing with the content type?
2260 if (csp->action->flags & ACTION_CONTENT_TYPE_OVERWRITE)
2263 * Make sure the user doesn't accidentally
2264 * change the content type of binary documents.
2266 if ((csp->content_type & CT_TEXT) || (csp->action->flags & ACTION_FORCE_TEXT_MODE))
2270 *header = strdup_or_die("Content-Type: ");
2272 err = string_append(header, csp->action->string[ACTION_STRING_CONTENT_TYPE]);
2273 if (JB_ERR_OK != err)
2275 log_error(LOG_LEVEL_HEADER, "Insufficient memory to replace Content-Type!");
2276 return JB_ERR_MEMORY;
2278 log_error(LOG_LEVEL_HEADER, "Modified: %s!", *header);
2282 log_error(LOG_LEVEL_HEADER, "%s not replaced. "
2283 "It doesn't look like a content type that should be filtered. "
2284 "Enable force-text-mode if you know what you're doing.", *header);
2292 /*********************************************************************
2294 * Function : server_transfer_coding
2296 * Description : - Prohibit filtering (CT_TABOO) if transfer coding compresses
2297 * - Raise the CSP_FLAG_CHUNKED flag if coding is "chunked"
2298 * - Remove header if body was chunked but has been
2299 * de-chunked for filtering.
2302 * 1 : csp = Current client state (buffers, headers, etc...)
2303 * 2 : header = On input, pointer to header to modify.
2304 * On output, pointer to the modified header, or NULL
2305 * to remove the header. This function frees the
2306 * original string if necessary.
2308 * Returns : JB_ERR_OK on success, or
2309 * JB_ERR_MEMORY on out-of-memory error.
2311 *********************************************************************/
2312 static jb_err server_transfer_coding(struct client_state *csp, char **header)
2315 * Turn off pcrs and gif filtering if body compressed
2317 if (strstr(*header, "gzip") || strstr(*header, "compress") || strstr(*header, "deflate"))
2321 * XXX: Added to test if we could use CT_GZIP and CT_DEFLATE here.
2323 log_error(LOG_LEVEL_INFO, "Marking content type for %s as CT_TABOO because of %s.",
2324 csp->http->cmd, *header);
2325 #endif /* def FEATURE_ZLIB */
2326 csp->content_type = CT_TABOO;
2330 * Raise flag if body chunked
2332 if (strstr(*header, "chunked"))
2334 csp->flags |= CSP_FLAG_CHUNKED;
2337 * If the body was modified, it has been de-chunked first
2338 * and the header must be removed.
2340 * FIXME: If there is more than one transfer encoding,
2341 * only the "chunked" part should be removed here.
2343 if (csp->flags & CSP_FLAG_MODIFIED)
2345 log_error(LOG_LEVEL_HEADER, "Removing: %s", *header);
2354 /*********************************************************************
2356 * Function : server_content_encoding
2358 * Description : Used to check if the content is compressed, and if
2359 * FEATURE_ZLIB is disabled, filtering is disabled as
2362 * If FEATURE_ZLIB is enabled and the compression type
2363 * supported, the content is marked for decompression.
2365 * XXX: Doesn't properly deal with multiple or with
2366 * unsupported but unknown encodings.
2367 * Is case-sensitive but shouldn't be.
2370 * 1 : csp = Current client state (buffers, headers, etc...)
2371 * 2 : header = On input, pointer to header to modify.
2372 * On output, pointer to the modified header, or NULL
2373 * to remove the header. This function frees the
2374 * original string if necessary.
2376 * Returns : JB_ERR_OK on success, or
2377 * JB_ERR_MEMORY on out-of-memory error.
2379 *********************************************************************/
2380 static jb_err server_content_encoding(struct client_state *csp, char **header)
2383 if (strstr(*header, "sdch"))
2386 * Shared Dictionary Compression over HTTP isn't supported,
2387 * filtering it anyway is pretty much guaranteed to mess up
2390 csp->content_type |= CT_TABOO;
2393 * Log a warning if the user expects the content to be filtered.
2395 if (content_filters_enabled(csp->action))
2397 log_error(LOG_LEVEL_INFO,
2398 "SDCH-compressed content detected, content filtering disabled. "
2399 "Consider suppressing SDCH offers made by the client.");
2402 else if (strstr(*header, "gzip"))
2404 /* Mark for gzip decompression */
2405 csp->content_type |= CT_GZIP;
2407 else if (strstr(*header, "deflate"))
2409 /* Mark for zlib decompression */
2410 csp->content_type |= CT_DEFLATE;
2412 else if (strstr(*header, "compress"))
2415 * We can't decompress this; therefore we can't filter
2418 csp->content_type |= CT_TABOO;
2420 #else /* !defined(FEATURE_ZLIB) */
2422 * XXX: Using a black list here isn't the right approach.
2424 * In case of SDCH, building with zlib support isn't
2427 if (strstr(*header, "gzip") ||
2428 strstr(*header, "compress") ||
2429 strstr(*header, "deflate") ||
2430 strstr(*header, "sdch"))
2433 * Body is compressed, turn off pcrs and gif filtering.
2435 csp->content_type |= CT_TABOO;
2438 * Log a warning if the user expects the content to be filtered.
2440 if (content_filters_enabled(csp->action))
2442 log_error(LOG_LEVEL_INFO,
2443 "Compressed content detected, content filtering disabled. "
2444 "Consider recompiling Privoxy with zlib support or "
2445 "enable the prevent-compression action.");
2448 #endif /* defined(FEATURE_ZLIB) */
2456 /*********************************************************************
2458 * Function : server_adjust_content_encoding
2460 * Description : Remove the Content-Encoding header if the
2461 * decompression was successful and the content
2462 * has been modified.
2465 * 1 : csp = Current client state (buffers, headers, etc...)
2466 * 2 : header = On input, pointer to header to modify.
2467 * On output, pointer to the modified header, or NULL
2468 * to remove the header. This function frees the
2469 * original string if necessary.
2471 * Returns : JB_ERR_OK on success, or
2472 * JB_ERR_MEMORY on out-of-memory error.
2474 *********************************************************************/
2475 static jb_err server_adjust_content_encoding(struct client_state *csp, char **header)
2477 if ((csp->flags & CSP_FLAG_MODIFIED)
2478 && (csp->content_type & (CT_GZIP | CT_DEFLATE)))
2481 * We successfully decompressed the content,
2482 * and have to clean the header now, so the
2483 * client no longer expects compressed data.
2485 * XXX: There is a difference between cleaning
2486 * and removing it completely.
2488 log_error(LOG_LEVEL_HEADER, "Crunching: %s", *header);
2495 #endif /* defined(FEATURE_ZLIB) */
2498 /*********************************************************************
2500 * Function : server_adjust_content_length
2502 * Description : Adjust Content-Length header if we modified
2506 * 1 : csp = Current client state (buffers, headers, etc...)
2507 * 2 : header = On input, pointer to header to modify.
2508 * On output, pointer to the modified header, or NULL
2509 * to remove the header. This function frees the
2510 * original string if necessary.
2512 * Returns : JB_ERR_OK on success, or
2513 * JB_ERR_MEMORY on out-of-memory error.
2515 *********************************************************************/
2516 static jb_err server_adjust_content_length(struct client_state *csp, char **header)
2518 /* Regenerate header if the content was modified. */
2519 if (csp->flags & CSP_FLAG_MODIFIED)
2521 const size_t header_length = 50;
2523 *header = malloc(header_length);
2524 if (*header == NULL)
2526 return JB_ERR_MEMORY;
2528 create_content_length_header(csp->content_length, *header, header_length);
2529 log_error(LOG_LEVEL_HEADER,
2530 "Adjusted Content-Length to %llu", csp->content_length);
2537 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
2538 /*********************************************************************
2540 * Function : server_save_content_length
2542 * Description : Save the Content-Length sent by the server.
2545 * 1 : csp = Current client state (buffers, headers, etc...)
2546 * 2 : header = On input, pointer to header to modify.
2547 * On output, pointer to the modified header, or NULL
2548 * to remove the header. This function frees the
2549 * original string if necessary.
2551 * Returns : JB_ERR_OK on success, or
2552 * JB_ERR_MEMORY on out-of-memory error.
2554 *********************************************************************/
2555 static jb_err server_save_content_length(struct client_state *csp, char **header)
2557 unsigned long long content_length = 0;
2558 const char *header_value;
2560 assert(*(*header+14) == ':');
2562 header_value = *header + 15;
2563 if (JB_ERR_OK != get_content_length(header_value, &content_length))
2565 log_error(LOG_LEVEL_ERROR, "Crunching invalid header: %s", *header);
2570 csp->expected_content_length = content_length;
2571 csp->flags |= CSP_FLAG_SERVER_CONTENT_LENGTH_SET;
2572 csp->flags |= CSP_FLAG_CONTENT_LENGTH_SET;
2577 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
2580 /*********************************************************************
2582 * Function : server_content_md5
2584 * Description : Crumble any Content-MD5 headers if the document was
2585 * modified. FIXME: Should we re-compute instead?
2588 * 1 : csp = Current client state (buffers, headers, etc...)
2589 * 2 : header = On input, pointer to header to modify.
2590 * On output, pointer to the modified header, or NULL
2591 * to remove the header. This function frees the
2592 * original string if necessary.
2594 * Returns : JB_ERR_OK on success, or
2595 * JB_ERR_MEMORY on out-of-memory error.
2597 *********************************************************************/
2598 static jb_err server_content_md5(struct client_state *csp, char **header)
2600 if (csp->flags & CSP_FLAG_MODIFIED)
2602 log_error(LOG_LEVEL_HEADER, "Crunching Content-MD5");
2610 /*********************************************************************
2612 * Function : server_content_disposition
2614 * Description : If enabled, blocks or modifies the "Content-Disposition" header.
2615 * Called from `sed'.
2618 * 1 : csp = Current client state (buffers, headers, etc...)
2619 * 2 : header = On input, pointer to header to modify.
2620 * On output, pointer to the modified header, or NULL
2621 * to remove the header. This function frees the
2622 * original string if necessary.
2624 * Returns : JB_ERR_OK on success, or
2625 * JB_ERR_MEMORY on out-of-memory error.
2627 *********************************************************************/
2628 static jb_err server_content_disposition(struct client_state *csp, char **header)
2633 * Are we messing with the Content-Disposition header?
2635 if ((csp->action->flags & ACTION_HIDE_CONTENT_DISPOSITION) == 0)
2641 newval = csp->action->string[ACTION_STRING_CONTENT_DISPOSITION];
2643 if ((newval == NULL) || (0 == strcmpic(newval, "block")))
2646 * Blocking content-disposition header
2648 log_error(LOG_LEVEL_HEADER, "Crunching %s!", *header);
2655 * Replacing Content-Disposition header
2658 *header = strdup("Content-Disposition: ");
2659 string_append(header, newval);
2661 if (*header != NULL)
2663 log_error(LOG_LEVEL_HEADER,
2664 "Content-Disposition header crunched and replaced with: %s", *header);
2667 return (*header == NULL) ? JB_ERR_MEMORY : JB_ERR_OK;
2671 /*********************************************************************
2673 * Function : server_last_modified
2675 * Description : Changes Last-Modified header to the actual date
2676 * to help hide-if-modified-since.
2677 * Called from `sed'.
2680 * 1 : csp = Current client state (buffers, headers, etc...)
2681 * 2 : header = On input, pointer to header to modify.
2682 * On output, pointer to the modified header, or NULL
2683 * to remove the header. This function frees the
2684 * original string if necessary.
2686 * Returns : JB_ERR_OK on success, or
2687 * JB_ERR_MEMORY on out-of-memory error.
2689 *********************************************************************/
2690 static jb_err server_last_modified(struct client_state *csp, char **header)
2693 time_t last_modified;
2697 * Are we messing with the Last-Modified header?
2699 if ((csp->action->flags & ACTION_OVERWRITE_LAST_MODIFIED) == 0)
2705 newval = csp->action->string[ACTION_STRING_LAST_MODIFIED];
2707 if (0 == strcmpic(newval, "block"))
2710 * Blocking Last-Modified header. Useless but why not.
2712 log_error(LOG_LEVEL_HEADER, "Crunching %s!", *header);
2716 else if (0 == strcmpic(newval, "reset-to-request-time"))
2719 * Setting Last-Modified Header to now.
2722 get_http_time(0, buf, sizeof(buf));
2724 *header = strdup("Last-Modified: ");
2725 string_append(header, buf);
2727 if (*header == NULL)
2729 log_error(LOG_LEVEL_HEADER, "Insufficient memory. Last-Modified header got lost, boohoo.");
2733 log_error(LOG_LEVEL_HEADER, "Reset to present time: %s", *header);
2736 else if (0 == strcmpic(newval, "randomize"))
2738 log_error(LOG_LEVEL_HEADER, "Randomizing: %s", *header);
2740 if (JB_ERR_OK != parse_time_header(*header, &last_modified))
2742 log_error(LOG_LEVEL_HEADER,
2743 "Couldn't parse time in %s (crunching!)", *header);
2749 struct tm *timeptr = NULL;
2754 rtime = (long int)difftime(now, last_modified);
2757 long int days, hours, minutes, seconds;
2758 const int negative_delta = (rtime < 0);
2763 log_error(LOG_LEVEL_HEADER, "Server time in the future.");
2765 rtime = pick_from_range(rtime);
2770 last_modified += rtime;
2771 timeptr = privoxy_gmtime_r(&last_modified, &gmt);
2772 if ((NULL == timeptr) || !strftime(newheader,
2773 sizeof(newheader), "%a, %d %b %Y %H:%M:%S GMT", timeptr))
2775 log_error(LOG_LEVEL_ERROR,
2776 "Randomizing '%s' failed. Crunching the header without replacement.",
2782 *header = strdup("Last-Modified: ");
2783 string_append(header, newheader);
2785 if (*header == NULL)
2787 log_error(LOG_LEVEL_ERROR, "Insufficient memory, header crunched without replacement.");
2788 return JB_ERR_MEMORY;
2791 days = rtime / (3600 * 24);
2792 hours = rtime / 3600 % 24;
2793 minutes = rtime / 60 % 60;
2794 seconds = rtime % 60;
2796 log_error(LOG_LEVEL_HEADER,
2797 "Randomized: %s (added %d da%s %d hou%s %d minut%s %d second%s",
2798 *header, days, (days == 1) ? "y" : "ys", hours, (hours == 1) ? "r" : "rs",
2799 minutes, (minutes == 1) ? "e" : "es", seconds, (seconds == 1) ? ")" : "s)");
2803 log_error(LOG_LEVEL_HEADER, "Randomized ... or not. No time difference to work with.");
2812 /*********************************************************************
2814 * Function : client_accept_encoding
2816 * Description : Rewrite the client's Accept-Encoding header so that
2817 * if doesn't allow compression, if the action applies.
2818 * Note: For HTTP/1.0 the absence of the header is enough.
2821 * 1 : csp = Current client state (buffers, headers, etc...)
2822 * 2 : header = On input, pointer to header to modify.
2823 * On output, pointer to the modified header, or NULL
2824 * to remove the header. This function frees the
2825 * original string if necessary.
2827 * Returns : JB_ERR_OK on success, or
2828 * JB_ERR_MEMORY on out-of-memory error.
2830 *********************************************************************/
2831 static jb_err client_accept_encoding(struct client_state *csp, char **header)
2833 #ifdef FEATURE_COMPRESSION
2834 if ((csp->config->feature_flags & RUNTIME_FEATURE_COMPRESSION)
2835 && strstr(*header, "deflate"))
2837 csp->flags |= CSP_FLAG_CLIENT_SUPPORTS_DEFLATE;
2840 if ((csp->action->flags & ACTION_NO_COMPRESSION) != 0)
2842 log_error(LOG_LEVEL_HEADER, "Suppressed offer to compress content");
2850 /*********************************************************************
2852 * Function : client_te
2854 * Description : Rewrite the client's TE header so that
2855 * if doesn't allow compression, if the action applies.
2858 * 1 : csp = Current client state (buffers, headers, etc...)
2859 * 2 : header = On input, pointer to header to modify.
2860 * On output, pointer to the modified header, or NULL
2861 * to remove the header. This function frees the
2862 * original string if necessary.
2864 * Returns : JB_ERR_OK on success, or
2865 * JB_ERR_MEMORY on out-of-memory error.
2867 *********************************************************************/
2868 static jb_err client_te(struct client_state *csp, char **header)
2870 if ((csp->action->flags & ACTION_NO_COMPRESSION) != 0)
2873 log_error(LOG_LEVEL_HEADER, "Suppressed offer to compress transfer");
2880 /*********************************************************************
2882 * Function : client_referrer
2884 * Description : Handle the "referer" config setting properly.
2885 * Called from `sed'.
2888 * 1 : csp = Current client state (buffers, headers, etc...)
2889 * 2 : header = On input, pointer to header to modify.
2890 * On output, pointer to the modified header, or NULL
2891 * to remove the header. This function frees the
2892 * original string if necessary.
2894 * Returns : JB_ERR_OK on success, or
2895 * JB_ERR_MEMORY on out-of-memory error.
2897 *********************************************************************/
2898 static jb_err client_referrer(struct client_state *csp, char **header)
2900 const char *parameter;
2901 /* booleans for parameters we have to check multiple times */
2902 int parameter_conditional_block;
2903 int parameter_conditional_forge;
2905 #ifdef FEATURE_FORCE_LOAD
2907 * Since the referrer can include the prefix even
2908 * if the request itself is non-forced, we must
2909 * clean it unconditionally.
2911 * XXX: strclean is too broad
2913 strclean(*header, FORCE_PREFIX);
2914 #endif /* def FEATURE_FORCE_LOAD */
2916 if ((csp->action->flags & ACTION_HIDE_REFERER) == 0)
2918 /* Nothing left to do */
2922 parameter = csp->action->string[ACTION_STRING_REFERER];
2923 assert(parameter != NULL);
2924 parameter_conditional_block = (0 == strcmpic(parameter, "conditional-block"));
2925 parameter_conditional_forge = (0 == strcmpic(parameter, "conditional-forge"));
2927 if (!parameter_conditional_block && !parameter_conditional_forge)
2930 * As conditional-block and conditional-forge are the only
2931 * parameters that rely on the original referrer, we can
2932 * remove it now for all the others.
2937 if (0 == strcmpic(parameter, "block"))
2939 log_error(LOG_LEVEL_HEADER, "Referer crunched!");
2942 else if (parameter_conditional_block || parameter_conditional_forge)
2944 return handle_conditional_hide_referrer_parameter(header,
2945 csp->http->hostport, parameter_conditional_block);
2947 else if (0 == strcmpic(parameter, "forge"))
2949 return create_forged_referrer(header, csp->http->hostport);
2953 /* interpret parameter as user-supplied referer to fake */
2954 return create_fake_referrer(header, parameter);
2959 /*********************************************************************
2961 * Function : client_accept_language
2963 * Description : Handle the "Accept-Language" config setting properly.
2964 * Called from `sed'.
2967 * 1 : csp = Current client state (buffers, headers, etc...)
2968 * 2 : header = On input, pointer to header to modify.
2969 * On output, pointer to the modified header, or NULL
2970 * to remove the header. This function frees the
2971 * original string if necessary.
2973 * Returns : JB_ERR_OK on success, or
2974 * JB_ERR_MEMORY on out-of-memory error.
2976 *********************************************************************/
2977 static jb_err client_accept_language(struct client_state *csp, char **header)
2982 * Are we messing with the Accept-Language?
2984 if ((csp->action->flags & ACTION_HIDE_ACCEPT_LANGUAGE) == 0)
2986 /*I don't think so*/
2990 newval = csp->action->string[ACTION_STRING_LANGUAGE];
2992 if ((newval == NULL) || (0 == strcmpic(newval, "block")))
2995 * Blocking Accept-Language header
2997 log_error(LOG_LEVEL_HEADER, "Crunching Accept-Language!");
3004 * Replacing Accept-Language header
3007 *header = strdup("Accept-Language: ");
3008 string_append(header, newval);
3010 if (*header == NULL)
3012 log_error(LOG_LEVEL_ERROR,
3013 "Insufficient memory. Accept-Language header crunched without replacement.");
3017 log_error(LOG_LEVEL_HEADER,
3018 "Accept-Language header crunched and replaced with: %s", *header);
3021 return (*header == NULL) ? JB_ERR_MEMORY : JB_ERR_OK;
3025 /*********************************************************************
3027 * Function : crunch_client_header
3029 * Description : Crunch client header if it matches a string supplied by the
3030 * user. Called from `sed'.
3033 * 1 : csp = Current client state (buffers, headers, etc...)
3034 * 2 : header = On input, pointer to header to modify.
3035 * On output, pointer to the modified header, or NULL
3036 * to remove the header. This function frees the
3037 * original string if necessary.
3039 * Returns : JB_ERR_OK on success and always succeeds
3041 *********************************************************************/
3042 static jb_err crunch_client_header(struct client_state *csp, char **header)
3044 const char *crunch_pattern;
3046 /* Do we feel like crunching? */
3047 if ((csp->action->flags & ACTION_CRUNCH_CLIENT_HEADER))
3049 crunch_pattern = csp->action->string[ACTION_STRING_CLIENT_HEADER];
3051 /* Is the current header the lucky one? */
3052 if (strstr(*header, crunch_pattern))
3054 log_error(LOG_LEVEL_HEADER, "Crunching client header: %s (contains: %s)", *header, crunch_pattern);
3062 /*********************************************************************
3064 * Function : client_uagent
3066 * Description : Handle the "user-agent" config setting properly
3067 * and remember its original value to enable browser
3068 * bug workarounds. Called from `sed'.
3071 * 1 : csp = Current client state (buffers, headers, etc...)
3072 * 2 : header = On input, pointer to header to modify.
3073 * On output, pointer to the modified header, or NULL
3074 * to remove the header. This function frees the
3075 * original string if necessary.
3077 * Returns : JB_ERR_OK on success, or
3078 * JB_ERR_MEMORY on out-of-memory error.
3080 *********************************************************************/
3081 static jb_err client_uagent(struct client_state *csp, char **header)
3085 if ((csp->action->flags & ACTION_HIDE_USER_AGENT) == 0)
3090 newval = csp->action->string[ACTION_STRING_USER_AGENT];
3097 *header = strdup("User-Agent: ");
3098 string_append(header, newval);
3100 log_error(LOG_LEVEL_HEADER, "Modified: %s", *header);
3102 return (*header == NULL) ? JB_ERR_MEMORY : JB_ERR_OK;
3106 /*********************************************************************
3108 * Function : client_ua
3110 * Description : Handle "ua-" headers properly. Called from `sed'.
3113 * 1 : csp = Current client state (buffers, headers, etc...)
3114 * 2 : header = On input, pointer to header to modify.
3115 * On output, pointer to the modified header, or NULL
3116 * to remove the header. This function frees the
3117 * original string if necessary.
3119 * Returns : JB_ERR_OK on success, or
3120 * JB_ERR_MEMORY on out-of-memory error.
3122 *********************************************************************/
3123 static jb_err client_ua(struct client_state *csp, char **header)
3125 if ((csp->action->flags & ACTION_HIDE_USER_AGENT) != 0)
3127 log_error(LOG_LEVEL_HEADER, "crunched User-Agent!");
3135 /*********************************************************************
3137 * Function : client_from
3139 * Description : Handle the "from" config setting properly.
3140 * Called from `sed'.
3143 * 1 : csp = Current client state (buffers, headers, etc...)
3144 * 2 : header = On input, pointer to header to modify.
3145 * On output, pointer to the modified header, or NULL
3146 * to remove the header. This function frees the
3147 * original string if necessary.
3149 * Returns : JB_ERR_OK on success, or
3150 * JB_ERR_MEMORY on out-of-memory error.
3152 *********************************************************************/
3153 static jb_err client_from(struct client_state *csp, char **header)
3157 if ((csp->action->flags & ACTION_HIDE_FROM) == 0)
3164 newval = csp->action->string[ACTION_STRING_FROM];
3167 * Are we blocking the e-mail address?
3169 if ((newval == NULL) || (0 == strcmpic(newval, "block")))
3171 log_error(LOG_LEVEL_HEADER, "crunched From!");
3175 log_error(LOG_LEVEL_HEADER, " modified");
3177 *header = strdup("From: ");
3178 string_append(header, newval);
3180 return (*header == NULL) ? JB_ERR_MEMORY : JB_ERR_OK;
3184 /*********************************************************************
3186 * Function : client_send_cookie
3188 * Description : Crunches the "cookie" header if necessary.
3189 * Called from `sed'.
3191 * XXX: Stupid name, doesn't send squat.
3194 * 1 : csp = Current client state (buffers, headers, etc...)
3195 * 2 : header = On input, pointer to header to modify.
3196 * On output, pointer to the modified header, or NULL
3197 * to remove the header. This function frees the
3198 * original string if necessary.
3200 * Returns : JB_ERR_OK on success, or
3201 * JB_ERR_MEMORY on out-of-memory error.
3203 *********************************************************************/
3204 static jb_err client_send_cookie(struct client_state *csp, char **header)
3206 if (csp->action->flags & ACTION_CRUNCH_OUTGOING_COOKIES)
3208 log_error(LOG_LEVEL_HEADER, "Crunched outgoing cookie: %s", *header);
3216 /*********************************************************************
3218 * Function : client_x_forwarded
3220 * Description : Handle the "x-forwarded-for" config setting properly,
3221 * also used in the add_client_headers list. Called from `sed'.
3224 * 1 : csp = Current client state (buffers, headers, etc...)
3225 * 2 : header = On input, pointer to header to modify.
3226 * On output, pointer to the modified header, or NULL
3227 * to remove the header. This function frees the
3228 * original string if necessary.
3230 * Returns : JB_ERR_OK on success, or
3231 * JB_ERR_MEMORY on out-of-memory error.
3233 *********************************************************************/
3234 jb_err client_x_forwarded(struct client_state *csp, char **header)
3236 if (0 != (csp->action->flags & ACTION_CHANGE_X_FORWARDED_FOR))
3238 const char *parameter = csp->action->string[ACTION_STRING_CHANGE_X_FORWARDED_FOR];
3240 if (0 == strcmpic(parameter, "block"))
3243 log_error(LOG_LEVEL_HEADER, "crunched x-forwarded-for!");
3245 else if (0 == strcmpic(parameter, "add"))
3247 string_append(header, ", ");
3248 string_append(header, csp->ip_addr_str);
3250 if (*header == NULL)
3252 return JB_ERR_MEMORY;
3254 log_error(LOG_LEVEL_HEADER,
3255 "Appended client IP address to %s", *header);
3256 csp->flags |= CSP_FLAG_X_FORWARDED_FOR_APPENDED;
3260 log_error(LOG_LEVEL_FATAL,
3261 "Invalid change-x-forwarded-for parameter: '%s'", parameter);
3269 /*********************************************************************
3271 * Function : client_max_forwards
3273 * Description : If the HTTP method is OPTIONS or TRACE, subtract one
3274 * from the value of the Max-Forwards header field.
3277 * 1 : csp = Current client state (buffers, headers, etc...)
3278 * 2 : header = On input, pointer to header to modify.
3279 * On output, pointer to the modified header, or NULL
3280 * to remove the header. This function frees the
3281 * original string if necessary.
3283 * Returns : JB_ERR_OK on success, or
3284 * JB_ERR_MEMORY on out-of-memory error.
3286 *********************************************************************/
3287 static jb_err client_max_forwards(struct client_state *csp, char **header)
3291 if ((0 == strcmpic(csp->http->gpc, "trace")) ||
3292 (0 == strcmpic(csp->http->gpc, "options")))
3294 assert(*(*header+12) == ':');
3295 if (1 == sscanf(*header+12, ": %d", &max_forwards))
3297 if (max_forwards > 0)
3299 snprintf(*header, strlen(*header)+1, "Max-Forwards: %d", --max_forwards);
3300 log_error(LOG_LEVEL_HEADER,
3301 "Max-Forwards value for %s request reduced to %d.",
3302 csp->http->gpc, max_forwards);
3304 else if (max_forwards < 0)
3306 log_error(LOG_LEVEL_ERROR, "Crunching invalid header: %s", *header);
3312 log_error(LOG_LEVEL_ERROR, "Crunching invalid header: %s", *header);
3321 /*********************************************************************
3323 * Function : client_host
3325 * Description : If the request URI did not contain host and
3326 * port information, parse and evaluate the Host
3330 * 1 : csp = Current client state (buffers, headers, etc...)
3331 * 2 : header = On input, pointer to header to modify.
3332 * On output, pointer to the modified header, or NULL
3333 * to remove the header. This function frees the
3334 * original string if necessary.
3336 * Returns : JB_ERR_OK on success, or
3337 * JB_ERR_MEMORY on out-of-memory error.
3339 *********************************************************************/
3340 static jb_err client_host(struct client_state *csp, char **header)
3344 if (strlen(*header) < 7)
3346 log_error(LOG_LEVEL_HEADER, "Removing empty Host header");
3351 if (!csp->http->hostport || (*csp->http->hostport == '*') ||
3352 *csp->http->hostport == ' ' || *csp->http->hostport == '\0')
3355 p = strdup_or_die((*header)+6);
3357 q = strdup_or_die(p);
3359 freez(csp->http->hostport);
3360 csp->http->hostport = p;
3361 freez(csp->http->host);
3362 csp->http->host = q;
3363 q = strchr(csp->http->host, ':');
3366 /* Terminate hostname and evaluate port string */
3368 csp->http->port = atoi(q);
3372 csp->http->port = csp->http->ssl ? 443 : 80;
3375 log_error(LOG_LEVEL_HEADER, "New host and port from Host field: %s = %s:%d",
3376 csp->http->hostport, csp->http->host, csp->http->port);
3379 /* Signal client_host_adder() to return right away */
3380 csp->flags |= CSP_FLAG_HOST_HEADER_IS_SET;
3386 /*********************************************************************
3388 * Function : client_if_modified_since
3390 * Description : Remove or modify the If-Modified-Since header.
3393 * 1 : csp = Current client state (buffers, headers, etc...)
3394 * 2 : header = On input, pointer to header to modify.
3395 * On output, pointer to the modified header, or NULL
3396 * to remove the header. This function frees the
3397 * original string if necessary.
3399 * Returns : JB_ERR_OK on success, or
3400 * JB_ERR_MEMORY on out-of-memory error.
3402 *********************************************************************/
3403 static jb_err client_if_modified_since(struct client_state *csp, char **header)
3407 struct tm *timeptr = NULL;
3412 if (0 == strcmpic(*header, "If-Modified-Since: Wed, 08 Jun 1955 12:00:00 GMT"))
3415 * The client got an error message because of a temporary problem,
3416 * the problem is gone and the client now tries to revalidate our
3417 * error message on the real server. The revalidation would always
3418 * end with the transmission of the whole document and there is
3419 * no need to expose the bogus If-Modified-Since header.
3421 log_error(LOG_LEVEL_HEADER, "Crunching useless If-Modified-Since header.");
3424 else if (csp->action->flags & ACTION_HIDE_IF_MODIFIED_SINCE)
3426 newval = csp->action->string[ACTION_STRING_IF_MODIFIED_SINCE];
3428 if ((0 == strcmpic(newval, "block")))
3430 log_error(LOG_LEVEL_HEADER, "Crunching %s", *header);
3433 else /* add random value */
3435 if (JB_ERR_OK != parse_time_header(*header, &tm))
3437 log_error(LOG_LEVEL_HEADER,
3438 "Couldn't parse time in %s (crunching!)", *header);
3443 long int hours, minutes, seconds;
3444 long int rtime = strtol(newval, &endptr, 0);
3445 const int negative_range = (rtime < 0);
3449 log_error(LOG_LEVEL_HEADER, "Randomizing: %s (random range: %d minut%s)",
3450 *header, rtime, (rtime == 1 || rtime == -1) ? "e": "es");
3456 rtime = pick_from_range(rtime);
3460 log_error(LOG_LEVEL_ERROR, "Random range is 0. Assuming time transformation test.",
3463 tm += rtime * (negative_range ? -1 : 1);
3464 timeptr = privoxy_gmtime_r(&tm, &gmt);
3465 if ((NULL == timeptr) || !strftime(newheader,
3466 sizeof(newheader), "%a, %d %b %Y %H:%M:%S GMT", timeptr))
3468 log_error(LOG_LEVEL_ERROR,
3469 "Randomizing '%s' failed. Crunching the header without replacement.",
3475 *header = strdup("If-Modified-Since: ");
3476 string_append(header, newheader);
3478 if (*header == NULL)
3480 log_error(LOG_LEVEL_HEADER, "Insufficient memory, header crunched without replacement.");
3481 return JB_ERR_MEMORY;
3484 hours = rtime / 3600;
3485 minutes = rtime / 60 % 60;
3486 seconds = rtime % 60;
3488 log_error(LOG_LEVEL_HEADER,
3489 "Randomized: %s (%s %d hou%s %d minut%s %d second%s",
3490 *header, (negative_range) ? "subtracted" : "added", hours,
3491 (hours == 1) ? "r" : "rs", minutes, (minutes == 1) ? "e" : "es",
3492 seconds, (seconds == 1) ? ")" : "s)");
3501 /*********************************************************************
3503 * Function : client_if_none_match
3505 * Description : Remove the If-None-Match header.
3508 * 1 : csp = Current client state (buffers, headers, etc...)
3509 * 2 : header = On input, pointer to header to modify.
3510 * On output, pointer to the modified header, or NULL
3511 * to remove the header. This function frees the
3512 * original string if necessary.
3514 * Returns : JB_ERR_OK on success, or
3515 * JB_ERR_MEMORY on out-of-memory error.
3517 *********************************************************************/
3518 static jb_err client_if_none_match(struct client_state *csp, char **header)
3520 if (csp->action->flags & ACTION_CRUNCH_IF_NONE_MATCH)
3522 log_error(LOG_LEVEL_HEADER, "Crunching %s", *header);
3530 /*********************************************************************
3532 * Function : client_x_filter
3534 * Description : Disables filtering if the client set "X-Filter: No".
3535 * Called from `sed'.
3538 * 1 : csp = Current client state (buffers, headers, etc...)
3539 * 2 : header = On input, pointer to header to modify.
3540 * On output, pointer to the modified header, or NULL
3541 * to remove the header. This function frees the
3542 * original string if necessary.
3544 * Returns : JB_ERR_OK on success
3546 *********************************************************************/
3547 jb_err client_x_filter(struct client_state *csp, char **header)
3549 if (0 == strcmpic(*header, "X-Filter: No"))
3551 if (!(csp->config->feature_flags & RUNTIME_FEATURE_HTTP_TOGGLE))
3553 log_error(LOG_LEVEL_INFO, "Ignored the client's request to fetch without filtering.");
3557 if (csp->action->flags & ACTION_FORCE_TEXT_MODE)
3559 log_error(LOG_LEVEL_HEADER,
3560 "force-text-mode overruled the client's request to fetch without filtering!");
3564 csp->content_type = CT_TABOO; /* XXX: This hack shouldn't be necessary */
3565 csp->flags |= CSP_FLAG_NO_FILTERING;
3566 log_error(LOG_LEVEL_HEADER, "Accepted the client's request to fetch without filtering.");
3568 log_error(LOG_LEVEL_HEADER, "Crunching %s", *header);
3576 /*********************************************************************
3578 * Function : client_range
3580 * Description : Removes Range, Request-Range and If-Range headers if
3581 * content filtering is enabled and the range doesn't
3584 * If the client's version of the document has been
3585 * altered by Privoxy, the server could interpret the
3586 * range differently than the client intended in which
3587 * case the user could end up with corrupted content.
3589 * If the range starts at byte 0 this isn't an issue
3590 * so the header can pass. Partial requests like this
3591 * are used to render preview images for videos without
3592 * downloading the whole video.
3594 * While HTTP doesn't require that range requests are
3595 * honoured and the client could simply abort the download
3596 * after receiving a sufficient amount of data, various
3597 * clients don't handle complete responses to range
3598 * requests gracefully and emit misleading error messages
3602 * 1 : csp = Current client state (buffers, headers, etc...)
3603 * 2 : header = On input, pointer to header to modify.
3604 * On output, pointer to the modified header, or NULL
3605 * to remove the header. This function frees the
3606 * original string if necessary.
3608 * Returns : JB_ERR_OK
3610 *********************************************************************/
3611 static jb_err client_range(struct client_state *csp, char **header)
3613 if (content_filters_enabled(csp->action)
3614 && (0 != strncmpic(strstr(*header, ":"), ": bytes=0-", 10)))
3616 log_error(LOG_LEVEL_HEADER, "Content filtering is enabled."
3617 " Crunching: \'%s\' to prevent range-mismatch problems.", *header);
3624 /* the following functions add headers directly to the header list */
3626 /*********************************************************************
3628 * Function : client_host_adder
3630 * Description : Adds the Host: header field if it is missing.
3631 * Called from `sed'.
3634 * 1 : csp = Current client state (buffers, headers, etc...)
3636 * Returns : JB_ERR_OK on success, or
3637 * JB_ERR_MEMORY on out-of-memory error.
3639 *********************************************************************/
3640 static jb_err client_host_adder(struct client_state *csp)
3645 if (csp->flags & CSP_FLAG_HOST_HEADER_IS_SET)
3647 /* Header already set by the client, nothing to do. */
3651 if (!csp->http->hostport || !*(csp->http->hostport))
3653 log_error(LOG_LEVEL_ERROR, "Destination host unknown.");
3654 return JB_ERR_PARSE;
3658 * remove 'user:pass@' from 'proto://user:pass@host'
3660 if ((p = strchr( csp->http->hostport, '@')) != NULL)
3666 p = csp->http->hostport;
3669 /* XXX: Just add it, we already made sure that it will be unique */
3670 log_error(LOG_LEVEL_HEADER, "addh-unique: Host: %s", p);
3671 err = enlist_unique_header(csp->headers, "Host", p);
3677 /*********************************************************************
3679 * Function : client_xtra_adder
3681 * Description : Used in the add_client_headers list. Called from `sed'.
3684 * 1 : csp = Current client state (buffers, headers, etc...)
3686 * Returns : JB_ERR_OK on success, or
3687 * JB_ERR_MEMORY on out-of-memory error.
3689 *********************************************************************/
3690 static jb_err client_xtra_adder(struct client_state *csp)
3692 struct list_entry *lst;
3695 for (lst = csp->action->multi[ACTION_MULTI_ADD_HEADER]->first;
3696 lst ; lst = lst->next)
3698 log_error(LOG_LEVEL_HEADER, "addh: %s", lst->str);
3699 err = enlist(csp->headers, lst->str);
3711 /*********************************************************************
3713 * Function : client_x_forwarded_for_adder
3715 * Description : Used in the add_client_headers list. Called from `sed'.
3718 * 1 : csp = Current client state (buffers, headers, etc...)
3720 * Returns : JB_ERR_OK on success, or
3721 * JB_ERR_MEMORY on out-of-memory error.
3723 *********************************************************************/
3724 static jb_err client_x_forwarded_for_adder(struct client_state *csp)
3726 char *header = NULL;
3729 if (!((csp->action->flags & ACTION_CHANGE_X_FORWARDED_FOR)
3730 && (0 == strcmpic(csp->action->string[ACTION_STRING_CHANGE_X_FORWARDED_FOR], "add")))
3731 || (csp->flags & CSP_FLAG_X_FORWARDED_FOR_APPENDED))
3734 * If we aren't adding X-Forwarded-For headers,
3735 * or we already appended an existing X-Forwarded-For
3736 * header, there's nothing left to do here.
3741 header = strdup("X-Forwarded-For: ");
3742 string_append(&header, csp->ip_addr_str);
3746 return JB_ERR_MEMORY;
3749 log_error(LOG_LEVEL_HEADER, "addh: %s", header);
3750 err = enlist(csp->headers, header);
3757 /*********************************************************************
3759 * Function : server_connection_adder
3761 * Description : Adds an appropriate "Connection:" header to csp->headers
3762 * unless the header was already present. Called from `sed'.
3765 * 1 : csp = Current client state (buffers, headers, etc...)
3767 * Returns : JB_ERR_OK on success, or
3768 * JB_ERR_MEMORY on out-of-memory error.
3770 *********************************************************************/
3771 static jb_err server_connection_adder(struct client_state *csp)
3773 const unsigned int flags = csp->flags;
3774 const char *response_status_line = csp->headers->first->str;
3775 static const char connection_close[] = "Connection: close";
3777 if ((flags & CSP_FLAG_CLIENT_HEADER_PARSING_DONE)
3778 && (flags & CSP_FLAG_SERVER_CONNECTION_HEADER_SET))
3784 * XXX: if we downgraded the response, this check will fail.
3786 if ((csp->config->feature_flags &
3787 RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
3788 && (NULL != response_status_line)
3789 && !strncmpic(response_status_line, "HTTP/1.1", 8)
3790 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3791 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
3795 log_error(LOG_LEVEL_HEADER, "A HTTP/1.1 response "
3796 "without Connection header implies keep-alive.");
3797 csp->flags |= CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE;
3801 log_error(LOG_LEVEL_HEADER, "Adding: %s", connection_close);
3803 return enlist(csp->headers, connection_close);
3807 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3808 /*********************************************************************
3810 * Function : server_proxy_connection_adder
3812 * Description : Adds a "Proxy-Connection: keep-alive" header to
3813 * csp->headers when appropriate.
3816 * 1 : csp = Current client state (buffers, headers, etc...)
3818 * Returns : JB_ERR_OK on success, or
3819 * JB_ERR_MEMORY on out-of-memory error.
3821 *********************************************************************/
3822 static jb_err server_proxy_connection_adder(struct client_state *csp)
3824 static const char proxy_connection_header[] = "Proxy-Connection: keep-alive";
3825 jb_err err = JB_ERR_OK;
3827 if ((csp->flags & CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE)
3828 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
3829 && !(csp->flags & CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET)
3830 && ((csp->flags & CSP_FLAG_SERVER_CONTENT_LENGTH_SET)
3831 || (csp->flags & CSP_FLAG_CHUNKED)))
3833 log_error(LOG_LEVEL_HEADER, "Adding: %s", proxy_connection_header);
3834 err = enlist(csp->headers, proxy_connection_header);
3839 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
3842 /*********************************************************************
3844 * Function : client_connection_header_adder
3846 * Description : Adds a proper "Connection:" header to csp->headers
3847 * unless the header was already present or it's a
3848 * CONNECT request. Called from `sed'.
3851 * 1 : csp = Current client state (buffers, headers, etc...)
3853 * Returns : JB_ERR_OK on success, or
3854 * JB_ERR_MEMORY on out-of-memory error.
3856 *********************************************************************/
3857 static jb_err client_connection_header_adder(struct client_state *csp)
3859 static const char connection_close[] = "Connection: close";
3861 if (!(csp->flags & CSP_FLAG_CLIENT_HEADER_PARSING_DONE)
3862 && (csp->flags & CSP_FLAG_CLIENT_CONNECTION_HEADER_SET))
3868 * In case of CONNECT requests "Connection: close" is implied,
3869 * but actually setting the header has been reported to cause
3870 * problems with some forwarding proxies that close the
3871 * connection prematurely.
3873 if (csp->http->ssl != 0)
3878 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
3879 if ((csp->config->feature_flags & RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE)
3880 && !(csp->flags & CSP_FLAG_SERVER_SOCKET_TAINTED)
3881 && !strcmpic(csp->http->version, "HTTP/1.1"))
3883 csp->flags |= CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE;
3886 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
3888 log_error(LOG_LEVEL_HEADER, "Adding: %s", connection_close);
3890 return enlist(csp->headers, connection_close);
3894 /*********************************************************************
3896 * Function : server_http
3898 * Description : - Save the HTTP Status into csp->http->status
3899 * - Set CT_TABOO to prevent filtering if the answer
3900 * is a partial range (HTTP status 206)
3901 * - Rewrite HTTP/1.1 answers to HTTP/1.0 if +downgrade
3903 * - Normalize the HTTP-version.
3906 * 1 : csp = Current client state (buffers, headers, etc...)
3907 * 2 : header = On input, pointer to header to modify.
3908 * On output, pointer to the modified header, or NULL
3909 * to remove the header. This function frees the
3910 * original string if necessary.
3912 * Returns : JB_ERR_OK on success, or
3913 * JB_ERR_PARSE on fatal parse errors.
3915 *********************************************************************/
3916 static jb_err server_http(struct client_state *csp, char **header)
3918 char *reason_phrase = NULL;
3919 char *new_response_line;
3922 unsigned int major_version;
3923 unsigned int minor_version;
3925 /* Get the reason phrase which start after the second whitespace */
3926 p = strchr(*header, ' ');
3930 reason_phrase = strchr(p, ' ');
3933 if (reason_phrase != NULL)
3939 log_error(LOG_LEVEL_ERROR,
3940 "Response line lacks reason phrase: %s", *header);
3944 if (3 != sscanf(*header, "HTTP/%u.%u %d", &major_version,
3945 &minor_version, &(csp->http->status)))
3947 log_error(LOG_LEVEL_ERROR,
3948 "Failed to parse the response line: %s", *header);
3949 return JB_ERR_PARSE;
3952 if (csp->http->status == 206)
3954 csp->content_type = CT_TABOO;
3957 if (major_version != 1 || (minor_version != 0 && minor_version != 1))
3960 * According to RFC 7230 2.6 intermediaries MUST send
3961 * their own HTTP-version in forwarded messages.
3963 log_error(LOG_LEVEL_ERROR,
3964 "Unsupported HTTP version. Downgrading to 1.1.");
3969 if (((csp->action->flags & ACTION_DOWNGRADE) != 0) && (minor_version == 1))
3971 log_error(LOG_LEVEL_HEADER, "Downgrading answer to HTTP/1.0");
3975 /* Rebuild response line. */
3976 length = sizeof("HTTP/1.1 200 ") + strlen(reason_phrase) + 1;
3977 new_response_line = malloc_or_die(length);
3979 snprintf(new_response_line, length, "HTTP/%u.%u %d %s",
3980 major_version, minor_version, csp->http->status, reason_phrase);
3982 if (0 != strcmp(*header, new_response_line))
3984 log_error(LOG_LEVEL_HEADER, "Response line '%s' changed to '%s'",
3985 *header, new_response_line);
3989 *header = new_response_line;
3994 /*********************************************************************
3996 * Function : add_cooky_expiry_date
3998 * Description : Adds a cookie expiry date to a string.
4001 * 1 : cookie = On input, pointer to cookie to modify.
4002 * On output, pointer to the modified header.
4003 * The original string is freed.
4004 * 2 : lifetime = Seconds the cookie should be valid
4008 *********************************************************************/
4009 static void add_cookie_expiry_date(char **cookie, time_t lifetime)
4012 struct tm *timeptr = NULL;
4013 time_t expiry_date = time(NULL) + lifetime;
4016 timeptr = privoxy_gmtime_r(&expiry_date, &gmt);
4017 if (NULL == timeptr)
4019 log_error(LOG_LEVEL_FATAL,
4020 "Failed to get the time in add_cooky_expiry_date()");
4022 strftime(tmp, sizeof(tmp), "; expires=%a, %d-%b-%Y %H:%M:%S GMT", timeptr);
4023 if (JB_ERR_OK != string_append(cookie, tmp))
4025 log_error(LOG_LEVEL_FATAL, "Out of memory in add_cooky_expiry()");
4030 /*********************************************************************
4032 * Function : server_set_cookie
4034 * Description : Handle the server "cookie" header properly.
4035 * Crunch, accept or rewrite it to a session cookie.
4036 * Called from `sed'.
4039 * 1 : csp = Current client state (buffers, headers, etc...)
4040 * 2 : header = On input, pointer to header to modify.
4041 * On output, pointer to the modified header, or NULL
4042 * to remove the header. This function frees the
4043 * original string if necessary.
4045 * Returns : JB_ERR_OK on success, or
4046 * JB_ERR_MEMORY on out-of-memory error.
4048 *********************************************************************/
4049 static jb_err server_set_cookie(struct client_state *csp, char **header)
4051 if ((csp->action->flags & ACTION_CRUNCH_INCOMING_COOKIES) != 0)
4053 log_error(LOG_LEVEL_HEADER, "Crunching incoming cookie: %s", *header);
4056 else if ((0 != (csp->action->flags & ACTION_SESSION_COOKIES_ONLY))
4057 || (0 != (csp->action->flags & ACTION_LIMIT_COOKIE_LIFETIME)))
4061 long cookie_lifetime = 0;
4064 NO_EXPIRY_DATE_SPECIFIED,
4065 EXPIRY_DATE_ACCEPTABLE,
4066 EXPIRY_DATE_UNACCEPTABLE
4067 } expiry_date_status = NO_EXPIRY_DATE_SPECIFIED;
4069 /* A variable to store the tag we're working on */
4072 /* Skip "Set-Cookie:" (11 characters) in header */
4073 cur_tag = *header + 11;
4075 /* skip whitespace between "Set-Cookie:" and value */
4076 while (*cur_tag && privoxy_isspace(*cur_tag))
4083 if ((csp->action->flags & ACTION_LIMIT_COOKIE_LIFETIME) != 0)
4085 const char *param = csp->action->string[ACTION_STRING_LIMIT_COOKIE_LIFETIME];
4087 cookie_lifetime = strtol(param, NULL, 0);
4088 if (cookie_lifetime < 0)
4090 log_error(LOG_LEVEL_FATAL, "Invalid cookie lifetime limit: %s", param);
4092 cookie_lifetime *= 60;
4095 /* Loop through each tag in the cookie */
4099 char *next_tag = strchr(cur_tag, ';');
4100 if (next_tag != NULL)
4102 /* Skip the ';' character itself */
4105 /* skip whitespace ";" and start of tag */
4106 while (*next_tag && privoxy_isspace(*next_tag))
4113 /* "Next tag" is the end of the string */
4114 next_tag = cur_tag + strlen(cur_tag);
4118 * Check the expiration date to see
4119 * if the cookie is still valid, if yes,
4120 * rewrite it to a session cookie.
4122 if ((strncmpic(cur_tag, "expires=", 8) == 0) && *(cur_tag + 8))
4124 char *expiration_date = cur_tag + 8; /* Skip "[Ee]xpires=" */
4126 if ((expiration_date[0] == '"')
4127 && (expiration_date[1] != '\0'))
4130 * Skip quotation mark. RFC 2109 10.1.2 seems to hint
4131 * that the expiration date isn't supposed to be quoted,
4132 * but some servers do it anyway.
4137 /* Did we detect the date properly? */
4138 if (JB_ERR_OK != parse_header_time(expiration_date, &cookie_time))
4141 * Nope, treat it as if it was still valid.
4143 * XXX: Should we remove the whole cookie instead?
4145 log_error(LOG_LEVEL_ERROR,
4146 "Can't parse \'%s\', send by %s. Unsupported time format?", cur_tag, csp->http->url);
4147 string_move(cur_tag, next_tag);
4148 expiry_date_status = EXPIRY_DATE_UNACCEPTABLE;
4153 * Yes. Check if the cookie is still valid.
4155 * If the cookie is already expired it's probably
4156 * a delete cookie and even if it isn't, the browser
4157 * will discard it anyway.
4161 * XXX: timegm() isn't available on some AmigaOS
4162 * versions and our replacement doesn't work.
4164 * Our options are to either:
4166 * - disable session-cookies-only completely if timegm
4169 * - to simply remove all expired tags, like it has
4170 * been done until Privoxy 3.0.6 and to live with
4171 * the consequence that it can cause login/logout
4172 * problems on servers that don't validate their
4173 * input properly, or
4175 * - to replace it with mktime in which
4176 * case there is a slight chance of valid cookies
4177 * passing as already expired.
4179 * This is the way it's currently done and it's not
4180 * as bad as it sounds. If the missing GMT offset is
4181 * enough to change the result of the expiration check
4182 * the cookie will be only valid for a few hours
4183 * anyway, which in many cases will be shorter
4184 * than a browser session.
4186 if (cookie_time < now)
4188 log_error(LOG_LEVEL_HEADER,
4189 "Cookie \'%s\' is already expired and can pass unmodified.", *header);
4190 /* Just in case some clown sets more then one expiration date */
4192 expiry_date_status = EXPIRY_DATE_ACCEPTABLE;
4194 else if ((cookie_lifetime != 0) && (cookie_time < (now + cookie_lifetime)))
4196 log_error(LOG_LEVEL_HEADER, "Cookie \'%s\' can pass unmodified. "
4197 "Its lifetime is below the limit.", *header);
4198 /* Just in case some clown sets more then one expiration date */
4200 expiry_date_status = EXPIRY_DATE_ACCEPTABLE;
4205 * Still valid, delete expiration date by copying
4206 * the rest of the string over it.
4208 string_move(cur_tag, next_tag);
4210 /* That changed the header, need to issue a log message */
4211 expiry_date_status = EXPIRY_DATE_UNACCEPTABLE;
4214 * Note that the next tag has now been moved to *cur_tag,
4215 * so we do not need to update the cur_tag pointer.
4223 /* Move on to next cookie tag */
4228 if (expiry_date_status != EXPIRY_DATE_ACCEPTABLE)
4230 assert(NULL != *header);
4231 if (cookie_lifetime != 0)
4233 add_cookie_expiry_date(header, cookie_lifetime);
4234 log_error(LOG_LEVEL_HEADER, "Cookie rewritten to: %s", *header);
4236 else if (expiry_date_status != NO_EXPIRY_DATE_SPECIFIED)
4238 log_error(LOG_LEVEL_HEADER,
4239 "Cookie rewritten to a temporary one: %s", *header);
4248 #ifdef FEATURE_FORCE_LOAD
4249 /*********************************************************************
4251 * Function : strclean
4253 * Description : In-Situ-Eliminate all occurrences of substring in
4257 * 1 : string = string to clean
4258 * 2 : substring = substring to eliminate
4260 * Returns : Number of eliminations
4262 *********************************************************************/
4263 int strclean(char *string, const char *substring)
4269 len = strlen(substring);
4271 while((pos = strstr(string, substring)) != NULL)
4278 while (*p++ != '\0');
4285 #endif /* def FEATURE_FORCE_LOAD */
4288 /*********************************************************************
4290 * Function : parse_header_time
4292 * Description : Parses time formats used in HTTP header strings
4293 * to get the numerical respresentation.
4296 * 1 : header_time = HTTP header time as string.
4297 * 2 : result = storage for header_time in seconds
4299 * Returns : JB_ERR_OK if the time format was recognized, or
4300 * JB_ERR_PARSE otherwise.
4302 *********************************************************************/
4303 static jb_err parse_header_time(const char *header_time, time_t *result)
4307 * Checking for two-digit years first in an
4308 * attempt to work around GNU libc's strptime()
4309 * reporting negative year values when using %Y.
4311 static const char time_formats[][22] = {
4312 /* Tue, 02-Jun-37 20:00:00 */
4313 "%a, %d-%b-%y %H:%M:%S",
4314 /* Tue, 02 Jun 2037 20:00:00 */
4315 "%a, %d %b %Y %H:%M:%S",
4316 /* Tue, 02-Jun-2037 20:00:00 */
4317 "%a, %d-%b-%Y %H:%M:%S",
4318 /* Tuesday, 02-Jun-2037 20:00:00 */
4319 "%A, %d-%b-%Y %H:%M:%S",
4320 /* Tuesday Jun 02 20:00:00 2037 */
4321 "%A %b %d %H:%M:%S %Y"
4325 for (i = 0; i < SZ(time_formats); i++)
4328 * Zero out gmt to prevent time zone offsets.
4329 * Documented to be required for GNU libc.
4331 memset(&gmt, 0, sizeof(gmt));
4333 if (NULL != strptime(header_time, time_formats[i], &gmt))
4335 /* Sanity check for GNU libc. */
4336 if (gmt.tm_year < 0)
4338 log_error(LOG_LEVEL_HEADER,
4339 "Failed to parse '%s' using '%s'. Moving on.",
4340 header_time, time_formats[i]);
4343 *result = timegm(&gmt);
4345 #ifdef FEATURE_STRPTIME_SANITY_CHECKS
4347 * Verify that parsing the date recreated from the first
4348 * parse operation gets the previous result. If it doesn't,
4349 * either strptime() or strftime() are malfunctioning.
4351 * We could string-compare the recreated date with the original
4352 * header date, but this leads to false positives as strptime()
4353 * may let %a accept all day formats while strftime() will only
4357 char recreated_date[100];
4362 tm = privoxy_gmtime_r(result, &storage);
4363 if (!strftime(recreated_date, sizeof(recreated_date),
4364 time_formats[i], tm))
4366 log_error(LOG_LEVEL_ERROR, "Failed to recreate date '%s' with '%s'.",
4367 header_time, time_formats[i]);
4370 memset(&gmt, 0, sizeof(gmt));
4371 if (NULL == strptime(recreated_date, time_formats[i], &gmt))
4373 log_error(LOG_LEVEL_ERROR,
4374 "Failed to parse '%s' generated with '%s' to recreate '%s'.",
4375 recreated_date, time_formats[i], header_time);
4378 result2 = timegm(&gmt);
4379 if (*result != result2)
4381 log_error(LOG_LEVEL_ERROR, "strftime() and strptime() disagree. "
4382 "Format: '%s'. In: '%s', out: '%s'. %d != %d. Rejecting.",
4383 time_formats[i], header_time, recreated_date, *result, result2);
4393 return JB_ERR_PARSE;
4397 /*********************************************************************
4399 * Function : parse_time_header
4401 * Description : Parses the time in an HTTP time header to get
4402 * the numerical respresentation.
4405 * 1 : header = HTTP header with a time value
4406 * 2 : result = storage for header_time in seconds
4408 * Returns : JB_ERR_OK if the time format was recognized, or
4409 * JB_ERR_PARSE otherwise.
4411 *********************************************************************/
4412 static jb_err parse_time_header(const char *header, time_t *result)
4414 const char *header_time;
4416 header_time = strchr(header, ':');
4419 * Currently this can't happen as all callers are called
4420 * through sed() which requires a header name followed by
4423 assert(header_time != NULL);
4426 if (*header_time == ' ')
4431 return parse_header_time(header_time, result);
4436 /*********************************************************************
4438 * Function : get_destination_from_headers
4440 * Description : Parse the "Host:" header to get the request's destination.
4441 * Only needed if the client's request was forcefully
4442 * redirected into Privoxy.
4444 * Code mainly copied from client_host() which is currently