filters.c

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