project.h

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