filters.c

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