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