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