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