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