1 const char filters_rcs[] = "$Id: filters.c,v 1.203 2016/12/24 16:00:49 fabiankeil Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/filters.c,v $
6 * Purpose : Declares functions to parse/crunch headers and pages.
8 * Copyright : Written by and Copyright (C) 2001-2016 the
9 * Privoxy team. http://www.privoxy.org/
11 * Based on the Internet Junkbuster originally written
12 * by and Copyright (C) 1997 Anonymous Coders and
13 * Junkbusters Corporation. http://www.junkbusters.com
15 * This program is free software; you can redistribute it
16 * and/or modify it under the terms of the GNU General
17 * Public License as published by the Free Software
18 * Foundation; either version 2 of the License, or (at
19 * your option) any later version.
21 * This program is distributed in the hope that it will
22 * be useful, but WITHOUT ANY WARRANTY; without even the
23 * implied warranty of MERCHANTABILITY or FITNESS FOR A
24 * PARTICULAR PURPOSE. See the GNU General Public
25 * License for more details.
27 * The GNU General Public License should be included with
28 * this file. If not, you can view it at
29 * http://www.gnu.org/copyleft/gpl.html
30 * or write to the Free Software Foundation, Inc., 59
31 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
33 *********************************************************************/
39 #include <sys/types.h>
48 #endif /* ndef __OS2__ */
49 #include <netinet/in.h>
52 #endif /* ndef _WIN32 */
56 #endif /* def __OS2__ */
64 #include "jbsockets.h"
70 #include "deanimate.h"
73 #ifdef FEATURE_CLIENT_TAGS
74 #include "client-tags.h"
81 const char filters_h_rcs[] = FILTERS_H_VERSION;
83 typedef char *(*filter_function_ptr)();
84 static filter_function_ptr get_filter_function(const struct client_state *csp);
85 static jb_err prepare_for_filtering(struct client_state *csp);
86 static void apply_url_actions(struct current_action_spec *action,
87 struct http_request *http,
88 #ifdef FEATURE_CLIENT_TAGS
89 const struct list *client_tags,
91 struct url_actions *b);
95 /*********************************************************************
97 * Function : sockaddr_storage_to_ip
99 * Description : Access internal structure of sockaddr_storage
102 * 1 : addr = socket address
103 * 2 : ip = IP address as array of octets in network order
104 * (it points into addr)
105 * 3 : len = length of IP address in octets
106 * 4 : port = port number in network order;
108 * Returns : 0 = no errror; -1 otherwise.
110 *********************************************************************/
111 static int sockaddr_storage_to_ip(const struct sockaddr_storage *addr,
112 uint8_t **ip, unsigned int *len,
120 switch (addr->ss_family)
130 &(((struct sockaddr_in *)addr)->sin_addr.s_addr);
134 *port = &((struct sockaddr_in *)addr)->sin_port;
145 *ip = ((struct sockaddr_in6 *)addr)->sin6_addr.s6_addr;
149 *port = &((struct sockaddr_in6 *)addr)->sin6_port;
154 /* Unsupported address family */
162 /*********************************************************************
164 * Function : match_sockaddr
166 * Description : Check whether address matches network (IP address and port)
169 * 1 : network = socket address of subnework
170 * 2 : netmask = network mask as socket address
171 * 3 : address = checked socket address against given network
173 * Returns : 0 = doesn't match; 1 = does match
175 *********************************************************************/
176 static int match_sockaddr(const struct sockaddr_storage *network,
177 const struct sockaddr_storage *netmask,
178 const struct sockaddr_storage *address)
180 uint8_t *network_addr, *netmask_addr, *address_addr;
181 unsigned int addr_len;
182 in_port_t *network_port, *netmask_port, *address_port;
185 if (network->ss_family != netmask->ss_family)
187 /* This should never happen */
188 assert(network->ss_family == netmask->ss_family);
189 log_error(LOG_LEVEL_FATAL, "Network and netmask differ in family.");
192 sockaddr_storage_to_ip(network, &network_addr, &addr_len, &network_port);
193 sockaddr_storage_to_ip(netmask, &netmask_addr, NULL, &netmask_port);
194 sockaddr_storage_to_ip(address, &address_addr, NULL, &address_port);
196 /* Check for family */
197 if ((network->ss_family == AF_INET) && (address->ss_family == AF_INET6)
198 && IN6_IS_ADDR_V4MAPPED((struct in6_addr *)address_addr))
200 /* Map AF_INET6 V4MAPPED address into AF_INET */
204 else if ((network->ss_family == AF_INET6) && (address->ss_family == AF_INET)
205 && IN6_IS_ADDR_V4MAPPED((struct in6_addr *)network_addr))
207 /* Map AF_INET6 V4MAPPED network into AF_INET */
213 /* XXX: Port check is signaled in netmask */
214 if (*netmask_port && *network_port != *address_port)
219 /* TODO: Optimize by checking by words insted of octets */
220 for (i = 0; (i < addr_len) && netmask_addr[i]; i++)
222 if ((network_addr[i] & netmask_addr[i]) !=
223 (address_addr[i] & netmask_addr[i]))
231 #endif /* def HAVE_RFC2553 */
234 /*********************************************************************
236 * Function : block_acl
238 * Description : Block this request?
239 * Decide yes or no based on ACL file.
242 * 1 : dst = The proxy or gateway address this is going to.
243 * Or NULL to check all possible targets.
244 * 2 : csp = Current client state (buffers, headers, etc...)
245 * Also includes the client IP address.
247 * Returns : 0 = FALSE (don't block) and 1 = TRUE (do block)
249 *********************************************************************/
250 int block_acl(const struct access_control_addr *dst, const struct client_state *csp)
252 struct access_control_list *acl = csp->config->acl;
254 /* if not using an access control list, then permit the connection */
260 /* search the list */
265 match_sockaddr(&acl->src->addr, &acl->src->mask, &csp->tcp_addr)
267 (csp->ip_addr_long & acl->src->mask) == acl->src->addr
273 /* Just want to check if they have any access */
274 if (acl->action == ACL_PERMIT)
286 * XXX: An undefined acl->dst is full of zeros and should be
287 * considered a wildcard address. sockaddr_storage_to_ip()
288 * fails on such destinations because of unknown sa_familly
289 * (glibc only?). However this test is not portable.
291 * So, we signal the acl->dst is wildcard in wildcard_dst.
294 match_sockaddr(&acl->dst->addr, &acl->dst->mask, &dst->addr)
296 ((dst->addr & acl->dst->mask) == acl->dst->addr)
297 && ((dst->port == acl->dst->port) || (acl->dst->port == 0))
301 if (acl->action == ACL_PERMIT)
319 /*********************************************************************
321 * Function : acl_addr
323 * Description : Called from `load_config' to parse an ACL address.
326 * 1 : aspec = String specifying ACL address.
327 * 2 : aca = struct access_control_addr to fill in.
329 * Returns : 0 => Ok, everything else is an error.
331 *********************************************************************/
332 int acl_addr(const char *aspec, struct access_control_addr *aca)
336 struct addrinfo hints, *result;
338 in_port_t *mask_port;
339 unsigned int addr_len;
342 #endif /* def HAVE_RFC2553 */
344 char *acl_spec = NULL;
347 /* XXX: Depend on ai_family */
355 * Use a temporary acl spec copy so we can log
356 * the unmodified original in case of parse errors.
358 acl_spec = strdup_or_die(aspec);
360 if ((p = strchr(acl_spec, '/')) != NULL)
363 if (privoxy_isdigit(*p) == 0)
368 masklength = atoi(p);
371 if ((masklength < 0) ||
383 if ((*acl_spec == '[') && (NULL != (p = strchr(acl_spec, ']'))))
386 memmove(acl_spec, acl_spec + 1, (size_t)(p - acl_spec));
395 p = strchr(acl_spec, ':');
405 memset(&hints, 0, sizeof(struct addrinfo));
406 hints.ai_family = AF_UNSPEC;
407 hints.ai_socktype = SOCK_STREAM;
409 i = getaddrinfo(acl_spec, p, &hints, &result);
413 log_error(LOG_LEVEL_ERROR, "Can not resolve [%s]:%s: %s",
414 acl_spec, p, gai_strerror(i));
420 /* TODO: Allow multihomed hostnames */
421 memcpy(&(aca->addr), result->ai_addr, result->ai_addrlen);
422 freeaddrinfo(result);
428 port = strtol(p, &endptr, 10);
430 if (port <= 0 || port > 65535 || *endptr != '\0')
437 aca->port = (unsigned long)port;
439 aca->addr = ntohl(resolve_hostname_to_ip(acl_spec));
442 if (aca->addr == INADDR_NONE)
444 /* XXX: This will be logged as parse error. */
447 #endif /* def HAVE_RFC2553 */
449 /* build the netmask */
451 /* Clip masklength according to current family. */
452 if ((aca->addr.ss_family == AF_INET) && (masklength > 32))
457 aca->mask.ss_family = aca->addr.ss_family;
458 if (sockaddr_storage_to_ip(&aca->mask, &mask_data, &addr_len, &mask_port))
465 /* ACL contains a port number, check ports in the future. */
470 * XXX: This could be optimized to operate on whole words instead
471 * of octets (128-bit CPU could do it in one iteration).
474 * Octets after prefix can be omitted because of
475 * previous initialization to zeros.
477 for (i = 0; (i < addr_len) && masklength; i++)
487 * XXX: This assumes MSB of octet is on the left side.
488 * This should be true for all architectures or solved
491 mask_data[i] = (uint8_t)~((1 << (8 - masklength)) - 1);
498 for (i=1; i <= masklength ; i++)
500 aca->mask |= (1U << (32 - i));
503 /* now mask off the host portion of the ip address
504 * (i.e. save on the network portion of the address).
506 aca->addr = aca->addr & aca->mask;
507 #endif /* def HAVE_RFC2553 */
512 #endif /* def FEATURE_ACL */
515 /*********************************************************************
517 * Function : connect_port_is_forbidden
519 * Description : Check to see if CONNECT requests to the destination
520 * port of this request are forbidden. The check is
521 * independend of the actual request method.
524 * 1 : csp = Current client state (buffers, headers, etc...)
526 * Returns : True if yes, false otherwise.
528 *********************************************************************/
529 int connect_port_is_forbidden(const struct client_state *csp)
531 return ((csp->action->flags & ACTION_LIMIT_CONNECT) &&
532 !match_portlist(csp->action->string[ACTION_STRING_LIMIT_CONNECT],
537 /*********************************************************************
539 * Function : block_url
541 * Description : Called from `chat'. Check to see if we need to block this.
544 * 1 : csp = Current client state (buffers, headers, etc...)
546 * Returns : NULL => unblocked, else HTTP block response
548 *********************************************************************/
549 struct http_response *block_url(struct client_state *csp)
551 struct http_response *rsp;
552 const char *new_content_type = NULL;
555 * If it's not blocked, don't block it ;-)
557 if ((csp->action->flags & ACTION_BLOCK) == 0)
561 if (csp->action->flags & ACTION_REDIRECT)
563 log_error(LOG_LEVEL_ERROR, "redirect{} overruled by block.");
566 * Else, prepare a response
568 if (NULL == (rsp = alloc_http_response()))
570 return cgi_error_memory();
574 * If it's an image-url, send back an image or redirect
575 * as specified by the relevant +image action
577 #ifdef FEATURE_IMAGE_BLOCKING
578 if (((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)
582 /* determine HOW images should be blocked */
583 p = csp->action->string[ACTION_STRING_IMAGE_BLOCKER];
585 if (csp->action->flags & ACTION_HANDLE_AS_EMPTY_DOCUMENT)
587 log_error(LOG_LEVEL_ERROR, "handle-as-empty-document overruled by handle-as-image.");
590 /* and handle accordingly: */
591 if ((p == NULL) || (0 == strcmpic(p, "pattern")))
593 rsp->status = strdup_or_die("403 Request blocked by Privoxy");
594 rsp->body = bindup(image_pattern_data, image_pattern_length);
595 if (rsp->body == NULL)
597 free_http_response(rsp);
598 return cgi_error_memory();
600 rsp->content_length = image_pattern_length;
602 if (enlist_unique_header(rsp->headers, "Content-Type", BUILTIN_IMAGE_MIMETYPE))
604 free_http_response(rsp);
605 return cgi_error_memory();
608 else if (0 == strcmpic(p, "blank"))
610 rsp->status = strdup_or_die("403 Request blocked by Privoxy");
611 rsp->body = bindup(image_blank_data, image_blank_length);
612 if (rsp->body == NULL)
614 free_http_response(rsp);
615 return cgi_error_memory();
617 rsp->content_length = image_blank_length;
619 if (enlist_unique_header(rsp->headers, "Content-Type", BUILTIN_IMAGE_MIMETYPE))
621 free_http_response(rsp);
622 return cgi_error_memory();
627 rsp->status = strdup_or_die("302 Local Redirect from Privoxy");
629 if (enlist_unique_header(rsp->headers, "Location", p))
631 free_http_response(rsp);
632 return cgi_error_memory();
638 #endif /* def FEATURE_IMAGE_BLOCKING */
639 if (csp->action->flags & ACTION_HANDLE_AS_EMPTY_DOCUMENT)
642 * Send empty document.
644 new_content_type = csp->action->string[ACTION_STRING_CONTENT_TYPE];
647 rsp->body = strdup_or_die(" ");
648 rsp->content_length = 1;
650 if (csp->config->feature_flags & RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK)
653 * Workaround for firefox bug 492459
654 * https://bugzilla.mozilla.org/show_bug.cgi?id=492459
655 * Return a 200 OK status for pages blocked with +handle-as-empty-document
656 * if the "handle-as-empty-doc-returns-ok" runtime config option is set.
658 rsp->status = strdup_or_die("200 Request blocked by Privoxy");
662 rsp->status = strdup_or_die("403 Request blocked by Privoxy");
665 if (new_content_type != 0)
667 log_error(LOG_LEVEL_HEADER, "Overwriting Content-Type with %s", new_content_type);
668 if (enlist_unique_header(rsp->headers, "Content-Type", new_content_type))
670 free_http_response(rsp);
671 return cgi_error_memory();
678 * Else, generate an HTML "blocked" message:
682 struct map * exports;
684 rsp->status = strdup_or_die("403 Request blocked by Privoxy");
686 exports = default_exports(csp, NULL);
689 free_http_response(rsp);
690 return cgi_error_memory();
693 #ifdef FEATURE_FORCE_LOAD
694 err = map(exports, "force-prefix", 1, FORCE_PREFIX, 1);
696 * Export the force conditional block killer if
698 * - Privoxy was compiled without FEATURE_FORCE_LOAD, or
699 * - Privoxy is configured to enforce blocks, or
700 * - it's a CONNECT request and enforcing wouldn't work anyway.
702 if ((csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS)
703 || (0 == strcmpic(csp->http->gpc, "connect")))
704 #endif /* ndef FEATURE_FORCE_LOAD */
706 err = map_block_killer(exports, "force-support");
709 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
710 if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
711 if (!err) err = map(exports, "path", 1, html_encode(csp->http->path), 0);
712 if (!err) err = map(exports, "path-ue", 1, url_encode(csp->http->path), 0);
715 const char *block_reason;
716 if (csp->action->string[ACTION_STRING_BLOCK] != NULL)
718 block_reason = csp->action->string[ACTION_STRING_BLOCK];
722 assert(connect_port_is_forbidden(csp));
723 block_reason = "Forbidden CONNECT port.";
725 err = map(exports, "block-reason", 1, html_encode(block_reason), 0);
730 free_http_response(rsp);
731 return cgi_error_memory();
734 err = template_fill_for_cgi(csp, "blocked", exports, rsp);
737 free_http_response(rsp);
738 return cgi_error_memory();
741 rsp->crunch_reason = BLOCKED;
743 return finish_http_response(csp, rsp);
749 /*********************************************************************
751 * Function : trust_url FIXME: I should be called distrust_url
753 * Description : Calls is_untrusted_url to determine if the URL is trusted
754 * and if not, returns a HTTP 403 response with a reject message.
757 * 1 : csp = Current client state (buffers, headers, etc...)
759 * Returns : NULL => trusted, else http_response.
761 *********************************************************************/
762 struct http_response *trust_url(struct client_state *csp)
764 struct http_response *rsp;
765 struct map * exports;
766 char buf[BUFFER_SIZE];
768 struct pattern_spec **tl;
769 struct pattern_spec *t;
773 * Don't bother to work on trusted URLs
775 if (!is_untrusted_url(csp))
781 * Else, prepare a response:
783 if (NULL == (rsp = alloc_http_response()))
785 return cgi_error_memory();
788 rsp->status = strdup_or_die("403 Request blocked by Privoxy");
789 exports = default_exports(csp, NULL);
792 free_http_response(rsp);
793 return cgi_error_memory();
797 * Export the protocol, host, port, and referrer information
799 err = map(exports, "hostport", 1, csp->http->hostport, 1);
800 if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
801 if (!err) err = map(exports, "path", 1, csp->http->path, 1);
803 if (NULL != (p = get_header_value(csp->headers, "Referer:")))
805 if (!err) err = map(exports, "referrer", 1, html_encode(p), 0);
809 if (!err) err = map(exports, "referrer", 1, "none set", 1);
815 free_http_response(rsp);
816 return cgi_error_memory();
820 * Export the trust list
822 p = strdup_or_die("");
823 for (tl = csp->config->trust_list; (t = *tl) != NULL ; tl++)
825 snprintf(buf, sizeof(buf), "<li>%s</li>\n", t->spec);
826 string_append(&p, buf);
828 err = map(exports, "trusted-referrers", 1, p, 0);
833 free_http_response(rsp);
834 return cgi_error_memory();
838 * Export the trust info, if available
840 if (csp->config->trust_info->first)
842 struct list_entry *l;
844 p = strdup_or_die("");
845 for (l = csp->config->trust_info->first; l ; l = l->next)
847 snprintf(buf, sizeof(buf), "<li> <a href=\"%s\">%s</a><br>\n", l->str, l->str);
848 string_append(&p, buf);
850 err = map(exports, "trust-info", 1, p, 0);
854 err = map_block_killer(exports, "have-trust-info");
860 free_http_response(rsp);
861 return cgi_error_memory();
865 * Export the force conditional block killer if
867 * - Privoxy was compiled without FEATURE_FORCE_LOAD, or
868 * - Privoxy is configured to enforce blocks, or
869 * - it's a CONNECT request and enforcing wouldn't work anyway.
871 #ifdef FEATURE_FORCE_LOAD
872 if ((csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS)
873 || (0 == strcmpic(csp->http->gpc, "connect")))
875 err = map_block_killer(exports, "force-support");
879 err = map(exports, "force-prefix", 1, FORCE_PREFIX, 1);
881 #else /* ifndef FEATURE_FORCE_LOAD */
882 err = map_block_killer(exports, "force-support");
883 #endif /* ndef FEATURE_FORCE_LOAD */
888 free_http_response(rsp);
889 return cgi_error_memory();
895 err = template_fill_for_cgi(csp, "untrusted", exports, rsp);
898 free_http_response(rsp);
899 return cgi_error_memory();
901 rsp->crunch_reason = UNTRUSTED;
903 return finish_http_response(csp, rsp);
905 #endif /* def FEATURE_TRUST */
908 /*********************************************************************
910 * Function : compile_dynamic_pcrs_job_list
912 * Description : Compiles a dynamic pcrs job list (one with variables
913 * resolved at request time)
916 * 1 : csp = Current client state (buffers, headers, etc...)
917 * 2 : b = The filter list to compile
919 * Returns : NULL in case of errors, otherwise the
922 *********************************************************************/
923 pcrs_job *compile_dynamic_pcrs_job_list(const struct client_state *csp, const struct re_filterfile_spec *b)
925 struct list_entry *pattern;
926 pcrs_job *job_list = NULL;
927 pcrs_job *dummy = NULL;
928 pcrs_job *lastjob = NULL;
931 const struct pcrs_variable variables[] =
933 {"url", csp->http->url, 1},
934 {"path", csp->http->path, 1},
935 {"host", csp->http->host, 1},
936 {"origin", csp->ip_addr_str, 1},
937 {"listen-address", csp->listen_addr_str, 1},
941 for (pattern = b->patterns->first; pattern != NULL; pattern = pattern->next)
943 assert(pattern->str != NULL);
945 dummy = pcrs_compile_dynamic_command(pattern->str, variables, &error);
948 log_error(LOG_LEVEL_ERROR,
949 "Compiling dynamic pcrs job '%s' for '%s' failed with error code %d: %s",
950 pattern->str, b->name, error, pcrs_strerror(error));
955 if (error == PCRS_WARN_TRUNCATION)
957 log_error(LOG_LEVEL_ERROR,
958 "At least one of the variables in \'%s\' had to "
959 "be truncated before compilation", pattern->str);
961 if (job_list == NULL)
967 lastjob->next = dummy;
977 /*********************************************************************
979 * Function : rewrite_url
981 * Description : Rewrites a URL with a single pcrs command
982 * and returns the result if it differs from the
983 * original and isn't obviously invalid.
986 * 1 : old_url = URL to rewrite.
987 * 2 : pcrs_command = pcrs command formatted as string (s@foo@bar@)
990 * Returns : NULL if the pcrs_command didn't change the url, or
991 * the result of the modification.
993 *********************************************************************/
994 char *rewrite_url(char *old_url, const char *pcrs_command)
996 char *new_url = NULL;
1000 assert(pcrs_command);
1002 new_url = pcrs_execute_single_command(old_url, pcrs_command, &hits);
1006 log_error(LOG_LEVEL_REDIRECTS,
1007 "pcrs command \"%s\" didn't change \"%s\".",
1008 pcrs_command, old_url);
1013 log_error(LOG_LEVEL_REDIRECTS,
1014 "executing pcrs command \"%s\" to rewrite %s failed: %s",
1015 pcrs_command, old_url, pcrs_strerror(hits));
1018 else if (strncmpic(new_url, "http://", 7) && strncmpic(new_url, "https://", 8))
1020 log_error(LOG_LEVEL_ERROR,
1021 "pcrs command \"%s\" changed \"%s\" to \"%s\" (%u hi%s), "
1022 "but the result doesn't look like a valid URL and will be ignored.",
1023 pcrs_command, old_url, new_url, hits, (hits == 1) ? "t" : "ts");
1028 log_error(LOG_LEVEL_REDIRECTS,
1029 "pcrs command \"%s\" changed \"%s\" to \"%s\" (%u hi%s).",
1030 pcrs_command, old_url, new_url, hits, (hits == 1) ? "t" : "ts");
1038 #ifdef FEATURE_FAST_REDIRECTS
1039 /*********************************************************************
1041 * Function : get_last_url
1043 * Description : Search for the last URL inside a string.
1044 * If the string already is a URL, it will
1045 * be the first URL found.
1048 * 1 : subject = the string to check
1049 * 2 : redirect_mode = +fast-redirect{} mode
1051 * Returns : NULL if no URL was found, or
1052 * the last URL found.
1054 *********************************************************************/
1055 char *get_last_url(char *subject, const char *redirect_mode)
1057 char *new_url = NULL;
1061 assert(redirect_mode);
1063 subject = strdup(subject);
1064 if (subject == NULL)
1066 log_error(LOG_LEVEL_ERROR, "Out of memory while searching for redirects.");
1070 if (0 == strcmpic(redirect_mode, "check-decoded-url") && strchr(subject, '%'))
1072 char *url_segment = NULL;
1073 char **url_segments;
1074 size_t max_segments;
1077 log_error(LOG_LEVEL_REDIRECTS,
1078 "Checking \"%s\" for encoded redirects.", subject);
1081 * Check each parameter in the URL separately.
1082 * Sectionize the URL at "?" and "&",
1083 * go backwards through the segments, URL-decode them
1084 * and look for a URL in the decoded result.
1085 * Stop the search after the first match.
1087 * XXX: This estimate is guaranteed to be high enough as we
1088 * let ssplit() ignore empty fields, but also a bit wasteful.
1090 max_segments = strlen(subject) / 2;
1091 url_segments = malloc(max_segments * sizeof(char *));
1093 if (NULL == url_segments)
1095 log_error(LOG_LEVEL_ERROR,
1096 "Out of memory while decoding URL: %s", subject);
1101 segments = ssplit(subject, "?&", url_segments, max_segments);
1103 while (segments-- > 0)
1105 char *dtoken = url_decode(url_segments[segments]);
1108 log_error(LOG_LEVEL_ERROR, "Unable to decode \"%s\".", url_segments[segments]);
1111 url_segment = strstr(dtoken, "http://");
1112 if (NULL == url_segment)
1114 url_segment = strstr(dtoken, "https://");
1116 if (NULL != url_segment)
1118 url_segment = strdup_or_die(url_segment);
1125 freez(url_segments);
1127 if (url_segment == NULL)
1131 subject = url_segment;
1135 /* Look for a URL inside this one, without decoding anything. */
1136 log_error(LOG_LEVEL_REDIRECTS,
1137 "Checking \"%s\" for unencoded redirects.", subject);
1141 * Find the last URL encoded in the request
1144 while ((tmp = strstr(tmp, "http://")) != NULL)
1148 tmp = (new_url != NULL) ? new_url : subject;
1149 while ((tmp = strstr(tmp, "https://")) != NULL)
1154 if ((new_url != NULL)
1155 && ( (new_url != subject)
1156 || (0 == strncmpic(subject, "http://", 7))
1157 || (0 == strncmpic(subject, "https://", 8))
1161 * Return new URL if we found a redirect
1162 * or if the subject already was a URL.
1164 * The second case makes sure that we can
1165 * chain get_last_url after another redirection check
1166 * (like rewrite_url) without losing earlier redirects.
1168 new_url = strdup(new_url);
1177 #endif /* def FEATURE_FAST_REDIRECTS */
1180 /*********************************************************************
1182 * Function : redirect_url
1184 * Description : Checks if Privoxy should answer the request with
1185 * a HTTP redirect and generates the redirect if
1189 * 1 : csp = Current client state (buffers, headers, etc...)
1191 * Returns : NULL if the request can pass, HTTP redirect otherwise.
1193 *********************************************************************/
1194 struct http_response *redirect_url(struct client_state *csp)
1196 struct http_response *rsp;
1197 #ifdef FEATURE_FAST_REDIRECTS
1199 * XXX: Do we still need FEATURE_FAST_REDIRECTS
1200 * as compile-time option? The user can easily disable
1201 * it in his action file.
1203 char * redirect_mode;
1204 #endif /* def FEATURE_FAST_REDIRECTS */
1205 char *old_url = NULL;
1206 char *new_url = NULL;
1207 char *redirection_string;
1209 if ((csp->action->flags & ACTION_REDIRECT))
1211 redirection_string = csp->action->string[ACTION_STRING_REDIRECT];
1214 * If the redirection string begins with 's',
1215 * assume it's a pcrs command, otherwise treat it as
1216 * properly formatted URL and use it for the redirection
1219 * According to (the now obsolete) RFC 2616 section 14.30
1220 * the URL has to be absolute and if the user tries:
1221 * +redirect{sadly/this/will/be/parsed/as/pcrs_command.html}
1222 * she would get undefined results anyway.
1224 * RFC 7231 7.1.2 actually allows relative references,
1225 * but those start with a leading slash (RFC 3986 4.2) and
1226 * thus can't be mistaken for pcrs commands either.
1229 if (*redirection_string == 's')
1231 old_url = csp->http->url;
1232 new_url = rewrite_url(old_url, redirection_string);
1236 log_error(LOG_LEVEL_REDIRECTS,
1237 "No pcrs command recognized, assuming that \"%s\" is already properly formatted.",
1238 redirection_string);
1239 new_url = strdup(redirection_string);
1243 #ifdef FEATURE_FAST_REDIRECTS
1244 if ((csp->action->flags & ACTION_FAST_REDIRECTS))
1246 redirect_mode = csp->action->string[ACTION_STRING_FAST_REDIRECTS];
1249 * If it exists, use the previously rewritten URL as input
1250 * otherwise just use the old path.
1252 old_url = (new_url != NULL) ? new_url : strdup(csp->http->path);
1253 new_url = get_last_url(old_url, redirect_mode);
1258 * Disable redirect checkers, so that they
1259 * will be only run more than once if the user
1260 * also enables them through tags.
1262 * From a performance point of view
1263 * it doesn't matter, but the duplicated
1264 * log messages are annoying.
1266 csp->action->flags &= ~ACTION_FAST_REDIRECTS;
1267 #endif /* def FEATURE_FAST_REDIRECTS */
1268 csp->action->flags &= ~ACTION_REDIRECT;
1270 /* Did any redirect action trigger? */
1273 if (url_requires_percent_encoding(new_url))
1276 log_error(LOG_LEVEL_REDIRECTS, "Percent-encoding redirect URL: %N",
1277 strlen(new_url), new_url);
1278 encoded_url = percent_encode_url(new_url);
1280 if (encoded_url == NULL)
1282 return cgi_error_memory();
1284 new_url = encoded_url;
1285 assert(FALSE == url_requires_percent_encoding(new_url));
1288 if (0 == strcmpic(new_url, csp->http->url))
1290 log_error(LOG_LEVEL_ERROR,
1291 "New URL \"%s\" and old URL \"%s\" are the same. Redirection loop prevented.",
1292 csp->http->url, new_url);
1297 log_error(LOG_LEVEL_REDIRECTS, "New URL is: %s", new_url);
1299 if (NULL == (rsp = alloc_http_response()))
1302 return cgi_error_memory();
1305 rsp->status = strdup_or_die("302 Local Redirect from Privoxy");
1306 if (enlist_unique_header(rsp->headers, "Location", new_url))
1309 free_http_response(rsp);
1310 return cgi_error_memory();
1312 rsp->crunch_reason = REDIRECTED;
1315 return finish_http_response(csp, rsp);
1319 /* Only reached if no redirect is required */
1325 #ifdef FEATURE_IMAGE_BLOCKING
1326 /*********************************************************************
1328 * Function : is_imageurl
1330 * Description : Given a URL, decide whether it should be treated
1331 * as image URL or not.
1334 * 1 : csp = Current client state (buffers, headers, etc...)
1336 * Returns : True (nonzero) if URL is an image URL, false (0)
1339 *********************************************************************/
1340 int is_imageurl(const struct client_state *csp)
1342 return ((csp->action->flags & ACTION_IMAGE) != 0);
1345 #endif /* def FEATURE_IMAGE_BLOCKING */
1348 #ifdef FEATURE_TRUST
1349 /*********************************************************************
1351 * Function : is_untrusted_url
1353 * Description : Should we "distrust" this URL (and block it)?
1355 * Yes if it matches a line in the trustfile, or if the
1356 * referrer matches a line starting with "+" in the
1361 * 1 : csp = Current client state (buffers, headers, etc...)
1363 * Returns : 0 => trusted, 1 => untrusted
1365 *********************************************************************/
1366 int is_untrusted_url(const struct client_state *csp)
1368 struct file_list *fl;
1369 struct block_spec *b;
1370 struct pattern_spec **trusted_url;
1371 struct http_request rhttp[1];
1372 const char * referer;
1376 * If we don't have a trustlist, we trust everybody
1378 if (((fl = csp->tlist) == NULL) || ((b = fl->f) == NULL))
1383 memset(rhttp, '\0', sizeof(*rhttp));
1386 * Do we trust the request URL itself?
1388 for (b = b->next; b ; b = b->next)
1390 if (url_match(b->url, csp->http))
1396 if (NULL == (referer = get_header_value(csp->headers, "Referer:")))
1398 /* no referrer was supplied */
1404 * If not, do we maybe trust its referrer?
1406 err = parse_http_url(referer, rhttp, REQUIRE_PROTOCOL);
1412 for (trusted_url = csp->config->trust_list; *trusted_url != NULL; trusted_url++)
1414 if (url_match(*trusted_url, rhttp))
1416 /* if the URL's referrer is from a trusted referrer, then
1417 * add the target spec to the trustfile as an unblocked
1418 * domain and return 0 (which means it's OK).
1423 if (NULL != (fp = fopen(csp->config->trustfile, "a")))
1427 char * new_entry = strdup_or_die("~");
1429 string_append(&new_entry, csp->http->hostport);
1431 path = csp->http->path;
1432 if ( (path[0] == '/')
1434 && ((path_end = strchr(path + 2, '/')) != NULL))
1436 /* since this path points into a user's home space
1437 * be sure to include this spec in the trustfile.
1439 long path_len = path_end - path; /* save offset */
1440 path = strdup(path); /* Copy string */
1443 path_end = path + path_len; /* regenerate ptr to new buffer */
1444 *(path_end + 1) = '\0'; /* Truncate path after '/' */
1446 string_join(&new_entry, path);
1450 * Give a reason for generating this entry.
1452 string_append(&new_entry, " # Trusted referrer was: ");
1453 string_append(&new_entry, referer);
1455 if (new_entry != NULL)
1457 if (-1 == fprintf(fp, "%s\n", new_entry))
1459 log_error(LOG_LEVEL_ERROR, "Failed to append \'%s\' to trustfile \'%s\': %E",
1460 new_entry, csp->config->trustfile);
1466 /* FIXME: No way to handle out-of memory, so mostly ignoring it */
1467 log_error(LOG_LEVEL_ERROR, "Out of memory adding pattern to trust file");
1474 log_error(LOG_LEVEL_ERROR, "Failed to append new entry for \'%s\' to trustfile \'%s\': %E",
1475 csp->http->hostport, csp->config->trustfile);
1483 #endif /* def FEATURE_TRUST */
1486 /*********************************************************************
1488 * Function : get_filter
1490 * Description : Get a filter with a given name and type.
1491 * Note that taggers are filters, too.
1494 * 1 : csp = Current client state (buffers, headers, etc...)
1495 * 2 : requested_name = Name of the content filter to get
1496 * 3 : requested_type = Type of the filter to tagger to lookup
1498 * Returns : A pointer to the requested filter
1499 * or NULL if the filter wasn't found
1501 *********************************************************************/
1502 struct re_filterfile_spec *get_filter(const struct client_state *csp,
1503 const char *requested_name,
1504 enum filter_type requested_type)
1507 struct re_filterfile_spec *b;
1508 struct file_list *fl;
1510 for (i = 0; i < MAX_AF_FILES; i++)
1513 if ((NULL == fl) || (NULL == fl->f))
1516 * Either there are no filter files left or this
1517 * filter file just contains no valid filters.
1519 * Continue to be sure we don't miss valid filter
1520 * files that are chained after empty or invalid ones.
1525 for (b = fl->f; b != NULL; b = b->next)
1527 if (b->type != requested_type)
1529 /* The callers isn't interested in this filter type. */
1532 if (strcmp(b->name, requested_name) == 0)
1534 /* The requested filter has been found. Abort search. */
1540 /* No filter with the given name and type exists. */
1546 /*********************************************************************
1548 * Function : pcrs_filter_response
1550 * Description : Execute all text substitutions from all applying
1551 * +filter actions on the text buffer that's been
1552 * accumulated in csp->iob->buf.
1555 * 1 : csp = Current client state (buffers, headers, etc...)
1557 * Returns : a pointer to the (newly allocated) modified buffer.
1558 * or NULL if there were no hits or something went wrong
1560 *********************************************************************/
1561 static char *pcrs_filter_response(struct client_state *csp)
1564 size_t size, prev_size;
1570 struct re_filterfile_spec *b;
1571 struct list_entry *filtername;
1576 if (csp->iob->cur >= csp->iob->eod)
1581 if (filters_available(csp) == FALSE)
1583 log_error(LOG_LEVEL_ERROR, "Inconsistent configuration: "
1584 "content filtering enabled, but no content filters available.");
1588 size = (size_t)(csp->iob->eod - csp->iob->cur);
1589 old = csp->iob->cur;
1592 * For all applying +filter actions, look if a filter by that
1593 * name exists and if yes, execute it's pcrs_joblist on the
1596 for (filtername = csp->action->multi[ACTION_MULTI_FILTER]->first;
1597 filtername != NULL; filtername = filtername->next)
1599 int current_hits = 0; /* Number of hits caused by this filter */
1600 int job_number = 0; /* Which job we're currently executing */
1601 int job_hits = 0; /* How many hits the current job caused */
1604 b = get_filter(csp, filtername->str, FT_CONTENT_FILTER);
1610 joblist = b->joblist;
1612 if (b->dynamic) joblist = compile_dynamic_pcrs_job_list(csp, b);
1614 if (NULL == joblist)
1616 log_error(LOG_LEVEL_RE_FILTER, "Filter %s has empty joblist. Nothing to do.", b->name);
1621 /* Apply all jobs from the joblist */
1622 for (job = joblist; NULL != job; job = job->next)
1625 job_hits = pcrs_execute(job, old, size, &new, &size);
1630 * That went well. Continue filtering
1631 * and use the result of this job as
1632 * input for the next one.
1634 current_hits += job_hits;
1635 if (old != csp->iob->cur)
1644 * This job caused an unexpected error. Inform the user
1645 * and skip the rest of the jobs in this filter. We could
1646 * continue with the next job, but usually the jobs
1647 * depend on each other or are similar enough to
1648 * fail for the same reason.
1650 * At the moment our pcrs expects the error codes of pcre 3.4,
1651 * but newer pcre versions can return additional error codes.
1652 * As a result pcrs_strerror()'s error message might be
1653 * "Unknown error ...", therefore we print the numerical value
1656 * XXX: Is this important enough for LOG_LEVEL_ERROR or
1657 * should we use LOG_LEVEL_RE_FILTER instead?
1659 log_error(LOG_LEVEL_ERROR, "Skipped filter \'%s\' after job number %u: %s (%d)",
1660 b->name, job_number, pcrs_strerror(job_hits), job_hits);
1665 if (b->dynamic) pcrs_free_joblist(joblist);
1667 log_error(LOG_LEVEL_RE_FILTER,
1668 "filtering %s%s (size %d) with \'%s\' produced %d hits (new size %d).",
1669 csp->http->hostport, csp->http->path, prev_size, b->name, current_hits, size);
1671 hits += current_hits;
1675 * If there were no hits, destroy our copy and let
1676 * chat() use the original in csp->iob
1684 csp->flags |= CSP_FLAG_MODIFIED;
1685 csp->content_length = size;
1686 clear_iob(csp->iob);
1693 #ifdef FEATURE_EXTERNAL_FILTERS
1694 /*********************************************************************
1696 * Function : get_external_filter
1698 * Description : Lookup the code to execute for an external filter.
1699 * Masks the misuse of the re_filterfile_spec.
1702 * 1 : csp = Current client state (buffers, headers, etc...)
1703 * 2 : name = Name of the content filter to get
1705 * Returns : A pointer to the requested code
1706 * or NULL if the filter wasn't found
1708 *********************************************************************/
1709 static const char *get_external_filter(const struct client_state *csp,
1712 struct re_filterfile_spec *external_filter;
1714 external_filter = get_filter(csp, name, FT_EXTERNAL_CONTENT_FILTER);
1715 if (external_filter == NULL)
1717 log_error(LOG_LEVEL_FATAL,
1718 "Didn't find stuff to execute for external filter: %s",
1722 return external_filter->patterns->first->str;
1727 /*********************************************************************
1729 * Function : set_privoxy_variables
1731 * Description : Sets a couple of privoxy-specific environment variables
1734 * 1 : csp = Current client state (buffers, headers, etc...)
1738 *********************************************************************/
1739 static void set_privoxy_variables(const struct client_state *csp)
1746 { "PRIVOXY_URL", csp->http->url },
1747 { "PRIVOXY_PATH", csp->http->path },
1748 { "PRIVOXY_HOST", csp->http->host },
1749 { "PRIVOXY_ORIGIN", csp->ip_addr_str },
1750 { "PRIVOXY_LISTEN_ADDRESS", csp->listen_addr_str },
1753 for (i = 0; i < SZ(env); i++)
1755 if (setenv(env[i].name, env[i].value, 1))
1757 log_error(LOG_LEVEL_ERROR, "Failed to set %s=%s: %E",
1758 env[i].name, env[i].value);
1764 /*********************************************************************
1766 * Function : execute_external_filter
1768 * Description : Pipe content into external filter and return the output
1771 * 1 : csp = Current client state (buffers, headers, etc...)
1772 * 2 : name = Name of the external filter to execute
1773 * 3 : content = The original content to filter
1774 * 4 : size = The size of the content buffer
1776 * Returns : a pointer to the (newly allocated) modified buffer.
1777 * or NULL if there were no hits or something went wrong
1779 *********************************************************************/
1780 static char *execute_external_filter(const struct client_state *csp,
1781 const char *name, char *content, size_t *size)
1784 char file_name[FILENAME_MAX];
1786 char *filter_output;
1790 const char *external_filter;
1792 if (csp->config->temporary_directory == NULL)
1794 log_error(LOG_LEVEL_ERROR,
1795 "No temporary-directory configured. Can't execute filter: %s",
1800 external_filter = get_external_filter(csp, name);
1802 if (sizeof(file_name) < snprintf(file_name, sizeof(file_name),
1803 "%s/privoxy-XXXXXXXX", csp->config->temporary_directory))
1805 log_error(LOG_LEVEL_ERROR, "temporary-directory path too long");
1809 fd = mkstemp(file_name);
1812 log_error(LOG_LEVEL_ERROR, "mkstemp() failed to create %s: %E", file_name);
1816 fp = fdopen(fd, "w");
1819 log_error(LOG_LEVEL_ERROR, "fdopen() failed: %E");
1825 * The size may be zero if a previous filter discarded everything.
1827 * This isn't necessary unintentional, so we just don't try
1828 * to fwrite() nothing and let the user deal with the rest.
1830 if ((*size != 0) && fwrite(content, *size, 1, fp) != 1)
1832 log_error(LOG_LEVEL_ERROR, "fwrite(..., %d, 1, ..) failed: %E", *size);
1839 if (sizeof(cmd) < snprintf(cmd, sizeof(cmd), "%s < %s", external_filter, file_name))
1841 log_error(LOG_LEVEL_ERROR,
1842 "temporary-directory or external filter path too long");
1847 log_error(LOG_LEVEL_RE_FILTER, "Executing '%s': %s", name, cmd);
1850 * The locking is necessary to prevent other threads
1851 * from overwriting the environment variables before
1852 * the popen fork. Afterwards this no longer matters.
1854 privoxy_mutex_lock(&external_filter_mutex);
1855 set_privoxy_variables(csp);
1856 fp = popen(cmd, "r");
1857 privoxy_mutex_unlock(&external_filter_mutex);
1860 log_error(LOG_LEVEL_ERROR, "popen(\"%s\", \"r\") failed: %E", cmd);
1865 /* Allocate at least one byte */
1866 filter_output = malloc_or_die(*size + 1);
1869 while (!feof(fp) && !ferror(fp))
1872 /* Could be bigger ... */
1873 enum { READ_LENGTH = 2048 };
1875 if (new_size + READ_LENGTH >= *size)
1879 /* Could be considered wasteful if the content is 'large'. */
1880 *size += (*size >= READ_LENGTH) ? *size : READ_LENGTH;
1882 p = realloc(filter_output, *size);
1885 log_error(LOG_LEVEL_ERROR, "Out of memory while reading "
1886 "external filter output. Using what we got so far.");
1891 assert(new_size + READ_LENGTH < *size);
1892 len = fread(&filter_output[new_size], 1, READ_LENGTH, fp);
1902 log_error(LOG_LEVEL_ERROR, "Executing %s failed: %E", cmd);
1906 log_error(LOG_LEVEL_RE_FILTER,
1907 "Executing '%s' resulted in return value %d. "
1908 "Read %d of up to %d bytes.", name, (ret >> 8), new_size, *size);
1914 return filter_output;
1917 #endif /* def FEATURE_EXTERNAL_FILTERS */
1920 /*********************************************************************
1922 * Function : gif_deanimate_response
1924 * Description : Deanimate the GIF image that has been accumulated in
1925 * csp->iob->buf, set csp->content_length to the modified
1926 * size and raise the CSP_FLAG_MODIFIED flag.
1929 * 1 : csp = Current client state (buffers, headers, etc...)
1931 * Returns : a pointer to the (newly allocated) modified buffer.
1932 * or NULL in case something went wrong.
1934 *********************************************************************/
1936 char *gif_deanimate_response(struct client_state *csp)
1938 static char *gif_deanimate_response(struct client_state *csp)
1941 struct binbuffer *in, *out;
1945 size = (size_t)(csp->iob->eod - csp->iob->cur);
1947 in = zalloc_or_die(sizeof(*in));
1948 out = zalloc_or_die(sizeof(*out));
1950 in->buffer = csp->iob->cur;
1953 if (gif_deanimate(in, out, strncmp("last", csp->action->string[ACTION_STRING_DEANIMATE], 4)))
1955 log_error(LOG_LEVEL_DEANIMATE, "failed! (gif parsing)");
1962 if ((int)size == out->offset)
1964 log_error(LOG_LEVEL_DEANIMATE, "GIF not changed.");
1968 log_error(LOG_LEVEL_DEANIMATE, "Success! GIF shrunk from %d bytes to %d.", size, out->offset);
1970 csp->content_length = out->offset;
1971 csp->flags |= CSP_FLAG_MODIFIED;
1981 /*********************************************************************
1983 * Function : get_filter_function
1985 * Description : Decides which content filter function has
1986 * to be applied (if any). Only considers functions
1987 * for internal filters which are mutually-exclusive.
1990 * 1 : csp = Current client state (buffers, headers, etc...)
1992 * Returns : The content filter function to run, or
1993 * NULL if no content filter is active
1995 *********************************************************************/
1996 static filter_function_ptr get_filter_function(const struct client_state *csp)
1998 filter_function_ptr filter_function = NULL;
2001 * Choose the applying filter function based on
2002 * the content type and action settings.
2004 if ((csp->content_type & CT_TEXT) &&
2005 (!list_is_empty(csp->action->multi[ACTION_MULTI_FILTER])))
2007 filter_function = pcrs_filter_response;
2009 else if ((csp->content_type & CT_GIF) &&
2010 (csp->action->flags & ACTION_DEANIMATE))
2012 filter_function = gif_deanimate_response;
2015 return filter_function;
2019 /*********************************************************************
2021 * Function : remove_chunked_transfer_coding
2023 * Description : In-situ remove the "chunked" transfer coding as defined
2024 * in RFC 7230 4.1 from a buffer. XXX: The implementation
2025 * is neither complete nor compliant (TODO #129).
2028 * 1 : buffer = Pointer to the text buffer
2029 * 2 : size = In: Number of bytes to be processed,
2030 * Out: Number of bytes after de-chunking.
2031 * (undefined in case of errors)
2033 * Returns : JB_ERR_OK for success,
2034 * JB_ERR_PARSE otherwise
2036 *********************************************************************/
2038 extern jb_err remove_chunked_transfer_coding(char *buffer, size_t *size)
2040 static jb_err remove_chunked_transfer_coding(char *buffer, size_t *size)
2044 unsigned int chunksize = 0;
2045 char *from_p, *to_p;
2046 const char *end_of_buffer = buffer + *size;
2050 log_error(LOG_LEVEL_FATAL, "Invalid chunked input. Buffer is empty.");
2051 return JB_ERR_PARSE;
2055 from_p = to_p = buffer;
2057 if (sscanf(buffer, "%x", &chunksize) != 1)
2059 log_error(LOG_LEVEL_ERROR, "Invalid first chunksize while stripping \"chunked\" transfer coding");
2060 return JB_ERR_PARSE;
2063 while (chunksize > 0U)
2066 * If the chunk-size is valid, we should have at least
2067 * chunk-size bytes of chunk-data and five bytes of
2068 * meta data (chunk-size, CRLF, CRLF) left in the buffer.
2070 if (chunksize + 5 >= *size - newsize)
2072 log_error(LOG_LEVEL_ERROR,
2073 "Chunk size %u exceeds buffered data left. "
2074 "Already digested %u of %u buffered bytes.",
2075 chunksize, (unsigned int)newsize, (unsigned int)*size);
2076 return JB_ERR_PARSE;
2080 * Skip the chunk-size, the optional chunk-ext and the CRLF
2081 * that is supposed to be located directly before the start
2084 if (NULL == (from_p = strstr(from_p, "\r\n")))
2086 log_error(LOG_LEVEL_ERROR, "Parse error while stripping \"chunked\" transfer coding");
2087 return JB_ERR_PARSE;
2092 * The previous strstr() does not enforce chunk-validity
2093 * and is sattisfied as long a CRLF is left in the buffer.
2095 * Make sure the bytes we consider chunk-data are within
2098 if (from_p + chunksize >= end_of_buffer)
2100 log_error(LOG_LEVEL_ERROR,
2101 "End of chunk is beyond the end of the buffer.");
2102 return JB_ERR_PARSE;
2105 memmove(to_p, from_p, (size_t) chunksize);
2106 newsize += chunksize;
2107 to_p = buffer + newsize;
2108 from_p += chunksize;
2111 * Not merging this check with the previous one allows us
2112 * to keep chunks without trailing CRLF. It's not clear
2113 * if we actually have to care about those, though.
2115 if (from_p + 2 >= end_of_buffer)
2117 log_error(LOG_LEVEL_ERROR, "Not enough room for trailing CRLF.");
2118 return JB_ERR_PARSE;
2121 if (sscanf(from_p, "%x", &chunksize) != 1)
2123 log_error(LOG_LEVEL_INFO, "Invalid \"chunked\" transfer encoding detected and ignored.");
2128 /* XXX: Should get its own loglevel. */
2129 log_error(LOG_LEVEL_RE_FILTER, "De-chunking successful. Shrunk from %d to %d", *size, newsize);
2138 /*********************************************************************
2140 * Function : prepare_for_filtering
2142 * Description : If necessary, de-chunks and decompresses
2143 * the content so it can get filterd.
2146 * 1 : csp = Current client state (buffers, headers, etc...)
2148 * Returns : JB_ERR_OK for success,
2149 * JB_ERR_PARSE otherwise
2151 *********************************************************************/
2152 static jb_err prepare_for_filtering(struct client_state *csp)
2154 jb_err err = JB_ERR_OK;
2157 * If the body has a "chunked" transfer-encoding,
2158 * get rid of it, adjusting size and iob->eod
2160 if (csp->flags & CSP_FLAG_CHUNKED)
2162 size_t size = (size_t)(csp->iob->eod - csp->iob->cur);
2164 log_error(LOG_LEVEL_RE_FILTER, "Need to de-chunk first");
2165 err = remove_chunked_transfer_coding(csp->iob->cur, &size);
2166 if (JB_ERR_OK == err)
2168 csp->iob->eod = csp->iob->cur + size;
2169 csp->flags |= CSP_FLAG_MODIFIED;
2173 return JB_ERR_PARSE;
2179 * If the body has a supported transfer-encoding,
2180 * decompress it, adjusting size and iob->eod.
2182 if (csp->content_type & (CT_GZIP|CT_DEFLATE))
2184 if (0 == csp->iob->eod - csp->iob->cur)
2186 /* Nothing left after de-chunking. */
2190 err = decompress_iob(csp);
2192 if (JB_ERR_OK == err)
2194 csp->flags |= CSP_FLAG_MODIFIED;
2195 csp->content_type &= ~CT_TABOO;
2200 * Unset CT_GZIP and CT_DEFLATE to remember not
2201 * to modify the Content-Encoding header later.
2203 csp->content_type &= ~CT_GZIP;
2204 csp->content_type &= ~CT_DEFLATE;
2213 /*********************************************************************
2215 * Function : execute_content_filters
2217 * Description : Executes a given content filter.
2220 * 1 : csp = Current client state (buffers, headers, etc...)
2222 * Returns : Pointer to the modified buffer, or
2223 * NULL if filtering failed or wasn't necessary.
2225 *********************************************************************/
2226 char *execute_content_filters(struct client_state *csp)
2229 filter_function_ptr content_filter;
2231 assert(content_filters_enabled(csp->action));
2233 if (0 == csp->iob->eod - csp->iob->cur)
2236 * No content (probably status code 301, 302 ...),
2237 * no filtering necessary.
2242 if (JB_ERR_OK != prepare_for_filtering(csp))
2245 * failed to de-chunk or decompress.
2250 if (0 == csp->iob->eod - csp->iob->cur)
2253 * Clown alarm: chunked and/or compressed nothing delivered.
2258 content_filter = get_filter_function(csp);
2259 content = (content_filter != NULL) ? (*content_filter)(csp) : NULL;
2261 #ifdef FEATURE_EXTERNAL_FILTERS
2262 if ((csp->content_type & CT_TEXT) &&
2263 !list_is_empty(csp->action->multi[ACTION_MULTI_EXTERNAL_FILTER]))
2265 struct list_entry *filtername;
2266 size_t size = (size_t)csp->content_length;
2268 if (content == NULL)
2270 content = csp->iob->cur;
2271 size = (size_t)(csp->iob->eod - csp->iob->cur);
2274 for (filtername = csp->action->multi[ACTION_MULTI_EXTERNAL_FILTER]->first;
2275 filtername ; filtername = filtername->next)
2277 char *result = execute_external_filter(csp, filtername->str, content, &size);
2280 if (content != csp->iob->cur)
2287 csp->flags |= CSP_FLAG_MODIFIED;
2288 csp->content_length = size;
2290 #endif /* def FEATURE_EXTERNAL_FILTERS */
2297 /*********************************************************************
2299 * Function : get_url_actions
2301 * Description : Gets the actions for this URL.
2304 * 1 : csp = Current client state (buffers, headers, etc...)
2305 * 2 : http = http_request request for blocked URLs
2309 *********************************************************************/
2310 void get_url_actions(struct client_state *csp, struct http_request *http)
2312 struct file_list *fl;
2313 struct url_actions *b;
2316 init_current_action(csp->action);
2318 for (i = 0; i < MAX_AF_FILES; i++)
2320 if (((fl = csp->actions_list[i]) == NULL) || ((b = fl->f) == NULL))
2325 #ifdef FEATURE_CLIENT_TAGS
2326 apply_url_actions(csp->action, http, csp->client_tags, b);
2328 apply_url_actions(csp->action, http, b);
2335 /*********************************************************************
2337 * Function : apply_url_actions
2339 * Description : Applies a list of URL actions.
2342 * 1 : action = Destination.
2343 * 2 : http = Current URL
2344 * 3 : client_tags = list of client tags
2345 * 4 : b = list of URL actions to apply
2349 *********************************************************************/
2350 static void apply_url_actions(struct current_action_spec *action,
2351 struct http_request *http,
2352 #ifdef FEATURE_CLIENT_TAGS
2353 const struct list *client_tags,
2355 struct url_actions *b)
2359 /* Should never happen */
2363 for (b = b->next; NULL != b; b = b->next)
2365 if (url_match(b->url, http))
2367 merge_current_action(action, b->action);
2369 #ifdef FEATURE_CLIENT_TAGS
2370 if (client_tag_match(b->url, client_tags))
2372 merge_current_action(action, b->action);
2379 /*********************************************************************
2381 * Function : get_forward_override_settings
2383 * Description : Returns forward settings as specified with the
2384 * forward-override{} action. forward-override accepts
2385 * forward lines similar to the one used in the
2386 * configuration file, but without the URL pattern.
2392 * in the configuration file can be replaced with
2393 * the action section:
2395 * {+forward-override{forward .}}
2399 * 1 : csp = Current client state (buffers, headers, etc...)
2401 * Returns : Pointer to forwarding structure in case of success.
2402 * Invalid syntax is fatal.
2404 *********************************************************************/
2405 static const struct forward_spec *get_forward_override_settings(struct client_state *csp)
2407 const char *forward_override_line = csp->action->string[ACTION_STRING_FORWARD_OVERRIDE];
2408 char forward_settings[BUFFER_SIZE];
2409 char *http_parent = NULL;
2410 /* variable names were chosen for consistency reasons. */
2411 struct forward_spec *fwd = NULL;
2415 assert(csp->action->flags & ACTION_FORWARD_OVERRIDE);
2416 /* Should be enforced by load_one_actions_file() */
2417 assert(strlen(forward_override_line) < sizeof(forward_settings) - 1);
2419 /* Create a copy ssplit can modify */
2420 strlcpy(forward_settings, forward_override_line, sizeof(forward_settings));
2422 if (NULL != csp->fwd)
2425 * XXX: Currently necessary to prevent memory
2426 * leaks when the show-url-info cgi page is visited.
2428 unload_forward_spec(csp->fwd);
2432 * allocate a new forward node, valid only for
2433 * the lifetime of this request. Save its location
2434 * in csp as well, so sweep() can free it later on.
2436 fwd = csp->fwd = zalloc_or_die(sizeof(*fwd));
2438 vec_count = ssplit(forward_settings, " \t", vec, SZ(vec));
2439 if ((vec_count == 2) && !strcasecmp(vec[0], "forward"))
2441 fwd->type = SOCKS_NONE;
2443 /* Parse the parent HTTP proxy host:port */
2444 http_parent = vec[1];
2447 else if ((vec_count == 2) && !strcasecmp(vec[0], "forward-webserver"))
2449 fwd->type = FORWARD_WEBSERVER;
2451 /* Parse the parent HTTP server host:port */
2452 http_parent = vec[1];
2455 else if (vec_count == 3)
2457 char *socks_proxy = NULL;
2459 if (!strcasecmp(vec[0], "forward-socks4"))
2461 fwd->type = SOCKS_4;
2462 socks_proxy = vec[1];
2464 else if (!strcasecmp(vec[0], "forward-socks4a"))
2466 fwd->type = SOCKS_4A;
2467 socks_proxy = vec[1];
2469 else if (!strcasecmp(vec[0], "forward-socks5"))
2471 fwd->type = SOCKS_5;
2472 socks_proxy = vec[1];
2474 else if (!strcasecmp(vec[0], "forward-socks5t"))
2476 fwd->type = SOCKS_5T;
2477 socks_proxy = vec[1];
2480 if (NULL != socks_proxy)
2482 /* Parse the SOCKS proxy host[:port] */
2483 fwd->gateway_port = 1080;
2484 parse_forwarder_address(socks_proxy,
2485 &fwd->gateway_host, &fwd->gateway_port);
2487 http_parent = vec[2];
2491 if (NULL == http_parent)
2493 log_error(LOG_LEVEL_FATAL,
2494 "Invalid forward-override syntax in: %s", forward_override_line);
2495 /* Never get here - LOG_LEVEL_FATAL causes program exit */
2498 /* Parse http forwarding settings */
2499 if (strcmp(http_parent, ".") != 0)
2501 fwd->forward_port = 8000;
2502 parse_forwarder_address(http_parent,
2503 &fwd->forward_host, &fwd->forward_port);
2506 assert (NULL != fwd);
2508 log_error(LOG_LEVEL_CONNECT,
2509 "Overriding forwarding settings based on \'%s\'", forward_override_line);
2515 /*********************************************************************
2517 * Function : forward_url
2519 * Description : Should we forward this to another proxy?
2522 * 1 : csp = Current client state (buffers, headers, etc...)
2523 * 2 : http = http_request request for current URL
2525 * Returns : Pointer to forwarding information.
2527 *********************************************************************/
2528 const struct forward_spec *forward_url(struct client_state *csp,
2529 const struct http_request *http)
2531 static const struct forward_spec fwd_default[1]; /* Zero'ed due to being static. */
2532 struct forward_spec *fwd = csp->config->forward;
2534 if (csp->action->flags & ACTION_FORWARD_OVERRIDE)
2536 return get_forward_override_settings(csp);
2546 if (url_match(fwd->url, http))
2557 /*********************************************************************
2559 * Function : direct_response
2561 * Description : Check if Max-Forwards == 0 for an OPTIONS or TRACE
2562 * request and if so, return a HTTP 501 to the client.
2564 * FIXME: I have a stupid name and I should handle the
2565 * requests properly. Still, what we do here is rfc-
2566 * compliant, whereas ignoring or forwarding are not.
2569 * 1 : csp = Current client state (buffers, headers, etc...)
2571 * Returns : http_response if , NULL if nonmatch or handler fail
2573 *********************************************************************/
2574 struct http_response *direct_response(struct client_state *csp)
2576 struct http_response *rsp;
2577 struct list_entry *p;
2579 if ((0 == strcmpic(csp->http->gpc, "trace"))
2580 || (0 == strcmpic(csp->http->gpc, "options")))
2582 for (p = csp->headers->first; (p != NULL) ; p = p->next)
2584 if (!strncmpic(p->str, "Max-Forwards:", 13))
2586 unsigned int max_forwards;
2589 * If it's a Max-Forwards value of zero,
2590 * we have to intercept the request.
2592 if (1 == sscanf(p->str+12, ": %u", &max_forwards) && max_forwards == 0)
2595 * FIXME: We could handle at least TRACE here,
2596 * but that would require a verbatim copy of
2597 * the request which we don't have anymore
2599 log_error(LOG_LEVEL_HEADER,
2600 "Detected header \'%s\' in OPTIONS or TRACE request. Returning 501.",
2603 /* Get mem for response or fail*/
2604 if (NULL == (rsp = alloc_http_response()))
2606 return cgi_error_memory();
2609 rsp->status = strdup_or_die("501 Not Implemented");
2611 rsp->crunch_reason = UNSUPPORTED;
2613 return(finish_http_response(csp, rsp));
2622 /*********************************************************************
2624 * Function : content_requires_filtering
2626 * Description : Checks whether there are any content filters
2627 * enabled for the current request and if they
2628 * can actually be applied..
2631 * 1 : csp = Current client state (buffers, headers, etc...)
2633 * Returns : TRUE for yes, FALSE otherwise
2635 *********************************************************************/
2636 int content_requires_filtering(struct client_state *csp)
2638 if ((csp->content_type & CT_TABOO)
2639 && !(csp->action->flags & ACTION_FORCE_TEXT_MODE))
2645 * Are we enabling text mode by force?
2647 if (csp->action->flags & ACTION_FORCE_TEXT_MODE)
2650 * Do we really have to?
2652 if (csp->content_type & CT_TEXT)
2654 log_error(LOG_LEVEL_HEADER, "Text mode is already enabled.");
2658 csp->content_type |= CT_TEXT;
2659 log_error(LOG_LEVEL_HEADER, "Text mode enabled by force. Take cover!");
2663 if (!(csp->content_type & CT_DECLARED))
2666 * The server didn't bother to declare a MIME-Type.
2667 * Assume it's text that can be filtered.
2669 * This also regulary happens with 304 responses,
2670 * therefore logging anything here would cause
2673 csp->content_type |= CT_TEXT;
2677 * Choose the applying filter function based on
2678 * the content type and action settings.
2680 if ((csp->content_type & CT_TEXT) &&
2681 (!list_is_empty(csp->action->multi[ACTION_MULTI_FILTER]) ||
2682 !list_is_empty(csp->action->multi[ACTION_MULTI_EXTERNAL_FILTER])))
2686 else if ((csp->content_type & CT_GIF) &&
2687 (csp->action->flags & ACTION_DEANIMATE))
2697 /*********************************************************************
2699 * Function : content_filters_enabled
2701 * Description : Checks whether there are any content filters
2702 * enabled for the current request.
2705 * 1 : action = Action spec to check.
2707 * Returns : TRUE for yes, FALSE otherwise
2709 *********************************************************************/
2710 int content_filters_enabled(const struct current_action_spec *action)
2712 return ((action->flags & ACTION_DEANIMATE) ||
2713 !list_is_empty(action->multi[ACTION_MULTI_FILTER]) ||
2714 !list_is_empty(action->multi[ACTION_MULTI_EXTERNAL_FILTER]));
2718 /*********************************************************************
2720 * Function : filters_available
2722 * Description : Checks whether there are any filters available.
2725 * 1 : csp = Current client state (buffers, headers, etc...)
2727 * Returns : TRUE for yes, FALSE otherwise.
2729 *********************************************************************/
2730 int filters_available(const struct client_state *csp)
2733 for (i = 0; i < MAX_AF_FILES; i++)
2735 const struct file_list *fl = csp->rlist[i];
2736 if ((NULL != fl) && (NULL != fl->f))