project.h

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