Add optional support for FreeBSD's accf_http(9).
[privoxy.git] / filters.c
1 const char filters_rcs[] = "$Id: filters.c,v 1.124 2009/08/19 15:24:30 fabiankeil Exp $";
2 /*********************************************************************
3  *
4  * File        :  $Source: /cvsroot/ijbswa/current/filters.c,v $
5  *
6  * Purpose     :  Declares functions to parse/crunch headers and pages.
7  *                Functions declared include:
8  *                   `acl_addr', `add_stats', `block_acl', `block_imageurl',
9  *                   `block_url', `url_actions', `domain_split',
10  *                   `filter_popups', `forward_url', 'redirect_url',
11  *                   `ij_untrusted_url', `intercept_url', `pcrs_filter_respose',
12  *                   `ijb_send_banner', `trust_url', `gif_deanimate_response',
13  *                   `execute_single_pcrs_command', `rewrite_url',
14  *                   `get_last_url'
15  *
16  * Copyright   :  Written by and Copyright (C) 2001, 2004-2009 the
17  *                Privoxy team. http://www.privoxy.org/
18  *
19  *                Based on the Internet Junkbuster originally written
20  *                by and Copyright (C) 1997 Anonymous Coders and
21  *                Junkbusters Corporation.  http://www.junkbusters.com
22  *
23  *                This program is free software; you can redistribute it
24  *                and/or modify it under the terms of the GNU General
25  *                Public License as published by the Free Software
26  *                Foundation; either version 2 of the License, or (at
27  *                your option) any later version.
28  *
29  *                This program is distributed in the hope that it will
30  *                be useful, but WITHOUT ANY WARRANTY; without even the
31  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
32  *                PARTICULAR PURPOSE.  See the GNU General Public
33  *                License for more details.
34  *
35  *                The GNU General Public License should be included with
36  *                this file.  If not, you can view it at
37  *                http://www.gnu.org/copyleft/gpl.html
38  *                or write to the Free Software Foundation, Inc., 59
39  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
40  *
41  *********************************************************************/
42
43
44 #include "config.h"
45
46 #include <stdio.h>
47 #include <sys/types.h>
48 #include <stdlib.h>
49 #include <ctype.h>
50 #include <string.h>
51 #include <assert.h>
52
53 #ifdef HAVE_RFC2553
54 #include <netdb.h>
55 #include <sys/socket.h>
56 #endif /* def HAVE_RFC2553 */
57
58 #ifndef _WIN32
59 #ifndef __OS2__
60 #include <unistd.h>
61 #endif /* ndef __OS2__ */
62 #include <netinet/in.h>
63 #else
64 #include <winsock2.h>
65 #endif /* ndef _WIN32 */
66
67 #ifdef __OS2__
68 #include <utils.h>
69 #endif /* def __OS2__ */
70
71 #include "project.h"
72 #include "filters.h"
73 #include "encode.h"
74 #include "parsers.h"
75 #include "ssplit.h"
76 #include "errlog.h"
77 #include "jbsockets.h"
78 #include "miscutil.h"
79 #include "actions.h"
80 #include "cgi.h"
81 #include "list.h"
82 #include "deanimate.h"
83 #include "urlmatch.h"
84 #include "loaders.h"
85
86 #ifdef _WIN32
87 #include "win32.h"
88 #endif
89
90 const char filters_h_rcs[] = FILTERS_H_VERSION;
91
92 /* Fix a problem with Solaris.  There should be no effect on other
93  * platforms.
94  * Solaris's isspace() is a macro which uses it's argument directly
95  * as an array index.  Therefore we need to make sure that high-bit
96  * characters generate +ve values, and ideally we also want to make
97  * the argument match the declared parameter type of "int".
98  */
99 #define ijb_isdigit(__X) isdigit((int)(unsigned char)(__X))
100
101 static jb_err remove_chunked_transfer_coding(char *buffer, size_t *size);
102 static jb_err prepare_for_filtering(struct client_state *csp);
103
104 #ifdef FEATURE_ACL
105 #ifdef HAVE_RFC2553
106 /*********************************************************************
107  *
108  * Function    :  sockaddr_storage_to_ip
109  *
110  * Description :  Access internal structure of sockaddr_storage
111  *
112  * Parameters  :
113  *          1  :  addr = socket address
114  *          2  :  ip   = IP address as array of octets in network order
115  *                       (it points into addr)
116  *          3  :  len  = length of IP address in octets
117  *          4  :  port = port number in network order;
118  *
119  * Returns     :  0 = no errror; -1 otherwise.
120  *
121  *********************************************************************/
122 static int sockaddr_storage_to_ip(const struct sockaddr_storage *addr,
123                                   uint8_t **ip, unsigned int *len,
124                                   in_port_t **port)
125 {
126    if (NULL == addr)
127    {
128       return(-1);
129    }
130
131    switch (addr->ss_family)
132    {
133       case AF_INET:
134          if (NULL != len)
135          {
136             *len = 4;
137          }
138          if (NULL != ip)
139          {
140             *ip = (uint8_t *)
141                &(((struct sockaddr_in *)addr)->sin_addr.s_addr);
142          }
143          if (NULL != port)
144          {
145             *port = &((struct sockaddr_in *)addr)->sin_port;
146          }
147          break;
148
149       case AF_INET6:
150          if (NULL != len)
151          {
152             *len = 16;
153          }
154          if (NULL != ip)
155          {
156             *ip = ((struct sockaddr_in6 *)addr)->sin6_addr.s6_addr;
157          }
158          if (NULL != port)
159          {
160             *port = &((struct sockaddr_in6 *)addr)->sin6_port;
161          }
162          break;
163
164       default:
165          /* Unsupported address family */
166          return(-1);
167    }
168
169    return(0);
170 }
171
172
173 /*********************************************************************
174  *
175  * Function    :  match_sockaddr
176  *
177  * Description :  Check whether address matches network (IP address and port)
178  *
179  * Parameters  :
180  *          1  :  network = socket address of subnework
181  *          2  :  netmask = network mask as socket address
182  *          3  :  address = checked socket address against given network
183  *
184  * Returns     :  0 = doesn't match; 1 = does match
185  *
186  *********************************************************************/
187 static int match_sockaddr(const struct sockaddr_storage *network,
188                           const struct sockaddr_storage *netmask,
189                           const struct sockaddr_storage *address)
190 {
191    uint8_t *network_addr, *netmask_addr, *address_addr;
192    unsigned int addr_len;
193    in_port_t *network_port, *netmask_port, *address_port;
194    int i;
195
196    if (network->ss_family != netmask->ss_family)
197    {
198       /* This should never happen */
199       log_error(LOG_LEVEL_ERROR,
200          "Internal error at %s:%llu: network and netmask differ in family",
201          __FILE__, __LINE__);
202       return 0;
203    }
204
205    sockaddr_storage_to_ip(network, &network_addr, &addr_len, &network_port);
206    sockaddr_storage_to_ip(netmask, &netmask_addr, NULL, &netmask_port);
207    sockaddr_storage_to_ip(address, &address_addr, NULL, &address_port);
208
209    /* Check for family */
210    if ((network->ss_family == AF_INET) && (address->ss_family == AF_INET6)
211       && IN6_IS_ADDR_V4MAPPED((struct in6_addr *)address_addr))
212    {
213       /* Map AF_INET6 V4MAPPED address into AF_INET */
214       address_addr += 12;
215       addr_len = 4;
216    }
217    else if ((network->ss_family == AF_INET6) && (address->ss_family == AF_INET)
218       && IN6_IS_ADDR_V4MAPPED((struct in6_addr *)network_addr))
219    {
220       /* Map AF_INET6 V4MAPPED network into AF_INET */
221       network_addr += 12;
222       netmask_addr += 12;
223       addr_len = 4;
224    }
225    else if (network->ss_family != address->ss_family)
226    {
227       return 0;
228    }
229
230    /* XXX: Port check is signaled in netmask */
231    if (*netmask_port && *network_port != *address_port)
232    {
233       return 0;
234    }
235
236    /* TODO: Optimize by checking by words insted of octets */
237    for (i = 0; (i < addr_len) && netmask_addr[i]; i++)
238    {
239       if ((network_addr[i] & netmask_addr[i]) !=
240           (address_addr[i] & netmask_addr[i]))
241       {
242          return 0;
243       }
244    }
245
246    return 1;
247 }
248 #endif /* def HAVE_RFC2553 */
249
250
251 /*********************************************************************
252  *
253  * Function    :  block_acl
254  *
255  * Description :  Block this request?
256  *                Decide yes or no based on ACL file.
257  *
258  * Parameters  :
259  *          1  :  dst = The proxy or gateway address this is going to.
260  *                      Or NULL to check all possible targets.
261  *          2  :  csp = Current client state (buffers, headers, etc...)
262  *                      Also includes the client IP address.
263  *
264  * Returns     : 0 = FALSE (don't block) and 1 = TRUE (do block)
265  *
266  *********************************************************************/
267 int block_acl(const struct access_control_addr *dst, const struct client_state *csp)
268 {
269    struct access_control_list *acl = csp->config->acl;
270
271    /* if not using an access control list, then permit the connection */
272    if (acl == NULL)
273    {
274       return(0);
275    }
276
277    /* search the list */
278    while (acl != NULL)
279    {
280       if (
281 #ifdef HAVE_RFC2553
282             match_sockaddr(&acl->src->addr, &acl->src->mask, &csp->tcp_addr)
283 #else
284             (csp->ip_addr_long & acl->src->mask) == acl->src->addr
285 #endif
286             )
287       {
288          if (dst == NULL)
289          {
290             /* Just want to check if they have any access */
291             if (acl->action == ACL_PERMIT)
292             {
293                return(0);
294             }
295          }
296          else if (
297 #ifdef HAVE_RFC2553
298                /*
299                 * XXX: An undefined acl->dst is full of zeros and should be
300                 * considered a wildcard address. sockaddr_storage_to_ip()
301                 * fails on such destinations because of unknown sa_familly
302                 * (glibc only?). However this test is not portable.
303                 *
304                 * So, we signal the acl->dst is wildcard in wildcard_dst.
305                 */
306                acl->wildcard_dst ||
307                   match_sockaddr(&acl->dst->addr, &acl->dst->mask, &dst->addr)
308 #else
309                ((dst->addr & acl->dst->mask) == acl->dst->addr)
310            && ((dst->port == acl->dst->port) || (acl->dst->port == 0))
311 #endif
312            )
313          {
314             if (acl->action == ACL_PERMIT)
315             {
316                return(0);
317             }
318             else
319             {
320                return(1);
321             }
322          }
323       }
324       acl = acl->next;
325    }
326
327    return(1);
328
329 }
330
331
332 /*********************************************************************
333  *
334  * Function    :  acl_addr
335  *
336  * Description :  Called from `load_config' to parse an ACL address.
337  *
338  * Parameters  :
339  *          1  :  aspec = String specifying ACL address.
340  *          2  :  aca = struct access_control_addr to fill in.
341  *
342  * Returns     :  0 => Ok, everything else is an error.
343  *
344  *********************************************************************/
345 int acl_addr(const char *aspec, struct access_control_addr *aca)
346 {
347    int i, masklength;
348 #ifdef HAVE_RFC2553
349    struct addrinfo hints, *result;
350    uint8_t *mask_data;
351    in_port_t *mask_port;
352    unsigned int addr_len;
353 #else
354    long port;
355 #endif /* def HAVE_RFC2553 */
356    char *p;
357    char *acl_spec = NULL;
358
359 #ifdef HAVE_RFC2553
360    /* XXX: Depend on ai_family */
361    masklength = 128;
362 #else
363    masklength = 32;
364    port       =  0;
365 #endif
366
367    /*
368     * Use a temporary acl spec copy so we can log
369     * the unmodified original in case of parse errors.
370     */
371    acl_spec = strdup(aspec);
372    if (acl_spec == NULL)
373    {
374       /* XXX: This will be logged as parse error. */
375       return(-1);
376    }
377
378    if ((p = strchr(acl_spec, '/')) != NULL)
379    {
380       *p++ = '\0';
381       if (ijb_isdigit(*p) == 0)
382       {
383          freez(acl_spec);
384          return(-1);
385       }
386       masklength = atoi(p);
387    }
388
389    if ((masklength < 0) ||
390 #ifdef HAVE_RFC2553
391          (masklength > 128)
392 #else
393          (masklength > 32)
394 #endif
395          )
396    {
397       freez(acl_spec);
398       return(-1);
399    }
400
401    if ((*acl_spec == '[') && (NULL != (p = strchr(acl_spec, ']'))))
402    {
403       *p = '\0';
404       memmove(acl_spec, acl_spec + 1, (size_t)(p - acl_spec));
405
406       if (*++p != ':')
407       {
408          p = NULL;
409       }
410    }
411    else
412    {
413       p = strchr(acl_spec, ':');
414    }
415
416 #ifdef HAVE_RFC2553
417    memset(&hints, 0, sizeof(struct addrinfo));
418    hints.ai_family = AF_UNSPEC;
419    hints.ai_socktype = SOCK_STREAM;
420
421    i = getaddrinfo(acl_spec, ((p) ? ++p : NULL), &hints, &result);
422
423    if (i != 0)
424    {
425       log_error(LOG_LEVEL_ERROR, "Can not resolve [%s]:%s: %s",
426          acl_spec, p, gai_strerror(i));
427       freez(acl_spec);
428       return(-1);
429    }
430    freez(acl_spec);
431
432    /* TODO: Allow multihomed hostnames */
433    memcpy(&(aca->addr), result->ai_addr, result->ai_addrlen);
434    freeaddrinfo(result);
435 #else
436    if (p != NULL)
437    {
438       char *endptr;
439
440       *p++ = '\0';
441       port = strtol(p, &endptr, 10);
442
443       if (port <= 0 || port > 65535 || *endptr != '\0')
444       {
445          freez(acl_spec);
446          return(-1);
447       }
448    }
449
450    aca->port = (unsigned long)port;
451
452    aca->addr = ntohl(resolve_hostname_to_ip(acl_spec));
453    freez(acl_spec);
454
455    if (aca->addr == INADDR_NONE)
456    {
457       /* XXX: This will be logged as parse error. */
458       return(-1);
459    }
460 #endif /* def HAVE_RFC2553 */
461
462    /* build the netmask */
463 #ifdef HAVE_RFC2553
464    /* Clip masklength according to current family. */
465    if ((aca->addr.ss_family == AF_INET) && (masklength > 32))
466    {
467       masklength = 32;
468    }
469
470    aca->mask.ss_family = aca->addr.ss_family;
471    if (sockaddr_storage_to_ip(&aca->mask, &mask_data, &addr_len, &mask_port))
472    {
473       return(-1);
474    }
475
476    if (p)
477    {
478       /* ACL contains a port number, check ports in the future. */
479       *mask_port = 1;
480    }
481
482    /*
483     * XXX: This could be optimized to operate on whole words instead
484     * of octets (128-bit CPU could do it in one iteration).
485     */
486    /*
487     * Octets after prefix can be ommitted because of
488     * previous initialization to zeros.
489     */
490    for (i = 0; (i < addr_len) && masklength; i++)
491    {
492       if (masklength >= 8)
493       {
494          mask_data[i] = 0xFF;
495          masklength -= 8;
496       }
497       else
498       {
499          /*
500           * XXX: This assumes MSB of octet is on the left side.
501           * This should be true for all architectures or solved
502           * by the link layer.
503           */
504          mask_data[i] = (uint8_t)~((1 << (8 - masklength)) - 1);
505          masklength = 0;
506       }
507    }
508
509 #else
510    aca->mask = 0;
511    for (i=1; i <= masklength ; i++)
512    {
513       aca->mask |= (1U << (32 - i));
514    }
515
516    /* now mask off the host portion of the ip address
517     * (i.e. save on the network portion of the address).
518     */
519    aca->addr = aca->addr & aca->mask;
520 #endif /* def HAVE_RFC2553 */
521
522    return(0);
523
524 }
525 #endif /* def FEATURE_ACL */
526
527
528 /*********************************************************************
529  *
530  * Function    :  connect_port_is_forbidden
531  *
532  * Description :  Check to see if CONNECT requests to the destination
533  *                port of this request are forbidden. The check is
534  *                independend of the actual request method.
535  *
536  * Parameters  :
537  *          1  :  csp = Current client state (buffers, headers, etc...)
538  *
539  * Returns     :  True if yes, false otherwise.
540  *
541  *********************************************************************/
542 int connect_port_is_forbidden(const struct client_state *csp)
543 {
544    return ((csp->action->flags & ACTION_LIMIT_CONNECT) &&
545      !match_portlist(csp->action->string[ACTION_STRING_LIMIT_CONNECT],
546         csp->http->port));
547 }
548
549
550 /*********************************************************************
551  *
552  * Function    :  block_url
553  *
554  * Description :  Called from `chat'.  Check to see if we need to block this.
555  *
556  * Parameters  :
557  *          1  :  csp = Current client state (buffers, headers, etc...)
558  *
559  * Returns     :  NULL => unblocked, else HTTP block response
560  *
561  *********************************************************************/
562 struct http_response *block_url(struct client_state *csp)
563 {
564    struct http_response *rsp;
565    const char *new_content_type = NULL;
566
567    /*
568     * If it's not blocked, don't block it ;-)
569     */
570    if ((csp->action->flags & ACTION_BLOCK) == 0)
571    {
572       return NULL;
573    }
574    if (csp->action->flags & ACTION_REDIRECT)
575    {
576       log_error(LOG_LEVEL_ERROR, "redirect{} overruled by block.");     
577    }
578    /*
579     * Else, prepare a response
580     */
581    if (NULL == (rsp = alloc_http_response()))
582    {
583       return cgi_error_memory();
584    }
585
586    /*
587     * If it's an image-url, send back an image or redirect
588     * as specified by the relevant +image action
589     */
590 #ifdef FEATURE_IMAGE_BLOCKING
591    if (((csp->action->flags & ACTION_IMAGE_BLOCKER) != 0)
592         && is_imageurl(csp))
593    {
594       char *p;
595       /* determine HOW images should be blocked */
596       p = csp->action->string[ACTION_STRING_IMAGE_BLOCKER];
597
598       if(csp->action->flags & ACTION_HANDLE_AS_EMPTY_DOCUMENT)
599       {
600          log_error(LOG_LEVEL_ERROR, "handle-as-empty-document overruled by handle-as-image.");
601       }
602 #if 1 /* Two alternative strategies, use this one for now: */
603
604       /* and handle accordingly: */
605       if ((p == NULL) || (0 == strcmpic(p, "pattern")))
606       {
607          rsp->status = strdup("403 Request blocked by Privoxy");
608          if (rsp->status == NULL)
609          {
610             free_http_response(rsp);
611             return cgi_error_memory();
612          }
613          rsp->body = bindup(image_pattern_data, image_pattern_length);
614          if (rsp->body == NULL)
615          {
616             free_http_response(rsp);
617             return cgi_error_memory();
618          }
619          rsp->content_length = image_pattern_length;
620
621          if (enlist_unique_header(rsp->headers, "Content-Type", BUILTIN_IMAGE_MIMETYPE))
622          {
623             free_http_response(rsp);
624             return cgi_error_memory();
625          }
626       }
627
628       else if (0 == strcmpic(p, "blank"))
629       {
630          rsp->status = strdup("403 Request blocked by Privoxy");
631          if (rsp->status == NULL)
632          {
633             free_http_response(rsp);
634             return cgi_error_memory();
635          }
636          rsp->body = bindup(image_blank_data, image_blank_length);
637          if (rsp->body == NULL)
638          {
639             free_http_response(rsp);
640             return cgi_error_memory();
641          }
642          rsp->content_length = image_blank_length;
643
644          if (enlist_unique_header(rsp->headers, "Content-Type", BUILTIN_IMAGE_MIMETYPE))
645          {
646             free_http_response(rsp);
647             return cgi_error_memory();
648          }
649       }
650
651       else
652       {
653          rsp->status = strdup("302 Local Redirect from Privoxy");
654          if (rsp->status == NULL)
655          {
656             free_http_response(rsp);
657             return cgi_error_memory();
658          }
659
660          if (enlist_unique_header(rsp->headers, "Location", p))
661          {
662             free_http_response(rsp);
663             return cgi_error_memory();
664          }
665       }
666
667 #else /* Following code is disabled for now */
668
669       /* and handle accordingly: */
670       if ((p == NULL) || (0 == strcmpic(p, "pattern")))
671       {
672          p = CGI_PREFIX "send-banner?type=pattern";
673       }
674       else if (0 == strcmpic(p, "blank"))
675       {
676          p = CGI_PREFIX "send-banner?type=blank";
677       }
678       rsp->status = strdup("302 Local Redirect from Privoxy");
679       if (rsp->status == NULL)
680       {
681          free_http_response(rsp);
682          return cgi_error_memory();
683       }
684
685       if (enlist_unique_header(rsp->headers, "Location", p))
686       {
687          free_http_response(rsp);
688          return cgi_error_memory();
689       }
690 #endif /* Preceeding code is disabled for now */
691    }
692    else
693 #endif /* def FEATURE_IMAGE_BLOCKING */
694    if(csp->action->flags & ACTION_HANDLE_AS_EMPTY_DOCUMENT)
695    {
696      /*
697       *  Send empty document.               
698       */
699       new_content_type = csp->action->string[ACTION_STRING_CONTENT_TYPE];
700
701       freez(rsp->body);
702       rsp->body = strdup(" ");
703       rsp->content_length = 1;
704
705       rsp->status = strdup("403 Request blocked by Privoxy");
706       if (rsp->status == NULL)
707       {
708          free_http_response(rsp);
709          return cgi_error_memory();
710       }
711       if (new_content_type != 0)
712       {
713          log_error(LOG_LEVEL_HEADER, "Overwriting Content-Type with %s", new_content_type);
714          if (enlist_unique_header(rsp->headers, "Content-Type", new_content_type))
715          {
716             free_http_response(rsp);
717             return cgi_error_memory();
718          }
719       }
720    }
721    else
722
723    /*
724     * Else, generate an HTML "blocked" message:
725     */
726    {
727       jb_err err;
728       struct map * exports;
729       char *p;
730
731       /*
732        * Workaround for stupid Netscape bug which prevents
733        * pages from being displayed if loading a referenced
734        * JavaScript or style sheet fails. So make it appear
735        * as if it succeeded.
736        */
737       if ( NULL != (p = get_header_value(csp->headers, "User-Agent:"))
738            && !strncmpic(p, "mozilla", 7) /* Catch Netscape but */
739            && !strstr(p, "Gecko")         /* save Mozilla, */
740            && !strstr(p, "compatible")    /* MSIE */
741            && !strstr(p, "Opera"))        /* and Opera. */
742       {
743          rsp->status = strdup("200 Request for blocked URL");
744       }
745       else
746       {
747          rsp->status = strdup("403 Request for blocked URL");
748       }
749
750       if (rsp->status == NULL)
751       {
752          free_http_response(rsp);
753          return cgi_error_memory();
754       }
755
756       exports = default_exports(csp, NULL);
757       if (exports == NULL)
758       {
759          free_http_response(rsp);
760          return cgi_error_memory();
761       }
762
763 #ifdef FEATURE_FORCE_LOAD
764       err = map(exports, "force-prefix", 1, FORCE_PREFIX, 1);
765       /*
766        * Export the force conditional block killer if
767        *
768        * - Privoxy was compiled without FEATURE_FORCE_LOAD, or
769        * - Privoxy is configured to enforce blocks, or
770        * - it's a CONNECT request and enforcing wouldn't work anyway.
771        */
772       if ((csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS)
773        || (0 == strcmpic(csp->http->gpc, "connect")))
774 #endif /* ndef FEATURE_FORCE_LOAD */
775       {
776          err = map_block_killer(exports, "force-support");
777       }
778
779       if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
780       if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
781       if (!err) err = map(exports, "path", 1, html_encode(csp->http->path), 0);
782       if (!err) err = map(exports, "path-ue", 1, url_encode(csp->http->path), 0);
783       if (!err)
784       {
785          const char *block_reason;
786          if (csp->action->string[ACTION_STRING_BLOCK] != NULL)
787          {
788             block_reason = csp->action->string[ACTION_STRING_BLOCK];
789          }
790          else
791          {
792             assert(connect_port_is_forbidden(csp));
793             block_reason = "Forbidden CONNECT port.";
794          }
795          err = map(exports, "block-reason", 1, html_encode(block_reason), 0);
796       }
797       if (err)
798       {
799          free_map(exports);
800          free_http_response(rsp);
801          return cgi_error_memory();
802       }
803
804       err = template_fill_for_cgi(csp, "blocked", exports, rsp);
805       if (err)
806       {
807          free_http_response(rsp);
808          return cgi_error_memory();
809       }
810    }
811    rsp->reason = RSP_REASON_BLOCKED;
812
813    return finish_http_response(csp, rsp);
814
815 }
816
817
818 #ifdef FEATURE_TRUST
819 /*********************************************************************
820  *
821  * Function    :  trust_url FIXME: I should be called distrust_url
822  *
823  * Description :  Calls is_untrusted_url to determine if the URL is trusted
824  *                and if not, returns a HTTP 403 response with a reject message.
825  *
826  * Parameters  :
827  *          1  :  csp = Current client state (buffers, headers, etc...)
828  *
829  * Returns     :  NULL => trusted, else http_response.
830  *
831  *********************************************************************/
832 struct http_response *trust_url(struct client_state *csp)
833 {
834    struct http_response *rsp;
835    struct map * exports;
836    char buf[BUFFER_SIZE];
837    char *p;
838    struct url_spec **tl;
839    struct url_spec *t;
840    jb_err err;
841
842    /*
843     * Don't bother to work on trusted URLs
844     */
845    if (!is_untrusted_url(csp))
846    {
847       return NULL;
848    }
849
850    /*
851     * Else, prepare a response:
852     */
853    if (NULL == (rsp = alloc_http_response()))
854    {
855       return cgi_error_memory();
856    }
857
858    rsp->status = strdup("403 Request blocked by Privoxy");
859    exports = default_exports(csp, NULL);
860    if (exports == NULL || rsp->status == NULL)
861    {
862       free_http_response(rsp);
863       return cgi_error_memory();
864    }
865
866    /*
867     * Export the protocol, host, port, and referrer information
868     */
869    err = map(exports, "hostport", 1, csp->http->hostport, 1);
870    if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1); 
871    if (!err) err = map(exports, "path", 1, csp->http->path, 1);
872
873    if (NULL != (p = get_header_value(csp->headers, "Referer:")))
874    {
875       if (!err) err = map(exports, "referrer", 1, html_encode(p), 0);
876    }
877    else
878    {
879       if (!err) err = map(exports, "referrer", 1, "none set", 1);
880    }
881
882    if (err)
883    {
884       free_map(exports);
885       free_http_response(rsp);
886       return cgi_error_memory();
887    }
888
889    /*
890     * Export the trust list
891     */
892    p = strdup("");
893    for (tl = csp->config->trust_list; (t = *tl) != NULL ; tl++)
894    {
895       snprintf(buf, sizeof(buf), "<li>%s</li>\n", t->spec);
896       string_append(&p, buf);
897    }
898    err = map(exports, "trusted-referrers", 1, p, 0);
899
900    if (err)
901    {
902       free_map(exports);
903       free_http_response(rsp);
904       return cgi_error_memory();
905    }
906
907    /*
908     * Export the trust info, if available
909     */
910    if (csp->config->trust_info->first)
911    {
912       struct list_entry *l;
913
914       p = strdup("");
915       for (l = csp->config->trust_info->first; l ; l = l->next)
916       {
917          snprintf(buf, sizeof(buf), "<li> <a href=\"%s\">%s</a><br>\n", l->str, l->str);
918          string_append(&p, buf);
919       }
920       err = map(exports, "trust-info", 1, p, 0);
921    }
922    else
923    {
924       err = map_block_killer(exports, "have-trust-info");
925    }
926
927    if (err)
928    {
929       free_map(exports);
930       free_http_response(rsp);
931       return cgi_error_memory();
932    }
933
934    /*
935     * Export the force conditional block killer if
936     *
937     * - Privoxy was compiled without FEATURE_FORCE_LOAD, or
938     * - Privoxy is configured to enforce blocks, or
939     * - it's a CONNECT request and enforcing wouldn't work anyway.
940     */
941 #ifdef FEATURE_FORCE_LOAD
942    if ((csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS)
943     || (0 == strcmpic(csp->http->gpc, "connect")))
944    {
945       err = map_block_killer(exports, "force-support");
946    }
947    else
948    {
949       err = map(exports, "force-prefix", 1, FORCE_PREFIX, 1);
950    }
951 #else /* ifndef FEATURE_FORCE_LOAD */
952    err = map_block_killer(exports, "force-support");
953 #endif /* ndef FEATURE_FORCE_LOAD */
954
955    if (err)
956    {
957       free_map(exports);
958       free_http_response(rsp);
959       return cgi_error_memory();
960    }
961
962    /*
963     * Build the response
964     */
965    err = template_fill_for_cgi(csp, "untrusted", exports, rsp);
966    if (err)
967    {
968       free_http_response(rsp);
969       return cgi_error_memory();
970    }
971    rsp->reason = RSP_REASON_UNTRUSTED;
972
973    return finish_http_response(csp, rsp);
974 }
975 #endif /* def FEATURE_TRUST */
976
977
978 /*********************************************************************
979  *
980  * Function    :  compile_dynamic_pcrs_job_list
981  *
982  * Description :  Compiles a dynamic pcrs job list (one with variables
983  *                resolved at request time)
984  *
985  * Parameters  :
986  *          1  :  csp = Current client state (buffers, headers, etc...)
987  *          2  :  b = The filter list to compile
988  *
989  * Returns     :  NULL in case of errors, otherwise the
990  *                pcrs job list.  
991  *
992  *********************************************************************/
993 pcrs_job *compile_dynamic_pcrs_job_list(const struct client_state *csp, const struct re_filterfile_spec *b)
994 {
995    struct list_entry *pattern;
996    pcrs_job *job_list = NULL;
997    pcrs_job *dummy = NULL;
998    pcrs_job *lastjob = NULL;
999    int error = 0;
1000
1001    const struct pcrs_variable variables[] =
1002    {
1003       {"url",    csp->http->url,   1},
1004       {"path",   csp->http->path,  1},
1005       {"host",   csp->http->host,  1},
1006       {"origin", csp->ip_addr_str, 1},
1007       {NULL,     NULL,             1}
1008    };
1009
1010    for (pattern = b->patterns->first; pattern != NULL; pattern = pattern->next)
1011    {
1012       assert(pattern->str != NULL);
1013
1014       dummy = pcrs_compile_dynamic_command(pattern->str, variables, &error);
1015       if (NULL == dummy)
1016       {
1017          assert(error < 0);
1018          log_error(LOG_LEVEL_ERROR,
1019             "Adding filter job \'%s\' to dynamic filter %s failed: %s",
1020             pattern->str, b->name, pcrs_strerror(error));
1021          continue;
1022       }
1023       else
1024       {
1025          if (error == PCRS_WARN_TRUNCATION)
1026          {
1027             log_error(LOG_LEVEL_ERROR,
1028                "At least one of the variables in \'%s\' had to "
1029                "be truncated before compilation", pattern->str);
1030          }
1031          if (job_list == NULL)
1032          {
1033             job_list = dummy;
1034          }
1035          else
1036          {
1037             lastjob->next = dummy;
1038          }
1039          lastjob = dummy;
1040       }
1041    }
1042
1043    return job_list;
1044 }
1045
1046
1047 /*********************************************************************
1048  *
1049  * Function    :  rewrite_url
1050  *
1051  * Description :  Rewrites a URL with a single pcrs command
1052  *                and returns the result if it differs from the
1053  *                original and isn't obviously invalid.
1054  *
1055  * Parameters  :
1056  *          1  :  old_url = URL to rewrite.
1057  *          2  :  pcrs_command = pcrs command formatted as string (s@foo@bar@)
1058  *
1059  *
1060  * Returns     :  NULL if the pcrs_command didn't change the url, or 
1061  *                the result of the modification.
1062  *
1063  *********************************************************************/
1064 char *rewrite_url(char *old_url, const char *pcrs_command)
1065 {
1066    char *new_url = NULL;
1067    int hits;
1068
1069    assert(old_url);
1070    assert(pcrs_command);
1071
1072    new_url = pcrs_execute_single_command(old_url, pcrs_command, &hits);
1073
1074    if (hits == 0)
1075    {
1076       log_error(LOG_LEVEL_REDIRECTS,
1077          "pcrs command \"%s\" didn't change \"%s\".",
1078          pcrs_command, old_url);
1079       freez(new_url);
1080    }
1081    else if (hits < 0)
1082    {
1083       log_error(LOG_LEVEL_REDIRECTS,
1084          "executing pcrs command \"%s\" to rewrite %s failed: %s",
1085          pcrs_command, old_url, pcrs_strerror(hits));
1086       freez(new_url);
1087    }
1088    else if (strncmpic(new_url, "http://", 7) && strncmpic(new_url, "https://", 8))
1089    {
1090       log_error(LOG_LEVEL_ERROR,
1091          "pcrs command \"%s\" changed \"%s\" to \"%s\" (%u hi%s), "
1092          "but the result doesn't look like a valid URL and will be ignored.",
1093          pcrs_command, old_url, new_url, hits, (hits == 1) ? "t" : "ts");
1094       freez(new_url);
1095    }
1096    else
1097    {
1098       log_error(LOG_LEVEL_REDIRECTS,
1099          "pcrs command \"%s\" changed \"%s\" to \"%s\" (%u hi%s).",
1100          pcrs_command, old_url, new_url, hits, (hits == 1) ? "t" : "ts");
1101    }
1102
1103    return new_url;
1104
1105 }
1106
1107
1108 #ifdef FEATURE_FAST_REDIRECTS
1109 /*********************************************************************
1110  *
1111  * Function    :  get_last_url
1112  *
1113  * Description :  Search for the last URL inside a string.
1114  *                If the string already is a URL, it will
1115  *                be the first URL found.
1116  *
1117  * Parameters  :
1118  *          1  :  subject = the string to check
1119  *          2  :  redirect_mode = +fast-redirect{} mode 
1120  *
1121  * Returns     :  NULL if no URL was found, or
1122  *                the last URL found.
1123  *
1124  *********************************************************************/
1125 char *get_last_url(char *subject, const char *redirect_mode)
1126 {
1127    char *new_url = NULL;
1128    char *tmp;
1129
1130    assert(subject);
1131    assert(redirect_mode);
1132
1133    subject = strdup(subject);
1134    if (subject == NULL)
1135    {
1136       log_error(LOG_LEVEL_ERROR, "Out of memory while searching for redirects.");
1137       return NULL;
1138    }
1139
1140    if (0 == strcmpic(redirect_mode, "check-decoded-url"))
1141    {  
1142       log_error(LOG_LEVEL_REDIRECTS, "Decoding \"%s\" if necessary.", subject);
1143       new_url = url_decode(subject);
1144       if (new_url != NULL)
1145       {
1146          freez(subject);
1147          subject = new_url;
1148       }
1149       else
1150       {
1151          log_error(LOG_LEVEL_ERROR, "Unable to decode \"%s\".", subject);
1152       }
1153    }
1154
1155    log_error(LOG_LEVEL_REDIRECTS, "Checking \"%s\" for redirects.", subject);
1156
1157    /*
1158     * Find the last URL encoded in the request
1159     */
1160    tmp = subject;
1161    while ((tmp = strstr(tmp, "http://")) != NULL)
1162    {
1163       new_url = tmp++;
1164    }
1165    tmp = (new_url != NULL) ? new_url : subject;
1166    while ((tmp = strstr(tmp, "https://")) != NULL)
1167    {
1168       new_url = tmp++;
1169    }
1170
1171    if ((new_url != NULL)
1172       && (  (new_url != subject)
1173          || (0 == strncmpic(subject, "http://", 7))
1174          || (0 == strncmpic(subject, "https://", 8))
1175          ))
1176    {
1177       /*
1178        * Return new URL if we found a redirect 
1179        * or if the subject already was a URL.
1180        *
1181        * The second case makes sure that we can
1182        * chain get_last_url after another redirection check
1183        * (like rewrite_url) without losing earlier redirects.
1184        */
1185       new_url = strdup(new_url);
1186       freez(subject);
1187       return new_url;
1188    }
1189
1190    freez(subject);
1191    return NULL;
1192
1193 }
1194 #endif /* def FEATURE_FAST_REDIRECTS */
1195
1196
1197 /*********************************************************************
1198  *
1199  * Function    :  redirect_url
1200  *
1201  * Description :  Checks if Privoxy should answer the request with
1202  *                a HTTP redirect and generates the redirect if
1203  *                necessary.
1204  *
1205  * Parameters  :
1206  *          1  :  csp = Current client state (buffers, headers, etc...)
1207  *
1208  * Returns     :  NULL if the request can pass, HTTP redirect otherwise.
1209  *
1210  *********************************************************************/
1211 struct http_response *redirect_url(struct client_state *csp)
1212 {
1213    struct http_response *rsp;
1214 #ifdef FEATURE_FAST_REDIRECTS
1215    /*
1216     * XXX: Do we still need FEATURE_FAST_REDIRECTS
1217     * as compile-time option? The user can easily disable
1218     * it in his action file.
1219     */
1220    char * redirect_mode;
1221 #endif /* def FEATURE_FAST_REDIRECTS */
1222    char *old_url = NULL;
1223    char *new_url = NULL;
1224    char *redirection_string;
1225
1226    if ((csp->action->flags & ACTION_REDIRECT))
1227    {
1228       redirection_string = csp->action->string[ACTION_STRING_REDIRECT];
1229
1230       /*
1231        * If the redirection string begins with 's',
1232        * assume it's a pcrs command, otherwise treat it as
1233        * properly formatted URL and use it for the redirection
1234        * directly.
1235        *
1236        * According to RFC 2616 section 14.30 the URL
1237        * has to be absolute and if the user tries:
1238        * +redirect{shit/this/will/be/parsed/as/pcrs_command.html}
1239        * she would get undefined results anyway.
1240        *
1241        */
1242
1243       if (*redirection_string == 's')
1244       {
1245          old_url = csp->http->url;
1246          new_url = rewrite_url(old_url, redirection_string);
1247       }
1248       else
1249       {
1250          log_error(LOG_LEVEL_REDIRECTS,
1251             "No pcrs command recognized, assuming that \"%s\" is already properly formatted.",
1252             redirection_string);
1253          new_url = strdup(redirection_string);
1254       }
1255    }
1256
1257 #ifdef FEATURE_FAST_REDIRECTS
1258    if ((csp->action->flags & ACTION_FAST_REDIRECTS))
1259    {
1260       redirect_mode = csp->action->string[ACTION_STRING_FAST_REDIRECTS];
1261
1262       /*
1263        * If it exists, use the previously rewritten URL as input
1264        * otherwise just use the old path.
1265        */
1266       old_url = (new_url != NULL) ? new_url : strdup(csp->http->path);
1267       new_url = get_last_url(old_url, redirect_mode);
1268       freez(old_url);
1269    }
1270
1271    /*
1272     * Disable redirect checkers, so that they
1273     * will be only run more than once if the user
1274     * also enables them through tags.
1275     *
1276     * From a performance point of view
1277     * it doesn't matter, but the duplicated
1278     * log messages are annoying.
1279     */
1280    csp->action->flags &= ~ACTION_FAST_REDIRECTS;
1281 #endif /* def FEATURE_FAST_REDIRECTS */
1282    csp->action->flags &= ~ACTION_REDIRECT;
1283
1284    /* Did any redirect action trigger? */   
1285    if (new_url)
1286    {
1287       if (0 == strcmpic(new_url, csp->http->url))
1288       {
1289          log_error(LOG_LEVEL_ERROR,
1290             "New URL \"%s\" and old URL \"%s\" are the same. Redirection loop prevented.",
1291             csp->http->url, new_url);
1292             freez(new_url);
1293       }
1294       else
1295       {
1296          log_error(LOG_LEVEL_REDIRECTS, "New URL is: %s", new_url);
1297
1298          if (NULL == (rsp = alloc_http_response()))
1299          {
1300             freez(new_url);
1301             return cgi_error_memory();
1302          }
1303
1304          if ( enlist_unique_header(rsp->headers, "Location", new_url)
1305            || (NULL == (rsp->status = strdup("302 Local Redirect from Privoxy"))) )
1306          {
1307             freez(new_url);
1308             free_http_response(rsp);
1309             return cgi_error_memory();
1310          }
1311          rsp->reason = RSP_REASON_REDIRECTED;
1312          freez(new_url);
1313
1314          return finish_http_response(csp, rsp);
1315       }
1316    }
1317
1318    /* Only reached if no redirect is required */
1319    return NULL;
1320
1321 }
1322
1323
1324 #ifdef FEATURE_IMAGE_BLOCKING
1325 /*********************************************************************
1326  *
1327  * Function    :  is_imageurl
1328  *
1329  * Description :  Given a URL, decide whether it is an image or not,
1330  *                using either the info from a previous +image action
1331  *                or, #ifdef FEATURE_IMAGE_DETECT_MSIE, and the browser
1332  *                is MSIE and not on a Mac, tell from the browser's accept
1333  *                header.
1334  *
1335  * Parameters  :
1336  *          1  :  csp = Current client state (buffers, headers, etc...)
1337  *
1338  * Returns     :  True (nonzero) if URL is an image, false (0)
1339  *                otherwise
1340  *
1341  *********************************************************************/
1342 int is_imageurl(const struct client_state *csp)
1343 {
1344 #ifdef FEATURE_IMAGE_DETECT_MSIE
1345    char *tmp;
1346
1347    tmp = get_header_value(csp->headers, "User-Agent:");
1348    if (tmp && strstr(tmp, "MSIE") && !strstr(tmp, "Mac_"))
1349    {
1350       tmp = get_header_value(csp->headers, "Accept:");
1351       if (tmp && strstr(tmp, "image/gif"))
1352       {
1353          /* Client will accept HTML.  If this seems counterintuitive,
1354           * blame Microsoft.
1355           */
1356          return(0);
1357       }
1358       else
1359       {
1360          return(1);
1361       }
1362    }
1363 #endif /* def FEATURE_IMAGE_DETECT_MSIE */
1364
1365    return ((csp->action->flags & ACTION_IMAGE) != 0);
1366
1367 }
1368 #endif /* def FEATURE_IMAGE_BLOCKING */
1369
1370
1371 #ifdef FEATURE_TRUST
1372 /*********************************************************************
1373  *
1374  * Function    :  is_untrusted_url
1375  *
1376  * Description :  Should we "distrust" this URL (and block it)?
1377  *
1378  *                Yes if it matches a line in the trustfile, or if the
1379  *                    referrer matches a line starting with "+" in the
1380  *                    trustfile.
1381  *                No  otherwise.
1382  *
1383  * Parameters  :
1384  *          1  :  csp = Current client state (buffers, headers, etc...)
1385  *
1386  * Returns     :  0 => trusted, 1 => untrusted
1387  *
1388  *********************************************************************/
1389 int is_untrusted_url(const struct client_state *csp)
1390 {
1391    struct file_list *fl;
1392    struct block_spec *b;
1393    struct url_spec **trusted_url;
1394    struct http_request rhttp[1];
1395    const char * referer;
1396    jb_err err;
1397
1398    /*
1399     * If we don't have a trustlist, we trust everybody
1400     */
1401    if (((fl = csp->tlist) == NULL) || ((b  = fl->f) == NULL))
1402    {
1403       return 0;
1404    }
1405
1406    memset(rhttp, '\0', sizeof(*rhttp));
1407
1408    /*
1409     * Do we trust the request URL itself?
1410     */
1411    for (b = b->next; b ; b = b->next)
1412    {
1413       if (url_match(b->url, csp->http))
1414       {
1415          return b->reject;
1416       }
1417    }
1418
1419    if (NULL == (referer = get_header_value(csp->headers, "Referer:")))
1420    {
1421       /* no referrer was supplied */
1422       return 1;
1423    }
1424
1425
1426    /*
1427     * If not, do we maybe trust its referrer?
1428     */
1429    err = parse_http_url(referer, rhttp, REQUIRE_PROTOCOL);
1430    if (err)
1431    {
1432       return 1;
1433    }
1434
1435    for (trusted_url = csp->config->trust_list; *trusted_url != NULL; trusted_url++)
1436    {
1437       if (url_match(*trusted_url, rhttp))
1438       {
1439          /* if the URL's referrer is from a trusted referrer, then
1440           * add the target spec to the trustfile as an unblocked
1441           * domain and return 0 (which means it's OK).
1442           */
1443
1444          FILE *fp;
1445
1446          if (NULL != (fp = fopen(csp->config->trustfile, "a")))
1447          {
1448             char * path;
1449             char * path_end;
1450             char * new_entry = strdup("~");
1451
1452             string_append(&new_entry, csp->http->hostport);
1453
1454             path = csp->http->path;
1455             if ( (path[0] == '/')
1456               && (path[1] == '~')
1457               && ((path_end = strchr(path + 2, '/')) != NULL))
1458             {
1459                /* since this path points into a user's home space
1460                 * be sure to include this spec in the trustfile.
1461                 */
1462                long path_len = path_end - path; /* save offset */
1463                path = strdup(path); /* Copy string */
1464                if (path != NULL)
1465                {
1466                   path_end = path + path_len; /* regenerate ptr to new buffer */
1467                   *(path_end + 1) = '\0'; /* Truncate path after '/' */
1468                }
1469                string_join(&new_entry, path);
1470             }
1471
1472             /*
1473              * Give a reason for generating this entry.
1474              */
1475             string_append(&new_entry, " # Trusted referrer was: ");
1476             string_append(&new_entry, referer);
1477
1478             if (new_entry != NULL)
1479             {
1480                if (-1 == fprintf(fp, "%s\n", new_entry))
1481                {
1482                   log_error(LOG_LEVEL_ERROR, "Failed to append \'%s\' to trustfile \'%s\': %E",
1483                      new_entry, csp->config->trustfile);
1484                }
1485                freez(new_entry);
1486             }
1487             else
1488             {
1489                /* FIXME: No way to handle out-of memory, so mostly ignoring it */
1490                log_error(LOG_LEVEL_ERROR, "Out of memory adding pattern to trust file");
1491             }
1492
1493             fclose(fp);
1494          }
1495          else
1496          {
1497             log_error(LOG_LEVEL_ERROR, "Failed to append new entry for \'%s\' to trustfile \'%s\': %E",
1498                csp->http->hostport, csp->config->trustfile);
1499          }
1500          return 0;
1501       }
1502    }
1503
1504    return 1;
1505 }
1506 #endif /* def FEATURE_TRUST */
1507
1508
1509 /*********************************************************************
1510  *
1511  * Function    :  pcrs_filter_response
1512  *
1513  * Description :  Execute all text substitutions from all applying
1514  *                +filter actions on the text buffer that's been
1515  *                accumulated in csp->iob->buf.
1516  *
1517  * Parameters  :
1518  *          1  :  csp = Current client state (buffers, headers, etc...)
1519  *
1520  * Returns     :  a pointer to the (newly allocated) modified buffer.
1521  *                or NULL if there were no hits or something went wrong
1522  *
1523  *********************************************************************/
1524 static char *pcrs_filter_response(struct client_state *csp)
1525 {
1526    int hits=0;
1527    size_t size, prev_size;
1528
1529    char *old = NULL;
1530    char *new = NULL;
1531    pcrs_job *job;
1532
1533    struct file_list *fl;
1534    struct re_filterfile_spec *b;
1535    struct list_entry *filtername;
1536
1537    int i, found_filters = 0;
1538
1539    /* 
1540     * Sanity first
1541     */
1542    if (csp->iob->cur >= csp->iob->eod)
1543    {
1544       return(NULL);
1545    }
1546
1547    /*
1548     * Need to check the set of re_filterfiles...
1549     */
1550    for (i = 0; i < MAX_AF_FILES; i++)
1551    {
1552       fl = csp->rlist[i];
1553       if (NULL != fl)
1554       {
1555          if (NULL != fl->f)
1556          {
1557            found_filters = 1;
1558            break;
1559          }
1560       }
1561    }
1562
1563    if (0 == found_filters)
1564    {
1565       log_error(LOG_LEVEL_ERROR, "Inconsistent configuration: "
1566          "content filtering enabled, but no content filters available.");
1567       return(NULL);
1568    }
1569
1570    size = (size_t)(csp->iob->eod - csp->iob->cur);
1571    old = csp->iob->cur;
1572
1573    for (i = 0; i < MAX_AF_FILES; i++)
1574    {
1575      fl = csp->rlist[i];
1576      if ((NULL == fl) || (NULL == fl->f))
1577      {
1578         /*
1579          * Either there are no filter files
1580          * left, or this filter file just
1581          * contains no valid filters.
1582          *
1583          * Continue to be sure we don't miss
1584          * valid filter files that are chained
1585          * after empty or invalid ones.
1586          */
1587         continue;
1588      }
1589    /*
1590     * For all applying +filter actions, look if a filter by that
1591     * name exists and if yes, execute it's pcrs_joblist on the
1592     * buffer.
1593     */
1594    for (b = fl->f; b; b = b->next)
1595    {
1596       if (b->type != FT_CONTENT_FILTER)
1597       {
1598          /* Skip header filters */
1599          continue;
1600       }
1601
1602       for (filtername = csp->action->multi[ACTION_MULTI_FILTER]->first;
1603            filtername ; filtername = filtername->next)
1604       {
1605          if (strcmp(b->name, filtername->str) == 0)
1606          {
1607             int current_hits = 0; /* Number of hits caused by this filter */
1608             int job_number   = 0; /* Which job we're currently executing  */
1609             int job_hits     = 0; /* How many hits the current job caused */
1610             pcrs_job *joblist = b->joblist;
1611
1612             if (b->dynamic) joblist = compile_dynamic_pcrs_job_list(csp, b);
1613
1614             if (NULL == joblist)
1615             {
1616                log_error(LOG_LEVEL_RE_FILTER, "Filter %s has empty joblist. Nothing to do.", b->name);
1617                continue;
1618             }
1619
1620             prev_size = size;
1621             /* Apply all jobs from the joblist */
1622             for (job = joblist; NULL != job; job = job->next)
1623             {
1624                job_number++;
1625                job_hits = pcrs_execute(job, old, size, &new, &size);
1626
1627                if (job_hits >= 0)
1628                {
1629                   /*
1630                    * That went well. Continue filtering
1631                    * and use the result of this job as
1632                    * input for the next one.
1633                    */
1634                   current_hits += job_hits;
1635                   if (old != csp->iob->cur)
1636                   {
1637                      freez(old);
1638                   }
1639                   old = new;
1640                }
1641                else
1642                {
1643                   /*
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.
1649                    *
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
1654                    * as well.
1655                    *
1656                    * XXX: Is this important enough for LOG_LEVEL_ERROR or
1657                    * should we use LOG_LEVEL_RE_FILTER instead?
1658                    */
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);
1661                   break;
1662                }
1663             }
1664
1665             if (b->dynamic) pcrs_free_joblist(joblist);
1666
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);
1670
1671             hits += current_hits;
1672          }
1673       }
1674    }
1675    }
1676
1677    /*
1678     * If there were no hits, destroy our copy and let
1679     * chat() use the original in csp->iob
1680     */
1681    if (!hits)
1682    {
1683       freez(new);
1684       return(NULL);
1685    }
1686
1687    csp->flags |= CSP_FLAG_MODIFIED;
1688    csp->content_length = size;
1689    IOB_RESET(csp);
1690
1691    return(new);
1692
1693 }
1694
1695
1696 /*********************************************************************
1697  *
1698  * Function    :  gif_deanimate_response
1699  *
1700  * Description :  Deanimate the GIF image that has been accumulated in
1701  *                csp->iob->buf, set csp->content_length to the modified
1702  *                size and raise the CSP_FLAG_MODIFIED flag.
1703  *
1704  * Parameters  :
1705  *          1  :  csp = Current client state (buffers, headers, etc...)
1706  *
1707  * Returns     :  a pointer to the (newly allocated) modified buffer.
1708  *                or NULL in case something went wrong.
1709  *
1710  *********************************************************************/
1711 static char *gif_deanimate_response(struct client_state *csp)
1712 {
1713    struct binbuffer *in, *out;
1714    char *p;
1715    size_t size;
1716
1717    size = (size_t)(csp->iob->eod - csp->iob->cur);
1718
1719    if (  (NULL == (in =  (struct binbuffer *)zalloc(sizeof *in )))
1720       || (NULL == (out = (struct binbuffer *)zalloc(sizeof *out))) )
1721    {
1722       log_error(LOG_LEVEL_DEANIMATE, "failed! (no mem)");
1723       return NULL;
1724    }
1725
1726    in->buffer = csp->iob->cur;
1727    in->size = size;
1728
1729    if (gif_deanimate(in, out, strncmp("last", csp->action->string[ACTION_STRING_DEANIMATE], 4)))
1730    {
1731       log_error(LOG_LEVEL_DEANIMATE, "failed! (gif parsing)");
1732       freez(in);
1733       buf_free(out);
1734       return(NULL);
1735    }
1736    else
1737    {
1738       if ((int)size == out->offset)
1739       {
1740          log_error(LOG_LEVEL_DEANIMATE, "GIF not changed.");
1741       }
1742       else
1743       {
1744          log_error(LOG_LEVEL_DEANIMATE, "Success! GIF shrunk from %d bytes to %d.", size, out->offset);
1745       }
1746       csp->content_length = out->offset;
1747       csp->flags |= CSP_FLAG_MODIFIED;
1748       p = out->buffer;
1749       freez(in);
1750       freez(out);
1751       return(p);
1752    }
1753
1754 }
1755
1756
1757 /*********************************************************************
1758  *
1759  * Function    :  get_filter_function
1760  *
1761  * Description :  Decides which content filter function has
1762  *                to be applied (if any).
1763  *
1764  * Parameters  :
1765  *          1  :  csp = Current client state (buffers, headers, etc...)
1766  *
1767  * Returns     :  The content filter function to run, or
1768  *                NULL if no content filter is active
1769  *
1770  *********************************************************************/
1771 filter_function_ptr get_filter_function(struct client_state *csp)
1772 {
1773    filter_function_ptr filter_function = NULL;
1774
1775    if ((csp->content_type & CT_TABOO)
1776       && !(csp->action->flags & ACTION_FORCE_TEXT_MODE))
1777    {
1778       return NULL;
1779    }
1780
1781    /*
1782     * Are we enabling text mode by force?
1783     */
1784    if (csp->action->flags & ACTION_FORCE_TEXT_MODE)
1785    {
1786       /*
1787        * Do we really have to?
1788        */
1789       if (csp->content_type & CT_TEXT)
1790       {
1791          log_error(LOG_LEVEL_HEADER, "Text mode is already enabled.");   
1792       }
1793       else
1794       {
1795          csp->content_type |= CT_TEXT;
1796          log_error(LOG_LEVEL_HEADER, "Text mode enabled by force. Take cover!");   
1797       }
1798    }
1799
1800    if (!(csp->content_type & CT_DECLARED))
1801    {
1802       /*
1803        * The server didn't bother to declare a MIME-Type.
1804        * Assume it's text that can be filtered.
1805        *
1806        * This also regulary happens with 304 responses,
1807        * therefore logging anything here would cause
1808        * too much noise.
1809        */
1810       csp->content_type |= CT_TEXT;
1811    }
1812
1813    /*
1814     * Choose the applying filter function based on
1815     * the content type and action settings.
1816     */
1817    if ((csp->content_type & CT_TEXT) &&
1818        (csp->rlist != NULL) &&
1819        (!list_is_empty(csp->action->multi[ACTION_MULTI_FILTER])))
1820    {
1821       filter_function = pcrs_filter_response;
1822    }
1823    else if ((csp->content_type & CT_GIF)  &&
1824             (csp->action->flags & ACTION_DEANIMATE))
1825    {
1826       filter_function = gif_deanimate_response;
1827    }
1828
1829    return filter_function;
1830 }
1831
1832
1833 /*********************************************************************
1834  *
1835  * Function    :  remove_chunked_transfer_coding
1836  *
1837  * Description :  In-situ remove the "chunked" transfer coding as defined
1838  *                in rfc2616 from a buffer.
1839  *
1840  * Parameters  :
1841  *          1  :  buffer = Pointer to the text buffer
1842  *          2  :  size =  In: Number of bytes to be processed,
1843  *                       Out: Number of bytes after de-chunking.
1844  *                       (undefined in case of errors)
1845  *
1846  * Returns     :  JB_ERR_OK for success,
1847  *                JB_ERR_PARSE otherwise
1848  *
1849  *********************************************************************/
1850 static jb_err remove_chunked_transfer_coding(char *buffer, size_t *size)
1851 {
1852    size_t newsize = 0;
1853    unsigned int chunksize = 0;
1854    char *from_p, *to_p;
1855
1856    assert(buffer);
1857    from_p = to_p = buffer;
1858
1859    if (sscanf(buffer, "%x", &chunksize) != 1)
1860    {
1861       log_error(LOG_LEVEL_ERROR, "Invalid first chunksize while stripping \"chunked\" transfer coding");
1862       return JB_ERR_PARSE;
1863    }
1864
1865    while (chunksize > 0U)
1866    {
1867       if (NULL == (from_p = strstr(from_p, "\r\n")))
1868       {
1869          log_error(LOG_LEVEL_ERROR, "Parse error while stripping \"chunked\" transfer coding");
1870          return JB_ERR_PARSE;
1871       }
1872
1873       if ((newsize += chunksize) >= *size)
1874       {
1875          log_error(LOG_LEVEL_ERROR,
1876             "Chunk size %d exceeds buffer size %d in  \"chunked\" transfer coding",
1877             chunksize, *size);
1878          return JB_ERR_PARSE;
1879       }
1880       from_p += 2;
1881
1882       memmove(to_p, from_p, (size_t) chunksize);
1883       to_p = buffer + newsize;
1884       from_p += chunksize + 2;
1885
1886       if (sscanf(from_p, "%x", &chunksize) != 1)
1887       {
1888          log_error(LOG_LEVEL_INFO, "Invalid \"chunked\" transfer encoding detected and ignored.");
1889          break;
1890       }
1891    }
1892    
1893    /* XXX: Should get its own loglevel. */
1894    log_error(LOG_LEVEL_RE_FILTER, "De-chunking successful. Shrunk from %d to %d", *size, newsize);
1895
1896    *size = newsize;
1897
1898    return JB_ERR_OK;
1899
1900 }
1901
1902
1903 /*********************************************************************
1904  *
1905  * Function    :  prepare_for_filtering
1906  *
1907  * Description :  If necessary, de-chunks and decompresses
1908  *                the content so it can get filterd.
1909  *
1910  * Parameters  :
1911  *          1  :  csp = Current client state (buffers, headers, etc...)
1912  *
1913  * Returns     :  JB_ERR_OK for success,
1914  *                JB_ERR_PARSE otherwise
1915  *
1916  *********************************************************************/
1917 static jb_err prepare_for_filtering(struct client_state *csp)
1918 {
1919    jb_err err = JB_ERR_OK;
1920
1921    /*
1922     * If the body has a "chunked" transfer-encoding,
1923     * get rid of it, adjusting size and iob->eod
1924     */
1925    if (csp->flags & CSP_FLAG_CHUNKED)
1926    {
1927       size_t size = (size_t)(csp->iob->eod - csp->iob->cur);
1928
1929       log_error(LOG_LEVEL_RE_FILTER, "Need to de-chunk first");
1930       err = remove_chunked_transfer_coding(csp->iob->cur, &size);
1931       if (JB_ERR_OK == err)
1932       {
1933          csp->iob->eod = csp->iob->cur + size;
1934          csp->flags |= CSP_FLAG_MODIFIED;
1935       }
1936       else
1937       {
1938          return JB_ERR_PARSE;
1939       }
1940    }
1941
1942 #ifdef FEATURE_ZLIB
1943    /*
1944     * If the body has a supported transfer-encoding,
1945     * decompress it, adjusting size and iob->eod.
1946     */
1947    if (csp->content_type & (CT_GZIP|CT_DEFLATE))
1948    {
1949       if (0 == csp->iob->eod - csp->iob->cur)
1950       {
1951          /* Nothing left after de-chunking. */
1952          return JB_ERR_OK;
1953       }
1954
1955       err = decompress_iob(csp);
1956
1957       if (JB_ERR_OK == err)
1958       {
1959          csp->flags |= CSP_FLAG_MODIFIED;
1960          csp->content_type &= ~CT_TABOO;
1961       }
1962       else
1963       {
1964          /*
1965           * Unset CT_GZIP and CT_DEFLATE to remember not
1966           * to modify the Content-Encoding header later.
1967           */
1968          csp->content_type &= ~CT_GZIP;
1969          csp->content_type &= ~CT_DEFLATE;
1970       }
1971    }
1972 #endif
1973
1974    return err;
1975 }
1976
1977
1978 /*********************************************************************
1979  *
1980  * Function    :  execute_content_filter
1981  *
1982  * Description :  Executes a given content filter.
1983  *
1984  * Parameters  :
1985  *          1  :  csp = Current client state (buffers, headers, etc...)
1986  *          2  :  content_filter = The filter function to execute
1987  *
1988  * Returns     :  Pointer to the modified buffer, or
1989  *                NULL if filtering failed or wasn't necessary.
1990  *
1991  *********************************************************************/
1992 char *execute_content_filter(struct client_state *csp, filter_function_ptr content_filter)
1993 {
1994    if (0 == csp->iob->eod - csp->iob->cur)
1995    {
1996       /*
1997        * No content (probably status code 301, 302 ...),
1998        * no filtering necessary.
1999        */
2000       return NULL;
2001    }
2002
2003    if (JB_ERR_OK != prepare_for_filtering(csp))
2004    {
2005       /*
2006        * failed to de-chunk or decompress.
2007        */
2008       return NULL;
2009    }
2010
2011    if (0 == csp->iob->eod - csp->iob->cur)
2012    {
2013       /*
2014        * Clown alarm: chunked and/or compressed nothing delivered.
2015        */
2016       return NULL;
2017    }
2018
2019    return ((*content_filter)(csp));
2020 }
2021
2022
2023 /*********************************************************************
2024  *
2025  * Function    :  get_url_actions
2026  *
2027  * Description :  Gets the actions for this URL.
2028  *
2029  * Parameters  :
2030  *          1  :  csp = Current client state (buffers, headers, etc...)
2031  *          2  :  http = http_request request for blocked URLs
2032  *
2033  * Returns     :  N/A
2034  *
2035  *********************************************************************/
2036 void get_url_actions(struct client_state *csp, struct http_request *http)
2037 {
2038    struct file_list *fl;
2039    struct url_actions *b;
2040    int i;
2041
2042    init_current_action(csp->action);
2043
2044    for (i = 0; i < MAX_AF_FILES; i++)
2045    {
2046       if (((fl = csp->actions_list[i]) == NULL) || ((b = fl->f) == NULL))
2047       {
2048          return;
2049       }
2050
2051       apply_url_actions(csp->action, http, b);
2052    }
2053
2054    return;
2055 }
2056
2057
2058 /*********************************************************************
2059  *
2060  * Function    :  apply_url_actions
2061  *
2062  * Description :  Applies a list of URL actions.
2063  *
2064  * Parameters  :
2065  *          1  :  action = Destination.
2066  *          2  :  http = Current URL
2067  *          3  :  b = list of URL actions to apply
2068  *
2069  * Returns     :  N/A
2070  *
2071  *********************************************************************/
2072 void apply_url_actions(struct current_action_spec *action,
2073                        struct http_request *http,
2074                        struct url_actions *b)
2075 {
2076    if (b == NULL)
2077    {
2078       /* Should never happen */
2079       return;
2080    }
2081
2082    for (b = b->next; NULL != b; b = b->next)
2083    {
2084       if (url_match(b->url, http))
2085       {
2086          merge_current_action(action, b->action);
2087       }
2088    }
2089 }
2090
2091
2092 /*********************************************************************
2093  *
2094  * Function    :  get_forward_override_settings
2095  *
2096  * Description :  Returns forward settings as specified with the
2097  *                forward-override{} action. forward-override accepts
2098  *                forward lines similar to the one used in the
2099  *                configuration file, but without the URL pattern.
2100  *
2101  *                For example:
2102  *
2103  *                   forward / .
2104  *
2105  *                in the configuration file can be replaced with
2106  *                the action section:
2107  *
2108  *                 {+forward-override{forward .}}
2109  *                 /
2110  *
2111  * Parameters  :
2112  *          1  :  csp = Current client state (buffers, headers, etc...)
2113  *
2114  * Returns     :  Pointer to forwarding structure in case of success.
2115  *                Invalid syntax is fatal.
2116  *
2117  *********************************************************************/
2118 const static struct forward_spec *get_forward_override_settings(struct client_state *csp)
2119 {
2120    const char *forward_override_line = csp->action->string[ACTION_STRING_FORWARD_OVERRIDE];
2121    char forward_settings[BUFFER_SIZE];
2122    char *http_parent = NULL;
2123    /* variable names were chosen for consistency reasons. */
2124    struct forward_spec *fwd = NULL;
2125    int vec_count;
2126    char *vec[3];
2127
2128    assert(csp->action->flags & ACTION_FORWARD_OVERRIDE);
2129    /* Should be enforced by load_one_actions_file() */
2130    assert(strlen(forward_override_line) < sizeof(forward_settings) - 1);
2131
2132    /* Create a copy ssplit can modify */
2133    strlcpy(forward_settings, forward_override_line, sizeof(forward_settings));
2134
2135    if (NULL != csp->fwd)
2136    {
2137       /*
2138        * XXX: Currently necessary to prevent memory
2139        * leaks when the show-url-info cgi page is visited.
2140        */
2141       unload_forward_spec(csp->fwd);
2142    }
2143
2144    /*
2145     * allocate a new forward node, valid only for
2146     * the lifetime of this request. Save its location
2147     * in csp as well, so sweep() can free it later on.
2148     */
2149    fwd = csp->fwd = zalloc(sizeof(*fwd));
2150    if (NULL == fwd)
2151    {
2152       log_error(LOG_LEVEL_FATAL,
2153          "can't allocate memory for forward-override{%s}", forward_override_line);
2154       /* Never get here - LOG_LEVEL_FATAL causes program exit */
2155       return NULL;
2156    }
2157
2158    vec_count = ssplit(forward_settings, " \t", vec, SZ(vec), 1, 1);
2159    if ((vec_count == 2) && !strcasecmp(vec[0], "forward"))
2160    {
2161       fwd->type = SOCKS_NONE;
2162
2163       /* Parse the parent HTTP proxy host:port */
2164       http_parent = vec[1];
2165
2166    }
2167    else if (vec_count == 3)
2168    {
2169       char *socks_proxy = NULL;
2170
2171       if  (!strcasecmp(vec[0], "forward-socks4"))
2172       {
2173          fwd->type = SOCKS_4;
2174          socks_proxy = vec[1];
2175       }
2176       else if (!strcasecmp(vec[0], "forward-socks4a"))
2177       {
2178          fwd->type = SOCKS_4A;
2179          socks_proxy = vec[1];
2180       }
2181       else if (!strcasecmp(vec[0], "forward-socks5"))
2182       {
2183          fwd->type = SOCKS_5;
2184          socks_proxy = vec[1];
2185       }
2186
2187       if (NULL != socks_proxy)
2188       {
2189          /* Parse the SOCKS proxy host[:port] */
2190          fwd->gateway_port = 1080;
2191          parse_forwarder_address(socks_proxy,
2192             &fwd->gateway_host, &fwd->gateway_port);
2193
2194          http_parent = vec[2];
2195       }
2196    }
2197
2198    if (NULL == http_parent)
2199    {
2200       log_error(LOG_LEVEL_FATAL,
2201          "Invalid forward-override syntax in: %s", forward_override_line);
2202       /* Never get here - LOG_LEVEL_FATAL causes program exit */
2203    }
2204
2205    /* Parse http forwarding settings */
2206    if (strcmp(http_parent, ".") != 0)
2207    {
2208       fwd->forward_port = 8000;
2209       parse_forwarder_address(http_parent,
2210          &fwd->forward_host, &fwd->forward_port);
2211    }
2212
2213    assert (NULL != fwd);
2214
2215    log_error(LOG_LEVEL_CONNECT,
2216       "Overriding forwarding settings based on \'%s\'", forward_override_line);
2217
2218    return fwd;
2219 }
2220
2221
2222 /*********************************************************************
2223  *
2224  * Function    :  forward_url
2225  *
2226  * Description :  Should we forward this to another proxy?
2227  *
2228  * Parameters  :
2229  *          1  :  csp = Current client state (buffers, headers, etc...)
2230  *          2  :  http = http_request request for current URL
2231  *
2232  * Returns     :  Pointer to forwarding information.
2233  *
2234  *********************************************************************/
2235 const struct forward_spec *forward_url(struct client_state *csp,
2236                                        const struct http_request *http)
2237 {
2238    static const struct forward_spec fwd_default[1] = { FORWARD_SPEC_INITIALIZER };
2239    struct forward_spec *fwd = csp->config->forward;
2240
2241    if (csp->action->flags & ACTION_FORWARD_OVERRIDE)
2242    {
2243       return get_forward_override_settings(csp);
2244    }
2245
2246    if (fwd == NULL)
2247    {
2248       return fwd_default;
2249    }
2250
2251    while (fwd != NULL)
2252    {
2253       if (url_match(fwd->url, http))
2254       {
2255          return fwd;
2256       }
2257       fwd = fwd->next;
2258    }
2259
2260    return fwd_default;
2261 }
2262
2263
2264 /*********************************************************************
2265  *
2266  * Function    :  direct_response 
2267  *
2268  * Description :  Check if Max-Forwards == 0 for an OPTIONS or TRACE
2269  *                request and if so, return a HTTP 501 to the client.
2270  *
2271  *                FIXME: I have a stupid name and I should handle the
2272  *                requests properly. Still, what we do here is rfc-
2273  *                compliant, whereas ignoring or forwarding are not.
2274  *
2275  * Parameters  :  
2276  *          1  :  csp = Current client state (buffers, headers, etc...)
2277  *
2278  * Returns     :  http_response if , NULL if nonmatch or handler fail
2279  *
2280  *********************************************************************/
2281 struct http_response *direct_response(struct client_state *csp)
2282 {
2283    struct http_response *rsp;
2284    struct list_entry *p;
2285
2286    if ((0 == strcmpic(csp->http->gpc, "trace"))
2287       || (0 == strcmpic(csp->http->gpc, "options")))
2288    {
2289       for (p = csp->headers->first; (p != NULL) ; p = p->next)
2290       {
2291          if (!strncmpic("Max-Forwards:", p->str, 13))
2292          {
2293             unsigned int max_forwards;
2294
2295             /*
2296              * If it's a Max-Forwards value of zero,
2297              * we have to intercept the request.
2298              */
2299             if (1 == sscanf(p->str+12, ": %u", &max_forwards) && max_forwards == 0)
2300             {
2301                /*
2302                 * FIXME: We could handle at least TRACE here,
2303                 * but that would require a verbatim copy of
2304                 * the request which we don't have anymore
2305                 */
2306                 log_error(LOG_LEVEL_HEADER,
2307                   "Detected header \'%s\' in OPTIONS or TRACE request. Returning 501.",
2308                   p->str);
2309
2310                /* Get mem for response or fail*/
2311                if (NULL == (rsp = alloc_http_response()))
2312                {
2313                   return cgi_error_memory();
2314                }
2315             
2316                if (NULL == (rsp->status = strdup("501 Not Implemented")))
2317                {
2318                   free_http_response(rsp);
2319                   return cgi_error_memory();
2320                }
2321
2322                rsp->is_static = 1;
2323                rsp->reason = RSP_REASON_UNSUPPORTED;
2324
2325                return(finish_http_response(csp, rsp));
2326             }
2327          }
2328       }
2329    }
2330    return NULL;
2331 }
2332
2333
2334 /*********************************************************************
2335  *
2336  * Function    :  content_filters_enabled
2337  *
2338  * Description :  Checks whether there are any content filters
2339  *                enabled for the current request.
2340  *
2341  * Parameters  :  
2342  *          1  :  action = Action spec to check.
2343  *
2344  * Returns     :  TRUE for yes, FALSE otherwise
2345  *
2346  *********************************************************************/
2347 int content_filters_enabled(const struct current_action_spec *action)
2348 {
2349    return ((action->flags & ACTION_DEANIMATE) ||
2350       !list_is_empty(action->multi[ACTION_MULTI_FILTER]));
2351 }
2352
2353 /*
2354   Local Variables:
2355   tab-width: 3
2356   end:
2357 */