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