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