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