Allow metrics.torproject.org
[privoxy.git] / filters.c
1 const char filters_rcs[] = "$Id: filters.c,v 1.127 2010/04/03 13:22:56 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
603       /* and handle accordingly: */
604       if ((p == NULL) || (0 == strcmpic(p, "pattern")))
605       {
606          rsp->status = strdup("403 Request blocked by Privoxy");
607          if (rsp->status == NULL)
608          {
609             free_http_response(rsp);
610             return cgi_error_memory();
611          }
612          rsp->body = bindup(image_pattern_data, image_pattern_length);
613          if (rsp->body == NULL)
614          {
615             free_http_response(rsp);
616             return cgi_error_memory();
617          }
618          rsp->content_length = image_pattern_length;
619
620          if (enlist_unique_header(rsp->headers, "Content-Type", BUILTIN_IMAGE_MIMETYPE))
621          {
622             free_http_response(rsp);
623             return cgi_error_memory();
624          }
625       }
626       else if (0 == strcmpic(p, "blank"))
627       {
628          rsp->status = strdup("403 Request blocked by Privoxy");
629          if (rsp->status == NULL)
630          {
631             free_http_response(rsp);
632             return cgi_error_memory();
633          }
634          rsp->body = bindup(image_blank_data, image_blank_length);
635          if (rsp->body == NULL)
636          {
637             free_http_response(rsp);
638             return cgi_error_memory();
639          }
640          rsp->content_length = image_blank_length;
641
642          if (enlist_unique_header(rsp->headers, "Content-Type", BUILTIN_IMAGE_MIMETYPE))
643          {
644             free_http_response(rsp);
645             return cgi_error_memory();
646          }
647       }
648       else
649       {
650          rsp->status = strdup("302 Local Redirect from Privoxy");
651          if (rsp->status == NULL)
652          {
653             free_http_response(rsp);
654             return cgi_error_memory();
655          }
656
657          if (enlist_unique_header(rsp->headers, "Location", p))
658          {
659             free_http_response(rsp);
660             return cgi_error_memory();
661          }
662       }
663
664    }
665    else
666 #endif /* def FEATURE_IMAGE_BLOCKING */
667    if(csp->action->flags & ACTION_HANDLE_AS_EMPTY_DOCUMENT)
668    {
669      /*
670       *  Send empty document.               
671       */
672       new_content_type = csp->action->string[ACTION_STRING_CONTENT_TYPE];
673
674       freez(rsp->body);
675       rsp->body = strdup(" ");
676       rsp->content_length = 1;
677
678       if (csp->config->feature_flags & RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK)
679       {
680          /*
681           * Workaround for firefox bug 492459
682           *   https://bugzilla.mozilla.org/show_bug.cgi?id=492459
683           * Return a 200 OK status for pages blocked with +handle-as-empty-document
684           * if the "handle-as-empty-doc-returns-ok" runtime config option is set.
685           */
686          rsp->status = strdup("200 Request blocked by Privoxy");
687       }
688       else
689       {
690          rsp->status = strdup("403 Request blocked by Privoxy");
691       }
692
693       if (rsp->status == NULL)
694       {
695          free_http_response(rsp);
696          return cgi_error_memory();
697       }
698       if (new_content_type != 0)
699       {
700          log_error(LOG_LEVEL_HEADER, "Overwriting Content-Type with %s", new_content_type);
701          if (enlist_unique_header(rsp->headers, "Content-Type", new_content_type))
702          {
703             free_http_response(rsp);
704             return cgi_error_memory();
705          }
706       }
707    }
708    else
709
710    /*
711     * Else, generate an HTML "blocked" message:
712     */
713    {
714       jb_err err;
715       struct map * exports;
716       char *p;
717
718       /*
719        * Workaround for stupid Netscape bug which prevents
720        * pages from being displayed if loading a referenced
721        * JavaScript or style sheet fails. So make it appear
722        * as if it succeeded.
723        */
724       if ( NULL != (p = get_header_value(csp->headers, "User-Agent:"))
725            && !strncmpic(p, "mozilla", 7) /* Catch Netscape but */
726            && !strstr(p, "Gecko")         /* save Mozilla, */
727            && !strstr(p, "compatible")    /* MSIE */
728            && !strstr(p, "Opera"))        /* and Opera. */
729       {
730          rsp->status = strdup("200 Request for blocked URL");
731       }
732       else
733       {
734          rsp->status = strdup("403 Request for blocked URL");
735       }
736
737       if (rsp->status == NULL)
738       {
739          free_http_response(rsp);
740          return cgi_error_memory();
741       }
742
743       exports = default_exports(csp, NULL);
744       if (exports == NULL)
745       {
746          free_http_response(rsp);
747          return cgi_error_memory();
748       }
749
750 #ifdef FEATURE_FORCE_LOAD
751       err = map(exports, "force-prefix", 1, FORCE_PREFIX, 1);
752       /*
753        * Export the force conditional block killer if
754        *
755        * - Privoxy was compiled without FEATURE_FORCE_LOAD, or
756        * - Privoxy is configured to enforce blocks, or
757        * - it's a CONNECT request and enforcing wouldn't work anyway.
758        */
759       if ((csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS)
760        || (0 == strcmpic(csp->http->gpc, "connect")))
761 #endif /* ndef FEATURE_FORCE_LOAD */
762       {
763          err = map_block_killer(exports, "force-support");
764       }
765
766       if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
767       if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
768       if (!err) err = map(exports, "path", 1, html_encode(csp->http->path), 0);
769       if (!err) err = map(exports, "path-ue", 1, url_encode(csp->http->path), 0);
770       if (!err)
771       {
772          const char *block_reason;
773          if (csp->action->string[ACTION_STRING_BLOCK] != NULL)
774          {
775             block_reason = csp->action->string[ACTION_STRING_BLOCK];
776          }
777          else
778          {
779             assert(connect_port_is_forbidden(csp));
780             block_reason = "Forbidden CONNECT port.";
781          }
782          err = map(exports, "block-reason", 1, html_encode(block_reason), 0);
783       }
784       if (err)
785       {
786          free_map(exports);
787          free_http_response(rsp);
788          return cgi_error_memory();
789       }
790
791       err = template_fill_for_cgi(csp, "blocked", exports, rsp);
792       if (err)
793       {
794          free_http_response(rsp);
795          return cgi_error_memory();
796       }
797    }
798    rsp->reason = RSP_REASON_BLOCKED;
799
800    return finish_http_response(csp, rsp);
801
802 }
803
804
805 #ifdef FEATURE_TRUST
806 /*********************************************************************
807  *
808  * Function    :  trust_url FIXME: I should be called distrust_url
809  *
810  * Description :  Calls is_untrusted_url to determine if the URL is trusted
811  *                and if not, returns a HTTP 403 response with a reject message.
812  *
813  * Parameters  :
814  *          1  :  csp = Current client state (buffers, headers, etc...)
815  *
816  * Returns     :  NULL => trusted, else http_response.
817  *
818  *********************************************************************/
819 struct http_response *trust_url(struct client_state *csp)
820 {
821    struct http_response *rsp;
822    struct map * exports;
823    char buf[BUFFER_SIZE];
824    char *p;
825    struct url_spec **tl;
826    struct url_spec *t;
827    jb_err err;
828
829    /*
830     * Don't bother to work on trusted URLs
831     */
832    if (!is_untrusted_url(csp))
833    {
834       return NULL;
835    }
836
837    /*
838     * Else, prepare a response:
839     */
840    if (NULL == (rsp = alloc_http_response()))
841    {
842       return cgi_error_memory();
843    }
844
845    rsp->status = strdup("403 Request blocked by Privoxy");
846    exports = default_exports(csp, NULL);
847    if (exports == NULL || rsp->status == NULL)
848    {
849       free_http_response(rsp);
850       return cgi_error_memory();
851    }
852
853    /*
854     * Export the protocol, host, port, and referrer information
855     */
856    err = map(exports, "hostport", 1, csp->http->hostport, 1);
857    if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1); 
858    if (!err) err = map(exports, "path", 1, csp->http->path, 1);
859
860    if (NULL != (p = get_header_value(csp->headers, "Referer:")))
861    {
862       if (!err) err = map(exports, "referrer", 1, html_encode(p), 0);
863    }
864    else
865    {
866       if (!err) err = map(exports, "referrer", 1, "none set", 1);
867    }
868
869    if (err)
870    {
871       free_map(exports);
872       free_http_response(rsp);
873       return cgi_error_memory();
874    }
875
876    /*
877     * Export the trust list
878     */
879    p = strdup("");
880    for (tl = csp->config->trust_list; (t = *tl) != NULL ; tl++)
881    {
882       snprintf(buf, sizeof(buf), "<li>%s</li>\n", t->spec);
883       string_append(&p, buf);
884    }
885    err = map(exports, "trusted-referrers", 1, p, 0);
886
887    if (err)
888    {
889       free_map(exports);
890       free_http_response(rsp);
891       return cgi_error_memory();
892    }
893
894    /*
895     * Export the trust info, if available
896     */
897    if (csp->config->trust_info->first)
898    {
899       struct list_entry *l;
900
901       p = strdup("");
902       for (l = csp->config->trust_info->first; l ; l = l->next)
903       {
904          snprintf(buf, sizeof(buf), "<li> <a href=\"%s\">%s</a><br>\n", l->str, l->str);
905          string_append(&p, buf);
906       }
907       err = map(exports, "trust-info", 1, p, 0);
908    }
909    else
910    {
911       err = map_block_killer(exports, "have-trust-info");
912    }
913
914    if (err)
915    {
916       free_map(exports);
917       free_http_response(rsp);
918       return cgi_error_memory();
919    }
920
921    /*
922     * Export the force conditional block killer if
923     *
924     * - Privoxy was compiled without FEATURE_FORCE_LOAD, or
925     * - Privoxy is configured to enforce blocks, or
926     * - it's a CONNECT request and enforcing wouldn't work anyway.
927     */
928 #ifdef FEATURE_FORCE_LOAD
929    if ((csp->config->feature_flags & RUNTIME_FEATURE_ENFORCE_BLOCKS)
930     || (0 == strcmpic(csp->http->gpc, "connect")))
931    {
932       err = map_block_killer(exports, "force-support");
933    }
934    else
935    {
936       err = map(exports, "force-prefix", 1, FORCE_PREFIX, 1);
937    }
938 #else /* ifndef FEATURE_FORCE_LOAD */
939    err = map_block_killer(exports, "force-support");
940 #endif /* ndef FEATURE_FORCE_LOAD */
941
942    if (err)
943    {
944       free_map(exports);
945       free_http_response(rsp);
946       return cgi_error_memory();
947    }
948
949    /*
950     * Build the response
951     */
952    err = template_fill_for_cgi(csp, "untrusted", exports, rsp);
953    if (err)
954    {
955       free_http_response(rsp);
956       return cgi_error_memory();
957    }
958    rsp->reason = RSP_REASON_UNTRUSTED;
959
960    return finish_http_response(csp, rsp);
961 }
962 #endif /* def FEATURE_TRUST */
963
964
965 /*********************************************************************
966  *
967  * Function    :  compile_dynamic_pcrs_job_list
968  *
969  * Description :  Compiles a dynamic pcrs job list (one with variables
970  *                resolved at request time)
971  *
972  * Parameters  :
973  *          1  :  csp = Current client state (buffers, headers, etc...)
974  *          2  :  b = The filter list to compile
975  *
976  * Returns     :  NULL in case of errors, otherwise the
977  *                pcrs job list.  
978  *
979  *********************************************************************/
980 pcrs_job *compile_dynamic_pcrs_job_list(const struct client_state *csp, const struct re_filterfile_spec *b)
981 {
982    struct list_entry *pattern;
983    pcrs_job *job_list = NULL;
984    pcrs_job *dummy = NULL;
985    pcrs_job *lastjob = NULL;
986    int error = 0;
987
988    const struct pcrs_variable variables[] =
989    {
990       {"url",    csp->http->url,   1},
991       {"path",   csp->http->path,  1},
992       {"host",   csp->http->host,  1},
993       {"origin", csp->ip_addr_str, 1},
994       {NULL,     NULL,             1}
995    };
996
997    for (pattern = b->patterns->first; pattern != NULL; pattern = pattern->next)
998    {
999       assert(pattern->str != NULL);
1000
1001       dummy = pcrs_compile_dynamic_command(pattern->str, variables, &error);
1002       if (NULL == dummy)
1003       {
1004          assert(error < 0);
1005          log_error(LOG_LEVEL_ERROR,
1006             "Adding filter job \'%s\' to dynamic filter %s failed: %s",
1007             pattern->str, b->name, pcrs_strerror(error));
1008          continue;
1009       }
1010       else
1011       {
1012          if (error == PCRS_WARN_TRUNCATION)
1013          {
1014             log_error(LOG_LEVEL_ERROR,
1015                "At least one of the variables in \'%s\' had to "
1016                "be truncated before compilation", pattern->str);
1017          }
1018          if (job_list == NULL)
1019          {
1020             job_list = dummy;
1021          }
1022          else
1023          {
1024             lastjob->next = dummy;
1025          }
1026          lastjob = dummy;
1027       }
1028    }
1029
1030    return job_list;
1031 }
1032
1033
1034 /*********************************************************************
1035  *
1036  * Function    :  rewrite_url
1037  *
1038  * Description :  Rewrites a URL with a single pcrs command
1039  *                and returns the result if it differs from the
1040  *                original and isn't obviously invalid.
1041  *
1042  * Parameters  :
1043  *          1  :  old_url = URL to rewrite.
1044  *          2  :  pcrs_command = pcrs command formatted as string (s@foo@bar@)
1045  *
1046  *
1047  * Returns     :  NULL if the pcrs_command didn't change the url, or 
1048  *                the result of the modification.
1049  *
1050  *********************************************************************/
1051 char *rewrite_url(char *old_url, const char *pcrs_command)
1052 {
1053    char *new_url = NULL;
1054    int hits;
1055
1056    assert(old_url);
1057    assert(pcrs_command);
1058
1059    new_url = pcrs_execute_single_command(old_url, pcrs_command, &hits);
1060
1061    if (hits == 0)
1062    {
1063       log_error(LOG_LEVEL_REDIRECTS,
1064          "pcrs command \"%s\" didn't change \"%s\".",
1065          pcrs_command, old_url);
1066       freez(new_url);
1067    }
1068    else if (hits < 0)
1069    {
1070       log_error(LOG_LEVEL_REDIRECTS,
1071          "executing pcrs command \"%s\" to rewrite %s failed: %s",
1072          pcrs_command, old_url, pcrs_strerror(hits));
1073       freez(new_url);
1074    }
1075    else if (strncmpic(new_url, "http://", 7) && strncmpic(new_url, "https://", 8))
1076    {
1077       log_error(LOG_LEVEL_ERROR,
1078          "pcrs command \"%s\" changed \"%s\" to \"%s\" (%u hi%s), "
1079          "but the result doesn't look like a valid URL and will be ignored.",
1080          pcrs_command, old_url, new_url, hits, (hits == 1) ? "t" : "ts");
1081       freez(new_url);
1082    }
1083    else
1084    {
1085       log_error(LOG_LEVEL_REDIRECTS,
1086          "pcrs command \"%s\" changed \"%s\" to \"%s\" (%u hi%s).",
1087          pcrs_command, old_url, new_url, hits, (hits == 1) ? "t" : "ts");
1088    }
1089
1090    return new_url;
1091
1092 }
1093
1094
1095 #ifdef FEATURE_FAST_REDIRECTS
1096 /*********************************************************************
1097  *
1098  * Function    :  get_last_url
1099  *
1100  * Description :  Search for the last URL inside a string.
1101  *                If the string already is a URL, it will
1102  *                be the first URL found.
1103  *
1104  * Parameters  :
1105  *          1  :  subject = the string to check
1106  *          2  :  redirect_mode = +fast-redirect{} mode 
1107  *
1108  * Returns     :  NULL if no URL was found, or
1109  *                the last URL found.
1110  *
1111  *********************************************************************/
1112 char *get_last_url(char *subject, const char *redirect_mode)
1113 {
1114    char *new_url = NULL;
1115    char *tmp;
1116
1117    assert(subject);
1118    assert(redirect_mode);
1119
1120    subject = strdup(subject);
1121    if (subject == NULL)
1122    {
1123       log_error(LOG_LEVEL_ERROR, "Out of memory while searching for redirects.");
1124       return NULL;
1125    }
1126
1127    if (0 == strcmpic(redirect_mode, "check-decoded-url"))
1128    {  
1129       log_error(LOG_LEVEL_REDIRECTS, "Decoding \"%s\" if necessary.", subject);
1130       new_url = url_decode(subject);
1131       if (new_url != NULL)
1132       {
1133          freez(subject);
1134          subject = new_url;
1135       }
1136       else
1137       {
1138          log_error(LOG_LEVEL_ERROR, "Unable to decode \"%s\".", subject);
1139       }
1140    }
1141
1142    log_error(LOG_LEVEL_REDIRECTS, "Checking \"%s\" for redirects.", subject);
1143
1144    /*
1145     * Find the last URL encoded in the request
1146     */
1147    tmp = subject;
1148    while ((tmp = strstr(tmp, "http://")) != NULL)
1149    {
1150       new_url = tmp++;
1151    }
1152    tmp = (new_url != NULL) ? new_url : subject;
1153    while ((tmp = strstr(tmp, "https://")) != NULL)
1154    {
1155       new_url = tmp++;
1156    }
1157
1158    if ((new_url != NULL)
1159       && (  (new_url != subject)
1160          || (0 == strncmpic(subject, "http://", 7))
1161          || (0 == strncmpic(subject, "https://", 8))
1162          ))
1163    {
1164       /*
1165        * Return new URL if we found a redirect 
1166        * or if the subject already was a URL.
1167        *
1168        * The second case makes sure that we can
1169        * chain get_last_url after another redirection check
1170        * (like rewrite_url) without losing earlier redirects.
1171        */
1172       new_url = strdup(new_url);
1173       freez(subject);
1174       return new_url;
1175    }
1176
1177    freez(subject);
1178    return NULL;
1179
1180 }
1181 #endif /* def FEATURE_FAST_REDIRECTS */
1182
1183
1184 /*********************************************************************
1185  *
1186  * Function    :  redirect_url
1187  *
1188  * Description :  Checks if Privoxy should answer the request with
1189  *                a HTTP redirect and generates the redirect if
1190  *                necessary.
1191  *
1192  * Parameters  :
1193  *          1  :  csp = Current client state (buffers, headers, etc...)
1194  *
1195  * Returns     :  NULL if the request can pass, HTTP redirect otherwise.
1196  *
1197  *********************************************************************/
1198 struct http_response *redirect_url(struct client_state *csp)
1199 {
1200    struct http_response *rsp;
1201 #ifdef FEATURE_FAST_REDIRECTS
1202    /*
1203     * XXX: Do we still need FEATURE_FAST_REDIRECTS
1204     * as compile-time option? The user can easily disable
1205     * it in his action file.
1206     */
1207    char * redirect_mode;
1208 #endif /* def FEATURE_FAST_REDIRECTS */
1209    char *old_url = NULL;
1210    char *new_url = NULL;
1211    char *redirection_string;
1212
1213    if ((csp->action->flags & ACTION_REDIRECT))
1214    {
1215       redirection_string = csp->action->string[ACTION_STRING_REDIRECT];
1216
1217       /*
1218        * If the redirection string begins with 's',
1219        * assume it's a pcrs command, otherwise treat it as
1220        * properly formatted URL and use it for the redirection
1221        * directly.
1222        *
1223        * According to RFC 2616 section 14.30 the URL
1224        * has to be absolute and if the user tries:
1225        * +redirect{shit/this/will/be/parsed/as/pcrs_command.html}
1226        * she would get undefined results anyway.
1227        *
1228        */
1229
1230       if (*redirection_string == 's')
1231       {
1232          old_url = csp->http->url;
1233          new_url = rewrite_url(old_url, redirection_string);
1234       }
1235       else
1236       {
1237          log_error(LOG_LEVEL_REDIRECTS,
1238             "No pcrs command recognized, assuming that \"%s\" is already properly formatted.",
1239             redirection_string);
1240          new_url = strdup(redirection_string);
1241       }
1242    }
1243
1244 #ifdef FEATURE_FAST_REDIRECTS
1245    if ((csp->action->flags & ACTION_FAST_REDIRECTS))
1246    {
1247       redirect_mode = csp->action->string[ACTION_STRING_FAST_REDIRECTS];
1248
1249       /*
1250        * If it exists, use the previously rewritten URL as input
1251        * otherwise just use the old path.
1252        */
1253       old_url = (new_url != NULL) ? new_url : strdup(csp->http->path);
1254       new_url = get_last_url(old_url, redirect_mode);
1255       freez(old_url);
1256    }
1257
1258    /*
1259     * Disable redirect checkers, so that they
1260     * will be only run more than once if the user
1261     * also enables them through tags.
1262     *
1263     * From a performance point of view
1264     * it doesn't matter, but the duplicated
1265     * log messages are annoying.
1266     */
1267    csp->action->flags &= ~ACTION_FAST_REDIRECTS;
1268 #endif /* def FEATURE_FAST_REDIRECTS */
1269    csp->action->flags &= ~ACTION_REDIRECT;
1270
1271    /* Did any redirect action trigger? */   
1272    if (new_url)
1273    {
1274       if (0 == strcmpic(new_url, csp->http->url))
1275       {
1276          log_error(LOG_LEVEL_ERROR,
1277             "New URL \"%s\" and old URL \"%s\" are the same. Redirection loop prevented.",
1278             csp->http->url, new_url);
1279             freez(new_url);
1280       }
1281       else
1282       {
1283          log_error(LOG_LEVEL_REDIRECTS, "New URL is: %s", new_url);
1284
1285          if (NULL == (rsp = alloc_http_response()))
1286          {
1287             freez(new_url);
1288             return cgi_error_memory();
1289          }
1290
1291          if ( enlist_unique_header(rsp->headers, "Location", new_url)
1292            || (NULL == (rsp->status = strdup("302 Local Redirect from Privoxy"))) )
1293          {
1294             freez(new_url);
1295             free_http_response(rsp);
1296             return cgi_error_memory();
1297          }
1298          rsp->reason = RSP_REASON_REDIRECTED;
1299          freez(new_url);
1300
1301          return finish_http_response(csp, rsp);
1302       }
1303    }
1304
1305    /* Only reached if no redirect is required */
1306    return NULL;
1307
1308 }
1309
1310
1311 #ifdef FEATURE_IMAGE_BLOCKING
1312 /*********************************************************************
1313  *
1314  * Function    :  is_imageurl
1315  *
1316  * Description :  Given a URL, decide whether it is an image or not,
1317  *                using either the info from a previous +image action
1318  *                or, #ifdef FEATURE_IMAGE_DETECT_MSIE, and the browser
1319  *                is MSIE and not on a Mac, tell from the browser's accept
1320  *                header.
1321  *
1322  * Parameters  :
1323  *          1  :  csp = Current client state (buffers, headers, etc...)
1324  *
1325  * Returns     :  True (nonzero) if URL is an image, false (0)
1326  *                otherwise
1327  *
1328  *********************************************************************/
1329 int is_imageurl(const struct client_state *csp)
1330 {
1331 #ifdef FEATURE_IMAGE_DETECT_MSIE
1332    char *tmp;
1333
1334    tmp = get_header_value(csp->headers, "User-Agent:");
1335    if (tmp && strstr(tmp, "MSIE") && !strstr(tmp, "Mac_"))
1336    {
1337       tmp = get_header_value(csp->headers, "Accept:");
1338       if (tmp && strstr(tmp, "image/gif"))
1339       {
1340          /* Client will accept HTML.  If this seems counterintuitive,
1341           * blame Microsoft.
1342           */
1343          return(0);
1344       }
1345       else
1346       {
1347          return(1);
1348       }
1349    }
1350 #endif /* def FEATURE_IMAGE_DETECT_MSIE */
1351
1352    return ((csp->action->flags & ACTION_IMAGE) != 0);
1353
1354 }
1355 #endif /* def FEATURE_IMAGE_BLOCKING */
1356
1357
1358 #ifdef FEATURE_TRUST
1359 /*********************************************************************
1360  *
1361  * Function    :  is_untrusted_url
1362  *
1363  * Description :  Should we "distrust" this URL (and block it)?
1364  *
1365  *                Yes if it matches a line in the trustfile, or if the
1366  *                    referrer matches a line starting with "+" in the
1367  *                    trustfile.
1368  *                No  otherwise.
1369  *
1370  * Parameters  :
1371  *          1  :  csp = Current client state (buffers, headers, etc...)
1372  *
1373  * Returns     :  0 => trusted, 1 => untrusted
1374  *
1375  *********************************************************************/
1376 int is_untrusted_url(const struct client_state *csp)
1377 {
1378    struct file_list *fl;
1379    struct block_spec *b;
1380    struct url_spec **trusted_url;
1381    struct http_request rhttp[1];
1382    const char * referer;
1383    jb_err err;
1384
1385    /*
1386     * If we don't have a trustlist, we trust everybody
1387     */
1388    if (((fl = csp->tlist) == NULL) || ((b  = fl->f) == NULL))
1389    {
1390       return 0;
1391    }
1392
1393    memset(rhttp, '\0', sizeof(*rhttp));
1394
1395    /*
1396     * Do we trust the request URL itself?
1397     */
1398    for (b = b->next; b ; b = b->next)
1399    {
1400       if (url_match(b->url, csp->http))
1401       {
1402          return b->reject;
1403       }
1404    }
1405
1406    if (NULL == (referer = get_header_value(csp->headers, "Referer:")))
1407    {
1408       /* no referrer was supplied */
1409       return 1;
1410    }
1411
1412
1413    /*
1414     * If not, do we maybe trust its referrer?
1415     */
1416    err = parse_http_url(referer, rhttp, REQUIRE_PROTOCOL);
1417    if (err)
1418    {
1419       return 1;
1420    }
1421
1422    for (trusted_url = csp->config->trust_list; *trusted_url != NULL; trusted_url++)
1423    {
1424       if (url_match(*trusted_url, rhttp))
1425       {
1426          /* if the URL's referrer is from a trusted referrer, then
1427           * add the target spec to the trustfile as an unblocked
1428           * domain and return 0 (which means it's OK).
1429           */
1430
1431          FILE *fp;
1432
1433          if (NULL != (fp = fopen(csp->config->trustfile, "a")))
1434          {
1435             char * path;
1436             char * path_end;
1437             char * new_entry = strdup("~");
1438
1439             string_append(&new_entry, csp->http->hostport);
1440
1441             path = csp->http->path;
1442             if ( (path[0] == '/')
1443               && (path[1] == '~')
1444               && ((path_end = strchr(path + 2, '/')) != NULL))
1445             {
1446                /* since this path points into a user's home space
1447                 * be sure to include this spec in the trustfile.
1448                 */
1449                long path_len = path_end - path; /* save offset */
1450                path = strdup(path); /* Copy string */
1451                if (path != NULL)
1452                {
1453                   path_end = path + path_len; /* regenerate ptr to new buffer */
1454                   *(path_end + 1) = '\0'; /* Truncate path after '/' */
1455                }
1456                string_join(&new_entry, path);
1457             }
1458
1459             /*
1460              * Give a reason for generating this entry.
1461              */
1462             string_append(&new_entry, " # Trusted referrer was: ");
1463             string_append(&new_entry, referer);
1464
1465             if (new_entry != NULL)
1466             {
1467                if (-1 == fprintf(fp, "%s\n", new_entry))
1468                {
1469                   log_error(LOG_LEVEL_ERROR, "Failed to append \'%s\' to trustfile \'%s\': %E",
1470                      new_entry, csp->config->trustfile);
1471                }
1472                freez(new_entry);
1473             }
1474             else
1475             {
1476                /* FIXME: No way to handle out-of memory, so mostly ignoring it */
1477                log_error(LOG_LEVEL_ERROR, "Out of memory adding pattern to trust file");
1478             }
1479
1480             fclose(fp);
1481          }
1482          else
1483          {
1484             log_error(LOG_LEVEL_ERROR, "Failed to append new entry for \'%s\' to trustfile \'%s\': %E",
1485                csp->http->hostport, csp->config->trustfile);
1486          }
1487          return 0;
1488       }
1489    }
1490
1491    return 1;
1492 }
1493 #endif /* def FEATURE_TRUST */
1494
1495
1496 /*********************************************************************
1497  *
1498  * Function    :  pcrs_filter_response
1499  *
1500  * Description :  Execute all text substitutions from all applying
1501  *                +filter actions on the text buffer that's been
1502  *                accumulated in csp->iob->buf.
1503  *
1504  * Parameters  :
1505  *          1  :  csp = Current client state (buffers, headers, etc...)
1506  *
1507  * Returns     :  a pointer to the (newly allocated) modified buffer.
1508  *                or NULL if there were no hits or something went wrong
1509  *
1510  *********************************************************************/
1511 static char *pcrs_filter_response(struct client_state *csp)
1512 {
1513    int hits=0;
1514    size_t size, prev_size;
1515
1516    char *old = NULL;
1517    char *new = NULL;
1518    pcrs_job *job;
1519
1520    struct file_list *fl;
1521    struct re_filterfile_spec *b;
1522    struct list_entry *filtername;
1523
1524    int i, found_filters = 0;
1525
1526    /* 
1527     * Sanity first
1528     */
1529    if (csp->iob->cur >= csp->iob->eod)
1530    {
1531       return(NULL);
1532    }
1533
1534    /*
1535     * Need to check the set of re_filterfiles...
1536     */
1537    for (i = 0; i < MAX_AF_FILES; i++)
1538    {
1539       fl = csp->rlist[i];
1540       if (NULL != fl)
1541       {
1542          if (NULL != fl->f)
1543          {
1544            found_filters = 1;
1545            break;
1546          }
1547       }
1548    }
1549
1550    if (0 == found_filters)
1551    {
1552       log_error(LOG_LEVEL_ERROR, "Inconsistent configuration: "
1553          "content filtering enabled, but no content filters available.");
1554       return(NULL);
1555    }
1556
1557    size = (size_t)(csp->iob->eod - csp->iob->cur);
1558    old = csp->iob->cur;
1559
1560    for (i = 0; i < MAX_AF_FILES; i++)
1561    {
1562      fl = csp->rlist[i];
1563      if ((NULL == fl) || (NULL == fl->f))
1564      {
1565         /*
1566          * Either there are no filter files
1567          * left, or this filter file just
1568          * contains no valid filters.
1569          *
1570          * Continue to be sure we don't miss
1571          * valid filter files that are chained
1572          * after empty or invalid ones.
1573          */
1574         continue;
1575      }
1576    /*
1577     * For all applying +filter actions, look if a filter by that
1578     * name exists and if yes, execute it's pcrs_joblist on the
1579     * buffer.
1580     */
1581    for (b = fl->f; b; b = b->next)
1582    {
1583       if (b->type != FT_CONTENT_FILTER)
1584       {
1585          /* Skip header filters */
1586          continue;
1587       }
1588
1589       for (filtername = csp->action->multi[ACTION_MULTI_FILTER]->first;
1590            filtername ; filtername = filtername->next)
1591       {
1592          if (strcmp(b->name, filtername->str) == 0)
1593          {
1594             int current_hits = 0; /* Number of hits caused by this filter */
1595             int job_number   = 0; /* Which job we're currently executing  */
1596             int job_hits     = 0; /* How many hits the current job caused */
1597             pcrs_job *joblist = b->joblist;
1598
1599             if (b->dynamic) joblist = compile_dynamic_pcrs_job_list(csp, b);
1600
1601             if (NULL == joblist)
1602             {
1603                log_error(LOG_LEVEL_RE_FILTER, "Filter %s has empty joblist. Nothing to do.", b->name);
1604                continue;
1605             }
1606
1607             prev_size = size;
1608             /* Apply all jobs from the joblist */
1609             for (job = joblist; NULL != job; job = job->next)
1610             {
1611                job_number++;
1612                job_hits = pcrs_execute(job, old, size, &new, &size);
1613
1614                if (job_hits >= 0)
1615                {
1616                   /*
1617                    * That went well. Continue filtering
1618                    * and use the result of this job as
1619                    * input for the next one.
1620                    */
1621                   current_hits += job_hits;
1622                   if (old != csp->iob->cur)
1623                   {
1624                      freez(old);
1625                   }
1626                   old = new;
1627                }
1628                else
1629                {
1630                   /*
1631                    * This job caused an unexpected error. Inform the user
1632                    * and skip the rest of the jobs in this filter. We could
1633                    * continue with the next job, but usually the jobs
1634                    * depend on each other or are similar enough to
1635                    * fail for the same reason.
1636                    *
1637                    * At the moment our pcrs expects the error codes of pcre 3.4,
1638                    * but newer pcre versions can return additional error codes.
1639                    * As a result pcrs_strerror()'s error message might be
1640                    * "Unknown error ...", therefore we print the numerical value
1641                    * as well.
1642                    *
1643                    * XXX: Is this important enough for LOG_LEVEL_ERROR or
1644                    * should we use LOG_LEVEL_RE_FILTER instead?
1645                    */
1646                   log_error(LOG_LEVEL_ERROR, "Skipped filter \'%s\' after job number %u: %s (%d)",
1647                      b->name, job_number, pcrs_strerror(job_hits), job_hits);
1648                   break;
1649                }
1650             }
1651
1652             if (b->dynamic) pcrs_free_joblist(joblist);
1653
1654             log_error(LOG_LEVEL_RE_FILTER,
1655                "filtering %s%s (size %d) with \'%s\' produced %d hits (new size %d).",
1656                csp->http->hostport, csp->http->path, prev_size, b->name, current_hits, size);
1657
1658             hits += current_hits;
1659          }
1660       }
1661    }
1662    }
1663
1664    /*
1665     * If there were no hits, destroy our copy and let
1666     * chat() use the original in csp->iob
1667     */
1668    if (!hits)
1669    {
1670       freez(new);
1671       return(NULL);
1672    }
1673
1674    csp->flags |= CSP_FLAG_MODIFIED;
1675    csp->content_length = size;
1676    IOB_RESET(csp);
1677
1678    return(new);
1679
1680 }
1681
1682
1683 /*********************************************************************
1684  *
1685  * Function    :  gif_deanimate_response
1686  *
1687  * Description :  Deanimate the GIF image that has been accumulated in
1688  *                csp->iob->buf, set csp->content_length to the modified
1689  *                size and raise the CSP_FLAG_MODIFIED flag.
1690  *
1691  * Parameters  :
1692  *          1  :  csp = Current client state (buffers, headers, etc...)
1693  *
1694  * Returns     :  a pointer to the (newly allocated) modified buffer.
1695  *                or NULL in case something went wrong.
1696  *
1697  *********************************************************************/
1698 static char *gif_deanimate_response(struct client_state *csp)
1699 {
1700    struct binbuffer *in, *out;
1701    char *p;
1702    size_t size;
1703
1704    size = (size_t)(csp->iob->eod - csp->iob->cur);
1705
1706    if (  (NULL == (in =  (struct binbuffer *)zalloc(sizeof *in )))
1707       || (NULL == (out = (struct binbuffer *)zalloc(sizeof *out))) )
1708    {
1709       log_error(LOG_LEVEL_DEANIMATE, "failed! (no mem)");
1710       return NULL;
1711    }
1712
1713    in->buffer = csp->iob->cur;
1714    in->size = size;
1715
1716    if (gif_deanimate(in, out, strncmp("last", csp->action->string[ACTION_STRING_DEANIMATE], 4)))
1717    {
1718       log_error(LOG_LEVEL_DEANIMATE, "failed! (gif parsing)");
1719       freez(in);
1720       buf_free(out);
1721       return(NULL);
1722    }
1723    else
1724    {
1725       if ((int)size == out->offset)
1726       {
1727          log_error(LOG_LEVEL_DEANIMATE, "GIF not changed.");
1728       }
1729       else
1730       {
1731          log_error(LOG_LEVEL_DEANIMATE, "Success! GIF shrunk from %d bytes to %d.", size, out->offset);
1732       }
1733       csp->content_length = out->offset;
1734       csp->flags |= CSP_FLAG_MODIFIED;
1735       p = out->buffer;
1736       freez(in);
1737       freez(out);
1738       return(p);
1739    }
1740
1741 }
1742
1743
1744 /*********************************************************************
1745  *
1746  * Function    :  get_filter_function
1747  *
1748  * Description :  Decides which content filter function has
1749  *                to be applied (if any).
1750  *
1751  * Parameters  :
1752  *          1  :  csp = Current client state (buffers, headers, etc...)
1753  *
1754  * Returns     :  The content filter function to run, or
1755  *                NULL if no content filter is active
1756  *
1757  *********************************************************************/
1758 filter_function_ptr get_filter_function(struct client_state *csp)
1759 {
1760    filter_function_ptr filter_function = NULL;
1761
1762    if ((csp->content_type & CT_TABOO)
1763       && !(csp->action->flags & ACTION_FORCE_TEXT_MODE))
1764    {
1765       return NULL;
1766    }
1767
1768    /*
1769     * Are we enabling text mode by force?
1770     */
1771    if (csp->action->flags & ACTION_FORCE_TEXT_MODE)
1772    {
1773       /*
1774        * Do we really have to?
1775        */
1776       if (csp->content_type & CT_TEXT)
1777       {
1778          log_error(LOG_LEVEL_HEADER, "Text mode is already enabled.");   
1779       }
1780       else
1781       {
1782          csp->content_type |= CT_TEXT;
1783          log_error(LOG_LEVEL_HEADER, "Text mode enabled by force. Take cover!");   
1784       }
1785    }
1786
1787    if (!(csp->content_type & CT_DECLARED))
1788    {
1789       /*
1790        * The server didn't bother to declare a MIME-Type.
1791        * Assume it's text that can be filtered.
1792        *
1793        * This also regulary happens with 304 responses,
1794        * therefore logging anything here would cause
1795        * too much noise.
1796        */
1797       csp->content_type |= CT_TEXT;
1798    }
1799
1800    /*
1801     * Choose the applying filter function based on
1802     * the content type and action settings.
1803     */
1804    if ((csp->content_type & CT_TEXT) &&
1805        (csp->rlist != NULL) &&
1806        (!list_is_empty(csp->action->multi[ACTION_MULTI_FILTER])))
1807    {
1808       filter_function = pcrs_filter_response;
1809    }
1810    else if ((csp->content_type & CT_GIF)  &&
1811             (csp->action->flags & ACTION_DEANIMATE))
1812    {
1813       filter_function = gif_deanimate_response;
1814    }
1815
1816    return filter_function;
1817 }
1818
1819
1820 /*********************************************************************
1821  *
1822  * Function    :  remove_chunked_transfer_coding
1823  *
1824  * Description :  In-situ remove the "chunked" transfer coding as defined
1825  *                in rfc2616 from a buffer.
1826  *
1827  * Parameters  :
1828  *          1  :  buffer = Pointer to the text buffer
1829  *          2  :  size =  In: Number of bytes to be processed,
1830  *                       Out: Number of bytes after de-chunking.
1831  *                       (undefined in case of errors)
1832  *
1833  * Returns     :  JB_ERR_OK for success,
1834  *                JB_ERR_PARSE otherwise
1835  *
1836  *********************************************************************/
1837 static jb_err remove_chunked_transfer_coding(char *buffer, size_t *size)
1838 {
1839    size_t newsize = 0;
1840    unsigned int chunksize = 0;
1841    char *from_p, *to_p;
1842
1843    assert(buffer);
1844    from_p = to_p = buffer;
1845
1846    if (sscanf(buffer, "%x", &chunksize) != 1)
1847    {
1848       log_error(LOG_LEVEL_ERROR, "Invalid first chunksize while stripping \"chunked\" transfer coding");
1849       return JB_ERR_PARSE;
1850    }
1851
1852    while (chunksize > 0U)
1853    {
1854       if (NULL == (from_p = strstr(from_p, "\r\n")))
1855       {
1856          log_error(LOG_LEVEL_ERROR, "Parse error while stripping \"chunked\" transfer coding");
1857          return JB_ERR_PARSE;
1858       }
1859
1860       if ((newsize += chunksize) >= *size)
1861       {
1862          log_error(LOG_LEVEL_ERROR,
1863             "Chunk size %d exceeds buffer size %d in  \"chunked\" transfer coding",
1864             chunksize, *size);
1865          return JB_ERR_PARSE;
1866       }
1867       from_p += 2;
1868
1869       memmove(to_p, from_p, (size_t) chunksize);
1870       to_p = buffer + newsize;
1871       from_p += chunksize + 2;
1872
1873       if (sscanf(from_p, "%x", &chunksize) != 1)
1874       {
1875          log_error(LOG_LEVEL_INFO, "Invalid \"chunked\" transfer encoding detected and ignored.");
1876          break;
1877       }
1878    }
1879    
1880    /* XXX: Should get its own loglevel. */
1881    log_error(LOG_LEVEL_RE_FILTER, "De-chunking successful. Shrunk from %d to %d", *size, newsize);
1882
1883    *size = newsize;
1884
1885    return JB_ERR_OK;
1886
1887 }
1888
1889
1890 /*********************************************************************
1891  *
1892  * Function    :  prepare_for_filtering
1893  *
1894  * Description :  If necessary, de-chunks and decompresses
1895  *                the content so it can get filterd.
1896  *
1897  * Parameters  :
1898  *          1  :  csp = Current client state (buffers, headers, etc...)
1899  *
1900  * Returns     :  JB_ERR_OK for success,
1901  *                JB_ERR_PARSE otherwise
1902  *
1903  *********************************************************************/
1904 static jb_err prepare_for_filtering(struct client_state *csp)
1905 {
1906    jb_err err = JB_ERR_OK;
1907
1908    /*
1909     * If the body has a "chunked" transfer-encoding,
1910     * get rid of it, adjusting size and iob->eod
1911     */
1912    if (csp->flags & CSP_FLAG_CHUNKED)
1913    {
1914       size_t size = (size_t)(csp->iob->eod - csp->iob->cur);
1915
1916       log_error(LOG_LEVEL_RE_FILTER, "Need to de-chunk first");
1917       err = remove_chunked_transfer_coding(csp->iob->cur, &size);
1918       if (JB_ERR_OK == err)
1919       {
1920          csp->iob->eod = csp->iob->cur + size;
1921          csp->flags |= CSP_FLAG_MODIFIED;
1922       }
1923       else
1924       {
1925          return JB_ERR_PARSE;
1926       }
1927    }
1928
1929 #ifdef FEATURE_ZLIB
1930    /*
1931     * If the body has a supported transfer-encoding,
1932     * decompress it, adjusting size and iob->eod.
1933     */
1934    if (csp->content_type & (CT_GZIP|CT_DEFLATE))
1935    {
1936       if (0 == csp->iob->eod - csp->iob->cur)
1937       {
1938          /* Nothing left after de-chunking. */
1939          return JB_ERR_OK;
1940       }
1941
1942       err = decompress_iob(csp);
1943
1944       if (JB_ERR_OK == err)
1945       {
1946          csp->flags |= CSP_FLAG_MODIFIED;
1947          csp->content_type &= ~CT_TABOO;
1948       }
1949       else
1950       {
1951          /*
1952           * Unset CT_GZIP and CT_DEFLATE to remember not
1953           * to modify the Content-Encoding header later.
1954           */
1955          csp->content_type &= ~CT_GZIP;
1956          csp->content_type &= ~CT_DEFLATE;
1957       }
1958    }
1959 #endif
1960
1961    return err;
1962 }
1963
1964
1965 /*********************************************************************
1966  *
1967  * Function    :  execute_content_filter
1968  *
1969  * Description :  Executes a given content filter.
1970  *
1971  * Parameters  :
1972  *          1  :  csp = Current client state (buffers, headers, etc...)
1973  *          2  :  content_filter = The filter function to execute
1974  *
1975  * Returns     :  Pointer to the modified buffer, or
1976  *                NULL if filtering failed or wasn't necessary.
1977  *
1978  *********************************************************************/
1979 char *execute_content_filter(struct client_state *csp, filter_function_ptr content_filter)
1980 {
1981    if (0 == csp->iob->eod - csp->iob->cur)
1982    {
1983       /*
1984        * No content (probably status code 301, 302 ...),
1985        * no filtering necessary.
1986        */
1987       return NULL;
1988    }
1989
1990    if (JB_ERR_OK != prepare_for_filtering(csp))
1991    {
1992       /*
1993        * failed to de-chunk or decompress.
1994        */
1995       return NULL;
1996    }
1997
1998    if (0 == csp->iob->eod - csp->iob->cur)
1999    {
2000       /*
2001        * Clown alarm: chunked and/or compressed nothing delivered.
2002        */
2003       return NULL;
2004    }
2005
2006    return ((*content_filter)(csp));
2007 }
2008
2009
2010 /*********************************************************************
2011  *
2012  * Function    :  get_url_actions
2013  *
2014  * Description :  Gets the actions for this URL.
2015  *
2016  * Parameters  :
2017  *          1  :  csp = Current client state (buffers, headers, etc...)
2018  *          2  :  http = http_request request for blocked URLs
2019  *
2020  * Returns     :  N/A
2021  *
2022  *********************************************************************/
2023 void get_url_actions(struct client_state *csp, struct http_request *http)
2024 {
2025    struct file_list *fl;
2026    struct url_actions *b;
2027    int i;
2028
2029    init_current_action(csp->action);
2030
2031    for (i = 0; i < MAX_AF_FILES; i++)
2032    {
2033       if (((fl = csp->actions_list[i]) == NULL) || ((b = fl->f) == NULL))
2034       {
2035          return;
2036       }
2037
2038       apply_url_actions(csp->action, http, b);
2039    }
2040
2041    return;
2042 }
2043
2044
2045 /*********************************************************************
2046  *
2047  * Function    :  apply_url_actions
2048  *
2049  * Description :  Applies a list of URL actions.
2050  *
2051  * Parameters  :
2052  *          1  :  action = Destination.
2053  *          2  :  http = Current URL
2054  *          3  :  b = list of URL actions to apply
2055  *
2056  * Returns     :  N/A
2057  *
2058  *********************************************************************/
2059 void apply_url_actions(struct current_action_spec *action,
2060                        struct http_request *http,
2061                        struct url_actions *b)
2062 {
2063    if (b == NULL)
2064    {
2065       /* Should never happen */
2066       return;
2067    }
2068
2069    for (b = b->next; NULL != b; b = b->next)
2070    {
2071       if (url_match(b->url, http))
2072       {
2073          merge_current_action(action, b->action);
2074       }
2075    }
2076 }
2077
2078
2079 /*********************************************************************
2080  *
2081  * Function    :  get_forward_override_settings
2082  *
2083  * Description :  Returns forward settings as specified with the
2084  *                forward-override{} action. forward-override accepts
2085  *                forward lines similar to the one used in the
2086  *                configuration file, but without the URL pattern.
2087  *
2088  *                For example:
2089  *
2090  *                   forward / .
2091  *
2092  *                in the configuration file can be replaced with
2093  *                the action section:
2094  *
2095  *                 {+forward-override{forward .}}
2096  *                 /
2097  *
2098  * Parameters  :
2099  *          1  :  csp = Current client state (buffers, headers, etc...)
2100  *
2101  * Returns     :  Pointer to forwarding structure in case of success.
2102  *                Invalid syntax is fatal.
2103  *
2104  *********************************************************************/
2105 const static struct forward_spec *get_forward_override_settings(struct client_state *csp)
2106 {
2107    const char *forward_override_line = csp->action->string[ACTION_STRING_FORWARD_OVERRIDE];
2108    char forward_settings[BUFFER_SIZE];
2109    char *http_parent = NULL;
2110    /* variable names were chosen for consistency reasons. */
2111    struct forward_spec *fwd = NULL;
2112    int vec_count;
2113    char *vec[3];
2114
2115    assert(csp->action->flags & ACTION_FORWARD_OVERRIDE);
2116    /* Should be enforced by load_one_actions_file() */
2117    assert(strlen(forward_override_line) < sizeof(forward_settings) - 1);
2118
2119    /* Create a copy ssplit can modify */
2120    strlcpy(forward_settings, forward_override_line, sizeof(forward_settings));
2121
2122    if (NULL != csp->fwd)
2123    {
2124       /*
2125        * XXX: Currently necessary to prevent memory
2126        * leaks when the show-url-info cgi page is visited.
2127        */
2128       unload_forward_spec(csp->fwd);
2129    }
2130
2131    /*
2132     * allocate a new forward node, valid only for
2133     * the lifetime of this request. Save its location
2134     * in csp as well, so sweep() can free it later on.
2135     */
2136    fwd = csp->fwd = zalloc(sizeof(*fwd));
2137    if (NULL == fwd)
2138    {
2139       log_error(LOG_LEVEL_FATAL,
2140          "can't allocate memory for forward-override{%s}", forward_override_line);
2141       /* Never get here - LOG_LEVEL_FATAL causes program exit */
2142       return NULL;
2143    }
2144
2145    vec_count = ssplit(forward_settings, " \t", vec, SZ(vec), 1, 1);
2146    if ((vec_count == 2) && !strcasecmp(vec[0], "forward"))
2147    {
2148       fwd->type = SOCKS_NONE;
2149
2150       /* Parse the parent HTTP proxy host:port */
2151       http_parent = vec[1];
2152
2153    }
2154    else if (vec_count == 3)
2155    {
2156       char *socks_proxy = NULL;
2157
2158       if  (!strcasecmp(vec[0], "forward-socks4"))
2159       {
2160          fwd->type = SOCKS_4;
2161          socks_proxy = vec[1];
2162       }
2163       else if (!strcasecmp(vec[0], "forward-socks4a"))
2164       {
2165          fwd->type = SOCKS_4A;
2166          socks_proxy = vec[1];
2167       }
2168       else if (!strcasecmp(vec[0], "forward-socks5"))
2169       {
2170          fwd->type = SOCKS_5;
2171          socks_proxy = vec[1];
2172       }
2173
2174       if (NULL != socks_proxy)
2175       {
2176          /* Parse the SOCKS proxy host[:port] */
2177          fwd->gateway_port = 1080;
2178          parse_forwarder_address(socks_proxy,
2179             &fwd->gateway_host, &fwd->gateway_port);
2180
2181          http_parent = vec[2];
2182       }
2183    }
2184
2185    if (NULL == http_parent)
2186    {
2187       log_error(LOG_LEVEL_FATAL,
2188          "Invalid forward-override syntax in: %s", forward_override_line);
2189       /* Never get here - LOG_LEVEL_FATAL causes program exit */
2190    }
2191
2192    /* Parse http forwarding settings */
2193    if (strcmp(http_parent, ".") != 0)
2194    {
2195       fwd->forward_port = 8000;
2196       parse_forwarder_address(http_parent,
2197          &fwd->forward_host, &fwd->forward_port);
2198    }
2199
2200    assert (NULL != fwd);
2201
2202    log_error(LOG_LEVEL_CONNECT,
2203       "Overriding forwarding settings based on \'%s\'", forward_override_line);
2204
2205    return fwd;
2206 }
2207
2208
2209 /*********************************************************************
2210  *
2211  * Function    :  forward_url
2212  *
2213  * Description :  Should we forward this to another proxy?
2214  *
2215  * Parameters  :
2216  *          1  :  csp = Current client state (buffers, headers, etc...)
2217  *          2  :  http = http_request request for current URL
2218  *
2219  * Returns     :  Pointer to forwarding information.
2220  *
2221  *********************************************************************/
2222 const struct forward_spec *forward_url(struct client_state *csp,
2223                                        const struct http_request *http)
2224 {
2225    static const struct forward_spec fwd_default[1] = { FORWARD_SPEC_INITIALIZER };
2226    struct forward_spec *fwd = csp->config->forward;
2227
2228    if (csp->action->flags & ACTION_FORWARD_OVERRIDE)
2229    {
2230       return get_forward_override_settings(csp);
2231    }
2232
2233    if (fwd == NULL)
2234    {
2235       return fwd_default;
2236    }
2237
2238    while (fwd != NULL)
2239    {
2240       if (url_match(fwd->url, http))
2241       {
2242          return fwd;
2243       }
2244       fwd = fwd->next;
2245    }
2246
2247    return fwd_default;
2248 }
2249
2250
2251 /*********************************************************************
2252  *
2253  * Function    :  direct_response 
2254  *
2255  * Description :  Check if Max-Forwards == 0 for an OPTIONS or TRACE
2256  *                request and if so, return a HTTP 501 to the client.
2257  *
2258  *                FIXME: I have a stupid name and I should handle the
2259  *                requests properly. Still, what we do here is rfc-
2260  *                compliant, whereas ignoring or forwarding are not.
2261  *
2262  * Parameters  :  
2263  *          1  :  csp = Current client state (buffers, headers, etc...)
2264  *
2265  * Returns     :  http_response if , NULL if nonmatch or handler fail
2266  *
2267  *********************************************************************/
2268 struct http_response *direct_response(struct client_state *csp)
2269 {
2270    struct http_response *rsp;
2271    struct list_entry *p;
2272
2273    if ((0 == strcmpic(csp->http->gpc, "trace"))
2274       || (0 == strcmpic(csp->http->gpc, "options")))
2275    {
2276       for (p = csp->headers->first; (p != NULL) ; p = p->next)
2277       {
2278          if (!strncmpic("Max-Forwards:", p->str, 13))
2279          {
2280             unsigned int max_forwards;
2281
2282             /*
2283              * If it's a Max-Forwards value of zero,
2284              * we have to intercept the request.
2285              */
2286             if (1 == sscanf(p->str+12, ": %u", &max_forwards) && max_forwards == 0)
2287             {
2288                /*
2289                 * FIXME: We could handle at least TRACE here,
2290                 * but that would require a verbatim copy of
2291                 * the request which we don't have anymore
2292                 */
2293                 log_error(LOG_LEVEL_HEADER,
2294                   "Detected header \'%s\' in OPTIONS or TRACE request. Returning 501.",
2295                   p->str);
2296
2297                /* Get mem for response or fail*/
2298                if (NULL == (rsp = alloc_http_response()))
2299                {
2300                   return cgi_error_memory();
2301                }
2302             
2303                if (NULL == (rsp->status = strdup("501 Not Implemented")))
2304                {
2305                   free_http_response(rsp);
2306                   return cgi_error_memory();
2307                }
2308
2309                rsp->is_static = 1;
2310                rsp->reason = RSP_REASON_UNSUPPORTED;
2311
2312                return(finish_http_response(csp, rsp));
2313             }
2314          }
2315       }
2316    }
2317    return NULL;
2318 }
2319
2320
2321 /*********************************************************************
2322  *
2323  * Function    :  content_filters_enabled
2324  *
2325  * Description :  Checks whether there are any content filters
2326  *                enabled for the current request.
2327  *
2328  * Parameters  :  
2329  *          1  :  action = Action spec to check.
2330  *
2331  * Returns     :  TRUE for yes, FALSE otherwise
2332  *
2333  *********************************************************************/
2334 int content_filters_enabled(const struct current_action_spec *action)
2335 {
2336    return ((action->flags & ACTION_DEANIMATE) ||
2337       !list_is_empty(action->multi[ACTION_MULTI_FILTER]));
2338 }
2339
2340 /*
2341   Local Variables:
2342   tab-width: 3
2343   end:
2344 */