project.h

   1 #ifndef PROJECT_H_INCLUDED
   2 #define PROJECT_H_INCLUDED
   3 /*********************************************************************
   4  *
   5  * File        :  $Source: /cvsroot/ijbswa/current/project.h,v $
   6  *
   7  * Purpose     :  Defines data structures which are widely used in the
   8  *                project.  Does not define any variables or functions
   9  *                (though it does declare some macros).
  10  *
  11  * Copyright   :  Written by and Copyright (C) 2001-2021 the
  12  *                Privoxy team. https://www.privoxy.org/
  13  *
  14  *                Based on the Internet Junkbuster originally written
  15  *                by and Copyright (C) 1997 Anonymous Coders and
  16  *                Junkbusters Corporation.  http://www.junkbusters.com
  17  *
  18  *                This program is free software; you can redistribute it
  19  *                and/or modify it under the terms of the GNU General
  20  *                Public License as published by the Free Software
  21  *                Foundation; either version 2 of the License, or (at
  22  *                your option) any later version.
  23  *
  24  *                This program is distributed in the hope that it will
  25  *                be useful, but WITHOUT ANY WARRANTY; without even the
  26  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  27  *                PARTICULAR PURPOSE.  See the GNU General Public
  28  *                License for more details.
  29  *
  30  *                The GNU General Public License should be included with
  31  *                this file.  If not, you can view it at
  32  *                http://www.gnu.org/copyleft/gpl.html
  33  *                or write to the Free Software Foundation, Inc., 59
  34  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  35  *
  36  *********************************************************************/
  37
  38
  39 /* Declare struct FILE for vars and funcs. */
  40 #include <stdio.h>
  41
  42 /* Need time_t for file_list */
  43 #include <time.h>
  44 /* Needed for pcre choice */
  45 #include "config.h"
  46
  47 #ifdef FEATURE_HTTPS_INSPECTION
  48 /*
  49 * Macros for SSL structures
  50 */
  51 #define CERT_INFO_BUF_SIZE         4096
  52 #define ISSUER_NAME_BUF_SIZE       2048
  53 #define HASH_OF_HOST_BUF_SIZE      16
  54 #endif /* FEATURE_HTTPS_INSPECTION */
  55
  56 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
  57 #include "mbedtls/net_sockets.h"
  58 #include "mbedtls/entropy.h"
  59 #include "mbedtls/ctr_drbg.h"
  60
  61 #if defined(MBEDTLS_SSL_CACHE_C)
  62 #include "mbedtls/ssl_cache.h"
  63 #endif
  64 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
  65
  66 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
  67 #ifdef _WIN32
  68 #include <wincrypt.h>
  69 #undef X509_NAME
  70 #undef X509_EXTENSIONS
  71 #endif
  72 #include <openssl/ssl.h>
  73 #include <openssl/bio.h>
  74 #include <openssl/err.h>
  75 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
  76
  77 /* Need for struct sockaddr_storage */
  78 #ifdef HAVE_RFC2553
  79 #  ifndef _WIN32
  80 #    include <netdb.h>
  81 #    include <sys/socket.h>
  82 #  else
  83 #    include <stdint.h>
  84 #    include <ws2tcpip.h>
  85      typedef unsigned short in_port_t;
  86 #  endif
  87 #endif
  88
  89
  90 /*
  91  * Include appropriate regular expression libraries.
  92  * Note that pcrs and pcre (native) are needed for cgi
  93  * and are included anyway.
  94  */
  95
  96 #ifdef STATIC_PCRE
  97 #ifdef HAVE_PCRE2
  98 #  include "pcre2.h"
  99 #  include "pcre2posix.h"
 100 #else
 101 #  include "pcre.h"
 102 #  include "pcreposix.h"
 103 #endif
 104 #else
 105 #  ifdef HAVE_PCRE2
 106 #    ifdef PCRE2_H_IN_SUBDIR
 107 #      define PCRE2_CODE_UNIT_WIDTH 8
 108 #      include <pcre2/pcre2.h>
 109 #    else
 110 #      define PCRE2_CODE_UNIT_WIDTH 8
 111 #      include <pcre2.h>
 112 #    endif
 113 #    ifdef PCRE2POSIX_H_IN_SUBDIR
 114 #        include <pcre2/pcre2posix.h>
 115 #    else
 116 #        include <pcre2posix.h>
 117 #    endif
 118 #  else
 119 #    ifdef PCRE_H_IN_SUBDIR
 120 #      include <pcre/pcre.h>
 121 #    else
 122 #      include <pcre.h>
 123 #    endif
 124 #    ifdef PCREPOSIX_H_IN_SUBDIR
 125 #        include <pcre/pcreposix.h>
 126 #    else
 127 #        include <pcreposix.h>
 128 #    endif
 129 #  endif
 130 #endif
 131
 132 #ifdef STATIC_PCRS
 133 #  include "pcrs.h"
 134 #else
 135 #  include <pcrs.h>
 136 #endif
 137
 138 #ifdef _WIN32
 139 /*
 140  * I don't want to have to #include all this just for the declaration
 141  * of SOCKET.  However, it looks like we have to...
 142  */
 143 #ifndef STRICT
 144 #define STRICT
 145 #endif
 146 #include <windows.h>
 147 #endif
 148
 149
 150 #ifdef _WIN32
 151
 152 typedef SOCKET jb_socket;
 153
 154 #define JB_INVALID_SOCKET INVALID_SOCKET
 155
 156 #else /* ndef _WIN32 */
 157
 158 /**
 159  * The type used by sockets.  On UNIX it's an int.  Microsoft decided to
 160  * make it an unsigned.
 161  */
 162 typedef int jb_socket;
 163
 164 /**
 165  * The error value used for variables of type jb_socket.  On UNIX this
 166  * is -1, however Microsoft decided to make socket handles unsigned, so
 167  * they use a different value.
 168  */
 169
 170 #define JB_INVALID_SOCKET (-1)
 171
 172 #endif /* ndef _WIN32 */
 173
 174
 175 /**
 176  * A standard error code.  This should be JB_ERR_OK or one of the JB_ERR_xxx
 177  * series of errors.
 178  */
 179 enum privoxy_err
 180 {
 181    JB_ERR_OK         = 0, /**< Success, no error                        */
 182    JB_ERR_MEMORY     = 1, /**< Out of memory                            */
 183    JB_ERR_CGI_PARAMS = 2, /**< Missing or corrupt CGI parameters        */
 184    JB_ERR_FILE       = 3, /**< Error opening, reading or writing a file */
 185    JB_ERR_PARSE      = 4, /**< Error parsing file                       */
 186    JB_ERR_MODIFIED   = 5, /**< File has been modified outside of the
 187                                CGI actions editor.                      */
 188    JB_ERR_COMPRESS   = 6  /**< Error on decompression                   */
 189 };
 190
 191 typedef enum privoxy_err jb_err;
 192
 193 /**
 194  * This macro is used to free a pointer that may be NULL.
 195  * It also sets the variable to NULL after it's been freed.
 196  * The parameter should be a simple variable without side effects.
 197  */
 198 #define freez(X)  { if(X) { free((void*)X); X = NULL ; } }
 199
 200
 201 /**
 202  * Macro definitions for platforms where isspace() and friends
 203  * are macros that use their argument directly as an array index
 204  * and thus better be positive. Supposedly that's the case on
 205  * some unspecified Solaris versions.
 206  * Note: Remember to #include <ctype.h> if you use these macros.
 207  */
 208 #define privoxy_isdigit(__X) isdigit((int)(unsigned char)(__X))
 209 #define privoxy_isupper(__X) isupper((int)(unsigned char)(__X))
 210 #define privoxy_toupper(__X) toupper((int)(unsigned char)(__X))
 211 #define privoxy_tolower(__X) tolower((int)(unsigned char)(__X))
 212 #define privoxy_isspace(__X) isspace((int)(unsigned char)(__X))
 213
 214 /**
 215  * Use for statically allocated buffers if you have no other choice.
 216  * Remember to check the length of what you write into the buffer
 217  * - we don't want any buffer overflows!
 218  */
 219 #define BUFFER_SIZE 5000
 220
 221 /**
 222  * Max length of CGI parameters (arbitrary limit).
 223  */
 224 #define CGI_PARAM_LEN_MAX 500U
 225
 226 /**
 227  * Buffer size for capturing struct hostent data in the
 228  * gethostby(name|addr)_r library calls. Since we don't
 229  * loop over gethostbyname_r, the buffer must be sufficient
 230  * to accommodate multiple IN A RRs, as used in DNS round robin
 231  * load balancing. W3C's wwwlib uses 1K, so that should be
 232  * good enough for us, too.
 233  */
 234 /**
 235  * XXX: Temporary doubled, for some configurations
 236  * 1K is still too small and we didn't get the
 237  * real fix ready for inclusion.
 238  */
 239 #define HOSTENT_BUFFER_SIZE 2048
 240
 241 /**
 242  * Default TCP/IP address to listen on, as a string.
 243  * Set to "127.0.0.1:8118".
 244  */
 245 #define HADDR_DEFAULT   "127.0.0.1:8118"
 246
 247
 248 /* Forward def for struct client_state */
 249 struct configuration_spec;
 250
 251
 252 /**
 253  * Entry in a linked list of strings.
 254  */
 255 struct list_entry
 256 {
 257    /**
 258     * The string pointer. It must point to a dynamically malloc()ed
 259     * string or be NULL for the list functions to work. In the latter
 260     * case, just be careful next time you iterate through the list in
 261     * your own code.
 262     */
 263    char *str;
 264
 265    /** Next entry in the linked list, or NULL if no more. */
 266    struct list_entry *next;
 267 };
 268
 269 /**
 270  * A header for a linked list of strings.
 271  */
 272 struct list
 273 {
 274    /** First entry in the list, or NULL if the list is empty. */
 275    struct list_entry *first;
 276
 277    /** Last entry in the list, or NULL if the list is empty. */
 278    struct list_entry *last;
 279 };
 280
 281
 282 /**
 283  * An entry in a map.  This is a name=value pair.
 284  */
 285 struct map_entry
 286 {
 287    /** The key for the map. */
 288    const char *name;
 289    /** The value associated with that key. */
 290    const char *value;
 291    /** The next map entry, or NULL if none. */
 292    struct map_entry *next;
 293 };
 294
 295 /**
 296  * A map from a string to another string.
 297  * This is used for the parameters passed in a HTTP GET request, and
 298  * to store the exports when the CGI interface is filling in a template.
 299  */
 300 struct map
 301 {
 302    /** The first map entry, or NULL if the map is empty. */
 303    struct map_entry *first;
 304    /** The last map entry, or NULL if the map is empty. */
 305    struct map_entry *last;
 306 };
 307
 308 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
 309 /*
 310  * Struct of attributes necessary for TLS/SSL connection
 311  */
 312 typedef struct {
 313    mbedtls_ssl_context      ssl;
 314    mbedtls_ssl_config       conf;
 315    mbedtls_net_context      socket_fd;
 316    mbedtls_x509_crt         server_cert;
 317    mbedtls_x509_crt         ca_cert;
 318    mbedtls_pk_context       prim_key;
 319    int                     *ciphersuites_list;
 320
 321    #if defined(MBEDTLS_SSL_CACHE_C)
 322       mbedtls_ssl_cache_context cache;
 323    #endif
 324 } mbedtls_connection_attr;
 325 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
 326
 327 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
 328 /*
 329  * Struct of attributes necessary for TLS/SSL connection
 330  */
 331 typedef struct {
 332    SSL_CTX *ctx;
 333    BIO *bio;
 334 } openssl_connection_attr;
 335 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
 336 /**
 337  * A HTTP request.  This includes the method (GET, POST) and
 338  * the parsed URL.
 339  *
 340  * This is also used whenever we want to match a URL against a
 341  * URL pattern.  This always contains the URL to match, and never
 342  * a URL pattern.  (See struct url_spec).
 343  */
 344 struct http_request
 345 {
 346    char *cmd;      /**< Whole command line: method, URL, Version */
 347    char *ocmd;     /**< Backup of original cmd for CLF logging */
 348    char *gpc;      /**< HTTP method: GET, POST, ... */
 349    char *url;      /**< The URL */
 350    char *version;  /**< Protocol version */
 351    int status;     /**< HTTP Status */
 352
 353    int   port;     /**< Port of URL or 80 (default) */
 354    char *host;     /**< Host part of URL */
 355    char *path;     /**< Path of URL */
 356    char *hostport; /**< host[:port] */
 357
 358    char *host_ip_addr_str; /**< String with dotted decimal representation
 359                                 of host's IP. NULL before connect_to() */
 360
 361    char  *dbuffer; /**< Buffer with '\0'-delimited domain name.           */
 362    char **dvec;    /**< List of pointers to the strings in dbuffer.       */
 363    int    dcount;  /**< How many parts to this domain? (length of dvec)   */
 364
 365 #ifdef FEATURE_HTTPS_INSPECTION
 366    int client_ssl;                                                  /**< Flag if we should communicate with client over ssl   */
 367    int server_ssl;                                                  /**< Flag if we should communicate with server over ssl   */
 368    unsigned char hash_of_host_hex[(HASH_OF_HOST_BUF_SIZE * 2) + 1]; /**< chars for hash in hex string and one for '\0'       */
 369    unsigned char hash_of_host[HASH_OF_HOST_BUF_SIZE+1];             /**< chars for bytes of hash and one for '\0'            */
 370 #endif
 371    short int   ssl;      /**< Flag if protocol is https */
 372 };
 373
 374
 375 #ifdef FEATURE_HTTPS_INSPECTION
 376 /*
 377  * Struct for linked list containing certificates
 378  */
 379 typedef struct certs_chain {
 380    char info_buf[CERT_INFO_BUF_SIZE];    /* text info about properties of certificate               */
 381    char *file_buf;                       /* buffer for whole certificate - format to save in file   */
 382    struct certs_chain *next;             /* next certificate in chain of trust                      */
 383 } certs_chain_t;
 384 #endif
 385
 386 /**
 387  * Reasons for generating a http_response instead of delivering
 388  * the requested resource. Mostly ordered the way they are checked
 389  * for in chat().
 390  */
 391 enum crunch_reason
 392 {
 393    UNSUPPORTED,
 394    BLOCKED,
 395    UNTRUSTED,
 396    REDIRECTED,
 397    CGI_CALL,
 398    NO_SUCH_DOMAIN,
 399    FORWARDING_FAILED,
 400    CONNECT_FAILED,
 401    OUT_OF_MEMORY,
 402    INTERNAL_ERROR,
 403    CONNECTION_TIMEOUT,
 404    NO_SERVER_DATA
 405 };
 406
 407 /**
 408  * Response generated by CGI, blocker, or error handler
 409  */
 410 struct http_response
 411 {
 412   char  *status;                    /**< HTTP status (string). */
 413   struct list headers[1];           /**< List of header lines. */
 414   char  *head;                      /**< Formatted http response head. */
 415   size_t head_length;               /**< Length of http response head. */
 416   char  *body;                      /**< HTTP document body. */
 417   size_t content_length;            /**< Length of body, REQUIRED if binary body. */
 418   int    is_static;                 /**< Nonzero if the content will never change and
 419                                          should be cached by the browser (e.g. images). */
 420   enum crunch_reason crunch_reason; /**< Why the response was generated in the first place. */
 421 };
 422
 423 #ifdef HAVE_PCRE2
 424 #define REGEX_TYPE pcre2_code
 425 #else
 426 #define REGEX_TYPE regex_t
 427 #endif
 428
 429 struct url_spec
 430 {
 431 #ifdef FEATURE_PCRE_HOST_PATTERNS
 432    REGEX_TYPE *host_regex;/**< Regex for host matching                          */
 433    enum host_regex_type { VANILLA_HOST_PATTERN, PCRE_HOST_PATTERN } host_regex_type;
 434 #endif /* defined FEATURE_PCRE_HOST_PATTERNS */
 435    int    dcount;      /**< How many parts to this domain? (length of dvec)   */
 436    char  *dbuffer;     /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
 437    char **dvec;        /**< List of pointers to the strings in dbuffer.       */
 438    int    unanchored;  /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT.  */
 439
 440    char  *port_list;   /**< List of acceptable ports, or NULL to match all ports */
 441
 442   REGEX_TYPE *preg;    /**< Regex for matching path part                      */
 443 };
 444
 445 /**
 446  * A URL or a tag pattern.
 447  */
 448 struct pattern_spec
 449 {
 450    /** The string which was parsed to produce this pattern_spec.
 451        Used for debugging or display only.  */
 452    char  *spec;
 453
 454    union
 455    {
 456       struct url_spec url_spec;
 457       REGEX_TYPE *tag_regex;
 458    } pattern;
 459
 460    unsigned int flags; /**< Bitmap with various pattern properties. */
 461 };
 462
 463 /**
 464  * Constant for host part matching in URLs.  If set, indicates that the start of
 465  * the pattern must match the start of the URL.  E.g. this is not set for the
 466  * pattern ".example.com", so that it will match both "example.com" and
 467  * "www.example.com".  It is set for the pattern "example.com", which makes it
 468  * match "example.com" only, not "www.example.com".
 469  */
 470 #define ANCHOR_LEFT  1
 471
 472 /**
 473  * Constant for host part matching in URLs.  If set, indicates that the end of
 474  * the pattern must match the end of the URL.  E.g. this is not set for the
 475  * pattern "ad.", so that it will match any host called "ad", irrespective
 476  * of how many subdomains are in the fully-qualified domain name.
 477  */
 478 #define ANCHOR_RIGHT 2
 479
 480 /** Pattern spec bitmap: It's an URL pattern. */
 481 #define PATTERN_SPEC_URL_PATTERN          0x00000001UL
 482
 483 /** Pattern spec bitmap: It's a TAG pattern. */
 484 #define PATTERN_SPEC_TAG_PATTERN          0x00000002UL
 485
 486 /** Pattern spec bitmap: It's a NO-REQUEST-TAG pattern. */
 487 #define PATTERN_SPEC_NO_REQUEST_TAG_PATTERN 0x00000004UL
 488
 489 /** Pattern spec bitmap: It's a NO-RESPONSE-TAG pattern. */
 490 #define PATTERN_SPEC_NO_RESPONSE_TAG_PATTERN 0x00000008UL
 491
 492 /** Pattern spec bitmap: It's a CLIENT-TAG pattern. */
 493 #define PATTERN_SPEC_CLIENT_TAG_PATTERN      0x00000010UL
 494
 495 /**
 496  * An I/O buffer.  Holds a string which can be appended to, and can have data
 497  * removed from the beginning.
 498  */
 499 struct iob
 500 {
 501    char *buf;    /**< Start of buffer        */
 502    char *cur;    /**< Start of relevant data */
 503    char *eod;    /**< End of relevant data   */
 504    size_t size;  /**< Size as malloc()ed     */
 505 };
 506
 507
 508 /* Bits for csp->content_type bitmask: */
 509 #define CT_TEXT    0x0001U /**< Suitable for pcrs filtering. */
 510 #define CT_GIF     0x0002U /**< Suitable for GIF filtering.  */
 511 #define CT_TABOO   0x0004U /**< DO NOT filter, irrespective of other flags. */
 512
 513 /* Although these are not, strictly speaking, content types
 514  * (they are content encodings), it is simple to handle them
 515  * as such.
 516  */
 517 #define CT_GZIP    0x0010U /**< gzip-compressed data. */
 518 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
 519 #define CT_BROTLI  0x0040U /**< Brotli-compressed data. */
 520
 521 /**
 522  * Flag to signal that the server declared the content type,
 523  * so we can differentiate between unknown and undeclared
 524  * content types.
 525  */
 526 #define CT_DECLARED 0x0080U
 527
 528 /**
 529  * The mask which includes all actions.
 530  */
 531 #define ACTION_MASK_ALL        (~0UL)
 532
 533 /**
 534  * The most compatible set of actions - i.e. none.
 535  */
 536 #define ACTION_MOST_COMPATIBLE                       0x00000000UL
 537
 538 /** Action bitmap: Block the request. */
 539 #define ACTION_BLOCK                                 0x00000001UL
 540 /** Action bitmap: Deanimate if it's a GIF. */
 541 #define ACTION_DEANIMATE                             0x00000002UL
 542 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
 543 #define ACTION_DOWNGRADE                             0x00000004UL
 544 /** Action bitmap: Fast redirects. */
 545 #define ACTION_FAST_REDIRECTS                        0x00000008UL
 546 /** Action bitmap: Remove or add "X-Forwarded-For" header. */
 547 #define ACTION_CHANGE_X_FORWARDED_FOR                0x00000010UL
 548 /** Action bitmap: Hide "From" header. */
 549 #define ACTION_HIDE_FROM                             0x00000020UL
 550 /** Action bitmap: Hide "Referer" header.  (sic - follow HTTP, not English). */
 551 #define ACTION_HIDE_REFERER                          0x00000040UL
 552 /** Action bitmap: Hide "User-Agent" and similar headers. */
 553 #define ACTION_HIDE_USER_AGENT                       0x00000080UL
 554 /** Action bitmap: This is an image. */
 555 #define ACTION_IMAGE                                 0x00000100UL
 556 /** Action bitmap: Sets the image blocker. */
 557 #define ACTION_IMAGE_BLOCKER                         0x00000200UL
 558 /** Action bitmap: Prevent compression. */
 559 #define ACTION_NO_COMPRESSION                        0x00000400UL
 560 /** Action bitmap: Change cookies to session only cookies. */
 561 #define ACTION_SESSION_COOKIES_ONLY                  0x00000800UL
 562 /** Action bitmap: Block cookies coming from the client. */
 563 #define ACTION_CRUNCH_OUTGOING_COOKIES               0x00001000UL
 564 /** Action bitmap: Block cookies coming from the server. */
 565 #define ACTION_CRUNCH_INCOMING_COOKIES               0x00002000UL
 566 /** Action bitmap: Override the forward settings in the config file */
 567 #define ACTION_FORWARD_OVERRIDE                      0x00004000UL
 568 /** Action bitmap: Block as empty document */
 569 #define  ACTION_HANDLE_AS_EMPTY_DOCUMENT             0x00008000UL
 570 /** Action bitmap: Limit CONNECT requests to safe ports. */
 571 #define ACTION_LIMIT_CONNECT                         0x00010000UL
 572 /** Action bitmap: Redirect request. */
 573 #define  ACTION_REDIRECT                             0x00020000UL
 574 /** Action bitmap: Crunch or modify "if-modified-since" header. */
 575 #define ACTION_HIDE_IF_MODIFIED_SINCE                0x00040000UL
 576 /** Action bitmap: Overwrite Content-Type header. */
 577 #define ACTION_CONTENT_TYPE_OVERWRITE                0x00080000UL
 578 /** Action bitmap: Crunch specified server header. */
 579 #define ACTION_CRUNCH_SERVER_HEADER                  0x00100000UL
 580 /** Action bitmap: Crunch specified client header */
 581 #define ACTION_CRUNCH_CLIENT_HEADER                  0x00200000UL
 582 /** Action bitmap: Enable text mode by force */
 583 #define ACTION_FORCE_TEXT_MODE                       0x00400000UL
 584 /** Action bitmap: Remove the "If-None-Match" header. */
 585 #define ACTION_CRUNCH_IF_NONE_MATCH                  0x00800000UL
 586 /** Action bitmap: Enable content-disposition crunching */
 587 #define ACTION_HIDE_CONTENT_DISPOSITION              0x01000000UL
 588 /** Action bitmap: Replace or block Last-Modified header */
 589 #define ACTION_OVERWRITE_LAST_MODIFIED               0x02000000UL
 590 /** Action bitmap: Replace or block Accept-Language header */
 591 #define ACTION_HIDE_ACCEPT_LANGUAGE                  0x04000000UL
 592 /** Action bitmap: Limit the cookie lifetime */
 593 #define ACTION_LIMIT_COOKIE_LIFETIME                 0x08000000UL
 594 /** Action bitmap: Delay writes */
 595 #define ACTION_DELAY_RESPONSE                        0x10000000UL
 596 /** Action bitmap: Turn https inspection on */
 597 #define ACTION_HTTPS_INSPECTION                      0x20000000UL
 598 /** Action bitmap: Turn certificates verification off */
 599 #define ACTION_IGNORE_CERTIFICATE_ERRORS             0x40000000UL
 600
 601 /** Action string index: How to deanimate GIFs */
 602 #define ACTION_STRING_DEANIMATE             0
 603 /** Action string index: Replacement for "From:" header */
 604 #define ACTION_STRING_FROM                  1
 605 /** Action string index: How to block images */
 606 #define ACTION_STRING_IMAGE_BLOCKER         2
 607 /** Action string index: Replacement for "Referer:" header */
 608 #define ACTION_STRING_REFERER               3
 609 /** Action string index: Replacement for "User-Agent:" header */
 610 #define ACTION_STRING_USER_AGENT            4
 611 /** Action string index: Legal CONNECT ports. */
 612 #define ACTION_STRING_LIMIT_CONNECT         5
 613 /** Action string index: Server headers containing this pattern are crunched*/
 614 #define ACTION_STRING_SERVER_HEADER         6
 615 /** Action string index: Client headers containing this pattern are crunched*/
 616 #define ACTION_STRING_CLIENT_HEADER         7
 617 /** Action string index: Replacement for the "Accept-Language:" header*/
 618 #define ACTION_STRING_LANGUAGE              8
 619 /** Action string index: Replacement for the "Content-Type:" header*/
 620 #define ACTION_STRING_CONTENT_TYPE          9
 621 /** Action string index: Replacement for the "content-disposition:" header*/
 622 #define ACTION_STRING_CONTENT_DISPOSITION  10
 623 /** Action string index: Replacement for the "If-Modified-Since:" header*/
 624 #define ACTION_STRING_IF_MODIFIED_SINCE    11
 625 /** Action string index: Replacement for the "Last-Modified:" header. */
 626 #define ACTION_STRING_LAST_MODIFIED        12
 627 /** Action string index: Redirect URL */
 628 #define ACTION_STRING_REDIRECT             13
 629 /** Action string index: Decode before redirect? */
 630 #define ACTION_STRING_FAST_REDIRECTS       14
 631 /** Action string index: Overriding forward rule. */
 632 #define ACTION_STRING_FORWARD_OVERRIDE     15
 633 /** Action string index: Reason for the block. */
 634 #define ACTION_STRING_BLOCK                16
 635 /** Action string index: what to do with the "X-Forwarded-For" header. */
 636 #define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17
 637 /** Action string index: how many minutes cookies should be valid. */
 638 #define ACTION_STRING_LIMIT_COOKIE_LIFETIME 18
 639 /** Action string index: how many milliseconds writes should be delayed. */
 640 #define ACTION_STRING_DELAY_RESPONSE       19
 641 /** Number of string actions. */
 642 #define ACTION_STRING_COUNT                20
 643
 644
 645 /* To make the ugly hack in sed easier to understand */
 646 #define CHECK_EVERY_HEADER_REMAINING 0
 647
 648
 649 /** Index into current_action_spec::multi[] for headers to add. */
 650 #define ACTION_MULTI_ADD_HEADER              0
 651 /** Index into current_action_spec::multi[] for content filters to apply. */
 652 #define ACTION_MULTI_FILTER                  1
 653 /** Index into current_action_spec::multi[] for server-header filters to apply. */
 654 #define ACTION_MULTI_SERVER_HEADER_FILTER    2
 655 /** Index into current_action_spec::multi[] for client-header filters to apply. */
 656 #define ACTION_MULTI_CLIENT_HEADER_FILTER    3
 657 /** Index into current_action_spec::multi[] for client-header tags to apply. */
 658 #define ACTION_MULTI_CLIENT_HEADER_TAGGER    4
 659 /** Index into current_action_spec::multi[] for server-header tags to apply. */
 660 #define ACTION_MULTI_SERVER_HEADER_TAGGER    5
 661 /** Number of multi-string actions. */
 662 #define ACTION_MULTI_EXTERNAL_FILTER         6
 663 /** Index into current_action_spec::multi[] for tags to suppress. */
 664 #define ACTION_MULTI_SUPPRESS_TAG            7
 665 /** Index into current_action_spec::multi[] for client body filters to apply. */
 666 #define ACTION_MULTI_CLIENT_BODY_FILTER      8
 667 /** Index into current_action_spec::multi[] for client body taggers to apply. */
 668 #define ACTION_MULTI_CLIENT_BODY_TAGGER      9
 669 /** Number of multi-string actions. */
 670 #define ACTION_MULTI_COUNT                  10
 671
 672
 673 /**
 674  * This structure contains a list of actions to apply to a URL.
 675  * It only contains positive instructions - no "-" options.
 676  * It is not used to store the actions list itself, only for
 677  * url_actions() to return the current values.
 678  */
 679 struct current_action_spec
 680 {
 681    /** Actions to apply.  A bit set to "1" means perform the action. */
 682    unsigned long flags;
 683
 684    /**
 685     * Parameters for those actions that require them.
 686     * Each entry is valid if & only if the corresponding entry in "flags" is
 687     * set.
 688     */
 689    char * string[ACTION_STRING_COUNT];
 690
 691    /** Lists of strings for multi-string actions. */
 692    struct list multi[ACTION_MULTI_COUNT][1];
 693 };
 694
 695
 696 /**
 697  * This structure contains a set of changes to actions.
 698  * It can contain both positive and negative instructions.
 699  * It is used to store an entry in the actions list.
 700  */
 701 struct action_spec
 702 {
 703    unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
 704    unsigned long add;  /**< Actions to add.  A bit set to "1" means add action.    */
 705
 706    /**
 707     * Parameters for those actions that require them.
 708     * Each entry is valid if & only if the corresponding entry in "flags" is
 709     * set.
 710     */
 711    char * string[ACTION_STRING_COUNT];
 712
 713    /** Lists of strings to remove, for multi-string actions. */
 714    struct list multi_remove[ACTION_MULTI_COUNT][1];
 715
 716    /** If nonzero, remove *all* strings from the multi-string action. */
 717    int         multi_remove_all[ACTION_MULTI_COUNT];
 718
 719    /** Lists of strings to add, for multi-string actions. */
 720    struct list multi_add[ACTION_MULTI_COUNT][1];
 721 };
 722
 723
 724 /**
 725  * This structure is used to store action files.
 726  *
 727  * It contains an URL or tag pattern, and the changes to
 728  * the actions. It's a linked list and should only be
 729  * free'd through unload_actions_file() unless there's
 730  * only a single entry.
 731  */
 732 struct url_actions
 733 {
 734    struct pattern_spec url[1]; /**< The URL or tag pattern. */
 735
 736    struct action_spec *action; /**< Action settings that might be shared with
 737                                     the list entry before or after the current
 738                                     one and can't be free'd willy nilly. */
 739
 740    struct url_actions *next;   /**< Next action section in file, or NULL. */
 741 };
 742
 743 enum forwarder_type {
 744    /**< Don't use a SOCKS server, forward to a HTTP proxy directly */
 745    SOCKS_NONE =  0,
 746    /**< original SOCKS 4 protocol              */
 747    SOCKS_4    = 40,
 748    /**< SOCKS 4A, DNS resolution is done by the SOCKS server */
 749    SOCKS_4A   = 41,
 750    /**< SOCKS 5 with hostnames, DNS resolution is done by the SOCKS server */
 751    SOCKS_5    = 50,
 752    /**< Like SOCKS5, but uses non-standard Tor extensions (currently only optimistic data) */
 753    SOCKS_5T,
 754    /**<
 755     * Don't use a SOCKS server, forward to the specified webserver.
 756     * The difference to SOCKS_NONE is that a request line without
 757     * full URL is sent.
 758     */
 759    FORWARD_WEBSERVER,
 760 };
 761
 762 /*
 763  * Structure to hold the server socket and the information
 764  * required to make sure we only reuse the connection if
 765  * the host and forwarding settings are the same.
 766  */
 767 struct reusable_connection
 768 {
 769    jb_socket sfd;
 770    int       in_use;
 771    time_t    timestamp; /* XXX: rename? */
 772
 773    time_t    request_sent;
 774    time_t    response_received;
 775
 776    /*
 777     * Number of seconds after which this
 778     * connection will no longer be reused.
 779     */
 780    unsigned int keep_alive_timeout;
 781    /*
 782     * Number of requests that were sent to this connection.
 783     * This is currently only for debugging purposes.
 784     */
 785    unsigned int requests_sent_total;
 786
 787    char *host;
 788    int  port;
 789    enum forwarder_type forwarder_type;
 790    char *forward_host;
 791    int  forward_port;
 792
 793    int  gateway_port;
 794    char *gateway_host;
 795    char *auth_username;
 796    char *auth_password;
 797
 798 };
 799
 800
 801 /*
 802  * Flags for use in csp->flags
 803  */
 804
 805 /**
 806  * Flag for csp->flags: Set if this client is processing data.
 807  * Cleared when the thread associated with this structure dies.
 808  */
 809 #define CSP_FLAG_ACTIVE     0x01U
 810
 811 /**
 812  * Flag for csp->flags: Set if the server's reply is in "chunked"
 813  * transfer encoding
 814  */
 815 #define CSP_FLAG_CHUNKED    0x02U
 816
 817 /**
 818  * Flag for csp->flags: Set if this request was enforced, although it would
 819  * normally have been blocked.
 820  */
 821 #define CSP_FLAG_FORCED     0x04U
 822
 823 /**
 824  * Flag for csp->flags: Set if any modification to the body was done.
 825  */
 826 #define CSP_FLAG_MODIFIED   0x08U
 827
 828 /**
 829  * Flag for csp->flags: Set if request was blocked.
 830  */
 831 #define CSP_FLAG_REJECTED   0x10U
 832
 833 /**
 834  * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
 835  */
 836 #define CSP_FLAG_TOGGLED_ON 0x20U
 837
 838 /**
 839  * Flag for csp->flags: Set if an acceptable Connection header
 840  * has already been set by the client.
 841  */
 842 #define CSP_FLAG_CLIENT_CONNECTION_HEADER_SET  0x00000040U
 843
 844 /**
 845  * Flag for csp->flags: Set if an acceptable Connection header
 846  * has already been set by the server.
 847  */
 848 #define CSP_FLAG_SERVER_CONNECTION_HEADER_SET  0x00000080U
 849
 850 /**
 851  * Flag for csp->flags: Signals header parsers whether they
 852  * are parsing server or client headers.
 853  */
 854 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE    0x00000100U
 855
 856 /**
 857  * Flag for csp->flags: Set if adding the Host: header
 858  * isn't necessary.
 859  */
 860 #define CSP_FLAG_HOST_HEADER_IS_SET            0x00000200U
 861
 862 /**
 863  * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
 864  * XXX: As we now have tags we might as well ditch this.
 865  */
 866 #define CSP_FLAG_NO_FILTERING                  0x00000400U
 867
 868 /**
 869  * Flag for csp->flags: Set the client IP has appended to
 870  * an already existing X-Forwarded-For header in which case
 871  * no new header has to be generated.
 872  */
 873 #define CSP_FLAG_X_FORWARDED_FOR_APPENDED      0x00000800U
 874
 875 /**
 876  * Flag for csp->flags: Set if the server wants to keep
 877  * the connection alive.
 878  */
 879 #define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE  0x00001000U
 880
 881 /**
 882  * Flag for csp->flags: Set if the server specified the
 883  * content length.
 884  */
 885 #define CSP_FLAG_SERVER_CONTENT_LENGTH_SET     0x00002000U
 886
 887 /**
 888  * Flag for csp->flags: Set if we know the content length,
 889  * either because the server set it, or we figured it out
 890  * on our own.
 891  */
 892 #define CSP_FLAG_CONTENT_LENGTH_SET            0x00004000U
 893
 894 /**
 895  * Flag for csp->flags: Set if the client wants to keep
 896  * the connection alive.
 897  */
 898 #define CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE  0x00008000U
 899
 900 /**
 901  * Flag for csp->flags: Set if we think we got the whole
 902  * client request and shouldn't read any additional data
 903  * coming from the client until the current request has
 904  * been dealt with.
 905  */
 906 #define CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ 0x00010000U
 907
 908 /**
 909  * Flag for csp->flags: Set if the server promised us to
 910  * keep the connection open for a known number of seconds.
 911  */
 912 #define CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET  0x00020000U
 913
 914 /**
 915  * Flag for csp->flags: Set if we think we can't reuse
 916  * the server socket. XXX: It's also set after sabotaging
 917  * pipelining attempts which is somewhat inconsistent with
 918  * the name.
 919  */
 920 #define CSP_FLAG_SERVER_SOCKET_TAINTED          0x00040000U
 921
 922 /**
 923  * Flag for csp->flags: Set if the Proxy-Connection header
 924  * is among the server headers.
 925  */
 926 #define CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET 0x00080000U
 927
 928 /**
 929  * Flag for csp->flags: Set if the client reused its connection.
 930  */
 931 #define CSP_FLAG_REUSED_CLIENT_CONNECTION           0x00100000U
 932
 933 /**
 934  * Flag for csp->flags: Set if the supports deflate compression.
 935  */
 936 #define CSP_FLAG_CLIENT_SUPPORTS_DEFLATE            0x00200000U
 937
 938 /**
 939  * Flag for csp->flags: Set if the content has been deflated by Privoxy
 940  */
 941 #define CSP_FLAG_BUFFERED_CONTENT_DEFLATED          0x00400000U
 942
 943 /**
 944  * Flag for csp->flags: Set if we already read (parts of)
 945  * a pipelined request in which case the client obviously
 946  * isn't done talking.
 947  */
 948 #define CSP_FLAG_PIPELINED_REQUEST_WAITING          0x00800000U
 949
 950 /**
 951  * Flag for csp->flags: Set if the client body is chunk-encoded
 952  */
 953 #define CSP_FLAG_CHUNKED_CLIENT_BODY                0x01000000U
 954
 955 /**
 956  * Flag for csp->flags: Set if the client set the Expect header
 957  */
 958 #define CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION     0x02000000U
 959
 960 /**
 961  * Flag for csp->flags: Set if we answered the request ourselves.
 962  */
 963 #define CSP_FLAG_CRUNCHED                           0x04000000U
 964
 965 #ifdef FUZZ
 966 /**
 967  * Flag for csp->flags: Set if we are working with fuzzed input
 968  */
 969 #define CSP_FLAG_FUZZED_INPUT                       0x08000000U
 970 #endif
 971
 972 /*
 973  * Flags for use in return codes of child processes
 974  */
 975
 976 /**
 977  * Flag for process return code: Set if exiting process has been toggled
 978  * during its lifetime.
 979  */
 980 #define RC_FLAG_TOGGLED   0x10
 981
 982 /**
 983  * Flag for process return code: Set if exiting process has blocked its
 984  * request.
 985  */
 986 #define RC_FLAG_BLOCKED   0x20
 987
 988 /**
 989  * Maximum number of actions/filter files.  This limit is arbitrary - it's just used
 990  * to size an array.
 991  */
 992 #define MAX_AF_FILES 100
 993
 994 /**
 995  * Maximum number of sockets to listen to.  This limit is arbitrary - it's just used
 996  * to size an array.
 997  */
 998 #define MAX_LISTENING_SOCKETS 10
 999
