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