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 (requested_url != csp->http->url)
1250          {
1251             assert(client_use_ssl(csp));
1252             freez(requested_url);
1253          }
1254 #endif
1255       }
1256       else
1257       {
1258          log_error(LOG_LEVEL_REDIRECTS,
1259             "No pcrs command recognized, assuming that \"%s\" is already properly formatted.",
1260             redirection_string);
1261          new_url = strdup(redirection_string);
1262       }
1263    }
1264
1265 #ifdef FEATURE_FAST_REDIRECTS
1266    if ((csp->action->flags & ACTION_FAST_REDIRECTS))
1267    {
1268       char *old_url;
1269
1270       redirect_mode = csp->action->string[ACTION_STRING_FAST_REDIRECTS];
1271
1272       /*
1273        * If it exists, use the previously rewritten URL as input
1274        * otherwise just use the old path.
1275        */
1276       old_url = (new_url != NULL) ? new_url : strdup(csp->http->path);
1277       new_url = get_last_url(old_url, redirect_mode);
1278       freez(old_url);
1279    }
1280
1281    /*
1282     * Disable redirect checkers, so that they
1283     * will be only run more than once if the user
1284     * also enables them through tags.
1285     *
1286     * From a performance point of view
1287     * it doesn't matter, but the duplicated
1288     * log messages are annoying.
1289     */
1290    csp->action->flags &= ~ACTION_FAST_REDIRECTS;
1291 #endif /* def FEATURE_FAST_REDIRECTS */
1292    csp->action->flags &= ~ACTION_REDIRECT;
1293
1294    /* Did any redirect action trigger? */
1295    if (new_url)
1296    {
1297       if (url_requires_percent_encoding(new_url))
1298       {
1299          char *encoded_url;
1300          log_error(LOG_LEVEL_REDIRECTS, "Percent-encoding redirect URL: %N",
1301             strlen(new_url), new_url);
1302          encoded_url = percent_encode_url(new_url);
1303          freez(new_url);
1304          if (encoded_url == NULL)
1305          {
1306             return cgi_error_memory();
1307          }
1308          new_url = encoded_url;
1309          assert(FALSE == url_requires_percent_encoding(new_url));
1310       }
1311
1312       if (0 == strcmpic(new_url, csp->http->url))
1313       {
1314          log_error(LOG_LEVEL_ERROR,
1315             "New URL \"%s\" and old URL \"%s\" are the same. Redirection loop prevented.",
1316             csp->http->url, new_url);
1317             freez(new_url);
1318       }
1319       else
1320       {
1321          log_error(LOG_LEVEL_REDIRECTS, "New URL is: %s", new_url);
1322
1323          if (NULL == (rsp = alloc_http_response()))
1324          {
1325             freez(new_url);
1326             return cgi_error_memory();
1327          }
1328
1329          rsp->status = strdup_or_die("302 Local Redirect from Privoxy");
1330          if (enlist_unique_header(rsp->headers, "Location", new_url))
1331          {
1332             freez(new_url);
1333             free_http_response(rsp);
1334             return cgi_error_memory();
1335          }
1336          rsp->crunch_reason = REDIRECTED;
1337          freez(new_url);
1338
1339          return finish_http_response(csp, rsp);
1340       }
1341    }
1342
1343    /* Only reached if no redirect is required */
1344    return NULL;
1345
1346 }
1347
1348
1349 #ifdef FEATURE_IMAGE_BLOCKING
1350 /*********************************************************************
1351  *
1352  * Function    :  is_imageurl
1353  *
1354  * Description :  Given a URL, decide whether it should be treated
1355  *                as image URL or not.
1356  *
1357  * Parameters  :
1358  *          1  :  csp = Current client state (buffers, headers, etc...)
1359  *
1360  * Returns     :  True (nonzero) if URL is an image URL, false (0)
1361  *                otherwise
1362  *
1363  *********************************************************************/
1364 int is_imageurl(const struct client_state *csp)
1365 {
1366    return ((csp->action->flags & ACTION_IMAGE) != 0);
1367
1368 }
1369 #endif /* def FEATURE_IMAGE_BLOCKING */
1370
1371
1372 #ifdef FEATURE_TRUST
1373 /*********************************************************************
1374  *
1375  * Function    :  is_untrusted_url
1376  *
1377  * Description :  Should we "distrust" this URL (and block it)?
1378  *
1379  *                Yes if it matches a line in the trustfile, or if the
1380  *                    referrer matches a line starting with "+" in the
1381  *                    trustfile.
1382  *                No  otherwise.
1383  *
1384  * Parameters  :
1385  *          1  :  csp = Current client state (buffers, headers, etc...)
1386  *
1387  * Returns     :  0 => trusted, 1 => untrusted
1388  *
1389  *********************************************************************/
1390 int is_untrusted_url(const struct client_state *csp)
1391 {
1392    struct file_list *fl;
1393    struct block_spec *b;
1394    struct pattern_spec **trusted_url;
1395    struct http_request rhttp[1];
1396    const char * referer;
1397    jb_err err;
1398
1399    /*
1400     * If we don't have a trustlist, we trust everybody
1401     */
1402    if (((fl = csp->tlist) == NULL) || ((b  = fl->f) == NULL))
1403    {
1404       return 0;
1405    }
1406
1407    memset(rhttp, '\0', sizeof(*rhttp));
1408
1409    /*
1410     * Do we trust the request URL itself?
1411     */
1412    for (b = b->next; b ; b = b->next)
1413    {
1414       if (url_match(b->url, csp->http))
1415       {
1416          return b->reject;
1417       }
1418    }
1419
1420    if (NULL == (referer = get_header_value(csp->headers, "Referer:")))
1421    {
1422       /* no referrer was supplied */
1423       return 1;
1424    }
1425
1426
1427    /*
1428     * If not, do we maybe trust its referrer?
1429     */
1430    err = parse_http_url(referer, rhttp, REQUIRE_PROTOCOL);
1431    if (err)
1432    {
1433       return 1;
1434    }
1435
1436    for (trusted_url = csp->config->trust_list; *trusted_url != NULL; trusted_url++)
1437    {
1438       if (url_match(*trusted_url, rhttp))
1439       {
1440          /* if the URL's referrer is from a trusted referrer, then
1441           * add the target spec to the trustfile as an unblocked
1442           * domain and return 0 (which means it's OK).
1443           */
1444
1445          FILE *fp;
1446
1447          if (NULL != (fp = fopen(csp->config->trustfile, "a")))
1448          {
1449             char * path;
1450             char * path_end;
1451             char * new_entry = strdup_or_die("~");
1452
1453             string_append(&new_entry, csp->http->hostport);
1454
1455             path = csp->http->path;
1456             if ( (path[0] == '/')
1457               && (path[1] == '~')
1458               && ((path_end = strchr(path + 2, '/')) != NULL))
1459             {
1460                /* since this path points into a user's home space
1461                 * be sure to include this spec in the trustfile.
1462                 */
1463                long path_len = path_end - path; /* save offset */
1464                path = strdup(path); /* Copy string */
1465                if (path != NULL)
1466                {
1467                   path_end = path + path_len; /* regenerate ptr to new buffer */
1468                   *(path_end + 1) = '\0'; /* Truncate path after '/' */
1469                }
1470                string_join(&new_entry, path);
1471             }
1472
1473             /*
1474              * Give a reason for generating this entry.
1475              */
1476             string_append(&new_entry, " # Trusted referrer was: ");
1477             string_append(&new_entry, referer);
1478
1479             if (new_entry != NULL)
1480             {
1481                if (-1 == fprintf(fp, "%s\n", new_entry))
1482                {
1483                   log_error(LOG_LEVEL_ERROR, "Failed to append \'%s\' to trustfile \'%s\': %E",
1484                      new_entry, csp->config->trustfile);
1485                }
1486                freez(new_entry);
1487             }
1488             else
1489             {
1490                /* FIXME: No way to handle out-of memory, so mostly ignoring it */
1491                log_error(LOG_LEVEL_ERROR, "Out of memory adding pattern to trust file");
1492             }
1493
1494             fclose(fp);
1495          }
1496          else
1497          {
1498             log_error(LOG_LEVEL_ERROR, "Failed to append new entry for \'%s\' to trustfile \'%s\': %E",
1499                csp->http->hostport, csp->config->trustfile);
1500          }
1501          return 0;
1502       }
1503    }
1504
1505    return 1;
1506 }
1507 #endif /* def FEATURE_TRUST */
1508
1509
1510 /*********************************************************************
1511  *
1512  * Function    :  get_filter
1513  *
1514  * Description :  Get a filter with a given name and type.
1515  *                Note that taggers are filters, too.
1516  *
1517  * Parameters  :
1518  *          1  :  csp = Current client state (buffers, headers, etc...)
1519  *          2  :  requested_name = Name of the content filter to get
1520  *          3  :  requested_type = Type of the filter to tagger to lookup
1521  *
1522  * Returns     :  A pointer to the requested filter
1523  *                or NULL if the filter wasn't found
1524  *
1525  *********************************************************************/
1526 struct re_filterfile_spec *get_filter(const struct client_state *csp,
1527                                       const char *requested_name,
1528                                       enum filter_type requested_type)
1529 {
1530    int i;
1531    struct re_filterfile_spec *b;
1532    struct file_list *fl;
1533
1534    for (i = 0; i < MAX_AF_FILES; i++)
1535    {
1536      fl = csp->rlist[i];
1537      if ((NULL == fl) || (NULL == fl->f))
1538      {
1539         /*
1540          * Either there are no filter files left or this
1541          * filter file just contains no valid filters.
1542          *
1543          * Continue to be sure we don't miss valid filter
1544          * files that are chained after empty or invalid ones.
1545          */
1546         continue;
1547      }
1548
1549      for (b = fl->f; b != NULL; b = b->next)
1550      {
1551         if (b->type != requested_type)
1552         {
1553            /* The callers isn't interested in this filter type. */
1554            continue;
1555         }
1556         if (strcmp(b->name, requested_name) == 0)
1557         {
1558            /* The requested filter has been found. Abort search. */
1559            return b;
1560         }
1561      }
1562    }
1563
1564    /* No filter with the given name and type exists. */
1565    return NULL;
1566
1567 }
1568
1569
1570 /*********************************************************************
1571  *
1572  * Function    :  pcrs_filter_impl
1573  *
1574  * Description :  Execute all text substitutions from all applying
1575  *                (based on filter_response_body value) +filter
1576  *                or +client_body_filter actions on the given buffer.
1577  *
1578  * Parameters  :
1579  *          1  :  csp = Current client state (buffers, headers, etc...)
1580  *          2  :  filter_response_body = when TRUE execute +filter
1581  *                actions; execute +client_body_filter actions otherwise
1582  *          3  :  data = Target data
1583  *          4  :  data_len = Target data len
1584  *
1585  * Returns     :  a pointer to the (newly allocated) modified buffer.
1586  *                or NULL if there were no hits or something went wrong
1587  *
1588  *********************************************************************/
1589 static char *pcrs_filter_impl(const struct client_state *csp, int filter_response_body,
1590                               const char *data, size_t *data_len)
1591 {
1592    int hits = 0;
1593    size_t size, prev_size;
1594    const int filters_idx =
1595       filter_response_body ? ACTION_MULTI_FILTER : ACTION_MULTI_CLIENT_BODY_FILTER;
1596    const enum filter_type filter_type =
1597       filter_response_body ? FT_CONTENT_FILTER : FT_CLIENT_BODY_FILTER;
1598
1599    const char *old = NULL;
1600    char *new = NULL;
1601    pcrs_job *job;
1602
1603    struct re_filterfile_spec *b;
1604    struct list_entry *filtername;
1605
1606    /*
1607     * Sanity first
1608     */
1609    if (*data_len == 0)
1610    {
1611       return(NULL);
1612    }
1613
1614    if (filters_available(csp) == FALSE)
1615    {
1616       log_error(LOG_LEVEL_ERROR, "Inconsistent configuration: "
1617          "content filtering enabled, but no content filters available.");
1618       return(NULL);
1619    }
1620
1621    size = *data_len;
1622    old = data;
1623
1624    /*
1625     * For all applying actions, look if a filter by that
1626     * name exists and if yes, execute it's pcrs_joblist on the
1627     * buffer.
1628     */
1629    for (filtername = csp->action->multi[filters_idx]->first;
1630         filtername != NULL; filtername = filtername->next)
1631    {
1632       int current_hits = 0; /* Number of hits caused by this filter */
1633       int job_number   = 0; /* Which job we're currently executing  */
1634       int job_hits     = 0; /* How many hits the current job caused */
1635       pcrs_job *joblist;
1636
1637       b = get_filter(csp, filtername->str, filter_type);
1638       if (b == NULL)
1639       {
1640          continue;
1641       }
1642
1643       joblist = b->joblist;
1644
1645       if (b->dynamic) joblist = compile_dynamic_pcrs_job_list(csp, b);
1646
1647       if (NULL == joblist)
1648       {
1649          log_error(LOG_LEVEL_RE_FILTER, "Filter %s has empty joblist. Nothing to do.", b->name);
1650          continue;
1651       }
1652
1653       prev_size = size;
1654       /* Apply all jobs from the joblist */
1655       for (job = joblist; NULL != job; job = job->next)
1656       {
1657          job_number++;
1658          job_hits = pcrs_execute(job, old, size, &new, &size);
1659
1660          if (job_hits >= 0)
1661          {
1662             /*
1663              * That went well. Continue filtering
1664              * and use the result of this job as
1665              * input for the next one.
1666              */
1667             current_hits += job_hits;
1668             if (old != data)
1669             {
1670                freez(old);
1671             }
1672             old = new;
1673          }
1674          else
1675          {
1676             /*
1677              * This job caused an unexpected error. Inform the user
1678              * and skip the rest of the jobs in this filter. We could
1679              * continue with the next job, but usually the jobs
1680              * depend on each other or are similar enough to
1681              * fail for the same reason.
1682              *
1683              * At the moment our pcrs expects the error codes of pcre 3.4,
1684              * but newer pcre versions can return additional error codes.
1685              * As a result pcrs_strerror()'s error message might be
1686              * "Unknown error ...", therefore we print the numerical value
1687              * as well.
1688              *
1689              * XXX: Is this important enough for LOG_LEVEL_ERROR or
1690              * should we use LOG_LEVEL_RE_FILTER instead?
1691              */
1692             log_error(LOG_LEVEL_ERROR, "Skipped filter \'%s\' after job number %u: %s (%d)",
1693                b->name, job_number, pcrs_strerror(job_hits), job_hits);
1694             break;
1695          }
1696       }
1697
1698       if (b->dynamic) pcrs_free_joblist(joblist);
1699
1700       if (filter_response_body)
1701       {
1702          log_error(LOG_LEVEL_RE_FILTER,
1703             "filtering %s%s (size %lu) with \'%s\' produced %d hits (new size %lu).",
1704             csp->http->hostport, csp->http->path, prev_size, b->name, current_hits, size);
1705       }
1706       else
1707       {
1708          log_error(LOG_LEVEL_RE_FILTER, "filtering request body from client %s "
1709             "(size %lu) with \'%s\' produced %d hits (new size %lu).",
1710             csp->ip_addr_str, prev_size, b->name, current_hits, size);
1711       }
1712 #ifdef FEATURE_EXTENDED_STATISTICS
1713       update_filter_statistics(b->name, current_hits);
1714 #endif
1715       hits += current_hits;
1716    }
1717
1718    /*
1719     * If there were no hits, destroy our copy and let
1720     * chat() use the original content
1721     */
1722    if (!hits)
1723    {
1724       if (old != data && old != new)
1725       {
1726          freez(old);
1727       }
1728       freez(new);
1729       return(NULL);
1730    }
1731
1732    *data_len = size;
1733    return(new);
1734 }
1735
1736
1737 /*********************************************************************
1738  *
1739  * Function    :  pcrs_filter_response_body
1740  *
1741  * Description :  Execute all text substitutions from all applying
1742  *                +filter actions on the text buffer that's been
1743  *                accumulated in csp->iob->buf.
1744  *
1745  * Parameters  :
1746  *          1  :  csp = Current client state (buffers, headers, etc...)
1747  *
1748  * Returns     :  a pointer to the (newly allocated) modified buffer.
1749  *                or NULL if there were no hits or something went wrong
1750  *
1751  *********************************************************************/
1752 static char *pcrs_filter_response_body(struct client_state *csp)
1753 {
1754    size_t size = (size_t)(csp->iob->eod - csp->iob->cur);
1755
1756    char *new = NULL;
1757
1758    /*
1759     * Sanity first
1760     */
1761    if (csp->iob->cur >= csp->iob->eod)
1762    {
1763       return NULL;
1764    }
1765
1766    new = pcrs_filter_impl(csp, TRUE, csp->iob->cur, &size);
1767
1768    if (new != NULL)
1769    {
1770       csp->flags |= CSP_FLAG_MODIFIED;
1771       csp->content_length = size;
1772       clear_iob(csp->iob);
1773    }
1774
1775    return new;
1776 }
1777
1778
1779 #ifdef FEATURE_EXTERNAL_FILTERS
1780 /*********************************************************************
1781  *
1782  * Function    :  get_external_filter
1783  *
1784  * Description :  Lookup the code to execute for an external filter.
1785  *                Masks the misuse of the re_filterfile_spec.
1786  *
1787  * Parameters  :
1788  *          1  :  csp = Current client state (buffers, headers, etc...)
1789  *          2  :  name = Name of the content filter to get
1790  *
1791  * Returns     :  A pointer to the requested code
1792  *                or NULL if the filter wasn't found
1793  *
1794  *********************************************************************/
1795 static const char *get_external_filter(const struct client_state *csp,
1796                                 const char *name)
1797 {
1798    struct re_filterfile_spec *external_filter;
1799
1800    external_filter = get_filter(csp, name, FT_EXTERNAL_CONTENT_FILTER);
1801    if (external_filter == NULL)
1802    {
1803       log_error(LOG_LEVEL_FATAL,
1804          "Didn't find stuff to execute for external filter: %s",
1805          name);
1806    }
1807
1808    return external_filter->patterns->first->str;
1809
1810 }
1811
1812
1813 /*********************************************************************
1814  *
1815  * Function    :  set_privoxy_variables
1816  *
1817  * Description :  Sets a couple of privoxy-specific environment variables
1818  *
1819  * Parameters  :
1820  *          1  :  csp = Current client state (buffers, headers, etc...)
1821  *
1822  * Returns     :  N/A
1823  *
1824  *********************************************************************/
1825 static void set_privoxy_variables(const struct client_state *csp)
1826 {
1827    int i;
1828    struct {
1829       const char *name;
1830       const char *value;
1831    } env[] = {
1832       { "PRIVOXY_URL",    csp->http->url   },
1833       { "PRIVOXY_PATH",   csp->http->path  },
1834       { "PRIVOXY_HOST",   csp->http->host  },
1835       { "PRIVOXY_ORIGIN", csp->ip_addr_str },
1836       { "PRIVOXY_LISTEN_ADDRESS", csp->listen_addr_str },
1837    };
1838
1839    for (i = 0; i < SZ(env); i++)
1840    {
1841       if (setenv(env[i].name, env[i].value, 1))
1842       {
1843          log_error(LOG_LEVEL_ERROR, "Failed to set %s=%s: %E",
1844             env[i].name, env[i].value);
1845       }
1846    }
1847 }
1848
1849
1850 /*********************************************************************
1851  *
1852  * Function    :  execute_external_filter
1853  *
1854  * Description :  Pipe content into external filter and return the output
1855  *
1856  * Parameters  :
1857  *          1  :  csp = Current client state (buffers, headers, etc...)
1858  *          2  :  name = Name of the external filter to execute
1859  *          3  :  content = The original content to filter
1860  *          4  :  size = The size of the content buffer
1861  *
1862  * Returns     :  a pointer to the (newly allocated) modified buffer.
1863  *                or NULL if there were no hits or something went wrong
1864  *
1865  *********************************************************************/
1866 static char *execute_external_filter(const struct client_state *csp,
1867    const char *name, char *content, size_t *size)
1868 {
1869    char cmd[200];
1870    char file_name[FILENAME_MAX];
1871    FILE *fp;
1872    char *filter_output;
1873    int fd;
1874    int ret;
1875    size_t new_size;
1876    const char *external_filter;
1877
1878    if (csp->config->temporary_directory == NULL)
1879    {
1880       log_error(LOG_LEVEL_ERROR,
1881          "No temporary-directory configured. Can't execute filter: %s",
1882          name);
1883       return NULL;
1884    }
1885
1886    external_filter = get_external_filter(csp, name);
1887
1888    if (sizeof(file_name) < snprintf(file_name, sizeof(file_name),
1889          "%s/privoxy-XXXXXXXX", csp->config->temporary_directory))
1890    {
1891       log_error(LOG_LEVEL_ERROR, "temporary-directory path too long");
1892       return NULL;
1893    }
1894
1895    fd = mkstemp(file_name);
1896    if (fd == -1)
1897    {
1898       log_error(LOG_LEVEL_ERROR, "mkstemp() failed to create %s: %E", file_name);
1899       return NULL;
1900    }
1901
1902    fp = fdopen(fd, "w");
1903    if (fp == NULL)
1904    {
1905       log_error(LOG_LEVEL_ERROR, "fdopen() failed: %E");
1906       unlink(file_name);
1907       return NULL;
1908    }
1909
1910    /*
1911     * The size may be zero if a previous filter discarded everything.
1912     *
1913     * This isn't necessary unintentional, so we just don't try
1914     * to fwrite() nothing and let the user deal with the rest.
1915     */
1916    if ((*size != 0) && fwrite(content, *size, 1, fp) != 1)
1917    {
1918       log_error(LOG_LEVEL_ERROR, "fwrite(..., %lu, 1, ..) failed: %E", *size);
1919       unlink(file_name);
1920       fclose(fp);
1921       return NULL;
1922    }
1923    fclose(fp);
1924
1925    if (sizeof(cmd) < snprintf(cmd, sizeof(cmd), "%s < %s", external_filter, file_name))
1926    {
1927       log_error(LOG_LEVEL_ERROR,
1928          "temporary-directory or external filter path too long");
1929       unlink(file_name);
1930       return NULL;
1931    }
1932
1933    log_error(LOG_LEVEL_RE_FILTER, "Executing '%s': %s", name, cmd);
1934
1935    /*
1936     * The locking is necessary to prevent other threads
1937     * from overwriting the environment variables before
1938     * the popen fork. Afterwards this no longer matters.
1939     */
1940    privoxy_mutex_lock(&external_filter_mutex);
1941    set_privoxy_variables(csp);
1942    fp = popen(cmd, "r");
1943    privoxy_mutex_unlock(&external_filter_mutex);
1944    if (fp == NULL)
1945    {
1946       log_error(LOG_LEVEL_ERROR, "popen(\"%s\", \"r\") failed: %E", cmd);
1947       unlink(file_name);
1948       return NULL;
1949    }
1950
1951    /* Allocate at least one byte */
1952    filter_output = malloc_or_die(*size + 1);
1953
1954    new_size = 0;
1955    while (!feof(fp) && !ferror(fp))
1956    {
1957       size_t len;
1958       /* Could be bigger ... */
1959       enum { READ_LENGTH = 2048 };
1960
1961       if (new_size + READ_LENGTH >= *size)
1962       {
1963          char *p;
1964
1965          /* Could be considered wasteful if the content is 'large'. */
1966          *size += (*size >= READ_LENGTH) ? *size : READ_LENGTH;
1967
1968          p = realloc(filter_output, *size);
1969          if (p == NULL)
1970          {
1971             log_error(LOG_LEVEL_ERROR, "Out of memory while reading "
1972                "external filter output. Using what we got so far.");
1973             break;
1974          }
1975          filter_output = p;
1976       }
1977       assert(new_size + READ_LENGTH < *size);
1978       len = fread(&filter_output[new_size], 1, READ_LENGTH, fp);
1979       if (len > 0)
1980       {
1981          new_size += len;
1982       }
1983    }
1984
1985    ret = pclose(fp);
1986    if (ret == -1)
1987    {
1988       log_error(LOG_LEVEL_ERROR, "Executing %s failed: %E", cmd);
1989    }
1990    else
1991    {
1992       log_error(LOG_LEVEL_RE_FILTER,
1993          "Executing '%s' resulted in return value %d. "
1994          "Read %lu of up to %lu bytes.", name, (ret >> 8), new_size, *size);
1995    }
1996
1997    unlink(file_name);
1998    *size = new_size;
1999
2000    return filter_output;
2001
2002 }
2003 #endif /* def FEATURE_EXTERNAL_FILTERS */
2004
2005
2006 /*********************************************************************
2007  *
2008  * Function    :  pcrs_filter_request_body
2009  *
2010  * Description :  Execute all text substitutions from all applying
2011  *                +client_body_filter actions on the given text buffer.
2012  *
2013  * Parameters  :
2014  *          1  :  csp = Current client state (buffers, headers, etc...)
2015  *          2  :  data = Target data
2016  *          3  :  data_len = Target data len
2017  *
2018  * Returns     :  a pointer to the (newly allocated) modified buffer.
2019  *                or NULL if there were no hits or something went wrong
2020  *
2021  *********************************************************************/
2022 static char *pcrs_filter_request_body(const struct client_state *csp, const char *data, size_t *data_len)
2023 {
2024    return pcrs_filter_impl(csp, FALSE, data, data_len);
2025 }
2026
2027
2028 /*********************************************************************
2029  *
2030  * Function    :  gif_deanimate_response
2031  *
2032  * Description :  Deanimate the GIF image that has been accumulated in
2033  *                csp->iob->buf, set csp->content_length to the modified
2034  *                size and raise the CSP_FLAG_MODIFIED flag.
2035  *
2036  * Parameters  :
2037  *          1  :  csp = Current client state (buffers, headers, etc...)
2038  *
2039  * Returns     :  a pointer to the (newly allocated) modified buffer.
2040  *                or NULL in case something went wrong.
2041  *
2042  *********************************************************************/
2043 #ifdef FUZZ
2044 char *gif_deanimate_response(struct client_state *csp)
2045 #else
2046 static char *gif_deanimate_response(struct client_state *csp)
2047 #endif
2048 {
2049    struct binbuffer *in, *out;
2050    char *p;
2051    size_t size;
2052
2053    size = (size_t)(csp->iob->eod - csp->iob->cur);
2054
2055    in =  zalloc_or_die(sizeof(*in));
2056    out = zalloc_or_die(sizeof(*out));
2057
2058    in->buffer = csp->iob->cur;
2059    in->size = size;
2060
2061    if (gif_deanimate(in, out, strncmp("last", csp->action->string[ACTION_STRING_DEANIMATE], 4)))
2062    {
2063       log_error(LOG_LEVEL_DEANIMATE, "failed! (gif parsing)");
2064       freez(in);
2065       buf_free(out);
2066       return(NULL);
2067    }
2068    else
2069    {
2070       if ((int)size == out->offset)
2071       {
2072          log_error(LOG_LEVEL_DEANIMATE, "GIF not changed.");
2073       }
2074       else
2075       {
2076          log_error(LOG_LEVEL_DEANIMATE,
2077             "Success! GIF shrunk from %lu bytes to %lu.", size, out->offset);
2078       }
2079       csp->content_length = out->offset;
2080       csp->flags |= CSP_FLAG_MODIFIED;
2081       p = out->buffer;
2082       freez(in);
2083       freez(out);
2084       return(p);
2085    }
2086
2087 }
2088
2089
2090 /*********************************************************************
2091  *
2092  * Function    :  get_filter_function
2093  *
2094  * Description :  Decides which content filter function has
2095  *                to be applied (if any). Only considers functions
2096  *                for internal filters which are mutually-exclusive.
2097  *
2098  * Parameters  :
2099  *          1  :  csp = Current client state (buffers, headers, etc...)
2100  *
2101  * Returns     :  The content filter function to run, or
2102  *                NULL if no content filter is active
2103  *
2104  *********************************************************************/
2105 static filter_function_ptr get_filter_function(const struct client_state *csp)
2106 {
2107    filter_function_ptr filter_function = NULL;
2108
2109    /*
2110     * Choose the applying filter function based on
2111     * the content type and action settings.
2112     */
2113    if ((csp->content_type & CT_TEXT) &&
2114        (!list_is_empty(csp->action->multi[ACTION_MULTI_FILTER])))
2115    {
2116       filter_function = pcrs_filter_response_body;
2117    }
2118    else if ((csp->content_type & CT_GIF) &&
2119             (csp->action->flags & ACTION_DEANIMATE))
2120    {
2121       filter_function = gif_deanimate_response;
2122    }
2123
2124    return filter_function;
2125 }
2126
2127
2128 /*********************************************************************
2129  *
2130  * Function    :  remove_chunked_transfer_coding
2131  *
2132  * Description :  In-situ remove the "chunked" transfer coding as defined
2133  *                in RFC 7230 4.1 from a buffer. XXX: The implementation
2134  *                is neither complete nor compliant (TODO #129).
2135  *
2136  * Parameters  :
2137  *          1  :  buffer = Pointer to the text buffer
2138  *          2  :  size =  In: Number of bytes to be processed,
2139  *                       Out: Number of bytes after de-chunking.
2140  *                       (undefined in case of errors)
2141  *
2142  * Returns     :  JB_ERR_OK for success,
2143  *                JB_ERR_PARSE otherwise
2144  *
2145  *********************************************************************/
2146 #ifdef FUZZ
2147 extern jb_err remove_chunked_transfer_coding(char *buffer, size_t *size)
2148 #else
2149 static jb_err remove_chunked_transfer_coding(char *buffer, size_t *size)
2150 #endif
2151 {
2152    size_t newsize = 0;
2153    unsigned int chunksize = 0;
2154    char *from_p, *to_p;
2155    const char *end_of_buffer = buffer + *size;
2156
2157    if (*size == 0)
2158    {
2159       log_error(LOG_LEVEL_FATAL, "Invalid chunked input. Buffer is empty.");
2160       return JB_ERR_PARSE;
2161    }
2162
2163    assert(buffer);
2164    from_p = to_p = buffer;
2165
2166    if (sscanf(buffer, "%x", &chunksize) != 1)
2167    {
2168       log_error(LOG_LEVEL_ERROR, "Invalid first chunksize while stripping \"chunked\" transfer coding");
2169       return JB_ERR_PARSE;
2170    }
2171
2172    while (chunksize > 0U)
2173    {
2174       /*
2175        * If the chunk-size is valid, we should have at least
2176        * chunk-size bytes of chunk-data and five bytes of
2177        * meta data (chunk-size, CRLF, CRLF) left in the buffer.
2178        */
2179       if (chunksize + 5 >= *size - newsize)
2180       {
2181          log_error(LOG_LEVEL_ERROR,
2182             "Chunk size %u exceeds buffered data left. "
2183             "Already digested %lu of %lu buffered bytes.",
2184             chunksize, newsize, *size);
2185          return JB_ERR_PARSE;
2186       }
2187
2188       /*
2189        * Skip the chunk-size, the optional chunk-ext and the CRLF
2190        * that is supposed to be located directly before the start
2191        * of chunk-data.
2192        */
2193       if (NULL == (from_p = strstr(from_p, "\r\n")))
2194       {
2195          log_error(LOG_LEVEL_ERROR, "Parse error while stripping \"chunked\" transfer coding");
2196          return JB_ERR_PARSE;
2197       }
2198       from_p += 2;
2199
2200       /*
2201        * The previous strstr() does not enforce chunk-validity
2202        * and is sattisfied as long a CRLF is left in the buffer.
2203        *
2204        * Make sure the bytes we consider chunk-data are within
2205        * the valid range.
2206        */
2207       if (from_p + chunksize >= end_of_buffer)
2208       {
2209          log_error(LOG_LEVEL_ERROR,
2210             "End of chunk is beyond the end of the buffer.");
2211          return JB_ERR_PARSE;
2212       }
2213
2214       memmove(to_p, from_p, (size_t) chunksize);
2215       newsize += chunksize;
2216       to_p = buffer + newsize;
2217       from_p += chunksize;
2218
2219       /*
2220        * Not merging this check with the previous one allows us
2221        * to keep chunks without trailing CRLF. It's not clear
2222        * if we actually have to care about those, though.
2223        */
2224       if (from_p + 2 >= end_of_buffer)
2225       {
2226          log_error(LOG_LEVEL_ERROR, "Not enough room for trailing CRLF.");
2227          return JB_ERR_PARSE;
2228       }
2229       from_p += 2;
2230       if (sscanf(from_p, "%x", &chunksize) != 1)
2231       {
2232          log_error(LOG_LEVEL_INFO, "Invalid \"chunked\" transfer encoding detected and ignored.");
2233          break;
2234       }
2235    }
2236
2237    /* XXX: Should get its own loglevel. */
2238    log_error(LOG_LEVEL_RE_FILTER,
2239       "De-chunking successful. Shrunk from %lu to %lu", *size, newsize);
2240
2241    *size = newsize;
2242
2243    return JB_ERR_OK;
2244
2245 }
2246
2247
2248 /*********************************************************************
2249  *
2250  * Function    :  prepare_for_filtering
2251  *
2252  * Description :  If necessary, de-chunks and decompresses
2253  *                the content so it can get filterd.
2254  *
2255  * Parameters  :
2256  *          1  :  csp = Current client state (buffers, headers, etc...)
2257  *
2258  * Returns     :  JB_ERR_OK for success,
2259  *                JB_ERR_PARSE otherwise
2260  *
2261  *********************************************************************/
2262 static jb_err prepare_for_filtering(struct client_state *csp)
2263 {
2264    jb_err err = JB_ERR_OK;
2265
2266    /*
2267     * If the body has a "chunked" transfer-encoding,
2268     * get rid of it, adjusting size and iob->eod
2269     */
2270    if (csp->flags & CSP_FLAG_CHUNKED)
2271    {
2272       size_t size = (size_t)(csp->iob->eod - csp->iob->cur);
2273
2274       log_error(LOG_LEVEL_RE_FILTER, "Need to de-chunk first");
2275       err = remove_chunked_transfer_coding(csp->iob->cur, &size);
2276       if (JB_ERR_OK == err)
2277       {
2278          csp->iob->eod = csp->iob->cur + size;
2279          csp->flags |= CSP_FLAG_MODIFIED;
2280       }
2281       else
2282       {
2283          return JB_ERR_PARSE;
2284       }
2285    }
2286
2287 #ifdef FEATURE_ZLIB
2288    /*
2289     * If the body has a supported transfer-encoding,
2290     * decompress it, adjusting size and iob->eod.
2291     */
2292    if ((csp->content_type & (CT_GZIP|CT_DEFLATE))
2293 #ifdef FEATURE_BROTLI
2294       || (csp->content_type & CT_BROTLI)
2295 #endif
2296        )
2297    {
2298       if (0 == csp->iob->eod - csp->iob->cur)
2299       {
2300          /* Nothing left after de-chunking. */
2301          return JB_ERR_OK;
2302       }
2303
2304       err = decompress_iob(csp);
2305
2306       if (JB_ERR_OK == err)
2307       {
2308          csp->flags |= CSP_FLAG_MODIFIED;
2309          csp->content_type &= ~CT_TABOO;
2310       }
2311       else
2312       {
2313          /*
2314           * Unset content types to remember not to
2315           * modify the Content-Encoding header later.
2316           */
2317          csp->content_type &= ~CT_GZIP;
2318          csp->content_type &= ~CT_DEFLATE;
2319 #ifdef FEATURE_BROTLI
2320          csp->content_type &= ~CT_BROTLI;
2321 #endif
2322       }
2323    }
2324 #endif
2325
2326    return err;
2327 }
2328
2329
2330 /*********************************************************************
2331  *
2332  * Function    :  execute_content_filters
2333  *
2334  * Description :  Executes a given content filter.
2335  *
2336  * Parameters  :
2337  *          1  :  csp = Current client state (buffers, headers, etc...)
2338  *
2339  * Returns     :  Pointer to the modified buffer, or
2340  *                NULL if filtering failed or wasn't necessary.
2341  *
2342  *********************************************************************/
2343 char *execute_content_filters(struct client_state *csp)
2344 {
2345    char *content;
2346    filter_function_ptr content_filter;
2347
2348    assert(content_filters_enabled(csp->action));
2349
2350    if (0 == csp->iob->eod - csp->iob->cur)
2351    {
2352       /*
2353        * No content (probably status code 301, 302 ...),
2354        * no filtering necessary.
2355        */
2356       return NULL;
2357    }
2358
2359    if (JB_ERR_OK != prepare_for_filtering(csp))
2360    {
2361       /*
2362        * failed to de-chunk or decompress.
2363        */
2364       return NULL;
2365    }
2366
2367    if (0 == csp->iob->eod - csp->iob->cur)
2368    {
2369       /*
2370        * Clown alarm: chunked and/or compressed nothing delivered.
2371        */
2372       return NULL;
2373    }
2374
2375    content_filter = get_filter_function(csp);
2376    content = (content_filter != NULL) ? (*content_filter)(csp) : NULL;
2377
2378 #ifdef FEATURE_EXTERNAL_FILTERS
2379    if ((csp->content_type & CT_TEXT) &&
2380        !list_is_empty(csp->action->multi[ACTION_MULTI_EXTERNAL_FILTER]))
2381    {
2382       struct list_entry *filtername;
2383       size_t size = (size_t)csp->content_length;
2384
2385       if (content == NULL)
2386       {
2387          content = csp->iob->cur;
2388          size = (size_t)(csp->iob->eod - csp->iob->cur);
2389       }
2390
2391       for (filtername = csp->action->multi[ACTION_MULTI_EXTERNAL_FILTER]->first;
2392            filtername ; filtername = filtername->next)
2393       {
2394          char *result = execute_external_filter(csp, filtername->str, content, &size);
2395          if (result != NULL)
2396          {
2397             if (content != csp->iob->cur)
2398             {
2399                free(content);
2400             }
2401             content = result;
2402          }
2403       }
2404       csp->flags |= CSP_FLAG_MODIFIED;
2405       csp->content_length = size;
2406    }
2407 #endif /* def FEATURE_EXTERNAL_FILTERS */
2408
2409    return content;
2410
2411 }
2412
2413
2414 /*********************************************************************
2415  *
2416  * Function    :  execute_client_body_filters
2417  *
2418  * Description :  Executes client body filters for the request that is buffered
2419  *                in the client_iob. Upon success moves client_iob cur pointer
2420  *                to the end of the processed data.
2421  *
2422  * Parameters  :
2423  *          1  :  csp = Current client state (buffers, headers, etc...)
2424  *          2  :  content_length = content length. Upon successful filtering
2425  *                the passed value is updated with the new content length.
2426  *
2427  * Returns     :  Pointer to the modified buffer, or
2428  *                NULL if filtering failed or wasn't necessary.
2429  *
2430  *********************************************************************/
2431 char *execute_client_body_filters(struct client_state *csp, size_t *content_length)
2432 {
2433    char *ret;
2434
2435    assert(client_body_filters_enabled(csp->action));
2436
2437    if (content_length == 0)
2438    {
2439       /*
2440        * No content, no filtering necessary.
2441        */
2442       return NULL;
2443    }
2444
2445    ret = pcrs_filter_request_body(csp, csp->client_iob->cur, content_length);
2446    if (ret != NULL)
2447    {
2448       csp->client_iob->cur = csp->client_iob->eod;
2449    }
2450    return ret;
2451 }
2452
2453
2454 /*********************************************************************
2455  *
2456  * Function    :  get_url_actions
2457  *
2458  * Description :  Gets the actions for this URL.
2459  *
2460  * Parameters  :
2461  *          1  :  csp = Current client state (buffers, headers, etc...)
2462  *          2  :  http = http_request request for blocked URLs
2463  *
2464  * Returns     :  N/A
2465  *
2466  *********************************************************************/
2467 void get_url_actions(struct client_state *csp, struct http_request *http)
2468 {
2469    struct file_list *fl;
2470    struct url_actions *b;
2471    int i;
2472
2473    init_current_action(csp->action);
2474
2475    for (i = 0; i < MAX_AF_FILES; i++)
2476    {
2477       if (((fl = csp->actions_list[i]) == NULL) || ((b = fl->f) == NULL))
2478       {
2479          return;
2480       }
2481
2482 #ifdef FEATURE_CLIENT_TAGS
2483       apply_url_actions(csp->action, http, csp->client_tags, b);
2484 #else
2485       apply_url_actions(csp->action, http, b);
2486 #endif
2487    }
2488
2489    return;
2490 }
2491
2492 /*********************************************************************
2493  *
2494  * Function    :  apply_url_actions
2495  *
2496  * Description :  Applies a list of URL actions.
2497  *
2498  * Parameters  :
2499  *          1  :  action = Destination.
2500  *          2  :  http = Current URL
2501  *          3  :  client_tags = list of client tags
2502  *          4  :  b = list of URL actions to apply
2503  *
2504  * Returns     :  N/A
2505  *
2506  *********************************************************************/
2507 static void apply_url_actions(struct current_action_spec *action,
2508                               struct http_request *http,
2509 #ifdef FEATURE_CLIENT_TAGS
2510                               const struct list *client_tags,
2511 #endif
2512                               struct url_actions *b)
2513 {
2514    if (b == NULL)
2515    {
2516       /* Should never happen */
2517       return;
2518    }
2519
2520    for (b = b->next; NULL != b; b = b->next)
2521    {
2522       if (url_match(b->url, http))
2523       {
2524          merge_current_action(action, b->action);
2525       }
2526 #ifdef FEATURE_CLIENT_TAGS
2527       if (client_tag_match(b->url, client_tags))
2528       {
2529          merge_current_action(action, b->action);
2530       }
2531 #endif
2532    }
2533 }
2534
2535
2536 /*********************************************************************
2537  *
2538  * Function    :  get_forward_override_settings
2539  *
2540  * Description :  Returns forward settings as specified with the
2541  *                forward-override{} action. forward-override accepts
2542  *                forward lines similar to the one used in the
2543  *                configuration file, but without the URL pattern.
2544  *
2545  *                For example:
2546  *
2547  *                   forward / .
2548  *
2549  *                in the configuration file can be replaced with
2550  *                the action section:
2551  *
2552  *                 {+forward-override{forward .}}
2553  *                 /
2554  *
2555  * Parameters  :
2556  *          1  :  csp = Current client state (buffers, headers, etc...)
2557  *
2558  * Returns     :  Pointer to forwarding structure in case of success.
2559  *                Invalid syntax is fatal.
2560  *
2561  *********************************************************************/
2562 static const struct forward_spec *get_forward_override_settings(struct client_state *csp)
2563 {
2564    const char *forward_override_line = csp->action->string[ACTION_STRING_FORWARD_OVERRIDE];
2565    char forward_settings[BUFFER_SIZE];
2566    char *http_parent = NULL;
2567    /* variable names were chosen for consistency reasons. */
2568    struct forward_spec *fwd = NULL;
2569    int vec_count;
2570    char *vec[3];
2571
2572    assert(csp->action->flags & ACTION_FORWARD_OVERRIDE);
2573    /* Should be enforced by load_one_actions_file() */
2574    assert(strlen(forward_override_line) < sizeof(forward_settings) - 1);
2575
2576    /* Create a copy ssplit can modify */
2577    strlcpy(forward_settings, forward_override_line, sizeof(forward_settings));
2578
2579    if (NULL != csp->fwd)
2580    {
2581       /*
2582        * XXX: Currently necessary to prevent memory
2583        * leaks when the show-url-info cgi page is visited.
2584        */
2585       unload_forward_spec(csp->fwd);
2586    }
2587
2588    /*
2589     * allocate a new forward node, valid only for
2590     * the lifetime of this request. Save its location
2591     * in csp as well, so sweep() can free it later on.
2592     */
2593    fwd = csp->fwd = zalloc_or_die(sizeof(*fwd));
2594
2595    vec_count = ssplit(forward_settings, " \t", vec, SZ(vec));
2596    if ((vec_count == 2) && !strcasecmp(vec[0], "forward"))
2597    {
2598       fwd->type = SOCKS_NONE;
2599
2600       /* Parse the parent HTTP proxy host:port */
2601       http_parent = vec[1];
2602
2603    }
2604    else if ((vec_count == 2) && !strcasecmp(vec[0], "forward-webserver"))
2605    {
2606       fwd->type = FORWARD_WEBSERVER;
2607
2608       /* Parse the parent HTTP server host:port */
2609       http_parent = vec[1];
2610
2611    }
2612    else if (vec_count == 3)
2613    {
2614       char *socks_proxy = NULL;
2615
2616       if  (!strcasecmp(vec[0], "forward-socks4"))
2617       {
2618          fwd->type = SOCKS_4;
2619          socks_proxy = vec[1];
2620       }
2621       else if (!strcasecmp(vec[0], "forward-socks4a"))
2622       {
2623          fwd->type = SOCKS_4A;
2624          socks_proxy = vec[1];
2625       }
2626       else if (!strcasecmp(vec[0], "forward-socks5"))
2627       {
2628          fwd->type = SOCKS_5;
2629          socks_proxy = vec[1];
2630       }
2631       else if (!strcasecmp(vec[0], "forward-socks5t"))
2632       {
2633          fwd->type = SOCKS_5T;
2634          socks_proxy = vec[1];
2635       }
2636
2637       if (NULL != socks_proxy)
2638       {
2639          /* Parse the SOCKS proxy [user:pass@]host[:port] */
2640          fwd->gateway_port = 1080;
2641          parse_forwarder_address(socks_proxy,
2642             &fwd->gateway_host, &fwd->gateway_port,
2643             &fwd->auth_username, &fwd->auth_password);
2644
2645          http_parent = vec[2];
2646       }
2647    }
2648
2649    if (NULL == http_parent)
2650    {
2651       log_error(LOG_LEVEL_FATAL,
2652          "Invalid forward-override syntax in: %s", forward_override_line);
2653       /* Never get here - LOG_LEVEL_FATAL causes program exit */
2654    }
2655
2656    /* Parse http forwarding settings */
2657    if (strcmp(http_parent, ".") != 0)
2658    {
2659       fwd->forward_port = 8000;
2660       parse_forwarder_address(http_parent,
2661          &fwd->forward_host, &fwd->forward_port,
2662          NULL, NULL);
2663    }
2664
2665    assert (NULL != fwd);
2666
2667    log_error(LOG_LEVEL_CONNECT,
2668       "Overriding forwarding settings based on \'%s\'", forward_override_line);
2669
2670    return fwd;
2671 }
2672
2673
2674 /*********************************************************************
2675  *
2676  * Function    :  forward_url
2677  *
2678  * Description :  Should we forward this to another proxy?
2679  *
2680  * Parameters  :
2681  *          1  :  csp = Current client state (buffers, headers, etc...)
2682  *          2  :  http = http_request request for current URL
2683  *
2684  * Returns     :  Pointer to forwarding information.
2685  *
2686  *********************************************************************/
2687 const struct forward_spec *forward_url(struct client_state *csp,
2688                                        const struct http_request *http)
2689 {
2690    static const struct forward_spec fwd_default[1]; /* Zero'ed due to being static. */
2691    struct forward_spec *fwd = csp->config->forward;
2692
2693    if (csp->action->flags & ACTION_FORWARD_OVERRIDE)
2694    {
2695       return get_forward_override_settings(csp);
2696    }
2697
2698    if (fwd == NULL)
2699    {
2700       return fwd_default;
2701    }
2702
2703    while (fwd != NULL)
2704    {
2705       if (url_match(fwd->url, http))
2706       {
2707          return fwd;
2708       }
2709       fwd = fwd->next;
2710    }
2711
2712    return fwd_default;
2713 }
2714
2715
2716 /*********************************************************************
2717  *
2718  * Function    :  direct_response
2719  *
2720  * Description :  Check if Max-Forwards == 0 for an OPTIONS or TRACE
2721  *                request and if so, return a HTTP 501 to the client.
2722  *
2723  *                FIXME: I have a stupid name and I should handle the
2724  *                requests properly. Still, what we do here is rfc-
2725  *                compliant, whereas ignoring or forwarding are not.
2726  *
2727  * Parameters  :
2728  *          1  :  csp = Current client state (buffers, headers, etc...)
2729  *
2730  * Returns     :  http_response if , NULL if nonmatch or handler fail
2731  *
2732  *********************************************************************/
2733 struct http_response *direct_response(struct client_state *csp)
2734 {
2735    struct http_response *rsp;
2736    struct list_entry *p;
2737
2738    if ((0 == strcmpic(csp->http->gpc, "trace"))
2739       || (0 == strcmpic(csp->http->gpc, "options")))
2740    {
2741       for (p = csp->headers->first; (p != NULL) ; p = p->next)
2742       {
2743          if (!strncmpic(p->str, "Max-Forwards:", 13))
2744          {
2745             unsigned int max_forwards;
2746
2747             /*
2748              * If it's a Max-Forwards value of zero,
2749              * we have to intercept the request.
2750              */
2751             if (1 == sscanf(p->str+12, ": %u", &max_forwards) && max_forwards == 0)
2752             {
2753                /*
2754                 * FIXME: We could handle at least TRACE here,
2755                 * but that would require a verbatim copy of
2756                 * the request which we don't have anymore
2757                 */
2758                 log_error(LOG_LEVEL_HEADER,
2759                   "Detected header \'%s\' in OPTIONS or TRACE request. Returning 501.",
2760                   p->str);
2761
2762                /* Get mem for response or fail*/
2763                if (NULL == (rsp = alloc_http_response()))
2764                {
2765                   return cgi_error_memory();
2766                }
2767
2768                rsp->status = strdup_or_die("501 Not Implemented");
2769                rsp->is_static = 1;
2770                rsp->crunch_reason = UNSUPPORTED;
2771
2772                return(finish_http_response(csp, rsp));
2773             }
2774          }
2775       }
2776    }
2777    return NULL;
2778 }
2779
2780
2781 /*********************************************************************
2782  *
2783  * Function    :  content_requires_filtering
2784  *
2785  * Description :  Checks whether there are any content filters
2786  *                enabled for the current request and if they
2787  *                can actually be applied..
2788  *
2789  * Parameters  :
2790  *          1  :  csp = Current client state (buffers, headers, etc...)
2791  *
2792  * Returns     :  TRUE for yes, FALSE otherwise
2793  *
2794  *********************************************************************/
2795 int content_requires_filtering(struct client_state *csp)
2796 {
2797    if ((csp->content_type & CT_TABOO)
2798       && !(csp->action->flags & ACTION_FORCE_TEXT_MODE))
2799    {
2800       return FALSE;
2801    }
2802
2803    /*
2804     * Are we enabling text mode by force?
2805     */
2806    if (csp->action->flags & ACTION_FORCE_TEXT_MODE)
2807    {
2808       /*
2809        * Do we really have to?
2810        */
2811       if (csp->content_type & CT_TEXT)
2812       {
2813          log_error(LOG_LEVEL_HEADER, "Text mode is already enabled.");
2814       }
2815       else
2816       {
2817          csp->content_type |= CT_TEXT;
2818          log_error(LOG_LEVEL_HEADER, "Text mode enabled by force. Take cover!");
2819       }
2820    }
2821
2822    if (!(csp->content_type & CT_DECLARED))
2823    {
2824       /*
2825        * The server didn't bother to declare a MIME-Type.
2826        * Assume it's text that can be filtered.
2827        *
2828        * This also regularly happens with 304 responses,
2829        * therefore logging anything here would cause
2830        * too much noise.
2831        */
2832       csp->content_type |= CT_TEXT;
2833    }
2834
2835    /*
2836     * Choose the applying filter function based on
2837     * the content type and action settings.
2838     */
2839    if ((csp->content_type & CT_TEXT) &&
2840        (!list_is_empty(csp->action->multi[ACTION_MULTI_FILTER]) ||
2841         !list_is_empty(csp->action->multi[ACTION_MULTI_EXTERNAL_FILTER])))
2842    {
2843       return TRUE;
2844    }
2845    else if ((csp->content_type & CT_GIF)  &&
2846             (csp->action->flags & ACTION_DEANIMATE))
2847    {
2848       return TRUE;
2849    }
2850
2851    return FALSE;
2852
2853 }
2854
2855
2856 /*********************************************************************
2857  *
2858  * Function    :  content_filters_enabled
2859  *
2860  * Description :  Checks whether there are any content filters
2861  *                enabled for the current request.
2862  *
2863  * Parameters  :
2864  *          1  :  action = Action spec to check.
2865  *
2866  * Returns     :  TRUE for yes, FALSE otherwise
2867  *
2868  *********************************************************************/
2869 int content_filters_enabled(const struct current_action_spec *action)
2870 {
2871    return ((action->flags & ACTION_DEANIMATE) ||
2872       !list_is_empty(action->multi[ACTION_MULTI_FILTER]) ||
2873       !list_is_empty(action->multi[ACTION_MULTI_EXTERNAL_FILTER]));
2874 }
2875
2876
2877 /*********************************************************************
2878  *
2879  * Function    :  client_body_filters_enabled
2880  *
2881  * Description :  Checks whether there are any client body filters
2882  *                enabled for the current request.
2883  *
2884  * Parameters  :
2885  *          1  :  action = Action spec to check.
2886  *
2887  * Returns     :  TRUE for yes, FALSE otherwise
2888  *
2889  *********************************************************************/
2890 int client_body_filters_enabled(const struct current_action_spec *action)
2891 {
2892    return !list_is_empty(action->multi[ACTION_MULTI_CLIENT_BODY_FILTER]);
2893 }
2894
2895
2896 /*********************************************************************
2897  *
2898  * Function    :  filters_available
2899  *
2900  * Description :  Checks whether there are any filters available.
2901  *
2902  * Parameters  :
2903  *          1  :  csp = Current client state (buffers, headers, etc...)
2904  *
2905  * Returns     :  TRUE for yes, FALSE otherwise.
2906  *
2907  *********************************************************************/
2908 int filters_available(const struct client_state *csp)
2909 {
2910    int i;
2911    for (i = 0; i < MAX_AF_FILES; i++)
2912    {
2913       const struct file_list *fl = csp->rlist[i];
2914       if ((NULL != fl) && (NULL != fl->f))
2915       {
2916          return TRUE;
2917       }
2918    }
2919    return FALSE;
2920 }
2921
2922 #ifdef FEATURE_EXTENDED_STATISTICS
2923
2924 struct filter_statistics_entry
2925 {
2926    char *filter;
2927    unsigned long long executions;
2928    unsigned long long response_bodies_modified;
2929    unsigned long long hits;
2930
2931    struct filter_statistics_entry *next;
2932 };
2933
2934 static struct filter_statistics_entry *filter_statistics = NULL;
2935
2936
2937 /*********************************************************************
2938  *
2939  * Function    :  register_filter_for_statistics
2940  *
2941  * Description :  Registers a filter so we can gather statistics for
2942  *                it unless the filter has already been registered
2943  *                before.
2944  *
2945  * Parameters  :
2946  *          1  :  filter = Name of the filter to register
2947  *
2948  * Returns     :  void
2949  *
2950  *********************************************************************/
2951 void register_filter_for_statistics(const char *filter)
2952 {
2953    struct filter_statistics_entry *entry;
2954
2955    privoxy_mutex_lock(&filter_statistics_mutex);
2956
2957    if (filter_statistics == NULL)
2958    {
2959       filter_statistics = zalloc_or_die(sizeof(struct filter_statistics_entry));
2960       entry = filter_statistics;
2961       entry->filter = strdup_or_die(filter);
2962       privoxy_mutex_unlock(&filter_statistics_mutex);
2963       return;
2964    }
2965    entry = filter_statistics;
2966    while (entry != NULL)
2967    {
2968       if (!strcmp(entry->filter, filter))
2969       {
2970          /* Already registered, nothing to do. */
2971          break;
2972       }
2973       if (entry->next == NULL)
2974       {
2975          entry->next = zalloc_or_die(sizeof(struct filter_statistics_entry));
2976          entry->next->filter = strdup_or_die(filter);
2977          break;
2978       }
2979       entry = entry->next;
2980    }
2981
2982    privoxy_mutex_unlock(&filter_statistics_mutex);
2983
2984 }
2985
2986
2987 /*********************************************************************
2988  *
2989  * Function    :  update_filter_statistics
2990  *
2991  * Description :  Updates the statistics for a filter.
2992  *
2993  * Parameters  :
2994  *          1  :  filter = Name of the filter to update
2995  *          2  :  hits = Hit count.
2996  *
2997  * Returns     :  void
2998  *
2999  *********************************************************************/
3000 void update_filter_statistics(const char *filter, int hits)
3001 {
3002    struct filter_statistics_entry *entry;
3003
3004    privoxy_mutex_lock(&filter_statistics_mutex);
3005
3006    entry = filter_statistics;
3007    while (entry != NULL)
3008    {
3009       if (!strcmp(entry->filter, filter))
3010       {
3011          entry->executions++;
3012          if (hits != 0)
3013          {
3014             entry->response_bodies_modified++;
3015             entry->hits += (unsigned)hits;
3016          }
3017          break;
3018       }
3019       entry = entry->next;
3020    }
3021
3022    privoxy_mutex_unlock(&filter_statistics_mutex);
3023
3024 }
3025
3026
3027 /*********************************************************************
3028  *
3029  * Function    :  get_filter_statistics
3030  *
3031  * Description :  Gets the statistics for a filter.
3032  *
3033  * Parameters  :
3034  *          1  :  filter = Name of the filter to get statistics for.
3035  *          2  :  executions = Storage for the execution count.
3036  *          3  :  response_bodies_modified = Storage for the number
3037  *                of modified response bodies.
3038  *          4  :  hits = Storage for the number of hits.
3039  *
3040  * Returns     :  void
3041  *
3042  *********************************************************************/
3043 void get_filter_statistics(const char *filter, unsigned long long *executions,
3044                            unsigned long long *response_bodies_modified,
3045                            unsigned long long *hits)
3046 {
3047    struct filter_statistics_entry *entry;
3048
3049    privoxy_mutex_lock(&filter_statistics_mutex);
3050
3051    entry = filter_statistics;
3052    while (entry != NULL)
3053    {
3054       if (!strcmp(entry->filter, filter))
3055       {
3056          *executions = entry->executions;
3057          *response_bodies_modified = entry->response_bodies_modified;
3058          *hits = entry->hits;
3059          break;
3060       }
3061       entry = entry->next;
3062    }
3063
3064    privoxy_mutex_unlock(&filter_statistics_mutex);
3065
3066 }
3067
3068
3069 struct block_statistics_entry
3070 {
3071    char *block_reason;
3072    unsigned long long count;
3073
3074    struct block_statistics_entry *next;
3075 };
3076
3077 static struct block_statistics_entry *block_statistics = NULL;
3078
3079 /*********************************************************************
3080  *
3081  * Function    :  register_block_reason_for_statistics
3082  *
3083  * Description :  Registers a block reason so we can gather statistics
3084  *                for it unless the block reason has already been
3085  *                registered before.
3086  *
3087  * Parameters  :
3088  *          1  :  block_reason = Block reason to register
3089  *
3090  * Returns     :  void
3091  *
3092  *********************************************************************/
3093 void register_block_reason_for_statistics(const char *block_reason)
3094 {
3095    struct block_statistics_entry *entry;
3096
3097    privoxy_mutex_lock(&block_statistics_mutex);
3098
3099    if (block_statistics == NULL)
3100    {
3101       block_statistics = zalloc_or_die(sizeof(struct block_statistics_entry));
3102       entry = block_statistics;
3103       entry->block_reason = strdup_or_die(block_reason);
3104       privoxy_mutex_unlock(&block_statistics_mutex);
3105       return;
3106    }
3107    entry = block_statistics;
3108    while (entry != NULL)
3109    {
3110       if (!strcmp(entry->block_reason, block_reason))
3111       {
3112          /* Already registered, nothing to do. */
3113          break;
3114       }
3115       if (entry->next == NULL)
3116       {
3117          entry->next = zalloc_or_die(sizeof(struct block_statistics_entry));
3118          entry->next->block_reason = strdup_or_die(block_reason);
3119          break;
3120       }
3121       entry = entry->next;
3122    }
3123
3124    privoxy_mutex_unlock(&block_statistics_mutex);
3125
3126 }
3127
3128
3129 /*********************************************************************
3130  *
3131  * Function    :  increment_block_reason_counter
3132  *
3133  * Description :  Updates the counter for a block reason.
3134  *
3135  * Parameters  :
3136  *          1  :  block_reason = Block reason to count
3137  *
3138  * Returns     :  void
3139  *
3140  *********************************************************************/
3141 static void increment_block_reason_counter(const char *block_reason)
3142 {
3143    struct block_statistics_entry *entry;
3144
3145    privoxy_mutex_lock(&block_statistics_mutex);
3146
3147    entry = block_statistics;
3148    while (entry != NULL)
3149    {
3150       if (!strcmp(entry->block_reason, block_reason))
3151       {
3152          entry->count++;
3153          break;
3154       }
3155       entry = entry->next;
3156    }
3157
3158    privoxy_mutex_unlock(&block_statistics_mutex);
3159
3160 }
3161
3162
3163 /*********************************************************************
3164  *
3165  * Function    :  get_block_reason_count
3166  *
3167  * Description :  Gets number of times a block reason was used.
3168  *
3169  * Parameters  :
3170  *          1  :  block_reason = Block reason to get statistics for.
3171  *          2  :  count = Storage for the number of times the block
3172  *                        reason was used.
3173  *
3174  * Returns     :  void
3175  *
3176  *********************************************************************/
3177 void get_block_reason_count(const char *block_reason, unsigned long long *count)
3178 {
3179    struct block_statistics_entry *entry;
3180
3181    privoxy_mutex_lock(&block_statistics_mutex);
3182
3183    entry = block_statistics;
3184    while (entry != NULL)
3185    {
3186       if (!strcmp(entry->block_reason, block_reason))
3187       {
3188          *count = entry->count;
3189          break;
3190       }
3191       entry = entry->next;
3192    }
3193
3194    privoxy_mutex_unlock(&block_statistics_mutex);
3195
3196 }
3197
3198 #endif /* def FEATURE_EXTENDED_STATISTICS */
3199
3200 /*
3201   Local Variables:
3202   tab-width: 3
3203   end:
3204 */