1000 struct ssl_attr {
1001 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
1002    mbedtls_connection_attr  mbedtls_attr; /* Mbed TLS attrs*/
1003 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
1004 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
1005    openssl_connection_attr  openssl_attr; /* OpenSSL atrrs */
1006 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
1007 };
1008 /**
1009  * The state of a Privoxy processing thread.
1010  */
1011 struct client_state
1012 {
1013    /** The proxy's configuration */
1014    struct configuration_spec * config;
1015
1016    /** The actions to perform on the current request */
1017    struct current_action_spec  action[1];
1018
1019    /** socket to talk to client (web browser) */
1020    jb_socket cfd;
1021
1022    /** Number of requests received on the client socket. */
1023    unsigned int requests_received_total;
1024
1025    /** current connection to the server (may go through a proxy) */
1026    struct reusable_connection server_connection;
1027
1028    /** Multi-purpose flag container, see CSP_FLAG_* above */
1029    unsigned int flags;
1030
1031    /** MIME-Type key, see CT_* above */
1032    unsigned int content_type;
1033
1034    /** Client PC's IP address, as reported by the accept() function.
1035        As a string. */
1036    char *ip_addr_str;
1037 #ifdef HAVE_RFC2553
1038    /** Client PC's TCP address, as reported by the accept() function.
1039        As a sockaddr. */
1040    struct sockaddr_storage tcp_addr;
1041 #else
1042    /** Client PC's IP address, as reported by the accept() function.
1043        As a number. */
1044    unsigned long ip_addr_long;
1045 #endif /* def HAVE_RFC2553 */
1046
1047    /** The host name and port (as a string of the form '<hostname>:<port>')
1048        of the server socket to which the client connected. */
1049    char *listen_addr_str;
1050
1051    /** The URL that was requested */
1052    struct http_request http[1];
1053
1054    /*
1055     * The final forwarding settings.
1056     * XXX: Currently this is only used for forward-override,
1057     * so we can free the space in sweep.
1058     */
1059    struct forward_spec * fwd;
1060
1061    /** An I/O buffer used for buffering data read from the server */
1062    /* XXX: should be renamed to server_iob */
1063    struct iob iob[1];
1064
1065    struct ssl_attr ssl_server_attr; /* attributes for connection to server */
1066    struct ssl_attr ssl_client_attr; /* attributes for connection to client */
1067
1068    /** An I/O buffer used for buffering data read from the client */
1069    struct iob client_iob[1];
1070
1071    /** Buffer used to briefly store data read from the network
1072     *  before forwarding or processing it.
1073     */
1074    char *receive_buffer;
1075    size_t receive_buffer_size;
1076
1077    /** List of all headers for this request */
1078    struct list headers[1];
1079
1080 #ifdef FEATURE_HTTPS_INSPECTION
1081    /** List of all encrypted headers for this request */
1082    struct list https_headers[1];
1083 #endif
1084
1085    /** List of all tags that apply to this request */
1086    struct list tags[1];
1087
1088 #ifdef FEATURE_CLIENT_TAGS
1089    /** List of all tags that apply to this client (assigned based on address) */
1090    struct list client_tags[1];
1091    /** The address of the client the request (presumably) came from.
1092     *  Either the address returned by accept(), or the address provided
1093     *  with the X-Forwarded-For header, provided Privoxy has been configured
1094     *  to use it.
1095     */
1096    char *client_address;
1097 #endif
1098
1099    /** Actions files associated with this client */
1100    struct file_list *actions_list[MAX_AF_FILES];
1101
1102    /** pcrs job files. */
1103    struct file_list *rlist[MAX_AF_FILES];
1104
1105    /** Length after content modification. */
1106    unsigned long long content_length;
1107
1108    /* XXX: is this the right location? */
1109
1110    /** Expected length of content after which we
1111     * should stop reading from the server socket.
1112     */
1113    unsigned long long expected_content_length;
1114
1115    /** Expected length of content after which we
1116     *  should stop reading from the client socket.
1117     */
1118    unsigned long long expected_client_content_length;
1119
1120 #ifdef FEATURE_TRUST
1121
1122    /** Trust file. */
1123    struct file_list *tlist;
1124
1125 #endif /* def FEATURE_TRUST */
1126
1127    /**
1128     * Failure reason to embedded in the CGI error page,
1129     * or NULL. Currently only used for socks errors.
1130     */
1131    char *error_message;
1132
1133 #ifdef FEATURE_HTTPS_INSPECTION
1134    /* Result of server certificate verification
1135     *
1136     * Values for flag determining certificate validity
1137     * are compatible with return value of function
1138     * mbedtls_ssl_get_verify_result() for mbedtls
1139     * and SSL_get_verify_result() for openssl.
1140     * There are no values for "invalid certificate", they are
1141     * set by the functions mentioned above.
1142     */
1143 #define SSL_CERT_VALID          0
1144 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
1145 #define SSL_CERT_NOT_VERIFIED   0xFFFFFFFF
1146    uint32_t server_cert_verification_result;
1147 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
1148 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
1149 #define SSL_CERT_NOT_VERIFIED    ~0L
1150    long server_cert_verification_result;
1151 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
1152
1153    /* Flag for certificate validity checking */
1154    int dont_verify_certificate;
1155
1156    /*
1157     * Flags if SSL connection with server or client is opened.
1158     * Thanks to this flags, we can call function to close both connections
1159     * and we don't have to care about more details.
1160     */
1161    short int ssl_with_server_is_opened;
1162    short int ssl_with_client_is_opened;
1163
1164    /*
1165     * Server certificate chain of trust including strings with certificates
1166     * information and string with whole certificate file
1167     */
1168    struct certs_chain server_certs_chain;
1169 #endif
1170 };
1171
1172 /**
1173  * List of client states so the main thread can keep
1174  * track of them and garbage collect their resources.
1175  */
1176 struct client_states
1177 {
1178    struct client_states *next;
1179    struct client_state csp;
1180 };
1181
1182 /**
1183  * A function to add a header
1184  */
1185 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1186
1187 /**
1188  * A function to process a header
1189  */
1190 typedef jb_err (*parser_func_ptr    )(struct client_state *, char **);
1191
1192
1193 /**
1194  * List of available CGI functions.
1195  */
1196 struct cgi_dispatcher
1197 {
1198    /** The URL of the CGI, relative to the CGI root. */
1199    const char * const name;
1200
1201    /** The handler function for the CGI */
1202    jb_err    (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1203
1204    /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1205    const char * const description;
1206
1207    /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1208    int harmless;
1209 };
1210
1211
1212 /**
1213  * A data file used by Privoxy.  Kept in a linked list.
1214  */
1215 struct file_list
1216 {
1217    /**
1218     * This is a pointer to the data structures associated with the file.
1219     * Read-only once the structure has been created.
1220     */
1221    void *f;
1222
1223    /**
1224     * The unloader function.
1225     * Normally NULL.  When we are finished with file (i.e. when we have
1226     * loaded a new one), set to a pointer to an unloader function.
1227     * Unloader will be called by sweep() (called from main loop) when
1228     * all clients using this file are done.  This prevents threading
1229     * problems.
1230     */
1231    void (*unloader)(void *);
1232
1233    /**
1234     * Used internally by sweep().  Do not access from elsewhere.
1235     */
1236    int active;
1237
1238    /**
1239     * File last-modified time, so we can check if file has been changed.
1240     * Read-only once the structure has been created.
1241     */
1242    time_t lastmodified;
1243
1244    /**
1245     * The full filename.
1246     */
1247    char * filename;
1248
1249    /**
1250     * Pointer to next entry in the linked list of all "file_list"s.
1251     * This linked list is so that sweep() can navigate it.
1252     * Since sweep() can remove items from the list, we must be careful
1253     * to only access this value from main thread (when we know sweep
1254     * won't be running).
1255     */
1256    struct file_list *next;
1257 };
1258
1259
1260 #ifdef FEATURE_TRUST
1261
1262 /**
1263  * The format of a trust file when loaded into memory.
1264  */
1265 struct block_spec
1266 {
1267    struct pattern_spec url[1]; /**< The URL pattern              */
1268    int    reject;              /**< FIXME: Please document this! */
1269    struct block_spec *next;    /**< Next entry in linked list    */
1270 };
1271
1272 /**
1273  * Arbitrary limit for the number of trusted referrers.
1274  */
1275 #define MAX_TRUSTED_REFERRERS 512
1276
1277 #endif /* def FEATURE_TRUST */
1278
1279 /**
1280  * How to forward a connection to a parent proxy.
1281  */
1282 struct forward_spec
1283 {
1284    /** URL pattern that this forward_spec is for. */
1285    struct pattern_spec url[1];
1286
1287    /** Connection type.  Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1288    enum forwarder_type type;
1289
1290    /** SOCKS server port. */
1291    int   gateway_port;
1292
1293    /** SOCKS server hostname.  Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1294    char *gateway_host;
1295
1296    /** SOCKS5 username. */
1297    char *auth_username;
1298
1299    /** SOCKS5 password. */
1300    char *auth_password;
1301
1302    /** Parent HTTP proxy hostname, or NULL for none. */
1303    char *forward_host;
1304
1305    /** Parent HTTP proxy port. */
1306    int   forward_port;
1307
1308    /** Next entry in the linked list. */
1309    struct forward_spec *next;
1310 };
1311
1312
1313 /* Supported filter types */
1314 enum filter_type
1315 {
1316    FT_CONTENT_FILTER       = 0,
1317    FT_CLIENT_HEADER_FILTER = 1,
1318    FT_SERVER_HEADER_FILTER = 2,
1319    FT_CLIENT_HEADER_TAGGER = 3,
1320    FT_SERVER_HEADER_TAGGER = 4,
1321    FT_SUPPRESS_TAG = 5,
1322    FT_CLIENT_BODY_FILTER = 6,
1323    FT_CLIENT_BODY_TAGGER = 7,
1324    FT_ADD_HEADER = 8,
1325 #ifdef FEATURE_EXTERNAL_FILTERS
1326    FT_EXTERNAL_CONTENT_FILTER = 9,
1327 #endif
1328    FT_INVALID_FILTER       = 42,
1329 };
1330
1331 #ifdef FEATURE_EXTERNAL_FILTERS
1332 #define MAX_FILTER_TYPES        9
1333 #else
1334 #define MAX_FILTER_TYPES        8
1335 #endif
1336
1337 /**
1338  * This struct represents one filter (one block) from
1339  * the re_filterfile. If there is more than one filter
1340  * in the file, the file will be represented by a
1341  * chained list of re_filterfile specs.
1342  */
1343 struct re_filterfile_spec
1344 {
1345    char *name;                      /**< Name from FILTER: statement in re_filterfile. */
1346    char *description;               /**< Description from FILTER: statement in re_filterfile. */
1347    struct list patterns[1];         /**< The patterns from the re_filterfile. */
1348    pcrs_job *joblist;               /**< The resulting compiled pcrs_jobs. */
1349    enum filter_type type;           /**< Filter type (content, client-header, server-header). */
1350    int dynamic;                     /**< Set to one if the pattern might contain variables
1351                                          and has to be recompiled for every request. */
1352    struct re_filterfile_spec *next; /**< The pointer for chaining. */
1353 };
1354
1355
1356 #ifdef FEATURE_ACL
1357
1358 #define ACL_PERMIT   1  /**< Accept connection request */
1359 #define ACL_DENY     2  /**< Reject connection request */
1360
1361 /**
1362  * An IP address pattern.  Used to specify networks in the ACL.
1363  */
1364 struct access_control_addr
1365 {
1366 #ifdef HAVE_RFC2553
1367    struct sockaddr_storage addr; /* <The TCP address in network order. */
1368    struct sockaddr_storage mask; /* <The TCP mask in network order. */
1369 #else
1370    unsigned long addr;  /**< The IP address as an integer. */
1371    unsigned long mask;  /**< The network mask as an integer. */
1372    unsigned long port;  /**< The port number. */
1373 #endif /* HAVE_RFC2553 */
1374 };
1375
1376 /**
1377  * An access control list (ACL) entry.
1378  *
1379  * This is a linked list.
1380  */
1381 struct access_control_list
1382 {
1383    struct access_control_addr src[1];  /**< Client IP address */
1384    struct access_control_addr dst[1];  /**< Website or parent proxy IP address */
1385 #ifdef HAVE_RFC2553
1386    short wildcard_dst;                 /** < dst address is wildcard */
1387 #endif
1388
1389    short action;                       /**< ACL_PERMIT or ACL_DENY */
1390    struct access_control_list *next;   /**< The next entry in the ACL. */
1391 };
1392
1393 #endif /* def FEATURE_ACL */
1394
1395
1396 /** Maximum number of loaders (actions, re_filter, ...) */
1397 #define NLOADERS 8
1398
1399 /**
1400  * This struct represents a client-spcific-tag and it's description
1401  */
1402 struct client_tag_spec
1403 {
1404    char *name;        /**< Name from "client-specific-tag bla" directive */
1405    char *description; /**< Description from "client-specific-tag-description " directive */
1406    struct client_tag_spec *next; /**< The pointer for chaining. */
1407 };
1408
1409 /** configuration_spec::feature_flags: CGI actions editor. */
1410 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS             1U
1411
1412 /** configuration_spec::feature_flags: Web-based toggle. */
1413 #define RUNTIME_FEATURE_CGI_TOGGLE                   2U
1414
1415 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1416 #define RUNTIME_FEATURE_HTTP_TOGGLE                  4U
1417
1418 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1419 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS            8U
1420
1421 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1422 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16U
1423
1424 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1425 #define RUNTIME_FEATURE_ENFORCE_BLOCKS              32U
1426
1427 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1428 #define RUNTIME_FEATURE_CGI_CRUNCHING               64U
1429
1430 /** configuration_spec::feature_flags: Try to keep the connection to the server alive. */
1431 #define RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE      128U
1432
1433 /** configuration_spec::feature_flags: Share outgoing connections between different client connections. */
1434 #define RUNTIME_FEATURE_CONNECTION_SHARING         256U
1435
1436 /** configuration_spec::feature_flags: Pages blocked with +handle-as-empty-doc get a return status of 200 OK. */
1437 #define RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK       512U
1438
1439 /** configuration_spec::feature_flags: Buffered content is sent compressed if the client supports it. */
1440 #define RUNTIME_FEATURE_COMPRESSION               1024U
1441
1442 /** configuration_spec::feature_flags: Pipelined requests are served instead of being discarded. */
1443 #define RUNTIME_FEATURE_TOLERATE_PIPELINING       2048U
1444
1445 /** configuration_spec::feature_flags: Proxy authentication headers are forwarded instead of removed. */
1446 #define RUNTIME_FEATURE_FORWARD_PROXY_AUTHENTICATION_HEADERS      4096U
1447
1448 /**
1449  * Data loaded from the configuration file.
1450  *
1451  * (Anomaly: toggle is still handled through a global, not this structure)
1452  */
1453 struct configuration_spec
1454 {
1455    /** What to log */
1456    int debug;
1457
1458    /** Nonzero to enable multithreading. */
1459    int multi_threaded;
1460
1461    /** Bitmask of features that can be controlled through the config file. */
1462    unsigned feature_flags;
1463
1464    /** Nonzero if we need to bind() to the new port. */
1465    int need_bind;
1466
1467    /** The log file name. */
1468    const char *logfile;
1469
1470    /** The config file directory. */
1471    const char *confdir;
1472
1473    /** The directory for customized CGI templates. */
1474    const char *templdir;
1475
1476    /** "Cross-origin resource sharing" (CORS) allowed origin */
1477    const char *cors_allowed_origin;
1478
1479 #ifdef FEATURE_EXTERNAL_FILTERS
1480    /** The template used to create temporary files. */
1481    const char *temporary_directory;
1482 #endif
1483
1484    /** The log file directory. */
1485    const char *logdir;
1486
1487    /** The full paths to the actions files. */
1488    const char *actions_file[MAX_AF_FILES];
1489
1490    /** The short names of the actions files. */
1491    const char *actions_file_short[MAX_AF_FILES];
1492
1493    /** The administrator's email address */
1494    char *admin_address;
1495
1496    /** A URL with info on this proxy */
1497    char *proxy_info_url;
1498
1499    /** URL to the user manual (on our website or local copy) */
1500    char *usermanual;
1501
1502    /** The file names of the pcre filter files. */
1503    const char *re_filterfile[MAX_AF_FILES];
1504
1505    /** The short names of the pcre filter files. */
1506    const char *re_filterfile_short[MAX_AF_FILES];
1507
1508    /**< List of ordered client header names. */
1509    struct list ordered_client_headers[1];
1510
1511    /** The hostname to show on CGI pages, or NULL to use the real one. */
1512    const char *hostname;
1513
1514    /** IP addresses to bind to.  Defaults to HADDR_DEFAULT == 127.0.0.1. */
1515    const char *haddr[MAX_LISTENING_SOCKETS];
1516
1517    /** Trusted referring site that can be used to reach CGI
1518      * pages that aren't marked as harmful.
1519      */
1520    const char *trusted_cgi_referrer;
1521
1522    /** Ports to bind to.  Defaults to HADDR_PORT == 8118. */
1523    int         hport[MAX_LISTENING_SOCKETS];
1524
1525    /** Size limit for IOB */
1526    size_t buffer_limit;
1527
1528    /** Size of the receive buffer */
1529    size_t receive_buffer_size;
1530
1531    /** Use accf_http(4) if available */
1532    int enable_accept_filter;
1533
1534    /** Backlog passed to listen() */
1535    int listen_backlog;
1536
1537 #ifdef FEATURE_TRUST
1538
1539    /** The file name of the trust file. */
1540    const char * trustfile;
1541
1542    /** FIXME: DOCME: Document this. */
1543    struct list trust_info[1];
1544
1545    /** FIXME: DOCME: Document this. */
1546    struct pattern_spec *trust_list[MAX_TRUSTED_REFERRERS];
1547
1548 #endif /* def FEATURE_TRUST */
1549
1550 #ifdef FEATURE_CLIENT_TAGS
1551    struct client_tag_spec client_tags[1];
1552
1553    /* Maximum number of seconds a temporarily enabled tag stays enabled. */
1554    unsigned int client_tag_lifetime;
1555 #endif /* def FEATURE_CLIENT_TAGS */
1556    int trust_x_forwarded_for;
1557
1558 #ifdef FEATURE_ACL
1559
1560    /** The access control list (ACL). */
1561    struct access_control_list *acl;
1562
1563 #endif /* def FEATURE_ACL */
1564
1565    /** Information about parent proxies (forwarding). */
1566    struct forward_spec *forward;
1567
1568    /** Number of retries in case a forwarded connection attempt fails */
1569    int forwarded_connect_retries;
1570
1571    /** Maximum number of client connections. */
1572    int max_client_connections;
1573
1574    /* Timeout when waiting on sockets for data to become available. */
1575    int socket_timeout;
1576
1577 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1578    /* Maximum number of seconds after which an open connection will no longer be reused. */
1579    unsigned int keep_alive_timeout;
1580
1581    /* Assumed server-side keep alive timeout if none is specified. */
1582    unsigned int default_server_timeout;
1583 #endif
1584
1585 #ifdef FEATURE_COMPRESSION
1586    int compression_level;
1587 #endif
1588
1589    /** All options from the config file, HTML-formatted. */
1590    char *proxy_args;
1591
1592    /** The configuration file object. */
1593    struct file_list *config_file_list;
1594
1595    /** List of loaders */
1596    int (*loaders[NLOADERS])(struct client_state *);
1597
1598 #ifdef FEATURE_HTTPS_INSPECTION
1599    /** Password for proxy ca file **/
1600    char *ca_password;
1601
1602    /** Directory with files of ca **/
1603    char *ca_directory;
1604
1605    /** Filename of ca certificate **/
1606    char *ca_cert_file;
1607
1608    /** Filename of ca key **/
1609    char *ca_key_file;
1610
1611    /** Directory for saving certificates and keys for each webpage **/
1612    char *certificate_directory;
1613
1614    /** Cipher list to use **/
1615    char *cipher_list;
1616
1617    /** Filename of trusted CAs certificates **/
1618    char *trusted_cas_file;
1619 #endif
1620 };
1621
1622 /** Calculates the number of elements in an array, using sizeof. */
1623 #define SZ(X)  (sizeof(X) / sizeof(*X))
1624
1625 /** The force load URL prefix. Not behind an ifdef because
1626   * it's always used for the show-status page. */
1627 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1628
1629 #ifdef FEATURE_NO_GIFS
1630 /** The MIME type for images ("image/png" or "image/gif"). */
1631 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1632 #else
1633 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1634 #endif /* def FEATURE_NO_GIFS */
1635
1636
1637 /*
1638  * Hardwired URLs
1639  */
1640
1641 /** URL for the Privoxy home page. */
1642 #define HOME_PAGE_URL     "https://www.privoxy.org/"
1643
1644 /** URL for the Privoxy user manual. */
1645 #define USER_MANUAL_URL   HOME_PAGE_URL VERSION "/user-manual/"
1646
1647 /** Prefix for actions help links  (append to USER_MANUAL_URL). */
1648 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1649
1650 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1651 #define CONFIG_HELP_PREFIX  "config.html#"
1652
1653 /*
1654  * The "hosts" to intercept and display CGI pages.
1655  * First one is a hostname only, second one can specify host and path.
1656  *
1657  * Notes:
1658  * 1) Do not specify the http: prefix
1659  * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1660  * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1661  */
1662 #define CGI_SITE_1_HOST "p.p"
1663 #define CGI_SITE_2_HOST "config.privoxy.org"
1664 #define CGI_SITE_2_PATH ""
1665
1666 /**
1667  * The prefix for CGI pages.  Written out in generated HTML.
1668  * INCLUDES the trailing slash.
1669  */
1670 #ifdef FEATURE_HTTPS_INSPECTION
1671 #define CGI_PREFIX  "//" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1672 #define CGI_PREFIX_HTTPS "https:" CGI_PREFIX
1673 #else
1674 #define CGI_PREFIX  "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1675 #endif
1676 #define CGI_PREFIX_HTTP  "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1677
1678 #endif /* ndef PROJECT_H_INCLUDED */
1679
1680 /*
1681   Local Variables:
1682   tab-width: 3
1683   end:
1684 */